re checking -fdump-passes
[official-gcc.git] / gcc / doc / invoke.texi
blob44a17b041f147a2221ddc969d07214c77872f8b1
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.
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
15 Free Software Foundation, Inc.
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.
25 (a) The FSF's Front-Cover Text is:
27      A GNU Manual
29 (b) The FSF's Back-Cover Text is:
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{}
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
67 @node Invoking GCC
68 @chapter GCC Command Options
69 @cindex GCC command options
70 @cindex command options
71 @cindex options, GCC command
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.
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.
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.
92 @cindex C++ compilation options
93 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
94 options for compiling C++ programs.
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}}.
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.
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.
118 @c man end
120 @xref{Option Index}, for an index to GCC's options.
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
153 @c man begin OPTIONS
155 @node Option Summary
156 @section Option Summary
158 Here is a summary of all the options, grouped by type.  Explanations are
159 in the following sections.
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}}
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} @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}
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}
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}
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}
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++0x-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} -Wjump-misses-init -Wignored-qualifiers @gol
248 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
249 -Winit-self  -Winline -Wmaybe-uninitialized @gol
250 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
251 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
252 -Wlogical-op -Wlong-long @gol
253 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
254 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
255 -Wno-mudflap @gol
256 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
257 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
258 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
259 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
260 -Wredundant-decls @gol
261 -Wreturn-type  -Wsequence-point  -Wshadow @gol
262 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
263 -Wstack-usage=@var{len} -Wstrict-aliasing -Wstrict-aliasing=n @gol
264 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
265 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]} @gol
266 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
267 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
268 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
269 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
270 -Wunused-label  -Wunused-parameter -Wno-unused-result -Wunused-value @gol
271 -Wunused-variable -Wunused-but-set-parameter -Wunused-but-set-variable @gol
272 -Wvariadic-macros -Wvla -Wvolatile-register-var  -Wwrite-strings}
274 @item C and Objective-C-only Warning Options
275 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
276 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
277 -Wold-style-declaration  -Wold-style-definition @gol
278 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
279 -Wdeclaration-after-statement -Wpointer-sign}
281 @item Debugging Options
282 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
283 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
284 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
285 -fdisable-ipa-@var{pass_name} @gol
286 -fdisable-rtl-@var{pass_name} @gol
287 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
288 -fdisable-tree-@var{pass_name} @gol
289 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
290 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
291 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
292 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
293 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
294 -fdump-passes @gol
295 -fdump-statistics @gol
296 -fdump-tree-all @gol
297 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
298 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
299 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
300 -fdump-tree-ch @gol
301 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
303 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
304 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
305 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
307 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
308 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-nrv -fdump-tree-vect @gol
311 -fdump-tree-sink @gol
312 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
316 -ftree-vectorizer-verbose=@var{n} @gol
317 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
318 -fdump-final-insns=@var{file} @gol
319 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
320 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
321 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
322 -fenable-@var{kind}-@var{pass} @gol
323 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
324 -fdebug-types-section @gol
325 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
326 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
327 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
328 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
329 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
330 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
331 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
332 -gvms  -gxcoff  -gxcoff+ @gol
333 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
334 -fdebug-prefix-map=@var{old}=@var{new} @gol
335 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
336 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
337 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
338 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
339 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
340 -print-sysroot -print-sysroot-headers-suffix @gol
341 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
343 @item Optimization Options
344 @xref{Optimize Options,,Options that Control Optimization}.
345 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
346 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
347 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
348 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
349 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
350 -fcompare-elim -fcprop-registers -fcrossjumping @gol
351 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
352 -fcx-limited-range @gol
353 -fdata-sections -fdce -fdce -fdelayed-branch @gol
354 -fdelete-null-pointer-checks -fdse -fdevirtualize -fdse @gol
355 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
356 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
357 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
358 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
359 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
360 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
361 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg @gol
362 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
363 -fira-algorithm=@var{algorithm} @gol
364 -fira-region=@var{region} @gol
365 -fira-loop-pressure -fno-ira-share-save-slots @gol
366 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
367 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
368 -floop-block -floop-flatten -floop-interchange -floop-strip-mine @gol
369 -floop-parallelize-all -flto -flto-compression-level @gol
370 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
371 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
372 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
373 -fno-default-inline @gol
374 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
375 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
376 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
377 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
378 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
379 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
380 -fprefetch-loop-arrays @gol
381 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
382 -fprofile-generate=@var{path} @gol
383 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
384 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
385 -freorder-blocks-and-partition -freorder-functions @gol
386 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
387 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
388 -fsched-spec-load -fsched-spec-load-dangerous @gol
389 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
390 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
391 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
392 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
393 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
394 -fselective-scheduling -fselective-scheduling2 @gol
395 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
396 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
397 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
398 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
399 -ftree-bit-ccp @gol
400 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
401 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
402 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
403 -ftree-loop-if-convert-stores -ftree-loop-im @gol
404 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
405 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
406 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
407 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
408 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
409 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
410 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
411 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
412 -fwhole-program -fwpa -fuse-linker-plugin @gol
413 --param @var{name}=@var{value}
414 -O  -O0  -O1  -O2  -O3  -Os -Ofast}
416 @item Preprocessor Options
417 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
418 @gccoptlist{-A@var{question}=@var{answer} @gol
419 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
420 -C  -dD  -dI  -dM  -dN @gol
421 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
422 -idirafter @var{dir} @gol
423 -include @var{file}  -imacros @var{file} @gol
424 -iprefix @var{file}  -iwithprefix @var{dir} @gol
425 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
426 -imultilib @var{dir} -isysroot @var{dir} @gol
427 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
428 -P  -fworking-directory  -remap @gol
429 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
430 -Xpreprocessor @var{option}}
432 @item Assembler Option
433 @xref{Assembler Options,,Passing Options to the Assembler}.
434 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
436 @item Linker Options
437 @xref{Link Options,,Options for Linking}.
438 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
439 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
440 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
441 -shared-libgcc  -symbolic @gol
442 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
443 -u @var{symbol}}
445 @item Directory Options
446 @xref{Directory Options,,Options for Directory Search}.
447 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
448 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
449 --sysroot=@var{dir}}
451 @item Machine Dependent Options
452 @xref{Submodel Options,,Hardware Models and Configurations}.
453 @c This list is ordered alphanumerically by subsection name.
454 @c Try and put the significant identifier (CPU or system) first,
455 @c so users have a clue at guessing where the ones they want will be.
457 @emph{ARM Options}
458 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
459 -mabi=@var{name} @gol
460 -mapcs-stack-check  -mno-apcs-stack-check @gol
461 -mapcs-float  -mno-apcs-float @gol
462 -mapcs-reentrant  -mno-apcs-reentrant @gol
463 -msched-prolog  -mno-sched-prolog @gol
464 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
465 -mfloat-abi=@var{name}  -mfpe @gol
466 -mfp16-format=@var{name}
467 -mthumb-interwork  -mno-thumb-interwork @gol
468 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
469 -mstructure-size-boundary=@var{n} @gol
470 -mabort-on-noreturn @gol
471 -mlong-calls  -mno-long-calls @gol
472 -msingle-pic-base  -mno-single-pic-base @gol
473 -mpic-register=@var{reg} @gol
474 -mnop-fun-dllimport @gol
475 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
476 -mpoke-function-name @gol
477 -mthumb  -marm @gol
478 -mtpcs-frame  -mtpcs-leaf-frame @gol
479 -mcaller-super-interworking  -mcallee-super-interworking @gol
480 -mtp=@var{name} @gol
481 -mword-relocations @gol
482 -mfix-cortex-m3-ldrd}
484 @emph{AVR Options}
485 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
486 -mcall-prologues  -mtiny-stack  -mint8}
488 @emph{Blackfin Options}
489 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
490 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
491 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
492 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
493 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
494 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
495 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
496 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
497 -micplb}
499 @emph{CRIS Options}
500 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
501 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
502 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
503 -mstack-align  -mdata-align  -mconst-align @gol
504 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
505 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
506 -mmul-bug-workaround  -mno-mul-bug-workaround}
508 @emph{Darwin Options}
509 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
510 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
511 -client_name  -compatibility_version  -current_version @gol
512 -dead_strip @gol
513 -dependency-file  -dylib_file  -dylinker_install_name @gol
514 -dynamic  -dynamiclib  -exported_symbols_list @gol
515 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
516 -force_flat_namespace  -headerpad_max_install_names @gol
517 -iframework @gol
518 -image_base  -init  -install_name  -keep_private_externs @gol
519 -multi_module  -multiply_defined  -multiply_defined_unused @gol
520 -noall_load   -no_dead_strip_inits_and_terms @gol
521 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
522 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
523 -private_bundle  -read_only_relocs  -sectalign @gol
524 -sectobjectsymbols  -whyload  -seg1addr @gol
525 -sectcreate  -sectobjectsymbols  -sectorder @gol
526 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
527 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
528 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
529 -single_module  -static  -sub_library  -sub_umbrella @gol
530 -twolevel_namespace  -umbrella  -undefined @gol
531 -unexported_symbols_list  -weak_reference_mismatches @gol
532 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
533 -mkernel -mone-byte-bool}
535 @emph{DEC Alpha Options}
536 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
537 -mieee  -mieee-with-inexact  -mieee-conformant @gol
538 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
539 -mtrap-precision=@var{mode}  -mbuild-constants @gol
540 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
541 -mbwx  -mmax  -mfix  -mcix @gol
542 -mfloat-vax  -mfloat-ieee @gol
543 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
544 -msmall-text  -mlarge-text @gol
545 -mmemory-latency=@var{time}}
547 @emph{DEC Alpha/VMS Options}
548 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
550 @emph{FR30 Options}
551 @gccoptlist{-msmall-model -mno-lsim}
553 @emph{FRV Options}
554 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
555 -mhard-float  -msoft-float @gol
556 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
557 -mdouble  -mno-double @gol
558 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
559 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
560 -mlinked-fp  -mlong-calls  -malign-labels @gol
561 -mlibrary-pic  -macc-4  -macc-8 @gol
562 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
563 -moptimize-membar -mno-optimize-membar @gol
564 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
565 -mvliw-branch  -mno-vliw-branch @gol
566 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
567 -mno-nested-cond-exec  -mtomcat-stats @gol
568 -mTLS -mtls @gol
569 -mcpu=@var{cpu}}
571 @emph{GNU/Linux Options}
572 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
573 -tno-android-cc -tno-android-ld}
575 @emph{H8/300 Options}
576 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
578 @emph{HPPA Options}
579 @gccoptlist{-march=@var{architecture-type} @gol
580 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
581 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
582 -mfixed-range=@var{register-range} @gol
583 -mjump-in-delay -mlinker-opt -mlong-calls @gol
584 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
585 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
586 -mno-jump-in-delay  -mno-long-load-store @gol
587 -mno-portable-runtime  -mno-soft-float @gol
588 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
589 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
590 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
591 -munix=@var{unix-std}  -nolibdld  -static  -threads}
593 @emph{i386 and x86-64 Options}
594 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
595 -mfpmath=@var{unit} @gol
596 -masm=@var{dialect}  -mno-fancy-math-387 @gol
597 -mno-fp-ret-in-387  -msoft-float @gol
598 -mno-wide-multiply  -mrtd  -malign-double @gol
599 -mpreferred-stack-boundary=@var{num} @gol
600 -mincoming-stack-boundary=@var{num} @gol
601 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip -mvzeroupper @gol
602 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
603 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfused-madd @gol
604 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlwp @gol
605 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
606 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
607 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
608 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
609 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
610 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
611 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
612 -mcmodel=@var{code-model} -mabi=@var{name} @gol
613 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
614 -msse2avx -mfentry -m8bit-idiv @gol
615 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
617 @emph{i386 and x86-64 Windows Options}
618 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
619 -mnop-fun-dllimport -mthread @gol
620 -municode -mwin32 -mwindows -fno-set-stack-executable}
622 @emph{IA-64 Options}
623 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
624 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
625 -mconstant-gp  -mauto-pic  -mfused-madd @gol
626 -minline-float-divide-min-latency @gol
627 -minline-float-divide-max-throughput @gol
628 -mno-inline-float-divide @gol
629 -minline-int-divide-min-latency @gol
630 -minline-int-divide-max-throughput  @gol
631 -mno-inline-int-divide @gol
632 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
633 -mno-inline-sqrt @gol
634 -mdwarf2-asm -mearly-stop-bits @gol
635 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
636 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
637 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
638 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
639 -msched-spec-ldc -msched-spec-control-ldc @gol
640 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
641 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
642 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
643 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
645 @emph{IA-64/VMS Options}
646 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
648 @emph{LM32 Options}
649 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
650 -msign-extend-enabled -muser-enabled}
652 @emph{M32R/D Options}
653 @gccoptlist{-m32r2 -m32rx -m32r @gol
654 -mdebug @gol
655 -malign-loops -mno-align-loops @gol
656 -missue-rate=@var{number} @gol
657 -mbranch-cost=@var{number} @gol
658 -mmodel=@var{code-size-model-type} @gol
659 -msdata=@var{sdata-type} @gol
660 -mno-flush-func -mflush-func=@var{name} @gol
661 -mno-flush-trap -mflush-trap=@var{number} @gol
662 -G @var{num}}
664 @emph{M32C Options}
665 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
667 @emph{M680x0 Options}
668 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
669 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
670 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
671 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
672 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
673 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
674 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
675 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
676 -mxgot -mno-xgot}
678 @emph{MCore Options}
679 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
680 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
681 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
682 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
683 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
685 @emph{MeP Options}
686 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
687 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
688 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
689 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
690 -mtiny=@var{n}}
692 @emph{MicroBlaze Options}
693 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
694 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
695 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
696 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
697 -mxl-mode-@var{app-model}}
699 @emph{MIPS Options}
700 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
701 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
702 -mips64  -mips64r2 @gol
703 -mips16  -mno-mips16  -mflip-mips16 @gol
704 -minterlink-mips16  -mno-interlink-mips16 @gol
705 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
706 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
707 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
708 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
709 -mfpu=@var{fpu-type} @gol
710 -msmartmips  -mno-smartmips @gol
711 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
712 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
713 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
714 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
715 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
716 -membedded-data  -mno-embedded-data @gol
717 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
718 -mcode-readable=@var{setting} @gol
719 -msplit-addresses  -mno-split-addresses @gol
720 -mexplicit-relocs  -mno-explicit-relocs @gol
721 -mcheck-zero-division  -mno-check-zero-division @gol
722 -mdivide-traps  -mdivide-breaks @gol
723 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
724 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
725 -mfix-24k -mno-fix-24k @gol
726 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
727 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
728 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
729 -mflush-func=@var{func}  -mno-flush-func @gol
730 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
731 -mfp-exceptions -mno-fp-exceptions @gol
732 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
733 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
735 @emph{MMIX Options}
736 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
737 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
738 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
739 -mno-base-addresses  -msingle-exit  -mno-single-exit}
741 @emph{MN10300 Options}
742 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
743 -mno-am33 -mam33 -mam33-2 -mam34 @gol
744 -mtune=@var{cpu-type} @gol
745 -mreturn-pointer-on-d0 @gol
746 -mno-crt0  -mrelax -mliw -msetlb}
748 @emph{PDP-11 Options}
749 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
750 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
751 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
752 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
753 -mbranch-expensive  -mbranch-cheap @gol
754 -munix-asm  -mdec-asm}
756 @emph{picoChip Options}
757 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
758 -msymbol-as-address -mno-inefficient-warnings}
760 @emph{PowerPC Options}
761 See RS/6000 and PowerPC Options.
763 @emph{RS/6000 and PowerPC Options}
764 @gccoptlist{-mcpu=@var{cpu-type} @gol
765 -mtune=@var{cpu-type} @gol
766 -mcmodel=@var{code-model} @gol
767 -mpower  -mno-power  -mpower2  -mno-power2 @gol
768 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
769 -maltivec  -mno-altivec @gol
770 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
771 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
772 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
773 -mfprnd  -mno-fprnd @gol
774 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
775 -mnew-mnemonics  -mold-mnemonics @gol
776 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
777 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
778 -malign-power  -malign-natural @gol
779 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
780 -msingle-float -mdouble-float -msimple-fpu @gol
781 -mstring  -mno-string  -mupdate  -mno-update @gol
782 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
783 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
784 -mstrict-align  -mno-strict-align  -mrelocatable @gol
785 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
786 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
787 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
788 -mprioritize-restricted-insns=@var{priority} @gol
789 -msched-costly-dep=@var{dependence_type} @gol
790 -minsert-sched-nops=@var{scheme} @gol
791 -mcall-sysv  -mcall-netbsd @gol
792 -maix-struct-return  -msvr4-struct-return @gol
793 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
794 -mblock-move-inline-limit=@var{num} @gol
795 -misel -mno-isel @gol
796 -misel=yes  -misel=no @gol
797 -mspe -mno-spe @gol
798 -mspe=yes  -mspe=no @gol
799 -mpaired @gol
800 -mgen-cell-microcode -mwarn-cell-microcode @gol
801 -mvrsave -mno-vrsave @gol
802 -mmulhw -mno-mulhw @gol
803 -mdlmzb -mno-dlmzb @gol
804 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
805 -mprototype  -mno-prototype @gol
806 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
807 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
808 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
809 -mno-recip-precision @gol
810 -mveclibabi=@var{type} -mfriz -mno-friz}
812 @emph{RX Options}
813 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
814 -mcpu=@gol
815 -mbig-endian-data -mlittle-endian-data @gol
816 -msmall-data @gol
817 -msim  -mno-sim@gol
818 -mas100-syntax -mno-as100-syntax@gol
819 -mrelax@gol
820 -mmax-constant-size=@gol
821 -mint-register=@gol
822 -msave-acc-in-interrupts}
824 @emph{S/390 and zSeries Options}
825 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
826 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
827 -mlong-double-64 -mlong-double-128 @gol
828 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
829 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
830 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
831 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
832 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
834 @emph{Score Options}
835 @gccoptlist{-meb -mel @gol
836 -mnhwloop @gol
837 -muls @gol
838 -mmac @gol
839 -mscore5 -mscore5u -mscore7 -mscore7d}
841 @emph{SH Options}
842 @gccoptlist{-m1  -m2  -m2e @gol
843 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
844 -m3  -m3e @gol
845 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
846 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
847 -m5-64media  -m5-64media-nofpu @gol
848 -m5-32media  -m5-32media-nofpu @gol
849 -m5-compact  -m5-compact-nofpu @gol
850 -mb  -ml  -mdalign  -mrelax @gol
851 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
852 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
853 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
854 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
855 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
856 -maccumulate-outgoing-args -minvalid-symbols}
858 @emph{Solaris 2 Options}
859 @gccoptlist{-mimpure-text  -mno-impure-text @gol
860 -pthreads -pthread}
862 @emph{SPARC Options}
863 @gccoptlist{-mcpu=@var{cpu-type} @gol
864 -mtune=@var{cpu-type} @gol
865 -mcmodel=@var{code-model} @gol
866 -m32  -m64  -mapp-regs  -mno-app-regs @gol
867 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
868 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
869 -mhard-quad-float  -msoft-quad-float @gol
870 -mlittle-endian @gol
871 -mstack-bias  -mno-stack-bias @gol
872 -munaligned-doubles  -mno-unaligned-doubles @gol
873 -mv8plus  -mno-v8plus  -mvis  -mno-vis}
875 @emph{SPU Options}
876 @gccoptlist{-mwarn-reloc -merror-reloc @gol
877 -msafe-dma -munsafe-dma @gol
878 -mbranch-hints @gol
879 -msmall-mem -mlarge-mem -mstdmain @gol
880 -mfixed-range=@var{register-range} @gol
881 -mea32 -mea64 @gol
882 -maddress-space-conversion -mno-address-space-conversion @gol
883 -mcache-size=@var{cache-size} @gol
884 -matomic-updates -mno-atomic-updates}
886 @emph{System V Options}
887 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
889 @emph{V850 Options}
890 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
891 -mprolog-function  -mno-prolog-function  -mspace @gol
892 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
893 -mapp-regs  -mno-app-regs @gol
894 -mdisable-callt  -mno-disable-callt @gol
895 -mv850e2v3 @gol
896 -mv850e2 @gol
897 -mv850e1 -mv850es @gol
898 -mv850e @gol
899 -mv850  -mbig-switch}
901 @emph{VAX Options}
902 @gccoptlist{-mg  -mgnu  -munix}
904 @emph{VxWorks Options}
905 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
906 -Xbind-lazy  -Xbind-now}
908 @emph{x86-64 Options}
909 See i386 and x86-64 Options.
911 @emph{Xstormy16 Options}
912 @gccoptlist{-msim}
914 @emph{Xtensa Options}
915 @gccoptlist{-mconst16 -mno-const16 @gol
916 -mfused-madd  -mno-fused-madd @gol
917 -mforce-no-pic @gol
918 -mserialize-volatile  -mno-serialize-volatile @gol
919 -mtext-section-literals  -mno-text-section-literals @gol
920 -mtarget-align  -mno-target-align @gol
921 -mlongcalls  -mno-longcalls}
923 @emph{zSeries Options}
924 See S/390 and zSeries Options.
926 @item Code Generation Options
927 @xref{Code Gen Options,,Options for Code Generation Conventions}.
928 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
929 -ffixed-@var{reg}  -fexceptions @gol
930 -fnon-call-exceptions  -funwind-tables @gol
931 -fasynchronous-unwind-tables @gol
932 -finhibit-size-directive  -finstrument-functions @gol
933 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
934 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
935 -fno-common  -fno-ident @gol
936 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
937 -fno-jump-tables @gol
938 -frecord-gcc-switches @gol
939 -freg-struct-return  -fshort-enums @gol
940 -fshort-double  -fshort-wchar @gol
941 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
942 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
943 -fno-stack-limit -fsplit-stack @gol
944 -fleading-underscore  -ftls-model=@var{model} @gol
945 -ftrapv  -fwrapv  -fbounds-check @gol
946 -fvisibility -fstrict-volatile-bitfields}
947 @end table
949 @menu
950 * Overall Options::     Controlling the kind of output:
951                         an executable, object files, assembler files,
952                         or preprocessed source.
953 * C Dialect Options::   Controlling the variant of C language compiled.
954 * C++ Dialect Options:: Variations on C++.
955 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
956                         and Objective-C++.
957 * Language Independent Options:: Controlling how diagnostics should be
958                         formatted.
959 * Warning Options::     How picky should the compiler be?
960 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
961 * Optimize Options::    How much optimization?
962 * Preprocessor Options:: Controlling header files and macro definitions.
963                          Also, getting dependency information for Make.
964 * Assembler Options::   Passing options to the assembler.
965 * Link Options::        Specifying libraries and so on.
966 * Directory Options::   Where to find header files and libraries.
967                         Where to find the compiler executable files.
968 * Spec Files::          How to pass switches to sub-processes.
969 * Target Options::      Running a cross-compiler, or an old version of GCC.
970 @end menu
972 @node Overall Options
973 @section Options Controlling the Kind of Output
975 Compilation can involve up to four stages: preprocessing, compilation
976 proper, assembly and linking, always in that order.  GCC is capable of
977 preprocessing and compiling several files either into several
978 assembler input files, or into one assembler input file; then each
979 assembler input file produces an object file, and linking combines all
980 the object files (those newly compiled, and those specified as input)
981 into an executable file.
983 @cindex file name suffix
984 For any given input file, the file name suffix determines what kind of
985 compilation is done:
987 @table @gcctabopt
988 @item @var{file}.c
989 C source code which must be preprocessed.
991 @item @var{file}.i
992 C source code which should not be preprocessed.
994 @item @var{file}.ii
995 C++ source code which should not be preprocessed.
997 @item @var{file}.m
998 Objective-C source code.  Note that you must link with the @file{libobjc}
999 library to make an Objective-C program work.
1001 @item @var{file}.mi
1002 Objective-C source code which should not be preprocessed.
1004 @item @var{file}.mm
1005 @itemx @var{file}.M
1006 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1007 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1008 to a literal capital M@.
1010 @item @var{file}.mii
1011 Objective-C++ source code which should not be preprocessed.
1013 @item @var{file}.h
1014 C, C++, Objective-C or Objective-C++ header file to be turned into a
1015 precompiled header (default), or C, C++ header file to be turned into an
1016 Ada spec (via the @option{-fdump-ada-spec} switch).
1018 @item @var{file}.cc
1019 @itemx @var{file}.cp
1020 @itemx @var{file}.cxx
1021 @itemx @var{file}.cpp
1022 @itemx @var{file}.CPP
1023 @itemx @var{file}.c++
1024 @itemx @var{file}.C
1025 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
1026 the last two letters must both be literally @samp{x}.  Likewise,
1027 @samp{.C} refers to a literal capital C@.
1029 @item @var{file}.mm
1030 @itemx @var{file}.M
1031 Objective-C++ source code which must be preprocessed.
1033 @item @var{file}.mii
1034 Objective-C++ source code which should not be preprocessed.
1036 @item @var{file}.hh
1037 @itemx @var{file}.H
1038 @itemx @var{file}.hp
1039 @itemx @var{file}.hxx
1040 @itemx @var{file}.hpp
1041 @itemx @var{file}.HPP
1042 @itemx @var{file}.h++
1043 @itemx @var{file}.tcc
1044 C++ header file to be turned into a precompiled header or Ada spec.
1046 @item @var{file}.f
1047 @itemx @var{file}.for
1048 @itemx @var{file}.ftn
1049 Fixed form Fortran source code which should not be preprocessed.
1051 @item @var{file}.F
1052 @itemx @var{file}.FOR
1053 @itemx @var{file}.fpp
1054 @itemx @var{file}.FPP
1055 @itemx @var{file}.FTN
1056 Fixed form Fortran source code which must be preprocessed (with the traditional
1057 preprocessor).
1059 @item @var{file}.f90
1060 @itemx @var{file}.f95
1061 @itemx @var{file}.f03
1062 @itemx @var{file}.f08
1063 Free form Fortran source code which should not be preprocessed.
1065 @item @var{file}.F90
1066 @itemx @var{file}.F95
1067 @itemx @var{file}.F03
1068 @itemx @var{file}.F08
1069 Free form Fortran source code which must be preprocessed (with the
1070 traditional preprocessor).
1072 @item @var{file}.go
1073 Go source code.
1075 @c FIXME: Descriptions of Java file types.
1076 @c @var{file}.java
1077 @c @var{file}.class
1078 @c @var{file}.zip
1079 @c @var{file}.jar
1081 @item @var{file}.ads
1082 Ada source code file which contains a library unit declaration (a
1083 declaration of a package, subprogram, or generic, or a generic
1084 instantiation), or a library unit renaming declaration (a package,
1085 generic, or subprogram renaming declaration).  Such files are also
1086 called @dfn{specs}.
1088 @item @var{file}.adb
1089 Ada source code file containing a library unit body (a subprogram or
1090 package body).  Such files are also called @dfn{bodies}.
1092 @c GCC also knows about some suffixes for languages not yet included:
1093 @c Pascal:
1094 @c @var{file}.p
1095 @c @var{file}.pas
1096 @c Ratfor:
1097 @c @var{file}.r
1099 @item @var{file}.s
1100 Assembler code.
1102 @item @var{file}.S
1103 @itemx @var{file}.sx
1104 Assembler code which must be preprocessed.
1106 @item @var{other}
1107 An object file to be fed straight into linking.
1108 Any file name with no recognized suffix is treated this way.
1109 @end table
1111 @opindex x
1112 You can specify the input language explicitly with the @option{-x} option:
1114 @table @gcctabopt
1115 @item -x @var{language}
1116 Specify explicitly the @var{language} for the following input files
1117 (rather than letting the compiler choose a default based on the file
1118 name suffix).  This option applies to all following input files until
1119 the next @option{-x} option.  Possible values for @var{language} are:
1120 @smallexample
1121 c  c-header  cpp-output
1122 c++  c++-header  c++-cpp-output
1123 objective-c  objective-c-header  objective-c-cpp-output
1124 objective-c++ objective-c++-header objective-c++-cpp-output
1125 assembler  assembler-with-cpp
1127 f77  f77-cpp-input f95  f95-cpp-input
1129 java
1130 @end smallexample
1132 @item -x none
1133 Turn off any specification of a language, so that subsequent files are
1134 handled according to their file name suffixes (as they are if @option{-x}
1135 has not been used at all).
1137 @item -pass-exit-codes
1138 @opindex pass-exit-codes
1139 Normally the @command{gcc} program will exit with the code of 1 if any
1140 phase of the compiler returns a non-success return code.  If you specify
1141 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1142 numerically highest error produced by any phase that returned an error
1143 indication.  The C, C++, and Fortran frontends return 4, if an internal
1144 compiler error is encountered.
1145 @end table
1147 If you only want some of the stages of compilation, you can use
1148 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1149 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1150 @command{gcc} is to stop.  Note that some combinations (for example,
1151 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1153 @table @gcctabopt
1154 @item -c
1155 @opindex c
1156 Compile or assemble the source files, but do not link.  The linking
1157 stage simply is not done.  The ultimate output is in the form of an
1158 object file for each source file.
1160 By default, the object file name for a source file is made by replacing
1161 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1163 Unrecognized input files, not requiring compilation or assembly, are
1164 ignored.
1166 @item -S
1167 @opindex S
1168 Stop after the stage of compilation proper; do not assemble.  The output
1169 is in the form of an assembler code file for each non-assembler input
1170 file specified.
1172 By default, the assembler file name for a source file is made by
1173 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1175 Input files that don't require compilation are ignored.
1177 @item -E
1178 @opindex E
1179 Stop after the preprocessing stage; do not run the compiler proper.  The
1180 output is in the form of preprocessed source code, which is sent to the
1181 standard output.
1183 Input files which don't require preprocessing are ignored.
1185 @cindex output file option
1186 @item -o @var{file}
1187 @opindex o
1188 Place output in file @var{file}.  This applies regardless to whatever
1189 sort of output is being produced, whether it be an executable file,
1190 an object file, an assembler file or preprocessed C code.
1192 If @option{-o} is not specified, the default is to put an executable
1193 file in @file{a.out}, the object file for
1194 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1195 assembler file in @file{@var{source}.s}, a precompiled header file in
1196 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1197 standard output.
1199 @item -v
1200 @opindex v
1201 Print (on standard error output) the commands executed to run the stages
1202 of compilation.  Also print the version number of the compiler driver
1203 program and of the preprocessor and the compiler proper.
1205 @item -###
1206 @opindex ###
1207 Like @option{-v} except the commands are not executed and arguments
1208 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1209 This is useful for shell scripts to capture the driver-generated command lines.
1211 @item -pipe
1212 @opindex pipe
1213 Use pipes rather than temporary files for communication between the
1214 various stages of compilation.  This fails to work on some systems where
1215 the assembler is unable to read from a pipe; but the GNU assembler has
1216 no trouble.
1218 @item --help
1219 @opindex help
1220 Print (on the standard output) a description of the command line options
1221 understood by @command{gcc}.  If the @option{-v} option is also specified
1222 then @option{--help} will also be passed on to the various processes
1223 invoked by @command{gcc}, so that they can display the command line options
1224 they accept.  If the @option{-Wextra} option has also been specified
1225 (prior to the @option{--help} option), then command line options which
1226 have no documentation associated with them will also be displayed.
1228 @item --target-help
1229 @opindex target-help
1230 Print (on the standard output) a description of target-specific command
1231 line options for each tool.  For some targets extra target-specific
1232 information may also be printed.
1234 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1235 Print (on the standard output) a description of the command line
1236 options understood by the compiler that fit into all specified classes
1237 and qualifiers.  These are the supported classes:
1239 @table @asis
1240 @item @samp{optimizers}
1241 This will display all of the optimization options supported by the
1242 compiler.
1244 @item @samp{warnings}
1245 This will display all of the options controlling warning messages
1246 produced by the compiler.
1248 @item @samp{target}
1249 This will display target-specific options.  Unlike the
1250 @option{--target-help} option however, target-specific options of the
1251 linker and assembler will not be displayed.  This is because those
1252 tools do not currently support the extended @option{--help=} syntax.
1254 @item @samp{params}
1255 This will display the values recognized by the @option{--param}
1256 option.
1258 @item @var{language}
1259 This will display the options supported for @var{language}, where
1260 @var{language} is the name of one of the languages supported in this
1261 version of GCC.
1263 @item @samp{common}
1264 This will display the options that are common to all languages.
1265 @end table
1267 These are the supported qualifiers:
1269 @table @asis
1270 @item @samp{undocumented}
1271 Display only those options which are undocumented.
1273 @item @samp{joined}
1274 Display options which take an argument that appears after an equal
1275 sign in the same continuous piece of text, such as:
1276 @samp{--help=target}.
1278 @item @samp{separate}
1279 Display options which take an argument that appears as a separate word
1280 following the original option, such as: @samp{-o output-file}.
1281 @end table
1283 Thus for example to display all the undocumented target-specific
1284 switches supported by the compiler the following can be used:
1286 @smallexample
1287 --help=target,undocumented
1288 @end smallexample
1290 The sense of a qualifier can be inverted by prefixing it with the
1291 @samp{^} character, so for example to display all binary warning
1292 options (i.e., ones that are either on or off and that do not take an
1293 argument), which have a description the following can be used:
1295 @smallexample
1296 --help=warnings,^joined,^undocumented
1297 @end smallexample
1299 The argument to @option{--help=} should not consist solely of inverted
1300 qualifiers.
1302 Combining several classes is possible, although this usually
1303 restricts the output by so much that there is nothing to display.  One
1304 case where it does work however is when one of the classes is
1305 @var{target}.  So for example to display all the target-specific
1306 optimization options the following can be used:
1308 @smallexample
1309 --help=target,optimizers
1310 @end smallexample
1312 The @option{--help=} option can be repeated on the command line.  Each
1313 successive use will display its requested class of options, skipping
1314 those that have already been displayed.
1316 If the @option{-Q} option appears on the command line before the
1317 @option{--help=} option, then the descriptive text displayed by
1318 @option{--help=} is changed.  Instead of describing the displayed
1319 options, an indication is given as to whether the option is enabled,
1320 disabled or set to a specific value (assuming that the compiler
1321 knows this at the point where the @option{--help=} option is used).
1323 Here is a truncated example from the ARM port of @command{gcc}:
1325 @smallexample
1326   % gcc -Q -mabi=2 --help=target -c
1327   The following options are target specific:
1328   -mabi=                                2
1329   -mabort-on-noreturn                   [disabled]
1330   -mapcs                                [disabled]
1331 @end smallexample
1333 The output is sensitive to the effects of previous command line
1334 options, so for example it is possible to find out which optimizations
1335 are enabled at @option{-O2} by using:
1337 @smallexample
1338 -Q -O2 --help=optimizers
1339 @end smallexample
1341 Alternatively you can discover which binary optimizations are enabled
1342 by @option{-O3} by using:
1344 @smallexample
1345 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1346 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1347 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1348 @end smallexample
1350 @item -no-canonical-prefixes
1351 @opindex no-canonical-prefixes
1352 Do not expand any symbolic links, resolve references to @samp{/../}
1353 or @samp{/./}, or make the path absolute when generating a relative
1354 prefix.
1356 @item --version
1357 @opindex version
1358 Display the version number and copyrights of the invoked GCC@.
1360 @item -wrapper
1361 @opindex wrapper
1362 Invoke all subcommands under a wrapper program.  The name of the
1363 wrapper program and its parameters are passed as a comma separated
1364 list.
1366 @smallexample
1367 gcc -c t.c -wrapper gdb,--args
1368 @end smallexample
1370 This will invoke all subprograms of @command{gcc} under
1371 @samp{gdb --args}, thus the invocation of @command{cc1} will be
1372 @samp{gdb --args cc1 @dots{}}.
1374 @item -fplugin=@var{name}.so
1375 Load the plugin code in file @var{name}.so, assumed to be a
1376 shared object to be dlopen'd by the compiler.  The base name of
1377 the shared object file is used to identify the plugin for the
1378 purposes of argument parsing (See
1379 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1380 Each plugin should define the callback functions specified in the
1381 Plugins API.
1383 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1384 Define an argument called @var{key} with a value of @var{value}
1385 for the plugin called @var{name}.
1387 @item -fdump-ada-spec@r{[}-slim@r{]}
1388 For C and C++ source and include files, generate corresponding Ada
1389 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1390 GNAT User's Guide}, which provides detailed documentation on this feature.
1392 @item -fdump-go-spec=@var{file}
1393 For input files in any language, generate corresponding Go
1394 declarations in @var{file}.  This generates Go @code{const},
1395 @code{type}, @code{var}, and @code{func} declarations which may be a
1396 useful way to start writing a Go interface to code written in some
1397 other language.
1399 @include @value{srcdir}/../libiberty/at-file.texi
1400 @end table
1402 @node Invoking G++
1403 @section Compiling C++ Programs
1405 @cindex suffixes for C++ source
1406 @cindex C++ source file suffixes
1407 C++ source files conventionally use one of the suffixes @samp{.C},
1408 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1409 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1410 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1411 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1412 files with these names and compiles them as C++ programs even if you
1413 call the compiler the same way as for compiling C programs (usually
1414 with the name @command{gcc}).
1416 @findex g++
1417 @findex c++
1418 However, the use of @command{gcc} does not add the C++ library.
1419 @command{g++} is a program that calls GCC and treats @samp{.c},
1420 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1421 files unless @option{-x} is used, and automatically specifies linking
1422 against the C++ library.  This program is also useful when
1423 precompiling a C header file with a @samp{.h} extension for use in C++
1424 compilations.  On many systems, @command{g++} is also installed with
1425 the name @command{c++}.
1427 @cindex invoking @command{g++}
1428 When you compile C++ programs, you may specify many of the same
1429 command-line options that you use for compiling programs in any
1430 language; or command-line options meaningful for C and related
1431 languages; or options that are meaningful only for C++ programs.
1432 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1433 explanations of options for languages related to C@.
1434 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1435 explanations of options that are meaningful only for C++ programs.
1437 @node C Dialect Options
1438 @section Options Controlling C Dialect
1439 @cindex dialect options
1440 @cindex language dialect options
1441 @cindex options, dialect
1443 The following options control the dialect of C (or languages derived
1444 from C, such as C++, Objective-C and Objective-C++) that the compiler
1445 accepts:
1447 @table @gcctabopt
1448 @cindex ANSI support
1449 @cindex ISO support
1450 @item -ansi
1451 @opindex ansi
1452 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1453 equivalent to @samp{-std=c++98}.
1455 This turns off certain features of GCC that are incompatible with ISO
1456 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1457 such as the @code{asm} and @code{typeof} keywords, and
1458 predefined macros such as @code{unix} and @code{vax} that identify the
1459 type of system you are using.  It also enables the undesirable and
1460 rarely used ISO trigraph feature.  For the C compiler,
1461 it disables recognition of C++ style @samp{//} comments as well as
1462 the @code{inline} keyword.
1464 The alternate keywords @code{__asm__}, @code{__extension__},
1465 @code{__inline__} and @code{__typeof__} continue to work despite
1466 @option{-ansi}.  You would not want to use them in an ISO C program, of
1467 course, but it is useful to put them in header files that might be included
1468 in compilations done with @option{-ansi}.  Alternate predefined macros
1469 such as @code{__unix__} and @code{__vax__} are also available, with or
1470 without @option{-ansi}.
1472 The @option{-ansi} option does not cause non-ISO programs to be
1473 rejected gratuitously.  For that, @option{-pedantic} is required in
1474 addition to @option{-ansi}.  @xref{Warning Options}.
1476 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1477 option is used.  Some header files may notice this macro and refrain
1478 from declaring certain functions or defining certain macros that the
1479 ISO standard doesn't call for; this is to avoid interfering with any
1480 programs that might use these names for other things.
1482 Functions that would normally be built in but do not have semantics
1483 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1484 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1485 built-in functions provided by GCC}, for details of the functions
1486 affected.
1488 @item -std=
1489 @opindex std
1490 Determine the language standard. @xref{Standards,,Language Standards
1491 Supported by GCC}, for details of these standard versions.  This option
1492 is currently only supported when compiling C or C++.
1494 The compiler can accept several base standards, such as @samp{c90} or
1495 @samp{c++98}, and GNU dialects of those standards, such as
1496 @samp{gnu90} or @samp{gnu++98}.  By specifying a base standard, the
1497 compiler will accept all programs following that standard and those
1498 using GNU extensions that do not contradict it.  For example,
1499 @samp{-std=c90} turns off certain features of GCC that are
1500 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1501 keywords, but not other GNU extensions that do not have a meaning in
1502 ISO C90, such as omitting the middle term of a @code{?:}
1503 expression. On the other hand, by specifying a GNU dialect of a
1504 standard, all features the compiler support are enabled, even when
1505 those features change the meaning of the base standard and some
1506 strict-conforming programs may be rejected.  The particular standard
1507 is used by @option{-pedantic} to identify which features are GNU
1508 extensions given that version of the standard. For example
1509 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1510 comments, while @samp{-std=gnu99 -pedantic} would not.
1512 A value for this option must be provided; possible values are
1514 @table @samp
1515 @item c90
1516 @itemx c89
1517 @itemx iso9899:1990
1518 Support all ISO C90 programs (certain GNU extensions that conflict
1519 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1521 @item iso9899:199409
1522 ISO C90 as modified in amendment 1.
1524 @item c99
1525 @itemx c9x
1526 @itemx iso9899:1999
1527 @itemx iso9899:199x
1528 ISO C99.  Note that this standard is not yet fully supported; see
1529 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1530 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1532 @item c1x
1533 ISO C1X, the draft of the next revision of the ISO C standard.
1534 Support is limited and experimental and features enabled by this
1535 option may be changed or removed if changed in or removed from the
1536 standard draft.
1538 @item gnu90
1539 @itemx gnu89
1540 GNU dialect of ISO C90 (including some C99 features). This
1541 is the default for C code.
1543 @item gnu99
1544 @itemx gnu9x
1545 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1546 this will become the default.  The name @samp{gnu9x} is deprecated.
1548 @item gnu1x
1549 GNU dialect of ISO C1X.  Support is limited and experimental and
1550 features enabled by this option may be changed or removed if changed
1551 in or removed from the standard draft.
1553 @item c++98
1554 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1555 C++ code.
1557 @item gnu++98
1558 GNU dialect of @option{-std=c++98}.  This is the default for
1559 C++ code.
1561 @item c++0x
1562 The working draft of the upcoming ISO C++0x standard. This option
1563 enables experimental features that are likely to be included in
1564 C++0x. The working draft is constantly changing, and any feature that is
1565 enabled by this flag may be removed from future versions of GCC if it is
1566 not part of the C++0x standard.
1568 @item gnu++0x
1569 GNU dialect of @option{-std=c++0x}. This option enables
1570 experimental features that may be removed in future versions of GCC.
1571 @end table
1573 @item -fgnu89-inline
1574 @opindex fgnu89-inline
1575 The option @option{-fgnu89-inline} tells GCC to use the traditional
1576 GNU semantics for @code{inline} functions when in C99 mode.
1577 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1578 is accepted and ignored by GCC versions 4.1.3 up to but not including
1579 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1580 C99 mode.  Using this option is roughly equivalent to adding the
1581 @code{gnu_inline} function attribute to all inline functions
1582 (@pxref{Function Attributes}).
1584 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1585 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1586 specifies the default behavior).  This option was first supported in
1587 GCC 4.3.  This option is not supported in @option{-std=c90} or
1588 @option{-std=gnu90} mode.
1590 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1591 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1592 in effect for @code{inline} functions.  @xref{Common Predefined
1593 Macros,,,cpp,The C Preprocessor}.
1595 @item -aux-info @var{filename}
1596 @opindex aux-info
1597 Output to the given filename prototyped declarations for all functions
1598 declared and/or defined in a translation unit, including those in header
1599 files.  This option is silently ignored in any language other than C@.
1601 Besides declarations, the file indicates, in comments, the origin of
1602 each declaration (source file and line), whether the declaration was
1603 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1604 @samp{O} for old, respectively, in the first character after the line
1605 number and the colon), and whether it came from a declaration or a
1606 definition (@samp{C} or @samp{F}, respectively, in the following
1607 character).  In the case of function definitions, a K&R-style list of
1608 arguments followed by their declarations is also provided, inside
1609 comments, after the declaration.
1611 @item -fno-asm
1612 @opindex fno-asm
1613 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1614 keyword, so that code can use these words as identifiers.  You can use
1615 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1616 instead.  @option{-ansi} implies @option{-fno-asm}.
1618 In C++, this switch only affects the @code{typeof} keyword, since
1619 @code{asm} and @code{inline} are standard keywords.  You may want to
1620 use the @option{-fno-gnu-keywords} flag instead, which has the same
1621 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1622 switch only affects the @code{asm} and @code{typeof} keywords, since
1623 @code{inline} is a standard keyword in ISO C99.
1625 @item -fno-builtin
1626 @itemx -fno-builtin-@var{function}
1627 @opindex fno-builtin
1628 @cindex built-in functions
1629 Don't recognize built-in functions that do not begin with
1630 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1631 functions provided by GCC}, for details of the functions affected,
1632 including those which are not built-in functions when @option{-ansi} or
1633 @option{-std} options for strict ISO C conformance are used because they
1634 do not have an ISO standard meaning.
1636 GCC normally generates special code to handle certain built-in functions
1637 more efficiently; for instance, calls to @code{alloca} may become single
1638 instructions that adjust the stack directly, and calls to @code{memcpy}
1639 may become inline copy loops.  The resulting code is often both smaller
1640 and faster, but since the function calls no longer appear as such, you
1641 cannot set a breakpoint on those calls, nor can you change the behavior
1642 of the functions by linking with a different library.  In addition,
1643 when a function is recognized as a built-in function, GCC may use
1644 information about that function to warn about problems with calls to
1645 that function, or to generate more efficient code, even if the
1646 resulting code still contains calls to that function.  For example,
1647 warnings are given with @option{-Wformat} for bad calls to
1648 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1649 known not to modify global memory.
1651 With the @option{-fno-builtin-@var{function}} option
1652 only the built-in function @var{function} is
1653 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1654 function is named that is not built-in in this version of GCC, this
1655 option is ignored.  There is no corresponding
1656 @option{-fbuiltin-@var{function}} option; if you wish to enable
1657 built-in functions selectively when using @option{-fno-builtin} or
1658 @option{-ffreestanding}, you may define macros such as:
1660 @smallexample
1661 #define abs(n)          __builtin_abs ((n))
1662 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1663 @end smallexample
1665 @item -fhosted
1666 @opindex fhosted
1667 @cindex hosted environment
1669 Assert that compilation takes place in a hosted environment.  This implies
1670 @option{-fbuiltin}.  A hosted environment is one in which the
1671 entire standard library is available, and in which @code{main} has a return
1672 type of @code{int}.  Examples are nearly everything except a kernel.
1673 This is equivalent to @option{-fno-freestanding}.
1675 @item -ffreestanding
1676 @opindex ffreestanding
1677 @cindex hosted environment
1679 Assert that compilation takes place in a freestanding environment.  This
1680 implies @option{-fno-builtin}.  A freestanding environment
1681 is one in which the standard library may not exist, and program startup may
1682 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1683 This is equivalent to @option{-fno-hosted}.
1685 @xref{Standards,,Language Standards Supported by GCC}, for details of
1686 freestanding and hosted environments.
1688 @item -fopenmp
1689 @opindex fopenmp
1690 @cindex OpenMP parallel
1691 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1692 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1693 compiler generates parallel code according to the OpenMP Application
1694 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1695 implies @option{-pthread}, and thus is only supported on targets that
1696 have support for @option{-pthread}.
1698 @item -fms-extensions
1699 @opindex fms-extensions
1700 Accept some non-standard constructs used in Microsoft header files.
1702 In C++ code, this allows member names in structures to be similar
1703 to previous types declarations.
1705 @smallexample
1706 typedef int UOW;
1707 struct ABC @{
1708   UOW UOW;
1710 @end smallexample
1712 Some cases of unnamed fields in structures and unions are only
1713 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1714 fields within structs/unions}, for details.
1716 @item -fplan9-extensions
1717 Accept some non-standard constructs used in Plan 9 code.
1719 This enables @option{-fms-extensions}, permits passing pointers to
1720 structures with anonymous fields to functions which expect pointers to
1721 elements of the type of the field, and permits referring to anonymous
1722 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1723 struct/union fields within structs/unions}, for details.  This is only
1724 supported for C, not C++.
1726 @item -trigraphs
1727 @opindex trigraphs
1728 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1729 options for strict ISO C conformance) implies @option{-trigraphs}.
1731 @item -no-integrated-cpp
1732 @opindex no-integrated-cpp
1733 Performs a compilation in two passes: preprocessing and compiling.  This
1734 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1735 @option{-B} option.  The user supplied compilation step can then add in
1736 an additional preprocessing step after normal preprocessing but before
1737 compiling.  The default is to use the integrated cpp (internal cpp)
1739 The semantics of this option will change if "cc1", "cc1plus", and
1740 "cc1obj" are merged.
1742 @cindex traditional C language
1743 @cindex C language, traditional
1744 @item -traditional
1745 @itemx -traditional-cpp
1746 @opindex traditional-cpp
1747 @opindex traditional
1748 Formerly, these options caused GCC to attempt to emulate a pre-standard
1749 C compiler.  They are now only supported with the @option{-E} switch.
1750 The preprocessor continues to support a pre-standard mode.  See the GNU
1751 CPP manual for details.
1753 @item -fcond-mismatch
1754 @opindex fcond-mismatch
1755 Allow conditional expressions with mismatched types in the second and
1756 third arguments.  The value of such an expression is void.  This option
1757 is not supported for C++.
1759 @item -flax-vector-conversions
1760 @opindex flax-vector-conversions
1761 Allow implicit conversions between vectors with differing numbers of
1762 elements and/or incompatible element types.  This option should not be
1763 used for new code.
1765 @item -funsigned-char
1766 @opindex funsigned-char
1767 Let the type @code{char} be unsigned, like @code{unsigned char}.
1769 Each kind of machine has a default for what @code{char} should
1770 be.  It is either like @code{unsigned char} by default or like
1771 @code{signed char} by default.
1773 Ideally, a portable program should always use @code{signed char} or
1774 @code{unsigned char} when it depends on the signedness of an object.
1775 But many programs have been written to use plain @code{char} and
1776 expect it to be signed, or expect it to be unsigned, depending on the
1777 machines they were written for.  This option, and its inverse, let you
1778 make such a program work with the opposite default.
1780 The type @code{char} is always a distinct type from each of
1781 @code{signed char} or @code{unsigned char}, even though its behavior
1782 is always just like one of those two.
1784 @item -fsigned-char
1785 @opindex fsigned-char
1786 Let the type @code{char} be signed, like @code{signed char}.
1788 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1789 the negative form of @option{-funsigned-char}.  Likewise, the option
1790 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1792 @item -fsigned-bitfields
1793 @itemx -funsigned-bitfields
1794 @itemx -fno-signed-bitfields
1795 @itemx -fno-unsigned-bitfields
1796 @opindex fsigned-bitfields
1797 @opindex funsigned-bitfields
1798 @opindex fno-signed-bitfields
1799 @opindex fno-unsigned-bitfields
1800 These options control whether a bit-field is signed or unsigned, when the
1801 declaration does not use either @code{signed} or @code{unsigned}.  By
1802 default, such a bit-field is signed, because this is consistent: the
1803 basic integer types such as @code{int} are signed types.
1804 @end table
1806 @node C++ Dialect Options
1807 @section Options Controlling C++ Dialect
1809 @cindex compiler options, C++
1810 @cindex C++ options, command line
1811 @cindex options, C++
1812 This section describes the command-line options that are only meaningful
1813 for C++ programs; but you can also use most of the GNU compiler options
1814 regardless of what language your program is in.  For example, you
1815 might compile a file @code{firstClass.C} like this:
1817 @smallexample
1818 g++ -g -frepo -O -c firstClass.C
1819 @end smallexample
1821 @noindent
1822 In this example, only @option{-frepo} is an option meant
1823 only for C++ programs; you can use the other options with any
1824 language supported by GCC@.
1826 Here is a list of options that are @emph{only} for compiling C++ programs:
1828 @table @gcctabopt
1830 @item -fabi-version=@var{n}
1831 @opindex fabi-version
1832 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1833 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1834 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1835 the version that conforms most closely to the C++ ABI specification.
1836 Therefore, the ABI obtained using version 0 will change as ABI bugs
1837 are fixed.
1839 The default is version 2.
1841 Version 3 corrects an error in mangling a constant address as a
1842 template argument.
1844 Version 4 implements a standard mangling for vector types.
1846 Version 5 corrects the mangling of attribute const/volatile on
1847 function pointer types, decltype of a plain decl, and use of a
1848 function parameter in the declaration of another parameter.
1850 Version 6 corrects the promotion behavior of C++0x scoped enums.
1852 See also @option{-Wabi}.
1854 @item -fno-access-control
1855 @opindex fno-access-control
1856 Turn off all access checking.  This switch is mainly useful for working
1857 around bugs in the access control code.
1859 @item -fcheck-new
1860 @opindex fcheck-new
1861 Check that the pointer returned by @code{operator new} is non-null
1862 before attempting to modify the storage allocated.  This check is
1863 normally unnecessary because the C++ standard specifies that
1864 @code{operator new} will only return @code{0} if it is declared
1865 @samp{throw()}, in which case the compiler will always check the
1866 return value even without this option.  In all other cases, when
1867 @code{operator new} has a non-empty exception specification, memory
1868 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1869 @samp{new (nothrow)}.
1871 @item -fconserve-space
1872 @opindex fconserve-space
1873 Put uninitialized or runtime-initialized global variables into the
1874 common segment, as C does.  This saves space in the executable at the
1875 cost of not diagnosing duplicate definitions.  If you compile with this
1876 flag and your program mysteriously crashes after @code{main()} has
1877 completed, you may have an object that is being destroyed twice because
1878 two definitions were merged.
1880 This option is no longer useful on most targets, now that support has
1881 been added for putting variables into BSS without making them common.
1883 @item -fconstexpr-depth=@var{n}
1884 @opindex fconstexpr-depth
1885 Set the maximum nested evaluation depth for C++0x constexpr functions
1886 to @var{n}.  A limit is needed to detect endless recursion during
1887 constant expression evaluation.  The minimum specified by the standard
1888 is 512.
1890 @item -fno-deduce-init-list
1891 @opindex fno-deduce-init-list
1892 Disable deduction of a template type parameter as
1893 std::initializer_list from a brace-enclosed initializer list, i.e.
1895 @smallexample
1896 template <class T> auto forward(T t) -> decltype (realfn (t))
1898   return realfn (t);
1901 void f()
1903   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1905 @end smallexample
1907 This option is present because this deduction is an extension to the
1908 current specification in the C++0x working draft, and there was
1909 some concern about potential overload resolution problems.
1911 @item -ffriend-injection
1912 @opindex ffriend-injection
1913 Inject friend functions into the enclosing namespace, so that they are
1914 visible outside the scope of the class in which they are declared.
1915 Friend functions were documented to work this way in the old Annotated
1916 C++ Reference Manual, and versions of G++ before 4.1 always worked
1917 that way.  However, in ISO C++ a friend function which is not declared
1918 in an enclosing scope can only be found using argument dependent
1919 lookup.  This option causes friends to be injected as they were in
1920 earlier releases.
1922 This option is for compatibility, and may be removed in a future
1923 release of G++.
1925 @item -fno-elide-constructors
1926 @opindex fno-elide-constructors
1927 The C++ standard allows an implementation to omit creating a temporary
1928 which is only used to initialize another object of the same type.
1929 Specifying this option disables that optimization, and forces G++ to
1930 call the copy constructor in all cases.
1932 @item -fno-enforce-eh-specs
1933 @opindex fno-enforce-eh-specs
1934 Don't generate code to check for violation of exception specifications
1935 at runtime.  This option violates the C++ standard, but may be useful
1936 for reducing code size in production builds, much like defining
1937 @samp{NDEBUG}.  This does not give user code permission to throw
1938 exceptions in violation of the exception specifications; the compiler
1939 will still optimize based on the specifications, so throwing an
1940 unexpected exception will result in undefined behavior.
1942 @item -ffor-scope
1943 @itemx -fno-for-scope
1944 @opindex ffor-scope
1945 @opindex fno-for-scope
1946 If @option{-ffor-scope} is specified, the scope of variables declared in
1947 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1948 as specified by the C++ standard.
1949 If @option{-fno-for-scope} is specified, the scope of variables declared in
1950 a @i{for-init-statement} extends to the end of the enclosing scope,
1951 as was the case in old versions of G++, and other (traditional)
1952 implementations of C++.
1954 The default if neither flag is given to follow the standard,
1955 but to allow and give a warning for old-style code that would
1956 otherwise be invalid, or have different behavior.
1958 @item -fno-gnu-keywords
1959 @opindex fno-gnu-keywords
1960 Do not recognize @code{typeof} as a keyword, so that code can use this
1961 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1962 @option{-ansi} implies @option{-fno-gnu-keywords}.
1964 @item -fno-implicit-templates
1965 @opindex fno-implicit-templates
1966 Never emit code for non-inline templates which are instantiated
1967 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1968 @xref{Template Instantiation}, for more information.
1970 @item -fno-implicit-inline-templates
1971 @opindex fno-implicit-inline-templates
1972 Don't emit code for implicit instantiations of inline templates, either.
1973 The default is to handle inlines differently so that compiles with and
1974 without optimization will need the same set of explicit instantiations.
1976 @item -fno-implement-inlines
1977 @opindex fno-implement-inlines
1978 To save space, do not emit out-of-line copies of inline functions
1979 controlled by @samp{#pragma implementation}.  This will cause linker
1980 errors if these functions are not inlined everywhere they are called.
1982 @item -fms-extensions
1983 @opindex fms-extensions
1984 Disable pedantic warnings about constructs used in MFC, such as implicit
1985 int and getting a pointer to member function via non-standard syntax.
1987 @item -fno-nonansi-builtins
1988 @opindex fno-nonansi-builtins
1989 Disable built-in declarations of functions that are not mandated by
1990 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1991 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1993 @item -fnothrow-opt
1994 @opindex fnothrow-opt
1995 Treat a @code{throw()} exception specification as though it were a
1996 @code{noexcept} specification to reduce or eliminate the text size
1997 overhead relative to a function with no exception specification.  If
1998 the function has local variables of types with non-trivial
1999 destructors, the exception specification will actually make the
2000 function smaller because the EH cleanups for those variables can be
2001 optimized away.  The semantic effect is that an exception thrown out of
2002 a function with such an exception specification will result in a call
2003 to @code{terminate} rather than @code{unexpected}.
2005 @item -fno-operator-names
2006 @opindex fno-operator-names
2007 Do not treat the operator name keywords @code{and}, @code{bitand},
2008 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2009 synonyms as keywords.
2011 @item -fno-optional-diags
2012 @opindex fno-optional-diags
2013 Disable diagnostics that the standard says a compiler does not need to
2014 issue.  Currently, the only such diagnostic issued by G++ is the one for
2015 a name having multiple meanings within a class.
2017 @item -fpermissive
2018 @opindex fpermissive
2019 Downgrade some diagnostics about nonconformant code from errors to
2020 warnings.  Thus, using @option{-fpermissive} will allow some
2021 nonconforming code to compile.
2023 @item -fno-pretty-templates
2024 @opindex fno-pretty-templates
2025 When an error message refers to a specialization of a function
2026 template, the compiler will normally print the signature of the
2027 template followed by the template arguments and any typedefs or
2028 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2029 rather than @code{void f(int)}) so that it's clear which template is
2030 involved.  When an error message refers to a specialization of a class
2031 template, the compiler will omit any template arguments which match
2032 the default template arguments for that template.  If either of these
2033 behaviors make it harder to understand the error message rather than
2034 easier, using @option{-fno-pretty-templates} will disable them.
2036 @item -frepo
2037 @opindex frepo
2038 Enable automatic template instantiation at link time.  This option also
2039 implies @option{-fno-implicit-templates}.  @xref{Template
2040 Instantiation}, for more information.
2042 @item -fno-rtti
2043 @opindex fno-rtti
2044 Disable generation of information about every class with virtual
2045 functions for use by the C++ runtime type identification features
2046 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2047 of the language, you can save some space by using this flag.  Note that
2048 exception handling uses the same information, but it will generate it as
2049 needed. The @samp{dynamic_cast} operator can still be used for casts that
2050 do not require runtime type information, i.e.@: casts to @code{void *} or to
2051 unambiguous base classes.
2053 @item -fstats
2054 @opindex fstats
2055 Emit statistics about front-end processing at the end of the compilation.
2056 This information is generally only useful to the G++ development team.
2058 @item -fstrict-enums
2059 @opindex fstrict-enums
2060 Allow the compiler to optimize using the assumption that a value of
2061 enumeration type can only be one of the values of the enumeration (as
2062 defined in the C++ standard; basically, a value which can be
2063 represented in the minimum number of bits needed to represent all the
2064 enumerators).  This assumption may not be valid if the program uses a
2065 cast to convert an arbitrary integer value to the enumeration type.
2067 @item -ftemplate-depth=@var{n}
2068 @opindex ftemplate-depth
2069 Set the maximum instantiation depth for template classes to @var{n}.
2070 A limit on the template instantiation depth is needed to detect
2071 endless recursions during template class instantiation.  ANSI/ISO C++
2072 conforming programs must not rely on a maximum depth greater than 17
2073 (changed to 1024 in C++0x).  The default value is 900, as the compiler
2074 can run out of stack space before hitting 1024 in some situations.
2076 @item -fno-threadsafe-statics
2077 @opindex fno-threadsafe-statics
2078 Do not emit the extra code to use the routines specified in the C++
2079 ABI for thread-safe initialization of local statics.  You can use this
2080 option to reduce code size slightly in code that doesn't need to be
2081 thread-safe.
2083 @item -fuse-cxa-atexit
2084 @opindex fuse-cxa-atexit
2085 Register destructors for objects with static storage duration with the
2086 @code{__cxa_atexit} function rather than the @code{atexit} function.
2087 This option is required for fully standards-compliant handling of static
2088 destructors, but will only work if your C library supports
2089 @code{__cxa_atexit}.
2091 @item -fno-use-cxa-get-exception-ptr
2092 @opindex fno-use-cxa-get-exception-ptr
2093 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2094 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2095 if the runtime routine is not available.
2097 @item -fvisibility-inlines-hidden
2098 @opindex fvisibility-inlines-hidden
2099 This switch declares that the user does not attempt to compare
2100 pointers to inline methods where the addresses of the two functions
2101 were taken in different shared objects.
2103 The effect of this is that GCC may, effectively, mark inline methods with
2104 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2105 appear in the export table of a DSO and do not require a PLT indirection
2106 when used within the DSO@.  Enabling this option can have a dramatic effect
2107 on load and link times of a DSO as it massively reduces the size of the
2108 dynamic export table when the library makes heavy use of templates.
2110 The behavior of this switch is not quite the same as marking the
2111 methods as hidden directly, because it does not affect static variables
2112 local to the function or cause the compiler to deduce that
2113 the function is defined in only one shared object.
2115 You may mark a method as having a visibility explicitly to negate the
2116 effect of the switch for that method.  For example, if you do want to
2117 compare pointers to a particular inline method, you might mark it as
2118 having default visibility.  Marking the enclosing class with explicit
2119 visibility will have no effect.
2121 Explicitly instantiated inline methods are unaffected by this option
2122 as their linkage might otherwise cross a shared library boundary.
2123 @xref{Template Instantiation}.
2125 @item -fvisibility-ms-compat
2126 @opindex fvisibility-ms-compat
2127 This flag attempts to use visibility settings to make GCC's C++
2128 linkage model compatible with that of Microsoft Visual Studio.
2130 The flag makes these changes to GCC's linkage model:
2132 @enumerate
2133 @item
2134 It sets the default visibility to @code{hidden}, like
2135 @option{-fvisibility=hidden}.
2137 @item
2138 Types, but not their members, are not hidden by default.
2140 @item
2141 The One Definition Rule is relaxed for types without explicit
2142 visibility specifications which are defined in more than one different
2143 shared object: those declarations are permitted if they would have
2144 been permitted when this option was not used.
2145 @end enumerate
2147 In new code it is better to use @option{-fvisibility=hidden} and
2148 export those classes which are intended to be externally visible.
2149 Unfortunately it is possible for code to rely, perhaps accidentally,
2150 on the Visual Studio behavior.
2152 Among the consequences of these changes are that static data members
2153 of the same type with the same name but defined in different shared
2154 objects will be different, so changing one will not change the other;
2155 and that pointers to function members defined in different shared
2156 objects may not compare equal.  When this flag is given, it is a
2157 violation of the ODR to define types with the same name differently.
2159 @item -fno-weak
2160 @opindex fno-weak
2161 Do not use weak symbol support, even if it is provided by the linker.
2162 By default, G++ will use weak symbols if they are available.  This
2163 option exists only for testing, and should not be used by end-users;
2164 it will result in inferior code and has no benefits.  This option may
2165 be removed in a future release of G++.
2167 @item -nostdinc++
2168 @opindex nostdinc++
2169 Do not search for header files in the standard directories specific to
2170 C++, but do still search the other standard directories.  (This option
2171 is used when building the C++ library.)
2172 @end table
2174 In addition, these optimization, warning, and code generation options
2175 have meanings only for C++ programs:
2177 @table @gcctabopt
2178 @item -fno-default-inline
2179 @opindex fno-default-inline
2180 Do not assume @samp{inline} for functions defined inside a class scope.
2181 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2182 functions will have linkage like inline functions; they just won't be
2183 inlined by default.
2185 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2186 @opindex Wabi
2187 @opindex Wno-abi
2188 Warn when G++ generates code that is probably not compatible with the
2189 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2190 all such cases, there are probably some cases that are not warned about,
2191 even though G++ is generating incompatible code.  There may also be
2192 cases where warnings are emitted even though the code that is generated
2193 will be compatible.
2195 You should rewrite your code to avoid these warnings if you are
2196 concerned about the fact that code generated by G++ may not be binary
2197 compatible with code generated by other compilers.
2199 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2201 @itemize @bullet
2203 @item
2204 A template with a non-type template parameter of reference type is
2205 mangled incorrectly:
2206 @smallexample
2207 extern int N;
2208 template <int &> struct S @{@};
2209 void n (S<N>) @{2@}
2210 @end smallexample
2212 This is fixed in @option{-fabi-version=3}.
2214 @item
2215 SIMD vector types declared using @code{__attribute ((vector_size))} are
2216 mangled in a non-standard way that does not allow for overloading of
2217 functions taking vectors of different sizes.
2219 The mangling is changed in @option{-fabi-version=4}.
2220 @end itemize
2222 The known incompatibilities in @option{-fabi-version=1} include:
2224 @itemize @bullet
2226 @item
2227 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2228 pack data into the same byte as a base class.  For example:
2230 @smallexample
2231 struct A @{ virtual void f(); int f1 : 1; @};
2232 struct B : public A @{ int f2 : 1; @};
2233 @end smallexample
2235 @noindent
2236 In this case, G++ will place @code{B::f2} into the same byte
2237 as@code{A::f1}; other compilers will not.  You can avoid this problem
2238 by explicitly padding @code{A} so that its size is a multiple of the
2239 byte size on your platform; that will cause G++ and other compilers to
2240 layout @code{B} identically.
2242 @item
2243 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2244 tail padding when laying out virtual bases.  For example:
2246 @smallexample
2247 struct A @{ virtual void f(); char c1; @};
2248 struct B @{ B(); char c2; @};
2249 struct C : public A, public virtual B @{@};
2250 @end smallexample
2252 @noindent
2253 In this case, G++ will not place @code{B} into the tail-padding for
2254 @code{A}; other compilers will.  You can avoid this problem by
2255 explicitly padding @code{A} so that its size is a multiple of its
2256 alignment (ignoring virtual base classes); that will cause G++ and other
2257 compilers to layout @code{C} identically.
2259 @item
2260 Incorrect handling of bit-fields with declared widths greater than that
2261 of their underlying types, when the bit-fields appear in a union.  For
2262 example:
2264 @smallexample
2265 union U @{ int i : 4096; @};
2266 @end smallexample
2268 @noindent
2269 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2270 union too small by the number of bits in an @code{int}.
2272 @item
2273 Empty classes can be placed at incorrect offsets.  For example:
2275 @smallexample
2276 struct A @{@};
2278 struct B @{
2279   A a;
2280   virtual void f ();
2283 struct C : public B, public A @{@};
2284 @end smallexample
2286 @noindent
2287 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2288 it should be placed at offset zero.  G++ mistakenly believes that the
2289 @code{A} data member of @code{B} is already at offset zero.
2291 @item
2292 Names of template functions whose types involve @code{typename} or
2293 template template parameters can be mangled incorrectly.
2295 @smallexample
2296 template <typename Q>
2297 void f(typename Q::X) @{@}
2299 template <template <typename> class Q>
2300 void f(typename Q<int>::X) @{@}
2301 @end smallexample
2303 @noindent
2304 Instantiations of these templates may be mangled incorrectly.
2306 @end itemize
2308 It also warns psABI related changes.  The known psABI changes at this
2309 point include:
2311 @itemize @bullet
2313 @item
2314 For SYSV/x86-64, when passing union with long double, it is changed to
2315 pass in memory as specified in psABI.  For example:
2317 @smallexample
2318 union U @{
2319   long double ld;
2320   int i;
2322 @end smallexample
2324 @noindent
2325 @code{union U} will always be passed in memory.
2327 @end itemize
2329 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2330 @opindex Wctor-dtor-privacy
2331 @opindex Wno-ctor-dtor-privacy
2332 Warn when a class seems unusable because all the constructors or
2333 destructors in that class are private, and it has neither friends nor
2334 public static member functions.
2336 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2337 @opindex Wdelete-non-virtual-dtor
2338 @opindex Wno-delete-non-virtual-dtor
2339 Warn when @samp{delete} is used to destroy an instance of a class which
2340 has virtual functions and non-virtual destructor. It is unsafe to delete
2341 an instance of a derived class through a pointer to a base class if the
2342 base class does not have a virtual destructor.  This warning is enabled
2343 by @option{-Wall}.
2345 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2346 @opindex Wnoexcept
2347 @opindex Wno-noexcept
2348 Warn when a noexcept-expression evaluates to false because of a call
2349 to a function that does not have a non-throwing exception
2350 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2351 the compiler to never throw an exception.
2353 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2354 @opindex Wnon-virtual-dtor
2355 @opindex Wno-non-virtual-dtor
2356 Warn when a class has virtual functions and accessible non-virtual
2357 destructor, in which case it would be possible but unsafe to delete
2358 an instance of a derived class through a pointer to the base class.
2359 This warning is also enabled if -Weffc++ is specified.
2361 @item -Wreorder @r{(C++ and Objective-C++ only)}
2362 @opindex Wreorder
2363 @opindex Wno-reorder
2364 @cindex reordering, warning
2365 @cindex warning for reordering of member initializers
2366 Warn when the order of member initializers given in the code does not
2367 match the order in which they must be executed.  For instance:
2369 @smallexample
2370 struct A @{
2371   int i;
2372   int j;
2373   A(): j (0), i (1) @{ @}
2375 @end smallexample
2377 The compiler will rearrange the member initializers for @samp{i}
2378 and @samp{j} to match the declaration order of the members, emitting
2379 a warning to that effect.  This warning is enabled by @option{-Wall}.
2380 @end table
2382 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2384 @table @gcctabopt
2385 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2386 @opindex Weffc++
2387 @opindex Wno-effc++
2388 Warn about violations of the following style guidelines from Scott Meyers'
2389 @cite{Effective C++} book:
2391 @itemize @bullet
2392 @item
2393 Item 11:  Define a copy constructor and an assignment operator for classes
2394 with dynamically allocated memory.
2396 @item
2397 Item 12:  Prefer initialization to assignment in constructors.
2399 @item
2400 Item 14:  Make destructors virtual in base classes.
2402 @item
2403 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2405 @item
2406 Item 23:  Don't try to return a reference when you must return an object.
2408 @end itemize
2410 Also warn about violations of the following style guidelines from
2411 Scott Meyers' @cite{More Effective C++} book:
2413 @itemize @bullet
2414 @item
2415 Item 6:  Distinguish between prefix and postfix forms of increment and
2416 decrement operators.
2418 @item
2419 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2421 @end itemize
2423 When selecting this option, be aware that the standard library
2424 headers do not obey all of these guidelines; use @samp{grep -v}
2425 to filter out those warnings.
2427 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2428 @opindex Wstrict-null-sentinel
2429 @opindex Wno-strict-null-sentinel
2430 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2431 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2432 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2433 it is guaranteed to be of the same size as a pointer.  But this use is
2434 not portable across different compilers.
2436 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2437 @opindex Wno-non-template-friend
2438 @opindex Wnon-template-friend
2439 Disable warnings when non-templatized friend functions are declared
2440 within a template.  Since the advent of explicit template specification
2441 support in G++, if the name of the friend is an unqualified-id (i.e.,
2442 @samp{friend foo(int)}), the C++ language specification demands that the
2443 friend declare or define an ordinary, nontemplate function.  (Section
2444 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2445 could be interpreted as a particular specialization of a templatized
2446 function.  Because this non-conforming behavior is no longer the default
2447 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2448 check existing code for potential trouble spots and is on by default.
2449 This new compiler behavior can be turned off with
2450 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2451 but disables the helpful warning.
2453 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2454 @opindex Wold-style-cast
2455 @opindex Wno-old-style-cast
2456 Warn if an old-style (C-style) cast to a non-void type is used within
2457 a C++ program.  The new-style casts (@samp{dynamic_cast},
2458 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2459 less vulnerable to unintended effects and much easier to search for.
2461 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2462 @opindex Woverloaded-virtual
2463 @opindex Wno-overloaded-virtual
2464 @cindex overloaded virtual function, warning
2465 @cindex warning for overloaded virtual function
2466 Warn when a function declaration hides virtual functions from a
2467 base class.  For example, in:
2469 @smallexample
2470 struct A @{
2471   virtual void f();
2474 struct B: public A @{
2475   void f(int);
2477 @end smallexample
2479 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2480 like:
2482 @smallexample
2483 B* b;
2484 b->f();
2485 @end smallexample
2487 will fail to compile.
2489 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2490 @opindex Wno-pmf-conversions
2491 @opindex Wpmf-conversions
2492 Disable the diagnostic for converting a bound pointer to member function
2493 to a plain pointer.
2495 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2496 @opindex Wsign-promo
2497 @opindex Wno-sign-promo
2498 Warn when overload resolution chooses a promotion from unsigned or
2499 enumerated type to a signed type, over a conversion to an unsigned type of
2500 the same size.  Previous versions of G++ would try to preserve
2501 unsignedness, but the standard mandates the current behavior.
2503 @smallexample
2504 struct A @{
2505   operator int ();
2506   A& operator = (int);
2509 main ()
2511   A a,b;
2512   a = b;
2514 @end smallexample
2516 In this example, G++ will synthesize a default @samp{A& operator =
2517 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2518 @end table
2520 @node Objective-C and Objective-C++ Dialect Options
2521 @section Options Controlling Objective-C and Objective-C++ Dialects
2523 @cindex compiler options, Objective-C and Objective-C++
2524 @cindex Objective-C and Objective-C++ options, command line
2525 @cindex options, Objective-C and Objective-C++
2526 (NOTE: This manual does not describe the Objective-C and Objective-C++
2527 languages themselves.  @xref{Standards,,Language Standards
2528 Supported by GCC}, for references.)
2530 This section describes the command-line options that are only meaningful
2531 for Objective-C and Objective-C++ programs, but you can also use most of
2532 the language-independent GNU compiler options.
2533 For example, you might compile a file @code{some_class.m} like this:
2535 @smallexample
2536 gcc -g -fgnu-runtime -O -c some_class.m
2537 @end smallexample
2539 @noindent
2540 In this example, @option{-fgnu-runtime} is an option meant only for
2541 Objective-C and Objective-C++ programs; you can use the other options with
2542 any language supported by GCC@.
2544 Note that since Objective-C is an extension of the C language, Objective-C
2545 compilations may also use options specific to the C front-end (e.g.,
2546 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2547 C++-specific options (e.g., @option{-Wabi}).
2549 Here is a list of options that are @emph{only} for compiling Objective-C
2550 and Objective-C++ programs:
2552 @table @gcctabopt
2553 @item -fconstant-string-class=@var{class-name}
2554 @opindex fconstant-string-class
2555 Use @var{class-name} as the name of the class to instantiate for each
2556 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2557 class name is @code{NXConstantString} if the GNU runtime is being used, and
2558 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2559 @option{-fconstant-cfstrings} option, if also present, will override the
2560 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2561 to be laid out as constant CoreFoundation strings.
2563 @item -fgnu-runtime
2564 @opindex fgnu-runtime
2565 Generate object code compatible with the standard GNU Objective-C
2566 runtime.  This is the default for most types of systems.
2568 @item -fnext-runtime
2569 @opindex fnext-runtime
2570 Generate output compatible with the NeXT runtime.  This is the default
2571 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2572 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2573 used.
2575 @item -fno-nil-receivers
2576 @opindex fno-nil-receivers
2577 Assume that all Objective-C message dispatches (@code{[receiver
2578 message:arg]}) in this translation unit ensure that the receiver is
2579 not @code{nil}.  This allows for more efficient entry points in the
2580 runtime to be used.  This option is only available in conjunction with
2581 the NeXT runtime and ABI version 0 or 1.
2583 @item -fobjc-abi-version=@var{n}
2584 @opindex fobjc-abi-version
2585 Use version @var{n} of the Objective-C ABI for the selected runtime.
2586 This option is currently supported only for the NeXT runtime.  In that
2587 case, Version 0 is the traditional (32-bit) ABI without support for
2588 properties and other Objective-C 2.0 additions.  Version 1 is the
2589 traditional (32-bit) ABI with support for properties and other
2590 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2591 nothing is specified, the default is Version 0 on 32-bit target
2592 machines, and Version 2 on 64-bit target machines.
2594 @item -fobjc-call-cxx-cdtors
2595 @opindex fobjc-call-cxx-cdtors
2596 For each Objective-C class, check if any of its instance variables is a
2597 C++ object with a non-trivial default constructor.  If so, synthesize a
2598 special @code{- (id) .cxx_construct} instance method that will run
2599 non-trivial default constructors on any such instance variables, in order,
2600 and then return @code{self}.  Similarly, check if any instance variable
2601 is a C++ object with a non-trivial destructor, and if so, synthesize a
2602 special @code{- (void) .cxx_destruct} method that will run
2603 all such default destructors, in reverse order.
2605 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2606 methods thusly generated will only operate on instance variables
2607 declared in the current Objective-C class, and not those inherited
2608 from superclasses.  It is the responsibility of the Objective-C
2609 runtime to invoke all such methods in an object's inheritance
2610 hierarchy.  The @code{- (id) .cxx_construct} methods will be invoked
2611 by the runtime immediately after a new object instance is allocated;
2612 the @code{- (void) .cxx_destruct} methods will be invoked immediately
2613 before the runtime deallocates an object instance.
2615 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2616 support for invoking the @code{- (id) .cxx_construct} and
2617 @code{- (void) .cxx_destruct} methods.
2619 @item -fobjc-direct-dispatch
2620 @opindex fobjc-direct-dispatch
2621 Allow fast jumps to the message dispatcher.  On Darwin this is
2622 accomplished via the comm page.
2624 @item -fobjc-exceptions
2625 @opindex fobjc-exceptions
2626 Enable syntactic support for structured exception handling in
2627 Objective-C, similar to what is offered by C++ and Java.  This option
2628 is required to use the Objective-C keywords @code{@@try},
2629 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2630 @code{@@synchronized}.  This option is available with both the GNU
2631 runtime and the NeXT runtime (but not available in conjunction with
2632 the NeXT runtime on Mac OS X 10.2 and earlier).
2634 @item -fobjc-gc
2635 @opindex fobjc-gc
2636 Enable garbage collection (GC) in Objective-C and Objective-C++
2637 programs.  This option is only available with the NeXT runtime; the
2638 GNU runtime has a different garbage collection implementation that
2639 does not require special compiler flags.
2641 @item -fobjc-nilcheck
2642 @opindex fobjc-nilcheck
2643 For the NeXT runtime with version 2 of the ABI, check for a nil
2644 receiver in method invocations before doing the actual method call.
2645 This is the default and can be disabled using
2646 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2647 checked for nil in this way no matter what this flag is set to.
2648 Currently this flag does nothing when the GNU runtime, or an older
2649 version of the NeXT runtime ABI, is used.
2651 @item -fobjc-std=objc1
2652 @opindex fobjc-std
2653 Conform to the language syntax of Objective-C 1.0, the language
2654 recognized by GCC 4.0.  This only affects the Objective-C additions to
2655 the C/C++ language; it does not affect conformance to C/C++ standards,
2656 which is controlled by the separate C/C++ dialect option flags.  When
2657 this option is used with the Objective-C or Objective-C++ compiler,
2658 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2659 This is useful if you need to make sure that your Objective-C code can
2660 be compiled with older versions of GCC.
2662 @item -freplace-objc-classes
2663 @opindex freplace-objc-classes
2664 Emit a special marker instructing @command{ld(1)} not to statically link in
2665 the resulting object file, and allow @command{dyld(1)} to load it in at
2666 run time instead.  This is used in conjunction with the Fix-and-Continue
2667 debugging mode, where the object file in question may be recompiled and
2668 dynamically reloaded in the course of program execution, without the need
2669 to restart the program itself.  Currently, Fix-and-Continue functionality
2670 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2671 and later.
2673 @item -fzero-link
2674 @opindex fzero-link
2675 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2676 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2677 compile time) with static class references that get initialized at load time,
2678 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2679 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2680 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2681 for individual class implementations to be modified during program execution.
2682 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2683 regardless of command line options.
2685 @item -gen-decls
2686 @opindex gen-decls
2687 Dump interface declarations for all classes seen in the source file to a
2688 file named @file{@var{sourcename}.decl}.
2690 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2691 @opindex Wassign-intercept
2692 @opindex Wno-assign-intercept
2693 Warn whenever an Objective-C assignment is being intercepted by the
2694 garbage collector.
2696 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2697 @opindex Wno-protocol
2698 @opindex Wprotocol
2699 If a class is declared to implement a protocol, a warning is issued for
2700 every method in the protocol that is not implemented by the class.  The
2701 default behavior is to issue a warning for every method not explicitly
2702 implemented in the class, even if a method implementation is inherited
2703 from the superclass.  If you use the @option{-Wno-protocol} option, then
2704 methods inherited from the superclass are considered to be implemented,
2705 and no warning is issued for them.
2707 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2708 @opindex Wselector
2709 @opindex Wno-selector
2710 Warn if multiple methods of different types for the same selector are
2711 found during compilation.  The check is performed on the list of methods
2712 in the final stage of compilation.  Additionally, a check is performed
2713 for each selector appearing in a @code{@@selector(@dots{})}
2714 expression, and a corresponding method for that selector has been found
2715 during compilation.  Because these checks scan the method table only at
2716 the end of compilation, these warnings are not produced if the final
2717 stage of compilation is not reached, for example because an error is
2718 found during compilation, or because the @option{-fsyntax-only} option is
2719 being used.
2721 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2722 @opindex Wstrict-selector-match
2723 @opindex Wno-strict-selector-match
2724 Warn if multiple methods with differing argument and/or return types are
2725 found for a given selector when attempting to send a message using this
2726 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2727 is off (which is the default behavior), the compiler will omit such warnings
2728 if any differences found are confined to types which share the same size
2729 and alignment.
2731 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2732 @opindex Wundeclared-selector
2733 @opindex Wno-undeclared-selector
2734 Warn if a @code{@@selector(@dots{})} expression referring to an
2735 undeclared selector is found.  A selector is considered undeclared if no
2736 method with that name has been declared before the
2737 @code{@@selector(@dots{})} expression, either explicitly in an
2738 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2739 an @code{@@implementation} section.  This option always performs its
2740 checks as soon as a @code{@@selector(@dots{})} expression is found,
2741 while @option{-Wselector} only performs its checks in the final stage of
2742 compilation.  This also enforces the coding style convention
2743 that methods and selectors must be declared before being used.
2745 @item -print-objc-runtime-info
2746 @opindex print-objc-runtime-info
2747 Generate C header describing the largest structure that is passed by
2748 value, if any.
2750 @end table
2752 @node Language Independent Options
2753 @section Options to Control Diagnostic Messages Formatting
2754 @cindex options to control diagnostics formatting
2755 @cindex diagnostic messages
2756 @cindex message formatting
2758 Traditionally, diagnostic messages have been formatted irrespective of
2759 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2760 below can be used to control the diagnostic messages formatting
2761 algorithm, e.g.@: how many characters per line, how often source location
2762 information should be reported.  Right now, only the C++ front end can
2763 honor these options.  However it is expected, in the near future, that
2764 the remaining front ends would be able to digest them correctly.
2766 @table @gcctabopt
2767 @item -fmessage-length=@var{n}
2768 @opindex fmessage-length
2769 Try to format error messages so that they fit on lines of about @var{n}
2770 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2771 the front ends supported by GCC@.  If @var{n} is zero, then no
2772 line-wrapping will be done; each error message will appear on a single
2773 line.
2775 @opindex fdiagnostics-show-location
2776 @item -fdiagnostics-show-location=once
2777 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2778 reporter to emit @emph{once} source location information; that is, in
2779 case the message is too long to fit on a single physical line and has to
2780 be wrapped, the source location won't be emitted (as prefix) again,
2781 over and over, in subsequent continuation lines.  This is the default
2782 behavior.
2784 @item -fdiagnostics-show-location=every-line
2785 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2786 messages reporter to emit the same source location information (as
2787 prefix) for physical lines that result from the process of breaking
2788 a message which is too long to fit on a single line.
2790 @item -fno-diagnostics-show-option
2791 @opindex fno-diagnostics-show-option
2792 @opindex fdiagnostics-show-option
2793 By default, each diagnostic emitted includes text which indicates the
2794 command line option that directly controls the diagnostic (if such an
2795 option is known to the diagnostic machinery).  Specifying the
2796 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2798 @item -Wcoverage-mismatch
2799 @opindex Wcoverage-mismatch
2800 Warn if feedback profiles do not match when using the
2801 @option{-fprofile-use} option.
2802 If a source file was changed between @option{-fprofile-gen} and
2803 @option{-fprofile-use}, the files with the profile feedback can fail
2804 to match the source file and GCC can not use the profile feedback
2805 information.  By default, this warning is enabled and is treated as an
2806 error.  @option{-Wno-coverage-mismatch} can be used to disable the
2807 warning or @option{-Wno-error=coverage-mismatch} can be used to
2808 disable the error.  Disable the error for this warning can result in
2809 poorly optimized code, so disabling the error is useful only in the
2810 case of very minor changes such as bug fixes to an existing code-base.
2811 Completely disabling the warning is not recommended.
2813 @end table
2815 @node Warning Options
2816 @section Options to Request or Suppress Warnings
2817 @cindex options to control warnings
2818 @cindex warning messages
2819 @cindex messages, warning
2820 @cindex suppressing warnings
2822 Warnings are diagnostic messages that report constructions which
2823 are not inherently erroneous but which are risky or suggest there
2824 may have been an error.
2826 The following language-independent options do not enable specific
2827 warnings but control the kinds of diagnostics produced by GCC.
2829 @table @gcctabopt
2830 @cindex syntax checking
2831 @item -fsyntax-only
2832 @opindex fsyntax-only
2833 Check the code for syntax errors, but don't do anything beyond that.
2835 @item -fmax-errors=@var{n}
2836 @opindex fmax-errors
2837 Limits the maximum number of error messages to @var{n}, at which point
2838 GCC bails out rather than attempting to continue processing the source
2839 code.  If @var{n} is 0 (the default), there is no limit on the number
2840 of error messages produced.  If @option{-Wfatal-errors} is also
2841 specified, then @option{-Wfatal-errors} takes precedence over this
2842 option.
2844 @item -w
2845 @opindex w
2846 Inhibit all warning messages.
2848 @item -Werror
2849 @opindex Werror
2850 @opindex Wno-error
2851 Make all warnings into errors.
2853 @item -Werror=
2854 @opindex Werror=
2855 @opindex Wno-error=
2856 Make the specified warning into an error.  The specifier for a warning
2857 is appended, for example @option{-Werror=switch} turns the warnings
2858 controlled by @option{-Wswitch} into errors.  This switch takes a
2859 negative form, to be used to negate @option{-Werror} for specific
2860 warnings, for example @option{-Wno-error=switch} makes
2861 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2862 is in effect.
2864 The warning message for each controllable warning includes the
2865 option which controls the warning.  That option can then be used with
2866 @option{-Werror=} and @option{-Wno-error=} as described above.
2867 (Printing of the option in the warning message can be disabled using the
2868 @option{-fno-diagnostics-show-option} flag.)
2870 Note that specifying @option{-Werror=}@var{foo} automatically implies
2871 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2872 imply anything.
2874 @item -Wfatal-errors
2875 @opindex Wfatal-errors
2876 @opindex Wno-fatal-errors
2877 This option causes the compiler to abort compilation on the first error
2878 occurred rather than trying to keep going and printing further error
2879 messages.
2881 @end table
2883 You can request many specific warnings with options beginning
2884 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2885 implicit declarations.  Each of these specific warning options also
2886 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2887 example, @option{-Wno-implicit}.  This manual lists only one of the
2888 two forms, whichever is not the default.  For further,
2889 language-specific options also refer to @ref{C++ Dialect Options} and
2890 @ref{Objective-C and Objective-C++ Dialect Options}.
2892 When an unrecognized warning option is requested (e.g.,
2893 @option{-Wunknown-warning}), GCC will emit a diagnostic stating
2894 that the option is not recognized.  However, if the @option{-Wno-} form
2895 is used, the behavior is slightly different: No diagnostic will be
2896 produced for @option{-Wno-unknown-warning} unless other diagnostics
2897 are being produced.  This allows the use of new @option{-Wno-} options
2898 with old compilers, but if something goes wrong, the compiler will
2899 warn that an unrecognized option was used.
2901 @table @gcctabopt
2902 @item -pedantic
2903 @opindex pedantic
2904 Issue all the warnings demanded by strict ISO C and ISO C++;
2905 reject all programs that use forbidden extensions, and some other
2906 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2907 version of the ISO C standard specified by any @option{-std} option used.
2909 Valid ISO C and ISO C++ programs should compile properly with or without
2910 this option (though a rare few will require @option{-ansi} or a
2911 @option{-std} option specifying the required version of ISO C)@.  However,
2912 without this option, certain GNU extensions and traditional C and C++
2913 features are supported as well.  With this option, they are rejected.
2915 @option{-pedantic} does not cause warning messages for use of the
2916 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2917 warnings are also disabled in the expression that follows
2918 @code{__extension__}.  However, only system header files should use
2919 these escape routes; application programs should avoid them.
2920 @xref{Alternate Keywords}.
2922 Some users try to use @option{-pedantic} to check programs for strict ISO
2923 C conformance.  They soon find that it does not do quite what they want:
2924 it finds some non-ISO practices, but not all---only those for which
2925 ISO C @emph{requires} a diagnostic, and some others for which
2926 diagnostics have been added.
2928 A feature to report any failure to conform to ISO C might be useful in
2929 some instances, but would require considerable additional work and would
2930 be quite different from @option{-pedantic}.  We don't have plans to
2931 support such a feature in the near future.
2933 Where the standard specified with @option{-std} represents a GNU
2934 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
2935 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2936 extended dialect is based.  Warnings from @option{-pedantic} are given
2937 where they are required by the base standard.  (It would not make sense
2938 for such warnings to be given only for features not in the specified GNU
2939 C dialect, since by definition the GNU dialects of C include all
2940 features the compiler supports with the given option, and there would be
2941 nothing to warn about.)
2943 @item -pedantic-errors
2944 @opindex pedantic-errors
2945 Like @option{-pedantic}, except that errors are produced rather than
2946 warnings.
2948 @item -Wall
2949 @opindex Wall
2950 @opindex Wno-all
2951 This enables all the warnings about constructions that some users
2952 consider questionable, and that are easy to avoid (or modify to
2953 prevent the warning), even in conjunction with macros.  This also
2954 enables some language-specific warnings described in @ref{C++ Dialect
2955 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2957 @option{-Wall} turns on the following warning flags:
2959 @gccoptlist{-Waddress   @gol
2960 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2961 -Wc++0x-compat  @gol
2962 -Wchar-subscripts  @gol
2963 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2964 -Wimplicit-int @r{(C and Objective-C only)} @gol
2965 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
2966 -Wcomment  @gol
2967 -Wformat   @gol
2968 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2969 -Wmaybe-uninitialized @gol
2970 -Wmissing-braces  @gol
2971 -Wnonnull  @gol
2972 -Wparentheses  @gol
2973 -Wpointer-sign  @gol
2974 -Wreorder   @gol
2975 -Wreturn-type  @gol
2976 -Wsequence-point  @gol
2977 -Wsign-compare @r{(only in C++)}  @gol
2978 -Wstrict-aliasing  @gol
2979 -Wstrict-overflow=1  @gol
2980 -Wswitch  @gol
2981 -Wtrigraphs  @gol
2982 -Wuninitialized  @gol
2983 -Wunknown-pragmas  @gol
2984 -Wunused-function  @gol
2985 -Wunused-label     @gol
2986 -Wunused-value     @gol
2987 -Wunused-variable  @gol
2988 -Wvolatile-register-var @gol
2991 Note that some warning flags are not implied by @option{-Wall}.  Some of
2992 them warn about constructions that users generally do not consider
2993 questionable, but which occasionally you might wish to check for;
2994 others warn about constructions that are necessary or hard to avoid in
2995 some cases, and there is no simple way to modify the code to suppress
2996 the warning. Some of them are enabled by @option{-Wextra} but many of
2997 them must be enabled individually.
2999 @item -Wextra
3000 @opindex W
3001 @opindex Wextra
3002 @opindex Wno-extra
3003 This enables some extra warning flags that are not enabled by
3004 @option{-Wall}. (This option used to be called @option{-W}.  The older
3005 name is still supported, but the newer name is more descriptive.)
3007 @gccoptlist{-Wclobbered  @gol
3008 -Wempty-body  @gol
3009 -Wignored-qualifiers @gol
3010 -Wmissing-field-initializers  @gol
3011 -Wmissing-parameter-type @r{(C only)}  @gol
3012 -Wold-style-declaration @r{(C only)}  @gol
3013 -Woverride-init  @gol
3014 -Wsign-compare  @gol
3015 -Wtype-limits  @gol
3016 -Wuninitialized  @gol
3017 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3018 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3021 The option @option{-Wextra} also prints warning messages for the
3022 following cases:
3024 @itemize @bullet
3026 @item
3027 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3028 @samp{>}, or @samp{>=}.
3030 @item
3031 (C++ only) An enumerator and a non-enumerator both appear in a
3032 conditional expression.
3034 @item
3035 (C++ only) Ambiguous virtual bases.
3037 @item
3038 (C++ only) Subscripting an array which has been declared @samp{register}.
3040 @item
3041 (C++ only) Taking the address of a variable which has been declared
3042 @samp{register}.
3044 @item
3045 (C++ only) A base class is not initialized in a derived class' copy
3046 constructor.
3048 @end itemize
3050 @item -Wchar-subscripts
3051 @opindex Wchar-subscripts
3052 @opindex Wno-char-subscripts
3053 Warn if an array subscript has type @code{char}.  This is a common cause
3054 of error, as programmers often forget that this type is signed on some
3055 machines.
3056 This warning is enabled by @option{-Wall}.
3058 @item -Wcomment
3059 @opindex Wcomment
3060 @opindex Wno-comment
3061 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3062 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3063 This warning is enabled by @option{-Wall}.
3065 @item -Wno-cpp
3066 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3068 Suppress warning messages emitted by @code{#warning} directives.
3070 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3071 @opindex Wdouble-promotion
3072 @opindex Wno-double-promotion
3073 Give a warning when a value of type @code{float} is implicitly
3074 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3075 floating-point unit implement @code{float} in hardware, but emulate
3076 @code{double} in software.  On such a machine, doing computations
3077 using @code{double} values is much more expensive because of the
3078 overhead required for software emulation.
3080 It is easy to accidentally do computations with @code{double} because
3081 floating-point literals are implicitly of type @code{double}.  For
3082 example, in:
3083 @smallexample
3084 @group
3085 float area(float radius)
3087    return 3.14159 * radius * radius;
3089 @end group
3090 @end smallexample
3091 the compiler will perform the entire computation with @code{double}
3092 because the floating-point literal is a @code{double}.
3094 @item -Wformat
3095 @opindex Wformat
3096 @opindex Wno-format
3097 @opindex ffreestanding
3098 @opindex fno-builtin
3099 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3100 the arguments supplied have types appropriate to the format string
3101 specified, and that the conversions specified in the format string make
3102 sense.  This includes standard functions, and others specified by format
3103 attributes (@pxref{Function Attributes}), in the @code{printf},
3104 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3105 not in the C standard) families (or other target-specific families).
3106 Which functions are checked without format attributes having been
3107 specified depends on the standard version selected, and such checks of
3108 functions without the attribute specified are disabled by
3109 @option{-ffreestanding} or @option{-fno-builtin}.
3111 The formats are checked against the format features supported by GNU
3112 libc version 2.2.  These include all ISO C90 and C99 features, as well
3113 as features from the Single Unix Specification and some BSD and GNU
3114 extensions.  Other library implementations may not support all these
3115 features; GCC does not support warning about features that go beyond a
3116 particular library's limitations.  However, if @option{-pedantic} is used
3117 with @option{-Wformat}, warnings will be given about format features not
3118 in the selected standard version (but not for @code{strfmon} formats,
3119 since those are not in any version of the C standard).  @xref{C Dialect
3120 Options,,Options Controlling C Dialect}.
3122 Since @option{-Wformat} also checks for null format arguments for
3123 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3125 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3126 aspects of format checking, the options @option{-Wformat-y2k},
3127 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3128 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3129 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3131 @item -Wformat-y2k
3132 @opindex Wformat-y2k
3133 @opindex Wno-format-y2k
3134 If @option{-Wformat} is specified, also warn about @code{strftime}
3135 formats which may yield only a two-digit year.
3137 @item -Wno-format-contains-nul
3138 @opindex Wno-format-contains-nul
3139 @opindex Wformat-contains-nul
3140 If @option{-Wformat} is specified, do not warn about format strings that
3141 contain NUL bytes.
3143 @item -Wno-format-extra-args
3144 @opindex Wno-format-extra-args
3145 @opindex Wformat-extra-args
3146 If @option{-Wformat} is specified, do not warn about excess arguments to a
3147 @code{printf} or @code{scanf} format function.  The C standard specifies
3148 that such arguments are ignored.
3150 Where the unused arguments lie between used arguments that are
3151 specified with @samp{$} operand number specifications, normally
3152 warnings are still given, since the implementation could not know what
3153 type to pass to @code{va_arg} to skip the unused arguments.  However,
3154 in the case of @code{scanf} formats, this option will suppress the
3155 warning if the unused arguments are all pointers, since the Single
3156 Unix Specification says that such unused arguments are allowed.
3158 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3159 @opindex Wno-format-zero-length
3160 @opindex Wformat-zero-length
3161 If @option{-Wformat} is specified, do not warn about zero-length formats.
3162 The C standard specifies that zero-length formats are allowed.
3164 @item -Wformat-nonliteral
3165 @opindex Wformat-nonliteral
3166 @opindex Wno-format-nonliteral
3167 If @option{-Wformat} is specified, also warn if the format string is not a
3168 string literal and so cannot be checked, unless the format function
3169 takes its format arguments as a @code{va_list}.
3171 @item -Wformat-security
3172 @opindex Wformat-security
3173 @opindex Wno-format-security
3174 If @option{-Wformat} is specified, also warn about uses of format
3175 functions that represent possible security problems.  At present, this
3176 warns about calls to @code{printf} and @code{scanf} functions where the
3177 format string is not a string literal and there are no format arguments,
3178 as in @code{printf (foo);}.  This may be a security hole if the format
3179 string came from untrusted input and contains @samp{%n}.  (This is
3180 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3181 in future warnings may be added to @option{-Wformat-security} that are not
3182 included in @option{-Wformat-nonliteral}.)
3184 @item -Wformat=2
3185 @opindex Wformat=2
3186 @opindex Wno-format=2
3187 Enable @option{-Wformat} plus format checks not included in
3188 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3189 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3191 @item -Wnonnull @r{(C and Objective-C only)}
3192 @opindex Wnonnull
3193 @opindex Wno-nonnull
3194 Warn about passing a null pointer for arguments marked as
3195 requiring a non-null value by the @code{nonnull} function attribute.
3197 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3198 can be disabled with the @option{-Wno-nonnull} option.
3200 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3201 @opindex Winit-self
3202 @opindex Wno-init-self
3203 Warn about uninitialized variables which are initialized with themselves.
3204 Note this option can only be used with the @option{-Wuninitialized} option.
3206 For example, GCC will warn about @code{i} being uninitialized in the
3207 following snippet only when @option{-Winit-self} has been specified:
3208 @smallexample
3209 @group
3210 int f()
3212   int i = i;
3213   return i;
3215 @end group
3216 @end smallexample
3218 @item -Wimplicit-int @r{(C and Objective-C only)}
3219 @opindex Wimplicit-int
3220 @opindex Wno-implicit-int
3221 Warn when a declaration does not specify a type.
3222 This warning is enabled by @option{-Wall}.
3224 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3225 @opindex Wimplicit-function-declaration
3226 @opindex Wno-implicit-function-declaration
3227 Give a warning whenever a function is used before being declared. In
3228 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3229 enabled by default and it is made into an error by
3230 @option{-pedantic-errors}. This warning is also enabled by
3231 @option{-Wall}.
3233 @item -Wimplicit @r{(C and Objective-C only)}
3234 @opindex Wimplicit
3235 @opindex Wno-implicit
3236 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3237 This warning is enabled by @option{-Wall}.
3239 @item -Wignored-qualifiers @r{(C and C++ only)}
3240 @opindex Wignored-qualifiers
3241 @opindex Wno-ignored-qualifiers
3242 Warn if the return type of a function has a type qualifier
3243 such as @code{const}.  For ISO C such a type qualifier has no effect,
3244 since the value returned by a function is not an lvalue.
3245 For C++, the warning is only emitted for scalar types or @code{void}.
3246 ISO C prohibits qualified @code{void} return types on function
3247 definitions, so such return types always receive a warning
3248 even without this option.
3250 This warning is also enabled by @option{-Wextra}.
3252 @item -Wmain
3253 @opindex Wmain
3254 @opindex Wno-main
3255 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3256 a function with external linkage, returning int, taking either zero
3257 arguments, two, or three arguments of appropriate types.  This warning
3258 is enabled by default in C++ and is enabled by either @option{-Wall}
3259 or @option{-pedantic}.
3261 @item -Wmissing-braces
3262 @opindex Wmissing-braces
3263 @opindex Wno-missing-braces
3264 Warn if an aggregate or union initializer is not fully bracketed.  In
3265 the following example, the initializer for @samp{a} is not fully
3266 bracketed, but that for @samp{b} is fully bracketed.
3268 @smallexample
3269 int a[2][2] = @{ 0, 1, 2, 3 @};
3270 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3271 @end smallexample
3273 This warning is enabled by @option{-Wall}.
3275 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3276 @opindex Wmissing-include-dirs
3277 @opindex Wno-missing-include-dirs
3278 Warn if a user-supplied include directory does not exist.
3280 @item -Wparentheses
3281 @opindex Wparentheses
3282 @opindex Wno-parentheses
3283 Warn if parentheses are omitted in certain contexts, such
3284 as when there is an assignment in a context where a truth value
3285 is expected, or when operators are nested whose precedence people
3286 often get confused about.
3288 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3289 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3290 interpretation from that of ordinary mathematical notation.
3292 Also warn about constructions where there may be confusion to which
3293 @code{if} statement an @code{else} branch belongs.  Here is an example of
3294 such a case:
3296 @smallexample
3297 @group
3299   if (a)
3300     if (b)
3301       foo ();
3302   else
3303     bar ();
3305 @end group
3306 @end smallexample
3308 In C/C++, every @code{else} branch belongs to the innermost possible
3309 @code{if} statement, which in this example is @code{if (b)}.  This is
3310 often not what the programmer expected, as illustrated in the above
3311 example by indentation the programmer chose.  When there is the
3312 potential for this confusion, GCC will issue a warning when this flag
3313 is specified.  To eliminate the warning, add explicit braces around
3314 the innermost @code{if} statement so there is no way the @code{else}
3315 could belong to the enclosing @code{if}.  The resulting code would
3316 look like this:
3318 @smallexample
3319 @group
3321   if (a)
3322     @{
3323       if (b)
3324         foo ();
3325       else
3326         bar ();
3327     @}
3329 @end group
3330 @end smallexample
3332 Also warn for dangerous uses of the
3333 ?: with omitted middle operand GNU extension. When the condition
3334 in the ?: operator is a boolean expression the omitted value will
3335 be always 1. Often the user expects it to be a value computed
3336 inside the conditional expression instead.
3338 This warning is enabled by @option{-Wall}.
3340 @item -Wsequence-point
3341 @opindex Wsequence-point
3342 @opindex Wno-sequence-point
3343 Warn about code that may have undefined semantics because of violations
3344 of sequence point rules in the C and C++ standards.
3346 The C and C++ standards defines the order in which expressions in a C/C++
3347 program are evaluated in terms of @dfn{sequence points}, which represent
3348 a partial ordering between the execution of parts of the program: those
3349 executed before the sequence point, and those executed after it.  These
3350 occur after the evaluation of a full expression (one which is not part
3351 of a larger expression), after the evaluation of the first operand of a
3352 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3353 function is called (but after the evaluation of its arguments and the
3354 expression denoting the called function), and in certain other places.
3355 Other than as expressed by the sequence point rules, the order of
3356 evaluation of subexpressions of an expression is not specified.  All
3357 these rules describe only a partial order rather than a total order,
3358 since, for example, if two functions are called within one expression
3359 with no sequence point between them, the order in which the functions
3360 are called is not specified.  However, the standards committee have
3361 ruled that function calls do not overlap.
3363 It is not specified when between sequence points modifications to the
3364 values of objects take effect.  Programs whose behavior depends on this
3365 have undefined behavior; the C and C++ standards specify that ``Between
3366 the previous and next sequence point an object shall have its stored
3367 value modified at most once by the evaluation of an expression.
3368 Furthermore, the prior value shall be read only to determine the value
3369 to be stored.''.  If a program breaks these rules, the results on any
3370 particular implementation are entirely unpredictable.
3372 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3373 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3374 diagnosed by this option, and it may give an occasional false positive
3375 result, but in general it has been found fairly effective at detecting
3376 this sort of problem in programs.
3378 The standard is worded confusingly, therefore there is some debate
3379 over the precise meaning of the sequence point rules in subtle cases.
3380 Links to discussions of the problem, including proposed formal
3381 definitions, may be found on the GCC readings page, at
3382 @uref{http://gcc.gnu.org/@/readings.html}.
3384 This warning is enabled by @option{-Wall} for C and C++.
3386 @item -Wreturn-type
3387 @opindex Wreturn-type
3388 @opindex Wno-return-type
3389 Warn whenever a function is defined with a return-type that defaults
3390 to @code{int}.  Also warn about any @code{return} statement with no
3391 return-value in a function whose return-type is not @code{void}
3392 (falling off the end of the function body is considered returning
3393 without a value), and about a @code{return} statement with an
3394 expression in a function whose return-type is @code{void}.
3396 For C++, a function without return type always produces a diagnostic
3397 message, even when @option{-Wno-return-type} is specified.  The only
3398 exceptions are @samp{main} and functions defined in system headers.
3400 This warning is enabled by @option{-Wall}.
3402 @item -Wswitch
3403 @opindex Wswitch
3404 @opindex Wno-switch
3405 Warn whenever a @code{switch} statement has an index of enumerated type
3406 and lacks a @code{case} for one or more of the named codes of that
3407 enumeration.  (The presence of a @code{default} label prevents this
3408 warning.)  @code{case} labels outside the enumeration range also
3409 provoke warnings when this option is used (even if there is a
3410 @code{default} label).
3411 This warning is enabled by @option{-Wall}.
3413 @item -Wswitch-default
3414 @opindex Wswitch-default
3415 @opindex Wno-switch-default
3416 Warn whenever a @code{switch} statement does not have a @code{default}
3417 case.
3419 @item -Wswitch-enum
3420 @opindex Wswitch-enum
3421 @opindex Wno-switch-enum
3422 Warn whenever a @code{switch} statement has an index of enumerated type
3423 and lacks a @code{case} for one or more of the named codes of that
3424 enumeration.  @code{case} labels outside the enumeration range also
3425 provoke warnings when this option is used.  The only difference
3426 between @option{-Wswitch} and this option is that this option gives a
3427 warning about an omitted enumeration code even if there is a
3428 @code{default} label.
3430 @item -Wsync-nand @r{(C and C++ only)}
3431 @opindex Wsync-nand
3432 @opindex Wno-sync-nand
3433 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3434 built-in functions are used.  These functions changed semantics in GCC 4.4.
3436 @item -Wtrigraphs
3437 @opindex Wtrigraphs
3438 @opindex Wno-trigraphs
3439 Warn if any trigraphs are encountered that might change the meaning of
3440 the program (trigraphs within comments are not warned about).
3441 This warning is enabled by @option{-Wall}.
3443 @item -Wunused-but-set-parameter
3444 @opindex Wunused-but-set-parameter
3445 @opindex Wno-unused-but-set-parameter
3446 Warn whenever a function parameter is assigned to, but otherwise unused
3447 (aside from its declaration).
3449 To suppress this warning use the @samp{unused} attribute
3450 (@pxref{Variable Attributes}).
3452 This warning is also enabled by @option{-Wunused} together with
3453 @option{-Wextra}.
3455 @item -Wunused-but-set-variable
3456 @opindex Wunused-but-set-variable
3457 @opindex Wno-unused-but-set-variable
3458 Warn whenever a local variable is assigned to, but otherwise unused
3459 (aside from its declaration).
3460 This warning is enabled by @option{-Wall}.
3462 To suppress this warning use the @samp{unused} attribute
3463 (@pxref{Variable Attributes}).
3465 This warning is also enabled by @option{-Wunused}, which is enabled
3466 by @option{-Wall}.
3468 @item -Wunused-function
3469 @opindex Wunused-function
3470 @opindex Wno-unused-function
3471 Warn whenever a static function is declared but not defined or a
3472 non-inline static function is unused.
3473 This warning is enabled by @option{-Wall}.
3475 @item -Wunused-label
3476 @opindex Wunused-label
3477 @opindex Wno-unused-label
3478 Warn whenever a label is declared but not used.
3479 This warning is enabled by @option{-Wall}.
3481 To suppress this warning use the @samp{unused} attribute
3482 (@pxref{Variable Attributes}).
3484 @item -Wunused-parameter
3485 @opindex Wunused-parameter
3486 @opindex Wno-unused-parameter
3487 Warn whenever a function parameter is unused aside from its declaration.
3489 To suppress this warning use the @samp{unused} attribute
3490 (@pxref{Variable Attributes}).
3492 @item -Wno-unused-result
3493 @opindex Wunused-result
3494 @opindex Wno-unused-result
3495 Do not warn if a caller of a function marked with attribute
3496 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3497 its return value. The default is @option{-Wunused-result}.
3499 @item -Wunused-variable
3500 @opindex Wunused-variable
3501 @opindex Wno-unused-variable
3502 Warn whenever a local variable or non-constant static variable is unused
3503 aside from its declaration.
3504 This warning is enabled by @option{-Wall}.
3506 To suppress this warning use the @samp{unused} attribute
3507 (@pxref{Variable Attributes}).
3509 @item -Wunused-value
3510 @opindex Wunused-value
3511 @opindex Wno-unused-value
3512 Warn whenever a statement computes a result that is explicitly not
3513 used. To suppress this warning cast the unused expression to
3514 @samp{void}. This includes an expression-statement or the left-hand
3515 side of a comma expression that contains no side effects. For example,
3516 an expression such as @samp{x[i,j]} will cause a warning, while
3517 @samp{x[(void)i,j]} will not.
3519 This warning is enabled by @option{-Wall}.
3521 @item -Wunused
3522 @opindex Wunused
3523 @opindex Wno-unused
3524 All the above @option{-Wunused} options combined.
3526 In order to get a warning about an unused function parameter, you must
3527 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3528 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3530 @item -Wuninitialized
3531 @opindex Wuninitialized
3532 @opindex Wno-uninitialized
3533 Warn if an automatic variable is used without first being initialized
3534 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3535 warn if a non-static reference or non-static @samp{const} member
3536 appears in a class without constructors.
3538 If you want to warn about code which uses the uninitialized value of the
3539 variable in its own initializer, use the @option{-Winit-self} option.
3541 These warnings occur for individual uninitialized or clobbered
3542 elements of structure, union or array variables as well as for
3543 variables which are uninitialized or clobbered as a whole.  They do
3544 not occur for variables or elements declared @code{volatile}.  Because
3545 these warnings depend on optimization, the exact variables or elements
3546 for which there are warnings will depend on the precise optimization
3547 options and version of GCC used.
3549 Note that there may be no warning about a variable that is used only
3550 to compute a value that itself is never used, because such
3551 computations may be deleted by data flow analysis before the warnings
3552 are printed.
3554 @item -Wmaybe-uninitialized
3555 @opindex Wmaybe-uninitialized
3556 @opindex Wno-maybe-uninitialized
3557 For an automatic variable, if there exists a path from the function
3558 entry to a use of the variable that is initialized, but there exist
3559 some other paths the variable is not initialized, the compiler will
3560 emit a warning if it can not prove the uninitialized paths do not
3561 happen at runtime. These warnings are made optional because GCC is
3562 not smart enough to see all the reasons why the code might be correct
3563 despite appearing to have an error.  Here is one example of how
3564 this can happen:
3566 @smallexample
3567 @group
3569   int x;
3570   switch (y)
3571     @{
3572     case 1: x = 1;
3573       break;
3574     case 2: x = 4;
3575       break;
3576     case 3: x = 5;
3577     @}
3578   foo (x);
3580 @end group
3581 @end smallexample
3583 @noindent
3584 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3585 always initialized, but GCC doesn't know this. To suppress the
3586 warning, the user needs to provide a default case with assert(0) or
3587 similar code.
3589 @cindex @code{longjmp} warnings
3590 This option also warns when a non-volatile automatic variable might be
3591 changed by a call to @code{longjmp}.  These warnings as well are possible
3592 only in optimizing compilation.
3594 The compiler sees only the calls to @code{setjmp}.  It cannot know
3595 where @code{longjmp} will be called; in fact, a signal handler could
3596 call it at any point in the code.  As a result, you may get a warning
3597 even when there is in fact no problem because @code{longjmp} cannot
3598 in fact be called at the place which would cause a problem.
3600 Some spurious warnings can be avoided if you declare all the functions
3601 you use that never return as @code{noreturn}.  @xref{Function
3602 Attributes}.
3604 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3606 @item -Wunknown-pragmas
3607 @opindex Wunknown-pragmas
3608 @opindex Wno-unknown-pragmas
3609 @cindex warning for unknown pragmas
3610 @cindex unknown pragmas, warning
3611 @cindex pragmas, warning of unknown
3612 Warn when a #pragma directive is encountered which is not understood by
3613 GCC@.  If this command line option is used, warnings will even be issued
3614 for unknown pragmas in system header files.  This is not the case if
3615 the warnings were only enabled by the @option{-Wall} command line option.
3617 @item -Wno-pragmas
3618 @opindex Wno-pragmas
3619 @opindex Wpragmas
3620 Do not warn about misuses of pragmas, such as incorrect parameters,
3621 invalid syntax, or conflicts between pragmas.  See also
3622 @samp{-Wunknown-pragmas}.
3624 @item -Wstrict-aliasing
3625 @opindex Wstrict-aliasing
3626 @opindex Wno-strict-aliasing
3627 This option is only active when @option{-fstrict-aliasing} is active.
3628 It warns about code which might break the strict aliasing rules that the
3629 compiler is using for optimization.  The warning does not catch all
3630 cases, but does attempt to catch the more common pitfalls.  It is
3631 included in @option{-Wall}.
3632 It is equivalent to @option{-Wstrict-aliasing=3}
3634 @item -Wstrict-aliasing=n
3635 @opindex Wstrict-aliasing=n
3636 @opindex Wno-strict-aliasing=n
3637 This option is only active when @option{-fstrict-aliasing} is active.
3638 It warns about code which might break the strict aliasing rules that the
3639 compiler is using for optimization.
3640 Higher levels correspond to higher accuracy (fewer false positives).
3641 Higher levels also correspond to more effort, similar to the way -O works.
3642 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3643 with n=3.
3645 Level 1: Most aggressive, quick, least accurate.
3646 Possibly useful when higher levels
3647 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3648 false negatives.  However, it has many false positives.
3649 Warns for all pointer conversions between possibly incompatible types,
3650 even if never dereferenced.  Runs in the frontend only.
3652 Level 2: Aggressive, quick, not too precise.
3653 May still have many false positives (not as many as level 1 though),
3654 and few false negatives (but possibly more than level 1).
3655 Unlike level 1, it only warns when an address is taken.  Warns about
3656 incomplete types.  Runs in the frontend only.
3658 Level 3 (default for @option{-Wstrict-aliasing}):
3659 Should have very few false positives and few false
3660 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3661 Takes care of the common pun+dereference pattern in the frontend:
3662 @code{*(int*)&some_float}.
3663 If optimization is enabled, it also runs in the backend, where it deals
3664 with multiple statement cases using flow-sensitive points-to information.
3665 Only warns when the converted pointer is dereferenced.
3666 Does not warn about incomplete types.
3668 @item -Wstrict-overflow
3669 @itemx -Wstrict-overflow=@var{n}
3670 @opindex Wstrict-overflow
3671 @opindex Wno-strict-overflow
3672 This option is only active when @option{-fstrict-overflow} is active.
3673 It warns about cases where the compiler optimizes based on the
3674 assumption that signed overflow does not occur.  Note that it does not
3675 warn about all cases where the code might overflow: it only warns
3676 about cases where the compiler implements some optimization.  Thus
3677 this warning depends on the optimization level.
3679 An optimization which assumes that signed overflow does not occur is
3680 perfectly safe if the values of the variables involved are such that
3681 overflow never does, in fact, occur.  Therefore this warning can
3682 easily give a false positive: a warning about code which is not
3683 actually a problem.  To help focus on important issues, several
3684 warning levels are defined.  No warnings are issued for the use of
3685 undefined signed overflow when estimating how many iterations a loop
3686 will require, in particular when determining whether a loop will be
3687 executed at all.
3689 @table @gcctabopt
3690 @item -Wstrict-overflow=1
3691 Warn about cases which are both questionable and easy to avoid.  For
3692 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3693 compiler will simplify this to @code{1}.  This level of
3694 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3695 are not, and must be explicitly requested.
3697 @item -Wstrict-overflow=2
3698 Also warn about other cases where a comparison is simplified to a
3699 constant.  For example: @code{abs (x) >= 0}.  This can only be
3700 simplified when @option{-fstrict-overflow} is in effect, because
3701 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3702 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3703 @option{-Wstrict-overflow=2}.
3705 @item -Wstrict-overflow=3
3706 Also warn about other cases where a comparison is simplified.  For
3707 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3709 @item -Wstrict-overflow=4
3710 Also warn about other simplifications not covered by the above cases.
3711 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3713 @item -Wstrict-overflow=5
3714 Also warn about cases where the compiler reduces the magnitude of a
3715 constant involved in a comparison.  For example: @code{x + 2 > y} will
3716 be simplified to @code{x + 1 >= y}.  This is reported only at the
3717 highest warning level because this simplification applies to many
3718 comparisons, so this warning level will give a very large number of
3719 false positives.
3720 @end table
3722 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]}
3723 @opindex Wsuggest-attribute=
3724 @opindex Wno-suggest-attribute=
3725 Warn for cases where adding an attribute may be beneficial. The
3726 attributes currently supported are listed below.
3728 @table @gcctabopt
3729 @item -Wsuggest-attribute=pure
3730 @itemx -Wsuggest-attribute=const
3731 @itemx -Wsuggest-attribute=noreturn
3732 @opindex Wsuggest-attribute=pure
3733 @opindex Wno-suggest-attribute=pure
3734 @opindex Wsuggest-attribute=const
3735 @opindex Wno-suggest-attribute=const
3736 @opindex Wsuggest-attribute=noreturn
3737 @opindex Wno-suggest-attribute=noreturn
3739 Warn about functions which might be candidates for attributes
3740 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3741 functions visible in other compilation units or (in the case of @code{pure} and
3742 @code{const}) if it cannot prove that the function returns normally. A function
3743 returns normally if it doesn't contain an infinite loop nor returns abnormally
3744 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3745 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3746 higher.  Higher optimization levels improve the accuracy of the analysis.
3747 @end table
3749 @item -Warray-bounds
3750 @opindex Wno-array-bounds
3751 @opindex Warray-bounds
3752 This option is only active when @option{-ftree-vrp} is active
3753 (default for @option{-O2} and above). It warns about subscripts to arrays
3754 that are always out of bounds. This warning is enabled by @option{-Wall}.
3756 @item -Wno-div-by-zero
3757 @opindex Wno-div-by-zero
3758 @opindex Wdiv-by-zero
3759 Do not warn about compile-time integer division by zero.  Floating point
3760 division by zero is not warned about, as it can be a legitimate way of
3761 obtaining infinities and NaNs.
3763 @item -Wsystem-headers
3764 @opindex Wsystem-headers
3765 @opindex Wno-system-headers
3766 @cindex warnings from system headers
3767 @cindex system headers, warnings from
3768 Print warning messages for constructs found in system header files.
3769 Warnings from system headers are normally suppressed, on the assumption
3770 that they usually do not indicate real problems and would only make the
3771 compiler output harder to read.  Using this command line option tells
3772 GCC to emit warnings from system headers as if they occurred in user
3773 code.  However, note that using @option{-Wall} in conjunction with this
3774 option will @emph{not} warn about unknown pragmas in system
3775 headers---for that, @option{-Wunknown-pragmas} must also be used.
3777 @item -Wtrampolines
3778 @opindex Wtrampolines
3779 @opindex Wno-trampolines
3780  Warn about trampolines generated for pointers to nested functions.
3782  A trampoline is a small piece of data or code that is created at run
3783  time on the stack when the address of a nested function is taken, and
3784  is used to call the nested function indirectly.  For some targets, it
3785  is made up of data only and thus requires no special treatment.  But,
3786  for most targets, it is made up of code and thus requires the stack
3787  to be made executable in order for the program to work properly.
3789 @item -Wfloat-equal
3790 @opindex Wfloat-equal
3791 @opindex Wno-float-equal
3792 Warn if floating point values are used in equality comparisons.
3794 The idea behind this is that sometimes it is convenient (for the
3795 programmer) to consider floating-point values as approximations to
3796 infinitely precise real numbers.  If you are doing this, then you need
3797 to compute (by analyzing the code, or in some other way) the maximum or
3798 likely maximum error that the computation introduces, and allow for it
3799 when performing comparisons (and when producing output, but that's a
3800 different problem).  In particular, instead of testing for equality, you
3801 would check to see whether the two values have ranges that overlap; and
3802 this is done with the relational operators, so equality comparisons are
3803 probably mistaken.
3805 @item -Wtraditional @r{(C and Objective-C only)}
3806 @opindex Wtraditional
3807 @opindex Wno-traditional
3808 Warn about certain constructs that behave differently in traditional and
3809 ISO C@.  Also warn about ISO C constructs that have no traditional C
3810 equivalent, and/or problematic constructs which should be avoided.
3812 @itemize @bullet
3813 @item
3814 Macro parameters that appear within string literals in the macro body.
3815 In traditional C macro replacement takes place within string literals,
3816 but does not in ISO C@.
3818 @item
3819 In traditional C, some preprocessor directives did not exist.
3820 Traditional preprocessors would only consider a line to be a directive
3821 if the @samp{#} appeared in column 1 on the line.  Therefore
3822 @option{-Wtraditional} warns about directives that traditional C
3823 understands but would ignore because the @samp{#} does not appear as the
3824 first character on the line.  It also suggests you hide directives like
3825 @samp{#pragma} not understood by traditional C by indenting them.  Some
3826 traditional implementations would not recognize @samp{#elif}, so it
3827 suggests avoiding it altogether.
3829 @item
3830 A function-like macro that appears without arguments.
3832 @item
3833 The unary plus operator.
3835 @item
3836 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3837 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3838 constants.)  Note, these suffixes appear in macros defined in the system
3839 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3840 Use of these macros in user code might normally lead to spurious
3841 warnings, however GCC's integrated preprocessor has enough context to
3842 avoid warning in these cases.
3844 @item
3845 A function declared external in one block and then used after the end of
3846 the block.
3848 @item
3849 A @code{switch} statement has an operand of type @code{long}.
3851 @item
3852 A non-@code{static} function declaration follows a @code{static} one.
3853 This construct is not accepted by some traditional C compilers.
3855 @item
3856 The ISO type of an integer constant has a different width or
3857 signedness from its traditional type.  This warning is only issued if
3858 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3859 typically represent bit patterns, are not warned about.
3861 @item
3862 Usage of ISO string concatenation is detected.
3864 @item
3865 Initialization of automatic aggregates.
3867 @item
3868 Identifier conflicts with labels.  Traditional C lacks a separate
3869 namespace for labels.
3871 @item
3872 Initialization of unions.  If the initializer is zero, the warning is
3873 omitted.  This is done under the assumption that the zero initializer in
3874 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3875 initializer warnings and relies on default initialization to zero in the
3876 traditional C case.
3878 @item
3879 Conversions by prototypes between fixed/floating point values and vice
3880 versa.  The absence of these prototypes when compiling with traditional
3881 C would cause serious problems.  This is a subset of the possible
3882 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3884 @item
3885 Use of ISO C style function definitions.  This warning intentionally is
3886 @emph{not} issued for prototype declarations or variadic functions
3887 because these ISO C features will appear in your code when using
3888 libiberty's traditional C compatibility macros, @code{PARAMS} and
3889 @code{VPARAMS}.  This warning is also bypassed for nested functions
3890 because that feature is already a GCC extension and thus not relevant to
3891 traditional C compatibility.
3892 @end itemize
3894 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3895 @opindex Wtraditional-conversion
3896 @opindex Wno-traditional-conversion
3897 Warn if a prototype causes a type conversion that is different from what
3898 would happen to the same argument in the absence of a prototype.  This
3899 includes conversions of fixed point to floating and vice versa, and
3900 conversions changing the width or signedness of a fixed point argument
3901 except when the same as the default promotion.
3903 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3904 @opindex Wdeclaration-after-statement
3905 @opindex Wno-declaration-after-statement
3906 Warn when a declaration is found after a statement in a block.  This
3907 construct, known from C++, was introduced with ISO C99 and is by default
3908 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3909 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3911 @item -Wundef
3912 @opindex Wundef
3913 @opindex Wno-undef
3914 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3916 @item -Wno-endif-labels
3917 @opindex Wno-endif-labels
3918 @opindex Wendif-labels
3919 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3921 @item -Wshadow
3922 @opindex Wshadow
3923 @opindex Wno-shadow
3924 Warn whenever a local variable or type declaration shadows another variable,
3925 parameter, type, or class member (in C++), or whenever a built-in function
3926 is shadowed. Note that in C++, the compiler will not warn if a local variable
3927 shadows a struct/class/enum, but will warn if it shadows an explicit typedef.
3929 @item -Wlarger-than=@var{len}
3930 @opindex Wlarger-than=@var{len}
3931 @opindex Wlarger-than-@var{len}
3932 Warn whenever an object of larger than @var{len} bytes is defined.
3934 @item -Wframe-larger-than=@var{len}
3935 @opindex Wframe-larger-than
3936 Warn if the size of a function frame is larger than @var{len} bytes.
3937 The computation done to determine the stack frame size is approximate
3938 and not conservative.
3939 The actual requirements may be somewhat greater than @var{len}
3940 even if you do not get a warning.  In addition, any space allocated
3941 via @code{alloca}, variable-length arrays, or related constructs
3942 is not included by the compiler when determining
3943 whether or not to issue a warning.
3945 @item -Wstack-usage=@var{len}
3946 @opindex Wstack-usage
3947 Warn if the stack usage of a function might be larger than @var{len} bytes.
3948 The computation done to determine the stack usage is conservative.
3949 Any space allocated via @code{alloca}, variable-length arrays, or related
3950 constructs is included by the compiler when determining whether or not to
3951 issue a warning.
3953 The message is in keeping with the output of @option{-fstack-usage}.
3955 @itemize
3956 @item
3957 If the stack usage is fully static but exceeds the specified amount, it's:
3959 @smallexample
3960   warning: stack usage is 1120 bytes
3961 @end smallexample
3962 @item
3963 If the stack usage is (partly) dynamic but bounded, it's:
3965 @smallexample
3966   warning: stack usage might be 1648 bytes
3967 @end smallexample
3968 @item
3969 If the stack usage is (partly) dynamic and not bounded, it's:
3971 @smallexample
3972   warning: stack usage might be unbounded
3973 @end smallexample
3974 @end itemize
3976 @item -Wunsafe-loop-optimizations
3977 @opindex Wunsafe-loop-optimizations
3978 @opindex Wno-unsafe-loop-optimizations
3979 Warn if the loop cannot be optimized because the compiler could not
3980 assume anything on the bounds of the loop indices.  With
3981 @option{-funsafe-loop-optimizations} warn if the compiler made
3982 such assumptions.
3984 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3985 @opindex Wno-pedantic-ms-format
3986 @opindex Wpedantic-ms-format
3987 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3988 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3989 depending on the MS runtime, when you are using the options @option{-Wformat}
3990 and @option{-pedantic} without gnu-extensions.
3992 @item -Wpointer-arith
3993 @opindex Wpointer-arith
3994 @opindex Wno-pointer-arith
3995 Warn about anything that depends on the ``size of'' a function type or
3996 of @code{void}.  GNU C assigns these types a size of 1, for
3997 convenience in calculations with @code{void *} pointers and pointers
3998 to functions.  In C++, warn also when an arithmetic operation involves
3999 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
4001 @item -Wtype-limits
4002 @opindex Wtype-limits
4003 @opindex Wno-type-limits
4004 Warn if a comparison is always true or always false due to the limited
4005 range of the data type, but do not warn for constant expressions.  For
4006 example, warn if an unsigned variable is compared against zero with
4007 @samp{<} or @samp{>=}.  This warning is also enabled by
4008 @option{-Wextra}.
4010 @item -Wbad-function-cast @r{(C and Objective-C only)}
4011 @opindex Wbad-function-cast
4012 @opindex Wno-bad-function-cast
4013 Warn whenever a function call is cast to a non-matching type.
4014 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4016 @item -Wc++-compat @r{(C and Objective-C only)}
4017 Warn about ISO C constructs that are outside of the common subset of
4018 ISO C and ISO C++, e.g.@: request for implicit conversion from
4019 @code{void *} to a pointer to non-@code{void} type.
4021 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
4022 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
4023 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
4024 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
4026 @item -Wcast-qual
4027 @opindex Wcast-qual
4028 @opindex Wno-cast-qual
4029 Warn whenever a pointer is cast so as to remove a type qualifier from
4030 the target type.  For example, warn if a @code{const char *} is cast
4031 to an ordinary @code{char *}.
4033 Also warn when making a cast which introduces a type qualifier in an
4034 unsafe way.  For example, casting @code{char **} to @code{const char **}
4035 is unsafe, as in this example:
4037 @smallexample
4038   /* p is char ** value.  */
4039   const char **q = (const char **) p;
4040   /* Assignment of readonly string to const char * is OK.  */
4041   *q = "string";
4042   /* Now char** pointer points to read-only memory.  */
4043   **p = 'b';
4044 @end smallexample
4046 @item -Wcast-align
4047 @opindex Wcast-align
4048 @opindex Wno-cast-align
4049 Warn whenever a pointer is cast such that the required alignment of the
4050 target is increased.  For example, warn if a @code{char *} is cast to
4051 an @code{int *} on machines where integers can only be accessed at
4052 two- or four-byte boundaries.
4054 @item -Wwrite-strings
4055 @opindex Wwrite-strings
4056 @opindex Wno-write-strings
4057 When compiling C, give string constants the type @code{const
4058 char[@var{length}]} so that copying the address of one into a
4059 non-@code{const} @code{char *} pointer will get a warning.  These
4060 warnings will help you find at compile time code that can try to write
4061 into a string constant, but only if you have been very careful about
4062 using @code{const} in declarations and prototypes.  Otherwise, it will
4063 just be a nuisance. This is why we did not make @option{-Wall} request
4064 these warnings.
4066 When compiling C++, warn about the deprecated conversion from string
4067 literals to @code{char *}.  This warning is enabled by default for C++
4068 programs.
4070 @item -Wclobbered
4071 @opindex Wclobbered
4072 @opindex Wno-clobbered
4073 Warn for variables that might be changed by @samp{longjmp} or
4074 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4076 @item -Wconversion
4077 @opindex Wconversion
4078 @opindex Wno-conversion
4079 Warn for implicit conversions that may alter a value. This includes
4080 conversions between real and integer, like @code{abs (x)} when
4081 @code{x} is @code{double}; conversions between signed and unsigned,
4082 like @code{unsigned ui = -1}; and conversions to smaller types, like
4083 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4084 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4085 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4086 conversions between signed and unsigned integers can be disabled by
4087 using @option{-Wno-sign-conversion}.
4089 For C++, also warn for confusing overload resolution for user-defined
4090 conversions; and conversions that will never use a type conversion
4091 operator: conversions to @code{void}, the same type, a base class or a
4092 reference to them. Warnings about conversions between signed and
4093 unsigned integers are disabled by default in C++ unless
4094 @option{-Wsign-conversion} is explicitly enabled.
4096 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4097 @opindex Wconversion-null
4098 @opindex Wno-conversion-null
4099 Do not warn for conversions between @code{NULL} and non-pointer
4100 types. @option{-Wconversion-null} is enabled by default.
4102 @item -Wempty-body
4103 @opindex Wempty-body
4104 @opindex Wno-empty-body
4105 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4106 while} statement.  This warning is also enabled by @option{-Wextra}.
4108 @item -Wenum-compare
4109 @opindex Wenum-compare
4110 @opindex Wno-enum-compare
4111 Warn about a comparison between values of different enum types. In C++
4112 this warning is enabled by default.  In C this warning is enabled by
4113 @option{-Wall}.
4115 @item -Wjump-misses-init @r{(C, Objective-C only)}
4116 @opindex Wjump-misses-init
4117 @opindex Wno-jump-misses-init
4118 Warn if a @code{goto} statement or a @code{switch} statement jumps
4119 forward across the initialization of a variable, or jumps backward to a
4120 label after the variable has been initialized.  This only warns about
4121 variables which are initialized when they are declared.  This warning is
4122 only supported for C and Objective C; in C++ this sort of branch is an
4123 error in any case.
4125 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4126 can be disabled with the @option{-Wno-jump-misses-init} option.
4128 @item -Wsign-compare
4129 @opindex Wsign-compare
4130 @opindex Wno-sign-compare
4131 @cindex warning for comparison of signed and unsigned values
4132 @cindex comparison of signed and unsigned values, warning
4133 @cindex signed and unsigned values, comparison warning
4134 Warn when a comparison between signed and unsigned values could produce
4135 an incorrect result when the signed value is converted to unsigned.
4136 This warning is also enabled by @option{-Wextra}; to get the other warnings
4137 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
4139 @item -Wsign-conversion
4140 @opindex Wsign-conversion
4141 @opindex Wno-sign-conversion
4142 Warn for implicit conversions that may change the sign of an integer
4143 value, like assigning a signed integer expression to an unsigned
4144 integer variable. An explicit cast silences the warning. In C, this
4145 option is enabled also by @option{-Wconversion}.
4147 @item -Waddress
4148 @opindex Waddress
4149 @opindex Wno-address
4150 Warn about suspicious uses of memory addresses. These include using
4151 the address of a function in a conditional expression, such as
4152 @code{void func(void); if (func)}, and comparisons against the memory
4153 address of a string literal, such as @code{if (x == "abc")}.  Such
4154 uses typically indicate a programmer error: the address of a function
4155 always evaluates to true, so their use in a conditional usually
4156 indicate that the programmer forgot the parentheses in a function
4157 call; and comparisons against string literals result in unspecified
4158 behavior and are not portable in C, so they usually indicate that the
4159 programmer intended to use @code{strcmp}.  This warning is enabled by
4160 @option{-Wall}.
4162 @item -Wlogical-op
4163 @opindex Wlogical-op
4164 @opindex Wno-logical-op
4165 Warn about suspicious uses of logical operators in expressions.
4166 This includes using logical operators in contexts where a
4167 bit-wise operator is likely to be expected.
4169 @item -Waggregate-return
4170 @opindex Waggregate-return
4171 @opindex Wno-aggregate-return
4172 Warn if any functions that return structures or unions are defined or
4173 called.  (In languages where you can return an array, this also elicits
4174 a warning.)
4176 @item -Wno-attributes
4177 @opindex Wno-attributes
4178 @opindex Wattributes
4179 Do not warn if an unexpected @code{__attribute__} is used, such as
4180 unrecognized attributes, function attributes applied to variables,
4181 etc.  This will not stop errors for incorrect use of supported
4182 attributes.
4184 @item -Wno-builtin-macro-redefined
4185 @opindex Wno-builtin-macro-redefined
4186 @opindex Wbuiltin-macro-redefined
4187 Do not warn if certain built-in macros are redefined.  This suppresses
4188 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4189 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4191 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4192 @opindex Wstrict-prototypes
4193 @opindex Wno-strict-prototypes
4194 Warn if a function is declared or defined without specifying the
4195 argument types.  (An old-style function definition is permitted without
4196 a warning if preceded by a declaration which specifies the argument
4197 types.)
4199 @item -Wold-style-declaration @r{(C and Objective-C only)}
4200 @opindex Wold-style-declaration
4201 @opindex Wno-old-style-declaration
4202 Warn for obsolescent usages, according to the C Standard, in a
4203 declaration. For example, warn if storage-class specifiers like
4204 @code{static} are not the first things in a declaration.  This warning
4205 is also enabled by @option{-Wextra}.
4207 @item -Wold-style-definition @r{(C and Objective-C only)}
4208 @opindex Wold-style-definition
4209 @opindex Wno-old-style-definition
4210 Warn if an old-style function definition is used.  A warning is given
4211 even if there is a previous prototype.
4213 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4214 @opindex Wmissing-parameter-type
4215 @opindex Wno-missing-parameter-type
4216 A function parameter is declared without a type specifier in K&R-style
4217 functions:
4219 @smallexample
4220 void foo(bar) @{ @}
4221 @end smallexample
4223 This warning is also enabled by @option{-Wextra}.
4225 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4226 @opindex Wmissing-prototypes
4227 @opindex Wno-missing-prototypes
4228 Warn if a global function is defined without a previous prototype
4229 declaration.  This warning is issued even if the definition itself
4230 provides a prototype.  The aim is to detect global functions that fail
4231 to be declared in header files.
4233 @item -Wmissing-declarations
4234 @opindex Wmissing-declarations
4235 @opindex Wno-missing-declarations
4236 Warn if a global function is defined without a previous declaration.
4237 Do so even if the definition itself provides a prototype.
4238 Use this option to detect global functions that are not declared in
4239 header files.  In C++, no warnings are issued for function templates,
4240 or for inline functions, or for functions in anonymous namespaces.
4242 @item -Wmissing-field-initializers
4243 @opindex Wmissing-field-initializers
4244 @opindex Wno-missing-field-initializers
4245 @opindex W
4246 @opindex Wextra
4247 @opindex Wno-extra
4248 Warn if a structure's initializer has some fields missing.  For
4249 example, the following code would cause such a warning, because
4250 @code{x.h} is implicitly zero:
4252 @smallexample
4253 struct s @{ int f, g, h; @};
4254 struct s x = @{ 3, 4 @};
4255 @end smallexample
4257 This option does not warn about designated initializers, so the following
4258 modification would not trigger a warning:
4260 @smallexample
4261 struct s @{ int f, g, h; @};
4262 struct s x = @{ .f = 3, .g = 4 @};
4263 @end smallexample
4265 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4266 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4268 @item -Wmissing-format-attribute
4269 @opindex Wmissing-format-attribute
4270 @opindex Wno-missing-format-attribute
4271 @opindex Wformat
4272 @opindex Wno-format
4273 Warn about function pointers which might be candidates for @code{format}
4274 attributes.  Note these are only possible candidates, not absolute ones.
4275 GCC will guess that function pointers with @code{format} attributes that
4276 are used in assignment, initialization, parameter passing or return
4277 statements should have a corresponding @code{format} attribute in the
4278 resulting type.  I.e.@: the left-hand side of the assignment or
4279 initialization, the type of the parameter variable, or the return type
4280 of the containing function respectively should also have a @code{format}
4281 attribute to avoid the warning.
4283 GCC will also warn about function definitions which might be
4284 candidates for @code{format} attributes.  Again, these are only
4285 possible candidates.  GCC will guess that @code{format} attributes
4286 might be appropriate for any function that calls a function like
4287 @code{vprintf} or @code{vscanf}, but this might not always be the
4288 case, and some functions for which @code{format} attributes are
4289 appropriate may not be detected.
4291 @item -Wno-multichar
4292 @opindex Wno-multichar
4293 @opindex Wmultichar
4294 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4295 Usually they indicate a typo in the user's code, as they have
4296 implementation-defined values, and should not be used in portable code.
4298 @item -Wnormalized=<none|id|nfc|nfkc>
4299 @opindex Wnormalized=
4300 @cindex NFC
4301 @cindex NFKC
4302 @cindex character set, input normalization
4303 In ISO C and ISO C++, two identifiers are different if they are
4304 different sequences of characters.  However, sometimes when characters
4305 outside the basic ASCII character set are used, you can have two
4306 different character sequences that look the same.  To avoid confusion,
4307 the ISO 10646 standard sets out some @dfn{normalization rules} which
4308 when applied ensure that two sequences that look the same are turned into
4309 the same sequence.  GCC can warn you if you are using identifiers which
4310 have not been normalized; this option controls that warning.
4312 There are four levels of warning that GCC supports.  The default is
4313 @option{-Wnormalized=nfc}, which warns about any identifier which is
4314 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4315 recommended form for most uses.
4317 Unfortunately, there are some characters which ISO C and ISO C++ allow
4318 in identifiers that when turned into NFC aren't allowable as
4319 identifiers.  That is, there's no way to use these symbols in portable
4320 ISO C or C++ and have all your identifiers in NFC@.
4321 @option{-Wnormalized=id} suppresses the warning for these characters.
4322 It is hoped that future versions of the standards involved will correct
4323 this, which is why this option is not the default.
4325 You can switch the warning off for all characters by writing
4326 @option{-Wnormalized=none}.  You would only want to do this if you
4327 were using some other normalization scheme (like ``D''), because
4328 otherwise you can easily create bugs that are literally impossible to see.
4330 Some characters in ISO 10646 have distinct meanings but look identical
4331 in some fonts or display methodologies, especially once formatting has
4332 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4333 LETTER N'', will display just like a regular @code{n} which has been
4334 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4335 normalization scheme to convert all these into a standard form as
4336 well, and GCC will warn if your code is not in NFKC if you use
4337 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4338 about every identifier that contains the letter O because it might be
4339 confused with the digit 0, and so is not the default, but may be
4340 useful as a local coding convention if the programming environment is
4341 unable to be fixed to display these characters distinctly.
4343 @item -Wno-deprecated
4344 @opindex Wno-deprecated
4345 @opindex Wdeprecated
4346 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4348 @item -Wno-deprecated-declarations
4349 @opindex Wno-deprecated-declarations
4350 @opindex Wdeprecated-declarations
4351 Do not warn about uses of functions (@pxref{Function Attributes}),
4352 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4353 Attributes}) marked as deprecated by using the @code{deprecated}
4354 attribute.
4356 @item -Wno-overflow
4357 @opindex Wno-overflow
4358 @opindex Woverflow
4359 Do not warn about compile-time overflow in constant expressions.
4361 @item -Woverride-init @r{(C and Objective-C only)}
4362 @opindex Woverride-init
4363 @opindex Wno-override-init
4364 @opindex W
4365 @opindex Wextra
4366 @opindex Wno-extra
4367 Warn if an initialized field without side effects is overridden when
4368 using designated initializers (@pxref{Designated Inits, , Designated
4369 Initializers}).
4371 This warning is included in @option{-Wextra}.  To get other
4372 @option{-Wextra} warnings without this one, use @samp{-Wextra
4373 -Wno-override-init}.
4375 @item -Wpacked
4376 @opindex Wpacked
4377 @opindex Wno-packed
4378 Warn if a structure is given the packed attribute, but the packed
4379 attribute has no effect on the layout or size of the structure.
4380 Such structures may be mis-aligned for little benefit.  For
4381 instance, in this code, the variable @code{f.x} in @code{struct bar}
4382 will be misaligned even though @code{struct bar} does not itself
4383 have the packed attribute:
4385 @smallexample
4386 @group
4387 struct foo @{
4388   int x;
4389   char a, b, c, d;
4390 @} __attribute__((packed));
4391 struct bar @{
4392   char z;
4393   struct foo f;
4395 @end group
4396 @end smallexample
4398 @item -Wpacked-bitfield-compat
4399 @opindex Wpacked-bitfield-compat
4400 @opindex Wno-packed-bitfield-compat
4401 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4402 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4403 the change can lead to differences in the structure layout.  GCC
4404 informs you when the offset of such a field has changed in GCC 4.4.
4405 For example there is no longer a 4-bit padding between field @code{a}
4406 and @code{b} in this structure:
4408 @smallexample
4409 struct foo
4411   char a:4;
4412   char b:8;
4413 @} __attribute__ ((packed));
4414 @end smallexample
4416 This warning is enabled by default.  Use
4417 @option{-Wno-packed-bitfield-compat} to disable this warning.
4419 @item -Wpadded
4420 @opindex Wpadded
4421 @opindex Wno-padded
4422 Warn if padding is included in a structure, either to align an element
4423 of the structure or to align the whole structure.  Sometimes when this
4424 happens it is possible to rearrange the fields of the structure to
4425 reduce the padding and so make the structure smaller.
4427 @item -Wredundant-decls
4428 @opindex Wredundant-decls
4429 @opindex Wno-redundant-decls
4430 Warn if anything is declared more than once in the same scope, even in
4431 cases where multiple declaration is valid and changes nothing.
4433 @item -Wnested-externs @r{(C and Objective-C only)}
4434 @opindex Wnested-externs
4435 @opindex Wno-nested-externs
4436 Warn if an @code{extern} declaration is encountered within a function.
4438 @item -Winline
4439 @opindex Winline
4440 @opindex Wno-inline
4441 Warn if a function can not be inlined and it was declared as inline.
4442 Even with this option, the compiler will not warn about failures to
4443 inline functions declared in system headers.
4445 The compiler uses a variety of heuristics to determine whether or not
4446 to inline a function.  For example, the compiler takes into account
4447 the size of the function being inlined and the amount of inlining
4448 that has already been done in the current function.  Therefore,
4449 seemingly insignificant changes in the source program can cause the
4450 warnings produced by @option{-Winline} to appear or disappear.
4452 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4453 @opindex Wno-invalid-offsetof
4454 @opindex Winvalid-offsetof
4455 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4456 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4457 to a non-POD type is undefined.  In existing C++ implementations,
4458 however, @samp{offsetof} typically gives meaningful results even when
4459 applied to certain kinds of non-POD types. (Such as a simple
4460 @samp{struct} that fails to be a POD type only by virtue of having a
4461 constructor.)  This flag is for users who are aware that they are
4462 writing nonportable code and who have deliberately chosen to ignore the
4463 warning about it.
4465 The restrictions on @samp{offsetof} may be relaxed in a future version
4466 of the C++ standard.
4468 @item -Wno-int-to-pointer-cast
4469 @opindex Wno-int-to-pointer-cast
4470 @opindex Wint-to-pointer-cast
4471 Suppress warnings from casts to pointer type of an integer of a
4472 different size. In C++, casting to a pointer type of smaller size is
4473 an error. @option{Wint-to-pointer-cast} is enabled by default.
4476 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4477 @opindex Wno-pointer-to-int-cast
4478 @opindex Wpointer-to-int-cast
4479 Suppress warnings from casts from a pointer to an integer type of a
4480 different size.
4482 @item -Winvalid-pch
4483 @opindex Winvalid-pch
4484 @opindex Wno-invalid-pch
4485 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4486 the search path but can't be used.
4488 @item -Wlong-long
4489 @opindex Wlong-long
4490 @opindex Wno-long-long
4491 Warn if @samp{long long} type is used.  This is enabled by either
4492 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4493 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4495 @item -Wvariadic-macros
4496 @opindex Wvariadic-macros
4497 @opindex Wno-variadic-macros
4498 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4499 alternate syntax when in pedantic ISO C99 mode.  This is default.
4500 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4502 @item -Wvla
4503 @opindex Wvla
4504 @opindex Wno-vla
4505 Warn if variable length array is used in the code.
4506 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4507 the variable length array.
4509 @item -Wvolatile-register-var
4510 @opindex Wvolatile-register-var
4511 @opindex Wno-volatile-register-var
4512 Warn if a register variable is declared volatile.  The volatile
4513 modifier does not inhibit all optimizations that may eliminate reads
4514 and/or writes to register variables.  This warning is enabled by
4515 @option{-Wall}.
4517 @item -Wdisabled-optimization
4518 @opindex Wdisabled-optimization
4519 @opindex Wno-disabled-optimization
4520 Warn if a requested optimization pass is disabled.  This warning does
4521 not generally indicate that there is anything wrong with your code; it
4522 merely indicates that GCC's optimizers were unable to handle the code
4523 effectively.  Often, the problem is that your code is too big or too
4524 complex; GCC will refuse to optimize programs when the optimization
4525 itself is likely to take inordinate amounts of time.
4527 @item -Wpointer-sign @r{(C and Objective-C only)}
4528 @opindex Wpointer-sign
4529 @opindex Wno-pointer-sign
4530 Warn for pointer argument passing or assignment with different signedness.
4531 This option is only supported for C and Objective-C@.  It is implied by
4532 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4533 @option{-Wno-pointer-sign}.
4535 @item -Wstack-protector
4536 @opindex Wstack-protector
4537 @opindex Wno-stack-protector
4538 This option is only active when @option{-fstack-protector} is active.  It
4539 warns about functions that will not be protected against stack smashing.
4541 @item -Wno-mudflap
4542 @opindex Wno-mudflap
4543 Suppress warnings about constructs that cannot be instrumented by
4544 @option{-fmudflap}.
4546 @item -Woverlength-strings
4547 @opindex Woverlength-strings
4548 @opindex Wno-overlength-strings
4549 Warn about string constants which are longer than the ``minimum
4550 maximum'' length specified in the C standard.  Modern compilers
4551 generally allow string constants which are much longer than the
4552 standard's minimum limit, but very portable programs should avoid
4553 using longer strings.
4555 The limit applies @emph{after} string constant concatenation, and does
4556 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4557 C99, it was raised to 4095.  C++98 does not specify a normative
4558 minimum maximum, so we do not diagnose overlength strings in C++@.
4560 This option is implied by @option{-pedantic}, and can be disabled with
4561 @option{-Wno-overlength-strings}.
4563 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4564 @opindex Wunsuffixed-float-constants
4566 GCC will issue a warning for any floating constant that does not have
4567 a suffix.  When used together with @option{-Wsystem-headers} it will
4568 warn about such constants in system header files.  This can be useful
4569 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4570 from the decimal floating-point extension to C99.
4571 @end table
4573 @node Debugging Options
4574 @section Options for Debugging Your Program or GCC
4575 @cindex options, debugging
4576 @cindex debugging information options
4578 GCC has various special options that are used for debugging
4579 either your program or GCC:
4581 @table @gcctabopt
4582 @item -g
4583 @opindex g
4584 Produce debugging information in the operating system's native format
4585 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4586 information.
4588 On most systems that use stabs format, @option{-g} enables use of extra
4589 debugging information that only GDB can use; this extra information
4590 makes debugging work better in GDB but will probably make other debuggers
4591 crash or
4592 refuse to read the program.  If you want to control for certain whether
4593 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4594 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4596 GCC allows you to use @option{-g} with
4597 @option{-O}.  The shortcuts taken by optimized code may occasionally
4598 produce surprising results: some variables you declared may not exist
4599 at all; flow of control may briefly move where you did not expect it;
4600 some statements may not be executed because they compute constant
4601 results or their values were already at hand; some statements may
4602 execute in different places because they were moved out of loops.
4604 Nevertheless it proves possible to debug optimized output.  This makes
4605 it reasonable to use the optimizer for programs that might have bugs.
4607 The following options are useful when GCC is generated with the
4608 capability for more than one debugging format.
4610 @item -ggdb
4611 @opindex ggdb
4612 Produce debugging information for use by GDB@.  This means to use the
4613 most expressive format available (DWARF 2, stabs, or the native format
4614 if neither of those are supported), including GDB extensions if at all
4615 possible.
4617 @item -gstabs
4618 @opindex gstabs
4619 Produce debugging information in stabs format (if that is supported),
4620 without GDB extensions.  This is the format used by DBX on most BSD
4621 systems.  On MIPS, Alpha and System V Release 4 systems this option
4622 produces stabs debugging output which is not understood by DBX or SDB@.
4623 On System V Release 4 systems this option requires the GNU assembler.
4625 @item -feliminate-unused-debug-symbols
4626 @opindex feliminate-unused-debug-symbols
4627 Produce debugging information in stabs format (if that is supported),
4628 for only symbols that are actually used.
4630 @item -femit-class-debug-always
4631 Instead of emitting debugging information for a C++ class in only one
4632 object file, emit it in all object files using the class.  This option
4633 should be used only with debuggers that are unable to handle the way GCC
4634 normally emits debugging information for classes because using this
4635 option will increase the size of debugging information by as much as a
4636 factor of two.
4638 @item -fno-debug-types-section
4639 @opindex fno-debug-types-section
4640 @opindex fdebug-types-section
4641 By default when using DWARF v4 or higher type DIEs will be put into
4642 their own .debug_types section instead of making them part of the
4643 .debug_info section.  It is more efficient to put them in a separate
4644 comdat sections since the linker will then be able to remove duplicates.
4645 But not all DWARF consumers support .debug_types sections yet.
4647 @item -gstabs+
4648 @opindex gstabs+
4649 Produce debugging information in stabs format (if that is supported),
4650 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4651 use of these extensions is likely to make other debuggers crash or
4652 refuse to read the program.
4654 @item -gcoff
4655 @opindex gcoff
4656 Produce debugging information in COFF format (if that is supported).
4657 This is the format used by SDB on most System V systems prior to
4658 System V Release 4.
4660 @item -gxcoff
4661 @opindex gxcoff
4662 Produce debugging information in XCOFF format (if that is supported).
4663 This is the format used by the DBX debugger on IBM RS/6000 systems.
4665 @item -gxcoff+
4666 @opindex gxcoff+
4667 Produce debugging information in XCOFF format (if that is supported),
4668 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4669 use of these extensions is likely to make other debuggers crash or
4670 refuse to read the program, and may cause assemblers other than the GNU
4671 assembler (GAS) to fail with an error.
4673 @item -gdwarf-@var{version}
4674 @opindex gdwarf-@var{version}
4675 Produce debugging information in DWARF format (if that is
4676 supported).  This is the format used by DBX on IRIX 6.  The value
4677 of @var{version} may be either 2, 3 or 4; the default version is 2.
4679 Note that with DWARF version 2 some ports require, and will always
4680 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4682 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4683 for maximum benefit.
4685 @item -gstrict-dwarf
4686 @opindex gstrict-dwarf
4687 Disallow using extensions of later DWARF standard version than selected
4688 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4689 DWARF extensions from later standard versions is allowed.
4691 @item -gno-strict-dwarf
4692 @opindex gno-strict-dwarf
4693 Allow using extensions of later DWARF standard version than selected with
4694 @option{-gdwarf-@var{version}}.
4696 @item -gvms
4697 @opindex gvms
4698 Produce debugging information in VMS debug format (if that is
4699 supported).  This is the format used by DEBUG on VMS systems.
4701 @item -g@var{level}
4702 @itemx -ggdb@var{level}
4703 @itemx -gstabs@var{level}
4704 @itemx -gcoff@var{level}
4705 @itemx -gxcoff@var{level}
4706 @itemx -gvms@var{level}
4707 Request debugging information and also use @var{level} to specify how
4708 much information.  The default level is 2.
4710 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4711 @option{-g}.
4713 Level 1 produces minimal information, enough for making backtraces in
4714 parts of the program that you don't plan to debug.  This includes
4715 descriptions of functions and external variables, but no information
4716 about local variables and no line numbers.
4718 Level 3 includes extra information, such as all the macro definitions
4719 present in the program.  Some debuggers support macro expansion when
4720 you use @option{-g3}.
4722 @option{-gdwarf-2} does not accept a concatenated debug level, because
4723 GCC used to support an option @option{-gdwarf} that meant to generate
4724 debug information in version 1 of the DWARF format (which is very
4725 different from version 2), and it would have been too confusing.  That
4726 debug format is long obsolete, but the option cannot be changed now.
4727 Instead use an additional @option{-g@var{level}} option to change the
4728 debug level for DWARF.
4730 @item -gtoggle
4731 @opindex gtoggle
4732 Turn off generation of debug info, if leaving out this option would have
4733 generated it, or turn it on at level 2 otherwise.  The position of this
4734 argument in the command line does not matter, it takes effect after all
4735 other options are processed, and it does so only once, no matter how
4736 many times it is given.  This is mainly intended to be used with
4737 @option{-fcompare-debug}.
4739 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4740 @opindex fdump-final-insns
4741 Dump the final internal representation (RTL) to @var{file}.  If the
4742 optional argument is omitted (or if @var{file} is @code{.}), the name
4743 of the dump file will be determined by appending @code{.gkd} to the
4744 compilation output file name.
4746 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4747 @opindex fcompare-debug
4748 @opindex fno-compare-debug
4749 If no error occurs during compilation, run the compiler a second time,
4750 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4751 passed to the second compilation.  Dump the final internal
4752 representation in both compilations, and print an error if they differ.
4754 If the equal sign is omitted, the default @option{-gtoggle} is used.
4756 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4757 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4758 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4759 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4760 is used.
4762 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4763 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4764 of the final representation and the second compilation, preventing even
4765 @env{GCC_COMPARE_DEBUG} from taking effect.
4767 To verify full coverage during @option{-fcompare-debug} testing, set
4768 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4769 which GCC will reject as an invalid option in any actual compilation
4770 (rather than preprocessing, assembly or linking).  To get just a
4771 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4772 not overridden} will do.
4774 @item -fcompare-debug-second
4775 @opindex fcompare-debug-second
4776 This option is implicitly passed to the compiler for the second
4777 compilation requested by @option{-fcompare-debug}, along with options to
4778 silence warnings, and omitting other options that would cause
4779 side-effect compiler outputs to files or to the standard output.  Dump
4780 files and preserved temporary files are renamed so as to contain the
4781 @code{.gk} additional extension during the second compilation, to avoid
4782 overwriting those generated by the first.
4784 When this option is passed to the compiler driver, it causes the
4785 @emph{first} compilation to be skipped, which makes it useful for little
4786 other than debugging the compiler proper.
4788 @item -feliminate-dwarf2-dups
4789 @opindex feliminate-dwarf2-dups
4790 Compress DWARF2 debugging information by eliminating duplicated
4791 information about each symbol.  This option only makes sense when
4792 generating DWARF2 debugging information with @option{-gdwarf-2}.
4794 @item -femit-struct-debug-baseonly
4795 Emit debug information for struct-like types
4796 only when the base name of the compilation source file
4797 matches the base name of file in which the struct was defined.
4799 This option substantially reduces the size of debugging information,
4800 but at significant potential loss in type information to the debugger.
4801 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4802 See @option{-femit-struct-debug-detailed} for more detailed control.
4804 This option works only with DWARF 2.
4806 @item -femit-struct-debug-reduced
4807 Emit debug information for struct-like types
4808 only when the base name of the compilation source file
4809 matches the base name of file in which the type was defined,
4810 unless the struct is a template or defined in a system header.
4812 This option significantly reduces the size of debugging information,
4813 with some potential loss in type information to the debugger.
4814 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4815 See @option{-femit-struct-debug-detailed} for more detailed control.
4817 This option works only with DWARF 2.
4819 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4820 Specify the struct-like types
4821 for which the compiler will generate debug information.
4822 The intent is to reduce duplicate struct debug information
4823 between different object files within the same program.
4825 This option is a detailed version of
4826 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4827 which will serve for most needs.
4829 A specification has the syntax@*
4830 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4832 The optional first word limits the specification to
4833 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4834 A struct type is used directly when it is the type of a variable, member.
4835 Indirect uses arise through pointers to structs.
4836 That is, when use of an incomplete struct would be legal, the use is indirect.
4837 An example is
4838 @samp{struct one direct; struct two * indirect;}.
4840 The optional second word limits the specification to
4841 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4842 Generic structs are a bit complicated to explain.
4843 For C++, these are non-explicit specializations of template classes,
4844 or non-template classes within the above.
4845 Other programming languages have generics,
4846 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4848 The third word specifies the source files for those
4849 structs for which the compiler will emit debug information.
4850 The values @samp{none} and @samp{any} have the normal meaning.
4851 The value @samp{base} means that
4852 the base of name of the file in which the type declaration appears
4853 must match the base of the name of the main compilation file.
4854 In practice, this means that
4855 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4856 but types declared in other header will not.
4857 The value @samp{sys} means those types satisfying @samp{base}
4858 or declared in system or compiler headers.
4860 You may need to experiment to determine the best settings for your application.
4862 The default is @samp{-femit-struct-debug-detailed=all}.
4864 This option works only with DWARF 2.
4866 @item -fno-merge-debug-strings
4867 @opindex fmerge-debug-strings
4868 @opindex fno-merge-debug-strings
4869 Direct the linker to not merge together strings in the debugging
4870 information which are identical in different object files.  Merging is
4871 not supported by all assemblers or linkers.  Merging decreases the size
4872 of the debug information in the output file at the cost of increasing
4873 link processing time.  Merging is enabled by default.
4875 @item -fdebug-prefix-map=@var{old}=@var{new}
4876 @opindex fdebug-prefix-map
4877 When compiling files in directory @file{@var{old}}, record debugging
4878 information describing them as in @file{@var{new}} instead.
4880 @item -fno-dwarf2-cfi-asm
4881 @opindex fdwarf2-cfi-asm
4882 @opindex fno-dwarf2-cfi-asm
4883 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4884 instead of using GAS @code{.cfi_*} directives.
4886 @cindex @command{prof}
4887 @item -p
4888 @opindex p
4889 Generate extra code to write profile information suitable for the
4890 analysis program @command{prof}.  You must use this option when compiling
4891 the source files you want data about, and you must also use it when
4892 linking.
4894 @cindex @command{gprof}
4895 @item -pg
4896 @opindex pg
4897 Generate extra code to write profile information suitable for the
4898 analysis program @command{gprof}.  You must use this option when compiling
4899 the source files you want data about, and you must also use it when
4900 linking.
4902 @item -Q
4903 @opindex Q
4904 Makes the compiler print out each function name as it is compiled, and
4905 print some statistics about each pass when it finishes.
4907 @item -ftime-report
4908 @opindex ftime-report
4909 Makes the compiler print some statistics about the time consumed by each
4910 pass when it finishes.
4912 @item -fmem-report
4913 @opindex fmem-report
4914 Makes the compiler print some statistics about permanent memory
4915 allocation when it finishes.
4917 @item -fpre-ipa-mem-report
4918 @opindex fpre-ipa-mem-report
4919 @item -fpost-ipa-mem-report
4920 @opindex fpost-ipa-mem-report
4921 Makes the compiler print some statistics about permanent memory
4922 allocation before or after interprocedural optimization.
4924 @item -fstack-usage
4925 @opindex fstack-usage
4926 Makes the compiler output stack usage information for the program, on a
4927 per-function basis.  The filename for the dump is made by appending
4928 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
4929 the output file, if explicitly specified and it is not an executable,
4930 otherwise it is the basename of the source file.  An entry is made up
4931 of three fields:
4933 @itemize
4934 @item
4935 The name of the function.
4936 @item
4937 A number of bytes.
4938 @item
4939 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
4940 @end itemize
4942 The qualifier @code{static} means that the function manipulates the stack
4943 statically: a fixed number of bytes are allocated for the frame on function
4944 entry and released on function exit; no stack adjustments are otherwise made
4945 in the function.  The second field is this fixed number of bytes.
4947 The qualifier @code{dynamic} means that the function manipulates the stack
4948 dynamically: in addition to the static allocation described above, stack
4949 adjustments are made in the body of the function, for example to push/pop
4950 arguments around function calls.  If the qualifier @code{bounded} is also
4951 present, the amount of these adjustments is bounded at compile-time and
4952 the second field is an upper bound of the total amount of stack used by
4953 the function.  If it is not present, the amount of these adjustments is
4954 not bounded at compile-time and the second field only represents the
4955 bounded part.
4957 @item -fprofile-arcs
4958 @opindex fprofile-arcs
4959 Add code so that program flow @dfn{arcs} are instrumented.  During
4960 execution the program records how many times each branch and call is
4961 executed and how many times it is taken or returns.  When the compiled
4962 program exits it saves this data to a file called
4963 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4964 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4965 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4966 @var{auxname} is generated from the name of the output file, if
4967 explicitly specified and it is not the final executable, otherwise it is
4968 the basename of the source file.  In both cases any suffix is removed
4969 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4970 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4971 @xref{Cross-profiling}.
4973 @cindex @command{gcov}
4974 @item --coverage
4975 @opindex coverage
4977 This option is used to compile and link code instrumented for coverage
4978 analysis.  The option is a synonym for @option{-fprofile-arcs}
4979 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4980 linking).  See the documentation for those options for more details.
4982 @itemize
4984 @item
4985 Compile the source files with @option{-fprofile-arcs} plus optimization
4986 and code generation options.  For test coverage analysis, use the
4987 additional @option{-ftest-coverage} option.  You do not need to profile
4988 every source file in a program.
4990 @item
4991 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4992 (the latter implies the former).
4994 @item
4995 Run the program on a representative workload to generate the arc profile
4996 information.  This may be repeated any number of times.  You can run
4997 concurrent instances of your program, and provided that the file system
4998 supports locking, the data files will be correctly updated.  Also
4999 @code{fork} calls are detected and correctly handled (double counting
5000 will not happen).
5002 @item
5003 For profile-directed optimizations, compile the source files again with
5004 the same optimization and code generation options plus
5005 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5006 Control Optimization}).
5008 @item
5009 For test coverage analysis, use @command{gcov} to produce human readable
5010 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5011 @command{gcov} documentation for further information.
5013 @end itemize
5015 With @option{-fprofile-arcs}, for each function of your program GCC
5016 creates a program flow graph, then finds a spanning tree for the graph.
5017 Only arcs that are not on the spanning tree have to be instrumented: the
5018 compiler adds code to count the number of times that these arcs are
5019 executed.  When an arc is the only exit or only entrance to a block, the
5020 instrumentation code can be added to the block; otherwise, a new basic
5021 block must be created to hold the instrumentation code.
5023 @need 2000
5024 @item -ftest-coverage
5025 @opindex ftest-coverage
5026 Produce a notes file that the @command{gcov} code-coverage utility
5027 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5028 show program coverage.  Each source file's note file is called
5029 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5030 above for a description of @var{auxname} and instructions on how to
5031 generate test coverage data.  Coverage data will match the source files
5032 more closely, if you do not optimize.
5034 @item -fdbg-cnt-list
5035 @opindex fdbg-cnt-list
5036 Print the name and the counter upper bound for all debug counters.
5039 @item -fdbg-cnt=@var{counter-value-list}
5040 @opindex fdbg-cnt
5041 Set the internal debug counter upper bound.  @var{counter-value-list}
5042 is a comma-separated list of @var{name}:@var{value} pairs
5043 which sets the upper bound of each debug counter @var{name} to @var{value}.
5044 All debug counters have the initial upper bound of @var{UINT_MAX},
5045 thus dbg_cnt() returns true always unless the upper bound is set by this option.
5046 e.g. With -fdbg-cnt=dce:10,tail_call:0
5047 dbg_cnt(dce) will return true only for first 10 invocations
5049 @itemx -fenable-@var{kind}-@var{pass}
5050 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5051 @opindex fdisable-
5052 @opindex fenable-
5054 This is a set of debugging options that are used to explicitly disable/enable
5055 optimization passes. For compiler users, regular options for enabling/disabling
5056 passes should be used instead.
5058 @itemize
5060 @item -fdisable-ipa-@var{pass}
5061 Disable ipa pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5062 statically invoked in the compiler multiple times, the pass name should be
5063 appended with a sequential number starting from 1.
5065 @item -fdisable-rtl-@var{pass}
5066 @item -fdisable-rtl-@var{pass}=@var{range-list}
5067 Disable rtl pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5068 statically invoked in the compiler multiple times, the pass name should be
5069 appended with a sequential number starting from 1.  @var{range-list} is a comma
5070 seperated list of function ranges or assembler names.  Each range is a number
5071 pair seperated by a colon.  The range is inclusive in both ends.  If the range
5072 is trivial, the number pair can be simplified as a single number.  If the
5073 function's cgraph node's @var{uid} is falling within one of the specified ranges,
5074 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5075 function header of a dump file, and the pass names can be dumped by using
5076 option @option{-fdump-passes}.
5078 @item -fdisable-tree-@var{pass}
5079 @item -fdisable-tree-@var{pass}=@var{range-list}
5080 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5081 option arguments.
5083 @item -fenable-ipa-@var{pass}
5084 Enable ipa pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5085 statically invoked in the compiler multiple times, the pass name should be
5086 appended with a sequential number starting from 1.
5088 @item -fenable-rtl-@var{pass}
5089 @item -fenable-rtl-@var{pass}=@var{range-list}
5090 Enable rtl pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5091 description and examples.
5093 @item -fenable-tree-@var{pass}
5094 @item -fenable-tree-@var{pass}=@var{range-list}
5095 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5096 of option arguments.
5098 @smallexample
5100 # disable ccp1 for all functions
5101    -fdisable-tree-ccp1
5102 # disable complete unroll for function whose cgraph node uid is 1
5103    -fenable-tree-cunroll=1
5104 # disable gcse2 for functions at the following ranges [1,1],
5105 # [300,400], and [400,1000]
5106 # disable gcse2 for functions foo and foo2
5107    -fdisable-rtl-gcse2=foo,foo2
5108 # disable early inlining
5109    -fdisable-tree-einline
5110 # disable ipa inlining
5111    -fdisable-ipa-inline
5112 # enable tree full unroll
5113    -fenable-tree-unroll
5115 @end smallexample
5117 @end itemize
5119 @item -d@var{letters}
5120 @itemx -fdump-rtl-@var{pass}
5121 @opindex d
5122 Says to make debugging dumps during compilation at times specified by
5123 @var{letters}.  This is used for debugging the RTL-based passes of the
5124 compiler.  The file names for most of the dumps are made by appending
5125 a pass number and a word to the @var{dumpname}, and the files are
5126 created in the directory of the output file.  Note that the pass
5127 number is computed statically as passes get registered into the pass
5128 manager.  Thus the numbering is not related to the dynamic order of
5129 execution of passes.  In particular, a pass installed by a plugin
5130 could have a number over 200 even if it executed quite early.
5131 @var{dumpname} is generated from the name of the output file, if
5132 explicitly specified and it is not an executable, otherwise it is the
5133 basename of the source file. These switches may have different effects
5134 when @option{-E} is used for preprocessing.
5136 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5137 @option{-d} option @var{letters}.  Here are the possible
5138 letters for use in @var{pass} and @var{letters}, and their meanings:
5140 @table @gcctabopt
5142 @item -fdump-rtl-alignments
5143 @opindex fdump-rtl-alignments
5144 Dump after branch alignments have been computed.
5146 @item -fdump-rtl-asmcons
5147 @opindex fdump-rtl-asmcons
5148 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5150 @item -fdump-rtl-auto_inc_dec
5151 @opindex fdump-rtl-auto_inc_dec
5152 Dump after auto-inc-dec discovery.  This pass is only run on
5153 architectures that have auto inc or auto dec instructions.
5155 @item -fdump-rtl-barriers
5156 @opindex fdump-rtl-barriers
5157 Dump after cleaning up the barrier instructions.
5159 @item -fdump-rtl-bbpart
5160 @opindex fdump-rtl-bbpart
5161 Dump after partitioning hot and cold basic blocks.
5163 @item -fdump-rtl-bbro
5164 @opindex fdump-rtl-bbro
5165 Dump after block reordering.
5167 @item -fdump-rtl-btl1
5168 @itemx -fdump-rtl-btl2
5169 @opindex fdump-rtl-btl2
5170 @opindex fdump-rtl-btl2
5171 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5172 after the two branch
5173 target load optimization passes.
5175 @item -fdump-rtl-bypass
5176 @opindex fdump-rtl-bypass
5177 Dump after jump bypassing and control flow optimizations.
5179 @item -fdump-rtl-combine
5180 @opindex fdump-rtl-combine
5181 Dump after the RTL instruction combination pass.
5183 @item -fdump-rtl-compgotos
5184 @opindex fdump-rtl-compgotos
5185 Dump after duplicating the computed gotos.
5187 @item -fdump-rtl-ce1
5188 @itemx -fdump-rtl-ce2
5189 @itemx -fdump-rtl-ce3
5190 @opindex fdump-rtl-ce1
5191 @opindex fdump-rtl-ce2
5192 @opindex fdump-rtl-ce3
5193 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5194 @option{-fdump-rtl-ce3} enable dumping after the three
5195 if conversion passes.
5197 @itemx -fdump-rtl-cprop_hardreg
5198 @opindex fdump-rtl-cprop_hardreg
5199 Dump after hard register copy propagation.
5201 @itemx -fdump-rtl-csa
5202 @opindex fdump-rtl-csa
5203 Dump after combining stack adjustments.
5205 @item -fdump-rtl-cse1
5206 @itemx -fdump-rtl-cse2
5207 @opindex fdump-rtl-cse1
5208 @opindex fdump-rtl-cse2
5209 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5210 the two common sub-expression elimination passes.
5212 @itemx -fdump-rtl-dce
5213 @opindex fdump-rtl-dce
5214 Dump after the standalone dead code elimination passes.
5216 @itemx -fdump-rtl-dbr
5217 @opindex fdump-rtl-dbr
5218 Dump after delayed branch scheduling.
5220 @item -fdump-rtl-dce1
5221 @itemx -fdump-rtl-dce2
5222 @opindex fdump-rtl-dce1
5223 @opindex fdump-rtl-dce2
5224 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5225 the two dead store elimination passes.
5227 @item -fdump-rtl-eh
5228 @opindex fdump-rtl-eh
5229 Dump after finalization of EH handling code.
5231 @item -fdump-rtl-eh_ranges
5232 @opindex fdump-rtl-eh_ranges
5233 Dump after conversion of EH handling range regions.
5235 @item -fdump-rtl-expand
5236 @opindex fdump-rtl-expand
5237 Dump after RTL generation.
5239 @item -fdump-rtl-fwprop1
5240 @itemx -fdump-rtl-fwprop2
5241 @opindex fdump-rtl-fwprop1
5242 @opindex fdump-rtl-fwprop2
5243 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5244 dumping after the two forward propagation passes.
5246 @item -fdump-rtl-gcse1
5247 @itemx -fdump-rtl-gcse2
5248 @opindex fdump-rtl-gcse1
5249 @opindex fdump-rtl-gcse2
5250 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5251 after global common subexpression elimination.
5253 @item -fdump-rtl-init-regs
5254 @opindex fdump-rtl-init-regs
5255 Dump after the initialization of the registers.
5257 @item -fdump-rtl-initvals
5258 @opindex fdump-rtl-initvals
5259 Dump after the computation of the initial value sets.
5261 @itemx -fdump-rtl-into_cfglayout
5262 @opindex fdump-rtl-into_cfglayout
5263 Dump after converting to cfglayout mode.
5265 @item -fdump-rtl-ira
5266 @opindex fdump-rtl-ira
5267 Dump after iterated register allocation.
5269 @item -fdump-rtl-jump
5270 @opindex fdump-rtl-jump
5271 Dump after the second jump optimization.
5273 @item -fdump-rtl-loop2
5274 @opindex fdump-rtl-loop2
5275 @option{-fdump-rtl-loop2} enables dumping after the rtl
5276 loop optimization passes.
5278 @item -fdump-rtl-mach
5279 @opindex fdump-rtl-mach
5280 Dump after performing the machine dependent reorganization pass, if that
5281 pass exists.
5283 @item -fdump-rtl-mode_sw
5284 @opindex fdump-rtl-mode_sw
5285 Dump after removing redundant mode switches.
5287 @item -fdump-rtl-rnreg
5288 @opindex fdump-rtl-rnreg
5289 Dump after register renumbering.
5291 @itemx -fdump-rtl-outof_cfglayout
5292 @opindex fdump-rtl-outof_cfglayout
5293 Dump after converting from cfglayout mode.
5295 @item -fdump-rtl-peephole2
5296 @opindex fdump-rtl-peephole2
5297 Dump after the peephole pass.
5299 @item -fdump-rtl-postreload
5300 @opindex fdump-rtl-postreload
5301 Dump after post-reload optimizations.
5303 @itemx -fdump-rtl-pro_and_epilogue
5304 @opindex fdump-rtl-pro_and_epilogue
5305 Dump after generating the function pro and epilogues.
5307 @item -fdump-rtl-regmove
5308 @opindex fdump-rtl-regmove
5309 Dump after the register move pass.
5311 @item -fdump-rtl-sched1
5312 @itemx -fdump-rtl-sched2
5313 @opindex fdump-rtl-sched1
5314 @opindex fdump-rtl-sched2
5315 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5316 after the basic block scheduling passes.
5318 @item -fdump-rtl-see
5319 @opindex fdump-rtl-see
5320 Dump after sign extension elimination.
5322 @item -fdump-rtl-seqabstr
5323 @opindex fdump-rtl-seqabstr
5324 Dump after common sequence discovery.
5326 @item -fdump-rtl-shorten
5327 @opindex fdump-rtl-shorten
5328 Dump after shortening branches.
5330 @item -fdump-rtl-sibling
5331 @opindex fdump-rtl-sibling
5332 Dump after sibling call optimizations.
5334 @item -fdump-rtl-split1
5335 @itemx -fdump-rtl-split2
5336 @itemx -fdump-rtl-split3
5337 @itemx -fdump-rtl-split4
5338 @itemx -fdump-rtl-split5
5339 @opindex fdump-rtl-split1
5340 @opindex fdump-rtl-split2
5341 @opindex fdump-rtl-split3
5342 @opindex fdump-rtl-split4
5343 @opindex fdump-rtl-split5
5344 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5345 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5346 @option{-fdump-rtl-split5} enable dumping after five rounds of
5347 instruction splitting.
5349 @item -fdump-rtl-sms
5350 @opindex fdump-rtl-sms
5351 Dump after modulo scheduling.  This pass is only run on some
5352 architectures.
5354 @item -fdump-rtl-stack
5355 @opindex fdump-rtl-stack
5356 Dump after conversion from GCC's "flat register file" registers to the
5357 x87's stack-like registers.  This pass is only run on x86 variants.
5359 @item -fdump-rtl-subreg1
5360 @itemx -fdump-rtl-subreg2
5361 @opindex fdump-rtl-subreg1
5362 @opindex fdump-rtl-subreg2
5363 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5364 the two subreg expansion passes.
5366 @item -fdump-rtl-unshare
5367 @opindex fdump-rtl-unshare
5368 Dump after all rtl has been unshared.
5370 @item -fdump-rtl-vartrack
5371 @opindex fdump-rtl-vartrack
5372 Dump after variable tracking.
5374 @item -fdump-rtl-vregs
5375 @opindex fdump-rtl-vregs
5376 Dump after converting virtual registers to hard registers.
5378 @item -fdump-rtl-web
5379 @opindex fdump-rtl-web
5380 Dump after live range splitting.
5382 @item -fdump-rtl-regclass
5383 @itemx -fdump-rtl-subregs_of_mode_init
5384 @itemx -fdump-rtl-subregs_of_mode_finish
5385 @itemx -fdump-rtl-dfinit
5386 @itemx -fdump-rtl-dfinish
5387 @opindex fdump-rtl-regclass
5388 @opindex fdump-rtl-subregs_of_mode_init
5389 @opindex fdump-rtl-subregs_of_mode_finish
5390 @opindex fdump-rtl-dfinit
5391 @opindex fdump-rtl-dfinish
5392 These dumps are defined but always produce empty files.
5394 @item -fdump-rtl-all
5395 @opindex fdump-rtl-all
5396 Produce all the dumps listed above.
5398 @item -dA
5399 @opindex dA
5400 Annotate the assembler output with miscellaneous debugging information.
5402 @item -dD
5403 @opindex dD
5404 Dump all macro definitions, at the end of preprocessing, in addition to
5405 normal output.
5407 @item -dH
5408 @opindex dH
5409 Produce a core dump whenever an error occurs.
5411 @item -dm
5412 @opindex dm
5413 Print statistics on memory usage, at the end of the run, to
5414 standard error.
5416 @item -dp
5417 @opindex dp
5418 Annotate the assembler output with a comment indicating which
5419 pattern and alternative was used.  The length of each instruction is
5420 also printed.
5422 @item -dP
5423 @opindex dP
5424 Dump the RTL in the assembler output as a comment before each instruction.
5425 Also turns on @option{-dp} annotation.
5427 @item -dv
5428 @opindex dv
5429 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5430 dump a representation of the control flow graph suitable for viewing with VCG
5431 to @file{@var{file}.@var{pass}.vcg}.
5433 @item -dx
5434 @opindex dx
5435 Just generate RTL for a function instead of compiling it.  Usually used
5436 with @option{-fdump-rtl-expand}.
5437 @end table
5439 @item -fdump-noaddr
5440 @opindex fdump-noaddr
5441 When doing debugging dumps, suppress address output.  This makes it more
5442 feasible to use diff on debugging dumps for compiler invocations with
5443 different compiler binaries and/or different
5444 text / bss / data / heap / stack / dso start locations.
5446 @item -fdump-unnumbered
5447 @opindex fdump-unnumbered
5448 When doing debugging dumps, suppress instruction numbers and address output.
5449 This makes it more feasible to use diff on debugging dumps for compiler
5450 invocations with different options, in particular with and without
5451 @option{-g}.
5453 @item -fdump-unnumbered-links
5454 @opindex fdump-unnumbered-links
5455 When doing debugging dumps (see @option{-d} option above), suppress
5456 instruction numbers for the links to the previous and next instructions
5457 in a sequence.
5459 @item -fdump-translation-unit @r{(C++ only)}
5460 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5461 @opindex fdump-translation-unit
5462 Dump a representation of the tree structure for the entire translation
5463 unit to a file.  The file name is made by appending @file{.tu} to the
5464 source file name, and the file is created in the same directory as the
5465 output file.  If the @samp{-@var{options}} form is used, @var{options}
5466 controls the details of the dump as described for the
5467 @option{-fdump-tree} options.
5469 @item -fdump-class-hierarchy @r{(C++ only)}
5470 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5471 @opindex fdump-class-hierarchy
5472 Dump a representation of each class's hierarchy and virtual function
5473 table layout to a file.  The file name is made by appending
5474 @file{.class} to the source file name, and the file is created in the
5475 same directory as the output file.  If the @samp{-@var{options}} form
5476 is used, @var{options} controls the details of the dump as described
5477 for the @option{-fdump-tree} options.
5479 @item -fdump-ipa-@var{switch}
5480 @opindex fdump-ipa
5481 Control the dumping at various stages of inter-procedural analysis
5482 language tree to a file.  The file name is generated by appending a
5483 switch specific suffix to the source file name, and the file is created
5484 in the same directory as the output file.  The following dumps are
5485 possible:
5487 @table @samp
5488 @item all
5489 Enables all inter-procedural analysis dumps.
5491 @item cgraph
5492 Dumps information about call-graph optimization, unused function removal,
5493 and inlining decisions.
5495 @item inline
5496 Dump after function inlining.
5498 @end table
5500 @item -fdump-passes
5501 @opindex fdump-passes
5502 Dump the list of optimization passes that are turned on and off by
5503 the current command line options.
5505 @item -fdump-statistics-@var{option}
5506 @opindex fdump-statistics
5507 Enable and control dumping of pass statistics in a separate file.  The
5508 file name is generated by appending a suffix ending in
5509 @samp{.statistics} to the source file name, and the file is created in
5510 the same directory as the output file.  If the @samp{-@var{option}}
5511 form is used, @samp{-stats} will cause counters to be summed over the
5512 whole compilation unit while @samp{-details} will dump every event as
5513 the passes generate them.  The default with no option is to sum
5514 counters for each function compiled.
5516 @item -fdump-tree-@var{switch}
5517 @itemx -fdump-tree-@var{switch}-@var{options}
5518 @opindex fdump-tree
5519 Control the dumping at various stages of processing the intermediate
5520 language tree to a file.  The file name is generated by appending a
5521 switch specific suffix to the source file name, and the file is
5522 created in the same directory as the output file.  If the
5523 @samp{-@var{options}} form is used, @var{options} is a list of
5524 @samp{-} separated options that control the details of the dump.  Not
5525 all options are applicable to all dumps, those which are not
5526 meaningful will be ignored.  The following options are available
5528 @table @samp
5529 @item address
5530 Print the address of each node.  Usually this is not meaningful as it
5531 changes according to the environment and source file.  Its primary use
5532 is for tying up a dump file with a debug environment.
5533 @item asmname
5534 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5535 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5536 use working backward from mangled names in the assembly file.
5537 @item slim
5538 Inhibit dumping of members of a scope or body of a function merely
5539 because that scope has been reached.  Only dump such items when they
5540 are directly reachable by some other path.  When dumping pretty-printed
5541 trees, this option inhibits dumping the bodies of control structures.
5542 @item raw
5543 Print a raw representation of the tree.  By default, trees are
5544 pretty-printed into a C-like representation.
5545 @item details
5546 Enable more detailed dumps (not honored by every dump option).
5547 @item stats
5548 Enable dumping various statistics about the pass (not honored by every dump
5549 option).
5550 @item blocks
5551 Enable showing basic block boundaries (disabled in raw dumps).
5552 @item vops
5553 Enable showing virtual operands for every statement.
5554 @item lineno
5555 Enable showing line numbers for statements.
5556 @item uid
5557 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5558 @item verbose
5559 Enable showing the tree dump for each statement.
5560 @item eh
5561 Enable showing the EH region number holding each statement.
5562 @item all
5563 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5564 and @option{lineno}.
5565 @end table
5567 The following tree dumps are possible:
5568 @table @samp
5570 @item original
5571 @opindex fdump-tree-original
5572 Dump before any tree based optimization, to @file{@var{file}.original}.
5574 @item optimized
5575 @opindex fdump-tree-optimized
5576 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5578 @item gimple
5579 @opindex fdump-tree-gimple
5580 Dump each function before and after the gimplification pass to a file.  The
5581 file name is made by appending @file{.gimple} to the source file name.
5583 @item cfg
5584 @opindex fdump-tree-cfg
5585 Dump the control flow graph of each function to a file.  The file name is
5586 made by appending @file{.cfg} to the source file name.
5588 @item vcg
5589 @opindex fdump-tree-vcg
5590 Dump the control flow graph of each function to a file in VCG format.  The
5591 file name is made by appending @file{.vcg} to the source file name.  Note
5592 that if the file contains more than one function, the generated file cannot
5593 be used directly by VCG@.  You will need to cut and paste each function's
5594 graph into its own separate file first.
5596 @item ch
5597 @opindex fdump-tree-ch
5598 Dump each function after copying loop headers.  The file name is made by
5599 appending @file{.ch} to the source file name.
5601 @item ssa
5602 @opindex fdump-tree-ssa
5603 Dump SSA related information to a file.  The file name is made by appending
5604 @file{.ssa} to the source file name.
5606 @item alias
5607 @opindex fdump-tree-alias
5608 Dump aliasing information for each function.  The file name is made by
5609 appending @file{.alias} to the source file name.
5611 @item ccp
5612 @opindex fdump-tree-ccp
5613 Dump each function after CCP@.  The file name is made by appending
5614 @file{.ccp} to the source file name.
5616 @item storeccp
5617 @opindex fdump-tree-storeccp
5618 Dump each function after STORE-CCP@.  The file name is made by appending
5619 @file{.storeccp} to the source file name.
5621 @item pre
5622 @opindex fdump-tree-pre
5623 Dump trees after partial redundancy elimination.  The file name is made
5624 by appending @file{.pre} to the source file name.
5626 @item fre
5627 @opindex fdump-tree-fre
5628 Dump trees after full redundancy elimination.  The file name is made
5629 by appending @file{.fre} to the source file name.
5631 @item copyprop
5632 @opindex fdump-tree-copyprop
5633 Dump trees after copy propagation.  The file name is made
5634 by appending @file{.copyprop} to the source file name.
5636 @item store_copyprop
5637 @opindex fdump-tree-store_copyprop
5638 Dump trees after store copy-propagation.  The file name is made
5639 by appending @file{.store_copyprop} to the source file name.
5641 @item dce
5642 @opindex fdump-tree-dce
5643 Dump each function after dead code elimination.  The file name is made by
5644 appending @file{.dce} to the source file name.
5646 @item mudflap
5647 @opindex fdump-tree-mudflap
5648 Dump each function after adding mudflap instrumentation.  The file name is
5649 made by appending @file{.mudflap} to the source file name.
5651 @item sra
5652 @opindex fdump-tree-sra
5653 Dump each function after performing scalar replacement of aggregates.  The
5654 file name is made by appending @file{.sra} to the source file name.
5656 @item sink
5657 @opindex fdump-tree-sink
5658 Dump each function after performing code sinking.  The file name is made
5659 by appending @file{.sink} to the source file name.
5661 @item dom
5662 @opindex fdump-tree-dom
5663 Dump each function after applying dominator tree optimizations.  The file
5664 name is made by appending @file{.dom} to the source file name.
5666 @item dse
5667 @opindex fdump-tree-dse
5668 Dump each function after applying dead store elimination.  The file
5669 name is made by appending @file{.dse} to the source file name.
5671 @item phiopt
5672 @opindex fdump-tree-phiopt
5673 Dump each function after optimizing PHI nodes into straightline code.  The file
5674 name is made by appending @file{.phiopt} to the source file name.
5676 @item forwprop
5677 @opindex fdump-tree-forwprop
5678 Dump each function after forward propagating single use variables.  The file
5679 name is made by appending @file{.forwprop} to the source file name.
5681 @item copyrename
5682 @opindex fdump-tree-copyrename
5683 Dump each function after applying the copy rename optimization.  The file
5684 name is made by appending @file{.copyrename} to the source file name.
5686 @item nrv
5687 @opindex fdump-tree-nrv
5688 Dump each function after applying the named return value optimization on
5689 generic trees.  The file name is made by appending @file{.nrv} to the source
5690 file name.
5692 @item vect
5693 @opindex fdump-tree-vect
5694 Dump each function after applying vectorization of loops.  The file name is
5695 made by appending @file{.vect} to the source file name.
5697 @item slp
5698 @opindex fdump-tree-slp
5699 Dump each function after applying vectorization of basic blocks.  The file name
5700 is made by appending @file{.slp} to the source file name.
5702 @item vrp
5703 @opindex fdump-tree-vrp
5704 Dump each function after Value Range Propagation (VRP).  The file name
5705 is made by appending @file{.vrp} to the source file name.
5707 @item all
5708 @opindex fdump-tree-all
5709 Enable all the available tree dumps with the flags provided in this option.
5710 @end table
5712 @item -ftree-vectorizer-verbose=@var{n}
5713 @opindex ftree-vectorizer-verbose
5714 This option controls the amount of debugging output the vectorizer prints.
5715 This information is written to standard error, unless
5716 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5717 in which case it is output to the usual dump listing file, @file{.vect}.
5718 For @var{n}=0 no diagnostic information is reported.
5719 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5720 and the total number of loops that got vectorized.
5721 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5722 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5723 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5724 level that @option{-fdump-tree-vect-stats} uses.
5725 Higher verbosity levels mean either more information dumped for each
5726 reported loop, or same amount of information reported for more loops:
5727 if @var{n}=3, vectorizer cost model information is reported.
5728 If @var{n}=4, alignment related information is added to the reports.
5729 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5730 memory access-patterns) is added to the reports.
5731 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5732 that did not pass the first analysis phase (i.e., may not be countable, or
5733 may have complicated control-flow).
5734 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5735 If @var{n}=8, SLP related information is added to the reports.
5736 For @var{n}=9, all the information the vectorizer generates during its
5737 analysis and transformation is reported.  This is the same verbosity level
5738 that @option{-fdump-tree-vect-details} uses.
5740 @item -frandom-seed=@var{string}
5741 @opindex frandom-seed
5742 This option provides a seed that GCC uses when it would otherwise use
5743 random numbers.  It is used to generate certain symbol names
5744 that have to be different in every compiled file.  It is also used to
5745 place unique stamps in coverage data files and the object files that
5746 produce them.  You can use the @option{-frandom-seed} option to produce
5747 reproducibly identical object files.
5749 The @var{string} should be different for every file you compile.
5751 @item -fsched-verbose=@var{n}
5752 @opindex fsched-verbose
5753 On targets that use instruction scheduling, this option controls the
5754 amount of debugging output the scheduler prints.  This information is
5755 written to standard error, unless @option{-fdump-rtl-sched1} or
5756 @option{-fdump-rtl-sched2} is specified, in which case it is output
5757 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5758 respectively.  However for @var{n} greater than nine, the output is
5759 always printed to standard error.
5761 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5762 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5763 For @var{n} greater than one, it also output basic block probabilities,
5764 detailed ready list information and unit/insn info.  For @var{n} greater
5765 than two, it includes RTL at abort point, control-flow and regions info.
5766 And for @var{n} over four, @option{-fsched-verbose} also includes
5767 dependence info.
5769 @item -save-temps
5770 @itemx -save-temps=cwd
5771 @opindex save-temps
5772 Store the usual ``temporary'' intermediate files permanently; place them
5773 in the current directory and name them based on the source file.  Thus,
5774 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5775 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5776 preprocessed @file{foo.i} output file even though the compiler now
5777 normally uses an integrated preprocessor.
5779 When used in combination with the @option{-x} command line option,
5780 @option{-save-temps} is sensible enough to avoid over writing an
5781 input source file with the same extension as an intermediate file.
5782 The corresponding intermediate file may be obtained by renaming the
5783 source file before using @option{-save-temps}.
5785 If you invoke GCC in parallel, compiling several different source
5786 files that share a common base name in different subdirectories or the
5787 same source file compiled for multiple output destinations, it is
5788 likely that the different parallel compilers will interfere with each
5789 other, and overwrite the temporary files.  For instance:
5791 @smallexample
5792 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5793 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5794 @end smallexample
5796 may result in @file{foo.i} and @file{foo.o} being written to
5797 simultaneously by both compilers.
5799 @item -save-temps=obj
5800 @opindex save-temps=obj
5801 Store the usual ``temporary'' intermediate files permanently.  If the
5802 @option{-o} option is used, the temporary files are based on the
5803 object file.  If the @option{-o} option is not used, the
5804 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5806 For example:
5808 @smallexample
5809 gcc -save-temps=obj -c foo.c
5810 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5811 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5812 @end smallexample
5814 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5815 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5816 @file{dir2/yfoobar.o}.
5818 @item -time@r{[}=@var{file}@r{]}
5819 @opindex time
5820 Report the CPU time taken by each subprocess in the compilation
5821 sequence.  For C source files, this is the compiler proper and assembler
5822 (plus the linker if linking is done).
5824 Without the specification of an output file, the output looks like this:
5826 @smallexample
5827 # cc1 0.12 0.01
5828 # as 0.00 0.01
5829 @end smallexample
5831 The first number on each line is the ``user time'', that is time spent
5832 executing the program itself.  The second number is ``system time'',
5833 time spent executing operating system routines on behalf of the program.
5834 Both numbers are in seconds.
5836 With the specification of an output file, the output is appended to the
5837 named file, and it looks like this:
5839 @smallexample
5840 0.12 0.01 cc1 @var{options}
5841 0.00 0.01 as @var{options}
5842 @end smallexample
5844 The ``user time'' and the ``system time'' are moved before the program
5845 name, and the options passed to the program are displayed, so that one
5846 can later tell what file was being compiled, and with which options.
5848 @item -fvar-tracking
5849 @opindex fvar-tracking
5850 Run variable tracking pass.  It computes where variables are stored at each
5851 position in code.  Better debugging information is then generated
5852 (if the debugging information format supports this information).
5854 It is enabled by default when compiling with optimization (@option{-Os},
5855 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5856 the debug info format supports it.
5858 @item -fvar-tracking-assignments
5859 @opindex fvar-tracking-assignments
5860 @opindex fno-var-tracking-assignments
5861 Annotate assignments to user variables early in the compilation and
5862 attempt to carry the annotations over throughout the compilation all the
5863 way to the end, in an attempt to improve debug information while
5864 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5866 It can be enabled even if var-tracking is disabled, in which case
5867 annotations will be created and maintained, but discarded at the end.
5869 @item -fvar-tracking-assignments-toggle
5870 @opindex fvar-tracking-assignments-toggle
5871 @opindex fno-var-tracking-assignments-toggle
5872 Toggle @option{-fvar-tracking-assignments}, in the same way that
5873 @option{-gtoggle} toggles @option{-g}.
5875 @item -print-file-name=@var{library}
5876 @opindex print-file-name
5877 Print the full absolute name of the library file @var{library} that
5878 would be used when linking---and don't do anything else.  With this
5879 option, GCC does not compile or link anything; it just prints the
5880 file name.
5882 @item -print-multi-directory
5883 @opindex print-multi-directory
5884 Print the directory name corresponding to the multilib selected by any
5885 other switches present in the command line.  This directory is supposed
5886 to exist in @env{GCC_EXEC_PREFIX}.
5888 @item -print-multi-lib
5889 @opindex print-multi-lib
5890 Print the mapping from multilib directory names to compiler switches
5891 that enable them.  The directory name is separated from the switches by
5892 @samp{;}, and each switch starts with an @samp{@@} instead of the
5893 @samp{-}, without spaces between multiple switches.  This is supposed to
5894 ease shell-processing.
5896 @item -print-multi-os-directory
5897 @opindex print-multi-os-directory
5898 Print the path to OS libraries for the selected
5899 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5900 present in the @file{lib} subdirectory and no multilibs are used, this is
5901 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5902 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5903 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5904 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5906 @item -print-prog-name=@var{program}
5907 @opindex print-prog-name
5908 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5910 @item -print-libgcc-file-name
5911 @opindex print-libgcc-file-name
5912 Same as @option{-print-file-name=libgcc.a}.
5914 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5915 but you do want to link with @file{libgcc.a}.  You can do
5917 @smallexample
5918 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5919 @end smallexample
5921 @item -print-search-dirs
5922 @opindex print-search-dirs
5923 Print the name of the configured installation directory and a list of
5924 program and library directories @command{gcc} will search---and don't do anything else.
5926 This is useful when @command{gcc} prints the error message
5927 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5928 To resolve this you either need to put @file{cpp0} and the other compiler
5929 components where @command{gcc} expects to find them, or you can set the environment
5930 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5931 Don't forget the trailing @samp{/}.
5932 @xref{Environment Variables}.
5934 @item -print-sysroot
5935 @opindex print-sysroot
5936 Print the target sysroot directory that will be used during
5937 compilation.  This is the target sysroot specified either at configure
5938 time or using the @option{--sysroot} option, possibly with an extra
5939 suffix that depends on compilation options.  If no target sysroot is
5940 specified, the option prints nothing.
5942 @item -print-sysroot-headers-suffix
5943 @opindex print-sysroot-headers-suffix
5944 Print the suffix added to the target sysroot when searching for
5945 headers, or give an error if the compiler is not configured with such
5946 a suffix---and don't do anything else.
5948 @item -dumpmachine
5949 @opindex dumpmachine
5950 Print the compiler's target machine (for example,
5951 @samp{i686-pc-linux-gnu})---and don't do anything else.
5953 @item -dumpversion
5954 @opindex dumpversion
5955 Print the compiler version (for example, @samp{3.0})---and don't do
5956 anything else.
5958 @item -dumpspecs
5959 @opindex dumpspecs
5960 Print the compiler's built-in specs---and don't do anything else.  (This
5961 is used when GCC itself is being built.)  @xref{Spec Files}.
5963 @item -feliminate-unused-debug-types
5964 @opindex feliminate-unused-debug-types
5965 Normally, when producing DWARF2 output, GCC will emit debugging
5966 information for all types declared in a compilation
5967 unit, regardless of whether or not they are actually used
5968 in that compilation unit.  Sometimes this is useful, such as
5969 if, in the debugger, you want to cast a value to a type that is
5970 not actually used in your program (but is declared).  More often,
5971 however, this results in a significant amount of wasted space.
5972 With this option, GCC will avoid producing debug symbol output
5973 for types that are nowhere used in the source file being compiled.
5974 @end table
5976 @node Optimize Options
5977 @section Options That Control Optimization
5978 @cindex optimize options
5979 @cindex options, optimization
5981 These options control various sorts of optimizations.
5983 Without any optimization option, the compiler's goal is to reduce the
5984 cost of compilation and to make debugging produce the expected
5985 results.  Statements are independent: if you stop the program with a
5986 breakpoint between statements, you can then assign a new value to any
5987 variable or change the program counter to any other statement in the
5988 function and get exactly the results you would expect from the source
5989 code.
5991 Turning on optimization flags makes the compiler attempt to improve
5992 the performance and/or code size at the expense of compilation time
5993 and possibly the ability to debug the program.
5995 The compiler performs optimization based on the knowledge it has of the
5996 program.  Compiling multiple files at once to a single output file mode allows
5997 the compiler to use information gained from all of the files when compiling
5998 each of them.
6000 Not all optimizations are controlled directly by a flag.  Only
6001 optimizations that have a flag are listed in this section.
6003 Most optimizations are only enabled if an @option{-O} level is set on
6004 the command line.  Otherwise they are disabled, even if individual
6005 optimization flags are specified.
6007 Depending on the target and how GCC was configured, a slightly different
6008 set of optimizations may be enabled at each @option{-O} level than
6009 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
6010 to find out the exact set of optimizations that are enabled at each level.
6011 @xref{Overall Options}, for examples.
6013 @table @gcctabopt
6014 @item -O
6015 @itemx -O1
6016 @opindex O
6017 @opindex O1
6018 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6019 more memory for a large function.
6021 With @option{-O}, the compiler tries to reduce code size and execution
6022 time, without performing any optimizations that take a great deal of
6023 compilation time.
6025 @option{-O} turns on the following optimization flags:
6026 @gccoptlist{
6027 -fauto-inc-dec @gol
6028 -fcompare-elim @gol
6029 -fcprop-registers @gol
6030 -fdce @gol
6031 -fdefer-pop @gol
6032 -fdelayed-branch @gol
6033 -fdse @gol
6034 -fguess-branch-probability @gol
6035 -fif-conversion2 @gol
6036 -fif-conversion @gol
6037 -fipa-pure-const @gol
6038 -fipa-profile @gol
6039 -fipa-reference @gol
6040 -fmerge-constants
6041 -fsplit-wide-types @gol
6042 -ftree-bit-ccp @gol
6043 -ftree-builtin-call-dce @gol
6044 -ftree-ccp @gol
6045 -ftree-ch @gol
6046 -ftree-copyrename @gol
6047 -ftree-dce @gol
6048 -ftree-dominator-opts @gol
6049 -ftree-dse @gol
6050 -ftree-forwprop @gol
6051 -ftree-fre @gol
6052 -ftree-phiprop @gol
6053 -ftree-sra @gol
6054 -ftree-pta @gol
6055 -ftree-ter @gol
6056 -funit-at-a-time}
6058 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6059 where doing so does not interfere with debugging.
6061 @item -O2
6062 @opindex O2
6063 Optimize even more.  GCC performs nearly all supported optimizations
6064 that do not involve a space-speed tradeoff.
6065 As compared to @option{-O}, this option increases both compilation time
6066 and the performance of the generated code.
6068 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6069 also turns on the following optimization flags:
6070 @gccoptlist{-fthread-jumps @gol
6071 -falign-functions  -falign-jumps @gol
6072 -falign-loops  -falign-labels @gol
6073 -fcaller-saves @gol
6074 -fcrossjumping @gol
6075 -fcse-follow-jumps  -fcse-skip-blocks @gol
6076 -fdelete-null-pointer-checks @gol
6077 -fdevirtualize @gol
6078 -fexpensive-optimizations @gol
6079 -fgcse  -fgcse-lm  @gol
6080 -finline-small-functions @gol
6081 -findirect-inlining @gol
6082 -fipa-sra @gol
6083 -foptimize-sibling-calls @gol
6084 -fpartial-inlining @gol
6085 -fpeephole2 @gol
6086 -fregmove @gol
6087 -freorder-blocks  -freorder-functions @gol
6088 -frerun-cse-after-loop  @gol
6089 -fsched-interblock  -fsched-spec @gol
6090 -fschedule-insns  -fschedule-insns2 @gol
6091 -fstrict-aliasing -fstrict-overflow @gol
6092 -ftree-switch-conversion @gol
6093 -ftree-pre @gol
6094 -ftree-vrp}
6096 Please note the warning under @option{-fgcse} about
6097 invoking @option{-O2} on programs that use computed gotos.
6099 @item -O3
6100 @opindex O3
6101 Optimize yet more.  @option{-O3} turns on all optimizations specified
6102 by @option{-O2} and also turns on the @option{-finline-functions},
6103 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6104 @option{-fgcse-after-reload}, @option{-ftree-vectorize} and
6105 @option{-fipa-cp-clone} options.
6107 @item -O0
6108 @opindex O0
6109 Reduce compilation time and make debugging produce the expected
6110 results.  This is the default.
6112 @item -Os
6113 @opindex Os
6114 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6115 do not typically increase code size.  It also performs further
6116 optimizations designed to reduce code size.
6118 @option{-Os} disables the following optimization flags:
6119 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6120 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6121 -fprefetch-loop-arrays  -ftree-vect-loop-version}
6123 @item -Ofast
6124 @opindex Ofast
6125 Disregard strict standards compliance.  @option{-Ofast} enables all
6126 @option{-O3} optimizations.  It also enables optimizations that are not
6127 valid for all standard compliant programs.
6128 It turns on @option{-ffast-math} and the Fortran-specific
6129 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6131 If you use multiple @option{-O} options, with or without level numbers,
6132 the last such option is the one that is effective.
6133 @end table
6135 Options of the form @option{-f@var{flag}} specify machine-independent
6136 flags.  Most flags have both positive and negative forms; the negative
6137 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
6138 below, only one of the forms is listed---the one you typically will
6139 use.  You can figure out the other form by either removing @samp{no-}
6140 or adding it.
6142 The following options control specific optimizations.  They are either
6143 activated by @option{-O} options or are related to ones that are.  You
6144 can use the following flags in the rare cases when ``fine-tuning'' of
6145 optimizations to be performed is desired.
6147 @table @gcctabopt
6148 @item -fno-default-inline
6149 @opindex fno-default-inline
6150 Do not make member functions inline by default merely because they are
6151 defined inside the class scope (C++ only).  Otherwise, when you specify
6152 @w{@option{-O}}, member functions defined inside class scope are compiled
6153 inline by default; i.e., you don't need to add @samp{inline} in front of
6154 the member function name.
6156 @item -fno-defer-pop
6157 @opindex fno-defer-pop
6158 Always pop the arguments to each function call as soon as that function
6159 returns.  For machines which must pop arguments after a function call,
6160 the compiler normally lets arguments accumulate on the stack for several
6161 function calls and pops them all at once.
6163 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6165 @item -fforward-propagate
6166 @opindex fforward-propagate
6167 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6168 instructions and checks if the result can be simplified.  If loop unrolling
6169 is active, two passes are performed and the second is scheduled after
6170 loop unrolling.
6172 This option is enabled by default at optimization levels @option{-O},
6173 @option{-O2}, @option{-O3}, @option{-Os}.
6175 @item -ffp-contract=@var{style}
6176 @opindex ffp-contract
6177 @option{-ffp-contract=off} disables floating-point expression contraction.
6178 @option{-ffp-contract=fast} enables floating-point expression contraction
6179 such as forming of fused multiply-add operations if the target has
6180 native support for them.
6181 @option{-ffp-contract=on} enables floating-point expression contraction
6182 if allowed by the language standard.  This is currently not implemented
6183 and treated equal to @option{-ffp-contract=off}.
6185 The default is @option{-ffp-contract=fast}.
6187 @item -fomit-frame-pointer
6188 @opindex fomit-frame-pointer
6189 Don't keep the frame pointer in a register for functions that
6190 don't need one.  This avoids the instructions to save, set up and
6191 restore frame pointers; it also makes an extra register available
6192 in many functions.  @strong{It also makes debugging impossible on
6193 some machines.}
6195 On some machines, such as the VAX, this flag has no effect, because
6196 the standard calling sequence automatically handles the frame pointer
6197 and nothing is saved by pretending it doesn't exist.  The
6198 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6199 whether a target machine supports this flag.  @xref{Registers,,Register
6200 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6202 Starting with GCC version 4.6, the default setting (when not optimizing for
6203 size) for 32-bit Linux x86 and 32-bit Darwin x86 targets has been changed to
6204 @option{-fomit-frame-pointer}.  The default can be reverted to
6205 @option{-fno-omit-frame-pointer} by configuring GCC with the
6206 @option{--enable-frame-pointer} configure option.
6208 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6210 @item -foptimize-sibling-calls
6211 @opindex foptimize-sibling-calls
6212 Optimize sibling and tail recursive calls.
6214 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6216 @item -fno-inline
6217 @opindex fno-inline
6218 Don't pay attention to the @code{inline} keyword.  Normally this option
6219 is used to keep the compiler from expanding any functions inline.
6220 Note that if you are not optimizing, no functions can be expanded inline.
6222 @item -finline-small-functions
6223 @opindex finline-small-functions
6224 Integrate functions into their callers when their body is smaller than expected
6225 function call code (so overall size of program gets smaller).  The compiler
6226 heuristically decides which functions are simple enough to be worth integrating
6227 in this way.
6229 Enabled at level @option{-O2}.
6231 @item -findirect-inlining
6232 @opindex findirect-inlining
6233 Inline also indirect calls that are discovered to be known at compile
6234 time thanks to previous inlining.  This option has any effect only
6235 when inlining itself is turned on by the @option{-finline-functions}
6236 or @option{-finline-small-functions} options.
6238 Enabled at level @option{-O2}.
6240 @item -finline-functions
6241 @opindex finline-functions
6242 Integrate all simple functions into their callers.  The compiler
6243 heuristically decides which functions are simple enough to be worth
6244 integrating in this way.
6246 If all calls to a given function are integrated, and the function is
6247 declared @code{static}, then the function is normally not output as
6248 assembler code in its own right.
6250 Enabled at level @option{-O3}.
6252 @item -finline-functions-called-once
6253 @opindex finline-functions-called-once
6254 Consider all @code{static} functions called once for inlining into their
6255 caller even if they are not marked @code{inline}.  If a call to a given
6256 function is integrated, then the function is not output as assembler code
6257 in its own right.
6259 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6261 @item -fearly-inlining
6262 @opindex fearly-inlining
6263 Inline functions marked by @code{always_inline} and functions whose body seems
6264 smaller than the function call overhead early before doing
6265 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6266 makes profiling significantly cheaper and usually inlining faster on programs
6267 having large chains of nested wrapper functions.
6269 Enabled by default.
6271 @item -fipa-sra
6272 @opindex fipa-sra
6273 Perform interprocedural scalar replacement of aggregates, removal of
6274 unused parameters and replacement of parameters passed by reference
6275 by parameters passed by value.
6277 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6279 @item -finline-limit=@var{n}
6280 @opindex finline-limit
6281 By default, GCC limits the size of functions that can be inlined.  This flag
6282 allows coarse control of this limit.  @var{n} is the size of functions that
6283 can be inlined in number of pseudo instructions.
6285 Inlining is actually controlled by a number of parameters, which may be
6286 specified individually by using @option{--param @var{name}=@var{value}}.
6287 The @option{-finline-limit=@var{n}} option sets some of these parameters
6288 as follows:
6290 @table @gcctabopt
6291 @item max-inline-insns-single
6292 is set to @var{n}/2.
6293 @item max-inline-insns-auto
6294 is set to @var{n}/2.
6295 @end table
6297 See below for a documentation of the individual
6298 parameters controlling inlining and for the defaults of these parameters.
6300 @emph{Note:} there may be no value to @option{-finline-limit} that results
6301 in default behavior.
6303 @emph{Note:} pseudo instruction represents, in this particular context, an
6304 abstract measurement of function's size.  In no way does it represent a count
6305 of assembly instructions and as such its exact meaning might change from one
6306 release to an another.
6308 @item -fno-keep-inline-dllexport
6309 @opindex -fno-keep-inline-dllexport
6310 This is a more fine-grained version of @option{-fkeep-inline-functions},
6311 which applies only to functions that are declared using the @code{dllexport}
6312 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6313 Functions}.)
6315 @item -fkeep-inline-functions
6316 @opindex fkeep-inline-functions
6317 In C, emit @code{static} functions that are declared @code{inline}
6318 into the object file, even if the function has been inlined into all
6319 of its callers.  This switch does not affect functions using the
6320 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6321 inline functions into the object file.
6323 @item -fkeep-static-consts
6324 @opindex fkeep-static-consts
6325 Emit variables declared @code{static const} when optimization isn't turned
6326 on, even if the variables aren't referenced.
6328 GCC enables this option by default.  If you want to force the compiler to
6329 check if the variable was referenced, regardless of whether or not
6330 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6332 @item -fmerge-constants
6333 @opindex fmerge-constants
6334 Attempt to merge identical constants (string constants and floating point
6335 constants) across compilation units.
6337 This option is the default for optimized compilation if the assembler and
6338 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6339 behavior.
6341 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6343 @item -fmerge-all-constants
6344 @opindex fmerge-all-constants
6345 Attempt to merge identical constants and identical variables.
6347 This option implies @option{-fmerge-constants}.  In addition to
6348 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6349 arrays or initialized constant variables with integral or floating point
6350 types.  Languages like C or C++ require each variable, including multiple
6351 instances of the same variable in recursive calls, to have distinct locations,
6352 so using this option will result in non-conforming
6353 behavior.
6355 @item -fmodulo-sched
6356 @opindex fmodulo-sched
6357 Perform swing modulo scheduling immediately before the first scheduling
6358 pass.  This pass looks at innermost loops and reorders their
6359 instructions by overlapping different iterations.
6361 @item -fmodulo-sched-allow-regmoves
6362 @opindex fmodulo-sched-allow-regmoves
6363 Perform more aggressive SMS based modulo scheduling with register moves
6364 allowed.  By setting this flag certain anti-dependences edges will be
6365 deleted which will trigger the generation of reg-moves based on the
6366 life-range analysis.  This option is effective only with
6367 @option{-fmodulo-sched} enabled.
6369 @item -fno-branch-count-reg
6370 @opindex fno-branch-count-reg
6371 Do not use ``decrement and branch'' instructions on a count register,
6372 but instead generate a sequence of instructions that decrement a
6373 register, compare it against zero, then branch based upon the result.
6374 This option is only meaningful on architectures that support such
6375 instructions, which include x86, PowerPC, IA-64 and S/390.
6377 The default is @option{-fbranch-count-reg}.
6379 @item -fno-function-cse
6380 @opindex fno-function-cse
6381 Do not put function addresses in registers; make each instruction that
6382 calls a constant function contain the function's address explicitly.
6384 This option results in less efficient code, but some strange hacks
6385 that alter the assembler output may be confused by the optimizations
6386 performed when this option is not used.
6388 The default is @option{-ffunction-cse}
6390 @item -fno-zero-initialized-in-bss
6391 @opindex fno-zero-initialized-in-bss
6392 If the target supports a BSS section, GCC by default puts variables that
6393 are initialized to zero into BSS@.  This can save space in the resulting
6394 code.
6396 This option turns off this behavior because some programs explicitly
6397 rely on variables going to the data section.  E.g., so that the
6398 resulting executable can find the beginning of that section and/or make
6399 assumptions based on that.
6401 The default is @option{-fzero-initialized-in-bss}.
6403 @item -fmudflap -fmudflapth -fmudflapir
6404 @opindex fmudflap
6405 @opindex fmudflapth
6406 @opindex fmudflapir
6407 @cindex bounds checking
6408 @cindex mudflap
6409 For front-ends that support it (C and C++), instrument all risky
6410 pointer/array dereferencing operations, some standard library
6411 string/heap functions, and some other associated constructs with
6412 range/validity tests.  Modules so instrumented should be immune to
6413 buffer overflows, invalid heap use, and some other classes of C/C++
6414 programming errors.  The instrumentation relies on a separate runtime
6415 library (@file{libmudflap}), which will be linked into a program if
6416 @option{-fmudflap} is given at link time.  Run-time behavior of the
6417 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6418 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6419 for its options.
6421 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6422 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6423 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6424 instrumentation should ignore pointer reads.  This produces less
6425 instrumentation (and therefore faster execution) and still provides
6426 some protection against outright memory corrupting writes, but allows
6427 erroneously read data to propagate within a program.
6429 @item -fthread-jumps
6430 @opindex fthread-jumps
6431 Perform optimizations where we check to see if a jump branches to a
6432 location where another comparison subsumed by the first is found.  If
6433 so, the first branch is redirected to either the destination of the
6434 second branch or a point immediately following it, depending on whether
6435 the condition is known to be true or false.
6437 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6439 @item -fsplit-wide-types
6440 @opindex fsplit-wide-types
6441 When using a type that occupies multiple registers, such as @code{long
6442 long} on a 32-bit system, split the registers apart and allocate them
6443 independently.  This normally generates better code for those types,
6444 but may make debugging more difficult.
6446 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6447 @option{-Os}.
6449 @item -fcse-follow-jumps
6450 @opindex fcse-follow-jumps
6451 In common subexpression elimination (CSE), scan through jump instructions
6452 when the target of the jump is not reached by any other path.  For
6453 example, when CSE encounters an @code{if} statement with an
6454 @code{else} clause, CSE will follow the jump when the condition
6455 tested is false.
6457 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6459 @item -fcse-skip-blocks
6460 @opindex fcse-skip-blocks
6461 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6462 follow jumps which conditionally skip over blocks.  When CSE
6463 encounters a simple @code{if} statement with no else clause,
6464 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6465 body of the @code{if}.
6467 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6469 @item -frerun-cse-after-loop
6470 @opindex frerun-cse-after-loop
6471 Re-run common subexpression elimination after loop optimizations has been
6472 performed.
6474 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6476 @item -fgcse
6477 @opindex fgcse
6478 Perform a global common subexpression elimination pass.
6479 This pass also performs global constant and copy propagation.
6481 @emph{Note:} When compiling a program using computed gotos, a GCC
6482 extension, you may get better runtime performance if you disable
6483 the global common subexpression elimination pass by adding
6484 @option{-fno-gcse} to the command line.
6486 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6488 @item -fgcse-lm
6489 @opindex fgcse-lm
6490 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6491 attempt to move loads which are only killed by stores into themselves.  This
6492 allows a loop containing a load/store sequence to be changed to a load outside
6493 the loop, and a copy/store within the loop.
6495 Enabled by default when gcse is enabled.
6497 @item -fgcse-sm
6498 @opindex fgcse-sm
6499 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6500 global common subexpression elimination.  This pass will attempt to move
6501 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6502 loops containing a load/store sequence can be changed to a load before
6503 the loop and a store after the loop.
6505 Not enabled at any optimization level.
6507 @item -fgcse-las
6508 @opindex fgcse-las
6509 When @option{-fgcse-las} is enabled, the global common subexpression
6510 elimination pass eliminates redundant loads that come after stores to the
6511 same memory location (both partial and full redundancies).
6513 Not enabled at any optimization level.
6515 @item -fgcse-after-reload
6516 @opindex fgcse-after-reload
6517 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6518 pass is performed after reload.  The purpose of this pass is to cleanup
6519 redundant spilling.
6521 @item -funsafe-loop-optimizations
6522 @opindex funsafe-loop-optimizations
6523 If given, the loop optimizer will assume that loop indices do not
6524 overflow, and that the loops with nontrivial exit condition are not
6525 infinite.  This enables a wider range of loop optimizations even if
6526 the loop optimizer itself cannot prove that these assumptions are valid.
6527 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6528 if it finds this kind of loop.
6530 @item -fcrossjumping
6531 @opindex fcrossjumping
6532 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6533 resulting code may or may not perform better than without cross-jumping.
6535 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6537 @item -fauto-inc-dec
6538 @opindex fauto-inc-dec
6539 Combine increments or decrements of addresses with memory accesses.
6540 This pass is always skipped on architectures that do not have
6541 instructions to support this.  Enabled by default at @option{-O} and
6542 higher on architectures that support this.
6544 @item -fdce
6545 @opindex fdce
6546 Perform dead code elimination (DCE) on RTL@.
6547 Enabled by default at @option{-O} and higher.
6549 @item -fdse
6550 @opindex fdse
6551 Perform dead store elimination (DSE) on RTL@.
6552 Enabled by default at @option{-O} and higher.
6554 @item -fif-conversion
6555 @opindex fif-conversion
6556 Attempt to transform conditional jumps into branch-less equivalents.  This
6557 include use of conditional moves, min, max, set flags and abs instructions, and
6558 some tricks doable by standard arithmetics.  The use of conditional execution
6559 on chips where it is available is controlled by @code{if-conversion2}.
6561 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6563 @item -fif-conversion2
6564 @opindex fif-conversion2
6565 Use conditional execution (where available) to transform conditional jumps into
6566 branch-less equivalents.
6568 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6570 @item -fdelete-null-pointer-checks
6571 @opindex fdelete-null-pointer-checks
6572 Assume that programs cannot safely dereference null pointers, and that
6573 no code or data element resides there.  This enables simple constant
6574 folding optimizations at all optimization levels.  In addition, other
6575 optimization passes in GCC use this flag to control global dataflow
6576 analyses that eliminate useless checks for null pointers; these assume
6577 that if a pointer is checked after it has already been dereferenced,
6578 it cannot be null.
6580 Note however that in some environments this assumption is not true.
6581 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6582 for programs which depend on that behavior.
6584 Some targets, especially embedded ones, disable this option at all levels.
6585 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6586 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6587 are enabled independently at different optimization levels.
6589 @item -fdevirtualize
6590 @opindex fdevirtualize
6591 Attempt to convert calls to virtual functions to direct calls.  This
6592 is done both within a procedure and interprocedurally as part of
6593 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
6594 propagation (@option{-fipa-cp}).
6595 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6597 @item -fexpensive-optimizations
6598 @opindex fexpensive-optimizations
6599 Perform a number of minor optimizations that are relatively expensive.
6601 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6603 @item -foptimize-register-move
6604 @itemx -fregmove
6605 @opindex foptimize-register-move
6606 @opindex fregmove
6607 Attempt to reassign register numbers in move instructions and as
6608 operands of other simple instructions in order to maximize the amount of
6609 register tying.  This is especially helpful on machines with two-operand
6610 instructions.
6612 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6613 optimization.
6615 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6617 @item -fira-algorithm=@var{algorithm}
6618 Use specified coloring algorithm for the integrated register
6619 allocator.  The @var{algorithm} argument should be @code{priority} or
6620 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6621 the second one specifies Chaitin-Briggs coloring.  The second
6622 algorithm can be unimplemented for some architectures.  If it is
6623 implemented, it is the default because Chaitin-Briggs coloring as a
6624 rule generates a better code.
6626 @item -fira-region=@var{region}
6627 Use specified regions for the integrated register allocator.  The
6628 @var{region} argument should be one of @code{all}, @code{mixed}, or
6629 @code{one}.  The first value means using all loops as register
6630 allocation regions, the second value which is the default means using
6631 all loops except for loops with small register pressure as the
6632 regions, and third one means using all function as a single region.
6633 The first value can give best result for machines with small size and
6634 irregular register set, the third one results in faster and generates
6635 decent code and the smallest size code, and the default value usually
6636 give the best results in most cases and for most architectures.
6638 @item -fira-loop-pressure
6639 @opindex fira-loop-pressure
6640 Use IRA to evaluate register pressure in loops for decision to move
6641 loop invariants.  Usage of this option usually results in generation
6642 of faster and smaller code on machines with big register files (>= 32
6643 registers) but it can slow compiler down.
6645 This option is enabled at level @option{-O3} for some targets.
6647 @item -fno-ira-share-save-slots
6648 @opindex fno-ira-share-save-slots
6649 Switch off sharing stack slots used for saving call used hard
6650 registers living through a call.  Each hard register will get a
6651 separate stack slot and as a result function stack frame will be
6652 bigger.
6654 @item -fno-ira-share-spill-slots
6655 @opindex fno-ira-share-spill-slots
6656 Switch off sharing stack slots allocated for pseudo-registers.  Each
6657 pseudo-register which did not get a hard register will get a separate
6658 stack slot and as a result function stack frame will be bigger.
6660 @item -fira-verbose=@var{n}
6661 @opindex fira-verbose
6662 Set up how verbose dump file for the integrated register allocator
6663 will be.  Default value is 5.  If the value is greater or equal to 10,
6664 the dump file will be stderr as if the value were @var{n} minus 10.
6666 @item -fdelayed-branch
6667 @opindex fdelayed-branch
6668 If supported for the target machine, attempt to reorder instructions
6669 to exploit instruction slots available after delayed branch
6670 instructions.
6672 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6674 @item -fschedule-insns
6675 @opindex fschedule-insns
6676 If supported for the target machine, attempt to reorder instructions to
6677 eliminate execution stalls due to required data being unavailable.  This
6678 helps machines that have slow floating point or memory load instructions
6679 by allowing other instructions to be issued until the result of the load
6680 or floating point instruction is required.
6682 Enabled at levels @option{-O2}, @option{-O3}.
6684 @item -fschedule-insns2
6685 @opindex fschedule-insns2
6686 Similar to @option{-fschedule-insns}, but requests an additional pass of
6687 instruction scheduling after register allocation has been done.  This is
6688 especially useful on machines with a relatively small number of
6689 registers and where memory load instructions take more than one cycle.
6691 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6693 @item -fno-sched-interblock
6694 @opindex fno-sched-interblock
6695 Don't schedule instructions across basic blocks.  This is normally
6696 enabled by default when scheduling before register allocation, i.e.@:
6697 with @option{-fschedule-insns} or at @option{-O2} or higher.
6699 @item -fno-sched-spec
6700 @opindex fno-sched-spec
6701 Don't allow speculative motion of non-load instructions.  This is normally
6702 enabled by default when scheduling before register allocation, i.e.@:
6703 with @option{-fschedule-insns} or at @option{-O2} or higher.
6705 @item -fsched-pressure
6706 @opindex fsched-pressure
6707 Enable register pressure sensitive insn scheduling before the register
6708 allocation.  This only makes sense when scheduling before register
6709 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6710 @option{-O2} or higher.  Usage of this option can improve the
6711 generated code and decrease its size by preventing register pressure
6712 increase above the number of available hard registers and as a
6713 consequence register spills in the register allocation.
6715 @item -fsched-spec-load
6716 @opindex fsched-spec-load
6717 Allow speculative motion of some load instructions.  This only makes
6718 sense when scheduling before register allocation, i.e.@: with
6719 @option{-fschedule-insns} or at @option{-O2} or higher.
6721 @item -fsched-spec-load-dangerous
6722 @opindex fsched-spec-load-dangerous
6723 Allow speculative motion of more load instructions.  This only makes
6724 sense when scheduling before register allocation, i.e.@: with
6725 @option{-fschedule-insns} or at @option{-O2} or higher.
6727 @item -fsched-stalled-insns
6728 @itemx -fsched-stalled-insns=@var{n}
6729 @opindex fsched-stalled-insns
6730 Define how many insns (if any) can be moved prematurely from the queue
6731 of stalled insns into the ready list, during the second scheduling pass.
6732 @option{-fno-sched-stalled-insns} means that no insns will be moved
6733 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6734 on how many queued insns can be moved prematurely.
6735 @option{-fsched-stalled-insns} without a value is equivalent to
6736 @option{-fsched-stalled-insns=1}.
6738 @item -fsched-stalled-insns-dep
6739 @itemx -fsched-stalled-insns-dep=@var{n}
6740 @opindex fsched-stalled-insns-dep
6741 Define how many insn groups (cycles) will be examined for a dependency
6742 on a stalled insn that is candidate for premature removal from the queue
6743 of stalled insns.  This has an effect only during the second scheduling pass,
6744 and only if @option{-fsched-stalled-insns} is used.
6745 @option{-fno-sched-stalled-insns-dep} is equivalent to
6746 @option{-fsched-stalled-insns-dep=0}.
6747 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6748 @option{-fsched-stalled-insns-dep=1}.
6750 @item -fsched2-use-superblocks
6751 @opindex fsched2-use-superblocks
6752 When scheduling after register allocation, do use superblock scheduling
6753 algorithm.  Superblock scheduling allows motion across basic block boundaries
6754 resulting on faster schedules.  This option is experimental, as not all machine
6755 descriptions used by GCC model the CPU closely enough to avoid unreliable
6756 results from the algorithm.
6758 This only makes sense when scheduling after register allocation, i.e.@: with
6759 @option{-fschedule-insns2} or at @option{-O2} or higher.
6761 @item -fsched-group-heuristic
6762 @opindex fsched-group-heuristic
6763 Enable the group heuristic in the scheduler.  This heuristic favors
6764 the instruction that belongs to a schedule group.  This is enabled
6765 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
6766 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6768 @item -fsched-critical-path-heuristic
6769 @opindex fsched-critical-path-heuristic
6770 Enable the critical-path heuristic in the scheduler.  This heuristic favors
6771 instructions on the critical path.  This is enabled by default when
6772 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
6773 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6775 @item -fsched-spec-insn-heuristic
6776 @opindex fsched-spec-insn-heuristic
6777 Enable the speculative instruction heuristic in the scheduler.  This
6778 heuristic favors speculative instructions with greater dependency weakness.
6779 This is enabled by default when scheduling is enabled, i.e.@:
6780 with @option{-fschedule-insns} or @option{-fschedule-insns2}
6781 or at @option{-O2} or higher.
6783 @item -fsched-rank-heuristic
6784 @opindex fsched-rank-heuristic
6785 Enable the rank heuristic in the scheduler.  This heuristic favors
6786 the instruction belonging to a basic block with greater size or frequency.
6787 This is enabled by default when scheduling is enabled, i.e.@:
6788 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6789 at @option{-O2} or higher.
6791 @item -fsched-last-insn-heuristic
6792 @opindex fsched-last-insn-heuristic
6793 Enable the last-instruction heuristic in the scheduler.  This heuristic
6794 favors the instruction that is less dependent on the last instruction
6795 scheduled.  This is enabled by default when scheduling is enabled,
6796 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6797 at @option{-O2} or higher.
6799 @item -fsched-dep-count-heuristic
6800 @opindex fsched-dep-count-heuristic
6801 Enable the dependent-count heuristic in the scheduler.  This heuristic
6802 favors the instruction that has more instructions depending on it.
6803 This is enabled by default when scheduling is enabled, i.e.@:
6804 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6805 at @option{-O2} or higher.
6807 @item -freschedule-modulo-scheduled-loops
6808 @opindex freschedule-modulo-scheduled-loops
6809 The modulo scheduling comes before the traditional scheduling, if a loop
6810 was modulo scheduled we may want to prevent the later scheduling passes
6811 from changing its schedule, we use this option to control that.
6813 @item -fselective-scheduling
6814 @opindex fselective-scheduling
6815 Schedule instructions using selective scheduling algorithm.  Selective
6816 scheduling runs instead of the first scheduler pass.
6818 @item -fselective-scheduling2
6819 @opindex fselective-scheduling2
6820 Schedule instructions using selective scheduling algorithm.  Selective
6821 scheduling runs instead of the second scheduler pass.
6823 @item -fsel-sched-pipelining
6824 @opindex fsel-sched-pipelining
6825 Enable software pipelining of innermost loops during selective scheduling.
6826 This option has no effect until one of @option{-fselective-scheduling} or
6827 @option{-fselective-scheduling2} is turned on.
6829 @item -fsel-sched-pipelining-outer-loops
6830 @opindex fsel-sched-pipelining-outer-loops
6831 When pipelining loops during selective scheduling, also pipeline outer loops.
6832 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6834 @item -fcaller-saves
6835 @opindex fcaller-saves
6836 Enable values to be allocated in registers that will be clobbered by
6837 function calls, by emitting extra instructions to save and restore the
6838 registers around such calls.  Such allocation is done only when it
6839 seems to result in better code than would otherwise be produced.
6841 This option is always enabled by default on certain machines, usually
6842 those which have no call-preserved registers to use instead.
6844 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6846 @item -fcombine-stack-adjustments
6847 @opindex fcombine-stack-adjustments
6848 Tracks stack adjustments (pushes and pops) and stack memory references
6849 and then tries to find ways to combine them.
6851 Enabled by default at @option{-O1} and higher.
6853 @item -fconserve-stack
6854 @opindex fconserve-stack
6855 Attempt to minimize stack usage.  The compiler will attempt to use less
6856 stack space, even if that makes the program slower.  This option
6857 implies setting the @option{large-stack-frame} parameter to 100
6858 and the @option{large-stack-frame-growth} parameter to 400.
6860 @item -ftree-reassoc
6861 @opindex ftree-reassoc
6862 Perform reassociation on trees.  This flag is enabled by default
6863 at @option{-O} and higher.
6865 @item -ftree-pre
6866 @opindex ftree-pre
6867 Perform partial redundancy elimination (PRE) on trees.  This flag is
6868 enabled by default at @option{-O2} and @option{-O3}.
6870 @item -ftree-forwprop
6871 @opindex ftree-forwprop
6872 Perform forward propagation on trees.  This flag is enabled by default
6873 at @option{-O} and higher.
6875 @item -ftree-fre
6876 @opindex ftree-fre
6877 Perform full redundancy elimination (FRE) on trees.  The difference
6878 between FRE and PRE is that FRE only considers expressions
6879 that are computed on all paths leading to the redundant computation.
6880 This analysis is faster than PRE, though it exposes fewer redundancies.
6881 This flag is enabled by default at @option{-O} and higher.
6883 @item -ftree-phiprop
6884 @opindex ftree-phiprop
6885 Perform hoisting of loads from conditional pointers on trees.  This
6886 pass is enabled by default at @option{-O} and higher.
6888 @item -ftree-copy-prop
6889 @opindex ftree-copy-prop
6890 Perform copy propagation on trees.  This pass eliminates unnecessary
6891 copy operations.  This flag is enabled by default at @option{-O} and
6892 higher.
6894 @item -fipa-pure-const
6895 @opindex fipa-pure-const
6896 Discover which functions are pure or constant.
6897 Enabled by default at @option{-O} and higher.
6899 @item -fipa-reference
6900 @opindex fipa-reference
6901 Discover which static variables do not escape cannot escape the
6902 compilation unit.
6903 Enabled by default at @option{-O} and higher.
6905 @item -fipa-pta
6906 @opindex fipa-pta
6907 Perform interprocedural pointer analysis and interprocedural modification
6908 and reference analysis.  This option can cause excessive memory and
6909 compile-time usage on large compilation units.  It is not enabled by
6910 default at any optimization level.
6912 @item -fipa-profile
6913 @opindex fipa-profile
6914 Perform interprocedural profile propagation.  The functions called only from
6915 cold functions are marked as cold. Also functions executed once (such as
6916 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
6917 functions and loop less parts of functions executed once are then optimized for
6918 size.
6919 Enabled by default at @option{-O} and higher.
6921 @item -fipa-cp
6922 @opindex fipa-cp
6923 Perform interprocedural constant propagation.
6924 This optimization analyzes the program to determine when values passed
6925 to functions are constants and then optimizes accordingly.
6926 This optimization can substantially increase performance
6927 if the application has constants passed to functions.
6928 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6930 @item -fipa-cp-clone
6931 @opindex fipa-cp-clone
6932 Perform function cloning to make interprocedural constant propagation stronger.
6933 When enabled, interprocedural constant propagation will perform function cloning
6934 when externally visible function can be called with constant arguments.
6935 Because this optimization can create multiple copies of functions,
6936 it may significantly increase code size
6937 (see @option{--param ipcp-unit-growth=@var{value}}).
6938 This flag is enabled by default at @option{-O3}.
6940 @item -fipa-matrix-reorg
6941 @opindex fipa-matrix-reorg
6942 Perform matrix flattening and transposing.
6943 Matrix flattening tries to replace an @math{m}-dimensional matrix
6944 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6945 This reduces the level of indirection needed for accessing the elements
6946 of the matrix. The second optimization is matrix transposing that
6947 attempts to change the order of the matrix's dimensions in order to
6948 improve cache locality.
6949 Both optimizations need the @option{-fwhole-program} flag.
6950 Transposing is enabled only if profiling information is available.
6952 @item -ftree-sink
6953 @opindex ftree-sink
6954 Perform forward store motion  on trees.  This flag is
6955 enabled by default at @option{-O} and higher.
6957 @item -ftree-bit-ccp
6958 @opindex ftree-bit-ccp
6959 Perform sparse conditional bit constant propagation on trees and propagate
6960 pointer alignment information.
6961 This pass only operates on local scalar variables and is enabled by default
6962 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
6964 @item -ftree-ccp
6965 @opindex ftree-ccp
6966 Perform sparse conditional constant propagation (CCP) on trees.  This
6967 pass only operates on local scalar variables and is enabled by default
6968 at @option{-O} and higher.
6970 @item -ftree-switch-conversion
6971 Perform conversion of simple initializations in a switch to
6972 initializations from a scalar array.  This flag is enabled by default
6973 at @option{-O2} and higher.
6975 @item -ftree-dce
6976 @opindex ftree-dce
6977 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6978 default at @option{-O} and higher.
6980 @item -ftree-builtin-call-dce
6981 @opindex ftree-builtin-call-dce
6982 Perform conditional dead code elimination (DCE) for calls to builtin functions
6983 that may set @code{errno} but are otherwise side-effect free.  This flag is
6984 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6985 specified.
6987 @item -ftree-dominator-opts
6988 @opindex ftree-dominator-opts
6989 Perform a variety of simple scalar cleanups (constant/copy
6990 propagation, redundancy elimination, range propagation and expression
6991 simplification) based on a dominator tree traversal.  This also
6992 performs jump threading (to reduce jumps to jumps). This flag is
6993 enabled by default at @option{-O} and higher.
6995 @item -ftree-dse
6996 @opindex ftree-dse
6997 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6998 a memory location which will later be overwritten by another store without
6999 any intervening loads.  In this case the earlier store can be deleted.  This
7000 flag is enabled by default at @option{-O} and higher.
7002 @item -ftree-ch
7003 @opindex ftree-ch
7004 Perform loop header copying on trees.  This is beneficial since it increases
7005 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7006 is enabled by default at @option{-O} and higher.  It is not enabled
7007 for @option{-Os}, since it usually increases code size.
7009 @item -ftree-loop-optimize
7010 @opindex ftree-loop-optimize
7011 Perform loop optimizations on trees.  This flag is enabled by default
7012 at @option{-O} and higher.
7014 @item -ftree-loop-linear
7015 @opindex ftree-loop-linear
7016 Perform loop interchange transformations on tree.  Same as
7017 @option{-floop-interchange}.  To use this code transformation, GCC has
7018 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7019 enable the Graphite loop transformation infrastructure.
7021 @item -floop-interchange
7022 @opindex floop-interchange
7023 Perform loop interchange transformations on loops.  Interchanging two
7024 nested loops switches the inner and outer loops.  For example, given a
7025 loop like:
7026 @smallexample
7027 DO J = 1, M
7028   DO I = 1, N
7029     A(J, I) = A(J, I) * C
7030   ENDDO
7031 ENDDO
7032 @end smallexample
7033 loop interchange will transform the loop as if the user had written:
7034 @smallexample
7035 DO I = 1, N
7036   DO J = 1, M
7037     A(J, I) = A(J, I) * C
7038   ENDDO
7039 ENDDO
7040 @end smallexample
7041 which can be beneficial when @code{N} is larger than the caches,
7042 because in Fortran, the elements of an array are stored in memory
7043 contiguously by column, and the original loop iterates over rows,
7044 potentially creating at each access a cache miss.  This optimization
7045 applies to all the languages supported by GCC and is not limited to
7046 Fortran.  To use this code transformation, GCC has to be configured
7047 with @option{--with-ppl} and @option{--with-cloog} to enable the
7048 Graphite loop transformation infrastructure.
7050 @item -floop-strip-mine
7051 @opindex floop-strip-mine
7052 Perform loop strip mining transformations on loops.  Strip mining
7053 splits a loop into two nested loops.  The outer loop has strides
7054 equal to the strip size and the inner loop has strides of the
7055 original loop within a strip.  The strip length can be changed
7056 using the @option{loop-block-tile-size} parameter.  For example,
7057 given a loop like:
7058 @smallexample
7059 DO I = 1, N
7060   A(I) = A(I) + C
7061 ENDDO
7062 @end smallexample
7063 loop strip mining will transform the loop as if the user had written:
7064 @smallexample
7065 DO II = 1, N, 51
7066   DO I = II, min (II + 50, N)
7067     A(I) = A(I) + C
7068   ENDDO
7069 ENDDO
7070 @end smallexample
7071 This optimization applies to all the languages supported by GCC and is
7072 not limited to Fortran.  To use this code transformation, GCC has to
7073 be configured with @option{--with-ppl} and @option{--with-cloog} to
7074 enable the Graphite loop transformation infrastructure.
7076 @item -floop-block
7077 @opindex floop-block
7078 Perform loop blocking transformations on loops.  Blocking strip mines
7079 each loop in the loop nest such that the memory accesses of the
7080 element loops fit inside caches.  The strip length can be changed
7081 using the @option{loop-block-tile-size} parameter.  For example, given
7082 a loop like:
7083 @smallexample
7084 DO I = 1, N
7085   DO J = 1, M
7086     A(J, I) = B(I) + C(J)
7087   ENDDO
7088 ENDDO
7089 @end smallexample
7090 loop blocking will transform the loop as if the user had written:
7091 @smallexample
7092 DO II = 1, N, 51
7093   DO JJ = 1, M, 51
7094     DO I = II, min (II + 50, N)
7095       DO J = JJ, min (JJ + 50, M)
7096         A(J, I) = B(I) + C(J)
7097       ENDDO
7098     ENDDO
7099   ENDDO
7100 ENDDO
7101 @end smallexample
7102 which can be beneficial when @code{M} is larger than the caches,
7103 because the innermost loop will iterate over a smaller amount of data
7104 that can be kept in the caches.  This optimization applies to all the
7105 languages supported by GCC and is not limited to Fortran.  To use this
7106 code transformation, GCC has to be configured with @option{--with-ppl}
7107 and @option{--with-cloog} to enable the Graphite loop transformation
7108 infrastructure.
7110 @item -fgraphite-identity
7111 @opindex fgraphite-identity
7112 Enable the identity transformation for graphite.  For every SCoP we generate
7113 the polyhedral representation and transform it back to gimple.  Using
7114 @option{-fgraphite-identity} we can check the costs or benefits of the
7115 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7116 are also performed by the code generator CLooG, like index splitting and
7117 dead code elimination in loops.
7119 @item -floop-flatten
7120 @opindex floop-flatten
7121 Removes the loop nesting structure: transforms the loop nest into a
7122 single loop.  This transformation can be useful to vectorize all the
7123 levels of the loop nest.
7125 @item -floop-parallelize-all
7126 @opindex floop-parallelize-all
7127 Use the Graphite data dependence analysis to identify loops that can
7128 be parallelized.  Parallelize all the loops that can be analyzed to
7129 not contain loop carried dependences without checking that it is
7130 profitable to parallelize the loops.
7132 @item -fcheck-data-deps
7133 @opindex fcheck-data-deps
7134 Compare the results of several data dependence analyzers.  This option
7135 is used for debugging the data dependence analyzers.
7137 @item -ftree-loop-if-convert
7138 Attempt to transform conditional jumps in the innermost loops to
7139 branch-less equivalents.  The intent is to remove control-flow from
7140 the innermost loops in order to improve the ability of the
7141 vectorization pass to handle these loops.  This is enabled by default
7142 if vectorization is enabled.
7144 @item -ftree-loop-if-convert-stores
7145 Attempt to also if-convert conditional jumps containing memory writes.
7146 This transformation can be unsafe for multi-threaded programs as it
7147 transforms conditional memory writes into unconditional memory writes.
7148 For example,
7149 @smallexample
7150 for (i = 0; i < N; i++)
7151   if (cond)
7152     A[i] = expr;
7153 @end smallexample
7154 would be transformed to
7155 @smallexample
7156 for (i = 0; i < N; i++)
7157   A[i] = cond ? expr : A[i];
7158 @end smallexample
7159 potentially producing data races.
7161 @item -ftree-loop-distribution
7162 Perform loop distribution.  This flag can improve cache performance on
7163 big loop bodies and allow further loop optimizations, like
7164 parallelization or vectorization, to take place.  For example, the loop
7165 @smallexample
7166 DO I = 1, N
7167   A(I) = B(I) + C
7168   D(I) = E(I) * F
7169 ENDDO
7170 @end smallexample
7171 is transformed to
7172 @smallexample
7173 DO I = 1, N
7174    A(I) = B(I) + C
7175 ENDDO
7176 DO I = 1, N
7177    D(I) = E(I) * F
7178 ENDDO
7179 @end smallexample
7181 @item -ftree-loop-distribute-patterns
7182 Perform loop distribution of patterns that can be code generated with
7183 calls to a library.  This flag is enabled by default at @option{-O3}.
7185 This pass distributes the initialization loops and generates a call to
7186 memset zero.  For example, the loop
7187 @smallexample
7188 DO I = 1, N
7189   A(I) = 0
7190   B(I) = A(I) + I
7191 ENDDO
7192 @end smallexample
7193 is transformed to
7194 @smallexample
7195 DO I = 1, N
7196    A(I) = 0
7197 ENDDO
7198 DO I = 1, N
7199    B(I) = A(I) + I
7200 ENDDO
7201 @end smallexample
7202 and the initialization loop is transformed into a call to memset zero.
7204 @item -ftree-loop-im
7205 @opindex ftree-loop-im
7206 Perform loop invariant motion on trees.  This pass moves only invariants that
7207 would be hard to handle at RTL level (function calls, operations that expand to
7208 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7209 operands of conditions that are invariant out of the loop, so that we can use
7210 just trivial invariantness analysis in loop unswitching.  The pass also includes
7211 store motion.
7213 @item -ftree-loop-ivcanon
7214 @opindex ftree-loop-ivcanon
7215 Create a canonical counter for number of iterations in the loop for that
7216 determining number of iterations requires complicated analysis.  Later
7217 optimizations then may determine the number easily.  Useful especially
7218 in connection with unrolling.
7220 @item -fivopts
7221 @opindex fivopts
7222 Perform induction variable optimizations (strength reduction, induction
7223 variable merging and induction variable elimination) on trees.
7225 @item -ftree-parallelize-loops=n
7226 @opindex ftree-parallelize-loops
7227 Parallelize loops, i.e., split their iteration space to run in n threads.
7228 This is only possible for loops whose iterations are independent
7229 and can be arbitrarily reordered.  The optimization is only
7230 profitable on multiprocessor machines, for loops that are CPU-intensive,
7231 rather than constrained e.g.@: by memory bandwidth.  This option
7232 implies @option{-pthread}, and thus is only supported on targets
7233 that have support for @option{-pthread}.
7235 @item -ftree-pta
7236 @opindex ftree-pta
7237 Perform function-local points-to analysis on trees.  This flag is
7238 enabled by default at @option{-O} and higher.
7240 @item -ftree-sra
7241 @opindex ftree-sra
7242 Perform scalar replacement of aggregates.  This pass replaces structure
7243 references with scalars to prevent committing structures to memory too
7244 early.  This flag is enabled by default at @option{-O} and higher.
7246 @item -ftree-copyrename
7247 @opindex ftree-copyrename
7248 Perform copy renaming on trees.  This pass attempts to rename compiler
7249 temporaries to other variables at copy locations, usually resulting in
7250 variable names which more closely resemble the original variables.  This flag
7251 is enabled by default at @option{-O} and higher.
7253 @item -ftree-ter
7254 @opindex ftree-ter
7255 Perform temporary expression replacement during the SSA->normal phase.  Single
7256 use/single def temporaries are replaced at their use location with their
7257 defining expression.  This results in non-GIMPLE code, but gives the expanders
7258 much more complex trees to work on resulting in better RTL generation.  This is
7259 enabled by default at @option{-O} and higher.
7261 @item -ftree-vectorize
7262 @opindex ftree-vectorize
7263 Perform loop vectorization on trees. This flag is enabled by default at
7264 @option{-O3}.
7266 @item -ftree-slp-vectorize
7267 @opindex ftree-slp-vectorize
7268 Perform basic block vectorization on trees. This flag is enabled by default at
7269 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7271 @item -ftree-vect-loop-version
7272 @opindex ftree-vect-loop-version
7273 Perform loop versioning when doing loop vectorization on trees.  When a loop
7274 appears to be vectorizable except that data alignment or data dependence cannot
7275 be determined at compile time then vectorized and non-vectorized versions of
7276 the loop are generated along with runtime checks for alignment or dependence
7277 to control which version is executed.  This option is enabled by default
7278 except at level @option{-Os} where it is disabled.
7280 @item -fvect-cost-model
7281 @opindex fvect-cost-model
7282 Enable cost model for vectorization.
7284 @item -ftree-vrp
7285 @opindex ftree-vrp
7286 Perform Value Range Propagation on trees.  This is similar to the
7287 constant propagation pass, but instead of values, ranges of values are
7288 propagated.  This allows the optimizers to remove unnecessary range
7289 checks like array bound checks and null pointer checks.  This is
7290 enabled by default at @option{-O2} and higher.  Null pointer check
7291 elimination is only done if @option{-fdelete-null-pointer-checks} is
7292 enabled.
7294 @item -ftracer
7295 @opindex ftracer
7296 Perform tail duplication to enlarge superblock size.  This transformation
7297 simplifies the control flow of the function allowing other optimizations to do
7298 better job.
7300 @item -funroll-loops
7301 @opindex funroll-loops
7302 Unroll loops whose number of iterations can be determined at compile
7303 time or upon entry to the loop.  @option{-funroll-loops} implies
7304 @option{-frerun-cse-after-loop}.  This option makes code larger,
7305 and may or may not make it run faster.
7307 @item -funroll-all-loops
7308 @opindex funroll-all-loops
7309 Unroll all loops, even if their number of iterations is uncertain when
7310 the loop is entered.  This usually makes programs run more slowly.
7311 @option{-funroll-all-loops} implies the same options as
7312 @option{-funroll-loops},
7314 @item -fsplit-ivs-in-unroller
7315 @opindex fsplit-ivs-in-unroller
7316 Enables expressing of values of induction variables in later iterations
7317 of the unrolled loop using the value in the first iteration.  This breaks
7318 long dependency chains, thus improving efficiency of the scheduling passes.
7320 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7321 same effect.  However in cases the loop body is more complicated than
7322 a single basic block, this is not reliable.  It also does not work at all
7323 on some of the architectures due to restrictions in the CSE pass.
7325 This optimization is enabled by default.
7327 @item -fvariable-expansion-in-unroller
7328 @opindex fvariable-expansion-in-unroller
7329 With this option, the compiler will create multiple copies of some
7330 local variables when unrolling a loop which can result in superior code.
7332 @item -fpartial-inlining
7333 @opindex fpartial-inlining
7334 Inline parts of functions.  This option has any effect only
7335 when inlining itself is turned on by the @option{-finline-functions}
7336 or @option{-finline-small-functions} options.
7338 Enabled at level @option{-O2}.
7340 @item -fpredictive-commoning
7341 @opindex fpredictive-commoning
7342 Perform predictive commoning optimization, i.e., reusing computations
7343 (especially memory loads and stores) performed in previous
7344 iterations of loops.
7346 This option is enabled at level @option{-O3}.
7348 @item -fprefetch-loop-arrays
7349 @opindex fprefetch-loop-arrays
7350 If supported by the target machine, generate instructions to prefetch
7351 memory to improve the performance of loops that access large arrays.
7353 This option may generate better or worse code; results are highly
7354 dependent on the structure of loops within the source code.
7356 Disabled at level @option{-Os}.
7358 @item -fno-peephole
7359 @itemx -fno-peephole2
7360 @opindex fno-peephole
7361 @opindex fno-peephole2
7362 Disable any machine-specific peephole optimizations.  The difference
7363 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7364 are implemented in the compiler; some targets use one, some use the
7365 other, a few use both.
7367 @option{-fpeephole} is enabled by default.
7368 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7370 @item -fno-guess-branch-probability
7371 @opindex fno-guess-branch-probability
7372 Do not guess branch probabilities using heuristics.
7374 GCC will use heuristics to guess branch probabilities if they are
7375 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7376 heuristics are based on the control flow graph.  If some branch probabilities
7377 are specified by @samp{__builtin_expect}, then the heuristics will be
7378 used to guess branch probabilities for the rest of the control flow graph,
7379 taking the @samp{__builtin_expect} info into account.  The interactions
7380 between the heuristics and @samp{__builtin_expect} can be complex, and in
7381 some cases, it may be useful to disable the heuristics so that the effects
7382 of @samp{__builtin_expect} are easier to understand.
7384 The default is @option{-fguess-branch-probability} at levels
7385 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7387 @item -freorder-blocks
7388 @opindex freorder-blocks
7389 Reorder basic blocks in the compiled function in order to reduce number of
7390 taken branches and improve code locality.
7392 Enabled at levels @option{-O2}, @option{-O3}.
7394 @item -freorder-blocks-and-partition
7395 @opindex freorder-blocks-and-partition
7396 In addition to reordering basic blocks in the compiled function, in order
7397 to reduce number of taken branches, partitions hot and cold basic blocks
7398 into separate sections of the assembly and .o files, to improve
7399 paging and cache locality performance.
7401 This optimization is automatically turned off in the presence of
7402 exception handling, for linkonce sections, for functions with a user-defined
7403 section attribute and on any architecture that does not support named
7404 sections.
7406 @item -freorder-functions
7407 @opindex freorder-functions
7408 Reorder functions in the object file in order to
7409 improve code locality.  This is implemented by using special
7410 subsections @code{.text.hot} for most frequently executed functions and
7411 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7412 the linker so object file format must support named sections and linker must
7413 place them in a reasonable way.
7415 Also profile feedback must be available in to make this option effective.  See
7416 @option{-fprofile-arcs} for details.
7418 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7420 @item -fstrict-aliasing
7421 @opindex fstrict-aliasing
7422 Allow the compiler to assume the strictest aliasing rules applicable to
7423 the language being compiled.  For C (and C++), this activates
7424 optimizations based on the type of expressions.  In particular, an
7425 object of one type is assumed never to reside at the same address as an
7426 object of a different type, unless the types are almost the same.  For
7427 example, an @code{unsigned int} can alias an @code{int}, but not a
7428 @code{void*} or a @code{double}.  A character type may alias any other
7429 type.
7431 @anchor{Type-punning}Pay special attention to code like this:
7432 @smallexample
7433 union a_union @{
7434   int i;
7435   double d;
7438 int f() @{
7439   union a_union t;
7440   t.d = 3.0;
7441   return t.i;
7443 @end smallexample
7444 The practice of reading from a different union member than the one most
7445 recently written to (called ``type-punning'') is common.  Even with
7446 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7447 is accessed through the union type.  So, the code above will work as
7448 expected.  @xref{Structures unions enumerations and bit-fields
7449 implementation}.  However, this code might not:
7450 @smallexample
7451 int f() @{
7452   union a_union t;
7453   int* ip;
7454   t.d = 3.0;
7455   ip = &t.i;
7456   return *ip;
7458 @end smallexample
7460 Similarly, access by taking the address, casting the resulting pointer
7461 and dereferencing the result has undefined behavior, even if the cast
7462 uses a union type, e.g.:
7463 @smallexample
7464 int f() @{
7465   double d = 3.0;
7466   return ((union a_union *) &d)->i;
7468 @end smallexample
7470 The @option{-fstrict-aliasing} option is enabled at levels
7471 @option{-O2}, @option{-O3}, @option{-Os}.
7473 @item -fstrict-overflow
7474 @opindex fstrict-overflow
7475 Allow the compiler to assume strict signed overflow rules, depending
7476 on the language being compiled.  For C (and C++) this means that
7477 overflow when doing arithmetic with signed numbers is undefined, which
7478 means that the compiler may assume that it will not happen.  This
7479 permits various optimizations.  For example, the compiler will assume
7480 that an expression like @code{i + 10 > i} will always be true for
7481 signed @code{i}.  This assumption is only valid if signed overflow is
7482 undefined, as the expression is false if @code{i + 10} overflows when
7483 using twos complement arithmetic.  When this option is in effect any
7484 attempt to determine whether an operation on signed numbers will
7485 overflow must be written carefully to not actually involve overflow.
7487 This option also allows the compiler to assume strict pointer
7488 semantics: given a pointer to an object, if adding an offset to that
7489 pointer does not produce a pointer to the same object, the addition is
7490 undefined.  This permits the compiler to conclude that @code{p + u >
7491 p} is always true for a pointer @code{p} and unsigned integer
7492 @code{u}.  This assumption is only valid because pointer wraparound is
7493 undefined, as the expression is false if @code{p + u} overflows using
7494 twos complement arithmetic.
7496 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7497 that integer signed overflow is fully defined: it wraps.  When
7498 @option{-fwrapv} is used, there is no difference between
7499 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7500 integers.  With @option{-fwrapv} certain types of overflow are
7501 permitted.  For example, if the compiler gets an overflow when doing
7502 arithmetic on constants, the overflowed value can still be used with
7503 @option{-fwrapv}, but not otherwise.
7505 The @option{-fstrict-overflow} option is enabled at levels
7506 @option{-O2}, @option{-O3}, @option{-Os}.
7508 @item -falign-functions
7509 @itemx -falign-functions=@var{n}
7510 @opindex falign-functions
7511 Align the start of functions to the next power-of-two greater than
7512 @var{n}, skipping up to @var{n} bytes.  For instance,
7513 @option{-falign-functions=32} aligns functions to the next 32-byte
7514 boundary, but @option{-falign-functions=24} would align to the next
7515 32-byte boundary only if this can be done by skipping 23 bytes or less.
7517 @option{-fno-align-functions} and @option{-falign-functions=1} are
7518 equivalent and mean that functions will not be aligned.
7520 Some assemblers only support this flag when @var{n} is a power of two;
7521 in that case, it is rounded up.
7523 If @var{n} is not specified or is zero, use a machine-dependent default.
7525 Enabled at levels @option{-O2}, @option{-O3}.
7527 @item -falign-labels
7528 @itemx -falign-labels=@var{n}
7529 @opindex falign-labels
7530 Align all branch targets to a power-of-two boundary, skipping up to
7531 @var{n} bytes like @option{-falign-functions}.  This option can easily
7532 make code slower, because it must insert dummy operations for when the
7533 branch target is reached in the usual flow of the code.
7535 @option{-fno-align-labels} and @option{-falign-labels=1} are
7536 equivalent and mean that labels will not be aligned.
7538 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7539 are greater than this value, then their values are used instead.
7541 If @var{n} is not specified or is zero, use a machine-dependent default
7542 which is very likely to be @samp{1}, meaning no alignment.
7544 Enabled at levels @option{-O2}, @option{-O3}.
7546 @item -falign-loops
7547 @itemx -falign-loops=@var{n}
7548 @opindex falign-loops
7549 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7550 like @option{-falign-functions}.  The hope is that the loop will be
7551 executed many times, which will make up for any execution of the dummy
7552 operations.
7554 @option{-fno-align-loops} and @option{-falign-loops=1} are
7555 equivalent and mean that loops will not be aligned.
7557 If @var{n} is not specified or is zero, use a machine-dependent default.
7559 Enabled at levels @option{-O2}, @option{-O3}.
7561 @item -falign-jumps
7562 @itemx -falign-jumps=@var{n}
7563 @opindex falign-jumps
7564 Align branch targets to a power-of-two boundary, for branch targets
7565 where the targets can only be reached by jumping, skipping up to @var{n}
7566 bytes like @option{-falign-functions}.  In this case, no dummy operations
7567 need be executed.
7569 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7570 equivalent and mean that loops will not be aligned.
7572 If @var{n} is not specified or is zero, use a machine-dependent default.
7574 Enabled at levels @option{-O2}, @option{-O3}.
7576 @item -funit-at-a-time
7577 @opindex funit-at-a-time
7578 This option is left for compatibility reasons. @option{-funit-at-a-time}
7579 has no effect, while @option{-fno-unit-at-a-time} implies
7580 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7582 Enabled by default.
7584 @item -fno-toplevel-reorder
7585 @opindex fno-toplevel-reorder
7586 Do not reorder top-level functions, variables, and @code{asm}
7587 statements.  Output them in the same order that they appear in the
7588 input file.  When this option is used, unreferenced static variables
7589 will not be removed.  This option is intended to support existing code
7590 which relies on a particular ordering.  For new code, it is better to
7591 use attributes.
7593 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7594 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7595 targets.
7597 @item -fweb
7598 @opindex fweb
7599 Constructs webs as commonly used for register allocation purposes and assign
7600 each web individual pseudo register.  This allows the register allocation pass
7601 to operate on pseudos directly, but also strengthens several other optimization
7602 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7603 however, make debugging impossible, since variables will no longer stay in a
7604 ``home register''.
7606 Enabled by default with @option{-funroll-loops}.
7608 @item -fwhole-program
7609 @opindex fwhole-program
7610 Assume that the current compilation unit represents the whole program being
7611 compiled.  All public functions and variables with the exception of @code{main}
7612 and those merged by attribute @code{externally_visible} become static functions
7613 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.
7614 While this option is equivalent to proper use of the @code{static} keyword for
7615 programs consisting of a single file, in combination with option
7616 @option{-flto} this flag can be used to
7617 compile many smaller scale programs since the functions and variables become
7618 local for the whole combined compilation unit, not for the single source file
7619 itself.
7621 This option implies @option{-fwhole-file} for Fortran programs.
7623 @item -flto[=@var{n}]
7624 @opindex flto
7625 This option runs the standard link-time optimizer.  When invoked
7626 with source code, it generates GIMPLE (one of GCC's internal
7627 representations) and writes it to special ELF sections in the object
7628 file.  When the object files are linked together, all the function
7629 bodies are read from these ELF sections and instantiated as if they
7630 had been part of the same translation unit.
7632 To use the link-timer optimizer, @option{-flto} needs to be specified at
7633 compile time and during the final link.  For example,
7635 @smallexample
7636 gcc -c -O2 -flto foo.c
7637 gcc -c -O2 -flto bar.c
7638 gcc -o myprog -flto -O2 foo.o bar.o
7639 @end smallexample
7641 The first two invocations to GCC will save a bytecode representation
7642 of GIMPLE into special ELF sections inside @file{foo.o} and
7643 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7644 @file{foo.o} and @file{bar.o}, merge the two files into a single
7645 internal image, and compile the result as usual.  Since both
7646 @file{foo.o} and @file{bar.o} are merged into a single image, this
7647 causes all the inter-procedural analyses and optimizations in GCC to
7648 work across the two files as if they were a single one.  This means,
7649 for example, that the inliner will be able to inline functions in
7650 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7652 Another (simpler) way to enable link-time optimization is,
7654 @smallexample
7655 gcc -o myprog -flto -O2 foo.c bar.c
7656 @end smallexample
7658 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7659 merge them together into a single GIMPLE representation and optimize
7660 them as usual to produce @file{myprog}.
7662 The only important thing to keep in mind is that to enable link-time
7663 optimizations the @option{-flto} flag needs to be passed to both the
7664 compile and the link commands.
7666 To make whole program optimization effective, it is necessary to make
7667 certain whole program assumptions.  The compiler needs to know
7668 what functions and variables can be accessed by libraries and runtime
7669 outside of the link time optimized unit.  When supported by the linker,
7670 the linker plugin (see @option{-fuse-linker-plugin}) passes to the
7671 compiler information about used and externally visible symbols.  When
7672 the linker plugin is not available, @option{-fwhole-program} should be
7673 used to allow the compiler to make these assumptions, which will lead
7674 to more aggressive optimization decisions.
7676 Note that when a file is compiled with @option{-flto}, the generated
7677 object file will be larger than a regular object file because it will
7678 contain GIMPLE bytecodes and the usual final code.  This means that
7679 object files with LTO information can be linked as a normal object
7680 file.  So, in the previous example, if the final link is done with
7682 @smallexample
7683 gcc -o myprog foo.o bar.o
7684 @end smallexample
7686 The only difference will be that no inter-procedural optimizations
7687 will be applied to produce @file{myprog}.  The two object files
7688 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7689 linker.
7691 Additionally, the optimization flags used to compile individual files
7692 are not necessarily related to those used at link-time.  For instance,
7694 @smallexample
7695 gcc -c -O0 -flto foo.c
7696 gcc -c -O0 -flto bar.c
7697 gcc -o myprog -flto -O3 foo.o bar.o
7698 @end smallexample
7700 This will produce individual object files with unoptimized assembler
7701 code, but the resulting binary @file{myprog} will be optimized at
7702 @option{-O3}.  Now, if the final binary is generated without
7703 @option{-flto}, then @file{myprog} will not be optimized.
7705 When producing the final binary with @option{-flto}, GCC will only
7706 apply link-time optimizations to those files that contain bytecode.
7707 Therefore, you can mix and match object files and libraries with
7708 GIMPLE bytecodes and final object code.  GCC will automatically select
7709 which files to optimize in LTO mode and which files to link without
7710 further processing.
7712 There are some code generation flags that GCC will preserve when
7713 generating bytecodes, as they need to be used during the final link
7714 stage.  Currently, the following options are saved into the GIMPLE
7715 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7716 @option{-m} target flags.
7718 At link time, these options are read-in and reapplied.  Note that the
7719 current implementation makes no attempt at recognizing conflicting
7720 values for these options.  If two or more files have a conflicting
7721 value (e.g., one file is compiled with @option{-fPIC} and another
7722 isn't), the compiler will simply use the last value read from the
7723 bytecode files.  It is recommended, then, that all the files
7724 participating in the same link be compiled with the same options.
7726 Another feature of LTO is that it is possible to apply interprocedural
7727 optimizations on files written in different languages.  This requires
7728 some support in the language front end.  Currently, the C, C++ and
7729 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7730 something like this should work
7732 @smallexample
7733 gcc -c -flto foo.c
7734 g++ -c -flto bar.cc
7735 gfortran -c -flto baz.f90
7736 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7737 @end smallexample
7739 Notice that the final link is done with @command{g++} to get the C++
7740 runtime libraries and @option{-lgfortran} is added to get the Fortran
7741 runtime libraries.  In general, when mixing languages in LTO mode, you
7742 should use the same link command used when mixing languages in a
7743 regular (non-LTO) compilation.  This means that if your build process
7744 was mixing languages before, all you need to add is @option{-flto} to
7745 all the compile and link commands.
7747 If LTO encounters objects with C linkage declared with incompatible
7748 types in separate translation units to be linked together (undefined
7749 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7750 issued.  The behavior is still undefined at runtime.
7752 If object files containing GIMPLE bytecode are stored in a library archive, say
7753 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
7754 are using a linker with linker plugin support.  To enable this feature, use
7755 the flag @option{-fuse-linker-plugin} at link-time:
7757 @smallexample
7758 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7759 @end smallexample
7761 With the linker plugin enabled, the linker will extract the needed
7762 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7763 to make them part of the aggregated GIMPLE image to be optimized.
7765 If you are not using a linker with linker plugin support and/or do not
7766 enable linker plugin then the objects inside @file{libfoo.a}
7767 will be extracted and linked as usual, but they will not participate
7768 in the LTO optimization process.
7770 Link time optimizations do not require the presence of the whole program to
7771 operate.  If the program does not require any symbols to be exported, it is
7772 possible to combine @option{-flto} and with @option{-fwhole-program} to allow
7773 the interprocedural optimizers to use more aggressive assumptions which may
7774 lead to improved optimization opportunities.
7775 Use of @option{-fwhole-program} is not needed when linker plugin is
7776 active (see @option{-fuse-linker-plugin}).
7778 Regarding portability: the current implementation of LTO makes no
7779 attempt at generating bytecode that can be ported between different
7780 types of hosts.  The bytecode files are versioned and there is a
7781 strict version check, so bytecode files generated in one version of
7782 GCC will not work with an older/newer version of GCC.
7784 Link time optimization does not play well with generating debugging
7785 information.  Combining @option{-flto} with
7786 @option{-g} is currently experimental and expected to produce wrong
7787 results.
7789 If you specify the optional @var{n}, the optimization and code
7790 generation done at link time is executed in parallel using @var{n}
7791 parallel jobs by utilizing an installed @command{make} program.  The
7792 environment variable @env{MAKE} may be used to override the program
7793 used.  The default value for @var{n} is 1.
7795 You can also specify @option{-flto=jobserver} to use GNU make's
7796 job server mode to determine the number of parallel jobs. This
7797 is useful when the Makefile calling GCC is already executing in parallel.
7798 The parent Makefile will need a @samp{+} prepended to the command recipe
7799 for this to work. This will likely only work if @env{MAKE} is
7800 GNU make.
7802 This option is disabled by default.
7804 @item -flto-partition=@var{alg}
7805 @opindex flto-partition
7806 Specify the partitioning algorithm used by the link time optimizer.
7807 The value is either @code{1to1} to specify a partitioning mirroring
7808 the original source files or @code{balanced} to specify partitioning
7809 into equally sized chunks (whenever possible).  Specifying @code{none}
7810 as an algorithm disables partitioning and streaming completely. The
7811 default value is @code{balanced}.
7813 @item -flto-compression-level=@var{n}
7814 This option specifies the level of compression used for intermediate
7815 language written to LTO object files, and is only meaningful in
7816 conjunction with LTO mode (@option{-flto}).  Valid
7817 values are 0 (no compression) to 9 (maximum compression).  Values
7818 outside this range are clamped to either 0 or 9.  If the option is not
7819 given, a default balanced compression setting is used.
7821 @item -flto-report
7822 Prints a report with internal details on the workings of the link-time
7823 optimizer.  The contents of this report vary from version to version,
7824 it is meant to be useful to GCC developers when processing object
7825 files in LTO mode (via @option{-flto}).
7827 Disabled by default.
7829 @item -fuse-linker-plugin
7830 Enables the use of a linker plugin during link time optimization.  This
7831 option relies on plugin support in the linker, which is available in gold
7832 or in GNU ld 2.21 or newer.
7834 This option enables the extraction of object files with GIMPLE bytecode out
7835 of library archives. This improves the quality of optimization by exposing
7836 more code to the link time optimizer.  This information specifies what
7837 symbols can be accessed externally (by non-LTO object or during dynamic
7838 linking).  Resulting code quality improvements on binaries (and shared
7839 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
7840 See @option{-flto} for a description of the effect of this flag and how to
7841 use it.
7843 Enabled by default when LTO support in GCC is enabled and GCC was compiled
7844 with a linker supporting plugins (GNU ld 2.21 or newer or gold).
7846 @item -fcompare-elim
7847 @opindex fcompare-elim
7848 After register allocation and post-register allocation instruction splitting,
7849 identify arithmetic instructions that compute processor flags similar to a
7850 comparison operation based on that arithmetic.  If possible, eliminate the
7851 explicit comparison operation.
7853 This pass only applies to certain targets that cannot explicitly represent
7854 the comparison operation before register allocation is complete.
7856 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7858 @item -fcprop-registers
7859 @opindex fcprop-registers
7860 After register allocation and post-register allocation instruction splitting,
7861 we perform a copy-propagation pass to try to reduce scheduling dependencies
7862 and occasionally eliminate the copy.
7864 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7866 @item -fprofile-correction
7867 @opindex fprofile-correction
7868 Profiles collected using an instrumented binary for multi-threaded programs may
7869 be inconsistent due to missed counter updates. When this option is specified,
7870 GCC will use heuristics to correct or smooth out such inconsistencies. By
7871 default, GCC will emit an error message when an inconsistent profile is detected.
7873 @item -fprofile-dir=@var{path}
7874 @opindex fprofile-dir
7876 Set the directory to search for the profile data files in to @var{path}.
7877 This option affects only the profile data generated by
7878 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7879 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7880 and its related options.  Both absolute and relative paths can be used.
7881 By default, GCC will use the current directory as @var{path}, thus the
7882 profile data file will appear in the same directory as the object file.
7884 @item -fprofile-generate
7885 @itemx -fprofile-generate=@var{path}
7886 @opindex fprofile-generate
7888 Enable options usually used for instrumenting application to produce
7889 profile useful for later recompilation with profile feedback based
7890 optimization.  You must use @option{-fprofile-generate} both when
7891 compiling and when linking your program.
7893 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7895 If @var{path} is specified, GCC will look at the @var{path} to find
7896 the profile feedback data files. See @option{-fprofile-dir}.
7898 @item -fprofile-use
7899 @itemx -fprofile-use=@var{path}
7900 @opindex fprofile-use
7901 Enable profile feedback directed optimizations, and optimizations
7902 generally profitable only with profile feedback available.
7904 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7905 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7907 By default, GCC emits an error message if the feedback profiles do not
7908 match the source code.  This error can be turned into a warning by using
7909 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7910 code.
7912 If @var{path} is specified, GCC will look at the @var{path} to find
7913 the profile feedback data files. See @option{-fprofile-dir}.
7914 @end table
7916 The following options control compiler behavior regarding floating
7917 point arithmetic.  These options trade off between speed and
7918 correctness.  All must be specifically enabled.
7920 @table @gcctabopt
7921 @item -ffloat-store
7922 @opindex ffloat-store
7923 Do not store floating point variables in registers, and inhibit other
7924 options that might change whether a floating point value is taken from a
7925 register or memory.
7927 @cindex floating point precision
7928 This option prevents undesirable excess precision on machines such as
7929 the 68000 where the floating registers (of the 68881) keep more
7930 precision than a @code{double} is supposed to have.  Similarly for the
7931 x86 architecture.  For most programs, the excess precision does only
7932 good, but a few programs rely on the precise definition of IEEE floating
7933 point.  Use @option{-ffloat-store} for such programs, after modifying
7934 them to store all pertinent intermediate computations into variables.
7936 @item -fexcess-precision=@var{style}
7937 @opindex fexcess-precision
7938 This option allows further control over excess precision on machines
7939 where floating-point registers have more precision than the IEEE
7940 @code{float} and @code{double} types and the processor does not
7941 support operations rounding to those types.  By default,
7942 @option{-fexcess-precision=fast} is in effect; this means that
7943 operations are carried out in the precision of the registers and that
7944 it is unpredictable when rounding to the types specified in the source
7945 code takes place.  When compiling C, if
7946 @option{-fexcess-precision=standard} is specified then excess
7947 precision will follow the rules specified in ISO C99; in particular,
7948 both casts and assignments cause values to be rounded to their
7949 semantic types (whereas @option{-ffloat-store} only affects
7950 assignments).  This option is enabled by default for C if a strict
7951 conformance option such as @option{-std=c99} is used.
7953 @opindex mfpmath
7954 @option{-fexcess-precision=standard} is not implemented for languages
7955 other than C, and has no effect if
7956 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7957 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7958 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7959 semantics apply without excess precision, and in the latter, rounding
7960 is unpredictable.
7962 @item -ffast-math
7963 @opindex ffast-math
7964 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7965 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7966 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7968 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7970 This option is not turned on by any @option{-O} option besides
7971 @option{-Ofast} since it can result in incorrect output for programs
7972 which depend on an exact implementation of IEEE or ISO rules/specifications
7973 for math functions. It may, however, yield faster code for programs
7974 that do not require the guarantees of these specifications.
7976 @item -fno-math-errno
7977 @opindex fno-math-errno
7978 Do not set ERRNO after calling math functions that are executed
7979 with a single instruction, e.g., sqrt.  A program that relies on
7980 IEEE exceptions for math error handling may want to use this flag
7981 for speed while maintaining IEEE arithmetic compatibility.
7983 This option is not turned on by any @option{-O} option since
7984 it can result in incorrect output for programs which depend on
7985 an exact implementation of IEEE or ISO rules/specifications for
7986 math functions. It may, however, yield faster code for programs
7987 that do not require the guarantees of these specifications.
7989 The default is @option{-fmath-errno}.
7991 On Darwin systems, the math library never sets @code{errno}.  There is
7992 therefore no reason for the compiler to consider the possibility that
7993 it might, and @option{-fno-math-errno} is the default.
7995 @item -funsafe-math-optimizations
7996 @opindex funsafe-math-optimizations
7998 Allow optimizations for floating-point arithmetic that (a) assume
7999 that arguments and results are valid and (b) may violate IEEE or
8000 ANSI standards.  When used at link-time, it may include libraries
8001 or startup files that change the default FPU control word or other
8002 similar optimizations.
8004 This option is not turned on by any @option{-O} option since
8005 it can result in incorrect output for programs which depend on
8006 an exact implementation of IEEE or ISO rules/specifications for
8007 math functions. It may, however, yield faster code for programs
8008 that do not require the guarantees of these specifications.
8009 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8010 @option{-fassociative-math} and @option{-freciprocal-math}.
8012 The default is @option{-fno-unsafe-math-optimizations}.
8014 @item -fassociative-math
8015 @opindex fassociative-math
8017 Allow re-association of operands in series of floating-point operations.
8018 This violates the ISO C and C++ language standard by possibly changing
8019 computation result.  NOTE: re-ordering may change the sign of zero as
8020 well as ignore NaNs and inhibit or create underflow or overflow (and
8021 thus cannot be used on a code which relies on rounding behavior like
8022 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
8023 and thus may not be used when ordered comparisons are required.
8024 This option requires that both @option{-fno-signed-zeros} and
8025 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8026 much sense with @option{-frounding-math}. For Fortran the option
8027 is automatically enabled when both @option{-fno-signed-zeros} and
8028 @option{-fno-trapping-math} are in effect.
8030 The default is @option{-fno-associative-math}.
8032 @item -freciprocal-math
8033 @opindex freciprocal-math
8035 Allow the reciprocal of a value to be used instead of dividing by
8036 the value if this enables optimizations.  For example @code{x / y}
8037 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
8038 is subject to common subexpression elimination.  Note that this loses
8039 precision and increases the number of flops operating on the value.
8041 The default is @option{-fno-reciprocal-math}.
8043 @item -ffinite-math-only
8044 @opindex ffinite-math-only
8045 Allow optimizations for floating-point arithmetic that assume
8046 that arguments and results are not NaNs or +-Infs.
8048 This option is not turned on by any @option{-O} option since
8049 it can result in incorrect output for programs which depend on
8050 an exact implementation of IEEE or ISO rules/specifications for
8051 math functions. It may, however, yield faster code for programs
8052 that do not require the guarantees of these specifications.
8054 The default is @option{-fno-finite-math-only}.
8056 @item -fno-signed-zeros
8057 @opindex fno-signed-zeros
8058 Allow optimizations for floating point arithmetic that ignore the
8059 signedness of zero.  IEEE arithmetic specifies the behavior of
8060 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8061 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8062 This option implies that the sign of a zero result isn't significant.
8064 The default is @option{-fsigned-zeros}.
8066 @item -fno-trapping-math
8067 @opindex fno-trapping-math
8068 Compile code assuming that floating-point operations cannot generate
8069 user-visible traps.  These traps include division by zero, overflow,
8070 underflow, inexact result and invalid operation.  This option requires
8071 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8072 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8074 This option should never be turned on by any @option{-O} option since
8075 it can result in incorrect output for programs which depend on
8076 an exact implementation of IEEE or ISO rules/specifications for
8077 math functions.
8079 The default is @option{-ftrapping-math}.
8081 @item -frounding-math
8082 @opindex frounding-math
8083 Disable transformations and optimizations that assume default floating
8084 point rounding behavior.  This is round-to-zero for all floating point
8085 to integer conversions, and round-to-nearest for all other arithmetic
8086 truncations.  This option should be specified for programs that change
8087 the FP rounding mode dynamically, or that may be executed with a
8088 non-default rounding mode.  This option disables constant folding of
8089 floating point expressions at compile-time (which may be affected by
8090 rounding mode) and arithmetic transformations that are unsafe in the
8091 presence of sign-dependent rounding modes.
8093 The default is @option{-fno-rounding-math}.
8095 This option is experimental and does not currently guarantee to
8096 disable all GCC optimizations that are affected by rounding mode.
8097 Future versions of GCC may provide finer control of this setting
8098 using C99's @code{FENV_ACCESS} pragma.  This command line option
8099 will be used to specify the default state for @code{FENV_ACCESS}.
8101 @item -fsignaling-nans
8102 @opindex fsignaling-nans
8103 Compile code assuming that IEEE signaling NaNs may generate user-visible
8104 traps during floating-point operations.  Setting this option disables
8105 optimizations that may change the number of exceptions visible with
8106 signaling NaNs.  This option implies @option{-ftrapping-math}.
8108 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8109 be defined.
8111 The default is @option{-fno-signaling-nans}.
8113 This option is experimental and does not currently guarantee to
8114 disable all GCC optimizations that affect signaling NaN behavior.
8116 @item -fsingle-precision-constant
8117 @opindex fsingle-precision-constant
8118 Treat floating point constant as single precision constant instead of
8119 implicitly converting it to double precision constant.
8121 @item -fcx-limited-range
8122 @opindex fcx-limited-range
8123 When enabled, this option states that a range reduction step is not
8124 needed when performing complex division.  Also, there is no checking
8125 whether the result of a complex multiplication or division is @code{NaN
8126 + I*NaN}, with an attempt to rescue the situation in that case.  The
8127 default is @option{-fno-cx-limited-range}, but is enabled by
8128 @option{-ffast-math}.
8130 This option controls the default setting of the ISO C99
8131 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8132 all languages.
8134 @item -fcx-fortran-rules
8135 @opindex fcx-fortran-rules
8136 Complex multiplication and division follow Fortran rules.  Range
8137 reduction is done as part of complex division, but there is no checking
8138 whether the result of a complex multiplication or division is @code{NaN
8139 + I*NaN}, with an attempt to rescue the situation in that case.
8141 The default is @option{-fno-cx-fortran-rules}.
8143 @end table
8145 The following options control optimizations that may improve
8146 performance, but are not enabled by any @option{-O} options.  This
8147 section includes experimental options that may produce broken code.
8149 @table @gcctabopt
8150 @item -fbranch-probabilities
8151 @opindex fbranch-probabilities
8152 After running a program compiled with @option{-fprofile-arcs}
8153 (@pxref{Debugging Options,, Options for Debugging Your Program or
8154 @command{gcc}}), you can compile it a second time using
8155 @option{-fbranch-probabilities}, to improve optimizations based on
8156 the number of times each branch was taken.  When the program
8157 compiled with @option{-fprofile-arcs} exits it saves arc execution
8158 counts to a file called @file{@var{sourcename}.gcda} for each source
8159 file.  The information in this data file is very dependent on the
8160 structure of the generated code, so you must use the same source code
8161 and the same optimization options for both compilations.
8163 With @option{-fbranch-probabilities}, GCC puts a
8164 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8165 These can be used to improve optimization.  Currently, they are only
8166 used in one place: in @file{reorg.c}, instead of guessing which path a
8167 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8168 exactly determine which path is taken more often.
8170 @item -fprofile-values
8171 @opindex fprofile-values
8172 If combined with @option{-fprofile-arcs}, it adds code so that some
8173 data about values of expressions in the program is gathered.
8175 With @option{-fbranch-probabilities}, it reads back the data gathered
8176 from profiling values of expressions for usage in optimizations.
8178 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8180 @item -fvpt
8181 @opindex fvpt
8182 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
8183 a code to gather information about values of expressions.
8185 With @option{-fbranch-probabilities}, it reads back the data gathered
8186 and actually performs the optimizations based on them.
8187 Currently the optimizations include specialization of division operation
8188 using the knowledge about the value of the denominator.
8190 @item -frename-registers
8191 @opindex frename-registers
8192 Attempt to avoid false dependencies in scheduled code by making use
8193 of registers left over after register allocation.  This optimization
8194 will most benefit processors with lots of registers.  Depending on the
8195 debug information format adopted by the target, however, it can
8196 make debugging impossible, since variables will no longer stay in
8197 a ``home register''.
8199 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8201 @item -ftracer
8202 @opindex ftracer
8203 Perform tail duplication to enlarge superblock size.  This transformation
8204 simplifies the control flow of the function allowing other optimizations to do
8205 better job.
8207 Enabled with @option{-fprofile-use}.
8209 @item -funroll-loops
8210 @opindex funroll-loops
8211 Unroll loops whose number of iterations can be determined at compile time or
8212 upon entry to the loop.  @option{-funroll-loops} implies
8213 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8214 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8215 small constant number of iterations).  This option makes code larger, and may
8216 or may not make it run faster.
8218 Enabled with @option{-fprofile-use}.
8220 @item -funroll-all-loops
8221 @opindex funroll-all-loops
8222 Unroll all loops, even if their number of iterations is uncertain when
8223 the loop is entered.  This usually makes programs run more slowly.
8224 @option{-funroll-all-loops} implies the same options as
8225 @option{-funroll-loops}.
8227 @item -fpeel-loops
8228 @opindex fpeel-loops
8229 Peels the loops for that there is enough information that they do not
8230 roll much (from profile feedback).  It also turns on complete loop peeling
8231 (i.e.@: complete removal of loops with small constant number of iterations).
8233 Enabled with @option{-fprofile-use}.
8235 @item -fmove-loop-invariants
8236 @opindex fmove-loop-invariants
8237 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8238 at level @option{-O1}
8240 @item -funswitch-loops
8241 @opindex funswitch-loops
8242 Move branches with loop invariant conditions out of the loop, with duplicates
8243 of the loop on both branches (modified according to result of the condition).
8245 @item -ffunction-sections
8246 @itemx -fdata-sections
8247 @opindex ffunction-sections
8248 @opindex fdata-sections
8249 Place each function or data item into its own section in the output
8250 file if the target supports arbitrary sections.  The name of the
8251 function or the name of the data item determines the section's name
8252 in the output file.
8254 Use these options on systems where the linker can perform optimizations
8255 to improve locality of reference in the instruction space.  Most systems
8256 using the ELF object format and SPARC processors running Solaris 2 have
8257 linkers with such optimizations.  AIX may have these optimizations in
8258 the future.
8260 Only use these options when there are significant benefits from doing
8261 so.  When you specify these options, the assembler and linker will
8262 create larger object and executable files and will also be slower.
8263 You will not be able to use @code{gprof} on all systems if you
8264 specify this option and you may have problems with debugging if
8265 you specify both this option and @option{-g}.
8267 @item -fbranch-target-load-optimize
8268 @opindex fbranch-target-load-optimize
8269 Perform branch target register load optimization before prologue / epilogue
8270 threading.
8271 The use of target registers can typically be exposed only during reload,
8272 thus hoisting loads out of loops and doing inter-block scheduling needs
8273 a separate optimization pass.
8275 @item -fbranch-target-load-optimize2
8276 @opindex fbranch-target-load-optimize2
8277 Perform branch target register load optimization after prologue / epilogue
8278 threading.
8280 @item -fbtr-bb-exclusive
8281 @opindex fbtr-bb-exclusive
8282 When performing branch target register load optimization, don't reuse
8283 branch target registers in within any basic block.
8285 @item -fstack-protector
8286 @opindex fstack-protector
8287 Emit extra code to check for buffer overflows, such as stack smashing
8288 attacks.  This is done by adding a guard variable to functions with
8289 vulnerable objects.  This includes functions that call alloca, and
8290 functions with buffers larger than 8 bytes.  The guards are initialized
8291 when a function is entered and then checked when the function exits.
8292 If a guard check fails, an error message is printed and the program exits.
8294 @item -fstack-protector-all
8295 @opindex fstack-protector-all
8296 Like @option{-fstack-protector} except that all functions are protected.
8298 @item -fsection-anchors
8299 @opindex fsection-anchors
8300 Try to reduce the number of symbolic address calculations by using
8301 shared ``anchor'' symbols to address nearby objects.  This transformation
8302 can help to reduce the number of GOT entries and GOT accesses on some
8303 targets.
8305 For example, the implementation of the following function @code{foo}:
8307 @smallexample
8308 static int a, b, c;
8309 int foo (void) @{ return a + b + c; @}
8310 @end smallexample
8312 would usually calculate the addresses of all three variables, but if you
8313 compile it with @option{-fsection-anchors}, it will access the variables
8314 from a common anchor point instead.  The effect is similar to the
8315 following pseudocode (which isn't valid C):
8317 @smallexample
8318 int foo (void)
8320   register int *xr = &x;
8321   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8323 @end smallexample
8325 Not all targets support this option.
8327 @item --param @var{name}=@var{value}
8328 @opindex param
8329 In some places, GCC uses various constants to control the amount of
8330 optimization that is done.  For example, GCC will not inline functions
8331 that contain more that a certain number of instructions.  You can
8332 control some of these constants on the command-line using the
8333 @option{--param} option.
8335 The names of specific parameters, and the meaning of the values, are
8336 tied to the internals of the compiler, and are subject to change
8337 without notice in future releases.
8339 In each case, the @var{value} is an integer.  The allowable choices for
8340 @var{name} are given in the following table:
8342 @table @gcctabopt
8343 @item predictable-branch-outcome
8344 When branch is predicted to be taken with probability lower than this threshold
8345 (in percent), then it is considered well predictable. The default is 10.
8347 @item max-crossjump-edges
8348 The maximum number of incoming edges to consider for crossjumping.
8349 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8350 the number of edges incoming to each block.  Increasing values mean
8351 more aggressive optimization, making the compile time increase with
8352 probably small improvement in executable size.
8354 @item min-crossjump-insns
8355 The minimum number of instructions which must be matched at the end
8356 of two blocks before crossjumping will be performed on them.  This
8357 value is ignored in the case where all instructions in the block being
8358 crossjumped from are matched.  The default value is 5.
8360 @item max-grow-copy-bb-insns
8361 The maximum code size expansion factor when copying basic blocks
8362 instead of jumping.  The expansion is relative to a jump instruction.
8363 The default value is 8.
8365 @item max-goto-duplication-insns
8366 The maximum number of instructions to duplicate to a block that jumps
8367 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8368 passes, GCC factors computed gotos early in the compilation process,
8369 and unfactors them as late as possible.  Only computed jumps at the
8370 end of a basic blocks with no more than max-goto-duplication-insns are
8371 unfactored.  The default value is 8.
8373 @item max-delay-slot-insn-search
8374 The maximum number of instructions to consider when looking for an
8375 instruction to fill a delay slot.  If more than this arbitrary number of
8376 instructions is searched, the time savings from filling the delay slot
8377 will be minimal so stop searching.  Increasing values mean more
8378 aggressive optimization, making the compile time increase with probably
8379 small improvement in executable run time.
8381 @item max-delay-slot-live-search
8382 When trying to fill delay slots, the maximum number of instructions to
8383 consider when searching for a block with valid live register
8384 information.  Increasing this arbitrarily chosen value means more
8385 aggressive optimization, increasing the compile time.  This parameter
8386 should be removed when the delay slot code is rewritten to maintain the
8387 control-flow graph.
8389 @item max-gcse-memory
8390 The approximate maximum amount of memory that will be allocated in
8391 order to perform the global common subexpression elimination
8392 optimization.  If more memory than specified is required, the
8393 optimization will not be done.
8395 @item max-gcse-insertion-ratio
8396 If the ratio of expression insertions to deletions is larger than this value
8397 for any expression, then RTL PRE will insert or remove the expression and thus
8398 leave partially redundant computations in the instruction stream.  The default value is 20.
8400 @item max-pending-list-length
8401 The maximum number of pending dependencies scheduling will allow
8402 before flushing the current state and starting over.  Large functions
8403 with few branches or calls can create excessively large lists which
8404 needlessly consume memory and resources.
8406 @item max-inline-insns-single
8407 Several parameters control the tree inliner used in gcc.
8408 This number sets the maximum number of instructions (counted in GCC's
8409 internal representation) in a single function that the tree inliner
8410 will consider for inlining.  This only affects functions declared
8411 inline and methods implemented in a class declaration (C++).
8412 The default value is 400.
8414 @item max-inline-insns-auto
8415 When you use @option{-finline-functions} (included in @option{-O3}),
8416 a lot of functions that would otherwise not be considered for inlining
8417 by the compiler will be investigated.  To those functions, a different
8418 (more restrictive) limit compared to functions declared inline can
8419 be applied.
8420 The default value is 40.
8422 @item large-function-insns
8423 The limit specifying really large functions.  For functions larger than this
8424 limit after inlining, inlining is constrained by
8425 @option{--param large-function-growth}.  This parameter is useful primarily
8426 to avoid extreme compilation time caused by non-linear algorithms used by the
8427 backend.
8428 The default value is 2700.
8430 @item large-function-growth
8431 Specifies maximal growth of large function caused by inlining in percents.
8432 The default value is 100 which limits large function growth to 2.0 times
8433 the original size.
8435 @item large-unit-insns
8436 The limit specifying large translation unit.  Growth caused by inlining of
8437 units larger than this limit is limited by @option{--param inline-unit-growth}.
8438 For small units this might be too tight (consider unit consisting of function A
8439 that is inline and B that just calls A three time.  If B is small relative to
8440 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8441 large units consisting of small inlineable functions however the overall unit
8442 growth limit is needed to avoid exponential explosion of code size.  Thus for
8443 smaller units, the size is increased to @option{--param large-unit-insns}
8444 before applying @option{--param inline-unit-growth}.  The default is 10000
8446 @item inline-unit-growth
8447 Specifies maximal overall growth of the compilation unit caused by inlining.
8448 The default value is 30 which limits unit growth to 1.3 times the original
8449 size.
8451 @item ipcp-unit-growth
8452 Specifies maximal overall growth of the compilation unit caused by
8453 interprocedural constant propagation.  The default value is 10 which limits
8454 unit growth to 1.1 times the original size.
8456 @item large-stack-frame
8457 The limit specifying large stack frames.  While inlining the algorithm is trying
8458 to not grow past this limit too much.  Default value is 256 bytes.
8460 @item large-stack-frame-growth
8461 Specifies maximal growth of large stack frames caused by inlining in percents.
8462 The default value is 1000 which limits large stack frame growth to 11 times
8463 the original size.
8465 @item max-inline-insns-recursive
8466 @itemx max-inline-insns-recursive-auto
8467 Specifies maximum number of instructions out-of-line copy of self recursive inline
8468 function can grow into by performing recursive inlining.
8470 For functions declared inline @option{--param max-inline-insns-recursive} is
8471 taken into account.  For function not declared inline, recursive inlining
8472 happens only when @option{-finline-functions} (included in @option{-O3}) is
8473 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8474 default value is 450.
8476 @item max-inline-recursive-depth
8477 @itemx max-inline-recursive-depth-auto
8478 Specifies maximum recursion depth used by the recursive inlining.
8480 For functions declared inline @option{--param max-inline-recursive-depth} is
8481 taken into account.  For function not declared inline, recursive inlining
8482 happens only when @option{-finline-functions} (included in @option{-O3}) is
8483 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8484 default value is 8.
8486 @item min-inline-recursive-probability
8487 Recursive inlining is profitable only for function having deep recursion
8488 in average and can hurt for function having little recursion depth by
8489 increasing the prologue size or complexity of function body to other
8490 optimizers.
8492 When profile feedback is available (see @option{-fprofile-generate}) the actual
8493 recursion depth can be guessed from probability that function will recurse via
8494 given call expression.  This parameter limits inlining only to call expression
8495 whose probability exceeds given threshold (in percents).  The default value is
8498 @item early-inlining-insns
8499 Specify growth that early inliner can make.  In effect it increases amount of
8500 inlining for code having large abstraction penalty.  The default value is 10.
8502 @item max-early-inliner-iterations
8503 @itemx max-early-inliner-iterations
8504 Limit of iterations of early inliner.  This basically bounds number of nested
8505 indirect calls early inliner can resolve.  Deeper chains are still handled by
8506 late inlining.
8508 @item comdat-sharing-probability
8509 @itemx comdat-sharing-probability
8510 Probability (in percent) that C++ inline function with comdat visibility
8511 will be shared across multiple compilation units.  The default value is 20.
8513 @item min-vect-loop-bound
8514 The minimum number of iterations under which a loop will not get vectorized
8515 when @option{-ftree-vectorize} is used.  The number of iterations after
8516 vectorization needs to be greater than the value specified by this option
8517 to allow vectorization.  The default value is 0.
8519 @item gcse-cost-distance-ratio
8520 Scaling factor in calculation of maximum distance an expression
8521 can be moved by GCSE optimizations.  This is currently supported only in the
8522 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
8523 will be with simple expressions, i.e., the expressions which have cost
8524 less than @option{gcse-unrestricted-cost}.  Specifying 0 will disable
8525 hoisting of simple expressions.  The default value is 10.
8527 @item gcse-unrestricted-cost
8528 Cost, roughly measured as the cost of a single typical machine
8529 instruction, at which GCSE optimizations will not constrain
8530 the distance an expression can travel.  This is currently
8531 supported only in the code hoisting pass.  The lesser the cost,
8532 the more aggressive code hoisting will be.  Specifying 0 will
8533 allow all expressions to travel unrestricted distances.
8534 The default value is 3.
8536 @item max-hoist-depth
8537 The depth of search in the dominator tree for expressions to hoist.
8538 This is used to avoid quadratic behavior in hoisting algorithm.
8539 The value of 0 will avoid limiting the search, but may slow down compilation
8540 of huge functions.  The default value is 30.
8542 @item max-unrolled-insns
8543 The maximum number of instructions that a loop should have if that loop
8544 is unrolled, and if the loop is unrolled, it determines how many times
8545 the loop code is unrolled.
8547 @item max-average-unrolled-insns
8548 The maximum number of instructions biased by probabilities of their execution
8549 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8550 it determines how many times the loop code is unrolled.
8552 @item max-unroll-times
8553 The maximum number of unrollings of a single loop.
8555 @item max-peeled-insns
8556 The maximum number of instructions that a loop should have if that loop
8557 is peeled, and if the loop is peeled, it determines how many times
8558 the loop code is peeled.
8560 @item max-peel-times
8561 The maximum number of peelings of a single loop.
8563 @item max-completely-peeled-insns
8564 The maximum number of insns of a completely peeled loop.
8566 @item max-completely-peel-times
8567 The maximum number of iterations of a loop to be suitable for complete peeling.
8569 @item max-completely-peel-loop-nest-depth
8570 The maximum depth of a loop nest suitable for complete peeling.
8572 @item max-unswitch-insns
8573 The maximum number of insns of an unswitched loop.
8575 @item max-unswitch-level
8576 The maximum number of branches unswitched in a single loop.
8578 @item lim-expensive
8579 The minimum cost of an expensive expression in the loop invariant motion.
8581 @item iv-consider-all-candidates-bound
8582 Bound on number of candidates for induction variables below that
8583 all candidates are considered for each use in induction variable
8584 optimizations.  Only the most relevant candidates are considered
8585 if there are more candidates, to avoid quadratic time complexity.
8587 @item iv-max-considered-uses
8588 The induction variable optimizations give up on loops that contain more
8589 induction variable uses.
8591 @item iv-always-prune-cand-set-bound
8592 If number of candidates in the set is smaller than this value,
8593 we always try to remove unnecessary ivs from the set during its
8594 optimization when a new iv is added to the set.
8596 @item scev-max-expr-size
8597 Bound on size of expressions used in the scalar evolutions analyzer.
8598 Large expressions slow the analyzer.
8600 @item scev-max-expr-complexity
8601 Bound on the complexity of the expressions in the scalar evolutions analyzer.
8602 Complex expressions slow the analyzer.
8604 @item omega-max-vars
8605 The maximum number of variables in an Omega constraint system.
8606 The default value is 128.
8608 @item omega-max-geqs
8609 The maximum number of inequalities in an Omega constraint system.
8610 The default value is 256.
8612 @item omega-max-eqs
8613 The maximum number of equalities in an Omega constraint system.
8614 The default value is 128.
8616 @item omega-max-wild-cards
8617 The maximum number of wildcard variables that the Omega solver will
8618 be able to insert.  The default value is 18.
8620 @item omega-hash-table-size
8621 The size of the hash table in the Omega solver.  The default value is
8622 550.
8624 @item omega-max-keys
8625 The maximal number of keys used by the Omega solver.  The default
8626 value is 500.
8628 @item omega-eliminate-redundant-constraints
8629 When set to 1, use expensive methods to eliminate all redundant
8630 constraints.  The default value is 0.
8632 @item vect-max-version-for-alignment-checks
8633 The maximum number of runtime checks that can be performed when
8634 doing loop versioning for alignment in the vectorizer.  See option
8635 ftree-vect-loop-version for more information.
8637 @item vect-max-version-for-alias-checks
8638 The maximum number of runtime checks that can be performed when
8639 doing loop versioning for alias in the vectorizer.  See option
8640 ftree-vect-loop-version for more information.
8642 @item max-iterations-to-track
8644 The maximum number of iterations of a loop the brute force algorithm
8645 for analysis of # of iterations of the loop tries to evaluate.
8647 @item hot-bb-count-fraction
8648 Select fraction of the maximal count of repetitions of basic block in program
8649 given basic block needs to have to be considered hot.
8651 @item hot-bb-frequency-fraction
8652 Select fraction of the entry block frequency of executions of basic block in
8653 function given basic block needs to have to be considered hot.
8655 @item max-predicted-iterations
8656 The maximum number of loop iterations we predict statically.  This is useful
8657 in cases where function contain single loop with known bound and other loop
8658 with unknown.  We predict the known number of iterations correctly, while
8659 the unknown number of iterations average to roughly 10.  This means that the
8660 loop without bounds would appear artificially cold relative to the other one.
8662 @item align-threshold
8664 Select fraction of the maximal frequency of executions of basic block in
8665 function given basic block will get aligned.
8667 @item align-loop-iterations
8669 A loop expected to iterate at lest the selected number of iterations will get
8670 aligned.
8672 @item tracer-dynamic-coverage
8673 @itemx tracer-dynamic-coverage-feedback
8675 This value is used to limit superblock formation once the given percentage of
8676 executed instructions is covered.  This limits unnecessary code size
8677 expansion.
8679 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8680 feedback is available.  The real profiles (as opposed to statically estimated
8681 ones) are much less balanced allowing the threshold to be larger value.
8683 @item tracer-max-code-growth
8684 Stop tail duplication once code growth has reached given percentage.  This is
8685 rather hokey argument, as most of the duplicates will be eliminated later in
8686 cross jumping, so it may be set to much higher values than is the desired code
8687 growth.
8689 @item tracer-min-branch-ratio
8691 Stop reverse growth when the reverse probability of best edge is less than this
8692 threshold (in percent).
8694 @item tracer-min-branch-ratio
8695 @itemx tracer-min-branch-ratio-feedback
8697 Stop forward growth if the best edge do have probability lower than this
8698 threshold.
8700 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8701 compilation for profile feedback and one for compilation without.  The value
8702 for compilation with profile feedback needs to be more conservative (higher) in
8703 order to make tracer effective.
8705 @item max-cse-path-length
8707 Maximum number of basic blocks on path that cse considers.  The default is 10.
8709 @item max-cse-insns
8710 The maximum instructions CSE process before flushing. The default is 1000.
8712 @item ggc-min-expand
8714 GCC uses a garbage collector to manage its own memory allocation.  This
8715 parameter specifies the minimum percentage by which the garbage
8716 collector's heap should be allowed to expand between collections.
8717 Tuning this may improve compilation speed; it has no effect on code
8718 generation.
8720 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8721 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8722 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8723 GCC is not able to calculate RAM on a particular platform, the lower
8724 bound of 30% is used.  Setting this parameter and
8725 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8726 every opportunity.  This is extremely slow, but can be useful for
8727 debugging.
8729 @item ggc-min-heapsize
8731 Minimum size of the garbage collector's heap before it begins bothering
8732 to collect garbage.  The first collection occurs after the heap expands
8733 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8734 tuning this may improve compilation speed, and has no effect on code
8735 generation.
8737 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8738 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8739 with a lower bound of 4096 (four megabytes) and an upper bound of
8740 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8741 particular platform, the lower bound is used.  Setting this parameter
8742 very large effectively disables garbage collection.  Setting this
8743 parameter and @option{ggc-min-expand} to zero causes a full collection
8744 to occur at every opportunity.
8746 @item max-reload-search-insns
8747 The maximum number of instruction reload should look backward for equivalent
8748 register.  Increasing values mean more aggressive optimization, making the
8749 compile time increase with probably slightly better performance.  The default
8750 value is 100.
8752 @item max-cselib-memory-locations
8753 The maximum number of memory locations cselib should take into account.
8754 Increasing values mean more aggressive optimization, making the compile time
8755 increase with probably slightly better performance.  The default value is 500.
8757 @item reorder-blocks-duplicate
8758 @itemx reorder-blocks-duplicate-feedback
8760 Used by basic block reordering pass to decide whether to use unconditional
8761 branch or duplicate the code on its destination.  Code is duplicated when its
8762 estimated size is smaller than this value multiplied by the estimated size of
8763 unconditional jump in the hot spots of the program.
8765 The @option{reorder-block-duplicate-feedback} is used only when profile
8766 feedback is available and may be set to higher values than
8767 @option{reorder-block-duplicate} since information about the hot spots is more
8768 accurate.
8770 @item max-sched-ready-insns
8771 The maximum number of instructions ready to be issued the scheduler should
8772 consider at any given time during the first scheduling pass.  Increasing
8773 values mean more thorough searches, making the compilation time increase
8774 with probably little benefit.  The default value is 100.
8776 @item max-sched-region-blocks
8777 The maximum number of blocks in a region to be considered for
8778 interblock scheduling.  The default value is 10.
8780 @item max-pipeline-region-blocks
8781 The maximum number of blocks in a region to be considered for
8782 pipelining in the selective scheduler.  The default value is 15.
8784 @item max-sched-region-insns
8785 The maximum number of insns in a region to be considered for
8786 interblock scheduling.  The default value is 100.
8788 @item max-pipeline-region-insns
8789 The maximum number of insns in a region to be considered for
8790 pipelining in the selective scheduler.  The default value is 200.
8792 @item min-spec-prob
8793 The minimum probability (in percents) of reaching a source block
8794 for interblock speculative scheduling.  The default value is 40.
8796 @item max-sched-extend-regions-iters
8797 The maximum number of iterations through CFG to extend regions.
8798 0 - disable region extension,
8799 N - do at most N iterations.
8800 The default value is 0.
8802 @item max-sched-insn-conflict-delay
8803 The maximum conflict delay for an insn to be considered for speculative motion.
8804 The default value is 3.
8806 @item sched-spec-prob-cutoff
8807 The minimal probability of speculation success (in percents), so that
8808 speculative insn will be scheduled.
8809 The default value is 40.
8811 @item sched-mem-true-dep-cost
8812 Minimal distance (in CPU cycles) between store and load targeting same
8813 memory locations.  The default value is 1.
8815 @item selsched-max-lookahead
8816 The maximum size of the lookahead window of selective scheduling.  It is a
8817 depth of search for available instructions.
8818 The default value is 50.
8820 @item selsched-max-sched-times
8821 The maximum number of times that an instruction will be scheduled during
8822 selective scheduling.  This is the limit on the number of iterations
8823 through which the instruction may be pipelined.  The default value is 2.
8825 @item selsched-max-insns-to-rename
8826 The maximum number of best instructions in the ready list that are considered
8827 for renaming in the selective scheduler.  The default value is 2.
8829 @item sms-min-sc
8830 The minimum value of stage count that swing modulo scheduler will
8831 generate.  The default value is 2.
8833 @item max-last-value-rtl
8834 The maximum size measured as number of RTLs that can be recorded in an expression
8835 in combiner for a pseudo register as last known value of that register.  The default
8836 is 10000.
8838 @item integer-share-limit
8839 Small integer constants can use a shared data structure, reducing the
8840 compiler's memory usage and increasing its speed.  This sets the maximum
8841 value of a shared integer constant.  The default value is 256.
8843 @item min-virtual-mappings
8844 Specifies the minimum number of virtual mappings in the incremental
8845 SSA updater that should be registered to trigger the virtual mappings
8846 heuristic defined by virtual-mappings-ratio.  The default value is
8847 100.
8849 @item virtual-mappings-ratio
8850 If the number of virtual mappings is virtual-mappings-ratio bigger
8851 than the number of virtual symbols to be updated, then the incremental
8852 SSA updater switches to a full update for those symbols.  The default
8853 ratio is 3.
8855 @item ssp-buffer-size
8856 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8857 protection when @option{-fstack-protection} is used.
8859 @item max-jump-thread-duplication-stmts
8860 Maximum number of statements allowed in a block that needs to be
8861 duplicated when threading jumps.
8863 @item max-fields-for-field-sensitive
8864 Maximum number of fields in a structure we will treat in
8865 a field sensitive manner during pointer analysis.  The default is zero
8866 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8868 @item prefetch-latency
8869 Estimate on average number of instructions that are executed before
8870 prefetch finishes.  The distance we prefetch ahead is proportional
8871 to this constant.  Increasing this number may also lead to less
8872 streams being prefetched (see @option{simultaneous-prefetches}).
8874 @item simultaneous-prefetches
8875 Maximum number of prefetches that can run at the same time.
8877 @item l1-cache-line-size
8878 The size of cache line in L1 cache, in bytes.
8880 @item l1-cache-size
8881 The size of L1 cache, in kilobytes.
8883 @item l2-cache-size
8884 The size of L2 cache, in kilobytes.
8886 @item min-insn-to-prefetch-ratio
8887 The minimum ratio between the number of instructions and the
8888 number of prefetches to enable prefetching in a loop.
8890 @item prefetch-min-insn-to-mem-ratio
8891 The minimum ratio between the number of instructions and the
8892 number of memory references to enable prefetching in a loop.
8894 @item use-canonical-types
8895 Whether the compiler should use the ``canonical'' type system.  By
8896 default, this should always be 1, which uses a more efficient internal
8897 mechanism for comparing types in C++ and Objective-C++.  However, if
8898 bugs in the canonical type system are causing compilation failures,
8899 set this value to 0 to disable canonical types.
8901 @item switch-conversion-max-branch-ratio
8902 Switch initialization conversion will refuse to create arrays that are
8903 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8904 branches in the switch.
8906 @item max-partial-antic-length
8907 Maximum length of the partial antic set computed during the tree
8908 partial redundancy elimination optimization (@option{-ftree-pre}) when
8909 optimizing at @option{-O3} and above.  For some sorts of source code
8910 the enhanced partial redundancy elimination optimization can run away,
8911 consuming all of the memory available on the host machine.  This
8912 parameter sets a limit on the length of the sets that are computed,
8913 which prevents the runaway behavior.  Setting a value of 0 for
8914 this parameter will allow an unlimited set length.
8916 @item sccvn-max-scc-size
8917 Maximum size of a strongly connected component (SCC) during SCCVN
8918 processing.  If this limit is hit, SCCVN processing for the whole
8919 function will not be done and optimizations depending on it will
8920 be disabled.  The default maximum SCC size is 10000.
8922 @item ira-max-loops-num
8923 IRA uses a regional register allocation by default.  If a function
8924 contains loops more than number given by the parameter, only at most
8925 given number of the most frequently executed loops will form regions
8926 for the regional register allocation.  The default value of the
8927 parameter is 100.
8929 @item ira-max-conflict-table-size
8930 Although IRA uses a sophisticated algorithm of compression conflict
8931 table, the table can be still big for huge functions.  If the conflict
8932 table for a function could be more than size in MB given by the
8933 parameter, the conflict table is not built and faster, simpler, and
8934 lower quality register allocation algorithm will be used.  The
8935 algorithm do not use pseudo-register conflicts.  The default value of
8936 the parameter is 2000.
8938 @item ira-loop-reserved-regs
8939 IRA can be used to evaluate more accurate register pressure in loops
8940 for decision to move loop invariants (see @option{-O3}).  The number
8941 of available registers reserved for some other purposes is described
8942 by this parameter.  The default value of the parameter is 2 which is
8943 minimal number of registers needed for execution of typical
8944 instruction.  This value is the best found from numerous experiments.
8946 @item loop-invariant-max-bbs-in-loop
8947 Loop invariant motion can be very expensive, both in compile time and
8948 in amount of needed compile time memory, with very large loops.  Loops
8949 with more basic blocks than this parameter won't have loop invariant
8950 motion optimization performed on them.  The default value of the
8951 parameter is 1000 for -O1 and 10000 for -O2 and above.
8953 @item max-vartrack-size
8954 Sets a maximum number of hash table slots to use during variable
8955 tracking dataflow analysis of any function.  If this limit is exceeded
8956 with variable tracking at assignments enabled, analysis for that
8957 function is retried without it, after removing all debug insns from
8958 the function.  If the limit is exceeded even without debug insns, var
8959 tracking analysis is completely disabled for the function.  Setting
8960 the parameter to zero makes it unlimited.
8962 @item max-vartrack-expr-depth
8963 Sets a maximum number of recursion levels when attempting to map
8964 variable names or debug temporaries to value expressions.  This trades
8965 compile time for more complete debug information.  If this is set too
8966 low, value expressions that are available and could be represented in
8967 debug information may end up not being used; setting this higher may
8968 enable the compiler to find more complex debug expressions, but compile
8969 time may grow exponentially, and even then, it may fail to find more
8970 usable expressions.  The default is 10.
8972 @item min-nondebug-insn-uid
8973 Use uids starting at this parameter for nondebug insns.  The range below
8974 the parameter is reserved exclusively for debug insns created by
8975 @option{-fvar-tracking-assignments}, but debug insns may get
8976 (non-overlapping) uids above it if the reserved range is exhausted.
8978 @item ipa-sra-ptr-growth-factor
8979 IPA-SRA will replace a pointer to an aggregate with one or more new
8980 parameters only when their cumulative size is less or equal to
8981 @option{ipa-sra-ptr-growth-factor} times the size of the original
8982 pointer parameter.
8984 @item graphite-max-nb-scop-params
8985 To avoid exponential effects in the Graphite loop transforms, the
8986 number of parameters in a Static Control Part (SCoP) is bounded.  The
8987 default value is 10 parameters.  A variable whose value is unknown at
8988 compile time and defined outside a SCoP is a parameter of the SCoP.
8990 @item graphite-max-bbs-per-function
8991 To avoid exponential effects in the detection of SCoPs, the size of
8992 the functions analyzed by Graphite is bounded.  The default value is
8993 100 basic blocks.
8995 @item loop-block-tile-size
8996 Loop blocking or strip mining transforms, enabled with
8997 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
8998 loop in the loop nest by a given number of iterations.  The strip
8999 length can be changed using the @option{loop-block-tile-size}
9000 parameter.  The default value is 51 iterations.
9002 @item devirt-type-list-size
9003 IPA-CP attempts to track all possible types passed to a function's
9004 parameter in order to perform devirtualization.
9005 @option{devirt-type-list-size} is the maximum number of types it
9006 stores per a single formal parameter of a function.
9008 @item lto-partitions
9009 Specify desired number of partitions produced during WHOPR compilation.
9010 The number of partitions should exceed the number of CPUs used for compilation.
9011 The default value is 32.
9013 @item lto-minpartition
9014 Size of minimal partition for WHOPR (in estimated instructions).
9015 This prevents expenses of splitting very small programs into too many
9016 partitions.
9018 @item cxx-max-namespaces-for-diagnostic-help
9019 The maximum number of namespaces to consult for suggestions when C++
9020 name lookup fails for an identifier.  The default is 1000.
9022 @item max-stores-to-sink
9023 The maximum number of conditional stores paires that can be sunk.  Set to 0
9024 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9025 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9027 @end table
9028 @end table
9030 @node Preprocessor Options
9031 @section Options Controlling the Preprocessor
9032 @cindex preprocessor options
9033 @cindex options, preprocessor
9035 These options control the C preprocessor, which is run on each C source
9036 file before actual compilation.
9038 If you use the @option{-E} option, nothing is done except preprocessing.
9039 Some of these options make sense only together with @option{-E} because
9040 they cause the preprocessor output to be unsuitable for actual
9041 compilation.
9043 @table @gcctabopt
9044 @item -Wp,@var{option}
9045 @opindex Wp
9046 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9047 and pass @var{option} directly through to the preprocessor.  If
9048 @var{option} contains commas, it is split into multiple options at the
9049 commas.  However, many options are modified, translated or interpreted
9050 by the compiler driver before being passed to the preprocessor, and
9051 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9052 interface is undocumented and subject to change, so whenever possible
9053 you should avoid using @option{-Wp} and let the driver handle the
9054 options instead.
9056 @item -Xpreprocessor @var{option}
9057 @opindex Xpreprocessor
9058 Pass @var{option} as an option to the preprocessor.  You can use this to
9059 supply system-specific preprocessor options which GCC does not know how to
9060 recognize.
9062 If you want to pass an option that takes an argument, you must use
9063 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9064 @end table
9066 @include cppopts.texi
9068 @node Assembler Options
9069 @section Passing Options to the Assembler
9071 @c prevent bad page break with this line
9072 You can pass options to the assembler.
9074 @table @gcctabopt
9075 @item -Wa,@var{option}
9076 @opindex Wa
9077 Pass @var{option} as an option to the assembler.  If @var{option}
9078 contains commas, it is split into multiple options at the commas.
9080 @item -Xassembler @var{option}
9081 @opindex Xassembler
9082 Pass @var{option} as an option to the assembler.  You can use this to
9083 supply system-specific assembler options which GCC does not know how to
9084 recognize.
9086 If you want to pass an option that takes an argument, you must use
9087 @option{-Xassembler} twice, once for the option and once for the argument.
9089 @end table
9091 @node Link Options
9092 @section Options for Linking
9093 @cindex link options
9094 @cindex options, linking
9096 These options come into play when the compiler links object files into
9097 an executable output file.  They are meaningless if the compiler is
9098 not doing a link step.
9100 @table @gcctabopt
9101 @cindex file names
9102 @item @var{object-file-name}
9103 A file name that does not end in a special recognized suffix is
9104 considered to name an object file or library.  (Object files are
9105 distinguished from libraries by the linker according to the file
9106 contents.)  If linking is done, these object files are used as input
9107 to the linker.
9109 @item -c
9110 @itemx -S
9111 @itemx -E
9112 @opindex c
9113 @opindex S
9114 @opindex E
9115 If any of these options is used, then the linker is not run, and
9116 object file names should not be used as arguments.  @xref{Overall
9117 Options}.
9119 @cindex Libraries
9120 @item -l@var{library}
9121 @itemx -l @var{library}
9122 @opindex l
9123 Search the library named @var{library} when linking.  (The second
9124 alternative with the library as a separate argument is only for
9125 POSIX compliance and is not recommended.)
9127 It makes a difference where in the command you write this option; the
9128 linker searches and processes libraries and object files in the order they
9129 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9130 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9131 to functions in @samp{z}, those functions may not be loaded.
9133 The linker searches a standard list of directories for the library,
9134 which is actually a file named @file{lib@var{library}.a}.  The linker
9135 then uses this file as if it had been specified precisely by name.
9137 The directories searched include several standard system directories
9138 plus any that you specify with @option{-L}.
9140 Normally the files found this way are library files---archive files
9141 whose members are object files.  The linker handles an archive file by
9142 scanning through it for members which define symbols that have so far
9143 been referenced but not defined.  But if the file that is found is an
9144 ordinary object file, it is linked in the usual fashion.  The only
9145 difference between using an @option{-l} option and specifying a file name
9146 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9147 and searches several directories.
9149 @item -lobjc
9150 @opindex lobjc
9151 You need this special case of the @option{-l} option in order to
9152 link an Objective-C or Objective-C++ program.
9154 @item -nostartfiles
9155 @opindex nostartfiles
9156 Do not use the standard system startup files when linking.
9157 The standard system libraries are used normally, unless @option{-nostdlib}
9158 or @option{-nodefaultlibs} is used.
9160 @item -nodefaultlibs
9161 @opindex nodefaultlibs
9162 Do not use the standard system libraries when linking.
9163 Only the libraries you specify will be passed to the linker, options
9164 specifying linkage of the system libraries, such as @code{-static-libgcc}
9165 or @code{-shared-libgcc}, will be ignored.
9166 The standard startup files are used normally, unless @option{-nostartfiles}
9167 is used.  The compiler may generate calls to @code{memcmp},
9168 @code{memset}, @code{memcpy} and @code{memmove}.
9169 These entries are usually resolved by entries in
9170 libc.  These entry points should be supplied through some other
9171 mechanism when this option is specified.
9173 @item -nostdlib
9174 @opindex nostdlib
9175 Do not use the standard system startup files or libraries when linking.
9176 No startup files and only the libraries you specify will be passed to
9177 the linker, options specifying linkage of the system libraries, such as
9178 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
9179 The compiler may generate calls to @code{memcmp}, @code{memset},
9180 @code{memcpy} and @code{memmove}.
9181 These entries are usually resolved by entries in
9182 libc.  These entry points should be supplied through some other
9183 mechanism when this option is specified.
9185 @cindex @option{-lgcc}, use with @option{-nostdlib}
9186 @cindex @option{-nostdlib} and unresolved references
9187 @cindex unresolved references and @option{-nostdlib}
9188 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9189 @cindex @option{-nodefaultlibs} and unresolved references
9190 @cindex unresolved references and @option{-nodefaultlibs}
9191 One of the standard libraries bypassed by @option{-nostdlib} and
9192 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9193 that GCC uses to overcome shortcomings of particular machines, or special
9194 needs for some languages.
9195 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9196 Collection (GCC) Internals},
9197 for more discussion of @file{libgcc.a}.)
9198 In most cases, you need @file{libgcc.a} even when you want to avoid
9199 other standard libraries.  In other words, when you specify @option{-nostdlib}
9200 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9201 This ensures that you have no unresolved references to internal GCC
9202 library subroutines.  (For example, @samp{__main}, used to ensure C++
9203 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
9204 GNU Compiler Collection (GCC) Internals}.)
9206 @item -pie
9207 @opindex pie
9208 Produce a position independent executable on targets which support it.
9209 For predictable results, you must also specify the same set of options
9210 that were used to generate code (@option{-fpie}, @option{-fPIE},
9211 or model suboptions) when you specify this option.
9213 @item -rdynamic
9214 @opindex rdynamic
9215 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9216 that support it. This instructs the linker to add all symbols, not
9217 only used ones, to the dynamic symbol table. This option is needed
9218 for some uses of @code{dlopen} or to allow obtaining backtraces
9219 from within a program.
9221 @item -s
9222 @opindex s
9223 Remove all symbol table and relocation information from the executable.
9225 @item -static
9226 @opindex static
9227 On systems that support dynamic linking, this prevents linking with the shared
9228 libraries.  On other systems, this option has no effect.
9230 @item -shared
9231 @opindex shared
9232 Produce a shared object which can then be linked with other objects to
9233 form an executable.  Not all systems support this option.  For predictable
9234 results, you must also specify the same set of options that were used to
9235 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
9236 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
9237 needs to build supplementary stub code for constructors to work.  On
9238 multi-libbed systems, @samp{gcc -shared} must select the correct support
9239 libraries to link against.  Failing to supply the correct flags may lead
9240 to subtle defects.  Supplying them in cases where they are not necessary
9241 is innocuous.}
9243 @item -shared-libgcc
9244 @itemx -static-libgcc
9245 @opindex shared-libgcc
9246 @opindex static-libgcc
9247 On systems that provide @file{libgcc} as a shared library, these options
9248 force the use of either the shared or static version respectively.
9249 If no shared version of @file{libgcc} was built when the compiler was
9250 configured, these options have no effect.
9252 There are several situations in which an application should use the
9253 shared @file{libgcc} instead of the static version.  The most common
9254 of these is when the application wishes to throw and catch exceptions
9255 across different shared libraries.  In that case, each of the libraries
9256 as well as the application itself should use the shared @file{libgcc}.
9258 Therefore, the G++ and GCJ drivers automatically add
9259 @option{-shared-libgcc} whenever you build a shared library or a main
9260 executable, because C++ and Java programs typically use exceptions, so
9261 this is the right thing to do.
9263 If, instead, you use the GCC driver to create shared libraries, you may
9264 find that they will not always be linked with the shared @file{libgcc}.
9265 If GCC finds, at its configuration time, that you have a non-GNU linker
9266 or a GNU linker that does not support option @option{--eh-frame-hdr},
9267 it will link the shared version of @file{libgcc} into shared libraries
9268 by default.  Otherwise, it will take advantage of the linker and optimize
9269 away the linking with the shared version of @file{libgcc}, linking with
9270 the static version of libgcc by default.  This allows exceptions to
9271 propagate through such shared libraries, without incurring relocation
9272 costs at library load time.
9274 However, if a library or main executable is supposed to throw or catch
9275 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9276 for the languages used in the program, or using the option
9277 @option{-shared-libgcc}, such that it is linked with the shared
9278 @file{libgcc}.
9280 @item -static-libstdc++
9281 When the @command{g++} program is used to link a C++ program, it will
9282 normally automatically link against @option{libstdc++}.  If
9283 @file{libstdc++} is available as a shared library, and the
9284 @option{-static} option is not used, then this will link against the
9285 shared version of @file{libstdc++}.  That is normally fine.  However, it
9286 is sometimes useful to freeze the version of @file{libstdc++} used by
9287 the program without going all the way to a fully static link.  The
9288 @option{-static-libstdc++} option directs the @command{g++} driver to
9289 link @file{libstdc++} statically, without necessarily linking other
9290 libraries statically.
9292 @item -symbolic
9293 @opindex symbolic
9294 Bind references to global symbols when building a shared object.  Warn
9295 about any unresolved references (unless overridden by the link editor
9296 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
9297 this option.
9299 @item -T @var{script}
9300 @opindex T
9301 @cindex linker script
9302 Use @var{script} as the linker script.  This option is supported by most
9303 systems using the GNU linker.  On some targets, such as bare-board
9304 targets without an operating system, the @option{-T} option may be required
9305 when linking to avoid references to undefined symbols.
9307 @item -Xlinker @var{option}
9308 @opindex Xlinker
9309 Pass @var{option} as an option to the linker.  You can use this to
9310 supply system-specific linker options which GCC does not know how to
9311 recognize.
9313 If you want to pass an option that takes a separate argument, you must use
9314 @option{-Xlinker} twice, once for the option and once for the argument.
9315 For example, to pass @option{-assert definitions}, you must write
9316 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9317 @option{-Xlinker "-assert definitions"}, because this passes the entire
9318 string as a single argument, which is not what the linker expects.
9320 When using the GNU linker, it is usually more convenient to pass
9321 arguments to linker options using the @option{@var{option}=@var{value}}
9322 syntax than as separate arguments.  For example, you can specify
9323 @samp{-Xlinker -Map=output.map} rather than
9324 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9325 this syntax for command-line options.
9327 @item -Wl,@var{option}
9328 @opindex Wl
9329 Pass @var{option} as an option to the linker.  If @var{option} contains
9330 commas, it is split into multiple options at the commas.  You can use this
9331 syntax to pass an argument to the option.
9332 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
9333 linker.  When using the GNU linker, you can also get the same effect with
9334 @samp{-Wl,-Map=output.map}.
9336 @item -u @var{symbol}
9337 @opindex u
9338 Pretend the symbol @var{symbol} is undefined, to force linking of
9339 library modules to define it.  You can use @option{-u} multiple times with
9340 different symbols to force loading of additional library modules.
9341 @end table
9343 @node Directory Options
9344 @section Options for Directory Search
9345 @cindex directory options
9346 @cindex options, directory search
9347 @cindex search path
9349 These options specify directories to search for header files, for
9350 libraries and for parts of the compiler:
9352 @table @gcctabopt
9353 @item -I@var{dir}
9354 @opindex I
9355 Add the directory @var{dir} to the head of the list of directories to be
9356 searched for header files.  This can be used to override a system header
9357 file, substituting your own version, since these directories are
9358 searched before the system header file directories.  However, you should
9359 not use this option to add directories that contain vendor-supplied
9360 system header files (use @option{-isystem} for that).  If you use more than
9361 one @option{-I} option, the directories are scanned in left-to-right
9362 order; the standard system directories come after.
9364 If a standard system include directory, or a directory specified with
9365 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9366 option will be ignored.  The directory will still be searched but as a
9367 system directory at its normal position in the system include chain.
9368 This is to ensure that GCC's procedure to fix buggy system headers and
9369 the ordering for the include_next directive are not inadvertently changed.
9370 If you really need to change the search order for system directories,
9371 use the @option{-nostdinc} and/or @option{-isystem} options.
9373 @item -iplugindir=@var{dir}
9374 Set the directory to search for plugins which are passed
9375 by @option{-fplugin=@var{name}} instead of
9376 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
9377 to be used by the user, but only passed by the driver.
9379 @item -iquote@var{dir}
9380 @opindex iquote
9381 Add the directory @var{dir} to the head of the list of directories to
9382 be searched for header files only for the case of @samp{#include
9383 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9384 otherwise just like @option{-I}.
9386 @item -L@var{dir}
9387 @opindex L
9388 Add directory @var{dir} to the list of directories to be searched
9389 for @option{-l}.
9391 @item -B@var{prefix}
9392 @opindex B
9393 This option specifies where to find the executables, libraries,
9394 include files, and data files of the compiler itself.
9396 The compiler driver program runs one or more of the subprograms
9397 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
9398 @var{prefix} as a prefix for each program it tries to run, both with and
9399 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9401 For each subprogram to be run, the compiler driver first tries the
9402 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9403 was not specified, the driver tries two standard prefixes, which are
9404 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9405 those results in a file name that is found, the unmodified program
9406 name is searched for using the directories specified in your
9407 @env{PATH} environment variable.
9409 The compiler will check to see if the path provided by the @option{-B}
9410 refers to a directory, and if necessary it will add a directory
9411 separator character at the end of the path.
9413 @option{-B} prefixes that effectively specify directory names also apply
9414 to libraries in the linker, because the compiler translates these
9415 options into @option{-L} options for the linker.  They also apply to
9416 includes files in the preprocessor, because the compiler translates these
9417 options into @option{-isystem} options for the preprocessor.  In this case,
9418 the compiler appends @samp{include} to the prefix.
9420 The run-time support file @file{libgcc.a} can also be searched for using
9421 the @option{-B} prefix, if needed.  If it is not found there, the two
9422 standard prefixes above are tried, and that is all.  The file is left
9423 out of the link if it is not found by those means.
9425 Another way to specify a prefix much like the @option{-B} prefix is to use
9426 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9427 Variables}.
9429 As a special kludge, if the path provided by @option{-B} is
9430 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9431 9, then it will be replaced by @file{[dir/]include}.  This is to help
9432 with boot-strapping the compiler.
9434 @item -specs=@var{file}
9435 @opindex specs
9436 Process @var{file} after the compiler reads in the standard @file{specs}
9437 file, in order to override the defaults that the @file{gcc} driver
9438 program uses when determining what switches to pass to @file{cc1},
9439 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
9440 @option{-specs=@var{file}} can be specified on the command line, and they
9441 are processed in order, from left to right.
9443 @item --sysroot=@var{dir}
9444 @opindex sysroot
9445 Use @var{dir} as the logical root directory for headers and libraries.
9446 For example, if the compiler would normally search for headers in
9447 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
9448 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9450 If you use both this option and the @option{-isysroot} option, then
9451 the @option{--sysroot} option will apply to libraries, but the
9452 @option{-isysroot} option will apply to header files.
9454 The GNU linker (beginning with version 2.16) has the necessary support
9455 for this option.  If your linker does not support this option, the
9456 header file aspect of @option{--sysroot} will still work, but the
9457 library aspect will not.
9459 @item -I-
9460 @opindex I-
9461 This option has been deprecated.  Please use @option{-iquote} instead for
9462 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9463 Any directories you specify with @option{-I} options before the @option{-I-}
9464 option are searched only for the case of @samp{#include "@var{file}"};
9465 they are not searched for @samp{#include <@var{file}>}.
9467 If additional directories are specified with @option{-I} options after
9468 the @option{-I-}, these directories are searched for all @samp{#include}
9469 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9470 this way.)
9472 In addition, the @option{-I-} option inhibits the use of the current
9473 directory (where the current input file came from) as the first search
9474 directory for @samp{#include "@var{file}"}.  There is no way to
9475 override this effect of @option{-I-}.  With @option{-I.} you can specify
9476 searching the directory which was current when the compiler was
9477 invoked.  That is not exactly the same as what the preprocessor does
9478 by default, but it is often satisfactory.
9480 @option{-I-} does not inhibit the use of the standard system directories
9481 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9482 independent.
9483 @end table
9485 @c man end
9487 @node Spec Files
9488 @section Specifying subprocesses and the switches to pass to them
9489 @cindex Spec Files
9491 @command{gcc} is a driver program.  It performs its job by invoking a
9492 sequence of other programs to do the work of compiling, assembling and
9493 linking.  GCC interprets its command-line parameters and uses these to
9494 deduce which programs it should invoke, and which command-line options
9495 it ought to place on their command lines.  This behavior is controlled
9496 by @dfn{spec strings}.  In most cases there is one spec string for each
9497 program that GCC can invoke, but a few programs have multiple spec
9498 strings to control their behavior.  The spec strings built into GCC can
9499 be overridden by using the @option{-specs=} command-line switch to specify
9500 a spec file.
9502 @dfn{Spec files} are plaintext files that are used to construct spec
9503 strings.  They consist of a sequence of directives separated by blank
9504 lines.  The type of directive is determined by the first non-whitespace
9505 character on the line and it can be one of the following:
9507 @table @code
9508 @item %@var{command}
9509 Issues a @var{command} to the spec file processor.  The commands that can
9510 appear here are:
9512 @table @code
9513 @item %include <@var{file}>
9514 @cindex @code{%include}
9515 Search for @var{file} and insert its text at the current point in the
9516 specs file.
9518 @item %include_noerr <@var{file}>
9519 @cindex @code{%include_noerr}
9520 Just like @samp{%include}, but do not generate an error message if the include
9521 file cannot be found.
9523 @item %rename @var{old_name} @var{new_name}
9524 @cindex @code{%rename}
9525 Rename the spec string @var{old_name} to @var{new_name}.
9527 @end table
9529 @item *[@var{spec_name}]:
9530 This tells the compiler to create, override or delete the named spec
9531 string.  All lines after this directive up to the next directive or
9532 blank line are considered to be the text for the spec string.  If this
9533 results in an empty string then the spec will be deleted.  (Or, if the
9534 spec did not exist, then nothing will happen.)  Otherwise, if the spec
9535 does not currently exist a new spec will be created.  If the spec does
9536 exist then its contents will be overridden by the text of this
9537 directive, unless the first character of that text is the @samp{+}
9538 character, in which case the text will be appended to the spec.
9540 @item [@var{suffix}]:
9541 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9542 and up to the next directive or blank line are considered to make up the
9543 spec string for the indicated suffix.  When the compiler encounters an
9544 input file with the named suffix, it will processes the spec string in
9545 order to work out how to compile that file.  For example:
9547 @smallexample
9548 .ZZ:
9549 z-compile -input %i
9550 @end smallexample
9552 This says that any input file whose name ends in @samp{.ZZ} should be
9553 passed to the program @samp{z-compile}, which should be invoked with the
9554 command-line switch @option{-input} and with the result of performing the
9555 @samp{%i} substitution.  (See below.)
9557 As an alternative to providing a spec string, the text that follows a
9558 suffix directive can be one of the following:
9560 @table @code
9561 @item @@@var{language}
9562 This says that the suffix is an alias for a known @var{language}.  This is
9563 similar to using the @option{-x} command-line switch to GCC to specify a
9564 language explicitly.  For example:
9566 @smallexample
9567 .ZZ:
9568 @@c++
9569 @end smallexample
9571 Says that .ZZ files are, in fact, C++ source files.
9573 @item #@var{name}
9574 This causes an error messages saying:
9576 @smallexample
9577 @var{name} compiler not installed on this system.
9578 @end smallexample
9579 @end table
9581 GCC already has an extensive list of suffixes built into it.
9582 This directive will add an entry to the end of the list of suffixes, but
9583 since the list is searched from the end backwards, it is effectively
9584 possible to override earlier entries using this technique.
9586 @end table
9588 GCC has the following spec strings built into it.  Spec files can
9589 override these strings or create their own.  Note that individual
9590 targets can also add their own spec strings to this list.
9592 @smallexample
9593 asm          Options to pass to the assembler
9594 asm_final    Options to pass to the assembler post-processor
9595 cpp          Options to pass to the C preprocessor
9596 cc1          Options to pass to the C compiler
9597 cc1plus      Options to pass to the C++ compiler
9598 endfile      Object files to include at the end of the link
9599 link         Options to pass to the linker
9600 lib          Libraries to include on the command line to the linker
9601 libgcc       Decides which GCC support library to pass to the linker
9602 linker       Sets the name of the linker
9603 predefines   Defines to be passed to the C preprocessor
9604 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9605              by default
9606 startfile    Object files to include at the start of the link
9607 @end smallexample
9609 Here is a small example of a spec file:
9611 @smallexample
9612 %rename lib                 old_lib
9614 *lib:
9615 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9616 @end smallexample
9618 This example renames the spec called @samp{lib} to @samp{old_lib} and
9619 then overrides the previous definition of @samp{lib} with a new one.
9620 The new definition adds in some extra command-line options before
9621 including the text of the old definition.
9623 @dfn{Spec strings} are a list of command-line options to be passed to their
9624 corresponding program.  In addition, the spec strings can contain
9625 @samp{%}-prefixed sequences to substitute variable text or to
9626 conditionally insert text into the command line.  Using these constructs
9627 it is possible to generate quite complex command lines.
9629 Here is a table of all defined @samp{%}-sequences for spec
9630 strings.  Note that spaces are not generated automatically around the
9631 results of expanding these sequences.  Therefore you can concatenate them
9632 together or combine them with constant text in a single argument.
9634 @table @code
9635 @item %%
9636 Substitute one @samp{%} into the program name or argument.
9638 @item %i
9639 Substitute the name of the input file being processed.
9641 @item %b
9642 Substitute the basename of the input file being processed.
9643 This is the substring up to (and not including) the last period
9644 and not including the directory.
9646 @item %B
9647 This is the same as @samp{%b}, but include the file suffix (text after
9648 the last period).
9650 @item %d
9651 Marks the argument containing or following the @samp{%d} as a
9652 temporary file name, so that that file will be deleted if GCC exits
9653 successfully.  Unlike @samp{%g}, this contributes no text to the
9654 argument.
9656 @item %g@var{suffix}
9657 Substitute a file name that has suffix @var{suffix} and is chosen
9658 once per compilation, and mark the argument in the same way as
9659 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9660 name is now chosen in a way that is hard to predict even when previously
9661 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9662 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9663 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9664 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9665 was simply substituted with a file name chosen once per compilation,
9666 without regard to any appended suffix (which was therefore treated
9667 just like ordinary text), making such attacks more likely to succeed.
9669 @item %u@var{suffix}
9670 Like @samp{%g}, but generates a new temporary file name even if
9671 @samp{%u@var{suffix}} was already seen.
9673 @item %U@var{suffix}
9674 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9675 new one if there is no such last file name.  In the absence of any
9676 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9677 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9678 would involve the generation of two distinct file names, one
9679 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9680 simply substituted with a file name chosen for the previous @samp{%u},
9681 without regard to any appended suffix.
9683 @item %j@var{suffix}
9684 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9685 writable, and if save-temps is off; otherwise, substitute the name
9686 of a temporary file, just like @samp{%u}.  This temporary file is not
9687 meant for communication between processes, but rather as a junk
9688 disposal mechanism.
9690 @item %|@var{suffix}
9691 @itemx %m@var{suffix}
9692 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9693 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9694 all.  These are the two most common ways to instruct a program that it
9695 should read from standard input or write to standard output.  If you
9696 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9697 construct: see for example @file{f/lang-specs.h}.
9699 @item %.@var{SUFFIX}
9700 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9701 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9702 terminated by the next space or %.
9704 @item %w
9705 Marks the argument containing or following the @samp{%w} as the
9706 designated output file of this compilation.  This puts the argument
9707 into the sequence of arguments that @samp{%o} will substitute later.
9709 @item %o
9710 Substitutes the names of all the output files, with spaces
9711 automatically placed around them.  You should write spaces
9712 around the @samp{%o} as well or the results are undefined.
9713 @samp{%o} is for use in the specs for running the linker.
9714 Input files whose names have no recognized suffix are not compiled
9715 at all, but they are included among the output files, so they will
9716 be linked.
9718 @item %O
9719 Substitutes the suffix for object files.  Note that this is
9720 handled specially when it immediately follows @samp{%g, %u, or %U},
9721 because of the need for those to form complete file names.  The
9722 handling is such that @samp{%O} is treated exactly as if it had already
9723 been substituted, except that @samp{%g, %u, and %U} do not currently
9724 support additional @var{suffix} characters following @samp{%O} as they would
9725 following, for example, @samp{.o}.
9727 @item %p
9728 Substitutes the standard macro predefinitions for the
9729 current target machine.  Use this when running @code{cpp}.
9731 @item %P
9732 Like @samp{%p}, but puts @samp{__} before and after the name of each
9733 predefined macro, except for macros that start with @samp{__} or with
9734 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9737 @item %I
9738 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9739 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9740 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9741 and @option{-imultilib} as necessary.
9743 @item %s
9744 Current argument is the name of a library or startup file of some sort.
9745 Search for that file in a standard list of directories and substitute
9746 the full name found.  The current working directory is included in the
9747 list of directories scanned.
9749 @item %T
9750 Current argument is the name of a linker script.  Search for that file
9751 in the current list of directories to scan for libraries. If the file
9752 is located insert a @option{--script} option into the command line
9753 followed by the full path name found.  If the file is not found then
9754 generate an error message.  Note: the current working directory is not
9755 searched.
9757 @item %e@var{str}
9758 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9759 Use this when inconsistent options are detected.
9761 @item %(@var{name})
9762 Substitute the contents of spec string @var{name} at this point.
9764 @item %[@var{name}]
9765 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9767 @item %x@{@var{option}@}
9768 Accumulate an option for @samp{%X}.
9770 @item %X
9771 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9772 spec string.
9774 @item %Y
9775 Output the accumulated assembler options specified by @option{-Wa}.
9777 @item %Z
9778 Output the accumulated preprocessor options specified by @option{-Wp}.
9780 @item %a
9781 Process the @code{asm} spec.  This is used to compute the
9782 switches to be passed to the assembler.
9784 @item %A
9785 Process the @code{asm_final} spec.  This is a spec string for
9786 passing switches to an assembler post-processor, if such a program is
9787 needed.
9789 @item %l
9790 Process the @code{link} spec.  This is the spec for computing the
9791 command line passed to the linker.  Typically it will make use of the
9792 @samp{%L %G %S %D and %E} sequences.
9794 @item %D
9795 Dump out a @option{-L} option for each directory that GCC believes might
9796 contain startup files.  If the target supports multilibs then the
9797 current multilib directory will be prepended to each of these paths.
9799 @item %L
9800 Process the @code{lib} spec.  This is a spec string for deciding which
9801 libraries should be included on the command line to the linker.
9803 @item %G
9804 Process the @code{libgcc} spec.  This is a spec string for deciding
9805 which GCC support library should be included on the command line to the linker.
9807 @item %S
9808 Process the @code{startfile} spec.  This is a spec for deciding which
9809 object files should be the first ones passed to the linker.  Typically
9810 this might be a file named @file{crt0.o}.
9812 @item %E
9813 Process the @code{endfile} spec.  This is a spec string that specifies
9814 the last object files that will be passed to the linker.
9816 @item %C
9817 Process the @code{cpp} spec.  This is used to construct the arguments
9818 to be passed to the C preprocessor.
9820 @item %1
9821 Process the @code{cc1} spec.  This is used to construct the options to be
9822 passed to the actual C compiler (@samp{cc1}).
9824 @item %2
9825 Process the @code{cc1plus} spec.  This is used to construct the options to be
9826 passed to the actual C++ compiler (@samp{cc1plus}).
9828 @item %*
9829 Substitute the variable part of a matched option.  See below.
9830 Note that each comma in the substituted string is replaced by
9831 a single space.
9833 @item %<@code{S}
9834 Remove all occurrences of @code{-S} from the command line.  Note---this
9835 command is position dependent.  @samp{%} commands in the spec string
9836 before this one will see @code{-S}, @samp{%} commands in the spec string
9837 after this one will not.
9839 @item %:@var{function}(@var{args})
9840 Call the named function @var{function}, passing it @var{args}.
9841 @var{args} is first processed as a nested spec string, then split
9842 into an argument vector in the usual fashion.  The function returns
9843 a string which is processed as if it had appeared literally as part
9844 of the current spec.
9846 The following built-in spec functions are provided:
9848 @table @code
9849 @item @code{getenv}
9850 The @code{getenv} spec function takes two arguments: an environment
9851 variable name and a string.  If the environment variable is not
9852 defined, a fatal error is issued.  Otherwise, the return value is the
9853 value of the environment variable concatenated with the string.  For
9854 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9856 @smallexample
9857 %:getenv(TOPDIR /include)
9858 @end smallexample
9860 expands to @file{/path/to/top/include}.
9862 @item @code{if-exists}
9863 The @code{if-exists} spec function takes one argument, an absolute
9864 pathname to a file.  If the file exists, @code{if-exists} returns the
9865 pathname.  Here is a small example of its usage:
9867 @smallexample
9868 *startfile:
9869 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9870 @end smallexample
9872 @item @code{if-exists-else}
9873 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9874 spec function, except that it takes two arguments.  The first argument is
9875 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9876 returns the pathname.  If it does not exist, it returns the second argument.
9877 This way, @code{if-exists-else} can be used to select one file or another,
9878 based on the existence of the first.  Here is a small example of its usage:
9880 @smallexample
9881 *startfile:
9882 crt0%O%s %:if-exists(crti%O%s) \
9883 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9884 @end smallexample
9886 @item @code{replace-outfile}
9887 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9888 first argument in the outfiles array and replaces it with the second argument.  Here
9889 is a small example of its usage:
9891 @smallexample
9892 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9893 @end smallexample
9895 @item @code{remove-outfile}
9896 The @code{remove-outfile} spec function takes one argument.  It looks for the
9897 first argument in the outfiles array and removes it.  Here is a small example
9898 its usage:
9900 @smallexample
9901 %:remove-outfile(-lm)
9902 @end smallexample
9904 @item @code{pass-through-libs}
9905 The @code{pass-through-libs} spec function takes any number of arguments.  It
9906 finds any @option{-l} options and any non-options ending in ".a" (which it
9907 assumes are the names of linker input library archive files) and returns a
9908 result containing all the found arguments each prepended by
9909 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
9910 intended to be passed to the LTO linker plugin.
9912 @smallexample
9913 %:pass-through-libs(%G %L %G)
9914 @end smallexample
9916 @item @code{print-asm-header}
9917 The @code{print-asm-header} function takes no arguments and simply
9918 prints a banner like:
9920 @smallexample
9921 Assembler options
9922 =================
9924 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9925 @end smallexample
9927 It is used to separate compiler options from assembler options
9928 in the @option{--target-help} output.
9929 @end table
9931 @item %@{@code{S}@}
9932 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9933 If that switch was not specified, this substitutes nothing.  Note that
9934 the leading dash is omitted when specifying this option, and it is
9935 automatically inserted if the substitution is performed.  Thus the spec
9936 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9937 and would output the command line option @option{-foo}.
9939 @item %W@{@code{S}@}
9940 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9941 deleted on failure.
9943 @item %@{@code{S}*@}
9944 Substitutes all the switches specified to GCC whose names start
9945 with @code{-S}, but which also take an argument.  This is used for
9946 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9947 GCC considers @option{-o foo} as being
9948 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9949 text, including the space.  Thus two arguments would be generated.
9951 @item %@{@code{S}*&@code{T}*@}
9952 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9953 (the order of @code{S} and @code{T} in the spec is not significant).
9954 There can be any number of ampersand-separated variables; for each the
9955 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9957 @item %@{@code{S}:@code{X}@}
9958 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9960 @item %@{!@code{S}:@code{X}@}
9961 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9963 @item %@{@code{S}*:@code{X}@}
9964 Substitutes @code{X} if one or more switches whose names start with
9965 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9966 once, no matter how many such switches appeared.  However, if @code{%*}
9967 appears somewhere in @code{X}, then @code{X} will be substituted once
9968 for each matching switch, with the @code{%*} replaced by the part of
9969 that switch that matched the @code{*}.
9971 @item %@{.@code{S}:@code{X}@}
9972 Substitutes @code{X}, if processing a file with suffix @code{S}.
9974 @item %@{!.@code{S}:@code{X}@}
9975 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9977 @item %@{,@code{S}:@code{X}@}
9978 Substitutes @code{X}, if processing a file for language @code{S}.
9980 @item %@{!,@code{S}:@code{X}@}
9981 Substitutes @code{X}, if not processing a file for language @code{S}.
9983 @item %@{@code{S}|@code{P}:@code{X}@}
9984 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9985 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9986 @code{*} sequences as well, although they have a stronger binding than
9987 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9988 alternatives must be starred, and only the first matching alternative
9989 is substituted.
9991 For example, a spec string like this:
9993 @smallexample
9994 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9995 @end smallexample
9997 will output the following command-line options from the following input
9998 command-line options:
10000 @smallexample
10001 fred.c        -foo -baz
10002 jim.d         -bar -boggle
10003 -d fred.c     -foo -baz -boggle
10004 -d jim.d      -bar -baz -boggle
10005 @end smallexample
10007 @item %@{S:X; T:Y; :D@}
10009 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
10010 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10011 be as many clauses as you need.  This may be combined with @code{.},
10012 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10015 @end table
10017 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10018 construct may contain other nested @samp{%} constructs or spaces, or
10019 even newlines.  They are processed as usual, as described above.
10020 Trailing white space in @code{X} is ignored.  White space may also
10021 appear anywhere on the left side of the colon in these constructs,
10022 except between @code{.} or @code{*} and the corresponding word.
10024 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10025 handled specifically in these constructs.  If another value of
10026 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10027 @option{-W} switch is found later in the command line, the earlier
10028 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10029 just one letter, which passes all matching options.
10031 The character @samp{|} at the beginning of the predicate text is used to
10032 indicate that a command should be piped to the following command, but
10033 only if @option{-pipe} is specified.
10035 It is built into GCC which switches take arguments and which do not.
10036 (You might think it would be useful to generalize this to allow each
10037 compiler's spec to say which switches take arguments.  But this cannot
10038 be done in a consistent fashion.  GCC cannot even decide which input
10039 files have been specified without knowing which switches take arguments,
10040 and it must know which input files to compile in order to tell which
10041 compilers to run).
10043 GCC also knows implicitly that arguments starting in @option{-l} are to be
10044 treated as compiler output files, and passed to the linker in their
10045 proper position among the other output files.
10047 @c man begin OPTIONS
10049 @node Target Options
10050 @section Specifying Target Machine and Compiler Version
10051 @cindex target options
10052 @cindex cross compiling
10053 @cindex specifying machine version
10054 @cindex specifying compiler version and target machine
10055 @cindex compiler version, specifying
10056 @cindex target machine, specifying
10058 The usual way to run GCC is to run the executable called @command{gcc}, or
10059 @command{@var{machine}-gcc} when cross-compiling, or
10060 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10061 one that was installed last.
10063 @node Submodel Options
10064 @section Hardware Models and Configurations
10065 @cindex submodel options
10066 @cindex specifying hardware config
10067 @cindex hardware models and configurations, specifying
10068 @cindex machine dependent options
10070 Each target machine types can have its own
10071 special options, starting with @samp{-m}, to choose among various
10072 hardware models or configurations---for example, 68010 vs 68020,
10073 floating coprocessor or none.  A single installed version of the
10074 compiler can compile for any model or configuration, according to the
10075 options specified.
10077 Some configurations of the compiler also support additional special
10078 options, usually for compatibility with other compilers on the same
10079 platform.
10081 @c This list is ordered alphanumerically by subsection name.
10082 @c It should be the same order and spelling as these options are listed
10083 @c in Machine Dependent Options
10085 @menu
10086 * ARM Options::
10087 * AVR Options::
10088 * Blackfin Options::
10089 * CRIS Options::
10090 * Darwin Options::
10091 * DEC Alpha Options::
10092 * DEC Alpha/VMS Options::
10093 * FR30 Options::
10094 * FRV Options::
10095 * GNU/Linux Options::
10096 * H8/300 Options::
10097 * HPPA Options::
10098 * i386 and x86-64 Options::
10099 * i386 and x86-64 Windows Options::
10100 * IA-64 Options::
10101 * IA-64/VMS Options::
10102 * LM32 Options::
10103 * M32C Options::
10104 * M32R/D Options::
10105 * M680x0 Options::
10106 * MCore Options::
10107 * MeP Options::
10108 * MicroBlaze Options::
10109 * MIPS Options::
10110 * MMIX Options::
10111 * MN10300 Options::
10112 * PDP-11 Options::
10113 * picoChip Options::
10114 * PowerPC Options::
10115 * RS/6000 and PowerPC Options::
10116 * RX Options::
10117 * S/390 and zSeries Options::
10118 * Score Options::
10119 * SH Options::
10120 * Solaris 2 Options::
10121 * SPARC Options::
10122 * SPU Options::
10123 * System V Options::
10124 * V850 Options::
10125 * VAX Options::
10126 * VxWorks Options::
10127 * x86-64 Options::
10128 * Xstormy16 Options::
10129 * Xtensa Options::
10130 * zSeries Options::
10131 @end menu
10133 @node ARM Options
10134 @subsection ARM Options
10135 @cindex ARM options
10137 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
10138 architectures:
10140 @table @gcctabopt
10141 @item -mabi=@var{name}
10142 @opindex mabi
10143 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
10144 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
10146 @item -mapcs-frame
10147 @opindex mapcs-frame
10148 Generate a stack frame that is compliant with the ARM Procedure Call
10149 Standard for all functions, even if this is not strictly necessary for
10150 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
10151 with this option will cause the stack frames not to be generated for
10152 leaf functions.  The default is @option{-mno-apcs-frame}.
10154 @item -mapcs
10155 @opindex mapcs
10156 This is a synonym for @option{-mapcs-frame}.
10158 @ignore
10159 @c not currently implemented
10160 @item -mapcs-stack-check
10161 @opindex mapcs-stack-check
10162 Generate code to check the amount of stack space available upon entry to
10163 every function (that actually uses some stack space).  If there is
10164 insufficient space available then either the function
10165 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
10166 called, depending upon the amount of stack space required.  The run time
10167 system is required to provide these functions.  The default is
10168 @option{-mno-apcs-stack-check}, since this produces smaller code.
10170 @c not currently implemented
10171 @item -mapcs-float
10172 @opindex mapcs-float
10173 Pass floating point arguments using the float point registers.  This is
10174 one of the variants of the APCS@.  This option is recommended if the
10175 target hardware has a floating point unit or if a lot of floating point
10176 arithmetic is going to be performed by the code.  The default is
10177 @option{-mno-apcs-float}, since integer only code is slightly increased in
10178 size if @option{-mapcs-float} is used.
10180 @c not currently implemented
10181 @item -mapcs-reentrant
10182 @opindex mapcs-reentrant
10183 Generate reentrant, position independent code.  The default is
10184 @option{-mno-apcs-reentrant}.
10185 @end ignore
10187 @item -mthumb-interwork
10188 @opindex mthumb-interwork
10189 Generate code which supports calling between the ARM and Thumb
10190 instruction sets.  Without this option, on pre-v5 architectures, the
10191 two instruction sets cannot be reliably used inside one program.  The
10192 default is @option{-mno-thumb-interwork}, since slightly larger code
10193 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
10194 configurations this option is meaningless.
10196 @item -mno-sched-prolog
10197 @opindex mno-sched-prolog
10198 Prevent the reordering of instructions in the function prolog, or the
10199 merging of those instruction with the instructions in the function's
10200 body.  This means that all functions will start with a recognizable set
10201 of instructions (or in fact one of a choice from a small set of
10202 different function prologues), and this information can be used to
10203 locate the start if functions inside an executable piece of code.  The
10204 default is @option{-msched-prolog}.
10206 @item -mfloat-abi=@var{name}
10207 @opindex mfloat-abi
10208 Specifies which floating-point ABI to use.  Permissible values
10209 are: @samp{soft}, @samp{softfp} and @samp{hard}.
10211 Specifying @samp{soft} causes GCC to generate output containing
10212 library calls for floating-point operations.
10213 @samp{softfp} allows the generation of code using hardware floating-point
10214 instructions, but still uses the soft-float calling conventions.
10215 @samp{hard} allows generation of floating-point instructions
10216 and uses FPU-specific calling conventions.
10218 The default depends on the specific target configuration.  Note that
10219 the hard-float and soft-float ABIs are not link-compatible; you must
10220 compile your entire program with the same ABI, and link with a
10221 compatible set of libraries.
10223 @item -mlittle-endian
10224 @opindex mlittle-endian
10225 Generate code for a processor running in little-endian mode.  This is
10226 the default for all standard configurations.
10228 @item -mbig-endian
10229 @opindex mbig-endian
10230 Generate code for a processor running in big-endian mode; the default is
10231 to compile code for a little-endian processor.
10233 @item -mwords-little-endian
10234 @opindex mwords-little-endian
10235 This option only applies when generating code for big-endian processors.
10236 Generate code for a little-endian word order but a big-endian byte
10237 order.  That is, a byte order of the form @samp{32107654}.  Note: this
10238 option should only be used if you require compatibility with code for
10239 big-endian ARM processors generated by versions of the compiler prior to
10240 2.8.
10242 @item -mcpu=@var{name}
10243 @opindex mcpu
10244 This specifies the name of the target ARM processor.  GCC uses this name
10245 to determine what kind of instructions it can emit when generating
10246 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
10247 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10248 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10249 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10250 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10251 @samp{arm720},
10252 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10253 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10254 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10255 @samp{strongarm1110},
10256 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10257 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10258 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10259 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10260 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10261 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10262 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10263 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a15},
10264 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
10265 @samp{cortex-m4}, @samp{cortex-m3},
10266 @samp{cortex-m1},
10267 @samp{cortex-m0},
10268 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10270 @item -mtune=@var{name}
10271 @opindex mtune
10272 This option is very similar to the @option{-mcpu=} option, except that
10273 instead of specifying the actual target processor type, and hence
10274 restricting which instructions can be used, it specifies that GCC should
10275 tune the performance of the code as if the target were of the type
10276 specified in this option, but still choosing the instructions that it
10277 will generate based on the CPU specified by a @option{-mcpu=} option.
10278 For some ARM implementations better performance can be obtained by using
10279 this option.
10281 @item -march=@var{name}
10282 @opindex march
10283 This specifies the name of the target ARM architecture.  GCC uses this
10284 name to determine what kind of instructions it can emit when generating
10285 assembly code.  This option can be used in conjunction with or instead
10286 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
10287 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10288 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10289 @samp{armv6}, @samp{armv6j},
10290 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10291 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10292 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10294 @item -mfpu=@var{name}
10295 @itemx -mfpe=@var{number}
10296 @itemx -mfp=@var{number}
10297 @opindex mfpu
10298 @opindex mfpe
10299 @opindex mfp
10300 This specifies what floating point hardware (or hardware emulation) is
10301 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
10302 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
10303 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
10304 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
10305 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10306 @option{-mfp} and @option{-mfpe} are synonyms for
10307 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
10308 of GCC@.
10310 If @option{-msoft-float} is specified this specifies the format of
10311 floating point values.
10313 If the selected floating-point hardware includes the NEON extension
10314 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10315 operations will not be used by GCC's auto-vectorization pass unless
10316 @option{-funsafe-math-optimizations} is also specified.  This is
10317 because NEON hardware does not fully implement the IEEE 754 standard for
10318 floating-point arithmetic (in particular denormal values are treated as
10319 zero), so the use of NEON instructions may lead to a loss of precision.
10321 @item -mfp16-format=@var{name}
10322 @opindex mfp16-format
10323 Specify the format of the @code{__fp16} half-precision floating-point type.
10324 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10325 the default is @samp{none}, in which case the @code{__fp16} type is not
10326 defined.  @xref{Half-Precision}, for more information.
10328 @item -mstructure-size-boundary=@var{n}
10329 @opindex mstructure-size-boundary
10330 The size of all structures and unions will be rounded up to a multiple
10331 of the number of bits set by this option.  Permissible values are 8, 32
10332 and 64.  The default value varies for different toolchains.  For the COFF
10333 targeted toolchain the default value is 8.  A value of 64 is only allowed
10334 if the underlying ABI supports it.
10336 Specifying the larger number can produce faster, more efficient code, but
10337 can also increase the size of the program.  Different values are potentially
10338 incompatible.  Code compiled with one value cannot necessarily expect to
10339 work with code or libraries compiled with another value, if they exchange
10340 information using structures or unions.
10342 @item -mabort-on-noreturn
10343 @opindex mabort-on-noreturn
10344 Generate a call to the function @code{abort} at the end of a
10345 @code{noreturn} function.  It will be executed if the function tries to
10346 return.
10348 @item -mlong-calls
10349 @itemx -mno-long-calls
10350 @opindex mlong-calls
10351 @opindex mno-long-calls
10352 Tells the compiler to perform function calls by first loading the
10353 address of the function into a register and then performing a subroutine
10354 call on this register.  This switch is needed if the target function
10355 will lie outside of the 64 megabyte addressing range of the offset based
10356 version of subroutine call instruction.
10358 Even if this switch is enabled, not all function calls will be turned
10359 into long calls.  The heuristic is that static functions, functions
10360 which have the @samp{short-call} attribute, functions that are inside
10361 the scope of a @samp{#pragma no_long_calls} directive and functions whose
10362 definitions have already been compiled within the current compilation
10363 unit, will not be turned into long calls.  The exception to this rule is
10364 that weak function definitions, functions with the @samp{long-call}
10365 attribute or the @samp{section} attribute, and functions that are within
10366 the scope of a @samp{#pragma long_calls} directive, will always be
10367 turned into long calls.
10369 This feature is not enabled by default.  Specifying
10370 @option{-mno-long-calls} will restore the default behavior, as will
10371 placing the function calls within the scope of a @samp{#pragma
10372 long_calls_off} directive.  Note these switches have no effect on how
10373 the compiler generates code to handle function calls via function
10374 pointers.
10376 @item -msingle-pic-base
10377 @opindex msingle-pic-base
10378 Treat the register used for PIC addressing as read-only, rather than
10379 loading it in the prologue for each function.  The run-time system is
10380 responsible for initializing this register with an appropriate value
10381 before execution begins.
10383 @item -mpic-register=@var{reg}
10384 @opindex mpic-register
10385 Specify the register to be used for PIC addressing.  The default is R10
10386 unless stack-checking is enabled, when R9 is used.
10388 @item -mcirrus-fix-invalid-insns
10389 @opindex mcirrus-fix-invalid-insns
10390 @opindex mno-cirrus-fix-invalid-insns
10391 Insert NOPs into the instruction stream to in order to work around
10392 problems with invalid Maverick instruction combinations.  This option
10393 is only valid if the @option{-mcpu=ep9312} option has been used to
10394 enable generation of instructions for the Cirrus Maverick floating
10395 point co-processor.  This option is not enabled by default, since the
10396 problem is only present in older Maverick implementations.  The default
10397 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10398 switch.
10400 @item -mpoke-function-name
10401 @opindex mpoke-function-name
10402 Write the name of each function into the text section, directly
10403 preceding the function prologue.  The generated code is similar to this:
10405 @smallexample
10406      t0
10407          .ascii "arm_poke_function_name", 0
10408          .align
10409      t1
10410          .word 0xff000000 + (t1 - t0)
10411      arm_poke_function_name
10412          mov     ip, sp
10413          stmfd   sp!, @{fp, ip, lr, pc@}
10414          sub     fp, ip, #4
10415 @end smallexample
10417 When performing a stack backtrace, code can inspect the value of
10418 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10419 location @code{pc - 12} and the top 8 bits are set, then we know that
10420 there is a function name embedded immediately preceding this location
10421 and has length @code{((pc[-3]) & 0xff000000)}.
10423 @item -mthumb
10424 @itemx -marm
10425 @opindex marm
10426 @opindex mthumb
10428 Select between generating code that executes in ARM and Thumb
10429 states.  The default for most configurations is to generate code
10430 that executes in ARM state, but the default can be changed by
10431 configuring GCC with the @option{--with-mode=}@var{state}
10432 configure option.
10434 @item -mtpcs-frame
10435 @opindex mtpcs-frame
10436 Generate a stack frame that is compliant with the Thumb Procedure Call
10437 Standard for all non-leaf functions.  (A leaf function is one that does
10438 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10440 @item -mtpcs-leaf-frame
10441 @opindex mtpcs-leaf-frame
10442 Generate a stack frame that is compliant with the Thumb Procedure Call
10443 Standard for all leaf functions.  (A leaf function is one that does
10444 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10446 @item -mcallee-super-interworking
10447 @opindex mcallee-super-interworking
10448 Gives all externally visible functions in the file being compiled an ARM
10449 instruction set header which switches to Thumb mode before executing the
10450 rest of the function.  This allows these functions to be called from
10451 non-interworking code.  This option is not valid in AAPCS configurations
10452 because interworking is enabled by default.
10454 @item -mcaller-super-interworking
10455 @opindex mcaller-super-interworking
10456 Allows calls via function pointers (including virtual functions) to
10457 execute correctly regardless of whether the target code has been
10458 compiled for interworking or not.  There is a small overhead in the cost
10459 of executing a function pointer if this option is enabled.  This option
10460 is not valid in AAPCS configurations because interworking is enabled
10461 by default.
10463 @item -mtp=@var{name}
10464 @opindex mtp
10465 Specify the access model for the thread local storage pointer.  The valid
10466 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
10467 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
10468 (supported in the arm6k architecture), and @option{auto}, which uses the
10469 best available method for the selected processor.  The default setting is
10470 @option{auto}.
10472 @item -mword-relocations
10473 @opindex mword-relocations
10474 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
10475 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
10476 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
10477 is specified.
10479 @item -mfix-cortex-m3-ldrd
10480 @opindex mfix-cortex-m3-ldrd
10481 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
10482 with overlapping destination and base registers are used.  This option avoids
10483 generating these instructions.  This option is enabled by default when
10484 @option{-mcpu=cortex-m3} is specified.
10486 @end table
10488 @node AVR Options
10489 @subsection AVR Options
10490 @cindex AVR Options
10492 These options are defined for AVR implementations:
10494 @table @gcctabopt
10495 @item -mmcu=@var{mcu}
10496 @opindex mmcu
10497 Specify ATMEL AVR instruction set or MCU type.
10499 Instruction set avr1 is for the minimal AVR core, not supported by the C
10500 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10501 attiny11, attiny12, attiny15, attiny28).
10503 Instruction set avr2 (default) is for the classic AVR core with up to
10504 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10505 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10506 at90c8534, at90s8535).
10508 Instruction set avr3 is for the classic AVR core with up to 128K program
10509 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10511 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10512 memory space (MCU types: atmega8, atmega83, atmega85).
10514 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10515 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10516 atmega64, atmega128, at43usb355, at94k).
10518 @item -mno-interrupts
10519 @opindex mno-interrupts
10520 Generated code is not compatible with hardware interrupts.
10521 Code size will be smaller.
10523 @item -mcall-prologues
10524 @opindex mcall-prologues
10525 Functions prologues/epilogues expanded as call to appropriate
10526 subroutines.  Code size will be smaller.
10528 @item -mtiny-stack
10529 @opindex mtiny-stack
10530 Change only the low 8 bits of the stack pointer.
10532 @item -mint8
10533 @opindex mint8
10534 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10535 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10536 and long long will be 4 bytes.  Please note that this option does not
10537 comply to the C standards, but it will provide you with smaller code
10538 size.
10539 @end table
10541 @node Blackfin Options
10542 @subsection Blackfin Options
10543 @cindex Blackfin Options
10545 @table @gcctabopt
10546 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10547 @opindex mcpu=
10548 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10549 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10550 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10551 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10552 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10553 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10554 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10555 @samp{bf561}, @samp{bf592}.
10556 The optional @var{sirevision} specifies the silicon revision of the target
10557 Blackfin processor.  Any workarounds available for the targeted silicon revision
10558 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10559 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10560 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10561 hexadecimal digits representing the major and minor numbers in the silicon
10562 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10563 is not defined.  If @var{sirevision} is @samp{any}, the
10564 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10565 If this optional @var{sirevision} is not used, GCC assumes the latest known
10566 silicon revision of the targeted Blackfin processor.
10568 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10569 Only the processor macro is defined.
10570 Without this option, @samp{bf532} is used as the processor by default.
10571 The corresponding predefined processor macros for @var{cpu} is to
10572 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10573 provided by libgloss to be linked in if @option{-msim} is not given.
10575 @item -msim
10576 @opindex msim
10577 Specifies that the program will be run on the simulator.  This causes
10578 the simulator BSP provided by libgloss to be linked in.  This option
10579 has effect only for @samp{bfin-elf} toolchain.
10580 Certain other options, such as @option{-mid-shared-library} and
10581 @option{-mfdpic}, imply @option{-msim}.
10583 @item -momit-leaf-frame-pointer
10584 @opindex momit-leaf-frame-pointer
10585 Don't keep the frame pointer in a register for leaf functions.  This
10586 avoids the instructions to save, set up and restore frame pointers and
10587 makes an extra register available in leaf functions.  The option
10588 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10589 which might make debugging harder.
10591 @item -mspecld-anomaly
10592 @opindex mspecld-anomaly
10593 When enabled, the compiler will ensure that the generated code does not
10594 contain speculative loads after jump instructions. If this option is used,
10595 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10597 @item -mno-specld-anomaly
10598 @opindex mno-specld-anomaly
10599 Don't generate extra code to prevent speculative loads from occurring.
10601 @item -mcsync-anomaly
10602 @opindex mcsync-anomaly
10603 When enabled, the compiler will ensure that the generated code does not
10604 contain CSYNC or SSYNC instructions too soon after conditional branches.
10605 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10607 @item -mno-csync-anomaly
10608 @opindex mno-csync-anomaly
10609 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10610 occurring too soon after a conditional branch.
10612 @item -mlow-64k
10613 @opindex mlow-64k
10614 When enabled, the compiler is free to take advantage of the knowledge that
10615 the entire program fits into the low 64k of memory.
10617 @item -mno-low-64k
10618 @opindex mno-low-64k
10619 Assume that the program is arbitrarily large.  This is the default.
10621 @item -mstack-check-l1
10622 @opindex mstack-check-l1
10623 Do stack checking using information placed into L1 scratchpad memory by the
10624 uClinux kernel.
10626 @item -mid-shared-library
10627 @opindex mid-shared-library
10628 Generate code that supports shared libraries via the library ID method.
10629 This allows for execute in place and shared libraries in an environment
10630 without virtual memory management.  This option implies @option{-fPIC}.
10631 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10633 @item -mno-id-shared-library
10634 @opindex mno-id-shared-library
10635 Generate code that doesn't assume ID based shared libraries are being used.
10636 This is the default.
10638 @item -mleaf-id-shared-library
10639 @opindex mleaf-id-shared-library
10640 Generate code that supports shared libraries via the library ID method,
10641 but assumes that this library or executable won't link against any other
10642 ID shared libraries.  That allows the compiler to use faster code for jumps
10643 and calls.
10645 @item -mno-leaf-id-shared-library
10646 @opindex mno-leaf-id-shared-library
10647 Do not assume that the code being compiled won't link against any ID shared
10648 libraries.  Slower code will be generated for jump and call insns.
10650 @item -mshared-library-id=n
10651 @opindex mshared-library-id
10652 Specified the identification number of the ID based shared library being
10653 compiled.  Specifying a value of 0 will generate more compact code, specifying
10654 other values will force the allocation of that number to the current
10655 library but is no more space or time efficient than omitting this option.
10657 @item -msep-data
10658 @opindex msep-data
10659 Generate code that allows the data segment to be located in a different
10660 area of memory from the text segment.  This allows for execute in place in
10661 an environment without virtual memory management by eliminating relocations
10662 against the text section.
10664 @item -mno-sep-data
10665 @opindex mno-sep-data
10666 Generate code that assumes that the data segment follows the text segment.
10667 This is the default.
10669 @item -mlong-calls
10670 @itemx -mno-long-calls
10671 @opindex mlong-calls
10672 @opindex mno-long-calls
10673 Tells the compiler to perform function calls by first loading the
10674 address of the function into a register and then performing a subroutine
10675 call on this register.  This switch is needed if the target function
10676 will lie outside of the 24 bit addressing range of the offset based
10677 version of subroutine call instruction.
10679 This feature is not enabled by default.  Specifying
10680 @option{-mno-long-calls} will restore the default behavior.  Note these
10681 switches have no effect on how the compiler generates code to handle
10682 function calls via function pointers.
10684 @item -mfast-fp
10685 @opindex mfast-fp
10686 Link with the fast floating-point library. This library relaxes some of
10687 the IEEE floating-point standard's rules for checking inputs against
10688 Not-a-Number (NAN), in the interest of performance.
10690 @item -minline-plt
10691 @opindex minline-plt
10692 Enable inlining of PLT entries in function calls to functions that are
10693 not known to bind locally.  It has no effect without @option{-mfdpic}.
10695 @item -mmulticore
10696 @opindex mmulticore
10697 Build standalone application for multicore Blackfin processor. Proper
10698 start files and link scripts will be used to support multicore.
10699 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10700 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10701 @option{-mcorea} or @option{-mcoreb}. If it's used without
10702 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10703 programming model is used. In this model, the main function of Core B
10704 should be named as coreb_main. If it's used with @option{-mcorea} or
10705 @option{-mcoreb}, one application per core programming model is used.
10706 If this option is not used, single core application programming
10707 model is used.
10709 @item -mcorea
10710 @opindex mcorea
10711 Build standalone application for Core A of BF561 when using
10712 one application per core programming model. Proper start files
10713 and link scripts will be used to support Core A. This option
10714 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10716 @item -mcoreb
10717 @opindex mcoreb
10718 Build standalone application for Core B of BF561 when using
10719 one application per core programming model. Proper start files
10720 and link scripts will be used to support Core B. This option
10721 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10722 should be used instead of main. It must be used with
10723 @option{-mmulticore}.
10725 @item -msdram
10726 @opindex msdram
10727 Build standalone application for SDRAM. Proper start files and
10728 link scripts will be used to put the application into SDRAM.
10729 Loader should initialize SDRAM before loading the application
10730 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10732 @item -micplb
10733 @opindex micplb
10734 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10735 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10736 are enabled; for standalone applications the default is off.
10737 @end table
10739 @node CRIS Options
10740 @subsection CRIS Options
10741 @cindex CRIS Options
10743 These options are defined specifically for the CRIS ports.
10745 @table @gcctabopt
10746 @item -march=@var{architecture-type}
10747 @itemx -mcpu=@var{architecture-type}
10748 @opindex march
10749 @opindex mcpu
10750 Generate code for the specified architecture.  The choices for
10751 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10752 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10753 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10754 @samp{v10}.
10756 @item -mtune=@var{architecture-type}
10757 @opindex mtune
10758 Tune to @var{architecture-type} everything applicable about the generated
10759 code, except for the ABI and the set of available instructions.  The
10760 choices for @var{architecture-type} are the same as for
10761 @option{-march=@var{architecture-type}}.
10763 @item -mmax-stack-frame=@var{n}
10764 @opindex mmax-stack-frame
10765 Warn when the stack frame of a function exceeds @var{n} bytes.
10767 @item -metrax4
10768 @itemx -metrax100
10769 @opindex metrax4
10770 @opindex metrax100
10771 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10772 @option{-march=v3} and @option{-march=v8} respectively.
10774 @item -mmul-bug-workaround
10775 @itemx -mno-mul-bug-workaround
10776 @opindex mmul-bug-workaround
10777 @opindex mno-mul-bug-workaround
10778 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10779 models where it applies.  This option is active by default.
10781 @item -mpdebug
10782 @opindex mpdebug
10783 Enable CRIS-specific verbose debug-related information in the assembly
10784 code.  This option also has the effect to turn off the @samp{#NO_APP}
10785 formatted-code indicator to the assembler at the beginning of the
10786 assembly file.
10788 @item -mcc-init
10789 @opindex mcc-init
10790 Do not use condition-code results from previous instruction; always emit
10791 compare and test instructions before use of condition codes.
10793 @item -mno-side-effects
10794 @opindex mno-side-effects
10795 Do not emit instructions with side-effects in addressing modes other than
10796 post-increment.
10798 @item -mstack-align
10799 @itemx -mno-stack-align
10800 @itemx -mdata-align
10801 @itemx -mno-data-align
10802 @itemx -mconst-align
10803 @itemx -mno-const-align
10804 @opindex mstack-align
10805 @opindex mno-stack-align
10806 @opindex mdata-align
10807 @opindex mno-data-align
10808 @opindex mconst-align
10809 @opindex mno-const-align
10810 These options (no-options) arranges (eliminate arrangements) for the
10811 stack-frame, individual data and constants to be aligned for the maximum
10812 single data access size for the chosen CPU model.  The default is to
10813 arrange for 32-bit alignment.  ABI details such as structure layout are
10814 not affected by these options.
10816 @item -m32-bit
10817 @itemx -m16-bit
10818 @itemx -m8-bit
10819 @opindex m32-bit
10820 @opindex m16-bit
10821 @opindex m8-bit
10822 Similar to the stack- data- and const-align options above, these options
10823 arrange for stack-frame, writable data and constants to all be 32-bit,
10824 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10826 @item -mno-prologue-epilogue
10827 @itemx -mprologue-epilogue
10828 @opindex mno-prologue-epilogue
10829 @opindex mprologue-epilogue
10830 With @option{-mno-prologue-epilogue}, the normal function prologue and
10831 epilogue that sets up the stack-frame are omitted and no return
10832 instructions or return sequences are generated in the code.  Use this
10833 option only together with visual inspection of the compiled code: no
10834 warnings or errors are generated when call-saved registers must be saved,
10835 or storage for local variable needs to be allocated.
10837 @item -mno-gotplt
10838 @itemx -mgotplt
10839 @opindex mno-gotplt
10840 @opindex mgotplt
10841 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10842 instruction sequences that load addresses for functions from the PLT part
10843 of the GOT rather than (traditional on other architectures) calls to the
10844 PLT@.  The default is @option{-mgotplt}.
10846 @item -melf
10847 @opindex melf
10848 Legacy no-op option only recognized with the cris-axis-elf and
10849 cris-axis-linux-gnu targets.
10851 @item -mlinux
10852 @opindex mlinux
10853 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10855 @item -sim
10856 @opindex sim
10857 This option, recognized for the cris-axis-elf arranges
10858 to link with input-output functions from a simulator library.  Code,
10859 initialized data and zero-initialized data are allocated consecutively.
10861 @item -sim2
10862 @opindex sim2
10863 Like @option{-sim}, but pass linker options to locate initialized data at
10864 0x40000000 and zero-initialized data at 0x80000000.
10865 @end table
10867 @node Darwin Options
10868 @subsection Darwin Options
10869 @cindex Darwin options
10871 These options are defined for all architectures running the Darwin operating
10872 system.
10874 FSF GCC on Darwin does not create ``fat'' object files; it will create
10875 an object file for the single architecture that it was built to
10876 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10877 @option{-arch} options are used; it does so by running the compiler or
10878 linker multiple times and joining the results together with
10879 @file{lipo}.
10881 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10882 @samp{i686}) is determined by the flags that specify the ISA
10883 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10884 @option{-force_cpusubtype_ALL} option can be used to override this.
10886 The Darwin tools vary in their behavior when presented with an ISA
10887 mismatch.  The assembler, @file{as}, will only permit instructions to
10888 be used that are valid for the subtype of the file it is generating,
10889 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10890 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10891 and print an error if asked to create a shared library with a less
10892 restrictive subtype than its input files (for instance, trying to put
10893 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10894 for executables, @file{ld}, will quietly give the executable the most
10895 restrictive subtype of any of its input files.
10897 @table @gcctabopt
10898 @item -F@var{dir}
10899 @opindex F
10900 Add the framework directory @var{dir} to the head of the list of
10901 directories to be searched for header files.  These directories are
10902 interleaved with those specified by @option{-I} options and are
10903 scanned in a left-to-right order.
10905 A framework directory is a directory with frameworks in it.  A
10906 framework is a directory with a @samp{"Headers"} and/or
10907 @samp{"PrivateHeaders"} directory contained directly in it that ends
10908 in @samp{".framework"}.  The name of a framework is the name of this
10909 directory excluding the @samp{".framework"}.  Headers associated with
10910 the framework are found in one of those two directories, with
10911 @samp{"Headers"} being searched first.  A subframework is a framework
10912 directory that is in a framework's @samp{"Frameworks"} directory.
10913 Includes of subframework headers can only appear in a header of a
10914 framework that contains the subframework, or in a sibling subframework
10915 header.  Two subframeworks are siblings if they occur in the same
10916 framework.  A subframework should not have the same name as a
10917 framework, a warning will be issued if this is violated.  Currently a
10918 subframework cannot have subframeworks, in the future, the mechanism
10919 may be extended to support this.  The standard frameworks can be found
10920 in @samp{"/System/Library/Frameworks"} and
10921 @samp{"/Library/Frameworks"}.  An example include looks like
10922 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10923 the name of the framework and header.h is found in the
10924 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10926 @item -iframework@var{dir}
10927 @opindex iframework
10928 Like @option{-F} except the directory is a treated as a system
10929 directory.  The main difference between this @option{-iframework} and
10930 @option{-F} is that with @option{-iframework} the compiler does not
10931 warn about constructs contained within header files found via
10932 @var{dir}.  This option is valid only for the C family of languages.
10934 @item -gused
10935 @opindex gused
10936 Emit debugging information for symbols that are used.  For STABS
10937 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10938 This is by default ON@.
10940 @item -gfull
10941 @opindex gfull
10942 Emit debugging information for all symbols and types.
10944 @item -mmacosx-version-min=@var{version}
10945 The earliest version of MacOS X that this executable will run on
10946 is @var{version}.  Typical values of @var{version} include @code{10.1},
10947 @code{10.2}, and @code{10.3.9}.
10949 If the compiler was built to use the system's headers by default,
10950 then the default for this option is the system version on which the
10951 compiler is running, otherwise the default is to make choices which
10952 are compatible with as many systems and code bases as possible.
10954 @item -mkernel
10955 @opindex mkernel
10956 Enable kernel development mode.  The @option{-mkernel} option sets
10957 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10958 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10959 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10960 applicable.  This mode also sets @option{-mno-altivec},
10961 @option{-msoft-float}, @option{-fno-builtin} and
10962 @option{-mlong-branch} for PowerPC targets.
10964 @item -mone-byte-bool
10965 @opindex mone-byte-bool
10966 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10967 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10968 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10969 option has no effect on x86.
10971 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10972 to generate code that is not binary compatible with code generated
10973 without that switch.  Using this switch may require recompiling all
10974 other modules in a program, including system libraries.  Use this
10975 switch to conform to a non-default data model.
10977 @item -mfix-and-continue
10978 @itemx -ffix-and-continue
10979 @itemx -findirect-data
10980 @opindex mfix-and-continue
10981 @opindex ffix-and-continue
10982 @opindex findirect-data
10983 Generate code suitable for fast turn around development.  Needed to
10984 enable gdb to dynamically load @code{.o} files into already running
10985 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10986 are provided for backwards compatibility.
10988 @item -all_load
10989 @opindex all_load
10990 Loads all members of static archive libraries.
10991 See man ld(1) for more information.
10993 @item -arch_errors_fatal
10994 @opindex arch_errors_fatal
10995 Cause the errors having to do with files that have the wrong architecture
10996 to be fatal.
10998 @item -bind_at_load
10999 @opindex bind_at_load
11000 Causes the output file to be marked such that the dynamic linker will
11001 bind all undefined references when the file is loaded or launched.
11003 @item -bundle
11004 @opindex bundle
11005 Produce a Mach-o bundle format file.
11006 See man ld(1) for more information.
11008 @item -bundle_loader @var{executable}
11009 @opindex bundle_loader
11010 This option specifies the @var{executable} that will be loading the build
11011 output file being linked.  See man ld(1) for more information.
11013 @item -dynamiclib
11014 @opindex dynamiclib
11015 When passed this option, GCC will produce a dynamic library instead of
11016 an executable when linking, using the Darwin @file{libtool} command.
11018 @item -force_cpusubtype_ALL
11019 @opindex force_cpusubtype_ALL
11020 This causes GCC's output file to have the @var{ALL} subtype, instead of
11021 one controlled by the @option{-mcpu} or @option{-march} option.
11023 @item -allowable_client  @var{client_name}
11024 @itemx -client_name
11025 @itemx -compatibility_version
11026 @itemx -current_version
11027 @itemx -dead_strip
11028 @itemx -dependency-file
11029 @itemx -dylib_file
11030 @itemx -dylinker_install_name
11031 @itemx -dynamic
11032 @itemx -exported_symbols_list
11033 @itemx -filelist
11034 @need 800
11035 @itemx -flat_namespace
11036 @itemx -force_flat_namespace
11037 @itemx -headerpad_max_install_names
11038 @itemx -image_base
11039 @itemx -init
11040 @itemx -install_name
11041 @itemx -keep_private_externs
11042 @itemx -multi_module
11043 @itemx -multiply_defined
11044 @itemx -multiply_defined_unused
11045 @need 800
11046 @itemx -noall_load
11047 @itemx -no_dead_strip_inits_and_terms
11048 @itemx -nofixprebinding
11049 @itemx -nomultidefs
11050 @itemx -noprebind
11051 @itemx -noseglinkedit
11052 @itemx -pagezero_size
11053 @itemx -prebind
11054 @itemx -prebind_all_twolevel_modules
11055 @itemx -private_bundle
11056 @need 800
11057 @itemx -read_only_relocs
11058 @itemx -sectalign
11059 @itemx -sectobjectsymbols
11060 @itemx -whyload
11061 @itemx -seg1addr
11062 @itemx -sectcreate
11063 @itemx -sectobjectsymbols
11064 @itemx -sectorder
11065 @itemx -segaddr
11066 @itemx -segs_read_only_addr
11067 @need 800
11068 @itemx -segs_read_write_addr
11069 @itemx -seg_addr_table
11070 @itemx -seg_addr_table_filename
11071 @itemx -seglinkedit
11072 @itemx -segprot
11073 @itemx -segs_read_only_addr
11074 @itemx -segs_read_write_addr
11075 @itemx -single_module
11076 @itemx -static
11077 @itemx -sub_library
11078 @need 800
11079 @itemx -sub_umbrella
11080 @itemx -twolevel_namespace
11081 @itemx -umbrella
11082 @itemx -undefined
11083 @itemx -unexported_symbols_list
11084 @itemx -weak_reference_mismatches
11085 @itemx -whatsloaded
11086 @opindex allowable_client
11087 @opindex client_name
11088 @opindex compatibility_version
11089 @opindex current_version
11090 @opindex dead_strip
11091 @opindex dependency-file
11092 @opindex dylib_file
11093 @opindex dylinker_install_name
11094 @opindex dynamic
11095 @opindex exported_symbols_list
11096 @opindex filelist
11097 @opindex flat_namespace
11098 @opindex force_flat_namespace
11099 @opindex headerpad_max_install_names
11100 @opindex image_base
11101 @opindex init
11102 @opindex install_name
11103 @opindex keep_private_externs
11104 @opindex multi_module
11105 @opindex multiply_defined
11106 @opindex multiply_defined_unused
11107 @opindex noall_load
11108 @opindex no_dead_strip_inits_and_terms
11109 @opindex nofixprebinding
11110 @opindex nomultidefs
11111 @opindex noprebind
11112 @opindex noseglinkedit
11113 @opindex pagezero_size
11114 @opindex prebind
11115 @opindex prebind_all_twolevel_modules
11116 @opindex private_bundle
11117 @opindex read_only_relocs
11118 @opindex sectalign
11119 @opindex sectobjectsymbols
11120 @opindex whyload
11121 @opindex seg1addr
11122 @opindex sectcreate
11123 @opindex sectobjectsymbols
11124 @opindex sectorder
11125 @opindex segaddr
11126 @opindex segs_read_only_addr
11127 @opindex segs_read_write_addr
11128 @opindex seg_addr_table
11129 @opindex seg_addr_table_filename
11130 @opindex seglinkedit
11131 @opindex segprot
11132 @opindex segs_read_only_addr
11133 @opindex segs_read_write_addr
11134 @opindex single_module
11135 @opindex static
11136 @opindex sub_library
11137 @opindex sub_umbrella
11138 @opindex twolevel_namespace
11139 @opindex umbrella
11140 @opindex undefined
11141 @opindex unexported_symbols_list
11142 @opindex weak_reference_mismatches
11143 @opindex whatsloaded
11144 These options are passed to the Darwin linker.  The Darwin linker man page
11145 describes them in detail.
11146 @end table
11148 @node DEC Alpha Options
11149 @subsection DEC Alpha Options
11151 These @samp{-m} options are defined for the DEC Alpha implementations:
11153 @table @gcctabopt
11154 @item -mno-soft-float
11155 @itemx -msoft-float
11156 @opindex mno-soft-float
11157 @opindex msoft-float
11158 Use (do not use) the hardware floating-point instructions for
11159 floating-point operations.  When @option{-msoft-float} is specified,
11160 functions in @file{libgcc.a} will be used to perform floating-point
11161 operations.  Unless they are replaced by routines that emulate the
11162 floating-point operations, or compiled in such a way as to call such
11163 emulations routines, these routines will issue floating-point
11164 operations.   If you are compiling for an Alpha without floating-point
11165 operations, you must ensure that the library is built so as not to call
11166 them.
11168 Note that Alpha implementations without floating-point operations are
11169 required to have floating-point registers.
11171 @item -mfp-reg
11172 @itemx -mno-fp-regs
11173 @opindex mfp-reg
11174 @opindex mno-fp-regs
11175 Generate code that uses (does not use) the floating-point register set.
11176 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
11177 register set is not used, floating point operands are passed in integer
11178 registers as if they were integers and floating-point results are passed
11179 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
11180 so any function with a floating-point argument or return value called by code
11181 compiled with @option{-mno-fp-regs} must also be compiled with that
11182 option.
11184 A typical use of this option is building a kernel that does not use,
11185 and hence need not save and restore, any floating-point registers.
11187 @item -mieee
11188 @opindex mieee
11189 The Alpha architecture implements floating-point hardware optimized for
11190 maximum performance.  It is mostly compliant with the IEEE floating
11191 point standard.  However, for full compliance, software assistance is
11192 required.  This option generates code fully IEEE compliant code
11193 @emph{except} that the @var{inexact-flag} is not maintained (see below).
11194 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
11195 defined during compilation.  The resulting code is less efficient but is
11196 able to correctly support denormalized numbers and exceptional IEEE
11197 values such as not-a-number and plus/minus infinity.  Other Alpha
11198 compilers call this option @option{-ieee_with_no_inexact}.
11200 @item -mieee-with-inexact
11201 @opindex mieee-with-inexact
11202 This is like @option{-mieee} except the generated code also maintains
11203 the IEEE @var{inexact-flag}.  Turning on this option causes the
11204 generated code to implement fully-compliant IEEE math.  In addition to
11205 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
11206 macro.  On some Alpha implementations the resulting code may execute
11207 significantly slower than the code generated by default.  Since there is
11208 very little code that depends on the @var{inexact-flag}, you should
11209 normally not specify this option.  Other Alpha compilers call this
11210 option @option{-ieee_with_inexact}.
11212 @item -mfp-trap-mode=@var{trap-mode}
11213 @opindex mfp-trap-mode
11214 This option controls what floating-point related traps are enabled.
11215 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
11216 The trap mode can be set to one of four values:
11218 @table @samp
11219 @item n
11220 This is the default (normal) setting.  The only traps that are enabled
11221 are the ones that cannot be disabled in software (e.g., division by zero
11222 trap).
11224 @item u
11225 In addition to the traps enabled by @samp{n}, underflow traps are enabled
11226 as well.
11228 @item su
11229 Like @samp{u}, but the instructions are marked to be safe for software
11230 completion (see Alpha architecture manual for details).
11232 @item sui
11233 Like @samp{su}, but inexact traps are enabled as well.
11234 @end table
11236 @item -mfp-rounding-mode=@var{rounding-mode}
11237 @opindex mfp-rounding-mode
11238 Selects the IEEE rounding mode.  Other Alpha compilers call this option
11239 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
11242 @table @samp
11243 @item n
11244 Normal IEEE rounding mode.  Floating point numbers are rounded towards
11245 the nearest machine number or towards the even machine number in case
11246 of a tie.
11248 @item m
11249 Round towards minus infinity.
11251 @item c
11252 Chopped rounding mode.  Floating point numbers are rounded towards zero.
11254 @item d
11255 Dynamic rounding mode.  A field in the floating point control register
11256 (@var{fpcr}, see Alpha architecture reference manual) controls the
11257 rounding mode in effect.  The C library initializes this register for
11258 rounding towards plus infinity.  Thus, unless your program modifies the
11259 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
11260 @end table
11262 @item -mtrap-precision=@var{trap-precision}
11263 @opindex mtrap-precision
11264 In the Alpha architecture, floating point traps are imprecise.  This
11265 means without software assistance it is impossible to recover from a
11266 floating trap and program execution normally needs to be terminated.
11267 GCC can generate code that can assist operating system trap handlers
11268 in determining the exact location that caused a floating point trap.
11269 Depending on the requirements of an application, different levels of
11270 precisions can be selected:
11272 @table @samp
11273 @item p
11274 Program precision.  This option is the default and means a trap handler
11275 can only identify which program caused a floating point exception.
11277 @item f
11278 Function precision.  The trap handler can determine the function that
11279 caused a floating point exception.
11281 @item i
11282 Instruction precision.  The trap handler can determine the exact
11283 instruction that caused a floating point exception.
11284 @end table
11286 Other Alpha compilers provide the equivalent options called
11287 @option{-scope_safe} and @option{-resumption_safe}.
11289 @item -mieee-conformant
11290 @opindex mieee-conformant
11291 This option marks the generated code as IEEE conformant.  You must not
11292 use this option unless you also specify @option{-mtrap-precision=i} and either
11293 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
11294 is to emit the line @samp{.eflag 48} in the function prologue of the
11295 generated assembly file.  Under DEC Unix, this has the effect that
11296 IEEE-conformant math library routines will be linked in.
11298 @item -mbuild-constants
11299 @opindex mbuild-constants
11300 Normally GCC examines a 32- or 64-bit integer constant to
11301 see if it can construct it from smaller constants in two or three
11302 instructions.  If it cannot, it will output the constant as a literal and
11303 generate code to load it from the data segment at runtime.
11305 Use this option to require GCC to construct @emph{all} integer constants
11306 using code, even if it takes more instructions (the maximum is six).
11308 You would typically use this option to build a shared library dynamic
11309 loader.  Itself a shared library, it must relocate itself in memory
11310 before it can find the variables and constants in its own data segment.
11312 @item -malpha-as
11313 @itemx -mgas
11314 @opindex malpha-as
11315 @opindex mgas
11316 Select whether to generate code to be assembled by the vendor-supplied
11317 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
11319 @item -mbwx
11320 @itemx -mno-bwx
11321 @itemx -mcix
11322 @itemx -mno-cix
11323 @itemx -mfix
11324 @itemx -mno-fix
11325 @itemx -mmax
11326 @itemx -mno-max
11327 @opindex mbwx
11328 @opindex mno-bwx
11329 @opindex mcix
11330 @opindex mno-cix
11331 @opindex mfix
11332 @opindex mno-fix
11333 @opindex mmax
11334 @opindex mno-max
11335 Indicate whether GCC should generate code to use the optional BWX,
11336 CIX, FIX and MAX instruction sets.  The default is to use the instruction
11337 sets supported by the CPU type specified via @option{-mcpu=} option or that
11338 of the CPU on which GCC was built if none was specified.
11340 @item -mfloat-vax
11341 @itemx -mfloat-ieee
11342 @opindex mfloat-vax
11343 @opindex mfloat-ieee
11344 Generate code that uses (does not use) VAX F and G floating point
11345 arithmetic instead of IEEE single and double precision.
11347 @item -mexplicit-relocs
11348 @itemx -mno-explicit-relocs
11349 @opindex mexplicit-relocs
11350 @opindex mno-explicit-relocs
11351 Older Alpha assemblers provided no way to generate symbol relocations
11352 except via assembler macros.  Use of these macros does not allow
11353 optimal instruction scheduling.  GNU binutils as of version 2.12
11354 supports a new syntax that allows the compiler to explicitly mark
11355 which relocations should apply to which instructions.  This option
11356 is mostly useful for debugging, as GCC detects the capabilities of
11357 the assembler when it is built and sets the default accordingly.
11359 @item -msmall-data
11360 @itemx -mlarge-data
11361 @opindex msmall-data
11362 @opindex mlarge-data
11363 When @option{-mexplicit-relocs} is in effect, static data is
11364 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
11365 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
11366 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
11367 16-bit relocations off of the @code{$gp} register.  This limits the
11368 size of the small data area to 64KB, but allows the variables to be
11369 directly accessed via a single instruction.
11371 The default is @option{-mlarge-data}.  With this option the data area
11372 is limited to just below 2GB@.  Programs that require more than 2GB of
11373 data must use @code{malloc} or @code{mmap} to allocate the data in the
11374 heap instead of in the program's data segment.
11376 When generating code for shared libraries, @option{-fpic} implies
11377 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
11379 @item -msmall-text
11380 @itemx -mlarge-text
11381 @opindex msmall-text
11382 @opindex mlarge-text
11383 When @option{-msmall-text} is used, the compiler assumes that the
11384 code of the entire program (or shared library) fits in 4MB, and is
11385 thus reachable with a branch instruction.  When @option{-msmall-data}
11386 is used, the compiler can assume that all local symbols share the
11387 same @code{$gp} value, and thus reduce the number of instructions
11388 required for a function call from 4 to 1.
11390 The default is @option{-mlarge-text}.
11392 @item -mcpu=@var{cpu_type}
11393 @opindex mcpu
11394 Set the instruction set and instruction scheduling parameters for
11395 machine type @var{cpu_type}.  You can specify either the @samp{EV}
11396 style name or the corresponding chip number.  GCC supports scheduling
11397 parameters for the EV4, EV5 and EV6 family of processors and will
11398 choose the default values for the instruction set from the processor
11399 you specify.  If you do not specify a processor type, GCC will default
11400 to the processor on which the compiler was built.
11402 Supported values for @var{cpu_type} are
11404 @table @samp
11405 @item ev4
11406 @itemx ev45
11407 @itemx 21064
11408 Schedules as an EV4 and has no instruction set extensions.
11410 @item ev5
11411 @itemx 21164
11412 Schedules as an EV5 and has no instruction set extensions.
11414 @item ev56
11415 @itemx 21164a
11416 Schedules as an EV5 and supports the BWX extension.
11418 @item pca56
11419 @itemx 21164pc
11420 @itemx 21164PC
11421 Schedules as an EV5 and supports the BWX and MAX extensions.
11423 @item ev6
11424 @itemx 21264
11425 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
11427 @item ev67
11428 @itemx 21264a
11429 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
11430 @end table
11432 Native Linux/GNU toolchains also support the value @samp{native},
11433 which selects the best architecture option for the host processor.
11434 @option{-mcpu=native} has no effect if GCC does not recognize
11435 the processor.
11437 @item -mtune=@var{cpu_type}
11438 @opindex mtune
11439 Set only the instruction scheduling parameters for machine type
11440 @var{cpu_type}.  The instruction set is not changed.
11442 Native Linux/GNU toolchains also support the value @samp{native},
11443 which selects the best architecture option for the host processor.
11444 @option{-mtune=native} has no effect if GCC does not recognize
11445 the processor.
11447 @item -mmemory-latency=@var{time}
11448 @opindex mmemory-latency
11449 Sets the latency the scheduler should assume for typical memory
11450 references as seen by the application.  This number is highly
11451 dependent on the memory access patterns used by the application
11452 and the size of the external cache on the machine.
11454 Valid options for @var{time} are
11456 @table @samp
11457 @item @var{number}
11458 A decimal number representing clock cycles.
11460 @item L1
11461 @itemx L2
11462 @itemx L3
11463 @itemx main
11464 The compiler contains estimates of the number of clock cycles for
11465 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
11466 (also called Dcache, Scache, and Bcache), as well as to main memory.
11467 Note that L3 is only valid for EV5.
11469 @end table
11470 @end table
11472 @node DEC Alpha/VMS Options
11473 @subsection DEC Alpha/VMS Options
11475 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
11477 @table @gcctabopt
11478 @item -mvms-return-codes
11479 @opindex mvms-return-codes
11480 Return VMS condition codes from main.  The default is to return POSIX
11481 style condition (e.g.@: error) codes.
11483 @item -mdebug-main=@var{prefix}
11484 @opindex mdebug-main=@var{prefix}
11485 Flag the first routine whose name starts with @var{prefix} as the main
11486 routine for the debugger.
11488 @item -mmalloc64
11489 @opindex mmalloc64
11490 Default to 64bit memory allocation routines.
11491 @end table
11493 @node FR30 Options
11494 @subsection FR30 Options
11495 @cindex FR30 Options
11497 These options are defined specifically for the FR30 port.
11499 @table @gcctabopt
11501 @item -msmall-model
11502 @opindex msmall-model
11503 Use the small address space model.  This can produce smaller code, but
11504 it does assume that all symbolic values and addresses will fit into a
11505 20-bit range.
11507 @item -mno-lsim
11508 @opindex mno-lsim
11509 Assume that run-time support has been provided and so there is no need
11510 to include the simulator library (@file{libsim.a}) on the linker
11511 command line.
11513 @end table
11515 @node FRV Options
11516 @subsection FRV Options
11517 @cindex FRV Options
11519 @table @gcctabopt
11520 @item -mgpr-32
11521 @opindex mgpr-32
11523 Only use the first 32 general purpose registers.
11525 @item -mgpr-64
11526 @opindex mgpr-64
11528 Use all 64 general purpose registers.
11530 @item -mfpr-32
11531 @opindex mfpr-32
11533 Use only the first 32 floating point registers.
11535 @item -mfpr-64
11536 @opindex mfpr-64
11538 Use all 64 floating point registers
11540 @item -mhard-float
11541 @opindex mhard-float
11543 Use hardware instructions for floating point operations.
11545 @item -msoft-float
11546 @opindex msoft-float
11548 Use library routines for floating point operations.
11550 @item -malloc-cc
11551 @opindex malloc-cc
11553 Dynamically allocate condition code registers.
11555 @item -mfixed-cc
11556 @opindex mfixed-cc
11558 Do not try to dynamically allocate condition code registers, only
11559 use @code{icc0} and @code{fcc0}.
11561 @item -mdword
11562 @opindex mdword
11564 Change ABI to use double word insns.
11566 @item -mno-dword
11567 @opindex mno-dword
11569 Do not use double word instructions.
11571 @item -mdouble
11572 @opindex mdouble
11574 Use floating point double instructions.
11576 @item -mno-double
11577 @opindex mno-double
11579 Do not use floating point double instructions.
11581 @item -mmedia
11582 @opindex mmedia
11584 Use media instructions.
11586 @item -mno-media
11587 @opindex mno-media
11589 Do not use media instructions.
11591 @item -mmuladd
11592 @opindex mmuladd
11594 Use multiply and add/subtract instructions.
11596 @item -mno-muladd
11597 @opindex mno-muladd
11599 Do not use multiply and add/subtract instructions.
11601 @item -mfdpic
11602 @opindex mfdpic
11604 Select the FDPIC ABI, that uses function descriptors to represent
11605 pointers to functions.  Without any PIC/PIE-related options, it
11606 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11607 assumes GOT entries and small data are within a 12-bit range from the
11608 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11609 are computed with 32 bits.
11610 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11612 @item -minline-plt
11613 @opindex minline-plt
11615 Enable inlining of PLT entries in function calls to functions that are
11616 not known to bind locally.  It has no effect without @option{-mfdpic}.
11617 It's enabled by default if optimizing for speed and compiling for
11618 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11619 optimization option such as @option{-O3} or above is present in the
11620 command line.
11622 @item -mTLS
11623 @opindex mTLS
11625 Assume a large TLS segment when generating thread-local code.
11627 @item -mtls
11628 @opindex mtls
11630 Do not assume a large TLS segment when generating thread-local code.
11632 @item -mgprel-ro
11633 @opindex mgprel-ro
11635 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11636 that is known to be in read-only sections.  It's enabled by default,
11637 except for @option{-fpic} or @option{-fpie}: even though it may help
11638 make the global offset table smaller, it trades 1 instruction for 4.
11639 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11640 one of which may be shared by multiple symbols, and it avoids the need
11641 for a GOT entry for the referenced symbol, so it's more likely to be a
11642 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11644 @item -multilib-library-pic
11645 @opindex multilib-library-pic
11647 Link with the (library, not FD) pic libraries.  It's implied by
11648 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11649 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11650 it explicitly.
11652 @item -mlinked-fp
11653 @opindex mlinked-fp
11655 Follow the EABI requirement of always creating a frame pointer whenever
11656 a stack frame is allocated.  This option is enabled by default and can
11657 be disabled with @option{-mno-linked-fp}.
11659 @item -mlong-calls
11660 @opindex mlong-calls
11662 Use indirect addressing to call functions outside the current
11663 compilation unit.  This allows the functions to be placed anywhere
11664 within the 32-bit address space.
11666 @item -malign-labels
11667 @opindex malign-labels
11669 Try to align labels to an 8-byte boundary by inserting nops into the
11670 previous packet.  This option only has an effect when VLIW packing
11671 is enabled.  It doesn't create new packets; it merely adds nops to
11672 existing ones.
11674 @item -mlibrary-pic
11675 @opindex mlibrary-pic
11677 Generate position-independent EABI code.
11679 @item -macc-4
11680 @opindex macc-4
11682 Use only the first four media accumulator registers.
11684 @item -macc-8
11685 @opindex macc-8
11687 Use all eight media accumulator registers.
11689 @item -mpack
11690 @opindex mpack
11692 Pack VLIW instructions.
11694 @item -mno-pack
11695 @opindex mno-pack
11697 Do not pack VLIW instructions.
11699 @item -mno-eflags
11700 @opindex mno-eflags
11702 Do not mark ABI switches in e_flags.
11704 @item -mcond-move
11705 @opindex mcond-move
11707 Enable the use of conditional-move instructions (default).
11709 This switch is mainly for debugging the compiler and will likely be removed
11710 in a future version.
11712 @item -mno-cond-move
11713 @opindex mno-cond-move
11715 Disable the use of conditional-move instructions.
11717 This switch is mainly for debugging the compiler and will likely be removed
11718 in a future version.
11720 @item -mscc
11721 @opindex mscc
11723 Enable the use of conditional set instructions (default).
11725 This switch is mainly for debugging the compiler and will likely be removed
11726 in a future version.
11728 @item -mno-scc
11729 @opindex mno-scc
11731 Disable the use of conditional set instructions.
11733 This switch is mainly for debugging the compiler and will likely be removed
11734 in a future version.
11736 @item -mcond-exec
11737 @opindex mcond-exec
11739 Enable the use of conditional execution (default).
11741 This switch is mainly for debugging the compiler and will likely be removed
11742 in a future version.
11744 @item -mno-cond-exec
11745 @opindex mno-cond-exec
11747 Disable the use of conditional execution.
11749 This switch is mainly for debugging the compiler and will likely be removed
11750 in a future version.
11752 @item -mvliw-branch
11753 @opindex mvliw-branch
11755 Run a pass to pack branches into VLIW instructions (default).
11757 This switch is mainly for debugging the compiler and will likely be removed
11758 in a future version.
11760 @item -mno-vliw-branch
11761 @opindex mno-vliw-branch
11763 Do not run a pass to pack branches into VLIW instructions.
11765 This switch is mainly for debugging the compiler and will likely be removed
11766 in a future version.
11768 @item -mmulti-cond-exec
11769 @opindex mmulti-cond-exec
11771 Enable optimization of @code{&&} and @code{||} in conditional execution
11772 (default).
11774 This switch is mainly for debugging the compiler and will likely be removed
11775 in a future version.
11777 @item -mno-multi-cond-exec
11778 @opindex mno-multi-cond-exec
11780 Disable optimization of @code{&&} and @code{||} in conditional execution.
11782 This switch is mainly for debugging the compiler and will likely be removed
11783 in a future version.
11785 @item -mnested-cond-exec
11786 @opindex mnested-cond-exec
11788 Enable nested conditional execution optimizations (default).
11790 This switch is mainly for debugging the compiler and will likely be removed
11791 in a future version.
11793 @item -mno-nested-cond-exec
11794 @opindex mno-nested-cond-exec
11796 Disable nested conditional execution optimizations.
11798 This switch is mainly for debugging the compiler and will likely be removed
11799 in a future version.
11801 @item -moptimize-membar
11802 @opindex moptimize-membar
11804 This switch removes redundant @code{membar} instructions from the
11805 compiler generated code.  It is enabled by default.
11807 @item -mno-optimize-membar
11808 @opindex mno-optimize-membar
11810 This switch disables the automatic removal of redundant @code{membar}
11811 instructions from the generated code.
11813 @item -mtomcat-stats
11814 @opindex mtomcat-stats
11816 Cause gas to print out tomcat statistics.
11818 @item -mcpu=@var{cpu}
11819 @opindex mcpu
11821 Select the processor type for which to generate code.  Possible values are
11822 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11823 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11825 @end table
11827 @node GNU/Linux Options
11828 @subsection GNU/Linux Options
11830 These @samp{-m} options are defined for GNU/Linux targets:
11832 @table @gcctabopt
11833 @item -mglibc
11834 @opindex mglibc
11835 Use the GNU C library.  This is the default except
11836 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
11838 @item -muclibc
11839 @opindex muclibc
11840 Use uClibc C library.  This is the default on
11841 @samp{*-*-linux-*uclibc*} targets.
11843 @item -mbionic
11844 @opindex mbionic
11845 Use Bionic C library.  This is the default on
11846 @samp{*-*-linux-*android*} targets.
11848 @item -mandroid
11849 @opindex mandroid
11850 Compile code compatible with Android platform.  This is the default on
11851 @samp{*-*-linux-*android*} targets.
11853 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
11854 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
11855 this option makes the GCC driver pass Android-specific options to the linker.
11856 Finally, this option causes the preprocessor macro @code{__ANDROID__}
11857 to be defined.
11859 @item -tno-android-cc
11860 @opindex tno-android-cc
11861 Disable compilation effects of @option{-mandroid}, i.e., do not enable
11862 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
11863 @option{-fno-rtti} by default.
11865 @item -tno-android-ld
11866 @opindex tno-android-ld
11867 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
11868 linking options to the linker.
11870 @end table
11872 @node H8/300 Options
11873 @subsection H8/300 Options
11875 These @samp{-m} options are defined for the H8/300 implementations:
11877 @table @gcctabopt
11878 @item -mrelax
11879 @opindex mrelax
11880 Shorten some address references at link time, when possible; uses the
11881 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11882 ld, Using ld}, for a fuller description.
11884 @item -mh
11885 @opindex mh
11886 Generate code for the H8/300H@.
11888 @item -ms
11889 @opindex ms
11890 Generate code for the H8S@.
11892 @item -mn
11893 @opindex mn
11894 Generate code for the H8S and H8/300H in the normal mode.  This switch
11895 must be used either with @option{-mh} or @option{-ms}.
11897 @item -ms2600
11898 @opindex ms2600
11899 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11901 @item -mint32
11902 @opindex mint32
11903 Make @code{int} data 32 bits by default.
11905 @item -malign-300
11906 @opindex malign-300
11907 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11908 The default for the H8/300H and H8S is to align longs and floats on 4
11909 byte boundaries.
11910 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11911 This option has no effect on the H8/300.
11912 @end table
11914 @node HPPA Options
11915 @subsection HPPA Options
11916 @cindex HPPA Options
11918 These @samp{-m} options are defined for the HPPA family of computers:
11920 @table @gcctabopt
11921 @item -march=@var{architecture-type}
11922 @opindex march
11923 Generate code for the specified architecture.  The choices for
11924 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11925 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11926 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11927 architecture option for your machine.  Code compiled for lower numbered
11928 architectures will run on higher numbered architectures, but not the
11929 other way around.
11931 @item -mpa-risc-1-0
11932 @itemx -mpa-risc-1-1
11933 @itemx -mpa-risc-2-0
11934 @opindex mpa-risc-1-0
11935 @opindex mpa-risc-1-1
11936 @opindex mpa-risc-2-0
11937 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11939 @item -mbig-switch
11940 @opindex mbig-switch
11941 Generate code suitable for big switch tables.  Use this option only if
11942 the assembler/linker complain about out of range branches within a switch
11943 table.
11945 @item -mjump-in-delay
11946 @opindex mjump-in-delay
11947 Fill delay slots of function calls with unconditional jump instructions
11948 by modifying the return pointer for the function call to be the target
11949 of the conditional jump.
11951 @item -mdisable-fpregs
11952 @opindex mdisable-fpregs
11953 Prevent floating point registers from being used in any manner.  This is
11954 necessary for compiling kernels which perform lazy context switching of
11955 floating point registers.  If you use this option and attempt to perform
11956 floating point operations, the compiler will abort.
11958 @item -mdisable-indexing
11959 @opindex mdisable-indexing
11960 Prevent the compiler from using indexing address modes.  This avoids some
11961 rather obscure problems when compiling MIG generated code under MACH@.
11963 @item -mno-space-regs
11964 @opindex mno-space-regs
11965 Generate code that assumes the target has no space registers.  This allows
11966 GCC to generate faster indirect calls and use unscaled index address modes.
11968 Such code is suitable for level 0 PA systems and kernels.
11970 @item -mfast-indirect-calls
11971 @opindex mfast-indirect-calls
11972 Generate code that assumes calls never cross space boundaries.  This
11973 allows GCC to emit code which performs faster indirect calls.
11975 This option will not work in the presence of shared libraries or nested
11976 functions.
11978 @item -mfixed-range=@var{register-range}
11979 @opindex mfixed-range
11980 Generate code treating the given register range as fixed registers.
11981 A fixed register is one that the register allocator can not use.  This is
11982 useful when compiling kernel code.  A register range is specified as
11983 two registers separated by a dash.  Multiple register ranges can be
11984 specified separated by a comma.
11986 @item -mlong-load-store
11987 @opindex mlong-load-store
11988 Generate 3-instruction load and store sequences as sometimes required by
11989 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11990 the HP compilers.
11992 @item -mportable-runtime
11993 @opindex mportable-runtime
11994 Use the portable calling conventions proposed by HP for ELF systems.
11996 @item -mgas
11997 @opindex mgas
11998 Enable the use of assembler directives only GAS understands.
12000 @item -mschedule=@var{cpu-type}
12001 @opindex mschedule
12002 Schedule code according to the constraints for the machine type
12003 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
12004 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
12005 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
12006 proper scheduling option for your machine.  The default scheduling is
12007 @samp{8000}.
12009 @item -mlinker-opt
12010 @opindex mlinker-opt
12011 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
12012 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
12013 linkers in which they give bogus error messages when linking some programs.
12015 @item -msoft-float
12016 @opindex msoft-float
12017 Generate output containing library calls for floating point.
12018 @strong{Warning:} the requisite libraries are not available for all HPPA
12019 targets.  Normally the facilities of the machine's usual C compiler are
12020 used, but this cannot be done directly in cross-compilation.  You must make
12021 your own arrangements to provide suitable library functions for
12022 cross-compilation.
12024 @option{-msoft-float} changes the calling convention in the output file;
12025 therefore, it is only useful if you compile @emph{all} of a program with
12026 this option.  In particular, you need to compile @file{libgcc.a}, the
12027 library that comes with GCC, with @option{-msoft-float} in order for
12028 this to work.
12030 @item -msio
12031 @opindex msio
12032 Generate the predefine, @code{_SIO}, for server IO@.  The default is
12033 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
12034 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
12035 options are available under HP-UX and HI-UX@.
12037 @item -mgnu-ld
12038 @opindex mgnu-ld
12039 Use GNU ld specific options.  This passes @option{-shared} to ld when
12040 building a shared library.  It is the default when GCC is configured,
12041 explicitly or implicitly, with the GNU linker.  This option does not
12042 have any affect on which ld is called, it only changes what parameters
12043 are passed to that ld.  The ld that is called is determined by the
12044 @option{--with-ld} configure option, GCC's program search path, and
12045 finally by the user's @env{PATH}.  The linker used by GCC can be printed
12046 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
12047 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
12049 @item -mhp-ld
12050 @opindex mhp-ld
12051 Use HP ld specific options.  This passes @option{-b} to ld when building
12052 a shared library and passes @option{+Accept TypeMismatch} to ld on all
12053 links.  It is the default when GCC is configured, explicitly or
12054 implicitly, with the HP linker.  This option does not have any affect on
12055 which ld is called, it only changes what parameters are passed to that
12056 ld.  The ld that is called is determined by the @option{--with-ld}
12057 configure option, GCC's program search path, and finally by the user's
12058 @env{PATH}.  The linker used by GCC can be printed using @samp{which
12059 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
12060 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
12062 @item -mlong-calls
12063 @opindex mno-long-calls
12064 Generate code that uses long call sequences.  This ensures that a call
12065 is always able to reach linker generated stubs.  The default is to generate
12066 long calls only when the distance from the call site to the beginning
12067 of the function or translation unit, as the case may be, exceeds a
12068 predefined limit set by the branch type being used.  The limits for
12069 normal calls are 7,600,000 and 240,000 bytes, respectively for the
12070 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
12071 240,000 bytes.
12073 Distances are measured from the beginning of functions when using the
12074 @option{-ffunction-sections} option, or when using the @option{-mgas}
12075 and @option{-mno-portable-runtime} options together under HP-UX with
12076 the SOM linker.
12078 It is normally not desirable to use this option as it will degrade
12079 performance.  However, it may be useful in large applications,
12080 particularly when partial linking is used to build the application.
12082 The types of long calls used depends on the capabilities of the
12083 assembler and linker, and the type of code being generated.  The
12084 impact on systems that support long absolute calls, and long pic
12085 symbol-difference or pc-relative calls should be relatively small.
12086 However, an indirect call is used on 32-bit ELF systems in pic code
12087 and it is quite long.
12089 @item -munix=@var{unix-std}
12090 @opindex march
12091 Generate compiler predefines and select a startfile for the specified
12092 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
12093 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
12094 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
12095 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
12096 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
12097 and later.
12099 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
12100 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
12101 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
12102 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
12103 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
12104 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
12106 It is @emph{important} to note that this option changes the interfaces
12107 for various library routines.  It also affects the operational behavior
12108 of the C library.  Thus, @emph{extreme} care is needed in using this
12109 option.
12111 Library code that is intended to operate with more than one UNIX
12112 standard must test, set and restore the variable @var{__xpg4_extended_mask}
12113 as appropriate.  Most GNU software doesn't provide this capability.
12115 @item -nolibdld
12116 @opindex nolibdld
12117 Suppress the generation of link options to search libdld.sl when the
12118 @option{-static} option is specified on HP-UX 10 and later.
12120 @item -static
12121 @opindex static
12122 The HP-UX implementation of setlocale in libc has a dependency on
12123 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
12124 when the @option{-static} option is specified, special link options
12125 are needed to resolve this dependency.
12127 On HP-UX 10 and later, the GCC driver adds the necessary options to
12128 link with libdld.sl when the @option{-static} option is specified.
12129 This causes the resulting binary to be dynamic.  On the 64-bit port,
12130 the linkers generate dynamic binaries by default in any case.  The
12131 @option{-nolibdld} option can be used to prevent the GCC driver from
12132 adding these link options.
12134 @item -threads
12135 @opindex threads
12136 Add support for multithreading with the @dfn{dce thread} library
12137 under HP-UX@.  This option sets flags for both the preprocessor and
12138 linker.
12139 @end table
12141 @node i386 and x86-64 Options
12142 @subsection Intel 386 and AMD x86-64 Options
12143 @cindex i386 Options
12144 @cindex x86-64 Options
12145 @cindex Intel 386 Options
12146 @cindex AMD x86-64 Options
12148 These @samp{-m} options are defined for the i386 and x86-64 family of
12149 computers:
12151 @table @gcctabopt
12152 @item -mtune=@var{cpu-type}
12153 @opindex mtune
12154 Tune to @var{cpu-type} everything applicable about the generated code, except
12155 for the ABI and the set of available instructions.  The choices for
12156 @var{cpu-type} are:
12157 @table @emph
12158 @item generic
12159 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
12160 If you know the CPU on which your code will run, then you should use
12161 the corresponding @option{-mtune} option instead of
12162 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
12163 of your application will have, then you should use this option.
12165 As new processors are deployed in the marketplace, the behavior of this
12166 option will change.  Therefore, if you upgrade to a newer version of
12167 GCC, the code generated option will change to reflect the processors
12168 that were most common when that version of GCC was released.
12170 There is no @option{-march=generic} option because @option{-march}
12171 indicates the instruction set the compiler can use, and there is no
12172 generic instruction set applicable to all processors.  In contrast,
12173 @option{-mtune} indicates the processor (or, in this case, collection of
12174 processors) for which the code is optimized.
12175 @item native
12176 This selects the CPU to tune for at compilation time by determining
12177 the processor type of the compiling machine.  Using @option{-mtune=native}
12178 will produce code optimized for the local machine under the constraints
12179 of the selected instruction set.  Using @option{-march=native} will
12180 enable all instruction subsets supported by the local machine (hence
12181 the result might not run on different machines).
12182 @item i386
12183 Original Intel's i386 CPU@.
12184 @item i486
12185 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
12186 @item i586, pentium
12187 Intel Pentium CPU with no MMX support.
12188 @item pentium-mmx
12189 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
12190 @item pentiumpro
12191 Intel PentiumPro CPU@.
12192 @item i686
12193 Same as @code{generic}, but when used as @code{march} option, PentiumPro
12194 instruction set will be used, so the code will run on all i686 family chips.
12195 @item pentium2
12196 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
12197 @item pentium3, pentium3m
12198 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
12199 support.
12200 @item pentium-m
12201 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
12202 support.  Used by Centrino notebooks.
12203 @item pentium4, pentium4m
12204 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
12205 @item prescott
12206 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
12207 set support.
12208 @item nocona
12209 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
12210 SSE2 and SSE3 instruction set support.
12211 @item core2
12212 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12213 instruction set support.
12214 @item corei7
12215 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
12216 and SSE4.2 instruction set support.
12217 @item corei7-avx
12218 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
12219 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
12220 @item atom
12221 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
12222 instruction set support.
12223 @item k6
12224 AMD K6 CPU with MMX instruction set support.
12225 @item k6-2, k6-3
12226 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
12227 @item athlon, athlon-tbird
12228 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
12229 support.
12230 @item athlon-4, athlon-xp, athlon-mp
12231 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
12232 instruction set support.
12233 @item k8, opteron, athlon64, athlon-fx
12234 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
12235 MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit instruction set extensions.)
12236 @item k8-sse3, opteron-sse3, athlon64-sse3
12237 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
12238 @item amdfam10, barcelona
12239 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
12240 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
12241 instruction set extensions.)
12242 @item winchip-c6
12243 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
12244 set support.
12245 @item winchip2
12246 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
12247 instruction set support.
12248 @item c3
12249 Via C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
12250 implemented for this chip.)
12251 @item c3-2
12252 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
12253 implemented for this chip.)
12254 @item geode
12255 Embedded AMD CPU with MMX and 3DNow!@: instruction set support.
12256 @end table
12258 While picking a specific @var{cpu-type} will schedule things appropriately
12259 for that particular chip, the compiler will not generate any code that
12260 does not run on the i386 without the @option{-march=@var{cpu-type}} option
12261 being used.
12263 @item -march=@var{cpu-type}
12264 @opindex march
12265 Generate instructions for the machine type @var{cpu-type}.  The choices
12266 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
12267 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
12269 @item -mcpu=@var{cpu-type}
12270 @opindex mcpu
12271 A deprecated synonym for @option{-mtune}.
12273 @item -mfpmath=@var{unit}
12274 @opindex mfpmath
12275 Generate floating point arithmetics for selected unit @var{unit}.  The choices
12276 for @var{unit} are:
12278 @table @samp
12279 @item 387
12280 Use the standard 387 floating point coprocessor present majority of chips and
12281 emulated otherwise.  Code compiled with this option will run almost everywhere.
12282 The temporary results are computed in 80bit precision instead of precision
12283 specified by the type resulting in slightly different results compared to most
12284 of other chips.  See @option{-ffloat-store} for more detailed description.
12286 This is the default choice for i386 compiler.
12288 @item sse
12289 Use scalar floating point instructions present in the SSE instruction set.
12290 This instruction set is supported by Pentium3 and newer chips, in the AMD line
12291 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
12292 instruction set supports only single precision arithmetics, thus the double and
12293 extended precision arithmetics is still done using 387.  Later version, present
12294 only in Pentium4 and the future AMD x86-64 chips supports double precision
12295 arithmetics too.
12297 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
12298 or @option{-msse2} switches to enable SSE extensions and make this option
12299 effective.  For the x86-64 compiler, these extensions are enabled by default.
12301 The resulting code should be considerably faster in the majority of cases and avoid
12302 the numerical instability problems of 387 code, but may break some existing
12303 code that expects temporaries to be 80bit.
12305 This is the default choice for the x86-64 compiler.
12307 @item sse,387
12308 @itemx sse+387
12309 @itemx both
12310 Attempt to utilize both instruction sets at once.  This effectively double the
12311 amount of available registers and on chips with separate execution units for
12312 387 and SSE the execution resources too.  Use this option with care, as it is
12313 still experimental, because the GCC register allocator does not model separate
12314 functional units well resulting in instable performance.
12315 @end table
12317 @item -masm=@var{dialect}
12318 @opindex masm=@var{dialect}
12319 Output asm instructions using selected @var{dialect}.  Supported
12320 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
12321 not support @samp{intel}.
12323 @item -mieee-fp
12324 @itemx -mno-ieee-fp
12325 @opindex mieee-fp
12326 @opindex mno-ieee-fp
12327 Control whether or not the compiler uses IEEE floating point
12328 comparisons.  These handle correctly the case where the result of a
12329 comparison is unordered.
12331 @item -msoft-float
12332 @opindex msoft-float
12333 Generate output containing library calls for floating point.
12334 @strong{Warning:} the requisite libraries are not part of GCC@.
12335 Normally the facilities of the machine's usual C compiler are used, but
12336 this can't be done directly in cross-compilation.  You must make your
12337 own arrangements to provide suitable library functions for
12338 cross-compilation.
12340 On machines where a function returns floating point results in the 80387
12341 register stack, some floating point opcodes may be emitted even if
12342 @option{-msoft-float} is used.
12344 @item -mno-fp-ret-in-387
12345 @opindex mno-fp-ret-in-387
12346 Do not use the FPU registers for return values of functions.
12348 The usual calling convention has functions return values of types
12349 @code{float} and @code{double} in an FPU register, even if there
12350 is no FPU@.  The idea is that the operating system should emulate
12351 an FPU@.
12353 The option @option{-mno-fp-ret-in-387} causes such values to be returned
12354 in ordinary CPU registers instead.
12356 @item -mno-fancy-math-387
12357 @opindex mno-fancy-math-387
12358 Some 387 emulators do not support the @code{sin}, @code{cos} and
12359 @code{sqrt} instructions for the 387.  Specify this option to avoid
12360 generating those instructions.  This option is the default on FreeBSD,
12361 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
12362 indicates that the target CPU will always have an FPU and so the
12363 instruction will not need emulation.  As of revision 2.6.1, these
12364 instructions are not generated unless you also use the
12365 @option{-funsafe-math-optimizations} switch.
12367 @item -malign-double
12368 @itemx -mno-align-double
12369 @opindex malign-double
12370 @opindex mno-align-double
12371 Control whether GCC aligns @code{double}, @code{long double}, and
12372 @code{long long} variables on a two word boundary or a one word
12373 boundary.  Aligning @code{double} variables on a two word boundary will
12374 produce code that runs somewhat faster on a @samp{Pentium} at the
12375 expense of more memory.
12377 On x86-64, @option{-malign-double} is enabled by default.
12379 @strong{Warning:} if you use the @option{-malign-double} switch,
12380 structures containing the above types will be aligned differently than
12381 the published application binary interface specifications for the 386
12382 and will not be binary compatible with structures in code compiled
12383 without that switch.
12385 @item -m96bit-long-double
12386 @itemx -m128bit-long-double
12387 @opindex m96bit-long-double
12388 @opindex m128bit-long-double
12389 These switches control the size of @code{long double} type.  The i386
12390 application binary interface specifies the size to be 96 bits,
12391 so @option{-m96bit-long-double} is the default in 32 bit mode.
12393 Modern architectures (Pentium and newer) would prefer @code{long double}
12394 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
12395 conforming to the ABI, this would not be possible.  So specifying a
12396 @option{-m128bit-long-double} will align @code{long double}
12397 to a 16 byte boundary by padding the @code{long double} with an additional
12398 32 bit zero.
12400 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
12401 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
12403 Notice that neither of these options enable any extra precision over the x87
12404 standard of 80 bits for a @code{long double}.
12406 @strong{Warning:} if you override the default value for your target ABI, the
12407 structures and arrays containing @code{long double} variables will change
12408 their size as well as function calling convention for function taking
12409 @code{long double} will be modified.  Hence they will not be binary
12410 compatible with arrays or structures in code compiled without that switch.
12412 @item -mlarge-data-threshold=@var{number}
12413 @opindex mlarge-data-threshold=@var{number}
12414 When @option{-mcmodel=medium} is specified, the data greater than
12415 @var{threshold} are placed in large data section.  This value must be the
12416 same across all object linked into the binary and defaults to 65535.
12418 @item -mrtd
12419 @opindex mrtd
12420 Use a different function-calling convention, in which functions that
12421 take a fixed number of arguments return with the @code{ret} @var{num}
12422 instruction, which pops their arguments while returning.  This saves one
12423 instruction in the caller since there is no need to pop the arguments
12424 there.
12426 You can specify that an individual function is called with this calling
12427 sequence with the function attribute @samp{stdcall}.  You can also
12428 override the @option{-mrtd} option by using the function attribute
12429 @samp{cdecl}.  @xref{Function Attributes}.
12431 @strong{Warning:} this calling convention is incompatible with the one
12432 normally used on Unix, so you cannot use it if you need to call
12433 libraries compiled with the Unix compiler.
12435 Also, you must provide function prototypes for all functions that
12436 take variable numbers of arguments (including @code{printf});
12437 otherwise incorrect code will be generated for calls to those
12438 functions.
12440 In addition, seriously incorrect code will result if you call a
12441 function with too many arguments.  (Normally, extra arguments are
12442 harmlessly ignored.)
12444 @item -mregparm=@var{num}
12445 @opindex mregparm
12446 Control how many registers are used to pass integer arguments.  By
12447 default, no registers are used to pass arguments, and at most 3
12448 registers can be used.  You can control this behavior for a specific
12449 function by using the function attribute @samp{regparm}.
12450 @xref{Function Attributes}.
12452 @strong{Warning:} if you use this switch, and
12453 @var{num} is nonzero, then you must build all modules with the same
12454 value, including any libraries.  This includes the system libraries and
12455 startup modules.
12457 @item -msseregparm
12458 @opindex msseregparm
12459 Use SSE register passing conventions for float and double arguments
12460 and return values.  You can control this behavior for a specific
12461 function by using the function attribute @samp{sseregparm}.
12462 @xref{Function Attributes}.
12464 @strong{Warning:} if you use this switch then you must build all
12465 modules with the same value, including any libraries.  This includes
12466 the system libraries and startup modules.
12468 @item -mvect8-ret-in-mem
12469 @opindex mvect8-ret-in-mem
12470 Return 8-byte vectors in memory instead of MMX registers.  This is the
12471 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
12472 Studio compilers until version 12.  Later compiler versions (starting
12473 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
12474 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
12475 you need to remain compatible with existing code produced by those
12476 previous compiler versions or older versions of GCC.
12478 @item -mpc32
12479 @itemx -mpc64
12480 @itemx -mpc80
12481 @opindex mpc32
12482 @opindex mpc64
12483 @opindex mpc80
12485 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
12486 is specified, the significands of results of floating-point operations are
12487 rounded to 24 bits (single precision); @option{-mpc64} rounds the
12488 significands of results of floating-point operations to 53 bits (double
12489 precision) and @option{-mpc80} rounds the significands of results of
12490 floating-point operations to 64 bits (extended double precision), which is
12491 the default.  When this option is used, floating-point operations in higher
12492 precisions are not available to the programmer without setting the FPU
12493 control word explicitly.
12495 Setting the rounding of floating-point operations to less than the default
12496 80 bits can speed some programs by 2% or more.  Note that some mathematical
12497 libraries assume that extended precision (80 bit) floating-point operations
12498 are enabled by default; routines in such libraries could suffer significant
12499 loss of accuracy, typically through so-called "catastrophic cancellation",
12500 when this option is used to set the precision to less than extended precision.
12502 @item -mstackrealign
12503 @opindex mstackrealign
12504 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
12505 option will generate an alternate prologue and epilogue that realigns the
12506 runtime stack if necessary.  This supports mixing legacy codes that keep
12507 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
12508 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
12509 applicable to individual functions.
12511 @item -mpreferred-stack-boundary=@var{num}
12512 @opindex mpreferred-stack-boundary
12513 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
12514 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
12515 the default is 4 (16 bytes or 128 bits).
12517 @item -mincoming-stack-boundary=@var{num}
12518 @opindex mincoming-stack-boundary
12519 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
12520 boundary.  If @option{-mincoming-stack-boundary} is not specified,
12521 the one specified by @option{-mpreferred-stack-boundary} will be used.
12523 On Pentium and PentiumPro, @code{double} and @code{long double} values
12524 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
12525 suffer significant run time performance penalties.  On Pentium III, the
12526 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
12527 properly if it is not 16 byte aligned.
12529 To ensure proper alignment of this values on the stack, the stack boundary
12530 must be as aligned as that required by any value stored on the stack.
12531 Further, every function must be generated such that it keeps the stack
12532 aligned.  Thus calling a function compiled with a higher preferred
12533 stack boundary from a function compiled with a lower preferred stack
12534 boundary will most likely misalign the stack.  It is recommended that
12535 libraries that use callbacks always use the default setting.
12537 This extra alignment does consume extra stack space, and generally
12538 increases code size.  Code that is sensitive to stack space usage, such
12539 as embedded systems and operating system kernels, may want to reduce the
12540 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12542 @item -mmmx
12543 @itemx -mno-mmx
12544 @itemx -msse
12545 @itemx -mno-sse
12546 @itemx -msse2
12547 @itemx -mno-sse2
12548 @itemx -msse3
12549 @itemx -mno-sse3
12550 @itemx -mssse3
12551 @itemx -mno-ssse3
12552 @itemx -msse4.1
12553 @need 800
12554 @itemx -mno-sse4.1
12555 @itemx -msse4.2
12556 @itemx -mno-sse4.2
12557 @itemx -msse4
12558 @itemx -mno-sse4
12559 @itemx -mavx
12560 @itemx -mno-avx
12561 @itemx -maes
12562 @itemx -mno-aes
12563 @itemx -mpclmul
12564 @need 800
12565 @itemx -mno-pclmul
12566 @itemx -mfsgsbase
12567 @itemx -mno-fsgsbase
12568 @itemx -mrdrnd
12569 @itemx -mno-rdrnd
12570 @itemx -mf16c
12571 @itemx -mno-f16c
12572 @itemx -msse4a
12573 @itemx -mno-sse4a
12574 @itemx -mfma4
12575 @need 800
12576 @itemx -mno-fma4
12577 @itemx -mxop
12578 @itemx -mno-xop
12579 @itemx -mlwp
12580 @itemx -mno-lwp
12581 @itemx -m3dnow
12582 @itemx -mno-3dnow
12583 @itemx -mpopcnt
12584 @itemx -mno-popcnt
12585 @itemx -mabm
12586 @itemx -mno-abm
12587 @itemx -mbmi
12588 @itemx -mno-bmi
12589 @itemx -mtbm
12590 @itemx -mno-tbm
12591 @opindex mmmx
12592 @opindex mno-mmx
12593 @opindex msse
12594 @opindex mno-sse
12595 @opindex m3dnow
12596 @opindex mno-3dnow
12597 These switches enable or disable the use of instructions in the MMX,
12598 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, FSGSBASE, RDRND,
12599 F16C, SSE4A, FMA4, XOP, LWP, ABM, BMI, or 3DNow!@: extended instruction sets.
12600 These extensions are also available as built-in functions: see
12601 @ref{X86 Built-in Functions}, for details of the functions enabled and
12602 disabled by these switches.
12604 To have SSE/SSE2 instructions generated automatically from floating-point
12605 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12607 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12608 generates new AVX instructions or AVX equivalence for all SSEx instructions
12609 when needed.
12611 These options will enable GCC to use these extended instructions in
12612 generated code, even without @option{-mfpmath=sse}.  Applications which
12613 perform runtime CPU detection must compile separate files for each
12614 supported architecture, using the appropriate flags.  In particular,
12615 the file containing the CPU detection code should be compiled without
12616 these options.
12618 @item -mfused-madd
12619 @itemx -mno-fused-madd
12620 @opindex mfused-madd
12621 @opindex mno-fused-madd
12622 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12623 instructions.  The default is to use these instructions.
12625 @item -mcld
12626 @opindex mcld
12627 This option instructs GCC to emit a @code{cld} instruction in the prologue
12628 of functions that use string instructions.  String instructions depend on
12629 the DF flag to select between autoincrement or autodecrement mode.  While the
12630 ABI specifies the DF flag to be cleared on function entry, some operating
12631 systems violate this specification by not clearing the DF flag in their
12632 exception dispatchers.  The exception handler can be invoked with the DF flag
12633 set which leads to wrong direction mode, when string instructions are used.
12634 This option can be enabled by default on 32-bit x86 targets by configuring
12635 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12636 instructions can be suppressed with the @option{-mno-cld} compiler option
12637 in this case.
12639 @item -mvzeroupper
12640 @opindex mvzeroupper
12641 This option instructs GCC to emit a @code{vzeroupper} instruction
12642 before a transfer of control flow out of the function to minimize
12643 AVX to SSE transition penalty as well as remove unnecessary zeroupper
12644 intrinsics.
12646 @item -mcx16
12647 @opindex mcx16
12648 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12649 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12650 data types.  This is useful for high resolution counters that could be updated
12651 by multiple processors (or cores).  This instruction is generated as part of
12652 atomic built-in functions: see @ref{Atomic Builtins} for details.
12654 @item -msahf
12655 @opindex msahf
12656 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12657 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12658 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12659 SAHF are load and store instructions, respectively, for certain status flags.
12660 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12661 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12663 @item -mmovbe
12664 @opindex mmovbe
12665 This option will enable GCC to use movbe instruction to implement
12666 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12668 @item -mcrc32
12669 @opindex mcrc32
12670 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12671 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12672 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12674 @item -mrecip
12675 @opindex mrecip
12676 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12677 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12678 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12679 variants) for single precision floating point arguments.  These instructions
12680 are generated only when @option{-funsafe-math-optimizations} is enabled
12681 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12682 Note that while the throughput of the sequence is higher than the throughput
12683 of the non-reciprocal instruction, the precision of the sequence can be
12684 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12686 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12687 already with @option{-ffast-math} (or the above option combination), and
12688 doesn't need @option{-mrecip}.
12690 @item -mveclibabi=@var{type}
12691 @opindex mveclibabi
12692 Specifies the ABI type to use for vectorizing intrinsics using an
12693 external library.  Supported types are @code{svml} for the Intel short
12694 vector math library and @code{acml} for the AMD math core library style
12695 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12696 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12697 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12698 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12699 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12700 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12701 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12702 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12703 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12704 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12705 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12706 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12707 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12708 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12709 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12710 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12711 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12712 compatible library will have to be specified at link time.
12714 @item -mabi=@var{name}
12715 @opindex mabi
12716 Generate code for the specified calling convention.  Permissible values
12717 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12718 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12719 ABI when targeting Windows.  On all other systems, the default is the
12720 SYSV ABI.  You can control this behavior for a specific function by
12721 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12722 @xref{Function Attributes}.
12724 @item -mtls-dialect=@var{type}
12725 @opindex mtls-dialect
12726 Generate code to access thread-local storage using the @samp{gnu} or
12727 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
12728 @samp{gnu2} is more efficient, but it may add compile- and run-time
12729 requirements that cannot be satisfied on all systems.
12731 @item -mpush-args
12732 @itemx -mno-push-args
12733 @opindex mpush-args
12734 @opindex mno-push-args
12735 Use PUSH operations to store outgoing parameters.  This method is shorter
12736 and usually equally fast as method using SUB/MOV operations and is enabled
12737 by default.  In some cases disabling it may improve performance because of
12738 improved scheduling and reduced dependencies.
12740 @item -maccumulate-outgoing-args
12741 @opindex maccumulate-outgoing-args
12742 If enabled, the maximum amount of space required for outgoing arguments will be
12743 computed in the function prologue.  This is faster on most modern CPUs
12744 because of reduced dependencies, improved scheduling and reduced stack usage
12745 when preferred stack boundary is not equal to 2.  The drawback is a notable
12746 increase in code size.  This switch implies @option{-mno-push-args}.
12748 @item -mthreads
12749 @opindex mthreads
12750 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12751 on thread-safe exception handling must compile and link all code with the
12752 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12753 @option{-D_MT}; when linking, it links in a special thread helper library
12754 @option{-lmingwthrd} which cleans up per thread exception handling data.
12756 @item -mno-align-stringops
12757 @opindex mno-align-stringops
12758 Do not align destination of inlined string operations.  This switch reduces
12759 code size and improves performance in case the destination is already aligned,
12760 but GCC doesn't know about it.
12762 @item -minline-all-stringops
12763 @opindex minline-all-stringops
12764 By default GCC inlines string operations only when destination is known to be
12765 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12766 size, but may improve performance of code that depends on fast memcpy, strlen
12767 and memset for short lengths.
12769 @item -minline-stringops-dynamically
12770 @opindex minline-stringops-dynamically
12771 For string operation of unknown size, inline runtime checks so for small
12772 blocks inline code is used, while for large blocks library call is used.
12774 @item -mstringop-strategy=@var{alg}
12775 @opindex mstringop-strategy=@var{alg}
12776 Overwrite internal decision heuristic about particular algorithm to inline
12777 string operation with.  The allowed values are @code{rep_byte},
12778 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12779 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12780 expanding inline loop, @code{libcall} for always expanding library call.
12782 @item -momit-leaf-frame-pointer
12783 @opindex momit-leaf-frame-pointer
12784 Don't keep the frame pointer in a register for leaf functions.  This
12785 avoids the instructions to save, set up and restore frame pointers and
12786 makes an extra register available in leaf functions.  The option
12787 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12788 which might make debugging harder.
12790 @item -mtls-direct-seg-refs
12791 @itemx -mno-tls-direct-seg-refs
12792 @opindex mtls-direct-seg-refs
12793 Controls whether TLS variables may be accessed with offsets from the
12794 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12795 or whether the thread base pointer must be added.  Whether or not this
12796 is legal depends on the operating system, and whether it maps the
12797 segment to cover the entire TLS area.
12799 For systems that use GNU libc, the default is on.
12801 @item -msse2avx
12802 @itemx -mno-sse2avx
12803 @opindex msse2avx
12804 Specify that the assembler should encode SSE instructions with VEX
12805 prefix.  The option @option{-mavx} turns this on by default.
12807 @item -mfentry
12808 @itemx -mno-fentry
12809 @opindex mfentry
12810 If profiling is active @option{-pg} put the profiling
12811 counter call before prologue.
12812 Note: On x86 architectures the attribute @code{ms_hook_prologue}
12813 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
12815 @item -m8bit-idiv
12816 @itemx -mno-8bit-idiv
12817 @opindex 8bit-idiv
12818 On some processors, like Intel Atom, 8bit unsigned integer divide is
12819 much faster than 32bit/64bit integer divide.  This option will generate a
12820 runt-time check.  If both dividend and divisor are within range of 0
12821 to 255, 8bit unsigned integer divide will be used instead of
12822 32bit/64bit integer divide.
12824 @item -mavx256-split-unaligned-load
12825 @item -mavx256-split-unaligned-store
12826 @opindex avx256-split-unaligned-load
12827 @opindex avx256-split-unaligned-store
12828 Split 32-byte AVX unaligned load and store.
12830 @end table
12832 These @samp{-m} switches are supported in addition to the above
12833 on AMD x86-64 processors in 64-bit environments.
12835 @table @gcctabopt
12836 @item -m32
12837 @itemx -m64
12838 @opindex m32
12839 @opindex m64
12840 Generate code for a 32-bit or 64-bit environment.
12841 The 32-bit environment sets int, long and pointer to 32 bits and
12842 generates code that runs on any i386 system.
12843 The 64-bit environment sets int to 32 bits and long and pointer
12844 to 64 bits and generates code for AMD's x86-64 architecture. For
12845 darwin only the -m64 option turns off the @option{-fno-pic} and
12846 @option{-mdynamic-no-pic} options.
12848 @item -mno-red-zone
12849 @opindex mno-red-zone
12850 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12851 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12852 stack pointer that will not be modified by signal or interrupt handlers
12853 and therefore can be used for temporary data without adjusting the stack
12854 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12856 @item -mcmodel=small
12857 @opindex mcmodel=small
12858 Generate code for the small code model: the program and its symbols must
12859 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12860 Programs can be statically or dynamically linked.  This is the default
12861 code model.
12863 @item -mcmodel=kernel
12864 @opindex mcmodel=kernel
12865 Generate code for the kernel code model.  The kernel runs in the
12866 negative 2 GB of the address space.
12867 This model has to be used for Linux kernel code.
12869 @item -mcmodel=medium
12870 @opindex mcmodel=medium
12871 Generate code for the medium model: The program is linked in the lower 2
12872 GB of the address space.  Small symbols are also placed there.  Symbols
12873 with sizes larger than @option{-mlarge-data-threshold} are put into
12874 large data or bss sections and can be located above 2GB.  Programs can
12875 be statically or dynamically linked.
12877 @item -mcmodel=large
12878 @opindex mcmodel=large
12879 Generate code for the large model: This model makes no assumptions
12880 about addresses and sizes of sections.
12881 @end table
12883 @node i386 and x86-64 Windows Options
12884 @subsection i386 and x86-64 Windows Options
12885 @cindex i386 and x86-64 Windows Options
12887 These additional options are available for Windows targets:
12889 @table @gcctabopt
12890 @item -mconsole
12891 @opindex mconsole
12892 This option is available for Cygwin and MinGW targets.  It
12893 specifies that a console application is to be generated, by
12894 instructing the linker to set the PE header subsystem type
12895 required for console applications.
12896 This is the default behavior for Cygwin and MinGW targets.
12898 @item -mdll
12899 @opindex mdll
12900 This option is available for Cygwin and MinGW targets.  It
12901 specifies that a DLL - a dynamic link library - is to be
12902 generated, enabling the selection of the required runtime
12903 startup object and entry point.
12905 @item -mnop-fun-dllimport
12906 @opindex mnop-fun-dllimport
12907 This option is available for Cygwin and MinGW targets.  It
12908 specifies that the dllimport attribute should be ignored.
12910 @item -mthread
12911 @opindex mthread
12912 This option is available for MinGW targets. It specifies
12913 that MinGW-specific thread support is to be used.
12915 @item -municode
12916 @opindex municode
12917 This option is available for mingw-w64 targets.  It specifies
12918 that the UNICODE macro is getting pre-defined and that the
12919 unicode capable runtime startup code is chosen.
12921 @item -mwin32
12922 @opindex mwin32
12923 This option is available for Cygwin and MinGW targets.  It
12924 specifies that the typical Windows pre-defined macros are to
12925 be set in the pre-processor, but does not influence the choice
12926 of runtime library/startup code.
12928 @item -mwindows
12929 @opindex mwindows
12930 This option is available for Cygwin and MinGW targets.  It
12931 specifies that a GUI application is to be generated by
12932 instructing the linker to set the PE header subsystem type
12933 appropriately.
12935 @item -fno-set-stack-executable
12936 @opindex fno-set-stack-executable
12937 This option is available for MinGW targets. It specifies that
12938 the executable flag for stack used by nested functions isn't
12939 set. This is necessary for binaries running in kernel mode of
12940 Windows, as there the user32 API, which is used to set executable
12941 privileges, isn't available.
12943 @item -mpe-aligned-commons
12944 @opindex mpe-aligned-commons
12945 This option is available for Cygwin and MinGW targets.  It
12946 specifies that the GNU extension to the PE file format that
12947 permits the correct alignment of COMMON variables should be
12948 used when generating code.  It will be enabled by default if
12949 GCC detects that the target assembler found during configuration
12950 supports the feature.
12951 @end table
12953 See also under @ref{i386 and x86-64 Options} for standard options.
12955 @node IA-64 Options
12956 @subsection IA-64 Options
12957 @cindex IA-64 Options
12959 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12961 @table @gcctabopt
12962 @item -mbig-endian
12963 @opindex mbig-endian
12964 Generate code for a big endian target.  This is the default for HP-UX@.
12966 @item -mlittle-endian
12967 @opindex mlittle-endian
12968 Generate code for a little endian target.  This is the default for AIX5
12969 and GNU/Linux.
12971 @item -mgnu-as
12972 @itemx -mno-gnu-as
12973 @opindex mgnu-as
12974 @opindex mno-gnu-as
12975 Generate (or don't) code for the GNU assembler.  This is the default.
12976 @c Also, this is the default if the configure option @option{--with-gnu-as}
12977 @c is used.
12979 @item -mgnu-ld
12980 @itemx -mno-gnu-ld
12981 @opindex mgnu-ld
12982 @opindex mno-gnu-ld
12983 Generate (or don't) code for the GNU linker.  This is the default.
12984 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12985 @c is used.
12987 @item -mno-pic
12988 @opindex mno-pic
12989 Generate code that does not use a global pointer register.  The result
12990 is not position independent code, and violates the IA-64 ABI@.
12992 @item -mvolatile-asm-stop
12993 @itemx -mno-volatile-asm-stop
12994 @opindex mvolatile-asm-stop
12995 @opindex mno-volatile-asm-stop
12996 Generate (or don't) a stop bit immediately before and after volatile asm
12997 statements.
12999 @item -mregister-names
13000 @itemx -mno-register-names
13001 @opindex mregister-names
13002 @opindex mno-register-names
13003 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
13004 the stacked registers.  This may make assembler output more readable.
13006 @item -mno-sdata
13007 @itemx -msdata
13008 @opindex mno-sdata
13009 @opindex msdata
13010 Disable (or enable) optimizations that use the small data section.  This may
13011 be useful for working around optimizer bugs.
13013 @item -mconstant-gp
13014 @opindex mconstant-gp
13015 Generate code that uses a single constant global pointer value.  This is
13016 useful when compiling kernel code.
13018 @item -mauto-pic
13019 @opindex mauto-pic
13020 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
13021 This is useful when compiling firmware code.
13023 @item -minline-float-divide-min-latency
13024 @opindex minline-float-divide-min-latency
13025 Generate code for inline divides of floating point values
13026 using the minimum latency algorithm.
13028 @item -minline-float-divide-max-throughput
13029 @opindex minline-float-divide-max-throughput
13030 Generate code for inline divides of floating point values
13031 using the maximum throughput algorithm.
13033 @item -mno-inline-float-divide
13034 @opindex mno-inline-float-divide
13035 Do not generate inline code for divides of floating point values.
13037 @item -minline-int-divide-min-latency
13038 @opindex minline-int-divide-min-latency
13039 Generate code for inline divides of integer values
13040 using the minimum latency algorithm.
13042 @item -minline-int-divide-max-throughput
13043 @opindex minline-int-divide-max-throughput
13044 Generate code for inline divides of integer values
13045 using the maximum throughput algorithm.
13047 @item -mno-inline-int-divide
13048 @opindex mno-inline-int-divide
13049 Do not generate inline code for divides of integer values.
13051 @item -minline-sqrt-min-latency
13052 @opindex minline-sqrt-min-latency
13053 Generate code for inline square roots
13054 using the minimum latency algorithm.
13056 @item -minline-sqrt-max-throughput
13057 @opindex minline-sqrt-max-throughput
13058 Generate code for inline square roots
13059 using the maximum throughput algorithm.
13061 @item -mno-inline-sqrt
13062 @opindex mno-inline-sqrt
13063 Do not generate inline code for sqrt.
13065 @item -mfused-madd
13066 @itemx -mno-fused-madd
13067 @opindex mfused-madd
13068 @opindex mno-fused-madd
13069 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
13070 instructions.  The default is to use these instructions.
13072 @item -mno-dwarf2-asm
13073 @itemx -mdwarf2-asm
13074 @opindex mno-dwarf2-asm
13075 @opindex mdwarf2-asm
13076 Don't (or do) generate assembler code for the DWARF2 line number debugging
13077 info.  This may be useful when not using the GNU assembler.
13079 @item -mearly-stop-bits
13080 @itemx -mno-early-stop-bits
13081 @opindex mearly-stop-bits
13082 @opindex mno-early-stop-bits
13083 Allow stop bits to be placed earlier than immediately preceding the
13084 instruction that triggered the stop bit.  This can improve instruction
13085 scheduling, but does not always do so.
13087 @item -mfixed-range=@var{register-range}
13088 @opindex mfixed-range
13089 Generate code treating the given register range as fixed registers.
13090 A fixed register is one that the register allocator can not use.  This is
13091 useful when compiling kernel code.  A register range is specified as
13092 two registers separated by a dash.  Multiple register ranges can be
13093 specified separated by a comma.
13095 @item -mtls-size=@var{tls-size}
13096 @opindex mtls-size
13097 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
13100 @item -mtune=@var{cpu-type}
13101 @opindex mtune
13102 Tune the instruction scheduling for a particular CPU, Valid values are
13103 itanium, itanium1, merced, itanium2, and mckinley.
13105 @item -milp32
13106 @itemx -mlp64
13107 @opindex milp32
13108 @opindex mlp64
13109 Generate code for a 32-bit or 64-bit environment.
13110 The 32-bit environment sets int, long and pointer to 32 bits.
13111 The 64-bit environment sets int to 32 bits and long and pointer
13112 to 64 bits.  These are HP-UX specific flags.
13114 @item -mno-sched-br-data-spec
13115 @itemx -msched-br-data-spec
13116 @opindex mno-sched-br-data-spec
13117 @opindex msched-br-data-spec
13118 (Dis/En)able data speculative scheduling before reload.
13119 This will result in generation of the ld.a instructions and
13120 the corresponding check instructions (ld.c / chk.a).
13121 The default is 'disable'.
13123 @item -msched-ar-data-spec
13124 @itemx -mno-sched-ar-data-spec
13125 @opindex msched-ar-data-spec
13126 @opindex mno-sched-ar-data-spec
13127 (En/Dis)able data speculative scheduling after reload.
13128 This will result in generation of the ld.a instructions and
13129 the corresponding check instructions (ld.c / chk.a).
13130 The default is 'enable'.
13132 @item -mno-sched-control-spec
13133 @itemx -msched-control-spec
13134 @opindex mno-sched-control-spec
13135 @opindex msched-control-spec
13136 (Dis/En)able control speculative scheduling.  This feature is
13137 available only during region scheduling (i.e.@: before reload).
13138 This will result in generation of the ld.s instructions and
13139 the corresponding check instructions chk.s .
13140 The default is 'disable'.
13142 @item -msched-br-in-data-spec
13143 @itemx -mno-sched-br-in-data-spec
13144 @opindex msched-br-in-data-spec
13145 @opindex mno-sched-br-in-data-spec
13146 (En/Dis)able speculative scheduling of the instructions that
13147 are dependent on the data speculative loads before reload.
13148 This is effective only with @option{-msched-br-data-spec} enabled.
13149 The default is 'enable'.
13151 @item -msched-ar-in-data-spec
13152 @itemx -mno-sched-ar-in-data-spec
13153 @opindex msched-ar-in-data-spec
13154 @opindex mno-sched-ar-in-data-spec
13155 (En/Dis)able speculative scheduling of the instructions that
13156 are dependent on the data speculative loads after reload.
13157 This is effective only with @option{-msched-ar-data-spec} enabled.
13158 The default is 'enable'.
13160 @item -msched-in-control-spec
13161 @itemx -mno-sched-in-control-spec
13162 @opindex msched-in-control-spec
13163 @opindex mno-sched-in-control-spec
13164 (En/Dis)able speculative scheduling of the instructions that
13165 are dependent on the control speculative loads.
13166 This is effective only with @option{-msched-control-spec} enabled.
13167 The default is 'enable'.
13169 @item -mno-sched-prefer-non-data-spec-insns
13170 @itemx -msched-prefer-non-data-spec-insns
13171 @opindex mno-sched-prefer-non-data-spec-insns
13172 @opindex msched-prefer-non-data-spec-insns
13173 If enabled, data speculative instructions will be chosen for schedule
13174 only if there are no other choices at the moment.  This will make
13175 the use of the data speculation much more conservative.
13176 The default is 'disable'.
13178 @item -mno-sched-prefer-non-control-spec-insns
13179 @itemx -msched-prefer-non-control-spec-insns
13180 @opindex mno-sched-prefer-non-control-spec-insns
13181 @opindex msched-prefer-non-control-spec-insns
13182 If enabled, control speculative instructions will be chosen for schedule
13183 only if there are no other choices at the moment.  This will make
13184 the use of the control speculation much more conservative.
13185 The default is 'disable'.
13187 @item -mno-sched-count-spec-in-critical-path
13188 @itemx -msched-count-spec-in-critical-path
13189 @opindex mno-sched-count-spec-in-critical-path
13190 @opindex msched-count-spec-in-critical-path
13191 If enabled, speculative dependencies will be considered during
13192 computation of the instructions priorities.  This will make the use of the
13193 speculation a bit more conservative.
13194 The default is 'disable'.
13196 @item -msched-spec-ldc
13197 @opindex msched-spec-ldc
13198 Use a simple data speculation check.  This option is on by default.
13200 @item -msched-control-spec-ldc
13201 @opindex msched-spec-ldc
13202 Use a simple check for control speculation.  This option is on by default.
13204 @item -msched-stop-bits-after-every-cycle
13205 @opindex msched-stop-bits-after-every-cycle
13206 Place a stop bit after every cycle when scheduling.  This option is on
13207 by default.
13209 @item -msched-fp-mem-deps-zero-cost
13210 @opindex msched-fp-mem-deps-zero-cost
13211 Assume that floating-point stores and loads are not likely to cause a conflict
13212 when placed into the same instruction group.  This option is disabled by
13213 default.
13215 @item -msel-sched-dont-check-control-spec
13216 @opindex msel-sched-dont-check-control-spec
13217 Generate checks for control speculation in selective scheduling.
13218 This flag is disabled by default.
13220 @item -msched-max-memory-insns=@var{max-insns}
13221 @opindex msched-max-memory-insns
13222 Limit on the number of memory insns per instruction group, giving lower
13223 priority to subsequent memory insns attempting to schedule in the same
13224 instruction group. Frequently useful to prevent cache bank conflicts.
13225 The default value is 1.
13227 @item -msched-max-memory-insns-hard-limit
13228 @opindex msched-max-memory-insns-hard-limit
13229 Disallow more than `msched-max-memory-insns' in instruction group.
13230 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
13231 when limit is reached but may still schedule memory operations.
13233 @end table
13235 @node IA-64/VMS Options
13236 @subsection IA-64/VMS Options
13238 These @samp{-m} options are defined for the IA-64/VMS implementations:
13240 @table @gcctabopt
13241 @item -mvms-return-codes
13242 @opindex mvms-return-codes
13243 Return VMS condition codes from main. The default is to return POSIX
13244 style condition (e.g.@ error) codes.
13246 @item -mdebug-main=@var{prefix}
13247 @opindex mdebug-main=@var{prefix}
13248 Flag the first routine whose name starts with @var{prefix} as the main
13249 routine for the debugger.
13251 @item -mmalloc64
13252 @opindex mmalloc64
13253 Default to 64bit memory allocation routines.
13254 @end table
13256 @node LM32 Options
13257 @subsection LM32 Options
13258 @cindex LM32 options
13260 These @option{-m} options are defined for the Lattice Mico32 architecture:
13262 @table @gcctabopt
13263 @item -mbarrel-shift-enabled
13264 @opindex mbarrel-shift-enabled
13265 Enable barrel-shift instructions.
13267 @item -mdivide-enabled
13268 @opindex mdivide-enabled
13269 Enable divide and modulus instructions.
13271 @item -mmultiply-enabled
13272 @opindex multiply-enabled
13273 Enable multiply instructions.
13275 @item -msign-extend-enabled
13276 @opindex msign-extend-enabled
13277 Enable sign extend instructions.
13279 @item -muser-enabled
13280 @opindex muser-enabled
13281 Enable user-defined instructions.
13283 @end table
13285 @node M32C Options
13286 @subsection M32C Options
13287 @cindex M32C options
13289 @table @gcctabopt
13290 @item -mcpu=@var{name}
13291 @opindex mcpu=
13292 Select the CPU for which code is generated.  @var{name} may be one of
13293 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
13294 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
13295 the M32C/80 series.
13297 @item -msim
13298 @opindex msim
13299 Specifies that the program will be run on the simulator.  This causes
13300 an alternate runtime library to be linked in which supports, for
13301 example, file I/O@.  You must not use this option when generating
13302 programs that will run on real hardware; you must provide your own
13303 runtime library for whatever I/O functions are needed.
13305 @item -memregs=@var{number}
13306 @opindex memregs=
13307 Specifies the number of memory-based pseudo-registers GCC will use
13308 during code generation.  These pseudo-registers will be used like real
13309 registers, so there is a tradeoff between GCC's ability to fit the
13310 code into available registers, and the performance penalty of using
13311 memory instead of registers.  Note that all modules in a program must
13312 be compiled with the same value for this option.  Because of that, you
13313 must not use this option with the default runtime libraries gcc
13314 builds.
13316 @end table
13318 @node M32R/D Options
13319 @subsection M32R/D Options
13320 @cindex M32R/D options
13322 These @option{-m} options are defined for Renesas M32R/D architectures:
13324 @table @gcctabopt
13325 @item -m32r2
13326 @opindex m32r2
13327 Generate code for the M32R/2@.
13329 @item -m32rx
13330 @opindex m32rx
13331 Generate code for the M32R/X@.
13333 @item -m32r
13334 @opindex m32r
13335 Generate code for the M32R@.  This is the default.
13337 @item -mmodel=small
13338 @opindex mmodel=small
13339 Assume all objects live in the lower 16MB of memory (so that their addresses
13340 can be loaded with the @code{ld24} instruction), and assume all subroutines
13341 are reachable with the @code{bl} instruction.
13342 This is the default.
13344 The addressability of a particular object can be set with the
13345 @code{model} attribute.
13347 @item -mmodel=medium
13348 @opindex mmodel=medium
13349 Assume objects may be anywhere in the 32-bit address space (the compiler
13350 will generate @code{seth/add3} instructions to load their addresses), and
13351 assume all subroutines are reachable with the @code{bl} instruction.
13353 @item -mmodel=large
13354 @opindex mmodel=large
13355 Assume objects may be anywhere in the 32-bit address space (the compiler
13356 will generate @code{seth/add3} instructions to load their addresses), and
13357 assume subroutines may not be reachable with the @code{bl} instruction
13358 (the compiler will generate the much slower @code{seth/add3/jl}
13359 instruction sequence).
13361 @item -msdata=none
13362 @opindex msdata=none
13363 Disable use of the small data area.  Variables will be put into
13364 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
13365 @code{section} attribute has been specified).
13366 This is the default.
13368 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
13369 Objects may be explicitly put in the small data area with the
13370 @code{section} attribute using one of these sections.
13372 @item -msdata=sdata
13373 @opindex msdata=sdata
13374 Put small global and static data in the small data area, but do not
13375 generate special code to reference them.
13377 @item -msdata=use
13378 @opindex msdata=use
13379 Put small global and static data in the small data area, and generate
13380 special instructions to reference them.
13382 @item -G @var{num}
13383 @opindex G
13384 @cindex smaller data references
13385 Put global and static objects less than or equal to @var{num} bytes
13386 into the small data or bss sections instead of the normal data or bss
13387 sections.  The default value of @var{num} is 8.
13388 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
13389 for this option to have any effect.
13391 All modules should be compiled with the same @option{-G @var{num}} value.
13392 Compiling with different values of @var{num} may or may not work; if it
13393 doesn't the linker will give an error message---incorrect code will not be
13394 generated.
13396 @item -mdebug
13397 @opindex mdebug
13398 Makes the M32R specific code in the compiler display some statistics
13399 that might help in debugging programs.
13401 @item -malign-loops
13402 @opindex malign-loops
13403 Align all loops to a 32-byte boundary.
13405 @item -mno-align-loops
13406 @opindex mno-align-loops
13407 Do not enforce a 32-byte alignment for loops.  This is the default.
13409 @item -missue-rate=@var{number}
13410 @opindex missue-rate=@var{number}
13411 Issue @var{number} instructions per cycle.  @var{number} can only be 1
13412 or 2.
13414 @item -mbranch-cost=@var{number}
13415 @opindex mbranch-cost=@var{number}
13416 @var{number} can only be 1 or 2.  If it is 1 then branches will be
13417 preferred over conditional code, if it is 2, then the opposite will
13418 apply.
13420 @item -mflush-trap=@var{number}
13421 @opindex mflush-trap=@var{number}
13422 Specifies the trap number to use to flush the cache.  The default is
13423 12.  Valid numbers are between 0 and 15 inclusive.
13425 @item -mno-flush-trap
13426 @opindex mno-flush-trap
13427 Specifies that the cache cannot be flushed by using a trap.
13429 @item -mflush-func=@var{name}
13430 @opindex mflush-func=@var{name}
13431 Specifies the name of the operating system function to call to flush
13432 the cache.  The default is @emph{_flush_cache}, but a function call
13433 will only be used if a trap is not available.
13435 @item -mno-flush-func
13436 @opindex mno-flush-func
13437 Indicates that there is no OS function for flushing the cache.
13439 @end table
13441 @node M680x0 Options
13442 @subsection M680x0 Options
13443 @cindex M680x0 options
13445 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
13446 The default settings depend on which architecture was selected when
13447 the compiler was configured; the defaults for the most common choices
13448 are given below.
13450 @table @gcctabopt
13451 @item -march=@var{arch}
13452 @opindex march
13453 Generate code for a specific M680x0 or ColdFire instruction set
13454 architecture.  Permissible values of @var{arch} for M680x0
13455 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
13456 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
13457 architectures are selected according to Freescale's ISA classification
13458 and the permissible values are: @samp{isaa}, @samp{isaaplus},
13459 @samp{isab} and @samp{isac}.
13461 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
13462 code for a ColdFire target.  The @var{arch} in this macro is one of the
13463 @option{-march} arguments given above.
13465 When used together, @option{-march} and @option{-mtune} select code
13466 that runs on a family of similar processors but that is optimized
13467 for a particular microarchitecture.
13469 @item -mcpu=@var{cpu}
13470 @opindex mcpu
13471 Generate code for a specific M680x0 or ColdFire processor.
13472 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
13473 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
13474 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
13475 below, which also classifies the CPUs into families:
13477 @multitable @columnfractions 0.20 0.80
13478 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
13479 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
13480 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
13481 @item @samp{5206e} @tab @samp{5206e}
13482 @item @samp{5208} @tab @samp{5207} @samp{5208}
13483 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
13484 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
13485 @item @samp{5216} @tab @samp{5214} @samp{5216}
13486 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
13487 @item @samp{5225} @tab @samp{5224} @samp{5225}
13488 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
13489 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
13490 @item @samp{5249} @tab @samp{5249}
13491 @item @samp{5250} @tab @samp{5250}
13492 @item @samp{5271} @tab @samp{5270} @samp{5271}
13493 @item @samp{5272} @tab @samp{5272}
13494 @item @samp{5275} @tab @samp{5274} @samp{5275}
13495 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
13496 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
13497 @item @samp{5307} @tab @samp{5307}
13498 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
13499 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
13500 @item @samp{5407} @tab @samp{5407}
13501 @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}
13502 @end multitable
13504 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
13505 @var{arch} is compatible with @var{cpu}.  Other combinations of
13506 @option{-mcpu} and @option{-march} are rejected.
13508 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
13509 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
13510 where the value of @var{family} is given by the table above.
13512 @item -mtune=@var{tune}
13513 @opindex mtune
13514 Tune the code for a particular microarchitecture, within the
13515 constraints set by @option{-march} and @option{-mcpu}.
13516 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
13517 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
13518 and @samp{cpu32}.  The ColdFire microarchitectures
13519 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
13521 You can also use @option{-mtune=68020-40} for code that needs
13522 to run relatively well on 68020, 68030 and 68040 targets.
13523 @option{-mtune=68020-60} is similar but includes 68060 targets
13524 as well.  These two options select the same tuning decisions as
13525 @option{-m68020-40} and @option{-m68020-60} respectively.
13527 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
13528 when tuning for 680x0 architecture @var{arch}.  It also defines
13529 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
13530 option is used.  If gcc is tuning for a range of architectures,
13531 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
13532 it defines the macros for every architecture in the range.
13534 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
13535 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
13536 of the arguments given above.
13538 @item -m68000
13539 @itemx -mc68000
13540 @opindex m68000
13541 @opindex mc68000
13542 Generate output for a 68000.  This is the default
13543 when the compiler is configured for 68000-based systems.
13544 It is equivalent to @option{-march=68000}.
13546 Use this option for microcontrollers with a 68000 or EC000 core,
13547 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
13549 @item -m68010
13550 @opindex m68010
13551 Generate output for a 68010.  This is the default
13552 when the compiler is configured for 68010-based systems.
13553 It is equivalent to @option{-march=68010}.
13555 @item -m68020
13556 @itemx -mc68020
13557 @opindex m68020
13558 @opindex mc68020
13559 Generate output for a 68020.  This is the default
13560 when the compiler is configured for 68020-based systems.
13561 It is equivalent to @option{-march=68020}.
13563 @item -m68030
13564 @opindex m68030
13565 Generate output for a 68030.  This is the default when the compiler is
13566 configured for 68030-based systems.  It is equivalent to
13567 @option{-march=68030}.
13569 @item -m68040
13570 @opindex m68040
13571 Generate output for a 68040.  This is the default when the compiler is
13572 configured for 68040-based systems.  It is equivalent to
13573 @option{-march=68040}.
13575 This option inhibits the use of 68881/68882 instructions that have to be
13576 emulated by software on the 68040.  Use this option if your 68040 does not
13577 have code to emulate those instructions.
13579 @item -m68060
13580 @opindex m68060
13581 Generate output for a 68060.  This is the default when the compiler is
13582 configured for 68060-based systems.  It is equivalent to
13583 @option{-march=68060}.
13585 This option inhibits the use of 68020 and 68881/68882 instructions that
13586 have to be emulated by software on the 68060.  Use this option if your 68060
13587 does not have code to emulate those instructions.
13589 @item -mcpu32
13590 @opindex mcpu32
13591 Generate output for a CPU32.  This is the default
13592 when the compiler is configured for CPU32-based systems.
13593 It is equivalent to @option{-march=cpu32}.
13595 Use this option for microcontrollers with a
13596 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
13597 68336, 68340, 68341, 68349 and 68360.
13599 @item -m5200
13600 @opindex m5200
13601 Generate output for a 520X ColdFire CPU@.  This is the default
13602 when the compiler is configured for 520X-based systems.
13603 It is equivalent to @option{-mcpu=5206}, and is now deprecated
13604 in favor of that option.
13606 Use this option for microcontroller with a 5200 core, including
13607 the MCF5202, MCF5203, MCF5204 and MCF5206.
13609 @item -m5206e
13610 @opindex m5206e
13611 Generate output for a 5206e ColdFire CPU@.  The option is now
13612 deprecated in favor of the equivalent @option{-mcpu=5206e}.
13614 @item -m528x
13615 @opindex m528x
13616 Generate output for a member of the ColdFire 528X family.
13617 The option is now deprecated in favor of the equivalent
13618 @option{-mcpu=528x}.
13620 @item -m5307
13621 @opindex m5307
13622 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
13623 in favor of the equivalent @option{-mcpu=5307}.
13625 @item -m5407
13626 @opindex m5407
13627 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
13628 in favor of the equivalent @option{-mcpu=5407}.
13630 @item -mcfv4e
13631 @opindex mcfv4e
13632 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
13633 This includes use of hardware floating point instructions.
13634 The option is equivalent to @option{-mcpu=547x}, and is now
13635 deprecated in favor of that option.
13637 @item -m68020-40
13638 @opindex m68020-40
13639 Generate output for a 68040, without using any of the new instructions.
13640 This results in code which can run relatively efficiently on either a
13641 68020/68881 or a 68030 or a 68040.  The generated code does use the
13642 68881 instructions that are emulated on the 68040.
13644 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
13646 @item -m68020-60
13647 @opindex m68020-60
13648 Generate output for a 68060, without using any of the new instructions.
13649 This results in code which can run relatively efficiently on either a
13650 68020/68881 or a 68030 or a 68040.  The generated code does use the
13651 68881 instructions that are emulated on the 68060.
13653 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
13655 @item -mhard-float
13656 @itemx -m68881
13657 @opindex mhard-float
13658 @opindex m68881
13659 Generate floating-point instructions.  This is the default for 68020
13660 and above, and for ColdFire devices that have an FPU@.  It defines the
13661 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13662 on ColdFire targets.
13664 @item -msoft-float
13665 @opindex msoft-float
13666 Do not generate floating-point instructions; use library calls instead.
13667 This is the default for 68000, 68010, and 68832 targets.  It is also
13668 the default for ColdFire devices that have no FPU.
13670 @item -mdiv
13671 @itemx -mno-div
13672 @opindex mdiv
13673 @opindex mno-div
13674 Generate (do not generate) ColdFire hardware divide and remainder
13675 instructions.  If @option{-march} is used without @option{-mcpu},
13676 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13677 architectures.  Otherwise, the default is taken from the target CPU
13678 (either the default CPU, or the one specified by @option{-mcpu}).  For
13679 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13680 @option{-mcpu=5206e}.
13682 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13684 @item -mshort
13685 @opindex mshort
13686 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13687 Additionally, parameters passed on the stack are also aligned to a
13688 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13690 @item -mno-short
13691 @opindex mno-short
13692 Do not consider type @code{int} to be 16 bits wide.  This is the default.
13694 @item -mnobitfield
13695 @itemx -mno-bitfield
13696 @opindex mnobitfield
13697 @opindex mno-bitfield
13698 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
13699 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13701 @item -mbitfield
13702 @opindex mbitfield
13703 Do use the bit-field instructions.  The @option{-m68020} option implies
13704 @option{-mbitfield}.  This is the default if you use a configuration
13705 designed for a 68020.
13707 @item -mrtd
13708 @opindex mrtd
13709 Use a different function-calling convention, in which functions
13710 that take a fixed number of arguments return with the @code{rtd}
13711 instruction, which pops their arguments while returning.  This
13712 saves one instruction in the caller since there is no need to pop
13713 the arguments there.
13715 This calling convention is incompatible with the one normally
13716 used on Unix, so you cannot use it if you need to call libraries
13717 compiled with the Unix compiler.
13719 Also, you must provide function prototypes for all functions that
13720 take variable numbers of arguments (including @code{printf});
13721 otherwise incorrect code will be generated for calls to those
13722 functions.
13724 In addition, seriously incorrect code will result if you call a
13725 function with too many arguments.  (Normally, extra arguments are
13726 harmlessly ignored.)
13728 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13729 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13731 @item -mno-rtd
13732 @opindex mno-rtd
13733 Do not use the calling conventions selected by @option{-mrtd}.
13734 This is the default.
13736 @item -malign-int
13737 @itemx -mno-align-int
13738 @opindex malign-int
13739 @opindex mno-align-int
13740 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13741 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13742 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13743 Aligning variables on 32-bit boundaries produces code that runs somewhat
13744 faster on processors with 32-bit busses at the expense of more memory.
13746 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13747 align structures containing the above types  differently than
13748 most published application binary interface specifications for the m68k.
13750 @item -mpcrel
13751 @opindex mpcrel
13752 Use the pc-relative addressing mode of the 68000 directly, instead of
13753 using a global offset table.  At present, this option implies @option{-fpic},
13754 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13755 not presently supported with @option{-mpcrel}, though this could be supported for
13756 68020 and higher processors.
13758 @item -mno-strict-align
13759 @itemx -mstrict-align
13760 @opindex mno-strict-align
13761 @opindex mstrict-align
13762 Do not (do) assume that unaligned memory references will be handled by
13763 the system.
13765 @item -msep-data
13766 Generate code that allows the data segment to be located in a different
13767 area of memory from the text segment.  This allows for execute in place in
13768 an environment without virtual memory management.  This option implies
13769 @option{-fPIC}.
13771 @item -mno-sep-data
13772 Generate code that assumes that the data segment follows the text segment.
13773 This is the default.
13775 @item -mid-shared-library
13776 Generate code that supports shared libraries via the library ID method.
13777 This allows for execute in place and shared libraries in an environment
13778 without virtual memory management.  This option implies @option{-fPIC}.
13780 @item -mno-id-shared-library
13781 Generate code that doesn't assume ID based shared libraries are being used.
13782 This is the default.
13784 @item -mshared-library-id=n
13785 Specified the identification number of the ID based shared library being
13786 compiled.  Specifying a value of 0 will generate more compact code, specifying
13787 other values will force the allocation of that number to the current
13788 library but is no more space or time efficient than omitting this option.
13790 @item -mxgot
13791 @itemx -mno-xgot
13792 @opindex mxgot
13793 @opindex mno-xgot
13794 When generating position-independent code for ColdFire, generate code
13795 that works if the GOT has more than 8192 entries.  This code is
13796 larger and slower than code generated without this option.  On M680x0
13797 processors, this option is not needed; @option{-fPIC} suffices.
13799 GCC normally uses a single instruction to load values from the GOT@.
13800 While this is relatively efficient, it only works if the GOT
13801 is smaller than about 64k.  Anything larger causes the linker
13802 to report an error such as:
13804 @cindex relocation truncated to fit (ColdFire)
13805 @smallexample
13806 relocation truncated to fit: R_68K_GOT16O foobar
13807 @end smallexample
13809 If this happens, you should recompile your code with @option{-mxgot}.
13810 It should then work with very large GOTs.  However, code generated with
13811 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13812 the value of a global symbol.
13814 Note that some linkers, including newer versions of the GNU linker,
13815 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13816 you should only need to use @option{-mxgot} when compiling a single
13817 object file that accesses more than 8192 GOT entries.  Very few do.
13819 These options have no effect unless GCC is generating
13820 position-independent code.
13822 @end table
13824 @node MCore Options
13825 @subsection MCore Options
13826 @cindex MCore options
13828 These are the @samp{-m} options defined for the Motorola M*Core
13829 processors.
13831 @table @gcctabopt
13833 @item -mhardlit
13834 @itemx -mno-hardlit
13835 @opindex mhardlit
13836 @opindex mno-hardlit
13837 Inline constants into the code stream if it can be done in two
13838 instructions or less.
13840 @item -mdiv
13841 @itemx -mno-div
13842 @opindex mdiv
13843 @opindex mno-div
13844 Use the divide instruction.  (Enabled by default).
13846 @item -mrelax-immediate
13847 @itemx -mno-relax-immediate
13848 @opindex mrelax-immediate
13849 @opindex mno-relax-immediate
13850 Allow arbitrary sized immediates in bit operations.
13852 @item -mwide-bitfields
13853 @itemx -mno-wide-bitfields
13854 @opindex mwide-bitfields
13855 @opindex mno-wide-bitfields
13856 Always treat bit-fields as int-sized.
13858 @item -m4byte-functions
13859 @itemx -mno-4byte-functions
13860 @opindex m4byte-functions
13861 @opindex mno-4byte-functions
13862 Force all functions to be aligned to a four byte boundary.
13864 @item -mcallgraph-data
13865 @itemx -mno-callgraph-data
13866 @opindex mcallgraph-data
13867 @opindex mno-callgraph-data
13868 Emit callgraph information.
13870 @item -mslow-bytes
13871 @itemx -mno-slow-bytes
13872 @opindex mslow-bytes
13873 @opindex mno-slow-bytes
13874 Prefer word access when reading byte quantities.
13876 @item -mlittle-endian
13877 @itemx -mbig-endian
13878 @opindex mlittle-endian
13879 @opindex mbig-endian
13880 Generate code for a little endian target.
13882 @item -m210
13883 @itemx -m340
13884 @opindex m210
13885 @opindex m340
13886 Generate code for the 210 processor.
13888 @item -mno-lsim
13889 @opindex mno-lsim
13890 Assume that run-time support has been provided and so omit the
13891 simulator library (@file{libsim.a)} from the linker command line.
13893 @item -mstack-increment=@var{size}
13894 @opindex mstack-increment
13895 Set the maximum amount for a single stack increment operation.  Large
13896 values can increase the speed of programs which contain functions
13897 that need a large amount of stack space, but they can also trigger a
13898 segmentation fault if the stack is extended too much.  The default
13899 value is 0x1000.
13901 @end table
13903 @node MeP Options
13904 @subsection MeP Options
13905 @cindex MeP options
13907 @table @gcctabopt
13909 @item -mabsdiff
13910 @opindex mabsdiff
13911 Enables the @code{abs} instruction, which is the absolute difference
13912 between two registers.
13914 @item -mall-opts
13915 @opindex mall-opts
13916 Enables all the optional instructions - average, multiply, divide, bit
13917 operations, leading zero, absolute difference, min/max, clip, and
13918 saturation.
13921 @item -maverage
13922 @opindex maverage
13923 Enables the @code{ave} instruction, which computes the average of two
13924 registers.
13926 @item -mbased=@var{n}
13927 @opindex mbased=
13928 Variables of size @var{n} bytes or smaller will be placed in the
13929 @code{.based} section by default.  Based variables use the @code{$tp}
13930 register as a base register, and there is a 128 byte limit to the
13931 @code{.based} section.
13933 @item -mbitops
13934 @opindex mbitops
13935 Enables the bit operation instructions - bit test (@code{btstm}), set
13936 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13937 test-and-set (@code{tas}).
13939 @item -mc=@var{name}
13940 @opindex mc=
13941 Selects which section constant data will be placed in.  @var{name} may
13942 be @code{tiny}, @code{near}, or @code{far}.
13944 @item -mclip
13945 @opindex mclip
13946 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13947 useful unless you also provide @code{-mminmax}.
13949 @item -mconfig=@var{name}
13950 @opindex mconfig=
13951 Selects one of the build-in core configurations.  Each MeP chip has
13952 one or more modules in it; each module has a core CPU and a variety of
13953 coprocessors, optional instructions, and peripherals.  The
13954 @code{MeP-Integrator} tool, not part of GCC, provides these
13955 configurations through this option; using this option is the same as
13956 using all the corresponding command line options.  The default
13957 configuration is @code{default}.
13959 @item -mcop
13960 @opindex mcop
13961 Enables the coprocessor instructions.  By default, this is a 32-bit
13962 coprocessor.  Note that the coprocessor is normally enabled via the
13963 @code{-mconfig=} option.
13965 @item -mcop32
13966 @opindex mcop32
13967 Enables the 32-bit coprocessor's instructions.
13969 @item -mcop64
13970 @opindex mcop64
13971 Enables the 64-bit coprocessor's instructions.
13973 @item -mivc2
13974 @opindex mivc2
13975 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13977 @item -mdc
13978 @opindex mdc
13979 Causes constant variables to be placed in the @code{.near} section.
13981 @item -mdiv
13982 @opindex mdiv
13983 Enables the @code{div} and @code{divu} instructions.
13985 @item -meb
13986 @opindex meb
13987 Generate big-endian code.
13989 @item -mel
13990 @opindex mel
13991 Generate little-endian code.
13993 @item -mio-volatile
13994 @opindex mio-volatile
13995 Tells the compiler that any variable marked with the @code{io}
13996 attribute is to be considered volatile.
13998 @item -ml
13999 @opindex ml
14000 Causes variables to be assigned to the @code{.far} section by default.
14002 @item -mleadz
14003 @opindex mleadz
14004 Enables the @code{leadz} (leading zero) instruction.
14006 @item -mm
14007 @opindex mm
14008 Causes variables to be assigned to the @code{.near} section by default.
14010 @item -mminmax
14011 @opindex mminmax
14012 Enables the @code{min} and @code{max} instructions.
14014 @item -mmult
14015 @opindex mmult
14016 Enables the multiplication and multiply-accumulate instructions.
14018 @item -mno-opts
14019 @opindex mno-opts
14020 Disables all the optional instructions enabled by @code{-mall-opts}.
14022 @item -mrepeat
14023 @opindex mrepeat
14024 Enables the @code{repeat} and @code{erepeat} instructions, used for
14025 low-overhead looping.
14027 @item -ms
14028 @opindex ms
14029 Causes all variables to default to the @code{.tiny} section.  Note
14030 that there is a 65536 byte limit to this section.  Accesses to these
14031 variables use the @code{%gp} base register.
14033 @item -msatur
14034 @opindex msatur
14035 Enables the saturation instructions.  Note that the compiler does not
14036 currently generate these itself, but this option is included for
14037 compatibility with other tools, like @code{as}.
14039 @item -msdram
14040 @opindex msdram
14041 Link the SDRAM-based runtime instead of the default ROM-based runtime.
14043 @item -msim
14044 @opindex msim
14045 Link the simulator runtime libraries.
14047 @item -msimnovec
14048 @opindex msimnovec
14049 Link the simulator runtime libraries, excluding built-in support
14050 for reset and exception vectors and tables.
14052 @item -mtf
14053 @opindex mtf
14054 Causes all functions to default to the @code{.far} section.  Without
14055 this option, functions default to the @code{.near} section.
14057 @item -mtiny=@var{n}
14058 @opindex mtiny=
14059 Variables that are @var{n} bytes or smaller will be allocated to the
14060 @code{.tiny} section.  These variables use the @code{$gp} base
14061 register.  The default for this option is 4, but note that there's a
14062 65536 byte limit to the @code{.tiny} section.
14064 @end table
14066 @node MicroBlaze Options
14067 @subsection MicroBlaze Options
14068 @cindex MicroBlaze Options
14070 @table @gcctabopt
14072 @item -msoft-float
14073 @opindex msoft-float
14074 Use software emulation for floating point (default).
14076 @item -mhard-float
14077 @opindex mhard-float
14078 Use hardware floating point instructions.
14080 @item -mmemcpy
14081 @opindex mmemcpy
14082 Do not optimize block moves, use @code{memcpy}.
14084 @item -mno-clearbss
14085 @opindex mno-clearbss
14086 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
14088 @item -mcpu=@var{cpu-type}
14089 @opindex mcpu=
14090 Use features of and schedule code for given CPU.
14091 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
14092 where @var{X} is a major version, @var{YY} is the minor version, and
14093 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
14094 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
14096 @item -mxl-soft-mul
14097 @opindex mxl-soft-mul
14098 Use software multiply emulation (default).
14100 @item -mxl-soft-div
14101 @opindex mxl-soft-div
14102 Use software emulation for divides (default).
14104 @item -mxl-barrel-shift
14105 @opindex mxl-barrel-shift
14106 Use the hardware barrel shifter.
14108 @item -mxl-pattern-compare
14109 @opindex mxl-pattern-compare
14110 Use pattern compare instructions.
14112 @item -msmall-divides
14113 @opindex msmall-divides
14114 Use table lookup optimization for small signed integer divisions.
14116 @item -mxl-stack-check
14117 @opindex mxl-stack-check
14118 This option is deprecated.  Use -fstack-check instead.
14120 @item -mxl-gp-opt
14121 @opindex mxl-gp-opt
14122 Use GP relative sdata/sbss sections.
14124 @item -mxl-multiply-high
14125 @opindex mxl-multiply-high
14126 Use multiply high instructions for high part of 32x32 multiply.
14128 @item -mxl-float-convert
14129 @opindex mxl-float-convert
14130 Use hardware floating point conversion instructions.
14132 @item -mxl-float-sqrt
14133 @opindex mxl-float-sqrt
14134 Use hardware floating point square root instruction.
14136 @item -mxl-mode-@var{app-model}
14137 Select application model @var{app-model}.  Valid models are
14138 @table @samp
14139 @item executable
14140 normal executable (default), uses startup code @file{crt0.o}.
14142 @item xmdstub
14143 for use with Xilinx Microprocessor Debugger (XMD) based
14144 software intrusive debug agent called xmdstub. This uses startup file
14145 @file{crt1.o} and sets the start address of the program to be 0x800.
14147 @item bootstrap
14148 for applications that are loaded using a bootloader.
14149 This model uses startup file @file{crt2.o} which does not contain a processor
14150 reset vector handler. This is suitable for transferring control on a
14151 processor reset to the bootloader rather than the application.
14153 @item novectors
14154 for applications that do not require any of the
14155 MicroBlaze vectors. This option may be useful for applications running
14156 within a monitoring application. This model uses @file{crt3.o} as a startup file.
14157 @end table
14159 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
14160 @option{-mxl-mode-@var{app-model}}.
14162 @end table
14164 @node MIPS Options
14165 @subsection MIPS Options
14166 @cindex MIPS options
14168 @table @gcctabopt
14170 @item -EB
14171 @opindex EB
14172 Generate big-endian code.
14174 @item -EL
14175 @opindex EL
14176 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
14177 configurations.
14179 @item -march=@var{arch}
14180 @opindex march
14181 Generate code that will run on @var{arch}, which can be the name of a
14182 generic MIPS ISA, or the name of a particular processor.
14183 The ISA names are:
14184 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
14185 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
14186 The processor names are:
14187 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
14188 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
14189 @samp{5kc}, @samp{5kf},
14190 @samp{20kc},
14191 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
14192 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
14193 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
14194 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
14195 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
14196 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
14197 @samp{m4k},
14198 @samp{octeon},
14199 @samp{orion},
14200 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
14201 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
14202 @samp{rm7000}, @samp{rm9000},
14203 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
14204 @samp{sb1},
14205 @samp{sr71000},
14206 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
14207 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
14208 and @samp{xlr}.
14209 The special value @samp{from-abi} selects the
14210 most compatible architecture for the selected ABI (that is,
14211 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
14213 Native Linux/GNU toolchains also support the value @samp{native},
14214 which selects the best architecture option for the host processor.
14215 @option{-march=native} has no effect if GCC does not recognize
14216 the processor.
14218 In processor names, a final @samp{000} can be abbreviated as @samp{k}
14219 (for example, @samp{-march=r2k}).  Prefixes are optional, and
14220 @samp{vr} may be written @samp{r}.
14222 Names of the form @samp{@var{n}f2_1} refer to processors with
14223 FPUs clocked at half the rate of the core, names of the form
14224 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
14225 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
14226 processors with FPUs clocked a ratio of 3:2 with respect to the core.
14227 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
14228 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
14229 accepted as synonyms for @samp{@var{n}f1_1}.
14231 GCC defines two macros based on the value of this option.  The first
14232 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
14233 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
14234 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
14235 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
14236 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
14238 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
14239 above.  In other words, it will have the full prefix and will not
14240 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
14241 the macro names the resolved architecture (either @samp{"mips1"} or
14242 @samp{"mips3"}).  It names the default architecture when no
14243 @option{-march} option is given.
14245 @item -mtune=@var{arch}
14246 @opindex mtune
14247 Optimize for @var{arch}.  Among other things, this option controls
14248 the way instructions are scheduled, and the perceived cost of arithmetic
14249 operations.  The list of @var{arch} values is the same as for
14250 @option{-march}.
14252 When this option is not used, GCC will optimize for the processor
14253 specified by @option{-march}.  By using @option{-march} and
14254 @option{-mtune} together, it is possible to generate code that will
14255 run on a family of processors, but optimize the code for one
14256 particular member of that family.
14258 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
14259 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
14260 @samp{-march} ones described above.
14262 @item -mips1
14263 @opindex mips1
14264 Equivalent to @samp{-march=mips1}.
14266 @item -mips2
14267 @opindex mips2
14268 Equivalent to @samp{-march=mips2}.
14270 @item -mips3
14271 @opindex mips3
14272 Equivalent to @samp{-march=mips3}.
14274 @item -mips4
14275 @opindex mips4
14276 Equivalent to @samp{-march=mips4}.
14278 @item -mips32
14279 @opindex mips32
14280 Equivalent to @samp{-march=mips32}.
14282 @item -mips32r2
14283 @opindex mips32r2
14284 Equivalent to @samp{-march=mips32r2}.
14286 @item -mips64
14287 @opindex mips64
14288 Equivalent to @samp{-march=mips64}.
14290 @item -mips64r2
14291 @opindex mips64r2
14292 Equivalent to @samp{-march=mips64r2}.
14294 @item -mips16
14295 @itemx -mno-mips16
14296 @opindex mips16
14297 @opindex mno-mips16
14298 Generate (do not generate) MIPS16 code.  If GCC is targetting a
14299 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
14301 MIPS16 code generation can also be controlled on a per-function basis
14302 by means of @code{mips16} and @code{nomips16} attributes.
14303 @xref{Function Attributes}, for more information.
14305 @item -mflip-mips16
14306 @opindex mflip-mips16
14307 Generate MIPS16 code on alternating functions.  This option is provided
14308 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
14309 not intended for ordinary use in compiling user code.
14311 @item -minterlink-mips16
14312 @itemx -mno-interlink-mips16
14313 @opindex minterlink-mips16
14314 @opindex mno-interlink-mips16
14315 Require (do not require) that non-MIPS16 code be link-compatible with
14316 MIPS16 code.
14318 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
14319 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
14320 therefore disables direct jumps unless GCC knows that the target of the
14321 jump is not MIPS16.
14323 @item -mabi=32
14324 @itemx -mabi=o64
14325 @itemx -mabi=n32
14326 @itemx -mabi=64
14327 @itemx -mabi=eabi
14328 @opindex mabi=32
14329 @opindex mabi=o64
14330 @opindex mabi=n32
14331 @opindex mabi=64
14332 @opindex mabi=eabi
14333 Generate code for the given ABI@.
14335 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
14336 generates 64-bit code when you select a 64-bit architecture, but you
14337 can use @option{-mgp32} to get 32-bit code instead.
14339 For information about the O64 ABI, see
14340 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
14342 GCC supports a variant of the o32 ABI in which floating-point registers
14343 are 64 rather than 32 bits wide.  You can select this combination with
14344 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
14345 and @samp{mfhc1} instructions and is therefore only supported for
14346 MIPS32R2 processors.
14348 The register assignments for arguments and return values remain the
14349 same, but each scalar value is passed in a single 64-bit register
14350 rather than a pair of 32-bit registers.  For example, scalar
14351 floating-point values are returned in @samp{$f0} only, not a
14352 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
14353 remains the same, but all 64 bits are saved.
14355 @item -mabicalls
14356 @itemx -mno-abicalls
14357 @opindex mabicalls
14358 @opindex mno-abicalls
14359 Generate (do not generate) code that is suitable for SVR4-style
14360 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
14361 systems.
14363 @item -mshared
14364 @itemx -mno-shared
14365 Generate (do not generate) code that is fully position-independent,
14366 and that can therefore be linked into shared libraries.  This option
14367 only affects @option{-mabicalls}.
14369 All @option{-mabicalls} code has traditionally been position-independent,
14370 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
14371 as an extension, the GNU toolchain allows executables to use absolute
14372 accesses for locally-binding symbols.  It can also use shorter GP
14373 initialization sequences and generate direct calls to locally-defined
14374 functions.  This mode is selected by @option{-mno-shared}.
14376 @option{-mno-shared} depends on binutils 2.16 or higher and generates
14377 objects that can only be linked by the GNU linker.  However, the option
14378 does not affect the ABI of the final executable; it only affects the ABI
14379 of relocatable objects.  Using @option{-mno-shared} will generally make
14380 executables both smaller and quicker.
14382 @option{-mshared} is the default.
14384 @item -mplt
14385 @itemx -mno-plt
14386 @opindex mplt
14387 @opindex mno-plt
14388 Assume (do not assume) that the static and dynamic linkers
14389 support PLTs and copy relocations.  This option only affects
14390 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
14391 has no effect without @samp{-msym32}.
14393 You can make @option{-mplt} the default by configuring
14394 GCC with @option{--with-mips-plt}.  The default is
14395 @option{-mno-plt} otherwise.
14397 @item -mxgot
14398 @itemx -mno-xgot
14399 @opindex mxgot
14400 @opindex mno-xgot
14401 Lift (do not lift) the usual restrictions on the size of the global
14402 offset table.
14404 GCC normally uses a single instruction to load values from the GOT@.
14405 While this is relatively efficient, it will only work if the GOT
14406 is smaller than about 64k.  Anything larger will cause the linker
14407 to report an error such as:
14409 @cindex relocation truncated to fit (MIPS)
14410 @smallexample
14411 relocation truncated to fit: R_MIPS_GOT16 foobar
14412 @end smallexample
14414 If this happens, you should recompile your code with @option{-mxgot}.
14415 It should then work with very large GOTs, although it will also be
14416 less efficient, since it will take three instructions to fetch the
14417 value of a global symbol.
14419 Note that some linkers can create multiple GOTs.  If you have such a
14420 linker, you should only need to use @option{-mxgot} when a single object
14421 file accesses more than 64k's worth of GOT entries.  Very few do.
14423 These options have no effect unless GCC is generating position
14424 independent code.
14426 @item -mgp32
14427 @opindex mgp32
14428 Assume that general-purpose registers are 32 bits wide.
14430 @item -mgp64
14431 @opindex mgp64
14432 Assume that general-purpose registers are 64 bits wide.
14434 @item -mfp32
14435 @opindex mfp32
14436 Assume that floating-point registers are 32 bits wide.
14438 @item -mfp64
14439 @opindex mfp64
14440 Assume that floating-point registers are 64 bits wide.
14442 @item -mhard-float
14443 @opindex mhard-float
14444 Use floating-point coprocessor instructions.
14446 @item -msoft-float
14447 @opindex msoft-float
14448 Do not use floating-point coprocessor instructions.  Implement
14449 floating-point calculations using library calls instead.
14451 @item -msingle-float
14452 @opindex msingle-float
14453 Assume that the floating-point coprocessor only supports single-precision
14454 operations.
14456 @item -mdouble-float
14457 @opindex mdouble-float
14458 Assume that the floating-point coprocessor supports double-precision
14459 operations.  This is the default.
14461 @item -mllsc
14462 @itemx -mno-llsc
14463 @opindex mllsc
14464 @opindex mno-llsc
14465 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
14466 implement atomic memory built-in functions.  When neither option is
14467 specified, GCC will use the instructions if the target architecture
14468 supports them.
14470 @option{-mllsc} is useful if the runtime environment can emulate the
14471 instructions and @option{-mno-llsc} can be useful when compiling for
14472 nonstandard ISAs.  You can make either option the default by
14473 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
14474 respectively.  @option{--with-llsc} is the default for some
14475 configurations; see the installation documentation for details.
14477 @item -mdsp
14478 @itemx -mno-dsp
14479 @opindex mdsp
14480 @opindex mno-dsp
14481 Use (do not use) revision 1 of the MIPS DSP ASE@.
14482 @xref{MIPS DSP Built-in Functions}.  This option defines the
14483 preprocessor macro @samp{__mips_dsp}.  It also defines
14484 @samp{__mips_dsp_rev} to 1.
14486 @item -mdspr2
14487 @itemx -mno-dspr2
14488 @opindex mdspr2
14489 @opindex mno-dspr2
14490 Use (do not use) revision 2 of the MIPS DSP ASE@.
14491 @xref{MIPS DSP Built-in Functions}.  This option defines the
14492 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
14493 It also defines @samp{__mips_dsp_rev} to 2.
14495 @item -msmartmips
14496 @itemx -mno-smartmips
14497 @opindex msmartmips
14498 @opindex mno-smartmips
14499 Use (do not use) the MIPS SmartMIPS ASE.
14501 @item -mpaired-single
14502 @itemx -mno-paired-single
14503 @opindex mpaired-single
14504 @opindex mno-paired-single
14505 Use (do not use) paired-single floating-point instructions.
14506 @xref{MIPS Paired-Single Support}.  This option requires
14507 hardware floating-point support to be enabled.
14509 @item -mdmx
14510 @itemx -mno-mdmx
14511 @opindex mdmx
14512 @opindex mno-mdmx
14513 Use (do not use) MIPS Digital Media Extension instructions.
14514 This option can only be used when generating 64-bit code and requires
14515 hardware floating-point support to be enabled.
14517 @item -mips3d
14518 @itemx -mno-mips3d
14519 @opindex mips3d
14520 @opindex mno-mips3d
14521 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
14522 The option @option{-mips3d} implies @option{-mpaired-single}.
14524 @item -mmt
14525 @itemx -mno-mt
14526 @opindex mmt
14527 @opindex mno-mt
14528 Use (do not use) MT Multithreading instructions.
14530 @item -mlong64
14531 @opindex mlong64
14532 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
14533 an explanation of the default and the way that the pointer size is
14534 determined.
14536 @item -mlong32
14537 @opindex mlong32
14538 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
14540 The default size of @code{int}s, @code{long}s and pointers depends on
14541 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
14542 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
14543 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
14544 or the same size as integer registers, whichever is smaller.
14546 @item -msym32
14547 @itemx -mno-sym32
14548 @opindex msym32
14549 @opindex mno-sym32
14550 Assume (do not assume) that all symbols have 32-bit values, regardless
14551 of the selected ABI@.  This option is useful in combination with
14552 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
14553 to generate shorter and faster references to symbolic addresses.
14555 @item -G @var{num}
14556 @opindex G
14557 Put definitions of externally-visible data in a small data section
14558 if that data is no bigger than @var{num} bytes.  GCC can then access
14559 the data more efficiently; see @option{-mgpopt} for details.
14561 The default @option{-G} option depends on the configuration.
14563 @item -mlocal-sdata
14564 @itemx -mno-local-sdata
14565 @opindex mlocal-sdata
14566 @opindex mno-local-sdata
14567 Extend (do not extend) the @option{-G} behavior to local data too,
14568 such as to static variables in C@.  @option{-mlocal-sdata} is the
14569 default for all configurations.
14571 If the linker complains that an application is using too much small data,
14572 you might want to try rebuilding the less performance-critical parts with
14573 @option{-mno-local-sdata}.  You might also want to build large
14574 libraries with @option{-mno-local-sdata}, so that the libraries leave
14575 more room for the main program.
14577 @item -mextern-sdata
14578 @itemx -mno-extern-sdata
14579 @opindex mextern-sdata
14580 @opindex mno-extern-sdata
14581 Assume (do not assume) that externally-defined data will be in
14582 a small data section if that data is within the @option{-G} limit.
14583 @option{-mextern-sdata} is the default for all configurations.
14585 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
14586 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
14587 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
14588 is placed in a small data section.  If @var{Var} is defined by another
14589 module, you must either compile that module with a high-enough
14590 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
14591 definition.  If @var{Var} is common, you must link the application
14592 with a high-enough @option{-G} setting.
14594 The easiest way of satisfying these restrictions is to compile
14595 and link every module with the same @option{-G} option.  However,
14596 you may wish to build a library that supports several different
14597 small data limits.  You can do this by compiling the library with
14598 the highest supported @option{-G} setting and additionally using
14599 @option{-mno-extern-sdata} to stop the library from making assumptions
14600 about externally-defined data.
14602 @item -mgpopt
14603 @itemx -mno-gpopt
14604 @opindex mgpopt
14605 @opindex mno-gpopt
14606 Use (do not use) GP-relative accesses for symbols that are known to be
14607 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
14608 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
14609 configurations.
14611 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
14612 might not hold the value of @code{_gp}.  For example, if the code is
14613 part of a library that might be used in a boot monitor, programs that
14614 call boot monitor routines will pass an unknown value in @code{$gp}.
14615 (In such situations, the boot monitor itself would usually be compiled
14616 with @option{-G0}.)
14618 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
14619 @option{-mno-extern-sdata}.
14621 @item -membedded-data
14622 @itemx -mno-embedded-data
14623 @opindex membedded-data
14624 @opindex mno-embedded-data
14625 Allocate variables to the read-only data section first if possible, then
14626 next in the small data section if possible, otherwise in data.  This gives
14627 slightly slower code than the default, but reduces the amount of RAM required
14628 when executing, and thus may be preferred for some embedded systems.
14630 @item -muninit-const-in-rodata
14631 @itemx -mno-uninit-const-in-rodata
14632 @opindex muninit-const-in-rodata
14633 @opindex mno-uninit-const-in-rodata
14634 Put uninitialized @code{const} variables in the read-only data section.
14635 This option is only meaningful in conjunction with @option{-membedded-data}.
14637 @item -mcode-readable=@var{setting}
14638 @opindex mcode-readable
14639 Specify whether GCC may generate code that reads from executable sections.
14640 There are three possible settings:
14642 @table @gcctabopt
14643 @item -mcode-readable=yes
14644 Instructions may freely access executable sections.  This is the
14645 default setting.
14647 @item -mcode-readable=pcrel
14648 MIPS16 PC-relative load instructions can access executable sections,
14649 but other instructions must not do so.  This option is useful on 4KSc
14650 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
14651 It is also useful on processors that can be configured to have a dual
14652 instruction/data SRAM interface and that, like the M4K, automatically
14653 redirect PC-relative loads to the instruction RAM.
14655 @item -mcode-readable=no
14656 Instructions must not access executable sections.  This option can be
14657 useful on targets that are configured to have a dual instruction/data
14658 SRAM interface but that (unlike the M4K) do not automatically redirect
14659 PC-relative loads to the instruction RAM.
14660 @end table
14662 @item -msplit-addresses
14663 @itemx -mno-split-addresses
14664 @opindex msplit-addresses
14665 @opindex mno-split-addresses
14666 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
14667 relocation operators.  This option has been superseded by
14668 @option{-mexplicit-relocs} but is retained for backwards compatibility.
14670 @item -mexplicit-relocs
14671 @itemx -mno-explicit-relocs
14672 @opindex mexplicit-relocs
14673 @opindex mno-explicit-relocs
14674 Use (do not use) assembler relocation operators when dealing with symbolic
14675 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
14676 is to use assembler macros instead.
14678 @option{-mexplicit-relocs} is the default if GCC was configured
14679 to use an assembler that supports relocation operators.
14681 @item -mcheck-zero-division
14682 @itemx -mno-check-zero-division
14683 @opindex mcheck-zero-division
14684 @opindex mno-check-zero-division
14685 Trap (do not trap) on integer division by zero.
14687 The default is @option{-mcheck-zero-division}.
14689 @item -mdivide-traps
14690 @itemx -mdivide-breaks
14691 @opindex mdivide-traps
14692 @opindex mdivide-breaks
14693 MIPS systems check for division by zero by generating either a
14694 conditional trap or a break instruction.  Using traps results in
14695 smaller code, but is only supported on MIPS II and later.  Also, some
14696 versions of the Linux kernel have a bug that prevents trap from
14697 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
14698 allow conditional traps on architectures that support them and
14699 @option{-mdivide-breaks} to force the use of breaks.
14701 The default is usually @option{-mdivide-traps}, but this can be
14702 overridden at configure time using @option{--with-divide=breaks}.
14703 Divide-by-zero checks can be completely disabled using
14704 @option{-mno-check-zero-division}.
14706 @item -mmemcpy
14707 @itemx -mno-memcpy
14708 @opindex mmemcpy
14709 @opindex mno-memcpy
14710 Force (do not force) the use of @code{memcpy()} for non-trivial block
14711 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
14712 most constant-sized copies.
14714 @item -mlong-calls
14715 @itemx -mno-long-calls
14716 @opindex mlong-calls
14717 @opindex mno-long-calls
14718 Disable (do not disable) use of the @code{jal} instruction.  Calling
14719 functions using @code{jal} is more efficient but requires the caller
14720 and callee to be in the same 256 megabyte segment.
14722 This option has no effect on abicalls code.  The default is
14723 @option{-mno-long-calls}.
14725 @item -mmad
14726 @itemx -mno-mad
14727 @opindex mmad
14728 @opindex mno-mad
14729 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14730 instructions, as provided by the R4650 ISA@.
14732 @item -mfused-madd
14733 @itemx -mno-fused-madd
14734 @opindex mfused-madd
14735 @opindex mno-fused-madd
14736 Enable (disable) use of the floating point multiply-accumulate
14737 instructions, when they are available.  The default is
14738 @option{-mfused-madd}.
14740 When multiply-accumulate instructions are used, the intermediate
14741 product is calculated to infinite precision and is not subject to
14742 the FCSR Flush to Zero bit.  This may be undesirable in some
14743 circumstances.
14745 @item -nocpp
14746 @opindex nocpp
14747 Tell the MIPS assembler to not run its preprocessor over user
14748 assembler files (with a @samp{.s} suffix) when assembling them.
14750 @item -mfix-24k
14751 @item -mno-fix-24k
14752 @opindex mfix-24k
14753 @opindex mno-fix-24k
14754 Work around the 24K E48 (lost data on stores during refill) errata.
14755 The workarounds are implemented by the assembler rather than by GCC.
14757 @item -mfix-r4000
14758 @itemx -mno-fix-r4000
14759 @opindex mfix-r4000
14760 @opindex mno-fix-r4000
14761 Work around certain R4000 CPU errata:
14762 @itemize @minus
14763 @item
14764 A double-word or a variable shift may give an incorrect result if executed
14765 immediately after starting an integer division.
14766 @item
14767 A double-word or a variable shift may give an incorrect result if executed
14768 while an integer multiplication is in progress.
14769 @item
14770 An integer division may give an incorrect result if started in a delay slot
14771 of a taken branch or a jump.
14772 @end itemize
14774 @item -mfix-r4400
14775 @itemx -mno-fix-r4400
14776 @opindex mfix-r4400
14777 @opindex mno-fix-r4400
14778 Work around certain R4400 CPU errata:
14779 @itemize @minus
14780 @item
14781 A double-word or a variable shift may give an incorrect result if executed
14782 immediately after starting an integer division.
14783 @end itemize
14785 @item -mfix-r10000
14786 @itemx -mno-fix-r10000
14787 @opindex mfix-r10000
14788 @opindex mno-fix-r10000
14789 Work around certain R10000 errata:
14790 @itemize @minus
14791 @item
14792 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14793 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14794 @end itemize
14796 This option can only be used if the target architecture supports
14797 branch-likely instructions.  @option{-mfix-r10000} is the default when
14798 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14799 otherwise.
14801 @item -mfix-vr4120
14802 @itemx -mno-fix-vr4120
14803 @opindex mfix-vr4120
14804 Work around certain VR4120 errata:
14805 @itemize @minus
14806 @item
14807 @code{dmultu} does not always produce the correct result.
14808 @item
14809 @code{div} and @code{ddiv} do not always produce the correct result if one
14810 of the operands is negative.
14811 @end itemize
14812 The workarounds for the division errata rely on special functions in
14813 @file{libgcc.a}.  At present, these functions are only provided by
14814 the @code{mips64vr*-elf} configurations.
14816 Other VR4120 errata require a nop to be inserted between certain pairs of
14817 instructions.  These errata are handled by the assembler, not by GCC itself.
14819 @item -mfix-vr4130
14820 @opindex mfix-vr4130
14821 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14822 workarounds are implemented by the assembler rather than by GCC,
14823 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14824 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14825 instructions are available instead.
14827 @item -mfix-sb1
14828 @itemx -mno-fix-sb1
14829 @opindex mfix-sb1
14830 Work around certain SB-1 CPU core errata.
14831 (This flag currently works around the SB-1 revision 2
14832 ``F1'' and ``F2'' floating point errata.)
14834 @item -mr10k-cache-barrier=@var{setting}
14835 @opindex mr10k-cache-barrier
14836 Specify whether GCC should insert cache barriers to avoid the
14837 side-effects of speculation on R10K processors.
14839 In common with many processors, the R10K tries to predict the outcome
14840 of a conditional branch and speculatively executes instructions from
14841 the ``taken'' branch.  It later aborts these instructions if the
14842 predicted outcome was wrong.  However, on the R10K, even aborted
14843 instructions can have side effects.
14845 This problem only affects kernel stores and, depending on the system,
14846 kernel loads.  As an example, a speculatively-executed store may load
14847 the target memory into cache and mark the cache line as dirty, even if
14848 the store itself is later aborted.  If a DMA operation writes to the
14849 same area of memory before the ``dirty'' line is flushed, the cached
14850 data will overwrite the DMA-ed data.  See the R10K processor manual
14851 for a full description, including other potential problems.
14853 One workaround is to insert cache barrier instructions before every memory
14854 access that might be speculatively executed and that might have side
14855 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14856 controls GCC's implementation of this workaround.  It assumes that
14857 aborted accesses to any byte in the following regions will not have
14858 side effects:
14860 @enumerate
14861 @item
14862 the memory occupied by the current function's stack frame;
14864 @item
14865 the memory occupied by an incoming stack argument;
14867 @item
14868 the memory occupied by an object with a link-time-constant address.
14869 @end enumerate
14871 It is the kernel's responsibility to ensure that speculative
14872 accesses to these regions are indeed safe.
14874 If the input program contains a function declaration such as:
14876 @smallexample
14877 void foo (void);
14878 @end smallexample
14880 then the implementation of @code{foo} must allow @code{j foo} and
14881 @code{jal foo} to be executed speculatively.  GCC honors this
14882 restriction for functions it compiles itself.  It expects non-GCC
14883 functions (such as hand-written assembly code) to do the same.
14885 The option has three forms:
14887 @table @gcctabopt
14888 @item -mr10k-cache-barrier=load-store
14889 Insert a cache barrier before a load or store that might be
14890 speculatively executed and that might have side effects even
14891 if aborted.
14893 @item -mr10k-cache-barrier=store
14894 Insert a cache barrier before a store that might be speculatively
14895 executed and that might have side effects even if aborted.
14897 @item -mr10k-cache-barrier=none
14898 Disable the insertion of cache barriers.  This is the default setting.
14899 @end table
14901 @item -mflush-func=@var{func}
14902 @itemx -mno-flush-func
14903 @opindex mflush-func
14904 Specifies the function to call to flush the I and D caches, or to not
14905 call any such function.  If called, the function must take the same
14906 arguments as the common @code{_flush_func()}, that is, the address of the
14907 memory range for which the cache is being flushed, the size of the
14908 memory range, and the number 3 (to flush both caches).  The default
14909 depends on the target GCC was configured for, but commonly is either
14910 @samp{_flush_func} or @samp{__cpu_flush}.
14912 @item mbranch-cost=@var{num}
14913 @opindex mbranch-cost
14914 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14915 This cost is only a heuristic and is not guaranteed to produce
14916 consistent results across releases.  A zero cost redundantly selects
14917 the default, which is based on the @option{-mtune} setting.
14919 @item -mbranch-likely
14920 @itemx -mno-branch-likely
14921 @opindex mbranch-likely
14922 @opindex mno-branch-likely
14923 Enable or disable use of Branch Likely instructions, regardless of the
14924 default for the selected architecture.  By default, Branch Likely
14925 instructions may be generated if they are supported by the selected
14926 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14927 and processors which implement those architectures; for those, Branch
14928 Likely instructions will not be generated by default because the MIPS32
14929 and MIPS64 architectures specifically deprecate their use.
14931 @item -mfp-exceptions
14932 @itemx -mno-fp-exceptions
14933 @opindex mfp-exceptions
14934 Specifies whether FP exceptions are enabled.  This affects how we schedule
14935 FP instructions for some processors.  The default is that FP exceptions are
14936 enabled.
14938 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14939 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14940 FP pipe.
14942 @item -mvr4130-align
14943 @itemx -mno-vr4130-align
14944 @opindex mvr4130-align
14945 The VR4130 pipeline is two-way superscalar, but can only issue two
14946 instructions together if the first one is 8-byte aligned.  When this
14947 option is enabled, GCC will align pairs of instructions that it
14948 thinks should execute in parallel.
14950 This option only has an effect when optimizing for the VR4130.
14951 It normally makes code faster, but at the expense of making it bigger.
14952 It is enabled by default at optimization level @option{-O3}.
14954 @item -msynci
14955 @itemx -mno-synci
14956 @opindex msynci
14957 Enable (disable) generation of @code{synci} instructions on
14958 architectures that support it.  The @code{synci} instructions (if
14959 enabled) will be generated when @code{__builtin___clear_cache()} is
14960 compiled.
14962 This option defaults to @code{-mno-synci}, but the default can be
14963 overridden by configuring with @code{--with-synci}.
14965 When compiling code for single processor systems, it is generally safe
14966 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14967 will not invalidate the instruction caches on all cores and may lead
14968 to undefined behavior.
14970 @item -mrelax-pic-calls
14971 @itemx -mno-relax-pic-calls
14972 @opindex mrelax-pic-calls
14973 Try to turn PIC calls that are normally dispatched via register
14974 @code{$25} into direct calls.  This is only possible if the linker can
14975 resolve the destination at link-time and if the destination is within
14976 range for a direct call.
14978 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14979 an assembler and a linker that supports the @code{.reloc} assembly
14980 directive and @code{-mexplicit-relocs} is in effect.  With
14981 @code{-mno-explicit-relocs}, this optimization can be performed by the
14982 assembler and the linker alone without help from the compiler.
14984 @item -mmcount-ra-address
14985 @itemx -mno-mcount-ra-address
14986 @opindex mmcount-ra-address
14987 @opindex mno-mcount-ra-address
14988 Emit (do not emit) code that allows @code{_mcount} to modify the
14989 calling function's return address.  When enabled, this option extends
14990 the usual @code{_mcount} interface with a new @var{ra-address}
14991 parameter, which has type @code{intptr_t *} and is passed in register
14992 @code{$12}.  @code{_mcount} can then modify the return address by
14993 doing both of the following:
14994 @itemize
14995 @item
14996 Returning the new address in register @code{$31}.
14997 @item
14998 Storing the new address in @code{*@var{ra-address}},
14999 if @var{ra-address} is nonnull.
15000 @end itemize
15002 The default is @option{-mno-mcount-ra-address}.
15004 @end table
15006 @node MMIX Options
15007 @subsection MMIX Options
15008 @cindex MMIX Options
15010 These options are defined for the MMIX:
15012 @table @gcctabopt
15013 @item -mlibfuncs
15014 @itemx -mno-libfuncs
15015 @opindex mlibfuncs
15016 @opindex mno-libfuncs
15017 Specify that intrinsic library functions are being compiled, passing all
15018 values in registers, no matter the size.
15020 @item -mepsilon
15021 @itemx -mno-epsilon
15022 @opindex mepsilon
15023 @opindex mno-epsilon
15024 Generate floating-point comparison instructions that compare with respect
15025 to the @code{rE} epsilon register.
15027 @item -mabi=mmixware
15028 @itemx -mabi=gnu
15029 @opindex mabi=mmixware
15030 @opindex mabi=gnu
15031 Generate code that passes function parameters and return values that (in
15032 the called function) are seen as registers @code{$0} and up, as opposed to
15033 the GNU ABI which uses global registers @code{$231} and up.
15035 @item -mzero-extend
15036 @itemx -mno-zero-extend
15037 @opindex mzero-extend
15038 @opindex mno-zero-extend
15039 When reading data from memory in sizes shorter than 64 bits, use (do not
15040 use) zero-extending load instructions by default, rather than
15041 sign-extending ones.
15043 @item -mknuthdiv
15044 @itemx -mno-knuthdiv
15045 @opindex mknuthdiv
15046 @opindex mno-knuthdiv
15047 Make the result of a division yielding a remainder have the same sign as
15048 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
15049 remainder follows the sign of the dividend.  Both methods are
15050 arithmetically valid, the latter being almost exclusively used.
15052 @item -mtoplevel-symbols
15053 @itemx -mno-toplevel-symbols
15054 @opindex mtoplevel-symbols
15055 @opindex mno-toplevel-symbols
15056 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
15057 code can be used with the @code{PREFIX} assembly directive.
15059 @item -melf
15060 @opindex melf
15061 Generate an executable in the ELF format, rather than the default
15062 @samp{mmo} format used by the @command{mmix} simulator.
15064 @item -mbranch-predict
15065 @itemx -mno-branch-predict
15066 @opindex mbranch-predict
15067 @opindex mno-branch-predict
15068 Use (do not use) the probable-branch instructions, when static branch
15069 prediction indicates a probable branch.
15071 @item -mbase-addresses
15072 @itemx -mno-base-addresses
15073 @opindex mbase-addresses
15074 @opindex mno-base-addresses
15075 Generate (do not generate) code that uses @emph{base addresses}.  Using a
15076 base address automatically generates a request (handled by the assembler
15077 and the linker) for a constant to be set up in a global register.  The
15078 register is used for one or more base address requests within the range 0
15079 to 255 from the value held in the register.  The generally leads to short
15080 and fast code, but the number of different data items that can be
15081 addressed is limited.  This means that a program that uses lots of static
15082 data may require @option{-mno-base-addresses}.
15084 @item -msingle-exit
15085 @itemx -mno-single-exit
15086 @opindex msingle-exit
15087 @opindex mno-single-exit
15088 Force (do not force) generated code to have a single exit point in each
15089 function.
15090 @end table
15092 @node MN10300 Options
15093 @subsection MN10300 Options
15094 @cindex MN10300 options
15096 These @option{-m} options are defined for Matsushita MN10300 architectures:
15098 @table @gcctabopt
15099 @item -mmult-bug
15100 @opindex mmult-bug
15101 Generate code to avoid bugs in the multiply instructions for the MN10300
15102 processors.  This is the default.
15104 @item -mno-mult-bug
15105 @opindex mno-mult-bug
15106 Do not generate code to avoid bugs in the multiply instructions for the
15107 MN10300 processors.
15109 @item -mam33
15110 @opindex mam33
15111 Generate code which uses features specific to the AM33 processor.
15113 @item -mno-am33
15114 @opindex mno-am33
15115 Do not generate code which uses features specific to the AM33 processor.  This
15116 is the default.
15118 @item -mam33-2
15119 @opindex mam33-2
15120 Generate code which uses features specific to the AM33/2.0 processor.
15122 @item -mam34
15123 @opindex mam34
15124 Generate code which uses features specific to the AM34 processor.
15126 @item -mtune=@var{cpu-type}
15127 @opindex mtune
15128 Use the timing characteristics of the indicated CPU type when
15129 scheduling instructions.  This does not change the targeted processor
15130 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
15131 @samp{am33-2} or @samp{am34}.
15133 @item -mreturn-pointer-on-d0
15134 @opindex mreturn-pointer-on-d0
15135 When generating a function which returns a pointer, return the pointer
15136 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
15137 only in a0, and attempts to call such functions without a prototype
15138 would result in errors.  Note that this option is on by default; use
15139 @option{-mno-return-pointer-on-d0} to disable it.
15141 @item -mno-crt0
15142 @opindex mno-crt0
15143 Do not link in the C run-time initialization object file.
15145 @item -mrelax
15146 @opindex mrelax
15147 Indicate to the linker that it should perform a relaxation optimization pass
15148 to shorten branches, calls and absolute memory addresses.  This option only
15149 has an effect when used on the command line for the final link step.
15151 This option makes symbolic debugging impossible.
15153 @item -mliw
15154 @opindex mliw
15155 Allow the compiler to generate @emph{Long Instruction Word}
15156 instructions if the target is the @samp{AM33} or later.  This is the
15157 default.  This option defines the preprocessor macro @samp{__LIW__}.
15159 @item -mnoliw
15160 @opindex mnoliw
15161 Do not allow the compiler to generate @emph{Long Instruction Word}
15162 instructions.  This option defines the preprocessor macro
15163 @samp{__NO_LIW__}.
15165 @item -msetlb
15166 @opindex msetlb
15167 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
15168 instructions if the target is the @samp{AM33} or later.  This is the
15169 default.  This option defines the preprocessor macro @samp{__SETLB__}.
15171 @item -mnosetlb
15172 @opindex mnosetlb
15173 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
15174 instructions.  This option defines the preprocessor macro
15175 @samp{__NO_SETLB__}.
15177 @end table
15179 @node PDP-11 Options
15180 @subsection PDP-11 Options
15181 @cindex PDP-11 Options
15183 These options are defined for the PDP-11:
15185 @table @gcctabopt
15186 @item -mfpu
15187 @opindex mfpu
15188 Use hardware FPP floating point.  This is the default.  (FIS floating
15189 point on the PDP-11/40 is not supported.)
15191 @item -msoft-float
15192 @opindex msoft-float
15193 Do not use hardware floating point.
15195 @item -mac0
15196 @opindex mac0
15197 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
15199 @item -mno-ac0
15200 @opindex mno-ac0
15201 Return floating-point results in memory.  This is the default.
15203 @item -m40
15204 @opindex m40
15205 Generate code for a PDP-11/40.
15207 @item -m45
15208 @opindex m45
15209 Generate code for a PDP-11/45.  This is the default.
15211 @item -m10
15212 @opindex m10
15213 Generate code for a PDP-11/10.
15215 @item -mbcopy-builtin
15216 @opindex mbcopy-builtin
15217 Use inline @code{movmemhi} patterns for copying memory.  This is the
15218 default.
15220 @item -mbcopy
15221 @opindex mbcopy
15222 Do not use inline @code{movmemhi} patterns for copying memory.
15224 @item -mint16
15225 @itemx -mno-int32
15226 @opindex mint16
15227 @opindex mno-int32
15228 Use 16-bit @code{int}.  This is the default.
15230 @item -mint32
15231 @itemx -mno-int16
15232 @opindex mint32
15233 @opindex mno-int16
15234 Use 32-bit @code{int}.
15236 @item -mfloat64
15237 @itemx -mno-float32
15238 @opindex mfloat64
15239 @opindex mno-float32
15240 Use 64-bit @code{float}.  This is the default.
15242 @item -mfloat32
15243 @itemx -mno-float64
15244 @opindex mfloat32
15245 @opindex mno-float64
15246 Use 32-bit @code{float}.
15248 @item -mabshi
15249 @opindex mabshi
15250 Use @code{abshi2} pattern.  This is the default.
15252 @item -mno-abshi
15253 @opindex mno-abshi
15254 Do not use @code{abshi2} pattern.
15256 @item -mbranch-expensive
15257 @opindex mbranch-expensive
15258 Pretend that branches are expensive.  This is for experimenting with
15259 code generation only.
15261 @item -mbranch-cheap
15262 @opindex mbranch-cheap
15263 Do not pretend that branches are expensive.  This is the default.
15265 @item -munix-asm
15266 @opindex munix-asm
15267 Use Unix assembler syntax.  This is the default when configured for
15268 @samp{pdp11-*-bsd}.
15270 @item -mdec-asm
15271 @opindex mdec-asm
15272 Use DEC assembler syntax.  This is the default when configured for any
15273 PDP-11 target other than @samp{pdp11-*-bsd}.
15274 @end table
15276 @node picoChip Options
15277 @subsection picoChip Options
15278 @cindex picoChip options
15280 These @samp{-m} options are defined for picoChip implementations:
15282 @table @gcctabopt
15284 @item -mae=@var{ae_type}
15285 @opindex mcpu
15286 Set the instruction set, register set, and instruction scheduling
15287 parameters for array element type @var{ae_type}.  Supported values
15288 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
15290 @option{-mae=ANY} selects a completely generic AE type.  Code
15291 generated with this option will run on any of the other AE types.  The
15292 code will not be as efficient as it would be if compiled for a specific
15293 AE type, and some types of operation (e.g., multiplication) will not
15294 work properly on all types of AE.
15296 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
15297 for compiled code, and is the default.
15299 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
15300 option may suffer from poor performance of byte (char) manipulation,
15301 since the DSP AE does not provide hardware support for byte load/stores.
15303 @item -msymbol-as-address
15304 Enable the compiler to directly use a symbol name as an address in a
15305 load/store instruction, without first loading it into a
15306 register.  Typically, the use of this option will generate larger
15307 programs, which run faster than when the option isn't used.  However, the
15308 results vary from program to program, so it is left as a user option,
15309 rather than being permanently enabled.
15311 @item -mno-inefficient-warnings
15312 Disables warnings about the generation of inefficient code.  These
15313 warnings can be generated, for example, when compiling code which
15314 performs byte-level memory operations on the MAC AE type.  The MAC AE has
15315 no hardware support for byte-level memory operations, so all byte
15316 load/stores must be synthesized from word load/store operations.  This is
15317 inefficient and a warning will be generated indicating to the programmer
15318 that they should rewrite the code to avoid byte operations, or to target
15319 an AE type which has the necessary hardware support.  This option enables
15320 the warning to be turned off.
15322 @end table
15324 @node PowerPC Options
15325 @subsection PowerPC Options
15326 @cindex PowerPC options
15328 These are listed under @xref{RS/6000 and PowerPC Options}.
15330 @node RS/6000 and PowerPC Options
15331 @subsection IBM RS/6000 and PowerPC Options
15332 @cindex RS/6000 and PowerPC Options
15333 @cindex IBM RS/6000 and PowerPC Options
15335 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
15336 @table @gcctabopt
15337 @item -mpower
15338 @itemx -mno-power
15339 @itemx -mpower2
15340 @itemx -mno-power2
15341 @itemx -mpowerpc
15342 @itemx -mno-powerpc
15343 @itemx -mpowerpc-gpopt
15344 @itemx -mno-powerpc-gpopt
15345 @itemx -mpowerpc-gfxopt
15346 @itemx -mno-powerpc-gfxopt
15347 @need 800
15348 @itemx -mpowerpc64
15349 @itemx -mno-powerpc64
15350 @itemx -mmfcrf
15351 @itemx -mno-mfcrf
15352 @itemx -mpopcntb
15353 @itemx -mno-popcntb
15354 @itemx -mpopcntd
15355 @itemx -mno-popcntd
15356 @itemx -mfprnd
15357 @itemx -mno-fprnd
15358 @need 800
15359 @itemx -mcmpb
15360 @itemx -mno-cmpb
15361 @itemx -mmfpgpr
15362 @itemx -mno-mfpgpr
15363 @itemx -mhard-dfp
15364 @itemx -mno-hard-dfp
15365 @opindex mpower
15366 @opindex mno-power
15367 @opindex mpower2
15368 @opindex mno-power2
15369 @opindex mpowerpc
15370 @opindex mno-powerpc
15371 @opindex mpowerpc-gpopt
15372 @opindex mno-powerpc-gpopt
15373 @opindex mpowerpc-gfxopt
15374 @opindex mno-powerpc-gfxopt
15375 @opindex mpowerpc64
15376 @opindex mno-powerpc64
15377 @opindex mmfcrf
15378 @opindex mno-mfcrf
15379 @opindex mpopcntb
15380 @opindex mno-popcntb
15381 @opindex mpopcntd
15382 @opindex mno-popcntd
15383 @opindex mfprnd
15384 @opindex mno-fprnd
15385 @opindex mcmpb
15386 @opindex mno-cmpb
15387 @opindex mmfpgpr
15388 @opindex mno-mfpgpr
15389 @opindex mhard-dfp
15390 @opindex mno-hard-dfp
15391 GCC supports two related instruction set architectures for the
15392 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
15393 instructions supported by the @samp{rios} chip set used in the original
15394 RS/6000 systems and the @dfn{PowerPC} instruction set is the
15395 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
15396 the IBM 4xx, 6xx, and follow-on microprocessors.
15398 Neither architecture is a subset of the other.  However there is a
15399 large common subset of instructions supported by both.  An MQ
15400 register is included in processors supporting the POWER architecture.
15402 You use these options to specify which instructions are available on the
15403 processor you are using.  The default value of these options is
15404 determined when configuring GCC@.  Specifying the
15405 @option{-mcpu=@var{cpu_type}} overrides the specification of these
15406 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
15407 rather than the options listed above.
15409 The @option{-mpower} option allows GCC to generate instructions that
15410 are found only in the POWER architecture and to use the MQ register.
15411 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
15412 to generate instructions that are present in the POWER2 architecture but
15413 not the original POWER architecture.
15415 The @option{-mpowerpc} option allows GCC to generate instructions that
15416 are found only in the 32-bit subset of the PowerPC architecture.
15417 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
15418 GCC to use the optional PowerPC architecture instructions in the
15419 General Purpose group, including floating-point square root.  Specifying
15420 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
15421 use the optional PowerPC architecture instructions in the Graphics
15422 group, including floating-point select.
15424 The @option{-mmfcrf} option allows GCC to generate the move from
15425 condition register field instruction implemented on the POWER4
15426 processor and other processors that support the PowerPC V2.01
15427 architecture.
15428 The @option{-mpopcntb} option allows GCC to generate the popcount and
15429 double precision FP reciprocal estimate instruction implemented on the
15430 POWER5 processor and other processors that support the PowerPC V2.02
15431 architecture.
15432 The @option{-mpopcntd} option allows GCC to generate the popcount
15433 instruction implemented on the POWER7 processor and other processors
15434 that support the PowerPC V2.06 architecture.
15435 The @option{-mfprnd} option allows GCC to generate the FP round to
15436 integer instructions implemented on the POWER5+ processor and other
15437 processors that support the PowerPC V2.03 architecture.
15438 The @option{-mcmpb} option allows GCC to generate the compare bytes
15439 instruction implemented on the POWER6 processor and other processors
15440 that support the PowerPC V2.05 architecture.
15441 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
15442 general purpose register instructions implemented on the POWER6X
15443 processor and other processors that support the extended PowerPC V2.05
15444 architecture.
15445 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
15446 point instructions implemented on some POWER processors.
15448 The @option{-mpowerpc64} option allows GCC to generate the additional
15449 64-bit instructions that are found in the full PowerPC64 architecture
15450 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
15451 @option{-mno-powerpc64}.
15453 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
15454 will use only the instructions in the common subset of both
15455 architectures plus some special AIX common-mode calls, and will not use
15456 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
15457 permits GCC to use any instruction from either architecture and to
15458 allow use of the MQ register; specify this for the Motorola MPC601.
15460 @item -mnew-mnemonics
15461 @itemx -mold-mnemonics
15462 @opindex mnew-mnemonics
15463 @opindex mold-mnemonics
15464 Select which mnemonics to use in the generated assembler code.  With
15465 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
15466 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
15467 assembler mnemonics defined for the POWER architecture.  Instructions
15468 defined in only one architecture have only one mnemonic; GCC uses that
15469 mnemonic irrespective of which of these options is specified.
15471 GCC defaults to the mnemonics appropriate for the architecture in
15472 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
15473 value of these option.  Unless you are building a cross-compiler, you
15474 should normally not specify either @option{-mnew-mnemonics} or
15475 @option{-mold-mnemonics}, but should instead accept the default.
15477 @item -mcpu=@var{cpu_type}
15478 @opindex mcpu
15479 Set architecture type, register usage, choice of mnemonics, and
15480 instruction scheduling parameters for machine type @var{cpu_type}.
15481 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
15482 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
15483 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
15484 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
15485 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
15486 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
15487 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
15488 @samp{G4}, @samp{G5}, @samp{titan}, @samp{power}, @samp{power2}, @samp{power3},
15489 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
15490 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
15491 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
15493 @option{-mcpu=common} selects a completely generic processor.  Code
15494 generated under this option will run on any POWER or PowerPC processor.
15495 GCC will use only the instructions in the common subset of both
15496 architectures, and will not use the MQ register.  GCC assumes a generic
15497 processor model for scheduling purposes.
15499 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
15500 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
15501 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
15502 types, with an appropriate, generic processor model assumed for
15503 scheduling purposes.
15505 The other options specify a specific processor.  Code generated under
15506 those options will run best on that processor, and may not run at all on
15507 others.
15509 The @option{-mcpu} options automatically enable or disable the
15510 following options:
15512 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
15513 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
15514 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
15515 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
15517 The particular options set for any particular CPU will vary between
15518 compiler versions, depending on what setting seems to produce optimal
15519 code for that CPU; it doesn't necessarily reflect the actual hardware's
15520 capabilities.  If you wish to set an individual option to a particular
15521 value, you may specify it after the @option{-mcpu} option, like
15522 @samp{-mcpu=970 -mno-altivec}.
15524 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
15525 not enabled or disabled by the @option{-mcpu} option at present because
15526 AIX does not have full support for these options.  You may still
15527 enable or disable them individually if you're sure it'll work in your
15528 environment.
15530 @item -mtune=@var{cpu_type}
15531 @opindex mtune
15532 Set the instruction scheduling parameters for machine type
15533 @var{cpu_type}, but do not set the architecture type, register usage, or
15534 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
15535 values for @var{cpu_type} are used for @option{-mtune} as for
15536 @option{-mcpu}.  If both are specified, the code generated will use the
15537 architecture, registers, and mnemonics set by @option{-mcpu}, but the
15538 scheduling parameters set by @option{-mtune}.
15540 @item -mcmodel=small
15541 @opindex mcmodel=small
15542 Generate PowerPC64 code for the small model: The TOC is limited to
15543 64k.
15545 @item -mcmodel=medium
15546 @opindex mcmodel=medium
15547 Generate PowerPC64 code for the medium model: The TOC and other static
15548 data may be up to a total of 4G in size.
15550 @item -mcmodel=large
15551 @opindex mcmodel=large
15552 Generate PowerPC64 code for the large model: The TOC may be up to 4G
15553 in size.  Other data and code is only limited by the 64-bit address
15554 space.
15556 @item -maltivec
15557 @itemx -mno-altivec
15558 @opindex maltivec
15559 @opindex mno-altivec
15560 Generate code that uses (does not use) AltiVec instructions, and also
15561 enable the use of built-in functions that allow more direct access to
15562 the AltiVec instruction set.  You may also need to set
15563 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
15564 enhancements.
15566 @item -mvrsave
15567 @itemx -mno-vrsave
15568 @opindex mvrsave
15569 @opindex mno-vrsave
15570 Generate VRSAVE instructions when generating AltiVec code.
15572 @item -mgen-cell-microcode
15573 @opindex mgen-cell-microcode
15574 Generate Cell microcode instructions
15576 @item -mwarn-cell-microcode
15577 @opindex mwarn-cell-microcode
15578 Warning when a Cell microcode instruction is going to emitted.  An example
15579 of a Cell microcode instruction is a variable shift.
15581 @item -msecure-plt
15582 @opindex msecure-plt
15583 Generate code that allows ld and ld.so to build executables and shared
15584 libraries with non-exec .plt and .got sections.  This is a PowerPC
15585 32-bit SYSV ABI option.
15587 @item -mbss-plt
15588 @opindex mbss-plt
15589 Generate code that uses a BSS .plt section that ld.so fills in, and
15590 requires .plt and .got sections that are both writable and executable.
15591 This is a PowerPC 32-bit SYSV ABI option.
15593 @item -misel
15594 @itemx -mno-isel
15595 @opindex misel
15596 @opindex mno-isel
15597 This switch enables or disables the generation of ISEL instructions.
15599 @item -misel=@var{yes/no}
15600 This switch has been deprecated.  Use @option{-misel} and
15601 @option{-mno-isel} instead.
15603 @item -mspe
15604 @itemx -mno-spe
15605 @opindex mspe
15606 @opindex mno-spe
15607 This switch enables or disables the generation of SPE simd
15608 instructions.
15610 @item -mpaired
15611 @itemx -mno-paired
15612 @opindex mpaired
15613 @opindex mno-paired
15614 This switch enables or disables the generation of PAIRED simd
15615 instructions.
15617 @item -mspe=@var{yes/no}
15618 This option has been deprecated.  Use @option{-mspe} and
15619 @option{-mno-spe} instead.
15621 @item -mvsx
15622 @itemx -mno-vsx
15623 @opindex mvsx
15624 @opindex mno-vsx
15625 Generate code that uses (does not use) vector/scalar (VSX)
15626 instructions, and also enable the use of built-in functions that allow
15627 more direct access to the VSX instruction set.
15629 @item -mfloat-gprs=@var{yes/single/double/no}
15630 @itemx -mfloat-gprs
15631 @opindex mfloat-gprs
15632 This switch enables or disables the generation of floating point
15633 operations on the general purpose registers for architectures that
15634 support it.
15636 The argument @var{yes} or @var{single} enables the use of
15637 single-precision floating point operations.
15639 The argument @var{double} enables the use of single and
15640 double-precision floating point operations.
15642 The argument @var{no} disables floating point operations on the
15643 general purpose registers.
15645 This option is currently only available on the MPC854x.
15647 @item -m32
15648 @itemx -m64
15649 @opindex m32
15650 @opindex m64
15651 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
15652 targets (including GNU/Linux).  The 32-bit environment sets int, long
15653 and pointer to 32 bits and generates code that runs on any PowerPC
15654 variant.  The 64-bit environment sets int to 32 bits and long and
15655 pointer to 64 bits, and generates code for PowerPC64, as for
15656 @option{-mpowerpc64}.
15658 @item -mfull-toc
15659 @itemx -mno-fp-in-toc
15660 @itemx -mno-sum-in-toc
15661 @itemx -mminimal-toc
15662 @opindex mfull-toc
15663 @opindex mno-fp-in-toc
15664 @opindex mno-sum-in-toc
15665 @opindex mminimal-toc
15666 Modify generation of the TOC (Table Of Contents), which is created for
15667 every executable file.  The @option{-mfull-toc} option is selected by
15668 default.  In that case, GCC will allocate at least one TOC entry for
15669 each unique non-automatic variable reference in your program.  GCC
15670 will also place floating-point constants in the TOC@.  However, only
15671 16,384 entries are available in the TOC@.
15673 If you receive a linker error message that saying you have overflowed
15674 the available TOC space, you can reduce the amount of TOC space used
15675 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
15676 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
15677 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
15678 generate code to calculate the sum of an address and a constant at
15679 run-time instead of putting that sum into the TOC@.  You may specify one
15680 or both of these options.  Each causes GCC to produce very slightly
15681 slower and larger code at the expense of conserving TOC space.
15683 If you still run out of space in the TOC even when you specify both of
15684 these options, specify @option{-mminimal-toc} instead.  This option causes
15685 GCC to make only one TOC entry for every file.  When you specify this
15686 option, GCC will produce code that is slower and larger but which
15687 uses extremely little TOC space.  You may wish to use this option
15688 only on files that contain less frequently executed code.
15690 @item -maix64
15691 @itemx -maix32
15692 @opindex maix64
15693 @opindex maix32
15694 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
15695 @code{long} type, and the infrastructure needed to support them.
15696 Specifying @option{-maix64} implies @option{-mpowerpc64} and
15697 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
15698 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
15700 @item -mxl-compat
15701 @itemx -mno-xl-compat
15702 @opindex mxl-compat
15703 @opindex mno-xl-compat
15704 Produce code that conforms more closely to IBM XL compiler semantics
15705 when using AIX-compatible ABI@.  Pass floating-point arguments to
15706 prototyped functions beyond the register save area (RSA) on the stack
15707 in addition to argument FPRs.  Do not assume that most significant
15708 double in 128-bit long double value is properly rounded when comparing
15709 values and converting to double.  Use XL symbol names for long double
15710 support routines.
15712 The AIX calling convention was extended but not initially documented to
15713 handle an obscure K&R C case of calling a function that takes the
15714 address of its arguments with fewer arguments than declared.  IBM XL
15715 compilers access floating point arguments which do not fit in the
15716 RSA from the stack when a subroutine is compiled without
15717 optimization.  Because always storing floating-point arguments on the
15718 stack is inefficient and rarely needed, this option is not enabled by
15719 default and only is necessary when calling subroutines compiled by IBM
15720 XL compilers without optimization.
15722 @item -mpe
15723 @opindex mpe
15724 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
15725 application written to use message passing with special startup code to
15726 enable the application to run.  The system must have PE installed in the
15727 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
15728 must be overridden with the @option{-specs=} option to specify the
15729 appropriate directory location.  The Parallel Environment does not
15730 support threads, so the @option{-mpe} option and the @option{-pthread}
15731 option are incompatible.
15733 @item -malign-natural
15734 @itemx -malign-power
15735 @opindex malign-natural
15736 @opindex malign-power
15737 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15738 @option{-malign-natural} overrides the ABI-defined alignment of larger
15739 types, such as floating-point doubles, on their natural size-based boundary.
15740 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15741 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
15743 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15744 is not supported.
15746 @item -msoft-float
15747 @itemx -mhard-float
15748 @opindex msoft-float
15749 @opindex mhard-float
15750 Generate code that does not use (uses) the floating-point register set.
15751 Software floating point emulation is provided if you use the
15752 @option{-msoft-float} option, and pass the option to GCC when linking.
15754 @item -msingle-float
15755 @itemx -mdouble-float
15756 @opindex msingle-float
15757 @opindex mdouble-float
15758 Generate code for single or double-precision floating point operations.
15759 @option{-mdouble-float} implies @option{-msingle-float}.
15761 @item -msimple-fpu
15762 @opindex msimple-fpu
15763 Do not generate sqrt and div instructions for hardware floating point unit.
15765 @item -mfpu
15766 @opindex mfpu
15767 Specify type of floating point unit.  Valid values are @var{sp_lite}
15768 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15769 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15770 and @var{dp_full} (equivalent to -mdouble-float).
15772 @item -mxilinx-fpu
15773 @opindex mxilinx-fpu
15774 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15776 @item -mmultiple
15777 @itemx -mno-multiple
15778 @opindex mmultiple
15779 @opindex mno-multiple
15780 Generate code that uses (does not use) the load multiple word
15781 instructions and the store multiple word instructions.  These
15782 instructions are generated by default on POWER systems, and not
15783 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
15784 endian PowerPC systems, since those instructions do not work when the
15785 processor is in little endian mode.  The exceptions are PPC740 and
15786 PPC750 which permit the instructions usage in little endian mode.
15788 @item -mstring
15789 @itemx -mno-string
15790 @opindex mstring
15791 @opindex mno-string
15792 Generate code that uses (does not use) the load string instructions
15793 and the store string word instructions to save multiple registers and
15794 do small block moves.  These instructions are generated by default on
15795 POWER systems, and not generated on PowerPC systems.  Do not use
15796 @option{-mstring} on little endian PowerPC systems, since those
15797 instructions do not work when the processor is in little endian mode.
15798 The exceptions are PPC740 and PPC750 which permit the instructions
15799 usage in little endian mode.
15801 @item -mupdate
15802 @itemx -mno-update
15803 @opindex mupdate
15804 @opindex mno-update
15805 Generate code that uses (does not use) the load or store instructions
15806 that update the base register to the address of the calculated memory
15807 location.  These instructions are generated by default.  If you use
15808 @option{-mno-update}, there is a small window between the time that the
15809 stack pointer is updated and the address of the previous frame is
15810 stored, which means code that walks the stack frame across interrupts or
15811 signals may get corrupted data.
15813 @item -mavoid-indexed-addresses
15814 @itemx -mno-avoid-indexed-addresses
15815 @opindex mavoid-indexed-addresses
15816 @opindex mno-avoid-indexed-addresses
15817 Generate code that tries to avoid (not avoid) the use of indexed load
15818 or store instructions. These instructions can incur a performance
15819 penalty on Power6 processors in certain situations, such as when
15820 stepping through large arrays that cross a 16M boundary.  This option
15821 is enabled by default when targetting Power6 and disabled otherwise.
15823 @item -mfused-madd
15824 @itemx -mno-fused-madd
15825 @opindex mfused-madd
15826 @opindex mno-fused-madd
15827 Generate code that uses (does not use) the floating point multiply and
15828 accumulate instructions.  These instructions are generated by default
15829 if hardware floating point is used.  The machine dependent
15830 @option{-mfused-madd} option is now mapped to the machine independent
15831 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
15832 mapped to @option{-ffp-contract=off}.
15834 @item -mmulhw
15835 @itemx -mno-mulhw
15836 @opindex mmulhw
15837 @opindex mno-mulhw
15838 Generate code that uses (does not use) the half-word multiply and
15839 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15840 These instructions are generated by default when targetting those
15841 processors.
15843 @item -mdlmzb
15844 @itemx -mno-dlmzb
15845 @opindex mdlmzb
15846 @opindex mno-dlmzb
15847 Generate code that uses (does not use) the string-search @samp{dlmzb}
15848 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15849 generated by default when targetting those processors.
15851 @item -mno-bit-align
15852 @itemx -mbit-align
15853 @opindex mno-bit-align
15854 @opindex mbit-align
15855 On System V.4 and embedded PowerPC systems do not (do) force structures
15856 and unions that contain bit-fields to be aligned to the base type of the
15857 bit-field.
15859 For example, by default a structure containing nothing but 8
15860 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15861 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15862 the structure would be aligned to a 1 byte boundary and be one byte in
15863 size.
15865 @item -mno-strict-align
15866 @itemx -mstrict-align
15867 @opindex mno-strict-align
15868 @opindex mstrict-align
15869 On System V.4 and embedded PowerPC systems do not (do) assume that
15870 unaligned memory references will be handled by the system.
15872 @item -mrelocatable
15873 @itemx -mno-relocatable
15874 @opindex mrelocatable
15875 @opindex mno-relocatable
15876 Generate code that allows (does not allow) a static executable to be
15877 relocated to a different address at runtime.  A simple embedded
15878 PowerPC system loader should relocate the entire contents of
15879 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
15880 a table of 32-bit addresses generated by this option.  For this to
15881 work, all objects linked together must be compiled with
15882 @option{-mrelocatable} or @option{-mrelocatable-lib}.
15883 @option{-mrelocatable} code aligns the stack to an 8 byte boundary.
15885 @item -mrelocatable-lib
15886 @itemx -mno-relocatable-lib
15887 @opindex mrelocatable-lib
15888 @opindex mno-relocatable-lib
15889 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
15890 @code{.fixup} section to allow static executables to be relocated at
15891 runtime, but @option{-mrelocatable-lib} does not use the smaller stack
15892 alignment of @option{-mrelocatable}.  Objects compiled with
15893 @option{-mrelocatable-lib} may be linked with objects compiled with
15894 any combination of the @option{-mrelocatable} options.
15896 @item -mno-toc
15897 @itemx -mtoc
15898 @opindex mno-toc
15899 @opindex mtoc
15900 On System V.4 and embedded PowerPC systems do not (do) assume that
15901 register 2 contains a pointer to a global area pointing to the addresses
15902 used in the program.
15904 @item -mlittle
15905 @itemx -mlittle-endian
15906 @opindex mlittle
15907 @opindex mlittle-endian
15908 On System V.4 and embedded PowerPC systems compile code for the
15909 processor in little endian mode.  The @option{-mlittle-endian} option is
15910 the same as @option{-mlittle}.
15912 @item -mbig
15913 @itemx -mbig-endian
15914 @opindex mbig
15915 @opindex mbig-endian
15916 On System V.4 and embedded PowerPC systems compile code for the
15917 processor in big endian mode.  The @option{-mbig-endian} option is
15918 the same as @option{-mbig}.
15920 @item -mdynamic-no-pic
15921 @opindex mdynamic-no-pic
15922 On Darwin and Mac OS X systems, compile code so that it is not
15923 relocatable, but that its external references are relocatable.  The
15924 resulting code is suitable for applications, but not shared
15925 libraries.
15927 @item -msingle-pic-base
15928 @opindex msingle-pic-base
15929 Treat the register used for PIC addressing as read-only, rather than
15930 loading it in the prologue for each function.  The run-time system is
15931 responsible for initializing this register with an appropriate value
15932 before execution begins.
15934 @item -mprioritize-restricted-insns=@var{priority}
15935 @opindex mprioritize-restricted-insns
15936 This option controls the priority that is assigned to
15937 dispatch-slot restricted instructions during the second scheduling
15938 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15939 @var{no/highest/second-highest} priority to dispatch slot restricted
15940 instructions.
15942 @item -msched-costly-dep=@var{dependence_type}
15943 @opindex msched-costly-dep
15944 This option controls which dependences are considered costly
15945 by the target during instruction scheduling.  The argument
15946 @var{dependence_type} takes one of the following values:
15947 @var{no}: no dependence is costly,
15948 @var{all}: all dependences are costly,
15949 @var{true_store_to_load}: a true dependence from store to load is costly,
15950 @var{store_to_load}: any dependence from store to load is costly,
15951 @var{number}: any dependence which latency >= @var{number} is costly.
15953 @item -minsert-sched-nops=@var{scheme}
15954 @opindex minsert-sched-nops
15955 This option controls which nop insertion scheme will be used during
15956 the second scheduling pass.  The argument @var{scheme} takes one of the
15957 following values:
15958 @var{no}: Don't insert nops.
15959 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15960 according to the scheduler's grouping.
15961 @var{regroup_exact}: Insert nops to force costly dependent insns into
15962 separate groups.  Insert exactly as many nops as needed to force an insn
15963 to a new group, according to the estimated processor grouping.
15964 @var{number}: Insert nops to force costly dependent insns into
15965 separate groups.  Insert @var{number} nops to force an insn to a new group.
15967 @item -mcall-sysv
15968 @opindex mcall-sysv
15969 On System V.4 and embedded PowerPC systems compile code using calling
15970 conventions that adheres to the March 1995 draft of the System V
15971 Application Binary Interface, PowerPC processor supplement.  This is the
15972 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15974 @item -mcall-sysv-eabi
15975 @itemx -mcall-eabi
15976 @opindex mcall-sysv-eabi
15977 @opindex mcall-eabi
15978 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15980 @item -mcall-sysv-noeabi
15981 @opindex mcall-sysv-noeabi
15982 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15984 @item -mcall-aixdesc
15985 @opindex m
15986 On System V.4 and embedded PowerPC systems compile code for the AIX
15987 operating system.
15989 @item -mcall-linux
15990 @opindex mcall-linux
15991 On System V.4 and embedded PowerPC systems compile code for the
15992 Linux-based GNU system.
15994 @item -mcall-freebsd
15995 @opindex mcall-freebsd
15996 On System V.4 and embedded PowerPC systems compile code for the
15997 FreeBSD operating system.
15999 @item -mcall-netbsd
16000 @opindex mcall-netbsd
16001 On System V.4 and embedded PowerPC systems compile code for the
16002 NetBSD operating system.
16004 @item -mcall-openbsd
16005 @opindex mcall-netbsd
16006 On System V.4 and embedded PowerPC systems compile code for the
16007 OpenBSD operating system.
16009 @item -maix-struct-return
16010 @opindex maix-struct-return
16011 Return all structures in memory (as specified by the AIX ABI)@.
16013 @item -msvr4-struct-return
16014 @opindex msvr4-struct-return
16015 Return structures smaller than 8 bytes in registers (as specified by the
16016 SVR4 ABI)@.
16018 @item -mabi=@var{abi-type}
16019 @opindex mabi
16020 Extend the current ABI with a particular extension, or remove such extension.
16021 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
16022 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
16024 @item -mabi=spe
16025 @opindex mabi=spe
16026 Extend the current ABI with SPE ABI extensions.  This does not change
16027 the default ABI, instead it adds the SPE ABI extensions to the current
16028 ABI@.
16030 @item -mabi=no-spe
16031 @opindex mabi=no-spe
16032 Disable Booke SPE ABI extensions for the current ABI@.
16034 @item -mabi=ibmlongdouble
16035 @opindex mabi=ibmlongdouble
16036 Change the current ABI to use IBM extended precision long double.
16037 This is a PowerPC 32-bit SYSV ABI option.
16039 @item -mabi=ieeelongdouble
16040 @opindex mabi=ieeelongdouble
16041 Change the current ABI to use IEEE extended precision long double.
16042 This is a PowerPC 32-bit Linux ABI option.
16044 @item -mprototype
16045 @itemx -mno-prototype
16046 @opindex mprototype
16047 @opindex mno-prototype
16048 On System V.4 and embedded PowerPC systems assume that all calls to
16049 variable argument functions are properly prototyped.  Otherwise, the
16050 compiler must insert an instruction before every non prototyped call to
16051 set or clear bit 6 of the condition code register (@var{CR}) to
16052 indicate whether floating point values were passed in the floating point
16053 registers in case the function takes a variable arguments.  With
16054 @option{-mprototype}, only calls to prototyped variable argument functions
16055 will set or clear the bit.
16057 @item -msim
16058 @opindex msim
16059 On embedded PowerPC systems, assume that the startup module is called
16060 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
16061 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
16062 configurations.
16064 @item -mmvme
16065 @opindex mmvme
16066 On embedded PowerPC systems, assume that the startup module is called
16067 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
16068 @file{libc.a}.
16070 @item -mads
16071 @opindex mads
16072 On embedded PowerPC systems, assume that the startup module is called
16073 @file{crt0.o} and the standard C libraries are @file{libads.a} and
16074 @file{libc.a}.
16076 @item -myellowknife
16077 @opindex myellowknife
16078 On embedded PowerPC systems, assume that the startup module is called
16079 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
16080 @file{libc.a}.
16082 @item -mvxworks
16083 @opindex mvxworks
16084 On System V.4 and embedded PowerPC systems, specify that you are
16085 compiling for a VxWorks system.
16087 @item -memb
16088 @opindex memb
16089 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
16090 header to indicate that @samp{eabi} extended relocations are used.
16092 @item -meabi
16093 @itemx -mno-eabi
16094 @opindex meabi
16095 @opindex mno-eabi
16096 On System V.4 and embedded PowerPC systems do (do not) adhere to the
16097 Embedded Applications Binary Interface (eabi) which is a set of
16098 modifications to the System V.4 specifications.  Selecting @option{-meabi}
16099 means that the stack is aligned to an 8 byte boundary, a function
16100 @code{__eabi} is called to from @code{main} to set up the eabi
16101 environment, and the @option{-msdata} option can use both @code{r2} and
16102 @code{r13} to point to two separate small data areas.  Selecting
16103 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
16104 do not call an initialization function from @code{main}, and the
16105 @option{-msdata} option will only use @code{r13} to point to a single
16106 small data area.  The @option{-meabi} option is on by default if you
16107 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
16109 @item -msdata=eabi
16110 @opindex msdata=eabi
16111 On System V.4 and embedded PowerPC systems, put small initialized
16112 @code{const} global and static data in the @samp{.sdata2} section, which
16113 is pointed to by register @code{r2}.  Put small initialized
16114 non-@code{const} global and static data in the @samp{.sdata} section,
16115 which is pointed to by register @code{r13}.  Put small uninitialized
16116 global and static data in the @samp{.sbss} section, which is adjacent to
16117 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
16118 incompatible with the @option{-mrelocatable} option.  The
16119 @option{-msdata=eabi} option also sets the @option{-memb} option.
16121 @item -msdata=sysv
16122 @opindex msdata=sysv
16123 On System V.4 and embedded PowerPC systems, put small global and static
16124 data in the @samp{.sdata} section, which is pointed to by register
16125 @code{r13}.  Put small uninitialized global and static data in the
16126 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
16127 The @option{-msdata=sysv} option is incompatible with the
16128 @option{-mrelocatable} option.
16130 @item -msdata=default
16131 @itemx -msdata
16132 @opindex msdata=default
16133 @opindex msdata
16134 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
16135 compile code the same as @option{-msdata=eabi}, otherwise compile code the
16136 same as @option{-msdata=sysv}.
16138 @item -msdata=data
16139 @opindex msdata=data
16140 On System V.4 and embedded PowerPC systems, put small global
16141 data in the @samp{.sdata} section.  Put small uninitialized global
16142 data in the @samp{.sbss} section.  Do not use register @code{r13}
16143 to address small data however.  This is the default behavior unless
16144 other @option{-msdata} options are used.
16146 @item -msdata=none
16147 @itemx -mno-sdata
16148 @opindex msdata=none
16149 @opindex mno-sdata
16150 On embedded PowerPC systems, put all initialized global and static data
16151 in the @samp{.data} section, and all uninitialized data in the
16152 @samp{.bss} section.
16154 @item -mblock-move-inline-limit=@var{num}
16155 @opindex mblock-move-inline-limit
16156 Inline all block moves (such as calls to @code{memcpy} or structure
16157 copies) less than or equal to @var{num} bytes.  The minimum value for
16158 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
16159 targets.  The default value is target-specific.
16161 @item -G @var{num}
16162 @opindex G
16163 @cindex smaller data references (PowerPC)
16164 @cindex .sdata/.sdata2 references (PowerPC)
16165 On embedded PowerPC systems, put global and static items less than or
16166 equal to @var{num} bytes into the small data or bss sections instead of
16167 the normal data or bss section.  By default, @var{num} is 8.  The
16168 @option{-G @var{num}} switch is also passed to the linker.
16169 All modules should be compiled with the same @option{-G @var{num}} value.
16171 @item -mregnames
16172 @itemx -mno-regnames
16173 @opindex mregnames
16174 @opindex mno-regnames
16175 On System V.4 and embedded PowerPC systems do (do not) emit register
16176 names in the assembly language output using symbolic forms.
16178 @item -mlongcall
16179 @itemx -mno-longcall
16180 @opindex mlongcall
16181 @opindex mno-longcall
16182 By default assume that all calls are far away so that a longer more
16183 expensive calling sequence is required.  This is required for calls
16184 further than 32 megabytes (33,554,432 bytes) from the current location.
16185 A short call will be generated if the compiler knows
16186 the call cannot be that far away.  This setting can be overridden by
16187 the @code{shortcall} function attribute, or by @code{#pragma
16188 longcall(0)}.
16190 Some linkers are capable of detecting out-of-range calls and generating
16191 glue code on the fly.  On these systems, long calls are unnecessary and
16192 generate slower code.  As of this writing, the AIX linker can do this,
16193 as can the GNU linker for PowerPC/64.  It is planned to add this feature
16194 to the GNU linker for 32-bit PowerPC systems as well.
16196 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
16197 callee, L42'', plus a ``branch island'' (glue code).  The two target
16198 addresses represent the callee and the ``branch island''.  The
16199 Darwin/PPC linker will prefer the first address and generate a ``bl
16200 callee'' if the PPC ``bl'' instruction will reach the callee directly;
16201 otherwise, the linker will generate ``bl L42'' to call the ``branch
16202 island''.  The ``branch island'' is appended to the body of the
16203 calling function; it computes the full 32-bit address of the callee
16204 and jumps to it.
16206 On Mach-O (Darwin) systems, this option directs the compiler emit to
16207 the glue for every direct call, and the Darwin linker decides whether
16208 to use or discard it.
16210 In the future, we may cause GCC to ignore all longcall specifications
16211 when the linker is known to generate glue.
16213 @item -mtls-markers
16214 @itemx -mno-tls-markers
16215 @opindex mtls-markers
16216 @opindex mno-tls-markers
16217 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
16218 specifying the function argument.  The relocation allows ld to
16219 reliably associate function call with argument setup instructions for
16220 TLS optimization, which in turn allows gcc to better schedule the
16221 sequence.
16223 @item -pthread
16224 @opindex pthread
16225 Adds support for multithreading with the @dfn{pthreads} library.
16226 This option sets flags for both the preprocessor and linker.
16228 @item -mrecip
16229 @itemx -mno-recip
16230 @opindex mrecip
16231 This option will enable GCC to use the reciprocal estimate and
16232 reciprocal square root estimate instructions with additional
16233 Newton-Raphson steps to increase precision instead of doing a divide or
16234 square root and divide for floating point arguments.  You should use
16235 the @option{-ffast-math} option when using @option{-mrecip} (or at
16236 least @option{-funsafe-math-optimizations},
16237 @option{-finite-math-only}, @option{-freciprocal-math} and
16238 @option{-fno-trapping-math}).  Note that while the throughput of the
16239 sequence is generally higher than the throughput of the non-reciprocal
16240 instruction, the precision of the sequence can be decreased by up to 2
16241 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
16242 roots.
16244 @item -mrecip=@var{opt}
16245 @opindex mrecip=opt
16246 This option allows to control which reciprocal estimate instructions
16247 may be used.  @var{opt} is a comma separated list of options, that may
16248 be preceded by a @code{!} to invert the option:
16249 @code{all}: enable all estimate instructions,
16250 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
16251 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
16252 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
16253 @code{divf}: enable the single precision reciprocal approximation instructions;
16254 @code{divd}: enable the double precision reciprocal approximation instructions;
16255 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
16256 @code{rsqrtf}: enable the single precision reciprocal square root approximation instructions;
16257 @code{rsqrtd}: enable the double precision reciprocal square root approximation instructions;
16259 So for example, @option{-mrecip=all,!rsqrtd} would enable the
16260 all of the reciprocal estimate instructions, except for the
16261 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
16262 which handle the double precision reciprocal square root calculations.
16264 @item -mrecip-precision
16265 @itemx -mno-recip-precision
16266 @opindex mrecip-precision
16267 Assume (do not assume) that the reciprocal estimate instructions
16268 provide higher precision estimates than is mandated by the powerpc
16269 ABI.  Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
16270 automatically selects @option{-mrecip-precision}.  The double
16271 precision square root estimate instructions are not generated by
16272 default on low precision machines, since they do not provide an
16273 estimate that converges after three steps.
16275 @item -mveclibabi=@var{type}
16276 @opindex mveclibabi
16277 Specifies the ABI type to use for vectorizing intrinsics using an
16278 external library.  The only type supported at present is @code{mass},
16279 which specifies to use IBM's Mathematical Acceleration Subsystem
16280 (MASS) libraries for vectorizing intrinsics using external libraries.
16281 GCC will currently emit calls to @code{acosd2}, @code{acosf4},
16282 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
16283 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
16284 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
16285 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
16286 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
16287 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
16288 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
16289 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
16290 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
16291 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
16292 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
16293 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
16294 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
16295 for power7.  Both @option{-ftree-vectorize} and
16296 @option{-funsafe-math-optimizations} have to be enabled.  The MASS
16297 libraries will have to be specified at link time.
16299 @item -mfriz
16300 @itemx -mno-friz
16301 @opindex mfriz
16302 Generate (do not generate) the @code{friz} instruction when the
16303 @option{-funsafe-math-optimizations} option is used to optimize
16304 rounding a floating point value to 64-bit integer and back to floating
16305 point.  The @code{friz} instruction does not return the same value if
16306 the floating point number is too large to fit in an integer.
16307 @end table
16309 @node RX Options
16310 @subsection RX Options
16311 @cindex RX Options
16313 These command line options are defined for RX targets:
16315 @table @gcctabopt
16316 @item -m64bit-doubles
16317 @itemx -m32bit-doubles
16318 @opindex m64bit-doubles
16319 @opindex m32bit-doubles
16320 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
16321 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
16322 @option{-m32bit-doubles}.  @emph{Note} RX floating point hardware only
16323 works on 32-bit values, which is why the default is
16324 @option{-m32bit-doubles}.
16326 @item -fpu
16327 @itemx -nofpu
16328 @opindex fpu
16329 @opindex nofpu
16330 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
16331 floating point hardware.  The default is enabled for the @var{RX600}
16332 series and disabled for the @var{RX200} series.
16334 Floating point instructions will only be generated for 32-bit floating
16335 point values however, so if the @option{-m64bit-doubles} option is in
16336 use then the FPU hardware will not be used for doubles.
16338 @emph{Note} If the @option{-fpu} option is enabled then
16339 @option{-funsafe-math-optimizations} is also enabled automatically.
16340 This is because the RX FPU instructions are themselves unsafe.
16342 @item -mcpu=@var{name}
16343 @opindex -mcpu
16344 Selects the type of RX CPU to be targeted.  Currently three types are
16345 supported, the generic @var{RX600} and @var{RX200} series hardware and
16346 the specific @var{RX610} CPU.  The default is @var{RX600}.
16348 The only difference between @var{RX600} and @var{RX610} is that the
16349 @var{RX610} does not support the @code{MVTIPL} instruction.
16351 The @var{RX200} series does not have a hardware floating point unit
16352 and so @option{-nofpu} is enabled by default when this type is
16353 selected.
16355 @item -mbig-endian-data
16356 @itemx -mlittle-endian-data
16357 @opindex mbig-endian-data
16358 @opindex mlittle-endian-data
16359 Store data (but not code) in the big-endian format.  The default is
16360 @option{-mlittle-endian-data}, i.e.@: to store data in the little endian
16361 format.
16363 @item -msmall-data-limit=@var{N}
16364 @opindex msmall-data-limit
16365 Specifies the maximum size in bytes of global and static variables
16366 which can be placed into the small data area.  Using the small data
16367 area can lead to smaller and faster code, but the size of area is
16368 limited and it is up to the programmer to ensure that the area does
16369 not overflow.  Also when the small data area is used one of the RX's
16370 registers (@code{r13}) is reserved for use pointing to this area, so
16371 it is no longer available for use by the compiler.  This could result
16372 in slower and/or larger code if variables which once could have been
16373 held in @code{r13} are now pushed onto the stack.
16375 Note, common variables (variables which have not been initialised) and
16376 constants are not placed into the small data area as they are assigned
16377 to other sections in the output executable.
16379 The default value is zero, which disables this feature.  Note, this
16380 feature is not enabled by default with higher optimization levels
16381 (@option{-O2} etc) because of the potentially detrimental effects of
16382 reserving register @code{r13}.  It is up to the programmer to
16383 experiment and discover whether this feature is of benefit to their
16384 program.
16386 @item -msim
16387 @itemx -mno-sim
16388 @opindex msim
16389 @opindex mno-sim
16390 Use the simulator runtime.  The default is to use the libgloss board
16391 specific runtime.
16393 @item -mas100-syntax
16394 @itemx -mno-as100-syntax
16395 @opindex mas100-syntax
16396 @opindex mno-as100-syntax
16397 When generating assembler output use a syntax that is compatible with
16398 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
16399 assembler but it has some restrictions so generating it is not the
16400 default option.
16402 @item -mmax-constant-size=@var{N}
16403 @opindex mmax-constant-size
16404 Specifies the maximum size, in bytes, of a constant that can be used as
16405 an operand in a RX instruction.  Although the RX instruction set does
16406 allow constants of up to 4 bytes in length to be used in instructions,
16407 a longer value equates to a longer instruction.  Thus in some
16408 circumstances it can be beneficial to restrict the size of constants
16409 that are used in instructions.  Constants that are too big are instead
16410 placed into a constant pool and referenced via register indirection.
16412 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
16413 or 4 means that constants of any size are allowed.
16415 @item -mrelax
16416 @opindex mrelax
16417 Enable linker relaxation.  Linker relaxation is a process whereby the
16418 linker will attempt to reduce the size of a program by finding shorter
16419 versions of various instructions.  Disabled by default.
16421 @item -mint-register=@var{N}
16422 @opindex mint-register
16423 Specify the number of registers to reserve for fast interrupt handler
16424 functions.  The value @var{N} can be between 0 and 4.  A value of 1
16425 means that register @code{r13} will be reserved for the exclusive use
16426 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
16427 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
16428 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
16429 A value of 0, the default, does not reserve any registers.
16431 @item -msave-acc-in-interrupts
16432 @opindex msave-acc-in-interrupts
16433 Specifies that interrupt handler functions should preserve the
16434 accumulator register.  This is only necessary if normal code might use
16435 the accumulator register, for example because it performs 64-bit
16436 multiplications.  The default is to ignore the accumulator as this
16437 makes the interrupt handlers faster.
16439 @end table
16441 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
16442 has special significance to the RX port when used with the
16443 @code{interrupt} function attribute.  This attribute indicates a
16444 function intended to process fast interrupts.  GCC will will ensure
16445 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
16446 and/or @code{r13} and only provided that the normal use of the
16447 corresponding registers have been restricted via the
16448 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
16449 options.
16451 @node S/390 and zSeries Options
16452 @subsection S/390 and zSeries Options
16453 @cindex S/390 and zSeries Options
16455 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
16457 @table @gcctabopt
16458 @item -mhard-float
16459 @itemx -msoft-float
16460 @opindex mhard-float
16461 @opindex msoft-float
16462 Use (do not use) the hardware floating-point instructions and registers
16463 for floating-point operations.  When @option{-msoft-float} is specified,
16464 functions in @file{libgcc.a} will be used to perform floating-point
16465 operations.  When @option{-mhard-float} is specified, the compiler
16466 generates IEEE floating-point instructions.  This is the default.
16468 @item -mhard-dfp
16469 @itemx -mno-hard-dfp
16470 @opindex mhard-dfp
16471 @opindex mno-hard-dfp
16472 Use (do not use) the hardware decimal-floating-point instructions for
16473 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
16474 specified, functions in @file{libgcc.a} will be used to perform
16475 decimal-floating-point operations.  When @option{-mhard-dfp} is
16476 specified, the compiler generates decimal-floating-point hardware
16477 instructions.  This is the default for @option{-march=z9-ec} or higher.
16479 @item -mlong-double-64
16480 @itemx -mlong-double-128
16481 @opindex mlong-double-64
16482 @opindex mlong-double-128
16483 These switches control the size of @code{long double} type. A size
16484 of 64bit makes the @code{long double} type equivalent to the @code{double}
16485 type. This is the default.
16487 @item -mbackchain
16488 @itemx -mno-backchain
16489 @opindex mbackchain
16490 @opindex mno-backchain
16491 Store (do not store) the address of the caller's frame as backchain pointer
16492 into the callee's stack frame.
16493 A backchain may be needed to allow debugging using tools that do not understand
16494 DWARF-2 call frame information.
16495 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
16496 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
16497 the backchain is placed into the topmost word of the 96/160 byte register
16498 save area.
16500 In general, code compiled with @option{-mbackchain} is call-compatible with
16501 code compiled with @option{-mmo-backchain}; however, use of the backchain
16502 for debugging purposes usually requires that the whole binary is built with
16503 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
16504 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
16505 to build a linux kernel use @option{-msoft-float}.
16507 The default is to not maintain the backchain.
16509 @item -mpacked-stack
16510 @itemx -mno-packed-stack
16511 @opindex mpacked-stack
16512 @opindex mno-packed-stack
16513 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
16514 specified, the compiler uses the all fields of the 96/160 byte register save
16515 area only for their default purpose; unused fields still take up stack space.
16516 When @option{-mpacked-stack} is specified, register save slots are densely
16517 packed at the top of the register save area; unused space is reused for other
16518 purposes, allowing for more efficient use of the available stack space.
16519 However, when @option{-mbackchain} is also in effect, the topmost word of
16520 the save area is always used to store the backchain, and the return address
16521 register is always saved two words below the backchain.
16523 As long as the stack frame backchain is not used, code generated with
16524 @option{-mpacked-stack} is call-compatible with code generated with
16525 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
16526 S/390 or zSeries generated code that uses the stack frame backchain at run
16527 time, not just for debugging purposes.  Such code is not call-compatible
16528 with code compiled with @option{-mpacked-stack}.  Also, note that the
16529 combination of @option{-mbackchain},
16530 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
16531 to build a linux kernel use @option{-msoft-float}.
16533 The default is to not use the packed stack layout.
16535 @item -msmall-exec
16536 @itemx -mno-small-exec
16537 @opindex msmall-exec
16538 @opindex mno-small-exec
16539 Generate (or do not generate) code using the @code{bras} instruction
16540 to do subroutine calls.
16541 This only works reliably if the total executable size does not
16542 exceed 64k.  The default is to use the @code{basr} instruction instead,
16543 which does not have this limitation.
16545 @item -m64
16546 @itemx -m31
16547 @opindex m64
16548 @opindex m31
16549 When @option{-m31} is specified, generate code compliant to the
16550 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
16551 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
16552 particular to generate 64-bit instructions.  For the @samp{s390}
16553 targets, the default is @option{-m31}, while the @samp{s390x}
16554 targets default to @option{-m64}.
16556 @item -mzarch
16557 @itemx -mesa
16558 @opindex mzarch
16559 @opindex mesa
16560 When @option{-mzarch} is specified, generate code using the
16561 instructions available on z/Architecture.
16562 When @option{-mesa} is specified, generate code using the
16563 instructions available on ESA/390.  Note that @option{-mesa} is
16564 not possible with @option{-m64}.
16565 When generating code compliant to the GNU/Linux for S/390 ABI,
16566 the default is @option{-mesa}.  When generating code compliant
16567 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
16569 @item -mmvcle
16570 @itemx -mno-mvcle
16571 @opindex mmvcle
16572 @opindex mno-mvcle
16573 Generate (or do not generate) code using the @code{mvcle} instruction
16574 to perform block moves.  When @option{-mno-mvcle} is specified,
16575 use a @code{mvc} loop instead.  This is the default unless optimizing for
16576 size.
16578 @item -mdebug
16579 @itemx -mno-debug
16580 @opindex mdebug
16581 @opindex mno-debug
16582 Print (or do not print) additional debug information when compiling.
16583 The default is to not print debug information.
16585 @item -march=@var{cpu-type}
16586 @opindex march
16587 Generate code that will run on @var{cpu-type}, which is the name of a system
16588 representing a certain processor type.  Possible values for
16589 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
16590 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
16591 When generating code using the instructions available on z/Architecture,
16592 the default is @option{-march=z900}.  Otherwise, the default is
16593 @option{-march=g5}.
16595 @item -mtune=@var{cpu-type}
16596 @opindex mtune
16597 Tune to @var{cpu-type} everything applicable about the generated code,
16598 except for the ABI and the set of available instructions.
16599 The list of @var{cpu-type} values is the same as for @option{-march}.
16600 The default is the value used for @option{-march}.
16602 @item -mtpf-trace
16603 @itemx -mno-tpf-trace
16604 @opindex mtpf-trace
16605 @opindex mno-tpf-trace
16606 Generate code that adds (does not add) in TPF OS specific branches to trace
16607 routines in the operating system.  This option is off by default, even
16608 when compiling for the TPF OS@.
16610 @item -mfused-madd
16611 @itemx -mno-fused-madd
16612 @opindex mfused-madd
16613 @opindex mno-fused-madd
16614 Generate code that uses (does not use) the floating point multiply and
16615 accumulate instructions.  These instructions are generated by default if
16616 hardware floating point is used.
16618 @item -mwarn-framesize=@var{framesize}
16619 @opindex mwarn-framesize
16620 Emit a warning if the current function exceeds the given frame size.  Because
16621 this is a compile time check it doesn't need to be a real problem when the program
16622 runs.  It is intended to identify functions which most probably cause
16623 a stack overflow.  It is useful to be used in an environment with limited stack
16624 size e.g.@: the linux kernel.
16626 @item -mwarn-dynamicstack
16627 @opindex mwarn-dynamicstack
16628 Emit a warning if the function calls alloca or uses dynamically
16629 sized arrays.  This is generally a bad idea with a limited stack size.
16631 @item -mstack-guard=@var{stack-guard}
16632 @itemx -mstack-size=@var{stack-size}
16633 @opindex mstack-guard
16634 @opindex mstack-size
16635 If these options are provided the s390 back end emits additional instructions in
16636 the function prologue which trigger a trap if the stack size is @var{stack-guard}
16637 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
16638 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
16639 the frame size of the compiled function is chosen.
16640 These options are intended to be used to help debugging stack overflow problems.
16641 The additionally emitted code causes only little overhead and hence can also be
16642 used in production like systems without greater performance degradation.  The given
16643 values have to be exact powers of 2 and @var{stack-size} has to be greater than
16644 @var{stack-guard} without exceeding 64k.
16645 In order to be efficient the extra code makes the assumption that the stack starts
16646 at an address aligned to the value given by @var{stack-size}.
16647 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
16648 @end table
16650 @node Score Options
16651 @subsection Score Options
16652 @cindex Score Options
16654 These options are defined for Score implementations:
16656 @table @gcctabopt
16657 @item -meb
16658 @opindex meb
16659 Compile code for big endian mode.  This is the default.
16661 @item -mel
16662 @opindex mel
16663 Compile code for little endian mode.
16665 @item -mnhwloop
16666 @opindex mnhwloop
16667 Disable generate bcnz instruction.
16669 @item -muls
16670 @opindex muls
16671 Enable generate unaligned load and store instruction.
16673 @item -mmac
16674 @opindex mmac
16675 Enable the use of multiply-accumulate instructions. Disabled by default.
16677 @item -mscore5
16678 @opindex mscore5
16679 Specify the SCORE5 as the target architecture.
16681 @item -mscore5u
16682 @opindex mscore5u
16683 Specify the SCORE5U of the target architecture.
16685 @item -mscore7
16686 @opindex mscore7
16687 Specify the SCORE7 as the target architecture. This is the default.
16689 @item -mscore7d
16690 @opindex mscore7d
16691 Specify the SCORE7D as the target architecture.
16692 @end table
16694 @node SH Options
16695 @subsection SH Options
16697 These @samp{-m} options are defined for the SH implementations:
16699 @table @gcctabopt
16700 @item -m1
16701 @opindex m1
16702 Generate code for the SH1.
16704 @item -m2
16705 @opindex m2
16706 Generate code for the SH2.
16708 @item -m2e
16709 Generate code for the SH2e.
16711 @item -m2a-nofpu
16712 @opindex m2a-nofpu
16713 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
16714 that the floating-point unit is not used.
16716 @item -m2a-single-only
16717 @opindex m2a-single-only
16718 Generate code for the SH2a-FPU, in such a way that no double-precision
16719 floating point operations are used.
16721 @item -m2a-single
16722 @opindex m2a-single
16723 Generate code for the SH2a-FPU assuming the floating-point unit is in
16724 single-precision mode by default.
16726 @item -m2a
16727 @opindex m2a
16728 Generate code for the SH2a-FPU assuming the floating-point unit is in
16729 double-precision mode by default.
16731 @item -m3
16732 @opindex m3
16733 Generate code for the SH3.
16735 @item -m3e
16736 @opindex m3e
16737 Generate code for the SH3e.
16739 @item -m4-nofpu
16740 @opindex m4-nofpu
16741 Generate code for the SH4 without a floating-point unit.
16743 @item -m4-single-only
16744 @opindex m4-single-only
16745 Generate code for the SH4 with a floating-point unit that only
16746 supports single-precision arithmetic.
16748 @item -m4-single
16749 @opindex m4-single
16750 Generate code for the SH4 assuming the floating-point unit is in
16751 single-precision mode by default.
16753 @item -m4
16754 @opindex m4
16755 Generate code for the SH4.
16757 @item -m4a-nofpu
16758 @opindex m4a-nofpu
16759 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
16760 floating-point unit is not used.
16762 @item -m4a-single-only
16763 @opindex m4a-single-only
16764 Generate code for the SH4a, in such a way that no double-precision
16765 floating point operations are used.
16767 @item -m4a-single
16768 @opindex m4a-single
16769 Generate code for the SH4a assuming the floating-point unit is in
16770 single-precision mode by default.
16772 @item -m4a
16773 @opindex m4a
16774 Generate code for the SH4a.
16776 @item -m4al
16777 @opindex m4al
16778 Same as @option{-m4a-nofpu}, except that it implicitly passes
16779 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
16780 instructions at the moment.
16782 @item -mb
16783 @opindex mb
16784 Compile code for the processor in big endian mode.
16786 @item -ml
16787 @opindex ml
16788 Compile code for the processor in little endian mode.
16790 @item -mdalign
16791 @opindex mdalign
16792 Align doubles at 64-bit boundaries.  Note that this changes the calling
16793 conventions, and thus some functions from the standard C library will
16794 not work unless you recompile it first with @option{-mdalign}.
16796 @item -mrelax
16797 @opindex mrelax
16798 Shorten some address references at link time, when possible; uses the
16799 linker option @option{-relax}.
16801 @item -mbigtable
16802 @opindex mbigtable
16803 Use 32-bit offsets in @code{switch} tables.  The default is to use
16804 16-bit offsets.
16806 @item -mbitops
16807 @opindex mbitops
16808 Enable the use of bit manipulation instructions on SH2A.
16810 @item -mfmovd
16811 @opindex mfmovd
16812 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
16813 alignment constraints.
16815 @item -mhitachi
16816 @opindex mhitachi
16817 Comply with the calling conventions defined by Renesas.
16819 @item -mrenesas
16820 @opindex mhitachi
16821 Comply with the calling conventions defined by Renesas.
16823 @item -mno-renesas
16824 @opindex mhitachi
16825 Comply with the calling conventions defined for GCC before the Renesas
16826 conventions were available.  This option is the default for all
16827 targets of the SH toolchain.
16829 @item -mnomacsave
16830 @opindex mnomacsave
16831 Mark the @code{MAC} register as call-clobbered, even if
16832 @option{-mhitachi} is given.
16834 @item -mieee
16835 @opindex mieee
16836 Increase IEEE-compliance of floating-point code.
16837 At the moment, this is equivalent to @option{-fno-finite-math-only}.
16838 When generating 16 bit SH opcodes, getting IEEE-conforming results for
16839 comparisons of NANs / infinities incurs extra overhead in every
16840 floating point comparison, therefore the default is set to
16841 @option{-ffinite-math-only}.
16843 @item -minline-ic_invalidate
16844 @opindex minline-ic_invalidate
16845 Inline code to invalidate instruction cache entries after setting up
16846 nested function trampolines.
16847 This option has no effect if -musermode is in effect and the selected
16848 code generation option (e.g. -m4) does not allow the use of the icbi
16849 instruction.
16850 If the selected code generation option does not allow the use of the icbi
16851 instruction, and -musermode is not in effect, the inlined code will
16852 manipulate the instruction cache address array directly with an associative
16853 write.  This not only requires privileged mode, but it will also
16854 fail if the cache line had been mapped via the TLB and has become unmapped.
16856 @item -misize
16857 @opindex misize
16858 Dump instruction size and location in the assembly code.
16860 @item -mpadstruct
16861 @opindex mpadstruct
16862 This option is deprecated.  It pads structures to multiple of 4 bytes,
16863 which is incompatible with the SH ABI@.
16865 @item -mspace
16866 @opindex mspace
16867 Optimize for space instead of speed.  Implied by @option{-Os}.
16869 @item -mprefergot
16870 @opindex mprefergot
16871 When generating position-independent code, emit function calls using
16872 the Global Offset Table instead of the Procedure Linkage Table.
16874 @item -musermode
16875 @opindex musermode
16876 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16877 if the inlined code would not work in user mode.
16878 This is the default when the target is @code{sh-*-linux*}.
16880 @item -multcost=@var{number}
16881 @opindex multcost=@var{number}
16882 Set the cost to assume for a multiply insn.
16884 @item -mdiv=@var{strategy}
16885 @opindex mdiv=@var{strategy}
16886 Set the division strategy to use for SHmedia code.  @var{strategy} must be
16887 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16888 inv:call2, inv:fp .
16889 "fp" performs the operation in floating point.  This has a very high latency,
16890 but needs only a few instructions, so it might be a good choice if
16891 your code has enough easily exploitable ILP to allow the compiler to
16892 schedule the floating point instructions together with other instructions.
16893 Division by zero causes a floating point exception.
16894 "inv" uses integer operations to calculate the inverse of the divisor,
16895 and then multiplies the dividend with the inverse.  This strategy allows
16896 cse and hoisting of the inverse calculation.  Division by zero calculates
16897 an unspecified result, but does not trap.
16898 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16899 have been found, or if the entire operation has been hoisted to the same
16900 place, the last stages of the inverse calculation are intertwined with the
16901 final multiply to reduce the overall latency, at the expense of using a few
16902 more instructions, and thus offering fewer scheduling opportunities with
16903 other code.
16904 "call" calls a library function that usually implements the inv:minlat
16905 strategy.
16906 This gives high code density for m5-*media-nofpu compilations.
16907 "call2" uses a different entry point of the same library function, where it
16908 assumes that a pointer to a lookup table has already been set up, which
16909 exposes the pointer load to cse / code hoisting optimizations.
16910 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16911 code generation, but if the code stays unoptimized, revert to the "call",
16912 "call2", or "fp" strategies, respectively.  Note that the
16913 potentially-trapping side effect of division by zero is carried by a
16914 separate instruction, so it is possible that all the integer instructions
16915 are hoisted out, but the marker for the side effect stays where it is.
16916 A recombination to fp operations or a call is not possible in that case.
16917 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16918 that the inverse calculation was nor separated from the multiply, they speed
16919 up division where the dividend fits into 20 bits (plus sign where applicable),
16920 by inserting a test to skip a number of operations in this case; this test
16921 slows down the case of larger dividends.  inv20u assumes the case of a such
16922 a small dividend to be unlikely, and inv20l assumes it to be likely.
16924 @item -maccumulate-outgoing-args
16925 @opindex maccumulate-outgoing-args
16926 Reserve space once for outgoing arguments in the function prologue rather
16927 than around each call.  Generally beneficial for performance and size.  Also
16928 needed for unwinding to avoid changing the stack frame around conditional code.
16930 @item -mdivsi3_libfunc=@var{name}
16931 @opindex mdivsi3_libfunc=@var{name}
16932 Set the name of the library function used for 32 bit signed division to
16933 @var{name}.  This only affect the name used in the call and inv:call
16934 division strategies, and the compiler will still expect the same
16935 sets of input/output/clobbered registers as if this option was not present.
16937 @item -mfixed-range=@var{register-range}
16938 @opindex mfixed-range
16939 Generate code treating the given register range as fixed registers.
16940 A fixed register is one that the register allocator can not use.  This is
16941 useful when compiling kernel code.  A register range is specified as
16942 two registers separated by a dash.  Multiple register ranges can be
16943 specified separated by a comma.
16945 @item -madjust-unroll
16946 @opindex madjust-unroll
16947 Throttle unrolling to avoid thrashing target registers.
16948 This option only has an effect if the gcc code base supports the
16949 TARGET_ADJUST_UNROLL_MAX target hook.
16951 @item -mindexed-addressing
16952 @opindex mindexed-addressing
16953 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16954 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16955 semantics for the indexed addressing mode.  The architecture allows the
16956 implementation of processors with 64 bit MMU, which the OS could use to
16957 get 32 bit addressing, but since no current hardware implementation supports
16958 this or any other way to make the indexed addressing mode safe to use in
16959 the 32 bit ABI, the default is -mno-indexed-addressing.
16961 @item -mgettrcost=@var{number}
16962 @opindex mgettrcost=@var{number}
16963 Set the cost assumed for the gettr instruction to @var{number}.
16964 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16966 @item -mpt-fixed
16967 @opindex mpt-fixed
16968 Assume pt* instructions won't trap.  This will generally generate better
16969 scheduled code, but is unsafe on current hardware.  The current architecture
16970 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16971 This has the unintentional effect of making it unsafe to schedule ptabs /
16972 ptrel before a branch, or hoist it out of a loop.  For example,
16973 __do_global_ctors, a part of libgcc that runs constructors at program
16974 startup, calls functions in a list which is delimited by @minus{}1.  With the
16975 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16976 That means that all the constructors will be run a bit quicker, but when
16977 the loop comes to the end of the list, the program crashes because ptabs
16978 loads @minus{}1 into a target register.  Since this option is unsafe for any
16979 hardware implementing the current architecture specification, the default
16980 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16981 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16982 this deters register allocation using target registers for storing
16983 ordinary integers.
16985 @item -minvalid-symbols
16986 @opindex minvalid-symbols
16987 Assume symbols might be invalid.  Ordinary function symbols generated by
16988 the compiler will always be valid to load with movi/shori/ptabs or
16989 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16990 to generate symbols that will cause ptabs / ptrel to trap.
16991 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16992 It will then prevent cross-basic-block cse, hoisting and most scheduling
16993 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16994 @end table
16996 @node Solaris 2 Options
16997 @subsection Solaris 2 Options
16998 @cindex Solaris 2 options
17000 These @samp{-m} options are supported on Solaris 2:
17002 @table @gcctabopt
17003 @item -mimpure-text
17004 @opindex mimpure-text
17005 @option{-mimpure-text}, used in addition to @option{-shared}, tells
17006 the compiler to not pass @option{-z text} to the linker when linking a
17007 shared object.  Using this option, you can link position-dependent
17008 code into a shared object.
17010 @option{-mimpure-text} suppresses the ``relocations remain against
17011 allocatable but non-writable sections'' linker error message.
17012 However, the necessary relocations will trigger copy-on-write, and the
17013 shared object is not actually shared across processes.  Instead of
17014 using @option{-mimpure-text}, you should compile all source code with
17015 @option{-fpic} or @option{-fPIC}.
17017 @end table
17019 These switches are supported in addition to the above on Solaris 2:
17021 @table @gcctabopt
17022 @item -pthreads
17023 @opindex pthreads
17024 Add support for multithreading using the POSIX threads library.  This
17025 option sets flags for both the preprocessor and linker.  This option does
17026 not affect the thread safety of object code produced  by the compiler or
17027 that of libraries supplied with it.
17029 @item -pthread
17030 @opindex pthread
17031 This is a synonym for @option{-pthreads}.
17032 @end table
17034 @node SPARC Options
17035 @subsection SPARC Options
17036 @cindex SPARC options
17038 These @samp{-m} options are supported on the SPARC:
17040 @table @gcctabopt
17041 @item -mno-app-regs
17042 @itemx -mapp-regs
17043 @opindex mno-app-regs
17044 @opindex mapp-regs
17045 Specify @option{-mapp-regs} to generate output using the global registers
17046 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
17047 is the default.
17049 To be fully SVR4 ABI compliant at the cost of some performance loss,
17050 specify @option{-mno-app-regs}.  You should compile libraries and system
17051 software with this option.
17053 @item -mflat
17054 @itemx -mno-flat
17055 @opindex mflat
17056 @opindex mno-flat
17057 With @option{-mflat}, the compiler does not generate save/restore instructions
17058 and uses a ``flat'' or single register window model.  This model is compatible
17059 with the regular register window model.  The local registers and the input
17060 registers (0--5) are still treated as ``call-saved'' registers and will be
17061 saved on the stack as needed.
17063 With @option{-mno-flat} (the default), the compiler generates save/restore
17064 instructions (except for leaf functions).  This is the normal operating mode.
17066 @item -mfpu
17067 @itemx -mhard-float
17068 @opindex mfpu
17069 @opindex mhard-float
17070 Generate output containing floating point instructions.  This is the
17071 default.
17073 @item -mno-fpu
17074 @itemx -msoft-float
17075 @opindex mno-fpu
17076 @opindex msoft-float
17077 Generate output containing library calls for floating point.
17078 @strong{Warning:} the requisite libraries are not available for all SPARC
17079 targets.  Normally the facilities of the machine's usual C compiler are
17080 used, but this cannot be done directly in cross-compilation.  You must make
17081 your own arrangements to provide suitable library functions for
17082 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
17083 @samp{sparclite-*-*} do provide software floating point support.
17085 @option{-msoft-float} changes the calling convention in the output file;
17086 therefore, it is only useful if you compile @emph{all} of a program with
17087 this option.  In particular, you need to compile @file{libgcc.a}, the
17088 library that comes with GCC, with @option{-msoft-float} in order for
17089 this to work.
17091 @item -mhard-quad-float
17092 @opindex mhard-quad-float
17093 Generate output containing quad-word (long double) floating point
17094 instructions.
17096 @item -msoft-quad-float
17097 @opindex msoft-quad-float
17098 Generate output containing library calls for quad-word (long double)
17099 floating point instructions.  The functions called are those specified
17100 in the SPARC ABI@.  This is the default.
17102 As of this writing, there are no SPARC implementations that have hardware
17103 support for the quad-word floating point instructions.  They all invoke
17104 a trap handler for one of these instructions, and then the trap handler
17105 emulates the effect of the instruction.  Because of the trap handler overhead,
17106 this is much slower than calling the ABI library routines.  Thus the
17107 @option{-msoft-quad-float} option is the default.
17109 @item -mno-unaligned-doubles
17110 @itemx -munaligned-doubles
17111 @opindex mno-unaligned-doubles
17112 @opindex munaligned-doubles
17113 Assume that doubles have 8 byte alignment.  This is the default.
17115 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
17116 alignment only if they are contained in another type, or if they have an
17117 absolute address.  Otherwise, it assumes they have 4 byte alignment.
17118 Specifying this option avoids some rare compatibility problems with code
17119 generated by other compilers.  It is not the default because it results
17120 in a performance loss, especially for floating point code.
17122 @item -mno-faster-structs
17123 @itemx -mfaster-structs
17124 @opindex mno-faster-structs
17125 @opindex mfaster-structs
17126 With @option{-mfaster-structs}, the compiler assumes that structures
17127 should have 8 byte alignment.  This enables the use of pairs of
17128 @code{ldd} and @code{std} instructions for copies in structure
17129 assignment, in place of twice as many @code{ld} and @code{st} pairs.
17130 However, the use of this changed alignment directly violates the SPARC
17131 ABI@.  Thus, it's intended only for use on targets where the developer
17132 acknowledges that their resulting code will not be directly in line with
17133 the rules of the ABI@.
17135 @item -mcpu=@var{cpu_type}
17136 @opindex mcpu
17137 Set the instruction set, register set, and instruction scheduling parameters
17138 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
17139 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
17140 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
17141 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
17142 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
17144 Default instruction scheduling parameters are used for values that select
17145 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
17146 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
17148 Here is a list of each supported architecture and their supported
17149 implementations.
17151 @smallexample
17152     v7:             cypress
17153     v8:             supersparc, hypersparc, leon
17154     sparclite:      f930, f934, sparclite86x
17155     sparclet:       tsc701
17156     v9:             ultrasparc, ultrasparc3, niagara, niagara2
17157 @end smallexample
17159 By default (unless configured otherwise), GCC generates code for the V7
17160 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
17161 additionally optimizes it for the Cypress CY7C602 chip, as used in the
17162 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
17163 SPARCStation 1, 2, IPX etc.
17165 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
17166 architecture.  The only difference from V7 code is that the compiler emits
17167 the integer multiply and integer divide instructions which exist in SPARC-V8
17168 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
17169 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
17170 2000 series.
17172 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
17173 the SPARC architecture.  This adds the integer multiply, integer divide step
17174 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
17175 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
17176 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
17177 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
17178 MB86934 chip, which is the more recent SPARClite with FPU@.
17180 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
17181 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
17182 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
17183 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
17184 optimizes it for the TEMIC SPARClet chip.
17186 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
17187 architecture.  This adds 64-bit integer and floating-point move instructions,
17188 3 additional floating-point condition code registers and conditional move
17189 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
17190 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
17191 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
17192 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
17193 @option{-mcpu=niagara}, the compiler additionally optimizes it for
17194 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
17195 additionally optimizes it for Sun UltraSPARC T2 chips.
17197 @item -mtune=@var{cpu_type}
17198 @opindex mtune
17199 Set the instruction scheduling parameters for machine type
17200 @var{cpu_type}, but do not set the instruction set or register set that the
17201 option @option{-mcpu=@var{cpu_type}} would.
17203 The same values for @option{-mcpu=@var{cpu_type}} can be used for
17204 @option{-mtune=@var{cpu_type}}, but the only useful values are those
17205 that select a particular CPU implementation.  Those are @samp{cypress},
17206 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
17207 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
17208 @samp{niagara}, and @samp{niagara2}.
17210 @item -mv8plus
17211 @itemx -mno-v8plus
17212 @opindex mv8plus
17213 @opindex mno-v8plus
17214 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
17215 difference from the V8 ABI is that the global and out registers are
17216 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
17217 mode for all SPARC-V9 processors.
17219 @item -mvis
17220 @itemx -mno-vis
17221 @opindex mvis
17222 @opindex mno-vis
17223 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
17224 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
17225 @end table
17227 These @samp{-m} options are supported in addition to the above
17228 on SPARC-V9 processors in 64-bit environments:
17230 @table @gcctabopt
17231 @item -mlittle-endian
17232 @opindex mlittle-endian
17233 Generate code for a processor running in little-endian mode.  It is only
17234 available for a few configurations and most notably not on Solaris and Linux.
17236 @item -m32
17237 @itemx -m64
17238 @opindex m32
17239 @opindex m64
17240 Generate code for a 32-bit or 64-bit environment.
17241 The 32-bit environment sets int, long and pointer to 32 bits.
17242 The 64-bit environment sets int to 32 bits and long and pointer
17243 to 64 bits.
17245 @item -mcmodel=medlow
17246 @opindex mcmodel=medlow
17247 Generate code for the Medium/Low code model: 64-bit addresses, programs
17248 must be linked in the low 32 bits of memory.  Programs can be statically
17249 or dynamically linked.
17251 @item -mcmodel=medmid
17252 @opindex mcmodel=medmid
17253 Generate code for the Medium/Middle code model: 64-bit addresses, programs
17254 must be linked in the low 44 bits of memory, the text and data segments must
17255 be less than 2GB in size and the data segment must be located within 2GB of
17256 the text segment.
17258 @item -mcmodel=medany
17259 @opindex mcmodel=medany
17260 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
17261 may be linked anywhere in memory, the text and data segments must be less
17262 than 2GB in size and the data segment must be located within 2GB of the
17263 text segment.
17265 @item -mcmodel=embmedany
17266 @opindex mcmodel=embmedany
17267 Generate code for the Medium/Anywhere code model for embedded systems:
17268 64-bit addresses, the text and data segments must be less than 2GB in
17269 size, both starting anywhere in memory (determined at link time).  The
17270 global register %g4 points to the base of the data segment.  Programs
17271 are statically linked and PIC is not supported.
17273 @item -mstack-bias
17274 @itemx -mno-stack-bias
17275 @opindex mstack-bias
17276 @opindex mno-stack-bias
17277 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
17278 frame pointer if present, are offset by @minus{}2047 which must be added back
17279 when making stack frame references.  This is the default in 64-bit mode.
17280 Otherwise, assume no such offset is present.
17281 @end table
17283 @node SPU Options
17284 @subsection SPU Options
17285 @cindex SPU options
17287 These @samp{-m} options are supported on the SPU:
17289 @table @gcctabopt
17290 @item -mwarn-reloc
17291 @itemx -merror-reloc
17292 @opindex mwarn-reloc
17293 @opindex merror-reloc
17295 The loader for SPU does not handle dynamic relocations.  By default, GCC
17296 will give an error when it generates code that requires a dynamic
17297 relocation.  @option{-mno-error-reloc} disables the error,
17298 @option{-mwarn-reloc} will generate a warning instead.
17300 @item -msafe-dma
17301 @itemx -munsafe-dma
17302 @opindex msafe-dma
17303 @opindex munsafe-dma
17305 Instructions which initiate or test completion of DMA must not be
17306 reordered with respect to loads and stores of the memory which is being
17307 accessed.  Users typically address this problem using the volatile
17308 keyword, but that can lead to inefficient code in places where the
17309 memory is known to not change.  Rather than mark the memory as volatile
17310 we treat the DMA instructions as potentially effecting all memory.  With
17311 @option{-munsafe-dma} users must use the volatile keyword to protect
17312 memory accesses.
17314 @item -mbranch-hints
17315 @opindex mbranch-hints
17317 By default, GCC will generate a branch hint instruction to avoid
17318 pipeline stalls for always taken or probably taken branches.  A hint
17319 will not be generated closer than 8 instructions away from its branch.
17320 There is little reason to disable them, except for debugging purposes,
17321 or to make an object a little bit smaller.
17323 @item -msmall-mem
17324 @itemx -mlarge-mem
17325 @opindex msmall-mem
17326 @opindex mlarge-mem
17328 By default, GCC generates code assuming that addresses are never larger
17329 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
17330 a full 32 bit address.
17332 @item -mstdmain
17333 @opindex mstdmain
17335 By default, GCC links against startup code that assumes the SPU-style
17336 main function interface (which has an unconventional parameter list).
17337 With @option{-mstdmain}, GCC will link your program against startup
17338 code that assumes a C99-style interface to @code{main}, including a
17339 local copy of @code{argv} strings.
17341 @item -mfixed-range=@var{register-range}
17342 @opindex mfixed-range
17343 Generate code treating the given register range as fixed registers.
17344 A fixed register is one that the register allocator can not use.  This is
17345 useful when compiling kernel code.  A register range is specified as
17346 two registers separated by a dash.  Multiple register ranges can be
17347 specified separated by a comma.
17349 @item -mea32
17350 @itemx -mea64
17351 @opindex mea32
17352 @opindex mea64
17353 Compile code assuming that pointers to the PPU address space accessed
17354 via the @code{__ea} named address space qualifier are either 32 or 64
17355 bits wide.  The default is 32 bits.  As this is an ABI changing option,
17356 all object code in an executable must be compiled with the same setting.
17358 @item -maddress-space-conversion
17359 @itemx -mno-address-space-conversion
17360 @opindex maddress-space-conversion
17361 @opindex mno-address-space-conversion
17362 Allow/disallow treating the @code{__ea} address space as superset
17363 of the generic address space.  This enables explicit type casts
17364 between @code{__ea} and generic pointer as well as implicit
17365 conversions of generic pointers to @code{__ea} pointers.  The
17366 default is to allow address space pointer conversions.
17368 @item -mcache-size=@var{cache-size}
17369 @opindex mcache-size
17370 This option controls the version of libgcc that the compiler links to an
17371 executable and selects a software-managed cache for accessing variables
17372 in the @code{__ea} address space with a particular cache size.  Possible
17373 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
17374 and @samp{128}.  The default cache size is 64KB.
17376 @item -matomic-updates
17377 @itemx -mno-atomic-updates
17378 @opindex matomic-updates
17379 @opindex mno-atomic-updates
17380 This option controls the version of libgcc that the compiler links to an
17381 executable and selects whether atomic updates to the software-managed
17382 cache of PPU-side variables are used.  If you use atomic updates, changes
17383 to a PPU variable from SPU code using the @code{__ea} named address space
17384 qualifier will not interfere with changes to other PPU variables residing
17385 in the same cache line from PPU code.  If you do not use atomic updates,
17386 such interference may occur; however, writing back cache lines will be
17387 more efficient.  The default behavior is to use atomic updates.
17389 @item -mdual-nops
17390 @itemx -mdual-nops=@var{n}
17391 @opindex mdual-nops
17392 By default, GCC will insert nops to increase dual issue when it expects
17393 it to increase performance.  @var{n} can be a value from 0 to 10.  A
17394 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
17395 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
17397 @item -mhint-max-nops=@var{n}
17398 @opindex mhint-max-nops
17399 Maximum number of nops to insert for a branch hint.  A branch hint must
17400 be at least 8 instructions away from the branch it is effecting.  GCC
17401 will insert up to @var{n} nops to enforce this, otherwise it will not
17402 generate the branch hint.
17404 @item -mhint-max-distance=@var{n}
17405 @opindex mhint-max-distance
17406 The encoding of the branch hint instruction limits the hint to be within
17407 256 instructions of the branch it is effecting.  By default, GCC makes
17408 sure it is within 125.
17410 @item -msafe-hints
17411 @opindex msafe-hints
17412 Work around a hardware bug which causes the SPU to stall indefinitely.
17413 By default, GCC will insert the @code{hbrp} instruction to make sure
17414 this stall won't happen.
17416 @end table
17418 @node System V Options
17419 @subsection Options for System V
17421 These additional options are available on System V Release 4 for
17422 compatibility with other compilers on those systems:
17424 @table @gcctabopt
17425 @item -G
17426 @opindex G
17427 Create a shared object.
17428 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
17430 @item -Qy
17431 @opindex Qy
17432 Identify the versions of each tool used by the compiler, in a
17433 @code{.ident} assembler directive in the output.
17435 @item -Qn
17436 @opindex Qn
17437 Refrain from adding @code{.ident} directives to the output file (this is
17438 the default).
17440 @item -YP,@var{dirs}
17441 @opindex YP
17442 Search the directories @var{dirs}, and no others, for libraries
17443 specified with @option{-l}.
17445 @item -Ym,@var{dir}
17446 @opindex Ym
17447 Look in the directory @var{dir} to find the M4 preprocessor.
17448 The assembler uses this option.
17449 @c This is supposed to go with a -Yd for predefined M4 macro files, but
17450 @c the generic assembler that comes with Solaris takes just -Ym.
17451 @end table
17453 @node V850 Options
17454 @subsection V850 Options
17455 @cindex V850 Options
17457 These @samp{-m} options are defined for V850 implementations:
17459 @table @gcctabopt
17460 @item -mlong-calls
17461 @itemx -mno-long-calls
17462 @opindex mlong-calls
17463 @opindex mno-long-calls
17464 Treat all calls as being far away (near).  If calls are assumed to be
17465 far away, the compiler will always load the functions address up into a
17466 register, and call indirect through the pointer.
17468 @item -mno-ep
17469 @itemx -mep
17470 @opindex mno-ep
17471 @opindex mep
17472 Do not optimize (do optimize) basic blocks that use the same index
17473 pointer 4 or more times to copy pointer into the @code{ep} register, and
17474 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
17475 option is on by default if you optimize.
17477 @item -mno-prolog-function
17478 @itemx -mprolog-function
17479 @opindex mno-prolog-function
17480 @opindex mprolog-function
17481 Do not use (do use) external functions to save and restore registers
17482 at the prologue and epilogue of a function.  The external functions
17483 are slower, but use less code space if more than one function saves
17484 the same number of registers.  The @option{-mprolog-function} option
17485 is on by default if you optimize.
17487 @item -mspace
17488 @opindex mspace
17489 Try to make the code as small as possible.  At present, this just turns
17490 on the @option{-mep} and @option{-mprolog-function} options.
17492 @item -mtda=@var{n}
17493 @opindex mtda
17494 Put static or global variables whose size is @var{n} bytes or less into
17495 the tiny data area that register @code{ep} points to.  The tiny data
17496 area can hold up to 256 bytes in total (128 bytes for byte references).
17498 @item -msda=@var{n}
17499 @opindex msda
17500 Put static or global variables whose size is @var{n} bytes or less into
17501 the small data area that register @code{gp} points to.  The small data
17502 area can hold up to 64 kilobytes.
17504 @item -mzda=@var{n}
17505 @opindex mzda
17506 Put static or global variables whose size is @var{n} bytes or less into
17507 the first 32 kilobytes of memory.
17509 @item -mv850
17510 @opindex mv850
17511 Specify that the target processor is the V850.
17513 @item -mbig-switch
17514 @opindex mbig-switch
17515 Generate code suitable for big switch tables.  Use this option only if
17516 the assembler/linker complain about out of range branches within a switch
17517 table.
17519 @item -mapp-regs
17520 @opindex mapp-regs
17521 This option will cause r2 and r5 to be used in the code generated by
17522 the compiler.  This setting is the default.
17524 @item -mno-app-regs
17525 @opindex mno-app-regs
17526 This option will cause r2 and r5 to be treated as fixed registers.
17528 @item -mv850e2v3
17529 @opindex mv850e2v3
17530 Specify that the target processor is the V850E2V3.  The preprocessor
17531 constants @samp{__v850e2v3__} will be defined if
17532 this option is used.
17534 @item -mv850e2
17535 @opindex mv850e2
17536 Specify that the target processor is the V850E2.  The preprocessor
17537 constants @samp{__v850e2__} will be defined if this option is used.
17539 @item -mv850e1
17540 @opindex mv850e1
17541 Specify that the target processor is the V850E1.  The preprocessor
17542 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
17543 this option is used.
17545 @item -mv850es
17546 @opindex mv850es
17547 Specify that the target processor is the V850ES.  This is an alias for
17548 the @option{-mv850e1} option.
17550 @item -mv850e
17551 @opindex mv850e
17552 Specify that the target processor is the V850E@.  The preprocessor
17553 constant @samp{__v850e__} will be defined if this option is used.
17555 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
17556 nor @option{-mv850e2} nor @option{-mv850e2v3}
17557 are defined then a default target processor will be chosen and the
17558 relevant @samp{__v850*__} preprocessor constant will be defined.
17560 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
17561 defined, regardless of which processor variant is the target.
17563 @item -mdisable-callt
17564 @opindex mdisable-callt
17565 This option will suppress generation of the CALLT instruction for the
17566 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
17567 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
17569 @end table
17571 @node VAX Options
17572 @subsection VAX Options
17573 @cindex VAX options
17575 These @samp{-m} options are defined for the VAX:
17577 @table @gcctabopt
17578 @item -munix
17579 @opindex munix
17580 Do not output certain jump instructions (@code{aobleq} and so on)
17581 that the Unix assembler for the VAX cannot handle across long
17582 ranges.
17584 @item -mgnu
17585 @opindex mgnu
17586 Do output those jump instructions, on the assumption that you
17587 will assemble with the GNU assembler.
17589 @item -mg
17590 @opindex mg
17591 Output code for g-format floating point numbers instead of d-format.
17592 @end table
17594 @node VxWorks Options
17595 @subsection VxWorks Options
17596 @cindex VxWorks Options
17598 The options in this section are defined for all VxWorks targets.
17599 Options specific to the target hardware are listed with the other
17600 options for that target.
17602 @table @gcctabopt
17603 @item -mrtp
17604 @opindex mrtp
17605 GCC can generate code for both VxWorks kernels and real time processes
17606 (RTPs).  This option switches from the former to the latter.  It also
17607 defines the preprocessor macro @code{__RTP__}.
17609 @item -non-static
17610 @opindex non-static
17611 Link an RTP executable against shared libraries rather than static
17612 libraries.  The options @option{-static} and @option{-shared} can
17613 also be used for RTPs (@pxref{Link Options}); @option{-static}
17614 is the default.
17616 @item -Bstatic
17617 @itemx -Bdynamic
17618 @opindex Bstatic
17619 @opindex Bdynamic
17620 These options are passed down to the linker.  They are defined for
17621 compatibility with Diab.
17623 @item -Xbind-lazy
17624 @opindex Xbind-lazy
17625 Enable lazy binding of function calls.  This option is equivalent to
17626 @option{-Wl,-z,now} and is defined for compatibility with Diab.
17628 @item -Xbind-now
17629 @opindex Xbind-now
17630 Disable lazy binding of function calls.  This option is the default and
17631 is defined for compatibility with Diab.
17632 @end table
17634 @node x86-64 Options
17635 @subsection x86-64 Options
17636 @cindex x86-64 options
17638 These are listed under @xref{i386 and x86-64 Options}.
17640 @node Xstormy16 Options
17641 @subsection Xstormy16 Options
17642 @cindex Xstormy16 Options
17644 These options are defined for Xstormy16:
17646 @table @gcctabopt
17647 @item -msim
17648 @opindex msim
17649 Choose startup files and linker script suitable for the simulator.
17650 @end table
17652 @node Xtensa Options
17653 @subsection Xtensa Options
17654 @cindex Xtensa Options
17656 These options are supported for Xtensa targets:
17658 @table @gcctabopt
17659 @item -mconst16
17660 @itemx -mno-const16
17661 @opindex mconst16
17662 @opindex mno-const16
17663 Enable or disable use of @code{CONST16} instructions for loading
17664 constant values.  The @code{CONST16} instruction is currently not a
17665 standard option from Tensilica.  When enabled, @code{CONST16}
17666 instructions are always used in place of the standard @code{L32R}
17667 instructions.  The use of @code{CONST16} is enabled by default only if
17668 the @code{L32R} instruction is not available.
17670 @item -mfused-madd
17671 @itemx -mno-fused-madd
17672 @opindex mfused-madd
17673 @opindex mno-fused-madd
17674 Enable or disable use of fused multiply/add and multiply/subtract
17675 instructions in the floating-point option.  This has no effect if the
17676 floating-point option is not also enabled.  Disabling fused multiply/add
17677 and multiply/subtract instructions forces the compiler to use separate
17678 instructions for the multiply and add/subtract operations.  This may be
17679 desirable in some cases where strict IEEE 754-compliant results are
17680 required: the fused multiply add/subtract instructions do not round the
17681 intermediate result, thereby producing results with @emph{more} bits of
17682 precision than specified by the IEEE standard.  Disabling fused multiply
17683 add/subtract instructions also ensures that the program output is not
17684 sensitive to the compiler's ability to combine multiply and add/subtract
17685 operations.
17687 @item -mserialize-volatile
17688 @itemx -mno-serialize-volatile
17689 @opindex mserialize-volatile
17690 @opindex mno-serialize-volatile
17691 When this option is enabled, GCC inserts @code{MEMW} instructions before
17692 @code{volatile} memory references to guarantee sequential consistency.
17693 The default is @option{-mserialize-volatile}.  Use
17694 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
17696 @item -mforce-no-pic
17697 @opindex mforce-no-pic
17698 For targets, like GNU/Linux, where all user-mode Xtensa code must be
17699 position-independent code (PIC), this option disables PIC for compiling
17700 kernel code.
17702 @item -mtext-section-literals
17703 @itemx -mno-text-section-literals
17704 @opindex mtext-section-literals
17705 @opindex mno-text-section-literals
17706 Control the treatment of literal pools.  The default is
17707 @option{-mno-text-section-literals}, which places literals in a separate
17708 section in the output file.  This allows the literal pool to be placed
17709 in a data RAM/ROM, and it also allows the linker to combine literal
17710 pools from separate object files to remove redundant literals and
17711 improve code size.  With @option{-mtext-section-literals}, the literals
17712 are interspersed in the text section in order to keep them as close as
17713 possible to their references.  This may be necessary for large assembly
17714 files.
17716 @item -mtarget-align
17717 @itemx -mno-target-align
17718 @opindex mtarget-align
17719 @opindex mno-target-align
17720 When this option is enabled, GCC instructs the assembler to
17721 automatically align instructions to reduce branch penalties at the
17722 expense of some code density.  The assembler attempts to widen density
17723 instructions to align branch targets and the instructions following call
17724 instructions.  If there are not enough preceding safe density
17725 instructions to align a target, no widening will be performed.  The
17726 default is @option{-mtarget-align}.  These options do not affect the
17727 treatment of auto-aligned instructions like @code{LOOP}, which the
17728 assembler will always align, either by widening density instructions or
17729 by inserting no-op instructions.
17731 @item -mlongcalls
17732 @itemx -mno-longcalls
17733 @opindex mlongcalls
17734 @opindex mno-longcalls
17735 When this option is enabled, GCC instructs the assembler to translate
17736 direct calls to indirect calls unless it can determine that the target
17737 of a direct call is in the range allowed by the call instruction.  This
17738 translation typically occurs for calls to functions in other source
17739 files.  Specifically, the assembler translates a direct @code{CALL}
17740 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
17741 The default is @option{-mno-longcalls}.  This option should be used in
17742 programs where the call target can potentially be out of range.  This
17743 option is implemented in the assembler, not the compiler, so the
17744 assembly code generated by GCC will still show direct call
17745 instructions---look at the disassembled object code to see the actual
17746 instructions.  Note that the assembler will use an indirect call for
17747 every cross-file call, not just those that really will be out of range.
17748 @end table
17750 @node zSeries Options
17751 @subsection zSeries Options
17752 @cindex zSeries options
17754 These are listed under @xref{S/390 and zSeries Options}.
17756 @node Code Gen Options
17757 @section Options for Code Generation Conventions
17758 @cindex code generation conventions
17759 @cindex options, code generation
17760 @cindex run-time options
17762 These machine-independent options control the interface conventions
17763 used in code generation.
17765 Most of them have both positive and negative forms; the negative form
17766 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
17767 one of the forms is listed---the one which is not the default.  You
17768 can figure out the other form by either removing @samp{no-} or adding
17771 @table @gcctabopt
17772 @item -fbounds-check
17773 @opindex fbounds-check
17774 For front-ends that support it, generate additional code to check that
17775 indices used to access arrays are within the declared range.  This is
17776 currently only supported by the Java and Fortran front-ends, where
17777 this option defaults to true and false respectively.
17779 @item -ftrapv
17780 @opindex ftrapv
17781 This option generates traps for signed overflow on addition, subtraction,
17782 multiplication operations.
17784 @item -fwrapv
17785 @opindex fwrapv
17786 This option instructs the compiler to assume that signed arithmetic
17787 overflow of addition, subtraction and multiplication wraps around
17788 using twos-complement representation.  This flag enables some optimizations
17789 and disables others.  This option is enabled by default for the Java
17790 front-end, as required by the Java language specification.
17792 @item -fexceptions
17793 @opindex fexceptions
17794 Enable exception handling.  Generates extra code needed to propagate
17795 exceptions.  For some targets, this implies GCC will generate frame
17796 unwind information for all functions, which can produce significant data
17797 size overhead, although it does not affect execution.  If you do not
17798 specify this option, GCC will enable it by default for languages like
17799 C++ which normally require exception handling, and disable it for
17800 languages like C that do not normally require it.  However, you may need
17801 to enable this option when compiling C code that needs to interoperate
17802 properly with exception handlers written in C++.  You may also wish to
17803 disable this option if you are compiling older C++ programs that don't
17804 use exception handling.
17806 @item -fnon-call-exceptions
17807 @opindex fnon-call-exceptions
17808 Generate code that allows trapping instructions to throw exceptions.
17809 Note that this requires platform-specific runtime support that does
17810 not exist everywhere.  Moreover, it only allows @emph{trapping}
17811 instructions to throw exceptions, i.e.@: memory references or floating
17812 point instructions.  It does not allow exceptions to be thrown from
17813 arbitrary signal handlers such as @code{SIGALRM}.
17815 @item -funwind-tables
17816 @opindex funwind-tables
17817 Similar to @option{-fexceptions}, except that it will just generate any needed
17818 static data, but will not affect the generated code in any other way.
17819 You will normally not enable this option; instead, a language processor
17820 that needs this handling would enable it on your behalf.
17822 @item -fasynchronous-unwind-tables
17823 @opindex fasynchronous-unwind-tables
17824 Generate unwind table in dwarf2 format, if supported by target machine.  The
17825 table is exact at each instruction boundary, so it can be used for stack
17826 unwinding from asynchronous events (such as debugger or garbage collector).
17828 @item -fpcc-struct-return
17829 @opindex fpcc-struct-return
17830 Return ``short'' @code{struct} and @code{union} values in memory like
17831 longer ones, rather than in registers.  This convention is less
17832 efficient, but it has the advantage of allowing intercallability between
17833 GCC-compiled files and files compiled with other compilers, particularly
17834 the Portable C Compiler (pcc).
17836 The precise convention for returning structures in memory depends
17837 on the target configuration macros.
17839 Short structures and unions are those whose size and alignment match
17840 that of some integer type.
17842 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17843 switch is not binary compatible with code compiled with the
17844 @option{-freg-struct-return} switch.
17845 Use it to conform to a non-default application binary interface.
17847 @item -freg-struct-return
17848 @opindex freg-struct-return
17849 Return @code{struct} and @code{union} values in registers when possible.
17850 This is more efficient for small structures than
17851 @option{-fpcc-struct-return}.
17853 If you specify neither @option{-fpcc-struct-return} nor
17854 @option{-freg-struct-return}, GCC defaults to whichever convention is
17855 standard for the target.  If there is no standard convention, GCC
17856 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17857 the principal compiler.  In those cases, we can choose the standard, and
17858 we chose the more efficient register return alternative.
17860 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17861 switch is not binary compatible with code compiled with the
17862 @option{-fpcc-struct-return} switch.
17863 Use it to conform to a non-default application binary interface.
17865 @item -fshort-enums
17866 @opindex fshort-enums
17867 Allocate to an @code{enum} type only as many bytes as it needs for the
17868 declared range of possible values.  Specifically, the @code{enum} type
17869 will be equivalent to the smallest integer type which has enough room.
17871 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17872 code that is not binary compatible with code generated without that switch.
17873 Use it to conform to a non-default application binary interface.
17875 @item -fshort-double
17876 @opindex fshort-double
17877 Use the same size for @code{double} as for @code{float}.
17879 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17880 code that is not binary compatible with code generated without that switch.
17881 Use it to conform to a non-default application binary interface.
17883 @item -fshort-wchar
17884 @opindex fshort-wchar
17885 Override the underlying type for @samp{wchar_t} to be @samp{short
17886 unsigned int} instead of the default for the target.  This option is
17887 useful for building programs to run under WINE@.
17889 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17890 code that is not binary compatible with code generated without that switch.
17891 Use it to conform to a non-default application binary interface.
17893 @item -fno-common
17894 @opindex fno-common
17895 In C code, controls the placement of uninitialized global variables.
17896 Unix C compilers have traditionally permitted multiple definitions of
17897 such variables in different compilation units by placing the variables
17898 in a common block.
17899 This is the behavior specified by @option{-fcommon}, and is the default
17900 for GCC on most targets.
17901 On the other hand, this behavior is not required by ISO C, and on some
17902 targets may carry a speed or code size penalty on variable references.
17903 The @option{-fno-common} option specifies that the compiler should place
17904 uninitialized global variables in the data section of the object file,
17905 rather than generating them as common blocks.
17906 This has the effect that if the same variable is declared
17907 (without @code{extern}) in two different compilations,
17908 you will get a multiple-definition error when you link them.
17909 In this case, you must compile with @option{-fcommon} instead.
17910 Compiling with @option{-fno-common} is useful on targets for which
17911 it provides better performance, or if you wish to verify that the
17912 program will work on other systems which always treat uninitialized
17913 variable declarations this way.
17915 @item -fno-ident
17916 @opindex fno-ident
17917 Ignore the @samp{#ident} directive.
17919 @item -finhibit-size-directive
17920 @opindex finhibit-size-directive
17921 Don't output a @code{.size} assembler directive, or anything else that
17922 would cause trouble if the function is split in the middle, and the
17923 two halves are placed at locations far apart in memory.  This option is
17924 used when compiling @file{crtstuff.c}; you should not need to use it
17925 for anything else.
17927 @item -fverbose-asm
17928 @opindex fverbose-asm
17929 Put extra commentary information in the generated assembly code to
17930 make it more readable.  This option is generally only of use to those
17931 who actually need to read the generated assembly code (perhaps while
17932 debugging the compiler itself).
17934 @option{-fno-verbose-asm}, the default, causes the
17935 extra information to be omitted and is useful when comparing two assembler
17936 files.
17938 @item -frecord-gcc-switches
17939 @opindex frecord-gcc-switches
17940 This switch causes the command line that was used to invoke the
17941 compiler to be recorded into the object file that is being created.
17942 This switch is only implemented on some targets and the exact format
17943 of the recording is target and binary file format dependent, but it
17944 usually takes the form of a section containing ASCII text.  This
17945 switch is related to the @option{-fverbose-asm} switch, but that
17946 switch only records information in the assembler output file as
17947 comments, so it never reaches the object file.
17949 @item -fpic
17950 @opindex fpic
17951 @cindex global offset table
17952 @cindex PIC
17953 Generate position-independent code (PIC) suitable for use in a shared
17954 library, if supported for the target machine.  Such code accesses all
17955 constant addresses through a global offset table (GOT)@.  The dynamic
17956 loader resolves the GOT entries when the program starts (the dynamic
17957 loader is not part of GCC; it is part of the operating system).  If
17958 the GOT size for the linked executable exceeds a machine-specific
17959 maximum size, you get an error message from the linker indicating that
17960 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17961 instead.  (These maximums are 8k on the SPARC and 32k
17962 on the m68k and RS/6000.  The 386 has no such limit.)
17964 Position-independent code requires special support, and therefore works
17965 only on certain machines.  For the 386, GCC supports PIC for System V
17966 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17967 position-independent.
17969 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17970 are defined to 1.
17972 @item -fPIC
17973 @opindex fPIC
17974 If supported for the target machine, emit position-independent code,
17975 suitable for dynamic linking and avoiding any limit on the size of the
17976 global offset table.  This option makes a difference on the m68k,
17977 PowerPC and SPARC@.
17979 Position-independent code requires special support, and therefore works
17980 only on certain machines.
17982 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17983 are defined to 2.
17985 @item -fpie
17986 @itemx -fPIE
17987 @opindex fpie
17988 @opindex fPIE
17989 These options are similar to @option{-fpic} and @option{-fPIC}, but
17990 generated position independent code can be only linked into executables.
17991 Usually these options are used when @option{-pie} GCC option will be
17992 used during linking.
17994 @option{-fpie} and @option{-fPIE} both define the macros
17995 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17996 for @option{-fpie} and 2 for @option{-fPIE}.
17998 @item -fno-jump-tables
17999 @opindex fno-jump-tables
18000 Do not use jump tables for switch statements even where it would be
18001 more efficient than other code generation strategies.  This option is
18002 of use in conjunction with @option{-fpic} or @option{-fPIC} for
18003 building code which forms part of a dynamic linker and cannot
18004 reference the address of a jump table.  On some targets, jump tables
18005 do not require a GOT and this option is not needed.
18007 @item -ffixed-@var{reg}
18008 @opindex ffixed
18009 Treat the register named @var{reg} as a fixed register; generated code
18010 should never refer to it (except perhaps as a stack pointer, frame
18011 pointer or in some other fixed role).
18013 @var{reg} must be the name of a register.  The register names accepted
18014 are machine-specific and are defined in the @code{REGISTER_NAMES}
18015 macro in the machine description macro file.
18017 This flag does not have a negative form, because it specifies a
18018 three-way choice.
18020 @item -fcall-used-@var{reg}
18021 @opindex fcall-used
18022 Treat the register named @var{reg} as an allocable register that is
18023 clobbered by function calls.  It may be allocated for temporaries or
18024 variables that do not live across a call.  Functions compiled this way
18025 will not save and restore the register @var{reg}.
18027 It is an error to used this flag with the frame pointer or stack pointer.
18028 Use of this flag for other registers that have fixed pervasive roles in
18029 the machine's execution model will produce disastrous results.
18031 This flag does not have a negative form, because it specifies a
18032 three-way choice.
18034 @item -fcall-saved-@var{reg}
18035 @opindex fcall-saved
18036 Treat the register named @var{reg} as an allocable register saved by
18037 functions.  It may be allocated even for temporaries or variables that
18038 live across a call.  Functions compiled this way will save and restore
18039 the register @var{reg} if they use it.
18041 It is an error to used this flag with the frame pointer or stack pointer.
18042 Use of this flag for other registers that have fixed pervasive roles in
18043 the machine's execution model will produce disastrous results.
18045 A different sort of disaster will result from the use of this flag for
18046 a register in which function values may be returned.
18048 This flag does not have a negative form, because it specifies a
18049 three-way choice.
18051 @item -fpack-struct[=@var{n}]
18052 @opindex fpack-struct
18053 Without a value specified, pack all structure members together without
18054 holes.  When a value is specified (which must be a small power of two), pack
18055 structure members according to this value, representing the maximum
18056 alignment (that is, objects with default alignment requirements larger than
18057 this will be output potentially unaligned at the next fitting location.
18059 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
18060 code that is not binary compatible with code generated without that switch.
18061 Additionally, it makes the code suboptimal.
18062 Use it to conform to a non-default application binary interface.
18064 @item -finstrument-functions
18065 @opindex finstrument-functions
18066 Generate instrumentation calls for entry and exit to functions.  Just
18067 after function entry and just before function exit, the following
18068 profiling functions will be called with the address of the current
18069 function and its call site.  (On some platforms,
18070 @code{__builtin_return_address} does not work beyond the current
18071 function, so the call site information may not be available to the
18072 profiling functions otherwise.)
18074 @smallexample
18075 void __cyg_profile_func_enter (void *this_fn,
18076                                void *call_site);
18077 void __cyg_profile_func_exit  (void *this_fn,
18078                                void *call_site);
18079 @end smallexample
18081 The first argument is the address of the start of the current function,
18082 which may be looked up exactly in the symbol table.
18084 This instrumentation is also done for functions expanded inline in other
18085 functions.  The profiling calls will indicate where, conceptually, the
18086 inline function is entered and exited.  This means that addressable
18087 versions of such functions must be available.  If all your uses of a
18088 function are expanded inline, this may mean an additional expansion of
18089 code size.  If you use @samp{extern inline} in your C code, an
18090 addressable version of such functions must be provided.  (This is
18091 normally the case anyways, but if you get lucky and the optimizer always
18092 expands the functions inline, you might have gotten away without
18093 providing static copies.)
18095 A function may be given the attribute @code{no_instrument_function}, in
18096 which case this instrumentation will not be done.  This can be used, for
18097 example, for the profiling functions listed above, high-priority
18098 interrupt routines, and any functions from which the profiling functions
18099 cannot safely be called (perhaps signal handlers, if the profiling
18100 routines generate output or allocate memory).
18102 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
18103 @opindex finstrument-functions-exclude-file-list
18105 Set the list of functions that are excluded from instrumentation (see
18106 the description of @code{-finstrument-functions}).  If the file that
18107 contains a function definition matches with one of @var{file}, then
18108 that function is not instrumented.  The match is done on substrings:
18109 if the @var{file} parameter is a substring of the file name, it is
18110 considered to be a match.
18112 For example:
18114 @smallexample
18115 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
18116 @end smallexample
18118 @noindent
18119 will exclude any inline function defined in files whose pathnames
18120 contain @code{/bits/stl} or @code{include/sys}.
18122 If, for some reason, you want to include letter @code{','} in one of
18123 @var{sym}, write @code{'\,'}. For example,
18124 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
18125 (note the single quote surrounding the option).
18127 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
18128 @opindex finstrument-functions-exclude-function-list
18130 This is similar to @code{-finstrument-functions-exclude-file-list},
18131 but this option sets the list of function names to be excluded from
18132 instrumentation.  The function name to be matched is its user-visible
18133 name, such as @code{vector<int> blah(const vector<int> &)}, not the
18134 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
18135 match is done on substrings: if the @var{sym} parameter is a substring
18136 of the function name, it is considered to be a match.  For C99 and C++
18137 extended identifiers, the function name must be given in UTF-8, not
18138 using universal character names.
18140 @item -fstack-check
18141 @opindex fstack-check
18142 Generate code to verify that you do not go beyond the boundary of the
18143 stack.  You should specify this flag if you are running in an
18144 environment with multiple threads, but only rarely need to specify it in
18145 a single-threaded environment since stack overflow is automatically
18146 detected on nearly all systems if there is only one stack.
18148 Note that this switch does not actually cause checking to be done; the
18149 operating system or the language runtime must do that.  The switch causes
18150 generation of code to ensure that they see the stack being extended.
18152 You can additionally specify a string parameter: @code{no} means no
18153 checking, @code{generic} means force the use of old-style checking,
18154 @code{specific} means use the best checking method and is equivalent
18155 to bare @option{-fstack-check}.
18157 Old-style checking is a generic mechanism that requires no specific
18158 target support in the compiler but comes with the following drawbacks:
18160 @enumerate
18161 @item
18162 Modified allocation strategy for large objects: they will always be
18163 allocated dynamically if their size exceeds a fixed threshold.
18165 @item
18166 Fixed limit on the size of the static frame of functions: when it is
18167 topped by a particular function, stack checking is not reliable and
18168 a warning is issued by the compiler.
18170 @item
18171 Inefficiency: because of both the modified allocation strategy and the
18172 generic implementation, the performances of the code are hampered.
18173 @end enumerate
18175 Note that old-style stack checking is also the fallback method for
18176 @code{specific} if no target support has been added in the compiler.
18178 @item -fstack-limit-register=@var{reg}
18179 @itemx -fstack-limit-symbol=@var{sym}
18180 @itemx -fno-stack-limit
18181 @opindex fstack-limit-register
18182 @opindex fstack-limit-symbol
18183 @opindex fno-stack-limit
18184 Generate code to ensure that the stack does not grow beyond a certain value,
18185 either the value of a register or the address of a symbol.  If the stack
18186 would grow beyond the value, a signal is raised.  For most targets,
18187 the signal is raised before the stack overruns the boundary, so
18188 it is possible to catch the signal without taking special precautions.
18190 For instance, if the stack starts at absolute address @samp{0x80000000}
18191 and grows downwards, you can use the flags
18192 @option{-fstack-limit-symbol=__stack_limit} and
18193 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
18194 of 128KB@.  Note that this may only work with the GNU linker.
18196 @item -fsplit-stack
18197 @opindex fsplit-stack
18198 Generate code to automatically split the stack before it overflows.
18199 The resulting program has a discontiguous stack which can only
18200 overflow if the program is unable to allocate any more memory.  This
18201 is most useful when running threaded programs, as it is no longer
18202 necessary to calculate a good stack size to use for each thread.  This
18203 is currently only implemented for the i386 and x86_64 backends running
18204 GNU/Linux.
18206 When code compiled with @option{-fsplit-stack} calls code compiled
18207 without @option{-fsplit-stack}, there may not be much stack space
18208 available for the latter code to run.  If compiling all code,
18209 including library code, with @option{-fsplit-stack} is not an option,
18210 then the linker can fix up these calls so that the code compiled
18211 without @option{-fsplit-stack} always has a large stack.  Support for
18212 this is implemented in the gold linker in GNU binutils release 2.21
18213 and later.
18215 @item -fleading-underscore
18216 @opindex fleading-underscore
18217 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
18218 change the way C symbols are represented in the object file.  One use
18219 is to help link with legacy assembly code.
18221 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
18222 generate code that is not binary compatible with code generated without that
18223 switch.  Use it to conform to a non-default application binary interface.
18224 Not all targets provide complete support for this switch.
18226 @item -ftls-model=@var{model}
18227 @opindex ftls-model
18228 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
18229 The @var{model} argument should be one of @code{global-dynamic},
18230 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
18232 The default without @option{-fpic} is @code{initial-exec}; with
18233 @option{-fpic} the default is @code{global-dynamic}.
18235 @item -fvisibility=@var{default|internal|hidden|protected}
18236 @opindex fvisibility
18237 Set the default ELF image symbol visibility to the specified option---all
18238 symbols will be marked with this unless overridden within the code.
18239 Using this feature can very substantially improve linking and
18240 load times of shared object libraries, produce more optimized
18241 code, provide near-perfect API export and prevent symbol clashes.
18242 It is @strong{strongly} recommended that you use this in any shared objects
18243 you distribute.
18245 Despite the nomenclature, @code{default} always means public; i.e.,
18246 available to be linked against from outside the shared object.
18247 @code{protected} and @code{internal} are pretty useless in real-world
18248 usage so the only other commonly used option will be @code{hidden}.
18249 The default if @option{-fvisibility} isn't specified is
18250 @code{default}, i.e., make every
18251 symbol public---this causes the same behavior as previous versions of
18252 GCC@.
18254 A good explanation of the benefits offered by ensuring ELF
18255 symbols have the correct visibility is given by ``How To Write
18256 Shared Libraries'' by Ulrich Drepper (which can be found at
18257 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
18258 solution made possible by this option to marking things hidden when
18259 the default is public is to make the default hidden and mark things
18260 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
18261 and @code{__attribute__ ((visibility("default")))} instead of
18262 @code{__declspec(dllexport)} you get almost identical semantics with
18263 identical syntax.  This is a great boon to those working with
18264 cross-platform projects.
18266 For those adding visibility support to existing code, you may find
18267 @samp{#pragma GCC visibility} of use.  This works by you enclosing
18268 the declarations you wish to set visibility for with (for example)
18269 @samp{#pragma GCC visibility push(hidden)} and
18270 @samp{#pragma GCC visibility pop}.
18271 Bear in mind that symbol visibility should be viewed @strong{as
18272 part of the API interface contract} and thus all new code should
18273 always specify visibility when it is not the default; i.e., declarations
18274 only for use within the local DSO should @strong{always} be marked explicitly
18275 as hidden as so to avoid PLT indirection overheads---making this
18276 abundantly clear also aids readability and self-documentation of the code.
18277 Note that due to ISO C++ specification requirements, operator new and
18278 operator delete must always be of default visibility.
18280 Be aware that headers from outside your project, in particular system
18281 headers and headers from any other library you use, may not be
18282 expecting to be compiled with visibility other than the default.  You
18283 may need to explicitly say @samp{#pragma GCC visibility push(default)}
18284 before including any such headers.
18286 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
18287 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
18288 no modifications.  However, this means that calls to @samp{extern}
18289 functions with no explicit visibility will use the PLT, so it is more
18290 effective to use @samp{__attribute ((visibility))} and/or
18291 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
18292 declarations should be treated as hidden.
18294 Note that @samp{-fvisibility} does affect C++ vague linkage
18295 entities. This means that, for instance, an exception class that will
18296 be thrown between DSOs must be explicitly marked with default
18297 visibility so that the @samp{type_info} nodes will be unified between
18298 the DSOs.
18300 An overview of these techniques, their benefits and how to use them
18301 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
18303 @item -fstrict-volatile-bitfields
18304 @opindex fstrict-volatile-bitfields
18305 This option should be used if accesses to volatile bitfields (or other
18306 structure fields, although the compiler usually honors those types
18307 anyway) should use a single access of the width of the
18308 field's type, aligned to a natural alignment if possible.  For
18309 example, targets with memory-mapped peripheral registers might require
18310 all such accesses to be 16 bits wide; with this flag the user could
18311 declare all peripheral bitfields as ``unsigned short'' (assuming short
18312 is 16 bits on these targets) to force GCC to use 16 bit accesses
18313 instead of, perhaps, a more efficient 32 bit access.
18315 If this option is disabled, the compiler will use the most efficient
18316 instruction.  In the previous example, that might be a 32-bit load
18317 instruction, even though that will access bytes that do not contain
18318 any portion of the bitfield, or memory-mapped registers unrelated to
18319 the one being updated.
18321 If the target requires strict alignment, and honoring the field
18322 type would require violating this alignment, a warning is issued.
18323 If the field has @code{packed} attribute, the access is done without
18324 honoring the field type.  If the field doesn't have @code{packed}
18325 attribute, the access is done honoring the field type.  In both cases,
18326 GCC assumes that the user knows something about the target hardware
18327 that it is unaware of.
18329 The default value of this option is determined by the application binary
18330 interface for the target processor.
18332 @end table
18334 @c man end
18336 @node Environment Variables
18337 @section Environment Variables Affecting GCC
18338 @cindex environment variables
18340 @c man begin ENVIRONMENT
18341 This section describes several environment variables that affect how GCC
18342 operates.  Some of them work by specifying directories or prefixes to use
18343 when searching for various kinds of files.  Some are used to specify other
18344 aspects of the compilation environment.
18346 Note that you can also specify places to search using options such as
18347 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
18348 take precedence over places specified using environment variables, which
18349 in turn take precedence over those specified by the configuration of GCC@.
18350 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
18351 GNU Compiler Collection (GCC) Internals}.
18353 @table @env
18354 @item LANG
18355 @itemx LC_CTYPE
18356 @c @itemx LC_COLLATE
18357 @itemx LC_MESSAGES
18358 @c @itemx LC_MONETARY
18359 @c @itemx LC_NUMERIC
18360 @c @itemx LC_TIME
18361 @itemx LC_ALL
18362 @findex LANG
18363 @findex LC_CTYPE
18364 @c @findex LC_COLLATE
18365 @findex LC_MESSAGES
18366 @c @findex LC_MONETARY
18367 @c @findex LC_NUMERIC
18368 @c @findex LC_TIME
18369 @findex LC_ALL
18370 @cindex locale
18371 These environment variables control the way that GCC uses
18372 localization information that allow GCC to work with different
18373 national conventions.  GCC inspects the locale categories
18374 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
18375 so.  These locale categories can be set to any value supported by your
18376 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
18377 Kingdom encoded in UTF-8.
18379 The @env{LC_CTYPE} environment variable specifies character
18380 classification.  GCC uses it to determine the character boundaries in
18381 a string; this is needed for some multibyte encodings that contain quote
18382 and escape characters that would otherwise be interpreted as a string
18383 end or escape.
18385 The @env{LC_MESSAGES} environment variable specifies the language to
18386 use in diagnostic messages.
18388 If the @env{LC_ALL} environment variable is set, it overrides the value
18389 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
18390 and @env{LC_MESSAGES} default to the value of the @env{LANG}
18391 environment variable.  If none of these variables are set, GCC
18392 defaults to traditional C English behavior.
18394 @item TMPDIR
18395 @findex TMPDIR
18396 If @env{TMPDIR} is set, it specifies the directory to use for temporary
18397 files.  GCC uses temporary files to hold the output of one stage of
18398 compilation which is to be used as input to the next stage: for example,
18399 the output of the preprocessor, which is the input to the compiler
18400 proper.
18402 @item GCC_COMPARE_DEBUG
18403 @findex GCC_COMPARE_DEBUG
18404 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
18405 @option{-fcompare-debug} to the compiler driver.  See the documentation
18406 of this option for more details.
18408 @item GCC_EXEC_PREFIX
18409 @findex GCC_EXEC_PREFIX
18410 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
18411 names of the subprograms executed by the compiler.  No slash is added
18412 when this prefix is combined with the name of a subprogram, but you can
18413 specify a prefix that ends with a slash if you wish.
18415 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
18416 an appropriate prefix to use based on the pathname it was invoked with.
18418 If GCC cannot find the subprogram using the specified prefix, it
18419 tries looking in the usual places for the subprogram.
18421 The default value of @env{GCC_EXEC_PREFIX} is
18422 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
18423 the installed compiler. In many cases @var{prefix} is the value
18424 of @code{prefix} when you ran the @file{configure} script.
18426 Other prefixes specified with @option{-B} take precedence over this prefix.
18428 This prefix is also used for finding files such as @file{crt0.o} that are
18429 used for linking.
18431 In addition, the prefix is used in an unusual way in finding the
18432 directories to search for header files.  For each of the standard
18433 directories whose name normally begins with @samp{/usr/local/lib/gcc}
18434 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
18435 replacing that beginning with the specified prefix to produce an
18436 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
18437 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
18438 These alternate directories are searched first; the standard directories
18439 come next. If a standard directory begins with the configured
18440 @var{prefix} then the value of @var{prefix} is replaced by
18441 @env{GCC_EXEC_PREFIX} when looking for header files.
18443 @item COMPILER_PATH
18444 @findex COMPILER_PATH
18445 The value of @env{COMPILER_PATH} is a colon-separated list of
18446 directories, much like @env{PATH}.  GCC tries the directories thus
18447 specified when searching for subprograms, if it can't find the
18448 subprograms using @env{GCC_EXEC_PREFIX}.
18450 @item LIBRARY_PATH
18451 @findex LIBRARY_PATH
18452 The value of @env{LIBRARY_PATH} is a colon-separated list of
18453 directories, much like @env{PATH}.  When configured as a native compiler,
18454 GCC tries the directories thus specified when searching for special
18455 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
18456 using GCC also uses these directories when searching for ordinary
18457 libraries for the @option{-l} option (but directories specified with
18458 @option{-L} come first).
18460 @item LANG
18461 @findex LANG
18462 @cindex locale definition
18463 This variable is used to pass locale information to the compiler.  One way in
18464 which this information is used is to determine the character set to be used
18465 when character literals, string literals and comments are parsed in C and C++.
18466 When the compiler is configured to allow multibyte characters,
18467 the following values for @env{LANG} are recognized:
18469 @table @samp
18470 @item C-JIS
18471 Recognize JIS characters.
18472 @item C-SJIS
18473 Recognize SJIS characters.
18474 @item C-EUCJP
18475 Recognize EUCJP characters.
18476 @end table
18478 If @env{LANG} is not defined, or if it has some other value, then the
18479 compiler will use mblen and mbtowc as defined by the default locale to
18480 recognize and translate multibyte characters.
18481 @end table
18483 @noindent
18484 Some additional environments variables affect the behavior of the
18485 preprocessor.
18487 @include cppenv.texi
18489 @c man end
18491 @node Precompiled Headers
18492 @section Using Precompiled Headers
18493 @cindex precompiled headers
18494 @cindex speed of compilation
18496 Often large projects have many header files that are included in every
18497 source file.  The time the compiler takes to process these header files
18498 over and over again can account for nearly all of the time required to
18499 build the project.  To make builds faster, GCC allows users to
18500 `precompile' a header file; then, if builds can use the precompiled
18501 header file they will be much faster.
18503 To create a precompiled header file, simply compile it as you would any
18504 other file, if necessary using the @option{-x} option to make the driver
18505 treat it as a C or C++ header file.  You will probably want to use a
18506 tool like @command{make} to keep the precompiled header up-to-date when
18507 the headers it contains change.
18509 A precompiled header file will be searched for when @code{#include} is
18510 seen in the compilation.  As it searches for the included file
18511 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
18512 compiler looks for a precompiled header in each directory just before it
18513 looks for the include file in that directory.  The name searched for is
18514 the name specified in the @code{#include} with @samp{.gch} appended.  If
18515 the precompiled header file can't be used, it is ignored.
18517 For instance, if you have @code{#include "all.h"}, and you have
18518 @file{all.h.gch} in the same directory as @file{all.h}, then the
18519 precompiled header file will be used if possible, and the original
18520 header will be used otherwise.
18522 Alternatively, you might decide to put the precompiled header file in a
18523 directory and use @option{-I} to ensure that directory is searched
18524 before (or instead of) the directory containing the original header.
18525 Then, if you want to check that the precompiled header file is always
18526 used, you can put a file of the same name as the original header in this
18527 directory containing an @code{#error} command.
18529 This also works with @option{-include}.  So yet another way to use
18530 precompiled headers, good for projects not designed with precompiled
18531 header files in mind, is to simply take most of the header files used by
18532 a project, include them from another header file, precompile that header
18533 file, and @option{-include} the precompiled header.  If the header files
18534 have guards against multiple inclusion, they will be skipped because
18535 they've already been included (in the precompiled header).
18537 If you need to precompile the same header file for different
18538 languages, targets, or compiler options, you can instead make a
18539 @emph{directory} named like @file{all.h.gch}, and put each precompiled
18540 header in the directory, perhaps using @option{-o}.  It doesn't matter
18541 what you call the files in the directory, every precompiled header in
18542 the directory will be considered.  The first precompiled header
18543 encountered in the directory that is valid for this compilation will
18544 be used; they're searched in no particular order.
18546 There are many other possibilities, limited only by your imagination,
18547 good sense, and the constraints of your build system.
18549 A precompiled header file can be used only when these conditions apply:
18551 @itemize
18552 @item
18553 Only one precompiled header can be used in a particular compilation.
18555 @item
18556 A precompiled header can't be used once the first C token is seen.  You
18557 can have preprocessor directives before a precompiled header; you can
18558 even include a precompiled header from inside another header, so long as
18559 there are no C tokens before the @code{#include}.
18561 @item
18562 The precompiled header file must be produced for the same language as
18563 the current compilation.  You can't use a C precompiled header for a C++
18564 compilation.
18566 @item
18567 The precompiled header file must have been produced by the same compiler
18568 binary as the current compilation is using.
18570 @item
18571 Any macros defined before the precompiled header is included must
18572 either be defined in the same way as when the precompiled header was
18573 generated, or must not affect the precompiled header, which usually
18574 means that they don't appear in the precompiled header at all.
18576 The @option{-D} option is one way to define a macro before a
18577 precompiled header is included; using a @code{#define} can also do it.
18578 There are also some options that define macros implicitly, like
18579 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
18580 defined this way.
18582 @item If debugging information is output when using the precompiled
18583 header, using @option{-g} or similar, the same kind of debugging information
18584 must have been output when building the precompiled header.  However,
18585 a precompiled header built using @option{-g} can be used in a compilation
18586 when no debugging information is being output.
18588 @item The same @option{-m} options must generally be used when building
18589 and using the precompiled header.  @xref{Submodel Options},
18590 for any cases where this rule is relaxed.
18592 @item Each of the following options must be the same when building and using
18593 the precompiled header:
18595 @gccoptlist{-fexceptions}
18597 @item
18598 Some other command-line options starting with @option{-f},
18599 @option{-p}, or @option{-O} must be defined in the same way as when
18600 the precompiled header was generated.  At present, it's not clear
18601 which options are safe to change and which are not; the safest choice
18602 is to use exactly the same options when generating and using the
18603 precompiled header.  The following are known to be safe:
18605 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
18606 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
18607 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
18608 -pedantic-errors}
18610 @end itemize
18612 For all of these except the last, the compiler will automatically
18613 ignore the precompiled header if the conditions aren't met.  If you
18614 find an option combination that doesn't work and doesn't cause the
18615 precompiled header to be ignored, please consider filing a bug report,
18616 see @ref{Bugs}.
18618 If you do use differing options when generating and using the
18619 precompiled header, the actual behavior will be a mixture of the
18620 behavior for the options.  For instance, if you use @option{-g} to
18621 generate the precompiled header but not when using it, you may or may
18622 not get debugging information for routines in the precompiled header.