c779d27428fb9df8059e9628d683f097ef7ad3a8
[platform/upstream/gcc.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, 2011
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, 2011
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.3 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}  -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}  @gol
168 -fdump-ada-spec@r{[}-slim@r{]} -fdump-go-spec=@var{file}}
169
170 @item C Language Options
171 @xref{C Dialect Options,,Options Controlling C Dialect}.
172 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
173 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
174 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
175 -fhosted  -ffreestanding -fopenmp -fms-extensions -fplan9-extensions @gol
176 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
177 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
178 -fsigned-bitfields  -fsigned-char @gol
179 -funsigned-bitfields  -funsigned-char}
180
181 @item C++ Language Options
182 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
183 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
184 -fconserve-space  -fconstexpr-depth=@var{n}  -ffriend-injection @gol
185 -fno-elide-constructors @gol
186 -fno-enforce-eh-specs @gol
187 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
188 -fno-implicit-templates @gol
189 -fno-implicit-inline-templates @gol
190 -fno-implement-inlines  -fms-extensions @gol
191 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
192 -fno-optional-diags  -fpermissive @gol
193 -fno-pretty-templates @gol
194 -frepo  -fno-rtti  -fstats  -ftemplate-depth=@var{n} @gol
195 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
196 -fno-default-inline  -fvisibility-inlines-hidden @gol
197 -fvisibility-ms-compat @gol
198 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
199 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
200 -Weffc++  -Wstrict-null-sentinel @gol
201 -Wno-non-template-friend  -Wold-style-cast @gol
202 -Woverloaded-virtual  -Wno-pmf-conversions @gol
203 -Wsign-promo -Wzero-as-null-pointer-constant}
204
205 @item Objective-C and Objective-C++ Language Options
206 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
207 Objective-C and Objective-C++ Dialects}.
208 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
209 -fgnu-runtime  -fnext-runtime @gol
210 -fno-nil-receivers @gol
211 -fobjc-abi-version=@var{n} @gol
212 -fobjc-call-cxx-cdtors @gol
213 -fobjc-direct-dispatch @gol
214 -fobjc-exceptions @gol
215 -fobjc-gc @gol
216 -fobjc-nilcheck @gol
217 -fobjc-std=objc1 @gol
218 -freplace-objc-classes @gol
219 -fzero-link @gol
220 -gen-decls @gol
221 -Wassign-intercept @gol
222 -Wno-protocol  -Wselector @gol
223 -Wstrict-selector-match @gol
224 -Wundeclared-selector}
225
226 @item Language Independent Options
227 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
228 @gccoptlist{-fmessage-length=@var{n}  @gol
229 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
230 -fno-diagnostics-show-option}
231
232 @item Warning Options
233 @xref{Warning Options,,Options to Request or Suppress Warnings}.
234 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -pedantic @gol
235 -pedantic-errors @gol
236 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
237 -Wno-attributes -Wno-builtin-macro-redefined @gol
238 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
239 -Wchar-subscripts -Wclobbered  -Wcomment @gol
240 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wno-deprecated  @gol
241 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
242 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
243 -Wno-endif-labels -Werror  -Werror=* @gol
244 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
245 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
246 -Wformat-security  -Wformat-y2k @gol
247 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
248 -Wignored-qualifiers @gol
249 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
250 -Winit-self  -Winline -Wmaybe-uninitialized @gol
251 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
252 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
253 -Wlogical-op -Wlong-long @gol
254 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
255 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
256 -Wno-mudflap @gol
257 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
258 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
259 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
260 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
261 -Wredundant-decls @gol
262 -Wreturn-type  -Wsequence-point  -Wshadow @gol
263 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
264 -Wstack-usage=@var{len} -Wstrict-aliasing -Wstrict-aliasing=n @gol
265 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
266 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]} @gol
267 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
268 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
269 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
270 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
271 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
272 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
273 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
274 -Wvariadic-macros -Wvector-operation-performance -Wvla 
275 -Wvolatile-register-var  -Wwrite-strings}
276
277 @item C and Objective-C-only Warning Options
278 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
279 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
280 -Wold-style-declaration  -Wold-style-definition @gol
281 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
282 -Wdeclaration-after-statement -Wpointer-sign}
283
284 @item Debugging Options
285 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
286 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
287 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
288 -fdisable-ipa-@var{pass_name} @gol
289 -fdisable-rtl-@var{pass_name} @gol
290 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
291 -fdisable-tree-@var{pass_name} @gol
292 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
293 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
294 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
295 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
296 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
297 -fdump-passes @gol
298 -fdump-statistics @gol
299 -fdump-tree-all @gol
300 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
301 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
303 -fdump-tree-ch @gol
304 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
305 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
307 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
308 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-nrv -fdump-tree-vect @gol
314 -fdump-tree-sink @gol
315 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
318 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
319 -ftree-vectorizer-verbose=@var{n} @gol
320 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
321 -fdump-final-insns=@var{file} @gol
322 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
323 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
324 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
325 -fenable-@var{kind}-@var{pass} @gol
326 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
327 -fdebug-types-section @gol
328 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
329 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
330 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
331 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
332 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
333 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
334 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
335 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
336 -gvms  -gxcoff  -gxcoff+ @gol
337 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
338 -fdebug-prefix-map=@var{old}=@var{new} @gol
339 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
340 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
341 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
342 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
343 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
344 -print-sysroot -print-sysroot-headers-suffix @gol
345 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
346
347 @item Optimization Options
348 @xref{Optimize Options,,Options that Control Optimization}.
349 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
350 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
351 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
352 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
353 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
354 -fcompare-elim -fcprop-registers -fcrossjumping @gol
355 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
356 -fcx-limited-range @gol
357 -fdata-sections -fdce -fdce -fdelayed-branch @gol
358 -fdelete-null-pointer-checks -fdse -fdevirtualize -fdse @gol
359 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
360 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
361 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
362 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
363 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
364 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
365 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg @gol
366 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
367 -fira-algorithm=@var{algorithm} @gol
368 -fira-region=@var{region} @gol
369 -fira-loop-pressure -fno-ira-share-save-slots @gol
370 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
371 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
372 -floop-block -floop-flatten -floop-interchange -floop-strip-mine @gol
373 -floop-parallelize-all -flto -flto-compression-level @gol
374 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
375 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
376 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
377 -fno-default-inline @gol
378 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
379 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
380 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
381 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
382 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
383 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
384 -fprefetch-loop-arrays @gol
385 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
386 -fprofile-generate=@var{path} @gol
387 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
388 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
389 -freorder-blocks-and-partition -freorder-functions @gol
390 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
391 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
392 -fsched-spec-load -fsched-spec-load-dangerous @gol
393 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
394 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
395 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
396 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
397 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
398 -fselective-scheduling -fselective-scheduling2 @gol
399 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
400 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
401 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
402 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
403 -fthread-jumps -ftracer -ftree-bit-ccp @gol
404 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
405 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
406 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
407 -ftree-loop-if-convert-stores -ftree-loop-im @gol
408 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
409 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
410 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
411 -ftree-sink -ftree-sra -ftree-switch-conversion -ftree-tail-merge @gol
412 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
413 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
414 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
415 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
416 -fwhole-program -fwpa -fuse-linker-plugin @gol
417 --param @var{name}=@var{value}
418 -O  -O0  -O1  -O2  -O3  -Os -Ofast}
419
420 @item Preprocessor Options
421 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
422 @gccoptlist{-A@var{question}=@var{answer} @gol
423 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
424 -C  -dD  -dI  -dM  -dN @gol
425 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
426 -idirafter @var{dir} @gol
427 -include @var{file}  -imacros @var{file} @gol
428 -iprefix @var{file}  -iwithprefix @var{dir} @gol
429 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
430 -imultilib @var{dir} -isysroot @var{dir} @gol
431 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
432 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
433 -remap -trigraphs  -undef  -U@var{macro}  @gol
434 -Wp,@var{option} -Xpreprocessor @var{option}}
435
436 @item Assembler Option
437 @xref{Assembler Options,,Passing Options to the Assembler}.
438 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
439
440 @item Linker Options
441 @xref{Link Options,,Options for Linking}.
442 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
443 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
444 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
445 -shared-libgcc  -symbolic @gol
446 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
447 -u @var{symbol}}
448
449 @item Directory Options
450 @xref{Directory Options,,Options for Directory Search}.
451 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
452 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
453 --sysroot=@var{dir}}
454
455 @item Machine Dependent Options
456 @xref{Submodel Options,,Hardware Models and Configurations}.
457 @c This list is ordered alphanumerically by subsection name.
458 @c Try and put the significant identifier (CPU or system) first,
459 @c so users have a clue at guessing where the ones they want will be.
460
461 @emph{Adapteva Epiphany Options}
462 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
463 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
464 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
465 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
466 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
467 -msplit-vecmove-early -m1reg-@var{reg}}
468
469 @emph{ARM Options}
470 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
471 -mabi=@var{name} @gol
472 -mapcs-stack-check  -mno-apcs-stack-check @gol
473 -mapcs-float  -mno-apcs-float @gol
474 -mapcs-reentrant  -mno-apcs-reentrant @gol
475 -msched-prolog  -mno-sched-prolog @gol
476 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
477 -mfloat-abi=@var{name}  -mfpe @gol
478 -mfp16-format=@var{name}
479 -mthumb-interwork  -mno-thumb-interwork @gol
480 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
481 -mstructure-size-boundary=@var{n} @gol
482 -mabort-on-noreturn @gol
483 -mlong-calls  -mno-long-calls @gol
484 -msingle-pic-base  -mno-single-pic-base @gol
485 -mpic-register=@var{reg} @gol
486 -mnop-fun-dllimport @gol
487 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
488 -mpoke-function-name @gol
489 -mthumb  -marm @gol
490 -mtpcs-frame  -mtpcs-leaf-frame @gol
491 -mcaller-super-interworking  -mcallee-super-interworking @gol
492 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
493 -mword-relocations @gol
494 -mfix-cortex-m3-ldrd}
495
496 @emph{AVR Options}
497 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
498 -mcall-prologues  -mtiny-stack  -mint8  -mstrict-X}
499
500 @emph{Blackfin Options}
501 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
502 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
503 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
504 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
505 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
506 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
507 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
508 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
509 -micplb}
510
511 @emph{C6X Options}
512 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
513 -msim -msdata=@var{sdata-type}}
514
515 @emph{CRIS Options}
516 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
517 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
518 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
519 -mstack-align  -mdata-align  -mconst-align @gol
520 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
521 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
522 -mmul-bug-workaround  -mno-mul-bug-workaround}
523
524 @emph{Darwin Options}
525 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
526 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
527 -client_name  -compatibility_version  -current_version @gol
528 -dead_strip @gol
529 -dependency-file  -dylib_file  -dylinker_install_name @gol
530 -dynamic  -dynamiclib  -exported_symbols_list @gol
531 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
532 -force_flat_namespace  -headerpad_max_install_names @gol
533 -iframework @gol
534 -image_base  -init  -install_name  -keep_private_externs @gol
535 -multi_module  -multiply_defined  -multiply_defined_unused @gol
536 -noall_load   -no_dead_strip_inits_and_terms @gol
537 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
538 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
539 -private_bundle  -read_only_relocs  -sectalign @gol
540 -sectobjectsymbols  -whyload  -seg1addr @gol
541 -sectcreate  -sectobjectsymbols  -sectorder @gol
542 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
543 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
544 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
545 -single_module  -static  -sub_library  -sub_umbrella @gol
546 -twolevel_namespace  -umbrella  -undefined @gol
547 -unexported_symbols_list  -weak_reference_mismatches @gol
548 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
549 -mkernel -mone-byte-bool}
550
551 @emph{DEC Alpha Options}
552 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
553 -mieee  -mieee-with-inexact  -mieee-conformant @gol
554 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
555 -mtrap-precision=@var{mode}  -mbuild-constants @gol
556 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
557 -mbwx  -mmax  -mfix  -mcix @gol
558 -mfloat-vax  -mfloat-ieee @gol
559 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
560 -msmall-text  -mlarge-text @gol
561 -mmemory-latency=@var{time}}
562
563 @emph{DEC Alpha/VMS Options}
564 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
565
566 @emph{FR30 Options}
567 @gccoptlist{-msmall-model -mno-lsim}
568
569 @emph{FRV Options}
570 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
571 -mhard-float  -msoft-float @gol
572 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
573 -mdouble  -mno-double @gol
574 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
575 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
576 -mlinked-fp  -mlong-calls  -malign-labels @gol
577 -mlibrary-pic  -macc-4  -macc-8 @gol
578 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
579 -moptimize-membar -mno-optimize-membar @gol
580 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
581 -mvliw-branch  -mno-vliw-branch @gol
582 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
583 -mno-nested-cond-exec  -mtomcat-stats @gol
584 -mTLS -mtls @gol
585 -mcpu=@var{cpu}}
586
587 @emph{GNU/Linux Options}
588 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
589 -tno-android-cc -tno-android-ld}
590
591 @emph{H8/300 Options}
592 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
593
594 @emph{HPPA Options}
595 @gccoptlist{-march=@var{architecture-type} @gol
596 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
597 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
598 -mfixed-range=@var{register-range} @gol
599 -mjump-in-delay -mlinker-opt -mlong-calls @gol
600 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
601 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
602 -mno-jump-in-delay  -mno-long-load-store @gol
603 -mno-portable-runtime  -mno-soft-float @gol
604 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
605 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
606 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
607 -munix=@var{unix-std}  -nolibdld  -static  -threads}
608
609 @emph{i386 and x86-64 Options}
610 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
611 -mfpmath=@var{unit} @gol
612 -masm=@var{dialect}  -mno-fancy-math-387 @gol
613 -mno-fp-ret-in-387  -msoft-float @gol
614 -mno-wide-multiply  -mrtd  -malign-double @gol
615 -mpreferred-stack-boundary=@var{num} @gol
616 -mincoming-stack-boundary=@var{num} @gol
617 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
618 -mrecip -mrecip=@var{opt} @gol
619 -mvzeroupper @gol
620 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
621 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
622 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
623 -mbmi2 -mlwp -mthreads  -mno-align-stringops  -minline-all-stringops @gol
624 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
625 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
626 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
627 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
628 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
629 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
630 -mcmodel=@var{code-model} -mabi=@var{name} @gol
631 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
632 -msse2avx -mfentry -m8bit-idiv @gol
633 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
634
635 @emph{i386 and x86-64 Windows Options}
636 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
637 -mnop-fun-dllimport -mthread @gol
638 -municode -mwin32 -mwindows -fno-set-stack-executable}
639
640 @emph{IA-64 Options}
641 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
642 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
643 -mconstant-gp  -mauto-pic  -mfused-madd @gol
644 -minline-float-divide-min-latency @gol
645 -minline-float-divide-max-throughput @gol
646 -mno-inline-float-divide @gol
647 -minline-int-divide-min-latency @gol
648 -minline-int-divide-max-throughput  @gol
649 -mno-inline-int-divide @gol
650 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
651 -mno-inline-sqrt @gol
652 -mdwarf2-asm -mearly-stop-bits @gol
653 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
654 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
655 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
656 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
657 -msched-spec-ldc -msched-spec-control-ldc @gol
658 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
659 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
660 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
661 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
662
663 @emph{IA-64/VMS Options}
664 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
665
666 @emph{LM32 Options}
667 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
668 -msign-extend-enabled -muser-enabled}
669
670 @emph{M32R/D Options}
671 @gccoptlist{-m32r2 -m32rx -m32r @gol
672 -mdebug @gol
673 -malign-loops -mno-align-loops @gol
674 -missue-rate=@var{number} @gol
675 -mbranch-cost=@var{number} @gol
676 -mmodel=@var{code-size-model-type} @gol
677 -msdata=@var{sdata-type} @gol
678 -mno-flush-func -mflush-func=@var{name} @gol
679 -mno-flush-trap -mflush-trap=@var{number} @gol
680 -G @var{num}}
681
682 @emph{M32C Options}
683 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
684
685 @emph{M680x0 Options}
686 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
687 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
688 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
689 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
690 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
691 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
692 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
693 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
694 -mxgot -mno-xgot}
695
696 @emph{MCore Options}
697 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
698 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
699 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
700 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
701 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
702
703 @emph{MeP Options}
704 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
705 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
706 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
707 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
708 -mtiny=@var{n}}
709
710 @emph{MicroBlaze Options}
711 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
712 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
713 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
714 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
715 -mxl-mode-@var{app-model}}
716
717 @emph{MIPS Options}
718 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
719 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
720 -mips64  -mips64r2 @gol
721 -mips16  -mno-mips16  -mflip-mips16 @gol
722 -minterlink-mips16  -mno-interlink-mips16 @gol
723 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
724 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
725 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
726 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
727 -mfpu=@var{fpu-type} @gol
728 -msmartmips  -mno-smartmips @gol
729 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
730 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
731 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
732 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
733 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
734 -membedded-data  -mno-embedded-data @gol
735 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
736 -mcode-readable=@var{setting} @gol
737 -msplit-addresses  -mno-split-addresses @gol
738 -mexplicit-relocs  -mno-explicit-relocs @gol
739 -mcheck-zero-division  -mno-check-zero-division @gol
740 -mdivide-traps  -mdivide-breaks @gol
741 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
742 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
743 -mfix-24k -mno-fix-24k @gol
744 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
745 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
746 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
747 -mflush-func=@var{func}  -mno-flush-func @gol
748 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
749 -mfp-exceptions -mno-fp-exceptions @gol
750 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
751 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
752
753 @emph{MMIX Options}
754 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
755 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
756 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
757 -mno-base-addresses  -msingle-exit  -mno-single-exit}
758
759 @emph{MN10300 Options}
760 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
761 -mno-am33 -mam33 -mam33-2 -mam34 @gol
762 -mtune=@var{cpu-type} @gol
763 -mreturn-pointer-on-d0 @gol
764 -mno-crt0  -mrelax -mliw -msetlb}
765
766 @emph{PDP-11 Options}
767 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
768 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
769 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
770 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
771 -mbranch-expensive  -mbranch-cheap @gol
772 -munix-asm  -mdec-asm}
773
774 @emph{picoChip Options}
775 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
776 -msymbol-as-address -mno-inefficient-warnings}
777
778 @emph{PowerPC Options}
779 See RS/6000 and PowerPC Options.
780
781 @emph{RL78 Options}
782 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
783
784 @emph{RS/6000 and PowerPC Options}
785 @gccoptlist{-mcpu=@var{cpu-type} @gol
786 -mtune=@var{cpu-type} @gol
787 -mcmodel=@var{code-model} @gol
788 -mpower  -mno-power  -mpower2  -mno-power2 @gol
789 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
790 -maltivec  -mno-altivec @gol
791 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
792 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
793 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
794 -mfprnd  -mno-fprnd @gol
795 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
796 -mnew-mnemonics  -mold-mnemonics @gol
797 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
798 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
799 -malign-power  -malign-natural @gol
800 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
801 -msingle-float -mdouble-float -msimple-fpu @gol
802 -mstring  -mno-string  -mupdate  -mno-update @gol
803 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
804 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
805 -mstrict-align  -mno-strict-align  -mrelocatable @gol
806 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
807 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
808 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
809 -mprioritize-restricted-insns=@var{priority} @gol
810 -msched-costly-dep=@var{dependence_type} @gol
811 -minsert-sched-nops=@var{scheme} @gol
812 -mcall-sysv  -mcall-netbsd @gol
813 -maix-struct-return  -msvr4-struct-return @gol
814 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
815 -mblock-move-inline-limit=@var{num} @gol
816 -misel -mno-isel @gol
817 -misel=yes  -misel=no @gol
818 -mspe -mno-spe @gol
819 -mspe=yes  -mspe=no @gol
820 -mpaired @gol
821 -mgen-cell-microcode -mwarn-cell-microcode @gol
822 -mvrsave -mno-vrsave @gol
823 -mmulhw -mno-mulhw @gol
824 -mdlmzb -mno-dlmzb @gol
825 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
826 -mprototype  -mno-prototype @gol
827 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
828 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
829 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
830 -mno-recip-precision @gol
831 -mveclibabi=@var{type} -mfriz -mno-friz @gol
832 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
833 -msave-toc-indirect -mno-save-toc-indirect}
834
835 @emph{RX Options}
836 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
837 -mcpu=@gol
838 -mbig-endian-data -mlittle-endian-data @gol
839 -msmall-data @gol
840 -msim  -mno-sim@gol
841 -mas100-syntax -mno-as100-syntax@gol
842 -mrelax@gol
843 -mmax-constant-size=@gol
844 -mint-register=@gol
845 -mpid@gol
846 -msave-acc-in-interrupts}
847
848 @emph{S/390 and zSeries Options}
849 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
850 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
851 -mlong-double-64 -mlong-double-128 @gol
852 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
853 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
854 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
855 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
856 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
857
858 @emph{Score Options}
859 @gccoptlist{-meb -mel @gol
860 -mnhwloop @gol
861 -muls @gol
862 -mmac @gol
863 -mscore5 -mscore5u -mscore7 -mscore7d}
864
865 @emph{SH Options}
866 @gccoptlist{-m1  -m2  -m2e @gol
867 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
868 -m3  -m3e @gol
869 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
870 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
871 -m5-64media  -m5-64media-nofpu @gol
872 -m5-32media  -m5-32media-nofpu @gol
873 -m5-compact  -m5-compact-nofpu @gol
874 -mb  -ml  -mdalign  -mrelax @gol
875 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
876 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
877 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
878 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
879 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
880 -maccumulate-outgoing-args -minvalid-symbols -msoft-atomic}
881
882 @emph{Solaris 2 Options}
883 @gccoptlist{-mimpure-text  -mno-impure-text @gol
884 -pthreads -pthread}
885
886 @emph{SPARC Options}
887 @gccoptlist{-mcpu=@var{cpu-type} @gol
888 -mtune=@var{cpu-type} @gol
889 -mcmodel=@var{code-model} @gol
890 -mmemory-model=@var{mem-model} @gol
891 -m32  -m64  -mapp-regs  -mno-app-regs @gol
892 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
893 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
894 -mhard-quad-float  -msoft-quad-float @gol
895 -mlittle-endian @gol
896 -mstack-bias  -mno-stack-bias @gol
897 -munaligned-doubles  -mno-unaligned-doubles @gol
898 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
899 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
900 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
901 -mfix-at697f}
902
903 @emph{SPU Options}
904 @gccoptlist{-mwarn-reloc -merror-reloc @gol
905 -msafe-dma -munsafe-dma @gol
906 -mbranch-hints @gol
907 -msmall-mem -mlarge-mem -mstdmain @gol
908 -mfixed-range=@var{register-range} @gol
909 -mea32 -mea64 @gol
910 -maddress-space-conversion -mno-address-space-conversion @gol
911 -mcache-size=@var{cache-size} @gol
912 -matomic-updates -mno-atomic-updates}
913
914 @emph{System V Options}
915 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
916
917 @emph{V850 Options}
918 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
919 -mprolog-function  -mno-prolog-function  -mspace @gol
920 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
921 -mapp-regs  -mno-app-regs @gol
922 -mdisable-callt  -mno-disable-callt @gol
923 -mv850e2v3 @gol
924 -mv850e2 @gol
925 -mv850e1 -mv850es @gol
926 -mv850e @gol
927 -mv850  -mbig-switch}
928
929 @emph{VAX Options}
930 @gccoptlist{-mg  -mgnu  -munix}
931
932 @emph{VxWorks Options}
933 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
934 -Xbind-lazy  -Xbind-now}
935
936 @emph{x86-64 Options}
937 See i386 and x86-64 Options.
938
939 @emph{Xstormy16 Options}
940 @gccoptlist{-msim}
941
942 @emph{Xtensa Options}
943 @gccoptlist{-mconst16 -mno-const16 @gol
944 -mfused-madd  -mno-fused-madd @gol
945 -mforce-no-pic @gol
946 -mserialize-volatile  -mno-serialize-volatile @gol
947 -mtext-section-literals  -mno-text-section-literals @gol
948 -mtarget-align  -mno-target-align @gol
949 -mlongcalls  -mno-longcalls}
950
951 @emph{zSeries Options}
952 See S/390 and zSeries Options.
953
954 @item Code Generation Options
955 @xref{Code Gen Options,,Options for Code Generation Conventions}.
956 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
957 -ffixed-@var{reg}  -fexceptions @gol
958 -fnon-call-exceptions  -funwind-tables @gol
959 -fasynchronous-unwind-tables @gol
960 -finhibit-size-directive  -finstrument-functions @gol
961 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
962 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
963 -fno-common  -fno-ident @gol
964 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
965 -fno-jump-tables @gol
966 -frecord-gcc-switches @gol
967 -freg-struct-return  -fshort-enums @gol
968 -fshort-double  -fshort-wchar @gol
969 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
970 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
971 -fno-stack-limit -fsplit-stack @gol
972 -fleading-underscore  -ftls-model=@var{model} @gol
973 -ftrapv  -fwrapv  -fbounds-check @gol
974 -fvisibility -fstrict-volatile-bitfields}
975 @end table
976
977 @menu
978 * Overall Options::     Controlling the kind of output:
979                         an executable, object files, assembler files,
980                         or preprocessed source.
981 * C Dialect Options::   Controlling the variant of C language compiled.
982 * C++ Dialect Options:: Variations on C++.
983 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
984                         and Objective-C++.
985 * Language Independent Options:: Controlling how diagnostics should be
986                         formatted.
987 * Warning Options::     How picky should the compiler be?
988 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
989 * Optimize Options::    How much optimization?
990 * Preprocessor Options:: Controlling header files and macro definitions.
991                          Also, getting dependency information for Make.
992 * Assembler Options::   Passing options to the assembler.
993 * Link Options::        Specifying libraries and so on.
994 * Directory Options::   Where to find header files and libraries.
995                         Where to find the compiler executable files.
996 * Spec Files::          How to pass switches to sub-processes.
997 * Target Options::      Running a cross-compiler, or an old version of GCC.
998 @end menu
999
1000 @node Overall Options
1001 @section Options Controlling the Kind of Output
1002
1003 Compilation can involve up to four stages: preprocessing, compilation
1004 proper, assembly and linking, always in that order.  GCC is capable of
1005 preprocessing and compiling several files either into several
1006 assembler input files, or into one assembler input file; then each
1007 assembler input file produces an object file, and linking combines all
1008 the object files (those newly compiled, and those specified as input)
1009 into an executable file.
1010
1011 @cindex file name suffix
1012 For any given input file, the file name suffix determines what kind of
1013 compilation is done:
1014
1015 @table @gcctabopt
1016 @item @var{file}.c
1017 C source code which must be preprocessed.
1018
1019 @item @var{file}.i
1020 C source code which should not be preprocessed.
1021
1022 @item @var{file}.ii
1023 C++ source code which should not be preprocessed.
1024
1025 @item @var{file}.m
1026 Objective-C source code.  Note that you must link with the @file{libobjc}
1027 library to make an Objective-C program work.
1028
1029 @item @var{file}.mi
1030 Objective-C source code which should not be preprocessed.
1031
1032 @item @var{file}.mm
1033 @itemx @var{file}.M
1034 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1035 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1036 to a literal capital M@.
1037
1038 @item @var{file}.mii
1039 Objective-C++ source code which should not be preprocessed.
1040
1041 @item @var{file}.h
1042 C, C++, Objective-C or Objective-C++ header file to be turned into a
1043 precompiled header (default), or C, C++ header file to be turned into an
1044 Ada spec (via the @option{-fdump-ada-spec} switch).
1045
1046 @item @var{file}.cc
1047 @itemx @var{file}.cp
1048 @itemx @var{file}.cxx
1049 @itemx @var{file}.cpp
1050 @itemx @var{file}.CPP
1051 @itemx @var{file}.c++
1052 @itemx @var{file}.C
1053 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
1054 the last two letters must both be literally @samp{x}.  Likewise,
1055 @samp{.C} refers to a literal capital C@.
1056
1057 @item @var{file}.mm
1058 @itemx @var{file}.M
1059 Objective-C++ source code which must be preprocessed.
1060
1061 @item @var{file}.mii
1062 Objective-C++ source code which should not be preprocessed.
1063
1064 @item @var{file}.hh
1065 @itemx @var{file}.H
1066 @itemx @var{file}.hp
1067 @itemx @var{file}.hxx
1068 @itemx @var{file}.hpp
1069 @itemx @var{file}.HPP
1070 @itemx @var{file}.h++
1071 @itemx @var{file}.tcc
1072 C++ header file to be turned into a precompiled header or Ada spec.
1073
1074 @item @var{file}.f
1075 @itemx @var{file}.for
1076 @itemx @var{file}.ftn
1077 Fixed form Fortran source code which should not be preprocessed.
1078
1079 @item @var{file}.F
1080 @itemx @var{file}.FOR
1081 @itemx @var{file}.fpp
1082 @itemx @var{file}.FPP
1083 @itemx @var{file}.FTN
1084 Fixed form Fortran source code which must be preprocessed (with the traditional
1085 preprocessor).
1086
1087 @item @var{file}.f90
1088 @itemx @var{file}.f95
1089 @itemx @var{file}.f03
1090 @itemx @var{file}.f08
1091 Free form Fortran source code which should not be preprocessed.
1092
1093 @item @var{file}.F90
1094 @itemx @var{file}.F95
1095 @itemx @var{file}.F03
1096 @itemx @var{file}.F08
1097 Free form Fortran source code which must be preprocessed (with the
1098 traditional preprocessor).
1099
1100 @item @var{file}.go
1101 Go source code.
1102
1103 @c FIXME: Descriptions of Java file types.
1104 @c @var{file}.java
1105 @c @var{file}.class
1106 @c @var{file}.zip
1107 @c @var{file}.jar
1108
1109 @item @var{file}.ads
1110 Ada source code file which contains a library unit declaration (a
1111 declaration of a package, subprogram, or generic, or a generic
1112 instantiation), or a library unit renaming declaration (a package,
1113 generic, or subprogram renaming declaration).  Such files are also
1114 called @dfn{specs}.
1115
1116 @item @var{file}.adb
1117 Ada source code file containing a library unit body (a subprogram or
1118 package body).  Such files are also called @dfn{bodies}.
1119
1120 @c GCC also knows about some suffixes for languages not yet included:
1121 @c Pascal:
1122 @c @var{file}.p
1123 @c @var{file}.pas
1124 @c Ratfor:
1125 @c @var{file}.r
1126
1127 @item @var{file}.s
1128 Assembler code.
1129
1130 @item @var{file}.S
1131 @itemx @var{file}.sx
1132 Assembler code which must be preprocessed.
1133
1134 @item @var{other}
1135 An object file to be fed straight into linking.
1136 Any file name with no recognized suffix is treated this way.
1137 @end table
1138
1139 @opindex x
1140 You can specify the input language explicitly with the @option{-x} option:
1141
1142 @table @gcctabopt
1143 @item -x @var{language}
1144 Specify explicitly the @var{language} for the following input files
1145 (rather than letting the compiler choose a default based on the file
1146 name suffix).  This option applies to all following input files until
1147 the next @option{-x} option.  Possible values for @var{language} are:
1148 @smallexample
1149 c  c-header  cpp-output
1150 c++  c++-header  c++-cpp-output
1151 objective-c  objective-c-header  objective-c-cpp-output
1152 objective-c++ objective-c++-header objective-c++-cpp-output
1153 assembler  assembler-with-cpp
1154 ada
1155 f77  f77-cpp-input f95  f95-cpp-input
1156 go
1157 java
1158 @end smallexample
1159
1160 @item -x none
1161 Turn off any specification of a language, so that subsequent files are
1162 handled according to their file name suffixes (as they are if @option{-x}
1163 has not been used at all).
1164
1165 @item -pass-exit-codes
1166 @opindex pass-exit-codes
1167 Normally the @command{gcc} program will exit with the code of 1 if any
1168 phase of the compiler returns a non-success return code.  If you specify
1169 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1170 numerically highest error produced by any phase that returned an error
1171 indication.  The C, C++, and Fortran frontends return 4, if an internal
1172 compiler error is encountered.
1173 @end table
1174
1175 If you only want some of the stages of compilation, you can use
1176 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1177 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1178 @command{gcc} is to stop.  Note that some combinations (for example,
1179 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1180
1181 @table @gcctabopt
1182 @item -c
1183 @opindex c
1184 Compile or assemble the source files, but do not link.  The linking
1185 stage simply is not done.  The ultimate output is in the form of an
1186 object file for each source file.
1187
1188 By default, the object file name for a source file is made by replacing
1189 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1190
1191 Unrecognized input files, not requiring compilation or assembly, are
1192 ignored.
1193
1194 @item -S
1195 @opindex S
1196 Stop after the stage of compilation proper; do not assemble.  The output
1197 is in the form of an assembler code file for each non-assembler input
1198 file specified.
1199
1200 By default, the assembler file name for a source file is made by
1201 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1202
1203 Input files that don't require compilation are ignored.
1204
1205 @item -E
1206 @opindex E
1207 Stop after the preprocessing stage; do not run the compiler proper.  The
1208 output is in the form of preprocessed source code, which is sent to the
1209 standard output.
1210
1211 Input files which don't require preprocessing are ignored.
1212
1213 @cindex output file option
1214 @item -o @var{file}
1215 @opindex o
1216 Place output in file @var{file}.  This applies regardless to whatever
1217 sort of output is being produced, whether it be an executable file,
1218 an object file, an assembler file or preprocessed C code.
1219
1220 If @option{-o} is not specified, the default is to put an executable
1221 file in @file{a.out}, the object file for
1222 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1223 assembler file in @file{@var{source}.s}, a precompiled header file in
1224 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1225 standard output.
1226
1227 @item -v
1228 @opindex v
1229 Print (on standard error output) the commands executed to run the stages
1230 of compilation.  Also print the version number of the compiler driver
1231 program and of the preprocessor and the compiler proper.
1232
1233 @item -###
1234 @opindex ###
1235 Like @option{-v} except the commands are not executed and arguments
1236 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1237 This is useful for shell scripts to capture the driver-generated command lines.
1238
1239 @item -pipe
1240 @opindex pipe
1241 Use pipes rather than temporary files for communication between the
1242 various stages of compilation.  This fails to work on some systems where
1243 the assembler is unable to read from a pipe; but the GNU assembler has
1244 no trouble.
1245
1246 @item --help
1247 @opindex help
1248 Print (on the standard output) a description of the command line options
1249 understood by @command{gcc}.  If the @option{-v} option is also specified
1250 then @option{--help} will also be passed on to the various processes
1251 invoked by @command{gcc}, so that they can display the command line options
1252 they accept.  If the @option{-Wextra} option has also been specified
1253 (prior to the @option{--help} option), then command line options which
1254 have no documentation associated with them will also be displayed.
1255
1256 @item --target-help
1257 @opindex target-help
1258 Print (on the standard output) a description of target-specific command
1259 line options for each tool.  For some targets extra target-specific
1260 information may also be printed.
1261
1262 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1263 Print (on the standard output) a description of the command line
1264 options understood by the compiler that fit into all specified classes
1265 and qualifiers.  These are the supported classes:
1266
1267 @table @asis
1268 @item @samp{optimizers}
1269 This will display all of the optimization options supported by the
1270 compiler.
1271
1272 @item @samp{warnings}
1273 This will display all of the options controlling warning messages
1274 produced by the compiler.
1275
1276 @item @samp{target}
1277 This will display target-specific options.  Unlike the
1278 @option{--target-help} option however, target-specific options of the
1279 linker and assembler will not be displayed.  This is because those
1280 tools do not currently support the extended @option{--help=} syntax.
1281
1282 @item @samp{params}
1283 This will display the values recognized by the @option{--param}
1284 option.
1285
1286 @item @var{language}
1287 This will display the options supported for @var{language}, where
1288 @var{language} is the name of one of the languages supported in this
1289 version of GCC.
1290
1291 @item @samp{common}
1292 This will display the options that are common to all languages.
1293 @end table
1294
1295 These are the supported qualifiers:
1296
1297 @table @asis
1298 @item @samp{undocumented}
1299 Display only those options which are undocumented.
1300
1301 @item @samp{joined}
1302 Display options which take an argument that appears after an equal
1303 sign in the same continuous piece of text, such as:
1304 @samp{--help=target}.
1305
1306 @item @samp{separate}
1307 Display options which take an argument that appears as a separate word
1308 following the original option, such as: @samp{-o output-file}.
1309 @end table
1310
1311 Thus for example to display all the undocumented target-specific
1312 switches supported by the compiler the following can be used:
1313
1314 @smallexample
1315 --help=target,undocumented
1316 @end smallexample
1317
1318 The sense of a qualifier can be inverted by prefixing it with the
1319 @samp{^} character, so for example to display all binary warning
1320 options (i.e., ones that are either on or off and that do not take an
1321 argument), which have a description the following can be used:
1322
1323 @smallexample
1324 --help=warnings,^joined,^undocumented
1325 @end smallexample
1326
1327 The argument to @option{--help=} should not consist solely of inverted
1328 qualifiers.
1329
1330 Combining several classes is possible, although this usually
1331 restricts the output by so much that there is nothing to display.  One
1332 case where it does work however is when one of the classes is
1333 @var{target}.  So for example to display all the target-specific
1334 optimization options the following can be used:
1335
1336 @smallexample
1337 --help=target,optimizers
1338 @end smallexample
1339
1340 The @option{--help=} option can be repeated on the command line.  Each
1341 successive use will display its requested class of options, skipping
1342 those that have already been displayed.
1343
1344 If the @option{-Q} option appears on the command line before the
1345 @option{--help=} option, then the descriptive text displayed by
1346 @option{--help=} is changed.  Instead of describing the displayed
1347 options, an indication is given as to whether the option is enabled,
1348 disabled or set to a specific value (assuming that the compiler
1349 knows this at the point where the @option{--help=} option is used).
1350
1351 Here is a truncated example from the ARM port of @command{gcc}:
1352
1353 @smallexample
1354   % gcc -Q -mabi=2 --help=target -c
1355   The following options are target specific:
1356   -mabi=                                2
1357   -mabort-on-noreturn                   [disabled]
1358   -mapcs                                [disabled]
1359 @end smallexample
1360
1361 The output is sensitive to the effects of previous command line
1362 options, so for example it is possible to find out which optimizations
1363 are enabled at @option{-O2} by using:
1364
1365 @smallexample
1366 -Q -O2 --help=optimizers
1367 @end smallexample
1368
1369 Alternatively you can discover which binary optimizations are enabled
1370 by @option{-O3} by using:
1371
1372 @smallexample
1373 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1374 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1375 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1376 @end smallexample
1377
1378 @item -no-canonical-prefixes
1379 @opindex no-canonical-prefixes
1380 Do not expand any symbolic links, resolve references to @samp{/../}
1381 or @samp{/./}, or make the path absolute when generating a relative
1382 prefix.
1383
1384 @item --version
1385 @opindex version
1386 Display the version number and copyrights of the invoked GCC@.
1387
1388 @item -wrapper
1389 @opindex wrapper
1390 Invoke all subcommands under a wrapper program.  The name of the
1391 wrapper program and its parameters are passed as a comma separated
1392 list.
1393
1394 @smallexample
1395 gcc -c t.c -wrapper gdb,--args
1396 @end smallexample
1397
1398 This will invoke all subprograms of @command{gcc} under
1399 @samp{gdb --args}, thus the invocation of @command{cc1} will be
1400 @samp{gdb --args cc1 @dots{}}.
1401
1402 @item -fplugin=@var{name}.so
1403 Load the plugin code in file @var{name}.so, assumed to be a
1404 shared object to be dlopen'd by the compiler.  The base name of
1405 the shared object file is used to identify the plugin for the
1406 purposes of argument parsing (See
1407 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1408 Each plugin should define the callback functions specified in the
1409 Plugins API.
1410
1411 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1412 Define an argument called @var{key} with a value of @var{value}
1413 for the plugin called @var{name}.
1414
1415 @item -fdump-ada-spec@r{[}-slim@r{]}
1416 For C and C++ source and include files, generate corresponding Ada
1417 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1418 GNAT User's Guide}, which provides detailed documentation on this feature.
1419
1420 @item -fdump-go-spec=@var{file}
1421 For input files in any language, generate corresponding Go
1422 declarations in @var{file}.  This generates Go @code{const},
1423 @code{type}, @code{var}, and @code{func} declarations which may be a
1424 useful way to start writing a Go interface to code written in some
1425 other language.
1426
1427 @include @value{srcdir}/../libiberty/at-file.texi
1428 @end table
1429
1430 @node Invoking G++
1431 @section Compiling C++ Programs
1432
1433 @cindex suffixes for C++ source
1434 @cindex C++ source file suffixes
1435 C++ source files conventionally use one of the suffixes @samp{.C},
1436 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1437 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1438 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1439 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1440 files with these names and compiles them as C++ programs even if you
1441 call the compiler the same way as for compiling C programs (usually
1442 with the name @command{gcc}).
1443
1444 @findex g++
1445 @findex c++
1446 However, the use of @command{gcc} does not add the C++ library.
1447 @command{g++} is a program that calls GCC and treats @samp{.c},
1448 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1449 files unless @option{-x} is used, and automatically specifies linking
1450 against the C++ library.  This program is also useful when
1451 precompiling a C header file with a @samp{.h} extension for use in C++
1452 compilations.  On many systems, @command{g++} is also installed with
1453 the name @command{c++}.
1454
1455 @cindex invoking @command{g++}
1456 When you compile C++ programs, you may specify many of the same
1457 command-line options that you use for compiling programs in any
1458 language; or command-line options meaningful for C and related
1459 languages; or options that are meaningful only for C++ programs.
1460 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1461 explanations of options for languages related to C@.
1462 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1463 explanations of options that are meaningful only for C++ programs.
1464
1465 @node C Dialect Options
1466 @section Options Controlling C Dialect
1467 @cindex dialect options
1468 @cindex language dialect options
1469 @cindex options, dialect
1470
1471 The following options control the dialect of C (or languages derived
1472 from C, such as C++, Objective-C and Objective-C++) that the compiler
1473 accepts:
1474
1475 @table @gcctabopt
1476 @cindex ANSI support
1477 @cindex ISO support
1478 @item -ansi
1479 @opindex ansi
1480 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1481 equivalent to @samp{-std=c++98}.
1482
1483 This turns off certain features of GCC that are incompatible with ISO
1484 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1485 such as the @code{asm} and @code{typeof} keywords, and
1486 predefined macros such as @code{unix} and @code{vax} that identify the
1487 type of system you are using.  It also enables the undesirable and
1488 rarely used ISO trigraph feature.  For the C compiler,
1489 it disables recognition of C++ style @samp{//} comments as well as
1490 the @code{inline} keyword.
1491
1492 The alternate keywords @code{__asm__}, @code{__extension__},
1493 @code{__inline__} and @code{__typeof__} continue to work despite
1494 @option{-ansi}.  You would not want to use them in an ISO C program, of
1495 course, but it is useful to put them in header files that might be included
1496 in compilations done with @option{-ansi}.  Alternate predefined macros
1497 such as @code{__unix__} and @code{__vax__} are also available, with or
1498 without @option{-ansi}.
1499
1500 The @option{-ansi} option does not cause non-ISO programs to be
1501 rejected gratuitously.  For that, @option{-pedantic} is required in
1502 addition to @option{-ansi}.  @xref{Warning Options}.
1503
1504 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1505 option is used.  Some header files may notice this macro and refrain
1506 from declaring certain functions or defining certain macros that the
1507 ISO standard doesn't call for; this is to avoid interfering with any
1508 programs that might use these names for other things.
1509
1510 Functions that would normally be built in but do not have semantics
1511 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1512 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1513 built-in functions provided by GCC}, for details of the functions
1514 affected.
1515
1516 @item -std=
1517 @opindex std
1518 Determine the language standard. @xref{Standards,,Language Standards
1519 Supported by GCC}, for details of these standard versions.  This option
1520 is currently only supported when compiling C or C++.
1521
1522 The compiler can accept several base standards, such as @samp{c90} or
1523 @samp{c++98}, and GNU dialects of those standards, such as
1524 @samp{gnu90} or @samp{gnu++98}.  By specifying a base standard, the
1525 compiler will accept all programs following that standard and those
1526 using GNU extensions that do not contradict it.  For example,
1527 @samp{-std=c90} turns off certain features of GCC that are
1528 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1529 keywords, but not other GNU extensions that do not have a meaning in
1530 ISO C90, such as omitting the middle term of a @code{?:}
1531 expression. On the other hand, by specifying a GNU dialect of a
1532 standard, all features the compiler support are enabled, even when
1533 those features change the meaning of the base standard and some
1534 strict-conforming programs may be rejected.  The particular standard
1535 is used by @option{-pedantic} to identify which features are GNU
1536 extensions given that version of the standard. For example
1537 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1538 comments, while @samp{-std=gnu99 -pedantic} would not.
1539
1540 A value for this option must be provided; possible values are
1541
1542 @table @samp
1543 @item c90
1544 @itemx c89
1545 @itemx iso9899:1990
1546 Support all ISO C90 programs (certain GNU extensions that conflict
1547 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1548
1549 @item iso9899:199409
1550 ISO C90 as modified in amendment 1.
1551
1552 @item c99
1553 @itemx c9x
1554 @itemx iso9899:1999
1555 @itemx iso9899:199x
1556 ISO C99.  Note that this standard is not yet fully supported; see
1557 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1558 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1559
1560 @item c11
1561 @itemx c1x
1562 @itemx iso9899:2011
1563 ISO C11, the 2011 revision of the ISO C standard.
1564 Support is incomplete and experimental.  The name @samp{c1x} is
1565 deprecated.
1566
1567 @item gnu90
1568 @itemx gnu89
1569 GNU dialect of ISO C90 (including some C99 features). This
1570 is the default for C code.
1571
1572 @item gnu99
1573 @itemx gnu9x
1574 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1575 this will become the default.  The name @samp{gnu9x} is deprecated.
1576
1577 @item gnu11
1578 @item gnu1x
1579 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1580 name @samp{gnu1x} is deprecated.
1581
1582 @item c++98
1583 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1584 C++ code.
1585
1586 @item gnu++98
1587 GNU dialect of @option{-std=c++98}.  This is the default for
1588 C++ code.
1589
1590 @item c++11
1591 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1592 experimental, and may change in incompatible ways in future releases.
1593
1594 @item gnu++11
1595 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1596 experimental, and may change in incompatible ways in future releases.
1597 @end table
1598
1599 @item -fgnu89-inline
1600 @opindex fgnu89-inline
1601 The option @option{-fgnu89-inline} tells GCC to use the traditional
1602 GNU semantics for @code{inline} functions when in C99 mode.
1603 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1604 is accepted and ignored by GCC versions 4.1.3 up to but not including
1605 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1606 C99 mode.  Using this option is roughly equivalent to adding the
1607 @code{gnu_inline} function attribute to all inline functions
1608 (@pxref{Function Attributes}).
1609
1610 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1611 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1612 specifies the default behavior).  This option was first supported in
1613 GCC 4.3.  This option is not supported in @option{-std=c90} or
1614 @option{-std=gnu90} mode.
1615
1616 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1617 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1618 in effect for @code{inline} functions.  @xref{Common Predefined
1619 Macros,,,cpp,The C Preprocessor}.
1620
1621 @item -aux-info @var{filename}
1622 @opindex aux-info
1623 Output to the given filename prototyped declarations for all functions
1624 declared and/or defined in a translation unit, including those in header
1625 files.  This option is silently ignored in any language other than C@.
1626
1627 Besides declarations, the file indicates, in comments, the origin of
1628 each declaration (source file and line), whether the declaration was
1629 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1630 @samp{O} for old, respectively, in the first character after the line
1631 number and the colon), and whether it came from a declaration or a
1632 definition (@samp{C} or @samp{F}, respectively, in the following
1633 character).  In the case of function definitions, a K&R-style list of
1634 arguments followed by their declarations is also provided, inside
1635 comments, after the declaration.
1636
1637 @item -fallow-parameterless-variadic-functions
1638 Accept variadic functions without named parameters.
1639
1640 Although it is possible to define such a function, this is not very
1641 useful as it is not possible to read the arguments.  This is only
1642 supported for C as this construct is allowed by C++.
1643
1644 @item -fno-asm
1645 @opindex fno-asm
1646 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1647 keyword, so that code can use these words as identifiers.  You can use
1648 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1649 instead.  @option{-ansi} implies @option{-fno-asm}.
1650
1651 In C++, this switch only affects the @code{typeof} keyword, since
1652 @code{asm} and @code{inline} are standard keywords.  You may want to
1653 use the @option{-fno-gnu-keywords} flag instead, which has the same
1654 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1655 switch only affects the @code{asm} and @code{typeof} keywords, since
1656 @code{inline} is a standard keyword in ISO C99.
1657
1658 @item -fno-builtin
1659 @itemx -fno-builtin-@var{function}
1660 @opindex fno-builtin
1661 @cindex built-in functions
1662 Don't recognize built-in functions that do not begin with
1663 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1664 functions provided by GCC}, for details of the functions affected,
1665 including those which are not built-in functions when @option{-ansi} or
1666 @option{-std} options for strict ISO C conformance are used because they
1667 do not have an ISO standard meaning.
1668
1669 GCC normally generates special code to handle certain built-in functions
1670 more efficiently; for instance, calls to @code{alloca} may become single
1671 instructions that adjust the stack directly, and calls to @code{memcpy}
1672 may become inline copy loops.  The resulting code is often both smaller
1673 and faster, but since the function calls no longer appear as such, you
1674 cannot set a breakpoint on those calls, nor can you change the behavior
1675 of the functions by linking with a different library.  In addition,
1676 when a function is recognized as a built-in function, GCC may use
1677 information about that function to warn about problems with calls to
1678 that function, or to generate more efficient code, even if the
1679 resulting code still contains calls to that function.  For example,
1680 warnings are given with @option{-Wformat} for bad calls to
1681 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1682 known not to modify global memory.
1683
1684 With the @option{-fno-builtin-@var{function}} option
1685 only the built-in function @var{function} is
1686 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1687 function is named that is not built-in in this version of GCC, this
1688 option is ignored.  There is no corresponding
1689 @option{-fbuiltin-@var{function}} option; if you wish to enable
1690 built-in functions selectively when using @option{-fno-builtin} or
1691 @option{-ffreestanding}, you may define macros such as:
1692
1693 @smallexample
1694 #define abs(n)          __builtin_abs ((n))
1695 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1696 @end smallexample
1697
1698 @item -fhosted
1699 @opindex fhosted
1700 @cindex hosted environment
1701
1702 Assert that compilation takes place in a hosted environment.  This implies
1703 @option{-fbuiltin}.  A hosted environment is one in which the
1704 entire standard library is available, and in which @code{main} has a return
1705 type of @code{int}.  Examples are nearly everything except a kernel.
1706 This is equivalent to @option{-fno-freestanding}.
1707
1708 @item -ffreestanding
1709 @opindex ffreestanding
1710 @cindex hosted environment
1711
1712 Assert that compilation takes place in a freestanding environment.  This
1713 implies @option{-fno-builtin}.  A freestanding environment
1714 is one in which the standard library may not exist, and program startup may
1715 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1716 This is equivalent to @option{-fno-hosted}.
1717
1718 @xref{Standards,,Language Standards Supported by GCC}, for details of
1719 freestanding and hosted environments.
1720
1721 @item -fopenmp
1722 @opindex fopenmp
1723 @cindex OpenMP parallel
1724 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1725 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1726 compiler generates parallel code according to the OpenMP Application
1727 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1728 implies @option{-pthread}, and thus is only supported on targets that
1729 have support for @option{-pthread}.
1730
1731 @item -fgnu-tm
1732 @opindex fgnu-tm
1733 When the option @option{-fgnu-tm} is specified, the compiler will
1734 generate code for the Linux variant of Intel's current Transactional
1735 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1736 an experimental feature whose interface may change in future versions
1737 of GCC, as the official specification changes.  Please note that not
1738 all architectures are supported for this feature.
1739
1740 For more information on GCC's support for transactional memory,
1741 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1742 Transactional Memory Library}.
1743
1744 @item -fms-extensions
1745 @opindex fms-extensions
1746 Accept some non-standard constructs used in Microsoft header files.
1747
1748 In C++ code, this allows member names in structures to be similar
1749 to previous types declarations.
1750
1751 @smallexample
1752 typedef int UOW;
1753 struct ABC @{
1754   UOW UOW;
1755 @};
1756 @end smallexample
1757
1758 Some cases of unnamed fields in structures and unions are only
1759 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1760 fields within structs/unions}, for details.
1761
1762 @item -fplan9-extensions
1763 Accept some non-standard constructs used in Plan 9 code.
1764
1765 This enables @option{-fms-extensions}, permits passing pointers to
1766 structures with anonymous fields to functions which expect pointers to
1767 elements of the type of the field, and permits referring to anonymous
1768 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1769 struct/union fields within structs/unions}, for details.  This is only
1770 supported for C, not C++.
1771
1772 @item -trigraphs
1773 @opindex trigraphs
1774 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1775 options for strict ISO C conformance) implies @option{-trigraphs}.
1776
1777 @item -no-integrated-cpp
1778 @opindex no-integrated-cpp
1779 Performs a compilation in two passes: preprocessing and compiling.  This
1780 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1781 @option{-B} option.  The user supplied compilation step can then add in
1782 an additional preprocessing step after normal preprocessing but before
1783 compiling.  The default is to use the integrated cpp (internal cpp)
1784
1785 The semantics of this option will change if "cc1", "cc1plus", and
1786 "cc1obj" are merged.
1787
1788 @cindex traditional C language
1789 @cindex C language, traditional
1790 @item -traditional
1791 @itemx -traditional-cpp
1792 @opindex traditional-cpp
1793 @opindex traditional
1794 Formerly, these options caused GCC to attempt to emulate a pre-standard
1795 C compiler.  They are now only supported with the @option{-E} switch.
1796 The preprocessor continues to support a pre-standard mode.  See the GNU
1797 CPP manual for details.
1798
1799 @item -fcond-mismatch
1800 @opindex fcond-mismatch
1801 Allow conditional expressions with mismatched types in the second and
1802 third arguments.  The value of such an expression is void.  This option
1803 is not supported for C++.
1804
1805 @item -flax-vector-conversions
1806 @opindex flax-vector-conversions
1807 Allow implicit conversions between vectors with differing numbers of
1808 elements and/or incompatible element types.  This option should not be
1809 used for new code.
1810
1811 @item -funsigned-char
1812 @opindex funsigned-char
1813 Let the type @code{char} be unsigned, like @code{unsigned char}.
1814
1815 Each kind of machine has a default for what @code{char} should
1816 be.  It is either like @code{unsigned char} by default or like
1817 @code{signed char} by default.
1818
1819 Ideally, a portable program should always use @code{signed char} or
1820 @code{unsigned char} when it depends on the signedness of an object.
1821 But many programs have been written to use plain @code{char} and
1822 expect it to be signed, or expect it to be unsigned, depending on the
1823 machines they were written for.  This option, and its inverse, let you
1824 make such a program work with the opposite default.
1825
1826 The type @code{char} is always a distinct type from each of
1827 @code{signed char} or @code{unsigned char}, even though its behavior
1828 is always just like one of those two.
1829
1830 @item -fsigned-char
1831 @opindex fsigned-char
1832 Let the type @code{char} be signed, like @code{signed char}.
1833
1834 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1835 the negative form of @option{-funsigned-char}.  Likewise, the option
1836 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1837
1838 @item -fsigned-bitfields
1839 @itemx -funsigned-bitfields
1840 @itemx -fno-signed-bitfields
1841 @itemx -fno-unsigned-bitfields
1842 @opindex fsigned-bitfields
1843 @opindex funsigned-bitfields
1844 @opindex fno-signed-bitfields
1845 @opindex fno-unsigned-bitfields
1846 These options control whether a bit-field is signed or unsigned, when the
1847 declaration does not use either @code{signed} or @code{unsigned}.  By
1848 default, such a bit-field is signed, because this is consistent: the
1849 basic integer types such as @code{int} are signed types.
1850 @end table
1851
1852 @node C++ Dialect Options
1853 @section Options Controlling C++ Dialect
1854
1855 @cindex compiler options, C++
1856 @cindex C++ options, command line
1857 @cindex options, C++
1858 This section describes the command-line options that are only meaningful
1859 for C++ programs; but you can also use most of the GNU compiler options
1860 regardless of what language your program is in.  For example, you
1861 might compile a file @code{firstClass.C} like this:
1862
1863 @smallexample
1864 g++ -g -frepo -O -c firstClass.C
1865 @end smallexample
1866
1867 @noindent
1868 In this example, only @option{-frepo} is an option meant
1869 only for C++ programs; you can use the other options with any
1870 language supported by GCC@.
1871
1872 Here is a list of options that are @emph{only} for compiling C++ programs:
1873
1874 @table @gcctabopt
1875
1876 @item -fabi-version=@var{n}
1877 @opindex fabi-version
1878 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1879 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1880 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1881 the version that conforms most closely to the C++ ABI specification.
1882 Therefore, the ABI obtained using version 0 will change as ABI bugs
1883 are fixed.
1884
1885 The default is version 2.
1886
1887 Version 3 corrects an error in mangling a constant address as a
1888 template argument.
1889
1890 Version 4 implements a standard mangling for vector types.
1891
1892 Version 5 corrects the mangling of attribute const/volatile on
1893 function pointer types, decltype of a plain decl, and use of a
1894 function parameter in the declaration of another parameter.
1895
1896 Version 6 corrects the promotion behavior of C++11 scoped enums.
1897
1898 See also @option{-Wabi}.
1899
1900 @item -fno-access-control
1901 @opindex fno-access-control
1902 Turn off all access checking.  This switch is mainly useful for working
1903 around bugs in the access control code.
1904
1905 @item -fcheck-new
1906 @opindex fcheck-new
1907 Check that the pointer returned by @code{operator new} is non-null
1908 before attempting to modify the storage allocated.  This check is
1909 normally unnecessary because the C++ standard specifies that
1910 @code{operator new} will only return @code{0} if it is declared
1911 @samp{throw()}, in which case the compiler will always check the
1912 return value even without this option.  In all other cases, when
1913 @code{operator new} has a non-empty exception specification, memory
1914 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1915 @samp{new (nothrow)}.
1916
1917 @item -fconserve-space
1918 @opindex fconserve-space
1919 Put uninitialized or runtime-initialized global variables into the
1920 common segment, as C does.  This saves space in the executable at the
1921 cost of not diagnosing duplicate definitions.  If you compile with this
1922 flag and your program mysteriously crashes after @code{main()} has
1923 completed, you may have an object that is being destroyed twice because
1924 two definitions were merged.
1925
1926 This option is no longer useful on most targets, now that support has
1927 been added for putting variables into BSS without making them common.
1928
1929 @item -fconstexpr-depth=@var{n}
1930 @opindex fconstexpr-depth
1931 Set the maximum nested evaluation depth for C++11 constexpr functions
1932 to @var{n}.  A limit is needed to detect endless recursion during
1933 constant expression evaluation.  The minimum specified by the standard
1934 is 512.
1935
1936 @item -fdeduce-init-list
1937 @opindex fdeduce-init-list
1938 Enable deduction of a template type parameter as
1939 std::initializer_list from a brace-enclosed initializer list, i.e.
1940
1941 @smallexample
1942 template <class T> auto forward(T t) -> decltype (realfn (t))
1943 @{
1944   return realfn (t);
1945 @}
1946
1947 void f()
1948 @{
1949   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1950 @}
1951 @end smallexample
1952
1953 This deduction was implemented as a possible extension to the
1954 originally proposed semantics for the C++11 standard, but was not part
1955 of the final standard, so it is disabled by default.  This option is
1956 deprecated, and may be removed in a future version of G++.
1957
1958 @item -ffriend-injection
1959 @opindex ffriend-injection
1960 Inject friend functions into the enclosing namespace, so that they are
1961 visible outside the scope of the class in which they are declared.
1962 Friend functions were documented to work this way in the old Annotated
1963 C++ Reference Manual, and versions of G++ before 4.1 always worked
1964 that way.  However, in ISO C++ a friend function which is not declared
1965 in an enclosing scope can only be found using argument dependent
1966 lookup.  This option causes friends to be injected as they were in
1967 earlier releases.
1968
1969 This option is for compatibility, and may be removed in a future
1970 release of G++.
1971
1972 @item -fno-elide-constructors
1973 @opindex fno-elide-constructors
1974 The C++ standard allows an implementation to omit creating a temporary
1975 which is only used to initialize another object of the same type.
1976 Specifying this option disables that optimization, and forces G++ to
1977 call the copy constructor in all cases.
1978
1979 @item -fno-enforce-eh-specs
1980 @opindex fno-enforce-eh-specs
1981 Don't generate code to check for violation of exception specifications
1982 at runtime.  This option violates the C++ standard, but may be useful
1983 for reducing code size in production builds, much like defining
1984 @samp{NDEBUG}.  This does not give user code permission to throw
1985 exceptions in violation of the exception specifications; the compiler
1986 will still optimize based on the specifications, so throwing an
1987 unexpected exception will result in undefined behavior.
1988
1989 @item -ffor-scope
1990 @itemx -fno-for-scope
1991 @opindex ffor-scope
1992 @opindex fno-for-scope
1993 If @option{-ffor-scope} is specified, the scope of variables declared in
1994 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1995 as specified by the C++ standard.
1996 If @option{-fno-for-scope} is specified, the scope of variables declared in
1997 a @i{for-init-statement} extends to the end of the enclosing scope,
1998 as was the case in old versions of G++, and other (traditional)
1999 implementations of C++.
2000
2001 The default if neither flag is given to follow the standard,
2002 but to allow and give a warning for old-style code that would
2003 otherwise be invalid, or have different behavior.
2004
2005 @item -fno-gnu-keywords
2006 @opindex fno-gnu-keywords
2007 Do not recognize @code{typeof} as a keyword, so that code can use this
2008 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2009 @option{-ansi} implies @option{-fno-gnu-keywords}.
2010
2011 @item -fno-implicit-templates
2012 @opindex fno-implicit-templates
2013 Never emit code for non-inline templates which are instantiated
2014 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2015 @xref{Template Instantiation}, for more information.
2016
2017 @item -fno-implicit-inline-templates
2018 @opindex fno-implicit-inline-templates
2019 Don't emit code for implicit instantiations of inline templates, either.
2020 The default is to handle inlines differently so that compiles with and
2021 without optimization will need the same set of explicit instantiations.
2022
2023 @item -fno-implement-inlines
2024 @opindex fno-implement-inlines
2025 To save space, do not emit out-of-line copies of inline functions
2026 controlled by @samp{#pragma implementation}.  This will cause linker
2027 errors if these functions are not inlined everywhere they are called.
2028
2029 @item -fms-extensions
2030 @opindex fms-extensions
2031 Disable pedantic warnings about constructs used in MFC, such as implicit
2032 int and getting a pointer to member function via non-standard syntax.
2033
2034 @item -fno-nonansi-builtins
2035 @opindex fno-nonansi-builtins
2036 Disable built-in declarations of functions that are not mandated by
2037 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2038 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2039
2040 @item -fnothrow-opt
2041 @opindex fnothrow-opt
2042 Treat a @code{throw()} exception specification as though it were a
2043 @code{noexcept} specification to reduce or eliminate the text size
2044 overhead relative to a function with no exception specification.  If
2045 the function has local variables of types with non-trivial
2046 destructors, the exception specification will actually make the
2047 function smaller because the EH cleanups for those variables can be
2048 optimized away.  The semantic effect is that an exception thrown out of
2049 a function with such an exception specification will result in a call
2050 to @code{terminate} rather than @code{unexpected}.
2051
2052 @item -fno-operator-names
2053 @opindex fno-operator-names
2054 Do not treat the operator name keywords @code{and}, @code{bitand},
2055 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2056 synonyms as keywords.
2057
2058 @item -fno-optional-diags
2059 @opindex fno-optional-diags
2060 Disable diagnostics that the standard says a compiler does not need to
2061 issue.  Currently, the only such diagnostic issued by G++ is the one for
2062 a name having multiple meanings within a class.
2063
2064 @item -fpermissive
2065 @opindex fpermissive
2066 Downgrade some diagnostics about nonconformant code from errors to
2067 warnings.  Thus, using @option{-fpermissive} will allow some
2068 nonconforming code to compile.
2069
2070 @item -fno-pretty-templates
2071 @opindex fno-pretty-templates
2072 When an error message refers to a specialization of a function
2073 template, the compiler will normally print the signature of the
2074 template followed by the template arguments and any typedefs or
2075 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2076 rather than @code{void f(int)}) so that it's clear which template is
2077 involved.  When an error message refers to a specialization of a class
2078 template, the compiler will omit any template arguments which match
2079 the default template arguments for that template.  If either of these
2080 behaviors make it harder to understand the error message rather than
2081 easier, using @option{-fno-pretty-templates} will disable them.
2082
2083 @item -frepo
2084 @opindex frepo
2085 Enable automatic template instantiation at link time.  This option also
2086 implies @option{-fno-implicit-templates}.  @xref{Template
2087 Instantiation}, for more information.
2088
2089 @item -fno-rtti
2090 @opindex fno-rtti
2091 Disable generation of information about every class with virtual
2092 functions for use by the C++ runtime type identification features
2093 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2094 of the language, you can save some space by using this flag.  Note that
2095 exception handling uses the same information, but it will generate it as
2096 needed. The @samp{dynamic_cast} operator can still be used for casts that
2097 do not require runtime type information, i.e.@: casts to @code{void *} or to
2098 unambiguous base classes.
2099
2100 @item -fstats
2101 @opindex fstats
2102 Emit statistics about front-end processing at the end of the compilation.
2103 This information is generally only useful to the G++ development team.
2104
2105 @item -fstrict-enums
2106 @opindex fstrict-enums
2107 Allow the compiler to optimize using the assumption that a value of
2108 enumeration type can only be one of the values of the enumeration (as
2109 defined in the C++ standard; basically, a value which can be
2110 represented in the minimum number of bits needed to represent all the
2111 enumerators).  This assumption may not be valid if the program uses a
2112 cast to convert an arbitrary integer value to the enumeration type.
2113
2114 @item -ftemplate-depth=@var{n}
2115 @opindex ftemplate-depth
2116 Set the maximum instantiation depth for template classes to @var{n}.
2117 A limit on the template instantiation depth is needed to detect
2118 endless recursions during template class instantiation.  ANSI/ISO C++
2119 conforming programs must not rely on a maximum depth greater than 17
2120 (changed to 1024 in C++11).  The default value is 900, as the compiler
2121 can run out of stack space before hitting 1024 in some situations.
2122
2123 @item -fno-threadsafe-statics
2124 @opindex fno-threadsafe-statics
2125 Do not emit the extra code to use the routines specified in the C++
2126 ABI for thread-safe initialization of local statics.  You can use this
2127 option to reduce code size slightly in code that doesn't need to be
2128 thread-safe.
2129
2130 @item -fuse-cxa-atexit
2131 @opindex fuse-cxa-atexit
2132 Register destructors for objects with static storage duration with the
2133 @code{__cxa_atexit} function rather than the @code{atexit} function.
2134 This option is required for fully standards-compliant handling of static
2135 destructors, but will only work if your C library supports
2136 @code{__cxa_atexit}.
2137
2138 @item -fno-use-cxa-get-exception-ptr
2139 @opindex fno-use-cxa-get-exception-ptr
2140 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2141 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2142 if the runtime routine is not available.
2143
2144 @item -fvisibility-inlines-hidden
2145 @opindex fvisibility-inlines-hidden
2146 This switch declares that the user does not attempt to compare
2147 pointers to inline functions or methods where the addresses of the two functions
2148 were taken in different shared objects.
2149
2150 The effect of this is that GCC may, effectively, mark inline methods with
2151 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2152 appear in the export table of a DSO and do not require a PLT indirection
2153 when used within the DSO@.  Enabling this option can have a dramatic effect
2154 on load and link times of a DSO as it massively reduces the size of the
2155 dynamic export table when the library makes heavy use of templates.
2156
2157 The behavior of this switch is not quite the same as marking the
2158 methods as hidden directly, because it does not affect static variables
2159 local to the function or cause the compiler to deduce that
2160 the function is defined in only one shared object.
2161
2162 You may mark a method as having a visibility explicitly to negate the
2163 effect of the switch for that method.  For example, if you do want to
2164 compare pointers to a particular inline method, you might mark it as
2165 having default visibility.  Marking the enclosing class with explicit
2166 visibility will have no effect.
2167
2168 Explicitly instantiated inline methods are unaffected by this option
2169 as their linkage might otherwise cross a shared library boundary.
2170 @xref{Template Instantiation}.
2171
2172 @item -fvisibility-ms-compat
2173 @opindex fvisibility-ms-compat
2174 This flag attempts to use visibility settings to make GCC's C++
2175 linkage model compatible with that of Microsoft Visual Studio.
2176
2177 The flag makes these changes to GCC's linkage model:
2178
2179 @enumerate
2180 @item
2181 It sets the default visibility to @code{hidden}, like
2182 @option{-fvisibility=hidden}.
2183
2184 @item
2185 Types, but not their members, are not hidden by default.
2186
2187 @item
2188 The One Definition Rule is relaxed for types without explicit
2189 visibility specifications which are defined in more than one different
2190 shared object: those declarations are permitted if they would have
2191 been permitted when this option was not used.
2192 @end enumerate
2193
2194 In new code it is better to use @option{-fvisibility=hidden} and
2195 export those classes which are intended to be externally visible.
2196 Unfortunately it is possible for code to rely, perhaps accidentally,
2197 on the Visual Studio behavior.
2198
2199 Among the consequences of these changes are that static data members
2200 of the same type with the same name but defined in different shared
2201 objects will be different, so changing one will not change the other;
2202 and that pointers to function members defined in different shared
2203 objects may not compare equal.  When this flag is given, it is a
2204 violation of the ODR to define types with the same name differently.
2205
2206 @item -fno-weak
2207 @opindex fno-weak
2208 Do not use weak symbol support, even if it is provided by the linker.
2209 By default, G++ will use weak symbols if they are available.  This
2210 option exists only for testing, and should not be used by end-users;
2211 it will result in inferior code and has no benefits.  This option may
2212 be removed in a future release of G++.
2213
2214 @item -nostdinc++
2215 @opindex nostdinc++
2216 Do not search for header files in the standard directories specific to
2217 C++, but do still search the other standard directories.  (This option
2218 is used when building the C++ library.)
2219 @end table
2220
2221 In addition, these optimization, warning, and code generation options
2222 have meanings only for C++ programs:
2223
2224 @table @gcctabopt
2225 @item -fno-default-inline
2226 @opindex fno-default-inline
2227 Do not assume @samp{inline} for functions defined inside a class scope.
2228 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2229 functions will have linkage like inline functions; they just won't be
2230 inlined by default.
2231
2232 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2233 @opindex Wabi
2234 @opindex Wno-abi
2235 Warn when G++ generates code that is probably not compatible with the
2236 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2237 all such cases, there are probably some cases that are not warned about,
2238 even though G++ is generating incompatible code.  There may also be
2239 cases where warnings are emitted even though the code that is generated
2240 will be compatible.
2241
2242 You should rewrite your code to avoid these warnings if you are
2243 concerned about the fact that code generated by G++ may not be binary
2244 compatible with code generated by other compilers.
2245
2246 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2247
2248 @itemize @bullet
2249
2250 @item
2251 A template with a non-type template parameter of reference type is
2252 mangled incorrectly:
2253 @smallexample
2254 extern int N;
2255 template <int &> struct S @{@};
2256 void n (S<N>) @{2@}
2257 @end smallexample
2258
2259 This is fixed in @option{-fabi-version=3}.
2260
2261 @item
2262 SIMD vector types declared using @code{__attribute ((vector_size))} are
2263 mangled in a non-standard way that does not allow for overloading of
2264 functions taking vectors of different sizes.
2265
2266 The mangling is changed in @option{-fabi-version=4}.
2267 @end itemize
2268
2269 The known incompatibilities in @option{-fabi-version=1} include:
2270
2271 @itemize @bullet
2272
2273 @item
2274 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2275 pack data into the same byte as a base class.  For example:
2276
2277 @smallexample
2278 struct A @{ virtual void f(); int f1 : 1; @};
2279 struct B : public A @{ int f2 : 1; @};
2280 @end smallexample
2281
2282 @noindent
2283 In this case, G++ will place @code{B::f2} into the same byte
2284 as@code{A::f1}; other compilers will not.  You can avoid this problem
2285 by explicitly padding @code{A} so that its size is a multiple of the
2286 byte size on your platform; that will cause G++ and other compilers to
2287 layout @code{B} identically.
2288
2289 @item
2290 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2291 tail padding when laying out virtual bases.  For example:
2292
2293 @smallexample
2294 struct A @{ virtual void f(); char c1; @};
2295 struct B @{ B(); char c2; @};
2296 struct C : public A, public virtual B @{@};
2297 @end smallexample
2298
2299 @noindent
2300 In this case, G++ will not place @code{B} into the tail-padding for
2301 @code{A}; other compilers will.  You can avoid this problem by
2302 explicitly padding @code{A} so that its size is a multiple of its
2303 alignment (ignoring virtual base classes); that will cause G++ and other
2304 compilers to layout @code{C} identically.
2305
2306 @item
2307 Incorrect handling of bit-fields with declared widths greater than that
2308 of their underlying types, when the bit-fields appear in a union.  For
2309 example:
2310
2311 @smallexample
2312 union U @{ int i : 4096; @};
2313 @end smallexample
2314
2315 @noindent
2316 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2317 union too small by the number of bits in an @code{int}.
2318
2319 @item
2320 Empty classes can be placed at incorrect offsets.  For example:
2321
2322 @smallexample
2323 struct A @{@};
2324
2325 struct B @{
2326   A a;
2327   virtual void f ();
2328 @};
2329
2330 struct C : public B, public A @{@};
2331 @end smallexample
2332
2333 @noindent
2334 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2335 it should be placed at offset zero.  G++ mistakenly believes that the
2336 @code{A} data member of @code{B} is already at offset zero.
2337
2338 @item
2339 Names of template functions whose types involve @code{typename} or
2340 template template parameters can be mangled incorrectly.
2341
2342 @smallexample
2343 template <typename Q>
2344 void f(typename Q::X) @{@}
2345
2346 template <template <typename> class Q>
2347 void f(typename Q<int>::X) @{@}
2348 @end smallexample
2349
2350 @noindent
2351 Instantiations of these templates may be mangled incorrectly.
2352
2353 @end itemize
2354
2355 It also warns psABI related changes.  The known psABI changes at this
2356 point include:
2357
2358 @itemize @bullet
2359
2360 @item
2361 For SYSV/x86-64, when passing union with long double, it is changed to
2362 pass in memory as specified in psABI.  For example:
2363
2364 @smallexample
2365 union U @{
2366   long double ld;
2367   int i;
2368 @};
2369 @end smallexample
2370
2371 @noindent
2372 @code{union U} will always be passed in memory.
2373
2374 @end itemize
2375
2376 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2377 @opindex Wctor-dtor-privacy
2378 @opindex Wno-ctor-dtor-privacy
2379 Warn when a class seems unusable because all the constructors or
2380 destructors in that class are private, and it has neither friends nor
2381 public static member functions.
2382
2383 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2384 @opindex Wdelete-non-virtual-dtor
2385 @opindex Wno-delete-non-virtual-dtor
2386 Warn when @samp{delete} is used to destroy an instance of a class which
2387 has virtual functions and non-virtual destructor. It is unsafe to delete
2388 an instance of a derived class through a pointer to a base class if the
2389 base class does not have a virtual destructor.  This warning is enabled
2390 by @option{-Wall}.
2391
2392 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2393 @opindex Wnarrowing
2394 @opindex Wno-narrowing
2395 Warn when a narrowing conversion prohibited by C++11 occurs within
2396 @samp{@{ @}}, e.g.
2397
2398 @smallexample
2399 int i = @{ 2.2 @}; // error: narrowing from double to int
2400 @end smallexample
2401
2402 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2403
2404 With -std=c++11, @option{-Wno-narrowing} suppresses the diagnostic
2405 required by the standard.  Note that this does not affect the meaning
2406 of well-formed code; narrowing conversions are still considered
2407 ill-formed in SFINAE context.
2408
2409 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2410 @opindex Wnoexcept
2411 @opindex Wno-noexcept
2412 Warn when a noexcept-expression evaluates to false because of a call
2413 to a function that does not have a non-throwing exception
2414 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2415 the compiler to never throw an exception.
2416
2417 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2418 @opindex Wnon-virtual-dtor
2419 @opindex Wno-non-virtual-dtor
2420 Warn when a class has virtual functions and accessible non-virtual
2421 destructor, in which case it would be possible but unsafe to delete
2422 an instance of a derived class through a pointer to the base class.
2423 This warning is also enabled if -Weffc++ is specified.
2424
2425 @item -Wreorder @r{(C++ and Objective-C++ only)}
2426 @opindex Wreorder
2427 @opindex Wno-reorder
2428 @cindex reordering, warning
2429 @cindex warning for reordering of member initializers
2430 Warn when the order of member initializers given in the code does not
2431 match the order in which they must be executed.  For instance:
2432
2433 @smallexample
2434 struct A @{
2435   int i;
2436   int j;
2437   A(): j (0), i (1) @{ @}
2438 @};
2439 @end smallexample
2440
2441 The compiler will rearrange the member initializers for @samp{i}
2442 and @samp{j} to match the declaration order of the members, emitting
2443 a warning to that effect.  This warning is enabled by @option{-Wall}.
2444 @end table
2445
2446 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2447
2448 @table @gcctabopt
2449 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2450 @opindex Weffc++
2451 @opindex Wno-effc++
2452 Warn about violations of the following style guidelines from Scott Meyers'
2453 @cite{Effective C++} book:
2454
2455 @itemize @bullet
2456 @item
2457 Item 11:  Define a copy constructor and an assignment operator for classes
2458 with dynamically allocated memory.
2459
2460 @item
2461 Item 12:  Prefer initialization to assignment in constructors.
2462
2463 @item
2464 Item 14:  Make destructors virtual in base classes.
2465
2466 @item
2467 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2468
2469 @item
2470 Item 23:  Don't try to return a reference when you must return an object.
2471
2472 @end itemize
2473
2474 Also warn about violations of the following style guidelines from
2475 Scott Meyers' @cite{More Effective C++} book:
2476
2477 @itemize @bullet
2478 @item
2479 Item 6:  Distinguish between prefix and postfix forms of increment and
2480 decrement operators.
2481
2482 @item
2483 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2484
2485 @end itemize
2486
2487 When selecting this option, be aware that the standard library
2488 headers do not obey all of these guidelines; use @samp{grep -v}
2489 to filter out those warnings.
2490
2491 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2492 @opindex Wstrict-null-sentinel
2493 @opindex Wno-strict-null-sentinel
2494 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2495 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2496 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2497 it is guaranteed to be of the same size as a pointer.  But this use is
2498 not portable across different compilers.
2499
2500 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2501 @opindex Wno-non-template-friend
2502 @opindex Wnon-template-friend
2503 Disable warnings when non-templatized friend functions are declared
2504 within a template.  Since the advent of explicit template specification
2505 support in G++, if the name of the friend is an unqualified-id (i.e.,
2506 @samp{friend foo(int)}), the C++ language specification demands that the
2507 friend declare or define an ordinary, nontemplate function.  (Section
2508 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2509 could be interpreted as a particular specialization of a templatized
2510 function.  Because this non-conforming behavior is no longer the default
2511 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2512 check existing code for potential trouble spots and is on by default.
2513 This new compiler behavior can be turned off with
2514 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2515 but disables the helpful warning.
2516
2517 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2518 @opindex Wold-style-cast
2519 @opindex Wno-old-style-cast
2520 Warn if an old-style (C-style) cast to a non-void type is used within
2521 a C++ program.  The new-style casts (@samp{dynamic_cast},
2522 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2523 less vulnerable to unintended effects and much easier to search for.
2524
2525 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2526 @opindex Woverloaded-virtual
2527 @opindex Wno-overloaded-virtual
2528 @cindex overloaded virtual function, warning
2529 @cindex warning for overloaded virtual function
2530 Warn when a function declaration hides virtual functions from a
2531 base class.  For example, in:
2532
2533 @smallexample
2534 struct A @{
2535   virtual void f();
2536 @};
2537
2538 struct B: public A @{
2539   void f(int);
2540 @};
2541 @end smallexample
2542
2543 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2544 like:
2545
2546 @smallexample
2547 B* b;
2548 b->f();
2549 @end smallexample
2550
2551 will fail to compile.
2552
2553 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2554 @opindex Wno-pmf-conversions
2555 @opindex Wpmf-conversions
2556 Disable the diagnostic for converting a bound pointer to member function
2557 to a plain pointer.
2558
2559 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2560 @opindex Wsign-promo
2561 @opindex Wno-sign-promo
2562 Warn when overload resolution chooses a promotion from unsigned or
2563 enumerated type to a signed type, over a conversion to an unsigned type of
2564 the same size.  Previous versions of G++ would try to preserve
2565 unsignedness, but the standard mandates the current behavior.
2566
2567 @smallexample
2568 struct A @{
2569   operator int ();
2570   A& operator = (int);
2571 @};
2572
2573 main ()
2574 @{
2575   A a,b;
2576   a = b;
2577 @}
2578 @end smallexample
2579
2580 In this example, G++ will synthesize a default @samp{A& operator =
2581 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2582 @end table
2583
2584 @node Objective-C and Objective-C++ Dialect Options
2585 @section Options Controlling Objective-C and Objective-C++ Dialects
2586
2587 @cindex compiler options, Objective-C and Objective-C++
2588 @cindex Objective-C and Objective-C++ options, command line
2589 @cindex options, Objective-C and Objective-C++
2590 (NOTE: This manual does not describe the Objective-C and Objective-C++
2591 languages themselves.  @xref{Standards,,Language Standards
2592 Supported by GCC}, for references.)
2593
2594 This section describes the command-line options that are only meaningful
2595 for Objective-C and Objective-C++ programs, but you can also use most of
2596 the language-independent GNU compiler options.
2597 For example, you might compile a file @code{some_class.m} like this:
2598
2599 @smallexample
2600 gcc -g -fgnu-runtime -O -c some_class.m
2601 @end smallexample
2602
2603 @noindent
2604 In this example, @option{-fgnu-runtime} is an option meant only for
2605 Objective-C and Objective-C++ programs; you can use the other options with
2606 any language supported by GCC@.
2607
2608 Note that since Objective-C is an extension of the C language, Objective-C
2609 compilations may also use options specific to the C front-end (e.g.,
2610 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2611 C++-specific options (e.g., @option{-Wabi}).
2612
2613 Here is a list of options that are @emph{only} for compiling Objective-C
2614 and Objective-C++ programs:
2615
2616 @table @gcctabopt
2617 @item -fconstant-string-class=@var{class-name}
2618 @opindex fconstant-string-class
2619 Use @var{class-name} as the name of the class to instantiate for each
2620 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2621 class name is @code{NXConstantString} if the GNU runtime is being used, and
2622 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2623 @option{-fconstant-cfstrings} option, if also present, will override the
2624 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2625 to be laid out as constant CoreFoundation strings.
2626
2627 @item -fgnu-runtime
2628 @opindex fgnu-runtime
2629 Generate object code compatible with the standard GNU Objective-C
2630 runtime.  This is the default for most types of systems.
2631
2632 @item -fnext-runtime
2633 @opindex fnext-runtime
2634 Generate output compatible with the NeXT runtime.  This is the default
2635 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2636 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2637 used.
2638
2639 @item -fno-nil-receivers
2640 @opindex fno-nil-receivers
2641 Assume that all Objective-C message dispatches (@code{[receiver
2642 message:arg]}) in this translation unit ensure that the receiver is
2643 not @code{nil}.  This allows for more efficient entry points in the
2644 runtime to be used.  This option is only available in conjunction with
2645 the NeXT runtime and ABI version 0 or 1.
2646
2647 @item -fobjc-abi-version=@var{n}
2648 @opindex fobjc-abi-version
2649 Use version @var{n} of the Objective-C ABI for the selected runtime.
2650 This option is currently supported only for the NeXT runtime.  In that
2651 case, Version 0 is the traditional (32-bit) ABI without support for
2652 properties and other Objective-C 2.0 additions.  Version 1 is the
2653 traditional (32-bit) ABI with support for properties and other
2654 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2655 nothing is specified, the default is Version 0 on 32-bit target
2656 machines, and Version 2 on 64-bit target machines.
2657
2658 @item -fobjc-call-cxx-cdtors
2659 @opindex fobjc-call-cxx-cdtors
2660 For each Objective-C class, check if any of its instance variables is a
2661 C++ object with a non-trivial default constructor.  If so, synthesize a
2662 special @code{- (id) .cxx_construct} instance method that will run
2663 non-trivial default constructors on any such instance variables, in order,
2664 and then return @code{self}.  Similarly, check if any instance variable
2665 is a C++ object with a non-trivial destructor, and if so, synthesize a
2666 special @code{- (void) .cxx_destruct} method that will run
2667 all such default destructors, in reverse order.
2668
2669 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2670 methods thusly generated will only operate on instance variables
2671 declared in the current Objective-C class, and not those inherited
2672 from superclasses.  It is the responsibility of the Objective-C
2673 runtime to invoke all such methods in an object's inheritance
2674 hierarchy.  The @code{- (id) .cxx_construct} methods will be invoked
2675 by the runtime immediately after a new object instance is allocated;
2676 the @code{- (void) .cxx_destruct} methods will be invoked immediately
2677 before the runtime deallocates an object instance.
2678
2679 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2680 support for invoking the @code{- (id) .cxx_construct} and
2681 @code{- (void) .cxx_destruct} methods.
2682
2683 @item -fobjc-direct-dispatch
2684 @opindex fobjc-direct-dispatch
2685 Allow fast jumps to the message dispatcher.  On Darwin this is
2686 accomplished via the comm page.
2687
2688 @item -fobjc-exceptions
2689 @opindex fobjc-exceptions
2690 Enable syntactic support for structured exception handling in
2691 Objective-C, similar to what is offered by C++ and Java.  This option
2692 is required to use the Objective-C keywords @code{@@try},
2693 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2694 @code{@@synchronized}.  This option is available with both the GNU
2695 runtime and the NeXT runtime (but not available in conjunction with
2696 the NeXT runtime on Mac OS X 10.2 and earlier).
2697
2698 @item -fobjc-gc
2699 @opindex fobjc-gc
2700 Enable garbage collection (GC) in Objective-C and Objective-C++
2701 programs.  This option is only available with the NeXT runtime; the
2702 GNU runtime has a different garbage collection implementation that
2703 does not require special compiler flags.
2704
2705 @item -fobjc-nilcheck
2706 @opindex fobjc-nilcheck
2707 For the NeXT runtime with version 2 of the ABI, check for a nil
2708 receiver in method invocations before doing the actual method call.
2709 This is the default and can be disabled using
2710 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2711 checked for nil in this way no matter what this flag is set to.
2712 Currently this flag does nothing when the GNU runtime, or an older
2713 version of the NeXT runtime ABI, is used.
2714
2715 @item -fobjc-std=objc1
2716 @opindex fobjc-std
2717 Conform to the language syntax of Objective-C 1.0, the language
2718 recognized by GCC 4.0.  This only affects the Objective-C additions to
2719 the C/C++ language; it does not affect conformance to C/C++ standards,
2720 which is controlled by the separate C/C++ dialect option flags.  When
2721 this option is used with the Objective-C or Objective-C++ compiler,
2722 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2723 This is useful if you need to make sure that your Objective-C code can
2724 be compiled with older versions of GCC.
2725
2726 @item -freplace-objc-classes
2727 @opindex freplace-objc-classes
2728 Emit a special marker instructing @command{ld(1)} not to statically link in
2729 the resulting object file, and allow @command{dyld(1)} to load it in at
2730 run time instead.  This is used in conjunction with the Fix-and-Continue
2731 debugging mode, where the object file in question may be recompiled and
2732 dynamically reloaded in the course of program execution, without the need
2733 to restart the program itself.  Currently, Fix-and-Continue functionality
2734 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2735 and later.
2736
2737 @item -fzero-link
2738 @opindex fzero-link
2739 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2740 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2741 compile time) with static class references that get initialized at load time,
2742 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2743 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2744 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2745 for individual class implementations to be modified during program execution.
2746 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2747 regardless of command line options.
2748
2749 @item -gen-decls
2750 @opindex gen-decls
2751 Dump interface declarations for all classes seen in the source file to a
2752 file named @file{@var{sourcename}.decl}.
2753
2754 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2755 @opindex Wassign-intercept
2756 @opindex Wno-assign-intercept
2757 Warn whenever an Objective-C assignment is being intercepted by the
2758 garbage collector.
2759
2760 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2761 @opindex Wno-protocol
2762 @opindex Wprotocol
2763 If a class is declared to implement a protocol, a warning is issued for
2764 every method in the protocol that is not implemented by the class.  The
2765 default behavior is to issue a warning for every method not explicitly
2766 implemented in the class, even if a method implementation is inherited
2767 from the superclass.  If you use the @option{-Wno-protocol} option, then
2768 methods inherited from the superclass are considered to be implemented,
2769 and no warning is issued for them.
2770
2771 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2772 @opindex Wselector
2773 @opindex Wno-selector
2774 Warn if multiple methods of different types for the same selector are
2775 found during compilation.  The check is performed on the list of methods
2776 in the final stage of compilation.  Additionally, a check is performed
2777 for each selector appearing in a @code{@@selector(@dots{})}
2778 expression, and a corresponding method for that selector has been found
2779 during compilation.  Because these checks scan the method table only at
2780 the end of compilation, these warnings are not produced if the final
2781 stage of compilation is not reached, for example because an error is
2782 found during compilation, or because the @option{-fsyntax-only} option is
2783 being used.
2784
2785 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2786 @opindex Wstrict-selector-match
2787 @opindex Wno-strict-selector-match
2788 Warn if multiple methods with differing argument and/or return types are
2789 found for a given selector when attempting to send a message using this
2790 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2791 is off (which is the default behavior), the compiler will omit such warnings
2792 if any differences found are confined to types which share the same size
2793 and alignment.
2794
2795 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2796 @opindex Wundeclared-selector
2797 @opindex Wno-undeclared-selector
2798 Warn if a @code{@@selector(@dots{})} expression referring to an
2799 undeclared selector is found.  A selector is considered undeclared if no
2800 method with that name has been declared before the
2801 @code{@@selector(@dots{})} expression, either explicitly in an
2802 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2803 an @code{@@implementation} section.  This option always performs its
2804 checks as soon as a @code{@@selector(@dots{})} expression is found,
2805 while @option{-Wselector} only performs its checks in the final stage of
2806 compilation.  This also enforces the coding style convention
2807 that methods and selectors must be declared before being used.
2808
2809 @item -print-objc-runtime-info
2810 @opindex print-objc-runtime-info
2811 Generate C header describing the largest structure that is passed by
2812 value, if any.
2813
2814 @end table
2815
2816 @node Language Independent Options
2817 @section Options to Control Diagnostic Messages Formatting
2818 @cindex options to control diagnostics formatting
2819 @cindex diagnostic messages
2820 @cindex message formatting
2821
2822 Traditionally, diagnostic messages have been formatted irrespective of
2823 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2824 below can be used to control the diagnostic messages formatting
2825 algorithm, e.g.@: how many characters per line, how often source location
2826 information should be reported.  Right now, only the C++ front end can
2827 honor these options.  However it is expected, in the near future, that
2828 the remaining front ends would be able to digest them correctly.
2829
2830 @table @gcctabopt
2831 @item -fmessage-length=@var{n}
2832 @opindex fmessage-length
2833 Try to format error messages so that they fit on lines of about @var{n}
2834 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2835 the front ends supported by GCC@.  If @var{n} is zero, then no
2836 line-wrapping will be done; each error message will appear on a single
2837 line.
2838
2839 @opindex fdiagnostics-show-location
2840 @item -fdiagnostics-show-location=once
2841 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2842 reporter to emit @emph{once} source location information; that is, in
2843 case the message is too long to fit on a single physical line and has to
2844 be wrapped, the source location won't be emitted (as prefix) again,
2845 over and over, in subsequent continuation lines.  This is the default
2846 behavior.
2847
2848 @item -fdiagnostics-show-location=every-line
2849 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2850 messages reporter to emit the same source location information (as
2851 prefix) for physical lines that result from the process of breaking
2852 a message which is too long to fit on a single line.
2853
2854 @item -fno-diagnostics-show-option
2855 @opindex fno-diagnostics-show-option
2856 @opindex fdiagnostics-show-option
2857 By default, each diagnostic emitted includes text which indicates the
2858 command line option that directly controls the diagnostic (if such an
2859 option is known to the diagnostic machinery).  Specifying the
2860 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2861
2862 @item -Wcoverage-mismatch
2863 @opindex Wcoverage-mismatch
2864 Warn if feedback profiles do not match when using the
2865 @option{-fprofile-use} option.
2866 If a source file was changed between @option{-fprofile-gen} and
2867 @option{-fprofile-use}, the files with the profile feedback can fail
2868 to match the source file and GCC can not use the profile feedback
2869 information.  By default, this warning is enabled and is treated as an
2870 error.  @option{-Wno-coverage-mismatch} can be used to disable the
2871 warning or @option{-Wno-error=coverage-mismatch} can be used to
2872 disable the error.  Disable the error for this warning can result in
2873 poorly optimized code, so disabling the error is useful only in the
2874 case of very minor changes such as bug fixes to an existing code-base.
2875 Completely disabling the warning is not recommended.
2876
2877 @end table
2878
2879 @node Warning Options
2880 @section Options to Request or Suppress Warnings
2881 @cindex options to control warnings
2882 @cindex warning messages
2883 @cindex messages, warning
2884 @cindex suppressing warnings
2885
2886 Warnings are diagnostic messages that report constructions which
2887 are not inherently erroneous but which are risky or suggest there
2888 may have been an error.
2889
2890 The following language-independent options do not enable specific
2891 warnings but control the kinds of diagnostics produced by GCC.
2892
2893 @table @gcctabopt
2894 @cindex syntax checking
2895 @item -fsyntax-only
2896 @opindex fsyntax-only
2897 Check the code for syntax errors, but don't do anything beyond that.
2898
2899 @item -fmax-errors=@var{n}
2900 @opindex fmax-errors
2901 Limits the maximum number of error messages to @var{n}, at which point
2902 GCC bails out rather than attempting to continue processing the source
2903 code.  If @var{n} is 0 (the default), there is no limit on the number
2904 of error messages produced.  If @option{-Wfatal-errors} is also
2905 specified, then @option{-Wfatal-errors} takes precedence over this
2906 option.
2907
2908 @item -w
2909 @opindex w
2910 Inhibit all warning messages.
2911
2912 @item -Werror
2913 @opindex Werror
2914 @opindex Wno-error
2915 Make all warnings into errors.
2916
2917 @item -Werror=
2918 @opindex Werror=
2919 @opindex Wno-error=
2920 Make the specified warning into an error.  The specifier for a warning
2921 is appended, for example @option{-Werror=switch} turns the warnings
2922 controlled by @option{-Wswitch} into errors.  This switch takes a
2923 negative form, to be used to negate @option{-Werror} for specific
2924 warnings, for example @option{-Wno-error=switch} makes
2925 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2926 is in effect.
2927
2928 The warning message for each controllable warning includes the
2929 option which controls the warning.  That option can then be used with
2930 @option{-Werror=} and @option{-Wno-error=} as described above.
2931 (Printing of the option in the warning message can be disabled using the
2932 @option{-fno-diagnostics-show-option} flag.)
2933
2934 Note that specifying @option{-Werror=}@var{foo} automatically implies
2935 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2936 imply anything.
2937
2938 @item -Wfatal-errors
2939 @opindex Wfatal-errors
2940 @opindex Wno-fatal-errors
2941 This option causes the compiler to abort compilation on the first error
2942 occurred rather than trying to keep going and printing further error
2943 messages.
2944
2945 @end table
2946
2947 You can request many specific warnings with options beginning
2948 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2949 implicit declarations.  Each of these specific warning options also
2950 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2951 example, @option{-Wno-implicit}.  This manual lists only one of the
2952 two forms, whichever is not the default.  For further,
2953 language-specific options also refer to @ref{C++ Dialect Options} and
2954 @ref{Objective-C and Objective-C++ Dialect Options}.
2955
2956 When an unrecognized warning option is requested (e.g.,
2957 @option{-Wunknown-warning}), GCC will emit a diagnostic stating
2958 that the option is not recognized.  However, if the @option{-Wno-} form
2959 is used, the behavior is slightly different: No diagnostic will be
2960 produced for @option{-Wno-unknown-warning} unless other diagnostics
2961 are being produced.  This allows the use of new @option{-Wno-} options
2962 with old compilers, but if something goes wrong, the compiler will
2963 warn that an unrecognized option was used.
2964
2965 @table @gcctabopt
2966 @item -pedantic
2967 @opindex pedantic
2968 Issue all the warnings demanded by strict ISO C and ISO C++;
2969 reject all programs that use forbidden extensions, and some other
2970 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2971 version of the ISO C standard specified by any @option{-std} option used.
2972
2973 Valid ISO C and ISO C++ programs should compile properly with or without
2974 this option (though a rare few will require @option{-ansi} or a
2975 @option{-std} option specifying the required version of ISO C)@.  However,
2976 without this option, certain GNU extensions and traditional C and C++
2977 features are supported as well.  With this option, they are rejected.
2978
2979 @option{-pedantic} does not cause warning messages for use of the
2980 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2981 warnings are also disabled in the expression that follows
2982 @code{__extension__}.  However, only system header files should use
2983 these escape routes; application programs should avoid them.
2984 @xref{Alternate Keywords}.
2985
2986 Some users try to use @option{-pedantic} to check programs for strict ISO
2987 C conformance.  They soon find that it does not do quite what they want:
2988 it finds some non-ISO practices, but not all---only those for which
2989 ISO C @emph{requires} a diagnostic, and some others for which
2990 diagnostics have been added.
2991
2992 A feature to report any failure to conform to ISO C might be useful in
2993 some instances, but would require considerable additional work and would
2994 be quite different from @option{-pedantic}.  We don't have plans to
2995 support such a feature in the near future.
2996
2997 Where the standard specified with @option{-std} represents a GNU
2998 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
2999 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3000 extended dialect is based.  Warnings from @option{-pedantic} are given
3001 where they are required by the base standard.  (It would not make sense
3002 for such warnings to be given only for features not in the specified GNU
3003 C dialect, since by definition the GNU dialects of C include all
3004 features the compiler supports with the given option, and there would be
3005 nothing to warn about.)
3006
3007 @item -pedantic-errors
3008 @opindex pedantic-errors
3009 Like @option{-pedantic}, except that errors are produced rather than
3010 warnings.
3011
3012 @item -Wall
3013 @opindex Wall
3014 @opindex Wno-all
3015 This enables all the warnings about constructions that some users
3016 consider questionable, and that are easy to avoid (or modify to
3017 prevent the warning), even in conjunction with macros.  This also
3018 enables some language-specific warnings described in @ref{C++ Dialect
3019 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3020
3021 @option{-Wall} turns on the following warning flags:
3022
3023 @gccoptlist{-Waddress   @gol
3024 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3025 -Wc++11-compat  @gol
3026 -Wchar-subscripts  @gol
3027 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
3028 -Wimplicit-int @r{(C and Objective-C only)} @gol
3029 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3030 -Wcomment  @gol
3031 -Wformat   @gol
3032 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3033 -Wmaybe-uninitialized @gol
3034 -Wmissing-braces  @gol
3035 -Wnonnull  @gol
3036 -Wparentheses  @gol
3037 -Wpointer-sign  @gol
3038 -Wreorder   @gol
3039 -Wreturn-type  @gol
3040 -Wsequence-point  @gol
3041 -Wsign-compare @r{(only in C++)}  @gol
3042 -Wstrict-aliasing  @gol
3043 -Wstrict-overflow=1  @gol
3044 -Wswitch  @gol
3045 -Wtrigraphs  @gol
3046 -Wuninitialized  @gol
3047 -Wunknown-pragmas  @gol
3048 -Wunused-function  @gol
3049 -Wunused-label     @gol
3050 -Wunused-value     @gol
3051 -Wunused-variable  @gol
3052 -Wvolatile-register-var @gol
3053 }
3054
3055 Note that some warning flags are not implied by @option{-Wall}.  Some of
3056 them warn about constructions that users generally do not consider
3057 questionable, but which occasionally you might wish to check for;
3058 others warn about constructions that are necessary or hard to avoid in
3059 some cases, and there is no simple way to modify the code to suppress
3060 the warning. Some of them are enabled by @option{-Wextra} but many of
3061 them must be enabled individually.
3062
3063 @item -Wextra
3064 @opindex W
3065 @opindex Wextra
3066 @opindex Wno-extra
3067 This enables some extra warning flags that are not enabled by
3068 @option{-Wall}. (This option used to be called @option{-W}.  The older
3069 name is still supported, but the newer name is more descriptive.)
3070
3071 @gccoptlist{-Wclobbered  @gol
3072 -Wempty-body  @gol
3073 -Wignored-qualifiers @gol
3074 -Wmissing-field-initializers  @gol
3075 -Wmissing-parameter-type @r{(C only)}  @gol
3076 -Wold-style-declaration @r{(C only)}  @gol
3077 -Woverride-init  @gol
3078 -Wsign-compare  @gol
3079 -Wtype-limits  @gol
3080 -Wuninitialized  @gol
3081 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3082 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3083 }
3084
3085 The option @option{-Wextra} also prints warning messages for the
3086 following cases:
3087
3088 @itemize @bullet
3089
3090 @item
3091 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3092 @samp{>}, or @samp{>=}.
3093
3094 @item
3095 (C++ only) An enumerator and a non-enumerator both appear in a
3096 conditional expression.
3097
3098 @item
3099 (C++ only) Ambiguous virtual bases.
3100
3101 @item
3102 (C++ only) Subscripting an array which has been declared @samp{register}.
3103
3104 @item
3105 (C++ only) Taking the address of a variable which has been declared
3106 @samp{register}.
3107
3108 @item
3109 (C++ only) A base class is not initialized in a derived class' copy
3110 constructor.
3111
3112 @end itemize
3113
3114 @item -Wchar-subscripts
3115 @opindex Wchar-subscripts
3116 @opindex Wno-char-subscripts
3117 Warn if an array subscript has type @code{char}.  This is a common cause
3118 of error, as programmers often forget that this type is signed on some
3119 machines.
3120 This warning is enabled by @option{-Wall}.
3121
3122 @item -Wcomment
3123 @opindex Wcomment
3124 @opindex Wno-comment
3125 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3126 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3127 This warning is enabled by @option{-Wall}.
3128
3129 @item -Wno-cpp
3130 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3131
3132 Suppress warning messages emitted by @code{#warning} directives.
3133
3134 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3135 @opindex Wdouble-promotion
3136 @opindex Wno-double-promotion
3137 Give a warning when a value of type @code{float} is implicitly
3138 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3139 floating-point unit implement @code{float} in hardware, but emulate
3140 @code{double} in software.  On such a machine, doing computations
3141 using @code{double} values is much more expensive because of the
3142 overhead required for software emulation.
3143
3144 It is easy to accidentally do computations with @code{double} because
3145 floating-point literals are implicitly of type @code{double}.  For
3146 example, in:
3147 @smallexample
3148 @group
3149 float area(float radius)
3150 @{
3151    return 3.14159 * radius * radius;
3152 @}
3153 @end group
3154 @end smallexample
3155 the compiler will perform the entire computation with @code{double}
3156 because the floating-point literal is a @code{double}.
3157
3158 @item -Wformat
3159 @opindex Wformat
3160 @opindex Wno-format
3161 @opindex ffreestanding
3162 @opindex fno-builtin
3163 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3164 the arguments supplied have types appropriate to the format string
3165 specified, and that the conversions specified in the format string make
3166 sense.  This includes standard functions, and others specified by format
3167 attributes (@pxref{Function Attributes}), in the @code{printf},
3168 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3169 not in the C standard) families (or other target-specific families).
3170 Which functions are checked without format attributes having been
3171 specified depends on the standard version selected, and such checks of
3172 functions without the attribute specified are disabled by
3173 @option{-ffreestanding} or @option{-fno-builtin}.
3174
3175 The formats are checked against the format features supported by GNU
3176 libc version 2.2.  These include all ISO C90 and C99 features, as well
3177 as features from the Single Unix Specification and some BSD and GNU
3178 extensions.  Other library implementations may not support all these
3179 features; GCC does not support warning about features that go beyond a
3180 particular library's limitations.  However, if @option{-pedantic} is used
3181 with @option{-Wformat}, warnings will be given about format features not
3182 in the selected standard version (but not for @code{strfmon} formats,
3183 since those are not in any version of the C standard).  @xref{C Dialect
3184 Options,,Options Controlling C Dialect}.
3185
3186 Since @option{-Wformat} also checks for null format arguments for
3187 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3188
3189 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3190 aspects of format checking, the options @option{-Wformat-y2k},
3191 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3192 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3193 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3194
3195 @item -Wformat-y2k
3196 @opindex Wformat-y2k
3197 @opindex Wno-format-y2k
3198 If @option{-Wformat} is specified, also warn about @code{strftime}
3199 formats which may yield only a two-digit year.
3200
3201 @item -Wno-format-contains-nul
3202 @opindex Wno-format-contains-nul
3203 @opindex Wformat-contains-nul
3204 If @option{-Wformat} is specified, do not warn about format strings that
3205 contain NUL bytes.
3206
3207 @item -Wno-format-extra-args
3208 @opindex Wno-format-extra-args
3209 @opindex Wformat-extra-args
3210 If @option{-Wformat} is specified, do not warn about excess arguments to a
3211 @code{printf} or @code{scanf} format function.  The C standard specifies
3212 that such arguments are ignored.
3213
3214 Where the unused arguments lie between used arguments that are
3215 specified with @samp{$} operand number specifications, normally
3216 warnings are still given, since the implementation could not know what
3217 type to pass to @code{va_arg} to skip the unused arguments.  However,
3218 in the case of @code{scanf} formats, this option will suppress the
3219 warning if the unused arguments are all pointers, since the Single
3220 Unix Specification says that such unused arguments are allowed.
3221
3222 @item -Wno-format-zero-length
3223 @opindex Wno-format-zero-length
3224 @opindex Wformat-zero-length
3225 If @option{-Wformat} is specified, do not warn about zero-length formats.
3226 The C standard specifies that zero-length formats are allowed.
3227
3228 @item -Wformat-nonliteral
3229 @opindex Wformat-nonliteral
3230 @opindex Wno-format-nonliteral
3231 If @option{-Wformat} is specified, also warn if the format string is not a
3232 string literal and so cannot be checked, unless the format function
3233 takes its format arguments as a @code{va_list}.
3234
3235 @item -Wformat-security
3236 @opindex Wformat-security
3237 @opindex Wno-format-security
3238 If @option{-Wformat} is specified, also warn about uses of format
3239 functions that represent possible security problems.  At present, this
3240 warns about calls to @code{printf} and @code{scanf} functions where the
3241 format string is not a string literal and there are no format arguments,
3242 as in @code{printf (foo);}.  This may be a security hole if the format
3243 string came from untrusted input and contains @samp{%n}.  (This is
3244 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3245 in future warnings may be added to @option{-Wformat-security} that are not
3246 included in @option{-Wformat-nonliteral}.)
3247
3248 @item -Wformat=2
3249 @opindex Wformat=2
3250 @opindex Wno-format=2
3251 Enable @option{-Wformat} plus format checks not included in
3252 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3253 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3254
3255 @item -Wnonnull
3256 @opindex Wnonnull
3257 @opindex Wno-nonnull
3258 Warn about passing a null pointer for arguments marked as
3259 requiring a non-null value by the @code{nonnull} function attribute.
3260
3261 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3262 can be disabled with the @option{-Wno-nonnull} option.
3263
3264 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3265 @opindex Winit-self
3266 @opindex Wno-init-self
3267 Warn about uninitialized variables which are initialized with themselves.
3268 Note this option can only be used with the @option{-Wuninitialized} option.
3269
3270 For example, GCC will warn about @code{i} being uninitialized in the
3271 following snippet only when @option{-Winit-self} has been specified:
3272 @smallexample
3273 @group
3274 int f()
3275 @{
3276   int i = i;
3277   return i;
3278 @}
3279 @end group
3280 @end smallexample
3281
3282 @item -Wimplicit-int @r{(C and Objective-C only)}
3283 @opindex Wimplicit-int
3284 @opindex Wno-implicit-int
3285 Warn when a declaration does not specify a type.
3286 This warning is enabled by @option{-Wall}.
3287
3288 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3289 @opindex Wimplicit-function-declaration
3290 @opindex Wno-implicit-function-declaration
3291 Give a warning whenever a function is used before being declared. In
3292 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3293 enabled by default and it is made into an error by
3294 @option{-pedantic-errors}. This warning is also enabled by
3295 @option{-Wall}.
3296
3297 @item -Wimplicit @r{(C and Objective-C only)}
3298 @opindex Wimplicit
3299 @opindex Wno-implicit
3300 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3301 This warning is enabled by @option{-Wall}.
3302
3303 @item -Wignored-qualifiers @r{(C and C++ only)}
3304 @opindex Wignored-qualifiers
3305 @opindex Wno-ignored-qualifiers
3306 Warn if the return type of a function has a type qualifier
3307 such as @code{const}.  For ISO C such a type qualifier has no effect,
3308 since the value returned by a function is not an lvalue.
3309 For C++, the warning is only emitted for scalar types or @code{void}.
3310 ISO C prohibits qualified @code{void} return types on function
3311 definitions, so such return types always receive a warning
3312 even without this option.
3313
3314 This warning is also enabled by @option{-Wextra}.
3315
3316 @item -Wmain
3317 @opindex Wmain
3318 @opindex Wno-main
3319 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3320 a function with external linkage, returning int, taking either zero
3321 arguments, two, or three arguments of appropriate types.  This warning
3322 is enabled by default in C++ and is enabled by either @option{-Wall}
3323 or @option{-pedantic}.
3324
3325 @item -Wmissing-braces
3326 @opindex Wmissing-braces
3327 @opindex Wno-missing-braces
3328 Warn if an aggregate or union initializer is not fully bracketed.  In
3329 the following example, the initializer for @samp{a} is not fully
3330 bracketed, but that for @samp{b} is fully bracketed.
3331
3332 @smallexample
3333 int a[2][2] = @{ 0, 1, 2, 3 @};
3334 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3335 @end smallexample
3336
3337 This warning is enabled by @option{-Wall}.
3338
3339 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3340 @opindex Wmissing-include-dirs
3341 @opindex Wno-missing-include-dirs
3342 Warn if a user-supplied include directory does not exist.
3343
3344 @item -Wparentheses
3345 @opindex Wparentheses
3346 @opindex Wno-parentheses
3347 Warn if parentheses are omitted in certain contexts, such
3348 as when there is an assignment in a context where a truth value
3349 is expected, or when operators are nested whose precedence people
3350 often get confused about.
3351
3352 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3353 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3354 interpretation from that of ordinary mathematical notation.
3355
3356 Also warn about constructions where there may be confusion to which
3357 @code{if} statement an @code{else} branch belongs.  Here is an example of
3358 such a case:
3359
3360 @smallexample
3361 @group
3362 @{
3363   if (a)
3364     if (b)
3365       foo ();
3366   else
3367     bar ();
3368 @}
3369 @end group
3370 @end smallexample
3371
3372 In C/C++, every @code{else} branch belongs to the innermost possible
3373 @code{if} statement, which in this example is @code{if (b)}.  This is
3374 often not what the programmer expected, as illustrated in the above
3375 example by indentation the programmer chose.  When there is the
3376 potential for this confusion, GCC will issue a warning when this flag
3377 is specified.  To eliminate the warning, add explicit braces around
3378 the innermost @code{if} statement so there is no way the @code{else}
3379 could belong to the enclosing @code{if}.  The resulting code would
3380 look like this:
3381
3382 @smallexample
3383 @group
3384 @{
3385   if (a)
3386     @{
3387       if (b)
3388         foo ();
3389       else
3390         bar ();
3391     @}
3392 @}
3393 @end group
3394 @end smallexample
3395
3396 Also warn for dangerous uses of the
3397 ?: with omitted middle operand GNU extension. When the condition
3398 in the ?: operator is a boolean expression the omitted value will
3399 be always 1. Often the user expects it to be a value computed
3400 inside the conditional expression instead.
3401
3402 This warning is enabled by @option{-Wall}.
3403
3404 @item -Wsequence-point
3405 @opindex Wsequence-point
3406 @opindex Wno-sequence-point
3407 Warn about code that may have undefined semantics because of violations
3408 of sequence point rules in the C and C++ standards.
3409
3410 The C and C++ standards defines the order in which expressions in a C/C++
3411 program are evaluated in terms of @dfn{sequence points}, which represent
3412 a partial ordering between the execution of parts of the program: those
3413 executed before the sequence point, and those executed after it.  These
3414 occur after the evaluation of a full expression (one which is not part
3415 of a larger expression), after the evaluation of the first operand of a
3416 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3417 function is called (but after the evaluation of its arguments and the
3418 expression denoting the called function), and in certain other places.
3419 Other than as expressed by the sequence point rules, the order of
3420 evaluation of subexpressions of an expression is not specified.  All
3421 these rules describe only a partial order rather than a total order,
3422 since, for example, if two functions are called within one expression
3423 with no sequence point between them, the order in which the functions
3424 are called is not specified.  However, the standards committee have
3425 ruled that function calls do not overlap.
3426
3427 It is not specified when between sequence points modifications to the
3428 values of objects take effect.  Programs whose behavior depends on this
3429 have undefined behavior; the C and C++ standards specify that ``Between
3430 the previous and next sequence point an object shall have its stored
3431 value modified at most once by the evaluation of an expression.
3432 Furthermore, the prior value shall be read only to determine the value
3433 to be stored.''.  If a program breaks these rules, the results on any
3434 particular implementation are entirely unpredictable.
3435
3436 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3437 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3438 diagnosed by this option, and it may give an occasional false positive
3439 result, but in general it has been found fairly effective at detecting
3440 this sort of problem in programs.
3441
3442 The standard is worded confusingly, therefore there is some debate
3443 over the precise meaning of the sequence point rules in subtle cases.
3444 Links to discussions of the problem, including proposed formal
3445 definitions, may be found on the GCC readings page, at
3446 @uref{http://gcc.gnu.org/@/readings.html}.
3447
3448 This warning is enabled by @option{-Wall} for C and C++.
3449
3450 @item -Wreturn-type
3451 @opindex Wreturn-type
3452 @opindex Wno-return-type
3453 Warn whenever a function is defined with a return-type that defaults
3454 to @code{int}.  Also warn about any @code{return} statement with no
3455 return-value in a function whose return-type is not @code{void}
3456 (falling off the end of the function body is considered returning
3457 without a value), and about a @code{return} statement with an
3458 expression in a function whose return-type is @code{void}.
3459
3460 For C++, a function without return type always produces a diagnostic
3461 message, even when @option{-Wno-return-type} is specified.  The only
3462 exceptions are @samp{main} and functions defined in system headers.
3463
3464 This warning is enabled by @option{-Wall}.
3465
3466 @item -Wswitch
3467 @opindex Wswitch
3468 @opindex Wno-switch
3469 Warn whenever a @code{switch} statement has an index of enumerated type
3470 and lacks a @code{case} for one or more of the named codes of that
3471 enumeration.  (The presence of a @code{default} label prevents this
3472 warning.)  @code{case} labels outside the enumeration range also
3473 provoke warnings when this option is used (even if there is a
3474 @code{default} label).
3475 This warning is enabled by @option{-Wall}.
3476
3477 @item -Wswitch-default
3478 @opindex Wswitch-default
3479 @opindex Wno-switch-default
3480 Warn whenever a @code{switch} statement does not have a @code{default}
3481 case.
3482
3483 @item -Wswitch-enum
3484 @opindex Wswitch-enum
3485 @opindex Wno-switch-enum
3486 Warn whenever a @code{switch} statement has an index of enumerated type
3487 and lacks a @code{case} for one or more of the named codes of that
3488 enumeration.  @code{case} labels outside the enumeration range also
3489 provoke warnings when this option is used.  The only difference
3490 between @option{-Wswitch} and this option is that this option gives a
3491 warning about an omitted enumeration code even if there is a
3492 @code{default} label.
3493
3494 @item -Wsync-nand @r{(C and C++ only)}
3495 @opindex Wsync-nand
3496 @opindex Wno-sync-nand
3497 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3498 built-in functions are used.  These functions changed semantics in GCC 4.4.
3499
3500 @item -Wtrigraphs
3501 @opindex Wtrigraphs
3502 @opindex Wno-trigraphs
3503 Warn if any trigraphs are encountered that might change the meaning of
3504 the program (trigraphs within comments are not warned about).
3505 This warning is enabled by @option{-Wall}.
3506
3507 @item -Wunused-but-set-parameter
3508 @opindex Wunused-but-set-parameter
3509 @opindex Wno-unused-but-set-parameter
3510 Warn whenever a function parameter is assigned to, but otherwise unused
3511 (aside from its declaration).
3512
3513 To suppress this warning use the @samp{unused} attribute
3514 (@pxref{Variable Attributes}).
3515
3516 This warning is also enabled by @option{-Wunused} together with
3517 @option{-Wextra}.
3518
3519 @item -Wunused-but-set-variable
3520 @opindex Wunused-but-set-variable
3521 @opindex Wno-unused-but-set-variable
3522 Warn whenever a local variable is assigned to, but otherwise unused
3523 (aside from its declaration).
3524 This warning is enabled by @option{-Wall}.
3525
3526 To suppress this warning use the @samp{unused} attribute
3527 (@pxref{Variable Attributes}).
3528
3529 This warning is also enabled by @option{-Wunused}, which is enabled
3530 by @option{-Wall}.
3531
3532 @item -Wunused-function
3533 @opindex Wunused-function
3534 @opindex Wno-unused-function
3535 Warn whenever a static function is declared but not defined or a
3536 non-inline static function is unused.
3537 This warning is enabled by @option{-Wall}.
3538
3539 @item -Wunused-label
3540 @opindex Wunused-label
3541 @opindex Wno-unused-label
3542 Warn whenever a label is declared but not used.
3543 This warning is enabled by @option{-Wall}.
3544
3545 To suppress this warning use the @samp{unused} attribute
3546 (@pxref{Variable Attributes}).
3547
3548 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3549 @opindex Wunused-local-typedefs
3550 Warn when a typedef locally defined in a function is not used.
3551
3552 @item -Wunused-parameter
3553 @opindex Wunused-parameter
3554 @opindex Wno-unused-parameter
3555 Warn whenever a function parameter is unused aside from its declaration.
3556
3557 To suppress this warning use the @samp{unused} attribute
3558 (@pxref{Variable Attributes}).
3559
3560 @item -Wno-unused-result
3561 @opindex Wunused-result
3562 @opindex Wno-unused-result
3563 Do not warn if a caller of a function marked with attribute
3564 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3565 its return value. The default is @option{-Wunused-result}.
3566
3567 @item -Wunused-variable
3568 @opindex Wunused-variable
3569 @opindex Wno-unused-variable
3570 Warn whenever a local variable or non-constant static variable is unused
3571 aside from its declaration.
3572 This warning is enabled by @option{-Wall}.
3573
3574 To suppress this warning use the @samp{unused} attribute
3575 (@pxref{Variable Attributes}).
3576
3577 @item -Wunused-value
3578 @opindex Wunused-value
3579 @opindex Wno-unused-value
3580 Warn whenever a statement computes a result that is explicitly not
3581 used. To suppress this warning cast the unused expression to
3582 @samp{void}. This includes an expression-statement or the left-hand
3583 side of a comma expression that contains no side effects. For example,
3584 an expression such as @samp{x[i,j]} will cause a warning, while
3585 @samp{x[(void)i,j]} will not.
3586
3587 This warning is enabled by @option{-Wall}.
3588
3589 @item -Wunused
3590 @opindex Wunused
3591 @opindex Wno-unused
3592 All the above @option{-Wunused} options combined.
3593
3594 In order to get a warning about an unused function parameter, you must
3595 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3596 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3597
3598 @item -Wuninitialized
3599 @opindex Wuninitialized
3600 @opindex Wno-uninitialized
3601 Warn if an automatic variable is used without first being initialized
3602 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3603 warn if a non-static reference or non-static @samp{const} member
3604 appears in a class without constructors.
3605
3606 If you want to warn about code which uses the uninitialized value of the
3607 variable in its own initializer, use the @option{-Winit-self} option.
3608
3609 These warnings occur for individual uninitialized or clobbered
3610 elements of structure, union or array variables as well as for
3611 variables which are uninitialized or clobbered as a whole.  They do
3612 not occur for variables or elements declared @code{volatile}.  Because
3613 these warnings depend on optimization, the exact variables or elements
3614 for which there are warnings will depend on the precise optimization
3615 options and version of GCC used.
3616
3617 Note that there may be no warning about a variable that is used only
3618 to compute a value that itself is never used, because such
3619 computations may be deleted by data flow analysis before the warnings
3620 are printed.
3621
3622 @item -Wmaybe-uninitialized
3623 @opindex Wmaybe-uninitialized
3624 @opindex Wno-maybe-uninitialized
3625 For an automatic variable, if there exists a path from the function
3626 entry to a use of the variable that is initialized, but there exist
3627 some other paths the variable is not initialized, the compiler will
3628 emit a warning if it can not prove the uninitialized paths do not
3629 happen at runtime. These warnings are made optional because GCC is
3630 not smart enough to see all the reasons why the code might be correct
3631 despite appearing to have an error.  Here is one example of how
3632 this can happen:
3633
3634 @smallexample
3635 @group
3636 @{
3637   int x;
3638   switch (y)
3639     @{
3640     case 1: x = 1;
3641       break;
3642     case 2: x = 4;
3643       break;
3644     case 3: x = 5;
3645     @}
3646   foo (x);
3647 @}
3648 @end group
3649 @end smallexample
3650
3651 @noindent
3652 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3653 always initialized, but GCC doesn't know this. To suppress the
3654 warning, the user needs to provide a default case with assert(0) or
3655 similar code.
3656
3657 @cindex @code{longjmp} warnings
3658 This option also warns when a non-volatile automatic variable might be
3659 changed by a call to @code{longjmp}.  These warnings as well are possible
3660 only in optimizing compilation.
3661
3662 The compiler sees only the calls to @code{setjmp}.  It cannot know
3663 where @code{longjmp} will be called; in fact, a signal handler could
3664 call it at any point in the code.  As a result, you may get a warning
3665 even when there is in fact no problem because @code{longjmp} cannot
3666 in fact be called at the place which would cause a problem.
3667
3668 Some spurious warnings can be avoided if you declare all the functions
3669 you use that never return as @code{noreturn}.  @xref{Function
3670 Attributes}.
3671
3672 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3673
3674 @item -Wunknown-pragmas
3675 @opindex Wunknown-pragmas
3676 @opindex Wno-unknown-pragmas
3677 @cindex warning for unknown pragmas
3678 @cindex unknown pragmas, warning
3679 @cindex pragmas, warning of unknown
3680 Warn when a #pragma directive is encountered which is not understood by
3681 GCC@.  If this command line option is used, warnings will even be issued
3682 for unknown pragmas in system header files.  This is not the case if
3683 the warnings were only enabled by the @option{-Wall} command line option.
3684
3685 @item -Wno-pragmas
3686 @opindex Wno-pragmas
3687 @opindex Wpragmas
3688 Do not warn about misuses of pragmas, such as incorrect parameters,
3689 invalid syntax, or conflicts between pragmas.  See also
3690 @samp{-Wunknown-pragmas}.
3691
3692 @item -Wstrict-aliasing
3693 @opindex Wstrict-aliasing
3694 @opindex Wno-strict-aliasing
3695 This option is only active when @option{-fstrict-aliasing} is active.
3696 It warns about code which might break the strict aliasing rules that the
3697 compiler is using for optimization.  The warning does not catch all
3698 cases, but does attempt to catch the more common pitfalls.  It is
3699 included in @option{-Wall}.
3700 It is equivalent to @option{-Wstrict-aliasing=3}
3701
3702 @item -Wstrict-aliasing=n
3703 @opindex Wstrict-aliasing=n
3704 @opindex Wno-strict-aliasing=n
3705 This option is only active when @option{-fstrict-aliasing} is active.
3706 It warns about code which might break the strict aliasing rules that the
3707 compiler is using for optimization.
3708 Higher levels correspond to higher accuracy (fewer false positives).
3709 Higher levels also correspond to more effort, similar to the way -O works.
3710 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3711 with n=3.
3712
3713 Level 1: Most aggressive, quick, least accurate.
3714 Possibly useful when higher levels
3715 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3716 false negatives.  However, it has many false positives.
3717 Warns for all pointer conversions between possibly incompatible types,
3718 even if never dereferenced.  Runs in the frontend only.
3719
3720 Level 2: Aggressive, quick, not too precise.
3721 May still have many false positives (not as many as level 1 though),
3722 and few false negatives (but possibly more than level 1).
3723 Unlike level 1, it only warns when an address is taken.  Warns about
3724 incomplete types.  Runs in the frontend only.
3725
3726 Level 3 (default for @option{-Wstrict-aliasing}):
3727 Should have very few false positives and few false
3728 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3729 Takes care of the common pun+dereference pattern in the frontend:
3730 @code{*(int*)&some_float}.
3731 If optimization is enabled, it also runs in the backend, where it deals
3732 with multiple statement cases using flow-sensitive points-to information.
3733 Only warns when the converted pointer is dereferenced.
3734 Does not warn about incomplete types.
3735
3736 @item -Wstrict-overflow
3737 @itemx -Wstrict-overflow=@var{n}
3738 @opindex Wstrict-overflow
3739 @opindex Wno-strict-overflow
3740 This option is only active when @option{-fstrict-overflow} is active.
3741 It warns about cases where the compiler optimizes based on the
3742 assumption that signed overflow does not occur.  Note that it does not
3743 warn about all cases where the code might overflow: it only warns
3744 about cases where the compiler implements some optimization.  Thus
3745 this warning depends on the optimization level.
3746
3747 An optimization which assumes that signed overflow does not occur is
3748 perfectly safe if the values of the variables involved are such that
3749 overflow never does, in fact, occur.  Therefore this warning can
3750 easily give a false positive: a warning about code which is not
3751 actually a problem.  To help focus on important issues, several
3752 warning levels are defined.  No warnings are issued for the use of
3753 undefined signed overflow when estimating how many iterations a loop
3754 will require, in particular when determining whether a loop will be
3755 executed at all.
3756
3757 @table @gcctabopt
3758 @item -Wstrict-overflow=1
3759 Warn about cases which are both questionable and easy to avoid.  For
3760 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3761 compiler will simplify this to @code{1}.  This level of
3762 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3763 are not, and must be explicitly requested.
3764
3765 @item -Wstrict-overflow=2
3766 Also warn about other cases where a comparison is simplified to a
3767 constant.  For example: @code{abs (x) >= 0}.  This can only be
3768 simplified when @option{-fstrict-overflow} is in effect, because
3769 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3770 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3771 @option{-Wstrict-overflow=2}.
3772
3773 @item -Wstrict-overflow=3
3774 Also warn about other cases where a comparison is simplified.  For
3775 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3776
3777 @item -Wstrict-overflow=4
3778 Also warn about other simplifications not covered by the above cases.
3779 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3780
3781 @item -Wstrict-overflow=5
3782 Also warn about cases where the compiler reduces the magnitude of a
3783 constant involved in a comparison.  For example: @code{x + 2 > y} will
3784 be simplified to @code{x + 1 >= y}.  This is reported only at the
3785 highest warning level because this simplification applies to many
3786 comparisons, so this warning level will give a very large number of
3787 false positives.
3788 @end table
3789
3790 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]}
3791 @opindex Wsuggest-attribute=
3792 @opindex Wno-suggest-attribute=
3793 Warn for cases where adding an attribute may be beneficial. The
3794 attributes currently supported are listed below.
3795
3796 @table @gcctabopt
3797 @item -Wsuggest-attribute=pure
3798 @itemx -Wsuggest-attribute=const
3799 @itemx -Wsuggest-attribute=noreturn
3800 @opindex Wsuggest-attribute=pure
3801 @opindex Wno-suggest-attribute=pure
3802 @opindex Wsuggest-attribute=const
3803 @opindex Wno-suggest-attribute=const
3804 @opindex Wsuggest-attribute=noreturn
3805 @opindex Wno-suggest-attribute=noreturn
3806
3807 Warn about functions which might be candidates for attributes
3808 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3809 functions visible in other compilation units or (in the case of @code{pure} and
3810 @code{const}) if it cannot prove that the function returns normally. A function
3811 returns normally if it doesn't contain an infinite loop nor returns abnormally
3812 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3813 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3814 higher.  Higher optimization levels improve the accuracy of the analysis.
3815 @end table
3816
3817 @item -Warray-bounds
3818 @opindex Wno-array-bounds
3819 @opindex Warray-bounds
3820 This option is only active when @option{-ftree-vrp} is active
3821 (default for @option{-O2} and above). It warns about subscripts to arrays
3822 that are always out of bounds. This warning is enabled by @option{-Wall}.
3823
3824 @item -Wno-div-by-zero
3825 @opindex Wno-div-by-zero
3826 @opindex Wdiv-by-zero
3827 Do not warn about compile-time integer division by zero.  Floating point
3828 division by zero is not warned about, as it can be a legitimate way of
3829 obtaining infinities and NaNs.
3830
3831 @item -Wsystem-headers
3832 @opindex Wsystem-headers
3833 @opindex Wno-system-headers
3834 @cindex warnings from system headers
3835 @cindex system headers, warnings from
3836 Print warning messages for constructs found in system header files.
3837 Warnings from system headers are normally suppressed, on the assumption
3838 that they usually do not indicate real problems and would only make the
3839 compiler output harder to read.  Using this command line option tells
3840 GCC to emit warnings from system headers as if they occurred in user
3841 code.  However, note that using @option{-Wall} in conjunction with this
3842 option will @emph{not} warn about unknown pragmas in system
3843 headers---for that, @option{-Wunknown-pragmas} must also be used.
3844
3845 @item -Wtrampolines
3846 @opindex Wtrampolines
3847 @opindex Wno-trampolines
3848  Warn about trampolines generated for pointers to nested functions.
3849
3850  A trampoline is a small piece of data or code that is created at run
3851  time on the stack when the address of a nested function is taken, and
3852  is used to call the nested function indirectly.  For some targets, it
3853  is made up of data only and thus requires no special treatment.  But,
3854  for most targets, it is made up of code and thus requires the stack
3855  to be made executable in order for the program to work properly.
3856
3857 @item -Wfloat-equal
3858 @opindex Wfloat-equal
3859 @opindex Wno-float-equal
3860 Warn if floating point values are used in equality comparisons.
3861
3862 The idea behind this is that sometimes it is convenient (for the
3863 programmer) to consider floating-point values as approximations to
3864 infinitely precise real numbers.  If you are doing this, then you need
3865 to compute (by analyzing the code, or in some other way) the maximum or
3866 likely maximum error that the computation introduces, and allow for it
3867 when performing comparisons (and when producing output, but that's a
3868 different problem).  In particular, instead of testing for equality, you
3869 would check to see whether the two values have ranges that overlap; and
3870 this is done with the relational operators, so equality comparisons are
3871 probably mistaken.
3872
3873 @item -Wtraditional @r{(C and Objective-C only)}
3874 @opindex Wtraditional
3875 @opindex Wno-traditional
3876 Warn about certain constructs that behave differently in traditional and
3877 ISO C@.  Also warn about ISO C constructs that have no traditional C
3878 equivalent, and/or problematic constructs which should be avoided.
3879
3880 @itemize @bullet
3881 @item
3882 Macro parameters that appear within string literals in the macro body.
3883 In traditional C macro replacement takes place within string literals,
3884 but does not in ISO C@.
3885
3886 @item
3887 In traditional C, some preprocessor directives did not exist.
3888 Traditional preprocessors would only consider a line to be a directive
3889 if the @samp{#} appeared in column 1 on the line.  Therefore
3890 @option{-Wtraditional} warns about directives that traditional C
3891 understands but would ignore because the @samp{#} does not appear as the
3892 first character on the line.  It also suggests you hide directives like
3893 @samp{#pragma} not understood by traditional C by indenting them.  Some
3894 traditional implementations would not recognize @samp{#elif}, so it
3895 suggests avoiding it altogether.
3896
3897 @item
3898 A function-like macro that appears without arguments.
3899
3900 @item
3901 The unary plus operator.
3902
3903 @item
3904 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3905 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3906 constants.)  Note, these suffixes appear in macros defined in the system
3907 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3908 Use of these macros in user code might normally lead to spurious
3909 warnings, however GCC's integrated preprocessor has enough context to
3910 avoid warning in these cases.
3911
3912 @item
3913 A function declared external in one block and then used after the end of
3914 the block.
3915
3916 @item
3917 A @code{switch} statement has an operand of type @code{long}.
3918
3919 @item
3920 A non-@code{static} function declaration follows a @code{static} one.
3921 This construct is not accepted by some traditional C compilers.
3922
3923 @item
3924 The ISO type of an integer constant has a different width or
3925 signedness from its traditional type.  This warning is only issued if
3926 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3927 typically represent bit patterns, are not warned about.
3928
3929 @item
3930 Usage of ISO string concatenation is detected.
3931
3932 @item
3933 Initialization of automatic aggregates.
3934
3935 @item
3936 Identifier conflicts with labels.  Traditional C lacks a separate
3937 namespace for labels.
3938
3939 @item
3940 Initialization of unions.  If the initializer is zero, the warning is
3941 omitted.  This is done under the assumption that the zero initializer in
3942 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3943 initializer warnings and relies on default initialization to zero in the
3944 traditional C case.
3945
3946 @item
3947 Conversions by prototypes between fixed/floating point values and vice
3948 versa.  The absence of these prototypes when compiling with traditional
3949 C would cause serious problems.  This is a subset of the possible
3950 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3951
3952 @item
3953 Use of ISO C style function definitions.  This warning intentionally is
3954 @emph{not} issued for prototype declarations or variadic functions
3955 because these ISO C features will appear in your code when using
3956 libiberty's traditional C compatibility macros, @code{PARAMS} and
3957 @code{VPARAMS}.  This warning is also bypassed for nested functions
3958 because that feature is already a GCC extension and thus not relevant to
3959 traditional C compatibility.
3960 @end itemize
3961
3962 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3963 @opindex Wtraditional-conversion
3964 @opindex Wno-traditional-conversion
3965 Warn if a prototype causes a type conversion that is different from what
3966 would happen to the same argument in the absence of a prototype.  This
3967 includes conversions of fixed point to floating and vice versa, and
3968 conversions changing the width or signedness of a fixed point argument
3969 except when the same as the default promotion.
3970
3971 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3972 @opindex Wdeclaration-after-statement
3973 @opindex Wno-declaration-after-statement
3974 Warn when a declaration is found after a statement in a block.  This
3975 construct, known from C++, was introduced with ISO C99 and is by default
3976 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3977 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3978
3979 @item -Wundef
3980 @opindex Wundef
3981 @opindex Wno-undef
3982 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3983
3984 @item -Wno-endif-labels
3985 @opindex Wno-endif-labels
3986 @opindex Wendif-labels
3987 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3988
3989 @item -Wshadow
3990 @opindex Wshadow
3991 @opindex Wno-shadow
3992 Warn whenever a local variable or type declaration shadows another variable,
3993 parameter, type, or class member (in C++), or whenever a built-in function
3994 is shadowed. Note that in C++, the compiler will not warn if a local variable
3995 shadows a struct/class/enum, but will warn if it shadows an explicit typedef.
3996
3997 @item -Wlarger-than=@var{len}
3998 @opindex Wlarger-than=@var{len}
3999 @opindex Wlarger-than-@var{len}
4000 Warn whenever an object of larger than @var{len} bytes is defined.
4001
4002 @item -Wframe-larger-than=@var{len}
4003 @opindex Wframe-larger-than
4004 Warn if the size of a function frame is larger than @var{len} bytes.
4005 The computation done to determine the stack frame size is approximate
4006 and not conservative.
4007 The actual requirements may be somewhat greater than @var{len}
4008 even if you do not get a warning.  In addition, any space allocated
4009 via @code{alloca}, variable-length arrays, or related constructs
4010 is not included by the compiler when determining
4011 whether or not to issue a warning.
4012
4013 @item -Wno-free-nonheap-object
4014 @opindex Wno-free-nonheap-object
4015 @opindex Wfree-nonheap-object
4016 Do not warn when attempting to free an object which was not allocated
4017 on the heap.
4018
4019 @item -Wstack-usage=@var{len}
4020 @opindex Wstack-usage
4021 Warn if the stack usage of a function might be larger than @var{len} bytes.
4022 The computation done to determine the stack usage is conservative.
4023 Any space allocated via @code{alloca}, variable-length arrays, or related
4024 constructs is included by the compiler when determining whether or not to
4025 issue a warning.
4026
4027 The message is in keeping with the output of @option{-fstack-usage}.
4028
4029 @itemize
4030 @item
4031 If the stack usage is fully static but exceeds the specified amount, it's:
4032
4033 @smallexample
4034   warning: stack usage is 1120 bytes
4035 @end smallexample
4036 @item
4037 If the stack usage is (partly) dynamic but bounded, it's:
4038
4039 @smallexample
4040   warning: stack usage might be 1648 bytes
4041 @end smallexample
4042 @item
4043 If the stack usage is (partly) dynamic and not bounded, it's:
4044
4045 @smallexample
4046   warning: stack usage might be unbounded
4047 @end smallexample
4048 @end itemize
4049
4050 @item -Wunsafe-loop-optimizations
4051 @opindex Wunsafe-loop-optimizations
4052 @opindex Wno-unsafe-loop-optimizations
4053 Warn if the loop cannot be optimized because the compiler could not
4054 assume anything on the bounds of the loop indices.  With
4055 @option{-funsafe-loop-optimizations} warn if the compiler made
4056 such assumptions.
4057
4058 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4059 @opindex Wno-pedantic-ms-format
4060 @opindex Wpedantic-ms-format
4061 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
4062 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
4063 depending on the MS runtime, when you are using the options @option{-Wformat}
4064 and @option{-pedantic} without gnu-extensions.
4065
4066 @item -Wpointer-arith
4067 @opindex Wpointer-arith
4068 @opindex Wno-pointer-arith
4069 Warn about anything that depends on the ``size of'' a function type or
4070 of @code{void}.  GNU C assigns these types a size of 1, for
4071 convenience in calculations with @code{void *} pointers and pointers
4072 to functions.  In C++, warn also when an arithmetic operation involves
4073 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
4074
4075 @item -Wtype-limits
4076 @opindex Wtype-limits
4077 @opindex Wno-type-limits
4078 Warn if a comparison is always true or always false due to the limited
4079 range of the data type, but do not warn for constant expressions.  For
4080 example, warn if an unsigned variable is compared against zero with
4081 @samp{<} or @samp{>=}.  This warning is also enabled by
4082 @option{-Wextra}.
4083
4084 @item -Wbad-function-cast @r{(C and Objective-C only)}
4085 @opindex Wbad-function-cast
4086 @opindex Wno-bad-function-cast
4087 Warn whenever a function call is cast to a non-matching type.
4088 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4089
4090 @item -Wc++-compat @r{(C and Objective-C only)}
4091 Warn about ISO C constructs that are outside of the common subset of
4092 ISO C and ISO C++, e.g.@: request for implicit conversion from
4093 @code{void *} to a pointer to non-@code{void} type.
4094
4095 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4096 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4097 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4098 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4099 enabled by @option{-Wall}.
4100
4101 @item -Wcast-qual
4102 @opindex Wcast-qual
4103 @opindex Wno-cast-qual
4104 Warn whenever a pointer is cast so as to remove a type qualifier from
4105 the target type.  For example, warn if a @code{const char *} is cast
4106 to an ordinary @code{char *}.
4107
4108 Also warn when making a cast which introduces a type qualifier in an
4109 unsafe way.  For example, casting @code{char **} to @code{const char **}
4110 is unsafe, as in this example:
4111
4112 @smallexample
4113   /* p is char ** value.  */
4114   const char **q = (const char **) p;
4115   /* Assignment of readonly string to const char * is OK.  */
4116   *q = "string";
4117   /* Now char** pointer points to read-only memory.  */
4118   **p = 'b';
4119 @end smallexample
4120
4121 @item -Wcast-align
4122 @opindex Wcast-align
4123 @opindex Wno-cast-align
4124 Warn whenever a pointer is cast such that the required alignment of the
4125 target is increased.  For example, warn if a @code{char *} is cast to
4126 an @code{int *} on machines where integers can only be accessed at
4127 two- or four-byte boundaries.
4128
4129 @item -Wwrite-strings
4130 @opindex Wwrite-strings
4131 @opindex Wno-write-strings
4132 When compiling C, give string constants the type @code{const
4133 char[@var{length}]} so that copying the address of one into a
4134 non-@code{const} @code{char *} pointer will get a warning.  These
4135 warnings will help you find at compile time code that can try to write
4136 into a string constant, but only if you have been very careful about
4137 using @code{const} in declarations and prototypes.  Otherwise, it will
4138 just be a nuisance. This is why we did not make @option{-Wall} request
4139 these warnings.
4140
4141 When compiling C++, warn about the deprecated conversion from string
4142 literals to @code{char *}.  This warning is enabled by default for C++
4143 programs.
4144
4145 @item -Wclobbered
4146 @opindex Wclobbered
4147 @opindex Wno-clobbered
4148 Warn for variables that might be changed by @samp{longjmp} or
4149 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4150
4151 @item -Wconversion
4152 @opindex Wconversion
4153 @opindex Wno-conversion
4154 Warn for implicit conversions that may alter a value. This includes
4155 conversions between real and integer, like @code{abs (x)} when
4156 @code{x} is @code{double}; conversions between signed and unsigned,
4157 like @code{unsigned ui = -1}; and conversions to smaller types, like
4158 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4159 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4160 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4161 conversions between signed and unsigned integers can be disabled by
4162 using @option{-Wno-sign-conversion}.
4163
4164 For C++, also warn for confusing overload resolution for user-defined
4165 conversions; and conversions that will never use a type conversion
4166 operator: conversions to @code{void}, the same type, a base class or a
4167 reference to them. Warnings about conversions between signed and
4168 unsigned integers are disabled by default in C++ unless
4169 @option{-Wsign-conversion} is explicitly enabled.
4170
4171 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4172 @opindex Wconversion-null
4173 @opindex Wno-conversion-null
4174 Do not warn for conversions between @code{NULL} and non-pointer
4175 types. @option{-Wconversion-null} is enabled by default.
4176
4177 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4178 @opindex Wzero-as-null-pointer-constant
4179 @opindex Wno-zero-as-null-pointer-constant
4180 Warn when a literal '0' is used as null pointer constant.  This can
4181 be useful to facilitate the conversion to @code{nullptr} in C++11.
4182
4183 @item -Wempty-body
4184 @opindex Wempty-body
4185 @opindex Wno-empty-body
4186 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4187 while} statement.  This warning is also enabled by @option{-Wextra}.
4188
4189 @item -Wenum-compare
4190 @opindex Wenum-compare
4191 @opindex Wno-enum-compare
4192 Warn about a comparison between values of different enum types. In C++
4193 this warning is enabled by default.  In C this warning is enabled by
4194 @option{-Wall}.
4195
4196 @item -Wjump-misses-init @r{(C, Objective-C only)}
4197 @opindex Wjump-misses-init
4198 @opindex Wno-jump-misses-init
4199 Warn if a @code{goto} statement or a @code{switch} statement jumps
4200 forward across the initialization of a variable, or jumps backward to a
4201 label after the variable has been initialized.  This only warns about
4202 variables which are initialized when they are declared.  This warning is
4203 only supported for C and Objective C; in C++ this sort of branch is an
4204 error in any case.
4205
4206 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4207 can be disabled with the @option{-Wno-jump-misses-init} option.
4208
4209 @item -Wsign-compare
4210 @opindex Wsign-compare
4211 @opindex Wno-sign-compare
4212 @cindex warning for comparison of signed and unsigned values
4213 @cindex comparison of signed and unsigned values, warning
4214 @cindex signed and unsigned values, comparison warning
4215 Warn when a comparison between signed and unsigned values could produce
4216 an incorrect result when the signed value is converted to unsigned.
4217 This warning is also enabled by @option{-Wextra}; to get the other warnings
4218 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
4219
4220 @item -Wsign-conversion
4221 @opindex Wsign-conversion
4222 @opindex Wno-sign-conversion
4223 Warn for implicit conversions that may change the sign of an integer
4224 value, like assigning a signed integer expression to an unsigned
4225 integer variable. An explicit cast silences the warning. In C, this
4226 option is enabled also by @option{-Wconversion}.
4227
4228 @item -Waddress
4229 @opindex Waddress
4230 @opindex Wno-address
4231 Warn about suspicious uses of memory addresses. These include using
4232 the address of a function in a conditional expression, such as
4233 @code{void func(void); if (func)}, and comparisons against the memory
4234 address of a string literal, such as @code{if (x == "abc")}.  Such
4235 uses typically indicate a programmer error: the address of a function
4236 always evaluates to true, so their use in a conditional usually
4237 indicate that the programmer forgot the parentheses in a function
4238 call; and comparisons against string literals result in unspecified
4239 behavior and are not portable in C, so they usually indicate that the
4240 programmer intended to use @code{strcmp}.  This warning is enabled by
4241 @option{-Wall}.
4242
4243 @item -Wlogical-op
4244 @opindex Wlogical-op
4245 @opindex Wno-logical-op
4246 Warn about suspicious uses of logical operators in expressions.
4247 This includes using logical operators in contexts where a
4248 bit-wise operator is likely to be expected.
4249
4250 @item -Waggregate-return
4251 @opindex Waggregate-return
4252 @opindex Wno-aggregate-return
4253 Warn if any functions that return structures or unions are defined or
4254 called.  (In languages where you can return an array, this also elicits
4255 a warning.)
4256
4257 @item -Wno-attributes
4258 @opindex Wno-attributes
4259 @opindex Wattributes
4260 Do not warn if an unexpected @code{__attribute__} is used, such as
4261 unrecognized attributes, function attributes applied to variables,
4262 etc.  This will not stop errors for incorrect use of supported
4263 attributes.
4264
4265 @item -Wno-builtin-macro-redefined
4266 @opindex Wno-builtin-macro-redefined
4267 @opindex Wbuiltin-macro-redefined
4268 Do not warn if certain built-in macros are redefined.  This suppresses
4269 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4270 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4271
4272 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4273 @opindex Wstrict-prototypes
4274 @opindex Wno-strict-prototypes
4275 Warn if a function is declared or defined without specifying the
4276 argument types.  (An old-style function definition is permitted without
4277 a warning if preceded by a declaration which specifies the argument
4278 types.)
4279
4280 @item -Wold-style-declaration @r{(C and Objective-C only)}
4281 @opindex Wold-style-declaration
4282 @opindex Wno-old-style-declaration
4283 Warn for obsolescent usages, according to the C Standard, in a
4284 declaration. For example, warn if storage-class specifiers like
4285 @code{static} are not the first things in a declaration.  This warning
4286 is also enabled by @option{-Wextra}.
4287
4288 @item -Wold-style-definition @r{(C and Objective-C only)}
4289 @opindex Wold-style-definition
4290 @opindex Wno-old-style-definition
4291 Warn if an old-style function definition is used.  A warning is given
4292 even if there is a previous prototype.
4293
4294 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4295 @opindex Wmissing-parameter-type
4296 @opindex Wno-missing-parameter-type
4297 A function parameter is declared without a type specifier in K&R-style
4298 functions:
4299
4300 @smallexample
4301 void foo(bar) @{ @}
4302 @end smallexample
4303
4304 This warning is also enabled by @option{-Wextra}.
4305
4306 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4307 @opindex Wmissing-prototypes
4308 @opindex Wno-missing-prototypes
4309 Warn if a global function is defined without a previous prototype
4310 declaration.  This warning is issued even if the definition itself
4311 provides a prototype.  The aim is to detect global functions that fail
4312 to be declared in header files.
4313
4314 @item -Wmissing-declarations
4315 @opindex Wmissing-declarations
4316 @opindex Wno-missing-declarations
4317 Warn if a global function is defined without a previous declaration.
4318 Do so even if the definition itself provides a prototype.
4319 Use this option to detect global functions that are not declared in
4320 header files.  In C++, no warnings are issued for function templates,
4321 or for inline functions, or for functions in anonymous namespaces.
4322
4323 @item -Wmissing-field-initializers
4324 @opindex Wmissing-field-initializers
4325 @opindex Wno-missing-field-initializers
4326 @opindex W
4327 @opindex Wextra
4328 @opindex Wno-extra
4329 Warn if a structure's initializer has some fields missing.  For
4330 example, the following code would cause such a warning, because
4331 @code{x.h} is implicitly zero:
4332
4333 @smallexample
4334 struct s @{ int f, g, h; @};
4335 struct s x = @{ 3, 4 @};
4336 @end smallexample
4337
4338 This option does not warn about designated initializers, so the following
4339 modification would not trigger a warning:
4340
4341 @smallexample
4342 struct s @{ int f, g, h; @};
4343 struct s x = @{ .f = 3, .g = 4 @};
4344 @end smallexample
4345
4346 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4347 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4348
4349 @item -Wmissing-format-attribute
4350 @opindex Wmissing-format-attribute
4351 @opindex Wno-missing-format-attribute
4352 @opindex Wformat
4353 @opindex Wno-format
4354 Warn about function pointers which might be candidates for @code{format}
4355 attributes.  Note these are only possible candidates, not absolute ones.
4356 GCC will guess that function pointers with @code{format} attributes that
4357 are used in assignment, initialization, parameter passing or return
4358 statements should have a corresponding @code{format} attribute in the
4359 resulting type.  I.e.@: the left-hand side of the assignment or
4360 initialization, the type of the parameter variable, or the return type
4361 of the containing function respectively should also have a @code{format}
4362 attribute to avoid the warning.
4363
4364 GCC will also warn about function definitions which might be
4365 candidates for @code{format} attributes.  Again, these are only
4366 possible candidates.  GCC will guess that @code{format} attributes
4367 might be appropriate for any function that calls a function like
4368 @code{vprintf} or @code{vscanf}, but this might not always be the
4369 case, and some functions for which @code{format} attributes are
4370 appropriate may not be detected.
4371
4372 @item -Wno-multichar
4373 @opindex Wno-multichar
4374 @opindex Wmultichar
4375 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4376 Usually they indicate a typo in the user's code, as they have
4377 implementation-defined values, and should not be used in portable code.
4378
4379 @item -Wnormalized=<none|id|nfc|nfkc>
4380 @opindex Wnormalized=
4381 @cindex NFC
4382 @cindex NFKC
4383 @cindex character set, input normalization
4384 In ISO C and ISO C++, two identifiers are different if they are
4385 different sequences of characters.  However, sometimes when characters
4386 outside the basic ASCII character set are used, you can have two
4387 different character sequences that look the same.  To avoid confusion,
4388 the ISO 10646 standard sets out some @dfn{normalization rules} which
4389 when applied ensure that two sequences that look the same are turned into
4390 the same sequence.  GCC can warn you if you are using identifiers which
4391 have not been normalized; this option controls that warning.
4392
4393 There are four levels of warning that GCC supports.  The default is
4394 @option{-Wnormalized=nfc}, which warns about any identifier which is
4395 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4396 recommended form for most uses.
4397
4398 Unfortunately, there are some characters which ISO C and ISO C++ allow
4399 in identifiers that when turned into NFC aren't allowable as
4400 identifiers.  That is, there's no way to use these symbols in portable
4401 ISO C or C++ and have all your identifiers in NFC@.
4402 @option{-Wnormalized=id} suppresses the warning for these characters.
4403 It is hoped that future versions of the standards involved will correct
4404 this, which is why this option is not the default.
4405
4406 You can switch the warning off for all characters by writing
4407 @option{-Wnormalized=none}.  You would only want to do this if you
4408 were using some other normalization scheme (like ``D''), because
4409 otherwise you can easily create bugs that are literally impossible to see.
4410
4411 Some characters in ISO 10646 have distinct meanings but look identical
4412 in some fonts or display methodologies, especially once formatting has
4413 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4414 LETTER N'', will display just like a regular @code{n} which has been
4415 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4416 normalization scheme to convert all these into a standard form as
4417 well, and GCC will warn if your code is not in NFKC if you use
4418 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4419 about every identifier that contains the letter O because it might be
4420 confused with the digit 0, and so is not the default, but may be
4421 useful as a local coding convention if the programming environment is
4422 unable to be fixed to display these characters distinctly.
4423
4424 @item -Wno-deprecated
4425 @opindex Wno-deprecated
4426 @opindex Wdeprecated
4427 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4428
4429 @item -Wno-deprecated-declarations
4430 @opindex Wno-deprecated-declarations
4431 @opindex Wdeprecated-declarations
4432 Do not warn about uses of functions (@pxref{Function Attributes}),
4433 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4434 Attributes}) marked as deprecated by using the @code{deprecated}
4435 attribute.
4436
4437 @item -Wno-overflow
4438 @opindex Wno-overflow
4439 @opindex Woverflow
4440 Do not warn about compile-time overflow in constant expressions.
4441
4442 @item -Woverride-init @r{(C and Objective-C only)}
4443 @opindex Woverride-init
4444 @opindex Wno-override-init
4445 @opindex W
4446 @opindex Wextra
4447 @opindex Wno-extra
4448 Warn if an initialized field without side effects is overridden when
4449 using designated initializers (@pxref{Designated Inits, , Designated
4450 Initializers}).
4451
4452 This warning is included in @option{-Wextra}.  To get other
4453 @option{-Wextra} warnings without this one, use @samp{-Wextra
4454 -Wno-override-init}.
4455
4456 @item -Wpacked
4457 @opindex Wpacked
4458 @opindex Wno-packed
4459 Warn if a structure is given the packed attribute, but the packed
4460 attribute has no effect on the layout or size of the structure.
4461 Such structures may be mis-aligned for little benefit.  For
4462 instance, in this code, the variable @code{f.x} in @code{struct bar}
4463 will be misaligned even though @code{struct bar} does not itself
4464 have the packed attribute:
4465
4466 @smallexample
4467 @group
4468 struct foo @{
4469   int x;
4470   char a, b, c, d;
4471 @} __attribute__((packed));
4472 struct bar @{
4473   char z;
4474   struct foo f;
4475 @};
4476 @end group
4477 @end smallexample
4478
4479 @item -Wpacked-bitfield-compat
4480 @opindex Wpacked-bitfield-compat
4481 @opindex Wno-packed-bitfield-compat
4482 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4483 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4484 the change can lead to differences in the structure layout.  GCC
4485 informs you when the offset of such a field has changed in GCC 4.4.
4486 For example there is no longer a 4-bit padding between field @code{a}
4487 and @code{b} in this structure:
4488
4489 @smallexample
4490 struct foo
4491 @{
4492   char a:4;
4493   char b:8;
4494 @} __attribute__ ((packed));
4495 @end smallexample
4496
4497 This warning is enabled by default.  Use
4498 @option{-Wno-packed-bitfield-compat} to disable this warning.
4499
4500 @item -Wpadded
4501 @opindex Wpadded
4502 @opindex Wno-padded
4503 Warn if padding is included in a structure, either to align an element
4504 of the structure or to align the whole structure.  Sometimes when this
4505 happens it is possible to rearrange the fields of the structure to
4506 reduce the padding and so make the structure smaller.
4507
4508 @item -Wredundant-decls
4509 @opindex Wredundant-decls
4510 @opindex Wno-redundant-decls
4511 Warn if anything is declared more than once in the same scope, even in
4512 cases where multiple declaration is valid and changes nothing.
4513
4514 @item -Wnested-externs @r{(C and Objective-C only)}
4515 @opindex Wnested-externs
4516 @opindex Wno-nested-externs
4517 Warn if an @code{extern} declaration is encountered within a function.
4518
4519 @item -Winline
4520 @opindex Winline
4521 @opindex Wno-inline
4522 Warn if a function can not be inlined and it was declared as inline.
4523 Even with this option, the compiler will not warn about failures to
4524 inline functions declared in system headers.
4525
4526 The compiler uses a variety of heuristics to determine whether or not
4527 to inline a function.  For example, the compiler takes into account
4528 the size of the function being inlined and the amount of inlining
4529 that has already been done in the current function.  Therefore,
4530 seemingly insignificant changes in the source program can cause the
4531 warnings produced by @option{-Winline} to appear or disappear.
4532
4533 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4534 @opindex Wno-invalid-offsetof
4535 @opindex Winvalid-offsetof
4536 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4537 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4538 to a non-POD type is undefined.  In existing C++ implementations,
4539 however, @samp{offsetof} typically gives meaningful results even when
4540 applied to certain kinds of non-POD types. (Such as a simple
4541 @samp{struct} that fails to be a POD type only by virtue of having a
4542 constructor.)  This flag is for users who are aware that they are
4543 writing nonportable code and who have deliberately chosen to ignore the
4544 warning about it.
4545
4546 The restrictions on @samp{offsetof} may be relaxed in a future version
4547 of the C++ standard.
4548
4549 @item -Wno-int-to-pointer-cast
4550 @opindex Wno-int-to-pointer-cast
4551 @opindex Wint-to-pointer-cast
4552 Suppress warnings from casts to pointer type of an integer of a
4553 different size. In C++, casting to a pointer type of smaller size is
4554 an error. @option{Wint-to-pointer-cast} is enabled by default.
4555
4556
4557 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4558 @opindex Wno-pointer-to-int-cast
4559 @opindex Wpointer-to-int-cast
4560 Suppress warnings from casts from a pointer to an integer type of a
4561 different size.
4562
4563 @item -Winvalid-pch
4564 @opindex Winvalid-pch
4565 @opindex Wno-invalid-pch
4566 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4567 the search path but can't be used.
4568
4569 @item -Wlong-long
4570 @opindex Wlong-long
4571 @opindex Wno-long-long
4572 Warn if @samp{long long} type is used.  This is enabled by either
4573 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4574 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4575
4576 @item -Wvariadic-macros
4577 @opindex Wvariadic-macros
4578 @opindex Wno-variadic-macros
4579 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4580 alternate syntax when in pedantic ISO C99 mode.  This is default.
4581 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4582
4583 @item -Wvector-operation-performance
4584 @opindex Wvector-operation-performance
4585 @opindex Wno-vector-operation-performance
4586 Warn if vector operation is not implemented via SIMD capabilities of the
4587 architecture.  Mainly useful for the performance tuning.
4588 Vector operation can be implemented @code{piecewise} which means that the
4589 scalar operation is performed on every vector element; 
4590 @code{in parallel} which means that the vector operation is implemented
4591 using scalars of wider type, which normally is more performance efficient;
4592 and @code{as a single scalar} which means that vector fits into a
4593 scalar type.
4594
4595 @item -Wvla
4596 @opindex Wvla
4597 @opindex Wno-vla
4598 Warn if variable length array is used in the code.
4599 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4600 the variable length array.
4601
4602 @item -Wvolatile-register-var
4603 @opindex Wvolatile-register-var
4604 @opindex Wno-volatile-register-var
4605 Warn if a register variable is declared volatile.  The volatile
4606 modifier does not inhibit all optimizations that may eliminate reads
4607 and/or writes to register variables.  This warning is enabled by
4608 @option{-Wall}.
4609
4610 @item -Wdisabled-optimization
4611 @opindex Wdisabled-optimization
4612 @opindex Wno-disabled-optimization
4613 Warn if a requested optimization pass is disabled.  This warning does
4614 not generally indicate that there is anything wrong with your code; it
4615 merely indicates that GCC's optimizers were unable to handle the code
4616 effectively.  Often, the problem is that your code is too big or too
4617 complex; GCC will refuse to optimize programs when the optimization
4618 itself is likely to take inordinate amounts of time.
4619
4620 @item -Wpointer-sign @r{(C and Objective-C only)}
4621 @opindex Wpointer-sign
4622 @opindex Wno-pointer-sign
4623 Warn for pointer argument passing or assignment with different signedness.
4624 This option is only supported for C and Objective-C@.  It is implied by
4625 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4626 @option{-Wno-pointer-sign}.
4627
4628 @item -Wstack-protector
4629 @opindex Wstack-protector
4630 @opindex Wno-stack-protector
4631 This option is only active when @option{-fstack-protector} is active.  It
4632 warns about functions that will not be protected against stack smashing.
4633
4634 @item -Wno-mudflap
4635 @opindex Wno-mudflap
4636 Suppress warnings about constructs that cannot be instrumented by
4637 @option{-fmudflap}.
4638
4639 @item -Woverlength-strings
4640 @opindex Woverlength-strings
4641 @opindex Wno-overlength-strings
4642 Warn about string constants which are longer than the ``minimum
4643 maximum'' length specified in the C standard.  Modern compilers
4644 generally allow string constants which are much longer than the
4645 standard's minimum limit, but very portable programs should avoid
4646 using longer strings.
4647
4648 The limit applies @emph{after} string constant concatenation, and does
4649 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4650 C99, it was raised to 4095.  C++98 does not specify a normative
4651 minimum maximum, so we do not diagnose overlength strings in C++@.
4652
4653 This option is implied by @option{-pedantic}, and can be disabled with
4654 @option{-Wno-overlength-strings}.
4655
4656 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4657 @opindex Wunsuffixed-float-constants
4658
4659 GCC will issue a warning for any floating constant that does not have
4660 a suffix.  When used together with @option{-Wsystem-headers} it will
4661 warn about such constants in system header files.  This can be useful
4662 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4663 from the decimal floating-point extension to C99.
4664 @end table
4665
4666 @node Debugging Options
4667 @section Options for Debugging Your Program or GCC
4668 @cindex options, debugging
4669 @cindex debugging information options
4670
4671 GCC has various special options that are used for debugging
4672 either your program or GCC:
4673
4674 @table @gcctabopt
4675 @item -g
4676 @opindex g
4677 Produce debugging information in the operating system's native format
4678 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4679 information.
4680
4681 On most systems that use stabs format, @option{-g} enables use of extra
4682 debugging information that only GDB can use; this extra information
4683 makes debugging work better in GDB but will probably make other debuggers
4684 crash or
4685 refuse to read the program.  If you want to control for certain whether
4686 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4687 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4688
4689 GCC allows you to use @option{-g} with
4690 @option{-O}.  The shortcuts taken by optimized code may occasionally
4691 produce surprising results: some variables you declared may not exist
4692 at all; flow of control may briefly move where you did not expect it;
4693 some statements may not be executed because they compute constant
4694 results or their values were already at hand; some statements may
4695 execute in different places because they were moved out of loops.
4696
4697 Nevertheless it proves possible to debug optimized output.  This makes
4698 it reasonable to use the optimizer for programs that might have bugs.
4699
4700 The following options are useful when GCC is generated with the
4701 capability for more than one debugging format.
4702
4703 @item -ggdb
4704 @opindex ggdb
4705 Produce debugging information for use by GDB@.  This means to use the
4706 most expressive format available (DWARF 2, stabs, or the native format
4707 if neither of those are supported), including GDB extensions if at all
4708 possible.
4709
4710 @item -gstabs
4711 @opindex gstabs
4712 Produce debugging information in stabs format (if that is supported),
4713 without GDB extensions.  This is the format used by DBX on most BSD
4714 systems.  On MIPS, Alpha and System V Release 4 systems this option
4715 produces stabs debugging output which is not understood by DBX or SDB@.
4716 On System V Release 4 systems this option requires the GNU assembler.
4717
4718 @item -feliminate-unused-debug-symbols
4719 @opindex feliminate-unused-debug-symbols
4720 Produce debugging information in stabs format (if that is supported),
4721 for only symbols that are actually used.
4722
4723 @item -femit-class-debug-always
4724 Instead of emitting debugging information for a C++ class in only one
4725 object file, emit it in all object files using the class.  This option
4726 should be used only with debuggers that are unable to handle the way GCC
4727 normally emits debugging information for classes because using this
4728 option will increase the size of debugging information by as much as a
4729 factor of two.
4730
4731 @item -fno-debug-types-section
4732 @opindex fno-debug-types-section
4733 @opindex fdebug-types-section
4734 By default when using DWARF v4 or higher type DIEs will be put into
4735 their own .debug_types section instead of making them part of the
4736 .debug_info section.  It is more efficient to put them in a separate
4737 comdat sections since the linker will then be able to remove duplicates.
4738 But not all DWARF consumers support .debug_types sections yet.
4739
4740 @item -gstabs+
4741 @opindex gstabs+
4742 Produce debugging information in stabs format (if that is supported),
4743 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4744 use of these extensions is likely to make other debuggers crash or
4745 refuse to read the program.
4746
4747 @item -gcoff
4748 @opindex gcoff
4749 Produce debugging information in COFF format (if that is supported).
4750 This is the format used by SDB on most System V systems prior to
4751 System V Release 4.
4752
4753 @item -gxcoff
4754 @opindex gxcoff
4755 Produce debugging information in XCOFF format (if that is supported).
4756 This is the format used by the DBX debugger on IBM RS/6000 systems.
4757
4758 @item -gxcoff+
4759 @opindex gxcoff+
4760 Produce debugging information in XCOFF format (if that is supported),
4761 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4762 use of these extensions is likely to make other debuggers crash or
4763 refuse to read the program, and may cause assemblers other than the GNU
4764 assembler (GAS) to fail with an error.
4765
4766 @item -gdwarf-@var{version}
4767 @opindex gdwarf-@var{version}
4768 Produce debugging information in DWARF format (if that is
4769 supported).  This is the format used by DBX on IRIX 6.  The value
4770 of @var{version} may be either 2, 3 or 4; the default version is 2.
4771
4772 Note that with DWARF version 2 some ports require, and will always
4773 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4774
4775 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4776 for maximum benefit.
4777
4778 @item -grecord-gcc-switches
4779 @opindex grecord-gcc-switches
4780 This switch causes the command line options, that were used to invoke the
4781 compiler and may affect code generation, to be appended to the
4782 DW_AT_producer attribute in DWARF debugging information.  The options
4783 are concatenated with spaces separating them from each other and from
4784 the compiler version.  See also @option{-frecord-gcc-switches} for another
4785 way of storing compiler options into the object file.
4786
4787 @item -gno-record-gcc-switches
4788 @opindex gno-record-gcc-switches
4789 Disallow appending command line options to the DW_AT_producer attribute
4790 in DWARF debugging information.  This is the default.
4791
4792 @item -gstrict-dwarf
4793 @opindex gstrict-dwarf
4794 Disallow using extensions of later DWARF standard version than selected
4795 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4796 DWARF extensions from later standard versions is allowed.
4797
4798 @item -gno-strict-dwarf
4799 @opindex gno-strict-dwarf
4800 Allow using extensions of later DWARF standard version than selected with
4801 @option{-gdwarf-@var{version}}.
4802
4803 @item -gvms
4804 @opindex gvms
4805 Produce debugging information in VMS debug format (if that is
4806 supported).  This is the format used by DEBUG on VMS systems.
4807
4808 @item -g@var{level}
4809 @itemx -ggdb@var{level}
4810 @itemx -gstabs@var{level}
4811 @itemx -gcoff@var{level}
4812 @itemx -gxcoff@var{level}
4813 @itemx -gvms@var{level}
4814 Request debugging information and also use @var{level} to specify how
4815 much information.  The default level is 2.
4816
4817 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4818 @option{-g}.
4819
4820 Level 1 produces minimal information, enough for making backtraces in
4821 parts of the program that you don't plan to debug.  This includes
4822 descriptions of functions and external variables, but no information
4823 about local variables and no line numbers.
4824
4825 Level 3 includes extra information, such as all the macro definitions
4826 present in the program.  Some debuggers support macro expansion when
4827 you use @option{-g3}.
4828
4829 @option{-gdwarf-2} does not accept a concatenated debug level, because
4830 GCC used to support an option @option{-gdwarf} that meant to generate
4831 debug information in version 1 of the DWARF format (which is very
4832 different from version 2), and it would have been too confusing.  That
4833 debug format is long obsolete, but the option cannot be changed now.
4834 Instead use an additional @option{-g@var{level}} option to change the
4835 debug level for DWARF.
4836
4837 @item -gtoggle
4838 @opindex gtoggle
4839 Turn off generation of debug info, if leaving out this option would have
4840 generated it, or turn it on at level 2 otherwise.  The position of this
4841 argument in the command line does not matter, it takes effect after all
4842 other options are processed, and it does so only once, no matter how
4843 many times it is given.  This is mainly intended to be used with
4844 @option{-fcompare-debug}.
4845
4846 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4847 @opindex fdump-final-insns
4848 Dump the final internal representation (RTL) to @var{file}.  If the
4849 optional argument is omitted (or if @var{file} is @code{.}), the name
4850 of the dump file will be determined by appending @code{.gkd} to the
4851 compilation output file name.
4852
4853 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4854 @opindex fcompare-debug
4855 @opindex fno-compare-debug
4856 If no error occurs during compilation, run the compiler a second time,
4857 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4858 passed to the second compilation.  Dump the final internal
4859 representation in both compilations, and print an error if they differ.
4860
4861 If the equal sign is omitted, the default @option{-gtoggle} is used.
4862
4863 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4864 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4865 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4866 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4867 is used.
4868
4869 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4870 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4871 of the final representation and the second compilation, preventing even
4872 @env{GCC_COMPARE_DEBUG} from taking effect.
4873
4874 To verify full coverage during @option{-fcompare-debug} testing, set
4875 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4876 which GCC will reject as an invalid option in any actual compilation
4877 (rather than preprocessing, assembly or linking).  To get just a
4878 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4879 not overridden} will do.
4880
4881 @item -fcompare-debug-second
4882 @opindex fcompare-debug-second
4883 This option is implicitly passed to the compiler for the second
4884 compilation requested by @option{-fcompare-debug}, along with options to
4885 silence warnings, and omitting other options that would cause
4886 side-effect compiler outputs to files or to the standard output.  Dump
4887 files and preserved temporary files are renamed so as to contain the
4888 @code{.gk} additional extension during the second compilation, to avoid
4889 overwriting those generated by the first.
4890
4891 When this option is passed to the compiler driver, it causes the
4892 @emph{first} compilation to be skipped, which makes it useful for little
4893 other than debugging the compiler proper.
4894
4895 @item -feliminate-dwarf2-dups
4896 @opindex feliminate-dwarf2-dups
4897 Compress DWARF2 debugging information by eliminating duplicated
4898 information about each symbol.  This option only makes sense when
4899 generating DWARF2 debugging information with @option{-gdwarf-2}.
4900
4901 @item -femit-struct-debug-baseonly
4902 Emit debug information for struct-like types
4903 only when the base name of the compilation source file
4904 matches the base name of file in which the struct was defined.
4905
4906 This option substantially reduces the size of debugging information,
4907 but at significant potential loss in type information to the debugger.
4908 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4909 See @option{-femit-struct-debug-detailed} for more detailed control.
4910
4911 This option works only with DWARF 2.
4912
4913 @item -femit-struct-debug-reduced
4914 Emit debug information for struct-like types
4915 only when the base name of the compilation source file
4916 matches the base name of file in which the type was defined,
4917 unless the struct is a template or defined in a system header.
4918
4919 This option significantly reduces the size of debugging information,
4920 with some potential loss in type information to the debugger.
4921 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4922 See @option{-femit-struct-debug-detailed} for more detailed control.
4923
4924 This option works only with DWARF 2.
4925
4926 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4927 Specify the struct-like types
4928 for which the compiler will generate debug information.
4929 The intent is to reduce duplicate struct debug information
4930 between different object files within the same program.
4931
4932 This option is a detailed version of
4933 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4934 which will serve for most needs.
4935
4936 A specification has the syntax@*
4937 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4938
4939 The optional first word limits the specification to
4940 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4941 A struct type is used directly when it is the type of a variable, member.
4942 Indirect uses arise through pointers to structs.
4943 That is, when use of an incomplete struct would be legal, the use is indirect.
4944 An example is
4945 @samp{struct one direct; struct two * indirect;}.
4946
4947 The optional second word limits the specification to
4948 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4949 Generic structs are a bit complicated to explain.
4950 For C++, these are non-explicit specializations of template classes,
4951 or non-template classes within the above.
4952 Other programming languages have generics,
4953 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4954
4955 The third word specifies the source files for those
4956 structs for which the compiler will emit debug information.
4957 The values @samp{none} and @samp{any} have the normal meaning.
4958 The value @samp{base} means that
4959 the base of name of the file in which the type declaration appears
4960 must match the base of the name of the main compilation file.
4961 In practice, this means that
4962 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4963 but types declared in other header will not.
4964 The value @samp{sys} means those types satisfying @samp{base}
4965 or declared in system or compiler headers.
4966
4967 You may need to experiment to determine the best settings for your application.
4968
4969 The default is @samp{-femit-struct-debug-detailed=all}.
4970
4971 This option works only with DWARF 2.
4972
4973 @item -fno-merge-debug-strings
4974 @opindex fmerge-debug-strings
4975 @opindex fno-merge-debug-strings
4976 Direct the linker to not merge together strings in the debugging
4977 information which are identical in different object files.  Merging is
4978 not supported by all assemblers or linkers.  Merging decreases the size
4979 of the debug information in the output file at the cost of increasing
4980 link processing time.  Merging is enabled by default.
4981
4982 @item -fdebug-prefix-map=@var{old}=@var{new}
4983 @opindex fdebug-prefix-map
4984 When compiling files in directory @file{@var{old}}, record debugging
4985 information describing them as in @file{@var{new}} instead.
4986
4987 @item -fno-dwarf2-cfi-asm
4988 @opindex fdwarf2-cfi-asm
4989 @opindex fno-dwarf2-cfi-asm
4990 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4991 instead of using GAS @code{.cfi_*} directives.
4992
4993 @cindex @command{prof}
4994 @item -p
4995 @opindex p
4996 Generate extra code to write profile information suitable for the
4997 analysis program @command{prof}.  You must use this option when compiling
4998 the source files you want data about, and you must also use it when
4999 linking.
5000
5001 @cindex @command{gprof}
5002 @item -pg
5003 @opindex pg
5004 Generate extra code to write profile information suitable for the
5005 analysis program @command{gprof}.  You must use this option when compiling
5006 the source files you want data about, and you must also use it when
5007 linking.
5008
5009 @item -Q
5010 @opindex Q
5011 Makes the compiler print out each function name as it is compiled, and
5012 print some statistics about each pass when it finishes.
5013
5014 @item -ftime-report
5015 @opindex ftime-report
5016 Makes the compiler print some statistics about the time consumed by each
5017 pass when it finishes.
5018
5019 @item -fmem-report
5020 @opindex fmem-report
5021 Makes the compiler print some statistics about permanent memory
5022 allocation when it finishes.
5023
5024 @item -fpre-ipa-mem-report
5025 @opindex fpre-ipa-mem-report
5026 @item -fpost-ipa-mem-report
5027 @opindex fpost-ipa-mem-report
5028 Makes the compiler print some statistics about permanent memory
5029 allocation before or after interprocedural optimization.
5030
5031 @item -fstack-usage
5032 @opindex fstack-usage
5033 Makes the compiler output stack usage information for the program, on a
5034 per-function basis.  The filename for the dump is made by appending
5035 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5036 the output file, if explicitly specified and it is not an executable,
5037 otherwise it is the basename of the source file.  An entry is made up
5038 of three fields:
5039
5040 @itemize
5041 @item
5042 The name of the function.
5043 @item
5044 A number of bytes.
5045 @item
5046 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5047 @end itemize
5048
5049 The qualifier @code{static} means that the function manipulates the stack
5050 statically: a fixed number of bytes are allocated for the frame on function
5051 entry and released on function exit; no stack adjustments are otherwise made
5052 in the function.  The second field is this fixed number of bytes.
5053
5054 The qualifier @code{dynamic} means that the function manipulates the stack
5055 dynamically: in addition to the static allocation described above, stack
5056 adjustments are made in the body of the function, for example to push/pop
5057 arguments around function calls.  If the qualifier @code{bounded} is also
5058 present, the amount of these adjustments is bounded at compile-time and
5059 the second field is an upper bound of the total amount of stack used by
5060 the function.  If it is not present, the amount of these adjustments is
5061 not bounded at compile-time and the second field only represents the
5062 bounded part.
5063
5064 @item -fprofile-arcs
5065 @opindex fprofile-arcs
5066 Add code so that program flow @dfn{arcs} are instrumented.  During
5067 execution the program records how many times each branch and call is
5068 executed and how many times it is taken or returns.  When the compiled
5069 program exits it saves this data to a file called
5070 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5071 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5072 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5073 @var{auxname} is generated from the name of the output file, if
5074 explicitly specified and it is not the final executable, otherwise it is
5075 the basename of the source file.  In both cases any suffix is removed
5076 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5077 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5078 @xref{Cross-profiling}.
5079
5080 @cindex @command{gcov}
5081 @item --coverage
5082 @opindex coverage
5083
5084 This option is used to compile and link code instrumented for coverage
5085 analysis.  The option is a synonym for @option{-fprofile-arcs}
5086 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5087 linking).  See the documentation for those options for more details.
5088
5089 @itemize
5090
5091 @item
5092 Compile the source files with @option{-fprofile-arcs} plus optimization
5093 and code generation options.  For test coverage analysis, use the
5094 additional @option{-ftest-coverage} option.  You do not need to profile
5095 every source file in a program.
5096
5097 @item
5098 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5099 (the latter implies the former).
5100
5101 @item
5102 Run the program on a representative workload to generate the arc profile
5103 information.  This may be repeated any number of times.  You can run
5104 concurrent instances of your program, and provided that the file system
5105 supports locking, the data files will be correctly updated.  Also
5106 @code{fork} calls are detected and correctly handled (double counting
5107 will not happen).
5108
5109 @item
5110 For profile-directed optimizations, compile the source files again with
5111 the same optimization and code generation options plus
5112 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5113 Control Optimization}).
5114
5115 @item
5116 For test coverage analysis, use @command{gcov} to produce human readable
5117 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5118 @command{gcov} documentation for further information.
5119
5120 @end itemize
5121
5122 With @option{-fprofile-arcs}, for each function of your program GCC
5123 creates a program flow graph, then finds a spanning tree for the graph.
5124 Only arcs that are not on the spanning tree have to be instrumented: the
5125 compiler adds code to count the number of times that these arcs are
5126 executed.  When an arc is the only exit or only entrance to a block, the
5127 instrumentation code can be added to the block; otherwise, a new basic
5128 block must be created to hold the instrumentation code.
5129
5130 @need 2000
5131 @item -ftest-coverage
5132 @opindex ftest-coverage
5133 Produce a notes file that the @command{gcov} code-coverage utility
5134 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5135 show program coverage.  Each source file's note file is called
5136 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5137 above for a description of @var{auxname} and instructions on how to
5138 generate test coverage data.  Coverage data will match the source files
5139 more closely, if you do not optimize.
5140
5141 @item -fdbg-cnt-list
5142 @opindex fdbg-cnt-list
5143 Print the name and the counter upper bound for all debug counters.
5144
5145
5146 @item -fdbg-cnt=@var{counter-value-list}
5147 @opindex fdbg-cnt
5148 Set the internal debug counter upper bound.  @var{counter-value-list}
5149 is a comma-separated list of @var{name}:@var{value} pairs
5150 which sets the upper bound of each debug counter @var{name} to @var{value}.
5151 All debug counters have the initial upper bound of @var{UINT_MAX},
5152 thus dbg_cnt() returns true always unless the upper bound is set by this option.
5153 e.g. With -fdbg-cnt=dce:10,tail_call:0
5154 dbg_cnt(dce) will return true only for first 10 invocations
5155
5156 @itemx -fenable-@var{kind}-@var{pass}
5157 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5158 @opindex fdisable-
5159 @opindex fenable-
5160
5161 This is a set of debugging options that are used to explicitly disable/enable
5162 optimization passes. For compiler users, regular options for enabling/disabling
5163 passes should be used instead.
5164
5165 @itemize
5166
5167 @item -fdisable-ipa-@var{pass}
5168 Disable ipa pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5169 statically invoked in the compiler multiple times, the pass name should be
5170 appended with a sequential number starting from 1.
5171
5172 @item -fdisable-rtl-@var{pass}
5173 @item -fdisable-rtl-@var{pass}=@var{range-list}
5174 Disable rtl pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5175 statically invoked in the compiler multiple times, the pass name should be
5176 appended with a sequential number starting from 1.  @var{range-list} is a comma
5177 seperated list of function ranges or assembler names.  Each range is a number
5178 pair seperated by a colon.  The range is inclusive in both ends.  If the range
5179 is trivial, the number pair can be simplified as a single number.  If the
5180 function's cgraph node's @var{uid} is falling within one of the specified ranges,
5181 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5182 function header of a dump file, and the pass names can be dumped by using
5183 option @option{-fdump-passes}.
5184
5185 @item -fdisable-tree-@var{pass}
5186 @item -fdisable-tree-@var{pass}=@var{range-list}
5187 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5188 option arguments.
5189
5190 @item -fenable-ipa-@var{pass}
5191 Enable ipa pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5192 statically invoked in the compiler multiple times, the pass name should be
5193 appended with a sequential number starting from 1.
5194
5195 @item -fenable-rtl-@var{pass}
5196 @item -fenable-rtl-@var{pass}=@var{range-list}
5197 Enable rtl pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5198 description and examples.
5199
5200 @item -fenable-tree-@var{pass}
5201 @item -fenable-tree-@var{pass}=@var{range-list}
5202 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5203 of option arguments.
5204
5205 @smallexample
5206
5207 # disable ccp1 for all functions
5208    -fdisable-tree-ccp1
5209 # disable complete unroll for function whose cgraph node uid is 1
5210    -fenable-tree-cunroll=1
5211 # disable gcse2 for functions at the following ranges [1,1],
5212 # [300,400], and [400,1000]
5213 # disable gcse2 for functions foo and foo2
5214    -fdisable-rtl-gcse2=foo,foo2
5215 # disable early inlining
5216    -fdisable-tree-einline
5217 # disable ipa inlining
5218    -fdisable-ipa-inline
5219 # enable tree full unroll
5220    -fenable-tree-unroll
5221
5222 @end smallexample
5223
5224 @end itemize
5225
5226 @item -d@var{letters}
5227 @itemx -fdump-rtl-@var{pass}
5228 @opindex d
5229 Says to make debugging dumps during compilation at times specified by
5230 @var{letters}.  This is used for debugging the RTL-based passes of the
5231 compiler.  The file names for most of the dumps are made by appending
5232 a pass number and a word to the @var{dumpname}, and the files are
5233 created in the directory of the output file.  Note that the pass
5234 number is computed statically as passes get registered into the pass
5235 manager.  Thus the numbering is not related to the dynamic order of
5236 execution of passes.  In particular, a pass installed by a plugin
5237 could have a number over 200 even if it executed quite early.
5238 @var{dumpname} is generated from the name of the output file, if
5239 explicitly specified and it is not an executable, otherwise it is the
5240 basename of the source file. These switches may have different effects
5241 when @option{-E} is used for preprocessing.
5242
5243 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5244 @option{-d} option @var{letters}.  Here are the possible
5245 letters for use in @var{pass} and @var{letters}, and their meanings:
5246
5247 @table @gcctabopt
5248
5249 @item -fdump-rtl-alignments
5250 @opindex fdump-rtl-alignments
5251 Dump after branch alignments have been computed.
5252
5253 @item -fdump-rtl-asmcons
5254 @opindex fdump-rtl-asmcons
5255 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5256
5257 @item -fdump-rtl-auto_inc_dec
5258 @opindex fdump-rtl-auto_inc_dec
5259 Dump after auto-inc-dec discovery.  This pass is only run on
5260 architectures that have auto inc or auto dec instructions.
5261
5262 @item -fdump-rtl-barriers
5263 @opindex fdump-rtl-barriers
5264 Dump after cleaning up the barrier instructions.
5265
5266 @item -fdump-rtl-bbpart
5267 @opindex fdump-rtl-bbpart
5268 Dump after partitioning hot and cold basic blocks.
5269
5270 @item -fdump-rtl-bbro
5271 @opindex fdump-rtl-bbro
5272 Dump after block reordering.
5273
5274 @item -fdump-rtl-btl1
5275 @itemx -fdump-rtl-btl2
5276 @opindex fdump-rtl-btl2
5277 @opindex fdump-rtl-btl2
5278 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5279 after the two branch
5280 target load optimization passes.
5281
5282 @item -fdump-rtl-bypass
5283 @opindex fdump-rtl-bypass
5284 Dump after jump bypassing and control flow optimizations.
5285
5286 @item -fdump-rtl-combine
5287 @opindex fdump-rtl-combine
5288 Dump after the RTL instruction combination pass.
5289
5290 @item -fdump-rtl-compgotos
5291 @opindex fdump-rtl-compgotos
5292 Dump after duplicating the computed gotos.
5293
5294 @item -fdump-rtl-ce1
5295 @itemx -fdump-rtl-ce2
5296 @itemx -fdump-rtl-ce3
5297 @opindex fdump-rtl-ce1
5298 @opindex fdump-rtl-ce2
5299 @opindex fdump-rtl-ce3
5300 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5301 @option{-fdump-rtl-ce3} enable dumping after the three
5302 if conversion passes.
5303
5304 @itemx -fdump-rtl-cprop_hardreg
5305 @opindex fdump-rtl-cprop_hardreg
5306 Dump after hard register copy propagation.
5307
5308 @itemx -fdump-rtl-csa
5309 @opindex fdump-rtl-csa
5310 Dump after combining stack adjustments.
5311
5312 @item -fdump-rtl-cse1
5313 @itemx -fdump-rtl-cse2
5314 @opindex fdump-rtl-cse1
5315 @opindex fdump-rtl-cse2
5316 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5317 the two common sub-expression elimination passes.
5318
5319 @itemx -fdump-rtl-dce
5320 @opindex fdump-rtl-dce
5321 Dump after the standalone dead code elimination passes.
5322
5323 @itemx -fdump-rtl-dbr
5324 @opindex fdump-rtl-dbr
5325 Dump after delayed branch scheduling.
5326
5327 @item -fdump-rtl-dce1
5328 @itemx -fdump-rtl-dce2
5329 @opindex fdump-rtl-dce1
5330 @opindex fdump-rtl-dce2
5331 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5332 the two dead store elimination passes.
5333
5334 @item -fdump-rtl-eh
5335 @opindex fdump-rtl-eh
5336 Dump after finalization of EH handling code.
5337
5338 @item -fdump-rtl-eh_ranges
5339 @opindex fdump-rtl-eh_ranges
5340 Dump after conversion of EH handling range regions.
5341
5342 @item -fdump-rtl-expand
5343 @opindex fdump-rtl-expand
5344 Dump after RTL generation.
5345
5346 @item -fdump-rtl-fwprop1
5347 @itemx -fdump-rtl-fwprop2
5348 @opindex fdump-rtl-fwprop1
5349 @opindex fdump-rtl-fwprop2
5350 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5351 dumping after the two forward propagation passes.
5352
5353 @item -fdump-rtl-gcse1
5354 @itemx -fdump-rtl-gcse2
5355 @opindex fdump-rtl-gcse1
5356 @opindex fdump-rtl-gcse2
5357 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5358 after global common subexpression elimination.
5359
5360 @item -fdump-rtl-init-regs
5361 @opindex fdump-rtl-init-regs
5362 Dump after the initialization of the registers.
5363
5364 @item -fdump-rtl-initvals
5365 @opindex fdump-rtl-initvals
5366 Dump after the computation of the initial value sets.
5367
5368 @itemx -fdump-rtl-into_cfglayout
5369 @opindex fdump-rtl-into_cfglayout
5370 Dump after converting to cfglayout mode.
5371
5372 @item -fdump-rtl-ira
5373 @opindex fdump-rtl-ira
5374 Dump after iterated register allocation.
5375
5376 @item -fdump-rtl-jump
5377 @opindex fdump-rtl-jump
5378 Dump after the second jump optimization.
5379
5380 @item -fdump-rtl-loop2
5381 @opindex fdump-rtl-loop2
5382 @option{-fdump-rtl-loop2} enables dumping after the rtl
5383 loop optimization passes.
5384
5385 @item -fdump-rtl-mach
5386 @opindex fdump-rtl-mach
5387 Dump after performing the machine dependent reorganization pass, if that
5388 pass exists.
5389
5390 @item -fdump-rtl-mode_sw
5391 @opindex fdump-rtl-mode_sw
5392 Dump after removing redundant mode switches.
5393
5394 @item -fdump-rtl-rnreg
5395 @opindex fdump-rtl-rnreg
5396 Dump after register renumbering.
5397
5398 @itemx -fdump-rtl-outof_cfglayout
5399 @opindex fdump-rtl-outof_cfglayout
5400 Dump after converting from cfglayout mode.
5401
5402 @item -fdump-rtl-peephole2
5403 @opindex fdump-rtl-peephole2
5404 Dump after the peephole pass.
5405
5406 @item -fdump-rtl-postreload
5407 @opindex fdump-rtl-postreload
5408 Dump after post-reload optimizations.
5409
5410 @itemx -fdump-rtl-pro_and_epilogue
5411 @opindex fdump-rtl-pro_and_epilogue
5412 Dump after generating the function pro and epilogues.
5413
5414 @item -fdump-rtl-regmove
5415 @opindex fdump-rtl-regmove
5416 Dump after the register move pass.
5417
5418 @item -fdump-rtl-sched1
5419 @itemx -fdump-rtl-sched2
5420 @opindex fdump-rtl-sched1
5421 @opindex fdump-rtl-sched2
5422 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5423 after the basic block scheduling passes.
5424
5425 @item -fdump-rtl-see
5426 @opindex fdump-rtl-see
5427 Dump after sign extension elimination.
5428
5429 @item -fdump-rtl-seqabstr
5430 @opindex fdump-rtl-seqabstr
5431 Dump after common sequence discovery.
5432
5433 @item -fdump-rtl-shorten
5434 @opindex fdump-rtl-shorten
5435 Dump after shortening branches.
5436
5437 @item -fdump-rtl-sibling
5438 @opindex fdump-rtl-sibling
5439 Dump after sibling call optimizations.
5440
5441 @item -fdump-rtl-split1
5442 @itemx -fdump-rtl-split2
5443 @itemx -fdump-rtl-split3
5444 @itemx -fdump-rtl-split4
5445 @itemx -fdump-rtl-split5
5446 @opindex fdump-rtl-split1
5447 @opindex fdump-rtl-split2
5448 @opindex fdump-rtl-split3
5449 @opindex fdump-rtl-split4
5450 @opindex fdump-rtl-split5
5451 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5452 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5453 @option{-fdump-rtl-split5} enable dumping after five rounds of
5454 instruction splitting.
5455
5456 @item -fdump-rtl-sms
5457 @opindex fdump-rtl-sms
5458 Dump after modulo scheduling.  This pass is only run on some
5459 architectures.
5460
5461 @item -fdump-rtl-stack
5462 @opindex fdump-rtl-stack
5463 Dump after conversion from GCC's "flat register file" registers to the
5464 x87's stack-like registers.  This pass is only run on x86 variants.
5465
5466 @item -fdump-rtl-subreg1
5467 @itemx -fdump-rtl-subreg2
5468 @opindex fdump-rtl-subreg1
5469 @opindex fdump-rtl-subreg2
5470 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5471 the two subreg expansion passes.
5472
5473 @item -fdump-rtl-unshare
5474 @opindex fdump-rtl-unshare
5475 Dump after all rtl has been unshared.
5476
5477 @item -fdump-rtl-vartrack
5478 @opindex fdump-rtl-vartrack
5479 Dump after variable tracking.
5480
5481 @item -fdump-rtl-vregs
5482 @opindex fdump-rtl-vregs
5483 Dump after converting virtual registers to hard registers.
5484
5485 @item -fdump-rtl-web
5486 @opindex fdump-rtl-web
5487 Dump after live range splitting.
5488
5489 @item -fdump-rtl-regclass
5490 @itemx -fdump-rtl-subregs_of_mode_init
5491 @itemx -fdump-rtl-subregs_of_mode_finish
5492 @itemx -fdump-rtl-dfinit
5493 @itemx -fdump-rtl-dfinish
5494 @opindex fdump-rtl-regclass
5495 @opindex fdump-rtl-subregs_of_mode_init
5496 @opindex fdump-rtl-subregs_of_mode_finish
5497 @opindex fdump-rtl-dfinit
5498 @opindex fdump-rtl-dfinish
5499 These dumps are defined but always produce empty files.
5500
5501 @item -fdump-rtl-all
5502 @opindex fdump-rtl-all
5503 Produce all the dumps listed above.
5504
5505 @item -dA
5506 @opindex dA
5507 Annotate the assembler output with miscellaneous debugging information.
5508
5509 @item -dD
5510 @opindex dD
5511 Dump all macro definitions, at the end of preprocessing, in addition to
5512 normal output.
5513
5514 @item -dH
5515 @opindex dH
5516 Produce a core dump whenever an error occurs.
5517
5518 @item -dm
5519 @opindex dm
5520 Print statistics on memory usage, at the end of the run, to
5521 standard error.
5522
5523 @item -dp
5524 @opindex dp
5525 Annotate the assembler output with a comment indicating which
5526 pattern and alternative was used.  The length of each instruction is
5527 also printed.
5528
5529 @item -dP
5530 @opindex dP
5531 Dump the RTL in the assembler output as a comment before each instruction.
5532 Also turns on @option{-dp} annotation.
5533
5534 @item -dv
5535 @opindex dv
5536 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5537 dump a representation of the control flow graph suitable for viewing with VCG
5538 to @file{@var{file}.@var{pass}.vcg}.
5539
5540 @item -dx
5541 @opindex dx
5542 Just generate RTL for a function instead of compiling it.  Usually used
5543 with @option{-fdump-rtl-expand}.
5544 @end table
5545
5546 @item -fdump-noaddr
5547 @opindex fdump-noaddr
5548 When doing debugging dumps, suppress address output.  This makes it more
5549 feasible to use diff on debugging dumps for compiler invocations with
5550 different compiler binaries and/or different
5551 text / bss / data / heap / stack / dso start locations.
5552
5553 @item -fdump-unnumbered
5554 @opindex fdump-unnumbered
5555 When doing debugging dumps, suppress instruction numbers and address output.
5556 This makes it more feasible to use diff on debugging dumps for compiler
5557 invocations with different options, in particular with and without
5558 @option{-g}.
5559
5560 @item -fdump-unnumbered-links
5561 @opindex fdump-unnumbered-links
5562 When doing debugging dumps (see @option{-d} option above), suppress
5563 instruction numbers for the links to the previous and next instructions
5564 in a sequence.
5565
5566 @item -fdump-translation-unit @r{(C++ only)}
5567 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5568 @opindex fdump-translation-unit
5569 Dump a representation of the tree structure for the entire translation
5570 unit to a file.  The file name is made by appending @file{.tu} to the
5571 source file name, and the file is created in the same directory as the
5572 output file.  If the @samp{-@var{options}} form is used, @var{options}
5573 controls the details of the dump as described for the
5574 @option{-fdump-tree} options.
5575
5576 @item -fdump-class-hierarchy @r{(C++ only)}
5577 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5578 @opindex fdump-class-hierarchy
5579 Dump a representation of each class's hierarchy and virtual function
5580 table layout to a file.  The file name is made by appending
5581 @file{.class} to the source file name, and the file is created in the
5582 same directory as the output file.  If the @samp{-@var{options}} form
5583 is used, @var{options} controls the details of the dump as described
5584 for the @option{-fdump-tree} options.
5585
5586 @item -fdump-ipa-@var{switch}
5587 @opindex fdump-ipa
5588 Control the dumping at various stages of inter-procedural analysis
5589 language tree to a file.  The file name is generated by appending a
5590 switch specific suffix to the source file name, and the file is created
5591 in the same directory as the output file.  The following dumps are
5592 possible:
5593
5594 @table @samp
5595 @item all
5596 Enables all inter-procedural analysis dumps.
5597
5598 @item cgraph
5599 Dumps information about call-graph optimization, unused function removal,
5600 and inlining decisions.
5601
5602 @item inline
5603 Dump after function inlining.
5604
5605 @end table
5606
5607 @item -fdump-passes
5608 @opindex fdump-passes
5609 Dump the list of optimization passes that are turned on and off by
5610 the current command line options.
5611
5612 @item -fdump-statistics-@var{option}
5613 @opindex fdump-statistics
5614 Enable and control dumping of pass statistics in a separate file.  The
5615 file name is generated by appending a suffix ending in
5616 @samp{.statistics} to the source file name, and the file is created in
5617 the same directory as the output file.  If the @samp{-@var{option}}
5618 form is used, @samp{-stats} will cause counters to be summed over the
5619 whole compilation unit while @samp{-details} will dump every event as
5620 the passes generate them.  The default with no option is to sum
5621 counters for each function compiled.
5622
5623 @item -fdump-tree-@var{switch}
5624 @itemx -fdump-tree-@var{switch}-@var{options}
5625 @opindex fdump-tree
5626 Control the dumping at various stages of processing the intermediate
5627 language tree to a file.  The file name is generated by appending a
5628 switch specific suffix to the source file name, and the file is
5629 created in the same directory as the output file.  If the
5630 @samp{-@var{options}} form is used, @var{options} is a list of
5631 @samp{-} separated options that control the details of the dump.  Not
5632 all options are applicable to all dumps, those which are not
5633 meaningful will be ignored.  The following options are available
5634
5635 @table @samp
5636 @item address
5637 Print the address of each node.  Usually this is not meaningful as it
5638 changes according to the environment and source file.  Its primary use
5639 is for tying up a dump file with a debug environment.
5640 @item asmname
5641 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5642 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5643 use working backward from mangled names in the assembly file.
5644 @item slim
5645 Inhibit dumping of members of a scope or body of a function merely
5646 because that scope has been reached.  Only dump such items when they
5647 are directly reachable by some other path.  When dumping pretty-printed
5648 trees, this option inhibits dumping the bodies of control structures.
5649 @item raw
5650 Print a raw representation of the tree.  By default, trees are
5651 pretty-printed into a C-like representation.
5652 @item details
5653 Enable more detailed dumps (not honored by every dump option).
5654 @item stats
5655 Enable dumping various statistics about the pass (not honored by every dump
5656 option).
5657 @item blocks
5658 Enable showing basic block boundaries (disabled in raw dumps).
5659 @item vops
5660 Enable showing virtual operands for every statement.
5661 @item lineno
5662 Enable showing line numbers for statements.
5663 @item uid
5664 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5665 @item verbose
5666 Enable showing the tree dump for each statement.
5667 @item eh
5668 Enable showing the EH region number holding each statement.
5669 @item scev
5670 Enable showing scalar evolution analysis details.
5671 @item all
5672 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5673 and @option{lineno}.
5674 @end table
5675
5676 The following tree dumps are possible:
5677 @table @samp
5678
5679 @item original
5680 @opindex fdump-tree-original
5681 Dump before any tree based optimization, to @file{@var{file}.original}.
5682
5683 @item optimized
5684 @opindex fdump-tree-optimized
5685 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5686
5687 @item gimple
5688 @opindex fdump-tree-gimple
5689 Dump each function before and after the gimplification pass to a file.  The
5690 file name is made by appending @file{.gimple} to the source file name.
5691
5692 @item cfg
5693 @opindex fdump-tree-cfg
5694 Dump the control flow graph of each function to a file.  The file name is
5695 made by appending @file{.cfg} to the source file name.
5696
5697 @item vcg
5698 @opindex fdump-tree-vcg
5699 Dump the control flow graph of each function to a file in VCG format.  The
5700 file name is made by appending @file{.vcg} to the source file name.  Note
5701 that if the file contains more than one function, the generated file cannot
5702 be used directly by VCG@.  You will need to cut and paste each function's
5703 graph into its own separate file first.
5704
5705 @item ch
5706 @opindex fdump-tree-ch
5707 Dump each function after copying loop headers.  The file name is made by
5708 appending @file{.ch} to the source file name.
5709
5710 @item ssa
5711 @opindex fdump-tree-ssa
5712 Dump SSA related information to a file.  The file name is made by appending
5713 @file{.ssa} to the source file name.
5714
5715 @item alias
5716 @opindex fdump-tree-alias
5717 Dump aliasing information for each function.  The file name is made by
5718 appending @file{.alias} to the source file name.
5719
5720 @item ccp
5721 @opindex fdump-tree-ccp
5722 Dump each function after CCP@.  The file name is made by appending
5723 @file{.ccp} to the source file name.
5724
5725 @item storeccp
5726 @opindex fdump-tree-storeccp
5727 Dump each function after STORE-CCP@.  The file name is made by appending
5728 @file{.storeccp} to the source file name.
5729
5730 @item pre
5731 @opindex fdump-tree-pre
5732 Dump trees after partial redundancy elimination.  The file name is made
5733 by appending @file{.pre} to the source file name.
5734
5735 @item fre
5736 @opindex fdump-tree-fre
5737 Dump trees after full redundancy elimination.  The file name is made
5738 by appending @file{.fre} to the source file name.
5739
5740 @item copyprop
5741 @opindex fdump-tree-copyprop
5742 Dump trees after copy propagation.  The file name is made
5743 by appending @file{.copyprop} to the source file name.
5744
5745 @item store_copyprop
5746 @opindex fdump-tree-store_copyprop
5747 Dump trees after store copy-propagation.  The file name is made
5748 by appending @file{.store_copyprop} to the source file name.
5749
5750 @item dce
5751 @opindex fdump-tree-dce
5752 Dump each function after dead code elimination.  The file name is made by
5753 appending @file{.dce} to the source file name.
5754
5755 @item mudflap
5756 @opindex fdump-tree-mudflap
5757 Dump each function after adding mudflap instrumentation.  The file name is
5758 made by appending @file{.mudflap} to the source file name.
5759
5760 @item sra
5761 @opindex fdump-tree-sra
5762 Dump each function after performing scalar replacement of aggregates.  The
5763 file name is made by appending @file{.sra} to the source file name.
5764
5765 @item sink
5766 @opindex fdump-tree-sink
5767 Dump each function after performing code sinking.  The file name is made
5768 by appending @file{.sink} to the source file name.
5769
5770 @item dom
5771 @opindex fdump-tree-dom
5772 Dump each function after applying dominator tree optimizations.  The file
5773 name is made by appending @file{.dom} to the source file name.
5774
5775 @item dse
5776 @opindex fdump-tree-dse
5777 Dump each function after applying dead store elimination.  The file
5778 name is made by appending @file{.dse} to the source file name.
5779
5780 @item phiopt
5781 @opindex fdump-tree-phiopt
5782 Dump each function after optimizing PHI nodes into straightline code.  The file
5783 name is made by appending @file{.phiopt} to the source file name.
5784
5785 @item forwprop
5786 @opindex fdump-tree-forwprop
5787 Dump each function after forward propagating single use variables.  The file
5788 name is made by appending @file{.forwprop} to the source file name.
5789
5790 @item copyrename
5791 @opindex fdump-tree-copyrename
5792 Dump each function after applying the copy rename optimization.  The file
5793 name is made by appending @file{.copyrename} to the source file name.
5794
5795 @item nrv
5796 @opindex fdump-tree-nrv
5797 Dump each function after applying the named return value optimization on
5798 generic trees.  The file name is made by appending @file{.nrv} to the source
5799 file name.
5800
5801 @item vect
5802 @opindex fdump-tree-vect
5803 Dump each function after applying vectorization of loops.  The file name is
5804 made by appending @file{.vect} to the source file name.
5805
5806 @item slp
5807 @opindex fdump-tree-slp
5808 Dump each function after applying vectorization of basic blocks.  The file name
5809 is made by appending @file{.slp} to the source file name.
5810
5811 @item vrp
5812 @opindex fdump-tree-vrp
5813 Dump each function after Value Range Propagation (VRP).  The file name
5814 is made by appending @file{.vrp} to the source file name.
5815
5816 @item all
5817 @opindex fdump-tree-all
5818 Enable all the available tree dumps with the flags provided in this option.
5819 @end table
5820
5821 @item -ftree-vectorizer-verbose=@var{n}
5822 @opindex ftree-vectorizer-verbose
5823 This option controls the amount of debugging output the vectorizer prints.
5824 This information is written to standard error, unless
5825 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5826 in which case it is output to the usual dump listing file, @file{.vect}.
5827 For @var{n}=0 no diagnostic information is reported.
5828 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5829 and the total number of loops that got vectorized.
5830 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5831 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5832 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5833 level that @option{-fdump-tree-vect-stats} uses.
5834 Higher verbosity levels mean either more information dumped for each
5835 reported loop, or same amount of information reported for more loops:
5836 if @var{n}=3, vectorizer cost model information is reported.
5837 If @var{n}=4, alignment related information is added to the reports.
5838 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5839 memory access-patterns) is added to the reports.
5840 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5841 that did not pass the first analysis phase (i.e., may not be countable, or
5842 may have complicated control-flow).
5843 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5844 If @var{n}=8, SLP related information is added to the reports.
5845 For @var{n}=9, all the information the vectorizer generates during its
5846 analysis and transformation is reported.  This is the same verbosity level
5847 that @option{-fdump-tree-vect-details} uses.
5848
5849 @item -frandom-seed=@var{string}
5850 @opindex frandom-seed
5851 This option provides a seed that GCC uses when it would otherwise use
5852 random numbers.  It is used to generate certain symbol names
5853 that have to be different in every compiled file.  It is also used to
5854 place unique stamps in coverage data files and the object files that
5855 produce them.  You can use the @option{-frandom-seed} option to produce
5856 reproducibly identical object files.
5857
5858 The @var{string} should be different for every file you compile.
5859
5860 @item -fsched-verbose=@var{n}
5861 @opindex fsched-verbose
5862 On targets that use instruction scheduling, this option controls the
5863 amount of debugging output the scheduler prints.  This information is
5864 written to standard error, unless @option{-fdump-rtl-sched1} or
5865 @option{-fdump-rtl-sched2} is specified, in which case it is output
5866 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5867 respectively.  However for @var{n} greater than nine, the output is
5868 always printed to standard error.
5869
5870 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5871 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5872 For @var{n} greater than one, it also output basic block probabilities,
5873 detailed ready list information and unit/insn info.  For @var{n} greater
5874 than two, it includes RTL at abort point, control-flow and regions info.
5875 And for @var{n} over four, @option{-fsched-verbose} also includes
5876 dependence info.
5877
5878 @item -save-temps
5879 @itemx -save-temps=cwd
5880 @opindex save-temps
5881 Store the usual ``temporary'' intermediate files permanently; place them
5882 in the current directory and name them based on the source file.  Thus,
5883 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5884 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5885 preprocessed @file{foo.i} output file even though the compiler now
5886 normally uses an integrated preprocessor.
5887
5888 When used in combination with the @option{-x} command line option,
5889 @option{-save-temps} is sensible enough to avoid over writing an
5890 input source file with the same extension as an intermediate file.
5891 The corresponding intermediate file may be obtained by renaming the
5892 source file before using @option{-save-temps}.
5893
5894 If you invoke GCC in parallel, compiling several different source
5895 files that share a common base name in different subdirectories or the
5896 same source file compiled for multiple output destinations, it is
5897 likely that the different parallel compilers will interfere with each
5898 other, and overwrite the temporary files.  For instance:
5899
5900 @smallexample
5901 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5902 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5903 @end smallexample
5904
5905 may result in @file{foo.i} and @file{foo.o} being written to
5906 simultaneously by both compilers.
5907
5908 @item -save-temps=obj
5909 @opindex save-temps=obj
5910 Store the usual ``temporary'' intermediate files permanently.  If the
5911 @option{-o} option is used, the temporary files are based on the
5912 object file.  If the @option{-o} option is not used, the
5913 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5914
5915 For example:
5916
5917 @smallexample
5918 gcc -save-temps=obj -c foo.c
5919 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5920 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5921 @end smallexample
5922
5923 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5924 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5925 @file{dir2/yfoobar.o}.
5926
5927 @item -time@r{[}=@var{file}@r{]}
5928 @opindex time
5929 Report the CPU time taken by each subprocess in the compilation
5930 sequence.  For C source files, this is the compiler proper and assembler
5931 (plus the linker if linking is done).
5932
5933 Without the specification of an output file, the output looks like this:
5934
5935 @smallexample
5936 # cc1 0.12 0.01
5937 # as 0.00 0.01
5938 @end smallexample
5939
5940 The first number on each line is the ``user time'', that is time spent
5941 executing the program itself.  The second number is ``system time'',
5942 time spent executing operating system routines on behalf of the program.
5943 Both numbers are in seconds.
5944
5945 With the specification of an output file, the output is appended to the
5946 named file, and it looks like this:
5947
5948 @smallexample
5949 0.12 0.01 cc1 @var{options}
5950 0.00 0.01 as @var{options}
5951 @end smallexample
5952
5953 The ``user time'' and the ``system time'' are moved before the program
5954 name, and the options passed to the program are displayed, so that one
5955 can later tell what file was being compiled, and with which options.
5956
5957 @item -fvar-tracking
5958 @opindex fvar-tracking
5959 Run variable tracking pass.  It computes where variables are stored at each
5960 position in code.  Better debugging information is then generated
5961 (if the debugging information format supports this information).
5962
5963 It is enabled by default when compiling with optimization (@option{-Os},
5964 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5965 the debug info format supports it.
5966
5967 @item -fvar-tracking-assignments
5968 @opindex fvar-tracking-assignments
5969 @opindex fno-var-tracking-assignments
5970 Annotate assignments to user variables early in the compilation and
5971 attempt to carry the annotations over throughout the compilation all the
5972 way to the end, in an attempt to improve debug information while
5973 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5974
5975 It can be enabled even if var-tracking is disabled, in which case
5976 annotations will be created and maintained, but discarded at the end.
5977
5978 @item -fvar-tracking-assignments-toggle
5979 @opindex fvar-tracking-assignments-toggle
5980 @opindex fno-var-tracking-assignments-toggle
5981 Toggle @option{-fvar-tracking-assignments}, in the same way that
5982 @option{-gtoggle} toggles @option{-g}.
5983
5984 @item -print-file-name=@var{library}
5985 @opindex print-file-name
5986 Print the full absolute name of the library file @var{library} that
5987 would be used when linking---and don't do anything else.  With this
5988 option, GCC does not compile or link anything; it just prints the
5989 file name.
5990
5991 @item -print-multi-directory
5992 @opindex print-multi-directory
5993 Print the directory name corresponding to the multilib selected by any
5994 other switches present in the command line.  This directory is supposed
5995 to exist in @env{GCC_EXEC_PREFIX}.
5996
5997 @item -print-multi-lib
5998 @opindex print-multi-lib
5999 Print the mapping from multilib directory names to compiler switches
6000 that enable them.  The directory name is separated from the switches by
6001 @samp{;}, and each switch starts with an @samp{@@} instead of the
6002 @samp{-}, without spaces between multiple switches.  This is supposed to
6003 ease shell-processing.
6004
6005 @item -print-multi-os-directory
6006 @opindex print-multi-os-directory
6007 Print the path to OS libraries for the selected
6008 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6009 present in the @file{lib} subdirectory and no multilibs are used, this is
6010 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6011 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6012 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6013 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6014
6015 @item -print-prog-name=@var{program}
6016 @opindex print-prog-name
6017 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6018
6019 @item -print-libgcc-file-name
6020 @opindex print-libgcc-file-name
6021 Same as @option{-print-file-name=libgcc.a}.
6022
6023 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6024 but you do want to link with @file{libgcc.a}.  You can do
6025
6026 @smallexample
6027 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6028 @end smallexample
6029
6030 @item -print-search-dirs
6031 @opindex print-search-dirs
6032 Print the name of the configured installation directory and a list of
6033 program and library directories @command{gcc} will search---and don't do anything else.
6034
6035 This is useful when @command{gcc} prints the error message
6036 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6037 To resolve this you either need to put @file{cpp0} and the other compiler
6038 components where @command{gcc} expects to find them, or you can set the environment
6039 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6040 Don't forget the trailing @samp{/}.
6041 @xref{Environment Variables}.
6042
6043 @item -print-sysroot
6044 @opindex print-sysroot
6045 Print the target sysroot directory that will be used during
6046 compilation.  This is the target sysroot specified either at configure
6047 time or using the @option{--sysroot} option, possibly with an extra
6048 suffix that depends on compilation options.  If no target sysroot is
6049 specified, the option prints nothing.
6050
6051 @item -print-sysroot-headers-suffix
6052 @opindex print-sysroot-headers-suffix
6053 Print the suffix added to the target sysroot when searching for
6054 headers, or give an error if the compiler is not configured with such
6055 a suffix---and don't do anything else.
6056
6057 @item -dumpmachine
6058 @opindex dumpmachine
6059 Print the compiler's target machine (for example,
6060 @samp{i686-pc-linux-gnu})---and don't do anything else.
6061
6062 @item -dumpversion
6063 @opindex dumpversion
6064 Print the compiler version (for example, @samp{3.0})---and don't do
6065 anything else.
6066
6067 @item -dumpspecs
6068 @opindex dumpspecs
6069 Print the compiler's built-in specs---and don't do anything else.  (This
6070 is used when GCC itself is being built.)  @xref{Spec Files}.
6071
6072 @item -feliminate-unused-debug-types
6073 @opindex feliminate-unused-debug-types
6074 Normally, when producing DWARF2 output, GCC will emit debugging
6075 information for all types declared in a compilation
6076 unit, regardless of whether or not they are actually used
6077 in that compilation unit.  Sometimes this is useful, such as
6078 if, in the debugger, you want to cast a value to a type that is
6079 not actually used in your program (but is declared).  More often,
6080 however, this results in a significant amount of wasted space.
6081 With this option, GCC will avoid producing debug symbol output
6082 for types that are nowhere used in the source file being compiled.
6083 @end table
6084
6085 @node Optimize Options
6086 @section Options That Control Optimization
6087 @cindex optimize options
6088 @cindex options, optimization
6089
6090 These options control various sorts of optimizations.
6091
6092 Without any optimization option, the compiler's goal is to reduce the
6093 cost of compilation and to make debugging produce the expected
6094 results.  Statements are independent: if you stop the program with a
6095 breakpoint between statements, you can then assign a new value to any
6096 variable or change the program counter to any other statement in the
6097 function and get exactly the results you would expect from the source
6098 code.
6099
6100 Turning on optimization flags makes the compiler attempt to improve
6101 the performance and/or code size at the expense of compilation time
6102 and possibly the ability to debug the program.
6103
6104 The compiler performs optimization based on the knowledge it has of the
6105 program.  Compiling multiple files at once to a single output file mode allows
6106 the compiler to use information gained from all of the files when compiling
6107 each of them.
6108
6109 Not all optimizations are controlled directly by a flag.  Only
6110 optimizations that have a flag are listed in this section.
6111
6112 Most optimizations are only enabled if an @option{-O} level is set on
6113 the command line.  Otherwise they are disabled, even if individual
6114 optimization flags are specified.
6115
6116 Depending on the target and how GCC was configured, a slightly different
6117 set of optimizations may be enabled at each @option{-O} level than
6118 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
6119 to find out the exact set of optimizations that are enabled at each level.
6120 @xref{Overall Options}, for examples.
6121
6122 @table @gcctabopt
6123 @item -O
6124 @itemx -O1
6125 @opindex O
6126 @opindex O1
6127 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6128 more memory for a large function.
6129
6130 With @option{-O}, the compiler tries to reduce code size and execution
6131 time, without performing any optimizations that take a great deal of
6132 compilation time.
6133
6134 @option{-O} turns on the following optimization flags:
6135 @gccoptlist{
6136 -fauto-inc-dec @gol
6137 -fcompare-elim @gol
6138 -fcprop-registers @gol
6139 -fdce @gol
6140 -fdefer-pop @gol
6141 -fdelayed-branch @gol
6142 -fdse @gol
6143 -fguess-branch-probability @gol
6144 -fif-conversion2 @gol
6145 -fif-conversion @gol
6146 -fipa-pure-const @gol
6147 -fipa-profile @gol
6148 -fipa-reference @gol
6149 -fmerge-constants
6150 -fsplit-wide-types @gol
6151 -ftree-bit-ccp @gol
6152 -ftree-builtin-call-dce @gol
6153 -ftree-ccp @gol
6154 -ftree-ch @gol
6155 -ftree-copyrename @gol
6156 -ftree-dce @gol
6157 -ftree-dominator-opts @gol
6158 -ftree-dse @gol
6159 -ftree-forwprop @gol
6160 -ftree-fre @gol
6161 -ftree-phiprop @gol
6162 -ftree-sra @gol
6163 -ftree-pta @gol
6164 -ftree-ter @gol
6165 -funit-at-a-time}
6166
6167 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6168 where doing so does not interfere with debugging.
6169
6170 @item -O2
6171 @opindex O2
6172 Optimize even more.  GCC performs nearly all supported optimizations
6173 that do not involve a space-speed tradeoff.
6174 As compared to @option{-O}, this option increases both compilation time
6175 and the performance of the generated code.
6176
6177 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6178 also turns on the following optimization flags:
6179 @gccoptlist{-fthread-jumps @gol
6180 -falign-functions  -falign-jumps @gol
6181 -falign-loops  -falign-labels @gol
6182 -fcaller-saves @gol
6183 -fcrossjumping @gol
6184 -fcse-follow-jumps  -fcse-skip-blocks @gol
6185 -fdelete-null-pointer-checks @gol
6186 -fdevirtualize @gol
6187 -fexpensive-optimizations @gol
6188 -fgcse  -fgcse-lm  @gol
6189 -finline-small-functions @gol
6190 -findirect-inlining @gol
6191 -fipa-sra @gol
6192 -foptimize-sibling-calls @gol
6193 -fpartial-inlining @gol
6194 -fpeephole2 @gol
6195 -fregmove @gol
6196 -freorder-blocks  -freorder-functions @gol
6197 -frerun-cse-after-loop  @gol
6198 -fsched-interblock  -fsched-spec @gol
6199 -fschedule-insns  -fschedule-insns2 @gol
6200 -fstrict-aliasing -fstrict-overflow @gol
6201 -ftree-switch-conversion -ftree-tail-merge @gol
6202 -ftree-pre @gol
6203 -ftree-vrp}
6204
6205 Please note the warning under @option{-fgcse} about
6206 invoking @option{-O2} on programs that use computed gotos.
6207
6208 @item -O3
6209 @opindex O3
6210 Optimize yet more.  @option{-O3} turns on all optimizations specified
6211 by @option{-O2} and also turns on the @option{-finline-functions},
6212 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6213 @option{-fgcse-after-reload}, @option{-ftree-vectorize} and
6214 @option{-fipa-cp-clone} options.
6215
6216 @item -O0
6217 @opindex O0
6218 Reduce compilation time and make debugging produce the expected
6219 results.  This is the default.
6220
6221 @item -Os
6222 @opindex Os
6223 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6224 do not typically increase code size.  It also performs further
6225 optimizations designed to reduce code size.
6226
6227 @option{-Os} disables the following optimization flags:
6228 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6229 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6230 -fprefetch-loop-arrays  -ftree-vect-loop-version}
6231
6232 @item -Ofast
6233 @opindex Ofast
6234 Disregard strict standards compliance.  @option{-Ofast} enables all
6235 @option{-O3} optimizations.  It also enables optimizations that are not
6236 valid for all standard compliant programs.
6237 It turns on @option{-ffast-math} and the Fortran-specific
6238 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6239
6240 If you use multiple @option{-O} options, with or without level numbers,
6241 the last such option is the one that is effective.
6242 @end table
6243
6244 Options of the form @option{-f@var{flag}} specify machine-independent
6245 flags.  Most flags have both positive and negative forms; the negative
6246 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
6247 below, only one of the forms is listed---the one you typically will
6248 use.  You can figure out the other form by either removing @samp{no-}
6249 or adding it.
6250
6251 The following options control specific optimizations.  They are either
6252 activated by @option{-O} options or are related to ones that are.  You
6253 can use the following flags in the rare cases when ``fine-tuning'' of
6254 optimizations to be performed is desired.
6255
6256 @table @gcctabopt
6257 @item -fno-default-inline
6258 @opindex fno-default-inline
6259 Do not make member functions inline by default merely because they are
6260 defined inside the class scope (C++ only).  Otherwise, when you specify
6261 @w{@option{-O}}, member functions defined inside class scope are compiled
6262 inline by default; i.e., you don't need to add @samp{inline} in front of
6263 the member function name.
6264
6265 @item -fno-defer-pop
6266 @opindex fno-defer-pop
6267 Always pop the arguments to each function call as soon as that function
6268 returns.  For machines which must pop arguments after a function call,
6269 the compiler normally lets arguments accumulate on the stack for several
6270 function calls and pops them all at once.
6271
6272 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6273
6274 @item -fforward-propagate
6275 @opindex fforward-propagate
6276 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6277 instructions and checks if the result can be simplified.  If loop unrolling
6278 is active, two passes are performed and the second is scheduled after
6279 loop unrolling.
6280
6281 This option is enabled by default at optimization levels @option{-O},
6282 @option{-O2}, @option{-O3}, @option{-Os}.
6283
6284 @item -ffp-contract=@var{style}
6285 @opindex ffp-contract
6286 @option{-ffp-contract=off} disables floating-point expression contraction.
6287 @option{-ffp-contract=fast} enables floating-point expression contraction
6288 such as forming of fused multiply-add operations if the target has
6289 native support for them.
6290 @option{-ffp-contract=on} enables floating-point expression contraction
6291 if allowed by the language standard.  This is currently not implemented
6292 and treated equal to @option{-ffp-contract=off}.
6293
6294 The default is @option{-ffp-contract=fast}.
6295
6296 @item -fomit-frame-pointer
6297 @opindex fomit-frame-pointer
6298 Don't keep the frame pointer in a register for functions that
6299 don't need one.  This avoids the instructions to save, set up and
6300 restore frame pointers; it also makes an extra register available
6301 in many functions.  @strong{It also makes debugging impossible on
6302 some machines.}
6303
6304 On some machines, such as the VAX, this flag has no effect, because
6305 the standard calling sequence automatically handles the frame pointer
6306 and nothing is saved by pretending it doesn't exist.  The
6307 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6308 whether a target machine supports this flag.  @xref{Registers,,Register
6309 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6310
6311 Starting with GCC version 4.6, the default setting (when not optimizing for
6312 size) for 32-bit Linux x86 and 32-bit Darwin x86 targets has been changed to
6313 @option{-fomit-frame-pointer}.  The default can be reverted to
6314 @option{-fno-omit-frame-pointer} by configuring GCC with the
6315 @option{--enable-frame-pointer} configure option.
6316
6317 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6318
6319 @item -foptimize-sibling-calls
6320 @opindex foptimize-sibling-calls
6321 Optimize sibling and tail recursive calls.
6322
6323 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6324
6325 @item -fno-inline
6326 @opindex fno-inline
6327 Don't pay attention to the @code{inline} keyword.  Normally this option
6328 is used to keep the compiler from expanding any functions inline.
6329 Note that if you are not optimizing, no functions can be expanded inline.
6330
6331 @item -finline-small-functions
6332 @opindex finline-small-functions
6333 Integrate functions into their callers when their body is smaller than expected
6334 function call code (so overall size of program gets smaller).  The compiler
6335 heuristically decides which functions are simple enough to be worth integrating
6336 in this way.
6337
6338 Enabled at level @option{-O2}.
6339
6340 @item -findirect-inlining
6341 @opindex findirect-inlining
6342 Inline also indirect calls that are discovered to be known at compile
6343 time thanks to previous inlining.  This option has any effect only
6344 when inlining itself is turned on by the @option{-finline-functions}
6345 or @option{-finline-small-functions} options.
6346
6347 Enabled at level @option{-O2}.
6348
6349 @item -finline-functions
6350 @opindex finline-functions
6351 Integrate all simple functions into their callers.  The compiler
6352 heuristically decides which functions are simple enough to be worth
6353 integrating in this way.
6354
6355 If all calls to a given function are integrated, and the function is
6356 declared @code{static}, then the function is normally not output as
6357 assembler code in its own right.
6358
6359 Enabled at level @option{-O3}.
6360
6361 @item -finline-functions-called-once
6362 @opindex finline-functions-called-once
6363 Consider all @code{static} functions called once for inlining into their
6364 caller even if they are not marked @code{inline}.  If a call to a given
6365 function is integrated, then the function is not output as assembler code
6366 in its own right.
6367
6368 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6369
6370 @item -fearly-inlining
6371 @opindex fearly-inlining
6372 Inline functions marked by @code{always_inline} and functions whose body seems
6373 smaller than the function call overhead early before doing
6374 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6375 makes profiling significantly cheaper and usually inlining faster on programs
6376 having large chains of nested wrapper functions.
6377
6378 Enabled by default.
6379
6380 @item -fipa-sra
6381 @opindex fipa-sra
6382 Perform interprocedural scalar replacement of aggregates, removal of
6383 unused parameters and replacement of parameters passed by reference
6384 by parameters passed by value.
6385
6386 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6387
6388 @item -finline-limit=@var{n}
6389 @opindex finline-limit
6390 By default, GCC limits the size of functions that can be inlined.  This flag
6391 allows coarse control of this limit.  @var{n} is the size of functions that
6392 can be inlined in number of pseudo instructions.
6393
6394 Inlining is actually controlled by a number of parameters, which may be
6395 specified individually by using @option{--param @var{name}=@var{value}}.
6396 The @option{-finline-limit=@var{n}} option sets some of these parameters
6397 as follows:
6398
6399 @table @gcctabopt
6400 @item max-inline-insns-single
6401 is set to @var{n}/2.
6402 @item max-inline-insns-auto
6403 is set to @var{n}/2.
6404 @end table
6405
6406 See below for a documentation of the individual
6407 parameters controlling inlining and for the defaults of these parameters.
6408
6409 @emph{Note:} there may be no value to @option{-finline-limit} that results
6410 in default behavior.
6411
6412 @emph{Note:} pseudo instruction represents, in this particular context, an
6413 abstract measurement of function's size.  In no way does it represent a count
6414 of assembly instructions and as such its exact meaning might change from one
6415 release to an another.
6416
6417 @item -fno-keep-inline-dllexport
6418 @opindex -fno-keep-inline-dllexport
6419 This is a more fine-grained version of @option{-fkeep-inline-functions},
6420 which applies only to functions that are declared using the @code{dllexport}
6421 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6422 Functions}.)
6423
6424 @item -fkeep-inline-functions
6425 @opindex fkeep-inline-functions
6426 In C, emit @code{static} functions that are declared @code{inline}
6427 into the object file, even if the function has been inlined into all
6428 of its callers.  This switch does not affect functions using the
6429 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6430 inline functions into the object file.
6431
6432 @item -fkeep-static-consts
6433 @opindex fkeep-static-consts
6434 Emit variables declared @code{static const} when optimization isn't turned
6435 on, even if the variables aren't referenced.
6436
6437 GCC enables this option by default.  If you want to force the compiler to
6438 check if the variable was referenced, regardless of whether or not
6439 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6440
6441 @item -fmerge-constants
6442 @opindex fmerge-constants
6443 Attempt to merge identical constants (string constants and floating point
6444 constants) across compilation units.
6445
6446 This option is the default for optimized compilation if the assembler and
6447 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6448 behavior.
6449
6450 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6451
6452 @item -fmerge-all-constants
6453 @opindex fmerge-all-constants
6454 Attempt to merge identical constants and identical variables.
6455
6456 This option implies @option{-fmerge-constants}.  In addition to
6457 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6458 arrays or initialized constant variables with integral or floating point
6459 types.  Languages like C or C++ require each variable, including multiple
6460 instances of the same variable in recursive calls, to have distinct locations,
6461 so using this option will result in non-conforming
6462 behavior.
6463
6464 @item -fmodulo-sched
6465 @opindex fmodulo-sched
6466 Perform swing modulo scheduling immediately before the first scheduling
6467 pass.  This pass looks at innermost loops and reorders their
6468 instructions by overlapping different iterations.
6469
6470 @item -fmodulo-sched-allow-regmoves
6471 @opindex fmodulo-sched-allow-regmoves
6472 Perform more aggressive SMS based modulo scheduling with register moves
6473 allowed.  By setting this flag certain anti-dependences edges will be
6474 deleted which will trigger the generation of reg-moves based on the
6475 life-range analysis.  This option is effective only with
6476 @option{-fmodulo-sched} enabled.
6477
6478 @item -fno-branch-count-reg
6479 @opindex fno-branch-count-reg
6480 Do not use ``decrement and branch'' instructions on a count register,
6481 but instead generate a sequence of instructions that decrement a
6482 register, compare it against zero, then branch based upon the result.
6483 This option is only meaningful on architectures that support such
6484 instructions, which include x86, PowerPC, IA-64 and S/390.
6485
6486 The default is @option{-fbranch-count-reg}.
6487
6488 @item -fno-function-cse
6489 @opindex fno-function-cse
6490 Do not put function addresses in registers; make each instruction that
6491 calls a constant function contain the function's address explicitly.
6492
6493 This option results in less efficient code, but some strange hacks
6494 that alter the assembler output may be confused by the optimizations
6495 performed when this option is not used.
6496
6497 The default is @option{-ffunction-cse}
6498
6499 @item -fno-zero-initialized-in-bss
6500 @opindex fno-zero-initialized-in-bss
6501 If the target supports a BSS section, GCC by default puts variables that
6502 are initialized to zero into BSS@.  This can save space in the resulting
6503 code.
6504
6505 This option turns off this behavior because some programs explicitly
6506 rely on variables going to the data section.  E.g., so that the
6507 resulting executable can find the beginning of that section and/or make
6508 assumptions based on that.
6509
6510 The default is @option{-fzero-initialized-in-bss}.
6511
6512 @item -fmudflap -fmudflapth -fmudflapir
6513 @opindex fmudflap
6514 @opindex fmudflapth
6515 @opindex fmudflapir
6516 @cindex bounds checking
6517 @cindex mudflap
6518 For front-ends that support it (C and C++), instrument all risky
6519 pointer/array dereferencing operations, some standard library
6520 string/heap functions, and some other associated constructs with
6521 range/validity tests.  Modules so instrumented should be immune to
6522 buffer overflows, invalid heap use, and some other classes of C/C++
6523 programming errors.  The instrumentation relies on a separate runtime
6524 library (@file{libmudflap}), which will be linked into a program if
6525 @option{-fmudflap} is given at link time.  Run-time behavior of the
6526 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6527 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6528 for its options.
6529
6530 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6531 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6532 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6533 instrumentation should ignore pointer reads.  This produces less
6534 instrumentation (and therefore faster execution) and still provides
6535 some protection against outright memory corrupting writes, but allows
6536 erroneously read data to propagate within a program.
6537
6538 @item -fthread-jumps
6539 @opindex fthread-jumps
6540 Perform optimizations where we check to see if a jump branches to a
6541 location where another comparison subsumed by the first is found.  If
6542 so, the first branch is redirected to either the destination of the
6543 second branch or a point immediately following it, depending on whether
6544 the condition is known to be true or false.
6545
6546 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6547
6548 @item -fsplit-wide-types
6549 @opindex fsplit-wide-types
6550 When using a type that occupies multiple registers, such as @code{long
6551 long} on a 32-bit system, split the registers apart and allocate them
6552 independently.  This normally generates better code for those types,
6553 but may make debugging more difficult.
6554
6555 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6556 @option{-Os}.
6557
6558 @item -fcse-follow-jumps
6559 @opindex fcse-follow-jumps
6560 In common subexpression elimination (CSE), scan through jump instructions
6561 when the target of the jump is not reached by any other path.  For
6562 example, when CSE encounters an @code{if} statement with an
6563 @code{else} clause, CSE will follow the jump when the condition
6564 tested is false.
6565
6566 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6567
6568 @item -fcse-skip-blocks
6569 @opindex fcse-skip-blocks
6570 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6571 follow jumps which conditionally skip over blocks.  When CSE
6572 encounters a simple @code{if} statement with no else clause,
6573 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6574 body of the @code{if}.
6575
6576 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6577
6578 @item -frerun-cse-after-loop
6579 @opindex frerun-cse-after-loop
6580 Re-run common subexpression elimination after loop optimizations has been
6581 performed.
6582
6583 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6584
6585 @item -fgcse
6586 @opindex fgcse
6587 Perform a global common subexpression elimination pass.
6588 This pass also performs global constant and copy propagation.
6589
6590 @emph{Note:} When compiling a program using computed gotos, a GCC
6591 extension, you may get better runtime performance if you disable
6592 the global common subexpression elimination pass by adding
6593 @option{-fno-gcse} to the command line.
6594
6595 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6596
6597 @item -fgcse-lm
6598 @opindex fgcse-lm
6599 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6600 attempt to move loads which are only killed by stores into themselves.  This
6601 allows a loop containing a load/store sequence to be changed to a load outside
6602 the loop, and a copy/store within the loop.
6603
6604 Enabled by default when gcse is enabled.
6605
6606 @item -fgcse-sm
6607 @opindex fgcse-sm
6608 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6609 global common subexpression elimination.  This pass will attempt to move
6610 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6611 loops containing a load/store sequence can be changed to a load before
6612 the loop and a store after the loop.
6613
6614 Not enabled at any optimization level.
6615
6616 @item -fgcse-las
6617 @opindex fgcse-las
6618 When @option{-fgcse-las} is enabled, the global common subexpression
6619 elimination pass eliminates redundant loads that come after stores to the
6620 same memory location (both partial and full redundancies).
6621
6622 Not enabled at any optimization level.
6623
6624 @item -fgcse-after-reload
6625 @opindex fgcse-after-reload
6626 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6627 pass is performed after reload.  The purpose of this pass is to cleanup
6628 redundant spilling.
6629
6630 @item -funsafe-loop-optimizations
6631 @opindex funsafe-loop-optimizations
6632 If given, the loop optimizer will assume that loop indices do not
6633 overflow, and that the loops with nontrivial exit condition are not
6634 infinite.  This enables a wider range of loop optimizations even if
6635 the loop optimizer itself cannot prove that these assumptions are valid.
6636 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6637 if it finds this kind of loop.
6638
6639 @item -fcrossjumping
6640 @opindex fcrossjumping
6641 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6642 resulting code may or may not perform better than without cross-jumping.
6643
6644 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6645
6646 @item -fauto-inc-dec
6647 @opindex fauto-inc-dec
6648 Combine increments or decrements of addresses with memory accesses.
6649 This pass is always skipped on architectures that do not have
6650 instructions to support this.  Enabled by default at @option{-O} and
6651 higher on architectures that support this.
6652
6653 @item -fdce
6654 @opindex fdce
6655 Perform dead code elimination (DCE) on RTL@.
6656 Enabled by default at @option{-O} and higher.
6657
6658 @item -fdse
6659 @opindex fdse
6660 Perform dead store elimination (DSE) on RTL@.
6661 Enabled by default at @option{-O} and higher.
6662
6663 @item -fif-conversion
6664 @opindex fif-conversion
6665 Attempt to transform conditional jumps into branch-less equivalents.  This
6666 include use of conditional moves, min, max, set flags and abs instructions, and
6667 some tricks doable by standard arithmetics.  The use of conditional execution
6668 on chips where it is available is controlled by @code{if-conversion2}.
6669
6670 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6671
6672 @item -fif-conversion2
6673 @opindex fif-conversion2
6674 Use conditional execution (where available) to transform conditional jumps into
6675 branch-less equivalents.
6676
6677 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6678
6679 @item -fdelete-null-pointer-checks
6680 @opindex fdelete-null-pointer-checks
6681 Assume that programs cannot safely dereference null pointers, and that
6682 no code or data element resides there.  This enables simple constant
6683 folding optimizations at all optimization levels.  In addition, other
6684 optimization passes in GCC use this flag to control global dataflow
6685 analyses that eliminate useless checks for null pointers; these assume
6686 that if a pointer is checked after it has already been dereferenced,
6687 it cannot be null.
6688
6689 Note however that in some environments this assumption is not true.
6690 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6691 for programs which depend on that behavior.
6692
6693 Some targets, especially embedded ones, disable this option at all levels.
6694 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6695 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6696 are enabled independently at different optimization levels.
6697
6698 @item -fdevirtualize
6699 @opindex fdevirtualize
6700 Attempt to convert calls to virtual functions to direct calls.  This
6701 is done both within a procedure and interprocedurally as part of
6702 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
6703 propagation (@option{-fipa-cp}).
6704 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6705
6706 @item -fexpensive-optimizations
6707 @opindex fexpensive-optimizations
6708 Perform a number of minor optimizations that are relatively expensive.
6709
6710 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6711
6712 @item -free
6713 @opindex free
6714 Attempt to remove redundant extension instructions.  This is especially
6715 helpful for the x86-64 architecture which implicitly zero-extends in 64-bit
6716 registers after writing to their lower 32-bit half.
6717
6718 Enabled for x86 at levels @option{-O2}, @option{-O3}.
6719
6720 @item -foptimize-register-move
6721 @itemx -fregmove
6722 @opindex foptimize-register-move
6723 @opindex fregmove
6724 Attempt to reassign register numbers in move instructions and as
6725 operands of other simple instructions in order to maximize the amount of
6726 register tying.  This is especially helpful on machines with two-operand
6727 instructions.
6728
6729 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6730 optimization.
6731
6732 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6733
6734 @item -fira-algorithm=@var{algorithm}
6735 Use specified coloring algorithm for the integrated register
6736 allocator.  The @var{algorithm} argument should be @code{priority} or
6737 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6738 the second one specifies Chaitin-Briggs coloring.  The second
6739 algorithm can be unimplemented for some architectures.  If it is
6740 implemented, it is the default because Chaitin-Briggs coloring as a
6741 rule generates a better code.
6742
6743 @item -fira-region=@var{region}
6744 Use specified regions for the integrated register allocator.  The
6745 @var{region} argument should be one of @code{all}, @code{mixed}, or
6746 @code{one}.  The first value means using all loops as register
6747 allocation regions, the second value which is enabled by default when
6748 compiling with optimization for speed (@option{-O}, @option{-O2},
6749 @dots{}) means using all loops except for loops with small register
6750 pressure as the regions, and third one which is enabled by default for
6751 @option{-Os} or @option{-O0} means using all function as a single
6752 region.  The first value can give best result for machines with small
6753 size and irregular register set, the third one results in faster and
6754 generates decent code and the smallest size code, and the second value
6755 usually give the best results in most cases and for most
6756 architectures.
6757
6758 @item -fira-loop-pressure
6759 @opindex fira-loop-pressure
6760 Use IRA to evaluate register pressure in loops for decision to move
6761 loop invariants.  Usage of this option usually results in generation
6762 of faster and smaller code on machines with big register files (>= 32
6763 registers) but it can slow compiler down.
6764
6765 This option is enabled at level @option{-O3} for some targets.
6766
6767 @item -fno-ira-share-save-slots
6768 @opindex fno-ira-share-save-slots
6769 Switch off sharing stack slots used for saving call used hard
6770 registers living through a call.  Each hard register will get a
6771 separate stack slot and as a result function stack frame will be
6772 bigger.
6773
6774 @item -fno-ira-share-spill-slots
6775 @opindex fno-ira-share-spill-slots
6776 Switch off sharing stack slots allocated for pseudo-registers.  Each
6777 pseudo-register which did not get a hard register will get a separate
6778 stack slot and as a result function stack frame will be bigger.
6779
6780 @item -fira-verbose=@var{n}
6781 @opindex fira-verbose
6782 Set up how verbose dump file for the integrated register allocator
6783 will be.  Default value is 5.  If the value is greater or equal to 10,
6784 the dump file will be stderr as if the value were @var{n} minus 10.
6785
6786 @item -fdelayed-branch
6787 @opindex fdelayed-branch
6788 If supported for the target machine, attempt to reorder instructions
6789 to exploit instruction slots available after delayed branch
6790 instructions.
6791
6792 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6793
6794 @item -fschedule-insns
6795 @opindex fschedule-insns
6796 If supported for the target machine, attempt to reorder instructions to
6797 eliminate execution stalls due to required data being unavailable.  This
6798 helps machines that have slow floating point or memory load instructions
6799 by allowing other instructions to be issued until the result of the load
6800 or floating point instruction is required.
6801
6802 Enabled at levels @option{-O2}, @option{-O3}.
6803
6804 @item -fschedule-insns2
6805 @opindex fschedule-insns2
6806 Similar to @option{-fschedule-insns}, but requests an additional pass of
6807 instruction scheduling after register allocation has been done.  This is
6808 especially useful on machines with a relatively small number of
6809 registers and where memory load instructions take more than one cycle.
6810
6811 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6812
6813 @item -fno-sched-interblock
6814 @opindex fno-sched-interblock
6815 Don't schedule instructions across basic blocks.  This is normally
6816 enabled by default when scheduling before register allocation, i.e.@:
6817 with @option{-fschedule-insns} or at @option{-O2} or higher.
6818
6819 @item -fno-sched-spec
6820 @opindex fno-sched-spec
6821 Don't allow speculative motion of non-load instructions.  This is normally
6822 enabled by default when scheduling before register allocation, i.e.@:
6823 with @option{-fschedule-insns} or at @option{-O2} or higher.
6824
6825 @item -fsched-pressure
6826 @opindex fsched-pressure
6827 Enable register pressure sensitive insn scheduling before the register
6828 allocation.  This only makes sense when scheduling before register
6829 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6830 @option{-O2} or higher.  Usage of this option can improve the
6831 generated code and decrease its size by preventing register pressure
6832 increase above the number of available hard registers and as a
6833 consequence register spills in the register allocation.
6834
6835 @item -fsched-spec-load
6836 @opindex fsched-spec-load
6837 Allow speculative motion of some load instructions.  This only makes
6838 sense when scheduling before register allocation, i.e.@: with
6839 @option{-fschedule-insns} or at @option{-O2} or higher.
6840
6841 @item -fsched-spec-load-dangerous
6842 @opindex fsched-spec-load-dangerous
6843 Allow speculative motion of more load instructions.  This only makes
6844 sense when scheduling before register allocation, i.e.@: with
6845 @option{-fschedule-insns} or at @option{-O2} or higher.
6846
6847 @item -fsched-stalled-insns
6848 @itemx -fsched-stalled-insns=@var{n}
6849 @opindex fsched-stalled-insns
6850 Define how many insns (if any) can be moved prematurely from the queue
6851 of stalled insns into the ready list, during the second scheduling pass.
6852 @option{-fno-sched-stalled-insns} means that no insns will be moved
6853 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6854 on how many queued insns can be moved prematurely.
6855 @option{-fsched-stalled-insns} without a value is equivalent to
6856 @option{-fsched-stalled-insns=1}.
6857
6858 @item -fsched-stalled-insns-dep
6859 @itemx -fsched-stalled-insns-dep=@var{n}
6860 @opindex fsched-stalled-insns-dep
6861 Define how many insn groups (cycles) will be examined for a dependency
6862 on a stalled insn that is candidate for premature removal from the queue
6863 of stalled insns.  This has an effect only during the second scheduling pass,
6864 and only if @option{-fsched-stalled-insns} is used.
6865 @option{-fno-sched-stalled-insns-dep} is equivalent to
6866 @option{-fsched-stalled-insns-dep=0}.
6867 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6868 @option{-fsched-stalled-insns-dep=1}.
6869
6870 @item -fsched2-use-superblocks
6871 @opindex fsched2-use-superblocks
6872 When scheduling after register allocation, do use superblock scheduling
6873 algorithm.  Superblock scheduling allows motion across basic block boundaries
6874 resulting on faster schedules.  This option is experimental, as not all machine
6875 descriptions used by GCC model the CPU closely enough to avoid unreliable
6876 results from the algorithm.
6877
6878 This only makes sense when scheduling after register allocation, i.e.@: with
6879 @option{-fschedule-insns2} or at @option{-O2} or higher.
6880
6881 @item -fsched-group-heuristic
6882 @opindex fsched-group-heuristic
6883 Enable the group heuristic in the scheduler.  This heuristic favors
6884 the instruction that belongs to a schedule group.  This is enabled
6885 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
6886 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6887
6888 @item -fsched-critical-path-heuristic
6889 @opindex fsched-critical-path-heuristic
6890 Enable the critical-path heuristic in the scheduler.  This heuristic favors
6891 instructions on the critical path.  This is enabled by default when
6892 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
6893 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6894
6895 @item -fsched-spec-insn-heuristic
6896 @opindex fsched-spec-insn-heuristic
6897 Enable the speculative instruction heuristic in the scheduler.  This
6898 heuristic favors speculative instructions with greater dependency weakness.
6899 This is enabled by default when scheduling is enabled, i.e.@:
6900 with @option{-fschedule-insns} or @option{-fschedule-insns2}
6901 or at @option{-O2} or higher.
6902
6903 @item -fsched-rank-heuristic
6904 @opindex fsched-rank-heuristic
6905 Enable the rank heuristic in the scheduler.  This heuristic favors
6906 the instruction belonging to a basic block with greater size or frequency.
6907 This is enabled by default when scheduling is enabled, i.e.@:
6908 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6909 at @option{-O2} or higher.
6910
6911 @item -fsched-last-insn-heuristic
6912 @opindex fsched-last-insn-heuristic
6913 Enable the last-instruction heuristic in the scheduler.  This heuristic
6914 favors the instruction that is less dependent on the last instruction
6915 scheduled.  This is enabled by default when scheduling is enabled,
6916 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6917 at @option{-O2} or higher.
6918
6919 @item -fsched-dep-count-heuristic
6920 @opindex fsched-dep-count-heuristic
6921 Enable the dependent-count heuristic in the scheduler.  This heuristic
6922 favors the instruction that has more instructions depending on it.
6923 This is enabled by default when scheduling is enabled, i.e.@:
6924 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6925 at @option{-O2} or higher.
6926
6927 @item -freschedule-modulo-scheduled-loops
6928 @opindex freschedule-modulo-scheduled-loops
6929 The modulo scheduling comes before the traditional scheduling, if a loop
6930 was modulo scheduled we may want to prevent the later scheduling passes
6931 from changing its schedule, we use this option to control that.
6932
6933 @item -fselective-scheduling
6934 @opindex fselective-scheduling
6935 Schedule instructions using selective scheduling algorithm.  Selective
6936 scheduling runs instead of the first scheduler pass.
6937
6938 @item -fselective-scheduling2
6939 @opindex fselective-scheduling2
6940 Schedule instructions using selective scheduling algorithm.  Selective
6941 scheduling runs instead of the second scheduler pass.
6942
6943 @item -fsel-sched-pipelining
6944 @opindex fsel-sched-pipelining
6945 Enable software pipelining of innermost loops during selective scheduling.
6946 This option has no effect until one of @option{-fselective-scheduling} or
6947 @option{-fselective-scheduling2} is turned on.
6948
6949 @item -fsel-sched-pipelining-outer-loops
6950 @opindex fsel-sched-pipelining-outer-loops
6951 When pipelining loops during selective scheduling, also pipeline outer loops.
6952 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6953
6954 @item -fshrink-wrap
6955 @opindex fshrink-wrap
6956 Emit function prologues only before parts of the function that need it,
6957 rather than at the top of the function.  This flag is enabled by default at
6958 @option{-O} and higher.
6959
6960 @item -fcaller-saves
6961 @opindex fcaller-saves
6962 Enable values to be allocated in registers that will be clobbered by
6963 function calls, by emitting extra instructions to save and restore the
6964 registers around such calls.  Such allocation is done only when it
6965 seems to result in better code than would otherwise be produced.
6966
6967 This option is always enabled by default on certain machines, usually
6968 those which have no call-preserved registers to use instead.
6969
6970 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6971
6972 @item -fcombine-stack-adjustments
6973 @opindex fcombine-stack-adjustments
6974 Tracks stack adjustments (pushes and pops) and stack memory references
6975 and then tries to find ways to combine them.
6976
6977 Enabled by default at @option{-O1} and higher.
6978
6979 @item -fconserve-stack
6980 @opindex fconserve-stack
6981 Attempt to minimize stack usage.  The compiler will attempt to use less
6982 stack space, even if that makes the program slower.  This option
6983 implies setting the @option{large-stack-frame} parameter to 100
6984 and the @option{large-stack-frame-growth} parameter to 400.
6985
6986 @item -ftree-reassoc
6987 @opindex ftree-reassoc
6988 Perform reassociation on trees.  This flag is enabled by default
6989 at @option{-O} and higher.
6990
6991 @item -ftree-pre
6992 @opindex ftree-pre
6993 Perform partial redundancy elimination (PRE) on trees.  This flag is
6994 enabled by default at @option{-O2} and @option{-O3}.
6995
6996 @item -ftree-forwprop
6997 @opindex ftree-forwprop
6998 Perform forward propagation on trees.  This flag is enabled by default
6999 at @option{-O} and higher.
7000
7001 @item -ftree-fre
7002 @opindex ftree-fre
7003 Perform full redundancy elimination (FRE) on trees.  The difference
7004 between FRE and PRE is that FRE only considers expressions
7005 that are computed on all paths leading to the redundant computation.
7006 This analysis is faster than PRE, though it exposes fewer redundancies.
7007 This flag is enabled by default at @option{-O} and higher.
7008
7009 @item -ftree-phiprop
7010 @opindex ftree-phiprop
7011 Perform hoisting of loads from conditional pointers on trees.  This
7012 pass is enabled by default at @option{-O} and higher.
7013
7014 @item -ftree-copy-prop
7015 @opindex ftree-copy-prop
7016 Perform copy propagation on trees.  This pass eliminates unnecessary
7017 copy operations.  This flag is enabled by default at @option{-O} and
7018 higher.
7019
7020 @item -fipa-pure-const
7021 @opindex fipa-pure-const
7022 Discover which functions are pure or constant.
7023 Enabled by default at @option{-O} and higher.
7024
7025 @item -fipa-reference
7026 @opindex fipa-reference
7027 Discover which static variables do not escape cannot escape the
7028 compilation unit.
7029 Enabled by default at @option{-O} and higher.
7030
7031 @item -fipa-pta
7032 @opindex fipa-pta
7033 Perform interprocedural pointer analysis and interprocedural modification
7034 and reference analysis.  This option can cause excessive memory and
7035 compile-time usage on large compilation units.  It is not enabled by
7036 default at any optimization level.
7037
7038 @item -fipa-profile
7039 @opindex fipa-profile
7040 Perform interprocedural profile propagation.  The functions called only from
7041 cold functions are marked as cold. Also functions executed once (such as
7042 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7043 functions and loop less parts of functions executed once are then optimized for
7044 size.
7045 Enabled by default at @option{-O} and higher.
7046
7047 @item -fipa-cp
7048 @opindex fipa-cp
7049 Perform interprocedural constant propagation.
7050 This optimization analyzes the program to determine when values passed
7051 to functions are constants and then optimizes accordingly.
7052 This optimization can substantially increase performance
7053 if the application has constants passed to functions.
7054 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7055
7056 @item -fipa-cp-clone
7057 @opindex fipa-cp-clone
7058 Perform function cloning to make interprocedural constant propagation stronger.
7059 When enabled, interprocedural constant propagation will perform function cloning
7060 when externally visible function can be called with constant arguments.
7061 Because this optimization can create multiple copies of functions,
7062 it may significantly increase code size
7063 (see @option{--param ipcp-unit-growth=@var{value}}).
7064 This flag is enabled by default at @option{-O3}.
7065
7066 @item -fipa-matrix-reorg
7067 @opindex fipa-matrix-reorg
7068 Perform matrix flattening and transposing.
7069 Matrix flattening tries to replace an @math{m}-dimensional matrix
7070 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
7071 This reduces the level of indirection needed for accessing the elements
7072 of the matrix. The second optimization is matrix transposing that
7073 attempts to change the order of the matrix's dimensions in order to
7074 improve cache locality.
7075 Both optimizations need the @option{-fwhole-program} flag.
7076 Transposing is enabled only if profiling information is available.
7077
7078 @item -ftree-sink
7079 @opindex ftree-sink
7080 Perform forward store motion  on trees.  This flag is
7081 enabled by default at @option{-O} and higher.
7082
7083 @item -ftree-bit-ccp
7084 @opindex ftree-bit-ccp
7085 Perform sparse conditional bit constant propagation on trees and propagate
7086 pointer alignment information.
7087 This pass only operates on local scalar variables and is enabled by default
7088 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7089
7090 @item -ftree-ccp
7091 @opindex ftree-ccp
7092 Perform sparse conditional constant propagation (CCP) on trees.  This
7093 pass only operates on local scalar variables and is enabled by default
7094 at @option{-O} and higher.
7095
7096 @item -ftree-switch-conversion
7097 Perform conversion of simple initializations in a switch to
7098 initializations from a scalar array.  This flag is enabled by default
7099 at @option{-O2} and higher.
7100
7101 @item -ftree-tail-merge
7102 Look for identical code sequences.  When found, replace one with a jump to the
7103 other.  This optimization is known as tail merging or cross jumping.  This flag
7104 is enabled by default at @option{-O2} and higher.  The run time of this pass can
7105 be limited using @option{max-tail-merge-comparisons} parameter and
7106 @option{max-tail-merge-iterations} parameter.
7107
7108 @item -ftree-dce
7109 @opindex ftree-dce
7110 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7111 default at @option{-O} and higher.
7112
7113 @item -ftree-builtin-call-dce
7114 @opindex ftree-builtin-call-dce
7115 Perform conditional dead code elimination (DCE) for calls to builtin functions
7116 that may set @code{errno} but are otherwise side-effect free.  This flag is
7117 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7118 specified.
7119
7120 @item -ftree-dominator-opts
7121 @opindex ftree-dominator-opts
7122 Perform a variety of simple scalar cleanups (constant/copy
7123 propagation, redundancy elimination, range propagation and expression
7124 simplification) based on a dominator tree traversal.  This also
7125 performs jump threading (to reduce jumps to jumps). This flag is
7126 enabled by default at @option{-O} and higher.
7127
7128 @item -ftree-dse
7129 @opindex ftree-dse
7130 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7131 a memory location which will later be overwritten by another store without
7132 any intervening loads.  In this case the earlier store can be deleted.  This
7133 flag is enabled by default at @option{-O} and higher.
7134
7135 @item -ftree-ch
7136 @opindex ftree-ch
7137 Perform loop header copying on trees.  This is beneficial since it increases
7138 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7139 is enabled by default at @option{-O} and higher.  It is not enabled
7140 for @option{-Os}, since it usually increases code size.
7141
7142 @item -ftree-loop-optimize
7143 @opindex ftree-loop-optimize
7144 Perform loop optimizations on trees.  This flag is enabled by default
7145 at @option{-O} and higher.
7146
7147 @item -ftree-loop-linear
7148 @opindex ftree-loop-linear
7149 Perform loop interchange transformations on tree.  Same as
7150 @option{-floop-interchange}.  To use this code transformation, GCC has
7151 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7152 enable the Graphite loop transformation infrastructure.
7153
7154 @item -floop-interchange
7155 @opindex floop-interchange
7156 Perform loop interchange transformations on loops.  Interchanging two
7157 nested loops switches the inner and outer loops.  For example, given a
7158 loop like:
7159 @smallexample
7160 DO J = 1, M
7161   DO I = 1, N
7162     A(J, I) = A(J, I) * C
7163   ENDDO
7164 ENDDO
7165 @end smallexample
7166 loop interchange will transform the loop as if the user had written:
7167 @smallexample
7168 DO I = 1, N
7169   DO J = 1, M
7170     A(J, I) = A(J, I) * C
7171   ENDDO
7172 ENDDO
7173 @end smallexample
7174 which can be beneficial when @code{N} is larger than the caches,
7175 because in Fortran, the elements of an array are stored in memory
7176 contiguously by column, and the original loop iterates over rows,
7177 potentially creating at each access a cache miss.  This optimization
7178 applies to all the languages supported by GCC and is not limited to
7179 Fortran.  To use this code transformation, GCC has to be configured
7180 with @option{--with-ppl} and @option{--with-cloog} to enable the
7181 Graphite loop transformation infrastructure.
7182
7183 @item -floop-strip-mine
7184 @opindex floop-strip-mine
7185 Perform loop strip mining transformations on loops.  Strip mining
7186 splits a loop into two nested loops.  The outer loop has strides
7187 equal to the strip size and the inner loop has strides of the
7188 original loop within a strip.  The strip length can be changed
7189 using the @option{loop-block-tile-size} parameter.  For example,
7190 given a loop like:
7191 @smallexample
7192 DO I = 1, N
7193   A(I) = A(I) + C
7194 ENDDO
7195 @end smallexample
7196 loop strip mining will transform the loop as if the user had written:
7197 @smallexample
7198 DO II = 1, N, 51
7199   DO I = II, min (II + 50, N)
7200     A(I) = A(I) + C
7201   ENDDO
7202 ENDDO
7203 @end smallexample
7204 This optimization applies to all the languages supported by GCC and is
7205 not limited to Fortran.  To use this code transformation, GCC has to
7206 be configured with @option{--with-ppl} and @option{--with-cloog} to
7207 enable the Graphite loop transformation infrastructure.
7208
7209 @item -floop-block
7210 @opindex floop-block
7211 Perform loop blocking transformations on loops.  Blocking strip mines
7212 each loop in the loop nest such that the memory accesses of the
7213 element loops fit inside caches.  The strip length can be changed
7214 using the @option{loop-block-tile-size} parameter.  For example, given
7215 a loop like:
7216 @smallexample
7217 DO I = 1, N
7218   DO J = 1, M
7219     A(J, I) = B(I) + C(J)
7220   ENDDO
7221 ENDDO
7222 @end smallexample
7223 loop blocking will transform the loop as if the user had written:
7224 @smallexample
7225 DO II = 1, N, 51
7226   DO JJ = 1, M, 51
7227     DO I = II, min (II + 50, N)
7228       DO J = JJ, min (JJ + 50, M)
7229         A(J, I) = B(I) + C(J)
7230       ENDDO
7231     ENDDO
7232   ENDDO
7233 ENDDO
7234 @end smallexample
7235 which can be beneficial when @code{M} is larger than the caches,
7236 because the innermost loop will iterate over a smaller amount of data
7237 that can be kept in the caches.  This optimization applies to all the
7238 languages supported by GCC and is not limited to Fortran.  To use this
7239 code transformation, GCC has to be configured with @option{--with-ppl}
7240 and @option{--with-cloog} to enable the Graphite loop transformation
7241 infrastructure.
7242
7243 @item -fgraphite-identity
7244 @opindex fgraphite-identity
7245 Enable the identity transformation for graphite.  For every SCoP we generate
7246 the polyhedral representation and transform it back to gimple.  Using
7247 @option{-fgraphite-identity} we can check the costs or benefits of the
7248 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7249 are also performed by the code generator CLooG, like index splitting and
7250 dead code elimination in loops.
7251
7252 @item -floop-flatten
7253 @opindex floop-flatten
7254 Removes the loop nesting structure: transforms the loop nest into a
7255 single loop.  This transformation can be useful to vectorize all the
7256 levels of the loop nest.
7257
7258 @item -floop-parallelize-all
7259 @opindex floop-parallelize-all
7260 Use the Graphite data dependence analysis to identify loops that can
7261 be parallelized.  Parallelize all the loops that can be analyzed to
7262 not contain loop carried dependences without checking that it is
7263 profitable to parallelize the loops.
7264
7265 @item -fcheck-data-deps
7266 @opindex fcheck-data-deps
7267 Compare the results of several data dependence analyzers.  This option
7268 is used for debugging the data dependence analyzers.
7269
7270 @item -ftree-loop-if-convert
7271 Attempt to transform conditional jumps in the innermost loops to
7272 branch-less equivalents.  The intent is to remove control-flow from
7273 the innermost loops in order to improve the ability of the
7274 vectorization pass to handle these loops.  This is enabled by default
7275 if vectorization is enabled.
7276
7277 @item -ftree-loop-if-convert-stores
7278 Attempt to also if-convert conditional jumps containing memory writes.
7279 This transformation can be unsafe for multi-threaded programs as it
7280 transforms conditional memory writes into unconditional memory writes.
7281 For example,
7282 @smallexample
7283 for (i = 0; i < N; i++)
7284   if (cond)
7285     A[i] = expr;
7286 @end smallexample
7287 would be transformed to
7288 @smallexample
7289 for (i = 0; i < N; i++)
7290   A[i] = cond ? expr : A[i];
7291 @end smallexample
7292 potentially producing data races.
7293
7294 @item -ftree-loop-distribution
7295 Perform loop distribution.  This flag can improve cache performance on
7296 big loop bodies and allow further loop optimizations, like
7297 parallelization or vectorization, to take place.  For example, the loop
7298 @smallexample
7299 DO I = 1, N
7300   A(I) = B(I) + C
7301   D(I) = E(I) * F
7302 ENDDO
7303 @end smallexample
7304 is transformed to
7305 @smallexample
7306 DO I = 1, N
7307    A(I) = B(I) + C
7308 ENDDO
7309 DO I = 1, N
7310    D(I) = E(I) * F
7311 ENDDO
7312 @end smallexample
7313
7314 @item -ftree-loop-distribute-patterns
7315 Perform loop distribution of patterns that can be code generated with
7316 calls to a library.  This flag is enabled by default at @option{-O3}.
7317
7318 This pass distributes the initialization loops and generates a call to
7319 memset zero.  For example, the loop
7320 @smallexample
7321 DO I = 1, N
7322   A(I) = 0
7323   B(I) = A(I) + I
7324 ENDDO
7325 @end smallexample
7326 is transformed to
7327 @smallexample
7328 DO I = 1, N
7329    A(I) = 0
7330 ENDDO
7331 DO I = 1, N
7332    B(I) = A(I) + I
7333 ENDDO
7334 @end smallexample
7335 and the initialization loop is transformed into a call to memset zero.
7336
7337 @item -ftree-loop-im
7338 @opindex ftree-loop-im
7339 Perform loop invariant motion on trees.  This pass moves only invariants that
7340 would be hard to handle at RTL level (function calls, operations that expand to
7341 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7342 operands of conditions that are invariant out of the loop, so that we can use
7343 just trivial invariantness analysis in loop unswitching.  The pass also includes
7344 store motion.
7345
7346 @item -ftree-loop-ivcanon
7347 @opindex ftree-loop-ivcanon
7348 Create a canonical counter for number of iterations in the loop for that
7349 determining number of iterations requires complicated analysis.  Later
7350 optimizations then may determine the number easily.  Useful especially
7351 in connection with unrolling.
7352
7353 @item -fivopts
7354 @opindex fivopts
7355 Perform induction variable optimizations (strength reduction, induction
7356 variable merging and induction variable elimination) on trees.
7357
7358 @item -ftree-parallelize-loops=n
7359 @opindex ftree-parallelize-loops
7360 Parallelize loops, i.e., split their iteration space to run in n threads.
7361 This is only possible for loops whose iterations are independent
7362 and can be arbitrarily reordered.  The optimization is only
7363 profitable on multiprocessor machines, for loops that are CPU-intensive,
7364 rather than constrained e.g.@: by memory bandwidth.  This option
7365 implies @option{-pthread}, and thus is only supported on targets
7366 that have support for @option{-pthread}.
7367
7368 @item -ftree-pta
7369 @opindex ftree-pta
7370 Perform function-local points-to analysis on trees.  This flag is
7371 enabled by default at @option{-O} and higher.
7372
7373 @item -ftree-sra
7374 @opindex ftree-sra
7375 Perform scalar replacement of aggregates.  This pass replaces structure
7376 references with scalars to prevent committing structures to memory too
7377 early.  This flag is enabled by default at @option{-O} and higher.
7378
7379 @item -ftree-copyrename
7380 @opindex ftree-copyrename
7381 Perform copy renaming on trees.  This pass attempts to rename compiler
7382 temporaries to other variables at copy locations, usually resulting in
7383 variable names which more closely resemble the original variables.  This flag
7384 is enabled by default at @option{-O} and higher.
7385
7386 @item -ftree-ter
7387 @opindex ftree-ter
7388 Perform temporary expression replacement during the SSA->normal phase.  Single
7389 use/single def temporaries are replaced at their use location with their
7390 defining expression.  This results in non-GIMPLE code, but gives the expanders
7391 much more complex trees to work on resulting in better RTL generation.  This is
7392 enabled by default at @option{-O} and higher.
7393
7394 @item -ftree-vectorize
7395 @opindex ftree-vectorize
7396 Perform loop vectorization on trees. This flag is enabled by default at
7397 @option{-O3}.
7398
7399 @item -ftree-slp-vectorize
7400 @opindex ftree-slp-vectorize
7401 Perform basic block vectorization on trees. This flag is enabled by default at
7402 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7403
7404 @item -ftree-vect-loop-version
7405 @opindex ftree-vect-loop-version
7406 Perform loop versioning when doing loop vectorization on trees.  When a loop
7407 appears to be vectorizable except that data alignment or data dependence cannot
7408 be determined at compile time then vectorized and non-vectorized versions of
7409 the loop are generated along with runtime checks for alignment or dependence
7410 to control which version is executed.  This option is enabled by default
7411 except at level @option{-Os} where it is disabled.
7412
7413 @item -fvect-cost-model
7414 @opindex fvect-cost-model
7415 Enable cost model for vectorization.
7416
7417 @item -ftree-vrp
7418 @opindex ftree-vrp
7419 Perform Value Range Propagation on trees.  This is similar to the
7420 constant propagation pass, but instead of values, ranges of values are
7421 propagated.  This allows the optimizers to remove unnecessary range
7422 checks like array bound checks and null pointer checks.  This is
7423 enabled by default at @option{-O2} and higher.  Null pointer check
7424 elimination is only done if @option{-fdelete-null-pointer-checks} is
7425 enabled.
7426
7427 @item -ftracer
7428 @opindex ftracer
7429 Perform tail duplication to enlarge superblock size.  This transformation
7430 simplifies the control flow of the function allowing other optimizations to do
7431 better job.
7432
7433 @item -funroll-loops
7434 @opindex funroll-loops
7435 Unroll loops whose number of iterations can be determined at compile
7436 time or upon entry to the loop.  @option{-funroll-loops} implies
7437 @option{-frerun-cse-after-loop}.  This option makes code larger,
7438 and may or may not make it run faster.
7439
7440 @item -funroll-all-loops
7441 @opindex funroll-all-loops
7442 Unroll all loops, even if their number of iterations is uncertain when
7443 the loop is entered.  This usually makes programs run more slowly.
7444 @option{-funroll-all-loops} implies the same options as
7445 @option{-funroll-loops},
7446
7447 @item -fsplit-ivs-in-unroller
7448 @opindex fsplit-ivs-in-unroller
7449 Enables expressing of values of induction variables in later iterations
7450 of the unrolled loop using the value in the first iteration.  This breaks
7451 long dependency chains, thus improving efficiency of the scheduling passes.
7452
7453 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7454 same effect.  However in cases the loop body is more complicated than
7455 a single basic block, this is not reliable.  It also does not work at all
7456 on some of the architectures due to restrictions in the CSE pass.
7457
7458 This optimization is enabled by default.
7459
7460 @item -fvariable-expansion-in-unroller
7461 @opindex fvariable-expansion-in-unroller
7462 With this option, the compiler will create multiple copies of some
7463 local variables when unrolling a loop which can result in superior code.
7464
7465 @item -fpartial-inlining
7466 @opindex fpartial-inlining
7467 Inline parts of functions.  This option has any effect only
7468 when inlining itself is turned on by the @option{-finline-functions}
7469 or @option{-finline-small-functions} options.
7470
7471 Enabled at level @option{-O2}.
7472
7473 @item -fpredictive-commoning
7474 @opindex fpredictive-commoning
7475 Perform predictive commoning optimization, i.e., reusing computations
7476 (especially memory loads and stores) performed in previous
7477 iterations of loops.
7478
7479 This option is enabled at level @option{-O3}.
7480
7481 @item -fprefetch-loop-arrays
7482 @opindex fprefetch-loop-arrays
7483 If supported by the target machine, generate instructions to prefetch
7484 memory to improve the performance of loops that access large arrays.
7485
7486 This option may generate better or worse code; results are highly
7487 dependent on the structure of loops within the source code.
7488
7489 Disabled at level @option{-Os}.
7490
7491 @item -fno-peephole
7492 @itemx -fno-peephole2
7493 @opindex fno-peephole
7494 @opindex fno-peephole2
7495 Disable any machine-specific peephole optimizations.  The difference
7496 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7497 are implemented in the compiler; some targets use one, some use the
7498 other, a few use both.
7499
7500 @option{-fpeephole} is enabled by default.
7501 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7502
7503 @item -fno-guess-branch-probability
7504 @opindex fno-guess-branch-probability
7505 Do not guess branch probabilities using heuristics.
7506
7507 GCC will use heuristics to guess branch probabilities if they are
7508 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7509 heuristics are based on the control flow graph.  If some branch probabilities
7510 are specified by @samp{__builtin_expect}, then the heuristics will be
7511 used to guess branch probabilities for the rest of the control flow graph,
7512 taking the @samp{__builtin_expect} info into account.  The interactions
7513 between the heuristics and @samp{__builtin_expect} can be complex, and in
7514 some cases, it may be useful to disable the heuristics so that the effects
7515 of @samp{__builtin_expect} are easier to understand.
7516
7517 The default is @option{-fguess-branch-probability} at levels
7518 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7519
7520 @item -freorder-blocks
7521 @opindex freorder-blocks
7522 Reorder basic blocks in the compiled function in order to reduce number of
7523 taken branches and improve code locality.
7524
7525 Enabled at levels @option{-O2}, @option{-O3}.
7526
7527 @item -freorder-blocks-and-partition
7528 @opindex freorder-blocks-and-partition
7529 In addition to reordering basic blocks in the compiled function, in order
7530 to reduce number of taken branches, partitions hot and cold basic blocks
7531 into separate sections of the assembly and .o files, to improve
7532 paging and cache locality performance.
7533
7534 This optimization is automatically turned off in the presence of
7535 exception handling, for linkonce sections, for functions with a user-defined
7536 section attribute and on any architecture that does not support named
7537 sections.
7538
7539 @item -freorder-functions
7540 @opindex freorder-functions
7541 Reorder functions in the object file in order to
7542 improve code locality.  This is implemented by using special
7543 subsections @code{.text.hot} for most frequently executed functions and
7544 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7545 the linker so object file format must support named sections and linker must
7546 place them in a reasonable way.
7547
7548 Also profile feedback must be available in to make this option effective.  See
7549 @option{-fprofile-arcs} for details.
7550
7551 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7552
7553 @item -fstrict-aliasing
7554 @opindex fstrict-aliasing
7555 Allow the compiler to assume the strictest aliasing rules applicable to
7556 the language being compiled.  For C (and C++), this activates
7557 optimizations based on the type of expressions.  In particular, an
7558 object of one type is assumed never to reside at the same address as an
7559 object of a different type, unless the types are almost the same.  For
7560 example, an @code{unsigned int} can alias an @code{int}, but not a
7561 @code{void*} or a @code{double}.  A character type may alias any other
7562 type.
7563
7564 @anchor{Type-punning}Pay special attention to code like this:
7565 @smallexample
7566 union a_union @{
7567   int i;
7568   double d;
7569 @};
7570
7571 int f() @{
7572   union a_union t;
7573   t.d = 3.0;
7574   return t.i;
7575 @}
7576 @end smallexample
7577 The practice of reading from a different union member than the one most
7578 recently written to (called ``type-punning'') is common.  Even with
7579 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7580 is accessed through the union type.  So, the code above will work as
7581 expected.  @xref{Structures unions enumerations and bit-fields
7582 implementation}.  However, this code might not:
7583 @smallexample
7584 int f() @{
7585   union a_union t;
7586   int* ip;
7587   t.d = 3.0;
7588   ip = &t.i;
7589   return *ip;
7590 @}
7591 @end smallexample
7592
7593 Similarly, access by taking the address, casting the resulting pointer
7594 and dereferencing the result has undefined behavior, even if the cast
7595 uses a union type, e.g.:
7596 @smallexample
7597 int f() @{
7598   double d = 3.0;
7599   return ((union a_union *) &d)->i;
7600 @}
7601 @end smallexample
7602
7603 The @option{-fstrict-aliasing} option is enabled at levels
7604 @option{-O2}, @option{-O3}, @option{-Os}.
7605
7606 @item -fstrict-overflow
7607 @opindex fstrict-overflow
7608 Allow the compiler to assume strict signed overflow rules, depending
7609 on the language being compiled.  For C (and C++) this means that
7610 overflow when doing arithmetic with signed numbers is undefined, which
7611 means that the compiler may assume that it will not happen.  This
7612 permits various optimizations.  For example, the compiler will assume
7613 that an expression like @code{i + 10 > i} will always be true for
7614 signed @code{i}.  This assumption is only valid if signed overflow is
7615 undefined, as the expression is false if @code{i + 10} overflows when
7616 using twos complement arithmetic.  When this option is in effect any
7617 attempt to determine whether an operation on signed numbers will
7618 overflow must be written carefully to not actually involve overflow.
7619
7620 This option also allows the compiler to assume strict pointer
7621 semantics: given a pointer to an object, if adding an offset to that
7622 pointer does not produce a pointer to the same object, the addition is
7623 undefined.  This permits the compiler to conclude that @code{p + u >
7624 p} is always true for a pointer @code{p} and unsigned integer
7625 @code{u}.  This assumption is only valid because pointer wraparound is
7626 undefined, as the expression is false if @code{p + u} overflows using
7627 twos complement arithmetic.
7628
7629 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7630 that integer signed overflow is fully defined: it wraps.  When
7631 @option{-fwrapv} is used, there is no difference between
7632 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7633 integers.  With @option{-fwrapv} certain types of overflow are
7634 permitted.  For example, if the compiler gets an overflow when doing
7635 arithmetic on constants, the overflowed value can still be used with
7636 @option{-fwrapv}, but not otherwise.
7637
7638 The @option{-fstrict-overflow} option is enabled at levels
7639 @option{-O2}, @option{-O3}, @option{-Os}.
7640
7641 @item -falign-functions
7642 @itemx -falign-functions=@var{n}
7643 @opindex falign-functions
7644 Align the start of functions to the next power-of-two greater than
7645 @var{n}, skipping up to @var{n} bytes.  For instance,
7646 @option{-falign-functions=32} aligns functions to the next 32-byte
7647 boundary, but @option{-falign-functions=24} would align to the next
7648 32-byte boundary only if this can be done by skipping 23 bytes or less.
7649
7650 @option{-fno-align-functions} and @option{-falign-functions=1} are
7651 equivalent and mean that functions will not be aligned.
7652
7653 Some assemblers only support this flag when @var{n} is a power of two;
7654 in that case, it is rounded up.
7655
7656 If @var{n} is not specified or is zero, use a machine-dependent default.
7657
7658 Enabled at levels @option{-O2}, @option{-O3}.
7659
7660 @item -falign-labels
7661 @itemx -falign-labels=@var{n}
7662 @opindex falign-labels
7663 Align all branch targets to a power-of-two boundary, skipping up to
7664 @var{n} bytes like @option{-falign-functions}.  This option can easily
7665 make code slower, because it must insert dummy operations for when the
7666 branch target is reached in the usual flow of the code.
7667
7668 @option{-fno-align-labels} and @option{-falign-labels=1} are
7669 equivalent and mean that labels will not be aligned.
7670
7671 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7672 are greater than this value, then their values are used instead.
7673
7674 If @var{n} is not specified or is zero, use a machine-dependent default
7675 which is very likely to be @samp{1}, meaning no alignment.
7676
7677 Enabled at levels @option{-O2}, @option{-O3}.
7678
7679 @item -falign-loops
7680 @itemx -falign-loops=@var{n}
7681 @opindex falign-loops
7682 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7683 like @option{-falign-functions}.  The hope is that the loop will be
7684 executed many times, which will make up for any execution of the dummy
7685 operations.
7686
7687 @option{-fno-align-loops} and @option{-falign-loops=1} are
7688 equivalent and mean that loops will not be aligned.
7689
7690 If @var{n} is not specified or is zero, use a machine-dependent default.
7691
7692 Enabled at levels @option{-O2}, @option{-O3}.
7693
7694 @item -falign-jumps
7695 @itemx -falign-jumps=@var{n}
7696 @opindex falign-jumps
7697 Align branch targets to a power-of-two boundary, for branch targets
7698 where the targets can only be reached by jumping, skipping up to @var{n}
7699 bytes like @option{-falign-functions}.  In this case, no dummy operations
7700 need be executed.
7701
7702 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7703 equivalent and mean that loops will not be aligned.
7704
7705 If @var{n} is not specified or is zero, use a machine-dependent default.
7706
7707 Enabled at levels @option{-O2}, @option{-O3}.
7708
7709 @item -funit-at-a-time
7710 @opindex funit-at-a-time
7711 This option is left for compatibility reasons. @option{-funit-at-a-time}
7712 has no effect, while @option{-fno-unit-at-a-time} implies
7713 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7714
7715 Enabled by default.
7716
7717 @item -fno-toplevel-reorder
7718 @opindex fno-toplevel-reorder
7719 Do not reorder top-level functions, variables, and @code{asm}
7720 statements.  Output them in the same order that they appear in the
7721 input file.  When this option is used, unreferenced static variables
7722 will not be removed.  This option is intended to support existing code
7723 which relies on a particular ordering.  For new code, it is better to
7724 use attributes.
7725
7726 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7727 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7728 targets.
7729
7730 @item -fweb
7731 @opindex fweb
7732 Constructs webs as commonly used for register allocation purposes and assign
7733 each web individual pseudo register.  This allows the register allocation pass
7734 to operate on pseudos directly, but also strengthens several other optimization
7735 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7736 however, make debugging impossible, since variables will no longer stay in a
7737 ``home register''.
7738
7739 Enabled by default with @option{-funroll-loops}.
7740
7741 @item -fwhole-program
7742 @opindex fwhole-program
7743 Assume that the current compilation unit represents the whole program being
7744 compiled.  All public functions and variables with the exception of @code{main}
7745 and those merged by attribute @code{externally_visible} become static functions
7746 and in effect are optimized more aggressively by interprocedural optimizers. If @command{gold} is used as the linker plugin, @code{externally_visible} attributes are automatically added to functions (not variable yet due to a current @command{gold} issue) that are accessed outside of LTO objects according to resolution file produced by @command{gold}.  For other linkers that cannot generate resolution file, explicit @code{externally_visible} attributes are still necessary.
7747 While this option is equivalent to proper use of the @code{static} keyword for
7748 programs consisting of a single file, in combination with option
7749 @option{-flto} this flag can be used to
7750 compile many smaller scale programs since the functions and variables become
7751 local for the whole combined compilation unit, not for the single source file
7752 itself.
7753
7754 This option implies @option{-fwhole-file} for Fortran programs.
7755
7756 @item -flto[=@var{n}]
7757 @opindex flto
7758 This option runs the standard link-time optimizer.  When invoked
7759 with source code, it generates GIMPLE (one of GCC's internal
7760 representations) and writes it to special ELF sections in the object
7761 file.  When the object files are linked together, all the function
7762 bodies are read from these ELF sections and instantiated as if they
7763 had been part of the same translation unit.
7764
7765 To use the link-timer optimizer, @option{-flto} needs to be specified at
7766 compile time and during the final link.  For example,
7767
7768 @smallexample
7769 gcc -c -O2 -flto foo.c
7770 gcc -c -O2 -flto bar.c
7771 gcc -o myprog -flto -O2 foo.o bar.o
7772 @end smallexample
7773
7774 The first two invocations to GCC will save a bytecode representation
7775 of GIMPLE into special ELF sections inside @file{foo.o} and
7776 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7777 @file{foo.o} and @file{bar.o}, merge the two files into a single
7778 internal image, and compile the result as usual.  Since both
7779 @file{foo.o} and @file{bar.o} are merged into a single image, this
7780 causes all the inter-procedural analyses and optimizations in GCC to
7781 work across the two files as if they were a single one.  This means,
7782 for example, that the inliner will be able to inline functions in
7783 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7784
7785 Another (simpler) way to enable link-time optimization is,
7786
7787 @smallexample
7788 gcc -o myprog -flto -O2 foo.c bar.c
7789 @end smallexample
7790
7791 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7792 merge them together into a single GIMPLE representation and optimize
7793 them as usual to produce @file{myprog}.
7794
7795 The only important thing to keep in mind is that to enable link-time
7796 optimizations the @option{-flto} flag needs to be passed to both the
7797 compile and the link commands.
7798
7799 To make whole program optimization effective, it is necessary to make
7800 certain whole program assumptions.  The compiler needs to know
7801 what functions and variables can be accessed by libraries and runtime
7802 outside of the link time optimized unit.  When supported by the linker,
7803 the linker plugin (see @option{-fuse-linker-plugin}) passes to the
7804 compiler information about used and externally visible symbols.  When
7805 the linker plugin is not available, @option{-fwhole-program} should be
7806 used to allow the compiler to make these assumptions, which will lead
7807 to more aggressive optimization decisions.
7808
7809 Note that when a file is compiled with @option{-flto}, the generated
7810 object file will be larger than a regular object file because it will
7811 contain GIMPLE bytecodes and the usual final code.  This means that
7812 object files with LTO information can be linked as a normal object
7813 file.  So, in the previous example, if the final link is done with
7814
7815 @smallexample
7816 gcc -o myprog foo.o bar.o
7817 @end smallexample
7818
7819 The only difference will be that no inter-procedural optimizations
7820 will be applied to produce @file{myprog}.  The two object files
7821 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7822 linker.
7823
7824 Additionally, the optimization flags used to compile individual files
7825 are not necessarily related to those used at link-time.  For instance,
7826
7827 @smallexample
7828 gcc -c -O0 -flto foo.c
7829 gcc -c -O0 -flto bar.c
7830 gcc -o myprog -flto -O3 foo.o bar.o
7831 @end smallexample
7832
7833 This will produce individual object files with unoptimized assembler
7834 code, but the resulting binary @file{myprog} will be optimized at
7835 @option{-O3}.  Now, if the final binary is generated without
7836 @option{-flto}, then @file{myprog} will not be optimized.
7837
7838 When producing the final binary with @option{-flto}, GCC will only
7839 apply link-time optimizations to those files that contain bytecode.
7840 Therefore, you can mix and match object files and libraries with
7841 GIMPLE bytecodes and final object code.  GCC will automatically select
7842 which files to optimize in LTO mode and which files to link without
7843 further processing.
7844
7845 There are some code generation flags that GCC will preserve when
7846 generating bytecodes, as they need to be used during the final link
7847 stage.  Currently, the following options are saved into the GIMPLE
7848 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7849 @option{-m} target flags.
7850
7851 At link time, these options are read-in and reapplied.  Note that the
7852 current implementation makes no attempt at recognizing conflicting
7853 values for these options.  If two or more files have a conflicting
7854 value (e.g., one file is compiled with @option{-fPIC} and another
7855 isn't), the compiler will simply use the last value read from the
7856 bytecode files.  It is recommended, then, that all the files
7857 participating in the same link be compiled with the same options.
7858
7859 Another feature of LTO is that it is possible to apply interprocedural
7860 optimizations on files written in different languages.  This requires
7861 some support in the language front end.  Currently, the C, C++ and
7862 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7863 something like this should work
7864
7865 @smallexample
7866 gcc -c -flto foo.c
7867 g++ -c -flto bar.cc
7868 gfortran -c -flto baz.f90
7869 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7870 @end smallexample
7871
7872 Notice that the final link is done with @command{g++} to get the C++
7873 runtime libraries and @option{-lgfortran} is added to get the Fortran
7874 runtime libraries.  In general, when mixing languages in LTO mode, you
7875 should use the same link command used when mixing languages in a
7876 regular (non-LTO) compilation.  This means that if your build process
7877 was mixing languages before, all you need to add is @option{-flto} to
7878 all the compile and link commands.
7879
7880 If LTO encounters objects with C linkage declared with incompatible
7881 types in separate translation units to be linked together (undefined
7882 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7883 issued.  The behavior is still undefined at runtime.
7884
7885 If object files containing GIMPLE bytecode are stored in a library archive, say
7886 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
7887 are using a linker with linker plugin support.  To enable this feature, use
7888 the flag @option{-fuse-linker-plugin} at link-time:
7889
7890 @smallexample
7891 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7892 @end smallexample
7893
7894 With the linker plugin enabled, the linker will extract the needed
7895 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7896 to make them part of the aggregated GIMPLE image to be optimized.
7897
7898 If you are not using a linker with linker plugin support and/or do not
7899 enable linker plugin then the objects inside @file{libfoo.a}
7900 will be extracted and linked as usual, but they will not participate
7901 in the LTO optimization process.
7902
7903 Link time optimizations do not require the presence of the whole program to
7904 operate.  If the program does not require any symbols to be exported, it is
7905 possible to combine @option{-flto} and with @option{-fwhole-program} to allow
7906 the interprocedural optimizers to use more aggressive assumptions which may
7907 lead to improved optimization opportunities.
7908 Use of @option{-fwhole-program} is not needed when linker plugin is
7909 active (see @option{-fuse-linker-plugin}).
7910
7911 Regarding portability: the current implementation of LTO makes no
7912 attempt at generating bytecode that can be ported between different
7913 types of hosts.  The bytecode files are versioned and there is a
7914 strict version check, so bytecode files generated in one version of
7915 GCC will not work with an older/newer version of GCC.
7916
7917 Link time optimization does not play well with generating debugging
7918 information.  Combining @option{-flto} with
7919 @option{-g} is currently experimental and expected to produce wrong
7920 results.
7921
7922 If you specify the optional @var{n}, the optimization and code
7923 generation done at link time is executed in parallel using @var{n}
7924 parallel jobs by utilizing an installed @command{make} program.  The
7925 environment variable @env{MAKE} may be used to override the program
7926 used.  The default value for @var{n} is 1.
7927
7928 You can also specify @option{-flto=jobserver} to use GNU make's
7929 job server mode to determine the number of parallel jobs. This
7930 is useful when the Makefile calling GCC is already executing in parallel.
7931 The parent Makefile will need a @samp{+} prepended to the command recipe
7932 for this to work. This will likely only work if @env{MAKE} is
7933 GNU make.
7934
7935 This option is disabled by default.
7936
7937 @item -flto-partition=@var{alg}
7938 @opindex flto-partition
7939 Specify the partitioning algorithm used by the link time optimizer.
7940 The value is either @code{1to1} to specify a partitioning mirroring
7941 the original source files or @code{balanced} to specify partitioning
7942 into equally sized chunks (whenever possible).  Specifying @code{none}
7943 as an algorithm disables partitioning and streaming completely. The
7944 default value is @code{balanced}.
7945
7946 @item -flto-compression-level=@var{n}
7947 This option specifies the level of compression used for intermediate
7948 language written to LTO object files, and is only meaningful in
7949 conjunction with LTO mode (@option{-flto}).  Valid
7950 values are 0 (no compression) to 9 (maximum compression).  Values
7951 outside this range are clamped to either 0 or 9.  If the option is not
7952 given, a default balanced compression setting is used.
7953
7954 @item -flto-report
7955 Prints a report with internal details on the workings of the link-time
7956 optimizer.  The contents of this report vary from version to version,
7957 it is meant to be useful to GCC developers when processing object
7958 files in LTO mode (via @option{-flto}).
7959
7960 Disabled by default.
7961
7962 @item -fuse-linker-plugin
7963 Enables the use of a linker plugin during link time optimization.  This
7964 option relies on plugin support in the linker, which is available in gold
7965 or in GNU ld 2.21 or newer.
7966
7967 This option enables the extraction of object files with GIMPLE bytecode out
7968 of library archives. This improves the quality of optimization by exposing
7969 more code to the link time optimizer.  This information specifies what
7970 symbols can be accessed externally (by non-LTO object or during dynamic
7971 linking).  Resulting code quality improvements on binaries (and shared
7972 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
7973 See @option{-flto} for a description of the effect of this flag and how to
7974 use it.
7975
7976 Enabled by default when LTO support in GCC is enabled and GCC was compiled
7977 with a linker supporting plugins (GNU ld 2.21 or newer or gold).
7978
7979 @item -ffat-lto-objects
7980 @opindex ffat-lto-objects
7981 Fat LTO objects are object files that contain both the intermediate language
7982 and the object code. This makes them useable for both LTO linking and normal
7983 linking. This option makes effect only with @option{-flto} and is ignored 
7984 at linktime.
7985
7986 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
7987 requires the complete toolchain to be aware of LTO. It requires a linker with
7988 linker plugin support for basic functionality.  Additionally, nm, ar and ranlib
7989 need to support linker plugins to allow a full-featured build environment
7990 (capable of building static libraries etc).
7991
7992 The default is @option{-ffat-lto-objects} but this default is intended to
7993 change in future releases when linker plugin enabled environments become more
7994 common.
7995 @item -fcompare-elim
7996 @opindex fcompare-elim
7997 After register allocation and post-register allocation instruction splitting,
7998 identify arithmetic instructions that compute processor flags similar to a
7999 comparison operation based on that arithmetic.  If possible, eliminate the
8000 explicit comparison operation.
8001
8002 This pass only applies to certain targets that cannot explicitly represent
8003 the comparison operation before register allocation is complete.
8004
8005 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8006
8007 @item -fcprop-registers
8008 @opindex fcprop-registers
8009 After register allocation and post-register allocation instruction splitting,
8010 we perform a copy-propagation pass to try to reduce scheduling dependencies
8011 and occasionally eliminate the copy.
8012
8013 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8014
8015 @item -fprofile-correction
8016 @opindex fprofile-correction
8017 Profiles collected using an instrumented binary for multi-threaded programs may
8018 be inconsistent due to missed counter updates. When this option is specified,
8019 GCC will use heuristics to correct or smooth out such inconsistencies. By
8020 default, GCC will emit an error message when an inconsistent profile is detected.
8021
8022 @item -fprofile-dir=@var{path}
8023 @opindex fprofile-dir
8024
8025 Set the directory to search for the profile data files in to @var{path}.
8026 This option affects only the profile data generated by
8027 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8028 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8029 and its related options.  Both absolute and relative paths can be used.
8030 By default, GCC will use the current directory as @var{path}, thus the
8031 profile data file will appear in the same directory as the object file.
8032
8033 @item -fprofile-generate
8034 @itemx -fprofile-generate=@var{path}
8035 @opindex fprofile-generate
8036
8037 Enable options usually used for instrumenting application to produce
8038 profile useful for later recompilation with profile feedback based
8039 optimization.  You must use @option{-fprofile-generate} both when
8040 compiling and when linking your program.
8041
8042 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8043
8044 If @var{path} is specified, GCC will look at the @var{path} to find
8045 the profile feedback data files. See @option{-fprofile-dir}.
8046
8047 @item -fprofile-use
8048 @itemx -fprofile-use=@var{path}
8049 @opindex fprofile-use
8050 Enable profile feedback directed optimizations, and optimizations
8051 generally profitable only with profile feedback available.
8052
8053 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8054 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
8055
8056 By default, GCC emits an error message if the feedback profiles do not
8057 match the source code.  This error can be turned into a warning by using
8058 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8059 code.
8060
8061 If @var{path} is specified, GCC will look at the @var{path} to find
8062 the profile feedback data files. See @option{-fprofile-dir}.
8063 @end table
8064
8065 The following options control compiler behavior regarding floating
8066 point arithmetic.  These options trade off between speed and
8067 correctness.  All must be specifically enabled.
8068
8069 @table @gcctabopt
8070 @item -ffloat-store
8071 @opindex ffloat-store
8072 Do not store floating point variables in registers, and inhibit other
8073 options that might change whether a floating point value is taken from a
8074 register or memory.
8075
8076 @cindex floating point precision
8077 This option prevents undesirable excess precision on machines such as
8078 the 68000 where the floating registers (of the 68881) keep more
8079 precision than a @code{double} is supposed to have.  Similarly for the
8080 x86 architecture.  For most programs, the excess precision does only
8081 good, but a few programs rely on the precise definition of IEEE floating
8082 point.  Use @option{-ffloat-store} for such programs, after modifying
8083 them to store all pertinent intermediate computations into variables.
8084
8085 @item -fexcess-precision=@var{style}
8086 @opindex fexcess-precision
8087 This option allows further control over excess precision on machines
8088 where floating-point registers have more precision than the IEEE
8089 @code{float} and @code{double} types and the processor does not
8090 support operations rounding to those types.  By default,
8091 @option{-fexcess-precision=fast} is in effect; this means that
8092 operations are carried out in the precision of the registers and that
8093 it is unpredictable when rounding to the types specified in the source
8094 code takes place.  When compiling C, if
8095 @option{-fexcess-precision=standard} is specified then excess
8096 precision will follow the rules specified in ISO C99; in particular,
8097 both casts and assignments cause values to be rounded to their
8098 semantic types (whereas @option{-ffloat-store} only affects
8099 assignments).  This option is enabled by default for C if a strict
8100 conformance option such as @option{-std=c99} is used.
8101
8102 @opindex mfpmath
8103 @option{-fexcess-precision=standard} is not implemented for languages
8104 other than C, and has no effect if
8105 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8106 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8107 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8108 semantics apply without excess precision, and in the latter, rounding
8109 is unpredictable.
8110
8111 @item -ffast-math
8112 @opindex ffast-math
8113 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8114 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8115 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8116
8117 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8118
8119 This option is not turned on by any @option{-O} option besides
8120 @option{-Ofast} since it can result in incorrect output for programs
8121 which depend on an exact implementation of IEEE or ISO rules/specifications
8122 for math functions. It may, however, yield faster code for programs
8123 that do not require the guarantees of these specifications.
8124
8125 @item -fno-math-errno
8126 @opindex fno-math-errno
8127 Do not set ERRNO after calling math functions that are executed
8128 with a single instruction, e.g., sqrt.  A program that relies on
8129 IEEE exceptions for math error handling may want to use this flag
8130 for speed while maintaining IEEE arithmetic compatibility.
8131
8132 This option is not turned on by any @option{-O} option since
8133 it can result in incorrect output for programs which depend on
8134 an exact implementation of IEEE or ISO rules/specifications for
8135 math functions. It may, however, yield faster code for programs
8136 that do not require the guarantees of these specifications.
8137
8138 The default is @option{-fmath-errno}.
8139
8140 On Darwin systems, the math library never sets @code{errno}.  There is
8141 therefore no reason for the compiler to consider the possibility that
8142 it might, and @option{-fno-math-errno} is the default.
8143
8144 @item -funsafe-math-optimizations
8145 @opindex funsafe-math-optimizations
8146
8147 Allow optimizations for floating-point arithmetic that (a) assume
8148 that arguments and results are valid and (b) may violate IEEE or
8149 ANSI standards.  When used at link-time, it may include libraries
8150 or startup files that change the default FPU control word or other
8151 similar optimizations.
8152
8153 This option is not turned on by any @option{-O} option since
8154 it can result in incorrect output for programs which depend on
8155 an exact implementation of IEEE or ISO rules/specifications for
8156 math functions. It may, however, yield faster code for programs
8157 that do not require the guarantees of these specifications.
8158 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8159 @option{-fassociative-math} and @option{-freciprocal-math}.
8160
8161 The default is @option{-fno-unsafe-math-optimizations}.
8162
8163 @item -fassociative-math
8164 @opindex fassociative-math
8165
8166 Allow re-association of operands in series of floating-point operations.
8167 This violates the ISO C and C++ language standard by possibly changing
8168 computation result.  NOTE: re-ordering may change the sign of zero as
8169 well as ignore NaNs and inhibit or create underflow or overflow (and
8170 thus cannot be used on a code which relies on rounding behavior like
8171 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
8172 and thus may not be used when ordered comparisons are required.
8173 This option requires that both @option{-fno-signed-zeros} and
8174 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8175 much sense with @option{-frounding-math}. For Fortran the option
8176 is automatically enabled when both @option{-fno-signed-zeros} and
8177 @option{-fno-trapping-math} are in effect.
8178
8179 The default is @option{-fno-associative-math}.
8180
8181 @item -freciprocal-math
8182 @opindex freciprocal-math
8183
8184 Allow the reciprocal of a value to be used instead of dividing by
8185 the value if this enables optimizations.  For example @code{x / y}
8186 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
8187 is subject to common subexpression elimination.  Note that this loses
8188 precision and increases the number of flops operating on the value.
8189
8190 The default is @option{-fno-reciprocal-math}.
8191
8192 @item -ffinite-math-only
8193 @opindex ffinite-math-only
8194 Allow optimizations for floating-point arithmetic that assume
8195 that arguments and results are not NaNs or +-Infs.
8196
8197 This option is not turned on by any @option{-O} option since
8198 it can result in incorrect output for programs which depend on
8199 an exact implementation of IEEE or ISO rules/specifications for
8200 math functions. It may, however, yield faster code for programs
8201 that do not require the guarantees of these specifications.
8202
8203 The default is @option{-fno-finite-math-only}.
8204
8205 @item -fno-signed-zeros
8206 @opindex fno-signed-zeros
8207 Allow optimizations for floating point arithmetic that ignore the
8208 signedness of zero.  IEEE arithmetic specifies the behavior of
8209 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8210 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8211 This option implies that the sign of a zero result isn't significant.
8212
8213 The default is @option{-fsigned-zeros}.
8214
8215 @item -fno-trapping-math
8216 @opindex fno-trapping-math
8217 Compile code assuming that floating-point operations cannot generate
8218 user-visible traps.  These traps include division by zero, overflow,
8219 underflow, inexact result and invalid operation.  This option requires
8220 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8221 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8222
8223 This option should never be turned on by any @option{-O} option since
8224 it can result in incorrect output for programs which depend on
8225 an exact implementation of IEEE or ISO rules/specifications for
8226 math functions.
8227
8228 The default is @option{-ftrapping-math}.
8229
8230 @item -frounding-math
8231 @opindex frounding-math
8232 Disable transformations and optimizations that assume default floating
8233 point rounding behavior.  This is round-to-zero for all floating point
8234 to integer conversions, and round-to-nearest for all other arithmetic
8235 truncations.  This option should be specified for programs that change
8236 the FP rounding mode dynamically, or that may be executed with a
8237 non-default rounding mode.  This option disables constant folding of
8238 floating point expressions at compile-time (which may be affected by
8239 rounding mode) and arithmetic transformations that are unsafe in the
8240 presence of sign-dependent rounding modes.
8241
8242 The default is @option{-fno-rounding-math}.
8243
8244 This option is experimental and does not currently guarantee to
8245 disable all GCC optimizations that are affected by rounding mode.
8246 Future versions of GCC may provide finer control of this setting
8247 using C99's @code{FENV_ACCESS} pragma.  This command line option
8248 will be used to specify the default state for @code{FENV_ACCESS}.
8249
8250 @item -fsignaling-nans
8251 @opindex fsignaling-nans
8252 Compile code assuming that IEEE signaling NaNs may generate user-visible
8253 traps during floating-point operations.  Setting this option disables
8254 optimizations that may change the number of exceptions visible with
8255 signaling NaNs.  This option implies @option{-ftrapping-math}.
8256
8257 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8258 be defined.
8259
8260 The default is @option{-fno-signaling-nans}.
8261
8262 This option is experimental and does not currently guarantee to
8263 disable all GCC optimizations that affect signaling NaN behavior.
8264
8265 @item -fsingle-precision-constant
8266 @opindex fsingle-precision-constant
8267 Treat floating point constant as single precision constant instead of
8268 implicitly converting it to double precision constant.
8269
8270 @item -fcx-limited-range
8271 @opindex fcx-limited-range
8272 When enabled, this option states that a range reduction step is not
8273 needed when performing complex division.  Also, there is no checking
8274 whether the result of a complex multiplication or division is @code{NaN
8275 + I*NaN}, with an attempt to rescue the situation in that case.  The
8276 default is @option{-fno-cx-limited-range}, but is enabled by
8277 @option{-ffast-math}.
8278
8279 This option controls the default setting of the ISO C99
8280 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8281 all languages.
8282
8283 @item -fcx-fortran-rules
8284 @opindex fcx-fortran-rules
8285 Complex multiplication and division follow Fortran rules.  Range
8286 reduction is done as part of complex division, but there is no checking
8287 whether the result of a complex multiplication or division is @code{NaN
8288 + I*NaN}, with an attempt to rescue the situation in that case.
8289
8290 The default is @option{-fno-cx-fortran-rules}.
8291
8292 @end table
8293
8294 The following options control optimizations that may improve
8295 performance, but are not enabled by any @option{-O} options.  This
8296 section includes experimental options that may produce broken code.
8297
8298 @table @gcctabopt
8299 @item -fbranch-probabilities
8300 @opindex fbranch-probabilities
8301 After running a program compiled with @option{-fprofile-arcs}
8302 (@pxref{Debugging Options,, Options for Debugging Your Program or
8303 @command{gcc}}), you can compile it a second time using
8304 @option{-fbranch-probabilities}, to improve optimizations based on
8305 the number of times each branch was taken.  When the program
8306 compiled with @option{-fprofile-arcs} exits it saves arc execution
8307 counts to a file called @file{@var{sourcename}.gcda} for each source
8308 file.  The information in this data file is very dependent on the
8309 structure of the generated code, so you must use the same source code
8310 and the same optimization options for both compilations.
8311
8312 With @option{-fbranch-probabilities}, GCC puts a
8313 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8314 These can be used to improve optimization.  Currently, they are only
8315 used in one place: in @file{reorg.c}, instead of guessing which path a
8316 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8317 exactly determine which path is taken more often.
8318
8319 @item -fprofile-values
8320 @opindex fprofile-values
8321 If combined with @option{-fprofile-arcs}, it adds code so that some
8322 data about values of expressions in the program is gathered.
8323
8324 With @option{-fbranch-probabilities}, it reads back the data gathered
8325 from profiling values of expressions for usage in optimizations.
8326
8327 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8328
8329 @item -fvpt
8330 @opindex fvpt
8331 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
8332 a code to gather information about values of expressions.
8333
8334 With @option{-fbranch-probabilities}, it reads back the data gathered
8335 and actually performs the optimizations based on them.
8336 Currently the optimizations include specialization of division operation
8337 using the knowledge about the value of the denominator.
8338
8339 @item -frename-registers
8340 @opindex frename-registers
8341 Attempt to avoid false dependencies in scheduled code by making use
8342 of registers left over after register allocation.  This optimization
8343 will most benefit processors with lots of registers.  Depending on the
8344 debug information format adopted by the target, however, it can
8345 make debugging impossible, since variables will no longer stay in
8346 a ``home register''.
8347
8348 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8349
8350 @item -ftracer
8351 @opindex ftracer
8352 Perform tail duplication to enlarge superblock size.  This transformation
8353 simplifies the control flow of the function allowing other optimizations to do
8354 better job.
8355
8356 Enabled with @option{-fprofile-use}.
8357
8358 @item -funroll-loops
8359 @opindex funroll-loops
8360 Unroll loops whose number of iterations can be determined at compile time or
8361 upon entry to the loop.  @option{-funroll-loops} implies
8362 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8363 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8364 small constant number of iterations).  This option makes code larger, and may
8365 or may not make it run faster.
8366
8367 Enabled with @option{-fprofile-use}.
8368
8369 @item -funroll-all-loops
8370 @opindex funroll-all-loops
8371 Unroll all loops, even if their number of iterations is uncertain when
8372 the loop is entered.  This usually makes programs run more slowly.
8373 @option{-funroll-all-loops} implies the same options as
8374 @option{-funroll-loops}.
8375
8376 @item -fpeel-loops
8377 @opindex fpeel-loops
8378 Peels the loops for that there is enough information that they do not
8379 roll much (from profile feedback).  It also turns on complete loop peeling
8380 (i.e.@: complete removal of loops with small constant number of iterations).
8381
8382 Enabled with @option{-fprofile-use}.
8383
8384 @item -fmove-loop-invariants
8385 @opindex fmove-loop-invariants
8386 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8387 at level @option{-O1}
8388
8389 @item -funswitch-loops
8390 @opindex funswitch-loops
8391 Move branches with loop invariant conditions out of the loop, with duplicates
8392 of the loop on both branches (modified according to result of the condition).
8393
8394 @item -ffunction-sections
8395 @itemx -fdata-sections
8396 @opindex ffunction-sections
8397 @opindex fdata-sections
8398 Place each function or data item into its own section in the output
8399 file if the target supports arbitrary sections.  The name of the
8400 function or the name of the data item determines the section's name
8401 in the output file.
8402
8403 Use these options on systems where the linker can perform optimizations
8404 to improve locality of reference in the instruction space.  Most systems
8405 using the ELF object format and SPARC processors running Solaris 2 have
8406 linkers with such optimizations.  AIX may have these optimizations in
8407 the future.
8408
8409 Only use these options when there are significant benefits from doing
8410 so.  When you specify these options, the assembler and linker will
8411 create larger object and executable files and will also be slower.
8412 You will not be able to use @code{gprof} on all systems if you
8413 specify this option and you may have problems with debugging if
8414 you specify both this option and @option{-g}.
8415
8416 @item -fbranch-target-load-optimize
8417 @opindex fbranch-target-load-optimize
8418 Perform branch target register load optimization before prologue / epilogue
8419 threading.
8420 The use of target registers can typically be exposed only during reload,
8421 thus hoisting loads out of loops and doing inter-block scheduling needs
8422 a separate optimization pass.
8423
8424 @item -fbranch-target-load-optimize2
8425 @opindex fbranch-target-load-optimize2
8426 Perform branch target register load optimization after prologue / epilogue
8427 threading.
8428
8429 @item -fbtr-bb-exclusive
8430 @opindex fbtr-bb-exclusive
8431 When performing branch target register load optimization, don't reuse
8432 branch target registers in within any basic block.
8433
8434 @item -fstack-protector
8435 @opindex fstack-protector
8436 Emit extra code to check for buffer overflows, such as stack smashing
8437 attacks.  This is done by adding a guard variable to functions with
8438 vulnerable objects.  This includes functions that call alloca, and
8439 functions with buffers larger than 8 bytes.  The guards are initialized
8440 when a function is entered and then checked when the function exits.
8441 If a guard check fails, an error message is printed and the program exits.
8442
8443 @item -fstack-protector-all
8444 @opindex fstack-protector-all
8445 Like @option{-fstack-protector} except that all functions are protected.
8446
8447 @item -fsection-anchors
8448 @opindex fsection-anchors
8449 Try to reduce the number of symbolic address calculations by using
8450 shared ``anchor'' symbols to address nearby objects.  This transformation
8451 can help to reduce the number of GOT entries and GOT accesses on some
8452 targets.
8453
8454 For example, the implementation of the following function @code{foo}:
8455
8456 @smallexample
8457 static int a, b, c;
8458 int foo (void) @{ return a + b + c; @}
8459 @end smallexample
8460
8461 would usually calculate the addresses of all three variables, but if you
8462 compile it with @option{-fsection-anchors}, it will access the variables
8463 from a common anchor point instead.  The effect is similar to the
8464 following pseudocode (which isn't valid C):
8465
8466 @smallexample
8467 int foo (void)
8468 @{
8469   register int *xr = &x;
8470   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8471 @}
8472 @end smallexample
8473
8474 Not all targets support this option.
8475
8476 @item --param @var{name}=@var{value}
8477 @opindex param
8478 In some places, GCC uses various constants to control the amount of
8479 optimization that is done.  For example, GCC will not inline functions
8480 that contain more that a certain number of instructions.  You can
8481 control some of these constants on the command-line using the
8482 @option{--param} option.
8483
8484 The names of specific parameters, and the meaning of the values, are
8485 tied to the internals of the compiler, and are subject to change
8486 without notice in future releases.
8487
8488 In each case, the @var{value} is an integer.  The allowable choices for
8489 @var{name} are given in the following table:
8490
8491 @table @gcctabopt
8492 @item predictable-branch-outcome
8493 When branch is predicted to be taken with probability lower than this threshold
8494 (in percent), then it is considered well predictable. The default is 10.
8495
8496 @item max-crossjump-edges
8497 The maximum number of incoming edges to consider for crossjumping.
8498 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8499 the number of edges incoming to each block.  Increasing values mean
8500 more aggressive optimization, making the compile time increase with
8501 probably small improvement in executable size.
8502
8503 @item min-crossjump-insns
8504 The minimum number of instructions which must be matched at the end
8505 of two blocks before crossjumping will be performed on them.  This
8506 value is ignored in the case where all instructions in the block being
8507 crossjumped from are matched.  The default value is 5.
8508
8509 @item max-grow-copy-bb-insns
8510 The maximum code size expansion factor when copying basic blocks
8511 instead of jumping.  The expansion is relative to a jump instruction.
8512 The default value is 8.
8513
8514 @item max-goto-duplication-insns
8515 The maximum number of instructions to duplicate to a block that jumps
8516 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8517 passes, GCC factors computed gotos early in the compilation process,
8518 and unfactors them as late as possible.  Only computed jumps at the
8519 end of a basic blocks with no more than max-goto-duplication-insns are
8520 unfactored.  The default value is 8.
8521
8522 @item max-delay-slot-insn-search
8523 The maximum number of instructions to consider when looking for an
8524 instruction to fill a delay slot.  If more than this arbitrary number of
8525 instructions is searched, the time savings from filling the delay slot
8526 will be minimal so stop searching.  Increasing values mean more
8527 aggressive optimization, making the compile time increase with probably
8528 small improvement in executable run time.
8529
8530 @item max-delay-slot-live-search
8531 When trying to fill delay slots, the maximum number of instructions to
8532 consider when searching for a block with valid live register
8533 information.  Increasing this arbitrarily chosen value means more
8534 aggressive optimization, increasing the compile time.  This parameter
8535 should be removed when the delay slot code is rewritten to maintain the
8536 control-flow graph.
8537
8538 @item max-gcse-memory
8539 The approximate maximum amount of memory that will be allocated in
8540 order to perform the global common subexpression elimination
8541 optimization.  If more memory than specified is required, the
8542 optimization will not be done.
8543
8544 @item max-gcse-insertion-ratio
8545 If the ratio of expression insertions to deletions is larger than this value
8546 for any expression, then RTL PRE will insert or remove the expression and thus
8547 leave partially redundant computations in the instruction stream.  The default value is 20.
8548
8549 @item max-pending-list-length
8550 The maximum number of pending dependencies scheduling will allow
8551 before flushing the current state and starting over.  Large functions
8552 with few branches or calls can create excessively large lists which
8553 needlessly consume memory and resources.
8554
8555 @item max-modulo-backtrack-attempts
8556 The maximum number of backtrack attempts the scheduler should make
8557 when modulo scheduling a loop.  Larger values can exponentially increase
8558 compile time.
8559
8560 @item max-inline-insns-single
8561 Several parameters control the tree inliner used in gcc.
8562 This number sets the maximum number of instructions (counted in GCC's
8563 internal representation) in a single function that the tree inliner
8564 will consider for inlining.  This only affects functions declared
8565 inline and methods implemented in a class declaration (C++).
8566 The default value is 400.
8567
8568 @item max-inline-insns-auto
8569 When you use @option{-finline-functions} (included in @option{-O3}),
8570 a lot of functions that would otherwise not be considered for inlining
8571 by the compiler will be investigated.  To those functions, a different
8572 (more restrictive) limit compared to functions declared inline can
8573 be applied.
8574 The default value is 40.
8575
8576 @item large-function-insns
8577 The limit specifying really large functions.  For functions larger than this
8578 limit after inlining, inlining is constrained by
8579 @option{--param large-function-growth}.  This parameter is useful primarily
8580 to avoid extreme compilation time caused by non-linear algorithms used by the
8581 backend.
8582 The default value is 2700.
8583
8584 @item large-function-growth
8585 Specifies maximal growth of large function caused by inlining in percents.
8586 The default value is 100 which limits large function growth to 2.0 times
8587 the original size.
8588
8589 @item large-unit-insns
8590 The limit specifying large translation unit.  Growth caused by inlining of
8591 units larger than this limit is limited by @option{--param inline-unit-growth}.
8592 For small units this might be too tight (consider unit consisting of function A
8593 that is inline and B that just calls A three time.  If B is small relative to
8594 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8595 large units consisting of small inlineable functions however the overall unit
8596 growth limit is needed to avoid exponential explosion of code size.  Thus for
8597 smaller units, the size is increased to @option{--param large-unit-insns}
8598 before applying @option{--param inline-unit-growth}.  The default is 10000
8599
8600 @item inline-unit-growth
8601 Specifies maximal overall growth of the compilation unit caused by inlining.
8602 The default value is 30 which limits unit growth to 1.3 times the original
8603 size.
8604
8605 @item ipcp-unit-growth
8606 Specifies maximal overall growth of the compilation unit caused by
8607 interprocedural constant propagation.  The default value is 10 which limits
8608 unit growth to 1.1 times the original size.
8609
8610 @item large-stack-frame
8611 The limit specifying large stack frames.  While inlining the algorithm is trying
8612 to not grow past this limit too much.  Default value is 256 bytes.
8613
8614 @item large-stack-frame-growth
8615 Specifies maximal growth of large stack frames caused by inlining in percents.
8616 The default value is 1000 which limits large stack frame growth to 11 times
8617 the original size.
8618
8619 @item max-inline-insns-recursive
8620 @itemx max-inline-insns-recursive-auto
8621 Specifies maximum number of instructions out-of-line copy of self recursive inline
8622 function can grow into by performing recursive inlining.
8623
8624 For functions declared inline @option{--param max-inline-insns-recursive} is
8625 taken into account.  For function not declared inline, recursive inlining
8626 happens only when @option{-finline-functions} (included in @option{-O3}) is
8627 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8628 default value is 450.
8629
8630 @item max-inline-recursive-depth
8631 @itemx max-inline-recursive-depth-auto
8632 Specifies maximum recursion depth used by the recursive inlining.
8633
8634 For functions declared inline @option{--param max-inline-recursive-depth} is
8635 taken into account.  For function not declared inline, recursive inlining
8636 happens only when @option{-finline-functions} (included in @option{-O3}) is
8637 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8638 default value is 8.
8639
8640 @item min-inline-recursive-probability
8641 Recursive inlining is profitable only for function having deep recursion
8642 in average and can hurt for function having little recursion depth by
8643 increasing the prologue size or complexity of function body to other
8644 optimizers.
8645
8646 When profile feedback is available (see @option{-fprofile-generate}) the actual
8647 recursion depth can be guessed from probability that function will recurse via
8648 given call expression.  This parameter limits inlining only to call expression
8649 whose probability exceeds given threshold (in percents).  The default value is
8650 10.
8651
8652 @item early-inlining-insns
8653 Specify growth that early inliner can make.  In effect it increases amount of
8654 inlining for code having large abstraction penalty.  The default value is 10.
8655
8656 @item max-early-inliner-iterations
8657 @itemx max-early-inliner-iterations
8658 Limit of iterations of early inliner.  This basically bounds number of nested
8659 indirect calls early inliner can resolve.  Deeper chains are still handled by
8660 late inlining.
8661
8662 @item comdat-sharing-probability
8663 @itemx comdat-sharing-probability
8664 Probability (in percent) that C++ inline function with comdat visibility
8665 will be shared across multiple compilation units.  The default value is 20.
8666
8667 @item min-vect-loop-bound
8668 The minimum number of iterations under which a loop will not get vectorized
8669 when @option{-ftree-vectorize} is used.  The number of iterations after
8670 vectorization needs to be greater than the value specified by this option
8671 to allow vectorization.  The default value is 0.
8672
8673 @item gcse-cost-distance-ratio
8674 Scaling factor in calculation of maximum distance an expression
8675 can be moved by GCSE optimizations.  This is currently supported only in the
8676 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
8677 will be with simple expressions, i.e., the expressions which have cost
8678 less than @option{gcse-unrestricted-cost}.  Specifying 0 will disable
8679 hoisting of simple expressions.  The default value is 10.
8680
8681 @item gcse-unrestricted-cost
8682 Cost, roughly measured as the cost of a single typical machine
8683 instruction, at which GCSE optimizations will not constrain
8684 the distance an expression can travel.  This is currently
8685 supported only in the code hoisting pass.  The lesser the cost,
8686 the more aggressive code hoisting will be.  Specifying 0 will
8687 allow all expressions to travel unrestricted distances.
8688 The default value is 3.
8689
8690 @item max-hoist-depth
8691 The depth of search in the dominator tree for expressions to hoist.
8692 This is used to avoid quadratic behavior in hoisting algorithm.
8693 The value of 0 will avoid limiting the search, but may slow down compilation
8694 of huge functions.  The default value is 30.
8695
8696 @item max-tail-merge-comparisons
8697 The maximum amount of similar bbs to compare a bb with.  This is used to
8698 avoid quadratic behaviour in tree tail merging.  The default value is 10.
8699
8700 @item max-tail-merge-iterations
8701 The maximum amount of iterations of the pass over the function.  This is used to
8702 limit run time in tree tail merging.  The default value is 2.
8703
8704 @item max-unrolled-insns
8705 The maximum number of instructions that a loop should have if that loop
8706 is unrolled, and if the loop is unrolled, it determines how many times
8707 the loop code is unrolled.
8708
8709 @item max-average-unrolled-insns
8710 The maximum number of instructions biased by probabilities of their execution
8711 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8712 it determines how many times the loop code is unrolled.
8713
8714 @item max-unroll-times
8715 The maximum number of unrollings of a single loop.
8716
8717 @item max-peeled-insns
8718 The maximum number of instructions that a loop should have if that loop
8719 is peeled, and if the loop is peeled, it determines how many times
8720 the loop code is peeled.
8721
8722 @item max-peel-times
8723 The maximum number of peelings of a single loop.
8724
8725 @item max-completely-peeled-insns
8726 The maximum number of insns of a completely peeled loop.
8727
8728 @item max-completely-peel-times
8729 The maximum number of iterations of a loop to be suitable for complete peeling.
8730
8731 @item max-completely-peel-loop-nest-depth
8732 The maximum depth of a loop nest suitable for complete peeling.
8733
8734 @item max-unswitch-insns
8735 The maximum number of insns of an unswitched loop.
8736
8737 @item max-unswitch-level
8738 The maximum number of branches unswitched in a single loop.
8739
8740 @item lim-expensive
8741 The minimum cost of an expensive expression in the loop invariant motion.
8742
8743 @item iv-consider-all-candidates-bound
8744 Bound on number of candidates for induction variables below that
8745 all candidates are considered for each use in induction variable
8746 optimizations.  Only the most relevant candidates are considered
8747 if there are more candidates, to avoid quadratic time complexity.
8748
8749 @item iv-max-considered-uses
8750 The induction variable optimizations give up on loops that contain more
8751 induction variable uses.
8752
8753 @item iv-always-prune-cand-set-bound
8754 If number of candidates in the set is smaller than this value,
8755 we always try to remove unnecessary ivs from the set during its
8756 optimization when a new iv is added to the set.
8757
8758 @item scev-max-expr-size
8759 Bound on size of expressions used in the scalar evolutions analyzer.
8760 Large expressions slow the analyzer.
8761
8762 @item scev-max-expr-complexity
8763 Bound on the complexity of the expressions in the scalar evolutions analyzer.
8764 Complex expressions slow the analyzer.
8765
8766 @item omega-max-vars
8767 The maximum number of variables in an Omega constraint system.
8768 The default value is 128.
8769
8770 @item omega-max-geqs
8771 The maximum number of inequalities in an Omega constraint system.
8772 The default value is 256.
8773
8774 @item omega-max-eqs
8775 The maximum number of equalities in an Omega constraint system.
8776 The default value is 128.
8777
8778 @item omega-max-wild-cards
8779 The maximum number of wildcard variables that the Omega solver will
8780 be able to insert.  The default value is 18.
8781
8782 @item omega-hash-table-size
8783 The size of the hash table in the Omega solver.  The default value is
8784 550.
8785
8786 @item omega-max-keys
8787 The maximal number of keys used by the Omega solver.  The default
8788 value is 500.
8789
8790 @item omega-eliminate-redundant-constraints
8791 When set to 1, use expensive methods to eliminate all redundant
8792 constraints.  The default value is 0.
8793
8794 @item vect-max-version-for-alignment-checks
8795 The maximum number of runtime checks that can be performed when
8796 doing loop versioning for alignment in the vectorizer.  See option
8797 ftree-vect-loop-version for more information.
8798
8799 @item vect-max-version-for-alias-checks
8800 The maximum number of runtime checks that can be performed when
8801 doing loop versioning for alias in the vectorizer.  See option
8802 ftree-vect-loop-version for more information.
8803
8804 @item max-iterations-to-track
8805
8806 The maximum number of iterations of a loop the brute force algorithm
8807 for analysis of # of iterations of the loop tries to evaluate.
8808
8809 @item hot-bb-count-fraction
8810 Select fraction of the maximal count of repetitions of basic block in program
8811 given basic block needs to have to be considered hot.
8812
8813 @item hot-bb-frequency-fraction
8814 Select fraction of the entry block frequency of executions of basic block in
8815 function given basic block needs to have to be considered hot.
8816
8817 @item max-predicted-iterations
8818 The maximum number of loop iterations we predict statically.  This is useful
8819 in cases where function contain single loop with known bound and other loop
8820 with unknown.  We predict the known number of iterations correctly, while
8821 the unknown number of iterations average to roughly 10.  This means that the
8822 loop without bounds would appear artificially cold relative to the other one.
8823
8824 @item align-threshold
8825
8826 Select fraction of the maximal frequency of executions of basic block in
8827 function given basic block will get aligned.
8828
8829 @item align-loop-iterations
8830
8831 A loop expected to iterate at lest the selected number of iterations will get
8832 aligned.
8833
8834 @item tracer-dynamic-coverage
8835 @itemx tracer-dynamic-coverage-feedback
8836
8837 This value is used to limit superblock formation once the given percentage of
8838 executed instructions is covered.  This limits unnecessary code size
8839 expansion.
8840
8841 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8842 feedback is available.  The real profiles (as opposed to statically estimated
8843 ones) are much less balanced allowing the threshold to be larger value.
8844
8845 @item tracer-max-code-growth
8846 Stop tail duplication once code growth has reached given percentage.  This is
8847 rather hokey argument, as most of the duplicates will be eliminated later in
8848 cross jumping, so it may be set to much higher values than is the desired code
8849 growth.
8850
8851 @item tracer-min-branch-ratio
8852
8853 Stop reverse growth when the reverse probability of best edge is less than this
8854 threshold (in percent).
8855
8856 @item tracer-min-branch-ratio
8857 @itemx tracer-min-branch-ratio-feedback
8858
8859 Stop forward growth if the best edge do have probability lower than this
8860 threshold.
8861
8862 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8863 compilation for profile feedback and one for compilation without.  The value
8864 for compilation with profile feedback needs to be more conservative (higher) in
8865 order to make tracer effective.
8866
8867 @item max-cse-path-length
8868
8869 Maximum number of basic blocks on path that cse considers.  The default is 10.
8870
8871 @item max-cse-insns
8872 The maximum instructions CSE process before flushing. The default is 1000.
8873
8874 @item ggc-min-expand
8875
8876 GCC uses a garbage collector to manage its own memory allocation.  This
8877 parameter specifies the minimum percentage by which the garbage
8878 collector's heap should be allowed to expand between collections.
8879 Tuning this may improve compilation speed; it has no effect on code
8880 generation.
8881
8882 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8883 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8884 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8885 GCC is not able to calculate RAM on a particular platform, the lower
8886 bound of 30% is used.  Setting this parameter and
8887 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8888 every opportunity.  This is extremely slow, but can be useful for
8889 debugging.
8890
8891 @item ggc-min-heapsize
8892
8893 Minimum size of the garbage collector's heap before it begins bothering
8894 to collect garbage.  The first collection occurs after the heap expands
8895 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8896 tuning this may improve compilation speed, and has no effect on code
8897 generation.
8898
8899 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8900 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8901 with a lower bound of 4096 (four megabytes) and an upper bound of
8902 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8903 particular platform, the lower bound is used.  Setting this parameter
8904 very large effectively disables garbage collection.  Setting this
8905 parameter and @option{ggc-min-expand} to zero causes a full collection
8906 to occur at every opportunity.
8907
8908 @item max-reload-search-insns
8909 The maximum number of instruction reload should look backward for equivalent
8910 register.  Increasing values mean more aggressive optimization, making the
8911 compile time increase with probably slightly better performance.  The default
8912 value is 100.
8913
8914 @item max-cselib-memory-locations
8915 The maximum number of memory locations cselib should take into account.
8916 Increasing values mean more aggressive optimization, making the compile time
8917 increase with probably slightly better performance.  The default value is 500.
8918
8919 @item reorder-blocks-duplicate
8920 @itemx reorder-blocks-duplicate-feedback
8921
8922 Used by basic block reordering pass to decide whether to use unconditional
8923 branch or duplicate the code on its destination.  Code is duplicated when its
8924 estimated size is smaller than this value multiplied by the estimated size of
8925 unconditional jump in the hot spots of the program.
8926
8927 The @option{reorder-block-duplicate-feedback} is used only when profile
8928 feedback is available and may be set to higher values than
8929 @option{reorder-block-duplicate} since information about the hot spots is more
8930 accurate.
8931
8932 @item max-sched-ready-insns
8933 The maximum number of instructions ready to be issued the scheduler should
8934 consider at any given time during the first scheduling pass.  Increasing
8935 values mean more thorough searches, making the compilation time increase
8936 with probably little benefit.  The default value is 100.
8937
8938 @item max-sched-region-blocks
8939 The maximum number of blocks in a region to be considered for
8940 interblock scheduling.  The default value is 10.
8941
8942 @item max-pipeline-region-blocks
8943 The maximum number of blocks in a region to be considered for
8944 pipelining in the selective scheduler.  The default value is 15.
8945
8946 @item max-sched-region-insns
8947 The maximum number of insns in a region to be considered for
8948 interblock scheduling.  The default value is 100.
8949
8950 @item max-pipeline-region-insns
8951 The maximum number of insns in a region to be considered for
8952 pipelining in the selective scheduler.  The default value is 200.
8953
8954 @item min-spec-prob
8955 The minimum probability (in percents) of reaching a source block
8956 for interblock speculative scheduling.  The default value is 40.
8957
8958 @item max-sched-extend-regions-iters
8959 The maximum number of iterations through CFG to extend regions.
8960 0 - disable region extension,
8961 N - do at most N iterations.
8962 The default value is 0.
8963
8964 @item max-sched-insn-conflict-delay
8965 The maximum conflict delay for an insn to be considered for speculative motion.
8966 The default value is 3.
8967
8968 @item sched-spec-prob-cutoff
8969 The minimal probability of speculation success (in percents), so that
8970 speculative insn will be scheduled.
8971 The default value is 40.
8972
8973 @item sched-mem-true-dep-cost
8974 Minimal distance (in CPU cycles) between store and load targeting same
8975 memory locations.  The default value is 1.
8976
8977 @item selsched-max-lookahead
8978 The maximum size of the lookahead window of selective scheduling.  It is a
8979 depth of search for available instructions.
8980 The default value is 50.
8981
8982 @item selsched-max-sched-times
8983 The maximum number of times that an instruction will be scheduled during
8984 selective scheduling.  This is the limit on the number of iterations
8985 through which the instruction may be pipelined.  The default value is 2.
8986
8987 @item selsched-max-insns-to-rename
8988 The maximum number of best instructions in the ready list that are considered
8989 for renaming in the selective scheduler.  The default value is 2.
8990
8991 @item sms-min-sc
8992 The minimum value of stage count that swing modulo scheduler will
8993 generate.  The default value is 2.
8994
8995 @item max-last-value-rtl
8996 The maximum size measured as number of RTLs that can be recorded in an expression
8997 in combiner for a pseudo register as last known value of that register.  The default
8998 is 10000.
8999
9000 @item integer-share-limit
9001 Small integer constants can use a shared data structure, reducing the
9002 compiler's memory usage and increasing its speed.  This sets the maximum
9003 value of a shared integer constant.  The default value is 256.
9004
9005 @item min-virtual-mappings
9006 Specifies the minimum number of virtual mappings in the incremental
9007 SSA updater that should be registered to trigger the virtual mappings
9008 heuristic defined by virtual-mappings-ratio.  The default value is
9009 100.
9010
9011 @item virtual-mappings-ratio
9012 If the number of virtual mappings is virtual-mappings-ratio bigger
9013 than the number of virtual symbols to be updated, then the incremental
9014 SSA updater switches to a full update for those symbols.  The default
9015 ratio is 3.
9016
9017 @item ssp-buffer-size
9018 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
9019 protection when @option{-fstack-protection} is used.
9020
9021 @item max-jump-thread-duplication-stmts
9022 Maximum number of statements allowed in a block that needs to be
9023 duplicated when threading jumps.
9024
9025 @item max-fields-for-field-sensitive
9026 Maximum number of fields in a structure we will treat in
9027 a field sensitive manner during pointer analysis.  The default is zero
9028 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
9029
9030 @item prefetch-latency
9031 Estimate on average number of instructions that are executed before
9032 prefetch finishes.  The distance we prefetch ahead is proportional
9033 to this constant.  Increasing this number may also lead to less
9034 streams being prefetched (see @option{simultaneous-prefetches}).
9035
9036 @item simultaneous-prefetches
9037 Maximum number of prefetches that can run at the same time.
9038
9039 @item l1-cache-line-size
9040 The size of cache line in L1 cache, in bytes.
9041
9042 @item l1-cache-size
9043 The size of L1 cache, in kilobytes.
9044
9045 @item l2-cache-size
9046 The size of L2 cache, in kilobytes.
9047
9048 @item min-insn-to-prefetch-ratio
9049 The minimum ratio between the number of instructions and the
9050 number of prefetches to enable prefetching in a loop.
9051
9052 @item prefetch-min-insn-to-mem-ratio
9053 The minimum ratio between the number of instructions and the
9054 number of memory references to enable prefetching in a loop.
9055
9056 @item use-canonical-types
9057 Whether the compiler should use the ``canonical'' type system.  By
9058 default, this should always be 1, which uses a more efficient internal
9059 mechanism for comparing types in C++ and Objective-C++.  However, if
9060 bugs in the canonical type system are causing compilation failures,
9061 set this value to 0 to disable canonical types.
9062
9063 @item switch-conversion-max-branch-ratio
9064 Switch initialization conversion will refuse to create arrays that are
9065 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9066 branches in the switch.
9067
9068 @item max-partial-antic-length
9069 Maximum length of the partial antic set computed during the tree
9070 partial redundancy elimination optimization (@option{-ftree-pre}) when
9071 optimizing at @option{-O3} and above.  For some sorts of source code
9072 the enhanced partial redundancy elimination optimization can run away,
9073 consuming all of the memory available on the host machine.  This
9074 parameter sets a limit on the length of the sets that are computed,
9075 which prevents the runaway behavior.  Setting a value of 0 for
9076 this parameter will allow an unlimited set length.
9077
9078 @item sccvn-max-scc-size
9079 Maximum size of a strongly connected component (SCC) during SCCVN
9080 processing.  If this limit is hit, SCCVN processing for the whole
9081 function will not be done and optimizations depending on it will
9082 be disabled.  The default maximum SCC size is 10000.
9083
9084 @item ira-max-loops-num
9085 IRA uses a regional register allocation by default.  If a function
9086 contains loops more than number given by the parameter, only at most
9087 given number of the most frequently executed loops will form regions
9088 for the regional register allocation.  The default value of the
9089 parameter is 100.
9090
9091 @item ira-max-conflict-table-size
9092 Although IRA uses a sophisticated algorithm of compression conflict
9093 table, the table can be still big for huge functions.  If the conflict
9094 table for a function could be more than size in MB given by the
9095 parameter, the conflict table is not built and faster, simpler, and
9096 lower quality register allocation algorithm will be used.  The
9097 algorithm do not use pseudo-register conflicts.  The default value of
9098 the parameter is 2000.
9099
9100 @item ira-loop-reserved-regs
9101 IRA can be used to evaluate more accurate register pressure in loops
9102 for decision to move loop invariants (see @option{-O3}).  The number
9103 of available registers reserved for some other purposes is described
9104 by this parameter.  The default value of the parameter is 2 which is
9105 minimal number of registers needed for execution of typical
9106 instruction.  This value is the best found from numerous experiments.
9107
9108 @item loop-invariant-max-bbs-in-loop
9109 Loop invariant motion can be very expensive, both in compile time and
9110 in amount of needed compile time memory, with very large loops.  Loops
9111 with more basic blocks than this parameter won't have loop invariant
9112 motion optimization performed on them.  The default value of the
9113 parameter is 1000 for -O1 and 10000 for -O2 and above.
9114
9115 @item max-vartrack-size
9116 Sets a maximum number of hash table slots to use during variable
9117 tracking dataflow analysis of any function.  If this limit is exceeded
9118 with variable tracking at assignments enabled, analysis for that
9119 function is retried without it, after removing all debug insns from
9120 the function.  If the limit is exceeded even without debug insns, var
9121 tracking analysis is completely disabled for the function.  Setting
9122 the parameter to zero makes it unlimited.
9123
9124 @item max-vartrack-expr-depth
9125 Sets a maximum number of recursion levels when attempting to map
9126 variable names or debug temporaries to value expressions.  This trades
9127 compile time for more complete debug information.  If this is set too
9128 low, value expressions that are available and could be represented in
9129 debug information may end up not being used; setting this higher may
9130 enable the compiler to find more complex debug expressions, but compile
9131 time and memory use may grow.  The default is 12.
9132
9133 @item min-nondebug-insn-uid
9134 Use uids starting at this parameter for nondebug insns.  The range below
9135 the parameter is reserved exclusively for debug insns created by
9136 @option{-fvar-tracking-assignments}, but debug insns may get
9137 (non-overlapping) uids above it if the reserved range is exhausted.
9138
9139 @item ipa-sra-ptr-growth-factor
9140 IPA-SRA will replace a pointer to an aggregate with one or more new
9141 parameters only when their cumulative size is less or equal to
9142 @option{ipa-sra-ptr-growth-factor} times the size of the original
9143 pointer parameter.
9144
9145 @item tm-max-aggregate-size
9146 When making copies of thread-local variables in a transaction, this
9147 parameter specifies the size in bytes after which variables will be
9148 saved with the logging functions as opposed to save/restore code
9149 sequence pairs.  This option only applies when using
9150 @option{-fgnu-tm}.
9151
9152 @item graphite-max-nb-scop-params
9153 To avoid exponential effects in the Graphite loop transforms, the
9154 number of parameters in a Static Control Part (SCoP) is bounded.  The
9155 default value is 10 parameters.  A variable whose value is unknown at
9156 compile time and defined outside a SCoP is a parameter of the SCoP.
9157
9158 @item graphite-max-bbs-per-function
9159 To avoid exponential effects in the detection of SCoPs, the size of
9160 the functions analyzed by Graphite is bounded.  The default value is
9161 100 basic blocks.
9162
9163 @item loop-block-tile-size
9164 Loop blocking or strip mining transforms, enabled with
9165 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9166 loop in the loop nest by a given number of iterations.  The strip
9167 length can be changed using the @option{loop-block-tile-size}
9168 parameter.  The default value is 51 iterations.
9169
9170 @item ipa-cp-value-list-size
9171 IPA-CP attempts to track all possible values and types passed to a function's
9172 parameter in order to propagate them and perform devirtualization.
9173 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9174 stores per one formal parameter of a function.
9175
9176 @item lto-partitions
9177 Specify desired number of partitions produced during WHOPR compilation.
9178 The number of partitions should exceed the number of CPUs used for compilation.
9179 The default value is 32.
9180
9181 @item lto-minpartition
9182 Size of minimal partition for WHOPR (in estimated instructions).
9183 This prevents expenses of splitting very small programs into too many
9184 partitions.
9185
9186 @item cxx-max-namespaces-for-diagnostic-help
9187 The maximum number of namespaces to consult for suggestions when C++
9188 name lookup fails for an identifier.  The default is 1000.
9189
9190 @item sink-frequency-threshold
9191 The maximum relative execution frequency (in percents) of the target block
9192 relative to a statement's original block to allow statement sinking of a
9193 statement.  Larger numbers result in more aggressive statement sinking.
9194 The default value is 75.  A small positive adjustment is applied for
9195 statements with memory operands as those are even more profitable so sink.
9196
9197 @item max-stores-to-sink
9198 The maximum number of conditional stores paires that can be sunk.  Set to 0
9199 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9200 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9201
9202 @item allow-load-data-races
9203 Allow optimizers to introduce new data races on loads.
9204 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9205 unless implicitly set by the @option{-fmemory-model=} option.
9206
9207 @item allow-store-data-races
9208 Allow optimizers to introduce new data races on stores.
9209 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9210 unless implicitly set by the @option{-fmemory-model=} option.
9211
9212 @item allow-packed-load-data-races
9213 Allow optimizers to introduce new data races on packed data loads.
9214 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9215 unless implicitly set by the @option{-fmemory-model=} option.
9216
9217 @item allow-packed-store-data-races
9218 Allow optimizers to introduce new data races on packed data stores.
9219 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9220 unless implicitly set by the @option{-fmemory-model=} option.
9221
9222 @item case-values-threshold
9223 The smallest number of different values for which it is best to use a
9224 jump-table instead of a tree of conditional branches.  If the value is
9225 0, use the default for the machine.  The default is 0.
9226
9227 @item tree-reassoc-width
9228 Set the maximum number of instructions executed in parallel in
9229 reassociated tree. This parameter overrides target dependent
9230 heuristics used by default if has non zero value.
9231
9232 @end table
9233 @end table
9234
9235 @node Preprocessor Options
9236 @section Options Controlling the Preprocessor
9237 @cindex preprocessor options
9238 @cindex options, preprocessor
9239
9240 These options control the C preprocessor, which is run on each C source
9241 file before actual compilation.
9242
9243 If you use the @option{-E} option, nothing is done except preprocessing.
9244 Some of these options make sense only together with @option{-E} because
9245 they cause the preprocessor output to be unsuitable for actual
9246 compilation.
9247
9248 @table @gcctabopt
9249 @item -Wp,@var{option}
9250 @opindex Wp
9251 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9252 and pass @var{option} directly through to the preprocessor.  If
9253 @var{option} contains commas, it is split into multiple options at the
9254 commas.  However, many options are modified, translated or interpreted
9255 by the compiler driver before being passed to the preprocessor, and
9256 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9257 interface is undocumented and subject to change, so whenever possible
9258 you should avoid using @option{-Wp} and let the driver handle the
9259 options instead.
9260
9261 @item -Xpreprocessor @var{option}
9262 @opindex Xpreprocessor
9263 Pass @var{option} as an option to the preprocessor.  You can use this to
9264 supply system-specific preprocessor options which GCC does not know how to
9265 recognize.
9266
9267 If you want to pass an option that takes an argument, you must use
9268 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9269 @end table
9270
9271 @include cppopts.texi
9272
9273 @node Assembler Options
9274 @section Passing Options to the Assembler
9275
9276 @c prevent bad page break with this line
9277 You can pass options to the assembler.
9278
9279 @table @gcctabopt
9280 @item -Wa,@var{option}
9281 @opindex Wa
9282 Pass @var{option} as an option to the assembler.  If @var{option}
9283 contains commas, it is split into multiple options at the commas.
9284
9285 @item -Xassembler @var{option}
9286 @opindex Xassembler
9287 Pass @var{option} as an option to the assembler.  You can use this to
9288 supply system-specific assembler options which GCC does not know how to
9289 recognize.
9290
9291 If you want to pass an option that takes an argument, you must use
9292 @option{-Xassembler} twice, once for the option and once for the argument.
9293
9294 @end table
9295
9296 @node Link Options
9297 @section Options for Linking
9298 @cindex link options
9299 @cindex options, linking
9300
9301 These options come into play when the compiler links object files into
9302 an executable output file.  They are meaningless if the compiler is
9303 not doing a link step.
9304
9305 @table @gcctabopt
9306 @cindex file names
9307 @item @var{object-file-name}
9308 A file name that does not end in a special recognized suffix is
9309 considered to name an object file or library.  (Object files are
9310 distinguished from libraries by the linker according to the file
9311 contents.)  If linking is done, these object files are used as input
9312 to the linker.
9313
9314 @item -c
9315 @itemx -S
9316 @itemx -E
9317 @opindex c
9318 @opindex S
9319 @opindex E
9320 If any of these options is used, then the linker is not run, and
9321 object file names should not be used as arguments.  @xref{Overall
9322 Options}.
9323
9324 @cindex Libraries
9325 @item -l@var{library}
9326 @itemx -l @var{library}
9327 @opindex l
9328 Search the library named @var{library} when linking.  (The second
9329 alternative with the library as a separate argument is only for
9330 POSIX compliance and is not recommended.)
9331
9332 It makes a difference where in the command you write this option; the
9333 linker searches and processes libraries and object files in the order they
9334 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9335 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9336 to functions in @samp{z}, those functions may not be loaded.
9337
9338 The linker searches a standard list of directories for the library,
9339 which is actually a file named @file{lib@var{library}.a}.  The linker
9340 then uses this file as if it had been specified precisely by name.
9341
9342 The directories searched include several standard system directories
9343 plus any that you specify with @option{-L}.
9344
9345 Normally the files found this way are library files---archive files
9346 whose members are object files.  The linker handles an archive file by
9347 scanning through it for members which define symbols that have so far
9348 been referenced but not defined.  But if the file that is found is an
9349 ordinary object file, it is linked in the usual fashion.  The only
9350 difference between using an @option{-l} option and specifying a file name
9351 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9352 and searches several directories.
9353
9354 @item -lobjc
9355 @opindex lobjc
9356 You need this special case of the @option{-l} option in order to
9357 link an Objective-C or Objective-C++ program.
9358
9359 @item -nostartfiles
9360 @opindex nostartfiles
9361 Do not use the standard system startup files when linking.
9362 The standard system libraries are used normally, unless @option{-nostdlib}
9363 or @option{-nodefaultlibs} is used.
9364
9365 @item -nodefaultlibs
9366 @opindex nodefaultlibs
9367 Do not use the standard system libraries when linking.
9368 Only the libraries you specify will be passed to the linker, options
9369 specifying linkage of the system libraries, such as @code{-static-libgcc}
9370 or @code{-shared-libgcc}, will be ignored.
9371 The standard startup files are used normally, unless @option{-nostartfiles}
9372 is used.  The compiler may generate calls to @code{memcmp},
9373 @code{memset}, @code{memcpy} and @code{memmove}.
9374 These entries are usually resolved by entries in
9375 libc.  These entry points should be supplied through some other
9376 mechanism when this option is specified.
9377
9378 @item -nostdlib
9379 @opindex nostdlib
9380 Do not use the standard system startup files or libraries when linking.
9381 No startup files and only the libraries you specify will be passed to
9382 the linker, options specifying linkage of the system libraries, such as
9383 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
9384 The compiler may generate calls to @code{memcmp}, @code{memset},
9385 @code{memcpy} and @code{memmove}.
9386 These entries are usually resolved by entries in
9387 libc.  These entry points should be supplied through some other
9388 mechanism when this option is specified.
9389
9390 @cindex @option{-lgcc}, use with @option{-nostdlib}
9391 @cindex @option{-nostdlib} and unresolved references
9392 @cindex unresolved references and @option{-nostdlib}
9393 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9394 @cindex @option{-nodefaultlibs} and unresolved references
9395 @cindex unresolved references and @option{-nodefaultlibs}
9396 One of the standard libraries bypassed by @option{-nostdlib} and
9397 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9398 that GCC uses to overcome shortcomings of particular machines, or special
9399 needs for some languages.
9400 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9401 Collection (GCC) Internals},
9402 for more discussion of @file{libgcc.a}.)
9403 In most cases, you need @file{libgcc.a} even when you want to avoid
9404 other standard libraries.  In other words, when you specify @option{-nostdlib}
9405 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9406 This ensures that you have no unresolved references to internal GCC
9407 library subroutines.  (For example, @samp{__main}, used to ensure C++
9408 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
9409 GNU Compiler Collection (GCC) Internals}.)
9410
9411 @item -pie
9412 @opindex pie
9413 Produce a position independent executable on targets which support it.
9414 For predictable results, you must also specify the same set of options
9415 that were used to generate code (@option{-fpie}, @option{-fPIE},
9416 or model suboptions) when you specify this option.
9417
9418 @item -rdynamic
9419 @opindex rdynamic
9420 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9421 that support it. This instructs the linker to add all symbols, not
9422 only used ones, to the dynamic symbol table. This option is needed
9423 for some uses of @code{dlopen} or to allow obtaining backtraces
9424 from within a program.
9425
9426 @item -s
9427 @opindex s
9428 Remove all symbol table and relocation information from the executable.
9429
9430 @item -static
9431 @opindex static
9432 On systems that support dynamic linking, this prevents linking with the shared
9433 libraries.  On other systems, this option has no effect.
9434
9435 @item -shared
9436 @opindex shared
9437 Produce a shared object which can then be linked with other objects to
9438 form an executable.  Not all systems support this option.  For predictable
9439 results, you must also specify the same set of options that were used to
9440 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
9441 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
9442 needs to build supplementary stub code for constructors to work.  On
9443 multi-libbed systems, @samp{gcc -shared} must select the correct support
9444 libraries to link against.  Failing to supply the correct flags may lead
9445 to subtle defects.  Supplying them in cases where they are not necessary
9446 is innocuous.}
9447
9448 @item -shared-libgcc
9449 @itemx -static-libgcc
9450 @opindex shared-libgcc
9451 @opindex static-libgcc
9452 On systems that provide @file{libgcc} as a shared library, these options
9453 force the use of either the shared or static version respectively.
9454 If no shared version of @file{libgcc} was built when the compiler was
9455 configured, these options have no effect.
9456
9457 There are several situations in which an application should use the
9458 shared @file{libgcc} instead of the static version.  The most common
9459 of these is when the application wishes to throw and catch exceptions
9460 across different shared libraries.  In that case, each of the libraries
9461 as well as the application itself should use the shared @file{libgcc}.
9462
9463 Therefore, the G++ and GCJ drivers automatically add
9464 @option{-shared-libgcc} whenever you build a shared library or a main
9465 executable, because C++ and Java programs typically use exceptions, so
9466 this is the right thing to do.
9467
9468 If, instead, you use the GCC driver to create shared libraries, you may
9469 find that they will not always be linked with the shared @file{libgcc}.
9470 If GCC finds, at its configuration time, that you have a non-GNU linker
9471 or a GNU linker that does not support option @option{--eh-frame-hdr},
9472 it will link the shared version of @file{libgcc} into shared libraries
9473 by default.  Otherwise, it will take advantage of the linker and optimize
9474 away the linking with the shared version of @file{libgcc}, linking with
9475 the static version of libgcc by default.  This allows exceptions to
9476 propagate through such shared libraries, without incurring relocation
9477 costs at library load time.
9478
9479 However, if a library or main executable is supposed to throw or catch
9480 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9481 for the languages used in the program, or using the option
9482 @option{-shared-libgcc}, such that it is linked with the shared
9483 @file{libgcc}.
9484
9485 @item -static-libstdc++
9486 When the @command{g++} program is used to link a C++ program, it will
9487 normally automatically link against @option{libstdc++}.  If
9488 @file{libstdc++} is available as a shared library, and the
9489 @option{-static} option is not used, then this will link against the
9490 shared version of @file{libstdc++}.  That is normally fine.  However, it
9491 is sometimes useful to freeze the version of @file{libstdc++} used by
9492 the program without going all the way to a fully static link.  The
9493 @option{-static-libstdc++} option directs the @command{g++} driver to
9494 link @file{libstdc++} statically, without necessarily linking other
9495 libraries statically.
9496
9497 @item -symbolic
9498 @opindex symbolic
9499 Bind references to global symbols when building a shared object.  Warn
9500 about any unresolved references (unless overridden by the link editor
9501 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
9502 this option.
9503
9504 @item -T @var{script}
9505 @opindex T
9506 @cindex linker script
9507 Use @var{script} as the linker script.  This option is supported by most
9508 systems using the GNU linker.  On some targets, such as bare-board
9509 targets without an operating system, the @option{-T} option may be required
9510 when linking to avoid references to undefined symbols.
9511
9512 @item -Xlinker @var{option}
9513 @opindex Xlinker
9514 Pass @var{option} as an option to the linker.  You can use this to
9515 supply system-specific linker options which GCC does not know how to
9516 recognize.
9517
9518 If you want to pass an option that takes a separate argument, you must use
9519 @option{-Xlinker} twice, once for the option and once for the argument.
9520 For example, to pass @option{-assert definitions}, you must write
9521 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9522 @option{-Xlinker "-assert definitions"}, because this passes the entire
9523 string as a single argument, which is not what the linker expects.
9524
9525 When using the GNU linker, it is usually more convenient to pass
9526 arguments to linker options using the @option{@var{option}=@var{value}}
9527 syntax than as separate arguments.  For example, you can specify
9528 @samp{-Xlinker -Map=output.map} rather than
9529 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9530 this syntax for command-line options.
9531
9532 @item -Wl,@var{option}
9533 @opindex Wl
9534 Pass @var{option} as an option to the linker.  If @var{option} contains
9535 commas, it is split into multiple options at the commas.  You can use this
9536 syntax to pass an argument to the option.
9537 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
9538 linker.  When using the GNU linker, you can also get the same effect with
9539 @samp{-Wl,-Map=output.map}.
9540
9541 @item -u @var{symbol}
9542 @opindex u
9543 Pretend the symbol @var{symbol} is undefined, to force linking of
9544 library modules to define it.  You can use @option{-u} multiple times with
9545 different symbols to force loading of additional library modules.
9546 @end table
9547
9548 @node Directory Options
9549 @section Options for Directory Search
9550 @cindex directory options
9551 @cindex options, directory search
9552 @cindex search path
9553
9554 These options specify directories to search for header files, for
9555 libraries and for parts of the compiler:
9556
9557 @table @gcctabopt
9558 @item -I@var{dir}
9559 @opindex I
9560 Add the directory @var{dir} to the head of the list of directories to be
9561 searched for header files.  This can be used to override a system header
9562 file, substituting your own version, since these directories are
9563 searched before the system header file directories.  However, you should
9564 not use this option to add directories that contain vendor-supplied
9565 system header files (use @option{-isystem} for that).  If you use more than
9566 one @option{-I} option, the directories are scanned in left-to-right
9567 order; the standard system directories come after.
9568
9569 If a standard system include directory, or a directory specified with
9570 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9571 option will be ignored.  The directory will still be searched but as a
9572 system directory at its normal position in the system include chain.
9573 This is to ensure that GCC's procedure to fix buggy system headers and
9574 the ordering for the include_next directive are not inadvertently changed.
9575 If you really need to change the search order for system directories,
9576 use the @option{-nostdinc} and/or @option{-isystem} options.
9577
9578 @item -iplugindir=@var{dir}
9579 Set the directory to search for plugins which are passed
9580 by @option{-fplugin=@var{name}} instead of
9581 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
9582 to be used by the user, but only passed by the driver.
9583
9584 @item -iquote@var{dir}
9585 @opindex iquote
9586 Add the directory @var{dir} to the head of the list of directories to
9587 be searched for header files only for the case of @samp{#include
9588 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9589 otherwise just like @option{-I}.
9590
9591 @item -L@var{dir}
9592 @opindex L
9593 Add directory @var{dir} to the list of directories to be searched
9594 for @option{-l}.
9595
9596 @item -B@var{prefix}
9597 @opindex B
9598 This option specifies where to find the executables, libraries,
9599 include files, and data files of the compiler itself.
9600
9601 The compiler driver program runs one or more of the subprograms
9602 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
9603 @var{prefix} as a prefix for each program it tries to run, both with and
9604 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9605
9606 For each subprogram to be run, the compiler driver first tries the
9607 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9608 was not specified, the driver tries two standard prefixes, which are
9609 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9610 those results in a file name that is found, the unmodified program
9611 name is searched for using the directories specified in your
9612 @env{PATH} environment variable.
9613
9614 The compiler will check to see if the path provided by the @option{-B}
9615 refers to a directory, and if necessary it will add a directory
9616 separator character at the end of the path.
9617
9618 @option{-B} prefixes that effectively specify directory names also apply
9619 to libraries in the linker, because the compiler translates these
9620 options into @option{-L} options for the linker.  They also apply to
9621 includes files in the preprocessor, because the compiler translates these
9622 options into @option{-isystem} options for the preprocessor.  In this case,
9623 the compiler appends @samp{include} to the prefix.
9624
9625 The run-time support file @file{libgcc.a} can also be searched for using
9626 the @option{-B} prefix, if needed.  If it is not found there, the two
9627 standard prefixes above are tried, and that is all.  The file is left
9628 out of the link if it is not found by those means.
9629
9630 Another way to specify a prefix much like the @option{-B} prefix is to use
9631 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9632 Variables}.
9633
9634 As a special kludge, if the path provided by @option{-B} is
9635 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9636 9, then it will be replaced by @file{[dir/]include}.  This is to help
9637 with boot-strapping the compiler.
9638
9639 @item -specs=@var{file}
9640 @opindex specs
9641 Process @var{file} after the compiler reads in the standard @file{specs}
9642 file, in order to override the defaults that the @file{gcc} driver
9643 program uses when determining what switches to pass to @file{cc1},
9644 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
9645 @option{-specs=@var{file}} can be specified on the command line, and they
9646 are processed in order, from left to right.
9647
9648 @item --sysroot=@var{dir}
9649 @opindex sysroot
9650 Use @var{dir} as the logical root directory for headers and libraries.
9651 For example, if the compiler would normally search for headers in
9652 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
9653 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9654
9655 If you use both this option and the @option{-isysroot} option, then
9656 the @option{--sysroot} option will apply to libraries, but the
9657 @option{-isysroot} option will apply to header files.
9658
9659 The GNU linker (beginning with version 2.16) has the necessary support
9660 for this option.  If your linker does not support this option, the
9661 header file aspect of @option{--sysroot} will still work, but the
9662 library aspect will not.
9663
9664 @item -I-
9665 @opindex I-
9666 This option has been deprecated.  Please use @option{-iquote} instead for
9667 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9668 Any directories you specify with @option{-I} options before the @option{-I-}
9669 option are searched only for the case of @samp{#include "@var{file}"};
9670 they are not searched for @samp{#include <@var{file}>}.
9671
9672 If additional directories are specified with @option{-I} options after
9673 the @option{-I-}, these directories are searched for all @samp{#include}
9674 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9675 this way.)
9676
9677 In addition, the @option{-I-} option inhibits the use of the current
9678 directory (where the current input file came from) as the first search
9679 directory for @samp{#include "@var{file}"}.  There is no way to
9680 override this effect of @option{-I-}.  With @option{-I.} you can specify
9681 searching the directory which was current when the compiler was
9682 invoked.  That is not exactly the same as what the preprocessor does
9683 by default, but it is often satisfactory.
9684
9685 @option{-I-} does not inhibit the use of the standard system directories
9686 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9687 independent.
9688 @end table
9689
9690 @c man end
9691
9692 @node Spec Files
9693 @section Specifying subprocesses and the switches to pass to them
9694 @cindex Spec Files
9695
9696 @command{gcc} is a driver program.  It performs its job by invoking a
9697 sequence of other programs to do the work of compiling, assembling and
9698 linking.  GCC interprets its command-line parameters and uses these to
9699 deduce which programs it should invoke, and which command-line options
9700 it ought to place on their command lines.  This behavior is controlled
9701 by @dfn{spec strings}.  In most cases there is one spec string for each
9702 program that GCC can invoke, but a few programs have multiple spec
9703 strings to control their behavior.  The spec strings built into GCC can
9704 be overridden by using the @option{-specs=} command-line switch to specify
9705 a spec file.
9706
9707 @dfn{Spec files} are plaintext files that are used to construct spec
9708 strings.  They consist of a sequence of directives separated by blank
9709 lines.  The type of directive is determined by the first non-whitespace
9710 character on the line and it can be one of the following:
9711
9712 @table @code
9713 @item %@var{command}
9714 Issues a @var{command} to the spec file processor.  The commands that can
9715 appear here are:
9716
9717 @table @code
9718 @item %include <@var{file}>
9719 @cindex @code{%include}
9720 Search for @var{file} and insert its text at the current point in the
9721 specs file.
9722
9723 @item %include_noerr <@var{file}>
9724 @cindex @code{%include_noerr}
9725 Just like @samp{%include}, but do not generate an error message if the include
9726 file cannot be found.
9727
9728 @item %rename @var{old_name} @var{new_name}
9729 @cindex @code{%rename}
9730 Rename the spec string @var{old_name} to @var{new_name}.
9731
9732 @end table
9733
9734 @item *[@var{spec_name}]:
9735 This tells the compiler to create, override or delete the named spec
9736 string.  All lines after this directive up to the next directive or
9737 blank line are considered to be the text for the spec string.  If this
9738 results in an empty string then the spec will be deleted.  (Or, if the
9739 spec did not exist, then nothing will happen.)  Otherwise, if the spec
9740 does not currently exist a new spec will be created.  If the spec does
9741 exist then its contents will be overridden by the text of this
9742 directive, unless the first character of that text is the @samp{+}
9743 character, in which case the text will be appended to the spec.
9744
9745 @item [@var{suffix}]:
9746 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9747 and up to the next directive or blank line are considered to make up the
9748 spec string for the indicated suffix.  When the compiler encounters an
9749 input file with the named suffix, it will processes the spec string in
9750 order to work out how to compile that file.  For example:
9751
9752 @smallexample
9753 .ZZ:
9754 z-compile -input %i
9755 @end smallexample
9756
9757 This says that any input file whose name ends in @samp{.ZZ} should be
9758 passed to the program @samp{z-compile}, which should be invoked with the
9759 command-line switch @option{-input} and with the result of performing the
9760 @samp{%i} substitution.  (See below.)
9761
9762 As an alternative to providing a spec string, the text that follows a
9763 suffix directive can be one of the following:
9764
9765 @table @code
9766 @item @@@var{language}
9767 This says that the suffix is an alias for a known @var{language}.  This is
9768 similar to using the @option{-x} command-line switch to GCC to specify a
9769 language explicitly.  For example:
9770
9771 @smallexample
9772 .ZZ:
9773 @@c++
9774 @end smallexample
9775
9776 Says that .ZZ files are, in fact, C++ source files.
9777
9778 @item #@var{name}
9779 This causes an error messages saying:
9780
9781 @smallexample
9782 @var{name} compiler not installed on this system.
9783 @end smallexample
9784 @end table
9785
9786 GCC already has an extensive list of suffixes built into it.
9787 This directive will add an entry to the end of the list of suffixes, but
9788 since the list is searched from the end backwards, it is effectively
9789 possible to override earlier entries using this technique.
9790
9791 @end table
9792
9793 GCC has the following spec strings built into it.  Spec files can
9794 override these strings or create their own.  Note that individual
9795 targets can also add their own spec strings to this list.
9796
9797 @smallexample
9798 asm          Options to pass to the assembler
9799 asm_final    Options to pass to the assembler post-processor
9800 cpp          Options to pass to the C preprocessor
9801 cc1          Options to pass to the C compiler
9802 cc1plus      Options to pass to the C++ compiler
9803 endfile      Object files to include at the end of the link
9804 link         Options to pass to the linker
9805 lib          Libraries to include on the command line to the linker
9806 libgcc       Decides which GCC support library to pass to the linker
9807 linker       Sets the name of the linker
9808 predefines   Defines to be passed to the C preprocessor
9809 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9810              by default
9811 startfile    Object files to include at the start of the link
9812 @end smallexample
9813
9814 Here is a small example of a spec file:
9815
9816 @smallexample
9817 %rename lib                 old_lib
9818
9819 *lib:
9820 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9821 @end smallexample
9822
9823 This example renames the spec called @samp{lib} to @samp{old_lib} and
9824 then overrides the previous definition of @samp{lib} with a new one.
9825 The new definition adds in some extra command-line options before
9826 including the text of the old definition.
9827
9828 @dfn{Spec strings} are a list of command-line options to be passed to their
9829 corresponding program.  In addition, the spec strings can contain
9830 @samp{%}-prefixed sequences to substitute variable text or to
9831 conditionally insert text into the command line.  Using these constructs
9832 it is possible to generate quite complex command lines.
9833
9834 Here is a table of all defined @samp{%}-sequences for spec
9835 strings.  Note that spaces are not generated automatically around the
9836 results of expanding these sequences.  Therefore you can concatenate them
9837 together or combine them with constant text in a single argument.
9838
9839 @table @code
9840 @item %%
9841 Substitute one @samp{%} into the program name or argument.
9842
9843 @item %i
9844 Substitute the name of the input file being processed.
9845
9846 @item %b
9847 Substitute the basename of the input file being processed.
9848 This is the substring up to (and not including) the last period
9849 and not including the directory.
9850
9851 @item %B
9852 This is the same as @samp{%b}, but include the file suffix (text after
9853 the last period).
9854
9855 @item %d
9856 Marks the argument containing or following the @samp{%d} as a
9857 temporary file name, so that that file will be deleted if GCC exits
9858 successfully.  Unlike @samp{%g}, this contributes no text to the
9859 argument.
9860
9861 @item %g@var{suffix}
9862 Substitute a file name that has suffix @var{suffix} and is chosen
9863 once per compilation, and mark the argument in the same way as
9864 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9865 name is now chosen in a way that is hard to predict even when previously
9866 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9867 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9868 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9869 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9870 was simply substituted with a file name chosen once per compilation,
9871 without regard to any appended suffix (which was therefore treated
9872 just like ordinary text), making such attacks more likely to succeed.
9873
9874 @item %u@var{suffix}
9875 Like @samp{%g}, but generates a new temporary file name even if
9876 @samp{%u@var{suffix}} was already seen.
9877
9878 @item %U@var{suffix}
9879 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9880 new one if there is no such last file name.  In the absence of any
9881 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9882 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9883 would involve the generation of two distinct file names, one
9884 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9885 simply substituted with a file name chosen for the previous @samp{%u},
9886 without regard to any appended suffix.
9887
9888 @item %j@var{suffix}
9889 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9890 writable, and if save-temps is off; otherwise, substitute the name
9891 of a temporary file, just like @samp{%u}.  This temporary file is not
9892 meant for communication between processes, but rather as a junk
9893 disposal mechanism.
9894
9895 @item %|@var{suffix}
9896 @itemx %m@var{suffix}
9897 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9898 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9899 all.  These are the two most common ways to instruct a program that it
9900 should read from standard input or write to standard output.  If you
9901 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9902 construct: see for example @file{f/lang-specs.h}.
9903
9904 @item %.@var{SUFFIX}
9905 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9906 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9907 terminated by the next space or %.
9908
9909 @item %w
9910 Marks the argument containing or following the @samp{%w} as the
9911 designated output file of this compilation.  This puts the argument
9912 into the sequence of arguments that @samp{%o} will substitute later.
9913
9914 @item %o
9915 Substitutes the names of all the output files, with spaces
9916 automatically placed around them.  You should write spaces
9917 around the @samp{%o} as well or the results are undefined.
9918 @samp{%o} is for use in the specs for running the linker.
9919 Input files whose names have no recognized suffix are not compiled
9920 at all, but they are included among the output files, so they will
9921 be linked.
9922
9923 @item %O
9924 Substitutes the suffix for object files.  Note that this is
9925 handled specially when it immediately follows @samp{%g, %u, or %U},
9926 because of the need for those to form complete file names.  The
9927 handling is such that @samp{%O} is treated exactly as if it had already
9928 been substituted, except that @samp{%g, %u, and %U} do not currently
9929 support additional @var{suffix} characters following @samp{%O} as they would
9930 following, for example, @samp{.o}.
9931
9932 @item %p
9933 Substitutes the standard macro predefinitions for the
9934 current target machine.  Use this when running @code{cpp}.
9935
9936 @item %P
9937 Like @samp{%p}, but puts @samp{__} before and after the name of each
9938 predefined macro, except for macros that start with @samp{__} or with
9939 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9940 C@.
9941
9942 @item %I
9943 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9944 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9945 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9946 and @option{-imultilib} as necessary.
9947
9948 @item %s
9949 Current argument is the name of a library or startup file of some sort.
9950 Search for that file in a standard list of directories and substitute
9951 the full name found.  The current working directory is included in the
9952 list of directories scanned.
9953
9954 @item %T
9955 Current argument is the name of a linker script.  Search for that file
9956 in the current list of directories to scan for libraries. If the file
9957 is located insert a @option{--script} option into the command line
9958 followed by the full path name found.  If the file is not found then
9959 generate an error message.  Note: the current working directory is not
9960 searched.
9961
9962 @item %e@var{str}
9963 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9964 Use this when inconsistent options are detected.
9965
9966 @item %(@var{name})
9967 Substitute the contents of spec string @var{name} at this point.
9968
9969 @item %x@{@var{option}@}
9970 Accumulate an option for @samp{%X}.
9971
9972 @item %X
9973 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9974 spec string.
9975
9976 @item %Y
9977 Output the accumulated assembler options specified by @option{-Wa}.
9978
9979 @item %Z
9980 Output the accumulated preprocessor options specified by @option{-Wp}.
9981
9982 @item %a
9983 Process the @code{asm} spec.  This is used to compute the
9984 switches to be passed to the assembler.
9985
9986 @item %A
9987 Process the @code{asm_final} spec.  This is a spec string for
9988 passing switches to an assembler post-processor, if such a program is
9989 needed.
9990
9991 @item %l
9992 Process the @code{link} spec.  This is the spec for computing the
9993 command line passed to the linker.  Typically it will make use of the
9994 @samp{%L %G %S %D and %E} sequences.
9995
9996 @item %D
9997 Dump out a @option{-L} option for each directory that GCC believes might
9998 contain startup files.  If the target supports multilibs then the
9999 current multilib directory will be prepended to each of these paths.
10000
10001 @item %L
10002 Process the @code{lib} spec.  This is a spec string for deciding which
10003 libraries should be included on the command line to the linker.
10004
10005 @item %G
10006 Process the @code{libgcc} spec.  This is a spec string for deciding
10007 which GCC support library should be included on the command line to the linker.
10008
10009 @item %S
10010 Process the @code{startfile} spec.  This is a spec for deciding which
10011 object files should be the first ones passed to the linker.  Typically
10012 this might be a file named @file{crt0.o}.
10013
10014 @item %E
10015 Process the @code{endfile} spec.  This is a spec string that specifies
10016 the last object files that will be passed to the linker.
10017
10018 @item %C
10019 Process the @code{cpp} spec.  This is used to construct the arguments
10020 to be passed to the C preprocessor.
10021
10022 @item %1
10023 Process the @code{cc1} spec.  This is used to construct the options to be
10024 passed to the actual C compiler (@samp{cc1}).
10025
10026 @item %2
10027 Process the @code{cc1plus} spec.  This is used to construct the options to be
10028 passed to the actual C++ compiler (@samp{cc1plus}).
10029
10030 @item %*
10031 Substitute the variable part of a matched option.  See below.
10032 Note that each comma in the substituted string is replaced by
10033 a single space.
10034
10035 @item %<@code{S}
10036 Remove all occurrences of @code{-S} from the command line.  Note---this
10037 command is position dependent.  @samp{%} commands in the spec string
10038 before this one will see @code{-S}, @samp{%} commands in the spec string
10039 after this one will not.
10040
10041 @item %:@var{function}(@var{args})
10042 Call the named function @var{function}, passing it @var{args}.
10043 @var{args} is first processed as a nested spec string, then split
10044 into an argument vector in the usual fashion.  The function returns
10045 a string which is processed as if it had appeared literally as part
10046 of the current spec.
10047
10048 The following built-in spec functions are provided:
10049
10050 @table @code
10051 @item @code{getenv}
10052 The @code{getenv} spec function takes two arguments: an environment
10053 variable name and a string.  If the environment variable is not
10054 defined, a fatal error is issued.  Otherwise, the return value is the
10055 value of the environment variable concatenated with the string.  For
10056 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10057
10058 @smallexample
10059 %:getenv(TOPDIR /include)
10060 @end smallexample
10061
10062 expands to @file{/path/to/top/include}.
10063
10064 @item @code{if-exists}
10065 The @code{if-exists} spec function takes one argument, an absolute
10066 pathname to a file.  If the file exists, @code{if-exists} returns the
10067 pathname.  Here is a small example of its usage:
10068
10069 @smallexample
10070 *startfile:
10071 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10072 @end smallexample
10073
10074 @item @code{if-exists-else}
10075 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10076 spec function, except that it takes two arguments.  The first argument is
10077 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10078 returns the pathname.  If it does not exist, it returns the second argument.
10079 This way, @code{if-exists-else} can be used to select one file or another,
10080 based on the existence of the first.  Here is a small example of its usage:
10081
10082 @smallexample
10083 *startfile:
10084 crt0%O%s %:if-exists(crti%O%s) \
10085 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10086 @end smallexample
10087
10088 @item @code{replace-outfile}
10089 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10090 first argument in the outfiles array and replaces it with the second argument.  Here
10091 is a small example of its usage:
10092
10093 @smallexample
10094 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10095 @end smallexample
10096
10097 @item @code{remove-outfile}
10098 The @code{remove-outfile} spec function takes one argument.  It looks for the
10099 first argument in the outfiles array and removes it.  Here is a small example
10100 its usage:
10101
10102 @smallexample
10103 %:remove-outfile(-lm)
10104 @end smallexample
10105
10106 @item @code{pass-through-libs}
10107 The @code{pass-through-libs} spec function takes any number of arguments.  It
10108 finds any @option{-l} options and any non-options ending in ".a" (which it
10109 assumes are the names of linker input library archive files) and returns a
10110 result containing all the found arguments each prepended by
10111 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10112 intended to be passed to the LTO linker plugin.
10113
10114 @smallexample
10115 %:pass-through-libs(%G %L %G)
10116 @end smallexample
10117
10118 @item @code{print-asm-header}
10119 The @code{print-asm-header} function takes no arguments and simply
10120 prints a banner like:
10121
10122 @smallexample
10123 Assembler options
10124 =================
10125
10126 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10127 @end smallexample
10128
10129 It is used to separate compiler options from assembler options
10130 in the @option{--target-help} output.
10131 @end table
10132
10133 @item %@{@code{S}@}
10134 Substitutes the @code{-S} switch, if that switch was given to GCC@.
10135 If that switch was not specified, this substitutes nothing.  Note that
10136 the leading dash is omitted when specifying this option, and it is
10137 automatically inserted if the substitution is performed.  Thus the spec
10138 string @samp{%@{foo@}} would match the command-line option @option{-foo}
10139 and would output the command line option @option{-foo}.
10140
10141 @item %W@{@code{S}@}
10142 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10143 deleted on failure.
10144
10145 @item %@{@code{S}*@}
10146 Substitutes all the switches specified to GCC whose names start
10147 with @code{-S}, but which also take an argument.  This is used for
10148 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10149 GCC considers @option{-o foo} as being
10150 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
10151 text, including the space.  Thus two arguments would be generated.
10152
10153 @item %@{@code{S}*&@code{T}*@}
10154 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10155 (the order of @code{S} and @code{T} in the spec is not significant).
10156 There can be any number of ampersand-separated variables; for each the
10157 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10158
10159 @item %@{@code{S}:@code{X}@}
10160 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
10161
10162 @item %@{!@code{S}:@code{X}@}
10163 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
10164
10165 @item %@{@code{S}*:@code{X}@}
10166 Substitutes @code{X} if one or more switches whose names start with
10167 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10168 once, no matter how many such switches appeared.  However, if @code{%*}
10169 appears somewhere in @code{X}, then @code{X} will be substituted once
10170 for each matching switch, with the @code{%*} replaced by the part of
10171 that switch that matched the @code{*}.
10172
10173 @item %@{.@code{S}:@code{X}@}
10174 Substitutes @code{X}, if processing a file with suffix @code{S}.
10175
10176 @item %@{!.@code{S}:@code{X}@}
10177 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10178
10179 @item %@{,@code{S}:@code{X}@}
10180 Substitutes @code{X}, if processing a file for language @code{S}.
10181
10182 @item %@{!,@code{S}:@code{X}@}
10183 Substitutes @code{X}, if not processing a file for language @code{S}.
10184
10185 @item %@{@code{S}|@code{P}:@code{X}@}
10186 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
10187 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10188 @code{*} sequences as well, although they have a stronger binding than
10189 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10190 alternatives must be starred, and only the first matching alternative
10191 is substituted.
10192
10193 For example, a spec string like this:
10194
10195 @smallexample
10196 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10197 @end smallexample
10198
10199 will output the following command-line options from the following input
10200 command-line options:
10201
10202 @smallexample
10203 fred.c        -foo -baz
10204 jim.d         -bar -boggle
10205 -d fred.c     -foo -baz -boggle
10206 -d jim.d      -bar -baz -boggle
10207 @end smallexample
10208
10209 @item %@{S:X; T:Y; :D@}
10210
10211 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
10212 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10213 be as many clauses as you need.  This may be combined with @code{.},
10214 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10215
10216
10217 @end table
10218
10219 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10220 construct may contain other nested @samp{%} constructs or spaces, or
10221 even newlines.  They are processed as usual, as described above.
10222 Trailing white space in @code{X} is ignored.  White space may also
10223 appear anywhere on the left side of the colon in these constructs,
10224 except between @code{.} or @code{*} and the corresponding word.
10225
10226 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10227 handled specifically in these constructs.  If another value of
10228 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10229 @option{-W} switch is found later in the command line, the earlier
10230 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10231 just one letter, which passes all matching options.
10232
10233 The character @samp{|} at the beginning of the predicate text is used to
10234 indicate that a command should be piped to the following command, but
10235 only if @option{-pipe} is specified.
10236
10237 It is built into GCC which switches take arguments and which do not.
10238 (You might think it would be useful to generalize this to allow each
10239 compiler's spec to say which switches take arguments.  But this cannot
10240 be done in a consistent fashion.  GCC cannot even decide which input
10241 files have been specified without knowing which switches take arguments,
10242 and it must know which input files to compile in order to tell which
10243 compilers to run).
10244
10245 GCC also knows implicitly that arguments starting in @option{-l} are to be
10246 treated as compiler output files, and passed to the linker in their
10247 proper position among the other output files.
10248
10249 @c man begin OPTIONS
10250
10251 @node Target Options
10252 @section Specifying Target Machine and Compiler Version
10253 @cindex target options
10254 @cindex cross compiling
10255 @cindex specifying machine version
10256 @cindex specifying compiler version and target machine
10257 @cindex compiler version, specifying
10258 @cindex target machine, specifying
10259
10260 The usual way to run GCC is to run the executable called @command{gcc}, or
10261 @command{@var{machine}-gcc} when cross-compiling, or
10262 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10263 one that was installed last.
10264
10265 @node Submodel Options
10266 @section Hardware Models and Configurations
10267 @cindex submodel options
10268 @cindex specifying hardware config
10269 @cindex hardware models and configurations, specifying
10270 @cindex machine dependent options
10271
10272 Each target machine types can have its own
10273 special options, starting with @samp{-m}, to choose among various
10274 hardware models or configurations---for example, 68010 vs 68020,
10275 floating coprocessor or none.  A single installed version of the
10276 compiler can compile for any model or configuration, according to the
10277 options specified.
10278
10279 Some configurations of the compiler also support additional special
10280 options, usually for compatibility with other compilers on the same
10281 platform.
10282
10283 @c This list is ordered alphanumerically by subsection name.
10284 @c It should be the same order and spelling as these options are listed
10285 @c in Machine Dependent Options
10286
10287 @menu
10288 * Adapteva Epiphany Options::
10289 * ARM Options::
10290 * AVR Options::
10291 * Blackfin Options::
10292 * C6X Options::
10293 * CRIS Options::
10294 * Darwin Options::
10295 * DEC Alpha Options::
10296 * DEC Alpha/VMS Options::
10297 * FR30 Options::
10298 * FRV Options::
10299 * GNU/Linux Options::
10300 * H8/300 Options::
10301 * HPPA Options::
10302 * i386 and x86-64 Options::
10303 * i386 and x86-64 Windows Options::
10304 * IA-64 Options::
10305 * IA-64/VMS Options::
10306 * LM32 Options::
10307 * M32C Options::
10308 * M32R/D Options::
10309 * M680x0 Options::
10310 * MCore Options::
10311 * MeP Options::
10312 * MicroBlaze Options::
10313 * MIPS Options::
10314 * MMIX Options::
10315 * MN10300 Options::
10316 * PDP-11 Options::
10317 * picoChip Options::
10318 * PowerPC Options::
10319 * RL78 Options::
10320 * RS/6000 and PowerPC Options::
10321 * RX Options::
10322 * S/390 and zSeries Options::
10323 * Score Options::
10324 * SH Options::
10325 * Solaris 2 Options::
10326 * SPARC Options::
10327 * SPU Options::
10328 * System V Options::
10329 * V850 Options::
10330 * VAX Options::
10331 * VxWorks Options::
10332 * x86-64 Options::
10333 * Xstormy16 Options::
10334 * Xtensa Options::
10335 * zSeries Options::
10336 @end menu
10337
10338 @node Adapteva Epiphany Options
10339 @subsection Adapteva Epiphany Options
10340
10341 These @samp{-m} options are defined for Adapteva Epiphany:
10342
10343 @table @gcctabopt
10344 @item -mhalf-reg-file
10345 @opindex mhalf-reg-file
10346 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
10347 That allows code to run on hardware variants that lack these registers.
10348
10349 @item -mprefer-short-insn-regs
10350 @opindex mprefer-short-insn-regs
10351 Preferrentially allocate registers that allow short instruction generation.
10352 This can result in increasesd instruction count, so if this reduces or
10353 increases code size might vary from case to case.
10354
10355 @item -mbranch-cost=@var{num}
10356 @opindex mbranch-cost
10357 Set the cost of branches to roughly @var{num} ``simple'' instructions.
10358 This cost is only a heuristic and is not guaranteed to produce
10359 consistent results across releases.
10360
10361 @item -mcmove
10362 @opindex mcmove
10363 Enable the generation of conditional moves.
10364
10365 @item -mnops=@var{num}
10366 @opindex mnops
10367 Emit @var{num} nops before every other generated instruction.
10368
10369 @item -mno-soft-cmpsf
10370 @opindex mno-soft-cmpsf
10371 For single-precision floating point comparisons, emit an fsub instruction
10372 and test the flags.  This is faster than a software comparison, but can
10373 get incorrect results in the presence of NaNs, or when two different small
10374 numbers are compared such that their difference is calculated as zero.
10375 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
10376 software comparisons.
10377
10378 @item -mstack-offset=@var{num}
10379 @opindex mstack-offset
10380 Set the offset between the top of the stack and the stack pointer.
10381 E.g., a value of 8 means that the eight bytes in the range sp+0@dots{}sp+7
10382 can be used by leaf functions without stack allocation.
10383 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
10384 Note also that this option changes the ABI, compiling a program with a
10385 different stack offset than the libraries have been compiled with
10386 will generally not work.
10387 This option can be useful if you want to evaluate if a different stack
10388 offset would give you better code, but to actually use a different stack
10389 offset to build working programs, it is recommended to configure the
10390 toolchain with the appropriate @samp{--with-stack-offset=@var{num}} option.
10391
10392 @item -mno-round-nearest
10393 @opindex mno-round-nearest
10394 Make the scheduler assume that the rounding mode has been set to
10395 truncating.  The default is @option{-mround-nearest}.
10396
10397 @item -mlong-calls
10398 @opindex mlong-calls
10399 If not otherwise specified by an attribute, assume all calls might be beyond
10400 the offset range of the b / bl instructions, and therefore load the
10401 function address into a register before performing a (otherwise direct) call.
10402 This is the default.
10403
10404 @item -mshort-calls
10405 @opindex short-calls
10406 If not otherwise specified by an attribute, assume all direct calls are
10407 in the range of the b / bl instructions, so use these instructions
10408 for direct calls.  The default is @option{-mlong-calls}.
10409
10410 @item -msmall16
10411 @opindex msmall16
10412 Assume addresses can be loaded as 16 bit unsigned values.  This does not
10413 apply to function addresses for which @option{-mlong-calls} semantics
10414 are in effect.
10415
10416 @item -mfp-mode=@var{mode}
10417 @opindex mfp-mode
10418 Set the prevailing mode of the floating point unit.
10419 This determines the floating point mode that is provided and expected
10420 at function call and return time.  Making this mode match the mode you
10421 predominantly need at function start can make your programs smaller and
10422 faster by avoiding unnecessary mode switches.
10423
10424 @var{mode} can be set to one the following values:
10425
10426 @table @samp
10427 @item caller
10428 Any mode at function entry is valid, and retained or restored when
10429 the function returns, and when it calls other functions.
10430 This mode is useful for compiling libraries or other compilation units
10431 you might want to incorporate into different programs with different
10432 prevailing FPU modes, and the convenience of being able to use a single
10433 object file outweighs the size and speed overhead for any extra
10434 mode switching that might be needed, compared with what would be needed
10435 with a more specific choice of prevailing FPU mode.
10436
10437 @item truncate
10438 This is the mode used for floating point calculations with
10439 truncating (i.e.@: round towards zero) rounding mode.  That includes
10440 conversion from floating point to integer.
10441
10442 @item round-nearest
10443 This is the mode used for floating point calculations with
10444 round-to-nearest-or-even rounding mode.
10445
10446 @item int
10447 This is the mode used to perform integer calculations in the FPU, e.g.@:
10448 integer multiply, or integer multiply-and-accumulate.
10449 @end table
10450
10451 The default is @option{-mfp-mode=caller}
10452
10453 @item -mnosplit-lohi
10454 @opindex mnosplit-lohi
10455 @item -mno-postinc
10456 @opindex mno-postinc
10457 @item -mno-postmodify
10458 @opindex mno-postmodify
10459 Code generation tweaks that disable, respectively, splitting of 32
10460 bit loads, generation of post-increment addresses, and generation of
10461 post-modify addresses.  The defaults are @option{msplit-lohi},
10462 @option{-mpost-inc}, and @option{-mpost-modify}.
10463
10464 @item -mnovect-double
10465 @opindex mno-vect-double
10466 Change the preferred SIMD mode to SImode.  The default is
10467 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
10468
10469 @item -max-vect-align=@var{num}
10470 @opindex max-vect-align
10471 The maximum alignment for SIMD vector mode types.
10472 @var{num} may be 4 or 8.  The default is 8.
10473 Note that this is an ABI change, even though many library function
10474 interfaces will be unaffected, if they don't use SIMD vector modes
10475 in places where they affect size and/or alignment of relevant types.
10476
10477 @item -msplit-vecmove-early
10478 @opindex msplit-vecmove-early
10479 Split vector moves into single word moves before reload.  In theory this
10480 could give better register allocation, but so far the reverse seems to be
10481 generally the case.
10482
10483 @item -m1reg-@var{reg}
10484 @opindex m1reg-
10485 Specify a register to hold the constant @minus{}1, which makes loading small negative
10486 constants and certain bitmasks faster.
10487 Allowable values for reg are r43 and r63, which specify to use that register
10488 as a fixed register, and none, which means that no register is used for this
10489 purpose.  The default is @option{-m1reg-none}.
10490
10491 @end table
10492
10493 @node ARM Options
10494 @subsection ARM Options
10495 @cindex ARM options
10496
10497 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
10498 architectures:
10499
10500 @table @gcctabopt
10501 @item -mabi=@var{name}
10502 @opindex mabi
10503 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
10504 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
10505
10506 @item -mapcs-frame
10507 @opindex mapcs-frame
10508 Generate a stack frame that is compliant with the ARM Procedure Call
10509 Standard for all functions, even if this is not strictly necessary for
10510 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
10511 with this option will cause the stack frames not to be generated for
10512 leaf functions.  The default is @option{-mno-apcs-frame}.
10513
10514 @item -mapcs
10515 @opindex mapcs
10516 This is a synonym for @option{-mapcs-frame}.
10517
10518 @ignore
10519 @c not currently implemented
10520 @item -mapcs-stack-check
10521 @opindex mapcs-stack-check
10522 Generate code to check the amount of stack space available upon entry to
10523 every function (that actually uses some stack space).  If there is
10524 insufficient space available then either the function
10525 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
10526 called, depending upon the amount of stack space required.  The run time
10527 system is required to provide these functions.  The default is
10528 @option{-mno-apcs-stack-check}, since this produces smaller code.
10529
10530 @c not currently implemented
10531 @item -mapcs-float
10532 @opindex mapcs-float
10533 Pass floating point arguments using the float point registers.  This is
10534 one of the variants of the APCS@.  This option is recommended if the
10535 target hardware has a floating point unit or if a lot of floating point
10536 arithmetic is going to be performed by the code.  The default is
10537 @option{-mno-apcs-float}, since integer only code is slightly increased in
10538 size if @option{-mapcs-float} is used.
10539
10540 @c not currently implemented
10541 @item -mapcs-reentrant
10542 @opindex mapcs-reentrant
10543 Generate reentrant, position independent code.  The default is
10544 @option{-mno-apcs-reentrant}.
10545 @end ignore
10546
10547 @item -mthumb-interwork
10548 @opindex mthumb-interwork
10549 Generate code which supports calling between the ARM and Thumb
10550 instruction sets.  Without this option, on pre-v5 architectures, the
10551 two instruction sets cannot be reliably used inside one program.  The
10552 default is @option{-mno-thumb-interwork}, since slightly larger code
10553 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
10554 configurations this option is meaningless.
10555
10556 @item -mno-sched-prolog
10557 @opindex mno-sched-prolog
10558 Prevent the reordering of instructions in the function prolog, or the
10559 merging of those instruction with the instructions in the function's
10560 body.  This means that all functions will start with a recognizable set
10561 of instructions (or in fact one of a choice from a small set of
10562 different function prologues), and this information can be used to
10563 locate the start if functions inside an executable piece of code.  The
10564 default is @option{-msched-prolog}.
10565
10566 @item -mfloat-abi=@var{name}
10567 @opindex mfloat-abi
10568 Specifies which floating-point ABI to use.  Permissible values
10569 are: @samp{soft}, @samp{softfp} and @samp{hard}.
10570
10571 Specifying @samp{soft} causes GCC to generate output containing
10572 library calls for floating-point operations.
10573 @samp{softfp} allows the generation of code using hardware floating-point
10574 instructions, but still uses the soft-float calling conventions.
10575 @samp{hard} allows generation of floating-point instructions
10576 and uses FPU-specific calling conventions.
10577
10578 The default depends on the specific target configuration.  Note that
10579 the hard-float and soft-float ABIs are not link-compatible; you must
10580 compile your entire program with the same ABI, and link with a
10581 compatible set of libraries.
10582
10583 @item -mlittle-endian
10584 @opindex mlittle-endian
10585 Generate code for a processor running in little-endian mode.  This is
10586 the default for all standard configurations.
10587
10588 @item -mbig-endian
10589 @opindex mbig-endian
10590 Generate code for a processor running in big-endian mode; the default is
10591 to compile code for a little-endian processor.
10592
10593 @item -mwords-little-endian
10594 @opindex mwords-little-endian
10595 This option only applies when generating code for big-endian processors.
10596 Generate code for a little-endian word order but a big-endian byte
10597 order.  That is, a byte order of the form @samp{32107654}.  Note: this
10598 option should only be used if you require compatibility with code for
10599 big-endian ARM processors generated by versions of the compiler prior to
10600 2.8.  This option is now deprecated.
10601
10602 @item -mcpu=@var{name}
10603 @opindex mcpu
10604 This specifies the name of the target ARM processor.  GCC uses this name
10605 to determine what kind of instructions it can emit when generating
10606 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
10607 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10608 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10609 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10610 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10611 @samp{arm720},
10612 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10613 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10614 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10615 @samp{strongarm1110},
10616 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10617 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10618 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10619 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10620 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10621 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10622 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10623 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
10624 @samp{cortex-a15}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
10625 @samp{cortex-m4}, @samp{cortex-m3},
10626 @samp{cortex-m1},
10627 @samp{cortex-m0},
10628 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
10629 @samp{fa526}, @samp{fa626},
10630 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
10631
10632
10633 @option{-mcpu=generic-@var{arch}} is also permissible, and is
10634 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
10635 See @option{-mtune} for more information.
10636
10637 @option{-mcpu=native} causes the compiler to auto-detect the CPU
10638 of the build computer.  At present, this feature is only supported on
10639 Linux, and not all architectures are recognised.  If the auto-detect is
10640 unsuccessful the option has no effect.
10641
10642 @item -mtune=@var{name}
10643 @opindex mtune
10644 This option is very similar to the @option{-mcpu=} option, except that
10645 instead of specifying the actual target processor type, and hence
10646 restricting which instructions can be used, it specifies that GCC should
10647 tune the performance of the code as if the target were of the type
10648 specified in this option, but still choosing the instructions that it
10649 will generate based on the CPU specified by a @option{-mcpu=} option.
10650 For some ARM implementations better performance can be obtained by using
10651 this option.
10652
10653 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
10654 performance for a blend of processors within architecture @var{arch}.
10655 The aim is to generate code that run well on the current most popular
10656 processors, balancing between optimizations that benefit some CPUs in the
10657 range, and avoiding performance pitfalls of other CPUs.  The effects of
10658 this option may change in future GCC versions as CPU models come and go.
10659
10660 @option{-mtune=native} causes the compiler to auto-detect the CPU
10661 of the build computer.  At present, this feature is only supported on
10662 Linux, and not all architectures are recognised.  If the auto-detect is
10663 unsuccessful the option has no effect.
10664
10665 @item -march=@var{name}
10666 @opindex march
10667 This specifies the name of the target ARM architecture.  GCC uses this
10668 name to determine what kind of instructions it can emit when generating
10669 assembly code.  This option can be used in conjunction with or instead
10670 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
10671 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10672 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10673 @samp{armv6}, @samp{armv6j},
10674 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10675 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10676 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10677
10678 @option{-march=native} causes the compiler to auto-detect the architecture
10679 of the build computer.  At present, this feature is only supported on
10680 Linux, and not all architectures are recognised.  If the auto-detect is
10681 unsuccessful the option has no effect.
10682
10683 @item -mfpu=@var{name}
10684 @itemx -mfpe=@var{number}
10685 @itemx -mfp=@var{number}
10686 @opindex mfpu
10687 @opindex mfpe
10688 @opindex mfp
10689 This specifies what floating point hardware (or hardware emulation) is
10690 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
10691 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
10692 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
10693 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
10694 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10695 @option{-mfp} and @option{-mfpe} are synonyms for
10696 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
10697 of GCC@.
10698
10699 If @option{-msoft-float} is specified this specifies the format of
10700 floating point values.
10701
10702 If the selected floating-point hardware includes the NEON extension
10703 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10704 operations will not be used by GCC's auto-vectorization pass unless
10705 @option{-funsafe-math-optimizations} is also specified.  This is
10706 because NEON hardware does not fully implement the IEEE 754 standard for
10707 floating-point arithmetic (in particular denormal values are treated as
10708 zero), so the use of NEON instructions may lead to a loss of precision.
10709
10710 @item -mfp16-format=@var{name}
10711 @opindex mfp16-format
10712 Specify the format of the @code{__fp16} half-precision floating-point type.
10713 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10714 the default is @samp{none}, in which case the @code{__fp16} type is not
10715 defined.  @xref{Half-Precision}, for more information.
10716
10717 @item -mstructure-size-boundary=@var{n}
10718 @opindex mstructure-size-boundary
10719 The size of all structures and unions will be rounded up to a multiple
10720 of the number of bits set by this option.  Permissible values are 8, 32
10721 and 64.  The default value varies for different toolchains.  For the COFF
10722 targeted toolchain the default value is 8.  A value of 64 is only allowed
10723 if the underlying ABI supports it.
10724
10725 Specifying the larger number can produce faster, more efficient code, but
10726 can also increase the size of the program.  Different values are potentially
10727 incompatible.  Code compiled with one value cannot necessarily expect to
10728 work with code or libraries compiled with another value, if they exchange
10729 information using structures or unions.
10730
10731 @item -mabort-on-noreturn
10732 @opindex mabort-on-noreturn
10733 Generate a call to the function @code{abort} at the end of a
10734 @code{noreturn} function.  It will be executed if the function tries to
10735 return.
10736
10737 @item -mlong-calls
10738 @itemx -mno-long-calls
10739 @opindex mlong-calls
10740 @opindex mno-long-calls
10741 Tells the compiler to perform function calls by first loading the
10742 address of the function into a register and then performing a subroutine
10743 call on this register.  This switch is needed if the target function
10744 will lie outside of the 64 megabyte addressing range of the offset based
10745 version of subroutine call instruction.
10746
10747 Even if this switch is enabled, not all function calls will be turned
10748 into long calls.  The heuristic is that static functions, functions
10749 which have the @samp{short-call} attribute, functions that are inside
10750 the scope of a @samp{#pragma no_long_calls} directive and functions whose
10751 definitions have already been compiled within the current compilation
10752 unit, will not be turned into long calls.  The exception to this rule is
10753 that weak function definitions, functions with the @samp{long-call}
10754 attribute or the @samp{section} attribute, and functions that are within
10755 the scope of a @samp{#pragma long_calls} directive, will always be
10756 turned into long calls.
10757
10758 This feature is not enabled by default.  Specifying
10759 @option{-mno-long-calls} will restore the default behavior, as will
10760 placing the function calls within the scope of a @samp{#pragma
10761 long_calls_off} directive.  Note these switches have no effect on how
10762 the compiler generates code to handle function calls via function
10763 pointers.
10764
10765 @item -msingle-pic-base
10766 @opindex msingle-pic-base
10767 Treat the register used for PIC addressing as read-only, rather than
10768 loading it in the prologue for each function.  The run-time system is
10769 responsible for initializing this register with an appropriate value
10770 before execution begins.
10771
10772 @item -mpic-register=@var{reg}
10773 @opindex mpic-register
10774 Specify the register to be used for PIC addressing.  The default is R10
10775 unless stack-checking is enabled, when R9 is used.
10776
10777 @item -mcirrus-fix-invalid-insns
10778 @opindex mcirrus-fix-invalid-insns
10779 @opindex mno-cirrus-fix-invalid-insns
10780 Insert NOPs into the instruction stream to in order to work around
10781 problems with invalid Maverick instruction combinations.  This option
10782 is only valid if the @option{-mcpu=ep9312} option has been used to
10783 enable generation of instructions for the Cirrus Maverick floating
10784 point co-processor.  This option is not enabled by default, since the
10785 problem is only present in older Maverick implementations.  The default
10786 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10787 switch.
10788
10789 @item -mpoke-function-name
10790 @opindex mpoke-function-name
10791 Write the name of each function into the text section, directly
10792 preceding the function prologue.  The generated code is similar to this:
10793
10794 @smallexample
10795      t0
10796          .ascii "arm_poke_function_name", 0
10797          .align
10798      t1
10799          .word 0xff000000 + (t1 - t0)
10800      arm_poke_function_name
10801          mov     ip, sp
10802          stmfd   sp!, @{fp, ip, lr, pc@}
10803          sub     fp, ip, #4
10804 @end smallexample
10805
10806 When performing a stack backtrace, code can inspect the value of
10807 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10808 location @code{pc - 12} and the top 8 bits are set, then we know that
10809 there is a function name embedded immediately preceding this location
10810 and has length @code{((pc[-3]) & 0xff000000)}.
10811
10812 @item -mthumb
10813 @itemx -marm
10814 @opindex marm
10815 @opindex mthumb
10816
10817 Select between generating code that executes in ARM and Thumb
10818 states.  The default for most configurations is to generate code
10819 that executes in ARM state, but the default can be changed by
10820 configuring GCC with the @option{--with-mode=}@var{state}
10821 configure option.
10822
10823 @item -mtpcs-frame
10824 @opindex mtpcs-frame
10825 Generate a stack frame that is compliant with the Thumb Procedure Call
10826 Standard for all non-leaf functions.  (A leaf function is one that does
10827 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10828
10829 @item -mtpcs-leaf-frame
10830 @opindex mtpcs-leaf-frame
10831 Generate a stack frame that is compliant with the Thumb Procedure Call
10832 Standard for all leaf functions.  (A leaf function is one that does
10833 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10834
10835 @item -mcallee-super-interworking
10836 @opindex mcallee-super-interworking
10837 Gives all externally visible functions in the file being compiled an ARM
10838 instruction set header which switches to Thumb mode before executing the
10839 rest of the function.  This allows these functions to be called from
10840 non-interworking code.  This option is not valid in AAPCS configurations
10841 because interworking is enabled by default.
10842
10843 @item -mcaller-super-interworking
10844 @opindex mcaller-super-interworking
10845 Allows calls via function pointers (including virtual functions) to
10846 execute correctly regardless of whether the target code has been
10847 compiled for interworking or not.  There is a small overhead in the cost
10848 of executing a function pointer if this option is enabled.  This option
10849 is not valid in AAPCS configurations because interworking is enabled
10850 by default.
10851
10852 @item -mtp=@var{name}
10853 @opindex mtp
10854 Specify the access model for the thread local storage pointer.  The valid
10855 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
10856 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
10857 (supported in the arm6k architecture), and @option{auto}, which uses the
10858 best available method for the selected processor.  The default setting is
10859 @option{auto}.
10860
10861 @item -mtls-dialect=@var{dialect}
10862 @opindex mtls-dialect
10863 Specify the dialect to use for accessing thread local storage.  Two
10864 dialects are supported --- @option{gnu} and @option{gnu2}.  The
10865 @option{gnu} dialect selects the original GNU scheme for supporting
10866 local and global dynamic TLS models.  The @option{gnu2} dialect
10867 selects the GNU descriptor scheme, which provides better performance
10868 for shared libraries.  The GNU descriptor scheme is compatible with
10869 the original scheme, but does require new assembler, linker and
10870 library support.  Initial and local exec TLS models are unaffected by
10871 this option and always use the original scheme.
10872
10873 @item -mword-relocations
10874 @opindex mword-relocations
10875 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
10876 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
10877 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
10878 is specified.
10879
10880 @item -mfix-cortex-m3-ldrd
10881 @opindex mfix-cortex-m3-ldrd
10882 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
10883 with overlapping destination and base registers are used.  This option avoids
10884 generating these instructions.  This option is enabled by default when
10885 @option{-mcpu=cortex-m3} is specified.
10886
10887 @end table
10888
10889 @node AVR Options
10890 @subsection AVR Options
10891 @cindex AVR Options
10892
10893 These options are defined for AVR implementations:
10894
10895 @table @gcctabopt
10896 @item -mmcu=@var{mcu}
10897 @opindex mmcu
10898 Specify ATMEL AVR instruction set or MCU type.
10899
10900 Instruction set avr1 is for the minimal AVR core, not supported by the C
10901 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10902 attiny11, attiny12, attiny15, attiny28).
10903
10904 Instruction set avr2 (default) is for the classic AVR core with up to
10905 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10906 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10907 at90c8534, at90s8535).
10908
10909 Instruction set avr3 is for the classic AVR core with up to 128K program
10910 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10911
10912 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10913 memory space (MCU types: atmega8, atmega83, atmega85).
10914
10915 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10916 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10917 atmega64, atmega128, at43usb355, at94k).
10918
10919 @item -mno-interrupts
10920 @opindex mno-interrupts
10921 Generated code is not compatible with hardware interrupts.
10922 Code size will be smaller.
10923
10924 @item -mcall-prologues
10925 @opindex mcall-prologues
10926 Functions prologues/epilogues expanded as call to appropriate
10927 subroutines.  Code size will be smaller.
10928
10929 @item -mtiny-stack
10930 @opindex mtiny-stack
10931 Change only the low 8 bits of the stack pointer.
10932
10933 @item -mint8
10934 @opindex mint8
10935 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10936 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10937 and long long will be 4 bytes.  Please note that this option does not
10938 comply to the C standards, but it will provide you with smaller code
10939 size.
10940
10941 @item -mstrict-X
10942 @opindex mstrict-X
10943 Use register @code{X} in a way proposed by the hardware.  This means
10944 that @code{X} will only be used in indirect, post-increment or
10945 pre-decrement addressing.
10946
10947 Without this option, the @code{X} register may be used in the same way
10948 as @code{Y} or @code{Z} which then is emulated by additional
10949 instructions.  
10950 For example, loading a value with @code{X+const} addressing with a
10951 small @code{const <= 63} to a register @var{Rn} will be printed as
10952 @example
10953 adiw r26, const
10954 ld   @var{Rn}, X
10955 sbiw r26, const
10956 @end example
10957 @end table
10958
10959 @subsubsection @code{EIND} and Devices with more than 128k Bytes of Flash
10960
10961 Pointers in the implementation are 16 bits wide.
10962 The address of a function or label is represented as word address so
10963 that indirect jumps and calls can address any code address in the
10964 range of 64k words.
10965
10966 In order to faciliate indirect jump on devices with more than 128k
10967 bytes of program memory space, there is a special function register called
10968 @code{EIND} that serves as most significant part of the target address
10969 when @code{EICALL} or @code{EIJMP} instructions are used.
10970
10971 Indirect jumps and calls on these devices are handled as follows and
10972 are subject to some limitations:
10973
10974 @itemize @bullet
10975
10976 @item
10977 The compiler never sets @code{EIND}.
10978
10979 @item
10980 The startup code from libgcc never sets @code{EIND}.
10981 Notice that startup code is a blend of code from libgcc and avr-libc.
10982 For the impact of avr-libc on @code{EIND}, see the
10983 @w{@uref{http://nongnu.org/avr-libc/user-manual,avr-libc user manual}}.
10984
10985 @item
10986 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
10987 instructions or might read @code{EIND} directly.
10988
10989 @item
10990 The compiler assumes that @code{EIND} never changes during the startup
10991 code or run of the application. In particular, @code{EIND} is not
10992 saved/restored in function or interrupt service routine
10993 prologue/epilogue.
10994
10995 @item
10996 It is legitimate for user-specific startup code to set up @code{EIND}
10997 early, for example by means of initialization code located in
10998 section @code{.init3}, and thus prior to general startup code that
10999 initializes RAM and calls constructors.
11000
11001 @item
11002 For indirect calls to functions and computed goto, the linker will
11003 generate @emph{stubs}. Stubs are jump pads sometimes also called
11004 @emph{trampolines}. Thus, the indirect call/jump will jump to such a stub.
11005 The stub contains a direct jump to the desired address.
11006
11007 @item
11008 Stubs will be generated automatically by the linker if
11009 the following two conditions are met:
11010 @itemize @minus
11011
11012 @item The address of a label is taken by means of the @code{gs} modifier
11013 (short for @emph{generate stubs}) like so:
11014 @example
11015 LDI r24, lo8(gs(@var{func}))
11016 LDI r25, hi8(gs(@var{func}))
11017 @end example
11018 @item The final location of that label is in a code segment
11019 @emph{outside} the segment where the stubs are located.
11020 @end itemize
11021
11022 @item
11023 The compiler will emit such @code{gs} modifiers for code labels in the
11024 following situations:
11025 @itemize @minus
11026 @item Taking address of a function or code label.
11027 @item Computed goto.
11028 @item If prologue-save function is used, see @option{-mcall-prologues}
11029 command line option.
11030 @item Switch/case dispatch tables. If you do not want such dispatch
11031 tables you can specify the @option{-fno-jump-tables} command line option.
11032 @item C and C++ constructors/destructors called during startup/shutdown.
11033 @item If the tools hit a @code{gs()} modifier explained above.
11034 @end itemize
11035
11036 @item
11037 The default linker script is arranged for code with @code{EIND = 0}.
11038 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11039 linker script has to be used in order to place the sections whose
11040 name start with @code{.trampolines} into the segment where @code{EIND}
11041 points to.
11042
11043 @item
11044 Jumping to non-symbolic addresses like so is @emph{not} supported:
11045
11046 @example
11047 int main (void)
11048 @{
11049     /* Call function at word address 0x2 */
11050     return ((int(*)(void)) 0x2)();
11051 @}
11052 @end example
11053
11054 Instead, a stub has to be set up:
11055
11056 @example
11057 int main (void)
11058 @{
11059     extern int func_4 (void);
11060
11061     /* Call function at byte address 0x4 */
11062     return func_4();
11063 @}
11064 @end example
11065
11066 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11067 Alternatively, @code{func_4} can be defined in the linker script.
11068 @end itemize
11069
11070 @node Blackfin Options
11071 @subsection Blackfin Options
11072 @cindex Blackfin Options
11073
11074 @table @gcctabopt
11075 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11076 @opindex mcpu=
11077 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
11078 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11079 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11080 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11081 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11082 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11083 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11084 @samp{bf561}, @samp{bf592}.
11085 The optional @var{sirevision} specifies the silicon revision of the target
11086 Blackfin processor.  Any workarounds available for the targeted silicon revision
11087 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
11088 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
11089 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
11090 hexadecimal digits representing the major and minor numbers in the silicon
11091 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
11092 is not defined.  If @var{sirevision} is @samp{any}, the
11093 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
11094 If this optional @var{sirevision} is not used, GCC assumes the latest known
11095 silicon revision of the targeted Blackfin processor.
11096
11097 Support for @samp{bf561} is incomplete.  For @samp{bf561},
11098 Only the processor macro is defined.
11099 Without this option, @samp{bf532} is used as the processor by default.
11100 The corresponding predefined processor macros for @var{cpu} is to
11101 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
11102 provided by libgloss to be linked in if @option{-msim} is not given.
11103
11104 @item -msim
11105 @opindex msim
11106 Specifies that the program will be run on the simulator.  This causes
11107 the simulator BSP provided by libgloss to be linked in.  This option
11108 has effect only for @samp{bfin-elf} toolchain.
11109 Certain other options, such as @option{-mid-shared-library} and
11110 @option{-mfdpic}, imply @option{-msim}.
11111
11112 @item -momit-leaf-frame-pointer
11113 @opindex momit-leaf-frame-pointer
11114 Don't keep the frame pointer in a register for leaf functions.  This
11115 avoids the instructions to save, set up and restore frame pointers and
11116 makes an extra register available in leaf functions.  The option
11117 @option{-fomit-frame-pointer} removes the frame pointer for all functions
11118 which might make debugging harder.
11119
11120 @item -mspecld-anomaly
11121 @opindex mspecld-anomaly
11122 When enabled, the compiler will ensure that the generated code does not
11123 contain speculative loads after jump instructions. If this option is used,
11124 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
11125
11126 @item -mno-specld-anomaly
11127 @opindex mno-specld-anomaly
11128 Don't generate extra code to prevent speculative loads from occurring.
11129
11130 @item -mcsync-anomaly
11131 @opindex mcsync-anomaly
11132 When enabled, the compiler will ensure that the generated code does not
11133 contain CSYNC or SSYNC instructions too soon after conditional branches.
11134 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
11135
11136 @item -mno-csync-anomaly
11137 @opindex mno-csync-anomaly
11138 Don't generate extra code to prevent CSYNC or SSYNC instructions from
11139 occurring too soon after a conditional branch.
11140
11141 @item -mlow-64k
11142 @opindex mlow-64k
11143 When enabled, the compiler is free to take advantage of the knowledge that
11144 the entire program fits into the low 64k of memory.
11145
11146 @item -mno-low-64k
11147 @opindex mno-low-64k
11148 Assume that the program is arbitrarily large.  This is the default.
11149
11150 @item -mstack-check-l1
11151 @opindex mstack-check-l1
11152 Do stack checking using information placed into L1 scratchpad memory by the
11153 uClinux kernel.
11154
11155 @item -mid-shared-library
11156 @opindex mid-shared-library
11157 Generate code that supports shared libraries via the library ID method.
11158 This allows for execute in place and shared libraries in an environment
11159 without virtual memory management.  This option implies @option{-fPIC}.
11160 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11161
11162 @item -mno-id-shared-library
11163 @opindex mno-id-shared-library
11164 Generate code that doesn't assume ID based shared libraries are being used.
11165 This is the default.
11166
11167 @item -mleaf-id-shared-library
11168 @opindex mleaf-id-shared-library
11169 Generate code that supports shared libraries via the library ID method,
11170 but assumes that this library or executable won't link against any other
11171 ID shared libraries.  That allows the compiler to use faster code for jumps
11172 and calls.
11173
11174 @item -mno-leaf-id-shared-library
11175 @opindex mno-leaf-id-shared-library
11176 Do not assume that the code being compiled won't link against any ID shared
11177 libraries.  Slower code will be generated for jump and call insns.
11178
11179 @item -mshared-library-id=n
11180 @opindex mshared-library-id
11181 Specified the identification number of the ID based shared library being
11182 compiled.  Specifying a value of 0 will generate more compact code, specifying
11183 other values will force the allocation of that number to the current
11184 library but is no more space or time efficient than omitting this option.
11185
11186 @item -msep-data
11187 @opindex msep-data
11188 Generate code that allows the data segment to be located in a different
11189 area of memory from the text segment.  This allows for execute in place in
11190 an environment without virtual memory management by eliminating relocations
11191 against the text section.
11192
11193 @item -mno-sep-data
11194 @opindex mno-sep-data
11195 Generate code that assumes that the data segment follows the text segment.
11196 This is the default.
11197
11198 @item -mlong-calls
11199 @itemx -mno-long-calls
11200 @opindex mlong-calls
11201 @opindex mno-long-calls
11202 Tells the compiler to perform function calls by first loading the
11203 address of the function into a register and then performing a subroutine
11204 call on this register.  This switch is needed if the target function
11205 will lie outside of the 24 bit addressing range of the offset based
11206 version of subroutine call instruction.
11207
11208 This feature is not enabled by default.  Specifying
11209 @option{-mno-long-calls} will restore the default behavior.  Note these
11210 switches have no effect on how the compiler generates code to handle
11211 function calls via function pointers.
11212
11213 @item -mfast-fp
11214 @opindex mfast-fp
11215 Link with the fast floating-point library. This library relaxes some of
11216 the IEEE floating-point standard's rules for checking inputs against
11217 Not-a-Number (NAN), in the interest of performance.
11218
11219 @item -minline-plt
11220 @opindex minline-plt
11221 Enable inlining of PLT entries in function calls to functions that are
11222 not known to bind locally.  It has no effect without @option{-mfdpic}.
11223
11224 @item -mmulticore
11225 @opindex mmulticore
11226 Build standalone application for multicore Blackfin processor. Proper
11227 start files and link scripts will be used to support multicore.
11228 This option defines @code{__BFIN_MULTICORE}. It can only be used with
11229 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
11230 @option{-mcorea} or @option{-mcoreb}. If it's used without
11231 @option{-mcorea} or @option{-mcoreb}, single application/dual core
11232 programming model is used. In this model, the main function of Core B
11233 should be named as coreb_main. If it's used with @option{-mcorea} or
11234 @option{-mcoreb}, one application per core programming model is used.
11235 If this option is not used, single core application programming
11236 model is used.
11237
11238 @item -mcorea
11239 @opindex mcorea
11240 Build standalone application for Core A of BF561 when using
11241 one application per core programming model. Proper start files
11242 and link scripts will be used to support Core A. This option
11243 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
11244
11245 @item -mcoreb
11246 @opindex mcoreb
11247 Build standalone application for Core B of BF561 when using
11248 one application per core programming model. Proper start files
11249 and link scripts will be used to support Core B. This option
11250 defines @code{__BFIN_COREB}. When this option is used, coreb_main
11251 should be used instead of main. It must be used with
11252 @option{-mmulticore}.
11253
11254 @item -msdram
11255 @opindex msdram
11256 Build standalone application for SDRAM. Proper start files and
11257 link scripts will be used to put the application into SDRAM.
11258 Loader should initialize SDRAM before loading the application
11259 into SDRAM. This option defines @code{__BFIN_SDRAM}.
11260
11261 @item -micplb
11262 @opindex micplb
11263 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
11264 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
11265 are enabled; for standalone applications the default is off.
11266 @end table
11267
11268 @node C6X Options
11269 @subsection C6X Options
11270 @cindex C6X Options
11271
11272 @table @gcctabopt
11273 @item -march=@var{name}
11274 @opindex march
11275 This specifies the name of the target architecture.  GCC uses this
11276 name to determine what kind of instructions it can emit when generating
11277 assembly code.  Permissible names are: @samp{c62x},
11278 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
11279
11280 @item -mbig-endian
11281 @opindex mbig-endian
11282 Generate code for a big endian target.
11283
11284 @item -mlittle-endian
11285 @opindex mlittle-endian
11286 Generate code for a little endian target.  This is the default.
11287
11288 @item -msim
11289 @opindex msim
11290 Choose startup files and linker script suitable for the simulator.
11291
11292 @item -msdata=default
11293 @opindex msdata=default
11294 Put small global and static data in the @samp{.neardata} section,
11295 which is pointed to by register @code{B14}.  Put small uninitialized
11296 global and static data in the @samp{.bss} section, which is adjacent
11297 to the @samp{.neardata} section.  Put small read-only data into the
11298 @samp{.rodata} section.  The corresponding sections used for large
11299 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
11300
11301 @item -msdata=all
11302 @opindex msdata=all
11303 Put all data, not just small objets, into the sections reserved for
11304 small data, and use addressing relative to the @code{B14} register to
11305 access them.
11306
11307 @item -msdata=none
11308 @opindex msdata=none
11309 Make no use of the sections reserved for small data, and use absolute
11310 addresses to access all data.  Put all initialized global and static
11311 data in the @samp{.fardata} section, and all uninitialized data in the
11312 @samp{.far} section.  Put all constant data into the @samp{.const}
11313 section.
11314 @end table
11315
11316 @node CRIS Options
11317 @subsection CRIS Options
11318 @cindex CRIS Options
11319
11320 These options are defined specifically for the CRIS ports.
11321
11322 @table @gcctabopt
11323 @item -march=@var{architecture-type}
11324 @itemx -mcpu=@var{architecture-type}
11325 @opindex march
11326 @opindex mcpu
11327 Generate code for the specified architecture.  The choices for
11328 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
11329 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
11330 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
11331 @samp{v10}.
11332
11333 @item -mtune=@var{architecture-type}
11334 @opindex mtune
11335 Tune to @var{architecture-type} everything applicable about the generated
11336 code, except for the ABI and the set of available instructions.  The
11337 choices for @var{architecture-type} are the same as for
11338 @option{-march=@var{architecture-type}}.
11339
11340 @item -mmax-stack-frame=@var{n}
11341 @opindex mmax-stack-frame
11342 Warn when the stack frame of a function exceeds @var{n} bytes.
11343
11344 @item -metrax4
11345 @itemx -metrax100
11346 @opindex metrax4
11347 @opindex metrax100
11348 The options @option{-metrax4} and @option{-metrax100} are synonyms for
11349 @option{-march=v3} and @option{-march=v8} respectively.
11350
11351 @item -mmul-bug-workaround
11352 @itemx -mno-mul-bug-workaround
11353 @opindex mmul-bug-workaround
11354 @opindex mno-mul-bug-workaround
11355 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
11356 models where it applies.  This option is active by default.
11357
11358 @item -mpdebug
11359 @opindex mpdebug
11360 Enable CRIS-specific verbose debug-related information in the assembly
11361 code.  This option also has the effect to turn off the @samp{#NO_APP}
11362 formatted-code indicator to the assembler at the beginning of the
11363 assembly file.
11364
11365 @item -mcc-init
11366 @opindex mcc-init
11367 Do not use condition-code results from previous instruction; always emit
11368 compare and test instructions before use of condition codes.
11369
11370 @item -mno-side-effects
11371 @opindex mno-side-effects
11372 Do not emit instructions with side-effects in addressing modes other than
11373 post-increment.
11374
11375 @item -mstack-align
11376 @itemx -mno-stack-align
11377 @itemx -mdata-align
11378 @itemx -mno-data-align
11379 @itemx -mconst-align
11380 @itemx -mno-const-align
11381 @opindex mstack-align
11382 @opindex mno-stack-align
11383 @opindex mdata-align
11384 @opindex mno-data-align
11385 @opindex mconst-align
11386 @opindex mno-const-align
11387 These options (no-options) arranges (eliminate arrangements) for the
11388 stack-frame, individual data and constants to be aligned for the maximum
11389 single data access size for the chosen CPU model.  The default is to
11390 arrange for 32-bit alignment.  ABI details such as structure layout are
11391 not affected by these options.
11392
11393 @item -m32-bit
11394 @itemx -m16-bit
11395 @itemx -m8-bit
11396 @opindex m32-bit
11397 @opindex m16-bit
11398 @opindex m8-bit
11399 Similar to the stack- data- and const-align options above, these options
11400 arrange for stack-frame, writable data and constants to all be 32-bit,
11401 16-bit or 8-bit aligned.  The default is 32-bit alignment.
11402
11403 @item -mno-prologue-epilogue
11404 @itemx -mprologue-epilogue
11405 @opindex mno-prologue-epilogue
11406 @opindex mprologue-epilogue
11407 With @option{-mno-prologue-epilogue}, the normal function prologue and
11408 epilogue that sets up the stack-frame are omitted and no return
11409 instructions or return sequences are generated in the code.  Use this
11410 option only together with visual inspection of the compiled code: no
11411 warnings or errors are generated when call-saved registers must be saved,
11412 or storage for local variable needs to be allocated.
11413
11414 @item -mno-gotplt
11415 @itemx -mgotplt
11416 @opindex mno-gotplt
11417 @opindex mgotplt
11418 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
11419 instruction sequences that load addresses for functions from the PLT part
11420 of the GOT rather than (traditional on other architectures) calls to the
11421 PLT@.  The default is @option{-mgotplt}.
11422
11423 @item -melf
11424 @opindex melf
11425 Legacy no-op option only recognized with the cris-axis-elf and
11426 cris-axis-linux-gnu targets.
11427
11428 @item -mlinux
11429 @opindex mlinux
11430 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
11431
11432 @item -sim
11433 @opindex sim
11434 This option, recognized for the cris-axis-elf arranges
11435 to link with input-output functions from a simulator library.  Code,
11436 initialized data and zero-initialized data are allocated consecutively.
11437
11438 @item -sim2
11439 @opindex sim2
11440 Like @option{-sim}, but pass linker options to locate initialized data at
11441 0x40000000 and zero-initialized data at 0x80000000.
11442 @end table
11443
11444 @node Darwin Options
11445 @subsection Darwin Options
11446 @cindex Darwin options
11447
11448 These options are defined for all architectures running the Darwin operating
11449 system.
11450
11451 FSF GCC on Darwin does not create ``fat'' object files; it will create
11452 an object file for the single architecture that it was built to
11453 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
11454 @option{-arch} options are used; it does so by running the compiler or
11455 linker multiple times and joining the results together with
11456 @file{lipo}.
11457
11458 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
11459 @samp{i686}) is determined by the flags that specify the ISA
11460 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
11461 @option{-force_cpusubtype_ALL} option can be used to override this.
11462
11463 The Darwin tools vary in their behavior when presented with an ISA
11464 mismatch.  The assembler, @file{as}, will only permit instructions to
11465 be used that are valid for the subtype of the file it is generating,
11466 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
11467 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
11468 and print an error if asked to create a shared library with a less
11469 restrictive subtype than its input files (for instance, trying to put
11470 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
11471 for executables, @file{ld}, will quietly give the executable the most
11472 restrictive subtype of any of its input files.
11473
11474 @table @gcctabopt
11475 @item -F@var{dir}
11476 @opindex F
11477 Add the framework directory @var{dir} to the head of the list of
11478 directories to be searched for header files.  These directories are
11479 interleaved with those specified by @option{-I} options and are
11480 scanned in a left-to-right order.
11481
11482 A framework directory is a directory with frameworks in it.  A
11483 framework is a directory with a @samp{"Headers"} and/or
11484 @samp{"PrivateHeaders"} directory contained directly in it that ends
11485 in @samp{".framework"}.  The name of a framework is the name of this
11486 directory excluding the @samp{".framework"}.  Headers associated with
11487 the framework are found in one of those two directories, with
11488 @samp{"Headers"} being searched first.  A subframework is a framework
11489 directory that is in a framework's @samp{"Frameworks"} directory.
11490 Includes of subframework headers can only appear in a header of a
11491 framework that contains the subframework, or in a sibling subframework
11492 header.  Two subframeworks are siblings if they occur in the same
11493 framework.  A subframework should not have the same name as a
11494 framework, a warning will be issued if this is violated.  Currently a
11495 subframework cannot have subframeworks, in the future, the mechanism
11496 may be extended to support this.  The standard frameworks can be found
11497 in @samp{"/System/Library/Frameworks"} and
11498 @samp{"/Library/Frameworks"}.  An example include looks like
11499 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
11500 the name of the framework and header.h is found in the
11501 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
11502
11503 @item -iframework@var{dir}
11504 @opindex iframework
11505 Like @option{-F} except the directory is a treated as a system
11506 directory.  The main difference between this @option{-iframework} and
11507 @option{-F} is that with @option{-iframework} the compiler does not
11508 warn about constructs contained within header files found via
11509 @var{dir}.  This option is valid only for the C family of languages.
11510
11511 @item -gused
11512 @opindex gused
11513 Emit debugging information for symbols that are used.  For STABS
11514 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
11515 This is by default ON@.
11516
11517 @item -gfull
11518 @opindex gfull
11519 Emit debugging information for all symbols and types.
11520
11521 @item -mmacosx-version-min=@var{version}
11522 The earliest version of MacOS X that this executable will run on
11523 is @var{version}.  Typical values of @var{version} include @code{10.1},
11524 @code{10.2}, and @code{10.3.9}.
11525
11526 If the compiler was built to use the system's headers by default,
11527 then the default for this option is the system version on which the
11528 compiler is running, otherwise the default is to make choices which
11529 are compatible with as many systems and code bases as possible.
11530
11531 @item -mkernel
11532 @opindex mkernel
11533 Enable kernel development mode.  The @option{-mkernel} option sets
11534 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
11535 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
11536 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
11537 applicable.  This mode also sets @option{-mno-altivec},
11538 @option{-msoft-float}, @option{-fno-builtin} and
11539 @option{-mlong-branch} for PowerPC targets.
11540
11541 @item -mone-byte-bool
11542 @opindex mone-byte-bool
11543 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
11544 By default @samp{sizeof(bool)} is @samp{4} when compiling for
11545 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
11546 option has no effect on x86.
11547
11548 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
11549 to generate code that is not binary compatible with code generated
11550 without that switch.  Using this switch may require recompiling all
11551 other modules in a program, including system libraries.  Use this
11552 switch to conform to a non-default data model.
11553
11554 @item -mfix-and-continue
11555 @itemx -ffix-and-continue
11556 @itemx -findirect-data
11557 @opindex mfix-and-continue
11558 @opindex ffix-and-continue
11559 @opindex findirect-data
11560 Generate code suitable for fast turn around development.  Needed to
11561 enable gdb to dynamically load @code{.o} files into already running
11562 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
11563 are provided for backwards compatibility.
11564
11565 @item -all_load
11566 @opindex all_load
11567 Loads all members of static archive libraries.
11568 See man ld(1) for more information.
11569
11570 @item -arch_errors_fatal
11571 @opindex arch_errors_fatal
11572 Cause the errors having to do with files that have the wrong architecture
11573 to be fatal.
11574
11575 @item -bind_at_load
11576 @opindex bind_at_load
11577 Causes the output file to be marked such that the dynamic linker will
11578 bind all undefined references when the file is loaded or launched.
11579
11580 @item -bundle
11581 @opindex bundle
11582 Produce a Mach-o bundle format file.
11583 See man ld(1) for more information.
11584
11585 @item -bundle_loader @var{executable}
11586 @opindex bundle_loader
11587 This option specifies the @var{executable} that will be loading the build
11588 output file being linked.  See man ld(1) for more information.
11589
11590 @item -dynamiclib
11591 @opindex dynamiclib
11592 When passed this option, GCC will produce a dynamic library instead of
11593 an executable when linking, using the Darwin @file{libtool} command.
11594
11595 @item -force_cpusubtype_ALL
11596 @opindex force_cpusubtype_ALL
11597 This causes GCC's output file to have the @var{ALL} subtype, instead of
11598 one controlled by the @option{-mcpu} or @option{-march} option.
11599
11600 @item -allowable_client  @var{client_name}
11601 @itemx -client_name
11602 @itemx -compatibility_version
11603 @itemx -current_version
11604 @itemx -dead_strip
11605 @itemx -dependency-file
11606 @itemx -dylib_file
11607 @itemx -dylinker_install_name
11608 @itemx -dynamic
11609 @itemx -exported_symbols_list
11610 @itemx -filelist
11611 @need 800
11612 @itemx -flat_namespace
11613 @itemx -force_flat_namespace
11614 @itemx -headerpad_max_install_names
11615 @itemx -image_base
11616 @itemx -init
11617 @itemx -install_name
11618 @itemx -keep_private_externs
11619 @itemx -multi_module
11620 @itemx -multiply_defined
11621 @itemx -multiply_defined_unused
11622 @need 800
11623 @itemx -noall_load
11624 @itemx -no_dead_strip_inits_and_terms
11625 @itemx -nofixprebinding
11626 @itemx -nomultidefs
11627 @itemx -noprebind
11628 @itemx -noseglinkedit
11629 @itemx -pagezero_size
11630 @itemx -prebind
11631 @itemx -prebind_all_twolevel_modules
11632 @itemx -private_bundle
11633 @need 800
11634 @itemx -read_only_relocs
11635 @itemx -sectalign
11636 @itemx -sectobjectsymbols
11637 @itemx -whyload
11638 @itemx -seg1addr
11639 @itemx -sectcreate
11640 @itemx -sectobjectsymbols
11641 @itemx -sectorder
11642 @itemx -segaddr
11643 @itemx -segs_read_only_addr
11644 @need 800
11645 @itemx -segs_read_write_addr
11646 @itemx -seg_addr_table
11647 @itemx -seg_addr_table_filename
11648 @itemx -seglinkedit
11649 @itemx -segprot
11650 @itemx -segs_read_only_addr
11651 @itemx -segs_read_write_addr
11652 @itemx -single_module
11653 @itemx -static
11654 @itemx -sub_library
11655 @need 800
11656 @itemx -sub_umbrella
11657 @itemx -twolevel_namespace
11658 @itemx -umbrella
11659 @itemx -undefined
11660 @itemx -unexported_symbols_list
11661 @itemx -weak_reference_mismatches
11662 @itemx -whatsloaded
11663 @opindex allowable_client
11664 @opindex client_name
11665 @opindex compatibility_version
11666 @opindex current_version
11667 @opindex dead_strip
11668 @opindex dependency-file
11669 @opindex dylib_file
11670 @opindex dylinker_install_name
11671 @opindex dynamic
11672 @opindex exported_symbols_list
11673 @opindex filelist
11674 @opindex flat_namespace
11675 @opindex force_flat_namespace
11676 @opindex headerpad_max_install_names
11677 @opindex image_base
11678 @opindex init
11679 @opindex install_name
11680 @opindex keep_private_externs
11681 @opindex multi_module
11682 @opindex multiply_defined
11683 @opindex multiply_defined_unused
11684 @opindex noall_load
11685 @opindex no_dead_strip_inits_and_terms
11686 @opindex nofixprebinding
11687 @opindex nomultidefs
11688 @opindex noprebind
11689 @opindex noseglinkedit
11690 @opindex pagezero_size
11691 @opindex prebind
11692 @opindex prebind_all_twolevel_modules
11693 @opindex private_bundle
11694 @opindex read_only_relocs
11695 @opindex sectalign
11696 @opindex sectobjectsymbols
11697 @opindex whyload
11698 @opindex seg1addr
11699 @opindex sectcreate
11700 @opindex sectobjectsymbols
11701 @opindex sectorder
11702 @opindex segaddr
11703 @opindex segs_read_only_addr
11704 @opindex segs_read_write_addr
11705 @opindex seg_addr_table
11706 @opindex seg_addr_table_filename
11707 @opindex seglinkedit
11708 @opindex segprot
11709 @opindex segs_read_only_addr
11710 @opindex segs_read_write_addr
11711 @opindex single_module
11712 @opindex static
11713 @opindex sub_library
11714 @opindex sub_umbrella
11715 @opindex twolevel_namespace
11716 @opindex umbrella
11717 @opindex undefined
11718 @opindex unexported_symbols_list
11719 @opindex weak_reference_mismatches
11720 @opindex whatsloaded
11721 These options are passed to the Darwin linker.  The Darwin linker man page
11722 describes them in detail.
11723 @end table
11724
11725 @node DEC Alpha Options
11726 @subsection DEC Alpha Options
11727
11728 These @samp{-m} options are defined for the DEC Alpha implementations:
11729
11730 @table @gcctabopt
11731 @item -mno-soft-float
11732 @itemx -msoft-float
11733 @opindex mno-soft-float
11734 @opindex msoft-float
11735 Use (do not use) the hardware floating-point instructions for
11736 floating-point operations.  When @option{-msoft-float} is specified,
11737 functions in @file{libgcc.a} will be used to perform floating-point
11738 operations.  Unless they are replaced by routines that emulate the
11739 floating-point operations, or compiled in such a way as to call such
11740 emulations routines, these routines will issue floating-point
11741 operations.   If you are compiling for an Alpha without floating-point
11742 operations, you must ensure that the library is built so as not to call
11743 them.
11744
11745 Note that Alpha implementations without floating-point operations are
11746 required to have floating-point registers.
11747
11748 @item -mfp-reg
11749 @itemx -mno-fp-regs
11750 @opindex mfp-reg
11751 @opindex mno-fp-regs
11752 Generate code that uses (does not use) the floating-point register set.
11753 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
11754 register set is not used, floating point operands are passed in integer
11755 registers as if they were integers and floating-point results are passed
11756 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
11757 so any function with a floating-point argument or return value called by code
11758 compiled with @option{-mno-fp-regs} must also be compiled with that
11759 option.
11760
11761 A typical use of this option is building a kernel that does not use,
11762 and hence need not save and restore, any floating-point registers.
11763
11764 @item -mieee
11765 @opindex mieee
11766 The Alpha architecture implements floating-point hardware optimized for
11767 maximum performance.  It is mostly compliant with the IEEE floating
11768 point standard.  However, for full compliance, software assistance is
11769 required.  This option generates code fully IEEE compliant code
11770 @emph{except} that the @var{inexact-flag} is not maintained (see below).
11771 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
11772 defined during compilation.  The resulting code is less efficient but is
11773 able to correctly support denormalized numbers and exceptional IEEE
11774 values such as not-a-number and plus/minus infinity.  Other Alpha
11775 compilers call this option @option{-ieee_with_no_inexact}.
11776
11777 @item -mieee-with-inexact
11778 @opindex mieee-with-inexact
11779 This is like @option{-mieee} except the generated code also maintains
11780 the IEEE @var{inexact-flag}.  Turning on this option causes the
11781 generated code to implement fully-compliant IEEE math.  In addition to
11782 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
11783 macro.  On some Alpha implementations the resulting code may execute
11784 significantly slower than the code generated by default.  Since there is
11785 very little code that depends on the @var{inexact-flag}, you should
11786 normally not specify this option.  Other Alpha compilers call this
11787 option @option{-ieee_with_inexact}.
11788
11789 @item -mfp-trap-mode=@var{trap-mode}
11790 @opindex mfp-trap-mode
11791 This option controls what floating-point related traps are enabled.
11792 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
11793 The trap mode can be set to one of four values:
11794
11795 @table @samp
11796 @item n
11797 This is the default (normal) setting.  The only traps that are enabled
11798 are the ones that cannot be disabled in software (e.g., division by zero
11799 trap).
11800
11801 @item u
11802 In addition to the traps enabled by @samp{n}, underflow traps are enabled
11803 as well.
11804
11805 @item su
11806 Like @samp{u}, but the instructions are marked to be safe for software
11807 completion (see Alpha architecture manual for details).
11808
11809 @item sui
11810 Like @samp{su}, but inexact traps are enabled as well.
11811 @end table
11812
11813 @item -mfp-rounding-mode=@var{rounding-mode}
11814 @opindex mfp-rounding-mode
11815 Selects the IEEE rounding mode.  Other Alpha compilers call this option
11816 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
11817 of:
11818
11819 @table @samp
11820 @item n
11821 Normal IEEE rounding mode.  Floating point numbers are rounded towards
11822 the nearest machine number or towards the even machine number in case
11823 of a tie.
11824
11825 @item m
11826 Round towards minus infinity.
11827
11828 @item c
11829 Chopped rounding mode.  Floating point numbers are rounded towards zero.
11830
11831 @item d
11832 Dynamic rounding mode.  A field in the floating point control register
11833 (@var{fpcr}, see Alpha architecture reference manual) controls the
11834 rounding mode in effect.  The C library initializes this register for
11835 rounding towards plus infinity.  Thus, unless your program modifies the
11836 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
11837 @end table
11838
11839 @item -mtrap-precision=@var{trap-precision}
11840 @opindex mtrap-precision
11841 In the Alpha architecture, floating point traps are imprecise.  This
11842 means without software assistance it is impossible to recover from a
11843 floating trap and program execution normally needs to be terminated.
11844 GCC can generate code that can assist operating system trap handlers
11845 in determining the exact location that caused a floating point trap.
11846 Depending on the requirements of an application, different levels of
11847 precisions can be selected:
11848
11849 @table @samp
11850 @item p
11851 Program precision.  This option is the default and means a trap handler
11852 can only identify which program caused a floating point exception.
11853
11854 @item f
11855 Function precision.  The trap handler can determine the function that
11856 caused a floating point exception.
11857
11858 @item i
11859 Instruction precision.  The trap handler can determine the exact
11860 instruction that caused a floating point exception.
11861 @end table
11862
11863 Other Alpha compilers provide the equivalent options called
11864 @option{-scope_safe} and @option{-resumption_safe}.
11865
11866 @item -mieee-conformant
11867 @opindex mieee-conformant
11868 This option marks the generated code as IEEE conformant.  You must not
11869 use this option unless you also specify @option{-mtrap-precision=i} and either
11870 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
11871 is to emit the line @samp{.eflag 48} in the function prologue of the
11872 generated assembly file.  Under DEC Unix, this has the effect that
11873 IEEE-conformant math library routines will be linked in.
11874
11875 @item -mbuild-constants
11876 @opindex mbuild-constants
11877 Normally GCC examines a 32- or 64-bit integer constant to
11878 see if it can construct it from smaller constants in two or three
11879 instructions.  If it cannot, it will output the constant as a literal and
11880 generate code to load it from the data segment at runtime.
11881
11882 Use this option to require GCC to construct @emph{all} integer constants
11883 using code, even if it takes more instructions (the maximum is six).
11884
11885 You would typically use this option to build a shared library dynamic
11886 loader.  Itself a shared library, it must relocate itself in memory
11887 before it can find the variables and constants in its own data segment.
11888
11889 @item -malpha-as
11890 @itemx -mgas
11891 @opindex malpha-as
11892 @opindex mgas
11893 Select whether to generate code to be assembled by the vendor-supplied
11894 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
11895
11896 @item -mbwx
11897 @itemx -mno-bwx
11898 @itemx -mcix
11899 @itemx -mno-cix
11900 @itemx -mfix
11901 @itemx -mno-fix
11902 @itemx -mmax
11903 @itemx -mno-max
11904 @opindex mbwx
11905 @opindex mno-bwx
11906 @opindex mcix
11907 @opindex mno-cix
11908 @opindex mfix
11909 @opindex mno-fix
11910 @opindex mmax
11911 @opindex mno-max
11912 Indicate whether GCC should generate code to use the optional BWX,
11913 CIX, FIX and MAX instruction sets.  The default is to use the instruction
11914 sets supported by the CPU type specified via @option{-mcpu=} option or that
11915 of the CPU on which GCC was built if none was specified.
11916
11917 @item -mfloat-vax
11918 @itemx -mfloat-ieee
11919 @opindex mfloat-vax
11920 @opindex mfloat-ieee
11921 Generate code that uses (does not use) VAX F and G floating point
11922 arithmetic instead of IEEE single and double precision.
11923
11924 @item -mexplicit-relocs
11925 @itemx -mno-explicit-relocs
11926 @opindex mexplicit-relocs
11927 @opindex mno-explicit-relocs
11928 Older Alpha assemblers provided no way to generate symbol relocations
11929 except via assembler macros.  Use of these macros does not allow
11930 optimal instruction scheduling.  GNU binutils as of version 2.12
11931 supports a new syntax that allows the compiler to explicitly mark
11932 which relocations should apply to which instructions.  This option
11933 is mostly useful for debugging, as GCC detects the capabilities of
11934 the assembler when it is built and sets the default accordingly.
11935
11936 @item -msmall-data
11937 @itemx -mlarge-data
11938 @opindex msmall-data
11939 @opindex mlarge-data
11940 When @option{-mexplicit-relocs} is in effect, static data is
11941 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
11942 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
11943 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
11944 16-bit relocations off of the @code{$gp} register.  This limits the
11945 size of the small data area to 64KB, but allows the variables to be
11946 directly accessed via a single instruction.
11947
11948 The default is @option{-mlarge-data}.  With this option the data area
11949 is limited to just below 2GB@.  Programs that require more than 2GB of
11950 data must use @code{malloc} or @code{mmap} to allocate the data in the
11951 heap instead of in the program's data segment.
11952
11953 When generating code for shared libraries, @option{-fpic} implies
11954 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
11955
11956 @item -msmall-text
11957 @itemx -mlarge-text
11958 @opindex msmall-text
11959 @opindex mlarge-text
11960 When @option{-msmall-text} is used, the compiler assumes that the
11961 code of the entire program (or shared library) fits in 4MB, and is
11962 thus reachable with a branch instruction.  When @option{-msmall-data}
11963 is used, the compiler can assume that all local symbols share the
11964 same @code{$gp} value, and thus reduce the number of instructions
11965 required for a function call from 4 to 1.
11966
11967 The default is @option{-mlarge-text}.
11968
11969 @item -mcpu=@var{cpu_type}
11970 @opindex mcpu
11971 Set the instruction set and instruction scheduling parameters for
11972 machine type @var{cpu_type}.  You can specify either the @samp{EV}
11973 style name or the corresponding chip number.  GCC supports scheduling
11974 parameters for the EV4, EV5 and EV6 family of processors and will
11975 choose the default values for the instruction set from the processor
11976 you specify.  If you do not specify a processor type, GCC will default
11977 to the processor on which the compiler was built.
11978
11979 Supported values for @var{cpu_type} are
11980
11981 @table @samp
11982 @item ev4
11983 @itemx ev45
11984 @itemx 21064
11985 Schedules as an EV4 and has no instruction set extensions.
11986
11987 @item ev5
11988 @itemx 21164
11989 Schedules as an EV5 and has no instruction set extensions.
11990
11991 @item ev56
11992 @itemx 21164a
11993 Schedules as an EV5 and supports the BWX extension.
11994
11995 @item pca56
11996 @itemx 21164pc
11997 @itemx 21164PC
11998 Schedules as an EV5 and supports the BWX and MAX extensions.
11999
12000 @item ev6
12001 @itemx 21264
12002 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12003
12004 @item ev67
12005 @itemx 21264a
12006 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12007 @end table
12008
12009 Native toolchains also support the value @samp{native},
12010 which selects the best architecture option for the host processor.
12011 @option{-mcpu=native} has no effect if GCC does not recognize
12012 the processor.
12013
12014 @item -mtune=@var{cpu_type}
12015 @opindex mtune
12016 Set only the instruction scheduling parameters for machine type
12017 @var{cpu_type}.  The instruction set is not changed.
12018
12019 Native toolchains also support the value @samp{native},
12020 which selects the best architecture option for the host processor.
12021 @option{-mtune=native} has no effect if GCC does not recognize
12022 the processor.
12023
12024 @item -mmemory-latency=@var{time}
12025 @opindex mmemory-latency
12026 Sets the latency the scheduler should assume for typical memory
12027 references as seen by the application.  This number is highly
12028 dependent on the memory access patterns used by the application
12029 and the size of the external cache on the machine.
12030
12031 Valid options for @var{time} are
12032
12033 @table @samp
12034 @item @var{number}
12035 A decimal number representing clock cycles.
12036
12037 @item L1
12038 @itemx L2
12039 @itemx L3
12040 @itemx main
12041 The compiler contains estimates of the number of clock cycles for
12042 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12043 (also called Dcache, Scache, and Bcache), as well as to main memory.
12044 Note that L3 is only valid for EV5.
12045
12046 @end table
12047 @end table
12048
12049 @node DEC Alpha/VMS Options
12050 @subsection DEC Alpha/VMS Options
12051
12052 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
12053
12054 @table @gcctabopt
12055 @item -mvms-return-codes
12056 @opindex mvms-return-codes
12057 Return VMS condition codes from main.  The default is to return POSIX
12058 style condition (e.g.@: error) codes.
12059
12060 @item -mdebug-main=@var{prefix}
12061 @opindex mdebug-main=@var{prefix}
12062 Flag the first routine whose name starts with @var{prefix} as the main
12063 routine for the debugger.
12064
12065 @item -mmalloc64
12066 @opindex mmalloc64
12067 Default to 64bit memory allocation routines.
12068 @end table
12069
12070 @node FR30 Options
12071 @subsection FR30 Options
12072 @cindex FR30 Options
12073
12074 These options are defined specifically for the FR30 port.
12075
12076 @table @gcctabopt
12077
12078 @item -msmall-model
12079 @opindex msmall-model
12080 Use the small address space model.  This can produce smaller code, but
12081 it does assume that all symbolic values and addresses will fit into a
12082 20-bit range.
12083
12084 @item -mno-lsim
12085 @opindex mno-lsim
12086 Assume that run-time support has been provided and so there is no need
12087 to include the simulator library (@file{libsim.a}) on the linker
12088 command line.
12089
12090 @end table
12091
12092 @node FRV Options
12093 @subsection FRV Options
12094 @cindex FRV Options
12095
12096 @table @gcctabopt
12097 @item -mgpr-32
12098 @opindex mgpr-32
12099
12100 Only use the first 32 general purpose registers.
12101
12102 @item -mgpr-64
12103 @opindex mgpr-64
12104
12105 Use all 64 general purpose registers.
12106
12107 @item -mfpr-32
12108 @opindex mfpr-32
12109
12110 Use only the first 32 floating point registers.
12111
12112 @item -mfpr-64
12113 @opindex mfpr-64
12114
12115 Use all 64 floating point registers
12116
12117 @item -mhard-float
12118 @opindex mhard-float
12119
12120 Use hardware instructions for floating point operations.
12121
12122 @item -msoft-float
12123 @opindex msoft-float
12124
12125 Use library routines for floating point operations.
12126
12127 @item -malloc-cc
12128 @opindex malloc-cc
12129
12130 Dynamically allocate condition code registers.
12131
12132 @item -mfixed-cc
12133 @opindex mfixed-cc
12134
12135 Do not try to dynamically allocate condition code registers, only
12136 use @code{icc0} and @code{fcc0}.
12137
12138 @item -mdword
12139 @opindex mdword
12140
12141 Change ABI to use double word insns.
12142
12143 @item -mno-dword
12144 @opindex mno-dword
12145
12146 Do not use double word instructions.
12147
12148 @item -mdouble
12149 @opindex mdouble
12150
12151 Use floating point double instructions.
12152
12153 @item -mno-double
12154 @opindex mno-double
12155
12156 Do not use floating point double instructions.
12157
12158 @item -mmedia
12159 @opindex mmedia
12160
12161 Use media instructions.
12162
12163 @item -mno-media
12164 @opindex mno-media
12165
12166 Do not use media instructions.
12167
12168 @item -mmuladd
12169 @opindex mmuladd
12170
12171 Use multiply and add/subtract instructions.
12172
12173 @item -mno-muladd
12174 @opindex mno-muladd
12175
12176 Do not use multiply and add/subtract instructions.
12177
12178 @item -mfdpic
12179 @opindex mfdpic
12180
12181 Select the FDPIC ABI, that uses function descriptors to represent
12182 pointers to functions.  Without any PIC/PIE-related options, it
12183 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
12184 assumes GOT entries and small data are within a 12-bit range from the
12185 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
12186 are computed with 32 bits.
12187 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12188
12189 @item -minline-plt
12190 @opindex minline-plt
12191
12192 Enable inlining of PLT entries in function calls to functions that are
12193 not known to bind locally.  It has no effect without @option{-mfdpic}.
12194 It's enabled by default if optimizing for speed and compiling for
12195 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
12196 optimization option such as @option{-O3} or above is present in the
12197 command line.
12198
12199 @item -mTLS
12200 @opindex mTLS
12201
12202 Assume a large TLS segment when generating thread-local code.
12203
12204 @item -mtls
12205 @opindex mtls
12206
12207 Do not assume a large TLS segment when generating thread-local code.
12208
12209 @item -mgprel-ro
12210 @opindex mgprel-ro
12211
12212 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
12213 that is known to be in read-only sections.  It's enabled by default,
12214 except for @option{-fpic} or @option{-fpie}: even though it may help
12215 make the global offset table smaller, it trades 1 instruction for 4.
12216 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
12217 one of which may be shared by multiple symbols, and it avoids the need
12218 for a GOT entry for the referenced symbol, so it's more likely to be a
12219 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
12220
12221 @item -multilib-library-pic
12222 @opindex multilib-library-pic
12223
12224 Link with the (library, not FD) pic libraries.  It's implied by
12225 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
12226 @option{-fpic} without @option{-mfdpic}.  You should never have to use
12227 it explicitly.
12228
12229 @item -mlinked-fp
12230 @opindex mlinked-fp
12231
12232 Follow the EABI requirement of always creating a frame pointer whenever
12233 a stack frame is allocated.  This option is enabled by default and can
12234 be disabled with @option{-mno-linked-fp}.
12235
12236 @item -mlong-calls
12237 @opindex mlong-calls
12238
12239 Use indirect addressing to call functions outside the current
12240 compilation unit.  This allows the functions to be placed anywhere
12241 within the 32-bit address space.
12242
12243 @item -malign-labels
12244 @opindex malign-labels
12245
12246 Try to align labels to an 8-byte boundary by inserting nops into the
12247 previous packet.  This option only has an effect when VLIW packing
12248 is enabled.  It doesn't create new packets; it merely adds nops to
12249 existing ones.
12250
12251 @item -mlibrary-pic
12252 @opindex mlibrary-pic
12253
12254 Generate position-independent EABI code.
12255
12256 @item -macc-4
12257 @opindex macc-4
12258
12259 Use only the first four media accumulator registers.
12260
12261 @item -macc-8
12262 @opindex macc-8
12263
12264 Use all eight media accumulator registers.
12265
12266 @item -mpack
12267 @opindex mpack
12268
12269 Pack VLIW instructions.
12270
12271 @item -mno-pack
12272 @opindex mno-pack
12273
12274 Do not pack VLIW instructions.
12275
12276 @item -mno-eflags
12277 @opindex mno-eflags
12278
12279 Do not mark ABI switches in e_flags.
12280
12281 @item -mcond-move
12282 @opindex mcond-move
12283
12284 Enable the use of conditional-move instructions (default).
12285
12286 This switch is mainly for debugging the compiler and will likely be removed
12287 in a future version.
12288
12289 @item -mno-cond-move
12290 @opindex mno-cond-move
12291
12292 Disable the use of conditional-move instructions.
12293
12294 This switch is mainly for debugging the compiler and will likely be removed
12295 in a future version.
12296
12297 @item -mscc
12298 @opindex mscc
12299
12300 Enable the use of conditional set instructions (default).
12301
12302 This switch is mainly for debugging the compiler and will likely be removed
12303 in a future version.
12304
12305 @item -mno-scc
12306 @opindex mno-scc
12307
12308 Disable the use of conditional set instructions.
12309
12310 This switch is mainly for debugging the compiler and will likely be removed
12311 in a future version.
12312
12313 @item -mcond-exec
12314 @opindex mcond-exec
12315
12316 Enable the use of conditional execution (default).
12317
12318 This switch is mainly for debugging the compiler and will likely be removed
12319 in a future version.
12320
12321 @item -mno-cond-exec
12322 @opindex mno-cond-exec
12323
12324 Disable the use of conditional execution.
12325
12326 This switch is mainly for debugging the compiler and will likely be removed
12327 in a future version.
12328
12329 @item -mvliw-branch
12330 @opindex mvliw-branch
12331
12332 Run a pass to pack branches into VLIW instructions (default).
12333
12334 This switch is mainly for debugging the compiler and will likely be removed
12335 in a future version.
12336
12337 @item -mno-vliw-branch
12338 @opindex mno-vliw-branch
12339
12340 Do not run a pass to pack branches into VLIW instructions.
12341
12342 This switch is mainly for debugging the compiler and will likely be removed
12343 in a future version.
12344
12345 @item -mmulti-cond-exec
12346 @opindex mmulti-cond-exec
12347
12348 Enable optimization of @code{&&} and @code{||} in conditional execution
12349 (default).
12350
12351 This switch is mainly for debugging the compiler and will likely be removed
12352 in a future version.
12353
12354 @item -mno-multi-cond-exec
12355 @opindex mno-multi-cond-exec
12356
12357 Disable optimization of @code{&&} and @code{||} in conditional execution.
12358
12359 This switch is mainly for debugging the compiler and will likely be removed
12360 in a future version.
12361
12362 @item -mnested-cond-exec
12363 @opindex mnested-cond-exec
12364
12365 Enable nested conditional execution optimizations (default).
12366
12367 This switch is mainly for debugging the compiler and will likely be removed
12368 in a future version.
12369
12370 @item -mno-nested-cond-exec
12371 @opindex mno-nested-cond-exec
12372
12373 Disable nested conditional execution optimizations.
12374
12375 This switch is mainly for debugging the compiler and will likely be removed
12376 in a future version.
12377
12378 @item -moptimize-membar
12379 @opindex moptimize-membar
12380
12381 This switch removes redundant @code{membar} instructions from the
12382 compiler generated code.  It is enabled by default.
12383
12384 @item -mno-optimize-membar
12385 @opindex mno-optimize-membar
12386
12387 This switch disables the automatic removal of redundant @code{membar}
12388 instructions from the generated code.
12389
12390 @item -mtomcat-stats
12391 @opindex mtomcat-stats
12392
12393 Cause gas to print out tomcat statistics.
12394
12395 @item -mcpu=@var{cpu}
12396 @opindex mcpu
12397
12398 Select the processor type for which to generate code.  Possible values are
12399 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
12400 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
12401
12402 @end table
12403
12404 @node GNU/Linux Options
12405 @subsection GNU/Linux Options
12406
12407 These @samp{-m} options are defined for GNU/Linux targets:
12408
12409 @table @gcctabopt
12410 @item -mglibc
12411 @opindex mglibc
12412 Use the GNU C library.  This is the default except
12413 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
12414
12415 @item -muclibc
12416 @opindex muclibc
12417 Use uClibc C library.  This is the default on
12418 @samp{*-*-linux-*uclibc*} targets.
12419
12420 @item -mbionic
12421 @opindex mbionic
12422 Use Bionic C library.  This is the default on
12423 @samp{*-*-linux-*android*} targets.
12424
12425 @item -mandroid
12426 @opindex mandroid
12427 Compile code compatible with Android platform.  This is the default on
12428 @samp{*-*-linux-*android*} targets.
12429
12430 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
12431 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
12432 this option makes the GCC driver pass Android-specific options to the linker.
12433 Finally, this option causes the preprocessor macro @code{__ANDROID__}
12434 to be defined.
12435
12436 @item -tno-android-cc
12437 @opindex tno-android-cc
12438 Disable compilation effects of @option{-mandroid}, i.e., do not enable
12439 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
12440 @option{-fno-rtti} by default.
12441
12442 @item -tno-android-ld
12443 @opindex tno-android-ld
12444 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
12445 linking options to the linker.
12446
12447 @end table
12448
12449 @node H8/300 Options
12450 @subsection H8/300 Options
12451
12452 These @samp{-m} options are defined for the H8/300 implementations:
12453
12454 @table @gcctabopt
12455 @item -mrelax
12456 @opindex mrelax
12457 Shorten some address references at link time, when possible; uses the
12458 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
12459 ld, Using ld}, for a fuller description.
12460
12461 @item -mh
12462 @opindex mh
12463 Generate code for the H8/300H@.
12464
12465 @item -ms
12466 @opindex ms
12467 Generate code for the H8S@.
12468
12469 @item -mn
12470 @opindex mn
12471 Generate code for the H8S and H8/300H in the normal mode.  This switch
12472 must be used either with @option{-mh} or @option{-ms}.
12473
12474 @item -ms2600
12475 @opindex ms2600
12476 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
12477
12478 @item -mint32
12479 @opindex mint32
12480 Make @code{int} data 32 bits by default.
12481
12482 @item -malign-300
12483 @opindex malign-300
12484 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
12485 The default for the H8/300H and H8S is to align longs and floats on 4
12486 byte boundaries.
12487 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
12488 This option has no effect on the H8/300.
12489 @end table
12490
12491 @node HPPA Options
12492 @subsection HPPA Options
12493 @cindex HPPA Options
12494
12495 These @samp{-m} options are defined for the HPPA family of computers:
12496
12497 @table @gcctabopt
12498 @item -march=@var{architecture-type}
12499 @opindex march
12500 Generate code for the specified architecture.  The choices for
12501 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
12502 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
12503 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
12504 architecture option for your machine.  Code compiled for lower numbered
12505 architectures will run on higher numbered architectures, but not the
12506 other way around.
12507
12508 @item -mpa-risc-1-0
12509 @itemx -mpa-risc-1-1
12510 @itemx -mpa-risc-2-0
12511 @opindex mpa-risc-1-0
12512 @opindex mpa-risc-1-1
12513 @opindex mpa-risc-2-0
12514 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
12515
12516 @item -mbig-switch
12517 @opindex mbig-switch
12518 Generate code suitable for big switch tables.  Use this option only if
12519 the assembler/linker complain about out of range branches within a switch
12520 table.
12521
12522 @item -mjump-in-delay
12523 @opindex mjump-in-delay
12524 Fill delay slots of function calls with unconditional jump instructions
12525 by modifying the return pointer for the function call to be the target
12526 of the conditional jump.
12527
12528 @item -mdisable-fpregs
12529 @opindex mdisable-fpregs
12530 Prevent floating point registers from being used in any manner.  This is
12531 necessary for compiling kernels which perform lazy context switching of
12532 floating point registers.  If you use this option and attempt to perform
12533 floating point operations, the compiler will abort.
12534
12535 @item -mdisable-indexing
12536 @opindex mdisable-indexing
12537 Prevent the compiler from using indexing address modes.  This avoids some
12538 rather obscure problems when compiling MIG generated code under MACH@.
12539
12540 @item -mno-space-regs
12541 @opindex mno-space-regs
12542 Generate code that assumes the target has no space registers.  This allows
12543 GCC to generate faster indirect calls and use unscaled index address modes.
12544
12545 Such code is suitable for level 0 PA systems and kernels.
12546
12547 @item -mfast-indirect-calls
12548 @opindex mfast-indirect-calls
12549 Generate code that assumes calls never cross space boundaries.  This
12550 allows GCC to emit code which performs faster indirect calls.
12551
12552 This option will not work in the presence of shared libraries or nested
12553 functions.
12554
12555 @item -mfixed-range=@var{register-range}
12556 @opindex mfixed-range
12557 Generate code treating the given register range as fixed registers.
12558 A fixed register is one that the register allocator can not use.  This is
12559 useful when compiling kernel code.  A register range is specified as
12560 two registers separated by a dash.  Multiple register ranges can be
12561 specified separated by a comma.
12562
12563 @item -mlong-load-store
12564 @opindex mlong-load-store
12565 Generate 3-instruction load and store sequences as sometimes required by
12566 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
12567 the HP compilers.
12568
12569 @item -mportable-runtime
12570 @opindex mportable-runtime
12571 Use the portable calling conventions proposed by HP for ELF systems.
12572
12573 @item -mgas
12574 @opindex mgas
12575 Enable the use of assembler directives only GAS understands.
12576
12577 @item -mschedule=@var{cpu-type}
12578 @opindex mschedule
12579 Schedule code according to the constraints for the machine type
12580 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
12581 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
12582 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
12583 proper scheduling option for your machine.  The default scheduling is
12584 @samp{8000}.
12585
12586 @item -mlinker-opt
12587 @opindex mlinker-opt
12588 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
12589 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
12590 linkers in which they give bogus error messages when linking some programs.
12591
12592 @item -msoft-float
12593 @opindex msoft-float
12594 Generate output containing library calls for floating point.
12595 @strong{Warning:} the requisite libraries are not available for all HPPA
12596 targets.  Normally the facilities of the machine's usual C compiler are
12597 used, but this cannot be done directly in cross-compilation.  You must make
12598 your own arrangements to provide suitable library functions for
12599 cross-compilation.
12600
12601 @option{-msoft-float} changes the calling convention in the output file;
12602 therefore, it is only useful if you compile @emph{all} of a program with
12603 this option.  In particular, you need to compile @file{libgcc.a}, the
12604 library that comes with GCC, with @option{-msoft-float} in order for
12605 this to work.
12606
12607 @item -msio
12608 @opindex msio
12609 Generate the predefine, @code{_SIO}, for server IO@.  The default is
12610 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
12611 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
12612 options are available under HP-UX and HI-UX@.
12613
12614 @item -mgnu-ld
12615 @opindex mgnu-ld
12616 Use GNU ld specific options.  This passes @option{-shared} to ld when
12617 building a shared library.  It is the default when GCC is configured,
12618 explicitly or implicitly, with the GNU linker.  This option does not
12619 have any affect on which ld is called, it only changes what parameters
12620 are passed to that ld.  The ld that is called is determined by the
12621 @option{--with-ld} configure option, GCC's program search path, and
12622 finally by the user's @env{PATH}.  The linker used by GCC can be printed
12623 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
12624 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
12625
12626 @item -mhp-ld
12627 @opindex mhp-ld
12628 Use HP ld specific options.  This passes @option{-b} to ld when building
12629 a shared library and passes @option{+Accept TypeMismatch} to ld on all
12630 links.  It is the default when GCC is configured, explicitly or
12631 implicitly, with the HP linker.  This option does not have any affect on
12632 which ld is called, it only changes what parameters are passed to that
12633 ld.  The ld that is called is determined by the @option{--with-ld}
12634 configure option, GCC's program search path, and finally by the user's
12635 @env{PATH}.  The linker used by GCC can be printed using @samp{which
12636 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
12637 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
12638
12639 @item -mlong-calls
12640 @opindex mno-long-calls
12641 Generate code that uses long call sequences.  This ensures that a call
12642 is always able to reach linker generated stubs.  The default is to generate
12643 long calls only when the distance from the call site to the beginning
12644 of the function or translation unit, as the case may be, exceeds a
12645 predefined limit set by the branch type being used.  The limits for
12646 normal calls are 7,600,000 and 240,000 bytes, respectively for the
12647 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
12648 240,000 bytes.
12649
12650 Distances are measured from the beginning of functions when using the
12651 @option{-ffunction-sections} option, or when using the @option{-mgas}
12652 and @option{-mno-portable-runtime} options together under HP-UX with
12653 the SOM linker.
12654
12655 It is normally not desirable to use this option as it will degrade
12656 performance.  However, it may be useful in large applications,
12657 particularly when partial linking is used to build the application.
12658
12659 The types of long calls used depends on the capabilities of the
12660 assembler and linker, and the type of code being generated.  The
12661 impact on systems that support long absolute calls, and long pic
12662 symbol-difference or pc-relative calls should be relatively small.
12663 However, an indirect call is used on 32-bit ELF systems in pic code
12664 and it is quite long.
12665
12666 @item -munix=@var{unix-std}
12667 @opindex march
12668 Generate compiler predefines and select a startfile for the specified
12669 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
12670 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
12671 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
12672 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
12673 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
12674 and later.
12675
12676 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
12677 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
12678 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
12679 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
12680 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
12681 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
12682
12683 It is @emph{important} to note that this option changes the interfaces
12684 for various library routines.  It also affects the operational behavior
12685 of the C library.  Thus, @emph{extreme} care is needed in using this
12686 option.
12687
12688 Library code that is intended to operate with more than one UNIX
12689 standard must test, set and restore the variable @var{__xpg4_extended_mask}
12690 as appropriate.  Most GNU software doesn't provide this capability.
12691
12692 @item -nolibdld
12693 @opindex nolibdld
12694 Suppress the generation of link options to search libdld.sl when the
12695 @option{-static} option is specified on HP-UX 10 and later.
12696
12697 @item -static
12698 @opindex static
12699 The HP-UX implementation of setlocale in libc has a dependency on
12700 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
12701 when the @option{-static} option is specified, special link options
12702 are needed to resolve this dependency.
12703
12704 On HP-UX 10 and later, the GCC driver adds the necessary options to
12705 link with libdld.sl when the @option{-static} option is specified.
12706 This causes the resulting binary to be dynamic.  On the 64-bit port,
12707 the linkers generate dynamic binaries by default in any case.  The
12708 @option{-nolibdld} option can be used to prevent the GCC driver from
12709 adding these link options.
12710
12711 @item -threads
12712 @opindex threads
12713 Add support for multithreading with the @dfn{dce thread} library
12714 under HP-UX@.  This option sets flags for both the preprocessor and
12715 linker.
12716 @end table
12717
12718 @node i386 and x86-64 Options
12719 @subsection Intel 386 and AMD x86-64 Options
12720 @cindex i386 Options
12721 @cindex x86-64 Options
12722 @cindex Intel 386 Options
12723 @cindex AMD x86-64 Options
12724
12725 These @samp{-m} options are defined for the i386 and x86-64 family of
12726 computers:
12727
12728 @table @gcctabopt
12729 @item -mtune=@var{cpu-type}
12730 @opindex mtune
12731 Tune to @var{cpu-type} everything applicable about the generated code, except
12732 for the ABI and the set of available instructions.  The choices for
12733 @var{cpu-type} are:
12734 @table @emph
12735 @item generic
12736 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
12737 If you know the CPU on which your code will run, then you should use
12738 the corresponding @option{-mtune} option instead of
12739 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
12740 of your application will have, then you should use this option.
12741
12742 As new processors are deployed in the marketplace, the behavior of this
12743 option will change.  Therefore, if you upgrade to a newer version of
12744 GCC, the code generated option will change to reflect the processors
12745 that were most common when that version of GCC was released.
12746
12747 There is no @option{-march=generic} option because @option{-march}
12748 indicates the instruction set the compiler can use, and there is no
12749 generic instruction set applicable to all processors.  In contrast,
12750 @option{-mtune} indicates the processor (or, in this case, collection of
12751 processors) for which the code is optimized.
12752 @item native
12753 This selects the CPU to tune for at compilation time by determining
12754 the processor type of the compiling machine.  Using @option{-mtune=native}
12755 will produce code optimized for the local machine under the constraints
12756 of the selected instruction set.  Using @option{-march=native} will
12757 enable all instruction subsets supported by the local machine (hence
12758 the result might not run on different machines).
12759 @item i386
12760 Original Intel's i386 CPU@.
12761 @item i486
12762 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
12763 @item i586, pentium
12764 Intel Pentium CPU with no MMX support.
12765 @item pentium-mmx
12766 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
12767 @item pentiumpro
12768 Intel PentiumPro CPU@.
12769 @item i686
12770 Same as @code{generic}, but when used as @code{march} option, PentiumPro
12771 instruction set will be used, so the code will run on all i686 family chips.
12772 @item pentium2
12773 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
12774 @item pentium3, pentium3m
12775 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
12776 support.
12777 @item pentium-m
12778 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
12779 support.  Used by Centrino notebooks.
12780 @item pentium4, pentium4m
12781 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
12782 @item prescott
12783 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
12784 set support.
12785 @item nocona
12786 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
12787 SSE2 and SSE3 instruction set support.
12788 @item core2
12789 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12790 instruction set support.
12791 @item corei7
12792 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
12793 and SSE4.2 instruction set support.
12794 @item corei7-avx
12795 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
12796 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
12797 @item core-avx-i
12798 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
12799 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
12800 set support.
12801 @item atom
12802 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12803 instruction set support.
12804 @item k6
12805 AMD K6 CPU with MMX instruction set support.
12806 @item k6-2, k6-3
12807 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
12808 @item athlon, athlon-tbird
12809 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
12810 support.
12811 @item athlon-4, athlon-xp, athlon-mp
12812 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
12813 instruction set support.
12814 @item k8, opteron, athlon64, athlon-fx
12815 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
12816 MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit instruction set extensions.)
12817 @item k8-sse3, opteron-sse3, athlon64-sse3
12818 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
12819 @item amdfam10, barcelona
12820 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
12821 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
12822 instruction set extensions.)
12823 @item bdver1
12824 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
12825 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
12826 SSSE3, SSE4.1, SSE4.2, 3DNow!, enhanced 3DNow!, ABM and 64-bit
12827 instruction set extensions.)
12828 @item btver1
12829 AMD Family 14h core based CPUs with x86-64 instruction set support.  (This
12830 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
12831 instruction set extensions.)
12832 @item winchip-c6
12833 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
12834 set support.
12835 @item winchip2
12836 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
12837 instruction set support.
12838 @item c3
12839 Via C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
12840 implemented for this chip.)
12841 @item c3-2
12842 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
12843 implemented for this chip.)
12844 @item geode
12845 Embedded AMD CPU with MMX and 3DNow!@: instruction set support.
12846 @end table
12847
12848 While picking a specific @var{cpu-type} will schedule things appropriately
12849 for that particular chip, the compiler will not generate any code that
12850 does not run on the default machine type without the @option{-march=@var{cpu-type}}
12851 option being used. For example, if GCC is configured for i686-pc-linux-gnu
12852 then @option{-mtune=pentium4} will generate code that is tuned for Pentium4
12853 but will still run on i686 machines.
12854
12855 @item -march=@var{cpu-type}
12856 @opindex march
12857 Generate instructions for the machine type @var{cpu-type}.  The choices
12858 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
12859 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
12860
12861 @item -mcpu=@var{cpu-type}
12862 @opindex mcpu
12863 A deprecated synonym for @option{-mtune}.
12864
12865 @item -mfpmath=@var{unit}
12866 @opindex mfpmath
12867 Generate floating point arithmetics for selected unit @var{unit}.  The choices
12868 for @var{unit} are:
12869
12870 @table @samp
12871 @item 387
12872 Use the standard 387 floating point coprocessor present majority of chips and
12873 emulated otherwise.  Code compiled with this option will run almost everywhere.
12874 The temporary results are computed in 80bit precision instead of precision
12875 specified by the type resulting in slightly different results compared to most
12876 of other chips.  See @option{-ffloat-store} for more detailed description.
12877
12878 This is the default choice for i386 compiler.
12879
12880 @item sse
12881 Use scalar floating point instructions present in the SSE instruction set.
12882 This instruction set is supported by Pentium3 and newer chips, in the AMD line
12883 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
12884 instruction set supports only single precision arithmetics, thus the double and
12885 extended precision arithmetics is still done using 387.  Later version, present
12886 only in Pentium4 and the future AMD x86-64 chips supports double precision
12887 arithmetics too.
12888
12889 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
12890 or @option{-msse2} switches to enable SSE extensions and make this option
12891 effective.  For the x86-64 compiler, these extensions are enabled by default.
12892
12893 The resulting code should be considerably faster in the majority of cases and avoid
12894 the numerical instability problems of 387 code, but may break some existing
12895 code that expects temporaries to be 80bit.
12896
12897 This is the default choice for the x86-64 compiler.
12898
12899 @item sse,387
12900 @itemx sse+387
12901 @itemx both
12902 Attempt to utilize both instruction sets at once.  This effectively double the
12903 amount of available registers and on chips with separate execution units for
12904 387 and SSE the execution resources too.  Use this option with care, as it is
12905 still experimental, because the GCC register allocator does not model separate
12906 functional units well resulting in instable performance.
12907 @end table
12908
12909 @item -masm=@var{dialect}
12910 @opindex masm=@var{dialect}
12911 Output asm instructions using selected @var{dialect}.  Supported
12912 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
12913 not support @samp{intel}.
12914
12915 @item -mieee-fp
12916 @itemx -mno-ieee-fp
12917 @opindex mieee-fp
12918 @opindex mno-ieee-fp
12919 Control whether or not the compiler uses IEEE floating point
12920 comparisons.  These handle correctly the case where the result of a
12921 comparison is unordered.
12922
12923 @item -msoft-float
12924 @opindex msoft-float
12925 Generate output containing library calls for floating point.
12926 @strong{Warning:} the requisite libraries are not part of GCC@.
12927 Normally the facilities of the machine's usual C compiler are used, but
12928 this can't be done directly in cross-compilation.  You must make your
12929 own arrangements to provide suitable library functions for
12930 cross-compilation.
12931
12932 On machines where a function returns floating point results in the 80387
12933 register stack, some floating point opcodes may be emitted even if
12934 @option{-msoft-float} is used.
12935
12936 @item -mno-fp-ret-in-387
12937 @opindex mno-fp-ret-in-387
12938 Do not use the FPU registers for return values of functions.
12939
12940 The usual calling convention has functions return values of types
12941 @code{float} and @code{double} in an FPU register, even if there
12942 is no FPU@.  The idea is that the operating system should emulate
12943 an FPU@.
12944
12945 The option @option{-mno-fp-ret-in-387} causes such values to be returned
12946 in ordinary CPU registers instead.
12947
12948 @item -mno-fancy-math-387
12949 @opindex mno-fancy-math-387
12950 Some 387 emulators do not support the @code{sin}, @code{cos} and
12951 @code{sqrt} instructions for the 387.  Specify this option to avoid
12952 generating those instructions.  This option is the default on FreeBSD,
12953 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
12954 indicates that the target CPU will always have an FPU and so the
12955 instruction will not need emulation.  As of revision 2.6.1, these
12956 instructions are not generated unless you also use the
12957 @option{-funsafe-math-optimizations} switch.
12958
12959 @item -malign-double
12960 @itemx -mno-align-double
12961 @opindex malign-double
12962 @opindex mno-align-double
12963 Control whether GCC aligns @code{double}, @code{long double}, and
12964 @code{long long} variables on a two word boundary or a one word
12965 boundary.  Aligning @code{double} variables on a two word boundary will
12966 produce code that runs somewhat faster on a @samp{Pentium} at the
12967 expense of more memory.
12968
12969 On x86-64, @option{-malign-double} is enabled by default.
12970
12971 @strong{Warning:} if you use the @option{-malign-double} switch,
12972 structures containing the above types will be aligned differently than
12973 the published application binary interface specifications for the 386
12974 and will not be binary compatible with structures in code compiled
12975 without that switch.
12976
12977 @item -m96bit-long-double
12978 @itemx -m128bit-long-double
12979 @opindex m96bit-long-double
12980 @opindex m128bit-long-double
12981 These switches control the size of @code{long double} type.  The i386
12982 application binary interface specifies the size to be 96 bits,
12983 so @option{-m96bit-long-double} is the default in 32 bit mode.
12984
12985 Modern architectures (Pentium and newer) would prefer @code{long double}
12986 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
12987 conforming to the ABI, this would not be possible.  So specifying a
12988 @option{-m128bit-long-double} will align @code{long double}
12989 to a 16 byte boundary by padding the @code{long double} with an additional
12990 32 bit zero.
12991
12992 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
12993 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
12994
12995 Notice that neither of these options enable any extra precision over the x87
12996 standard of 80 bits for a @code{long double}.
12997
12998 @strong{Warning:} if you override the default value for your target ABI, the
12999 structures and arrays containing @code{long double} variables will change
13000 their size as well as function calling convention for function taking
13001 @code{long double} will be modified.  Hence they will not be binary
13002 compatible with arrays or structures in code compiled without that switch.
13003
13004 @item -mlarge-data-threshold=@var{number}
13005 @opindex mlarge-data-threshold=@var{number}
13006 When @option{-mcmodel=medium} is specified, the data greater than
13007 @var{threshold} are placed in large data section.  This value must be the
13008 same across all object linked into the binary and defaults to 65535.
13009
13010 @item -mrtd
13011 @opindex mrtd
13012 Use a different function-calling convention, in which functions that
13013 take a fixed number of arguments return with the @code{ret} @var{num}
13014 instruction, which pops their arguments while returning.  This saves one
13015 instruction in the caller since there is no need to pop the arguments
13016 there.
13017
13018 You can specify that an individual function is called with this calling
13019 sequence with the function attribute @samp{stdcall}.  You can also
13020 override the @option{-mrtd} option by using the function attribute
13021 @samp{cdecl}.  @xref{Function Attributes}.
13022
13023 @strong{Warning:} this calling convention is incompatible with the one
13024 normally used on Unix, so you cannot use it if you need to call
13025 libraries compiled with the Unix compiler.
13026
13027 Also, you must provide function prototypes for all functions that
13028 take variable numbers of arguments (including @code{printf});
13029 otherwise incorrect code will be generated for calls to those
13030 functions.
13031
13032 In addition, seriously incorrect code will result if you call a
13033 function with too many arguments.  (Normally, extra arguments are
13034 harmlessly ignored.)
13035
13036 @item -mregparm=@var{num}
13037 @opindex mregparm
13038 Control how many registers are used to pass integer arguments.  By
13039 default, no registers are used to pass arguments, and at most 3
13040 registers can be used.  You can control this behavior for a specific
13041 function by using the function attribute @samp{regparm}.
13042 @xref{Function Attributes}.
13043
13044 @strong{Warning:} if you use this switch, and
13045 @var{num} is nonzero, then you must build all modules with the same
13046 value, including any libraries.  This includes the system libraries and
13047 startup modules.
13048
13049 @item -msseregparm
13050 @opindex msseregparm
13051 Use SSE register passing conventions for float and double arguments
13052 and return values.  You can control this behavior for a specific
13053 function by using the function attribute @samp{sseregparm}.
13054 @xref{Function Attributes}.
13055
13056 @strong{Warning:} if you use this switch then you must build all
13057 modules with the same value, including any libraries.  This includes
13058 the system libraries and startup modules.
13059
13060 @item -mvect8-ret-in-mem
13061 @opindex mvect8-ret-in-mem
13062 Return 8-byte vectors in memory instead of MMX registers.  This is the
13063 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
13064 Studio compilers until version 12.  Later compiler versions (starting
13065 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
13066 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
13067 you need to remain compatible with existing code produced by those
13068 previous compiler versions or older versions of GCC.
13069
13070 @item -mpc32
13071 @itemx -mpc64
13072 @itemx -mpc80
13073 @opindex mpc32
13074 @opindex mpc64
13075 @opindex mpc80
13076
13077 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
13078 is specified, the significands of results of floating-point operations are
13079 rounded to 24 bits (single precision); @option{-mpc64} rounds the
13080 significands of results of floating-point operations to 53 bits (double
13081 precision) and @option{-mpc80} rounds the significands of results of
13082 floating-point operations to 64 bits (extended double precision), which is
13083 the default.  When this option is used, floating-point operations in higher
13084 precisions are not available to the programmer without setting the FPU
13085 control word explicitly.
13086
13087 Setting the rounding of floating-point operations to less than the default
13088 80 bits can speed some programs by 2% or more.  Note that some mathematical
13089 libraries assume that extended precision (80 bit) floating-point operations
13090 are enabled by default; routines in such libraries could suffer significant
13091 loss of accuracy, typically through so-called "catastrophic cancellation",
13092 when this option is used to set the precision to less than extended precision.
13093
13094 @item -mstackrealign
13095 @opindex mstackrealign
13096 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
13097 option will generate an alternate prologue and epilogue that realigns the
13098 runtime stack if necessary.  This supports mixing legacy codes that keep
13099 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
13100 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
13101 applicable to individual functions.
13102
13103 @item -mpreferred-stack-boundary=@var{num}
13104 @opindex mpreferred-stack-boundary
13105 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
13106 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
13107 the default is 4 (16 bytes or 128 bits).
13108
13109 @item -mincoming-stack-boundary=@var{num}
13110 @opindex mincoming-stack-boundary
13111 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
13112 boundary.  If @option{-mincoming-stack-boundary} is not specified,
13113 the one specified by @option{-mpreferred-stack-boundary} will be used.
13114
13115 On Pentium and PentiumPro, @code{double} and @code{long double} values
13116 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
13117 suffer significant run time performance penalties.  On Pentium III, the
13118 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
13119 properly if it is not 16 byte aligned.
13120
13121 To ensure proper alignment of this values on the stack, the stack boundary
13122 must be as aligned as that required by any value stored on the stack.
13123 Further, every function must be generated such that it keeps the stack
13124 aligned.  Thus calling a function compiled with a higher preferred
13125 stack boundary from a function compiled with a lower preferred stack
13126 boundary will most likely misalign the stack.  It is recommended that
13127 libraries that use callbacks always use the default setting.
13128
13129 This extra alignment does consume extra stack space, and generally
13130 increases code size.  Code that is sensitive to stack space usage, such
13131 as embedded systems and operating system kernels, may want to reduce the
13132 preferred alignment to @option{-mpreferred-stack-boundary=2}.
13133
13134 @item -mmmx
13135 @itemx -mno-mmx
13136 @itemx -msse
13137 @itemx -mno-sse
13138 @itemx -msse2
13139 @itemx -mno-sse2
13140 @itemx -msse3
13141 @itemx -mno-sse3
13142 @itemx -mssse3
13143 @itemx -mno-ssse3
13144 @itemx -msse4.1
13145 @need 800
13146 @itemx -mno-sse4.1
13147 @itemx -msse4.2
13148 @itemx -mno-sse4.2
13149 @itemx -msse4
13150 @itemx -mno-sse4
13151 @itemx -mavx
13152 @itemx -mno-avx
13153 @itemx -mavx2
13154 @itemx -mno-avx2
13155 @itemx -maes
13156 @itemx -mno-aes
13157 @itemx -mpclmul
13158 @need 800
13159 @itemx -mno-pclmul
13160 @itemx -mfsgsbase
13161 @itemx -mno-fsgsbase
13162 @itemx -mrdrnd
13163 @itemx -mno-rdrnd
13164 @itemx -mf16c
13165 @itemx -mno-f16c
13166 @itemx -mfma
13167 @itemx -mno-fma
13168 @itemx -msse4a
13169 @itemx -mno-sse4a
13170 @itemx -mfma4
13171 @need 800
13172 @itemx -mno-fma4
13173 @itemx -mxop
13174 @itemx -mno-xop
13175 @itemx -mlwp
13176 @itemx -mno-lwp
13177 @itemx -m3dnow
13178 @itemx -mno-3dnow
13179 @itemx -mpopcnt
13180 @itemx -mno-popcnt
13181 @itemx -mabm
13182 @itemx -mno-abm
13183 @itemx -mbmi
13184 @itemx -mbmi2
13185 @itemx -mno-bmi
13186 @itemx -mno-bmi2
13187 @itemx -mlzcnt
13188 @itemx -mno-lzcnt
13189 @itemx -mtbm
13190 @itemx -mno-tbm
13191 @opindex mmmx
13192 @opindex mno-mmx
13193 @opindex msse
13194 @opindex mno-sse
13195 @opindex m3dnow
13196 @opindex mno-3dnow
13197 These switches enable or disable the use of instructions in the MMX, SSE,
13198 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
13199 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT or 3DNow!
13200 @: extended instruction sets.
13201 These extensions are also available as built-in functions: see
13202 @ref{X86 Built-in Functions}, for details of the functions enabled and
13203 disabled by these switches.
13204
13205 To have SSE/SSE2 instructions generated automatically from floating-point
13206 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
13207
13208 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
13209 generates new AVX instructions or AVX equivalence for all SSEx instructions
13210 when needed.
13211
13212 These options will enable GCC to use these extended instructions in
13213 generated code, even without @option{-mfpmath=sse}.  Applications which
13214 perform runtime CPU detection must compile separate files for each
13215 supported architecture, using the appropriate flags.  In particular,
13216 the file containing the CPU detection code should be compiled without
13217 these options.
13218
13219 @item -mcld
13220 @opindex mcld
13221 This option instructs GCC to emit a @code{cld} instruction in the prologue
13222 of functions that use string instructions.  String instructions depend on
13223 the DF flag to select between autoincrement or autodecrement mode.  While the
13224 ABI specifies the DF flag to be cleared on function entry, some operating
13225 systems violate this specification by not clearing the DF flag in their
13226 exception dispatchers.  The exception handler can be invoked with the DF flag
13227 set which leads to wrong direction mode, when string instructions are used.
13228 This option can be enabled by default on 32-bit x86 targets by configuring
13229 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
13230 instructions can be suppressed with the @option{-mno-cld} compiler option
13231 in this case.
13232
13233 @item -mvzeroupper
13234 @opindex mvzeroupper
13235 This option instructs GCC to emit a @code{vzeroupper} instruction
13236 before a transfer of control flow out of the function to minimize
13237 AVX to SSE transition penalty as well as remove unnecessary zeroupper
13238 intrinsics.
13239
13240 @item -mcx16
13241 @opindex mcx16
13242 This option will enable GCC to use CMPXCHG16B instruction in generated code.
13243 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
13244 data types.  This is useful for high resolution counters that could be updated
13245 by multiple processors (or cores).  This instruction is generated as part of
13246 atomic built-in functions: see @ref{__sync Builtins} or
13247 @ref{__atomic Builtins} for details.
13248
13249 @item -msahf
13250 @opindex msahf
13251 This option will enable GCC to use SAHF instruction in generated 64-bit code.
13252 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
13253 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
13254 SAHF are load and store instructions, respectively, for certain status flags.
13255 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
13256 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
13257
13258 @item -mmovbe
13259 @opindex mmovbe
13260 This option will enable GCC to use movbe instruction to implement
13261 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
13262
13263 @item -mcrc32
13264 @opindex mcrc32
13265 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
13266 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
13267 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
13268
13269 @item -mrecip
13270 @opindex mrecip
13271 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
13272 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
13273 to increase precision instead of DIVSS and SQRTSS (and their vectorized
13274 variants) for single precision floating point arguments.  These instructions
13275 are generated only when @option{-funsafe-math-optimizations} is enabled
13276 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
13277 Note that while the throughput of the sequence is higher than the throughput
13278 of the non-reciprocal instruction, the precision of the sequence can be
13279 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
13280
13281 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of RSQRTSS
13282 (or RSQRTPS) already with @option{-ffast-math} (or the above option
13283 combination), and doesn't need @option{-mrecip}.
13284
13285 Also note that GCC emits the above sequence with additional Newton-Raphson step
13286 for vectorized single float division and vectorized @code{sqrtf(@var{x})}
13287 already with @option{-ffast-math} (or the above option combination), and
13288 doesn't need @option{-mrecip}.
13289
13290 @item -mrecip=@var{opt}
13291 @opindex mrecip=opt
13292 This option allows to control which reciprocal estimate instructions
13293 may be used.  @var{opt} is a comma separated list of options, that may
13294 be preceded by a @code{!} to invert the option:
13295 @code{all}: enable all estimate instructions,
13296 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
13297 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip},
13298 @code{div}: enable the approximation for scalar division,
13299 @code{vec-div}: enable the approximation for vectorized division,
13300 @code{sqrt}: enable the approximation for scalar square root,
13301 @code{vec-sqrt}: enable the approximation for vectorized square root.
13302
13303 So for example, @option{-mrecip=all,!sqrt} would enable
13304 all of the reciprocal approximations, except for square root.
13305
13306 @item -mveclibabi=@var{type}
13307 @opindex mveclibabi
13308 Specifies the ABI type to use for vectorizing intrinsics using an
13309 external library.  Supported types are @code{svml} for the Intel short
13310 vector math library and @code{acml} for the AMD math core library style
13311 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
13312 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
13313 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
13314 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
13315 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
13316 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
13317 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
13318 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
13319 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
13320 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
13321 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
13322 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
13323 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
13324 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
13325 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
13326 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
13327 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
13328 compatible library will have to be specified at link time.
13329
13330 @item -mabi=@var{name}
13331 @opindex mabi
13332 Generate code for the specified calling convention.  Permissible values
13333 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
13334 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
13335 ABI when targeting Windows.  On all other systems, the default is the
13336 SYSV ABI.  You can control this behavior for a specific function by
13337 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
13338 @xref{Function Attributes}.
13339
13340 @item -mtls-dialect=@var{type}
13341 @opindex mtls-dialect
13342 Generate code to access thread-local storage using the @samp{gnu} or
13343 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
13344 @samp{gnu2} is more efficient, but it may add compile- and run-time
13345 requirements that cannot be satisfied on all systems.
13346
13347 @item -mpush-args
13348 @itemx -mno-push-args
13349 @opindex mpush-args
13350 @opindex mno-push-args
13351 Use PUSH operations to store outgoing parameters.  This method is shorter
13352 and usually equally fast as method using SUB/MOV operations and is enabled
13353 by default.  In some cases disabling it may improve performance because of
13354 improved scheduling and reduced dependencies.
13355
13356 @item -maccumulate-outgoing-args
13357 @opindex maccumulate-outgoing-args
13358 If enabled, the maximum amount of space required for outgoing arguments will be
13359 computed in the function prologue.  This is faster on most modern CPUs
13360 because of reduced dependencies, improved scheduling and reduced stack usage
13361 when preferred stack boundary is not equal to 2.  The drawback is a notable
13362 increase in code size.  This switch implies @option{-mno-push-args}.
13363
13364 @item -mthreads
13365 @opindex mthreads
13366 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
13367 on thread-safe exception handling must compile and link all code with the
13368 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
13369 @option{-D_MT}; when linking, it links in a special thread helper library
13370 @option{-lmingwthrd} which cleans up per thread exception handling data.
13371
13372 @item -mno-align-stringops
13373 @opindex mno-align-stringops
13374 Do not align destination of inlined string operations.  This switch reduces
13375 code size and improves performance in case the destination is already aligned,
13376 but GCC doesn't know about it.
13377
13378 @item -minline-all-stringops
13379 @opindex minline-all-stringops
13380 By default GCC inlines string operations only when destination is known to be
13381 aligned at least to 4 byte boundary.  This enables more inlining, increase code
13382 size, but may improve performance of code that depends on fast memcpy, strlen
13383 and memset for short lengths.
13384
13385 @item -minline-stringops-dynamically
13386 @opindex minline-stringops-dynamically
13387 For string operation of unknown size, inline runtime checks so for small
13388 blocks inline code is used, while for large blocks library call is used.
13389
13390 @item -mstringop-strategy=@var{alg}
13391 @opindex mstringop-strategy=@var{alg}
13392 Overwrite internal decision heuristic about particular algorithm to inline
13393 string operation with.  The allowed values are @code{rep_byte},
13394 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
13395 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
13396 expanding inline loop, @code{libcall} for always expanding library call.
13397
13398 @item -momit-leaf-frame-pointer
13399 @opindex momit-leaf-frame-pointer
13400 Don't keep the frame pointer in a register for leaf functions.  This
13401 avoids the instructions to save, set up and restore frame pointers and
13402 makes an extra register available in leaf functions.  The option
13403 @option{-fomit-frame-pointer} removes the frame pointer for all functions
13404 which might make debugging harder.
13405
13406 @item -mtls-direct-seg-refs
13407 @itemx -mno-tls-direct-seg-refs
13408 @opindex mtls-direct-seg-refs
13409 Controls whether TLS variables may be accessed with offsets from the
13410 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
13411 or whether the thread base pointer must be added.  Whether or not this
13412 is legal depends on the operating system, and whether it maps the
13413 segment to cover the entire TLS area.
13414
13415 For systems that use GNU libc, the default is on.
13416
13417 @item -msse2avx
13418 @itemx -mno-sse2avx
13419 @opindex msse2avx
13420 Specify that the assembler should encode SSE instructions with VEX
13421 prefix.  The option @option{-mavx} turns this on by default.
13422
13423 @item -mfentry
13424 @itemx -mno-fentry
13425 @opindex mfentry
13426 If profiling is active @option{-pg} put the profiling
13427 counter call before prologue.
13428 Note: On x86 architectures the attribute @code{ms_hook_prologue}
13429 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
13430
13431 @item -m8bit-idiv
13432 @itemx -mno-8bit-idiv
13433 @opindex 8bit-idiv
13434 On some processors, like Intel Atom, 8bit unsigned integer divide is
13435 much faster than 32bit/64bit integer divide.  This option will generate a
13436 runt-time check.  If both dividend and divisor are within range of 0
13437 to 255, 8bit unsigned integer divide will be used instead of
13438 32bit/64bit integer divide.
13439
13440 @item -mavx256-split-unaligned-load
13441 @item -mavx256-split-unaligned-store
13442 @opindex avx256-split-unaligned-load
13443 @opindex avx256-split-unaligned-store
13444 Split 32-byte AVX unaligned load and store.
13445
13446 @end table
13447
13448 These @samp{-m} switches are supported in addition to the above
13449 on AMD x86-64 processors in 64-bit environments.
13450
13451 @table @gcctabopt
13452 @item -m32
13453 @itemx -m64
13454 @itemx -mx32
13455 @opindex m32
13456 @opindex m64
13457 @opindex mx32
13458 Generate code for a 32-bit or 64-bit environment.
13459 The @option{-m32} option sets int, long and pointer to 32 bits and
13460 generates code that runs on any i386 system.
13461 The @option{-m64} option sets int to 32 bits and long and pointer
13462 to 64 bits and generates code for AMD's x86-64 architecture.
13463 The @option{-mx32} option sets int, long and pointer to 32 bits and
13464 generates code for AMD's x86-64 architecture.
13465 For darwin only the @option{-m64} option turns off the @option{-fno-pic}
13466 and @option{-mdynamic-no-pic} options.
13467
13468 @item -mno-red-zone
13469 @opindex mno-red-zone
13470 Do not use a so called red zone for x86-64 code.  The red zone is mandated
13471 by the x86-64 ABI, it is a 128-byte area beyond the location of the
13472 stack pointer that will not be modified by signal or interrupt handlers
13473 and therefore can be used for temporary data without adjusting the stack
13474 pointer.  The flag @option{-mno-red-zone} disables this red zone.
13475
13476 @item -mcmodel=small
13477 @opindex mcmodel=small
13478 Generate code for the small code model: the program and its symbols must
13479 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
13480 Programs can be statically or dynamically linked.  This is the default
13481 code model.
13482
13483 @item -mcmodel=kernel
13484 @opindex mcmodel=kernel
13485 Generate code for the kernel code model.  The kernel runs in the
13486 negative 2 GB of the address space.
13487 This model has to be used for Linux kernel code.
13488
13489 @item -mcmodel=medium
13490 @opindex mcmodel=medium
13491 Generate code for the medium model: The program is linked in the lower 2
13492 GB of the address space.  Small symbols are also placed there.  Symbols
13493 with sizes larger than @option{-mlarge-data-threshold} are put into
13494 large data or bss sections and can be located above 2GB.  Programs can
13495 be statically or dynamically linked.
13496
13497 @item -mcmodel=large
13498 @opindex mcmodel=large
13499 Generate code for the large model: This model makes no assumptions
13500 about addresses and sizes of sections.
13501 @end table
13502
13503 @node i386 and x86-64 Windows Options
13504 @subsection i386 and x86-64 Windows Options
13505 @cindex i386 and x86-64 Windows Options
13506
13507 These additional options are available for Windows targets:
13508
13509 @table @gcctabopt
13510 @item -mconsole
13511 @opindex mconsole
13512 This option is available for Cygwin and MinGW targets.  It
13513 specifies that a console application is to be generated, by
13514 instructing the linker to set the PE header subsystem type
13515 required for console applications.
13516 This is the default behavior for Cygwin and MinGW targets.
13517
13518 @item -mdll
13519 @opindex mdll
13520 This option is available for Cygwin and MinGW targets.  It
13521 specifies that a DLL - a dynamic link library - is to be
13522 generated, enabling the selection of the required runtime
13523 startup object and entry point.
13524
13525 @item -mnop-fun-dllimport
13526 @opindex mnop-fun-dllimport
13527 This option is available for Cygwin and MinGW targets.  It
13528 specifies that the dllimport attribute should be ignored.
13529
13530 @item -mthread
13531 @opindex mthread
13532 This option is available for MinGW targets. It specifies
13533 that MinGW-specific thread support is to be used.
13534
13535 @item -municode
13536 @opindex municode
13537 This option is available for mingw-w64 targets.  It specifies
13538 that the UNICODE macro is getting pre-defined and that the
13539 unicode capable runtime startup code is chosen.
13540
13541 @item -mwin32
13542 @opindex mwin32
13543 This option is available for Cygwin and MinGW targets.  It
13544 specifies that the typical Windows pre-defined macros are to
13545 be set in the pre-processor, but does not influence the choice
13546 of runtime library/startup code.
13547
13548 @item -mwindows
13549 @opindex mwindows
13550 This option is available for Cygwin and MinGW targets.  It
13551 specifies that a GUI application is to be generated by
13552 instructing the linker to set the PE header subsystem type
13553 appropriately.
13554
13555 @item -fno-set-stack-executable
13556 @opindex fno-set-stack-executable
13557 This option is available for MinGW targets. It specifies that
13558 the executable flag for stack used by nested functions isn't
13559 set. This is necessary for binaries running in kernel mode of
13560 Windows, as there the user32 API, which is used to set executable
13561 privileges, isn't available.
13562
13563 @item -mpe-aligned-commons
13564 @opindex mpe-aligned-commons
13565 This option is available for Cygwin and MinGW targets.  It
13566 specifies that the GNU extension to the PE file format that
13567 permits the correct alignment of COMMON variables should be
13568 used when generating code.  It will be enabled by default if
13569 GCC detects that the target assembler found during configuration
13570 supports the feature.
13571 @end table
13572
13573 See also under @ref{i386 and x86-64 Options} for standard options.
13574
13575 @node IA-64 Options
13576 @subsection IA-64 Options
13577 @cindex IA-64 Options
13578
13579 These are the @samp{-m} options defined for the Intel IA-64 architecture.
13580
13581 @table @gcctabopt
13582 @item -mbig-endian
13583 @opindex mbig-endian
13584 Generate code for a big endian target.  This is the default for HP-UX@.
13585
13586 @item -mlittle-endian
13587 @opindex mlittle-endian
13588 Generate code for a little endian target.  This is the default for AIX5
13589 and GNU/Linux.
13590
13591 @item -mgnu-as
13592 @itemx -mno-gnu-as
13593 @opindex mgnu-as
13594 @opindex mno-gnu-as
13595 Generate (or don't) code for the GNU assembler.  This is the default.
13596 @c Also, this is the default if the configure option @option{--with-gnu-as}
13597 @c is used.
13598
13599 @item -mgnu-ld
13600 @itemx -mno-gnu-ld
13601 @opindex mgnu-ld
13602 @opindex mno-gnu-ld
13603 Generate (or don't) code for the GNU linker.  This is the default.
13604 @c Also, this is the default if the configure option @option{--with-gnu-ld}
13605 @c is used.
13606
13607 @item -mno-pic
13608 @opindex mno-pic
13609 Generate code that does not use a global pointer register.  The result
13610 is not position independent code, and violates the IA-64 ABI@.
13611
13612 @item -mvolatile-asm-stop
13613 @itemx -mno-volatile-asm-stop
13614 @opindex mvolatile-asm-stop
13615 @opindex mno-volatile-asm-stop
13616 Generate (or don't) a stop bit immediately before and after volatile asm
13617 statements.
13618
13619 @item -mregister-names
13620 @itemx -mno-register-names
13621 @opindex mregister-names
13622 @opindex mno-register-names
13623 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
13624 the stacked registers.  This may make assembler output more readable.
13625
13626 @item -mno-sdata
13627 @itemx -msdata
13628 @opindex mno-sdata
13629 @opindex msdata
13630 Disable (or enable) optimizations that use the small data section.  This may
13631 be useful for working around optimizer bugs.
13632
13633 @item -mconstant-gp
13634 @opindex mconstant-gp
13635 Generate code that uses a single constant global pointer value.  This is
13636 useful when compiling kernel code.
13637
13638 @item -mauto-pic
13639 @opindex mauto-pic
13640 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
13641 This is useful when compiling firmware code.
13642
13643 @item -minline-float-divide-min-latency
13644 @opindex minline-float-divide-min-latency
13645 Generate code for inline divides of floating point values
13646 using the minimum latency algorithm.
13647
13648 @item -minline-float-divide-max-throughput
13649 @opindex minline-float-divide-max-throughput
13650 Generate code for inline divides of floating point values
13651 using the maximum throughput algorithm.
13652
13653 @item -mno-inline-float-divide
13654 @opindex mno-inline-float-divide
13655 Do not generate inline code for divides of floating point values.
13656
13657 @item -minline-int-divide-min-latency
13658 @opindex minline-int-divide-min-latency
13659 Generate code for inline divides of integer values
13660 using the minimum latency algorithm.
13661
13662 @item -minline-int-divide-max-throughput
13663 @opindex minline-int-divide-max-throughput
13664 Generate code for inline divides of integer values
13665 using the maximum throughput algorithm.
13666
13667 @item -mno-inline-int-divide
13668 @opindex mno-inline-int-divide
13669 Do not generate inline code for divides of integer values.
13670
13671 @item -minline-sqrt-min-latency
13672 @opindex minline-sqrt-min-latency
13673 Generate code for inline square roots
13674 using the minimum latency algorithm.
13675
13676 @item -minline-sqrt-max-throughput
13677 @opindex minline-sqrt-max-throughput
13678 Generate code for inline square roots
13679 using the maximum throughput algorithm.
13680
13681 @item -mno-inline-sqrt
13682 @opindex mno-inline-sqrt
13683 Do not generate inline code for sqrt.
13684
13685 @item -mfused-madd
13686 @itemx -mno-fused-madd
13687 @opindex mfused-madd
13688 @opindex mno-fused-madd
13689 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
13690 instructions.  The default is to use these instructions.
13691
13692 @item -mno-dwarf2-asm
13693 @itemx -mdwarf2-asm
13694 @opindex mno-dwarf2-asm
13695 @opindex mdwarf2-asm
13696 Don't (or do) generate assembler code for the DWARF2 line number debugging
13697 info.  This may be useful when not using the GNU assembler.
13698
13699 @item -mearly-stop-bits
13700 @itemx -mno-early-stop-bits
13701 @opindex mearly-stop-bits
13702 @opindex mno-early-stop-bits
13703 Allow stop bits to be placed earlier than immediately preceding the
13704 instruction that triggered the stop bit.  This can improve instruction
13705 scheduling, but does not always do so.
13706
13707 @item -mfixed-range=@var{register-range}
13708 @opindex mfixed-range
13709 Generate code treating the given register range as fixed registers.
13710 A fixed register is one that the register allocator can not use.  This is
13711 useful when compiling kernel code.  A register range is specified as
13712 two registers separated by a dash.  Multiple register ranges can be
13713 specified separated by a comma.
13714
13715 @item -mtls-size=@var{tls-size}
13716 @opindex mtls-size
13717 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
13718 64.
13719
13720 @item -mtune=@var{cpu-type}
13721 @opindex mtune
13722 Tune the instruction scheduling for a particular CPU, Valid values are
13723 itanium, itanium1, merced, itanium2, and mckinley.
13724
13725 @item -milp32
13726 @itemx -mlp64
13727 @opindex milp32
13728 @opindex mlp64
13729 Generate code for a 32-bit or 64-bit environment.
13730 The 32-bit environment sets int, long and pointer to 32 bits.
13731 The 64-bit environment sets int to 32 bits and long and pointer
13732 to 64 bits.  These are HP-UX specific flags.
13733
13734 @item -mno-sched-br-data-spec
13735 @itemx -msched-br-data-spec
13736 @opindex mno-sched-br-data-spec
13737 @opindex msched-br-data-spec
13738 (Dis/En)able data speculative scheduling before reload.
13739 This will result in generation of the ld.a instructions and
13740 the corresponding check instructions (ld.c / chk.a).
13741 The default is 'disable'.
13742
13743 @item -msched-ar-data-spec
13744 @itemx -mno-sched-ar-data-spec
13745 @opindex msched-ar-data-spec
13746 @opindex mno-sched-ar-data-spec
13747 (En/Dis)able data speculative scheduling after reload.
13748 This will result in generation of the ld.a instructions and
13749 the corresponding check instructions (ld.c / chk.a).
13750 The default is 'enable'.
13751
13752 @item -mno-sched-control-spec
13753 @itemx -msched-control-spec
13754 @opindex mno-sched-control-spec
13755 @opindex msched-control-spec
13756 (Dis/En)able control speculative scheduling.  This feature is
13757 available only during region scheduling (i.e.@: before reload).
13758 This will result in generation of the ld.s instructions and
13759 the corresponding check instructions chk.s .
13760 The default is 'disable'.
13761
13762 @item -msched-br-in-data-spec
13763 @itemx -mno-sched-br-in-data-spec
13764 @opindex msched-br-in-data-spec
13765 @opindex mno-sched-br-in-data-spec
13766 (En/Dis)able speculative scheduling of the instructions that
13767 are dependent on the data speculative loads before reload.
13768 This is effective only with @option{-msched-br-data-spec} enabled.
13769 The default is 'enable'.
13770
13771 @item -msched-ar-in-data-spec
13772 @itemx -mno-sched-ar-in-data-spec
13773 @opindex msched-ar-in-data-spec
13774 @opindex mno-sched-ar-in-data-spec
13775 (En/Dis)able speculative scheduling of the instructions that
13776 are dependent on the data speculative loads after reload.
13777 This is effective only with @option{-msched-ar-data-spec} enabled.
13778 The default is 'enable'.
13779
13780 @item -msched-in-control-spec
13781 @itemx -mno-sched-in-control-spec
13782 @opindex msched-in-control-spec
13783 @opindex mno-sched-in-control-spec
13784 (En/Dis)able speculative scheduling of the instructions that
13785 are dependent on the control speculative loads.
13786 This is effective only with @option{-msched-control-spec} enabled.
13787 The default is 'enable'.
13788
13789 @item -mno-sched-prefer-non-data-spec-insns
13790 @itemx -msched-prefer-non-data-spec-insns
13791 @opindex mno-sched-prefer-non-data-spec-insns
13792 @opindex msched-prefer-non-data-spec-insns
13793 If enabled, data speculative instructions will be chosen for schedule
13794 only if there are no other choices at the moment.  This will make
13795 the use of the data speculation much more conservative.
13796 The default is 'disable'.
13797
13798 @item -mno-sched-prefer-non-control-spec-insns
13799 @itemx -msched-prefer-non-control-spec-insns
13800 @opindex mno-sched-prefer-non-control-spec-insns
13801 @opindex msched-prefer-non-control-spec-insns
13802 If enabled, control speculative instructions will be chosen for schedule
13803 only if there are no other choices at the moment.  This will make
13804 the use of the control speculation much more conservative.
13805 The default is 'disable'.
13806
13807 @item -mno-sched-count-spec-in-critical-path
13808 @itemx -msched-count-spec-in-critical-path
13809 @opindex mno-sched-count-spec-in-critical-path
13810 @opindex msched-count-spec-in-critical-path
13811 If enabled, speculative dependencies will be considered during
13812 computation of the instructions priorities.  This will make the use of the
13813 speculation a bit more conservative.
13814 The default is 'disable'.
13815
13816 @item -msched-spec-ldc
13817 @opindex msched-spec-ldc
13818 Use a simple data speculation check.  This option is on by default.
13819
13820 @item -msched-control-spec-ldc
13821 @opindex msched-spec-ldc
13822 Use a simple check for control speculation.  This option is on by default.
13823
13824 @item -msched-stop-bits-after-every-cycle
13825 @opindex msched-stop-bits-after-every-cycle
13826 Place a stop bit after every cycle when scheduling.  This option is on
13827 by default.
13828
13829 @item -msched-fp-mem-deps-zero-cost
13830 @opindex msched-fp-mem-deps-zero-cost
13831 Assume that floating-point stores and loads are not likely to cause a conflict
13832 when placed into the same instruction group.  This option is disabled by
13833 default.
13834
13835 @item -msel-sched-dont-check-control-spec
13836 @opindex msel-sched-dont-check-control-spec
13837 Generate checks for control speculation in selective scheduling.
13838 This flag is disabled by default.
13839
13840 @item -msched-max-memory-insns=@var{max-insns}
13841 @opindex msched-max-memory-insns
13842 Limit on the number of memory insns per instruction group, giving lower
13843 priority to subsequent memory insns attempting to schedule in the same
13844 instruction group. Frequently useful to prevent cache bank conflicts.
13845 The default value is 1.
13846
13847 @item -msched-max-memory-insns-hard-limit
13848 @opindex msched-max-memory-insns-hard-limit
13849 Disallow more than `msched-max-memory-insns' in instruction group.
13850 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
13851 when limit is reached but may still schedule memory operations.
13852
13853 @end table
13854
13855 @node IA-64/VMS Options
13856 @subsection IA-64/VMS Options
13857
13858 These @samp{-m} options are defined for the IA-64/VMS implementations:
13859
13860 @table @gcctabopt
13861 @item -mvms-return-codes
13862 @opindex mvms-return-codes
13863 Return VMS condition codes from main. The default is to return POSIX
13864 style condition (e.g.@ error) codes.
13865
13866 @item -mdebug-main=@var{prefix}
13867 @opindex mdebug-main=@var{prefix}
13868 Flag the first routine whose name starts with @var{prefix} as the main
13869 routine for the debugger.
13870
13871 @item -mmalloc64
13872 @opindex mmalloc64
13873 Default to 64bit memory allocation routines.
13874 @end table
13875
13876 @node LM32 Options
13877 @subsection LM32 Options
13878 @cindex LM32 options
13879
13880 These @option{-m} options are defined for the Lattice Mico32 architecture:
13881
13882 @table @gcctabopt
13883 @item -mbarrel-shift-enabled
13884 @opindex mbarrel-shift-enabled
13885 Enable barrel-shift instructions.
13886
13887 @item -mdivide-enabled
13888 @opindex mdivide-enabled
13889 Enable divide and modulus instructions.
13890
13891 @item -mmultiply-enabled
13892 @opindex multiply-enabled
13893 Enable multiply instructions.
13894
13895 @item -msign-extend-enabled
13896 @opindex msign-extend-enabled
13897 Enable sign extend instructions.
13898
13899 @item -muser-enabled
13900 @opindex muser-enabled
13901 Enable user-defined instructions.
13902
13903 @end table
13904
13905 @node M32C Options
13906 @subsection M32C Options
13907 @cindex M32C options
13908
13909 @table @gcctabopt
13910 @item -mcpu=@var{name}
13911 @opindex mcpu=
13912 Select the CPU for which code is generated.  @var{name} may be one of
13913 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
13914 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
13915 the M32C/80 series.
13916
13917 @item -msim
13918 @opindex msim
13919 Specifies that the program will be run on the simulator.  This causes
13920 an alternate runtime library to be linked in which supports, for
13921 example, file I/O@.  You must not use this option when generating
13922 programs that will run on real hardware; you must provide your own
13923 runtime library for whatever I/O functions are needed.
13924
13925 @item -memregs=@var{number}
13926 @opindex memregs=
13927 Specifies the number of memory-based pseudo-registers GCC will use
13928 during code generation.  These pseudo-registers will be used like real
13929 registers, so there is a tradeoff between GCC's ability to fit the
13930 code into available registers, and the performance penalty of using
13931 memory instead of registers.  Note that all modules in a program must
13932 be compiled with the same value for this option.  Because of that, you
13933 must not use this option with the default runtime libraries gcc
13934 builds.
13935
13936 @end table
13937
13938 @node M32R/D Options
13939 @subsection M32R/D Options
13940 @cindex M32R/D options
13941
13942 These @option{-m} options are defined for Renesas M32R/D architectures:
13943
13944 @table @gcctabopt
13945 @item -m32r2
13946 @opindex m32r2
13947 Generate code for the M32R/2@.
13948
13949 @item -m32rx
13950 @opindex m32rx
13951 Generate code for the M32R/X@.
13952
13953 @item -m32r
13954 @opindex m32r
13955 Generate code for the M32R@.  This is the default.
13956
13957 @item -mmodel=small
13958 @opindex mmodel=small
13959 Assume all objects live in the lower 16MB of memory (so that their addresses
13960 can be loaded with the @code{ld24} instruction), and assume all subroutines
13961 are reachable with the @code{bl} instruction.
13962 This is the default.
13963
13964 The addressability of a particular object can be set with the
13965 @code{model} attribute.
13966
13967 @item -mmodel=medium
13968 @opindex mmodel=medium
13969 Assume objects may be anywhere in the 32-bit address space (the compiler
13970 will generate @code{seth/add3} instructions to load their addresses), and
13971 assume all subroutines are reachable with the @code{bl} instruction.
13972
13973 @item -mmodel=large
13974 @opindex mmodel=large
13975 Assume objects may be anywhere in the 32-bit address space (the compiler
13976 will generate @code{seth/add3} instructions to load their addresses), and
13977 assume subroutines may not be reachable with the @code{bl} instruction
13978 (the compiler will generate the much slower @code{seth/add3/jl}
13979 instruction sequence).
13980
13981 @item -msdata=none
13982 @opindex msdata=none
13983 Disable use of the small data area.  Variables will be put into
13984 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
13985 @code{section} attribute has been specified).
13986 This is the default.
13987
13988 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
13989 Objects may be explicitly put in the small data area with the
13990 @code{section} attribute using one of these sections.
13991
13992 @item -msdata=sdata
13993 @opindex msdata=sdata
13994 Put small global and static data in the small data area, but do not
13995 generate special code to reference them.
13996
13997 @item -msdata=use
13998 @opindex msdata=use
13999 Put small global and static data in the small data area, and generate
14000 special instructions to reference them.
14001
14002 @item -G @var{num}
14003 @opindex G
14004 @cindex smaller data references
14005 Put global and static objects less than or equal to @var{num} bytes
14006 into the small data or bss sections instead of the normal data or bss
14007 sections.  The default value of @var{num} is 8.
14008 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
14009 for this option to have any effect.
14010
14011 All modules should be compiled with the same @option{-G @var{num}} value.
14012 Compiling with different values of @var{num} may or may not work; if it
14013 doesn't the linker will give an error message---incorrect code will not be
14014 generated.
14015
14016 @item -mdebug
14017 @opindex mdebug
14018 Makes the M32R specific code in the compiler display some statistics
14019 that might help in debugging programs.
14020
14021 @item -malign-loops
14022 @opindex malign-loops
14023 Align all loops to a 32-byte boundary.
14024
14025 @item -mno-align-loops
14026 @opindex mno-align-loops
14027 Do not enforce a 32-byte alignment for loops.  This is the default.
14028
14029 @item -missue-rate=@var{number}
14030 @opindex missue-rate=@var{number}
14031 Issue @var{number} instructions per cycle.  @var{number} can only be 1
14032 or 2.
14033
14034 @item -mbranch-cost=@var{number}
14035 @opindex mbranch-cost=@var{number}
14036 @var{number} can only be 1 or 2.  If it is 1 then branches will be
14037 preferred over conditional code, if it is 2, then the opposite will
14038 apply.
14039
14040 @item -mflush-trap=@var{number}
14041 @opindex mflush-trap=@var{number}
14042 Specifies the trap number to use to flush the cache.  The default is
14043 12.  Valid numbers are between 0 and 15 inclusive.
14044
14045 @item -mno-flush-trap
14046 @opindex mno-flush-trap
14047 Specifies that the cache cannot be flushed by using a trap.
14048
14049 @item -mflush-func=@var{name}
14050 @opindex mflush-func=@var{name}
14051 Specifies the name of the operating system function to call to flush
14052 the cache.  The default is @emph{_flush_cache}, but a function call
14053 will only be used if a trap is not available.
14054
14055 @item -mno-flush-func
14056 @opindex mno-flush-func
14057 Indicates that there is no OS function for flushing the cache.
14058
14059 @end table
14060
14061 @node M680x0 Options
14062 @subsection M680x0 Options
14063 @cindex M680x0 options
14064
14065 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
14066 The default settings depend on which architecture was selected when
14067 the compiler was configured; the defaults for the most common choices
14068 are given below.
14069
14070 @table @gcctabopt
14071 @item -march=@var{arch}
14072 @opindex march
14073 Generate code for a specific M680x0 or ColdFire instruction set
14074 architecture.  Permissible values of @var{arch} for M680x0
14075 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
14076 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
14077 architectures are selected according to Freescale's ISA classification
14078 and the permissible values are: @samp{isaa}, @samp{isaaplus},
14079 @samp{isab} and @samp{isac}.
14080
14081 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
14082 code for a ColdFire target.  The @var{arch} in this macro is one of the
14083 @option{-march} arguments given above.
14084
14085 When used together, @option{-march} and @option{-mtune} select code
14086 that runs on a family of similar processors but that is optimized
14087 for a particular microarchitecture.
14088
14089 @item -mcpu=@var{cpu}
14090 @opindex mcpu
14091 Generate code for a specific M680x0 or ColdFire processor.
14092 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
14093 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
14094 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
14095 below, which also classifies the CPUs into families:
14096
14097 @multitable @columnfractions 0.20 0.80
14098 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
14099 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
14100 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
14101 @item @samp{5206e} @tab @samp{5206e}
14102 @item @samp{5208} @tab @samp{5207} @samp{5208}
14103 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
14104 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
14105 @item @samp{5216} @tab @samp{5214} @samp{5216}
14106 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
14107 @item @samp{5225} @tab @samp{5224} @samp{5225}
14108 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
14109 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
14110 @item @samp{5249} @tab @samp{5249}
14111 @item @samp{5250} @tab @samp{5250}
14112 @item @samp{5271} @tab @samp{5270} @samp{5271}
14113 @item @samp{5272} @tab @samp{5272}
14114 @item @samp{5275} @tab @samp{5274} @samp{5275}
14115 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
14116 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
14117 @item @samp{5307} @tab @samp{5307}
14118 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
14119 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
14120 @item @samp{5407} @tab @samp{5407}
14121 @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}
14122 @end multitable
14123
14124 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
14125 @var{arch} is compatible with @var{cpu}.  Other combinations of
14126 @option{-mcpu} and @option{-march} are rejected.
14127
14128 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
14129 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
14130 where the value of @var{family} is given by the table above.
14131
14132 @item -mtune=@var{tune}
14133 @opindex mtune
14134 Tune the code for a particular microarchitecture, within the
14135 constraints set by @option{-march} and @option{-mcpu}.
14136 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
14137 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
14138 and @samp{cpu32}.  The ColdFire microarchitectures
14139 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
14140
14141 You can also use @option{-mtune=68020-40} for code that needs
14142 to run relatively well on 68020, 68030 and 68040 targets.
14143 @option{-mtune=68020-60} is similar but includes 68060 targets
14144 as well.  These two options select the same tuning decisions as
14145 @option{-m68020-40} and @option{-m68020-60} respectively.
14146
14147 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
14148 when tuning for 680x0 architecture @var{arch}.  It also defines
14149 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
14150 option is used.  If gcc is tuning for a range of architectures,
14151 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
14152 it defines the macros for every architecture in the range.
14153
14154 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
14155 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
14156 of the arguments given above.
14157
14158 @item -m68000
14159 @itemx -mc68000
14160 @opindex m68000
14161 @opindex mc68000
14162 Generate output for a 68000.  This is the default
14163 when the compiler is configured for 68000-based systems.
14164 It is equivalent to @option{-march=68000}.
14165
14166 Use this option for microcontrollers with a 68000 or EC000 core,
14167 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
14168
14169 @item -m68010
14170 @opindex m68010
14171 Generate output for a 68010.  This is the default
14172 when the compiler is configured for 68010-based systems.
14173 It is equivalent to @option{-march=68010}.
14174
14175 @item -m68020
14176 @itemx -mc68020
14177 @opindex m68020
14178 @opindex mc68020
14179 Generate output for a 68020.  This is the default
14180 when the compiler is configured for 68020-based systems.
14181 It is equivalent to @option{-march=68020}.
14182
14183 @item -m68030
14184 @opindex m68030
14185 Generate output for a 68030.  This is the default when the compiler is
14186 configured for 68030-based systems.  It is equivalent to
14187 @option{-march=68030}.
14188
14189 @item -m68040
14190 @opindex m68040
14191 Generate output for a 68040.  This is the default when the compiler is
14192 configured for 68040-based systems.  It is equivalent to
14193 @option{-march=68040}.
14194
14195 This option inhibits the use of 68881/68882 instructions that have to be
14196 emulated by software on the 68040.  Use this option if your 68040 does not
14197 have code to emulate those instructions.
14198
14199 @item -m68060
14200 @opindex m68060
14201 Generate output for a 68060.  This is the default when the compiler is
14202 configured for 68060-based systems.  It is equivalent to
14203 @option{-march=68060}.
14204
14205 This option inhibits the use of 68020 and 68881/68882 instructions that
14206 have to be emulated by software on the 68060.  Use this option if your 68060
14207 does not have code to emulate those instructions.
14208
14209 @item -mcpu32
14210 @opindex mcpu32
14211 Generate output for a CPU32.  This is the default
14212 when the compiler is configured for CPU32-based systems.
14213 It is equivalent to @option{-march=cpu32}.
14214
14215 Use this option for microcontrollers with a
14216 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
14217 68336, 68340, 68341, 68349 and 68360.
14218
14219 @item -m5200
14220 @opindex m5200
14221 Generate output for a 520X ColdFire CPU@.  This is the default
14222 when the compiler is configured for 520X-based systems.
14223 It is equivalent to @option{-mcpu=5206}, and is now deprecated
14224 in favor of that option.
14225
14226 Use this option for microcontroller with a 5200 core, including
14227 the MCF5202, MCF5203, MCF5204 and MCF5206.
14228
14229 @item -m5206e
14230 @opindex m5206e
14231 Generate output for a 5206e ColdFire CPU@.  The option is now
14232 deprecated in favor of the equivalent @option{-mcpu=5206e}.
14233
14234 @item -m528x
14235 @opindex m528x
14236 Generate output for a member of the ColdFire 528X family.
14237 The option is now deprecated in favor of the equivalent
14238 @option{-mcpu=528x}.
14239
14240 @item -m5307
14241 @opindex m5307
14242 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
14243 in favor of the equivalent @option{-mcpu=5307}.
14244
14245 @item -m5407
14246 @opindex m5407
14247 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
14248 in favor of the equivalent @option{-mcpu=5407}.
14249
14250 @item -mcfv4e
14251 @opindex mcfv4e
14252 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
14253 This includes use of hardware floating point instructions.
14254 The option is equivalent to @option{-mcpu=547x}, and is now
14255 deprecated in favor of that option.
14256
14257 @item -m68020-40
14258 @opindex m68020-40
14259 Generate output for a 68040, without using any of the new instructions.
14260 This results in code which can run relatively efficiently on either a
14261 68020/68881 or a 68030 or a 68040.  The generated code does use the
14262 68881 instructions that are emulated on the 68040.
14263
14264 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
14265
14266 @item -m68020-60
14267 @opindex m68020-60
14268 Generate output for a 68060, without using any of the new instructions.
14269 This results in code which can run relatively efficiently on either a
14270 68020/68881 or a 68030 or a 68040.  The generated code does use the
14271 68881 instructions that are emulated on the 68060.
14272
14273 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
14274
14275 @item -mhard-float
14276 @itemx -m68881
14277 @opindex mhard-float
14278 @opindex m68881
14279 Generate floating-point instructions.  This is the default for 68020
14280 and above, and for ColdFire devices that have an FPU@.  It defines the
14281 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
14282 on ColdFire targets.
14283
14284 @item -msoft-float
14285 @opindex msoft-float
14286 Do not generate floating-point instructions; use library calls instead.
14287 This is the default for 68000, 68010, and 68832 targets.  It is also
14288 the default for ColdFire devices that have no FPU.
14289
14290 @item -mdiv
14291 @itemx -mno-div
14292 @opindex mdiv
14293 @opindex mno-div
14294 Generate (do not generate) ColdFire hardware divide and remainder
14295 instructions.  If @option{-march} is used without @option{-mcpu},
14296 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
14297 architectures.  Otherwise, the default is taken from the target CPU
14298 (either the default CPU, or the one specified by @option{-mcpu}).  For
14299 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
14300 @option{-mcpu=5206e}.
14301
14302 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
14303
14304 @item -mshort
14305 @opindex mshort
14306 Consider type @code{int} to be 16 bits wide, like @code{short int}.
14307 Additionally, parameters passed on the stack are also aligned to a
14308 16-bit boundary even on targets whose API mandates promotion to 32-bit.
14309
14310 @item -mno-short
14311 @opindex mno-short
14312 Do not consider type @code{int} to be 16 bits wide.  This is the default.
14313
14314 @item -mnobitfield
14315 @itemx -mno-bitfield
14316 @opindex mnobitfield
14317 @opindex mno-bitfield
14318 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
14319 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
14320
14321 @item -mbitfield
14322 @opindex mbitfield
14323 Do use the bit-field instructions.  The @option{-m68020} option implies
14324 @option{-mbitfield}.  This is the default if you use a configuration
14325 designed for a 68020.
14326
14327 @item -mrtd
14328 @opindex mrtd
14329 Use a different function-calling convention, in which functions
14330 that take a fixed number of arguments return with the @code{rtd}
14331 instruction, which pops their arguments while returning.  This
14332 saves one instruction in the caller since there is no need to pop
14333 the arguments there.
14334
14335 This calling convention is incompatible with the one normally
14336 used on Unix, so you cannot use it if you need to call libraries
14337 compiled with the Unix compiler.
14338
14339 Also, you must provide function prototypes for all functions that
14340 take variable numbers of arguments (including @code{printf});
14341 otherwise incorrect code will be generated for calls to those
14342 functions.
14343
14344 In addition, seriously incorrect code will result if you call a
14345 function with too many arguments.  (Normally, extra arguments are
14346 harmlessly ignored.)
14347
14348 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
14349 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
14350
14351 @item -mno-rtd
14352 @opindex mno-rtd
14353 Do not use the calling conventions selected by @option{-mrtd}.
14354 This is the default.
14355
14356 @item -malign-int
14357 @itemx -mno-align-int
14358 @opindex malign-int
14359 @opindex mno-align-int
14360 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
14361 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
14362 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
14363 Aligning variables on 32-bit boundaries produces code that runs somewhat
14364 faster on processors with 32-bit busses at the expense of more memory.
14365
14366 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
14367 align structures containing the above types  differently than
14368 most published application binary interface specifications for the m68k.
14369
14370 @item -mpcrel
14371 @opindex mpcrel
14372 Use the pc-relative addressing mode of the 68000 directly, instead of
14373 using a global offset table.  At present, this option implies @option{-fpic},
14374 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
14375 not presently supported with @option{-mpcrel}, though this could be supported for
14376 68020 and higher processors.
14377
14378 @item -mno-strict-align
14379 @itemx -mstrict-align
14380 @opindex mno-strict-align
14381 @opindex mstrict-align
14382 Do not (do) assume that unaligned memory references will be handled by
14383 the system.
14384
14385 @item -msep-data
14386 Generate code that allows the data segment to be located in a different
14387 area of memory from the text segment.  This allows for execute in place in
14388 an environment without virtual memory management.  This option implies
14389 @option{-fPIC}.
14390
14391 @item -mno-sep-data
14392 Generate code that assumes that the data segment follows the text segment.
14393 This is the default.
14394
14395 @item -mid-shared-library
14396 Generate code that supports shared libraries via the library ID method.
14397 This allows for execute in place and shared libraries in an environment
14398 without virtual memory management.  This option implies @option{-fPIC}.
14399
14400 @item -mno-id-shared-library
14401 Generate code that doesn't assume ID based shared libraries are being used.
14402 This is the default.
14403
14404 @item -mshared-library-id=n
14405 Specified the identification number of the ID based shared library being
14406 compiled.  Specifying a value of 0 will generate more compact code, specifying
14407 other values will force the allocation of that number to the current
14408 library but is no more space or time efficient than omitting this option.
14409
14410 @item -mxgot
14411 @itemx -mno-xgot
14412 @opindex mxgot
14413 @opindex mno-xgot
14414 When generating position-independent code for ColdFire, generate code
14415 that works if the GOT has more than 8192 entries.  This code is
14416 larger and slower than code generated without this option.  On M680x0
14417 processors, this option is not needed; @option{-fPIC} suffices.
14418
14419 GCC normally uses a single instruction to load values from the GOT@.
14420 While this is relatively efficient, it only works if the GOT
14421 is smaller than about 64k.  Anything larger causes the linker
14422 to report an error such as:
14423
14424 @cindex relocation truncated to fit (ColdFire)
14425 @smallexample
14426 relocation truncated to fit: R_68K_GOT16O foobar
14427 @end smallexample
14428
14429 If this happens, you should recompile your code with @option{-mxgot}.
14430 It should then work with very large GOTs.  However, code generated with
14431 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
14432 the value of a global symbol.
14433
14434 Note that some linkers, including newer versions of the GNU linker,
14435 can create multiple GOTs and sort GOT entries.  If you have such a linker,
14436 you should only need to use @option{-mxgot} when compiling a single
14437 object file that accesses more than 8192 GOT entries.  Very few do.
14438
14439 These options have no effect unless GCC is generating
14440 position-independent code.
14441
14442 @end table
14443
14444 @node MCore Options
14445 @subsection MCore Options
14446 @cindex MCore options
14447
14448 These are the @samp{-m} options defined for the Motorola M*Core
14449 processors.
14450
14451 @table @gcctabopt
14452
14453 @item -mhardlit
14454 @itemx -mno-hardlit
14455 @opindex mhardlit
14456 @opindex mno-hardlit
14457 Inline constants into the code stream if it can be done in two
14458 instructions or less.
14459
14460 @item -mdiv
14461 @itemx -mno-div
14462 @opindex mdiv
14463 @opindex mno-div
14464 Use the divide instruction.  (Enabled by default).
14465
14466 @item -mrelax-immediate
14467 @itemx -mno-relax-immediate
14468 @opindex mrelax-immediate
14469 @opindex mno-relax-immediate
14470 Allow arbitrary sized immediates in bit operations.
14471
14472 @item -mwide-bitfields
14473 @itemx -mno-wide-bitfields
14474 @opindex mwide-bitfields
14475 @opindex mno-wide-bitfields
14476 Always treat bit-fields as int-sized.
14477
14478 @item -m4byte-functions
14479 @itemx -mno-4byte-functions
14480 @opindex m4byte-functions
14481 @opindex mno-4byte-functions
14482 Force all functions to be aligned to a four byte boundary.
14483
14484 @item -mcallgraph-data
14485 @itemx -mno-callgraph-data
14486 @opindex mcallgraph-data
14487 @opindex mno-callgraph-data
14488 Emit callgraph information.
14489
14490 @item -mslow-bytes
14491 @itemx -mno-slow-bytes
14492 @opindex mslow-bytes
14493 @opindex mno-slow-bytes
14494 Prefer word access when reading byte quantities.
14495
14496 @item -mlittle-endian
14497 @itemx -mbig-endian
14498 @opindex mlittle-endian
14499 @opindex mbig-endian
14500 Generate code for a little endian target.
14501
14502 @item -m210
14503 @itemx -m340
14504 @opindex m210
14505 @opindex m340
14506 Generate code for the 210 processor.
14507
14508 @item -mno-lsim
14509 @opindex mno-lsim
14510 Assume that run-time support has been provided and so omit the
14511 simulator library (@file{libsim.a)} from the linker command line.
14512
14513 @item -mstack-increment=@var{size}
14514 @opindex mstack-increment
14515 Set the maximum amount for a single stack increment operation.  Large
14516 values can increase the speed of programs which contain functions
14517 that need a large amount of stack space, but they can also trigger a
14518 segmentation fault if the stack is extended too much.  The default
14519 value is 0x1000.
14520
14521 @end table
14522
14523 @node MeP Options
14524 @subsection MeP Options
14525 @cindex MeP options
14526
14527 @table @gcctabopt
14528
14529 @item -mabsdiff
14530 @opindex mabsdiff
14531 Enables the @code{abs} instruction, which is the absolute difference
14532 between two registers.
14533
14534 @item -mall-opts
14535 @opindex mall-opts
14536 Enables all the optional instructions - average, multiply, divide, bit
14537 operations, leading zero, absolute difference, min/max, clip, and
14538 saturation.
14539
14540
14541 @item -maverage
14542 @opindex maverage
14543 Enables the @code{ave} instruction, which computes the average of two
14544 registers.
14545
14546 @item -mbased=@var{n}
14547 @opindex mbased=
14548 Variables of size @var{n} bytes or smaller will be placed in the
14549 @code{.based} section by default.  Based variables use the @code{$tp}
14550 register as a base register, and there is a 128 byte limit to the
14551 @code{.based} section.
14552
14553 @item -mbitops
14554 @opindex mbitops
14555 Enables the bit operation instructions - bit test (@code{btstm}), set
14556 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
14557 test-and-set (@code{tas}).
14558
14559 @item -mc=@var{name}
14560 @opindex mc=
14561 Selects which section constant data will be placed in.  @var{name} may
14562 be @code{tiny}, @code{near}, or @code{far}.
14563
14564 @item -mclip
14565 @opindex mclip
14566 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
14567 useful unless you also provide @code{-mminmax}.
14568
14569 @item -mconfig=@var{name}
14570 @opindex mconfig=
14571 Selects one of the build-in core configurations.  Each MeP chip has
14572 one or more modules in it; each module has a core CPU and a variety of
14573 coprocessors, optional instructions, and peripherals.  The
14574 @code{MeP-Integrator} tool, not part of GCC, provides these
14575 configurations through this option; using this option is the same as
14576 using all the corresponding command line options.  The default
14577 configuration is @code{default}.
14578
14579 @item -mcop
14580 @opindex mcop
14581 Enables the coprocessor instructions.  By default, this is a 32-bit
14582 coprocessor.  Note that the coprocessor is normally enabled via the
14583 @code{-mconfig=} option.
14584
14585 @item -mcop32
14586 @opindex mcop32
14587 Enables the 32-bit coprocessor's instructions.
14588
14589 @item -mcop64
14590 @opindex mcop64
14591 Enables the 64-bit coprocessor's instructions.
14592
14593 @item -mivc2
14594 @opindex mivc2
14595 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
14596
14597 @item -mdc
14598 @opindex mdc
14599 Causes constant variables to be placed in the @code{.near} section.
14600
14601 @item -mdiv
14602 @opindex mdiv
14603 Enables the @code{div} and @code{divu} instructions.
14604
14605 @item -meb
14606 @opindex meb
14607 Generate big-endian code.
14608
14609 @item -mel
14610 @opindex mel
14611 Generate little-endian code.
14612
14613 @item -mio-volatile
14614 @opindex mio-volatile
14615 Tells the compiler that any variable marked with the @code{io}
14616 attribute is to be considered volatile.
14617
14618 @item -ml
14619 @opindex ml
14620 Causes variables to be assigned to the @code{.far} section by default.
14621
14622 @item -mleadz
14623 @opindex mleadz
14624 Enables the @code{leadz} (leading zero) instruction.
14625
14626 @item -mm
14627 @opindex mm
14628 Causes variables to be assigned to the @code{.near} section by default.
14629
14630 @item -mminmax
14631 @opindex mminmax
14632 Enables the @code{min} and @code{max} instructions.
14633
14634 @item -mmult
14635 @opindex mmult
14636 Enables the multiplication and multiply-accumulate instructions.
14637
14638 @item -mno-opts
14639 @opindex mno-opts
14640 Disables all the optional instructions enabled by @code{-mall-opts}.
14641
14642 @item -mrepeat
14643 @opindex mrepeat
14644 Enables the @code{repeat} and @code{erepeat} instructions, used for
14645 low-overhead looping.
14646
14647 @item -ms
14648 @opindex ms
14649 Causes all variables to default to the @code{.tiny} section.  Note
14650 that there is a 65536 byte limit to this section.  Accesses to these
14651 variables use the @code{%gp} base register.
14652
14653 @item -msatur
14654 @opindex msatur
14655 Enables the saturation instructions.  Note that the compiler does not
14656 currently generate these itself, but this option is included for
14657 compatibility with other tools, like @code{as}.
14658
14659 @item -msdram
14660 @opindex msdram
14661 Link the SDRAM-based runtime instead of the default ROM-based runtime.
14662
14663 @item -msim
14664 @opindex msim
14665 Link the simulator runtime libraries.
14666
14667 @item -msimnovec
14668 @opindex msimnovec
14669 Link the simulator runtime libraries, excluding built-in support
14670 for reset and exception vectors and tables.
14671
14672 @item -mtf
14673 @opindex mtf
14674 Causes all functions to default to the @code{.far} section.  Without
14675 this option, functions default to the @code{.near} section.
14676
14677 @item -mtiny=@var{n}
14678 @opindex mtiny=
14679 Variables that are @var{n} bytes or smaller will be allocated to the
14680 @code{.tiny} section.  These variables use the @code{$gp} base
14681 register.  The default for this option is 4, but note that there's a
14682 65536 byte limit to the @code{.tiny} section.
14683
14684 @end table
14685
14686 @node MicroBlaze Options
14687 @subsection MicroBlaze Options
14688 @cindex MicroBlaze Options
14689
14690 @table @gcctabopt
14691
14692 @item -msoft-float
14693 @opindex msoft-float
14694 Use software emulation for floating point (default).
14695
14696 @item -mhard-float
14697 @opindex mhard-float
14698 Use hardware floating point instructions.
14699
14700 @item -mmemcpy
14701 @opindex mmemcpy
14702 Do not optimize block moves, use @code{memcpy}.
14703
14704 @item -mno-clearbss
14705 @opindex mno-clearbss
14706 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
14707
14708 @item -mcpu=@var{cpu-type}
14709 @opindex mcpu=
14710 Use features of and schedule code for given CPU.
14711 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
14712 where @var{X} is a major version, @var{YY} is the minor version, and
14713 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
14714 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
14715
14716 @item -mxl-soft-mul
14717 @opindex mxl-soft-mul
14718 Use software multiply emulation (default).
14719
14720 @item -mxl-soft-div
14721 @opindex mxl-soft-div
14722 Use software emulation for divides (default).
14723
14724 @item -mxl-barrel-shift
14725 @opindex mxl-barrel-shift
14726 Use the hardware barrel shifter.
14727
14728 @item -mxl-pattern-compare
14729 @opindex mxl-pattern-compare
14730 Use pattern compare instructions.
14731
14732 @item -msmall-divides
14733 @opindex msmall-divides
14734 Use table lookup optimization for small signed integer divisions.
14735
14736 @item -mxl-stack-check
14737 @opindex mxl-stack-check
14738 This option is deprecated.  Use -fstack-check instead.
14739
14740 @item -mxl-gp-opt
14741 @opindex mxl-gp-opt
14742 Use GP relative sdata/sbss sections.
14743
14744 @item -mxl-multiply-high
14745 @opindex mxl-multiply-high
14746 Use multiply high instructions for high part of 32x32 multiply.
14747
14748 @item -mxl-float-convert
14749 @opindex mxl-float-convert
14750 Use hardware floating point conversion instructions.
14751
14752 @item -mxl-float-sqrt
14753 @opindex mxl-float-sqrt
14754 Use hardware floating point square root instruction.
14755
14756 @item -mxl-mode-@var{app-model}
14757 Select application model @var{app-model}.  Valid models are
14758 @table @samp
14759 @item executable
14760 normal executable (default), uses startup code @file{crt0.o}.
14761
14762 @item xmdstub
14763 for use with Xilinx Microprocessor Debugger (XMD) based
14764 software intrusive debug agent called xmdstub. This uses startup file
14765 @file{crt1.o} and sets the start address of the program to be 0x800.
14766
14767 @item bootstrap
14768 for applications that are loaded using a bootloader.
14769 This model uses startup file @file{crt2.o} which does not contain a processor
14770 reset vector handler. This is suitable for transferring control on a
14771 processor reset to the bootloader rather than the application.
14772
14773 @item novectors
14774 for applications that do not require any of the
14775 MicroBlaze vectors. This option may be useful for applications running
14776 within a monitoring application. This model uses @file{crt3.o} as a startup file.
14777 @end table
14778
14779 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
14780 @option{-mxl-mode-@var{app-model}}.
14781
14782 @end table
14783
14784 @node MIPS Options
14785 @subsection MIPS Options
14786 @cindex MIPS options
14787
14788 @table @gcctabopt
14789
14790 @item -EB
14791 @opindex EB
14792 Generate big-endian code.
14793
14794 @item -EL
14795 @opindex EL
14796 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
14797 configurations.
14798
14799 @item -march=@var{arch}
14800 @opindex march
14801 Generate code that will run on @var{arch}, which can be the name of a
14802 generic MIPS ISA, or the name of a particular processor.
14803 The ISA names are:
14804 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
14805 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
14806 The processor names are:
14807 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
14808 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
14809 @samp{5kc}, @samp{5kf},
14810 @samp{20kc},
14811 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
14812 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
14813 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
14814 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
14815 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
14816 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
14817 @samp{m4k},
14818 @samp{octeon},
14819 @samp{orion},
14820 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
14821 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
14822 @samp{rm7000}, @samp{rm9000},
14823 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
14824 @samp{sb1},
14825 @samp{sr71000},
14826 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
14827 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
14828 and @samp{xlr}.
14829 The special value @samp{from-abi} selects the
14830 most compatible architecture for the selected ABI (that is,
14831 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
14832
14833 Native Linux/GNU and IRIX toolchains also support the value @samp{native},
14834 which selects the best architecture option for the host processor.
14835 @option{-march=native} has no effect if GCC does not recognize
14836 the processor.
14837
14838 In processor names, a final @samp{000} can be abbreviated as @samp{k}
14839 (for example, @samp{-march=r2k}).  Prefixes are optional, and
14840 @samp{vr} may be written @samp{r}.
14841
14842 Names of the form @samp{@var{n}f2_1} refer to processors with
14843 FPUs clocked at half the rate of the core, names of the form
14844 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
14845 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
14846 processors with FPUs clocked a ratio of 3:2 with respect to the core.
14847 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
14848 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
14849 accepted as synonyms for @samp{@var{n}f1_1}.
14850
14851 GCC defines two macros based on the value of this option.  The first
14852 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
14853 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
14854 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
14855 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
14856 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
14857
14858 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
14859 above.  In other words, it will have the full prefix and will not
14860 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
14861 the macro names the resolved architecture (either @samp{"mips1"} or
14862 @samp{"mips3"}).  It names the default architecture when no
14863 @option{-march} option is given.
14864
14865 @item -mtune=@var{arch}
14866 @opindex mtune
14867 Optimize for @var{arch}.  Among other things, this option controls
14868 the way instructions are scheduled, and the perceived cost of arithmetic
14869 operations.  The list of @var{arch} values is the same as for
14870 @option{-march}.
14871
14872 When this option is not used, GCC will optimize for the processor
14873 specified by @option{-march}.  By using @option{-march} and
14874 @option{-mtune} together, it is possible to generate code that will
14875 run on a family of processors, but optimize the code for one
14876 particular member of that family.
14877
14878 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
14879 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
14880 @samp{-march} ones described above.
14881
14882 @item -mips1
14883 @opindex mips1
14884 Equivalent to @samp{-march=mips1}.
14885
14886 @item -mips2
14887 @opindex mips2
14888 Equivalent to @samp{-march=mips2}.
14889
14890 @item -mips3
14891 @opindex mips3
14892 Equivalent to @samp{-march=mips3}.
14893
14894 @item -mips4
14895 @opindex mips4
14896 Equivalent to @samp{-march=mips4}.
14897
14898 @item -mips32
14899 @opindex mips32
14900 Equivalent to @samp{-march=mips32}.
14901
14902 @item -mips32r2
14903 @opindex mips32r2
14904 Equivalent to @samp{-march=mips32r2}.
14905
14906 @item -mips64
14907 @opindex mips64
14908 Equivalent to @samp{-march=mips64}.
14909
14910 @item -mips64r2
14911 @opindex mips64r2
14912 Equivalent to @samp{-march=mips64r2}.
14913
14914 @item -mips16
14915 @itemx -mno-mips16
14916 @opindex mips16
14917 @opindex mno-mips16
14918 Generate (do not generate) MIPS16 code.  If GCC is targetting a
14919 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
14920
14921 MIPS16 code generation can also be controlled on a per-function basis
14922 by means of @code{mips16} and @code{nomips16} attributes.
14923 @xref{Function Attributes}, for more information.
14924
14925 @item -mflip-mips16
14926 @opindex mflip-mips16
14927 Generate MIPS16 code on alternating functions.  This option is provided
14928 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
14929 not intended for ordinary use in compiling user code.
14930
14931 @item -minterlink-mips16
14932 @itemx -mno-interlink-mips16
14933 @opindex minterlink-mips16
14934 @opindex mno-interlink-mips16
14935 Require (do not require) that non-MIPS16 code be link-compatible with
14936 MIPS16 code.
14937
14938 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
14939 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
14940 therefore disables direct jumps unless GCC knows that the target of the
14941 jump is not MIPS16.
14942
14943 @item -mabi=32
14944 @itemx -mabi=o64
14945 @itemx -mabi=n32
14946 @itemx -mabi=64
14947 @itemx -mabi=eabi
14948 @opindex mabi=32
14949 @opindex mabi=o64
14950 @opindex mabi=n32
14951 @opindex mabi=64
14952 @opindex mabi=eabi
14953 Generate code for the given ABI@.
14954
14955 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
14956 generates 64-bit code when you select a 64-bit architecture, but you
14957 can use @option{-mgp32} to get 32-bit code instead.
14958
14959 For information about the O64 ABI, see
14960 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
14961
14962 GCC supports a variant of the o32 ABI in which floating-point registers
14963 are 64 rather than 32 bits wide.  You can select this combination with
14964 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
14965 and @samp{mfhc1} instructions and is therefore only supported for
14966 MIPS32R2 processors.
14967
14968 The register assignments for arguments and return values remain the
14969 same, but each scalar value is passed in a single 64-bit register
14970 rather than a pair of 32-bit registers.  For example, scalar
14971 floating-point values are returned in @samp{$f0} only, not a
14972 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
14973 remains the same, but all 64 bits are saved.
14974
14975 @item -mabicalls
14976 @itemx -mno-abicalls
14977 @opindex mabicalls
14978 @opindex mno-abicalls
14979 Generate (do not generate) code that is suitable for SVR4-style
14980 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
14981 systems.
14982
14983 @item -mshared
14984 @itemx -mno-shared
14985 Generate (do not generate) code that is fully position-independent,
14986 and that can therefore be linked into shared libraries.  This option
14987 only affects @option{-mabicalls}.
14988
14989 All @option{-mabicalls} code has traditionally been position-independent,
14990 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
14991 as an extension, the GNU toolchain allows executables to use absolute
14992 accesses for locally-binding symbols.  It can also use shorter GP
14993 initialization sequences and generate direct calls to locally-defined
14994 functions.  This mode is selected by @option{-mno-shared}.
14995
14996 @option{-mno-shared} depends on binutils 2.16 or higher and generates
14997 objects that can only be linked by the GNU linker.  However, the option
14998 does not affect the ABI of the final executable; it only affects the ABI
14999 of relocatable objects.  Using @option{-mno-shared} will generally make
15000 executables both smaller and quicker.
15001
15002 @option{-mshared} is the default.
15003
15004 @item -mplt
15005 @itemx -mno-plt
15006 @opindex mplt
15007 @opindex mno-plt
15008 Assume (do not assume) that the static and dynamic linkers
15009 support PLTs and copy relocations.  This option only affects
15010 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
15011 has no effect without @samp{-msym32}.
15012
15013 You can make @option{-mplt} the default by configuring
15014 GCC with @option{--with-mips-plt}.  The default is
15015 @option{-mno-plt} otherwise.
15016
15017 @item -mxgot
15018 @itemx -mno-xgot
15019 @opindex mxgot
15020 @opindex mno-xgot
15021 Lift (do not lift) the usual restrictions on the size of the global
15022 offset table.
15023
15024 GCC normally uses a single instruction to load values from the GOT@.
15025 While this is relatively efficient, it will only work if the GOT
15026 is smaller than about 64k.  Anything larger will cause the linker
15027 to report an error such as:
15028
15029 @cindex relocation truncated to fit (MIPS)
15030 @smallexample
15031 relocation truncated to fit: R_MIPS_GOT16 foobar
15032 @end smallexample
15033
15034 If this happens, you should recompile your code with @option{-mxgot}.
15035 It should then work with very large GOTs, although it will also be
15036 less efficient, since it will take three instructions to fetch the
15037 value of a global symbol.
15038
15039 Note that some linkers can create multiple GOTs.  If you have such a
15040 linker, you should only need to use @option{-mxgot} when a single object
15041 file accesses more than 64k's worth of GOT entries.  Very few do.
15042
15043 These options have no effect unless GCC is generating position
15044 independent code.
15045
15046 @item -mgp32
15047 @opindex mgp32
15048 Assume that general-purpose registers are 32 bits wide.
15049
15050 @item -mgp64
15051 @opindex mgp64
15052 Assume that general-purpose registers are 64 bits wide.
15053
15054 @item -mfp32
15055 @opindex mfp32
15056 Assume that floating-point registers are 32 bits wide.
15057
15058 @item -mfp64
15059 @opindex mfp64
15060 Assume that floating-point registers are 64 bits wide.
15061
15062 @item -mhard-float
15063 @opindex mhard-float
15064 Use floating-point coprocessor instructions.
15065
15066 @item -msoft-float
15067 @opindex msoft-float
15068 Do not use floating-point coprocessor instructions.  Implement
15069 floating-point calculations using library calls instead.
15070
15071 @item -msingle-float
15072 @opindex msingle-float
15073 Assume that the floating-point coprocessor only supports single-precision
15074 operations.
15075
15076 @item -mdouble-float
15077 @opindex mdouble-float
15078 Assume that the floating-point coprocessor supports double-precision
15079 operations.  This is the default.
15080
15081 @item -mllsc
15082 @itemx -mno-llsc
15083 @opindex mllsc
15084 @opindex mno-llsc
15085 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
15086 implement atomic memory built-in functions.  When neither option is
15087 specified, GCC will use the instructions if the target architecture
15088 supports them.
15089
15090 @option{-mllsc} is useful if the runtime environment can emulate the
15091 instructions and @option{-mno-llsc} can be useful when compiling for
15092 nonstandard ISAs.  You can make either option the default by
15093 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
15094 respectively.  @option{--with-llsc} is the default for some
15095 configurations; see the installation documentation for details.
15096
15097 @item -mdsp
15098 @itemx -mno-dsp
15099 @opindex mdsp
15100 @opindex mno-dsp
15101 Use (do not use) revision 1 of the MIPS DSP ASE@.
15102 @xref{MIPS DSP Built-in Functions}.  This option defines the
15103 preprocessor macro @samp{__mips_dsp}.  It also defines
15104 @samp{__mips_dsp_rev} to 1.
15105
15106 @item -mdspr2
15107 @itemx -mno-dspr2
15108 @opindex mdspr2
15109 @opindex mno-dspr2
15110 Use (do not use) revision 2 of the MIPS DSP ASE@.
15111 @xref{MIPS DSP Built-in Functions}.  This option defines the
15112 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
15113 It also defines @samp{__mips_dsp_rev} to 2.
15114
15115 @item -msmartmips
15116 @itemx -mno-smartmips
15117 @opindex msmartmips
15118 @opindex mno-smartmips
15119 Use (do not use) the MIPS SmartMIPS ASE.
15120
15121 @item -mpaired-single
15122 @itemx -mno-paired-single
15123 @opindex mpaired-single
15124 @opindex mno-paired-single
15125 Use (do not use) paired-single floating-point instructions.
15126 @xref{MIPS Paired-Single Support}.  This option requires
15127 hardware floating-point support to be enabled.
15128
15129 @item -mdmx
15130 @itemx -mno-mdmx
15131 @opindex mdmx
15132 @opindex mno-mdmx
15133 Use (do not use) MIPS Digital Media Extension instructions.
15134 This option can only be used when generating 64-bit code and requires
15135 hardware floating-point support to be enabled.
15136
15137 @item -mips3d
15138 @itemx -mno-mips3d
15139 @opindex mips3d
15140 @opindex mno-mips3d
15141 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
15142 The option @option{-mips3d} implies @option{-mpaired-single}.
15143
15144 @item -mmt
15145 @itemx -mno-mt
15146 @opindex mmt
15147 @opindex mno-mt
15148 Use (do not use) MT Multithreading instructions.
15149
15150 @item -mlong64
15151 @opindex mlong64
15152 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
15153 an explanation of the default and the way that the pointer size is
15154 determined.
15155
15156 @item -mlong32
15157 @opindex mlong32
15158 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
15159
15160 The default size of @code{int}s, @code{long}s and pointers depends on
15161 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
15162 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
15163 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
15164 or the same size as integer registers, whichever is smaller.
15165
15166 @item -msym32
15167 @itemx -mno-sym32
15168 @opindex msym32
15169 @opindex mno-sym32
15170 Assume (do not assume) that all symbols have 32-bit values, regardless
15171 of the selected ABI@.  This option is useful in combination with
15172 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
15173 to generate shorter and faster references to symbolic addresses.
15174
15175 @item -G @var{num}
15176 @opindex G
15177 Put definitions of externally-visible data in a small data section
15178 if that data is no bigger than @var{num} bytes.  GCC can then access
15179 the data more efficiently; see @option{-mgpopt} for details.
15180
15181 The default @option{-G} option depends on the configuration.
15182
15183 @item -mlocal-sdata
15184 @itemx -mno-local-sdata
15185 @opindex mlocal-sdata
15186 @opindex mno-local-sdata
15187 Extend (do not extend) the @option{-G} behavior to local data too,
15188 such as to static variables in C@.  @option{-mlocal-sdata} is the
15189 default for all configurations.
15190
15191 If the linker complains that an application is using too much small data,
15192 you might want to try rebuilding the less performance-critical parts with
15193 @option{-mno-local-sdata}.  You might also want to build large
15194 libraries with @option{-mno-local-sdata}, so that the libraries leave
15195 more room for the main program.
15196
15197 @item -mextern-sdata
15198 @itemx -mno-extern-sdata
15199 @opindex mextern-sdata
15200 @opindex mno-extern-sdata
15201 Assume (do not assume) that externally-defined data will be in
15202 a small data section if that data is within the @option{-G} limit.
15203 @option{-mextern-sdata} is the default for all configurations.
15204
15205 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
15206 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
15207 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
15208 is placed in a small data section.  If @var{Var} is defined by another
15209 module, you must either compile that module with a high-enough
15210 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
15211 definition.  If @var{Var} is common, you must link the application
15212 with a high-enough @option{-G} setting.
15213
15214 The easiest way of satisfying these restrictions is to compile
15215 and link every module with the same @option{-G} option.  However,
15216 you may wish to build a library that supports several different
15217 small data limits.  You can do this by compiling the library with
15218 the highest supported @option{-G} setting and additionally using
15219 @option{-mno-extern-sdata} to stop the library from making assumptions
15220 about externally-defined data.
15221
15222 @item -mgpopt
15223 @itemx -mno-gpopt
15224 @opindex mgpopt
15225 @opindex mno-gpopt
15226 Use (do not use) GP-relative accesses for symbols that are known to be
15227 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
15228 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
15229 configurations.
15230
15231 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
15232 might not hold the value of @code{_gp}.  For example, if the code is
15233 part of a library that might be used in a boot monitor, programs that
15234 call boot monitor routines will pass an unknown value in @code{$gp}.
15235 (In such situations, the boot monitor itself would usually be compiled
15236 with @option{-G0}.)
15237
15238 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
15239 @option{-mno-extern-sdata}.
15240
15241 @item -membedded-data
15242 @itemx -mno-embedded-data
15243 @opindex membedded-data
15244 @opindex mno-embedded-data
15245 Allocate variables to the read-only data section first if possible, then
15246 next in the small data section if possible, otherwise in data.  This gives
15247 slightly slower code than the default, but reduces the amount of RAM required
15248 when executing, and thus may be preferred for some embedded systems.
15249
15250 @item -muninit-const-in-rodata
15251 @itemx -mno-uninit-const-in-rodata
15252 @opindex muninit-const-in-rodata
15253 @opindex mno-uninit-const-in-rodata
15254 Put uninitialized @code{const} variables in the read-only data section.
15255 This option is only meaningful in conjunction with @option{-membedded-data}.
15256
15257 @item -mcode-readable=@var{setting}
15258 @opindex mcode-readable
15259 Specify whether GCC may generate code that reads from executable sections.
15260 There are three possible settings:
15261
15262 @table @gcctabopt
15263 @item -mcode-readable=yes
15264 Instructions may freely access executable sections.  This is the
15265 default setting.
15266
15267 @item -mcode-readable=pcrel
15268 MIPS16 PC-relative load instructions can access executable sections,
15269 but other instructions must not do so.  This option is useful on 4KSc
15270 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
15271 It is also useful on processors that can be configured to have a dual
15272 instruction/data SRAM interface and that, like the M4K, automatically
15273 redirect PC-relative loads to the instruction RAM.
15274
15275 @item -mcode-readable=no
15276 Instructions must not access executable sections.  This option can be
15277 useful on targets that are configured to have a dual instruction/data
15278 SRAM interface but that (unlike the M4K) do not automatically redirect
15279 PC-relative loads to the instruction RAM.
15280 @end table
15281
15282 @item -msplit-addresses
15283 @itemx -mno-split-addresses
15284 @opindex msplit-addresses
15285 @opindex mno-split-addresses
15286 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
15287 relocation operators.  This option has been superseded by
15288 @option{-mexplicit-relocs} but is retained for backwards compatibility.
15289
15290 @item -mexplicit-relocs
15291 @itemx -mno-explicit-relocs
15292 @opindex mexplicit-relocs
15293 @opindex mno-explicit-relocs
15294 Use (do not use) assembler relocation operators when dealing with symbolic
15295 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
15296 is to use assembler macros instead.
15297
15298 @option{-mexplicit-relocs} is the default if GCC was configured
15299 to use an assembler that supports relocation operators.
15300
15301 @item -mcheck-zero-division
15302 @itemx -mno-check-zero-division
15303 @opindex mcheck-zero-division
15304 @opindex mno-check-zero-division
15305 Trap (do not trap) on integer division by zero.
15306
15307 The default is @option{-mcheck-zero-division}.
15308
15309 @item -mdivide-traps
15310 @itemx -mdivide-breaks
15311 @opindex mdivide-traps
15312 @opindex mdivide-breaks
15313 MIPS systems check for division by zero by generating either a
15314 conditional trap or a break instruction.  Using traps results in
15315 smaller code, but is only supported on MIPS II and later.  Also, some
15316 versions of the Linux kernel have a bug that prevents trap from
15317 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
15318 allow conditional traps on architectures that support them and
15319 @option{-mdivide-breaks} to force the use of breaks.
15320
15321 The default is usually @option{-mdivide-traps}, but this can be
15322 overridden at configure time using @option{--with-divide=breaks}.
15323 Divide-by-zero checks can be completely disabled using
15324 @option{-mno-check-zero-division}.
15325
15326 @item -mmemcpy
15327 @itemx -mno-memcpy
15328 @opindex mmemcpy
15329 @opindex mno-memcpy
15330 Force (do not force) the use of @code{memcpy()} for non-trivial block
15331 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
15332 most constant-sized copies.
15333
15334 @item -mlong-calls
15335 @itemx -mno-long-calls
15336 @opindex mlong-calls
15337 @opindex mno-long-calls
15338 Disable (do not disable) use of the @code{jal} instruction.  Calling
15339 functions using @code{jal} is more efficient but requires the caller
15340 and callee to be in the same 256 megabyte segment.
15341
15342 This option has no effect on abicalls code.  The default is
15343 @option{-mno-long-calls}.
15344
15345 @item -mmad
15346 @itemx -mno-mad
15347 @opindex mmad
15348 @opindex mno-mad
15349 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
15350 instructions, as provided by the R4650 ISA@.
15351
15352 @item -mfused-madd
15353 @itemx -mno-fused-madd
15354 @opindex mfused-madd
15355 @opindex mno-fused-madd
15356 Enable (disable) use of the floating point multiply-accumulate
15357 instructions, when they are available.  The default is
15358 @option{-mfused-madd}.
15359
15360 When multiply-accumulate instructions are used, the intermediate
15361 product is calculated to infinite precision and is not subject to
15362 the FCSR Flush to Zero bit.  This may be undesirable in some
15363 circumstances.
15364
15365 @item -nocpp
15366 @opindex nocpp
15367 Tell the MIPS assembler to not run its preprocessor over user
15368 assembler files (with a @samp{.s} suffix) when assembling them.
15369
15370 @item -mfix-24k
15371 @item -mno-fix-24k
15372 @opindex mfix-24k
15373 @opindex mno-fix-24k
15374 Work around the 24K E48 (lost data on stores during refill) errata.
15375 The workarounds are implemented by the assembler rather than by GCC.
15376
15377 @item -mfix-r4000
15378 @itemx -mno-fix-r4000
15379 @opindex mfix-r4000
15380 @opindex mno-fix-r4000
15381 Work around certain R4000 CPU errata:
15382 @itemize @minus
15383 @item
15384 A double-word or a variable shift may give an incorrect result if executed
15385 immediately after starting an integer division.
15386 @item
15387 A double-word or a variable shift may give an incorrect result if executed
15388 while an integer multiplication is in progress.
15389 @item
15390 An integer division may give an incorrect result if started in a delay slot
15391 of a taken branch or a jump.
15392 @end itemize
15393
15394 @item -mfix-r4400
15395 @itemx -mno-fix-r4400
15396 @opindex mfix-r4400
15397 @opindex mno-fix-r4400
15398 Work around certain R4400 CPU errata:
15399 @itemize @minus
15400 @item
15401 A double-word or a variable shift may give an incorrect result if executed
15402 immediately after starting an integer division.
15403 @end itemize
15404
15405 @item -mfix-r10000
15406 @itemx -mno-fix-r10000
15407 @opindex mfix-r10000
15408 @opindex mno-fix-r10000
15409 Work around certain R10000 errata:
15410 @itemize @minus
15411 @item
15412 @code{ll}/@code{sc} sequences may not behave atomically on revisions
15413 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
15414 @end itemize
15415
15416 This option can only be used if the target architecture supports
15417 branch-likely instructions.  @option{-mfix-r10000} is the default when
15418 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
15419 otherwise.
15420
15421 @item -mfix-vr4120
15422 @itemx -mno-fix-vr4120
15423 @opindex mfix-vr4120
15424 Work around certain VR4120 errata:
15425 @itemize @minus
15426 @item
15427 @code{dmultu} does not always produce the correct result.
15428 @item
15429 @code{div} and @code{ddiv} do not always produce the correct result if one
15430 of the operands is negative.
15431 @end itemize
15432 The workarounds for the division errata rely on special functions in
15433 @file{libgcc.a}.  At present, these functions are only provided by
15434 the @code{mips64vr*-elf} configurations.
15435
15436 Other VR4120 errata require a nop to be inserted between certain pairs of
15437 instructions.  These errata are handled by the assembler, not by GCC itself.
15438
15439 @item -mfix-vr4130
15440 @opindex mfix-vr4130
15441 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
15442 workarounds are implemented by the assembler rather than by GCC,
15443 although GCC will avoid using @code{mflo} and @code{mfhi} if the
15444 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
15445 instructions are available instead.
15446
15447 @item -mfix-sb1
15448 @itemx -mno-fix-sb1
15449 @opindex mfix-sb1
15450 Work around certain SB-1 CPU core errata.
15451 (This flag currently works around the SB-1 revision 2
15452 ``F1'' and ``F2'' floating point errata.)
15453
15454 @item -mr10k-cache-barrier=@var{setting}
15455 @opindex mr10k-cache-barrier
15456 Specify whether GCC should insert cache barriers to avoid the
15457 side-effects of speculation on R10K processors.
15458
15459 In common with many processors, the R10K tries to predict the outcome
15460 of a conditional branch and speculatively executes instructions from
15461 the ``taken'' branch.  It later aborts these instructions if the
15462 predicted outcome was wrong.  However, on the R10K, even aborted
15463 instructions can have side effects.
15464
15465 This problem only affects kernel stores and, depending on the system,
15466 kernel loads.  As an example, a speculatively-executed store may load
15467 the target memory into cache and mark the cache line as dirty, even if
15468 the store itself is later aborted.  If a DMA operation writes to the
15469 same area of memory before the ``dirty'' line is flushed, the cached
15470 data will overwrite the DMA-ed data.  See the R10K processor manual
15471 for a full description, including other potential problems.
15472
15473 One workaround is to insert cache barrier instructions before every memory
15474 access that might be speculatively executed and that might have side
15475 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
15476 controls GCC's implementation of this workaround.  It assumes that
15477 aborted accesses to any byte in the following regions will not have
15478 side effects:
15479
15480 @enumerate
15481 @item
15482 the memory occupied by the current function's stack frame;
15483
15484 @item
15485 the memory occupied by an incoming stack argument;
15486
15487 @item
15488 the memory occupied by an object with a link-time-constant address.
15489 @end enumerate
15490
15491 It is the kernel's responsibility to ensure that speculative
15492 accesses to these regions are indeed safe.
15493
15494 If the input program contains a function declaration such as:
15495
15496 @smallexample
15497 void foo (void);
15498 @end smallexample
15499
15500 then the implementation of @code{foo} must allow @code{j foo} and
15501 @code{jal foo} to be executed speculatively.  GCC honors this
15502 restriction for functions it compiles itself.  It expects non-GCC
15503 functions (such as hand-written assembly code) to do the same.
15504
15505 The option has three forms:
15506
15507 @table @gcctabopt
15508 @item -mr10k-cache-barrier=load-store
15509 Insert a cache barrier before a load or store that might be
15510 speculatively executed and that might have side effects even
15511 if aborted.
15512
15513 @item -mr10k-cache-barrier=store
15514 Insert a cache barrier before a store that might be speculatively
15515 executed and that might have side effects even if aborted.
15516
15517 @item -mr10k-cache-barrier=none
15518 Disable the insertion of cache barriers.  This is the default setting.
15519 @end table
15520
15521 @item -mflush-func=@var{func}
15522 @itemx -mno-flush-func
15523 @opindex mflush-func
15524 Specifies the function to call to flush the I and D caches, or to not
15525 call any such function.  If called, the function must take the same
15526 arguments as the common @code{_flush_func()}, that is, the address of the
15527 memory range for which the cache is being flushed, the size of the
15528 memory range, and the number 3 (to flush both caches).  The default
15529 depends on the target GCC was configured for, but commonly is either
15530 @samp{_flush_func} or @samp{__cpu_flush}.
15531
15532 @item mbranch-cost=@var{num}
15533 @opindex mbranch-cost
15534 Set the cost of branches to roughly @var{num} ``simple'' instructions.
15535 This cost is only a heuristic and is not guaranteed to produce
15536 consistent results across releases.  A zero cost redundantly selects
15537 the default, which is based on the @option{-mtune} setting.
15538
15539 @item -mbranch-likely
15540 @itemx -mno-branch-likely
15541 @opindex mbranch-likely
15542 @opindex mno-branch-likely
15543 Enable or disable use of Branch Likely instructions, regardless of the
15544 default for the selected architecture.  By default, Branch Likely
15545 instructions may be generated if they are supported by the selected
15546 architecture.  An exception is for the MIPS32 and MIPS64 architectures
15547 and processors which implement those architectures; for those, Branch
15548 Likely instructions will not be generated by default because the MIPS32
15549 and MIPS64 architectures specifically deprecate their use.
15550
15551 @item -mfp-exceptions
15552 @itemx -mno-fp-exceptions
15553 @opindex mfp-exceptions
15554 Specifies whether FP exceptions are enabled.  This affects how we schedule
15555 FP instructions for some processors.  The default is that FP exceptions are
15556 enabled.
15557
15558 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
15559 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
15560 FP pipe.
15561
15562 @item -mvr4130-align
15563 @itemx -mno-vr4130-align
15564 @opindex mvr4130-align
15565 The VR4130 pipeline is two-way superscalar, but can only issue two
15566 instructions together if the first one is 8-byte aligned.  When this
15567 option is enabled, GCC will align pairs of instructions that it
15568 thinks should execute in parallel.
15569
15570 This option only has an effect when optimizing for the VR4130.
15571 It normally makes code faster, but at the expense of making it bigger.
15572 It is enabled by default at optimization level @option{-O3}.
15573
15574 @item -msynci
15575 @itemx -mno-synci
15576 @opindex msynci
15577 Enable (disable) generation of @code{synci} instructions on
15578 architectures that support it.  The @code{synci} instructions (if
15579 enabled) will be generated when @code{__builtin___clear_cache()} is
15580 compiled.
15581
15582 This option defaults to @code{-mno-synci}, but the default can be
15583 overridden by configuring with @code{--with-synci}.
15584
15585 When compiling code for single processor systems, it is generally safe
15586 to use @code{synci}.  However, on many multi-core (SMP) systems, it
15587 will not invalidate the instruction caches on all cores and may lead
15588 to undefined behavior.
15589
15590 @item -mrelax-pic-calls
15591 @itemx -mno-relax-pic-calls
15592 @opindex mrelax-pic-calls
15593 Try to turn PIC calls that are normally dispatched via register
15594 @code{$25} into direct calls.  This is only possible if the linker can
15595 resolve the destination at link-time and if the destination is within
15596 range for a direct call.
15597
15598 @option{-mrelax-pic-calls} is the default if GCC was configured to use
15599 an assembler and a linker that supports the @code{.reloc} assembly
15600 directive and @code{-mexplicit-relocs} is in effect.  With
15601 @code{-mno-explicit-relocs}, this optimization can be performed by the
15602 assembler and the linker alone without help from the compiler.
15603
15604 @item -mmcount-ra-address
15605 @itemx -mno-mcount-ra-address
15606 @opindex mmcount-ra-address
15607 @opindex mno-mcount-ra-address
15608 Emit (do not emit) code that allows @code{_mcount} to modify the
15609 calling function's return address.  When enabled, this option extends
15610 the usual @code{_mcount} interface with a new @var{ra-address}
15611 parameter, which has type @code{intptr_t *} and is passed in register
15612 @code{$12}.  @code{_mcount} can then modify the return address by
15613 doing both of the following:
15614 @itemize
15615 @item
15616 Returning the new address in register @code{$31}.
15617 @item
15618 Storing the new address in @code{*@var{ra-address}},
15619 if @var{ra-address} is nonnull.
15620 @end itemize
15621
15622 The default is @option{-mno-mcount-ra-address}.
15623
15624 @end table
15625
15626 @node MMIX Options
15627 @subsection MMIX Options
15628 @cindex MMIX Options
15629
15630 These options are defined for the MMIX:
15631
15632 @table @gcctabopt
15633 @item -mlibfuncs
15634 @itemx -mno-libfuncs
15635 @opindex mlibfuncs
15636 @opindex mno-libfuncs
15637 Specify that intrinsic library functions are being compiled, passing all
15638 values in registers, no matter the size.
15639
15640 @item -mepsilon
15641 @itemx -mno-epsilon
15642 @opindex mepsilon
15643 @opindex mno-epsilon
15644 Generate floating-point comparison instructions that compare with respect
15645 to the @code{rE} epsilon register.
15646
15647 @item -mabi=mmixware
15648 @itemx -mabi=gnu
15649 @opindex mabi=mmixware
15650 @opindex mabi=gnu
15651 Generate code that passes function parameters and return values that (in
15652 the called function) are seen as registers @code{$0} and up, as opposed to
15653 the GNU ABI which uses global registers @code{$231} and up.
15654
15655 @item -mzero-extend
15656 @itemx -mno-zero-extend
15657 @opindex mzero-extend
15658 @opindex mno-zero-extend
15659 When reading data from memory in sizes shorter than 64 bits, use (do not
15660 use) zero-extending load instructions by default, rather than
15661 sign-extending ones.
15662
15663 @item -mknuthdiv
15664 @itemx -mno-knuthdiv
15665 @opindex mknuthdiv
15666 @opindex mno-knuthdiv
15667 Make the result of a division yielding a remainder have the same sign as
15668 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
15669 remainder follows the sign of the dividend.  Both methods are
15670 arithmetically valid, the latter being almost exclusively used.
15671
15672 @item -mtoplevel-symbols
15673 @itemx -mno-toplevel-symbols
15674 @opindex mtoplevel-symbols
15675 @opindex mno-toplevel-symbols
15676 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
15677 code can be used with the @code{PREFIX} assembly directive.
15678
15679 @item -melf
15680 @opindex melf
15681 Generate an executable in the ELF format, rather than the default
15682 @samp{mmo} format used by the @command{mmix} simulator.
15683
15684 @item -mbranch-predict
15685 @itemx -mno-branch-predict
15686 @opindex mbranch-predict
15687 @opindex mno-branch-predict
15688 Use (do not use) the probable-branch instructions, when static branch
15689 prediction indicates a probable branch.
15690
15691 @item -mbase-addresses
15692 @itemx -mno-base-addresses
15693 @opindex mbase-addresses
15694 @opindex mno-base-addresses
15695 Generate (do not generate) code that uses @emph{base addresses}.  Using a
15696 base address automatically generates a request (handled by the assembler
15697 and the linker) for a constant to be set up in a global register.  The
15698 register is used for one or more base address requests within the range 0
15699 to 255 from the value held in the register.  The generally leads to short
15700 and fast code, but the number of different data items that can be
15701 addressed is limited.  This means that a program that uses lots of static
15702 data may require @option{-mno-base-addresses}.
15703
15704 @item -msingle-exit
15705 @itemx -mno-single-exit
15706 @opindex msingle-exit
15707 @opindex mno-single-exit
15708 Force (do not force) generated code to have a single exit point in each
15709 function.
15710 @end table
15711
15712 @node MN10300 Options
15713 @subsection MN10300 Options
15714 @cindex MN10300 options
15715
15716 These @option{-m} options are defined for Matsushita MN10300 architectures:
15717
15718 @table @gcctabopt
15719 @item -mmult-bug
15720 @opindex mmult-bug
15721 Generate code to avoid bugs in the multiply instructions for the MN10300
15722 processors.  This is the default.
15723
15724 @item -mno-mult-bug
15725 @opindex mno-mult-bug
15726 Do not generate code to avoid bugs in the multiply instructions for the
15727 MN10300 processors.
15728
15729 @item -mam33
15730 @opindex mam33
15731 Generate code which uses features specific to the AM33 processor.
15732
15733 @item -mno-am33
15734 @opindex mno-am33
15735 Do not generate code which uses features specific to the AM33 processor.  This
15736 is the default.
15737
15738 @item -mam33-2
15739 @opindex mam33-2
15740 Generate code which uses features specific to the AM33/2.0 processor.
15741
15742 @item -mam34
15743 @opindex mam34
15744 Generate code which uses features specific to the AM34 processor.
15745
15746 @item -mtune=@var{cpu-type}
15747 @opindex mtune
15748 Use the timing characteristics of the indicated CPU type when
15749 scheduling instructions.  This does not change the targeted processor
15750 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
15751 @samp{am33-2} or @samp{am34}.
15752
15753 @item -mreturn-pointer-on-d0
15754 @opindex mreturn-pointer-on-d0
15755 When generating a function which returns a pointer, return the pointer
15756 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
15757 only in a0, and attempts to call such functions without a prototype
15758 would result in errors.  Note that this option is on by default; use
15759 @option{-mno-return-pointer-on-d0} to disable it.
15760
15761 @item -mno-crt0
15762 @opindex mno-crt0
15763 Do not link in the C run-time initialization object file.
15764
15765 @item -mrelax
15766 @opindex mrelax
15767 Indicate to the linker that it should perform a relaxation optimization pass
15768 to shorten branches, calls and absolute memory addresses.  This option only
15769 has an effect when used on the command line for the final link step.
15770
15771 This option makes symbolic debugging impossible.
15772
15773 @item -mliw
15774 @opindex mliw
15775 Allow the compiler to generate @emph{Long Instruction Word}
15776 instructions if the target is the @samp{AM33} or later.  This is the
15777 default.  This option defines the preprocessor macro @samp{__LIW__}.
15778
15779 @item -mnoliw
15780 @opindex mnoliw
15781 Do not allow the compiler to generate @emph{Long Instruction Word}
15782 instructions.  This option defines the preprocessor macro
15783 @samp{__NO_LIW__}.
15784
15785 @item -msetlb
15786 @opindex msetlb
15787 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
15788 instructions if the target is the @samp{AM33} or later.  This is the
15789 default.  This option defines the preprocessor macro @samp{__SETLB__}.
15790
15791 @item -mnosetlb
15792 @opindex mnosetlb
15793 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
15794 instructions.  This option defines the preprocessor macro
15795 @samp{__NO_SETLB__}.
15796
15797 @end table
15798
15799 @node PDP-11 Options
15800 @subsection PDP-11 Options
15801 @cindex PDP-11 Options
15802
15803 These options are defined for the PDP-11:
15804
15805 @table @gcctabopt
15806 @item -mfpu
15807 @opindex mfpu
15808 Use hardware FPP floating point.  This is the default.  (FIS floating
15809 point on the PDP-11/40 is not supported.)
15810
15811 @item -msoft-float
15812 @opindex msoft-float
15813 Do not use hardware floating point.
15814
15815 @item -mac0
15816 @opindex mac0
15817 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
15818
15819 @item -mno-ac0
15820 @opindex mno-ac0
15821 Return floating-point results in memory.  This is the default.
15822
15823 @item -m40
15824 @opindex m40
15825 Generate code for a PDP-11/40.
15826
15827 @item -m45
15828 @opindex m45
15829 Generate code for a PDP-11/45.  This is the default.
15830
15831 @item -m10
15832 @opindex m10
15833 Generate code for a PDP-11/10.
15834
15835 @item -mbcopy-builtin
15836 @opindex mbcopy-builtin
15837 Use inline @code{movmemhi} patterns for copying memory.  This is the
15838 default.
15839
15840 @item -mbcopy
15841 @opindex mbcopy
15842 Do not use inline @code{movmemhi} patterns for copying memory.
15843
15844 @item -mint16
15845 @itemx -mno-int32
15846 @opindex mint16
15847 @opindex mno-int32
15848 Use 16-bit @code{int}.  This is the default.
15849
15850 @item -mint32
15851 @itemx -mno-int16
15852 @opindex mint32
15853 @opindex mno-int16
15854 Use 32-bit @code{int}.
15855
15856 @item -mfloat64
15857 @itemx -mno-float32
15858 @opindex mfloat64
15859 @opindex mno-float32
15860 Use 64-bit @code{float}.  This is the default.
15861
15862 @item -mfloat32
15863 @itemx -mno-float64
15864 @opindex mfloat32
15865 @opindex mno-float64
15866 Use 32-bit @code{float}.
15867
15868 @item -mabshi
15869 @opindex mabshi
15870 Use @code{abshi2} pattern.  This is the default.
15871
15872 @item -mno-abshi
15873 @opindex mno-abshi
15874 Do not use @code{abshi2} pattern.
15875
15876 @item -mbranch-expensive
15877 @opindex mbranch-expensive
15878 Pretend that branches are expensive.  This is for experimenting with
15879 code generation only.
15880
15881 @item -mbranch-cheap
15882 @opindex mbranch-cheap
15883 Do not pretend that branches are expensive.  This is the default.
15884
15885 @item -munix-asm
15886 @opindex munix-asm
15887 Use Unix assembler syntax.  This is the default when configured for
15888 @samp{pdp11-*-bsd}.
15889
15890 @item -mdec-asm
15891 @opindex mdec-asm
15892 Use DEC assembler syntax.  This is the default when configured for any
15893 PDP-11 target other than @samp{pdp11-*-bsd}.
15894 @end table
15895
15896 @node picoChip Options
15897 @subsection picoChip Options
15898 @cindex picoChip options
15899
15900 These @samp{-m} options are defined for picoChip implementations:
15901
15902 @table @gcctabopt
15903
15904 @item -mae=@var{ae_type}
15905 @opindex mcpu
15906 Set the instruction set, register set, and instruction scheduling
15907 parameters for array element type @var{ae_type}.  Supported values
15908 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
15909
15910 @option{-mae=ANY} selects a completely generic AE type.  Code
15911 generated with this option will run on any of the other AE types.  The
15912 code will not be as efficient as it would be if compiled for a specific
15913 AE type, and some types of operation (e.g., multiplication) will not
15914 work properly on all types of AE.
15915
15916 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
15917 for compiled code, and is the default.
15918
15919 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
15920 option may suffer from poor performance of byte (char) manipulation,
15921 since the DSP AE does not provide hardware support for byte load/stores.
15922
15923 @item -msymbol-as-address
15924 Enable the compiler to directly use a symbol name as an address in a
15925 load/store instruction, without first loading it into a
15926 register.  Typically, the use of this option will generate larger
15927 programs, which run faster than when the option isn't used.  However, the
15928 results vary from program to program, so it is left as a user option,
15929 rather than being permanently enabled.
15930
15931 @item -mno-inefficient-warnings
15932 Disables warnings about the generation of inefficient code.  These
15933 warnings can be generated, for example, when compiling code which
15934 performs byte-level memory operations on the MAC AE type.  The MAC AE has
15935 no hardware support for byte-level memory operations, so all byte
15936 load/stores must be synthesized from word load/store operations.  This is
15937 inefficient and a warning will be generated indicating to the programmer
15938 that they should rewrite the code to avoid byte operations, or to target
15939 an AE type which has the necessary hardware support.  This option enables
15940 the warning to be turned off.
15941
15942 @end table
15943
15944 @node PowerPC Options
15945 @subsection PowerPC Options
15946 @cindex PowerPC options
15947
15948 These are listed under @xref{RS/6000 and PowerPC Options}.
15949
15950 @node RL78 Options
15951 @subsection RL78 Options
15952 @cindex RL78 Options
15953
15954 @table @gcctabopt
15955
15956 @item -msim
15957 @opindex msim
15958 Links in additional target libraries to support operation within a
15959 simulator.
15960
15961 @item -mmul=none
15962 @itemx -mmul=g13
15963 @itemx -mmul=rl78
15964 @opindex mmul
15965 Specifies the type of hardware multiplication support to be used.  The
15966 default is @code{none}, which uses software multiplication functions.
15967 The @code{g13} option is for the hardware multiply/divide peripheral
15968 only on the RL78/G13 targets.  The @code{rl78} option is for the
15969 standard hardware multiplication defined in the RL78 software manual.
15970
15971 @end table
15972
15973 @node RS/6000 and PowerPC Options
15974 @subsection IBM RS/6000 and PowerPC Options
15975 @cindex RS/6000 and PowerPC Options
15976 @cindex IBM RS/6000 and PowerPC Options
15977
15978 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
15979 @table @gcctabopt
15980 @item -mpower
15981 @itemx -mno-power
15982 @itemx -mpower2
15983 @itemx -mno-power2
15984 @itemx -mpowerpc
15985 @itemx -mno-powerpc
15986 @itemx -mpowerpc-gpopt
15987 @itemx -mno-powerpc-gpopt
15988 @itemx -mpowerpc-gfxopt
15989 @itemx -mno-powerpc-gfxopt
15990 @need 800
15991 @itemx -mpowerpc64
15992 @itemx -mno-powerpc64
15993 @itemx -mmfcrf
15994 @itemx -mno-mfcrf
15995 @itemx -mpopcntb
15996 @itemx -mno-popcntb
15997 @itemx -mpopcntd
15998 @itemx -mno-popcntd
15999 @itemx -mfprnd
16000 @itemx -mno-fprnd
16001 @need 800
16002 @itemx -mcmpb
16003 @itemx -mno-cmpb
16004 @itemx -mmfpgpr
16005 @itemx -mno-mfpgpr
16006 @itemx -mhard-dfp
16007 @itemx -mno-hard-dfp
16008 @opindex mpower
16009 @opindex mno-power
16010 @opindex mpower2
16011 @opindex mno-power2
16012 @opindex mpowerpc
16013 @opindex mno-powerpc
16014 @opindex mpowerpc-gpopt
16015 @opindex mno-powerpc-gpopt
16016 @opindex mpowerpc-gfxopt
16017 @opindex mno-powerpc-gfxopt
16018 @opindex mpowerpc64
16019 @opindex mno-powerpc64
16020 @opindex mmfcrf
16021 @opindex mno-mfcrf
16022 @opindex mpopcntb
16023 @opindex mno-popcntb
16024 @opindex mpopcntd
16025 @opindex mno-popcntd
16026 @opindex mfprnd
16027 @opindex mno-fprnd
16028 @opindex mcmpb
16029 @opindex mno-cmpb
16030 @opindex mmfpgpr
16031 @opindex mno-mfpgpr
16032 @opindex mhard-dfp
16033 @opindex mno-hard-dfp
16034 GCC supports two related instruction set architectures for the
16035 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
16036 instructions supported by the @samp{rios} chip set used in the original
16037 RS/6000 systems and the @dfn{PowerPC} instruction set is the
16038 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
16039 the IBM 4xx, 6xx, and follow-on microprocessors.
16040
16041 Neither architecture is a subset of the other.  However there is a
16042 large common subset of instructions supported by both.  An MQ
16043 register is included in processors supporting the POWER architecture.
16044
16045 You use these options to specify which instructions are available on the
16046 processor you are using.  The default value of these options is
16047 determined when configuring GCC@.  Specifying the
16048 @option{-mcpu=@var{cpu_type}} overrides the specification of these
16049 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
16050 rather than the options listed above.
16051
16052 The @option{-mpower} option allows GCC to generate instructions that
16053 are found only in the POWER architecture and to use the MQ register.
16054 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
16055 to generate instructions that are present in the POWER2 architecture but
16056 not the original POWER architecture.
16057
16058 The @option{-mpowerpc} option allows GCC to generate instructions that
16059 are found only in the 32-bit subset of the PowerPC architecture.
16060 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
16061 GCC to use the optional PowerPC architecture instructions in the
16062 General Purpose group, including floating-point square root.  Specifying
16063 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
16064 use the optional PowerPC architecture instructions in the Graphics
16065 group, including floating-point select.
16066
16067 The @option{-mmfcrf} option allows GCC to generate the move from
16068 condition register field instruction implemented on the POWER4
16069 processor and other processors that support the PowerPC V2.01
16070 architecture.
16071 The @option{-mpopcntb} option allows GCC to generate the popcount and
16072 double precision FP reciprocal estimate instruction implemented on the
16073 POWER5 processor and other processors that support the PowerPC V2.02
16074 architecture.
16075 The @option{-mpopcntd} option allows GCC to generate the popcount
16076 instruction implemented on the POWER7 processor and other processors
16077 that support the PowerPC V2.06 architecture.
16078 The @option{-mfprnd} option allows GCC to generate the FP round to
16079 integer instructions implemented on the POWER5+ processor and other
16080 processors that support the PowerPC V2.03 architecture.
16081 The @option{-mcmpb} option allows GCC to generate the compare bytes
16082 instruction implemented on the POWER6 processor and other processors
16083 that support the PowerPC V2.05 architecture.
16084 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
16085 general purpose register instructions implemented on the POWER6X
16086 processor and other processors that support the extended PowerPC V2.05
16087 architecture.
16088 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
16089 point instructions implemented on some POWER processors.
16090
16091 The @option{-mpowerpc64} option allows GCC to generate the additional
16092 64-bit instructions that are found in the full PowerPC64 architecture
16093 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
16094 @option{-mno-powerpc64}.
16095
16096 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
16097 will use only the instructions in the common subset of both
16098 architectures plus some special AIX common-mode calls, and will not use
16099 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
16100 permits GCC to use any instruction from either architecture and to
16101 allow use of the MQ register; specify this for the Motorola MPC601.
16102
16103 @item -mnew-mnemonics
16104 @itemx -mold-mnemonics
16105 @opindex mnew-mnemonics
16106 @opindex mold-mnemonics
16107 Select which mnemonics to use in the generated assembler code.  With
16108 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
16109 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
16110 assembler mnemonics defined for the POWER architecture.  Instructions
16111 defined in only one architecture have only one mnemonic; GCC uses that
16112 mnemonic irrespective of which of these options is specified.
16113
16114 GCC defaults to the mnemonics appropriate for the architecture in
16115 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
16116 value of these option.  Unless you are building a cross-compiler, you
16117 should normally not specify either @option{-mnew-mnemonics} or
16118 @option{-mold-mnemonics}, but should instead accept the default.
16119
16120 @item -mcpu=@var{cpu_type}
16121 @opindex mcpu
16122 Set architecture type, register usage, choice of mnemonics, and
16123 instruction scheduling parameters for machine type @var{cpu_type}.
16124 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
16125 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
16126 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
16127 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
16128 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
16129 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
16130 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
16131 @samp{G4}, @samp{G5}, @samp{titan}, @samp{power}, @samp{power2}, @samp{power3},
16132 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
16133 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
16134 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
16135
16136 @option{-mcpu=common} selects a completely generic processor.  Code
16137 generated under this option will run on any POWER or PowerPC processor.
16138 GCC will use only the instructions in the common subset of both
16139 architectures, and will not use the MQ register.  GCC assumes a generic
16140 processor model for scheduling purposes.
16141
16142 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
16143 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
16144 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
16145 types, with an appropriate, generic processor model assumed for
16146 scheduling purposes.
16147
16148 The other options specify a specific processor.  Code generated under
16149 those options will run best on that processor, and may not run at all on
16150 others.
16151
16152 The @option{-mcpu} options automatically enable or disable the
16153 following options:
16154
16155 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
16156 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
16157 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
16158 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
16159
16160 The particular options set for any particular CPU will vary between
16161 compiler versions, depending on what setting seems to produce optimal
16162 code for that CPU; it doesn't necessarily reflect the actual hardware's
16163 capabilities.  If you wish to set an individual option to a particular
16164 value, you may specify it after the @option{-mcpu} option, like
16165 @samp{-mcpu=970 -mno-altivec}.
16166
16167 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
16168 not enabled or disabled by the @option{-mcpu} option at present because
16169 AIX does not have full support for these options.  You may still
16170 enable or disable them individually if you're sure it'll work in your
16171 environment.
16172
16173 @item -mtune=@var{cpu_type}
16174 @opindex mtune
16175 Set the instruction scheduling parameters for machine type
16176 @var{cpu_type}, but do not set the architecture type, register usage, or
16177 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
16178 values for @var{cpu_type} are used for @option{-mtune} as for
16179 @option{-mcpu}.  If both are specified, the code generated will use the
16180 architecture, registers, and mnemonics set by @option{-mcpu}, but the
16181 scheduling parameters set by @option{-mtune}.
16182
16183 @item -mcmodel=small
16184 @opindex mcmodel=small
16185 Generate PowerPC64 code for the small model: The TOC is limited to
16186 64k.
16187
16188 @item -mcmodel=medium
16189 @opindex mcmodel=medium
16190 Generate PowerPC64 code for the medium model: The TOC and other static
16191 data may be up to a total of 4G in size.
16192
16193 @item -mcmodel=large
16194 @opindex mcmodel=large
16195 Generate PowerPC64 code for the large model: The TOC may be up to 4G
16196 in size.  Other data and code is only limited by the 64-bit address
16197 space.
16198
16199 @item -maltivec
16200 @itemx -mno-altivec
16201 @opindex maltivec
16202 @opindex mno-altivec
16203 Generate code that uses (does not use) AltiVec instructions, and also
16204 enable the use of built-in functions that allow more direct access to
16205 the AltiVec instruction set.  You may also need to set
16206 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
16207 enhancements.
16208
16209 @item -mvrsave
16210 @itemx -mno-vrsave
16211 @opindex mvrsave
16212 @opindex mno-vrsave
16213 Generate VRSAVE instructions when generating AltiVec code.
16214
16215 @item -mgen-cell-microcode
16216 @opindex mgen-cell-microcode
16217 Generate Cell microcode instructions
16218
16219 @item -mwarn-cell-microcode
16220 @opindex mwarn-cell-microcode
16221 Warning when a Cell microcode instruction is going to emitted.  An example
16222 of a Cell microcode instruction is a variable shift.
16223
16224 @item -msecure-plt
16225 @opindex msecure-plt
16226 Generate code that allows ld and ld.so to build executables and shared
16227 libraries with non-exec .plt and .got sections.  This is a PowerPC
16228 32-bit SYSV ABI option.
16229
16230 @item -mbss-plt
16231 @opindex mbss-plt
16232 Generate code that uses a BSS .plt section that ld.so fills in, and
16233 requires .plt and .got sections that are both writable and executable.
16234 This is a PowerPC 32-bit SYSV ABI option.
16235
16236 @item -misel
16237 @itemx -mno-isel
16238 @opindex misel
16239 @opindex mno-isel
16240 This switch enables or disables the generation of ISEL instructions.
16241
16242 @item -misel=@var{yes/no}
16243 This switch has been deprecated.  Use @option{-misel} and
16244 @option{-mno-isel} instead.
16245
16246 @item -mspe
16247 @itemx -mno-spe
16248 @opindex mspe
16249 @opindex mno-spe
16250 This switch enables or disables the generation of SPE simd
16251 instructions.
16252
16253 @item -mpaired
16254 @itemx -mno-paired
16255 @opindex mpaired
16256 @opindex mno-paired
16257 This switch enables or disables the generation of PAIRED simd
16258 instructions.
16259
16260 @item -mspe=@var{yes/no}
16261 This option has been deprecated.  Use @option{-mspe} and
16262 @option{-mno-spe} instead.
16263
16264 @item -mvsx
16265 @itemx -mno-vsx
16266 @opindex mvsx
16267 @opindex mno-vsx
16268 Generate code that uses (does not use) vector/scalar (VSX)
16269 instructions, and also enable the use of built-in functions that allow
16270 more direct access to the VSX instruction set.
16271
16272 @item -mfloat-gprs=@var{yes/single/double/no}
16273 @itemx -mfloat-gprs
16274 @opindex mfloat-gprs
16275 This switch enables or disables the generation of floating point
16276 operations on the general purpose registers for architectures that
16277 support it.
16278
16279 The argument @var{yes} or @var{single} enables the use of
16280 single-precision floating point operations.
16281
16282 The argument @var{double} enables the use of single and
16283 double-precision floating point operations.
16284
16285 The argument @var{no} disables floating point operations on the
16286 general purpose registers.
16287
16288 This option is currently only available on the MPC854x.
16289
16290 @item -m32
16291 @itemx -m64
16292 @opindex m32
16293 @opindex m64
16294 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
16295 targets (including GNU/Linux).  The 32-bit environment sets int, long
16296 and pointer to 32 bits and generates code that runs on any PowerPC
16297 variant.  The 64-bit environment sets int to 32 bits and long and
16298 pointer to 64 bits, and generates code for PowerPC64, as for
16299 @option{-mpowerpc64}.
16300
16301 @item -mfull-toc
16302 @itemx -mno-fp-in-toc
16303 @itemx -mno-sum-in-toc
16304 @itemx -mminimal-toc
16305 @opindex mfull-toc
16306 @opindex mno-fp-in-toc
16307 @opindex mno-sum-in-toc
16308 @opindex mminimal-toc
16309 Modify generation of the TOC (Table Of Contents), which is created for
16310 every executable file.  The @option{-mfull-toc} option is selected by
16311 default.  In that case, GCC will allocate at least one TOC entry for
16312 each unique non-automatic variable reference in your program.  GCC
16313 will also place floating-point constants in the TOC@.  However, only
16314 16,384 entries are available in the TOC@.
16315
16316 If you receive a linker error message that saying you have overflowed
16317 the available TOC space, you can reduce the amount of TOC space used
16318 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
16319 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
16320 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
16321 generate code to calculate the sum of an address and a constant at
16322 run-time instead of putting that sum into the TOC@.  You may specify one
16323 or both of these options.  Each causes GCC to produce very slightly
16324 slower and larger code at the expense of conserving TOC space.
16325
16326 If you still run out of space in the TOC even when you specify both of
16327 these options, specify @option{-mminimal-toc} instead.  This option causes
16328 GCC to make only one TOC entry for every file.  When you specify this
16329 option, GCC will produce code that is slower and larger but which
16330 uses extremely little TOC space.  You may wish to use this option
16331 only on files that contain less frequently executed code.
16332
16333 @item -maix64
16334 @itemx -maix32
16335 @opindex maix64
16336 @opindex maix32
16337 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
16338 @code{long} type, and the infrastructure needed to support them.
16339 Specifying @option{-maix64} implies @option{-mpowerpc64} and
16340 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
16341 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
16342
16343 @item -mxl-compat
16344 @itemx -mno-xl-compat
16345 @opindex mxl-compat
16346 @opindex mno-xl-compat
16347 Produce code that conforms more closely to IBM XL compiler semantics
16348 when using AIX-compatible ABI@.  Pass floating-point arguments to
16349 prototyped functions beyond the register save area (RSA) on the stack
16350 in addition to argument FPRs.  Do not assume that most significant
16351 double in 128-bit long double value is properly rounded when comparing
16352 values and converting to double.  Use XL symbol names for long double
16353 support routines.
16354
16355 The AIX calling convention was extended but not initially documented to
16356 handle an obscure K&R C case of calling a function that takes the
16357 address of its arguments with fewer arguments than declared.  IBM XL
16358 compilers access floating point arguments which do not fit in the
16359 RSA from the stack when a subroutine is compiled without
16360 optimization.  Because always storing floating-point arguments on the
16361 stack is inefficient and rarely needed, this option is not enabled by
16362 default and only is necessary when calling subroutines compiled by IBM
16363 XL compilers without optimization.
16364
16365 @item -mpe
16366 @opindex mpe
16367 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
16368 application written to use message passing with special startup code to
16369 enable the application to run.  The system must have PE installed in the
16370 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
16371 must be overridden with the @option{-specs=} option to specify the
16372 appropriate directory location.  The Parallel Environment does not
16373 support threads, so the @option{-mpe} option and the @option{-pthread}
16374 option are incompatible.
16375
16376 @item -malign-natural
16377 @itemx -malign-power
16378 @opindex malign-natural
16379 @opindex malign-power
16380 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
16381 @option{-malign-natural} overrides the ABI-defined alignment of larger
16382 types, such as floating-point doubles, on their natural size-based boundary.
16383 The option @option{-malign-power} instructs GCC to follow the ABI-specified
16384 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
16385
16386 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
16387 is not supported.
16388
16389 @item -msoft-float
16390 @itemx -mhard-float
16391 @opindex msoft-float
16392 @opindex mhard-float
16393 Generate code that does not use (uses) the floating-point register set.
16394 Software floating point emulation is provided if you use the
16395 @option{-msoft-float} option, and pass the option to GCC when linking.
16396
16397 @item -msingle-float
16398 @itemx -mdouble-float
16399 @opindex msingle-float
16400 @opindex mdouble-float
16401 Generate code for single or double-precision floating point operations.
16402 @option{-mdouble-float} implies @option{-msingle-float}.
16403
16404 @item -msimple-fpu
16405 @opindex msimple-fpu
16406 Do not generate sqrt and div instructions for hardware floating point unit.
16407
16408 @item -mfpu
16409 @opindex mfpu
16410 Specify type of floating point unit.  Valid values are @var{sp_lite}
16411 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
16412 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
16413 and @var{dp_full} (equivalent to -mdouble-float).
16414
16415 @item -mxilinx-fpu
16416 @opindex mxilinx-fpu
16417 Perform optimizations for floating point unit on Xilinx PPC 405/440.
16418
16419 @item -mmultiple
16420 @itemx -mno-multiple
16421 @opindex mmultiple
16422 @opindex mno-multiple
16423 Generate code that uses (does not use) the load multiple word
16424 instructions and the store multiple word instructions.  These
16425 instructions are generated by default on POWER systems, and not
16426 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
16427 endian PowerPC systems, since those instructions do not work when the
16428 processor is in little endian mode.  The exceptions are PPC740 and
16429 PPC750 which permit the instructions usage in little endian mode.
16430
16431 @item -mstring
16432 @itemx -mno-string
16433 @opindex mstring
16434 @opindex mno-string
16435 Generate code that uses (does not use) the load string instructions
16436 and the store string word instructions to save multiple registers and
16437 do small block moves.  These instructions are generated by default on
16438 POWER systems, and not generated on PowerPC systems.  Do not use
16439 @option{-mstring} on little endian PowerPC systems, since those
16440 instructions do not work when the processor is in little endian mode.
16441 The exceptions are PPC740 and PPC750 which permit the instructions
16442 usage in little endian mode.
16443
16444 @item -mupdate
16445 @itemx -mno-update
16446 @opindex mupdate
16447 @opindex mno-update
16448 Generate code that uses (does not use) the load or store instructions
16449 that update the base register to the address of the calculated memory
16450 location.  These instructions are generated by default.  If you use
16451 @option{-mno-update}, there is a small window between the time that the
16452 stack pointer is updated and the address of the previous frame is
16453 stored, which means code that walks the stack frame across interrupts or
16454 signals may get corrupted data.
16455
16456 @item -mavoid-indexed-addresses
16457 @itemx -mno-avoid-indexed-addresses
16458 @opindex mavoid-indexed-addresses
16459 @opindex mno-avoid-indexed-addresses
16460 Generate code that tries to avoid (not avoid) the use of indexed load
16461 or store instructions. These instructions can incur a performance
16462 penalty on Power6 processors in certain situations, such as when
16463 stepping through large arrays that cross a 16M boundary.  This option
16464 is enabled by default when targetting Power6 and disabled otherwise.
16465
16466 @item -mfused-madd
16467 @itemx -mno-fused-madd
16468 @opindex mfused-madd
16469 @opindex mno-fused-madd
16470 Generate code that uses (does not use) the floating point multiply and
16471 accumulate instructions.  These instructions are generated by default
16472 if hardware floating point is used.  The machine dependent
16473 @option{-mfused-madd} option is now mapped to the machine independent
16474 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
16475 mapped to @option{-ffp-contract=off}.
16476
16477 @item -mmulhw
16478 @itemx -mno-mulhw
16479 @opindex mmulhw
16480 @opindex mno-mulhw
16481 Generate code that uses (does not use) the half-word multiply and
16482 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
16483 These instructions are generated by default when targetting those
16484 processors.
16485
16486 @item -mdlmzb
16487 @itemx -mno-dlmzb
16488 @opindex mdlmzb
16489 @opindex mno-dlmzb
16490 Generate code that uses (does not use) the string-search @samp{dlmzb}
16491 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
16492 generated by default when targetting those processors.
16493
16494 @item -mno-bit-align
16495 @itemx -mbit-align
16496 @opindex mno-bit-align
16497 @opindex mbit-align
16498 On System V.4 and embedded PowerPC systems do not (do) force structures
16499 and unions that contain bit-fields to be aligned to the base type of the
16500 bit-field.
16501
16502 For example, by default a structure containing nothing but 8
16503 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
16504 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
16505 the structure would be aligned to a 1 byte boundary and be one byte in
16506 size.
16507
16508 @item -mno-strict-align
16509 @itemx -mstrict-align
16510 @opindex mno-strict-align
16511 @opindex mstrict-align
16512 On System V.4 and embedded PowerPC systems do not (do) assume that
16513 unaligned memory references will be handled by the system.
16514
16515 @item -mrelocatable
16516 @itemx -mno-relocatable
16517 @opindex mrelocatable
16518 @opindex mno-relocatable
16519 Generate code that allows (does not allow) a static executable to be
16520 relocated to a different address at runtime.  A simple embedded
16521 PowerPC system loader should relocate the entire contents of
16522 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
16523 a table of 32-bit addresses generated by this option.  For this to
16524 work, all objects linked together must be compiled with
16525 @option{-mrelocatable} or @option{-mrelocatable-lib}.
16526 @option{-mrelocatable} code aligns the stack to an 8 byte boundary.
16527
16528 @item -mrelocatable-lib
16529 @itemx -mno-relocatable-lib
16530 @opindex mrelocatable-lib
16531 @opindex mno-relocatable-lib
16532 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
16533 @code{.fixup} section to allow static executables to be relocated at
16534 runtime, but @option{-mrelocatable-lib} does not use the smaller stack
16535 alignment of @option{-mrelocatable}.  Objects compiled with
16536 @option{-mrelocatable-lib} may be linked with objects compiled with
16537 any combination of the @option{-mrelocatable} options.
16538
16539 @item -mno-toc
16540 @itemx -mtoc
16541 @opindex mno-toc
16542 @opindex mtoc
16543 On System V.4 and embedded PowerPC systems do not (do) assume that
16544 register 2 contains a pointer to a global area pointing to the addresses
16545 used in the program.
16546
16547 @item -mlittle
16548 @itemx -mlittle-endian
16549 @opindex mlittle
16550 @opindex mlittle-endian
16551 On System V.4 and embedded PowerPC systems compile code for the
16552 processor in little endian mode.  The @option{-mlittle-endian} option is
16553 the same as @option{-mlittle}.
16554
16555 @item -mbig
16556 @itemx -mbig-endian
16557 @opindex mbig
16558 @opindex mbig-endian
16559 On System V.4 and embedded PowerPC systems compile code for the
16560 processor in big endian mode.  The @option{-mbig-endian} option is
16561 the same as @option{-mbig}.
16562
16563 @item -mdynamic-no-pic
16564 @opindex mdynamic-no-pic
16565 On Darwin and Mac OS X systems, compile code so that it is not
16566 relocatable, but that its external references are relocatable.  The
16567 resulting code is suitable for applications, but not shared
16568 libraries.
16569
16570 @item -msingle-pic-base
16571 @opindex msingle-pic-base
16572 Treat the register used for PIC addressing as read-only, rather than
16573 loading it in the prologue for each function.  The run-time system is
16574 responsible for initializing this register with an appropriate value
16575 before execution begins.
16576
16577 @item -mprioritize-restricted-insns=@var{priority}
16578 @opindex mprioritize-restricted-insns
16579 This option controls the priority that is assigned to
16580 dispatch-slot restricted instructions during the second scheduling
16581 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
16582 @var{no/highest/second-highest} priority to dispatch slot restricted
16583 instructions.
16584
16585 @item -msched-costly-dep=@var{dependence_type}
16586 @opindex msched-costly-dep
16587 This option controls which dependences are considered costly
16588 by the target during instruction scheduling.  The argument
16589 @var{dependence_type} takes one of the following values:
16590 @var{no}: no dependence is costly,
16591 @var{all}: all dependences are costly,
16592 @var{true_store_to_load}: a true dependence from store to load is costly,
16593 @var{store_to_load}: any dependence from store to load is costly,
16594 @var{number}: any dependence which latency >= @var{number} is costly.
16595
16596 @item -minsert-sched-nops=@var{scheme}
16597 @opindex minsert-sched-nops
16598 This option controls which nop insertion scheme will be used during
16599 the second scheduling pass.  The argument @var{scheme} takes one of the
16600 following values:
16601 @var{no}: Don't insert nops.
16602 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
16603 according to the scheduler's grouping.
16604 @var{regroup_exact}: Insert nops to force costly dependent insns into
16605 separate groups.  Insert exactly as many nops as needed to force an insn
16606 to a new group, according to the estimated processor grouping.
16607 @var{number}: Insert nops to force costly dependent insns into
16608 separate groups.  Insert @var{number} nops to force an insn to a new group.
16609
16610 @item -mcall-sysv
16611 @opindex mcall-sysv
16612 On System V.4 and embedded PowerPC systems compile code using calling
16613 conventions that adheres to the March 1995 draft of the System V
16614 Application Binary Interface, PowerPC processor supplement.  This is the
16615 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
16616
16617 @item -mcall-sysv-eabi
16618 @itemx -mcall-eabi
16619 @opindex mcall-sysv-eabi
16620 @opindex mcall-eabi
16621 Specify both @option{-mcall-sysv} and @option{-meabi} options.
16622
16623 @item -mcall-sysv-noeabi
16624 @opindex mcall-sysv-noeabi
16625 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
16626
16627 @item -mcall-aixdesc
16628 @opindex m
16629 On System V.4 and embedded PowerPC systems compile code for the AIX
16630 operating system.
16631
16632 @item -mcall-linux
16633 @opindex mcall-linux
16634 On System V.4 and embedded PowerPC systems compile code for the
16635 Linux-based GNU system.
16636
16637 @item -mcall-freebsd
16638 @opindex mcall-freebsd
16639 On System V.4 and embedded PowerPC systems compile code for the
16640 FreeBSD operating system.
16641
16642 @item -mcall-netbsd
16643 @opindex mcall-netbsd
16644 On System V.4 and embedded PowerPC systems compile code for the
16645 NetBSD operating system.
16646
16647 @item -mcall-openbsd
16648 @opindex mcall-netbsd
16649 On System V.4 and embedded PowerPC systems compile code for the
16650 OpenBSD operating system.
16651
16652 @item -maix-struct-return
16653 @opindex maix-struct-return
16654 Return all structures in memory (as specified by the AIX ABI)@.
16655
16656 @item -msvr4-struct-return
16657 @opindex msvr4-struct-return
16658 Return structures smaller than 8 bytes in registers (as specified by the
16659 SVR4 ABI)@.
16660
16661 @item -mabi=@var{abi-type}
16662 @opindex mabi
16663 Extend the current ABI with a particular extension, or remove such extension.
16664 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
16665 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
16666
16667 @item -mabi=spe
16668 @opindex mabi=spe
16669 Extend the current ABI with SPE ABI extensions.  This does not change
16670 the default ABI, instead it adds the SPE ABI extensions to the current
16671 ABI@.
16672
16673 @item -mabi=no-spe
16674 @opindex mabi=no-spe
16675 Disable Booke SPE ABI extensions for the current ABI@.
16676
16677 @item -mabi=ibmlongdouble
16678 @opindex mabi=ibmlongdouble
16679 Change the current ABI to use IBM extended precision long double.
16680 This is a PowerPC 32-bit SYSV ABI option.
16681
16682 @item -mabi=ieeelongdouble
16683 @opindex mabi=ieeelongdouble
16684 Change the current ABI to use IEEE extended precision long double.
16685 This is a PowerPC 32-bit Linux ABI option.
16686
16687 @item -mprototype
16688 @itemx -mno-prototype
16689 @opindex mprototype
16690 @opindex mno-prototype
16691 On System V.4 and embedded PowerPC systems assume that all calls to
16692 variable argument functions are properly prototyped.  Otherwise, the
16693 compiler must insert an instruction before every non prototyped call to
16694 set or clear bit 6 of the condition code register (@var{CR}) to
16695 indicate whether floating point values were passed in the floating point
16696 registers in case the function takes a variable arguments.  With
16697 @option{-mprototype}, only calls to prototyped variable argument functions
16698 will set or clear the bit.
16699
16700 @item -msim
16701 @opindex msim
16702 On embedded PowerPC systems, assume that the startup module is called
16703 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
16704 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
16705 configurations.
16706
16707 @item -mmvme
16708 @opindex mmvme
16709 On embedded PowerPC systems, assume that the startup module is called
16710 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
16711 @file{libc.a}.
16712
16713 @item -mads
16714 @opindex mads
16715 On embedded PowerPC systems, assume that the startup module is called
16716 @file{crt0.o} and the standard C libraries are @file{libads.a} and
16717 @file{libc.a}.
16718
16719 @item -myellowknife
16720 @opindex myellowknife
16721 On embedded PowerPC systems, assume that the startup module is called
16722 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
16723 @file{libc.a}.
16724
16725 @item -mvxworks
16726 @opindex mvxworks
16727 On System V.4 and embedded PowerPC systems, specify that you are
16728 compiling for a VxWorks system.
16729
16730 @item -memb
16731 @opindex memb
16732 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
16733 header to indicate that @samp{eabi} extended relocations are used.
16734
16735 @item -meabi
16736 @itemx -mno-eabi
16737 @opindex meabi
16738 @opindex mno-eabi
16739 On System V.4 and embedded PowerPC systems do (do not) adhere to the
16740 Embedded Applications Binary Interface (eabi) which is a set of
16741 modifications to the System V.4 specifications.  Selecting @option{-meabi}
16742 means that the stack is aligned to an 8 byte boundary, a function
16743 @code{__eabi} is called to from @code{main} to set up the eabi
16744 environment, and the @option{-msdata} option can use both @code{r2} and
16745 @code{r13} to point to two separate small data areas.  Selecting
16746 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
16747 do not call an initialization function from @code{main}, and the
16748 @option{-msdata} option will only use @code{r13} to point to a single
16749 small data area.  The @option{-meabi} option is on by default if you
16750 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
16751
16752 @item -msdata=eabi
16753 @opindex msdata=eabi
16754 On System V.4 and embedded PowerPC systems, put small initialized
16755 @code{const} global and static data in the @samp{.sdata2} section, which
16756 is pointed to by register @code{r2}.  Put small initialized
16757 non-@code{const} global and static data in the @samp{.sdata} section,
16758 which is pointed to by register @code{r13}.  Put small uninitialized
16759 global and static data in the @samp{.sbss} section, which is adjacent to
16760 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
16761 incompatible with the @option{-mrelocatable} option.  The
16762 @option{-msdata=eabi} option also sets the @option{-memb} option.
16763
16764 @item -msdata=sysv
16765 @opindex msdata=sysv
16766 On System V.4 and embedded PowerPC systems, put small global and static
16767 data in the @samp{.sdata} section, which is pointed to by register
16768 @code{r13}.  Put small uninitialized global and static data in the
16769 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
16770 The @option{-msdata=sysv} option is incompatible with the
16771 @option{-mrelocatable} option.
16772
16773 @item -msdata=default
16774 @itemx -msdata
16775 @opindex msdata=default
16776 @opindex msdata
16777 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
16778 compile code the same as @option{-msdata=eabi}, otherwise compile code the
16779 same as @option{-msdata=sysv}.
16780
16781 @item -msdata=data
16782 @opindex msdata=data
16783 On System V.4 and embedded PowerPC systems, put small global
16784 data in the @samp{.sdata} section.  Put small uninitialized global
16785 data in the @samp{.sbss} section.  Do not use register @code{r13}
16786 to address small data however.  This is the default behavior unless
16787 other @option{-msdata} options are used.
16788
16789 @item -msdata=none
16790 @itemx -mno-sdata
16791 @opindex msdata=none
16792 @opindex mno-sdata
16793 On embedded PowerPC systems, put all initialized global and static data
16794 in the @samp{.data} section, and all uninitialized data in the
16795 @samp{.bss} section.
16796
16797 @item -mblock-move-inline-limit=@var{num}
16798 @opindex mblock-move-inline-limit
16799 Inline all block moves (such as calls to @code{memcpy} or structure
16800 copies) less than or equal to @var{num} bytes.  The minimum value for
16801 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
16802 targets.  The default value is target-specific.
16803
16804 @item -G @var{num}
16805 @opindex G
16806 @cindex smaller data references (PowerPC)
16807 @cindex .sdata/.sdata2 references (PowerPC)
16808 On embedded PowerPC systems, put global and static items less than or
16809 equal to @var{num} bytes into the small data or bss sections instead of
16810 the normal data or bss section.  By default, @var{num} is 8.  The
16811 @option{-G @var{num}} switch is also passed to the linker.
16812 All modules should be compiled with the same @option{-G @var{num}} value.
16813
16814 @item -mregnames
16815 @itemx -mno-regnames
16816 @opindex mregnames
16817 @opindex mno-regnames
16818 On System V.4 and embedded PowerPC systems do (do not) emit register
16819 names in the assembly language output using symbolic forms.
16820
16821 @item -mlongcall
16822 @itemx -mno-longcall
16823 @opindex mlongcall
16824 @opindex mno-longcall
16825 By default assume that all calls are far away so that a longer more
16826 expensive calling sequence is required.  This is required for calls
16827 further than 32 megabytes (33,554,432 bytes) from the current location.
16828 A short call will be generated if the compiler knows
16829 the call cannot be that far away.  This setting can be overridden by
16830 the @code{shortcall} function attribute, or by @code{#pragma
16831 longcall(0)}.
16832
16833 Some linkers are capable of detecting out-of-range calls and generating
16834 glue code on the fly.  On these systems, long calls are unnecessary and
16835 generate slower code.  As of this writing, the AIX linker can do this,
16836 as can the GNU linker for PowerPC/64.  It is planned to add this feature
16837 to the GNU linker for 32-bit PowerPC systems as well.
16838
16839 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
16840 callee, L42'', plus a ``branch island'' (glue code).  The two target
16841 addresses represent the callee and the ``branch island''.  The
16842 Darwin/PPC linker will prefer the first address and generate a ``bl
16843 callee'' if the PPC ``bl'' instruction will reach the callee directly;
16844 otherwise, the linker will generate ``bl L42'' to call the ``branch
16845 island''.  The ``branch island'' is appended to the body of the
16846 calling function; it computes the full 32-bit address of the callee
16847 and jumps to it.
16848
16849 On Mach-O (Darwin) systems, this option directs the compiler emit to
16850 the glue for every direct call, and the Darwin linker decides whether
16851 to use or discard it.
16852
16853 In the future, we may cause GCC to ignore all longcall specifications
16854 when the linker is known to generate glue.
16855
16856 @item -mtls-markers
16857 @itemx -mno-tls-markers
16858 @opindex mtls-markers
16859 @opindex mno-tls-markers
16860 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
16861 specifying the function argument.  The relocation allows ld to
16862 reliably associate function call with argument setup instructions for
16863 TLS optimization, which in turn allows gcc to better schedule the
16864 sequence.
16865
16866 @item -pthread
16867 @opindex pthread
16868 Adds support for multithreading with the @dfn{pthreads} library.
16869 This option sets flags for both the preprocessor and linker.
16870
16871 @item -mrecip
16872 @itemx -mno-recip
16873 @opindex mrecip
16874 This option will enable GCC to use the reciprocal estimate and
16875 reciprocal square root estimate instructions with additional
16876 Newton-Raphson steps to increase precision instead of doing a divide or
16877 square root and divide for floating point arguments.  You should use
16878 the @option{-ffast-math} option when using @option{-mrecip} (or at
16879 least @option{-funsafe-math-optimizations},
16880 @option{-finite-math-only}, @option{-freciprocal-math} and
16881 @option{-fno-trapping-math}).  Note that while the throughput of the
16882 sequence is generally higher than the throughput of the non-reciprocal
16883 instruction, the precision of the sequence can be decreased by up to 2
16884 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
16885 roots.
16886
16887 @item -mrecip=@var{opt}
16888 @opindex mrecip=opt
16889 This option allows to control which reciprocal estimate instructions
16890 may be used.  @var{opt} is a comma separated list of options, that may
16891 be preceded by a @code{!} to invert the option:
16892 @code{all}: enable all estimate instructions,
16893 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
16894 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
16895 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
16896 @code{divf}: enable the single precision reciprocal approximation instructions;
16897 @code{divd}: enable the double precision reciprocal approximation instructions;
16898 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
16899 @code{rsqrtf}: enable the single precision reciprocal square root approximation instructions;
16900 @code{rsqrtd}: enable the double precision reciprocal square root approximation instructions;
16901
16902 So for example, @option{-mrecip=all,!rsqrtd} would enable the
16903 all of the reciprocal estimate instructions, except for the
16904 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
16905 which handle the double precision reciprocal square root calculations.
16906
16907 @item -mrecip-precision
16908 @itemx -mno-recip-precision
16909 @opindex mrecip-precision
16910 Assume (do not assume) that the reciprocal estimate instructions
16911 provide higher precision estimates than is mandated by the powerpc
16912 ABI.  Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
16913 automatically selects @option{-mrecip-precision}.  The double
16914 precision square root estimate instructions are not generated by
16915 default on low precision machines, since they do not provide an
16916 estimate that converges after three steps.
16917
16918 @item -mveclibabi=@var{type}
16919 @opindex mveclibabi
16920 Specifies the ABI type to use for vectorizing intrinsics using an
16921 external library.  The only type supported at present is @code{mass},
16922 which specifies to use IBM's Mathematical Acceleration Subsystem
16923 (MASS) libraries for vectorizing intrinsics using external libraries.
16924 GCC will currently emit calls to @code{acosd2}, @code{acosf4},
16925 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
16926 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
16927 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
16928 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
16929 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
16930 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
16931 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
16932 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
16933 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
16934 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
16935 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
16936 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
16937 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
16938 for power7.  Both @option{-ftree-vectorize} and
16939 @option{-funsafe-math-optimizations} have to be enabled.  The MASS
16940 libraries will have to be specified at link time.
16941
16942 @item -mfriz
16943 @itemx -mno-friz
16944 @opindex mfriz
16945 Generate (do not generate) the @code{friz} instruction when the
16946 @option{-funsafe-math-optimizations} option is used to optimize
16947 rounding a floating point value to 64-bit integer and back to floating
16948 point.  The @code{friz} instruction does not return the same value if
16949 the floating point number is too large to fit in an integer.
16950
16951 @item -mpointers-to-nested-functions
16952 @itemx -mno-pointers-to-nested-functions
16953 @opindex mpointers-to-nested-functions
16954 Generate (do not generate) code to load up the static chain register
16955 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
16956 systems where a function pointer points to a 3 word descriptor giving
16957 the function address, TOC value to be loaded in register @var{r2}, and
16958 static chain value to be loaded in register @var{r11}.  The
16959 @option{-mpointers-to-nested-functions} is on by default.  You will
16960 not be able to call through pointers to nested functions or pointers
16961 to functions compiled in other languages that use the static chain if
16962 you use the @option{-mno-pointers-to-nested-functions}.
16963
16964 @item -msave-toc-indirect
16965 @itemx -mno-save-toc-indirect
16966 @opindex msave-toc-indirect
16967 Generate (do not generate) code to save the TOC value in the reserved
16968 stack location in the function prologue if the function calls through
16969 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
16970 saved in the prologue, it is saved just before the call through the
16971 pointer.  The @option{-mno-save-toc-indirect} option is the default.
16972 @end table
16973
16974 @node RX Options
16975 @subsection RX Options
16976 @cindex RX Options
16977
16978 These command line options are defined for RX targets:
16979
16980 @table @gcctabopt
16981 @item -m64bit-doubles
16982 @itemx -m32bit-doubles
16983 @opindex m64bit-doubles
16984 @opindex m32bit-doubles
16985 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
16986 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
16987 @option{-m32bit-doubles}.  @emph{Note} RX floating point hardware only
16988 works on 32-bit values, which is why the default is
16989 @option{-m32bit-doubles}.
16990
16991 @item -fpu
16992 @itemx -nofpu
16993 @opindex fpu
16994 @opindex nofpu
16995 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
16996 floating point hardware.  The default is enabled for the @var{RX600}
16997 series and disabled for the @var{RX200} series.
16998
16999 Floating point instructions will only be generated for 32-bit floating
17000 point values however, so if the @option{-m64bit-doubles} option is in
17001 use then the FPU hardware will not be used for doubles.
17002
17003 @emph{Note} If the @option{-fpu} option is enabled then
17004 @option{-funsafe-math-optimizations} is also enabled automatically.
17005 This is because the RX FPU instructions are themselves unsafe.
17006
17007 @item -mcpu=@var{name}
17008 @opindex -mcpu
17009 Selects the type of RX CPU to be targeted.  Currently three types are
17010 supported, the generic @var{RX600} and @var{RX200} series hardware and
17011 the specific @var{RX610} CPU.  The default is @var{RX600}.
17012
17013 The only difference between @var{RX600} and @var{RX610} is that the
17014 @var{RX610} does not support the @code{MVTIPL} instruction.
17015
17016 The @var{RX200} series does not have a hardware floating point unit
17017 and so @option{-nofpu} is enabled by default when this type is
17018 selected.
17019
17020 @item -mbig-endian-data
17021 @itemx -mlittle-endian-data
17022 @opindex mbig-endian-data
17023 @opindex mlittle-endian-data
17024 Store data (but not code) in the big-endian format.  The default is
17025 @option{-mlittle-endian-data}, i.e.@: to store data in the little endian
17026 format.
17027
17028 @item -msmall-data-limit=@var{N}
17029 @opindex msmall-data-limit
17030 Specifies the maximum size in bytes of global and static variables
17031 which can be placed into the small data area.  Using the small data
17032 area can lead to smaller and faster code, but the size of area is
17033 limited and it is up to the programmer to ensure that the area does
17034 not overflow.  Also when the small data area is used one of the RX's
17035 registers (usually @code{r13}) is reserved for use pointing to this
17036 area, so it is no longer available for use by the compiler.  This
17037 could result in slower and/or larger code if variables which once
17038 could have been held in the reserved register are now pushed onto the
17039 stack.
17040
17041 Note, common variables (variables which have not been initialised) and
17042 constants are not placed into the small data area as they are assigned
17043 to other sections in the output executable.
17044
17045 The default value is zero, which disables this feature.  Note, this
17046 feature is not enabled by default with higher optimization levels
17047 (@option{-O2} etc) because of the potentially detrimental effects of
17048 reserving a register.  It is up to the programmer to experiment and
17049 discover whether this feature is of benefit to their program.  See the
17050 description of the @option{-mpid} option for a description of how the
17051 actual register to hold the small data area pointer is chosen.
17052
17053 @item -msim
17054 @itemx -mno-sim
17055 @opindex msim
17056 @opindex mno-sim
17057 Use the simulator runtime.  The default is to use the libgloss board
17058 specific runtime.
17059
17060 @item -mas100-syntax
17061 @itemx -mno-as100-syntax
17062 @opindex mas100-syntax
17063 @opindex mno-as100-syntax
17064 When generating assembler output use a syntax that is compatible with
17065 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
17066 assembler but it has some restrictions so generating it is not the
17067 default option.
17068
17069 @item -mmax-constant-size=@var{N}
17070 @opindex mmax-constant-size
17071 Specifies the maximum size, in bytes, of a constant that can be used as
17072 an operand in a RX instruction.  Although the RX instruction set does
17073 allow constants of up to 4 bytes in length to be used in instructions,
17074 a longer value equates to a longer instruction.  Thus in some
17075 circumstances it can be beneficial to restrict the size of constants
17076 that are used in instructions.  Constants that are too big are instead
17077 placed into a constant pool and referenced via register indirection.
17078
17079 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
17080 or 4 means that constants of any size are allowed.
17081
17082 @item -mrelax
17083 @opindex mrelax
17084 Enable linker relaxation.  Linker relaxation is a process whereby the
17085 linker will attempt to reduce the size of a program by finding shorter
17086 versions of various instructions.  Disabled by default.
17087
17088 @item -mint-register=@var{N}
17089 @opindex mint-register
17090 Specify the number of registers to reserve for fast interrupt handler
17091 functions.  The value @var{N} can be between 0 and 4.  A value of 1
17092 means that register @code{r13} will be reserved for the exclusive use
17093 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
17094 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
17095 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
17096 A value of 0, the default, does not reserve any registers.
17097
17098 @item -msave-acc-in-interrupts
17099 @opindex msave-acc-in-interrupts
17100 Specifies that interrupt handler functions should preserve the
17101 accumulator register.  This is only necessary if normal code might use
17102 the accumulator register, for example because it performs 64-bit
17103 multiplications.  The default is to ignore the accumulator as this
17104 makes the interrupt handlers faster.
17105
17106 @item -mpid
17107 @itemx -mno-pid
17108 @opindex mpid
17109 @opindex mno-pid
17110 Enables the generation of position independent data.  When enabled any
17111 access to constant data will done via an offset from a base address
17112 held in a register.  This allows the location of constant data to be
17113 determined at run-time without requiring the executable to be
17114 relocated, which is a benefit to embedded applications with tight
17115 memory constraints.  Data that can be modified is not affected by this
17116 option.
17117
17118 Note, using this feature reserves a register, usually @code{r13}, for
17119 the constant data base address.  This can result in slower and/or
17120 larger code, especially in complicated functions.
17121
17122 The actual register chosen to hold the constant data base address
17123 depends upon whether the @option{-msmall-data-limit} and/or the
17124 @option{-mint-register} command line options are enabled.  Starting
17125 with register @code{r13} and proceeding downwards, registers are
17126 allocated first to satisfy the requirements of @option{-mint-register},
17127 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
17128 is possible for the small data area register to be @code{r8} if both
17129 @option{-mint-register=4} and @option{-mpid} are specified on the
17130 command line.
17131
17132 By default this feature is not enabled.  The default can be restored
17133 via the @option{-mno-pid} command line option.
17134
17135 @end table
17136
17137 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
17138 has special significance to the RX port when used with the
17139 @code{interrupt} function attribute.  This attribute indicates a
17140 function intended to process fast interrupts.  GCC will will ensure
17141 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
17142 and/or @code{r13} and only provided that the normal use of the
17143 corresponding registers have been restricted via the
17144 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
17145 options.
17146
17147 @node S/390 and zSeries Options
17148 @subsection S/390 and zSeries Options
17149 @cindex S/390 and zSeries Options
17150
17151 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
17152
17153 @table @gcctabopt
17154 @item -mhard-float
17155 @itemx -msoft-float
17156 @opindex mhard-float
17157 @opindex msoft-float
17158 Use (do not use) the hardware floating-point instructions and registers
17159 for floating-point operations.  When @option{-msoft-float} is specified,
17160 functions in @file{libgcc.a} will be used to perform floating-point
17161 operations.  When @option{-mhard-float} is specified, the compiler
17162 generates IEEE floating-point instructions.  This is the default.
17163
17164 @item -mhard-dfp
17165 @itemx -mno-hard-dfp
17166 @opindex mhard-dfp
17167 @opindex mno-hard-dfp
17168 Use (do not use) the hardware decimal-floating-point instructions for
17169 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
17170 specified, functions in @file{libgcc.a} will be used to perform
17171 decimal-floating-point operations.  When @option{-mhard-dfp} is
17172 specified, the compiler generates decimal-floating-point hardware
17173 instructions.  This is the default for @option{-march=z9-ec} or higher.
17174
17175 @item -mlong-double-64
17176 @itemx -mlong-double-128
17177 @opindex mlong-double-64
17178 @opindex mlong-double-128
17179 These switches control the size of @code{long double} type. A size
17180 of 64bit makes the @code{long double} type equivalent to the @code{double}
17181 type. This is the default.
17182
17183 @item -mbackchain
17184 @itemx -mno-backchain
17185 @opindex mbackchain
17186 @opindex mno-backchain
17187 Store (do not store) the address of the caller's frame as backchain pointer
17188 into the callee's stack frame.
17189 A backchain may be needed to allow debugging using tools that do not understand
17190 DWARF-2 call frame information.
17191 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
17192 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
17193 the backchain is placed into the topmost word of the 96/160 byte register
17194 save area.
17195
17196 In general, code compiled with @option{-mbackchain} is call-compatible with
17197 code compiled with @option{-mmo-backchain}; however, use of the backchain
17198 for debugging purposes usually requires that the whole binary is built with
17199 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
17200 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17201 to build a linux kernel use @option{-msoft-float}.
17202
17203 The default is to not maintain the backchain.
17204
17205 @item -mpacked-stack
17206 @itemx -mno-packed-stack
17207 @opindex mpacked-stack
17208 @opindex mno-packed-stack
17209 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
17210 specified, the compiler uses the all fields of the 96/160 byte register save
17211 area only for their default purpose; unused fields still take up stack space.
17212 When @option{-mpacked-stack} is specified, register save slots are densely
17213 packed at the top of the register save area; unused space is reused for other
17214 purposes, allowing for more efficient use of the available stack space.
17215 However, when @option{-mbackchain} is also in effect, the topmost word of
17216 the save area is always used to store the backchain, and the return address
17217 register is always saved two words below the backchain.
17218
17219 As long as the stack frame backchain is not used, code generated with
17220 @option{-mpacked-stack} is call-compatible with code generated with
17221 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
17222 S/390 or zSeries generated code that uses the stack frame backchain at run
17223 time, not just for debugging purposes.  Such code is not call-compatible
17224 with code compiled with @option{-mpacked-stack}.  Also, note that the
17225 combination of @option{-mbackchain},
17226 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17227 to build a linux kernel use @option{-msoft-float}.
17228
17229 The default is to not use the packed stack layout.
17230
17231 @item -msmall-exec
17232 @itemx -mno-small-exec
17233 @opindex msmall-exec
17234 @opindex mno-small-exec
17235 Generate (or do not generate) code using the @code{bras} instruction
17236 to do subroutine calls.
17237 This only works reliably if the total executable size does not
17238 exceed 64k.  The default is to use the @code{basr} instruction instead,
17239 which does not have this limitation.
17240
17241 @item -m64
17242 @itemx -m31
17243 @opindex m64
17244 @opindex m31
17245 When @option{-m31} is specified, generate code compliant to the
17246 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
17247 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
17248 particular to generate 64-bit instructions.  For the @samp{s390}
17249 targets, the default is @option{-m31}, while the @samp{s390x}
17250 targets default to @option{-m64}.
17251
17252 @item -mzarch
17253 @itemx -mesa
17254 @opindex mzarch
17255 @opindex mesa
17256 When @option{-mzarch} is specified, generate code using the
17257 instructions available on z/Architecture.
17258 When @option{-mesa} is specified, generate code using the
17259 instructions available on ESA/390.  Note that @option{-mesa} is
17260 not possible with @option{-m64}.
17261 When generating code compliant to the GNU/Linux for S/390 ABI,
17262 the default is @option{-mesa}.  When generating code compliant
17263 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
17264
17265 @item -mmvcle
17266 @itemx -mno-mvcle
17267 @opindex mmvcle
17268 @opindex mno-mvcle
17269 Generate (or do not generate) code using the @code{mvcle} instruction
17270 to perform block moves.  When @option{-mno-mvcle} is specified,
17271 use a @code{mvc} loop instead.  This is the default unless optimizing for
17272 size.
17273
17274 @item -mdebug
17275 @itemx -mno-debug
17276 @opindex mdebug
17277 @opindex mno-debug
17278 Print (or do not print) additional debug information when compiling.
17279 The default is to not print debug information.
17280
17281 @item -march=@var{cpu-type}
17282 @opindex march
17283 Generate code that will run on @var{cpu-type}, which is the name of a system
17284 representing a certain processor type.  Possible values for
17285 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
17286 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
17287 When generating code using the instructions available on z/Architecture,
17288 the default is @option{-march=z900}.  Otherwise, the default is
17289 @option{-march=g5}.
17290
17291 @item -mtune=@var{cpu-type}
17292 @opindex mtune
17293 Tune to @var{cpu-type} everything applicable about the generated code,
17294 except for the ABI and the set of available instructions.
17295 The list of @var{cpu-type} values is the same as for @option{-march}.
17296 The default is the value used for @option{-march}.
17297
17298 @item -mtpf-trace
17299 @itemx -mno-tpf-trace
17300 @opindex mtpf-trace
17301 @opindex mno-tpf-trace
17302 Generate code that adds (does not add) in TPF OS specific branches to trace
17303 routines in the operating system.  This option is off by default, even
17304 when compiling for the TPF OS@.
17305
17306 @item -mfused-madd
17307 @itemx -mno-fused-madd
17308 @opindex mfused-madd
17309 @opindex mno-fused-madd
17310 Generate code that uses (does not use) the floating point multiply and
17311 accumulate instructions.  These instructions are generated by default if
17312 hardware floating point is used.
17313
17314 @item -mwarn-framesize=@var{framesize}
17315 @opindex mwarn-framesize
17316 Emit a warning if the current function exceeds the given frame size.  Because
17317 this is a compile time check it doesn't need to be a real problem when the program
17318 runs.  It is intended to identify functions which most probably cause
17319 a stack overflow.  It is useful to be used in an environment with limited stack
17320 size e.g.@: the linux kernel.
17321
17322 @item -mwarn-dynamicstack
17323 @opindex mwarn-dynamicstack
17324 Emit a warning if the function calls alloca or uses dynamically
17325 sized arrays.  This is generally a bad idea with a limited stack size.
17326
17327 @item -mstack-guard=@var{stack-guard}
17328 @itemx -mstack-size=@var{stack-size}
17329 @opindex mstack-guard
17330 @opindex mstack-size
17331 If these options are provided the s390 back end emits additional instructions in
17332 the function prologue which trigger a trap if the stack size is @var{stack-guard}
17333 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
17334 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
17335 the frame size of the compiled function is chosen.
17336 These options are intended to be used to help debugging stack overflow problems.
17337 The additionally emitted code causes only little overhead and hence can also be
17338 used in production like systems without greater performance degradation.  The given
17339 values have to be exact powers of 2 and @var{stack-size} has to be greater than
17340 @var{stack-guard} without exceeding 64k.
17341 In order to be efficient the extra code makes the assumption that the stack starts
17342 at an address aligned to the value given by @var{stack-size}.
17343 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
17344 @end table
17345
17346 @node Score Options
17347 @subsection Score Options
17348 @cindex Score Options
17349
17350 These options are defined for Score implementations:
17351
17352 @table @gcctabopt
17353 @item -meb
17354 @opindex meb
17355 Compile code for big endian mode.  This is the default.
17356
17357 @item -mel
17358 @opindex mel
17359 Compile code for little endian mode.
17360
17361 @item -mnhwloop
17362 @opindex mnhwloop
17363 Disable generate bcnz instruction.
17364
17365 @item -muls
17366 @opindex muls
17367 Enable generate unaligned load and store instruction.
17368
17369 @item -mmac
17370 @opindex mmac
17371 Enable the use of multiply-accumulate instructions. Disabled by default.
17372
17373 @item -mscore5
17374 @opindex mscore5
17375 Specify the SCORE5 as the target architecture.
17376
17377 @item -mscore5u
17378 @opindex mscore5u
17379 Specify the SCORE5U of the target architecture.
17380
17381 @item -mscore7
17382 @opindex mscore7
17383 Specify the SCORE7 as the target architecture. This is the default.
17384
17385 @item -mscore7d
17386 @opindex mscore7d
17387 Specify the SCORE7D as the target architecture.
17388 @end table
17389
17390 @node SH Options
17391 @subsection SH Options
17392
17393 These @samp{-m} options are defined for the SH implementations:
17394
17395 @table @gcctabopt
17396 @item -m1
17397 @opindex m1
17398 Generate code for the SH1.
17399
17400 @item -m2
17401 @opindex m2
17402 Generate code for the SH2.
17403
17404 @item -m2e
17405 Generate code for the SH2e.
17406
17407 @item -m2a-nofpu
17408 @opindex m2a-nofpu
17409 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
17410 that the floating-point unit is not used.
17411
17412 @item -m2a-single-only
17413 @opindex m2a-single-only
17414 Generate code for the SH2a-FPU, in such a way that no double-precision
17415 floating point operations are used.
17416
17417 @item -m2a-single
17418 @opindex m2a-single
17419 Generate code for the SH2a-FPU assuming the floating-point unit is in
17420 single-precision mode by default.
17421
17422 @item -m2a
17423 @opindex m2a
17424 Generate code for the SH2a-FPU assuming the floating-point unit is in
17425 double-precision mode by default.
17426
17427 @item -m3
17428 @opindex m3
17429 Generate code for the SH3.
17430
17431 @item -m3e
17432 @opindex m3e
17433 Generate code for the SH3e.
17434
17435 @item -m4-nofpu
17436 @opindex m4-nofpu
17437 Generate code for the SH4 without a floating-point unit.
17438
17439 @item -m4-single-only
17440 @opindex m4-single-only
17441 Generate code for the SH4 with a floating-point unit that only
17442 supports single-precision arithmetic.
17443
17444 @item -m4-single
17445 @opindex m4-single
17446 Generate code for the SH4 assuming the floating-point unit is in
17447 single-precision mode by default.
17448
17449 @item -m4
17450 @opindex m4
17451 Generate code for the SH4.
17452
17453 @item -m4a-nofpu
17454 @opindex m4a-nofpu
17455 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
17456 floating-point unit is not used.
17457
17458 @item -m4a-single-only
17459 @opindex m4a-single-only
17460 Generate code for the SH4a, in such a way that no double-precision
17461 floating point operations are used.
17462
17463 @item -m4a-single
17464 @opindex m4a-single
17465 Generate code for the SH4a assuming the floating-point unit is in
17466 single-precision mode by default.
17467
17468 @item -m4a
17469 @opindex m4a
17470 Generate code for the SH4a.
17471
17472 @item -m4al
17473 @opindex m4al
17474 Same as @option{-m4a-nofpu}, except that it implicitly passes
17475 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
17476 instructions at the moment.
17477
17478 @item -mb
17479 @opindex mb
17480 Compile code for the processor in big endian mode.
17481
17482 @item -ml
17483 @opindex ml
17484 Compile code for the processor in little endian mode.
17485
17486 @item -mdalign
17487 @opindex mdalign
17488 Align doubles at 64-bit boundaries.  Note that this changes the calling
17489 conventions, and thus some functions from the standard C library will
17490 not work unless you recompile it first with @option{-mdalign}.
17491
17492 @item -mrelax
17493 @opindex mrelax
17494 Shorten some address references at link time, when possible; uses the
17495 linker option @option{-relax}.
17496
17497 @item -mbigtable
17498 @opindex mbigtable
17499 Use 32-bit offsets in @code{switch} tables.  The default is to use
17500 16-bit offsets.
17501
17502 @item -mbitops
17503 @opindex mbitops
17504 Enable the use of bit manipulation instructions on SH2A.
17505
17506 @item -mfmovd
17507 @opindex mfmovd
17508 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
17509 alignment constraints.
17510
17511 @item -mhitachi
17512 @opindex mhitachi
17513 Comply with the calling conventions defined by Renesas.
17514
17515 @item -mrenesas
17516 @opindex mhitachi
17517 Comply with the calling conventions defined by Renesas.
17518
17519 @item -mno-renesas
17520 @opindex mhitachi
17521 Comply with the calling conventions defined for GCC before the Renesas
17522 conventions were available.  This option is the default for all
17523 targets of the SH toolchain.
17524
17525 @item -mnomacsave
17526 @opindex mnomacsave
17527 Mark the @code{MAC} register as call-clobbered, even if
17528 @option{-mhitachi} is given.
17529
17530 @item -mieee
17531 @opindex mieee
17532 Increase IEEE-compliance of floating-point code.
17533 At the moment, this is equivalent to @option{-fno-finite-math-only}.
17534 When generating 16 bit SH opcodes, getting IEEE-conforming results for
17535 comparisons of NANs / infinities incurs extra overhead in every
17536 floating point comparison, therefore the default is set to
17537 @option{-ffinite-math-only}.
17538
17539 @item -minline-ic_invalidate
17540 @opindex minline-ic_invalidate
17541 Inline code to invalidate instruction cache entries after setting up
17542 nested function trampolines.
17543 This option has no effect if -musermode is in effect and the selected
17544 code generation option (e.g. -m4) does not allow the use of the icbi
17545 instruction.
17546 If the selected code generation option does not allow the use of the icbi
17547 instruction, and -musermode is not in effect, the inlined code will
17548 manipulate the instruction cache address array directly with an associative
17549 write.  This not only requires privileged mode, but it will also
17550 fail if the cache line had been mapped via the TLB and has become unmapped.
17551
17552 @item -misize
17553 @opindex misize
17554 Dump instruction size and location in the assembly code.
17555
17556 @item -mpadstruct
17557 @opindex mpadstruct
17558 This option is deprecated.  It pads structures to multiple of 4 bytes,
17559 which is incompatible with the SH ABI@.
17560
17561 @item -msoft-atomic
17562 @opindex msoft-atomic
17563 Generate software atomic sequences for the atomic operations.
17564 This is the default when the target is @code{sh-*-linux*}.
17565
17566 @item -mspace
17567 @opindex mspace
17568 Optimize for space instead of speed.  Implied by @option{-Os}.
17569
17570 @item -mprefergot
17571 @opindex mprefergot
17572 When generating position-independent code, emit function calls using
17573 the Global Offset Table instead of the Procedure Linkage Table.
17574
17575 @item -musermode
17576 @opindex musermode
17577 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
17578 if the inlined code would not work in user mode.
17579 This is the default when the target is @code{sh-*-linux*}.
17580
17581 @item -multcost=@var{number}
17582 @opindex multcost=@var{number}
17583 Set the cost to assume for a multiply insn.
17584
17585 @item -mdiv=@var{strategy}
17586 @opindex mdiv=@var{strategy}
17587 Set the division strategy to use for SHmedia code.  @var{strategy} must be
17588 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
17589 inv:call2, inv:fp .
17590 "fp" performs the operation in floating point.  This has a very high latency,
17591 but needs only a few instructions, so it might be a good choice if
17592 your code has enough easily exploitable ILP to allow the compiler to
17593 schedule the floating point instructions together with other instructions.
17594 Division by zero causes a floating point exception.
17595 "inv" uses integer operations to calculate the inverse of the divisor,
17596 and then multiplies the dividend with the inverse.  This strategy allows
17597 cse and hoisting of the inverse calculation.  Division by zero calculates
17598 an unspecified result, but does not trap.
17599 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
17600 have been found, or if the entire operation has been hoisted to the same
17601 place, the last stages of the inverse calculation are intertwined with the
17602 final multiply to reduce the overall latency, at the expense of using a few
17603 more instructions, and thus offering fewer scheduling opportunities with
17604 other code.
17605 "call" calls a library function that usually implements the inv:minlat
17606 strategy.
17607 This gives high code density for m5-*media-nofpu compilations.
17608 "call2" uses a different entry point of the same library function, where it
17609 assumes that a pointer to a lookup table has already been set up, which
17610 exposes the pointer load to cse / code hoisting optimizations.
17611 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
17612 code generation, but if the code stays unoptimized, revert to the "call",
17613 "call2", or "fp" strategies, respectively.  Note that the
17614 potentially-trapping side effect of division by zero is carried by a
17615 separate instruction, so it is possible that all the integer instructions
17616 are hoisted out, but the marker for the side effect stays where it is.
17617 A recombination to fp operations or a call is not possible in that case.
17618 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
17619 that the inverse calculation was nor separated from the multiply, they speed
17620 up division where the dividend fits into 20 bits (plus sign where applicable),
17621 by inserting a test to skip a number of operations in this case; this test
17622 slows down the case of larger dividends.  inv20u assumes the case of a such
17623 a small dividend to be unlikely, and inv20l assumes it to be likely.
17624
17625 @item -maccumulate-outgoing-args
17626 @opindex maccumulate-outgoing-args
17627 Reserve space once for outgoing arguments in the function prologue rather
17628 than around each call.  Generally beneficial for performance and size.  Also
17629 needed for unwinding to avoid changing the stack frame around conditional code.
17630
17631 @item -mdivsi3_libfunc=@var{name}
17632 @opindex mdivsi3_libfunc=@var{name}
17633 Set the name of the library function used for 32 bit signed division to
17634 @var{name}.  This only affect the name used in the call and inv:call
17635 division strategies, and the compiler will still expect the same
17636 sets of input/output/clobbered registers as if this option was not present.
17637
17638 @item -mfixed-range=@var{register-range}
17639 @opindex mfixed-range
17640 Generate code treating the given register range as fixed registers.
17641 A fixed register is one that the register allocator can not use.  This is
17642 useful when compiling kernel code.  A register range is specified as
17643 two registers separated by a dash.  Multiple register ranges can be
17644 specified separated by a comma.
17645
17646 @item -madjust-unroll
17647 @opindex madjust-unroll
17648 Throttle unrolling to avoid thrashing target registers.
17649 This option only has an effect if the gcc code base supports the
17650 TARGET_ADJUST_UNROLL_MAX target hook.
17651
17652 @item -mindexed-addressing
17653 @opindex mindexed-addressing
17654 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
17655 This is only safe if the hardware and/or OS implement 32 bit wrap-around
17656 semantics for the indexed addressing mode.  The architecture allows the
17657 implementation of processors with 64 bit MMU, which the OS could use to
17658 get 32 bit addressing, but since no current hardware implementation supports
17659 this or any other way to make the indexed addressing mode safe to use in
17660 the 32 bit ABI, the default is -mno-indexed-addressing.
17661
17662 @item -mgettrcost=@var{number}
17663 @opindex mgettrcost=@var{number}
17664 Set the cost assumed for the gettr instruction to @var{number}.
17665 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
17666
17667 @item -mpt-fixed
17668 @opindex mpt-fixed
17669 Assume pt* instructions won't trap.  This will generally generate better
17670 scheduled code, but is unsafe on current hardware.  The current architecture
17671 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
17672 This has the unintentional effect of making it unsafe to schedule ptabs /
17673 ptrel before a branch, or hoist it out of a loop.  For example,
17674 __do_global_ctors, a part of libgcc that runs constructors at program
17675 startup, calls functions in a list which is delimited by @minus{}1.  With the
17676 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
17677 That means that all the constructors will be run a bit quicker, but when
17678 the loop comes to the end of the list, the program crashes because ptabs
17679 loads @minus{}1 into a target register.  Since this option is unsafe for any
17680 hardware implementing the current architecture specification, the default
17681 is -mno-pt-fixed.  Unless the user specifies a specific cost with
17682 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
17683 this deters register allocation using target registers for storing
17684 ordinary integers.
17685
17686 @item -minvalid-symbols
17687 @opindex minvalid-symbols
17688 Assume symbols might be invalid.  Ordinary function symbols generated by
17689 the compiler will always be valid to load with movi/shori/ptabs or
17690 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
17691 to generate symbols that will cause ptabs / ptrel to trap.
17692 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
17693 It will then prevent cross-basic-block cse, hoisting and most scheduling
17694 of symbol loads.  The default is @option{-mno-invalid-symbols}.
17695 @end table
17696
17697 @node Solaris 2 Options
17698 @subsection Solaris 2 Options
17699 @cindex Solaris 2 options
17700
17701 These @samp{-m} options are supported on Solaris 2:
17702
17703 @table @gcctabopt
17704 @item -mimpure-text
17705 @opindex mimpure-text
17706 @option{-mimpure-text}, used in addition to @option{-shared}, tells
17707 the compiler to not pass @option{-z text} to the linker when linking a
17708 shared object.  Using this option, you can link position-dependent
17709 code into a shared object.
17710
17711 @option{-mimpure-text} suppresses the ``relocations remain against
17712 allocatable but non-writable sections'' linker error message.
17713 However, the necessary relocations will trigger copy-on-write, and the
17714 shared object is not actually shared across processes.  Instead of
17715 using @option{-mimpure-text}, you should compile all source code with
17716 @option{-fpic} or @option{-fPIC}.
17717
17718 @end table
17719
17720 These switches are supported in addition to the above on Solaris 2:
17721
17722 @table @gcctabopt
17723 @item -pthreads
17724 @opindex pthreads
17725 Add support for multithreading using the POSIX threads library.  This
17726 option sets flags for both the preprocessor and linker.  This option does
17727 not affect the thread safety of object code produced  by the compiler or
17728 that of libraries supplied with it.
17729
17730 @item -pthread
17731 @opindex pthread
17732 This is a synonym for @option{-pthreads}.
17733 @end table
17734
17735 @node SPARC Options
17736 @subsection SPARC Options
17737 @cindex SPARC options
17738
17739 These @samp{-m} options are supported on the SPARC:
17740
17741 @table @gcctabopt
17742 @item -mno-app-regs
17743 @itemx -mapp-regs
17744 @opindex mno-app-regs
17745 @opindex mapp-regs
17746 Specify @option{-mapp-regs} to generate output using the global registers
17747 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
17748 is the default.
17749
17750 To be fully SVR4 ABI compliant at the cost of some performance loss,
17751 specify @option{-mno-app-regs}.  You should compile libraries and system
17752 software with this option.
17753
17754 @item -mflat
17755 @itemx -mno-flat
17756 @opindex mflat
17757 @opindex mno-flat
17758 With @option{-mflat}, the compiler does not generate save/restore instructions
17759 and uses a ``flat'' or single register window model.  This model is compatible
17760 with the regular register window model.  The local registers and the input
17761 registers (0--5) are still treated as ``call-saved'' registers and will be
17762 saved on the stack as needed.
17763
17764 With @option{-mno-flat} (the default), the compiler generates save/restore
17765 instructions (except for leaf functions).  This is the normal operating mode.
17766
17767 @item -mfpu
17768 @itemx -mhard-float
17769 @opindex mfpu
17770 @opindex mhard-float
17771 Generate output containing floating point instructions.  This is the
17772 default.
17773
17774 @item -mno-fpu
17775 @itemx -msoft-float
17776 @opindex mno-fpu
17777 @opindex msoft-float
17778 Generate output containing library calls for floating point.
17779 @strong{Warning:} the requisite libraries are not available for all SPARC
17780 targets.  Normally the facilities of the machine's usual C compiler are
17781 used, but this cannot be done directly in cross-compilation.  You must make
17782 your own arrangements to provide suitable library functions for
17783 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
17784 @samp{sparclite-*-*} do provide software floating point support.
17785
17786 @option{-msoft-float} changes the calling convention in the output file;
17787 therefore, it is only useful if you compile @emph{all} of a program with
17788 this option.  In particular, you need to compile @file{libgcc.a}, the
17789 library that comes with GCC, with @option{-msoft-float} in order for
17790 this to work.
17791
17792 @item -mhard-quad-float
17793 @opindex mhard-quad-float
17794 Generate output containing quad-word (long double) floating point
17795 instructions.
17796
17797 @item -msoft-quad-float
17798 @opindex msoft-quad-float
17799 Generate output containing library calls for quad-word (long double)
17800 floating point instructions.  The functions called are those specified
17801 in the SPARC ABI@.  This is the default.
17802
17803 As of this writing, there are no SPARC implementations that have hardware
17804 support for the quad-word floating point instructions.  They all invoke
17805 a trap handler for one of these instructions, and then the trap handler
17806 emulates the effect of the instruction.  Because of the trap handler overhead,
17807 this is much slower than calling the ABI library routines.  Thus the
17808 @option{-msoft-quad-float} option is the default.
17809
17810 @item -mno-unaligned-doubles
17811 @itemx -munaligned-doubles
17812 @opindex mno-unaligned-doubles
17813 @opindex munaligned-doubles
17814 Assume that doubles have 8 byte alignment.  This is the default.
17815
17816 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
17817 alignment only if they are contained in another type, or if they have an
17818 absolute address.  Otherwise, it assumes they have 4 byte alignment.
17819 Specifying this option avoids some rare compatibility problems with code
17820 generated by other compilers.  It is not the default because it results
17821 in a performance loss, especially for floating point code.
17822
17823 @item -mno-faster-structs
17824 @itemx -mfaster-structs
17825 @opindex mno-faster-structs
17826 @opindex mfaster-structs
17827 With @option{-mfaster-structs}, the compiler assumes that structures
17828 should have 8 byte alignment.  This enables the use of pairs of
17829 @code{ldd} and @code{std} instructions for copies in structure
17830 assignment, in place of twice as many @code{ld} and @code{st} pairs.
17831 However, the use of this changed alignment directly violates the SPARC
17832 ABI@.  Thus, it's intended only for use on targets where the developer
17833 acknowledges that their resulting code will not be directly in line with
17834 the rules of the ABI@.
17835
17836 @item -mcpu=@var{cpu_type}
17837 @opindex mcpu
17838 Set the instruction set, register set, and instruction scheduling parameters
17839 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
17840 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
17841 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
17842 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
17843 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
17844 and @samp{niagara4}.
17845
17846 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
17847 which selects the best architecture option for the host processor.
17848 @option{-mcpu=native} has no effect if GCC does not recognize
17849 the processor.
17850
17851 Default instruction scheduling parameters are used for values that select
17852 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
17853 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
17854
17855 Here is a list of each supported architecture and their supported
17856 implementations.
17857
17858 @table @asis
17859 @item v7
17860 cypress
17861
17862 @item v8
17863 supersparc, hypersparc, leon
17864
17865 @item sparclite
17866 f930, f934, sparclite86x
17867
17868 @item sparclet
17869 tsc701
17870
17871 @item v9
17872 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
17873 @end table
17874
17875 By default (unless configured otherwise), GCC generates code for the V7
17876 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
17877 additionally optimizes it for the Cypress CY7C602 chip, as used in the
17878 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
17879 SPARCStation 1, 2, IPX etc.
17880
17881 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
17882 architecture.  The only difference from V7 code is that the compiler emits
17883 the integer multiply and integer divide instructions which exist in SPARC-V8
17884 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
17885 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
17886 2000 series.
17887
17888 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
17889 the SPARC architecture.  This adds the integer multiply, integer divide step
17890 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
17891 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
17892 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
17893 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
17894 MB86934 chip, which is the more recent SPARClite with FPU@.
17895
17896 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
17897 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
17898 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
17899 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
17900 optimizes it for the TEMIC SPARClet chip.
17901
17902 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
17903 architecture.  This adds 64-bit integer and floating-point move instructions,
17904 3 additional floating-point condition code registers and conditional move
17905 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
17906 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
17907 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
17908 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
17909 @option{-mcpu=niagara}, the compiler additionally optimizes it for
17910 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
17911 additionally optimizes it for Sun UltraSPARC T2 chips. With
17912 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
17913 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
17914 additionally optimizes it for Sun UltraSPARC T4 chips.
17915
17916 @item -mtune=@var{cpu_type}
17917 @opindex mtune
17918 Set the instruction scheduling parameters for machine type
17919 @var{cpu_type}, but do not set the instruction set or register set that the
17920 option @option{-mcpu=@var{cpu_type}} would.
17921
17922 The same values for @option{-mcpu=@var{cpu_type}} can be used for
17923 @option{-mtune=@var{cpu_type}}, but the only useful values are those
17924 that select a particular CPU implementation.  Those are @samp{cypress},
17925 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
17926 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
17927 @samp{niagara}, @samp{niagara2}, @samp{niagara3} and @samp{niagara4}.  With
17928 native Solaris and GNU/Linux toolchains, @samp{native} can also be used.
17929
17930 @item -mv8plus
17931 @itemx -mno-v8plus
17932 @opindex mv8plus
17933 @opindex mno-v8plus
17934 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
17935 difference from the V8 ABI is that the global and out registers are
17936 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
17937 mode for all SPARC-V9 processors.
17938
17939 @item -mvis
17940 @itemx -mno-vis
17941 @opindex mvis
17942 @opindex mno-vis
17943 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
17944 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
17945
17946 @item -mvis2
17947 @itemx -mno-vis2
17948 @opindex mvis2
17949 @opindex mno-vis2
17950 With @option{-mvis2}, GCC generates code that takes advantage of
17951 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
17952 default is @option{-mvis2} when targetting a cpu that supports such
17953 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
17954 also sets @option{-mvis}.
17955
17956 @item -mvis3
17957 @itemx -mno-vis3
17958 @opindex mvis3
17959 @opindex mno-vis3
17960 With @option{-mvis3}, GCC generates code that takes advantage of
17961 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
17962 default is @option{-mvis3} when targetting a cpu that supports such
17963 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
17964 also sets @option{-mvis2} and @option{-mvis}.
17965
17966 @item -mpopc
17967 @itemx -mno-popc
17968 @opindex mpopc
17969 @opindex mno-popc
17970 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
17971 population count instruction.  The default is @option{-mpopc}
17972 when targetting a cpu that supports such instructions, such as Niagara-2 and
17973 later.
17974
17975 @item -mfmaf
17976 @itemx -mno-fmaf
17977 @opindex mfmaf
17978 @opindex mno-fmaf
17979 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
17980 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
17981 when targetting a cpu that supports such instructions, such as Niagara-3 and
17982 later.
17983
17984 @item -mfix-at697f
17985 @opindex mfix-at697f
17986 Enable the documented workaround for the single erratum of the Atmel AT697F
17987 processor (which corresponds to erratum #13 of the AT697E processor).
17988 @end table
17989
17990 These @samp{-m} options are supported in addition to the above
17991 on SPARC-V9 processors in 64-bit environments:
17992
17993 @table @gcctabopt
17994 @item -mlittle-endian
17995 @opindex mlittle-endian
17996 Generate code for a processor running in little-endian mode.  It is only
17997 available for a few configurations and most notably not on Solaris and Linux.
17998
17999 @item -m32
18000 @itemx -m64
18001 @opindex m32
18002 @opindex m64
18003 Generate code for a 32-bit or 64-bit environment.
18004 The 32-bit environment sets int, long and pointer to 32 bits.
18005 The 64-bit environment sets int to 32 bits and long and pointer
18006 to 64 bits.
18007
18008 @item -mcmodel=@var{which}
18009 @opindex mcmodel
18010 Set the code model to one of
18011
18012 @table @samp
18013 @item medlow
18014 The Medium/Low code model: 64-bit addresses, programs
18015 must be linked in the low 32 bits of memory.  Programs can be statically
18016 or dynamically linked.
18017
18018 @item medmid
18019 The Medium/Middle code model: 64-bit addresses, programs
18020 must be linked in the low 44 bits of memory, the text and data segments must
18021 be less than 2GB in size and the data segment must be located within 2GB of
18022 the text segment.
18023
18024 @item medany
18025 The Medium/Anywhere code model: 64-bit addresses, programs
18026 may be linked anywhere in memory, the text and data segments must be less
18027 than 2GB in size and the data segment must be located within 2GB of the
18028 text segment.
18029
18030 @item embmedany
18031 The Medium/Anywhere code model for embedded systems:
18032 64-bit addresses, the text and data segments must be less than 2GB in
18033 size, both starting anywhere in memory (determined at link time).  The
18034 global register %g4 points to the base of the data segment.  Programs
18035 are statically linked and PIC is not supported.
18036 @end table
18037
18038 @item -mmemory-model=@var{mem-model}
18039 @opindex mmemory-model
18040 Set the memory model in force on the processor to one of
18041
18042 @table @samp
18043 @item default
18044 The default memory model for the processor and operating system.
18045
18046 @item rmo
18047 Relaxed Memory Order
18048
18049 @item pso
18050 Partial Store Order
18051
18052 @item tso
18053 Total Store Order
18054
18055 @item sc
18056 Sequential Consistency
18057 @end table
18058
18059 These memory models are formally defined in Appendix D of the Sparc V9
18060 architecture manual, as set in the processor's @code{PSTATE.MM} field.
18061
18062 @item -mstack-bias
18063 @itemx -mno-stack-bias
18064 @opindex mstack-bias
18065 @opindex mno-stack-bias
18066 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
18067 frame pointer if present, are offset by @minus{}2047 which must be added back
18068 when making stack frame references.  This is the default in 64-bit mode.
18069 Otherwise, assume no such offset is present.
18070 @end table
18071
18072 @node SPU Options
18073 @subsection SPU Options
18074 @cindex SPU options
18075
18076 These @samp{-m} options are supported on the SPU:
18077
18078 @table @gcctabopt
18079 @item -mwarn-reloc
18080 @itemx -merror-reloc
18081 @opindex mwarn-reloc
18082 @opindex merror-reloc
18083
18084 The loader for SPU does not handle dynamic relocations.  By default, GCC
18085 will give an error when it generates code that requires a dynamic
18086 relocation.  @option{-mno-error-reloc} disables the error,
18087 @option{-mwarn-reloc} will generate a warning instead.
18088
18089 @item -msafe-dma
18090 @itemx -munsafe-dma
18091 @opindex msafe-dma
18092 @opindex munsafe-dma
18093
18094 Instructions which initiate or test completion of DMA must not be
18095 reordered with respect to loads and stores of the memory which is being
18096 accessed.  Users typically address this problem using the volatile
18097 keyword, but that can lead to inefficient code in places where the
18098 memory is known to not change.  Rather than mark the memory as volatile
18099 we treat the DMA instructions as potentially effecting all memory.  With
18100 @option{-munsafe-dma} users must use the volatile keyword to protect
18101 memory accesses.
18102
18103 @item -mbranch-hints
18104 @opindex mbranch-hints
18105
18106 By default, GCC will generate a branch hint instruction to avoid
18107 pipeline stalls for always taken or probably taken branches.  A hint
18108 will not be generated closer than 8 instructions away from its branch.
18109 There is little reason to disable them, except for debugging purposes,
18110 or to make an object a little bit smaller.
18111
18112 @item -msmall-mem
18113 @itemx -mlarge-mem
18114 @opindex msmall-mem
18115 @opindex mlarge-mem
18116
18117 By default, GCC generates code assuming that addresses are never larger
18118 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
18119 a full 32 bit address.
18120
18121 @item -mstdmain
18122 @opindex mstdmain
18123
18124 By default, GCC links against startup code that assumes the SPU-style
18125 main function interface (which has an unconventional parameter list).
18126 With @option{-mstdmain}, GCC will link your program against startup
18127 code that assumes a C99-style interface to @code{main}, including a
18128 local copy of @code{argv} strings.
18129
18130 @item -mfixed-range=@var{register-range}
18131 @opindex mfixed-range
18132 Generate code treating the given register range as fixed registers.
18133 A fixed register is one that the register allocator can not use.  This is
18134 useful when compiling kernel code.  A register range is specified as
18135 two registers separated by a dash.  Multiple register ranges can be
18136 specified separated by a comma.
18137
18138 @item -mea32
18139 @itemx -mea64
18140 @opindex mea32
18141 @opindex mea64
18142 Compile code assuming that pointers to the PPU address space accessed
18143 via the @code{__ea} named address space qualifier are either 32 or 64
18144 bits wide.  The default is 32 bits.  As this is an ABI changing option,
18145 all object code in an executable must be compiled with the same setting.
18146
18147 @item -maddress-space-conversion
18148 @itemx -mno-address-space-conversion
18149 @opindex maddress-space-conversion
18150 @opindex mno-address-space-conversion
18151 Allow/disallow treating the @code{__ea} address space as superset
18152 of the generic address space.  This enables explicit type casts
18153 between @code{__ea} and generic pointer as well as implicit
18154 conversions of generic pointers to @code{__ea} pointers.  The
18155 default is to allow address space pointer conversions.
18156
18157 @item -mcache-size=@var{cache-size}
18158 @opindex mcache-size
18159 This option controls the version of libgcc that the compiler links to an
18160 executable and selects a software-managed cache for accessing variables
18161 in the @code{__ea} address space with a particular cache size.  Possible
18162 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
18163 and @samp{128}.  The default cache size is 64KB.
18164
18165 @item -matomic-updates
18166 @itemx -mno-atomic-updates
18167 @opindex matomic-updates
18168 @opindex mno-atomic-updates
18169 This option controls the version of libgcc that the compiler links to an
18170 executable and selects whether atomic updates to the software-managed
18171 cache of PPU-side variables are used.  If you use atomic updates, changes
18172 to a PPU variable from SPU code using the @code{__ea} named address space
18173 qualifier will not interfere with changes to other PPU variables residing
18174 in the same cache line from PPU code.  If you do not use atomic updates,
18175 such interference may occur; however, writing back cache lines will be
18176 more efficient.  The default behavior is to use atomic updates.
18177
18178 @item -mdual-nops
18179 @itemx -mdual-nops=@var{n}
18180 @opindex mdual-nops
18181 By default, GCC will insert nops to increase dual issue when it expects
18182 it to increase performance.  @var{n} can be a value from 0 to 10.  A
18183 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
18184 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
18185
18186 @item -mhint-max-nops=@var{n}
18187 @opindex mhint-max-nops
18188 Maximum number of nops to insert for a branch hint.  A branch hint must
18189 be at least 8 instructions away from the branch it is effecting.  GCC
18190 will insert up to @var{n} nops to enforce this, otherwise it will not
18191 generate the branch hint.
18192
18193 @item -mhint-max-distance=@var{n}
18194 @opindex mhint-max-distance
18195 The encoding of the branch hint instruction limits the hint to be within
18196 256 instructions of the branch it is effecting.  By default, GCC makes
18197 sure it is within 125.
18198
18199 @item -msafe-hints
18200 @opindex msafe-hints
18201 Work around a hardware bug which causes the SPU to stall indefinitely.
18202 By default, GCC will insert the @code{hbrp} instruction to make sure
18203 this stall won't happen.
18204
18205 @end table
18206
18207 @node System V Options
18208 @subsection Options for System V
18209
18210 These additional options are available on System V Release 4 for
18211 compatibility with other compilers on those systems:
18212
18213 @table @gcctabopt
18214 @item -G
18215 @opindex G
18216 Create a shared object.
18217 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
18218
18219 @item -Qy
18220 @opindex Qy
18221 Identify the versions of each tool used by the compiler, in a
18222 @code{.ident} assembler directive in the output.
18223
18224 @item -Qn
18225 @opindex Qn
18226 Refrain from adding @code{.ident} directives to the output file (this is
18227 the default).
18228
18229 @item -YP,@var{dirs}
18230 @opindex YP
18231 Search the directories @var{dirs}, and no others, for libraries
18232 specified with @option{-l}.
18233
18234 @item -Ym,@var{dir}
18235 @opindex Ym
18236 Look in the directory @var{dir} to find the M4 preprocessor.
18237 The assembler uses this option.
18238 @c This is supposed to go with a -Yd for predefined M4 macro files, but
18239 @c the generic assembler that comes with Solaris takes just -Ym.
18240 @end table
18241
18242 @node V850 Options
18243 @subsection V850 Options
18244 @cindex V850 Options
18245
18246 These @samp{-m} options are defined for V850 implementations:
18247
18248 @table @gcctabopt
18249 @item -mlong-calls
18250 @itemx -mno-long-calls
18251 @opindex mlong-calls
18252 @opindex mno-long-calls
18253 Treat all calls as being far away (near).  If calls are assumed to be
18254 far away, the compiler will always load the functions address up into a
18255 register, and call indirect through the pointer.
18256
18257 @item -mno-ep
18258 @itemx -mep
18259 @opindex mno-ep
18260 @opindex mep
18261 Do not optimize (do optimize) basic blocks that use the same index
18262 pointer 4 or more times to copy pointer into the @code{ep} register, and
18263 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
18264 option is on by default if you optimize.
18265
18266 @item -mno-prolog-function
18267 @itemx -mprolog-function
18268 @opindex mno-prolog-function
18269 @opindex mprolog-function
18270 Do not use (do use) external functions to save and restore registers
18271 at the prologue and epilogue of a function.  The external functions
18272 are slower, but use less code space if more than one function saves
18273 the same number of registers.  The @option{-mprolog-function} option
18274 is on by default if you optimize.
18275
18276 @item -mspace
18277 @opindex mspace
18278 Try to make the code as small as possible.  At present, this just turns
18279 on the @option{-mep} and @option{-mprolog-function} options.
18280
18281 @item -mtda=@var{n}
18282 @opindex mtda
18283 Put static or global variables whose size is @var{n} bytes or less into
18284 the tiny data area that register @code{ep} points to.  The tiny data
18285 area can hold up to 256 bytes in total (128 bytes for byte references).
18286
18287 @item -msda=@var{n}
18288 @opindex msda
18289 Put static or global variables whose size is @var{n} bytes or less into
18290 the small data area that register @code{gp} points to.  The small data
18291 area can hold up to 64 kilobytes.
18292
18293 @item -mzda=@var{n}
18294 @opindex mzda
18295 Put static or global variables whose size is @var{n} bytes or less into
18296 the first 32 kilobytes of memory.
18297
18298 @item -mv850
18299 @opindex mv850
18300 Specify that the target processor is the V850.
18301
18302 @item -mbig-switch
18303 @opindex mbig-switch
18304 Generate code suitable for big switch tables.  Use this option only if
18305 the assembler/linker complain about out of range branches within a switch
18306 table.
18307
18308 @item -mapp-regs
18309 @opindex mapp-regs
18310 This option will cause r2 and r5 to be used in the code generated by
18311 the compiler.  This setting is the default.
18312
18313 @item -mno-app-regs
18314 @opindex mno-app-regs
18315 This option will cause r2 and r5 to be treated as fixed registers.
18316
18317 @item -mv850e2v3
18318 @opindex mv850e2v3
18319 Specify that the target processor is the V850E2V3.  The preprocessor
18320 constants @samp{__v850e2v3__} will be defined if
18321 this option is used.
18322
18323 @item -mv850e2
18324 @opindex mv850e2
18325 Specify that the target processor is the V850E2.  The preprocessor
18326 constants @samp{__v850e2__} will be defined if this option is used.
18327
18328 @item -mv850e1
18329 @opindex mv850e1
18330 Specify that the target processor is the V850E1.  The preprocessor
18331 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
18332 this option is used.
18333
18334 @item -mv850es
18335 @opindex mv850es
18336 Specify that the target processor is the V850ES.  This is an alias for
18337 the @option{-mv850e1} option.
18338
18339 @item -mv850e
18340 @opindex mv850e
18341 Specify that the target processor is the V850E@.  The preprocessor
18342 constant @samp{__v850e__} will be defined if this option is used.
18343
18344 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
18345 nor @option{-mv850e2} nor @option{-mv850e2v3}
18346 are defined then a default target processor will be chosen and the
18347 relevant @samp{__v850*__} preprocessor constant will be defined.
18348
18349 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
18350 defined, regardless of which processor variant is the target.
18351
18352 @item -mdisable-callt
18353 @opindex mdisable-callt
18354 This option will suppress generation of the CALLT instruction for the
18355 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
18356 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
18357
18358 @end table
18359
18360 @node VAX Options
18361 @subsection VAX Options
18362 @cindex VAX options
18363
18364 These @samp{-m} options are defined for the VAX:
18365
18366 @table @gcctabopt
18367 @item -munix
18368 @opindex munix
18369 Do not output certain jump instructions (@code{aobleq} and so on)
18370 that the Unix assembler for the VAX cannot handle across long
18371 ranges.
18372
18373 @item -mgnu
18374 @opindex mgnu
18375 Do output those jump instructions, on the assumption that you
18376 will assemble with the GNU assembler.
18377
18378 @item -mg
18379 @opindex mg
18380 Output code for g-format floating point numbers instead of d-format.
18381 @end table
18382
18383 @node VxWorks Options
18384 @subsection VxWorks Options
18385 @cindex VxWorks Options
18386
18387 The options in this section are defined for all VxWorks targets.
18388 Options specific to the target hardware are listed with the other
18389 options for that target.
18390
18391 @table @gcctabopt
18392 @item -mrtp
18393 @opindex mrtp
18394 GCC can generate code for both VxWorks kernels and real time processes
18395 (RTPs).  This option switches from the former to the latter.  It also
18396 defines the preprocessor macro @code{__RTP__}.
18397
18398 @item -non-static
18399 @opindex non-static
18400 Link an RTP executable against shared libraries rather than static
18401 libraries.  The options @option{-static} and @option{-shared} can
18402 also be used for RTPs (@pxref{Link Options}); @option{-static}
18403 is the default.
18404
18405 @item -Bstatic
18406 @itemx -Bdynamic
18407 @opindex Bstatic
18408 @opindex Bdynamic
18409 These options are passed down to the linker.  They are defined for
18410 compatibility with Diab.
18411
18412 @item -Xbind-lazy
18413 @opindex Xbind-lazy
18414 Enable lazy binding of function calls.  This option is equivalent to
18415 @option{-Wl,-z,now} and is defined for compatibility with Diab.
18416
18417 @item -Xbind-now
18418 @opindex Xbind-now
18419 Disable lazy binding of function calls.  This option is the default and
18420 is defined for compatibility with Diab.
18421 @end table
18422
18423 @node x86-64 Options
18424 @subsection x86-64 Options
18425 @cindex x86-64 options
18426
18427 These are listed under @xref{i386 and x86-64 Options}.
18428
18429 @node Xstormy16 Options
18430 @subsection Xstormy16 Options
18431 @cindex Xstormy16 Options
18432
18433 These options are defined for Xstormy16:
18434
18435 @table @gcctabopt
18436 @item -msim
18437 @opindex msim
18438 Choose startup files and linker script suitable for the simulator.
18439 @end table
18440
18441 @node Xtensa Options
18442 @subsection Xtensa Options
18443 @cindex Xtensa Options
18444
18445 These options are supported for Xtensa targets:
18446
18447 @table @gcctabopt
18448 @item -mconst16
18449 @itemx -mno-const16
18450 @opindex mconst16
18451 @opindex mno-const16
18452 Enable or disable use of @code{CONST16} instructions for loading
18453 constant values.  The @code{CONST16} instruction is currently not a
18454 standard option from Tensilica.  When enabled, @code{CONST16}
18455 instructions are always used in place of the standard @code{L32R}
18456 instructions.  The use of @code{CONST16} is enabled by default only if
18457 the @code{L32R} instruction is not available.
18458
18459 @item -mfused-madd
18460 @itemx -mno-fused-madd
18461 @opindex mfused-madd
18462 @opindex mno-fused-madd
18463 Enable or disable use of fused multiply/add and multiply/subtract
18464 instructions in the floating-point option.  This has no effect if the
18465 floating-point option is not also enabled.  Disabling fused multiply/add
18466 and multiply/subtract instructions forces the compiler to use separate
18467 instructions for the multiply and add/subtract operations.  This may be
18468 desirable in some cases where strict IEEE 754-compliant results are
18469 required: the fused multiply add/subtract instructions do not round the
18470 intermediate result, thereby producing results with @emph{more} bits of
18471 precision than specified by the IEEE standard.  Disabling fused multiply
18472 add/subtract instructions also ensures that the program output is not
18473 sensitive to the compiler's ability to combine multiply and add/subtract
18474 operations.
18475
18476 @item -mserialize-volatile
18477 @itemx -mno-serialize-volatile
18478 @opindex mserialize-volatile
18479 @opindex mno-serialize-volatile
18480 When this option is enabled, GCC inserts @code{MEMW} instructions before
18481 @code{volatile} memory references to guarantee sequential consistency.
18482 The default is @option{-mserialize-volatile}.  Use
18483 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
18484
18485 @item -mforce-no-pic
18486 @opindex mforce-no-pic
18487 For targets, like GNU/Linux, where all user-mode Xtensa code must be
18488 position-independent code (PIC), this option disables PIC for compiling
18489 kernel code.
18490
18491 @item -mtext-section-literals
18492 @itemx -mno-text-section-literals
18493 @opindex mtext-section-literals
18494 @opindex mno-text-section-literals
18495 Control the treatment of literal pools.  The default is
18496 @option{-mno-text-section-literals}, which places literals in a separate
18497 section in the output file.  This allows the literal pool to be placed
18498 in a data RAM/ROM, and it also allows the linker to combine literal
18499 pools from separate object files to remove redundant literals and
18500 improve code size.  With @option{-mtext-section-literals}, the literals
18501 are interspersed in the text section in order to keep them as close as
18502 possible to their references.  This may be necessary for large assembly
18503 files.
18504
18505 @item -mtarget-align
18506 @itemx -mno-target-align
18507 @opindex mtarget-align
18508 @opindex mno-target-align
18509 When this option is enabled, GCC instructs the assembler to
18510 automatically align instructions to reduce branch penalties at the
18511 expense of some code density.  The assembler attempts to widen density
18512 instructions to align branch targets and the instructions following call
18513 instructions.  If there are not enough preceding safe density
18514 instructions to align a target, no widening will be performed.  The
18515 default is @option{-mtarget-align}.  These options do not affect the
18516 treatment of auto-aligned instructions like @code{LOOP}, which the
18517 assembler will always align, either by widening density instructions or
18518 by inserting no-op instructions.
18519
18520 @item -mlongcalls
18521 @itemx -mno-longcalls
18522 @opindex mlongcalls
18523 @opindex mno-longcalls
18524 When this option is enabled, GCC instructs the assembler to translate
18525 direct calls to indirect calls unless it can determine that the target
18526 of a direct call is in the range allowed by the call instruction.  This
18527 translation typically occurs for calls to functions in other source
18528 files.  Specifically, the assembler translates a direct @code{CALL}
18529 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
18530 The default is @option{-mno-longcalls}.  This option should be used in
18531 programs where the call target can potentially be out of range.  This
18532 option is implemented in the assembler, not the compiler, so the
18533 assembly code generated by GCC will still show direct call
18534 instructions---look at the disassembled object code to see the actual
18535 instructions.  Note that the assembler will use an indirect call for
18536 every cross-file call, not just those that really will be out of range.
18537 @end table
18538
18539 @node zSeries Options
18540 @subsection zSeries Options
18541 @cindex zSeries options
18542
18543 These are listed under @xref{S/390 and zSeries Options}.
18544
18545 @node Code Gen Options
18546 @section Options for Code Generation Conventions
18547 @cindex code generation conventions
18548 @cindex options, code generation
18549 @cindex run-time options
18550
18551 These machine-independent options control the interface conventions
18552 used in code generation.
18553
18554 Most of them have both positive and negative forms; the negative form
18555 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
18556 one of the forms is listed---the one which is not the default.  You
18557 can figure out the other form by either removing @samp{no-} or adding
18558 it.
18559
18560 @table @gcctabopt
18561 @item -fbounds-check
18562 @opindex fbounds-check
18563 For front-ends that support it, generate additional code to check that
18564 indices used to access arrays are within the declared range.  This is
18565 currently only supported by the Java and Fortran front-ends, where
18566 this option defaults to true and false respectively.
18567
18568 @item -ftrapv
18569 @opindex ftrapv
18570 This option generates traps for signed overflow on addition, subtraction,
18571 multiplication operations.
18572
18573 @item -fwrapv
18574 @opindex fwrapv
18575 This option instructs the compiler to assume that signed arithmetic
18576 overflow of addition, subtraction and multiplication wraps around
18577 using twos-complement representation.  This flag enables some optimizations
18578 and disables others.  This option is enabled by default for the Java
18579 front-end, as required by the Java language specification.
18580
18581 @item -fexceptions
18582 @opindex fexceptions
18583 Enable exception handling.  Generates extra code needed to propagate
18584 exceptions.  For some targets, this implies GCC will generate frame
18585 unwind information for all functions, which can produce significant data
18586 size overhead, although it does not affect execution.  If you do not
18587 specify this option, GCC will enable it by default for languages like
18588 C++ which normally require exception handling, and disable it for
18589 languages like C that do not normally require it.  However, you may need
18590 to enable this option when compiling C code that needs to interoperate
18591 properly with exception handlers written in C++.  You may also wish to
18592 disable this option if you are compiling older C++ programs that don't
18593 use exception handling.
18594
18595 @item -fnon-call-exceptions
18596 @opindex fnon-call-exceptions
18597 Generate code that allows trapping instructions to throw exceptions.
18598 Note that this requires platform-specific runtime support that does
18599 not exist everywhere.  Moreover, it only allows @emph{trapping}
18600 instructions to throw exceptions, i.e.@: memory references or floating
18601 point instructions.  It does not allow exceptions to be thrown from
18602 arbitrary signal handlers such as @code{SIGALRM}.
18603
18604 @item -funwind-tables
18605 @opindex funwind-tables
18606 Similar to @option{-fexceptions}, except that it will just generate any needed
18607 static data, but will not affect the generated code in any other way.
18608 You will normally not enable this option; instead, a language processor
18609 that needs this handling would enable it on your behalf.
18610
18611 @item -fasynchronous-unwind-tables
18612 @opindex fasynchronous-unwind-tables
18613 Generate unwind table in dwarf2 format, if supported by target machine.  The
18614 table is exact at each instruction boundary, so it can be used for stack
18615 unwinding from asynchronous events (such as debugger or garbage collector).
18616
18617 @item -fpcc-struct-return
18618 @opindex fpcc-struct-return
18619 Return ``short'' @code{struct} and @code{union} values in memory like
18620 longer ones, rather than in registers.  This convention is less
18621 efficient, but it has the advantage of allowing intercallability between
18622 GCC-compiled files and files compiled with other compilers, particularly
18623 the Portable C Compiler (pcc).
18624
18625 The precise convention for returning structures in memory depends
18626 on the target configuration macros.
18627
18628 Short structures and unions are those whose size and alignment match
18629 that of some integer type.
18630
18631 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
18632 switch is not binary compatible with code compiled with the
18633 @option{-freg-struct-return} switch.
18634 Use it to conform to a non-default application binary interface.
18635
18636 @item -freg-struct-return
18637 @opindex freg-struct-return
18638 Return @code{struct} and @code{union} values in registers when possible.
18639 This is more efficient for small structures than
18640 @option{-fpcc-struct-return}.
18641
18642 If you specify neither @option{-fpcc-struct-return} nor
18643 @option{-freg-struct-return}, GCC defaults to whichever convention is
18644 standard for the target.  If there is no standard convention, GCC
18645 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
18646 the principal compiler.  In those cases, we can choose the standard, and
18647 we chose the more efficient register return alternative.
18648
18649 @strong{Warning:} code compiled with the @option{-freg-struct-return}
18650 switch is not binary compatible with code compiled with the
18651 @option{-fpcc-struct-return} switch.
18652 Use it to conform to a non-default application binary interface.
18653
18654 @item -fshort-enums
18655 @opindex fshort-enums
18656 Allocate to an @code{enum} type only as many bytes as it needs for the
18657 declared range of possible values.  Specifically, the @code{enum} type
18658 will be equivalent to the smallest integer type which has enough room.
18659
18660 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
18661 code that is not binary compatible with code generated without that switch.
18662 Use it to conform to a non-default application binary interface.
18663
18664 @item -fshort-double
18665 @opindex fshort-double
18666 Use the same size for @code{double} as for @code{float}.
18667
18668 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
18669 code that is not binary compatible with code generated without that switch.
18670 Use it to conform to a non-default application binary interface.
18671
18672 @item -fshort-wchar
18673 @opindex fshort-wchar
18674 Override the underlying type for @samp{wchar_t} to be @samp{short
18675 unsigned int} instead of the default for the target.  This option is
18676 useful for building programs to run under WINE@.
18677
18678 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
18679 code that is not binary compatible with code generated without that switch.
18680 Use it to conform to a non-default application binary interface.
18681
18682 @item -fno-common
18683 @opindex fno-common
18684 In C code, controls the placement of uninitialized global variables.
18685 Unix C compilers have traditionally permitted multiple definitions of
18686 such variables in different compilation units by placing the variables
18687 in a common block.
18688 This is the behavior specified by @option{-fcommon}, and is the default
18689 for GCC on most targets.
18690 On the other hand, this behavior is not required by ISO C, and on some
18691 targets may carry a speed or code size penalty on variable references.
18692 The @option{-fno-common} option specifies that the compiler should place
18693 uninitialized global variables in the data section of the object file,
18694 rather than generating them as common blocks.
18695 This has the effect that if the same variable is declared
18696 (without @code{extern}) in two different compilations,
18697 you will get a multiple-definition error when you link them.
18698 In this case, you must compile with @option{-fcommon} instead.
18699 Compiling with @option{-fno-common} is useful on targets for which
18700 it provides better performance, or if you wish to verify that the
18701 program will work on other systems which always treat uninitialized
18702 variable declarations this way.
18703
18704 @item -fno-ident
18705 @opindex fno-ident
18706 Ignore the @samp{#ident} directive.
18707
18708 @item -finhibit-size-directive
18709 @opindex finhibit-size-directive
18710 Don't output a @code{.size} assembler directive, or anything else that
18711 would cause trouble if the function is split in the middle, and the
18712 two halves are placed at locations far apart in memory.  This option is
18713 used when compiling @file{crtstuff.c}; you should not need to use it
18714 for anything else.
18715
18716 @item -fverbose-asm
18717 @opindex fverbose-asm
18718 Put extra commentary information in the generated assembly code to
18719 make it more readable.  This option is generally only of use to those
18720 who actually need to read the generated assembly code (perhaps while
18721 debugging the compiler itself).
18722
18723 @option{-fno-verbose-asm}, the default, causes the
18724 extra information to be omitted and is useful when comparing two assembler
18725 files.
18726
18727 @item -frecord-gcc-switches
18728 @opindex frecord-gcc-switches
18729 This switch causes the command line that was used to invoke the
18730 compiler to be recorded into the object file that is being created.
18731 This switch is only implemented on some targets and the exact format
18732 of the recording is target and binary file format dependent, but it
18733 usually takes the form of a section containing ASCII text.  This
18734 switch is related to the @option{-fverbose-asm} switch, but that
18735 switch only records information in the assembler output file as
18736 comments, so it never reaches the object file.
18737 See also @option{-grecord-gcc-switches} for another
18738 way of storing compiler options into the object file.
18739
18740 @item -fpic
18741 @opindex fpic
18742 @cindex global offset table
18743 @cindex PIC
18744 Generate position-independent code (PIC) suitable for use in a shared
18745 library, if supported for the target machine.  Such code accesses all
18746 constant addresses through a global offset table (GOT)@.  The dynamic
18747 loader resolves the GOT entries when the program starts (the dynamic
18748 loader is not part of GCC; it is part of the operating system).  If
18749 the GOT size for the linked executable exceeds a machine-specific
18750 maximum size, you get an error message from the linker indicating that
18751 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
18752 instead.  (These maximums are 8k on the SPARC and 32k
18753 on the m68k and RS/6000.  The 386 has no such limit.)
18754
18755 Position-independent code requires special support, and therefore works
18756 only on certain machines.  For the 386, GCC supports PIC for System V
18757 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
18758 position-independent.
18759
18760 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
18761 are defined to 1.
18762
18763 @item -fPIC
18764 @opindex fPIC
18765 If supported for the target machine, emit position-independent code,
18766 suitable for dynamic linking and avoiding any limit on the size of the
18767 global offset table.  This option makes a difference on the m68k,
18768 PowerPC and SPARC@.
18769
18770 Position-independent code requires special support, and therefore works
18771 only on certain machines.
18772
18773 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
18774 are defined to 2.
18775
18776 @item -fpie
18777 @itemx -fPIE
18778 @opindex fpie
18779 @opindex fPIE
18780 These options are similar to @option{-fpic} and @option{-fPIC}, but
18781 generated position independent code can be only linked into executables.
18782 Usually these options are used when @option{-pie} GCC option will be
18783 used during linking.
18784
18785 @option{-fpie} and @option{-fPIE} both define the macros
18786 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
18787 for @option{-fpie} and 2 for @option{-fPIE}.
18788
18789 @item -fno-jump-tables
18790 @opindex fno-jump-tables
18791 Do not use jump tables for switch statements even where it would be
18792 more efficient than other code generation strategies.  This option is
18793 of use in conjunction with @option{-fpic} or @option{-fPIC} for
18794 building code which forms part of a dynamic linker and cannot
18795 reference the address of a jump table.  On some targets, jump tables
18796 do not require a GOT and this option is not needed.
18797
18798 @item -ffixed-@var{reg}
18799 @opindex ffixed
18800 Treat the register named @var{reg} as a fixed register; generated code
18801 should never refer to it (except perhaps as a stack pointer, frame
18802 pointer or in some other fixed role).
18803
18804 @var{reg} must be the name of a register.  The register names accepted
18805 are machine-specific and are defined in the @code{REGISTER_NAMES}
18806 macro in the machine description macro file.
18807
18808 This flag does not have a negative form, because it specifies a
18809 three-way choice.
18810
18811 @item -fcall-used-@var{reg}
18812 @opindex fcall-used
18813 Treat the register named @var{reg} as an allocable register that is
18814 clobbered by function calls.  It may be allocated for temporaries or
18815 variables that do not live across a call.  Functions compiled this way
18816 will not save and restore the register @var{reg}.
18817
18818 It is an error to used this flag with the frame pointer or stack pointer.
18819 Use of this flag for other registers that have fixed pervasive roles in
18820 the machine's execution model will produce disastrous results.
18821
18822 This flag does not have a negative form, because it specifies a
18823 three-way choice.
18824
18825 @item -fcall-saved-@var{reg}
18826 @opindex fcall-saved
18827 Treat the register named @var{reg} as an allocable register saved by
18828 functions.  It may be allocated even for temporaries or variables that
18829 live across a call.  Functions compiled this way will save and restore
18830 the register @var{reg} if they use it.
18831
18832 It is an error to used this flag with the frame pointer or stack pointer.
18833 Use of this flag for other registers that have fixed pervasive roles in
18834 the machine's execution model will produce disastrous results.
18835
18836 A different sort of disaster will result from the use of this flag for
18837 a register in which function values may be returned.
18838
18839 This flag does not have a negative form, because it specifies a
18840 three-way choice.
18841
18842 @item -fpack-struct[=@var{n}]
18843 @opindex fpack-struct
18844 Without a value specified, pack all structure members together without
18845 holes.  When a value is specified (which must be a small power of two), pack
18846 structure members according to this value, representing the maximum
18847 alignment (that is, objects with default alignment requirements larger than
18848 this will be output potentially unaligned at the next fitting location.
18849
18850 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
18851 code that is not binary compatible with code generated without that switch.
18852 Additionally, it makes the code suboptimal.
18853 Use it to conform to a non-default application binary interface.
18854
18855 @item -finstrument-functions
18856 @opindex finstrument-functions
18857 Generate instrumentation calls for entry and exit to functions.  Just
18858 after function entry and just before function exit, the following
18859 profiling functions will be called with the address of the current
18860 function and its call site.  (On some platforms,
18861 @code{__builtin_return_address} does not work beyond the current
18862 function, so the call site information may not be available to the
18863 profiling functions otherwise.)
18864
18865 @smallexample
18866 void __cyg_profile_func_enter (void *this_fn,
18867                                void *call_site);
18868 void __cyg_profile_func_exit  (void *this_fn,
18869                                void *call_site);
18870 @end smallexample
18871
18872 The first argument is the address of the start of the current function,
18873 which may be looked up exactly in the symbol table.
18874
18875 This instrumentation is also done for functions expanded inline in other
18876 functions.  The profiling calls will indicate where, conceptually, the
18877 inline function is entered and exited.  This means that addressable
18878 versions of such functions must be available.  If all your uses of a
18879 function are expanded inline, this may mean an additional expansion of
18880 code size.  If you use @samp{extern inline} in your C code, an
18881 addressable version of such functions must be provided.  (This is
18882 normally the case anyways, but if you get lucky and the optimizer always
18883 expands the functions inline, you might have gotten away without
18884 providing static copies.)
18885
18886 A function may be given the attribute @code{no_instrument_function}, in
18887 which case this instrumentation will not be done.  This can be used, for
18888 example, for the profiling functions listed above, high-priority
18889 interrupt routines, and any functions from which the profiling functions
18890 cannot safely be called (perhaps signal handlers, if the profiling
18891 routines generate output or allocate memory).
18892
18893 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
18894 @opindex finstrument-functions-exclude-file-list
18895
18896 Set the list of functions that are excluded from instrumentation (see
18897 the description of @code{-finstrument-functions}).  If the file that
18898 contains a function definition matches with one of @var{file}, then
18899 that function is not instrumented.  The match is done on substrings:
18900 if the @var{file} parameter is a substring of the file name, it is
18901 considered to be a match.
18902
18903 For example:
18904
18905 @smallexample
18906 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
18907 @end smallexample
18908
18909 @noindent
18910 will exclude any inline function defined in files whose pathnames
18911 contain @code{/bits/stl} or @code{include/sys}.
18912
18913 If, for some reason, you want to include letter @code{','} in one of
18914 @var{sym}, write @code{'\,'}. For example,
18915 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
18916 (note the single quote surrounding the option).
18917
18918 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
18919 @opindex finstrument-functions-exclude-function-list
18920
18921 This is similar to @code{-finstrument-functions-exclude-file-list},
18922 but this option sets the list of function names to be excluded from
18923 instrumentation.  The function name to be matched is its user-visible
18924 name, such as @code{vector<int> blah(const vector<int> &)}, not the
18925 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
18926 match is done on substrings: if the @var{sym} parameter is a substring
18927 of the function name, it is considered to be a match.  For C99 and C++
18928 extended identifiers, the function name must be given in UTF-8, not
18929 using universal character names.
18930
18931 @item -fstack-check
18932 @opindex fstack-check
18933 Generate code to verify that you do not go beyond the boundary of the
18934 stack.  You should specify this flag if you are running in an
18935 environment with multiple threads, but only rarely need to specify it in
18936 a single-threaded environment since stack overflow is automatically
18937 detected on nearly all systems if there is only one stack.
18938
18939 Note that this switch does not actually cause checking to be done; the
18940 operating system or the language runtime must do that.  The switch causes
18941 generation of code to ensure that they see the stack being extended.
18942
18943 You can additionally specify a string parameter: @code{no} means no
18944 checking, @code{generic} means force the use of old-style checking,
18945 @code{specific} means use the best checking method and is equivalent
18946 to bare @option{-fstack-check}.
18947
18948 Old-style checking is a generic mechanism that requires no specific
18949 target support in the compiler but comes with the following drawbacks:
18950
18951 @enumerate
18952 @item
18953 Modified allocation strategy for large objects: they will always be
18954 allocated dynamically if their size exceeds a fixed threshold.
18955
18956 @item
18957 Fixed limit on the size of the static frame of functions: when it is
18958 topped by a particular function, stack checking is not reliable and
18959 a warning is issued by the compiler.
18960
18961 @item
18962 Inefficiency: because of both the modified allocation strategy and the
18963 generic implementation, the performances of the code are hampered.
18964 @end enumerate
18965
18966 Note that old-style stack checking is also the fallback method for
18967 @code{specific} if no target support has been added in the compiler.
18968
18969 @item -fstack-limit-register=@var{reg}
18970 @itemx -fstack-limit-symbol=@var{sym}
18971 @itemx -fno-stack-limit
18972 @opindex fstack-limit-register
18973 @opindex fstack-limit-symbol
18974 @opindex fno-stack-limit
18975 Generate code to ensure that the stack does not grow beyond a certain value,
18976 either the value of a register or the address of a symbol.  If the stack
18977 would grow beyond the value, a signal is raised.  For most targets,
18978 the signal is raised before the stack overruns the boundary, so
18979 it is possible to catch the signal without taking special precautions.
18980
18981 For instance, if the stack starts at absolute address @samp{0x80000000}
18982 and grows downwards, you can use the flags
18983 @option{-fstack-limit-symbol=__stack_limit} and
18984 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
18985 of 128KB@.  Note that this may only work with the GNU linker.
18986
18987 @item -fsplit-stack
18988 @opindex fsplit-stack
18989 Generate code to automatically split the stack before it overflows.
18990 The resulting program has a discontiguous stack which can only
18991 overflow if the program is unable to allocate any more memory.  This
18992 is most useful when running threaded programs, as it is no longer
18993 necessary to calculate a good stack size to use for each thread.  This
18994 is currently only implemented for the i386 and x86_64 backends running
18995 GNU/Linux.
18996
18997 When code compiled with @option{-fsplit-stack} calls code compiled
18998 without @option{-fsplit-stack}, there may not be much stack space
18999 available for the latter code to run.  If compiling all code,
19000 including library code, with @option{-fsplit-stack} is not an option,
19001 then the linker can fix up these calls so that the code compiled
19002 without @option{-fsplit-stack} always has a large stack.  Support for
19003 this is implemented in the gold linker in GNU binutils release 2.21
19004 and later.
19005
19006 @item -fleading-underscore
19007 @opindex fleading-underscore
19008 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
19009 change the way C symbols are represented in the object file.  One use
19010 is to help link with legacy assembly code.
19011
19012 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
19013 generate code that is not binary compatible with code generated without that
19014 switch.  Use it to conform to a non-default application binary interface.
19015 Not all targets provide complete support for this switch.
19016
19017 @item -ftls-model=@var{model}
19018 @opindex ftls-model
19019 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
19020 The @var{model} argument should be one of @code{global-dynamic},
19021 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
19022
19023 The default without @option{-fpic} is @code{initial-exec}; with
19024 @option{-fpic} the default is @code{global-dynamic}.
19025
19026 @item -fvisibility=@var{default|internal|hidden|protected}
19027 @opindex fvisibility
19028 Set the default ELF image symbol visibility to the specified option---all
19029 symbols will be marked with this unless overridden within the code.
19030 Using this feature can very substantially improve linking and
19031 load times of shared object libraries, produce more optimized
19032 code, provide near-perfect API export and prevent symbol clashes.
19033 It is @strong{strongly} recommended that you use this in any shared objects
19034 you distribute.
19035
19036 Despite the nomenclature, @code{default} always means public; i.e.,
19037 available to be linked against from outside the shared object.
19038 @code{protected} and @code{internal} are pretty useless in real-world
19039 usage so the only other commonly used option will be @code{hidden}.
19040 The default if @option{-fvisibility} isn't specified is
19041 @code{default}, i.e., make every
19042 symbol public---this causes the same behavior as previous versions of
19043 GCC@.
19044
19045 A good explanation of the benefits offered by ensuring ELF
19046 symbols have the correct visibility is given by ``How To Write
19047 Shared Libraries'' by Ulrich Drepper (which can be found at
19048 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
19049 solution made possible by this option to marking things hidden when
19050 the default is public is to make the default hidden and mark things
19051 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
19052 and @code{__attribute__ ((visibility("default")))} instead of
19053 @code{__declspec(dllexport)} you get almost identical semantics with
19054 identical syntax.  This is a great boon to those working with
19055 cross-platform projects.
19056
19057 For those adding visibility support to existing code, you may find
19058 @samp{#pragma GCC visibility} of use.  This works by you enclosing
19059 the declarations you wish to set visibility for with (for example)
19060 @samp{#pragma GCC visibility push(hidden)} and
19061 @samp{#pragma GCC visibility pop}.
19062 Bear in mind that symbol visibility should be viewed @strong{as
19063 part of the API interface contract} and thus all new code should
19064 always specify visibility when it is not the default; i.e., declarations
19065 only for use within the local DSO should @strong{always} be marked explicitly
19066 as hidden as so to avoid PLT indirection overheads---making this
19067 abundantly clear also aids readability and self-documentation of the code.
19068 Note that due to ISO C++ specification requirements, operator new and
19069 operator delete must always be of default visibility.
19070
19071 Be aware that headers from outside your project, in particular system
19072 headers and headers from any other library you use, may not be
19073 expecting to be compiled with visibility other than the default.  You
19074 may need to explicitly say @samp{#pragma GCC visibility push(default)}
19075 before including any such headers.
19076
19077 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
19078 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
19079 no modifications.  However, this means that calls to @samp{extern}
19080 functions with no explicit visibility will use the PLT, so it is more
19081 effective to use @samp{__attribute ((visibility))} and/or
19082 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
19083 declarations should be treated as hidden.
19084
19085 Note that @samp{-fvisibility} does affect C++ vague linkage
19086 entities. This means that, for instance, an exception class that will
19087 be thrown between DSOs must be explicitly marked with default
19088 visibility so that the @samp{type_info} nodes will be unified between
19089 the DSOs.
19090
19091 An overview of these techniques, their benefits and how to use them
19092 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
19093
19094 @item -fstrict-volatile-bitfields
19095 @opindex fstrict-volatile-bitfields
19096 This option should be used if accesses to volatile bitfields (or other
19097 structure fields, although the compiler usually honors those types
19098 anyway) should use a single access of the width of the
19099 field's type, aligned to a natural alignment if possible.  For
19100 example, targets with memory-mapped peripheral registers might require
19101 all such accesses to be 16 bits wide; with this flag the user could
19102 declare all peripheral bitfields as ``unsigned short'' (assuming short
19103 is 16 bits on these targets) to force GCC to use 16 bit accesses
19104 instead of, perhaps, a more efficient 32 bit access.
19105
19106 If this option is disabled, the compiler will use the most efficient
19107 instruction.  In the previous example, that might be a 32-bit load
19108 instruction, even though that will access bytes that do not contain
19109 any portion of the bitfield, or memory-mapped registers unrelated to
19110 the one being updated.
19111
19112 If the target requires strict alignment, and honoring the field
19113 type would require violating this alignment, a warning is issued.
19114 If the field has @code{packed} attribute, the access is done without
19115 honoring the field type.  If the field doesn't have @code{packed}
19116 attribute, the access is done honoring the field type.  In both cases,
19117 GCC assumes that the user knows something about the target hardware
19118 that it is unaware of.
19119
19120 The default value of this option is determined by the application binary
19121 interface for the target processor.
19122
19123 @end table
19124
19125 @c man end
19126
19127 @node Environment Variables
19128 @section Environment Variables Affecting GCC
19129 @cindex environment variables
19130
19131 @c man begin ENVIRONMENT
19132 This section describes several environment variables that affect how GCC
19133 operates.  Some of them work by specifying directories or prefixes to use
19134 when searching for various kinds of files.  Some are used to specify other
19135 aspects of the compilation environment.
19136
19137 Note that you can also specify places to search using options such as
19138 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
19139 take precedence over places specified using environment variables, which
19140 in turn take precedence over those specified by the configuration of GCC@.
19141 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
19142 GNU Compiler Collection (GCC) Internals}.
19143
19144 @table @env
19145 @item LANG
19146 @itemx LC_CTYPE
19147 @c @itemx LC_COLLATE
19148 @itemx LC_MESSAGES
19149 @c @itemx LC_MONETARY
19150 @c @itemx LC_NUMERIC
19151 @c @itemx LC_TIME
19152 @itemx LC_ALL
19153 @findex LANG
19154 @findex LC_CTYPE
19155 @c @findex LC_COLLATE
19156 @findex LC_MESSAGES
19157 @c @findex LC_MONETARY
19158 @c @findex LC_NUMERIC
19159 @c @findex LC_TIME
19160 @findex LC_ALL
19161 @cindex locale
19162 These environment variables control the way that GCC uses
19163 localization information that allow GCC to work with different
19164 national conventions.  GCC inspects the locale categories
19165 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
19166 so.  These locale categories can be set to any value supported by your
19167 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
19168 Kingdom encoded in UTF-8.
19169
19170 The @env{LC_CTYPE} environment variable specifies character
19171 classification.  GCC uses it to determine the character boundaries in
19172 a string; this is needed for some multibyte encodings that contain quote
19173 and escape characters that would otherwise be interpreted as a string
19174 end or escape.
19175
19176 The @env{LC_MESSAGES} environment variable specifies the language to
19177 use in diagnostic messages.
19178
19179 If the @env{LC_ALL} environment variable is set, it overrides the value
19180 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
19181 and @env{LC_MESSAGES} default to the value of the @env{LANG}
19182 environment variable.  If none of these variables are set, GCC
19183 defaults to traditional C English behavior.
19184
19185 @item TMPDIR
19186 @findex TMPDIR
19187 If @env{TMPDIR} is set, it specifies the directory to use for temporary
19188 files.  GCC uses temporary files to hold the output of one stage of
19189 compilation which is to be used as input to the next stage: for example,
19190 the output of the preprocessor, which is the input to the compiler
19191 proper.
19192
19193 @item GCC_COMPARE_DEBUG
19194 @findex GCC_COMPARE_DEBUG
19195 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
19196 @option{-fcompare-debug} to the compiler driver.  See the documentation
19197 of this option for more details.
19198
19199 @item GCC_EXEC_PREFIX
19200 @findex GCC_EXEC_PREFIX
19201 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
19202 names of the subprograms executed by the compiler.  No slash is added
19203 when this prefix is combined with the name of a subprogram, but you can
19204 specify a prefix that ends with a slash if you wish.
19205
19206 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
19207 an appropriate prefix to use based on the pathname it was invoked with.
19208
19209 If GCC cannot find the subprogram using the specified prefix, it
19210 tries looking in the usual places for the subprogram.
19211
19212 The default value of @env{GCC_EXEC_PREFIX} is
19213 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
19214 the installed compiler. In many cases @var{prefix} is the value
19215 of @code{prefix} when you ran the @file{configure} script.
19216
19217 Other prefixes specified with @option{-B} take precedence over this prefix.
19218
19219 This prefix is also used for finding files such as @file{crt0.o} that are
19220 used for linking.
19221
19222 In addition, the prefix is used in an unusual way in finding the
19223 directories to search for header files.  For each of the standard
19224 directories whose name normally begins with @samp{/usr/local/lib/gcc}
19225 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
19226 replacing that beginning with the specified prefix to produce an
19227 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
19228 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
19229 These alternate directories are searched first; the standard directories
19230 come next. If a standard directory begins with the configured
19231 @var{prefix} then the value of @var{prefix} is replaced by
19232 @env{GCC_EXEC_PREFIX} when looking for header files.
19233
19234 @item COMPILER_PATH
19235 @findex COMPILER_PATH
19236 The value of @env{COMPILER_PATH} is a colon-separated list of
19237 directories, much like @env{PATH}.  GCC tries the directories thus
19238 specified when searching for subprograms, if it can't find the
19239 subprograms using @env{GCC_EXEC_PREFIX}.
19240
19241 @item LIBRARY_PATH
19242 @findex LIBRARY_PATH
19243 The value of @env{LIBRARY_PATH} is a colon-separated list of
19244 directories, much like @env{PATH}.  When configured as a native compiler,
19245 GCC tries the directories thus specified when searching for special
19246 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
19247 using GCC also uses these directories when searching for ordinary
19248 libraries for the @option{-l} option (but directories specified with
19249 @option{-L} come first).
19250
19251 @item LANG
19252 @findex LANG
19253 @cindex locale definition
19254 This variable is used to pass locale information to the compiler.  One way in
19255 which this information is used is to determine the character set to be used
19256 when character literals, string literals and comments are parsed in C and C++.
19257 When the compiler is configured to allow multibyte characters,
19258 the following values for @env{LANG} are recognized:
19259
19260 @table @samp
19261 @item C-JIS
19262 Recognize JIS characters.
19263 @item C-SJIS
19264 Recognize SJIS characters.
19265 @item C-EUCJP
19266 Recognize EUCJP characters.
19267 @end table
19268
19269 If @env{LANG} is not defined, or if it has some other value, then the
19270 compiler will use mblen and mbtowc as defined by the default locale to
19271 recognize and translate multibyte characters.
19272 @end table
19273
19274 @noindent
19275 Some additional environments variables affect the behavior of the
19276 preprocessor.
19277
19278 @include cppenv.texi
19279
19280 @c man end
19281
19282 @node Precompiled Headers
19283 @section Using Precompiled Headers
19284 @cindex precompiled headers
19285 @cindex speed of compilation
19286
19287 Often large projects have many header files that are included in every
19288 source file.  The time the compiler takes to process these header files
19289 over and over again can account for nearly all of the time required to
19290 build the project.  To make builds faster, GCC allows users to
19291 `precompile' a header file; then, if builds can use the precompiled
19292 header file they will be much faster.
19293
19294 To create a precompiled header file, simply compile it as you would any
19295 other file, if necessary using the @option{-x} option to make the driver
19296 treat it as a C or C++ header file.  You will probably want to use a
19297 tool like @command{make} to keep the precompiled header up-to-date when
19298 the headers it contains change.
19299
19300 A precompiled header file will be searched for when @code{#include} is
19301 seen in the compilation.  As it searches for the included file
19302 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
19303 compiler looks for a precompiled header in each directory just before it
19304 looks for the include file in that directory.  The name searched for is
19305 the name specified in the @code{#include} with @samp{.gch} appended.  If
19306 the precompiled header file can't be used, it is ignored.
19307
19308 For instance, if you have @code{#include "all.h"}, and you have
19309 @file{all.h.gch} in the same directory as @file{all.h}, then the
19310 precompiled header file will be used if possible, and the original
19311 header will be used otherwise.
19312
19313 Alternatively, you might decide to put the precompiled header file in a
19314 directory and use @option{-I} to ensure that directory is searched
19315 before (or instead of) the directory containing the original header.
19316 Then, if you want to check that the precompiled header file is always
19317 used, you can put a file of the same name as the original header in this
19318 directory containing an @code{#error} command.
19319
19320 This also works with @option{-include}.  So yet another way to use
19321 precompiled headers, good for projects not designed with precompiled
19322 header files in mind, is to simply take most of the header files used by
19323 a project, include them from another header file, precompile that header
19324 file, and @option{-include} the precompiled header.  If the header files
19325 have guards against multiple inclusion, they will be skipped because
19326 they've already been included (in the precompiled header).
19327
19328 If you need to precompile the same header file for different
19329 languages, targets, or compiler options, you can instead make a
19330 @emph{directory} named like @file{all.h.gch}, and put each precompiled
19331 header in the directory, perhaps using @option{-o}.  It doesn't matter
19332 what you call the files in the directory, every precompiled header in
19333 the directory will be considered.  The first precompiled header
19334 encountered in the directory that is valid for this compilation will
19335 be used; they're searched in no particular order.
19336
19337 There are many other possibilities, limited only by your imagination,
19338 good sense, and the constraints of your build system.
19339
19340 A precompiled header file can be used only when these conditions apply:
19341
19342 @itemize
19343 @item
19344 Only one precompiled header can be used in a particular compilation.
19345
19346 @item
19347 A precompiled header can't be used once the first C token is seen.  You
19348 can have preprocessor directives before a precompiled header; you can
19349 even include a precompiled header from inside another header, so long as
19350 there are no C tokens before the @code{#include}.
19351
19352 @item
19353 The precompiled header file must be produced for the same language as
19354 the current compilation.  You can't use a C precompiled header for a C++
19355 compilation.
19356
19357 @item
19358 The precompiled header file must have been produced by the same compiler
19359 binary as the current compilation is using.
19360
19361 @item
19362 Any macros defined before the precompiled header is included must
19363 either be defined in the same way as when the precompiled header was
19364 generated, or must not affect the precompiled header, which usually
19365 means that they don't appear in the precompiled header at all.
19366
19367 The @option{-D} option is one way to define a macro before a
19368 precompiled header is included; using a @code{#define} can also do it.
19369 There are also some options that define macros implicitly, like
19370 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
19371 defined this way.
19372
19373 @item If debugging information is output when using the precompiled
19374 header, using @option{-g} or similar, the same kind of debugging information
19375 must have been output when building the precompiled header.  However,
19376 a precompiled header built using @option{-g} can be used in a compilation
19377 when no debugging information is being output.
19378
19379 @item The same @option{-m} options must generally be used when building
19380 and using the precompiled header.  @xref{Submodel Options},
19381 for any cases where this rule is relaxed.
19382
19383 @item Each of the following options must be the same when building and using
19384 the precompiled header:
19385
19386 @gccoptlist{-fexceptions}
19387
19388 @item
19389 Some other command-line options starting with @option{-f},
19390 @option{-p}, or @option{-O} must be defined in the same way as when
19391 the precompiled header was generated.  At present, it's not clear
19392 which options are safe to change and which are not; the safest choice
19393 is to use exactly the same options when generating and using the
19394 precompiled header.  The following are known to be safe:
19395
19396 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
19397 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
19398 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
19399 -pedantic-errors}
19400
19401 @end itemize
19402
19403 For all of these except the last, the compiler will automatically
19404 ignore the precompiled header if the conditions aren't met.  If you
19405 find an option combination that doesn't work and doesn't cause the
19406 precompiled header to be ignored, please consider filing a bug report,
19407 see @ref{Bugs}.
19408
19409 If you do use differing options when generating and using the
19410 precompiled header, the actual behavior will be a mixture of the
19411 behavior for the options.  For instance, if you use @option{-g} to
19412 generate the precompiled header but not when using it, you may or may
19413 not get debugging information for routines in the precompiled header.