2012-07-26 Segher Boessenkool <segher@kernel.crashing.org>
[official-gcc.git] / gcc / doc / invoke.texi
bloba5b7f824b1170cb690588392f1d6bd14766a2419
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, 2012
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, 2011,
15 2012
16 Free Software Foundation, Inc.
18 Permission is granted to copy, distribute and/or modify this document
19 under the terms of the GNU Free Documentation License, Version 1.3 or
20 any later version published by the Free Software Foundation; with the
21 Invariant Sections being ``GNU General Public License'' and ``Funding
22 Free Software'', the Front-Cover texts being (a) (see below), and with
23 the Back-Cover Texts being (b) (see below).  A copy of the license is
24 included in the gfdl(7) man page.
26 (a) The FSF's Front-Cover Text is:
28      A GNU Manual
30 (b) The FSF's Back-Cover Text is:
32      You have freedom to copy and modify this GNU Manual, like GNU
33      software.  Copies published by the Free Software Foundation raise
34      funds for GNU development.
35 @c man end
36 @c Set file name and title for the man page.
37 @setfilename gcc
38 @settitle GNU project C and C++ compiler
39 @c man begin SYNOPSIS
40 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
41     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
42     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
43     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
44     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
45     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
46     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
48 Only the most useful options are listed here; see below for the
49 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
50 @c man end
51 @c man begin SEEALSO
52 gpl(7), gfdl(7), fsf-funding(7),
53 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
54 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
55 @file{ld}, @file{binutils} and @file{gdb}.
56 @c man end
57 @c man begin BUGS
58 For instructions on reporting bugs, see
59 @w{@value{BUGURL}}.
60 @c man end
61 @c man begin AUTHOR
62 See the Info entry for @command{gcc}, or
63 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
64 for contributors to GCC@.
65 @c man end
66 @end ignore
68 @node Invoking GCC
69 @chapter GCC Command Options
70 @cindex GCC command options
71 @cindex command options
72 @cindex options, GCC command
74 @c man begin DESCRIPTION
75 When you invoke GCC, it normally does preprocessing, compilation,
76 assembly and linking.  The ``overall options'' allow you to stop this
77 process at an intermediate stage.  For example, the @option{-c} option
78 says not to run the linker.  Then the output consists of object files
79 output by the assembler.
81 Other options are passed on to one stage of processing.  Some options
82 control the preprocessor and others the compiler itself.  Yet other
83 options control the assembler and linker; most of these are not
84 documented here, since you rarely need to use any of them.
86 @cindex C compilation options
87 Most of the command-line options that you can use with GCC are useful
88 for C programs; when an option is only useful with another language
89 (usually C++), the explanation says so explicitly.  If the description
90 for a particular option does not mention a source language, you can use
91 that option with all supported languages.
93 @cindex C++ compilation options
94 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
95 options for compiling C++ programs.
97 @cindex grouping options
98 @cindex options, grouping
99 The @command{gcc} program accepts options and file names as operands.  Many
100 options have multi-letter names; therefore multiple single-letter options
101 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
102 -v}}.
104 @cindex order of options
105 @cindex options, order
106 You can mix options and other arguments.  For the most part, the order
107 you use doesn't matter.  Order does matter when you use several
108 options of the same kind; for example, if you specify @option{-L} more
109 than once, the directories are searched in the order specified.  Also,
110 the placement of the @option{-l} option is significant.
112 Many options have long names starting with @samp{-f} or with
113 @samp{-W}---for example,
114 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
115 these have both positive and negative forms; the negative form of
116 @option{-ffoo} is @option{-fno-foo}.  This manual documents
117 only one of these two forms, whichever one is not the default.
119 @c man end
121 @xref{Option Index}, for an index to GCC's options.
123 @menu
124 * Option Summary::      Brief list of all options, without explanations.
125 * Overall Options::     Controlling the kind of output:
126                         an executable, object files, assembler files,
127                         or preprocessed source.
128 * Invoking G++::        Compiling C++ programs.
129 * C Dialect Options::   Controlling the variant of C language compiled.
130 * C++ Dialect Options:: Variations on C++.
131 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
132                         and Objective-C++.
133 * Language Independent Options:: Controlling how diagnostics should be
134                         formatted.
135 * Warning Options::     How picky should the compiler be?
136 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
137 * Optimize Options::    How much optimization?
138 * Preprocessor Options:: Controlling header files and macro definitions.
139                          Also, getting dependency information for Make.
140 * Assembler Options::   Passing options to the assembler.
141 * Link Options::        Specifying libraries and so on.
142 * Directory Options::   Where to find header files and libraries.
143                         Where to find the compiler executable files.
144 * Spec Files::          How to pass switches to sub-processes.
145 * Target Options::      Running a cross-compiler, or an old version of GCC.
146 * Submodel Options::    Specifying minor hardware or convention variations,
147                         such as 68010 vs 68020.
148 * Code Gen Options::    Specifying conventions for function calls, data layout
149                         and register usage.
150 * Environment Variables:: Env vars that affect GCC.
151 * Precompiled Headers:: Compiling a header once, and using it many times.
152 @end menu
154 @c man begin OPTIONS
156 @node Option Summary
157 @section Option Summary
159 Here is a summary of all the options, grouped by type.  Explanations are
160 in the following sections.
162 @table @emph
163 @item Overall Options
164 @xref{Overall Options,,Options Controlling the Kind of Output}.
165 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
166 -pipe  -pass-exit-codes  @gol
167 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
168 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
169 -fdump-ada-spec@r{[}-slim@r{]} -fdump-go-spec=@var{file}}
171 @item C Language Options
172 @xref{C Dialect Options,,Options Controlling C Dialect}.
173 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
174 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
175 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
176 -fhosted  -ffreestanding -fopenmp -fms-extensions -fplan9-extensions @gol
177 -trigraphs  -traditional  -traditional-cpp @gol
178 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
179 -fsigned-bitfields  -fsigned-char @gol
180 -funsigned-bitfields  -funsigned-char}
182 @item C++ Language Options
183 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
184 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
185 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
186 -fno-elide-constructors @gol
187 -fno-enforce-eh-specs @gol
188 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
189 -fno-implicit-templates @gol
190 -fno-implicit-inline-templates @gol
191 -fno-implement-inlines  -fms-extensions @gol
192 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
193 -fno-optional-diags  -fpermissive @gol
194 -fno-pretty-templates @gol
195 -frepo  -fno-rtti  -fstats  -ftemplate-backtrace-limit=@var{n} @gol
196 -ftemplate-depth=@var{n} @gol
197 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
198 -fno-default-inline  -fvisibility-inlines-hidden @gol
199 -fvisibility-ms-compat @gol
200 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
202 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
203 -Weffc++  -Wstrict-null-sentinel @gol
204 -Wno-non-template-friend  -Wold-style-cast @gol
205 -Woverloaded-virtual  -Wno-pmf-conversions @gol
206 -Wsign-promo}
208 @item Objective-C and Objective-C++ Language Options
209 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
210 Objective-C and Objective-C++ Dialects}.
211 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
212 -fgnu-runtime  -fnext-runtime @gol
213 -fno-nil-receivers @gol
214 -fobjc-abi-version=@var{n} @gol
215 -fobjc-call-cxx-cdtors @gol
216 -fobjc-direct-dispatch @gol
217 -fobjc-exceptions @gol
218 -fobjc-gc @gol
219 -fobjc-nilcheck @gol
220 -fobjc-std=objc1 @gol
221 -freplace-objc-classes @gol
222 -fzero-link @gol
223 -gen-decls @gol
224 -Wassign-intercept @gol
225 -Wno-protocol  -Wselector @gol
226 -Wstrict-selector-match @gol
227 -Wundeclared-selector}
229 @item Language Independent Options
230 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
231 @gccoptlist{-fmessage-length=@var{n}  @gol
232 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
233 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
235 @item Warning Options
236 @xref{Warning Options,,Options to Request or Suppress Warnings}.
237 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
238 -pedantic-errors @gol
239 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
240 -Wno-attributes -Wno-builtin-macro-redefined @gol
241 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
242 -Wchar-subscripts -Wclobbered  -Wcomment @gol
243 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wno-deprecated  @gol
244 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
245 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
246 -Wno-endif-labels -Werror  -Werror=* @gol
247 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
248 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
249 -Wformat-security  -Wformat-y2k @gol
250 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
251 -Wignored-qualifiers @gol
252 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
253 -Winit-self  -Winline -Wmaybe-uninitialized @gol
254 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
255 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
256 -Wlogical-op -Wlong-long @gol
257 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
258 -Wmissing-include-dirs @gol
259 -Wno-mudflap @gol
260 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
261 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
262 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
263 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
264 -Wredundant-decls @gol
265 -Wreturn-type  -Wsequence-point  -Wshadow @gol
266 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
267 -Wstack-usage=@var{len} -Wstrict-aliasing -Wstrict-aliasing=n @gol
268 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
269 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
270 -Wmissing-format-attribute @gol
271 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
272 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
273 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
274 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
275 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
276 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
277 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
278 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
279 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
281 @item C and Objective-C-only Warning Options
282 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
283 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
284 -Wold-style-declaration  -Wold-style-definition @gol
285 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
286 -Wdeclaration-after-statement -Wpointer-sign}
288 @item Debugging Options
289 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
290 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
291 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
292 -fdisable-ipa-@var{pass_name} @gol
293 -fdisable-rtl-@var{pass_name} @gol
294 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
295 -fdisable-tree-@var{pass_name} @gol
296 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
297 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
298 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
299 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
300 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
301 -fdump-passes @gol
302 -fdump-statistics @gol
303 -fdump-tree-all @gol
304 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
305 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
307 -fdump-tree-ch @gol
308 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-nrv -fdump-tree-vect @gol
318 -fdump-tree-sink @gol
319 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
323 -ftree-vectorizer-verbose=@var{n} @gol
324 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
325 -fdump-final-insns=@var{file} @gol
326 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
327 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
328 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
329 -fenable-@var{kind}-@var{pass} @gol
330 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
331 -fdebug-types-section @gol
332 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
333 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
334 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
335 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
336 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
337 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
338 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
339 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
340 -gvms  -gxcoff  -gxcoff+ @gol
341 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
342 -fdebug-prefix-map=@var{old}=@var{new} @gol
343 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
344 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
345 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
346 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
347 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
348 -print-sysroot -print-sysroot-headers-suffix @gol
349 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
351 @item Optimization Options
352 @xref{Optimize Options,,Options that Control Optimization}.
353 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
354 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
355 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
356 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
357 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
358 -fcompare-elim -fcprop-registers -fcrossjumping @gol
359 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
360 -fcx-limited-range @gol
361 -fdata-sections -fdce -fdelayed-branch @gol
362 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
363 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
364 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
365 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
366 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
367 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
368 -fif-conversion2 -findirect-inlining @gol
369 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
370 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg @gol
371 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
372 -fira-algorithm=@var{algorithm} @gol
373 -fira-region=@var{region} @gol
374 -fira-loop-pressure -fno-ira-share-save-slots @gol
375 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
376 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
377 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
378 -floop-parallelize-all -flto -flto-compression-level @gol
379 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
380 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
381 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
382 -fno-default-inline @gol
383 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
384 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
385 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
386 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
387 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
388 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
389 -fprefetch-loop-arrays @gol
390 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
391 -fprofile-generate=@var{path} @gol
392 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
393 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
394 -freorder-blocks-and-partition -freorder-functions @gol
395 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
396 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
397 -fsched-spec-load -fsched-spec-load-dangerous @gol
398 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
399 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
400 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
401 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
402 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
403 -fselective-scheduling -fselective-scheduling2 @gol
404 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
405 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
406 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
407 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
408 -fthread-jumps -ftracer -ftree-bit-ccp @gol
409 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
410 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
411 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
412 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
413 -ftree-loop-if-convert-stores -ftree-loop-im @gol
414 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
415 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
416 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
417 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
418 -ftree-switch-conversion -ftree-tail-merge @gol
419 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
420 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
421 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
422 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
423 -fwhole-program -fwpa -fuse-linker-plugin @gol
424 --param @var{name}=@var{value}
425 -O  -O0  -O1  -O2  -O3  -Os -Ofast}
427 @item Preprocessor Options
428 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
429 @gccoptlist{-A@var{question}=@var{answer} @gol
430 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
431 -C  -dD  -dI  -dM  -dN @gol
432 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
433 -idirafter @var{dir} @gol
434 -include @var{file}  -imacros @var{file} @gol
435 -iprefix @var{file}  -iwithprefix @var{dir} @gol
436 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
437 -imultilib @var{dir} -isysroot @var{dir} @gol
438 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
439 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
440 -remap -trigraphs  -undef  -U@var{macro}  @gol
441 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
443 @item Assembler Option
444 @xref{Assembler Options,,Passing Options to the Assembler}.
445 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
447 @item Linker Options
448 @xref{Link Options,,Options for Linking}.
449 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
450 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
451 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
452 -shared-libgcc  -symbolic @gol
453 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
454 -u @var{symbol}}
456 @item Directory Options
457 @xref{Directory Options,,Options for Directory Search}.
458 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
459 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
460 --sysroot=@var{dir}}
462 @item Machine Dependent Options
463 @xref{Submodel Options,,Hardware Models and Configurations}.
464 @c This list is ordered alphanumerically by subsection name.
465 @c Try and put the significant identifier (CPU or system) first,
466 @c so users have a clue at guessing where the ones they want will be.
468 @emph{Adapteva Epiphany Options}
469 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
470 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
471 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
472 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
473 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
474 -msplit-vecmove-early -m1reg-@var{reg}}
476 @emph{ARM Options}
477 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
478 -mabi=@var{name} @gol
479 -mapcs-stack-check  -mno-apcs-stack-check @gol
480 -mapcs-float  -mno-apcs-float @gol
481 -mapcs-reentrant  -mno-apcs-reentrant @gol
482 -msched-prolog  -mno-sched-prolog @gol
483 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
484 -mfloat-abi=@var{name} @gol
485 -mfp16-format=@var{name}
486 -mthumb-interwork  -mno-thumb-interwork @gol
487 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
488 -mstructure-size-boundary=@var{n} @gol
489 -mabort-on-noreturn @gol
490 -mlong-calls  -mno-long-calls @gol
491 -msingle-pic-base  -mno-single-pic-base @gol
492 -mpic-register=@var{reg} @gol
493 -mnop-fun-dllimport @gol
494 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
495 -mpoke-function-name @gol
496 -mthumb  -marm @gol
497 -mtpcs-frame  -mtpcs-leaf-frame @gol
498 -mcaller-super-interworking  -mcallee-super-interworking @gol
499 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
500 -mword-relocations @gol
501 -mfix-cortex-m3-ldrd @gol
502 -munaligned-access}
504 @emph{AVR Options}
505 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
506 -mcall-prologues -mint8 -mno-interrupts -mrelax -mshort-calls @gol
507 -mstrict-X -mtiny-stack}
509 @emph{Blackfin Options}
510 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
511 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
512 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
513 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
514 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
515 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
516 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
517 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
518 -micplb}
520 @emph{C6X Options}
521 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
522 -msim -msdata=@var{sdata-type}}
524 @emph{CRIS Options}
525 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
526 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
527 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
528 -mstack-align  -mdata-align  -mconst-align @gol
529 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
530 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
531 -mmul-bug-workaround  -mno-mul-bug-workaround}
533 @emph{CR16 Options}
534 @gccoptlist{-mmac @gol
535 -mcr16cplus -mcr16c @gol
536 -msim -mint32 -mbit-ops
537 -mdata-model=@var{model}}
539 @emph{Darwin Options}
540 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
541 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
542 -client_name  -compatibility_version  -current_version @gol
543 -dead_strip @gol
544 -dependency-file  -dylib_file  -dylinker_install_name @gol
545 -dynamic  -dynamiclib  -exported_symbols_list @gol
546 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
547 -force_flat_namespace  -headerpad_max_install_names @gol
548 -iframework @gol
549 -image_base  -init  -install_name  -keep_private_externs @gol
550 -multi_module  -multiply_defined  -multiply_defined_unused @gol
551 -noall_load   -no_dead_strip_inits_and_terms @gol
552 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
553 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
554 -private_bundle  -read_only_relocs  -sectalign @gol
555 -sectobjectsymbols  -whyload  -seg1addr @gol
556 -sectcreate  -sectobjectsymbols  -sectorder @gol
557 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
558 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
559 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
560 -single_module  -static  -sub_library  -sub_umbrella @gol
561 -twolevel_namespace  -umbrella  -undefined @gol
562 -unexported_symbols_list  -weak_reference_mismatches @gol
563 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
564 -mkernel -mone-byte-bool}
566 @emph{DEC Alpha Options}
567 @gccoptlist{-mno-fp-regs  -msoft-float @gol
568 -mieee  -mieee-with-inexact  -mieee-conformant @gol
569 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
570 -mtrap-precision=@var{mode}  -mbuild-constants @gol
571 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
572 -mbwx  -mmax  -mfix  -mcix @gol
573 -mfloat-vax  -mfloat-ieee @gol
574 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
575 -msmall-text  -mlarge-text @gol
576 -mmemory-latency=@var{time}}
578 @emph{FR30 Options}
579 @gccoptlist{-msmall-model -mno-lsim}
581 @emph{FRV Options}
582 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
583 -mhard-float  -msoft-float @gol
584 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
585 -mdouble  -mno-double @gol
586 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
587 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
588 -mlinked-fp  -mlong-calls  -malign-labels @gol
589 -mlibrary-pic  -macc-4  -macc-8 @gol
590 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
591 -moptimize-membar -mno-optimize-membar @gol
592 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
593 -mvliw-branch  -mno-vliw-branch @gol
594 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
595 -mno-nested-cond-exec  -mtomcat-stats @gol
596 -mTLS -mtls @gol
597 -mcpu=@var{cpu}}
599 @emph{GNU/Linux Options}
600 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
601 -tno-android-cc -tno-android-ld}
603 @emph{H8/300 Options}
604 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
606 @emph{HPPA Options}
607 @gccoptlist{-march=@var{architecture-type} @gol
608 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
609 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
610 -mfixed-range=@var{register-range} @gol
611 -mjump-in-delay -mlinker-opt -mlong-calls @gol
612 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
613 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
614 -mno-jump-in-delay  -mno-long-load-store @gol
615 -mno-portable-runtime  -mno-soft-float @gol
616 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
617 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
618 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
619 -munix=@var{unix-std}  -nolibdld  -static  -threads}
621 @emph{i386 and x86-64 Options}
622 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
623 -mfpmath=@var{unit} @gol
624 -masm=@var{dialect}  -mno-fancy-math-387 @gol
625 -mno-fp-ret-in-387  -msoft-float @gol
626 -mno-wide-multiply  -mrtd  -malign-double @gol
627 -mpreferred-stack-boundary=@var{num} @gol
628 -mincoming-stack-boundary=@var{num} @gol
629 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
630 -mrecip -mrecip=@var{opt} @gol
631 -mvzeroupper @gol
632 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
633 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
634 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
635 -mbmi2 -mrtm -mlwp -mthreads @gol
636 -mno-align-stringops  -minline-all-stringops @gol
637 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
638 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
639 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
640 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
641 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
642 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
643 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
644 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
645 -msse2avx -mfentry -m8bit-idiv @gol
646 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
648 @emph{i386 and x86-64 Windows Options}
649 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
650 -mnop-fun-dllimport -mthread @gol
651 -municode -mwin32 -mwindows -fno-set-stack-executable}
653 @emph{IA-64 Options}
654 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
655 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
656 -mconstant-gp  -mauto-pic  -mfused-madd @gol
657 -minline-float-divide-min-latency @gol
658 -minline-float-divide-max-throughput @gol
659 -mno-inline-float-divide @gol
660 -minline-int-divide-min-latency @gol
661 -minline-int-divide-max-throughput  @gol
662 -mno-inline-int-divide @gol
663 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
664 -mno-inline-sqrt @gol
665 -mdwarf2-asm -mearly-stop-bits @gol
666 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
667 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
668 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
669 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
670 -msched-spec-ldc -msched-spec-control-ldc @gol
671 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
672 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
673 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
674 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
676 @emph{LM32 Options}
677 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
678 -msign-extend-enabled -muser-enabled}
680 @emph{M32R/D Options}
681 @gccoptlist{-m32r2 -m32rx -m32r @gol
682 -mdebug @gol
683 -malign-loops -mno-align-loops @gol
684 -missue-rate=@var{number} @gol
685 -mbranch-cost=@var{number} @gol
686 -mmodel=@var{code-size-model-type} @gol
687 -msdata=@var{sdata-type} @gol
688 -mno-flush-func -mflush-func=@var{name} @gol
689 -mno-flush-trap -mflush-trap=@var{number} @gol
690 -G @var{num}}
692 @emph{M32C Options}
693 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
695 @emph{M680x0 Options}
696 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
697 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
698 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
699 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
700 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
701 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
702 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
703 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
704 -mxgot -mno-xgot}
706 @emph{MCore Options}
707 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
708 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
709 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
710 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
711 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
713 @emph{MeP Options}
714 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
715 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
716 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
717 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
718 -mtiny=@var{n}}
720 @emph{MicroBlaze Options}
721 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
722 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
723 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
724 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
725 -mxl-mode-@var{app-model}}
727 @emph{MIPS Options}
728 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
729 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
730 -mips64  -mips64r2 @gol
731 -mips16  -mno-mips16  -mflip-mips16 @gol
732 -minterlink-mips16  -mno-interlink-mips16 @gol
733 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
734 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
735 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
736 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
737 -mmcu -mmno-mcu @gol
738 -mfpu=@var{fpu-type} @gol
739 -msmartmips  -mno-smartmips @gol
740 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
741 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
742 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
743 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
744 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
745 -membedded-data  -mno-embedded-data @gol
746 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
747 -mcode-readable=@var{setting} @gol
748 -msplit-addresses  -mno-split-addresses @gol
749 -mexplicit-relocs  -mno-explicit-relocs @gol
750 -mcheck-zero-division  -mno-check-zero-division @gol
751 -mdivide-traps  -mdivide-breaks @gol
752 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
753 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
754 -mfix-24k -mno-fix-24k @gol
755 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
756 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
757 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
758 -mflush-func=@var{func}  -mno-flush-func @gol
759 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
760 -mfp-exceptions -mno-fp-exceptions @gol
761 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
762 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
764 @emph{MMIX Options}
765 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
766 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
767 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
768 -mno-base-addresses  -msingle-exit  -mno-single-exit}
770 @emph{MN10300 Options}
771 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
772 -mno-am33 -mam33 -mam33-2 -mam34 @gol
773 -mtune=@var{cpu-type} @gol
774 -mreturn-pointer-on-d0 @gol
775 -mno-crt0  -mrelax -mliw -msetlb}
777 @emph{PDP-11 Options}
778 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
779 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
780 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
781 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
782 -mbranch-expensive  -mbranch-cheap @gol
783 -munix-asm  -mdec-asm}
785 @emph{picoChip Options}
786 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
787 -msymbol-as-address -mno-inefficient-warnings}
789 @emph{PowerPC Options}
790 See RS/6000 and PowerPC Options.
792 @emph{RL78 Options}
793 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
795 @emph{RS/6000 and PowerPC Options}
796 @gccoptlist{-mcpu=@var{cpu-type} @gol
797 -mtune=@var{cpu-type} @gol
798 -mcmodel=@var{code-model} @gol
799 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
800 -maltivec  -mno-altivec @gol
801 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
802 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
803 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
804 -mfprnd  -mno-fprnd @gol
805 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
806 -mnew-mnemonics  -mold-mnemonics @gol
807 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
808 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
809 -malign-power  -malign-natural @gol
810 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
811 -msingle-float -mdouble-float -msimple-fpu @gol
812 -mstring  -mno-string  -mupdate  -mno-update @gol
813 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
814 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
815 -mstrict-align  -mno-strict-align  -mrelocatable @gol
816 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
817 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
818 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
819 -mprioritize-restricted-insns=@var{priority} @gol
820 -msched-costly-dep=@var{dependence_type} @gol
821 -minsert-sched-nops=@var{scheme} @gol
822 -mcall-sysv  -mcall-netbsd @gol
823 -maix-struct-return  -msvr4-struct-return @gol
824 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
825 -mblock-move-inline-limit=@var{num} @gol
826 -misel -mno-isel @gol
827 -misel=yes  -misel=no @gol
828 -mspe -mno-spe @gol
829 -mspe=yes  -mspe=no @gol
830 -mpaired @gol
831 -mgen-cell-microcode -mwarn-cell-microcode @gol
832 -mvrsave -mno-vrsave @gol
833 -mmulhw -mno-mulhw @gol
834 -mdlmzb -mno-dlmzb @gol
835 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
836 -mprototype  -mno-prototype @gol
837 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
838 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
839 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
840 -mno-recip-precision @gol
841 -mveclibabi=@var{type} -mfriz -mno-friz @gol
842 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
843 -msave-toc-indirect -mno-save-toc-indirect}
845 @emph{RX Options}
846 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
847 -mcpu=@gol
848 -mbig-endian-data -mlittle-endian-data @gol
849 -msmall-data @gol
850 -msim  -mno-sim@gol
851 -mas100-syntax -mno-as100-syntax@gol
852 -mrelax@gol
853 -mmax-constant-size=@gol
854 -mint-register=@gol
855 -mpid@gol
856 -msave-acc-in-interrupts}
858 @emph{S/390 and zSeries Options}
859 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
860 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
861 -mlong-double-64 -mlong-double-128 @gol
862 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
863 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
864 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
865 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
866 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
868 @emph{Score Options}
869 @gccoptlist{-meb -mel @gol
870 -mnhwloop @gol
871 -muls @gol
872 -mmac @gol
873 -mscore5 -mscore5u -mscore7 -mscore7d}
875 @emph{SH Options}
876 @gccoptlist{-m1  -m2  -m2e @gol
877 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
878 -m3  -m3e @gol
879 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
880 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
881 -m5-64media  -m5-64media-nofpu @gol
882 -m5-32media  -m5-32media-nofpu @gol
883 -m5-compact  -m5-compact-nofpu @gol
884 -mb  -ml  -mdalign  -mrelax @gol
885 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
886 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
887 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
888 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
889 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
890 -maccumulate-outgoing-args -minvalid-symbols -msoft-atomic -mhard-atomic @gol
891 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch -mcbranchdi -mcmpeqdi @gol
892 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
893 -mpretend-cmove -menable-tas}
895 @emph{Solaris 2 Options}
896 @gccoptlist{-mimpure-text  -mno-impure-text @gol
897 -pthreads -pthread}
899 @emph{SPARC Options}
900 @gccoptlist{-mcpu=@var{cpu-type} @gol
901 -mtune=@var{cpu-type} @gol
902 -mcmodel=@var{code-model} @gol
903 -mmemory-model=@var{mem-model} @gol
904 -m32  -m64  -mapp-regs  -mno-app-regs @gol
905 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
906 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
907 -mhard-quad-float  -msoft-quad-float @gol
908 -mlittle-endian @gol
909 -mstack-bias  -mno-stack-bias @gol
910 -munaligned-doubles  -mno-unaligned-doubles @gol
911 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
912 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
913 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
914 -mfix-at697f}
916 @emph{SPU Options}
917 @gccoptlist{-mwarn-reloc -merror-reloc @gol
918 -msafe-dma -munsafe-dma @gol
919 -mbranch-hints @gol
920 -msmall-mem -mlarge-mem -mstdmain @gol
921 -mfixed-range=@var{register-range} @gol
922 -mea32 -mea64 @gol
923 -maddress-space-conversion -mno-address-space-conversion @gol
924 -mcache-size=@var{cache-size} @gol
925 -matomic-updates -mno-atomic-updates}
927 @emph{System V Options}
928 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
930 @emph{TILE-Gx Options}
931 @gccoptlist{-mcpu=CPU -m32 -m64}
933 @emph{TILEPro Options}
934 @gccoptlist{-mcpu=CPU -m32}
936 @emph{V850 Options}
937 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
938 -mprolog-function  -mno-prolog-function  -mspace @gol
939 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
940 -mapp-regs  -mno-app-regs @gol
941 -mdisable-callt  -mno-disable-callt @gol
942 -mv850e2v3 @gol
943 -mv850e2 @gol
944 -mv850e1 -mv850es @gol
945 -mv850e @gol
946 -mv850  -mbig-switch}
948 @emph{VAX Options}
949 @gccoptlist{-mg  -mgnu  -munix}
951 @emph{VMS Options}
952 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
953 -mpointer-size=@var{size}}
955 @emph{VxWorks Options}
956 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
957 -Xbind-lazy  -Xbind-now}
959 @emph{x86-64 Options}
960 See i386 and x86-64 Options.
962 @emph{Xstormy16 Options}
963 @gccoptlist{-msim}
965 @emph{Xtensa Options}
966 @gccoptlist{-mconst16 -mno-const16 @gol
967 -mfused-madd  -mno-fused-madd @gol
968 -mforce-no-pic @gol
969 -mserialize-volatile  -mno-serialize-volatile @gol
970 -mtext-section-literals  -mno-text-section-literals @gol
971 -mtarget-align  -mno-target-align @gol
972 -mlongcalls  -mno-longcalls}
974 @emph{zSeries Options}
975 See S/390 and zSeries Options.
977 @item Code Generation Options
978 @xref{Code Gen Options,,Options for Code Generation Conventions}.
979 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
980 -ffixed-@var{reg}  -fexceptions @gol
981 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
982 -fasynchronous-unwind-tables @gol
983 -finhibit-size-directive  -finstrument-functions @gol
984 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
985 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
986 -fno-common  -fno-ident @gol
987 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
988 -fno-jump-tables @gol
989 -frecord-gcc-switches @gol
990 -freg-struct-return  -fshort-enums @gol
991 -fshort-double  -fshort-wchar @gol
992 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
993 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
994 -fno-stack-limit -fsplit-stack @gol
995 -fleading-underscore  -ftls-model=@var{model} @gol
996 -fstack-reuse=@var{reuse_level} @gol
997 -ftrapv  -fwrapv  -fbounds-check @gol
998 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
999 @end table
1001 @menu
1002 * Overall Options::     Controlling the kind of output:
1003                         an executable, object files, assembler files,
1004                         or preprocessed source.
1005 * C Dialect Options::   Controlling the variant of C language compiled.
1006 * C++ Dialect Options:: Variations on C++.
1007 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1008                         and Objective-C++.
1009 * Language Independent Options:: Controlling how diagnostics should be
1010                         formatted.
1011 * Warning Options::     How picky should the compiler be?
1012 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
1013 * Optimize Options::    How much optimization?
1014 * Preprocessor Options:: Controlling header files and macro definitions.
1015                          Also, getting dependency information for Make.
1016 * Assembler Options::   Passing options to the assembler.
1017 * Link Options::        Specifying libraries and so on.
1018 * Directory Options::   Where to find header files and libraries.
1019                         Where to find the compiler executable files.
1020 * Spec Files::          How to pass switches to sub-processes.
1021 * Target Options::      Running a cross-compiler, or an old version of GCC.
1022 @end menu
1024 @node Overall Options
1025 @section Options Controlling the Kind of Output
1027 Compilation can involve up to four stages: preprocessing, compilation
1028 proper, assembly and linking, always in that order.  GCC is capable of
1029 preprocessing and compiling several files either into several
1030 assembler input files, or into one assembler input file; then each
1031 assembler input file produces an object file, and linking combines all
1032 the object files (those newly compiled, and those specified as input)
1033 into an executable file.
1035 @cindex file name suffix
1036 For any given input file, the file name suffix determines what kind of
1037 compilation is done:
1039 @table @gcctabopt
1040 @item @var{file}.c
1041 C source code that must be preprocessed.
1043 @item @var{file}.i
1044 C source code that should not be preprocessed.
1046 @item @var{file}.ii
1047 C++ source code that should not be preprocessed.
1049 @item @var{file}.m
1050 Objective-C source code.  Note that you must link with the @file{libobjc}
1051 library to make an Objective-C program work.
1053 @item @var{file}.mi
1054 Objective-C source code that should not be preprocessed.
1056 @item @var{file}.mm
1057 @itemx @var{file}.M
1058 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1059 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1060 to a literal capital M@.
1062 @item @var{file}.mii
1063 Objective-C++ source code that should not be preprocessed.
1065 @item @var{file}.h
1066 C, C++, Objective-C or Objective-C++ header file to be turned into a
1067 precompiled header (default), or C, C++ header file to be turned into an
1068 Ada spec (via the @option{-fdump-ada-spec} switch).
1070 @item @var{file}.cc
1071 @itemx @var{file}.cp
1072 @itemx @var{file}.cxx
1073 @itemx @var{file}.cpp
1074 @itemx @var{file}.CPP
1075 @itemx @var{file}.c++
1076 @itemx @var{file}.C
1077 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1078 the last two letters must both be literally @samp{x}.  Likewise,
1079 @samp{.C} refers to a literal capital C@.
1081 @item @var{file}.mm
1082 @itemx @var{file}.M
1083 Objective-C++ source code that must be preprocessed.
1085 @item @var{file}.mii
1086 Objective-C++ source code that should not be preprocessed.
1088 @item @var{file}.hh
1089 @itemx @var{file}.H
1090 @itemx @var{file}.hp
1091 @itemx @var{file}.hxx
1092 @itemx @var{file}.hpp
1093 @itemx @var{file}.HPP
1094 @itemx @var{file}.h++
1095 @itemx @var{file}.tcc
1096 C++ header file to be turned into a precompiled header or Ada spec.
1098 @item @var{file}.f
1099 @itemx @var{file}.for
1100 @itemx @var{file}.ftn
1101 Fixed form Fortran source code that should not be preprocessed.
1103 @item @var{file}.F
1104 @itemx @var{file}.FOR
1105 @itemx @var{file}.fpp
1106 @itemx @var{file}.FPP
1107 @itemx @var{file}.FTN
1108 Fixed form Fortran source code that must be preprocessed (with the traditional
1109 preprocessor).
1111 @item @var{file}.f90
1112 @itemx @var{file}.f95
1113 @itemx @var{file}.f03
1114 @itemx @var{file}.f08
1115 Free form Fortran source code that should not be preprocessed.
1117 @item @var{file}.F90
1118 @itemx @var{file}.F95
1119 @itemx @var{file}.F03
1120 @itemx @var{file}.F08
1121 Free form Fortran source code that must be preprocessed (with the
1122 traditional preprocessor).
1124 @item @var{file}.go
1125 Go source code.
1127 @c FIXME: Descriptions of Java file types.
1128 @c @var{file}.java
1129 @c @var{file}.class
1130 @c @var{file}.zip
1131 @c @var{file}.jar
1133 @item @var{file}.ads
1134 Ada source code file that contains a library unit declaration (a
1135 declaration of a package, subprogram, or generic, or a generic
1136 instantiation), or a library unit renaming declaration (a package,
1137 generic, or subprogram renaming declaration).  Such files are also
1138 called @dfn{specs}.
1140 @item @var{file}.adb
1141 Ada source code file containing a library unit body (a subprogram or
1142 package body).  Such files are also called @dfn{bodies}.
1144 @c GCC also knows about some suffixes for languages not yet included:
1145 @c Pascal:
1146 @c @var{file}.p
1147 @c @var{file}.pas
1148 @c Ratfor:
1149 @c @var{file}.r
1151 @item @var{file}.s
1152 Assembler code.
1154 @item @var{file}.S
1155 @itemx @var{file}.sx
1156 Assembler code that must be preprocessed.
1158 @item @var{other}
1159 An object file to be fed straight into linking.
1160 Any file name with no recognized suffix is treated this way.
1161 @end table
1163 @opindex x
1164 You can specify the input language explicitly with the @option{-x} option:
1166 @table @gcctabopt
1167 @item -x @var{language}
1168 Specify explicitly the @var{language} for the following input files
1169 (rather than letting the compiler choose a default based on the file
1170 name suffix).  This option applies to all following input files until
1171 the next @option{-x} option.  Possible values for @var{language} are:
1172 @smallexample
1173 c  c-header  cpp-output
1174 c++  c++-header  c++-cpp-output
1175 objective-c  objective-c-header  objective-c-cpp-output
1176 objective-c++ objective-c++-header objective-c++-cpp-output
1177 assembler  assembler-with-cpp
1179 f77  f77-cpp-input f95  f95-cpp-input
1181 java
1182 @end smallexample
1184 @item -x none
1185 Turn off any specification of a language, so that subsequent files are
1186 handled according to their file name suffixes (as they are if @option{-x}
1187 has not been used at all).
1189 @item -pass-exit-codes
1190 @opindex pass-exit-codes
1191 Normally the @command{gcc} program exits with the code of 1 if any
1192 phase of the compiler returns a non-success return code.  If you specify
1193 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1194 the numerically highest error produced by any phase returning an error
1195 indication.  The C, C++, and Fortran front ends return 4 if an internal
1196 compiler error is encountered.
1197 @end table
1199 If you only want some of the stages of compilation, you can use
1200 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1201 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1202 @command{gcc} is to stop.  Note that some combinations (for example,
1203 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1205 @table @gcctabopt
1206 @item -c
1207 @opindex c
1208 Compile or assemble the source files, but do not link.  The linking
1209 stage simply is not done.  The ultimate output is in the form of an
1210 object file for each source file.
1212 By default, the object file name for a source file is made by replacing
1213 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1215 Unrecognized input files, not requiring compilation or assembly, are
1216 ignored.
1218 @item -S
1219 @opindex S
1220 Stop after the stage of compilation proper; do not assemble.  The output
1221 is in the form of an assembler code file for each non-assembler input
1222 file specified.
1224 By default, the assembler file name for a source file is made by
1225 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1227 Input files that don't require compilation are ignored.
1229 @item -E
1230 @opindex E
1231 Stop after the preprocessing stage; do not run the compiler proper.  The
1232 output is in the form of preprocessed source code, which is sent to the
1233 standard output.
1235 Input files that don't require preprocessing are ignored.
1237 @cindex output file option
1238 @item -o @var{file}
1239 @opindex o
1240 Place output in file @var{file}.  This applies regardless to whatever
1241 sort of output is being produced, whether it be an executable file,
1242 an object file, an assembler file or preprocessed C code.
1244 If @option{-o} is not specified, the default is to put an executable
1245 file in @file{a.out}, the object file for
1246 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1247 assembler file in @file{@var{source}.s}, a precompiled header file in
1248 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1249 standard output.
1251 @item -v
1252 @opindex v
1253 Print (on standard error output) the commands executed to run the stages
1254 of compilation.  Also print the version number of the compiler driver
1255 program and of the preprocessor and the compiler proper.
1257 @item -###
1258 @opindex ###
1259 Like @option{-v} except the commands are not executed and arguments
1260 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1261 This is useful for shell scripts to capture the driver-generated command lines.
1263 @item -pipe
1264 @opindex pipe
1265 Use pipes rather than temporary files for communication between the
1266 various stages of compilation.  This fails to work on some systems where
1267 the assembler is unable to read from a pipe; but the GNU assembler has
1268 no trouble.
1270 @item --help
1271 @opindex help
1272 Print (on the standard output) a description of the command-line options
1273 understood by @command{gcc}.  If the @option{-v} option is also specified
1274 then @option{--help} is also passed on to the various processes
1275 invoked by @command{gcc}, so that they can display the command-line options
1276 they accept.  If the @option{-Wextra} option has also been specified
1277 (prior to the @option{--help} option), then command-line options that
1278 have no documentation associated with them are also displayed.
1280 @item --target-help
1281 @opindex target-help
1282 Print (on the standard output) a description of target-specific command-line
1283 options for each tool.  For some targets extra target-specific
1284 information may also be printed.
1286 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1287 Print (on the standard output) a description of the command-line
1288 options understood by the compiler that fit into all specified classes
1289 and qualifiers.  These are the supported classes:
1291 @table @asis
1292 @item @samp{optimizers}
1293 Display all of the optimization options supported by the
1294 compiler.
1296 @item @samp{warnings}
1297 Display all of the options controlling warning messages
1298 produced by the compiler.
1300 @item @samp{target}
1301 Display target-specific options.  Unlike the
1302 @option{--target-help} option however, target-specific options of the
1303 linker and assembler are not displayed.  This is because those
1304 tools do not currently support the extended @option{--help=} syntax.
1306 @item @samp{params}
1307 Display the values recognized by the @option{--param}
1308 option.
1310 @item @var{language}
1311 Display the options supported for @var{language}, where
1312 @var{language} is the name of one of the languages supported in this
1313 version of GCC@.
1315 @item @samp{common}
1316 Display the options that are common to all languages.
1317 @end table
1319 These are the supported qualifiers:
1321 @table @asis
1322 @item @samp{undocumented}
1323 Display only those options that are undocumented.
1325 @item @samp{joined}
1326 Display options taking an argument that appears after an equal
1327 sign in the same continuous piece of text, such as:
1328 @samp{--help=target}.
1330 @item @samp{separate}
1331 Display options taking an argument that appears as a separate word
1332 following the original option, such as: @samp{-o output-file}.
1333 @end table
1335 Thus for example to display all the undocumented target-specific
1336 switches supported by the compiler the following can be used:
1338 @smallexample
1339 --help=target,undocumented
1340 @end smallexample
1342 The sense of a qualifier can be inverted by prefixing it with the
1343 @samp{^} character, so for example to display all binary warning
1344 options (i.e., ones that are either on or off and that do not take an
1345 argument) that have a description, use:
1347 @smallexample
1348 --help=warnings,^joined,^undocumented
1349 @end smallexample
1351 The argument to @option{--help=} should not consist solely of inverted
1352 qualifiers.
1354 Combining several classes is possible, although this usually
1355 restricts the output by so much that there is nothing to display.  One
1356 case where it does work however is when one of the classes is
1357 @var{target}.  So for example to display all the target-specific
1358 optimization options the following can be used:
1360 @smallexample
1361 --help=target,optimizers
1362 @end smallexample
1364 The @option{--help=} option can be repeated on the command line.  Each
1365 successive use displays its requested class of options, skipping
1366 those that have already been displayed.
1368 If the @option{-Q} option appears on the command line before the
1369 @option{--help=} option, then the descriptive text displayed by
1370 @option{--help=} is changed.  Instead of describing the displayed
1371 options, an indication is given as to whether the option is enabled,
1372 disabled or set to a specific value (assuming that the compiler
1373 knows this at the point where the @option{--help=} option is used).
1375 Here is a truncated example from the ARM port of @command{gcc}:
1377 @smallexample
1378   % gcc -Q -mabi=2 --help=target -c
1379   The following options are target specific:
1380   -mabi=                                2
1381   -mabort-on-noreturn                   [disabled]
1382   -mapcs                                [disabled]
1383 @end smallexample
1385 The output is sensitive to the effects of previous command-line
1386 options, so for example it is possible to find out which optimizations
1387 are enabled at @option{-O2} by using:
1389 @smallexample
1390 -Q -O2 --help=optimizers
1391 @end smallexample
1393 Alternatively you can discover which binary optimizations are enabled
1394 by @option{-O3} by using:
1396 @smallexample
1397 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1398 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1399 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1400 @end smallexample
1402 @item -no-canonical-prefixes
1403 @opindex no-canonical-prefixes
1404 Do not expand any symbolic links, resolve references to @samp{/../}
1405 or @samp{/./}, or make the path absolute when generating a relative
1406 prefix.
1408 @item --version
1409 @opindex version
1410 Display the version number and copyrights of the invoked GCC@.
1412 @item -wrapper
1413 @opindex wrapper
1414 Invoke all subcommands under a wrapper program.  The name of the
1415 wrapper program and its parameters are passed as a comma separated
1416 list.
1418 @smallexample
1419 gcc -c t.c -wrapper gdb,--args
1420 @end smallexample
1422 @noindent
1423 This invokes all subprograms of @command{gcc} under
1424 @samp{gdb --args}, thus the invocation of @command{cc1} is
1425 @samp{gdb --args cc1 @dots{}}.
1427 @item -fplugin=@var{name}.so
1428 Load the plugin code in file @var{name}.so, assumed to be a
1429 shared object to be dlopen'd by the compiler.  The base name of
1430 the shared object file is used to identify the plugin for the
1431 purposes of argument parsing (See
1432 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1433 Each plugin should define the callback functions specified in the
1434 Plugins API.
1436 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1437 Define an argument called @var{key} with a value of @var{value}
1438 for the plugin called @var{name}.
1440 @item -fdump-ada-spec@r{[}-slim@r{]}
1441 For C and C++ source and include files, generate corresponding Ada
1442 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1443 GNAT User's Guide}, which provides detailed documentation on this feature.
1445 @item -fdump-go-spec=@var{file}
1446 For input files in any language, generate corresponding Go
1447 declarations in @var{file}.  This generates Go @code{const},
1448 @code{type}, @code{var}, and @code{func} declarations which may be a
1449 useful way to start writing a Go interface to code written in some
1450 other language.
1452 @include @value{srcdir}/../libiberty/at-file.texi
1453 @end table
1455 @node Invoking G++
1456 @section Compiling C++ Programs
1458 @cindex suffixes for C++ source
1459 @cindex C++ source file suffixes
1460 C++ source files conventionally use one of the suffixes @samp{.C},
1461 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1462 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1463 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1464 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1465 files with these names and compiles them as C++ programs even if you
1466 call the compiler the same way as for compiling C programs (usually
1467 with the name @command{gcc}).
1469 @findex g++
1470 @findex c++
1471 However, the use of @command{gcc} does not add the C++ library.
1472 @command{g++} is a program that calls GCC and treats @samp{.c},
1473 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1474 files unless @option{-x} is used, and automatically specifies linking
1475 against the C++ library.  This program is also useful when
1476 precompiling a C header file with a @samp{.h} extension for use in C++
1477 compilations.  On many systems, @command{g++} is also installed with
1478 the name @command{c++}.
1480 @cindex invoking @command{g++}
1481 When you compile C++ programs, you may specify many of the same
1482 command-line options that you use for compiling programs in any
1483 language; or command-line options meaningful for C and related
1484 languages; or options that are meaningful only for C++ programs.
1485 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1486 explanations of options for languages related to C@.
1487 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1488 explanations of options that are meaningful only for C++ programs.
1490 @node C Dialect Options
1491 @section Options Controlling C Dialect
1492 @cindex dialect options
1493 @cindex language dialect options
1494 @cindex options, dialect
1496 The following options control the dialect of C (or languages derived
1497 from C, such as C++, Objective-C and Objective-C++) that the compiler
1498 accepts:
1500 @table @gcctabopt
1501 @cindex ANSI support
1502 @cindex ISO support
1503 @item -ansi
1504 @opindex ansi
1505 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1506 equivalent to @option{-std=c++98}.
1508 This turns off certain features of GCC that are incompatible with ISO
1509 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1510 such as the @code{asm} and @code{typeof} keywords, and
1511 predefined macros such as @code{unix} and @code{vax} that identify the
1512 type of system you are using.  It also enables the undesirable and
1513 rarely used ISO trigraph feature.  For the C compiler,
1514 it disables recognition of C++ style @samp{//} comments as well as
1515 the @code{inline} keyword.
1517 The alternate keywords @code{__asm__}, @code{__extension__},
1518 @code{__inline__} and @code{__typeof__} continue to work despite
1519 @option{-ansi}.  You would not want to use them in an ISO C program, of
1520 course, but it is useful to put them in header files that might be included
1521 in compilations done with @option{-ansi}.  Alternate predefined macros
1522 such as @code{__unix__} and @code{__vax__} are also available, with or
1523 without @option{-ansi}.
1525 The @option{-ansi} option does not cause non-ISO programs to be
1526 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1527 addition to @option{-ansi}.  @xref{Warning Options}.
1529 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1530 option is used.  Some header files may notice this macro and refrain
1531 from declaring certain functions or defining certain macros that the
1532 ISO standard doesn't call for; this is to avoid interfering with any
1533 programs that might use these names for other things.
1535 Functions that are normally built in but do not have semantics
1536 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1537 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1538 built-in functions provided by GCC}, for details of the functions
1539 affected.
1541 @item -std=
1542 @opindex std
1543 Determine the language standard. @xref{Standards,,Language Standards
1544 Supported by GCC}, for details of these standard versions.  This option
1545 is currently only supported when compiling C or C++.
1547 The compiler can accept several base standards, such as @samp{c90} or
1548 @samp{c++98}, and GNU dialects of those standards, such as
1549 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1550 compiler accepts all programs following that standard plus those
1551 using GNU extensions that do not contradict it.  For example,
1552 @option{-std=c90} turns off certain features of GCC that are
1553 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1554 keywords, but not other GNU extensions that do not have a meaning in
1555 ISO C90, such as omitting the middle term of a @code{?:}
1556 expression. On the other hand, by specifying a GNU dialect of a
1557 standard, all features the compiler support are enabled, even when
1558 those features change the meaning of the base standard and some
1559 strict-conforming programs may be rejected.  The particular standard
1560 is used by @option{-Wpedantic} to identify which features are GNU
1561 extensions given that version of the standard. For example
1562 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1563 comments, while @option{-std=gnu99 -Wpedantic} does not.
1565 A value for this option must be provided; possible values are
1567 @table @samp
1568 @item c90
1569 @itemx c89
1570 @itemx iso9899:1990
1571 Support all ISO C90 programs (certain GNU extensions that conflict
1572 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1574 @item iso9899:199409
1575 ISO C90 as modified in amendment 1.
1577 @item c99
1578 @itemx c9x
1579 @itemx iso9899:1999
1580 @itemx iso9899:199x
1581 ISO C99.  Note that this standard is not yet fully supported; see
1582 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1583 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1585 @item c11
1586 @itemx c1x
1587 @itemx iso9899:2011
1588 ISO C11, the 2011 revision of the ISO C standard.
1589 Support is incomplete and experimental.  The name @samp{c1x} is
1590 deprecated.
1592 @item gnu90
1593 @itemx gnu89
1594 GNU dialect of ISO C90 (including some C99 features). This
1595 is the default for C code.
1597 @item gnu99
1598 @itemx gnu9x
1599 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1600 this will become the default.  The name @samp{gnu9x} is deprecated.
1602 @item gnu11
1603 @item gnu1x
1604 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1605 name @samp{gnu1x} is deprecated.
1607 @item c++98
1608 @itemx c++03
1609 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1610 additional defect reports. Same as @option{-ansi} for C++ code.
1612 @item gnu++98
1613 @itemx gnu++03
1614 GNU dialect of @option{-std=c++98}.  This is the default for
1615 C++ code.
1617 @item c++11
1618 @itemx c++0x
1619 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1620 experimental, and may change in incompatible ways in future releases.
1621 The name @samp{c++0x} is deprecated.
1623 @item gnu++11
1624 @itemx gnu++0x
1625 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1626 experimental, and may change in incompatible ways in future releases.
1627 The name @samp{gnu++0x} is deprecated.
1629 @item c++1y
1630 The next revision of the ISO C++ standard, tentatively planned for
1631 2017.  Support is highly experimental, and will almost certainly
1632 change in incompatible ways in future releases.
1634 @item gnu++1y
1635 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1636 and will almost certainly change in incompatible ways in future
1637 releases.
1638 @end table
1640 @item -fgnu89-inline
1641 @opindex fgnu89-inline
1642 The option @option{-fgnu89-inline} tells GCC to use the traditional
1643 GNU semantics for @code{inline} functions when in C99 mode.
1644 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1645 is accepted and ignored by GCC versions 4.1.3 up to but not including
1646 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1647 C99 mode.  Using this option is roughly equivalent to adding the
1648 @code{gnu_inline} function attribute to all inline functions
1649 (@pxref{Function Attributes}).
1651 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1652 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1653 specifies the default behavior).  This option was first supported in
1654 GCC 4.3.  This option is not supported in @option{-std=c90} or
1655 @option{-std=gnu90} mode.
1657 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1658 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1659 in effect for @code{inline} functions.  @xref{Common Predefined
1660 Macros,,,cpp,The C Preprocessor}.
1662 @item -aux-info @var{filename}
1663 @opindex aux-info
1664 Output to the given filename prototyped declarations for all functions
1665 declared and/or defined in a translation unit, including those in header
1666 files.  This option is silently ignored in any language other than C@.
1668 Besides declarations, the file indicates, in comments, the origin of
1669 each declaration (source file and line), whether the declaration was
1670 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1671 @samp{O} for old, respectively, in the first character after the line
1672 number and the colon), and whether it came from a declaration or a
1673 definition (@samp{C} or @samp{F}, respectively, in the following
1674 character).  In the case of function definitions, a K&R-style list of
1675 arguments followed by their declarations is also provided, inside
1676 comments, after the declaration.
1678 @item -fallow-parameterless-variadic-functions
1679 Accept variadic functions without named parameters.
1681 Although it is possible to define such a function, this is not very
1682 useful as it is not possible to read the arguments.  This is only
1683 supported for C as this construct is allowed by C++.
1685 @item -fno-asm
1686 @opindex fno-asm
1687 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1688 keyword, so that code can use these words as identifiers.  You can use
1689 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1690 instead.  @option{-ansi} implies @option{-fno-asm}.
1692 In C++, this switch only affects the @code{typeof} keyword, since
1693 @code{asm} and @code{inline} are standard keywords.  You may want to
1694 use the @option{-fno-gnu-keywords} flag instead, which has the same
1695 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1696 switch only affects the @code{asm} and @code{typeof} keywords, since
1697 @code{inline} is a standard keyword in ISO C99.
1699 @item -fno-builtin
1700 @itemx -fno-builtin-@var{function}
1701 @opindex fno-builtin
1702 @cindex built-in functions
1703 Don't recognize built-in functions that do not begin with
1704 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1705 functions provided by GCC}, for details of the functions affected,
1706 including those which are not built-in functions when @option{-ansi} or
1707 @option{-std} options for strict ISO C conformance are used because they
1708 do not have an ISO standard meaning.
1710 GCC normally generates special code to handle certain built-in functions
1711 more efficiently; for instance, calls to @code{alloca} may become single
1712 instructions which adjust the stack directly, and calls to @code{memcpy}
1713 may become inline copy loops.  The resulting code is often both smaller
1714 and faster, but since the function calls no longer appear as such, you
1715 cannot set a breakpoint on those calls, nor can you change the behavior
1716 of the functions by linking with a different library.  In addition,
1717 when a function is recognized as a built-in function, GCC may use
1718 information about that function to warn about problems with calls to
1719 that function, or to generate more efficient code, even if the
1720 resulting code still contains calls to that function.  For example,
1721 warnings are given with @option{-Wformat} for bad calls to
1722 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1723 known not to modify global memory.
1725 With the @option{-fno-builtin-@var{function}} option
1726 only the built-in function @var{function} is
1727 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1728 function is named that is not built-in in this version of GCC, this
1729 option is ignored.  There is no corresponding
1730 @option{-fbuiltin-@var{function}} option; if you wish to enable
1731 built-in functions selectively when using @option{-fno-builtin} or
1732 @option{-ffreestanding}, you may define macros such as:
1734 @smallexample
1735 #define abs(n)          __builtin_abs ((n))
1736 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1737 @end smallexample
1739 @item -fhosted
1740 @opindex fhosted
1741 @cindex hosted environment
1743 Assert that compilation takes place in a hosted environment.  This implies
1744 @option{-fbuiltin}.  A hosted environment is one in which the
1745 entire standard library is available, and in which @code{main} has a return
1746 type of @code{int}.  Examples are nearly everything except a kernel.
1747 This is equivalent to @option{-fno-freestanding}.
1749 @item -ffreestanding
1750 @opindex ffreestanding
1751 @cindex hosted environment
1753 Assert that compilation takes place in a freestanding environment.  This
1754 implies @option{-fno-builtin}.  A freestanding environment
1755 is one in which the standard library may not exist, and program startup may
1756 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1757 This is equivalent to @option{-fno-hosted}.
1759 @xref{Standards,,Language Standards Supported by GCC}, for details of
1760 freestanding and hosted environments.
1762 @item -fopenmp
1763 @opindex fopenmp
1764 @cindex OpenMP parallel
1765 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1766 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1767 compiler generates parallel code according to the OpenMP Application
1768 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1769 implies @option{-pthread}, and thus is only supported on targets that
1770 have support for @option{-pthread}.
1772 @item -fgnu-tm
1773 @opindex fgnu-tm
1774 When the option @option{-fgnu-tm} is specified, the compiler
1775 generates code for the Linux variant of Intel's current Transactional
1776 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1777 an experimental feature whose interface may change in future versions
1778 of GCC, as the official specification changes.  Please note that not
1779 all architectures are supported for this feature.
1781 For more information on GCC's support for transactional memory,
1782 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1783 Transactional Memory Library}.
1785 Note that the transactional memory feature is not supported with
1786 non-call exceptions (@option{-fnon-call-exceptions}).
1788 @item -fms-extensions
1789 @opindex fms-extensions
1790 Accept some non-standard constructs used in Microsoft header files.
1792 In C++ code, this allows member names in structures to be similar
1793 to previous types declarations.
1795 @smallexample
1796 typedef int UOW;
1797 struct ABC @{
1798   UOW UOW;
1800 @end smallexample
1802 Some cases of unnamed fields in structures and unions are only
1803 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1804 fields within structs/unions}, for details.
1806 @item -fplan9-extensions
1807 Accept some non-standard constructs used in Plan 9 code.
1809 This enables @option{-fms-extensions}, permits passing pointers to
1810 structures with anonymous fields to functions that expect pointers to
1811 elements of the type of the field, and permits referring to anonymous
1812 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1813 struct/union fields within structs/unions}, for details.  This is only
1814 supported for C, not C++.
1816 @item -trigraphs
1817 @opindex trigraphs
1818 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1819 options for strict ISO C conformance) implies @option{-trigraphs}.
1821 @cindex traditional C language
1822 @cindex C language, traditional
1823 @item -traditional
1824 @itemx -traditional-cpp
1825 @opindex traditional-cpp
1826 @opindex traditional
1827 Formerly, these options caused GCC to attempt to emulate a pre-standard
1828 C compiler.  They are now only supported with the @option{-E} switch.
1829 The preprocessor continues to support a pre-standard mode.  See the GNU
1830 CPP manual for details.
1832 @item -fcond-mismatch
1833 @opindex fcond-mismatch
1834 Allow conditional expressions with mismatched types in the second and
1835 third arguments.  The value of such an expression is void.  This option
1836 is not supported for C++.
1838 @item -flax-vector-conversions
1839 @opindex flax-vector-conversions
1840 Allow implicit conversions between vectors with differing numbers of
1841 elements and/or incompatible element types.  This option should not be
1842 used for new code.
1844 @item -funsigned-char
1845 @opindex funsigned-char
1846 Let the type @code{char} be unsigned, like @code{unsigned char}.
1848 Each kind of machine has a default for what @code{char} should
1849 be.  It is either like @code{unsigned char} by default or like
1850 @code{signed char} by default.
1852 Ideally, a portable program should always use @code{signed char} or
1853 @code{unsigned char} when it depends on the signedness of an object.
1854 But many programs have been written to use plain @code{char} and
1855 expect it to be signed, or expect it to be unsigned, depending on the
1856 machines they were written for.  This option, and its inverse, let you
1857 make such a program work with the opposite default.
1859 The type @code{char} is always a distinct type from each of
1860 @code{signed char} or @code{unsigned char}, even though its behavior
1861 is always just like one of those two.
1863 @item -fsigned-char
1864 @opindex fsigned-char
1865 Let the type @code{char} be signed, like @code{signed char}.
1867 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1868 the negative form of @option{-funsigned-char}.  Likewise, the option
1869 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1871 @item -fsigned-bitfields
1872 @itemx -funsigned-bitfields
1873 @itemx -fno-signed-bitfields
1874 @itemx -fno-unsigned-bitfields
1875 @opindex fsigned-bitfields
1876 @opindex funsigned-bitfields
1877 @opindex fno-signed-bitfields
1878 @opindex fno-unsigned-bitfields
1879 These options control whether a bit-field is signed or unsigned, when the
1880 declaration does not use either @code{signed} or @code{unsigned}.  By
1881 default, such a bit-field is signed, because this is consistent: the
1882 basic integer types such as @code{int} are signed types.
1883 @end table
1885 @node C++ Dialect Options
1886 @section Options Controlling C++ Dialect
1888 @cindex compiler options, C++
1889 @cindex C++ options, command-line
1890 @cindex options, C++
1891 This section describes the command-line options that are only meaningful
1892 for C++ programs; but you can also use most of the GNU compiler options
1893 regardless of what language your program is in.  For example, you
1894 might compile a file @code{firstClass.C} like this:
1896 @smallexample
1897 g++ -g -frepo -O -c firstClass.C
1898 @end smallexample
1900 @noindent
1901 In this example, only @option{-frepo} is an option meant
1902 only for C++ programs; you can use the other options with any
1903 language supported by GCC@.
1905 Here is a list of options that are @emph{only} for compiling C++ programs:
1907 @table @gcctabopt
1909 @item -fabi-version=@var{n}
1910 @opindex fabi-version
1911 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1912 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1913 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1914 the version that conforms most closely to the C++ ABI specification.
1915 Therefore, the ABI obtained using version 0 will change as ABI bugs
1916 are fixed.
1918 The default is version 2.
1920 Version 3 corrects an error in mangling a constant address as a
1921 template argument.
1923 Version 4, which first appeared in G++ 4.5, implements a standard
1924 mangling for vector types.
1926 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1927 attribute const/volatile on function pointer types, decltype of a
1928 plain decl, and use of a function parameter in the declaration of
1929 another parameter.
1931 Version 6, which first appeared in G++ 4.7, corrects the promotion
1932 behavior of C++11 scoped enums and the mangling of template argument
1933 packs, const/static_cast, prefix ++ and --, and a class scope function
1934 used as a template argument.
1936 See also @option{-Wabi}.
1938 @item -fno-access-control
1939 @opindex fno-access-control
1940 Turn off all access checking.  This switch is mainly useful for working
1941 around bugs in the access control code.
1943 @item -fcheck-new
1944 @opindex fcheck-new
1945 Check that the pointer returned by @code{operator new} is non-null
1946 before attempting to modify the storage allocated.  This check is
1947 normally unnecessary because the C++ standard specifies that
1948 @code{operator new} only returns @code{0} if it is declared
1949 @samp{throw()}, in which case the compiler always checks the
1950 return value even without this option.  In all other cases, when
1951 @code{operator new} has a non-empty exception specification, memory
1952 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1953 @samp{new (nothrow)}.
1955 @item -fconstexpr-depth=@var{n}
1956 @opindex fconstexpr-depth
1957 Set the maximum nested evaluation depth for C++11 constexpr functions
1958 to @var{n}.  A limit is needed to detect endless recursion during
1959 constant expression evaluation.  The minimum specified by the standard
1960 is 512.
1962 @item -fdeduce-init-list
1963 @opindex fdeduce-init-list
1964 Enable deduction of a template type parameter as
1965 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
1967 @smallexample
1968 template <class T> auto forward(T t) -> decltype (realfn (t))
1970   return realfn (t);
1973 void f()
1975   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1977 @end smallexample
1979 This deduction was implemented as a possible extension to the
1980 originally proposed semantics for the C++11 standard, but was not part
1981 of the final standard, so it is disabled by default.  This option is
1982 deprecated, and may be removed in a future version of G++.
1984 @item -ffriend-injection
1985 @opindex ffriend-injection
1986 Inject friend functions into the enclosing namespace, so that they are
1987 visible outside the scope of the class in which they are declared.
1988 Friend functions were documented to work this way in the old Annotated
1989 C++ Reference Manual, and versions of G++ before 4.1 always worked
1990 that way.  However, in ISO C++ a friend function that is not declared
1991 in an enclosing scope can only be found using argument dependent
1992 lookup.  This option causes friends to be injected as they were in
1993 earlier releases.
1995 This option is for compatibility, and may be removed in a future
1996 release of G++.
1998 @item -fno-elide-constructors
1999 @opindex fno-elide-constructors
2000 The C++ standard allows an implementation to omit creating a temporary
2001 that is only used to initialize another object of the same type.
2002 Specifying this option disables that optimization, and forces G++ to
2003 call the copy constructor in all cases.
2005 @item -fno-enforce-eh-specs
2006 @opindex fno-enforce-eh-specs
2007 Don't generate code to check for violation of exception specifications
2008 at run time.  This option violates the C++ standard, but may be useful
2009 for reducing code size in production builds, much like defining
2010 @samp{NDEBUG}.  This does not give user code permission to throw
2011 exceptions in violation of the exception specifications; the compiler
2012 still optimizes based on the specifications, so throwing an
2013 unexpected exception results in undefined behavior at run time.
2015 @item -ffor-scope
2016 @itemx -fno-for-scope
2017 @opindex ffor-scope
2018 @opindex fno-for-scope
2019 If @option{-ffor-scope} is specified, the scope of variables declared in
2020 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2021 as specified by the C++ standard.
2022 If @option{-fno-for-scope} is specified, the scope of variables declared in
2023 a @i{for-init-statement} extends to the end of the enclosing scope,
2024 as was the case in old versions of G++, and other (traditional)
2025 implementations of C++.
2027 The default if neither flag is given to follow the standard,
2028 but to allow and give a warning for old-style code that would
2029 otherwise be invalid, or have different behavior.
2031 @item -fno-gnu-keywords
2032 @opindex fno-gnu-keywords
2033 Do not recognize @code{typeof} as a keyword, so that code can use this
2034 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2035 @option{-ansi} implies @option{-fno-gnu-keywords}.
2037 @item -fno-implicit-templates
2038 @opindex fno-implicit-templates
2039 Never emit code for non-inline templates that are instantiated
2040 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2041 @xref{Template Instantiation}, for more information.
2043 @item -fno-implicit-inline-templates
2044 @opindex fno-implicit-inline-templates
2045 Don't emit code for implicit instantiations of inline templates, either.
2046 The default is to handle inlines differently so that compiles with and
2047 without optimization need the same set of explicit instantiations.
2049 @item -fno-implement-inlines
2050 @opindex fno-implement-inlines
2051 To save space, do not emit out-of-line copies of inline functions
2052 controlled by @samp{#pragma implementation}.  This causes linker
2053 errors if these functions are not inlined everywhere they are called.
2055 @item -fms-extensions
2056 @opindex fms-extensions
2057 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2058 int and getting a pointer to member function via non-standard syntax.
2060 @item -fno-nonansi-builtins
2061 @opindex fno-nonansi-builtins
2062 Disable built-in declarations of functions that are not mandated by
2063 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2064 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2066 @item -fnothrow-opt
2067 @opindex fnothrow-opt
2068 Treat a @code{throw()} exception specification as if it were a
2069 @code{noexcept} specification to reduce or eliminate the text size
2070 overhead relative to a function with no exception specification.  If
2071 the function has local variables of types with non-trivial
2072 destructors, the exception specification actually makes the
2073 function smaller because the EH cleanups for those variables can be
2074 optimized away.  The semantic effect is that an exception thrown out of
2075 a function with such an exception specification results in a call
2076 to @code{terminate} rather than @code{unexpected}.
2078 @item -fno-operator-names
2079 @opindex fno-operator-names
2080 Do not treat the operator name keywords @code{and}, @code{bitand},
2081 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2082 synonyms as keywords.
2084 @item -fno-optional-diags
2085 @opindex fno-optional-diags
2086 Disable diagnostics that the standard says a compiler does not need to
2087 issue.  Currently, the only such diagnostic issued by G++ is the one for
2088 a name having multiple meanings within a class.
2090 @item -fpermissive
2091 @opindex fpermissive
2092 Downgrade some diagnostics about nonconformant code from errors to
2093 warnings.  Thus, using @option{-fpermissive} allows some
2094 nonconforming code to compile.
2096 @item -fno-pretty-templates
2097 @opindex fno-pretty-templates
2098 When an error message refers to a specialization of a function
2099 template, the compiler normally prints the signature of the
2100 template followed by the template arguments and any typedefs or
2101 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2102 rather than @code{void f(int)}) so that it's clear which template is
2103 involved.  When an error message refers to a specialization of a class
2104 template, the compiler omits any template arguments that match
2105 the default template arguments for that template.  If either of these
2106 behaviors make it harder to understand the error message rather than
2107 easier, you can use @option{-fno-pretty-templates} to disable them.
2109 @item -frepo
2110 @opindex frepo
2111 Enable automatic template instantiation at link time.  This option also
2112 implies @option{-fno-implicit-templates}.  @xref{Template
2113 Instantiation}, for more information.
2115 @item -fno-rtti
2116 @opindex fno-rtti
2117 Disable generation of information about every class with virtual
2118 functions for use by the C++ run-time type identification features
2119 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2120 of the language, you can save some space by using this flag.  Note that
2121 exception handling uses the same information, but G++ generates it as
2122 needed. The @samp{dynamic_cast} operator can still be used for casts that
2123 do not require run-time type information, i.e.@: casts to @code{void *} or to
2124 unambiguous base classes.
2126 @item -fstats
2127 @opindex fstats
2128 Emit statistics about front-end processing at the end of the compilation.
2129 This information is generally only useful to the G++ development team.
2131 @item -fstrict-enums
2132 @opindex fstrict-enums
2133 Allow the compiler to optimize using the assumption that a value of
2134 enumerated type can only be one of the values of the enumeration (as
2135 defined in the C++ standard; basically, a value that can be
2136 represented in the minimum number of bits needed to represent all the
2137 enumerators).  This assumption may not be valid if the program uses a
2138 cast to convert an arbitrary integer value to the enumerated type.
2140 @item -ftemplate-backtrace-limit=@var{n}
2141 @opindex ftemplate-backtrace-limit
2142 Set the maximum number of template instantiation notes for a single
2143 warning or error to @var{n}.  The default value is 10.
2145 @item -ftemplate-depth=@var{n}
2146 @opindex ftemplate-depth
2147 Set the maximum instantiation depth for template classes to @var{n}.
2148 A limit on the template instantiation depth is needed to detect
2149 endless recursions during template class instantiation.  ANSI/ISO C++
2150 conforming programs must not rely on a maximum depth greater than 17
2151 (changed to 1024 in C++11).  The default value is 900, as the compiler
2152 can run out of stack space before hitting 1024 in some situations.
2154 @item -fno-threadsafe-statics
2155 @opindex fno-threadsafe-statics
2156 Do not emit the extra code to use the routines specified in the C++
2157 ABI for thread-safe initialization of local statics.  You can use this
2158 option to reduce code size slightly in code that doesn't need to be
2159 thread-safe.
2161 @item -fuse-cxa-atexit
2162 @opindex fuse-cxa-atexit
2163 Register destructors for objects with static storage duration with the
2164 @code{__cxa_atexit} function rather than the @code{atexit} function.
2165 This option is required for fully standards-compliant handling of static
2166 destructors, but only works if your C library supports
2167 @code{__cxa_atexit}.
2169 @item -fno-use-cxa-get-exception-ptr
2170 @opindex fno-use-cxa-get-exception-ptr
2171 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2172 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2173 if the runtime routine is not available.
2175 @item -fvisibility-inlines-hidden
2176 @opindex fvisibility-inlines-hidden
2177 This switch declares that the user does not attempt to compare
2178 pointers to inline functions or methods where the addresses of the two functions
2179 are taken in different shared objects.
2181 The effect of this is that GCC may, effectively, mark inline methods with
2182 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2183 appear in the export table of a DSO and do not require a PLT indirection
2184 when used within the DSO@.  Enabling this option can have a dramatic effect
2185 on load and link times of a DSO as it massively reduces the size of the
2186 dynamic export table when the library makes heavy use of templates.
2188 The behavior of this switch is not quite the same as marking the
2189 methods as hidden directly, because it does not affect static variables
2190 local to the function or cause the compiler to deduce that
2191 the function is defined in only one shared object.
2193 You may mark a method as having a visibility explicitly to negate the
2194 effect of the switch for that method.  For example, if you do want to
2195 compare pointers to a particular inline method, you might mark it as
2196 having default visibility.  Marking the enclosing class with explicit
2197 visibility has no effect.
2199 Explicitly instantiated inline methods are unaffected by this option
2200 as their linkage might otherwise cross a shared library boundary.
2201 @xref{Template Instantiation}.
2203 @item -fvisibility-ms-compat
2204 @opindex fvisibility-ms-compat
2205 This flag attempts to use visibility settings to make GCC's C++
2206 linkage model compatible with that of Microsoft Visual Studio.
2208 The flag makes these changes to GCC's linkage model:
2210 @enumerate
2211 @item
2212 It sets the default visibility to @code{hidden}, like
2213 @option{-fvisibility=hidden}.
2215 @item
2216 Types, but not their members, are not hidden by default.
2218 @item
2219 The One Definition Rule is relaxed for types without explicit
2220 visibility specifications that are defined in more than one
2221 shared object: those declarations are permitted if they are
2222 permitted when this option is not used.
2223 @end enumerate
2225 In new code it is better to use @option{-fvisibility=hidden} and
2226 export those classes that are intended to be externally visible.
2227 Unfortunately it is possible for code to rely, perhaps accidentally,
2228 on the Visual Studio behavior.
2230 Among the consequences of these changes are that static data members
2231 of the same type with the same name but defined in different shared
2232 objects are different, so changing one does not change the other;
2233 and that pointers to function members defined in different shared
2234 objects may not compare equal.  When this flag is given, it is a
2235 violation of the ODR to define types with the same name differently.
2237 @item -fno-weak
2238 @opindex fno-weak
2239 Do not use weak symbol support, even if it is provided by the linker.
2240 By default, G++ uses weak symbols if they are available.  This
2241 option exists only for testing, and should not be used by end-users;
2242 it results in inferior code and has no benefits.  This option may
2243 be removed in a future release of G++.
2245 @item -nostdinc++
2246 @opindex nostdinc++
2247 Do not search for header files in the standard directories specific to
2248 C++, but do still search the other standard directories.  (This option
2249 is used when building the C++ library.)
2250 @end table
2252 In addition, these optimization, warning, and code generation options
2253 have meanings only for C++ programs:
2255 @table @gcctabopt
2256 @item -fno-default-inline
2257 @opindex fno-default-inline
2258 Do not assume @samp{inline} for functions defined inside a class scope.
2259 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2260 functions have linkage like inline functions; they just aren't
2261 inlined by default.
2263 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2264 @opindex Wabi
2265 @opindex Wno-abi
2266 Warn when G++ generates code that is probably not compatible with the
2267 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2268 all such cases, there are probably some cases that are not warned about,
2269 even though G++ is generating incompatible code.  There may also be
2270 cases where warnings are emitted even though the code that is generated
2271 is compatible.
2273 You should rewrite your code to avoid these warnings if you are
2274 concerned about the fact that code generated by G++ may not be binary
2275 compatible with code generated by other compilers.
2277 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2279 @itemize @bullet
2281 @item
2282 A template with a non-type template parameter of reference type is
2283 mangled incorrectly:
2284 @smallexample
2285 extern int N;
2286 template <int &> struct S @{@};
2287 void n (S<N>) @{2@}
2288 @end smallexample
2290 This is fixed in @option{-fabi-version=3}.
2292 @item
2293 SIMD vector types declared using @code{__attribute ((vector_size))} are
2294 mangled in a non-standard way that does not allow for overloading of
2295 functions taking vectors of different sizes.
2297 The mangling is changed in @option{-fabi-version=4}.
2298 @end itemize
2300 The known incompatibilities in @option{-fabi-version=1} include:
2302 @itemize @bullet
2304 @item
2305 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2306 pack data into the same byte as a base class.  For example:
2308 @smallexample
2309 struct A @{ virtual void f(); int f1 : 1; @};
2310 struct B : public A @{ int f2 : 1; @};
2311 @end smallexample
2313 @noindent
2314 In this case, G++ places @code{B::f2} into the same byte
2315 as@code{A::f1}; other compilers do not.  You can avoid this problem
2316 by explicitly padding @code{A} so that its size is a multiple of the
2317 byte size on your platform; that causes G++ and other compilers to
2318 lay out @code{B} identically.
2320 @item
2321 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2322 tail padding when laying out virtual bases.  For example:
2324 @smallexample
2325 struct A @{ virtual void f(); char c1; @};
2326 struct B @{ B(); char c2; @};
2327 struct C : public A, public virtual B @{@};
2328 @end smallexample
2330 @noindent
2331 In this case, G++ does not place @code{B} into the tail-padding for
2332 @code{A}; other compilers do.  You can avoid this problem by
2333 explicitly padding @code{A} so that its size is a multiple of its
2334 alignment (ignoring virtual base classes); that causes G++ and other
2335 compilers to lay out @code{C} identically.
2337 @item
2338 Incorrect handling of bit-fields with declared widths greater than that
2339 of their underlying types, when the bit-fields appear in a union.  For
2340 example:
2342 @smallexample
2343 union U @{ int i : 4096; @};
2344 @end smallexample
2346 @noindent
2347 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2348 union too small by the number of bits in an @code{int}.
2350 @item
2351 Empty classes can be placed at incorrect offsets.  For example:
2353 @smallexample
2354 struct A @{@};
2356 struct B @{
2357   A a;
2358   virtual void f ();
2361 struct C : public B, public A @{@};
2362 @end smallexample
2364 @noindent
2365 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2366 it should be placed at offset zero.  G++ mistakenly believes that the
2367 @code{A} data member of @code{B} is already at offset zero.
2369 @item
2370 Names of template functions whose types involve @code{typename} or
2371 template template parameters can be mangled incorrectly.
2373 @smallexample
2374 template <typename Q>
2375 void f(typename Q::X) @{@}
2377 template <template <typename> class Q>
2378 void f(typename Q<int>::X) @{@}
2379 @end smallexample
2381 @noindent
2382 Instantiations of these templates may be mangled incorrectly.
2384 @end itemize
2386 It also warns about psABI-related changes.  The known psABI changes at this
2387 point include:
2389 @itemize @bullet
2391 @item
2392 For SysV/x86-64, unions with @code{long double} members are 
2393 passed in memory as specified in psABI.  For example:
2395 @smallexample
2396 union U @{
2397   long double ld;
2398   int i;
2400 @end smallexample
2402 @noindent
2403 @code{union U} is always passed in memory.
2405 @end itemize
2407 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2408 @opindex Wctor-dtor-privacy
2409 @opindex Wno-ctor-dtor-privacy
2410 Warn when a class seems unusable because all the constructors or
2411 destructors in that class are private, and it has neither friends nor
2412 public static member functions.
2414 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2415 @opindex Wdelete-non-virtual-dtor
2416 @opindex Wno-delete-non-virtual-dtor
2417 Warn when @samp{delete} is used to destroy an instance of a class that
2418 has virtual functions and non-virtual destructor. It is unsafe to delete
2419 an instance of a derived class through a pointer to a base class if the
2420 base class does not have a virtual destructor.  This warning is enabled
2421 by @option{-Wall}.
2423 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2424 @opindex Wliteral-suffix
2425 @opindex Wno-literal-suffix
2426 Warn when a string or character literal is followed by a ud-suffix which does
2427 not begin with an underscore.  As a conforming extension, GCC treats such
2428 suffixes as separate preprocessing tokens in order to maintain backwards
2429 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2430 For example:
2432 @smallexample
2433 #define __STDC_FORMAT_MACROS
2434 #include <inttypes.h>
2435 #include <stdio.h>
2437 int main() @{
2438   int64_t i64 = 123;
2439   printf("My int64: %"PRId64"\n", i64);
2441 @end smallexample
2443 In this case, @code{PRId64} is treated as a separate preprocessing token.
2445 This warning is enabled by default.
2447 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2448 @opindex Wnarrowing
2449 @opindex Wno-narrowing
2450 Warn when a narrowing conversion prohibited by C++11 occurs within
2451 @samp{@{ @}}, e.g.
2453 @smallexample
2454 int i = @{ 2.2 @}; // error: narrowing from double to int
2455 @end smallexample
2457 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2459 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2460 required by the standard.  Note that this does not affect the meaning
2461 of well-formed code; narrowing conversions are still considered
2462 ill-formed in SFINAE context.
2464 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2465 @opindex Wnoexcept
2466 @opindex Wno-noexcept
2467 Warn when a noexcept-expression evaluates to false because of a call
2468 to a function that does not have a non-throwing exception
2469 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2470 the compiler to never throw an exception.
2472 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2473 @opindex Wnon-virtual-dtor
2474 @opindex Wno-non-virtual-dtor
2475 Warn when a class has virtual functions and an accessible non-virtual
2476 destructor, in which case it is possible but unsafe to delete
2477 an instance of a derived class through a pointer to the base class.
2478 This warning is also enabled if @option{-Weffc++} is specified.
2480 @item -Wreorder @r{(C++ and Objective-C++ only)}
2481 @opindex Wreorder
2482 @opindex Wno-reorder
2483 @cindex reordering, warning
2484 @cindex warning for reordering of member initializers
2485 Warn when the order of member initializers given in the code does not
2486 match the order in which they must be executed.  For instance:
2488 @smallexample
2489 struct A @{
2490   int i;
2491   int j;
2492   A(): j (0), i (1) @{ @}
2494 @end smallexample
2496 @noindent
2497 The compiler rearranges the member initializers for @samp{i}
2498 and @samp{j} to match the declaration order of the members, emitting
2499 a warning to that effect.  This warning is enabled by @option{-Wall}.
2500 @end table
2502 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2504 @table @gcctabopt
2505 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2506 @opindex Weffc++
2507 @opindex Wno-effc++
2508 Warn about violations of the following style guidelines from Scott Meyers'
2509 @cite{Effective C++, Second Edition} book:
2511 @itemize @bullet
2512 @item
2513 Item 11:  Define a copy constructor and an assignment operator for classes
2514 with dynamically allocated memory.
2516 @item
2517 Item 12:  Prefer initialization to assignment in constructors.
2519 @item
2520 Item 14:  Make destructors virtual in base classes.
2522 @item
2523 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2525 @item
2526 Item 23:  Don't try to return a reference when you must return an object.
2528 @end itemize
2530 Also warn about violations of the following style guidelines from
2531 Scott Meyers' @cite{More Effective C++} book:
2533 @itemize @bullet
2534 @item
2535 Item 6:  Distinguish between prefix and postfix forms of increment and
2536 decrement operators.
2538 @item
2539 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2541 @end itemize
2543 When selecting this option, be aware that the standard library
2544 headers do not obey all of these guidelines; use @samp{grep -v}
2545 to filter out those warnings.
2547 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2548 @opindex Wstrict-null-sentinel
2549 @opindex Wno-strict-null-sentinel
2550 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2551 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2552 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2553 it is guaranteed to be of the same size as a pointer.  But this use is
2554 not portable across different compilers.
2556 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2557 @opindex Wno-non-template-friend
2558 @opindex Wnon-template-friend
2559 Disable warnings when non-templatized friend functions are declared
2560 within a template.  Since the advent of explicit template specification
2561 support in G++, if the name of the friend is an unqualified-id (i.e.,
2562 @samp{friend foo(int)}), the C++ language specification demands that the
2563 friend declare or define an ordinary, nontemplate function.  (Section
2564 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2565 could be interpreted as a particular specialization of a templatized
2566 function.  Because this non-conforming behavior is no longer the default
2567 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2568 check existing code for potential trouble spots and is on by default.
2569 This new compiler behavior can be turned off with
2570 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2571 but disables the helpful warning.
2573 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2574 @opindex Wold-style-cast
2575 @opindex Wno-old-style-cast
2576 Warn if an old-style (C-style) cast to a non-void type is used within
2577 a C++ program.  The new-style casts (@samp{dynamic_cast},
2578 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2579 less vulnerable to unintended effects and much easier to search for.
2581 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2582 @opindex Woverloaded-virtual
2583 @opindex Wno-overloaded-virtual
2584 @cindex overloaded virtual function, warning
2585 @cindex warning for overloaded virtual function
2586 Warn when a function declaration hides virtual functions from a
2587 base class.  For example, in:
2589 @smallexample
2590 struct A @{
2591   virtual void f();
2594 struct B: public A @{
2595   void f(int);
2597 @end smallexample
2599 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2600 like:
2602 @smallexample
2603 B* b;
2604 b->f();
2605 @end smallexample
2607 @noindent
2608 fails to compile.
2610 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2611 @opindex Wno-pmf-conversions
2612 @opindex Wpmf-conversions
2613 Disable the diagnostic for converting a bound pointer to member function
2614 to a plain pointer.
2616 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2617 @opindex Wsign-promo
2618 @opindex Wno-sign-promo
2619 Warn when overload resolution chooses a promotion from unsigned or
2620 enumerated type to a signed type, over a conversion to an unsigned type of
2621 the same size.  Previous versions of G++ tried to preserve
2622 unsignedness, but the standard mandates the current behavior.
2624 @smallexample
2625 struct A @{
2626   operator int ();
2627   A& operator = (int);
2630 main ()
2632   A a,b;
2633   a = b;
2635 @end smallexample
2637 @noindent
2638 In this example, G++ synthesizes a default @samp{A& operator =
2639 (const A&);}, while cfront uses the user-defined @samp{operator =}.
2640 @end table
2642 @node Objective-C and Objective-C++ Dialect Options
2643 @section Options Controlling Objective-C and Objective-C++ Dialects
2645 @cindex compiler options, Objective-C and Objective-C++
2646 @cindex Objective-C and Objective-C++ options, command-line
2647 @cindex options, Objective-C and Objective-C++
2648 (NOTE: This manual does not describe the Objective-C and Objective-C++
2649 languages themselves.  @xref{Standards,,Language Standards
2650 Supported by GCC}, for references.)
2652 This section describes the command-line options that are only meaningful
2653 for Objective-C and Objective-C++ programs, but you can also use most of
2654 the language-independent GNU compiler options.
2655 For example, you might compile a file @code{some_class.m} like this:
2657 @smallexample
2658 gcc -g -fgnu-runtime -O -c some_class.m
2659 @end smallexample
2661 @noindent
2662 In this example, @option{-fgnu-runtime} is an option meant only for
2663 Objective-C and Objective-C++ programs; you can use the other options with
2664 any language supported by GCC@.
2666 Note that since Objective-C is an extension of the C language, Objective-C
2667 compilations may also use options specific to the C front-end (e.g.,
2668 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2669 C++-specific options (e.g., @option{-Wabi}).
2671 Here is a list of options that are @emph{only} for compiling Objective-C
2672 and Objective-C++ programs:
2674 @table @gcctabopt
2675 @item -fconstant-string-class=@var{class-name}
2676 @opindex fconstant-string-class
2677 Use @var{class-name} as the name of the class to instantiate for each
2678 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2679 class name is @code{NXConstantString} if the GNU runtime is being used, and
2680 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2681 @option{-fconstant-cfstrings} option, if also present, overrides the
2682 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2683 to be laid out as constant CoreFoundation strings.
2685 @item -fgnu-runtime
2686 @opindex fgnu-runtime
2687 Generate object code compatible with the standard GNU Objective-C
2688 runtime.  This is the default for most types of systems.
2690 @item -fnext-runtime
2691 @opindex fnext-runtime
2692 Generate output compatible with the NeXT runtime.  This is the default
2693 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2694 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2695 used.
2697 @item -fno-nil-receivers
2698 @opindex fno-nil-receivers
2699 Assume that all Objective-C message dispatches (@code{[receiver
2700 message:arg]}) in this translation unit ensure that the receiver is
2701 not @code{nil}.  This allows for more efficient entry points in the
2702 runtime to be used.  This option is only available in conjunction with
2703 the NeXT runtime and ABI version 0 or 1.
2705 @item -fobjc-abi-version=@var{n}
2706 @opindex fobjc-abi-version
2707 Use version @var{n} of the Objective-C ABI for the selected runtime.
2708 This option is currently supported only for the NeXT runtime.  In that
2709 case, Version 0 is the traditional (32-bit) ABI without support for
2710 properties and other Objective-C 2.0 additions.  Version 1 is the
2711 traditional (32-bit) ABI with support for properties and other
2712 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2713 nothing is specified, the default is Version 0 on 32-bit target
2714 machines, and Version 2 on 64-bit target machines.
2716 @item -fobjc-call-cxx-cdtors
2717 @opindex fobjc-call-cxx-cdtors
2718 For each Objective-C class, check if any of its instance variables is a
2719 C++ object with a non-trivial default constructor.  If so, synthesize a
2720 special @code{- (id) .cxx_construct} instance method which runs
2721 non-trivial default constructors on any such instance variables, in order,
2722 and then return @code{self}.  Similarly, check if any instance variable
2723 is a C++ object with a non-trivial destructor, and if so, synthesize a
2724 special @code{- (void) .cxx_destruct} method which runs
2725 all such default destructors, in reverse order.
2727 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2728 methods thusly generated only operate on instance variables
2729 declared in the current Objective-C class, and not those inherited
2730 from superclasses.  It is the responsibility of the Objective-C
2731 runtime to invoke all such methods in an object's inheritance
2732 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2733 by the runtime immediately after a new object instance is allocated;
2734 the @code{- (void) .cxx_destruct} methods are invoked immediately
2735 before the runtime deallocates an object instance.
2737 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2738 support for invoking the @code{- (id) .cxx_construct} and
2739 @code{- (void) .cxx_destruct} methods.
2741 @item -fobjc-direct-dispatch
2742 @opindex fobjc-direct-dispatch
2743 Allow fast jumps to the message dispatcher.  On Darwin this is
2744 accomplished via the comm page.
2746 @item -fobjc-exceptions
2747 @opindex fobjc-exceptions
2748 Enable syntactic support for structured exception handling in
2749 Objective-C, similar to what is offered by C++ and Java.  This option
2750 is required to use the Objective-C keywords @code{@@try},
2751 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2752 @code{@@synchronized}.  This option is available with both the GNU
2753 runtime and the NeXT runtime (but not available in conjunction with
2754 the NeXT runtime on Mac OS X 10.2 and earlier).
2756 @item -fobjc-gc
2757 @opindex fobjc-gc
2758 Enable garbage collection (GC) in Objective-C and Objective-C++
2759 programs.  This option is only available with the NeXT runtime; the
2760 GNU runtime has a different garbage collection implementation that
2761 does not require special compiler flags.
2763 @item -fobjc-nilcheck
2764 @opindex fobjc-nilcheck
2765 For the NeXT runtime with version 2 of the ABI, check for a nil
2766 receiver in method invocations before doing the actual method call.
2767 This is the default and can be disabled using
2768 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2769 checked for nil in this way no matter what this flag is set to.
2770 Currently this flag does nothing when the GNU runtime, or an older
2771 version of the NeXT runtime ABI, is used.
2773 @item -fobjc-std=objc1
2774 @opindex fobjc-std
2775 Conform to the language syntax of Objective-C 1.0, the language
2776 recognized by GCC 4.0.  This only affects the Objective-C additions to
2777 the C/C++ language; it does not affect conformance to C/C++ standards,
2778 which is controlled by the separate C/C++ dialect option flags.  When
2779 this option is used with the Objective-C or Objective-C++ compiler,
2780 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2781 This is useful if you need to make sure that your Objective-C code can
2782 be compiled with older versions of GCC@.
2784 @item -freplace-objc-classes
2785 @opindex freplace-objc-classes
2786 Emit a special marker instructing @command{ld(1)} not to statically link in
2787 the resulting object file, and allow @command{dyld(1)} to load it in at
2788 run time instead.  This is used in conjunction with the Fix-and-Continue
2789 debugging mode, where the object file in question may be recompiled and
2790 dynamically reloaded in the course of program execution, without the need
2791 to restart the program itself.  Currently, Fix-and-Continue functionality
2792 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2793 and later.
2795 @item -fzero-link
2796 @opindex fzero-link
2797 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2798 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2799 compile time) with static class references that get initialized at load time,
2800 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2801 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2802 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2803 for individual class implementations to be modified during program execution.
2804 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2805 regardless of command-line options.
2807 @item -gen-decls
2808 @opindex gen-decls
2809 Dump interface declarations for all classes seen in the source file to a
2810 file named @file{@var{sourcename}.decl}.
2812 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2813 @opindex Wassign-intercept
2814 @opindex Wno-assign-intercept
2815 Warn whenever an Objective-C assignment is being intercepted by the
2816 garbage collector.
2818 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2819 @opindex Wno-protocol
2820 @opindex Wprotocol
2821 If a class is declared to implement a protocol, a warning is issued for
2822 every method in the protocol that is not implemented by the class.  The
2823 default behavior is to issue a warning for every method not explicitly
2824 implemented in the class, even if a method implementation is inherited
2825 from the superclass.  If you use the @option{-Wno-protocol} option, then
2826 methods inherited from the superclass are considered to be implemented,
2827 and no warning is issued for them.
2829 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2830 @opindex Wselector
2831 @opindex Wno-selector
2832 Warn if multiple methods of different types for the same selector are
2833 found during compilation.  The check is performed on the list of methods
2834 in the final stage of compilation.  Additionally, a check is performed
2835 for each selector appearing in a @code{@@selector(@dots{})}
2836 expression, and a corresponding method for that selector has been found
2837 during compilation.  Because these checks scan the method table only at
2838 the end of compilation, these warnings are not produced if the final
2839 stage of compilation is not reached, for example because an error is
2840 found during compilation, or because the @option{-fsyntax-only} option is
2841 being used.
2843 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2844 @opindex Wstrict-selector-match
2845 @opindex Wno-strict-selector-match
2846 Warn if multiple methods with differing argument and/or return types are
2847 found for a given selector when attempting to send a message using this
2848 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2849 is off (which is the default behavior), the compiler omits such warnings
2850 if any differences found are confined to types that share the same size
2851 and alignment.
2853 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2854 @opindex Wundeclared-selector
2855 @opindex Wno-undeclared-selector
2856 Warn if a @code{@@selector(@dots{})} expression referring to an
2857 undeclared selector is found.  A selector is considered undeclared if no
2858 method with that name has been declared before the
2859 @code{@@selector(@dots{})} expression, either explicitly in an
2860 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2861 an @code{@@implementation} section.  This option always performs its
2862 checks as soon as a @code{@@selector(@dots{})} expression is found,
2863 while @option{-Wselector} only performs its checks in the final stage of
2864 compilation.  This also enforces the coding style convention
2865 that methods and selectors must be declared before being used.
2867 @item -print-objc-runtime-info
2868 @opindex print-objc-runtime-info
2869 Generate C header describing the largest structure that is passed by
2870 value, if any.
2872 @end table
2874 @node Language Independent Options
2875 @section Options to Control Diagnostic Messages Formatting
2876 @cindex options to control diagnostics formatting
2877 @cindex diagnostic messages
2878 @cindex message formatting
2880 Traditionally, diagnostic messages have been formatted irrespective of
2881 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
2882 options described below
2883 to control the formatting algorithm for diagnostic messages, 
2884 e.g.@: how many characters per line, how often source location
2885 information should be reported.  Note that some language front ends may not
2886 honor these options.
2888 @table @gcctabopt
2889 @item -fmessage-length=@var{n}
2890 @opindex fmessage-length
2891 Try to format error messages so that they fit on lines of about @var{n}
2892 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2893 the front ends supported by GCC@.  If @var{n} is zero, then no
2894 line-wrapping is done; each error message appears on a single
2895 line.
2897 @item -fdiagnostics-show-location=once
2898 @opindex fdiagnostics-show-location
2899 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2900 reporter to emit @emph{once} source location information; that is, in
2901 case the message is too long to fit on a single physical line and has to
2902 be wrapped, the source location won't be emitted (as prefix) again,
2903 over and over, in subsequent continuation lines.  This is the default
2904 behavior.
2906 @item -fdiagnostics-show-location=every-line
2907 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2908 messages reporter to emit the same source location information (as
2909 prefix) for physical lines that result from the process of breaking
2910 a message which is too long to fit on a single line.
2912 @item -fno-diagnostics-show-option
2913 @opindex fno-diagnostics-show-option
2914 @opindex fdiagnostics-show-option
2915 By default, each diagnostic emitted includes text indicating the
2916 command-line option that directly controls the diagnostic (if such an
2917 option is known to the diagnostic machinery).  Specifying the
2918 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2920 @item -fno-diagnostics-show-caret
2921 @opindex fno-diagnostics-show-caret
2922 @opindex fdiagnostics-show-caret
2923 By default, each diagnostic emitted includes the original source line
2924 and a caret '^' indicating the column.  This option suppresses this
2925 information.
2927 @end table
2929 @node Warning Options
2930 @section Options to Request or Suppress Warnings
2931 @cindex options to control warnings
2932 @cindex warning messages
2933 @cindex messages, warning
2934 @cindex suppressing warnings
2936 Warnings are diagnostic messages that report constructions that
2937 are not inherently erroneous but that are risky or suggest there
2938 may have been an error.
2940 The following language-independent options do not enable specific
2941 warnings but control the kinds of diagnostics produced by GCC@.
2943 @table @gcctabopt
2944 @cindex syntax checking
2945 @item -fsyntax-only
2946 @opindex fsyntax-only
2947 Check the code for syntax errors, but don't do anything beyond that.
2949 @item -fmax-errors=@var{n}
2950 @opindex fmax-errors
2951 Limits the maximum number of error messages to @var{n}, at which point
2952 GCC bails out rather than attempting to continue processing the source
2953 code.  If @var{n} is 0 (the default), there is no limit on the number
2954 of error messages produced.  If @option{-Wfatal-errors} is also
2955 specified, then @option{-Wfatal-errors} takes precedence over this
2956 option.
2958 @item -w
2959 @opindex w
2960 Inhibit all warning messages.
2962 @item -Werror
2963 @opindex Werror
2964 @opindex Wno-error
2965 Make all warnings into errors.
2967 @item -Werror=
2968 @opindex Werror=
2969 @opindex Wno-error=
2970 Make the specified warning into an error.  The specifier for a warning
2971 is appended, for example @option{-Werror=switch} turns the warnings
2972 controlled by @option{-Wswitch} into errors.  This switch takes a
2973 negative form, to be used to negate @option{-Werror} for specific
2974 warnings, for example @option{-Wno-error=switch} makes
2975 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2976 is in effect.
2978 The warning message for each controllable warning includes the
2979 option that controls the warning.  That option can then be used with
2980 @option{-Werror=} and @option{-Wno-error=} as described above.
2981 (Printing of the option in the warning message can be disabled using the
2982 @option{-fno-diagnostics-show-option} flag.)
2984 Note that specifying @option{-Werror=}@var{foo} automatically implies
2985 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2986 imply anything.
2988 @item -Wfatal-errors
2989 @opindex Wfatal-errors
2990 @opindex Wno-fatal-errors
2991 This option causes the compiler to abort compilation on the first error
2992 occurred rather than trying to keep going and printing further error
2993 messages.
2995 @end table
2997 You can request many specific warnings with options beginning
2998 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2999 implicit declarations.  Each of these specific warning options also
3000 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3001 example, @option{-Wno-implicit}.  This manual lists only one of the
3002 two forms, whichever is not the default.  For further,
3003 language-specific options also refer to @ref{C++ Dialect Options} and
3004 @ref{Objective-C and Objective-C++ Dialect Options}.
3006 When an unrecognized warning option is requested (e.g.,
3007 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3008 that the option is not recognized.  However, if the @option{-Wno-} form
3009 is used, the behavior is slightly different: no diagnostic is
3010 produced for @option{-Wno-unknown-warning} unless other diagnostics
3011 are being produced.  This allows the use of new @option{-Wno-} options
3012 with old compilers, but if something goes wrong, the compiler
3013 warns that an unrecognized option is present.
3015 @table @gcctabopt
3016 @item -Wpedantic
3017 @itemx -pedantic
3018 @opindex pedantic
3019 @opindex Wpedantic
3020 Issue all the warnings demanded by strict ISO C and ISO C++;
3021 reject all programs that use forbidden extensions, and some other
3022 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3023 version of the ISO C standard specified by any @option{-std} option used.
3025 Valid ISO C and ISO C++ programs should compile properly with or without
3026 this option (though a rare few require @option{-ansi} or a
3027 @option{-std} option specifying the required version of ISO C)@.  However,
3028 without this option, certain GNU extensions and traditional C and C++
3029 features are supported as well.  With this option, they are rejected.
3031 @option{-Wpedantic} does not cause warning messages for use of the
3032 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3033 warnings are also disabled in the expression that follows
3034 @code{__extension__}.  However, only system header files should use
3035 these escape routes; application programs should avoid them.
3036 @xref{Alternate Keywords}.
3038 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3039 C conformance.  They soon find that it does not do quite what they want:
3040 it finds some non-ISO practices, but not all---only those for which
3041 ISO C @emph{requires} a diagnostic, and some others for which
3042 diagnostics have been added.
3044 A feature to report any failure to conform to ISO C might be useful in
3045 some instances, but would require considerable additional work and would
3046 be quite different from @option{-Wpedantic}.  We don't have plans to
3047 support such a feature in the near future.
3049 Where the standard specified with @option{-std} represents a GNU
3050 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3051 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3052 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3053 where they are required by the base standard.  (It does not make sense
3054 for such warnings to be given only for features not in the specified GNU
3055 C dialect, since by definition the GNU dialects of C include all
3056 features the compiler supports with the given option, and there would be
3057 nothing to warn about.)
3059 @item -pedantic-errors
3060 @opindex pedantic-errors
3061 Like @option{-Wpedantic}, except that errors are produced rather than
3062 warnings.
3064 @item -Wall
3065 @opindex Wall
3066 @opindex Wno-all
3067 This enables all the warnings about constructions that some users
3068 consider questionable, and that are easy to avoid (or modify to
3069 prevent the warning), even in conjunction with macros.  This also
3070 enables some language-specific warnings described in @ref{C++ Dialect
3071 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3073 @option{-Wall} turns on the following warning flags:
3075 @gccoptlist{-Waddress   @gol
3076 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3077 -Wc++11-compat  @gol
3078 -Wchar-subscripts  @gol
3079 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
3080 -Wimplicit-int @r{(C and Objective-C only)} @gol
3081 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3082 -Wcomment  @gol
3083 -Wformat   @gol
3084 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3085 -Wmaybe-uninitialized @gol
3086 -Wmissing-braces @r{(only for C/ObjC)} @gol
3087 -Wnonnull  @gol
3088 -Wparentheses  @gol
3089 -Wpointer-sign  @gol
3090 -Wreorder   @gol
3091 -Wreturn-type  @gol
3092 -Wsequence-point  @gol
3093 -Wsign-compare @r{(only in C++)}  @gol
3094 -Wstrict-aliasing  @gol
3095 -Wstrict-overflow=1  @gol
3096 -Wswitch  @gol
3097 -Wtrigraphs  @gol
3098 -Wuninitialized  @gol
3099 -Wunknown-pragmas  @gol
3100 -Wunused-function  @gol
3101 -Wunused-label     @gol
3102 -Wunused-value     @gol
3103 -Wunused-variable  @gol
3104 -Wvolatile-register-var @gol
3107 Note that some warning flags are not implied by @option{-Wall}.  Some of
3108 them warn about constructions that users generally do not consider
3109 questionable, but which occasionally you might wish to check for;
3110 others warn about constructions that are necessary or hard to avoid in
3111 some cases, and there is no simple way to modify the code to suppress
3112 the warning. Some of them are enabled by @option{-Wextra} but many of
3113 them must be enabled individually.
3115 @item -Wextra
3116 @opindex W
3117 @opindex Wextra
3118 @opindex Wno-extra
3119 This enables some extra warning flags that are not enabled by
3120 @option{-Wall}. (This option used to be called @option{-W}.  The older
3121 name is still supported, but the newer name is more descriptive.)
3123 @gccoptlist{-Wclobbered  @gol
3124 -Wempty-body  @gol
3125 -Wignored-qualifiers @gol
3126 -Wmissing-field-initializers  @gol
3127 -Wmissing-parameter-type @r{(C only)}  @gol
3128 -Wold-style-declaration @r{(C only)}  @gol
3129 -Woverride-init  @gol
3130 -Wsign-compare  @gol
3131 -Wtype-limits  @gol
3132 -Wuninitialized  @gol
3133 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3134 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3137 The option @option{-Wextra} also prints warning messages for the
3138 following cases:
3140 @itemize @bullet
3142 @item
3143 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3144 @samp{>}, or @samp{>=}.
3146 @item
3147 (C++ only) An enumerator and a non-enumerator both appear in a
3148 conditional expression.
3150 @item
3151 (C++ only) Ambiguous virtual bases.
3153 @item
3154 (C++ only) Subscripting an array that has been declared @samp{register}.
3156 @item
3157 (C++ only) Taking the address of a variable that has been declared
3158 @samp{register}.
3160 @item
3161 (C++ only) A base class is not initialized in a derived class' copy
3162 constructor.
3164 @end itemize
3166 @item -Wchar-subscripts
3167 @opindex Wchar-subscripts
3168 @opindex Wno-char-subscripts
3169 Warn if an array subscript has type @code{char}.  This is a common cause
3170 of error, as programmers often forget that this type is signed on some
3171 machines.
3172 This warning is enabled by @option{-Wall}.
3174 @item -Wcomment
3175 @opindex Wcomment
3176 @opindex Wno-comment
3177 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3178 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3179 This warning is enabled by @option{-Wall}.
3181 @item -Wno-coverage-mismatch
3182 @opindex Wno-coverage-mismatch
3183 Warn if feedback profiles do not match when using the
3184 @option{-fprofile-use} option.
3185 If a source file is changed between compiling with @option{-fprofile-gen} and
3186 with @option{-fprofile-use}, the files with the profile feedback can fail
3187 to match the source file and GCC cannot use the profile feedback
3188 information.  By default, this warning is enabled and is treated as an
3189 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3190 warning or @option{-Wno-error=coverage-mismatch} can be used to
3191 disable the error.  Disabling the error for this warning can result in
3192 poorly optimized code and is useful only in the
3193 case of very minor changes such as bug fixes to an existing code-base.
3194 Completely disabling the warning is not recommended.
3196 @item -Wno-cpp
3197 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3199 Suppress warning messages emitted by @code{#warning} directives.
3201 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3202 @opindex Wdouble-promotion
3203 @opindex Wno-double-promotion
3204 Give a warning when a value of type @code{float} is implicitly
3205 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3206 floating-point unit implement @code{float} in hardware, but emulate
3207 @code{double} in software.  On such a machine, doing computations
3208 using @code{double} values is much more expensive because of the
3209 overhead required for software emulation.
3211 It is easy to accidentally do computations with @code{double} because
3212 floating-point literals are implicitly of type @code{double}.  For
3213 example, in:
3214 @smallexample
3215 @group
3216 float area(float radius)
3218    return 3.14159 * radius * radius;
3220 @end group
3221 @end smallexample
3222 the compiler performs the entire computation with @code{double}
3223 because the floating-point literal is a @code{double}.
3225 @item -Wformat
3226 @opindex Wformat
3227 @opindex Wno-format
3228 @opindex ffreestanding
3229 @opindex fno-builtin
3230 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3231 the arguments supplied have types appropriate to the format string
3232 specified, and that the conversions specified in the format string make
3233 sense.  This includes standard functions, and others specified by format
3234 attributes (@pxref{Function Attributes}), in the @code{printf},
3235 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3236 not in the C standard) families (or other target-specific families).
3237 Which functions are checked without format attributes having been
3238 specified depends on the standard version selected, and such checks of
3239 functions without the attribute specified are disabled by
3240 @option{-ffreestanding} or @option{-fno-builtin}.
3242 The formats are checked against the format features supported by GNU
3243 libc version 2.2.  These include all ISO C90 and C99 features, as well
3244 as features from the Single Unix Specification and some BSD and GNU
3245 extensions.  Other library implementations may not support all these
3246 features; GCC does not support warning about features that go beyond a
3247 particular library's limitations.  However, if @option{-Wpedantic} is used
3248 with @option{-Wformat}, warnings are given about format features not
3249 in the selected standard version (but not for @code{strfmon} formats,
3250 since those are not in any version of the C standard).  @xref{C Dialect
3251 Options,,Options Controlling C Dialect}.
3253 Since @option{-Wformat} also checks for null format arguments for
3254 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3256 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3257 aspects of format checking, the options @option{-Wformat-y2k},
3258 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3259 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3260 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3262 @item -Wformat-y2k
3263 @opindex Wformat-y2k
3264 @opindex Wno-format-y2k
3265 If @option{-Wformat} is specified, also warn about @code{strftime}
3266 formats that may yield only a two-digit year.
3268 @item -Wno-format-contains-nul
3269 @opindex Wno-format-contains-nul
3270 @opindex Wformat-contains-nul
3271 If @option{-Wformat} is specified, do not warn about format strings that
3272 contain NUL bytes.
3274 @item -Wno-format-extra-args
3275 @opindex Wno-format-extra-args
3276 @opindex Wformat-extra-args
3277 If @option{-Wformat} is specified, do not warn about excess arguments to a
3278 @code{printf} or @code{scanf} format function.  The C standard specifies
3279 that such arguments are ignored.
3281 Where the unused arguments lie between used arguments that are
3282 specified with @samp{$} operand number specifications, normally
3283 warnings are still given, since the implementation could not know what
3284 type to pass to @code{va_arg} to skip the unused arguments.  However,
3285 in the case of @code{scanf} formats, this option suppresses the
3286 warning if the unused arguments are all pointers, since the Single
3287 Unix Specification says that such unused arguments are allowed.
3289 @item -Wno-format-zero-length
3290 @opindex Wno-format-zero-length
3291 @opindex Wformat-zero-length
3292 If @option{-Wformat} is specified, do not warn about zero-length formats.
3293 The C standard specifies that zero-length formats are allowed.
3295 @item -Wformat-nonliteral
3296 @opindex Wformat-nonliteral
3297 @opindex Wno-format-nonliteral
3298 If @option{-Wformat} is specified, also warn if the format string is not a
3299 string literal and so cannot be checked, unless the format function
3300 takes its format arguments as a @code{va_list}.
3302 @item -Wformat-security
3303 @opindex Wformat-security
3304 @opindex Wno-format-security
3305 If @option{-Wformat} is specified, also warn about uses of format
3306 functions that represent possible security problems.  At present, this
3307 warns about calls to @code{printf} and @code{scanf} functions where the
3308 format string is not a string literal and there are no format arguments,
3309 as in @code{printf (foo);}.  This may be a security hole if the format
3310 string came from untrusted input and contains @samp{%n}.  (This is
3311 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3312 in future warnings may be added to @option{-Wformat-security} that are not
3313 included in @option{-Wformat-nonliteral}.)
3315 @item -Wformat=2
3316 @opindex Wformat=2
3317 @opindex Wno-format=2
3318 Enable @option{-Wformat} plus format checks not included in
3319 @option{-Wformat}.  Currently equivalent to @option{-Wformat
3320 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3322 @item -Wnonnull
3323 @opindex Wnonnull
3324 @opindex Wno-nonnull
3325 Warn about passing a null pointer for arguments marked as
3326 requiring a non-null value by the @code{nonnull} function attribute.
3328 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3329 can be disabled with the @option{-Wno-nonnull} option.
3331 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3332 @opindex Winit-self
3333 @opindex Wno-init-self
3334 Warn about uninitialized variables that are initialized with themselves.
3335 Note this option can only be used with the @option{-Wuninitialized} option.
3337 For example, GCC warns about @code{i} being uninitialized in the
3338 following snippet only when @option{-Winit-self} has been specified:
3339 @smallexample
3340 @group
3341 int f()
3343   int i = i;
3344   return i;
3346 @end group
3347 @end smallexample
3349 @item -Wimplicit-int @r{(C and Objective-C only)}
3350 @opindex Wimplicit-int
3351 @opindex Wno-implicit-int
3352 Warn when a declaration does not specify a type.
3353 This warning is enabled by @option{-Wall}.
3355 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3356 @opindex Wimplicit-function-declaration
3357 @opindex Wno-implicit-function-declaration
3358 Give a warning whenever a function is used before being declared. In
3359 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3360 enabled by default and it is made into an error by
3361 @option{-pedantic-errors}. This warning is also enabled by
3362 @option{-Wall}.
3364 @item -Wimplicit @r{(C and Objective-C only)}
3365 @opindex Wimplicit
3366 @opindex Wno-implicit
3367 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3368 This warning is enabled by @option{-Wall}.
3370 @item -Wignored-qualifiers @r{(C and C++ only)}
3371 @opindex Wignored-qualifiers
3372 @opindex Wno-ignored-qualifiers
3373 Warn if the return type of a function has a type qualifier
3374 such as @code{const}.  For ISO C such a type qualifier has no effect,
3375 since the value returned by a function is not an lvalue.
3376 For C++, the warning is only emitted for scalar types or @code{void}.
3377 ISO C prohibits qualified @code{void} return types on function
3378 definitions, so such return types always receive a warning
3379 even without this option.
3381 This warning is also enabled by @option{-Wextra}.
3383 @item -Wmain
3384 @opindex Wmain
3385 @opindex Wno-main
3386 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3387 a function with external linkage, returning int, taking either zero
3388 arguments, two, or three arguments of appropriate types.  This warning
3389 is enabled by default in C++ and is enabled by either @option{-Wall}
3390 or @option{-Wpedantic}.
3392 @item -Wmissing-braces
3393 @opindex Wmissing-braces
3394 @opindex Wno-missing-braces
3395 Warn if an aggregate or union initializer is not fully bracketed.  In
3396 the following example, the initializer for @samp{a} is not fully
3397 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3398 enabled by @option{-Wall} in C.
3400 @smallexample
3401 int a[2][2] = @{ 0, 1, 2, 3 @};
3402 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3403 @end smallexample
3405 This warning is enabled by @option{-Wall}.
3407 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3408 @opindex Wmissing-include-dirs
3409 @opindex Wno-missing-include-dirs
3410 Warn if a user-supplied include directory does not exist.
3412 @item -Wparentheses
3413 @opindex Wparentheses
3414 @opindex Wno-parentheses
3415 Warn if parentheses are omitted in certain contexts, such
3416 as when there is an assignment in a context where a truth value
3417 is expected, or when operators are nested whose precedence people
3418 often get confused about.
3420 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3421 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3422 interpretation from that of ordinary mathematical notation.
3424 Also warn about constructions where there may be confusion to which
3425 @code{if} statement an @code{else} branch belongs.  Here is an example of
3426 such a case:
3428 @smallexample
3429 @group
3431   if (a)
3432     if (b)
3433       foo ();
3434   else
3435     bar ();
3437 @end group
3438 @end smallexample
3440 In C/C++, every @code{else} branch belongs to the innermost possible
3441 @code{if} statement, which in this example is @code{if (b)}.  This is
3442 often not what the programmer expected, as illustrated in the above
3443 example by indentation the programmer chose.  When there is the
3444 potential for this confusion, GCC issues a warning when this flag
3445 is specified.  To eliminate the warning, add explicit braces around
3446 the innermost @code{if} statement so there is no way the @code{else}
3447 can belong to the enclosing @code{if}.  The resulting code
3448 looks like this:
3450 @smallexample
3451 @group
3453   if (a)
3454     @{
3455       if (b)
3456         foo ();
3457       else
3458         bar ();
3459     @}
3461 @end group
3462 @end smallexample
3464 Also warn for dangerous uses of the GNU extension to
3465 @code{?:} with omitted middle operand. When the condition
3466 in the @code{?}: operator is a boolean expression, the omitted value is
3467 always 1.  Often programmers expect it to be a value computed
3468 inside the conditional expression instead.
3470 This warning is enabled by @option{-Wall}.
3472 @item -Wsequence-point
3473 @opindex Wsequence-point
3474 @opindex Wno-sequence-point
3475 Warn about code that may have undefined semantics because of violations
3476 of sequence point rules in the C and C++ standards.
3478 The C and C++ standards defines the order in which expressions in a C/C++
3479 program are evaluated in terms of @dfn{sequence points}, which represent
3480 a partial ordering between the execution of parts of the program: those
3481 executed before the sequence point, and those executed after it.  These
3482 occur after the evaluation of a full expression (one which is not part
3483 of a larger expression), after the evaluation of the first operand of a
3484 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3485 function is called (but after the evaluation of its arguments and the
3486 expression denoting the called function), and in certain other places.
3487 Other than as expressed by the sequence point rules, the order of
3488 evaluation of subexpressions of an expression is not specified.  All
3489 these rules describe only a partial order rather than a total order,
3490 since, for example, if two functions are called within one expression
3491 with no sequence point between them, the order in which the functions
3492 are called is not specified.  However, the standards committee have
3493 ruled that function calls do not overlap.
3495 It is not specified when between sequence points modifications to the
3496 values of objects take effect.  Programs whose behavior depends on this
3497 have undefined behavior; the C and C++ standards specify that ``Between
3498 the previous and next sequence point an object shall have its stored
3499 value modified at most once by the evaluation of an expression.
3500 Furthermore, the prior value shall be read only to determine the value
3501 to be stored.''.  If a program breaks these rules, the results on any
3502 particular implementation are entirely unpredictable.
3504 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3505 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3506 diagnosed by this option, and it may give an occasional false positive
3507 result, but in general it has been found fairly effective at detecting
3508 this sort of problem in programs.
3510 The standard is worded confusingly, therefore there is some debate
3511 over the precise meaning of the sequence point rules in subtle cases.
3512 Links to discussions of the problem, including proposed formal
3513 definitions, may be found on the GCC readings page, at
3514 @uref{http://gcc.gnu.org/@/readings.html}.
3516 This warning is enabled by @option{-Wall} for C and C++.
3518 @item -Wreturn-type
3519 @opindex Wreturn-type
3520 @opindex Wno-return-type
3521 Warn whenever a function is defined with a return-type that defaults
3522 to @code{int}.  Also warn about any @code{return} statement with no
3523 return-value in a function whose return-type is not @code{void}
3524 (falling off the end of the function body is considered returning
3525 without a value), and about a @code{return} statement with an
3526 expression in a function whose return-type is @code{void}.
3528 For C++, a function without return type always produces a diagnostic
3529 message, even when @option{-Wno-return-type} is specified.  The only
3530 exceptions are @samp{main} and functions defined in system headers.
3532 This warning is enabled by @option{-Wall}.
3534 @item -Wswitch
3535 @opindex Wswitch
3536 @opindex Wno-switch
3537 Warn whenever a @code{switch} statement has an index of enumerated type
3538 and lacks a @code{case} for one or more of the named codes of that
3539 enumeration.  (The presence of a @code{default} label prevents this
3540 warning.)  @code{case} labels outside the enumeration range also
3541 provoke warnings when this option is used (even if there is a
3542 @code{default} label).
3543 This warning is enabled by @option{-Wall}.
3545 @item -Wswitch-default
3546 @opindex Wswitch-default
3547 @opindex Wno-switch-default
3548 Warn whenever a @code{switch} statement does not have a @code{default}
3549 case.
3551 @item -Wswitch-enum
3552 @opindex Wswitch-enum
3553 @opindex Wno-switch-enum
3554 Warn whenever a @code{switch} statement has an index of enumerated type
3555 and lacks a @code{case} for one or more of the named codes of that
3556 enumeration.  @code{case} labels outside the enumeration range also
3557 provoke warnings when this option is used.  The only difference
3558 between @option{-Wswitch} and this option is that this option gives a
3559 warning about an omitted enumeration code even if there is a
3560 @code{default} label.
3562 @item -Wsync-nand @r{(C and C++ only)}
3563 @opindex Wsync-nand
3564 @opindex Wno-sync-nand
3565 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3566 built-in functions are used.  These functions changed semantics in GCC 4.4.
3568 @item -Wtrigraphs
3569 @opindex Wtrigraphs
3570 @opindex Wno-trigraphs
3571 Warn if any trigraphs are encountered that might change the meaning of
3572 the program (trigraphs within comments are not warned about).
3573 This warning is enabled by @option{-Wall}.
3575 @item -Wunused-but-set-parameter
3576 @opindex Wunused-but-set-parameter
3577 @opindex Wno-unused-but-set-parameter
3578 Warn whenever a function parameter is assigned to, but otherwise unused
3579 (aside from its declaration).
3581 To suppress this warning use the @samp{unused} attribute
3582 (@pxref{Variable Attributes}).
3584 This warning is also enabled by @option{-Wunused} together with
3585 @option{-Wextra}.
3587 @item -Wunused-but-set-variable
3588 @opindex Wunused-but-set-variable
3589 @opindex Wno-unused-but-set-variable
3590 Warn whenever a local variable is assigned to, but otherwise unused
3591 (aside from its declaration).
3592 This warning is enabled by @option{-Wall}.
3594 To suppress this warning use the @samp{unused} attribute
3595 (@pxref{Variable Attributes}).
3597 This warning is also enabled by @option{-Wunused}, which is enabled
3598 by @option{-Wall}.
3600 @item -Wunused-function
3601 @opindex Wunused-function
3602 @opindex Wno-unused-function
3603 Warn whenever a static function is declared but not defined or a
3604 non-inline static function is unused.
3605 This warning is enabled by @option{-Wall}.
3607 @item -Wunused-label
3608 @opindex Wunused-label
3609 @opindex Wno-unused-label
3610 Warn whenever a label is declared but not used.
3611 This warning is enabled by @option{-Wall}.
3613 To suppress this warning use the @samp{unused} attribute
3614 (@pxref{Variable Attributes}).
3616 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3617 @opindex Wunused-local-typedefs
3618 Warn when a typedef locally defined in a function is not used.
3619 This warning is enabled by @option{-Wall}.
3621 @item -Wunused-parameter
3622 @opindex Wunused-parameter
3623 @opindex Wno-unused-parameter
3624 Warn whenever a function parameter is unused aside from its declaration.
3626 To suppress this warning use the @samp{unused} attribute
3627 (@pxref{Variable Attributes}).
3629 @item -Wno-unused-result
3630 @opindex Wunused-result
3631 @opindex Wno-unused-result
3632 Do not warn if a caller of a function marked with attribute
3633 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3634 its return value. The default is @option{-Wunused-result}.
3636 @item -Wunused-variable
3637 @opindex Wunused-variable
3638 @opindex Wno-unused-variable
3639 Warn whenever a local variable or non-constant static variable is unused
3640 aside from its declaration.
3641 This warning is enabled by @option{-Wall}.
3643 To suppress this warning use the @samp{unused} attribute
3644 (@pxref{Variable Attributes}).
3646 @item -Wunused-value
3647 @opindex Wunused-value
3648 @opindex Wno-unused-value
3649 Warn whenever a statement computes a result that is explicitly not
3650 used. To suppress this warning cast the unused expression to
3651 @samp{void}. This includes an expression-statement or the left-hand
3652 side of a comma expression that contains no side effects. For example,
3653 an expression such as @samp{x[i,j]} causes a warning, while
3654 @samp{x[(void)i,j]} does not.
3656 This warning is enabled by @option{-Wall}.
3658 @item -Wunused
3659 @opindex Wunused
3660 @opindex Wno-unused
3661 All the above @option{-Wunused} options combined.
3663 In order to get a warning about an unused function parameter, you must
3664 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3665 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3667 @item -Wuninitialized
3668 @opindex Wuninitialized
3669 @opindex Wno-uninitialized
3670 Warn if an automatic variable is used without first being initialized
3671 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3672 warn if a non-static reference or non-static @samp{const} member
3673 appears in a class without constructors.
3675 If you want to warn about code that uses the uninitialized value of the
3676 variable in its own initializer, use the @option{-Winit-self} option.
3678 These warnings occur for individual uninitialized or clobbered
3679 elements of structure, union or array variables as well as for
3680 variables that are uninitialized or clobbered as a whole.  They do
3681 not occur for variables or elements declared @code{volatile}.  Because
3682 these warnings depend on optimization, the exact variables or elements
3683 for which there are warnings depends on the precise optimization
3684 options and version of GCC used.
3686 Note that there may be no warning about a variable that is used only
3687 to compute a value that itself is never used, because such
3688 computations may be deleted by data flow analysis before the warnings
3689 are printed.
3691 @item -Wmaybe-uninitialized
3692 @opindex Wmaybe-uninitialized
3693 @opindex Wno-maybe-uninitialized
3694 For an automatic variable, if there exists a path from the function
3695 entry to a use of the variable that is initialized, but there exist
3696 some other paths for which the variable is not initialized, the compiler
3697 emits a warning if it cannot prove the uninitialized paths are not
3698 executed at run time. These warnings are made optional because GCC is
3699 not smart enough to see all the reasons why the code might be correct
3700 in spite of appearing to have an error.  Here is one example of how
3701 this can happen:
3703 @smallexample
3704 @group
3706   int x;
3707   switch (y)
3708     @{
3709     case 1: x = 1;
3710       break;
3711     case 2: x = 4;
3712       break;
3713     case 3: x = 5;
3714     @}
3715   foo (x);
3717 @end group
3718 @end smallexample
3720 @noindent
3721 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3722 always initialized, but GCC doesn't know this. To suppress the
3723 warning, you need to provide a default case with assert(0) or
3724 similar code.
3726 @cindex @code{longjmp} warnings
3727 This option also warns when a non-volatile automatic variable might be
3728 changed by a call to @code{longjmp}.  These warnings as well are possible
3729 only in optimizing compilation.
3731 The compiler sees only the calls to @code{setjmp}.  It cannot know
3732 where @code{longjmp} will be called; in fact, a signal handler could
3733 call it at any point in the code.  As a result, you may get a warning
3734 even when there is in fact no problem because @code{longjmp} cannot
3735 in fact be called at the place that would cause a problem.
3737 Some spurious warnings can be avoided if you declare all the functions
3738 you use that never return as @code{noreturn}.  @xref{Function
3739 Attributes}.
3741 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3743 @item -Wunknown-pragmas
3744 @opindex Wunknown-pragmas
3745 @opindex Wno-unknown-pragmas
3746 @cindex warning for unknown pragmas
3747 @cindex unknown pragmas, warning
3748 @cindex pragmas, warning of unknown
3749 Warn when a @code{#pragma} directive is encountered that is not understood by 
3750 GCC@.  If this command-line option is used, warnings are even issued
3751 for unknown pragmas in system header files.  This is not the case if
3752 the warnings are only enabled by the @option{-Wall} command-line option.
3754 @item -Wno-pragmas
3755 @opindex Wno-pragmas
3756 @opindex Wpragmas
3757 Do not warn about misuses of pragmas, such as incorrect parameters,
3758 invalid syntax, or conflicts between pragmas.  See also
3759 @option{-Wunknown-pragmas}.
3761 @item -Wstrict-aliasing
3762 @opindex Wstrict-aliasing
3763 @opindex Wno-strict-aliasing
3764 This option is only active when @option{-fstrict-aliasing} is active.
3765 It warns about code that might break the strict aliasing rules that the
3766 compiler is using for optimization.  The warning does not catch all
3767 cases, but does attempt to catch the more common pitfalls.  It is
3768 included in @option{-Wall}.
3769 It is equivalent to @option{-Wstrict-aliasing=3}
3771 @item -Wstrict-aliasing=n
3772 @opindex Wstrict-aliasing=n
3773 @opindex Wno-strict-aliasing=n
3774 This option is only active when @option{-fstrict-aliasing} is active.
3775 It warns about code that might break the strict aliasing rules that the
3776 compiler is using for optimization.
3777 Higher levels correspond to higher accuracy (fewer false positives).
3778 Higher levels also correspond to more effort, similar to the way @option{-O} 
3779 works.
3780 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
3782 Level 1: Most aggressive, quick, least accurate.
3783 Possibly useful when higher levels
3784 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
3785 false negatives.  However, it has many false positives.
3786 Warns for all pointer conversions between possibly incompatible types,
3787 even if never dereferenced.  Runs in the front end only.
3789 Level 2: Aggressive, quick, not too precise.
3790 May still have many false positives (not as many as level 1 though),
3791 and few false negatives (but possibly more than level 1).
3792 Unlike level 1, it only warns when an address is taken.  Warns about
3793 incomplete types.  Runs in the front end only.
3795 Level 3 (default for @option{-Wstrict-aliasing}):
3796 Should have very few false positives and few false
3797 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3798 Takes care of the common pun+dereference pattern in the front end:
3799 @code{*(int*)&some_float}.
3800 If optimization is enabled, it also runs in the back end, where it deals
3801 with multiple statement cases using flow-sensitive points-to information.
3802 Only warns when the converted pointer is dereferenced.
3803 Does not warn about incomplete types.
3805 @item -Wstrict-overflow
3806 @itemx -Wstrict-overflow=@var{n}
3807 @opindex Wstrict-overflow
3808 @opindex Wno-strict-overflow
3809 This option is only active when @option{-fstrict-overflow} is active.
3810 It warns about cases where the compiler optimizes based on the
3811 assumption that signed overflow does not occur.  Note that it does not
3812 warn about all cases where the code might overflow: it only warns
3813 about cases where the compiler implements some optimization.  Thus
3814 this warning depends on the optimization level.
3816 An optimization that assumes that signed overflow does not occur is
3817 perfectly safe if the values of the variables involved are such that
3818 overflow never does, in fact, occur.  Therefore this warning can
3819 easily give a false positive: a warning about code that is not
3820 actually a problem.  To help focus on important issues, several
3821 warning levels are defined.  No warnings are issued for the use of
3822 undefined signed overflow when estimating how many iterations a loop
3823 requires, in particular when determining whether a loop will be
3824 executed at all.
3826 @table @gcctabopt
3827 @item -Wstrict-overflow=1
3828 Warn about cases that are both questionable and easy to avoid.  For
3829 example,  with @option{-fstrict-overflow}, the compiler simplifies
3830 @code{x + 1 > x} to @code{1}.  This level of
3831 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3832 are not, and must be explicitly requested.
3834 @item -Wstrict-overflow=2
3835 Also warn about other cases where a comparison is simplified to a
3836 constant.  For example: @code{abs (x) >= 0}.  This can only be
3837 simplified when @option{-fstrict-overflow} is in effect, because
3838 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3839 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3840 @option{-Wstrict-overflow=2}.
3842 @item -Wstrict-overflow=3
3843 Also warn about other cases where a comparison is simplified.  For
3844 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
3846 @item -Wstrict-overflow=4
3847 Also warn about other simplifications not covered by the above cases.
3848 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
3850 @item -Wstrict-overflow=5
3851 Also warn about cases where the compiler reduces the magnitude of a
3852 constant involved in a comparison.  For example: @code{x + 2 > y} is
3853 simplified to @code{x + 1 >= y}.  This is reported only at the
3854 highest warning level because this simplification applies to many
3855 comparisons, so this warning level gives a very large number of
3856 false positives.
3857 @end table
3859 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
3860 @opindex Wsuggest-attribute=
3861 @opindex Wno-suggest-attribute=
3862 Warn for cases where adding an attribute may be beneficial. The
3863 attributes currently supported are listed below.
3865 @table @gcctabopt
3866 @item -Wsuggest-attribute=pure
3867 @itemx -Wsuggest-attribute=const
3868 @itemx -Wsuggest-attribute=noreturn
3869 @opindex Wsuggest-attribute=pure
3870 @opindex Wno-suggest-attribute=pure
3871 @opindex Wsuggest-attribute=const
3872 @opindex Wno-suggest-attribute=const
3873 @opindex Wsuggest-attribute=noreturn
3874 @opindex Wno-suggest-attribute=noreturn
3876 Warn about functions that might be candidates for attributes
3877 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3878 functions visible in other compilation units or (in the case of @code{pure} and
3879 @code{const}) if it cannot prove that the function returns normally. A function
3880 returns normally if it doesn't contain an infinite loop nor returns abnormally
3881 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3882 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3883 higher.  Higher optimization levels improve the accuracy of the analysis.
3885 @item -Wsuggest-attribute=format
3886 @itemx -Wmissing-format-attribute
3887 @opindex Wsuggest-attribute=format
3888 @opindex Wmissing-format-attribute
3889 @opindex Wno-suggest-attribute=format
3890 @opindex Wno-missing-format-attribute
3891 @opindex Wformat
3892 @opindex Wno-format
3894 Warn about function pointers that might be candidates for @code{format}
3895 attributes.  Note these are only possible candidates, not absolute ones.
3896 GCC guesses that function pointers with @code{format} attributes that
3897 are used in assignment, initialization, parameter passing or return
3898 statements should have a corresponding @code{format} attribute in the
3899 resulting type.  I.e.@: the left-hand side of the assignment or
3900 initialization, the type of the parameter variable, or the return type
3901 of the containing function respectively should also have a @code{format}
3902 attribute to avoid the warning.
3904 GCC also warns about function definitions that might be
3905 candidates for @code{format} attributes.  Again, these are only
3906 possible candidates.  GCC guesses that @code{format} attributes
3907 might be appropriate for any function that calls a function like
3908 @code{vprintf} or @code{vscanf}, but this might not always be the
3909 case, and some functions for which @code{format} attributes are
3910 appropriate may not be detected.
3911 @end table
3913 @item -Warray-bounds
3914 @opindex Wno-array-bounds
3915 @opindex Warray-bounds
3916 This option is only active when @option{-ftree-vrp} is active
3917 (default for @option{-O2} and above). It warns about subscripts to arrays
3918 that are always out of bounds. This warning is enabled by @option{-Wall}.
3920 @item -Wno-div-by-zero
3921 @opindex Wno-div-by-zero
3922 @opindex Wdiv-by-zero
3923 Do not warn about compile-time integer division by zero.  Floating-point
3924 division by zero is not warned about, as it can be a legitimate way of
3925 obtaining infinities and NaNs.
3927 @item -Wsystem-headers
3928 @opindex Wsystem-headers
3929 @opindex Wno-system-headers
3930 @cindex warnings from system headers
3931 @cindex system headers, warnings from
3932 Print warning messages for constructs found in system header files.
3933 Warnings from system headers are normally suppressed, on the assumption
3934 that they usually do not indicate real problems and would only make the
3935 compiler output harder to read.  Using this command-line option tells
3936 GCC to emit warnings from system headers as if they occurred in user
3937 code.  However, note that using @option{-Wall} in conjunction with this
3938 option does @emph{not} warn about unknown pragmas in system
3939 headers---for that, @option{-Wunknown-pragmas} must also be used.
3941 @item -Wtrampolines
3942 @opindex Wtrampolines
3943 @opindex Wno-trampolines
3944  Warn about trampolines generated for pointers to nested functions.
3946  A trampoline is a small piece of data or code that is created at run
3947  time on the stack when the address of a nested function is taken, and
3948  is used to call the nested function indirectly.  For some targets, it
3949  is made up of data only and thus requires no special treatment.  But,
3950  for most targets, it is made up of code and thus requires the stack
3951  to be made executable in order for the program to work properly.
3953 @item -Wfloat-equal
3954 @opindex Wfloat-equal
3955 @opindex Wno-float-equal
3956 Warn if floating-point values are used in equality comparisons.
3958 The idea behind this is that sometimes it is convenient (for the
3959 programmer) to consider floating-point values as approximations to
3960 infinitely precise real numbers.  If you are doing this, then you need
3961 to compute (by analyzing the code, or in some other way) the maximum or
3962 likely maximum error that the computation introduces, and allow for it
3963 when performing comparisons (and when producing output, but that's a
3964 different problem).  In particular, instead of testing for equality, you
3965 should check to see whether the two values have ranges that overlap; and
3966 this is done with the relational operators, so equality comparisons are
3967 probably mistaken.
3969 @item -Wtraditional @r{(C and Objective-C only)}
3970 @opindex Wtraditional
3971 @opindex Wno-traditional
3972 Warn about certain constructs that behave differently in traditional and
3973 ISO C@.  Also warn about ISO C constructs that have no traditional C
3974 equivalent, and/or problematic constructs that should be avoided.
3976 @itemize @bullet
3977 @item
3978 Macro parameters that appear within string literals in the macro body.
3979 In traditional C macro replacement takes place within string literals,
3980 but does not in ISO C@.
3982 @item
3983 In traditional C, some preprocessor directives did not exist.
3984 Traditional preprocessors only considered a line to be a directive
3985 if the @samp{#} appeared in column 1 on the line.  Therefore
3986 @option{-Wtraditional} warns about directives that traditional C
3987 understands but ignores because the @samp{#} does not appear as the
3988 first character on the line.  It also suggests you hide directives like
3989 @samp{#pragma} not understood by traditional C by indenting them.  Some
3990 traditional implementations do not recognize @samp{#elif}, so this option
3991 suggests avoiding it altogether.
3993 @item
3994 A function-like macro that appears without arguments.
3996 @item
3997 The unary plus operator.
3999 @item
4000 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4001 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4002 constants.)  Note, these suffixes appear in macros defined in the system
4003 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4004 Use of these macros in user code might normally lead to spurious
4005 warnings, however GCC's integrated preprocessor has enough context to
4006 avoid warning in these cases.
4008 @item
4009 A function declared external in one block and then used after the end of
4010 the block.
4012 @item
4013 A @code{switch} statement has an operand of type @code{long}.
4015 @item
4016 A non-@code{static} function declaration follows a @code{static} one.
4017 This construct is not accepted by some traditional C compilers.
4019 @item
4020 The ISO type of an integer constant has a different width or
4021 signedness from its traditional type.  This warning is only issued if
4022 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4023 typically represent bit patterns, are not warned about.
4025 @item
4026 Usage of ISO string concatenation is detected.
4028 @item
4029 Initialization of automatic aggregates.
4031 @item
4032 Identifier conflicts with labels.  Traditional C lacks a separate
4033 namespace for labels.
4035 @item
4036 Initialization of unions.  If the initializer is zero, the warning is
4037 omitted.  This is done under the assumption that the zero initializer in
4038 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4039 initializer warnings and relies on default initialization to zero in the
4040 traditional C case.
4042 @item
4043 Conversions by prototypes between fixed/floating-point values and vice
4044 versa.  The absence of these prototypes when compiling with traditional
4045 C causes serious problems.  This is a subset of the possible
4046 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4048 @item
4049 Use of ISO C style function definitions.  This warning intentionally is
4050 @emph{not} issued for prototype declarations or variadic functions
4051 because these ISO C features appear in your code when using
4052 libiberty's traditional C compatibility macros, @code{PARAMS} and
4053 @code{VPARAMS}.  This warning is also bypassed for nested functions
4054 because that feature is already a GCC extension and thus not relevant to
4055 traditional C compatibility.
4056 @end itemize
4058 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4059 @opindex Wtraditional-conversion
4060 @opindex Wno-traditional-conversion
4061 Warn if a prototype causes a type conversion that is different from what
4062 would happen to the same argument in the absence of a prototype.  This
4063 includes conversions of fixed point to floating and vice versa, and
4064 conversions changing the width or signedness of a fixed-point argument
4065 except when the same as the default promotion.
4067 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4068 @opindex Wdeclaration-after-statement
4069 @opindex Wno-declaration-after-statement
4070 Warn when a declaration is found after a statement in a block.  This
4071 construct, known from C++, was introduced with ISO C99 and is by default
4072 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4073 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4075 @item -Wundef
4076 @opindex Wundef
4077 @opindex Wno-undef
4078 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4080 @item -Wno-endif-labels
4081 @opindex Wno-endif-labels
4082 @opindex Wendif-labels
4083 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4085 @item -Wshadow
4086 @opindex Wshadow
4087 @opindex Wno-shadow
4088 Warn whenever a local variable or type declaration shadows another variable,
4089 parameter, type, or class member (in C++), or whenever a built-in function
4090 is shadowed. Note that in C++, the compiler warns if a local variable
4091 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4093 @item -Wlarger-than=@var{len}
4094 @opindex Wlarger-than=@var{len}
4095 @opindex Wlarger-than-@var{len}
4096 Warn whenever an object of larger than @var{len} bytes is defined.
4098 @item -Wframe-larger-than=@var{len}
4099 @opindex Wframe-larger-than
4100 Warn if the size of a function frame is larger than @var{len} bytes.
4101 The computation done to determine the stack frame size is approximate
4102 and not conservative.
4103 The actual requirements may be somewhat greater than @var{len}
4104 even if you do not get a warning.  In addition, any space allocated
4105 via @code{alloca}, variable-length arrays, or related constructs
4106 is not included by the compiler when determining
4107 whether or not to issue a warning.
4109 @item -Wno-free-nonheap-object
4110 @opindex Wno-free-nonheap-object
4111 @opindex Wfree-nonheap-object
4112 Do not warn when attempting to free an object that was not allocated
4113 on the heap.
4115 @item -Wstack-usage=@var{len}
4116 @opindex Wstack-usage
4117 Warn if the stack usage of a function might be larger than @var{len} bytes.
4118 The computation done to determine the stack usage is conservative.
4119 Any space allocated via @code{alloca}, variable-length arrays, or related
4120 constructs is included by the compiler when determining whether or not to
4121 issue a warning.
4123 The message is in keeping with the output of @option{-fstack-usage}.
4125 @itemize
4126 @item
4127 If the stack usage is fully static but exceeds the specified amount, it's:
4129 @smallexample
4130   warning: stack usage is 1120 bytes
4131 @end smallexample
4132 @item
4133 If the stack usage is (partly) dynamic but bounded, it's:
4135 @smallexample
4136   warning: stack usage might be 1648 bytes
4137 @end smallexample
4138 @item
4139 If the stack usage is (partly) dynamic and not bounded, it's:
4141 @smallexample
4142   warning: stack usage might be unbounded
4143 @end smallexample
4144 @end itemize
4146 @item -Wunsafe-loop-optimizations
4147 @opindex Wunsafe-loop-optimizations
4148 @opindex Wno-unsafe-loop-optimizations
4149 Warn if the loop cannot be optimized because the compiler cannot
4150 assume anything on the bounds of the loop indices.  With
4151 @option{-funsafe-loop-optimizations} warn if the compiler makes
4152 such assumptions.
4154 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4155 @opindex Wno-pedantic-ms-format
4156 @opindex Wpedantic-ms-format
4157 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
4158 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
4159 depending on the MS runtime, when you are using the options @option{-Wformat}
4160 and @option{-Wpedantic} without gnu-extensions.
4162 @item -Wpointer-arith
4163 @opindex Wpointer-arith
4164 @opindex Wno-pointer-arith
4165 Warn about anything that depends on the ``size of'' a function type or
4166 of @code{void}.  GNU C assigns these types a size of 1, for
4167 convenience in calculations with @code{void *} pointers and pointers
4168 to functions.  In C++, warn also when an arithmetic operation involves
4169 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4171 @item -Wtype-limits
4172 @opindex Wtype-limits
4173 @opindex Wno-type-limits
4174 Warn if a comparison is always true or always false due to the limited
4175 range of the data type, but do not warn for constant expressions.  For
4176 example, warn if an unsigned variable is compared against zero with
4177 @samp{<} or @samp{>=}.  This warning is also enabled by
4178 @option{-Wextra}.
4180 @item -Wbad-function-cast @r{(C and Objective-C only)}
4181 @opindex Wbad-function-cast
4182 @opindex Wno-bad-function-cast
4183 Warn whenever a function call is cast to a non-matching type.
4184 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4186 @item -Wc++-compat @r{(C and Objective-C only)}
4187 Warn about ISO C constructs that are outside of the common subset of
4188 ISO C and ISO C++, e.g.@: request for implicit conversion from
4189 @code{void *} to a pointer to non-@code{void} type.
4191 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4192 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4193 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4194 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4195 enabled by @option{-Wall}.
4197 @item -Wcast-qual
4198 @opindex Wcast-qual
4199 @opindex Wno-cast-qual
4200 Warn whenever a pointer is cast so as to remove a type qualifier from
4201 the target type.  For example, warn if a @code{const char *} is cast
4202 to an ordinary @code{char *}.
4204 Also warn when making a cast that introduces a type qualifier in an
4205 unsafe way.  For example, casting @code{char **} to @code{const char **}
4206 is unsafe, as in this example:
4208 @smallexample
4209   /* p is char ** value.  */
4210   const char **q = (const char **) p;
4211   /* Assignment of readonly string to const char * is OK.  */
4212   *q = "string";
4213   /* Now char** pointer points to read-only memory.  */
4214   **p = 'b';
4215 @end smallexample
4217 @item -Wcast-align
4218 @opindex Wcast-align
4219 @opindex Wno-cast-align
4220 Warn whenever a pointer is cast such that the required alignment of the
4221 target is increased.  For example, warn if a @code{char *} is cast to
4222 an @code{int *} on machines where integers can only be accessed at
4223 two- or four-byte boundaries.
4225 @item -Wwrite-strings
4226 @opindex Wwrite-strings
4227 @opindex Wno-write-strings
4228 When compiling C, give string constants the type @code{const
4229 char[@var{length}]} so that copying the address of one into a
4230 non-@code{const} @code{char *} pointer produces a warning.  These
4231 warnings help you find at compile time code that can try to write
4232 into a string constant, but only if you have been very careful about
4233 using @code{const} in declarations and prototypes.  Otherwise, it is
4234 just a nuisance. This is why we did not make @option{-Wall} request
4235 these warnings.
4237 When compiling C++, warn about the deprecated conversion from string
4238 literals to @code{char *}.  This warning is enabled by default for C++
4239 programs.
4241 @item -Wclobbered
4242 @opindex Wclobbered
4243 @opindex Wno-clobbered
4244 Warn for variables that might be changed by @samp{longjmp} or
4245 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4247 @item -Wconversion
4248 @opindex Wconversion
4249 @opindex Wno-conversion
4250 Warn for implicit conversions that may alter a value. This includes
4251 conversions between real and integer, like @code{abs (x)} when
4252 @code{x} is @code{double}; conversions between signed and unsigned,
4253 like @code{unsigned ui = -1}; and conversions to smaller types, like
4254 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4255 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4256 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4257 conversions between signed and unsigned integers can be disabled by
4258 using @option{-Wno-sign-conversion}.
4260 For C++, also warn for confusing overload resolution for user-defined
4261 conversions; and conversions that never use a type conversion
4262 operator: conversions to @code{void}, the same type, a base class or a
4263 reference to them. Warnings about conversions between signed and
4264 unsigned integers are disabled by default in C++ unless
4265 @option{-Wsign-conversion} is explicitly enabled.
4267 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4268 @opindex Wconversion-null
4269 @opindex Wno-conversion-null
4270 Do not warn for conversions between @code{NULL} and non-pointer
4271 types. @option{-Wconversion-null} is enabled by default.
4273 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4274 @opindex Wzero-as-null-pointer-constant
4275 @opindex Wno-zero-as-null-pointer-constant
4276 Warn when a literal '0' is used as null pointer constant.  This can
4277 be useful to facilitate the conversion to @code{nullptr} in C++11.
4279 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4280 @opindex Wuseless-cast
4281 @opindex Wno-useless-cast
4282 Warn when an expression is casted to its own type.
4284 @item -Wempty-body
4285 @opindex Wempty-body
4286 @opindex Wno-empty-body
4287 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4288 while} statement.  This warning is also enabled by @option{-Wextra}.
4290 @item -Wenum-compare
4291 @opindex Wenum-compare
4292 @opindex Wno-enum-compare
4293 Warn about a comparison between values of different enumerated types.
4294 In C++ enumeral mismatches in conditional expressions are also
4295 diagnosed and the warning is enabled by default.  In C this warning is 
4296 enabled by @option{-Wall}.
4298 @item -Wjump-misses-init @r{(C, Objective-C only)}
4299 @opindex Wjump-misses-init
4300 @opindex Wno-jump-misses-init
4301 Warn if a @code{goto} statement or a @code{switch} statement jumps
4302 forward across the initialization of a variable, or jumps backward to a
4303 label after the variable has been initialized.  This only warns about
4304 variables that are initialized when they are declared.  This warning is
4305 only supported for C and Objective-C; in C++ this sort of branch is an
4306 error in any case.
4308 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4309 can be disabled with the @option{-Wno-jump-misses-init} option.
4311 @item -Wsign-compare
4312 @opindex Wsign-compare
4313 @opindex Wno-sign-compare
4314 @cindex warning for comparison of signed and unsigned values
4315 @cindex comparison of signed and unsigned values, warning
4316 @cindex signed and unsigned values, comparison warning
4317 Warn when a comparison between signed and unsigned values could produce
4318 an incorrect result when the signed value is converted to unsigned.
4319 This warning is also enabled by @option{-Wextra}; to get the other warnings
4320 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4322 @item -Wsign-conversion
4323 @opindex Wsign-conversion
4324 @opindex Wno-sign-conversion
4325 Warn for implicit conversions that may change the sign of an integer
4326 value, like assigning a signed integer expression to an unsigned
4327 integer variable. An explicit cast silences the warning. In C, this
4328 option is enabled also by @option{-Wconversion}.
4330 @item -Waddress
4331 @opindex Waddress
4332 @opindex Wno-address
4333 Warn about suspicious uses of memory addresses. These include using
4334 the address of a function in a conditional expression, such as
4335 @code{void func(void); if (func)}, and comparisons against the memory
4336 address of a string literal, such as @code{if (x == "abc")}.  Such
4337 uses typically indicate a programmer error: the address of a function
4338 always evaluates to true, so their use in a conditional usually
4339 indicate that the programmer forgot the parentheses in a function
4340 call; and comparisons against string literals result in unspecified
4341 behavior and are not portable in C, so they usually indicate that the
4342 programmer intended to use @code{strcmp}.  This warning is enabled by
4343 @option{-Wall}.
4345 @item -Wlogical-op
4346 @opindex Wlogical-op
4347 @opindex Wno-logical-op
4348 Warn about suspicious uses of logical operators in expressions.
4349 This includes using logical operators in contexts where a
4350 bit-wise operator is likely to be expected.
4352 @item -Waggregate-return
4353 @opindex Waggregate-return
4354 @opindex Wno-aggregate-return
4355 Warn if any functions that return structures or unions are defined or
4356 called.  (In languages where you can return an array, this also elicits
4357 a warning.)
4359 @item -Wno-attributes
4360 @opindex Wno-attributes
4361 @opindex Wattributes
4362 Do not warn if an unexpected @code{__attribute__} is used, such as
4363 unrecognized attributes, function attributes applied to variables,
4364 etc.  This does not stop errors for incorrect use of supported
4365 attributes.
4367 @item -Wno-builtin-macro-redefined
4368 @opindex Wno-builtin-macro-redefined
4369 @opindex Wbuiltin-macro-redefined
4370 Do not warn if certain built-in macros are redefined.  This suppresses
4371 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4372 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4374 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4375 @opindex Wstrict-prototypes
4376 @opindex Wno-strict-prototypes
4377 Warn if a function is declared or defined without specifying the
4378 argument types.  (An old-style function definition is permitted without
4379 a warning if preceded by a declaration that specifies the argument
4380 types.)
4382 @item -Wold-style-declaration @r{(C and Objective-C only)}
4383 @opindex Wold-style-declaration
4384 @opindex Wno-old-style-declaration
4385 Warn for obsolescent usages, according to the C Standard, in a
4386 declaration. For example, warn if storage-class specifiers like
4387 @code{static} are not the first things in a declaration.  This warning
4388 is also enabled by @option{-Wextra}.
4390 @item -Wold-style-definition @r{(C and Objective-C only)}
4391 @opindex Wold-style-definition
4392 @opindex Wno-old-style-definition
4393 Warn if an old-style function definition is used.  A warning is given
4394 even if there is a previous prototype.
4396 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4397 @opindex Wmissing-parameter-type
4398 @opindex Wno-missing-parameter-type
4399 A function parameter is declared without a type specifier in K&R-style
4400 functions:
4402 @smallexample
4403 void foo(bar) @{ @}
4404 @end smallexample
4406 This warning is also enabled by @option{-Wextra}.
4408 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4409 @opindex Wmissing-prototypes
4410 @opindex Wno-missing-prototypes
4411 Warn if a global function is defined without a previous prototype
4412 declaration.  This warning is issued even if the definition itself
4413 provides a prototype.  Use this option to detect global functions
4414 that do not have a matching prototype declaration in a header file.
4415 This option is not valid for C++ because all function declarations
4416 provide prototypes and a non-matching declaration will declare an
4417 overload rather than conflict with an earlier declaration.
4418 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4420 @item -Wmissing-declarations
4421 @opindex Wmissing-declarations
4422 @opindex Wno-missing-declarations
4423 Warn if a global function is defined without a previous declaration.
4424 Do so even if the definition itself provides a prototype.
4425 Use this option to detect global functions that are not declared in
4426 header files.  In C, no warnings are issued for functions with previous
4427 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4428 missing prototypes.  In C++, no warnings are issued for function templates,
4429 or for inline functions, or for functions in anonymous namespaces.
4431 @item -Wmissing-field-initializers
4432 @opindex Wmissing-field-initializers
4433 @opindex Wno-missing-field-initializers
4434 @opindex W
4435 @opindex Wextra
4436 @opindex Wno-extra
4437 Warn if a structure's initializer has some fields missing.  For
4438 example, the following code causes such a warning, because
4439 @code{x.h} is implicitly zero:
4441 @smallexample
4442 struct s @{ int f, g, h; @};
4443 struct s x = @{ 3, 4 @};
4444 @end smallexample
4446 This option does not warn about designated initializers, so the following
4447 modification does not trigger a warning:
4449 @smallexample
4450 struct s @{ int f, g, h; @};
4451 struct s x = @{ .f = 3, .g = 4 @};
4452 @end smallexample
4454 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4455 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4457 @item -Wno-multichar
4458 @opindex Wno-multichar
4459 @opindex Wmultichar
4460 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4461 Usually they indicate a typo in the user's code, as they have
4462 implementation-defined values, and should not be used in portable code.
4464 @item -Wnormalized=<none|id|nfc|nfkc>
4465 @opindex Wnormalized=
4466 @cindex NFC
4467 @cindex NFKC
4468 @cindex character set, input normalization
4469 In ISO C and ISO C++, two identifiers are different if they are
4470 different sequences of characters.  However, sometimes when characters
4471 outside the basic ASCII character set are used, you can have two
4472 different character sequences that look the same.  To avoid confusion,
4473 the ISO 10646 standard sets out some @dfn{normalization rules} which
4474 when applied ensure that two sequences that look the same are turned into
4475 the same sequence.  GCC can warn you if you are using identifiers that
4476 have not been normalized; this option controls that warning.
4478 There are four levels of warning supported by GCC@.  The default is
4479 @option{-Wnormalized=nfc}, which warns about any identifier that is
4480 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4481 recommended form for most uses.
4483 Unfortunately, there are some characters allowed in identifiers by
4484 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4485 identifiers.  That is, there's no way to use these symbols in portable
4486 ISO C or C++ and have all your identifiers in NFC@.
4487 @option{-Wnormalized=id} suppresses the warning for these characters.
4488 It is hoped that future versions of the standards involved will correct
4489 this, which is why this option is not the default.
4491 You can switch the warning off for all characters by writing
4492 @option{-Wnormalized=none}.  You should only do this if you
4493 are using some other normalization scheme (like ``D''), because
4494 otherwise you can easily create bugs that are literally impossible to see.
4496 Some characters in ISO 10646 have distinct meanings but look identical
4497 in some fonts or display methodologies, especially once formatting has
4498 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4499 LETTER N'', displays just like a regular @code{n} that has been
4500 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4501 normalization scheme to convert all these into a standard form as
4502 well, and GCC warns if your code is not in NFKC if you use
4503 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4504 about every identifier that contains the letter O because it might be
4505 confused with the digit 0, and so is not the default, but may be
4506 useful as a local coding convention if the programming environment 
4507 cannot be fixed to display these characters distinctly.
4509 @item -Wno-deprecated
4510 @opindex Wno-deprecated
4511 @opindex Wdeprecated
4512 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4514 @item -Wno-deprecated-declarations
4515 @opindex Wno-deprecated-declarations
4516 @opindex Wdeprecated-declarations
4517 Do not warn about uses of functions (@pxref{Function Attributes}),
4518 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4519 Attributes}) marked as deprecated by using the @code{deprecated}
4520 attribute.
4522 @item -Wno-overflow
4523 @opindex Wno-overflow
4524 @opindex Woverflow
4525 Do not warn about compile-time overflow in constant expressions.
4527 @item -Woverride-init @r{(C and Objective-C only)}
4528 @opindex Woverride-init
4529 @opindex Wno-override-init
4530 @opindex W
4531 @opindex Wextra
4532 @opindex Wno-extra
4533 Warn if an initialized field without side effects is overridden when
4534 using designated initializers (@pxref{Designated Inits, , Designated
4535 Initializers}).
4537 This warning is included in @option{-Wextra}.  To get other
4538 @option{-Wextra} warnings without this one, use @option{-Wextra
4539 -Wno-override-init}.
4541 @item -Wpacked
4542 @opindex Wpacked
4543 @opindex Wno-packed
4544 Warn if a structure is given the packed attribute, but the packed
4545 attribute has no effect on the layout or size of the structure.
4546 Such structures may be mis-aligned for little benefit.  For
4547 instance, in this code, the variable @code{f.x} in @code{struct bar}
4548 is misaligned even though @code{struct bar} does not itself
4549 have the packed attribute:
4551 @smallexample
4552 @group
4553 struct foo @{
4554   int x;
4555   char a, b, c, d;
4556 @} __attribute__((packed));
4557 struct bar @{
4558   char z;
4559   struct foo f;
4561 @end group
4562 @end smallexample
4564 @item -Wpacked-bitfield-compat
4565 @opindex Wpacked-bitfield-compat
4566 @opindex Wno-packed-bitfield-compat
4567 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4568 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4569 the change can lead to differences in the structure layout.  GCC
4570 informs you when the offset of such a field has changed in GCC 4.4.
4571 For example there is no longer a 4-bit padding between field @code{a}
4572 and @code{b} in this structure:
4574 @smallexample
4575 struct foo
4577   char a:4;
4578   char b:8;
4579 @} __attribute__ ((packed));
4580 @end smallexample
4582 This warning is enabled by default.  Use
4583 @option{-Wno-packed-bitfield-compat} to disable this warning.
4585 @item -Wpadded
4586 @opindex Wpadded
4587 @opindex Wno-padded
4588 Warn if padding is included in a structure, either to align an element
4589 of the structure or to align the whole structure.  Sometimes when this
4590 happens it is possible to rearrange the fields of the structure to
4591 reduce the padding and so make the structure smaller.
4593 @item -Wredundant-decls
4594 @opindex Wredundant-decls
4595 @opindex Wno-redundant-decls
4596 Warn if anything is declared more than once in the same scope, even in
4597 cases where multiple declaration is valid and changes nothing.
4599 @item -Wnested-externs @r{(C and Objective-C only)}
4600 @opindex Wnested-externs
4601 @opindex Wno-nested-externs
4602 Warn if an @code{extern} declaration is encountered within a function.
4604 @item -Winline
4605 @opindex Winline
4606 @opindex Wno-inline
4607 Warn if a function that is declared as inline cannot be inlined.
4608 Even with this option, the compiler does not warn about failures to
4609 inline functions declared in system headers.
4611 The compiler uses a variety of heuristics to determine whether or not
4612 to inline a function.  For example, the compiler takes into account
4613 the size of the function being inlined and the amount of inlining
4614 that has already been done in the current function.  Therefore,
4615 seemingly insignificant changes in the source program can cause the
4616 warnings produced by @option{-Winline} to appear or disappear.
4618 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4619 @opindex Wno-invalid-offsetof
4620 @opindex Winvalid-offsetof
4621 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4622 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4623 to a non-POD type is undefined.  In existing C++ implementations,
4624 however, @samp{offsetof} typically gives meaningful results even when
4625 applied to certain kinds of non-POD types. (Such as a simple
4626 @samp{struct} that fails to be a POD type only by virtue of having a
4627 constructor.)  This flag is for users who are aware that they are
4628 writing nonportable code and who have deliberately chosen to ignore the
4629 warning about it.
4631 The restrictions on @samp{offsetof} may be relaxed in a future version
4632 of the C++ standard.
4634 @item -Wno-int-to-pointer-cast
4635 @opindex Wno-int-to-pointer-cast
4636 @opindex Wint-to-pointer-cast
4637 Suppress warnings from casts to pointer type of an integer of a
4638 different size. In C++, casting to a pointer type of smaller size is
4639 an error. @option{Wint-to-pointer-cast} is enabled by default.
4642 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4643 @opindex Wno-pointer-to-int-cast
4644 @opindex Wpointer-to-int-cast
4645 Suppress warnings from casts from a pointer to an integer type of a
4646 different size.
4648 @item -Winvalid-pch
4649 @opindex Winvalid-pch
4650 @opindex Wno-invalid-pch
4651 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4652 the search path but can't be used.
4654 @item -Wlong-long
4655 @opindex Wlong-long
4656 @opindex Wno-long-long
4657 Warn if @samp{long long} type is used.  This is enabled by either
4658 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4659 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4661 @item -Wvariadic-macros
4662 @opindex Wvariadic-macros
4663 @opindex Wno-variadic-macros
4664 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4665 alternate syntax when in pedantic ISO C99 mode.  This is default.
4666 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4668 @item -Wvarargs
4669 @opindex Wvarargs
4670 @opindex Wno-varargs
4671 Warn upon questionable usage of the macros used to handle variable
4672 arguments like @samp{va_start}.  This is default.  To inhibit the
4673 warning messages, use @option{-Wno-varargs}.
4675 @item -Wvector-operation-performance
4676 @opindex Wvector-operation-performance
4677 @opindex Wno-vector-operation-performance
4678 Warn if vector operation is not implemented via SIMD capabilities of the
4679 architecture.  Mainly useful for the performance tuning.
4680 Vector operation can be implemented @code{piecewise}, which means that the
4681 scalar operation is performed on every vector element; 
4682 @code{in parallel}, which means that the vector operation is implemented
4683 using scalars of wider type, which normally is more performance efficient;
4684 and @code{as a single scalar}, which means that vector fits into a
4685 scalar type.
4687 @item -Wvla
4688 @opindex Wvla
4689 @opindex Wno-vla
4690 Warn if variable length array is used in the code.
4691 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4692 the variable length array.
4694 @item -Wvolatile-register-var
4695 @opindex Wvolatile-register-var
4696 @opindex Wno-volatile-register-var
4697 Warn if a register variable is declared volatile.  The volatile
4698 modifier does not inhibit all optimizations that may eliminate reads
4699 and/or writes to register variables.  This warning is enabled by
4700 @option{-Wall}.
4702 @item -Wdisabled-optimization
4703 @opindex Wdisabled-optimization
4704 @opindex Wno-disabled-optimization
4705 Warn if a requested optimization pass is disabled.  This warning does
4706 not generally indicate that there is anything wrong with your code; it
4707 merely indicates that GCC's optimizers are unable to handle the code
4708 effectively.  Often, the problem is that your code is too big or too
4709 complex; GCC refuses to optimize programs when the optimization
4710 itself is likely to take inordinate amounts of time.
4712 @item -Wpointer-sign @r{(C and Objective-C only)}
4713 @opindex Wpointer-sign
4714 @opindex Wno-pointer-sign
4715 Warn for pointer argument passing or assignment with different signedness.
4716 This option is only supported for C and Objective-C@.  It is implied by
4717 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
4718 @option{-Wno-pointer-sign}.
4720 @item -Wstack-protector
4721 @opindex Wstack-protector
4722 @opindex Wno-stack-protector
4723 This option is only active when @option{-fstack-protector} is active.  It
4724 warns about functions that are not protected against stack smashing.
4726 @item -Wno-mudflap
4727 @opindex Wno-mudflap
4728 Suppress warnings about constructs that cannot be instrumented by
4729 @option{-fmudflap}.
4731 @item -Woverlength-strings
4732 @opindex Woverlength-strings
4733 @opindex Wno-overlength-strings
4734 Warn about string constants that are longer than the ``minimum
4735 maximum'' length specified in the C standard.  Modern compilers
4736 generally allow string constants that are much longer than the
4737 standard's minimum limit, but very portable programs should avoid
4738 using longer strings.
4740 The limit applies @emph{after} string constant concatenation, and does
4741 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4742 C99, it was raised to 4095.  C++98 does not specify a normative
4743 minimum maximum, so we do not diagnose overlength strings in C++@.
4745 This option is implied by @option{-Wpedantic}, and can be disabled with
4746 @option{-Wno-overlength-strings}.
4748 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4749 @opindex Wunsuffixed-float-constants
4751 Issue a warning for any floating constant that does not have
4752 a suffix.  When used together with @option{-Wsystem-headers} it
4753 warns about such constants in system header files.  This can be useful
4754 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4755 from the decimal floating-point extension to C99.
4756 @end table
4758 @node Debugging Options
4759 @section Options for Debugging Your Program or GCC
4760 @cindex options, debugging
4761 @cindex debugging information options
4763 GCC has various special options that are used for debugging
4764 either your program or GCC:
4766 @table @gcctabopt
4767 @item -g
4768 @opindex g
4769 Produce debugging information in the operating system's native format
4770 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4771 information.
4773 On most systems that use stabs format, @option{-g} enables use of extra
4774 debugging information that only GDB can use; this extra information
4775 makes debugging work better in GDB but probably makes other debuggers
4776 crash or
4777 refuse to read the program.  If you want to control for certain whether
4778 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4779 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4781 GCC allows you to use @option{-g} with
4782 @option{-O}.  The shortcuts taken by optimized code may occasionally
4783 produce surprising results: some variables you declared may not exist
4784 at all; flow of control may briefly move where you did not expect it;
4785 some statements may not be executed because they compute constant
4786 results or their values are already at hand; some statements may
4787 execute in different places because they have been moved out of loops.
4789 Nevertheless it proves possible to debug optimized output.  This makes
4790 it reasonable to use the optimizer for programs that might have bugs.
4792 The following options are useful when GCC is generated with the
4793 capability for more than one debugging format.
4795 @item -ggdb
4796 @opindex ggdb
4797 Produce debugging information for use by GDB@.  This means to use the
4798 most expressive format available (DWARF 2, stabs, or the native format
4799 if neither of those are supported), including GDB extensions if at all
4800 possible.
4802 @item -gpubnames
4803 @opindex gpubnames
4804 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
4806 @item -gstabs
4807 @opindex gstabs
4808 Produce debugging information in stabs format (if that is supported),
4809 without GDB extensions.  This is the format used by DBX on most BSD
4810 systems.  On MIPS, Alpha and System V Release 4 systems this option
4811 produces stabs debugging output that is not understood by DBX or SDB@.
4812 On System V Release 4 systems this option requires the GNU assembler.
4814 @item -feliminate-unused-debug-symbols
4815 @opindex feliminate-unused-debug-symbols
4816 Produce debugging information in stabs format (if that is supported),
4817 for only symbols that are actually used.
4819 @item -femit-class-debug-always
4820 Instead of emitting debugging information for a C++ class in only one
4821 object file, emit it in all object files using the class.  This option
4822 should be used only with debuggers that are unable to handle the way GCC
4823 normally emits debugging information for classes because using this
4824 option increases the size of debugging information by as much as a
4825 factor of two.
4827 @item -fdebug-types-section
4828 @opindex fdebug-types-section
4829 @opindex fno-debug-types-section
4830 When using DWARF Version 4 or higher, type DIEs can be put into
4831 their own @code{.debug_types} section instead of making them part of the
4832 @code{.debug_info} section.  It is more efficient to put them in a separate
4833 comdat sections since the linker can then remove duplicates.
4834 But not all DWARF consumers support @code{.debug_types} sections yet
4835 and on some objects @code{.debug_types} produces larger instead of smaller
4836 debugging information.
4838 @item -gstabs+
4839 @opindex gstabs+
4840 Produce debugging information in stabs format (if that is supported),
4841 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4842 use of these extensions is likely to make other debuggers crash or
4843 refuse to read the program.
4845 @item -gcoff
4846 @opindex gcoff
4847 Produce debugging information in COFF format (if that is supported).
4848 This is the format used by SDB on most System V systems prior to
4849 System V Release 4.
4851 @item -gxcoff
4852 @opindex gxcoff
4853 Produce debugging information in XCOFF format (if that is supported).
4854 This is the format used by the DBX debugger on IBM RS/6000 systems.
4856 @item -gxcoff+
4857 @opindex gxcoff+
4858 Produce debugging information in XCOFF format (if that is supported),
4859 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4860 use of these extensions is likely to make other debuggers crash or
4861 refuse to read the program, and may cause assemblers other than the GNU
4862 assembler (GAS) to fail with an error.
4864 @item -gdwarf-@var{version}
4865 @opindex gdwarf-@var{version}
4866 Produce debugging information in DWARF format (if that is supported).
4867 The value of @var{version} may be either 2, 3 or 4; the default version
4868 for most targets is 4.
4870 Note that with DWARF Version 2, some ports require and always
4871 use some non-conflicting DWARF 3 extensions in the unwind tables.
4873 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4874 for maximum benefit.
4876 @item -grecord-gcc-switches
4877 @opindex grecord-gcc-switches
4878 This switch causes the command-line options used to invoke the
4879 compiler that may affect code generation to be appended to the
4880 DW_AT_producer attribute in DWARF debugging information.  The options
4881 are concatenated with spaces separating them from each other and from
4882 the compiler version.  See also @option{-frecord-gcc-switches} for another
4883 way of storing compiler options into the object file.  This is the default.
4885 @item -gno-record-gcc-switches
4886 @opindex gno-record-gcc-switches
4887 Disallow appending command-line options to the DW_AT_producer attribute
4888 in DWARF debugging information.
4890 @item -gstrict-dwarf
4891 @opindex gstrict-dwarf
4892 Disallow using extensions of later DWARF standard version than selected
4893 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4894 DWARF extensions from later standard versions is allowed.
4896 @item -gno-strict-dwarf
4897 @opindex gno-strict-dwarf
4898 Allow using extensions of later DWARF standard version than selected with
4899 @option{-gdwarf-@var{version}}.
4901 @item -gvms
4902 @opindex gvms
4903 Produce debugging information in Alpha/VMS debug format (if that is
4904 supported).  This is the format used by DEBUG on Alpha/VMS systems.
4906 @item -g@var{level}
4907 @itemx -ggdb@var{level}
4908 @itemx -gstabs@var{level}
4909 @itemx -gcoff@var{level}
4910 @itemx -gxcoff@var{level}
4911 @itemx -gvms@var{level}
4912 Request debugging information and also use @var{level} to specify how
4913 much information.  The default level is 2.
4915 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4916 @option{-g}.
4918 Level 1 produces minimal information, enough for making backtraces in
4919 parts of the program that you don't plan to debug.  This includes
4920 descriptions of functions and external variables, but no information
4921 about local variables and no line numbers.
4923 Level 3 includes extra information, such as all the macro definitions
4924 present in the program.  Some debuggers support macro expansion when
4925 you use @option{-g3}.
4927 @option{-gdwarf-2} does not accept a concatenated debug level, because
4928 GCC used to support an option @option{-gdwarf} that meant to generate
4929 debug information in version 1 of the DWARF format (which is very
4930 different from version 2), and it would have been too confusing.  That
4931 debug format is long obsolete, but the option cannot be changed now.
4932 Instead use an additional @option{-g@var{level}} option to change the
4933 debug level for DWARF.
4935 @item -gtoggle
4936 @opindex gtoggle
4937 Turn off generation of debug info, if leaving out this option
4938 generates it, or turn it on at level 2 otherwise.  The position of this
4939 argument in the command line does not matter; it takes effect after all
4940 other options are processed, and it does so only once, no matter how
4941 many times it is given.  This is mainly intended to be used with
4942 @option{-fcompare-debug}.
4944 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4945 @opindex fdump-final-insns
4946 Dump the final internal representation (RTL) to @var{file}.  If the
4947 optional argument is omitted (or if @var{file} is @code{.}), the name
4948 of the dump file is determined by appending @code{.gkd} to the
4949 compilation output file name.
4951 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4952 @opindex fcompare-debug
4953 @opindex fno-compare-debug
4954 If no error occurs during compilation, run the compiler a second time,
4955 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4956 passed to the second compilation.  Dump the final internal
4957 representation in both compilations, and print an error if they differ.
4959 If the equal sign is omitted, the default @option{-gtoggle} is used.
4961 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4962 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4963 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4964 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4965 is used.
4967 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4968 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4969 of the final representation and the second compilation, preventing even
4970 @env{GCC_COMPARE_DEBUG} from taking effect.
4972 To verify full coverage during @option{-fcompare-debug} testing, set
4973 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4974 which GCC rejects as an invalid option in any actual compilation
4975 (rather than preprocessing, assembly or linking).  To get just a
4976 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4977 not overridden} will do.
4979 @item -fcompare-debug-second
4980 @opindex fcompare-debug-second
4981 This option is implicitly passed to the compiler for the second
4982 compilation requested by @option{-fcompare-debug}, along with options to
4983 silence warnings, and omitting other options that would cause
4984 side-effect compiler outputs to files or to the standard output.  Dump
4985 files and preserved temporary files are renamed so as to contain the
4986 @code{.gk} additional extension during the second compilation, to avoid
4987 overwriting those generated by the first.
4989 When this option is passed to the compiler driver, it causes the
4990 @emph{first} compilation to be skipped, which makes it useful for little
4991 other than debugging the compiler proper.
4993 @item -feliminate-dwarf2-dups
4994 @opindex feliminate-dwarf2-dups
4995 Compress DWARF 2 debugging information by eliminating duplicated
4996 information about each symbol.  This option only makes sense when
4997 generating DWARF 2 debugging information with @option{-gdwarf-2}.
4999 @item -femit-struct-debug-baseonly
5000 Emit debug information for struct-like types
5001 only when the base name of the compilation source file
5002 matches the base name of file in which the struct is defined.
5004 This option substantially reduces the size of debugging information,
5005 but at significant potential loss in type information to the debugger.
5006 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5007 See @option{-femit-struct-debug-detailed} for more detailed control.
5009 This option works only with DWARF 2.
5011 @item -femit-struct-debug-reduced
5012 Emit debug information for struct-like types
5013 only when the base name of the compilation source file
5014 matches the base name of file in which the type is defined,
5015 unless the struct is a template or defined in a system header.
5017 This option significantly reduces the size of debugging information,
5018 with some potential loss in type information to the debugger.
5019 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5020 See @option{-femit-struct-debug-detailed} for more detailed control.
5022 This option works only with DWARF 2.
5024 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5025 Specify the struct-like types
5026 for which the compiler generates debug information.
5027 The intent is to reduce duplicate struct debug information
5028 between different object files within the same program.
5030 This option is a detailed version of
5031 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5032 which serves for most needs.
5034 A specification has the syntax@*
5035 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5037 The optional first word limits the specification to
5038 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5039 A struct type is used directly when it is the type of a variable, member.
5040 Indirect uses arise through pointers to structs.
5041 That is, when use of an incomplete struct is valid, the use is indirect.
5042 An example is
5043 @samp{struct one direct; struct two * indirect;}.
5045 The optional second word limits the specification to
5046 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5047 Generic structs are a bit complicated to explain.
5048 For C++, these are non-explicit specializations of template classes,
5049 or non-template classes within the above.
5050 Other programming languages have generics,
5051 but @option{-femit-struct-debug-detailed} does not yet implement them.
5053 The third word specifies the source files for those
5054 structs for which the compiler should emit debug information.
5055 The values @samp{none} and @samp{any} have the normal meaning.
5056 The value @samp{base} means that
5057 the base of name of the file in which the type declaration appears
5058 must match the base of the name of the main compilation file.
5059 In practice, this means that when compiling @file{foo.c}, debug information
5060 is generated for types declared in that file and @file{foo.h},
5061 but not other header files.
5062 The value @samp{sys} means those types satisfying @samp{base}
5063 or declared in system or compiler headers.
5065 You may need to experiment to determine the best settings for your application.
5067 The default is @option{-femit-struct-debug-detailed=all}.
5069 This option works only with DWARF 2.
5071 @item -fno-merge-debug-strings
5072 @opindex fmerge-debug-strings
5073 @opindex fno-merge-debug-strings
5074 Direct the linker to not merge together strings in the debugging
5075 information that are identical in different object files.  Merging is
5076 not supported by all assemblers or linkers.  Merging decreases the size
5077 of the debug information in the output file at the cost of increasing
5078 link processing time.  Merging is enabled by default.
5080 @item -fdebug-prefix-map=@var{old}=@var{new}
5081 @opindex fdebug-prefix-map
5082 When compiling files in directory @file{@var{old}}, record debugging
5083 information describing them as in @file{@var{new}} instead.
5085 @item -fno-dwarf2-cfi-asm
5086 @opindex fdwarf2-cfi-asm
5087 @opindex fno-dwarf2-cfi-asm
5088 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5089 instead of using GAS @code{.cfi_*} directives.
5091 @cindex @command{prof}
5092 @item -p
5093 @opindex p
5094 Generate extra code to write profile information suitable for the
5095 analysis program @command{prof}.  You must use this option when compiling
5096 the source files you want data about, and you must also use it when
5097 linking.
5099 @cindex @command{gprof}
5100 @item -pg
5101 @opindex pg
5102 Generate extra code to write profile information suitable for the
5103 analysis program @command{gprof}.  You must use this option when compiling
5104 the source files you want data about, and you must also use it when
5105 linking.
5107 @item -Q
5108 @opindex Q
5109 Makes the compiler print out each function name as it is compiled, and
5110 print some statistics about each pass when it finishes.
5112 @item -ftime-report
5113 @opindex ftime-report
5114 Makes the compiler print some statistics about the time consumed by each
5115 pass when it finishes.
5117 @item -fmem-report
5118 @opindex fmem-report
5119 Makes the compiler print some statistics about permanent memory
5120 allocation when it finishes.
5122 @item -fpre-ipa-mem-report
5123 @opindex fpre-ipa-mem-report
5124 @item -fpost-ipa-mem-report
5125 @opindex fpost-ipa-mem-report
5126 Makes the compiler print some statistics about permanent memory
5127 allocation before or after interprocedural optimization.
5129 @item -fstack-usage
5130 @opindex fstack-usage
5131 Makes the compiler output stack usage information for the program, on a
5132 per-function basis.  The filename for the dump is made by appending
5133 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5134 the output file, if explicitly specified and it is not an executable,
5135 otherwise it is the basename of the source file.  An entry is made up
5136 of three fields:
5138 @itemize
5139 @item
5140 The name of the function.
5141 @item
5142 A number of bytes.
5143 @item
5144 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5145 @end itemize
5147 The qualifier @code{static} means that the function manipulates the stack
5148 statically: a fixed number of bytes are allocated for the frame on function
5149 entry and released on function exit; no stack adjustments are otherwise made
5150 in the function.  The second field is this fixed number of bytes.
5152 The qualifier @code{dynamic} means that the function manipulates the stack
5153 dynamically: in addition to the static allocation described above, stack
5154 adjustments are made in the body of the function, for example to push/pop
5155 arguments around function calls.  If the qualifier @code{bounded} is also
5156 present, the amount of these adjustments is bounded at compile time and
5157 the second field is an upper bound of the total amount of stack used by
5158 the function.  If it is not present, the amount of these adjustments is
5159 not bounded at compile time and the second field only represents the
5160 bounded part.
5162 @item -fprofile-arcs
5163 @opindex fprofile-arcs
5164 Add code so that program flow @dfn{arcs} are instrumented.  During
5165 execution the program records how many times each branch and call is
5166 executed and how many times it is taken or returns.  When the compiled
5167 program exits it saves this data to a file called
5168 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5169 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5170 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5171 @var{auxname} is generated from the name of the output file, if
5172 explicitly specified and it is not the final executable, otherwise it is
5173 the basename of the source file.  In both cases any suffix is removed
5174 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5175 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5176 @xref{Cross-profiling}.
5178 @cindex @command{gcov}
5179 @item --coverage
5180 @opindex coverage
5182 This option is used to compile and link code instrumented for coverage
5183 analysis.  The option is a synonym for @option{-fprofile-arcs}
5184 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5185 linking).  See the documentation for those options for more details.
5187 @itemize
5189 @item
5190 Compile the source files with @option{-fprofile-arcs} plus optimization
5191 and code generation options.  For test coverage analysis, use the
5192 additional @option{-ftest-coverage} option.  You do not need to profile
5193 every source file in a program.
5195 @item
5196 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5197 (the latter implies the former).
5199 @item
5200 Run the program on a representative workload to generate the arc profile
5201 information.  This may be repeated any number of times.  You can run
5202 concurrent instances of your program, and provided that the file system
5203 supports locking, the data files will be correctly updated.  Also
5204 @code{fork} calls are detected and correctly handled (double counting
5205 will not happen).
5207 @item
5208 For profile-directed optimizations, compile the source files again with
5209 the same optimization and code generation options plus
5210 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5211 Control Optimization}).
5213 @item
5214 For test coverage analysis, use @command{gcov} to produce human readable
5215 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5216 @command{gcov} documentation for further information.
5218 @end itemize
5220 With @option{-fprofile-arcs}, for each function of your program GCC
5221 creates a program flow graph, then finds a spanning tree for the graph.
5222 Only arcs that are not on the spanning tree have to be instrumented: the
5223 compiler adds code to count the number of times that these arcs are
5224 executed.  When an arc is the only exit or only entrance to a block, the
5225 instrumentation code can be added to the block; otherwise, a new basic
5226 block must be created to hold the instrumentation code.
5228 @need 2000
5229 @item -ftest-coverage
5230 @opindex ftest-coverage
5231 Produce a notes file that the @command{gcov} code-coverage utility
5232 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5233 show program coverage.  Each source file's note file is called
5234 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5235 above for a description of @var{auxname} and instructions on how to
5236 generate test coverage data.  Coverage data matches the source files
5237 more closely if you do not optimize.
5239 @item -fdbg-cnt-list
5240 @opindex fdbg-cnt-list
5241 Print the name and the counter upper bound for all debug counters.
5244 @item -fdbg-cnt=@var{counter-value-list}
5245 @opindex fdbg-cnt
5246 Set the internal debug counter upper bound.  @var{counter-value-list}
5247 is a comma-separated list of @var{name}:@var{value} pairs
5248 which sets the upper bound of each debug counter @var{name} to @var{value}.
5249 All debug counters have the initial upper bound of @code{UINT_MAX};
5250 thus @code{dbg_cnt()} returns true always unless the upper bound
5251 is set by this option.
5252 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5253 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5255 @itemx -fenable-@var{kind}-@var{pass}
5256 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5257 @opindex fdisable-
5258 @opindex fenable-
5260 This is a set of options that are used to explicitly disable/enable
5261 optimization passes.  These options are intended for use for debugging GCC.
5262 Compiler users should use regular options for enabling/disabling
5263 passes instead.
5265 @table @gcctabopt
5267 @item -fdisable-ipa-@var{pass}
5268 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5269 statically invoked in the compiler multiple times, the pass name should be
5270 appended with a sequential number starting from 1.
5272 @item -fdisable-rtl-@var{pass}
5273 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5274 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5275 statically invoked in the compiler multiple times, the pass name should be
5276 appended with a sequential number starting from 1.  @var{range-list} is a 
5277 comma-separated list of function ranges or assembler names.  Each range is a number
5278 pair separated by a colon.  The range is inclusive in both ends.  If the range
5279 is trivial, the number pair can be simplified as a single number.  If the
5280 function's cgraph node's @var{uid} falls within one of the specified ranges,
5281 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5282 function header of a dump file, and the pass names can be dumped by using
5283 option @option{-fdump-passes}.
5285 @item -fdisable-tree-@var{pass}
5286 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5287 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5288 option arguments.
5290 @item -fenable-ipa-@var{pass}
5291 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5292 statically invoked in the compiler multiple times, the pass name should be
5293 appended with a sequential number starting from 1.
5295 @item -fenable-rtl-@var{pass}
5296 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5297 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5298 description and examples.
5300 @item -fenable-tree-@var{pass}
5301 @itemx -fenable-tree-@var{pass}=@var{range-list}
5302 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5303 of option arguments.
5305 @end table
5307 Here are some examples showing uses of these options.
5309 @smallexample
5311 # disable ccp1 for all functions
5312    -fdisable-tree-ccp1
5313 # disable complete unroll for function whose cgraph node uid is 1
5314    -fenable-tree-cunroll=1
5315 # disable gcse2 for functions at the following ranges [1,1],
5316 # [300,400], and [400,1000]
5317 # disable gcse2 for functions foo and foo2
5318    -fdisable-rtl-gcse2=foo,foo2
5319 # disable early inlining
5320    -fdisable-tree-einline
5321 # disable ipa inlining
5322    -fdisable-ipa-inline
5323 # enable tree full unroll
5324    -fenable-tree-unroll
5326 @end smallexample
5328 @item -d@var{letters}
5329 @itemx -fdump-rtl-@var{pass}
5330 @opindex d
5331 Says to make debugging dumps during compilation at times specified by
5332 @var{letters}.  This is used for debugging the RTL-based passes of the
5333 compiler.  The file names for most of the dumps are made by appending
5334 a pass number and a word to the @var{dumpname}, and the files are
5335 created in the directory of the output file.  Note that the pass
5336 number is computed statically as passes get registered into the pass
5337 manager.  Thus the numbering is not related to the dynamic order of
5338 execution of passes.  In particular, a pass installed by a plugin
5339 could have a number over 200 even if it executed quite early.
5340 @var{dumpname} is generated from the name of the output file, if
5341 explicitly specified and it is not an executable, otherwise it is the
5342 basename of the source file. These switches may have different effects
5343 when @option{-E} is used for preprocessing.
5345 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5346 @option{-d} option @var{letters}.  Here are the possible
5347 letters for use in @var{pass} and @var{letters}, and their meanings:
5349 @table @gcctabopt
5351 @item -fdump-rtl-alignments
5352 @opindex fdump-rtl-alignments
5353 Dump after branch alignments have been computed.
5355 @item -fdump-rtl-asmcons
5356 @opindex fdump-rtl-asmcons
5357 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5359 @item -fdump-rtl-auto_inc_dec
5360 @opindex fdump-rtl-auto_inc_dec
5361 Dump after auto-inc-dec discovery.  This pass is only run on
5362 architectures that have auto inc or auto dec instructions.
5364 @item -fdump-rtl-barriers
5365 @opindex fdump-rtl-barriers
5366 Dump after cleaning up the barrier instructions.
5368 @item -fdump-rtl-bbpart
5369 @opindex fdump-rtl-bbpart
5370 Dump after partitioning hot and cold basic blocks.
5372 @item -fdump-rtl-bbro
5373 @opindex fdump-rtl-bbro
5374 Dump after block reordering.
5376 @item -fdump-rtl-btl1
5377 @itemx -fdump-rtl-btl2
5378 @opindex fdump-rtl-btl2
5379 @opindex fdump-rtl-btl2
5380 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5381 after the two branch
5382 target load optimization passes.
5384 @item -fdump-rtl-bypass
5385 @opindex fdump-rtl-bypass
5386 Dump after jump bypassing and control flow optimizations.
5388 @item -fdump-rtl-combine
5389 @opindex fdump-rtl-combine
5390 Dump after the RTL instruction combination pass.
5392 @item -fdump-rtl-compgotos
5393 @opindex fdump-rtl-compgotos
5394 Dump after duplicating the computed gotos.
5396 @item -fdump-rtl-ce1
5397 @itemx -fdump-rtl-ce2
5398 @itemx -fdump-rtl-ce3
5399 @opindex fdump-rtl-ce1
5400 @opindex fdump-rtl-ce2
5401 @opindex fdump-rtl-ce3
5402 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5403 @option{-fdump-rtl-ce3} enable dumping after the three
5404 if conversion passes.
5406 @itemx -fdump-rtl-cprop_hardreg
5407 @opindex fdump-rtl-cprop_hardreg
5408 Dump after hard register copy propagation.
5410 @itemx -fdump-rtl-csa
5411 @opindex fdump-rtl-csa
5412 Dump after combining stack adjustments.
5414 @item -fdump-rtl-cse1
5415 @itemx -fdump-rtl-cse2
5416 @opindex fdump-rtl-cse1
5417 @opindex fdump-rtl-cse2
5418 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5419 the two common sub-expression elimination passes.
5421 @itemx -fdump-rtl-dce
5422 @opindex fdump-rtl-dce
5423 Dump after the standalone dead code elimination passes.
5425 @itemx -fdump-rtl-dbr
5426 @opindex fdump-rtl-dbr
5427 Dump after delayed branch scheduling.
5429 @item -fdump-rtl-dce1
5430 @itemx -fdump-rtl-dce2
5431 @opindex fdump-rtl-dce1
5432 @opindex fdump-rtl-dce2
5433 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5434 the two dead store elimination passes.
5436 @item -fdump-rtl-eh
5437 @opindex fdump-rtl-eh
5438 Dump after finalization of EH handling code.
5440 @item -fdump-rtl-eh_ranges
5441 @opindex fdump-rtl-eh_ranges
5442 Dump after conversion of EH handling range regions.
5444 @item -fdump-rtl-expand
5445 @opindex fdump-rtl-expand
5446 Dump after RTL generation.
5448 @item -fdump-rtl-fwprop1
5449 @itemx -fdump-rtl-fwprop2
5450 @opindex fdump-rtl-fwprop1
5451 @opindex fdump-rtl-fwprop2
5452 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5453 dumping after the two forward propagation passes.
5455 @item -fdump-rtl-gcse1
5456 @itemx -fdump-rtl-gcse2
5457 @opindex fdump-rtl-gcse1
5458 @opindex fdump-rtl-gcse2
5459 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5460 after global common subexpression elimination.
5462 @item -fdump-rtl-init-regs
5463 @opindex fdump-rtl-init-regs
5464 Dump after the initialization of the registers.
5466 @item -fdump-rtl-initvals
5467 @opindex fdump-rtl-initvals
5468 Dump after the computation of the initial value sets.
5470 @itemx -fdump-rtl-into_cfglayout
5471 @opindex fdump-rtl-into_cfglayout
5472 Dump after converting to cfglayout mode.
5474 @item -fdump-rtl-ira
5475 @opindex fdump-rtl-ira
5476 Dump after iterated register allocation.
5478 @item -fdump-rtl-jump
5479 @opindex fdump-rtl-jump
5480 Dump after the second jump optimization.
5482 @item -fdump-rtl-loop2
5483 @opindex fdump-rtl-loop2
5484 @option{-fdump-rtl-loop2} enables dumping after the rtl
5485 loop optimization passes.
5487 @item -fdump-rtl-mach
5488 @opindex fdump-rtl-mach
5489 Dump after performing the machine dependent reorganization pass, if that
5490 pass exists.
5492 @item -fdump-rtl-mode_sw
5493 @opindex fdump-rtl-mode_sw
5494 Dump after removing redundant mode switches.
5496 @item -fdump-rtl-rnreg
5497 @opindex fdump-rtl-rnreg
5498 Dump after register renumbering.
5500 @itemx -fdump-rtl-outof_cfglayout
5501 @opindex fdump-rtl-outof_cfglayout
5502 Dump after converting from cfglayout mode.
5504 @item -fdump-rtl-peephole2
5505 @opindex fdump-rtl-peephole2
5506 Dump after the peephole pass.
5508 @item -fdump-rtl-postreload
5509 @opindex fdump-rtl-postreload
5510 Dump after post-reload optimizations.
5512 @itemx -fdump-rtl-pro_and_epilogue
5513 @opindex fdump-rtl-pro_and_epilogue
5514 Dump after generating the function prologues and epilogues.
5516 @item -fdump-rtl-regmove
5517 @opindex fdump-rtl-regmove
5518 Dump after the register move pass.
5520 @item -fdump-rtl-sched1
5521 @itemx -fdump-rtl-sched2
5522 @opindex fdump-rtl-sched1
5523 @opindex fdump-rtl-sched2
5524 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5525 after the basic block scheduling passes.
5527 @item -fdump-rtl-see
5528 @opindex fdump-rtl-see
5529 Dump after sign extension elimination.
5531 @item -fdump-rtl-seqabstr
5532 @opindex fdump-rtl-seqabstr
5533 Dump after common sequence discovery.
5535 @item -fdump-rtl-shorten
5536 @opindex fdump-rtl-shorten
5537 Dump after shortening branches.
5539 @item -fdump-rtl-sibling
5540 @opindex fdump-rtl-sibling
5541 Dump after sibling call optimizations.
5543 @item -fdump-rtl-split1
5544 @itemx -fdump-rtl-split2
5545 @itemx -fdump-rtl-split3
5546 @itemx -fdump-rtl-split4
5547 @itemx -fdump-rtl-split5
5548 @opindex fdump-rtl-split1
5549 @opindex fdump-rtl-split2
5550 @opindex fdump-rtl-split3
5551 @opindex fdump-rtl-split4
5552 @opindex fdump-rtl-split5
5553 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5554 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5555 @option{-fdump-rtl-split5} enable dumping after five rounds of
5556 instruction splitting.
5558 @item -fdump-rtl-sms
5559 @opindex fdump-rtl-sms
5560 Dump after modulo scheduling.  This pass is only run on some
5561 architectures.
5563 @item -fdump-rtl-stack
5564 @opindex fdump-rtl-stack
5565 Dump after conversion from GCC's ``flat register file'' registers to the
5566 x87's stack-like registers.  This pass is only run on x86 variants.
5568 @item -fdump-rtl-subreg1
5569 @itemx -fdump-rtl-subreg2
5570 @opindex fdump-rtl-subreg1
5571 @opindex fdump-rtl-subreg2
5572 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5573 the two subreg expansion passes.
5575 @item -fdump-rtl-unshare
5576 @opindex fdump-rtl-unshare
5577 Dump after all rtl has been unshared.
5579 @item -fdump-rtl-vartrack
5580 @opindex fdump-rtl-vartrack
5581 Dump after variable tracking.
5583 @item -fdump-rtl-vregs
5584 @opindex fdump-rtl-vregs
5585 Dump after converting virtual registers to hard registers.
5587 @item -fdump-rtl-web
5588 @opindex fdump-rtl-web
5589 Dump after live range splitting.
5591 @item -fdump-rtl-regclass
5592 @itemx -fdump-rtl-subregs_of_mode_init
5593 @itemx -fdump-rtl-subregs_of_mode_finish
5594 @itemx -fdump-rtl-dfinit
5595 @itemx -fdump-rtl-dfinish
5596 @opindex fdump-rtl-regclass
5597 @opindex fdump-rtl-subregs_of_mode_init
5598 @opindex fdump-rtl-subregs_of_mode_finish
5599 @opindex fdump-rtl-dfinit
5600 @opindex fdump-rtl-dfinish
5601 These dumps are defined but always produce empty files.
5603 @item -fdump-rtl-all
5604 @opindex fdump-rtl-all
5605 Produce all the dumps listed above.
5607 @item -dA
5608 @opindex dA
5609 Annotate the assembler output with miscellaneous debugging information.
5611 @item -dD
5612 @opindex dD
5613 Dump all macro definitions, at the end of preprocessing, in addition to
5614 normal output.
5616 @item -dH
5617 @opindex dH
5618 Produce a core dump whenever an error occurs.
5620 @item -dm
5621 @opindex dm
5622 Print statistics on memory usage, at the end of the run, to
5623 standard error.
5625 @item -dp
5626 @opindex dp
5627 Annotate the assembler output with a comment indicating which
5628 pattern and alternative is used.  The length of each instruction is
5629 also printed.
5631 @item -dP
5632 @opindex dP
5633 Dump the RTL in the assembler output as a comment before each instruction.
5634 Also turns on @option{-dp} annotation.
5636 @item -dv
5637 @opindex dv
5638 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5639 dump a representation of the control flow graph suitable for viewing with VCG
5640 to @file{@var{file}.@var{pass}.vcg}.
5642 @item -dx
5643 @opindex dx
5644 Just generate RTL for a function instead of compiling it.  Usually used
5645 with @option{-fdump-rtl-expand}.
5646 @end table
5648 @item -fdump-noaddr
5649 @opindex fdump-noaddr
5650 When doing debugging dumps, suppress address output.  This makes it more
5651 feasible to use diff on debugging dumps for compiler invocations with
5652 different compiler binaries and/or different
5653 text / bss / data / heap / stack / dso start locations.
5655 @item -fdump-unnumbered
5656 @opindex fdump-unnumbered
5657 When doing debugging dumps, suppress instruction numbers and address output.
5658 This makes it more feasible to use diff on debugging dumps for compiler
5659 invocations with different options, in particular with and without
5660 @option{-g}.
5662 @item -fdump-unnumbered-links
5663 @opindex fdump-unnumbered-links
5664 When doing debugging dumps (see @option{-d} option above), suppress
5665 instruction numbers for the links to the previous and next instructions
5666 in a sequence.
5668 @item -fdump-translation-unit @r{(C++ only)}
5669 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5670 @opindex fdump-translation-unit
5671 Dump a representation of the tree structure for the entire translation
5672 unit to a file.  The file name is made by appending @file{.tu} to the
5673 source file name, and the file is created in the same directory as the
5674 output file.  If the @samp{-@var{options}} form is used, @var{options}
5675 controls the details of the dump as described for the
5676 @option{-fdump-tree} options.
5678 @item -fdump-class-hierarchy @r{(C++ only)}
5679 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5680 @opindex fdump-class-hierarchy
5681 Dump a representation of each class's hierarchy and virtual function
5682 table layout to a file.  The file name is made by appending
5683 @file{.class} to the source file name, and the file is created in the
5684 same directory as the output file.  If the @samp{-@var{options}} form
5685 is used, @var{options} controls the details of the dump as described
5686 for the @option{-fdump-tree} options.
5688 @item -fdump-ipa-@var{switch}
5689 @opindex fdump-ipa
5690 Control the dumping at various stages of inter-procedural analysis
5691 language tree to a file.  The file name is generated by appending a
5692 switch specific suffix to the source file name, and the file is created
5693 in the same directory as the output file.  The following dumps are
5694 possible:
5696 @table @samp
5697 @item all
5698 Enables all inter-procedural analysis dumps.
5700 @item cgraph
5701 Dumps information about call-graph optimization, unused function removal,
5702 and inlining decisions.
5704 @item inline
5705 Dump after function inlining.
5707 @end table
5709 @item -fdump-passes
5710 @opindex fdump-passes
5711 Dump the list of optimization passes that are turned on and off by
5712 the current command-line options.
5714 @item -fdump-statistics-@var{option}
5715 @opindex fdump-statistics
5716 Enable and control dumping of pass statistics in a separate file.  The
5717 file name is generated by appending a suffix ending in
5718 @samp{.statistics} to the source file name, and the file is created in
5719 the same directory as the output file.  If the @samp{-@var{option}}
5720 form is used, @samp{-stats} causes counters to be summed over the
5721 whole compilation unit while @samp{-details} dumps every event as
5722 the passes generate them.  The default with no option is to sum
5723 counters for each function compiled.
5725 @item -fdump-tree-@var{switch}
5726 @itemx -fdump-tree-@var{switch}-@var{options}
5727 @opindex fdump-tree
5728 Control the dumping at various stages of processing the intermediate
5729 language tree to a file.  The file name is generated by appending a
5730 switch specific suffix to the source file name, and the file is
5731 created in the same directory as the output file.  If the
5732 @samp{-@var{options}} form is used, @var{options} is a list of
5733 @samp{-} separated options which control the details of the dump.  Not
5734 all options are applicable to all dumps; those that are not
5735 meaningful are ignored.  The following options are available
5737 @table @samp
5738 @item address
5739 Print the address of each node.  Usually this is not meaningful as it
5740 changes according to the environment and source file.  Its primary use
5741 is for tying up a dump file with a debug environment.
5742 @item asmname
5743 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5744 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5745 use working backward from mangled names in the assembly file.
5746 @item slim
5747 Inhibit dumping of members of a scope or body of a function merely
5748 because that scope has been reached.  Only dump such items when they
5749 are directly reachable by some other path.  When dumping pretty-printed
5750 trees, this option inhibits dumping the bodies of control structures.
5751 @item raw
5752 Print a raw representation of the tree.  By default, trees are
5753 pretty-printed into a C-like representation.
5754 @item details
5755 Enable more detailed dumps (not honored by every dump option).
5756 @item stats
5757 Enable dumping various statistics about the pass (not honored by every dump
5758 option).
5759 @item blocks
5760 Enable showing basic block boundaries (disabled in raw dumps).
5761 @item vops
5762 Enable showing virtual operands for every statement.
5763 @item lineno
5764 Enable showing line numbers for statements.
5765 @item uid
5766 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5767 @item verbose
5768 Enable showing the tree dump for each statement.
5769 @item eh
5770 Enable showing the EH region number holding each statement.
5771 @item scev
5772 Enable showing scalar evolution analysis details.
5773 @item all
5774 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5775 and @option{lineno}.
5776 @end table
5778 The following tree dumps are possible:
5779 @table @samp
5781 @item original
5782 @opindex fdump-tree-original
5783 Dump before any tree based optimization, to @file{@var{file}.original}.
5785 @item optimized
5786 @opindex fdump-tree-optimized
5787 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5789 @item gimple
5790 @opindex fdump-tree-gimple
5791 Dump each function before and after the gimplification pass to a file.  The
5792 file name is made by appending @file{.gimple} to the source file name.
5794 @item cfg
5795 @opindex fdump-tree-cfg
5796 Dump the control flow graph of each function to a file.  The file name is
5797 made by appending @file{.cfg} to the source file name.
5799 @item vcg
5800 @opindex fdump-tree-vcg
5801 Dump the control flow graph of each function to a file in VCG format.  The
5802 file name is made by appending @file{.vcg} to the source file name.  Note
5803 that if the file contains more than one function, the generated file cannot
5804 be used directly by VCG@.  You must cut and paste each function's
5805 graph into its own separate file first.
5807 @item ch
5808 @opindex fdump-tree-ch
5809 Dump each function after copying loop headers.  The file name is made by
5810 appending @file{.ch} to the source file name.
5812 @item ssa
5813 @opindex fdump-tree-ssa
5814 Dump SSA related information to a file.  The file name is made by appending
5815 @file{.ssa} to the source file name.
5817 @item alias
5818 @opindex fdump-tree-alias
5819 Dump aliasing information for each function.  The file name is made by
5820 appending @file{.alias} to the source file name.
5822 @item ccp
5823 @opindex fdump-tree-ccp
5824 Dump each function after CCP@.  The file name is made by appending
5825 @file{.ccp} to the source file name.
5827 @item storeccp
5828 @opindex fdump-tree-storeccp
5829 Dump each function after STORE-CCP@.  The file name is made by appending
5830 @file{.storeccp} to the source file name.
5832 @item pre
5833 @opindex fdump-tree-pre
5834 Dump trees after partial redundancy elimination.  The file name is made
5835 by appending @file{.pre} to the source file name.
5837 @item fre
5838 @opindex fdump-tree-fre
5839 Dump trees after full redundancy elimination.  The file name is made
5840 by appending @file{.fre} to the source file name.
5842 @item copyprop
5843 @opindex fdump-tree-copyprop
5844 Dump trees after copy propagation.  The file name is made
5845 by appending @file{.copyprop} to the source file name.
5847 @item store_copyprop
5848 @opindex fdump-tree-store_copyprop
5849 Dump trees after store copy-propagation.  The file name is made
5850 by appending @file{.store_copyprop} to the source file name.
5852 @item dce
5853 @opindex fdump-tree-dce
5854 Dump each function after dead code elimination.  The file name is made by
5855 appending @file{.dce} to the source file name.
5857 @item mudflap
5858 @opindex fdump-tree-mudflap
5859 Dump each function after adding mudflap instrumentation.  The file name is
5860 made by appending @file{.mudflap} to the source file name.
5862 @item sra
5863 @opindex fdump-tree-sra
5864 Dump each function after performing scalar replacement of aggregates.  The
5865 file name is made by appending @file{.sra} to the source file name.
5867 @item sink
5868 @opindex fdump-tree-sink
5869 Dump each function after performing code sinking.  The file name is made
5870 by appending @file{.sink} to the source file name.
5872 @item dom
5873 @opindex fdump-tree-dom
5874 Dump each function after applying dominator tree optimizations.  The file
5875 name is made by appending @file{.dom} to the source file name.
5877 @item dse
5878 @opindex fdump-tree-dse
5879 Dump each function after applying dead store elimination.  The file
5880 name is made by appending @file{.dse} to the source file name.
5882 @item phiopt
5883 @opindex fdump-tree-phiopt
5884 Dump each function after optimizing PHI nodes into straightline code.  The file
5885 name is made by appending @file{.phiopt} to the source file name.
5887 @item forwprop
5888 @opindex fdump-tree-forwprop
5889 Dump each function after forward propagating single use variables.  The file
5890 name is made by appending @file{.forwprop} to the source file name.
5892 @item copyrename
5893 @opindex fdump-tree-copyrename
5894 Dump each function after applying the copy rename optimization.  The file
5895 name is made by appending @file{.copyrename} to the source file name.
5897 @item nrv
5898 @opindex fdump-tree-nrv
5899 Dump each function after applying the named return value optimization on
5900 generic trees.  The file name is made by appending @file{.nrv} to the source
5901 file name.
5903 @item vect
5904 @opindex fdump-tree-vect
5905 Dump each function after applying vectorization of loops.  The file name is
5906 made by appending @file{.vect} to the source file name.
5908 @item slp
5909 @opindex fdump-tree-slp
5910 Dump each function after applying vectorization of basic blocks.  The file name
5911 is made by appending @file{.slp} to the source file name.
5913 @item vrp
5914 @opindex fdump-tree-vrp
5915 Dump each function after Value Range Propagation (VRP).  The file name
5916 is made by appending @file{.vrp} to the source file name.
5918 @item all
5919 @opindex fdump-tree-all
5920 Enable all the available tree dumps with the flags provided in this option.
5921 @end table
5923 @item -ftree-vectorizer-verbose=@var{n}
5924 @opindex ftree-vectorizer-verbose
5925 This option controls the amount of debugging output the vectorizer prints.
5926 This information is written to standard error, unless
5927 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5928 in which case it is output to the usual dump listing file, @file{.vect}.
5929 For @var{n}=0 no diagnostic information is reported.
5930 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5931 and the total number of loops that got vectorized.
5932 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5933 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5934 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5935 level that @option{-fdump-tree-vect-stats} uses.
5936 Higher verbosity levels mean either more information dumped for each
5937 reported loop, or same amount of information reported for more loops:
5938 if @var{n}=3, vectorizer cost model information is reported.
5939 If @var{n}=4, alignment related information is added to the reports.
5940 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5941 memory access-patterns) is added to the reports.
5942 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5943 that did not pass the first analysis phase (i.e., may not be countable, or
5944 may have complicated control-flow).
5945 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5946 If @var{n}=8, SLP related information is added to the reports.
5947 For @var{n}=9, all the information the vectorizer generates during its
5948 analysis and transformation is reported.  This is the same verbosity level
5949 that @option{-fdump-tree-vect-details} uses.
5951 @item -frandom-seed=@var{string}
5952 @opindex frandom-seed
5953 This option provides a seed that GCC uses in place of
5954 random numbers in generating certain symbol names
5955 that have to be different in every compiled file.  It is also used to
5956 place unique stamps in coverage data files and the object files that
5957 produce them.  You can use the @option{-frandom-seed} option to produce
5958 reproducibly identical object files.
5960 The @var{string} should be different for every file you compile.
5962 @item -fsched-verbose=@var{n}
5963 @opindex fsched-verbose
5964 On targets that use instruction scheduling, this option controls the
5965 amount of debugging output the scheduler prints.  This information is
5966 written to standard error, unless @option{-fdump-rtl-sched1} or
5967 @option{-fdump-rtl-sched2} is specified, in which case it is output
5968 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5969 respectively.  However for @var{n} greater than nine, the output is
5970 always printed to standard error.
5972 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5973 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5974 For @var{n} greater than one, it also output basic block probabilities,
5975 detailed ready list information and unit/insn info.  For @var{n} greater
5976 than two, it includes RTL at abort point, control-flow and regions info.
5977 And for @var{n} over four, @option{-fsched-verbose} also includes
5978 dependence info.
5980 @item -save-temps
5981 @itemx -save-temps=cwd
5982 @opindex save-temps
5983 Store the usual ``temporary'' intermediate files permanently; place them
5984 in the current directory and name them based on the source file.  Thus,
5985 compiling @file{foo.c} with @option{-c -save-temps} produces files
5986 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5987 preprocessed @file{foo.i} output file even though the compiler now
5988 normally uses an integrated preprocessor.
5990 When used in combination with the @option{-x} command-line option,
5991 @option{-save-temps} is sensible enough to avoid over writing an
5992 input source file with the same extension as an intermediate file.
5993 The corresponding intermediate file may be obtained by renaming the
5994 source file before using @option{-save-temps}.
5996 If you invoke GCC in parallel, compiling several different source
5997 files that share a common base name in different subdirectories or the
5998 same source file compiled for multiple output destinations, it is
5999 likely that the different parallel compilers will interfere with each
6000 other, and overwrite the temporary files.  For instance:
6002 @smallexample
6003 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6004 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6005 @end smallexample
6007 may result in @file{foo.i} and @file{foo.o} being written to
6008 simultaneously by both compilers.
6010 @item -save-temps=obj
6011 @opindex save-temps=obj
6012 Store the usual ``temporary'' intermediate files permanently.  If the
6013 @option{-o} option is used, the temporary files are based on the
6014 object file.  If the @option{-o} option is not used, the
6015 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6017 For example:
6019 @smallexample
6020 gcc -save-temps=obj -c foo.c
6021 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6022 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6023 @end smallexample
6025 @noindent
6026 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6027 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6028 @file{dir2/yfoobar.o}.
6030 @item -time@r{[}=@var{file}@r{]}
6031 @opindex time
6032 Report the CPU time taken by each subprocess in the compilation
6033 sequence.  For C source files, this is the compiler proper and assembler
6034 (plus the linker if linking is done).
6036 Without the specification of an output file, the output looks like this:
6038 @smallexample
6039 # cc1 0.12 0.01
6040 # as 0.00 0.01
6041 @end smallexample
6043 The first number on each line is the ``user time'', that is time spent
6044 executing the program itself.  The second number is ``system time'',
6045 time spent executing operating system routines on behalf of the program.
6046 Both numbers are in seconds.
6048 With the specification of an output file, the output is appended to the
6049 named file, and it looks like this:
6051 @smallexample
6052 0.12 0.01 cc1 @var{options}
6053 0.00 0.01 as @var{options}
6054 @end smallexample
6056 The ``user time'' and the ``system time'' are moved before the program
6057 name, and the options passed to the program are displayed, so that one
6058 can later tell what file was being compiled, and with which options.
6060 @item -fvar-tracking
6061 @opindex fvar-tracking
6062 Run variable tracking pass.  It computes where variables are stored at each
6063 position in code.  Better debugging information is then generated
6064 (if the debugging information format supports this information).
6066 It is enabled by default when compiling with optimization (@option{-Os},
6067 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6068 the debug info format supports it.
6070 @item -fvar-tracking-assignments
6071 @opindex fvar-tracking-assignments
6072 @opindex fno-var-tracking-assignments
6073 Annotate assignments to user variables early in the compilation and
6074 attempt to carry the annotations over throughout the compilation all the
6075 way to the end, in an attempt to improve debug information while
6076 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6078 It can be enabled even if var-tracking is disabled, in which case
6079 annotations are created and maintained, but discarded at the end.
6081 @item -fvar-tracking-assignments-toggle
6082 @opindex fvar-tracking-assignments-toggle
6083 @opindex fno-var-tracking-assignments-toggle
6084 Toggle @option{-fvar-tracking-assignments}, in the same way that
6085 @option{-gtoggle} toggles @option{-g}.
6087 @item -print-file-name=@var{library}
6088 @opindex print-file-name
6089 Print the full absolute name of the library file @var{library} that
6090 would be used when linking---and don't do anything else.  With this
6091 option, GCC does not compile or link anything; it just prints the
6092 file name.
6094 @item -print-multi-directory
6095 @opindex print-multi-directory
6096 Print the directory name corresponding to the multilib selected by any
6097 other switches present in the command line.  This directory is supposed
6098 to exist in @env{GCC_EXEC_PREFIX}.
6100 @item -print-multi-lib
6101 @opindex print-multi-lib
6102 Print the mapping from multilib directory names to compiler switches
6103 that enable them.  The directory name is separated from the switches by
6104 @samp{;}, and each switch starts with an @samp{@@} instead of the
6105 @samp{-}, without spaces between multiple switches.  This is supposed to
6106 ease shell-processing.
6108 @item -print-multi-os-directory
6109 @opindex print-multi-os-directory
6110 Print the path to OS libraries for the selected
6111 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6112 present in the @file{lib} subdirectory and no multilibs are used, this is
6113 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6114 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6115 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6116 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6118 @item -print-prog-name=@var{program}
6119 @opindex print-prog-name
6120 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6122 @item -print-libgcc-file-name
6123 @opindex print-libgcc-file-name
6124 Same as @option{-print-file-name=libgcc.a}.
6126 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6127 but you do want to link with @file{libgcc.a}.  You can do
6129 @smallexample
6130 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6131 @end smallexample
6133 @item -print-search-dirs
6134 @opindex print-search-dirs
6135 Print the name of the configured installation directory and a list of
6136 program and library directories @command{gcc} searches---and don't do anything else.
6138 This is useful when @command{gcc} prints the error message
6139 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6140 To resolve this you either need to put @file{cpp0} and the other compiler
6141 components where @command{gcc} expects to find them, or you can set the environment
6142 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6143 Don't forget the trailing @samp{/}.
6144 @xref{Environment Variables}.
6146 @item -print-sysroot
6147 @opindex print-sysroot
6148 Print the target sysroot directory that is used during
6149 compilation.  This is the target sysroot specified either at configure
6150 time or using the @option{--sysroot} option, possibly with an extra
6151 suffix that depends on compilation options.  If no target sysroot is
6152 specified, the option prints nothing.
6154 @item -print-sysroot-headers-suffix
6155 @opindex print-sysroot-headers-suffix
6156 Print the suffix added to the target sysroot when searching for
6157 headers, or give an error if the compiler is not configured with such
6158 a suffix---and don't do anything else.
6160 @item -dumpmachine
6161 @opindex dumpmachine
6162 Print the compiler's target machine (for example,
6163 @samp{i686-pc-linux-gnu})---and don't do anything else.
6165 @item -dumpversion
6166 @opindex dumpversion
6167 Print the compiler version (for example, @samp{3.0})---and don't do
6168 anything else.
6170 @item -dumpspecs
6171 @opindex dumpspecs
6172 Print the compiler's built-in specs---and don't do anything else.  (This
6173 is used when GCC itself is being built.)  @xref{Spec Files}.
6175 @item -feliminate-unused-debug-types
6176 @opindex feliminate-unused-debug-types
6177 Normally, when producing DWARF 2 output, GCC emits debugging
6178 information for all types declared in a compilation
6179 unit, regardless of whether or not they are actually used
6180 in that compilation unit.  Sometimes this is useful, such as
6181 if, in the debugger, you want to cast a value to a type that is
6182 not actually used in your program (but is declared).  More often,
6183 however, this results in a significant amount of wasted space.
6184 With this option, GCC avoids producing debug symbol output
6185 for types that are nowhere used in the source file being compiled.
6186 @end table
6188 @node Optimize Options
6189 @section Options That Control Optimization
6190 @cindex optimize options
6191 @cindex options, optimization
6193 These options control various sorts of optimizations.
6195 Without any optimization option, the compiler's goal is to reduce the
6196 cost of compilation and to make debugging produce the expected
6197 results.  Statements are independent: if you stop the program with a
6198 breakpoint between statements, you can then assign a new value to any
6199 variable or change the program counter to any other statement in the
6200 function and get exactly the results you expect from the source
6201 code.
6203 Turning on optimization flags makes the compiler attempt to improve
6204 the performance and/or code size at the expense of compilation time
6205 and possibly the ability to debug the program.
6207 The compiler performs optimization based on the knowledge it has of the
6208 program.  Compiling multiple files at once to a single output file mode allows
6209 the compiler to use information gained from all of the files when compiling
6210 each of them.
6212 Not all optimizations are controlled directly by a flag.  Only
6213 optimizations that have a flag are listed in this section.
6215 Most optimizations are only enabled if an @option{-O} level is set on
6216 the command line.  Otherwise they are disabled, even if individual
6217 optimization flags are specified.
6219 Depending on the target and how GCC was configured, a slightly different
6220 set of optimizations may be enabled at each @option{-O} level than
6221 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6222 to find out the exact set of optimizations that are enabled at each level.
6223 @xref{Overall Options}, for examples.
6225 @table @gcctabopt
6226 @item -O
6227 @itemx -O1
6228 @opindex O
6229 @opindex O1
6230 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6231 more memory for a large function.
6233 With @option{-O}, the compiler tries to reduce code size and execution
6234 time, without performing any optimizations that take a great deal of
6235 compilation time.
6237 @option{-O} turns on the following optimization flags:
6238 @gccoptlist{
6239 -fauto-inc-dec @gol
6240 -fcompare-elim @gol
6241 -fcprop-registers @gol
6242 -fdce @gol
6243 -fdefer-pop @gol
6244 -fdelayed-branch @gol
6245 -fdse @gol
6246 -fguess-branch-probability @gol
6247 -fif-conversion2 @gol
6248 -fif-conversion @gol
6249 -fipa-pure-const @gol
6250 -fipa-profile @gol
6251 -fipa-reference @gol
6252 -fmerge-constants
6253 -fsplit-wide-types @gol
6254 -ftree-bit-ccp @gol
6255 -ftree-builtin-call-dce @gol
6256 -ftree-ccp @gol
6257 -ftree-ch @gol
6258 -ftree-copyrename @gol
6259 -ftree-dce @gol
6260 -ftree-dominator-opts @gol
6261 -ftree-dse @gol
6262 -ftree-forwprop @gol
6263 -ftree-fre @gol
6264 -ftree-phiprop @gol
6265 -ftree-slsr @gol
6266 -ftree-sra @gol
6267 -ftree-pta @gol
6268 -ftree-ter @gol
6269 -funit-at-a-time}
6271 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6272 where doing so does not interfere with debugging.
6274 @item -O2
6275 @opindex O2
6276 Optimize even more.  GCC performs nearly all supported optimizations
6277 that do not involve a space-speed tradeoff.
6278 As compared to @option{-O}, this option increases both compilation time
6279 and the performance of the generated code.
6281 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6282 also turns on the following optimization flags:
6283 @gccoptlist{-fthread-jumps @gol
6284 -falign-functions  -falign-jumps @gol
6285 -falign-loops  -falign-labels @gol
6286 -fcaller-saves @gol
6287 -fcrossjumping @gol
6288 -fcse-follow-jumps  -fcse-skip-blocks @gol
6289 -fdelete-null-pointer-checks @gol
6290 -fdevirtualize @gol
6291 -fexpensive-optimizations @gol
6292 -fgcse  -fgcse-lm  @gol
6293 -fhoist-adjacent-loads @gol
6294 -finline-small-functions @gol
6295 -findirect-inlining @gol
6296 -fipa-sra @gol
6297 -foptimize-sibling-calls @gol
6298 -fpartial-inlining @gol
6299 -fpeephole2 @gol
6300 -fregmove @gol
6301 -freorder-blocks  -freorder-functions @gol
6302 -frerun-cse-after-loop  @gol
6303 -fsched-interblock  -fsched-spec @gol
6304 -fschedule-insns  -fschedule-insns2 @gol
6305 -fstrict-aliasing -fstrict-overflow @gol
6306 -ftree-switch-conversion -ftree-tail-merge @gol
6307 -ftree-pre @gol
6308 -ftree-vrp}
6310 Please note the warning under @option{-fgcse} about
6311 invoking @option{-O2} on programs that use computed gotos.
6313 @item -O3
6314 @opindex O3
6315 Optimize yet more.  @option{-O3} turns on all optimizations specified
6316 by @option{-O2} and also turns on the @option{-finline-functions},
6317 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6318 @option{-fgcse-after-reload}, @option{-ftree-vectorize},
6319 @option{-fvect-cost-model},
6320 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6322 @item -O0
6323 @opindex O0
6324 Reduce compilation time and make debugging produce the expected
6325 results.  This is the default.
6327 @item -Os
6328 @opindex Os
6329 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6330 do not typically increase code size.  It also performs further
6331 optimizations designed to reduce code size.
6333 @option{-Os} disables the following optimization flags:
6334 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6335 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6336 -fprefetch-loop-arrays  -ftree-vect-loop-version}
6338 @item -Ofast
6339 @opindex Ofast
6340 Disregard strict standards compliance.  @option{-Ofast} enables all
6341 @option{-O3} optimizations.  It also enables optimizations that are not
6342 valid for all standard compliant programs.
6343 It turns on @option{-ffast-math} and the Fortran-specific
6344 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6346 If you use multiple @option{-O} options, with or without level numbers,
6347 the last such option is the one that is effective.
6348 @end table
6350 Options of the form @option{-f@var{flag}} specify machine-independent
6351 flags.  Most flags have both positive and negative forms; the negative
6352 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6353 below, only one of the forms is listed---the one you typically 
6354 use.  You can figure out the other form by either removing @samp{no-}
6355 or adding it.
6357 The following options control specific optimizations.  They are either
6358 activated by @option{-O} options or are related to ones that are.  You
6359 can use the following flags in the rare cases when ``fine-tuning'' of
6360 optimizations to be performed is desired.
6362 @table @gcctabopt
6363 @item -fno-default-inline
6364 @opindex fno-default-inline
6365 Do not make member functions inline by default merely because they are
6366 defined inside the class scope (C++ only).  Otherwise, when you specify
6367 @w{@option{-O}}, member functions defined inside class scope are compiled
6368 inline by default; i.e., you don't need to add @samp{inline} in front of
6369 the member function name.
6371 @item -fno-defer-pop
6372 @opindex fno-defer-pop
6373 Always pop the arguments to each function call as soon as that function
6374 returns.  For machines that must pop arguments after a function call,
6375 the compiler normally lets arguments accumulate on the stack for several
6376 function calls and pops them all at once.
6378 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6380 @item -fforward-propagate
6381 @opindex fforward-propagate
6382 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6383 instructions and checks if the result can be simplified.  If loop unrolling
6384 is active, two passes are performed and the second is scheduled after
6385 loop unrolling.
6387 This option is enabled by default at optimization levels @option{-O},
6388 @option{-O2}, @option{-O3}, @option{-Os}.
6390 @item -ffp-contract=@var{style}
6391 @opindex ffp-contract
6392 @option{-ffp-contract=off} disables floating-point expression contraction.
6393 @option{-ffp-contract=fast} enables floating-point expression contraction
6394 such as forming of fused multiply-add operations if the target has
6395 native support for them.
6396 @option{-ffp-contract=on} enables floating-point expression contraction
6397 if allowed by the language standard.  This is currently not implemented
6398 and treated equal to @option{-ffp-contract=off}.
6400 The default is @option{-ffp-contract=fast}.
6402 @item -fomit-frame-pointer
6403 @opindex fomit-frame-pointer
6404 Don't keep the frame pointer in a register for functions that
6405 don't need one.  This avoids the instructions to save, set up and
6406 restore frame pointers; it also makes an extra register available
6407 in many functions.  @strong{It also makes debugging impossible on
6408 some machines.}
6410 On some machines, such as the VAX, this flag has no effect, because
6411 the standard calling sequence automatically handles the frame pointer
6412 and nothing is saved by pretending it doesn't exist.  The
6413 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6414 whether a target machine supports this flag.  @xref{Registers,,Register
6415 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6417 Starting with GCC version 4.6, the default setting (when not optimizing for
6418 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6419 @option{-fomit-frame-pointer}.  The default can be reverted to
6420 @option{-fno-omit-frame-pointer} by configuring GCC with the
6421 @option{--enable-frame-pointer} configure option.
6423 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6425 @item -foptimize-sibling-calls
6426 @opindex foptimize-sibling-calls
6427 Optimize sibling and tail recursive calls.
6429 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6431 @item -fno-inline
6432 @opindex fno-inline
6433 Do not expand any functions inline apart from those marked with
6434 the @code{always_inline} attribute.  This is the default when not
6435 optimizing.
6437 Single functions can be exempted from inlining by marking them
6438 with the @code{noinline} attribute.
6440 @item -finline-small-functions
6441 @opindex finline-small-functions
6442 Integrate functions into their callers when their body is smaller than expected
6443 function call code (so overall size of program gets smaller).  The compiler
6444 heuristically decides which functions are simple enough to be worth integrating
6445 in this way.  This inlining applies to all functions, even those not declared
6446 inline.
6448 Enabled at level @option{-O2}.
6450 @item -findirect-inlining
6451 @opindex findirect-inlining
6452 Inline also indirect calls that are discovered to be known at compile
6453 time thanks to previous inlining.  This option has any effect only
6454 when inlining itself is turned on by the @option{-finline-functions}
6455 or @option{-finline-small-functions} options.
6457 Enabled at level @option{-O2}.
6459 @item -finline-functions
6460 @opindex finline-functions
6461 Consider all functions for inlining, even if they are not declared inline.
6462 The compiler heuristically decides which functions are worth integrating
6463 in this way.
6465 If all calls to a given function are integrated, and the function is
6466 declared @code{static}, then the function is normally not output as
6467 assembler code in its own right.
6469 Enabled at level @option{-O3}.
6471 @item -finline-functions-called-once
6472 @opindex finline-functions-called-once
6473 Consider all @code{static} functions called once for inlining into their
6474 caller even if they are not marked @code{inline}.  If a call to a given
6475 function is integrated, then the function is not output as assembler code
6476 in its own right.
6478 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6480 @item -fearly-inlining
6481 @opindex fearly-inlining
6482 Inline functions marked by @code{always_inline} and functions whose body seems
6483 smaller than the function call overhead early before doing
6484 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6485 makes profiling significantly cheaper and usually inlining faster on programs
6486 having large chains of nested wrapper functions.
6488 Enabled by default.
6490 @item -fipa-sra
6491 @opindex fipa-sra
6492 Perform interprocedural scalar replacement of aggregates, removal of
6493 unused parameters and replacement of parameters passed by reference
6494 by parameters passed by value.
6496 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6498 @item -finline-limit=@var{n}
6499 @opindex finline-limit
6500 By default, GCC limits the size of functions that can be inlined.  This flag
6501 allows coarse control of this limit.  @var{n} is the size of functions that
6502 can be inlined in number of pseudo instructions.
6504 Inlining is actually controlled by a number of parameters, which may be
6505 specified individually by using @option{--param @var{name}=@var{value}}.
6506 The @option{-finline-limit=@var{n}} option sets some of these parameters
6507 as follows:
6509 @table @gcctabopt
6510 @item max-inline-insns-single
6511 is set to @var{n}/2.
6512 @item max-inline-insns-auto
6513 is set to @var{n}/2.
6514 @end table
6516 See below for a documentation of the individual
6517 parameters controlling inlining and for the defaults of these parameters.
6519 @emph{Note:} there may be no value to @option{-finline-limit} that results
6520 in default behavior.
6522 @emph{Note:} pseudo instruction represents, in this particular context, an
6523 abstract measurement of function's size.  In no way does it represent a count
6524 of assembly instructions and as such its exact meaning might change from one
6525 release to an another.
6527 @item -fno-keep-inline-dllexport
6528 @opindex -fno-keep-inline-dllexport
6529 This is a more fine-grained version of @option{-fkeep-inline-functions},
6530 which applies only to functions that are declared using the @code{dllexport}
6531 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6532 Functions}.)
6534 @item -fkeep-inline-functions
6535 @opindex fkeep-inline-functions
6536 In C, emit @code{static} functions that are declared @code{inline}
6537 into the object file, even if the function has been inlined into all
6538 of its callers.  This switch does not affect functions using the
6539 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6540 inline functions into the object file.
6542 @item -fkeep-static-consts
6543 @opindex fkeep-static-consts
6544 Emit variables declared @code{static const} when optimization isn't turned
6545 on, even if the variables aren't referenced.
6547 GCC enables this option by default.  If you want to force the compiler to
6548 check if a variable is referenced, regardless of whether or not
6549 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6551 @item -fmerge-constants
6552 @opindex fmerge-constants
6553 Attempt to merge identical constants (string constants and floating-point
6554 constants) across compilation units.
6556 This option is the default for optimized compilation if the assembler and
6557 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6558 behavior.
6560 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6562 @item -fmerge-all-constants
6563 @opindex fmerge-all-constants
6564 Attempt to merge identical constants and identical variables.
6566 This option implies @option{-fmerge-constants}.  In addition to
6567 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6568 arrays or initialized constant variables with integral or floating-point
6569 types.  Languages like C or C++ require each variable, including multiple
6570 instances of the same variable in recursive calls, to have distinct locations,
6571 so using this option results in non-conforming
6572 behavior.
6574 @item -fmodulo-sched
6575 @opindex fmodulo-sched
6576 Perform swing modulo scheduling immediately before the first scheduling
6577 pass.  This pass looks at innermost loops and reorders their
6578 instructions by overlapping different iterations.
6580 @item -fmodulo-sched-allow-regmoves
6581 @opindex fmodulo-sched-allow-regmoves
6582 Perform more aggressive SMS-based modulo scheduling with register moves
6583 allowed.  By setting this flag certain anti-dependences edges are
6584 deleted, which triggers the generation of reg-moves based on the
6585 life-range analysis.  This option is effective only with
6586 @option{-fmodulo-sched} enabled.
6588 @item -fno-branch-count-reg
6589 @opindex fno-branch-count-reg
6590 Do not use ``decrement and branch'' instructions on a count register,
6591 but instead generate a sequence of instructions that decrement a
6592 register, compare it against zero, then branch based upon the result.
6593 This option is only meaningful on architectures that support such
6594 instructions, which include x86, PowerPC, IA-64 and S/390.
6596 The default is @option{-fbranch-count-reg}.
6598 @item -fno-function-cse
6599 @opindex fno-function-cse
6600 Do not put function addresses in registers; make each instruction that
6601 calls a constant function contain the function's address explicitly.
6603 This option results in less efficient code, but some strange hacks
6604 that alter the assembler output may be confused by the optimizations
6605 performed when this option is not used.
6607 The default is @option{-ffunction-cse}
6609 @item -fno-zero-initialized-in-bss
6610 @opindex fno-zero-initialized-in-bss
6611 If the target supports a BSS section, GCC by default puts variables that
6612 are initialized to zero into BSS@.  This can save space in the resulting
6613 code.
6615 This option turns off this behavior because some programs explicitly
6616 rely on variables going to the data section.  E.g., so that the
6617 resulting executable can find the beginning of that section and/or make
6618 assumptions based on that.
6620 The default is @option{-fzero-initialized-in-bss}.
6622 @item -fmudflap -fmudflapth -fmudflapir
6623 @opindex fmudflap
6624 @opindex fmudflapth
6625 @opindex fmudflapir
6626 @cindex bounds checking
6627 @cindex mudflap
6628 For front-ends that support it (C and C++), instrument all risky
6629 pointer/array dereferencing operations, some standard library
6630 string/heap functions, and some other associated constructs with
6631 range/validity tests.  Modules so instrumented should be immune to
6632 buffer overflows, invalid heap use, and some other classes of C/C++
6633 programming errors.  The instrumentation relies on a separate runtime
6634 library (@file{libmudflap}), which is linked into a program if
6635 @option{-fmudflap} is given at link time.  Run-time behavior of the
6636 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6637 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6638 for its options.
6640 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6641 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6642 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6643 instrumentation should ignore pointer reads.  This produces less
6644 instrumentation (and therefore faster execution) and still provides
6645 some protection against outright memory corrupting writes, but allows
6646 erroneously read data to propagate within a program.
6648 @item -fthread-jumps
6649 @opindex fthread-jumps
6650 Perform optimizations where we check to see if a jump branches to a
6651 location where another comparison subsumed by the first is found.  If
6652 so, the first branch is redirected to either the destination of the
6653 second branch or a point immediately following it, depending on whether
6654 the condition is known to be true or false.
6656 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6658 @item -fsplit-wide-types
6659 @opindex fsplit-wide-types
6660 When using a type that occupies multiple registers, such as @code{long
6661 long} on a 32-bit system, split the registers apart and allocate them
6662 independently.  This normally generates better code for those types,
6663 but may make debugging more difficult.
6665 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6666 @option{-Os}.
6668 @item -fcse-follow-jumps
6669 @opindex fcse-follow-jumps
6670 In common subexpression elimination (CSE), scan through jump instructions
6671 when the target of the jump is not reached by any other path.  For
6672 example, when CSE encounters an @code{if} statement with an
6673 @code{else} clause, CSE follows the jump when the condition
6674 tested is false.
6676 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6678 @item -fcse-skip-blocks
6679 @opindex fcse-skip-blocks
6680 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6681 follow jumps that conditionally skip over blocks.  When CSE
6682 encounters a simple @code{if} statement with no else clause,
6683 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6684 body of the @code{if}.
6686 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6688 @item -frerun-cse-after-loop
6689 @opindex frerun-cse-after-loop
6690 Re-run common subexpression elimination after loop optimizations are
6691 performed.
6693 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6695 @item -fgcse
6696 @opindex fgcse
6697 Perform a global common subexpression elimination pass.
6698 This pass also performs global constant and copy propagation.
6700 @emph{Note:} When compiling a program using computed gotos, a GCC
6701 extension, you may get better run-time performance if you disable
6702 the global common subexpression elimination pass by adding
6703 @option{-fno-gcse} to the command line.
6705 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6707 @item -fgcse-lm
6708 @opindex fgcse-lm
6709 When @option{-fgcse-lm} is enabled, global common subexpression elimination
6710 attempts to move loads that are only killed by stores into themselves.  This
6711 allows a loop containing a load/store sequence to be changed to a load outside
6712 the loop, and a copy/store within the loop.
6714 Enabled by default when @option{-fgcse} is enabled.
6716 @item -fgcse-sm
6717 @opindex fgcse-sm
6718 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6719 global common subexpression elimination.  This pass attempts to move
6720 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6721 loops containing a load/store sequence can be changed to a load before
6722 the loop and a store after the loop.
6724 Not enabled at any optimization level.
6726 @item -fgcse-las
6727 @opindex fgcse-las
6728 When @option{-fgcse-las} is enabled, the global common subexpression
6729 elimination pass eliminates redundant loads that come after stores to the
6730 same memory location (both partial and full redundancies).
6732 Not enabled at any optimization level.
6734 @item -fgcse-after-reload
6735 @opindex fgcse-after-reload
6736 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6737 pass is performed after reload.  The purpose of this pass is to cleanup
6738 redundant spilling.
6740 @item -funsafe-loop-optimizations
6741 @opindex funsafe-loop-optimizations
6742 If given, the loop optimizer assumes that loop indices do not
6743 overflow, and that the loops with nontrivial exit condition are not
6744 infinite.  This enables a wider range of loop optimizations even if
6745 the loop optimizer itself cannot prove that these assumptions are valid.
6746 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
6747 if it finds this kind of loop.
6749 @item -fcrossjumping
6750 @opindex fcrossjumping
6751 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6752 resulting code may or may not perform better than without cross-jumping.
6754 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6756 @item -fauto-inc-dec
6757 @opindex fauto-inc-dec
6758 Combine increments or decrements of addresses with memory accesses.
6759 This pass is always skipped on architectures that do not have
6760 instructions to support this.  Enabled by default at @option{-O} and
6761 higher on architectures that support this.
6763 @item -fdce
6764 @opindex fdce
6765 Perform dead code elimination (DCE) on RTL@.
6766 Enabled by default at @option{-O} and higher.
6768 @item -fdse
6769 @opindex fdse
6770 Perform dead store elimination (DSE) on RTL@.
6771 Enabled by default at @option{-O} and higher.
6773 @item -fif-conversion
6774 @opindex fif-conversion
6775 Attempt to transform conditional jumps into branch-less equivalents.  This
6776 include use of conditional moves, min, max, set flags and abs instructions, and
6777 some tricks doable by standard arithmetics.  The use of conditional execution
6778 on chips where it is available is controlled by @code{if-conversion2}.
6780 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6782 @item -fif-conversion2
6783 @opindex fif-conversion2
6784 Use conditional execution (where available) to transform conditional jumps into
6785 branch-less equivalents.
6787 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6789 @item -fdelete-null-pointer-checks
6790 @opindex fdelete-null-pointer-checks
6791 Assume that programs cannot safely dereference null pointers, and that
6792 no code or data element resides there.  This enables simple constant
6793 folding optimizations at all optimization levels.  In addition, other
6794 optimization passes in GCC use this flag to control global dataflow
6795 analyses that eliminate useless checks for null pointers; these assume
6796 that if a pointer is checked after it has already been dereferenced,
6797 it cannot be null.
6799 Note however that in some environments this assumption is not true.
6800 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6801 for programs that depend on that behavior.
6803 Some targets, especially embedded ones, disable this option at all levels.
6804 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6805 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6806 are enabled independently at different optimization levels.
6808 @item -fdevirtualize
6809 @opindex fdevirtualize
6810 Attempt to convert calls to virtual functions to direct calls.  This
6811 is done both within a procedure and interprocedurally as part of
6812 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
6813 propagation (@option{-fipa-cp}).
6814 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6816 @item -fexpensive-optimizations
6817 @opindex fexpensive-optimizations
6818 Perform a number of minor optimizations that are relatively expensive.
6820 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6822 @item -free
6823 @opindex free
6824 Attempt to remove redundant extension instructions.  This is especially
6825 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
6826 registers after writing to their lower 32-bit half.
6828 Enabled for x86 at levels @option{-O2}, @option{-O3}.
6830 @item -foptimize-register-move
6831 @itemx -fregmove
6832 @opindex foptimize-register-move
6833 @opindex fregmove
6834 Attempt to reassign register numbers in move instructions and as
6835 operands of other simple instructions in order to maximize the amount of
6836 register tying.  This is especially helpful on machines with two-operand
6837 instructions.
6839 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6840 optimization.
6842 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6844 @item -fira-algorithm=@var{algorithm}
6845 Use the specified coloring algorithm for the integrated register
6846 allocator.  The @var{algorithm} argument can be @samp{priority}, which
6847 specifies Chow's priority coloring, or @samp{CB}, which specifies
6848 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
6849 for all architectures, but for those targets that do support it, it is
6850 the default because it generates better code.
6852 @item -fira-region=@var{region}
6853 Use specified regions for the integrated register allocator.  The
6854 @var{region} argument should be one of the following:
6856 @table @samp
6858 @item all
6859 Use all loops as register allocation regions.
6860 This can give the best results for machines with a small and/or
6861 irregular register set.
6863 @item mixed
6864 Use all loops except for loops with small register pressure 
6865 as the regions.  This value usually gives
6866 the best results in most cases and for most architectures,
6867 and is enabled by default when compiling with optimization for speed
6868 (@option{-O}, @option{-O2}, @dots{}).
6870 @item one
6871 Use all functions as a single region.  
6872 This typically results in the smallest code size, and is enabled by default for
6873 @option{-Os} or @option{-O0}.
6875 @end table
6877 @item -fira-loop-pressure
6878 @opindex fira-loop-pressure
6879 Use IRA to evaluate register pressure in loops for decisions to move
6880 loop invariants.  This option usually results in generation
6881 of faster and smaller code on machines with large register files (>= 32
6882 registers), but it can slow the compiler down.
6884 This option is enabled at level @option{-O3} for some targets.
6886 @item -fno-ira-share-save-slots
6887 @opindex fno-ira-share-save-slots
6888 Disable sharing of stack slots used for saving call-used hard
6889 registers living through a call.  Each hard register gets a
6890 separate stack slot, and as a result function stack frames are
6891 larger.
6893 @item -fno-ira-share-spill-slots
6894 @opindex fno-ira-share-spill-slots
6895 Disable sharing of stack slots allocated for pseudo-registers.  Each
6896 pseudo-register that does not get a hard register gets a separate
6897 stack slot, and as a result function stack frames are larger.
6899 @item -fira-verbose=@var{n}
6900 @opindex fira-verbose
6901 Control the verbosity of the dump file for the integrated register allocator.
6902 The default value is 5.  If the value @var{n} is greater or equal to 10,
6903 the dump output is sent to stderr using the same format as @var{n} minus 10.
6905 @item -fdelayed-branch
6906 @opindex fdelayed-branch
6907 If supported for the target machine, attempt to reorder instructions
6908 to exploit instruction slots available after delayed branch
6909 instructions.
6911 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6913 @item -fschedule-insns
6914 @opindex fschedule-insns
6915 If supported for the target machine, attempt to reorder instructions to
6916 eliminate execution stalls due to required data being unavailable.  This
6917 helps machines that have slow floating point or memory load instructions
6918 by allowing other instructions to be issued until the result of the load
6919 or floating-point instruction is required.
6921 Enabled at levels @option{-O2}, @option{-O3}.
6923 @item -fschedule-insns2
6924 @opindex fschedule-insns2
6925 Similar to @option{-fschedule-insns}, but requests an additional pass of
6926 instruction scheduling after register allocation has been done.  This is
6927 especially useful on machines with a relatively small number of
6928 registers and where memory load instructions take more than one cycle.
6930 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6932 @item -fno-sched-interblock
6933 @opindex fno-sched-interblock
6934 Don't schedule instructions across basic blocks.  This is normally
6935 enabled by default when scheduling before register allocation, i.e.@:
6936 with @option{-fschedule-insns} or at @option{-O2} or higher.
6938 @item -fno-sched-spec
6939 @opindex fno-sched-spec
6940 Don't allow speculative motion of non-load instructions.  This is normally
6941 enabled by default when scheduling before register allocation, i.e.@:
6942 with @option{-fschedule-insns} or at @option{-O2} or higher.
6944 @item -fsched-pressure
6945 @opindex fsched-pressure
6946 Enable register pressure sensitive insn scheduling before the register
6947 allocation.  This only makes sense when scheduling before register
6948 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6949 @option{-O2} or higher.  Usage of this option can improve the
6950 generated code and decrease its size by preventing register pressure
6951 increase above the number of available hard registers and as a
6952 consequence register spills in the register allocation.
6954 @item -fsched-spec-load
6955 @opindex fsched-spec-load
6956 Allow speculative motion of some load instructions.  This only makes
6957 sense when scheduling before register allocation, i.e.@: with
6958 @option{-fschedule-insns} or at @option{-O2} or higher.
6960 @item -fsched-spec-load-dangerous
6961 @opindex fsched-spec-load-dangerous
6962 Allow speculative motion of more load instructions.  This only makes
6963 sense when scheduling before register allocation, i.e.@: with
6964 @option{-fschedule-insns} or at @option{-O2} or higher.
6966 @item -fsched-stalled-insns
6967 @itemx -fsched-stalled-insns=@var{n}
6968 @opindex fsched-stalled-insns
6969 Define how many insns (if any) can be moved prematurely from the queue
6970 of stalled insns into the ready list during the second scheduling pass.
6971 @option{-fno-sched-stalled-insns} means that no insns are moved
6972 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6973 on how many queued insns can be moved prematurely.
6974 @option{-fsched-stalled-insns} without a value is equivalent to
6975 @option{-fsched-stalled-insns=1}.
6977 @item -fsched-stalled-insns-dep
6978 @itemx -fsched-stalled-insns-dep=@var{n}
6979 @opindex fsched-stalled-insns-dep
6980 Define how many insn groups (cycles) are examined for a dependency
6981 on a stalled insn that is a candidate for premature removal from the queue
6982 of stalled insns.  This has an effect only during the second scheduling pass,
6983 and only if @option{-fsched-stalled-insns} is used.
6984 @option{-fno-sched-stalled-insns-dep} is equivalent to
6985 @option{-fsched-stalled-insns-dep=0}.
6986 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6987 @option{-fsched-stalled-insns-dep=1}.
6989 @item -fsched2-use-superblocks
6990 @opindex fsched2-use-superblocks
6991 When scheduling after register allocation, do use superblock scheduling
6992 algorithm.  Superblock scheduling allows motion across basic block boundaries
6993 resulting on faster schedules.  This option is experimental, as not all machine
6994 descriptions used by GCC model the CPU closely enough to avoid unreliable
6995 results from the algorithm.
6997 This only makes sense when scheduling after register allocation, i.e.@: with
6998 @option{-fschedule-insns2} or at @option{-O2} or higher.
7000 @item -fsched-group-heuristic
7001 @opindex fsched-group-heuristic
7002 Enable the group heuristic in the scheduler.  This heuristic favors
7003 the instruction that belongs to a schedule group.  This is enabled
7004 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7005 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7007 @item -fsched-critical-path-heuristic
7008 @opindex fsched-critical-path-heuristic
7009 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7010 instructions on the critical path.  This is enabled by default when
7011 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7012 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7014 @item -fsched-spec-insn-heuristic
7015 @opindex fsched-spec-insn-heuristic
7016 Enable the speculative instruction heuristic in the scheduler.  This
7017 heuristic favors speculative instructions with greater dependency weakness.
7018 This is enabled by default when scheduling is enabled, i.e.@:
7019 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7020 or at @option{-O2} or higher.
7022 @item -fsched-rank-heuristic
7023 @opindex fsched-rank-heuristic
7024 Enable the rank heuristic in the scheduler.  This heuristic favors
7025 the instruction belonging to a basic block with greater size or frequency.
7026 This is enabled by default when scheduling is enabled, i.e.@:
7027 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7028 at @option{-O2} or higher.
7030 @item -fsched-last-insn-heuristic
7031 @opindex fsched-last-insn-heuristic
7032 Enable the last-instruction heuristic in the scheduler.  This heuristic
7033 favors the instruction that is less dependent on the last instruction
7034 scheduled.  This is enabled by default when scheduling is enabled,
7035 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7036 at @option{-O2} or higher.
7038 @item -fsched-dep-count-heuristic
7039 @opindex fsched-dep-count-heuristic
7040 Enable the dependent-count heuristic in the scheduler.  This heuristic
7041 favors the instruction that has more instructions depending on it.
7042 This is enabled by default when scheduling is enabled, i.e.@:
7043 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7044 at @option{-O2} or higher.
7046 @item -freschedule-modulo-scheduled-loops
7047 @opindex freschedule-modulo-scheduled-loops
7048 The modulo scheduling comes before the traditional scheduling.  If a loop
7049 is modulo scheduled you may want to prevent the later scheduling passes
7050 from changing its schedule; use this option to control that.
7052 @item -fselective-scheduling
7053 @opindex fselective-scheduling
7054 Schedule instructions using selective scheduling algorithm.  Selective
7055 scheduling runs instead of the first scheduler pass.
7057 @item -fselective-scheduling2
7058 @opindex fselective-scheduling2
7059 Schedule instructions using selective scheduling algorithm.  Selective
7060 scheduling runs instead of the second scheduler pass.
7062 @item -fsel-sched-pipelining
7063 @opindex fsel-sched-pipelining
7064 Enable software pipelining of innermost loops during selective scheduling.
7065 This option has no effect until one of @option{-fselective-scheduling} or
7066 @option{-fselective-scheduling2} is turned on.
7068 @item -fsel-sched-pipelining-outer-loops
7069 @opindex fsel-sched-pipelining-outer-loops
7070 When pipelining loops during selective scheduling, also pipeline outer loops.
7071 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
7073 @item -fshrink-wrap
7074 @opindex fshrink-wrap
7075 Emit function prologues only before parts of the function that need it,
7076 rather than at the top of the function.  This flag is enabled by default at
7077 @option{-O} and higher.
7079 @item -fcaller-saves
7080 @opindex fcaller-saves
7081 Enable allocation of values to registers that are clobbered by
7082 function calls, by emitting extra instructions to save and restore the
7083 registers around such calls.  Such allocation is done only when it
7084 seems to result in better code.
7086 This option is always enabled by default on certain machines, usually
7087 those which have no call-preserved registers to use instead.
7089 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7091 @item -fcombine-stack-adjustments
7092 @opindex fcombine-stack-adjustments
7093 Tracks stack adjustments (pushes and pops) and stack memory references
7094 and then tries to find ways to combine them.
7096 Enabled by default at @option{-O1} and higher.
7098 @item -fconserve-stack
7099 @opindex fconserve-stack
7100 Attempt to minimize stack usage.  The compiler attempts to use less
7101 stack space, even if that makes the program slower.  This option
7102 implies setting the @option{large-stack-frame} parameter to 100
7103 and the @option{large-stack-frame-growth} parameter to 400.
7105 @item -ftree-reassoc
7106 @opindex ftree-reassoc
7107 Perform reassociation on trees.  This flag is enabled by default
7108 at @option{-O} and higher.
7110 @item -ftree-pre
7111 @opindex ftree-pre
7112 Perform partial redundancy elimination (PRE) on trees.  This flag is
7113 enabled by default at @option{-O2} and @option{-O3}.
7115 @item -ftree-partial-pre
7116 @opindex ftree-partial-pre
7117 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7118 enabled by default at @option{-O3}.
7120 @item -ftree-forwprop
7121 @opindex ftree-forwprop
7122 Perform forward propagation on trees.  This flag is enabled by default
7123 at @option{-O} and higher.
7125 @item -ftree-fre
7126 @opindex ftree-fre
7127 Perform full redundancy elimination (FRE) on trees.  The difference
7128 between FRE and PRE is that FRE only considers expressions
7129 that are computed on all paths leading to the redundant computation.
7130 This analysis is faster than PRE, though it exposes fewer redundancies.
7131 This flag is enabled by default at @option{-O} and higher.
7133 @item -ftree-phiprop
7134 @opindex ftree-phiprop
7135 Perform hoisting of loads from conditional pointers on trees.  This
7136 pass is enabled by default at @option{-O} and higher.
7138 @item -fhoist-adjacent-loads
7139 @opindex hoist-adjacent-loads
7140 Speculatively hoist loads from both branches of an if-then-else if the
7141 loads are from adjacent locations in the same structure and the target
7142 architecture has a conditional move instruction.  This flag is enabled
7143 by default at @option{-O2} and higher.
7145 @item -ftree-copy-prop
7146 @opindex ftree-copy-prop
7147 Perform copy propagation on trees.  This pass eliminates unnecessary
7148 copy operations.  This flag is enabled by default at @option{-O} and
7149 higher.
7151 @item -fipa-pure-const
7152 @opindex fipa-pure-const
7153 Discover which functions are pure or constant.
7154 Enabled by default at @option{-O} and higher.
7156 @item -fipa-reference
7157 @opindex fipa-reference
7158 Discover which static variables do not escape cannot escape the
7159 compilation unit.
7160 Enabled by default at @option{-O} and higher.
7162 @item -fipa-pta
7163 @opindex fipa-pta
7164 Perform interprocedural pointer analysis and interprocedural modification
7165 and reference analysis.  This option can cause excessive memory and
7166 compile-time usage on large compilation units.  It is not enabled by
7167 default at any optimization level.
7169 @item -fipa-profile
7170 @opindex fipa-profile
7171 Perform interprocedural profile propagation.  The functions called only from
7172 cold functions are marked as cold. Also functions executed once (such as
7173 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7174 functions and loop less parts of functions executed once are then optimized for
7175 size.
7176 Enabled by default at @option{-O} and higher.
7178 @item -fipa-cp
7179 @opindex fipa-cp
7180 Perform interprocedural constant propagation.
7181 This optimization analyzes the program to determine when values passed
7182 to functions are constants and then optimizes accordingly.
7183 This optimization can substantially increase performance
7184 if the application has constants passed to functions.
7185 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7187 @item -fipa-cp-clone
7188 @opindex fipa-cp-clone
7189 Perform function cloning to make interprocedural constant propagation stronger.
7190 When enabled, interprocedural constant propagation performs function cloning
7191 when externally visible function can be called with constant arguments.
7192 Because this optimization can create multiple copies of functions,
7193 it may significantly increase code size
7194 (see @option{--param ipcp-unit-growth=@var{value}}).
7195 This flag is enabled by default at @option{-O3}.
7197 @item -fipa-matrix-reorg
7198 @opindex fipa-matrix-reorg
7199 Perform matrix flattening and transposing.
7200 Matrix flattening tries to replace an @math{m}-dimensional matrix
7201 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
7202 This reduces the level of indirection needed for accessing the elements
7203 of the matrix. The second optimization is matrix transposing, which
7204 attempts to change the order of the matrix's dimensions in order to
7205 improve cache locality.
7206 Both optimizations need the @option{-fwhole-program} flag.
7207 Transposing is enabled only if profiling information is available.
7209 @item -ftree-sink
7210 @opindex ftree-sink
7211 Perform forward store motion  on trees.  This flag is
7212 enabled by default at @option{-O} and higher.
7214 @item -ftree-bit-ccp
7215 @opindex ftree-bit-ccp
7216 Perform sparse conditional bit constant propagation on trees and propagate
7217 pointer alignment information.
7218 This pass only operates on local scalar variables and is enabled by default
7219 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7221 @item -ftree-ccp
7222 @opindex ftree-ccp
7223 Perform sparse conditional constant propagation (CCP) on trees.  This
7224 pass only operates on local scalar variables and is enabled by default
7225 at @option{-O} and higher.
7227 @item -ftree-switch-conversion
7228 Perform conversion of simple initializations in a switch to
7229 initializations from a scalar array.  This flag is enabled by default
7230 at @option{-O2} and higher.
7232 @item -ftree-tail-merge
7233 Look for identical code sequences.  When found, replace one with a jump to the
7234 other.  This optimization is known as tail merging or cross jumping.  This flag
7235 is enabled by default at @option{-O2} and higher.  The compilation time
7236 in this pass can
7237 be limited using @option{max-tail-merge-comparisons} parameter and
7238 @option{max-tail-merge-iterations} parameter.
7240 @item -ftree-dce
7241 @opindex ftree-dce
7242 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7243 default at @option{-O} and higher.
7245 @item -ftree-builtin-call-dce
7246 @opindex ftree-builtin-call-dce
7247 Perform conditional dead code elimination (DCE) for calls to builtin functions
7248 that may set @code{errno} but are otherwise side-effect free.  This flag is
7249 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7250 specified.
7252 @item -ftree-dominator-opts
7253 @opindex ftree-dominator-opts
7254 Perform a variety of simple scalar cleanups (constant/copy
7255 propagation, redundancy elimination, range propagation and expression
7256 simplification) based on a dominator tree traversal.  This also
7257 performs jump threading (to reduce jumps to jumps). This flag is
7258 enabled by default at @option{-O} and higher.
7260 @item -ftree-dse
7261 @opindex ftree-dse
7262 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7263 a memory location that is later overwritten by another store without
7264 any intervening loads.  In this case the earlier store can be deleted.  This
7265 flag is enabled by default at @option{-O} and higher.
7267 @item -ftree-ch
7268 @opindex ftree-ch
7269 Perform loop header copying on trees.  This is beneficial since it increases
7270 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7271 is enabled by default at @option{-O} and higher.  It is not enabled
7272 for @option{-Os}, since it usually increases code size.
7274 @item -ftree-loop-optimize
7275 @opindex ftree-loop-optimize
7276 Perform loop optimizations on trees.  This flag is enabled by default
7277 at @option{-O} and higher.
7279 @item -ftree-loop-linear
7280 @opindex ftree-loop-linear
7281 Perform loop interchange transformations on tree.  Same as
7282 @option{-floop-interchange}.  To use this code transformation, GCC has
7283 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7284 enable the Graphite loop transformation infrastructure.
7286 @item -floop-interchange
7287 @opindex floop-interchange
7288 Perform loop interchange transformations on loops.  Interchanging two
7289 nested loops switches the inner and outer loops.  For example, given a
7290 loop like:
7291 @smallexample
7292 DO J = 1, M
7293   DO I = 1, N
7294     A(J, I) = A(J, I) * C
7295   ENDDO
7296 ENDDO
7297 @end smallexample
7298 loop interchange transforms the loop as if it were written:
7299 @smallexample
7300 DO I = 1, N
7301   DO J = 1, M
7302     A(J, I) = A(J, I) * C
7303   ENDDO
7304 ENDDO
7305 @end smallexample
7306 which can be beneficial when @code{N} is larger than the caches,
7307 because in Fortran, the elements of an array are stored in memory
7308 contiguously by column, and the original loop iterates over rows,
7309 potentially creating at each access a cache miss.  This optimization
7310 applies to all the languages supported by GCC and is not limited to
7311 Fortran.  To use this code transformation, GCC has to be configured
7312 with @option{--with-ppl} and @option{--with-cloog} to enable the
7313 Graphite loop transformation infrastructure.
7315 @item -floop-strip-mine
7316 @opindex floop-strip-mine
7317 Perform loop strip mining transformations on loops.  Strip mining
7318 splits a loop into two nested loops.  The outer loop has strides
7319 equal to the strip size and the inner loop has strides of the
7320 original loop within a strip.  The strip length can be changed
7321 using the @option{loop-block-tile-size} parameter.  For example,
7322 given a loop like:
7323 @smallexample
7324 DO I = 1, N
7325   A(I) = A(I) + C
7326 ENDDO
7327 @end smallexample
7328 loop strip mining transforms the loop as if it were written:
7329 @smallexample
7330 DO II = 1, N, 51
7331   DO I = II, min (II + 50, N)
7332     A(I) = A(I) + C
7333   ENDDO
7334 ENDDO
7335 @end smallexample
7336 This optimization applies to all the languages supported by GCC and is
7337 not limited to Fortran.  To use this code transformation, GCC has to
7338 be configured with @option{--with-ppl} and @option{--with-cloog} to
7339 enable the Graphite loop transformation infrastructure.
7341 @item -floop-block
7342 @opindex floop-block
7343 Perform loop blocking transformations on loops.  Blocking strip mines
7344 each loop in the loop nest such that the memory accesses of the
7345 element loops fit inside caches.  The strip length can be changed
7346 using the @option{loop-block-tile-size} parameter.  For example, given
7347 a loop like:
7348 @smallexample
7349 DO I = 1, N
7350   DO J = 1, M
7351     A(J, I) = B(I) + C(J)
7352   ENDDO
7353 ENDDO
7354 @end smallexample
7355 loop blocking transforms the loop as if it were written:
7356 @smallexample
7357 DO II = 1, N, 51
7358   DO JJ = 1, M, 51
7359     DO I = II, min (II + 50, N)
7360       DO J = JJ, min (JJ + 50, M)
7361         A(J, I) = B(I) + C(J)
7362       ENDDO
7363     ENDDO
7364   ENDDO
7365 ENDDO
7366 @end smallexample
7367 which can be beneficial when @code{M} is larger than the caches,
7368 because the innermost loop iterates over a smaller amount of data
7369 which can be kept in the caches.  This optimization applies to all the
7370 languages supported by GCC and is not limited to Fortran.  To use this
7371 code transformation, GCC has to be configured with @option{--with-ppl}
7372 and @option{--with-cloog} to enable the Graphite loop transformation
7373 infrastructure.
7375 @item -fgraphite-identity
7376 @opindex fgraphite-identity
7377 Enable the identity transformation for graphite.  For every SCoP we generate
7378 the polyhedral representation and transform it back to gimple.  Using
7379 @option{-fgraphite-identity} we can check the costs or benefits of the
7380 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7381 are also performed by the code generator CLooG, like index splitting and
7382 dead code elimination in loops.
7384 @item -floop-nest-optimize
7385 @opindex floop-nest-optimize
7386 Enable the ISL based loop nest optimizer.  This is a generic loop nest
7387 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7388 structure optimized for data-locality and parallelism.  This option
7389 is experimental.
7391 @item -floop-parallelize-all
7392 @opindex floop-parallelize-all
7393 Use the Graphite data dependence analysis to identify loops that can
7394 be parallelized.  Parallelize all the loops that can be analyzed to
7395 not contain loop carried dependences without checking that it is
7396 profitable to parallelize the loops.
7398 @item -fcheck-data-deps
7399 @opindex fcheck-data-deps
7400 Compare the results of several data dependence analyzers.  This option
7401 is used for debugging the data dependence analyzers.
7403 @item -ftree-loop-if-convert
7404 Attempt to transform conditional jumps in the innermost loops to
7405 branch-less equivalents.  The intent is to remove control-flow from
7406 the innermost loops in order to improve the ability of the
7407 vectorization pass to handle these loops.  This is enabled by default
7408 if vectorization is enabled.
7410 @item -ftree-loop-if-convert-stores
7411 Attempt to also if-convert conditional jumps containing memory writes.
7412 This transformation can be unsafe for multi-threaded programs as it
7413 transforms conditional memory writes into unconditional memory writes.
7414 For example,
7415 @smallexample
7416 for (i = 0; i < N; i++)
7417   if (cond)
7418     A[i] = expr;
7419 @end smallexample
7420 is transformed to
7421 @smallexample
7422 for (i = 0; i < N; i++)
7423   A[i] = cond ? expr : A[i];
7424 @end smallexample
7425 potentially producing data races.
7427 @item -ftree-loop-distribution
7428 Perform loop distribution.  This flag can improve cache performance on
7429 big loop bodies and allow further loop optimizations, like
7430 parallelization or vectorization, to take place.  For example, the loop
7431 @smallexample
7432 DO I = 1, N
7433   A(I) = B(I) + C
7434   D(I) = E(I) * F
7435 ENDDO
7436 @end smallexample
7437 is transformed to
7438 @smallexample
7439 DO I = 1, N
7440    A(I) = B(I) + C
7441 ENDDO
7442 DO I = 1, N
7443    D(I) = E(I) * F
7444 ENDDO
7445 @end smallexample
7447 @item -ftree-loop-distribute-patterns
7448 Perform loop distribution of patterns that can be code generated with
7449 calls to a library.  This flag is enabled by default at @option{-O3}.
7451 This pass distributes the initialization loops and generates a call to
7452 memset zero.  For example, the loop
7453 @smallexample
7454 DO I = 1, N
7455   A(I) = 0
7456   B(I) = A(I) + I
7457 ENDDO
7458 @end smallexample
7459 is transformed to
7460 @smallexample
7461 DO I = 1, N
7462    A(I) = 0
7463 ENDDO
7464 DO I = 1, N
7465    B(I) = A(I) + I
7466 ENDDO
7467 @end smallexample
7468 and the initialization loop is transformed into a call to memset zero.
7470 @item -ftree-loop-im
7471 @opindex ftree-loop-im
7472 Perform loop invariant motion on trees.  This pass moves only invariants that
7473 are hard to handle at RTL level (function calls, operations that expand to
7474 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7475 operands of conditions that are invariant out of the loop, so that we can use
7476 just trivial invariantness analysis in loop unswitching.  The pass also includes
7477 store motion.
7479 @item -ftree-loop-ivcanon
7480 @opindex ftree-loop-ivcanon
7481 Create a canonical counter for number of iterations in loops for which
7482 determining number of iterations requires complicated analysis.  Later
7483 optimizations then may determine the number easily.  Useful especially
7484 in connection with unrolling.
7486 @item -fivopts
7487 @opindex fivopts
7488 Perform induction variable optimizations (strength reduction, induction
7489 variable merging and induction variable elimination) on trees.
7491 @item -ftree-parallelize-loops=n
7492 @opindex ftree-parallelize-loops
7493 Parallelize loops, i.e., split their iteration space to run in n threads.
7494 This is only possible for loops whose iterations are independent
7495 and can be arbitrarily reordered.  The optimization is only
7496 profitable on multiprocessor machines, for loops that are CPU-intensive,
7497 rather than constrained e.g.@: by memory bandwidth.  This option
7498 implies @option{-pthread}, and thus is only supported on targets
7499 that have support for @option{-pthread}.
7501 @item -ftree-pta
7502 @opindex ftree-pta
7503 Perform function-local points-to analysis on trees.  This flag is
7504 enabled by default at @option{-O} and higher.
7506 @item -ftree-sra
7507 @opindex ftree-sra
7508 Perform scalar replacement of aggregates.  This pass replaces structure
7509 references with scalars to prevent committing structures to memory too
7510 early.  This flag is enabled by default at @option{-O} and higher.
7512 @item -ftree-copyrename
7513 @opindex ftree-copyrename
7514 Perform copy renaming on trees.  This pass attempts to rename compiler
7515 temporaries to other variables at copy locations, usually resulting in
7516 variable names which more closely resemble the original variables.  This flag
7517 is enabled by default at @option{-O} and higher.
7519 @item -ftree-coalesce-inlined-vars
7520 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7521 combine small user-defined variables too, but only if they were inlined
7522 from other functions.  It is a more limited form of
7523 @option{-ftree-coalesce-vars}.  This may harm debug information of such
7524 inlined variables, but it will keep variables of the inlined-into
7525 function apart from each other, such that they are more likely to
7526 contain the expected values in a debugging session.  This was the
7527 default in GCC versions older than 4.7.
7529 @item -ftree-coalesce-vars
7530 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7531 combine small user-defined variables too, instead of just compiler
7532 temporaries.  This may severely limit the ability to debug an optimized
7533 program compiled with @option{-fno-var-tracking-assignments}.  In the
7534 negated form, this flag prevents SSA coalescing of user variables,
7535 including inlined ones.  This option is enabled by default.
7537 @item -ftree-ter
7538 @opindex ftree-ter
7539 Perform temporary expression replacement during the SSA->normal phase.  Single
7540 use/single def temporaries are replaced at their use location with their
7541 defining expression.  This results in non-GIMPLE code, but gives the expanders
7542 much more complex trees to work on resulting in better RTL generation.  This is
7543 enabled by default at @option{-O} and higher.
7545 @item -ftree-slsr
7546 @opindex ftree-slsr
7547 Perform straight-line strength reduction on trees.  This recognizes related
7548 expressions involving multiplications and replaces them by less expensive
7549 calculations when possible.  This is enabled by default at @option{-O} and
7550 higher.
7552 @item -ftree-vectorize
7553 @opindex ftree-vectorize
7554 Perform loop vectorization on trees. This flag is enabled by default at
7555 @option{-O3}.
7557 @item -ftree-slp-vectorize
7558 @opindex ftree-slp-vectorize
7559 Perform basic block vectorization on trees. This flag is enabled by default at
7560 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7562 @item -ftree-vect-loop-version
7563 @opindex ftree-vect-loop-version
7564 Perform loop versioning when doing loop vectorization on trees.  When a loop
7565 appears to be vectorizable except that data alignment or data dependence cannot
7566 be determined at compile time, then vectorized and non-vectorized versions of
7567 the loop are generated along with run-time checks for alignment or dependence
7568 to control which version is executed.  This option is enabled by default
7569 except at level @option{-Os} where it is disabled.
7571 @item -fvect-cost-model
7572 @opindex fvect-cost-model
7573 Enable cost model for vectorization.  This option is enabled by default at
7574 @option{-O3}.
7576 @item -ftree-vrp
7577 @opindex ftree-vrp
7578 Perform Value Range Propagation on trees.  This is similar to the
7579 constant propagation pass, but instead of values, ranges of values are
7580 propagated.  This allows the optimizers to remove unnecessary range
7581 checks like array bound checks and null pointer checks.  This is
7582 enabled by default at @option{-O2} and higher.  Null pointer check
7583 elimination is only done if @option{-fdelete-null-pointer-checks} is
7584 enabled.
7586 @item -ftracer
7587 @opindex ftracer
7588 Perform tail duplication to enlarge superblock size.  This transformation
7589 simplifies the control flow of the function allowing other optimizations to do
7590 better job.
7592 @item -funroll-loops
7593 @opindex funroll-loops
7594 Unroll loops whose number of iterations can be determined at compile
7595 time or upon entry to the loop.  @option{-funroll-loops} implies
7596 @option{-frerun-cse-after-loop}.  This option makes code larger,
7597 and may or may not make it run faster.
7599 @item -funroll-all-loops
7600 @opindex funroll-all-loops
7601 Unroll all loops, even if their number of iterations is uncertain when
7602 the loop is entered.  This usually makes programs run more slowly.
7603 @option{-funroll-all-loops} implies the same options as
7604 @option{-funroll-loops},
7606 @item -fsplit-ivs-in-unroller
7607 @opindex fsplit-ivs-in-unroller
7608 Enables expressing of values of induction variables in later iterations
7609 of the unrolled loop using the value in the first iteration.  This breaks
7610 long dependency chains, thus improving efficiency of the scheduling passes.
7612 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7613 same effect.  However in cases the loop body is more complicated than
7614 a single basic block, this is not reliable.  It also does not work at all
7615 on some of the architectures due to restrictions in the CSE pass.
7617 This optimization is enabled by default.
7619 @item -fvariable-expansion-in-unroller
7620 @opindex fvariable-expansion-in-unroller
7621 With this option, the compiler creates multiple copies of some
7622 local variables when unrolling a loop, which can result in superior code.
7624 @item -fpartial-inlining
7625 @opindex fpartial-inlining
7626 Inline parts of functions.  This option has any effect only
7627 when inlining itself is turned on by the @option{-finline-functions}
7628 or @option{-finline-small-functions} options.
7630 Enabled at level @option{-O2}.
7632 @item -fpredictive-commoning
7633 @opindex fpredictive-commoning
7634 Perform predictive commoning optimization, i.e., reusing computations
7635 (especially memory loads and stores) performed in previous
7636 iterations of loops.
7638 This option is enabled at level @option{-O3}.
7640 @item -fprefetch-loop-arrays
7641 @opindex fprefetch-loop-arrays
7642 If supported by the target machine, generate instructions to prefetch
7643 memory to improve the performance of loops that access large arrays.
7645 This option may generate better or worse code; results are highly
7646 dependent on the structure of loops within the source code.
7648 Disabled at level @option{-Os}.
7650 @item -fno-peephole
7651 @itemx -fno-peephole2
7652 @opindex fno-peephole
7653 @opindex fno-peephole2
7654 Disable any machine-specific peephole optimizations.  The difference
7655 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7656 are implemented in the compiler; some targets use one, some use the
7657 other, a few use both.
7659 @option{-fpeephole} is enabled by default.
7660 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7662 @item -fno-guess-branch-probability
7663 @opindex fno-guess-branch-probability
7664 Do not guess branch probabilities using heuristics.
7666 GCC uses heuristics to guess branch probabilities if they are
7667 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7668 heuristics are based on the control flow graph.  If some branch probabilities
7669 are specified by @samp{__builtin_expect}, then the heuristics are
7670 used to guess branch probabilities for the rest of the control flow graph,
7671 taking the @samp{__builtin_expect} info into account.  The interactions
7672 between the heuristics and @samp{__builtin_expect} can be complex, and in
7673 some cases, it may be useful to disable the heuristics so that the effects
7674 of @samp{__builtin_expect} are easier to understand.
7676 The default is @option{-fguess-branch-probability} at levels
7677 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7679 @item -freorder-blocks
7680 @opindex freorder-blocks
7681 Reorder basic blocks in the compiled function in order to reduce number of
7682 taken branches and improve code locality.
7684 Enabled at levels @option{-O2}, @option{-O3}.
7686 @item -freorder-blocks-and-partition
7687 @opindex freorder-blocks-and-partition
7688 In addition to reordering basic blocks in the compiled function, in order
7689 to reduce number of taken branches, partitions hot and cold basic blocks
7690 into separate sections of the assembly and .o files, to improve
7691 paging and cache locality performance.
7693 This optimization is automatically turned off in the presence of
7694 exception handling, for linkonce sections, for functions with a user-defined
7695 section attribute and on any architecture that does not support named
7696 sections.
7698 @item -freorder-functions
7699 @opindex freorder-functions
7700 Reorder functions in the object file in order to
7701 improve code locality.  This is implemented by using special
7702 subsections @code{.text.hot} for most frequently executed functions and
7703 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7704 the linker so object file format must support named sections and linker must
7705 place them in a reasonable way.
7707 Also profile feedback must be available in to make this option effective.  See
7708 @option{-fprofile-arcs} for details.
7710 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7712 @item -fstrict-aliasing
7713 @opindex fstrict-aliasing
7714 Allow the compiler to assume the strictest aliasing rules applicable to
7715 the language being compiled.  For C (and C++), this activates
7716 optimizations based on the type of expressions.  In particular, an
7717 object of one type is assumed never to reside at the same address as an
7718 object of a different type, unless the types are almost the same.  For
7719 example, an @code{unsigned int} can alias an @code{int}, but not a
7720 @code{void*} or a @code{double}.  A character type may alias any other
7721 type.
7723 @anchor{Type-punning}Pay special attention to code like this:
7724 @smallexample
7725 union a_union @{
7726   int i;
7727   double d;
7730 int f() @{
7731   union a_union t;
7732   t.d = 3.0;
7733   return t.i;
7735 @end smallexample
7736 The practice of reading from a different union member than the one most
7737 recently written to (called ``type-punning'') is common.  Even with
7738 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7739 is accessed through the union type.  So, the code above works as
7740 expected.  @xref{Structures unions enumerations and bit-fields
7741 implementation}.  However, this code might not:
7742 @smallexample
7743 int f() @{
7744   union a_union t;
7745   int* ip;
7746   t.d = 3.0;
7747   ip = &t.i;
7748   return *ip;
7750 @end smallexample
7752 Similarly, access by taking the address, casting the resulting pointer
7753 and dereferencing the result has undefined behavior, even if the cast
7754 uses a union type, e.g.:
7755 @smallexample
7756 int f() @{
7757   double d = 3.0;
7758   return ((union a_union *) &d)->i;
7760 @end smallexample
7762 The @option{-fstrict-aliasing} option is enabled at levels
7763 @option{-O2}, @option{-O3}, @option{-Os}.
7765 @item -fstrict-overflow
7766 @opindex fstrict-overflow
7767 Allow the compiler to assume strict signed overflow rules, depending
7768 on the language being compiled.  For C (and C++) this means that
7769 overflow when doing arithmetic with signed numbers is undefined, which
7770 means that the compiler may assume that it does not happen.  This
7771 permits various optimizations.  For example, the compiler assumes
7772 that an expression like @code{i + 10 > i} is always true for
7773 signed @code{i}.  This assumption is only valid if signed overflow is
7774 undefined, as the expression is false if @code{i + 10} overflows when
7775 using twos complement arithmetic.  When this option is in effect any
7776 attempt to determine whether an operation on signed numbers 
7777 overflows must be written carefully to not actually involve overflow.
7779 This option also allows the compiler to assume strict pointer
7780 semantics: given a pointer to an object, if adding an offset to that
7781 pointer does not produce a pointer to the same object, the addition is
7782 undefined.  This permits the compiler to conclude that @code{p + u >
7783 p} is always true for a pointer @code{p} and unsigned integer
7784 @code{u}.  This assumption is only valid because pointer wraparound is
7785 undefined, as the expression is false if @code{p + u} overflows using
7786 twos complement arithmetic.
7788 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7789 that integer signed overflow is fully defined: it wraps.  When
7790 @option{-fwrapv} is used, there is no difference between
7791 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7792 integers.  With @option{-fwrapv} certain types of overflow are
7793 permitted.  For example, if the compiler gets an overflow when doing
7794 arithmetic on constants, the overflowed value can still be used with
7795 @option{-fwrapv}, but not otherwise.
7797 The @option{-fstrict-overflow} option is enabled at levels
7798 @option{-O2}, @option{-O3}, @option{-Os}.
7800 @item -falign-functions
7801 @itemx -falign-functions=@var{n}
7802 @opindex falign-functions
7803 Align the start of functions to the next power-of-two greater than
7804 @var{n}, skipping up to @var{n} bytes.  For instance,
7805 @option{-falign-functions=32} aligns functions to the next 32-byte
7806 boundary, but @option{-falign-functions=24} aligns to the next
7807 32-byte boundary only if this can be done by skipping 23 bytes or less.
7809 @option{-fno-align-functions} and @option{-falign-functions=1} are
7810 equivalent and mean that functions are not aligned.
7812 Some assemblers only support this flag when @var{n} is a power of two;
7813 in that case, it is rounded up.
7815 If @var{n} is not specified or is zero, use a machine-dependent default.
7817 Enabled at levels @option{-O2}, @option{-O3}.
7819 @item -falign-labels
7820 @itemx -falign-labels=@var{n}
7821 @opindex falign-labels
7822 Align all branch targets to a power-of-two boundary, skipping up to
7823 @var{n} bytes like @option{-falign-functions}.  This option can easily
7824 make code slower, because it must insert dummy operations for when the
7825 branch target is reached in the usual flow of the code.
7827 @option{-fno-align-labels} and @option{-falign-labels=1} are
7828 equivalent and mean that labels are not aligned.
7830 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7831 are greater than this value, then their values are used instead.
7833 If @var{n} is not specified or is zero, use a machine-dependent default
7834 which is very likely to be @samp{1}, meaning no alignment.
7836 Enabled at levels @option{-O2}, @option{-O3}.
7838 @item -falign-loops
7839 @itemx -falign-loops=@var{n}
7840 @opindex falign-loops
7841 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7842 like @option{-falign-functions}.  If the loops are
7843 executed many times, this makes up for any execution of the dummy
7844 operations.
7846 @option{-fno-align-loops} and @option{-falign-loops=1} are
7847 equivalent and mean that loops are not aligned.
7849 If @var{n} is not specified or is zero, use a machine-dependent default.
7851 Enabled at levels @option{-O2}, @option{-O3}.
7853 @item -falign-jumps
7854 @itemx -falign-jumps=@var{n}
7855 @opindex falign-jumps
7856 Align branch targets to a power-of-two boundary, for branch targets
7857 where the targets can only be reached by jumping, skipping up to @var{n}
7858 bytes like @option{-falign-functions}.  In this case, no dummy operations
7859 need be executed.
7861 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7862 equivalent and mean that loops are not aligned.
7864 If @var{n} is not specified or is zero, use a machine-dependent default.
7866 Enabled at levels @option{-O2}, @option{-O3}.
7868 @item -funit-at-a-time
7869 @opindex funit-at-a-time
7870 This option is left for compatibility reasons. @option{-funit-at-a-time}
7871 has no effect, while @option{-fno-unit-at-a-time} implies
7872 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7874 Enabled by default.
7876 @item -fno-toplevel-reorder
7877 @opindex fno-toplevel-reorder
7878 Do not reorder top-level functions, variables, and @code{asm}
7879 statements.  Output them in the same order that they appear in the
7880 input file.  When this option is used, unreferenced static variables
7881 are not removed.  This option is intended to support existing code
7882 that relies on a particular ordering.  For new code, it is better to
7883 use attributes.
7885 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
7886 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
7887 targets.
7889 @item -fweb
7890 @opindex fweb
7891 Constructs webs as commonly used for register allocation purposes and assign
7892 each web individual pseudo register.  This allows the register allocation pass
7893 to operate on pseudos directly, but also strengthens several other optimization
7894 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7895 however, make debugging impossible, since variables no longer stay in a
7896 ``home register''.
7898 Enabled by default with @option{-funroll-loops}.
7900 @item -fwhole-program
7901 @opindex fwhole-program
7902 Assume that the current compilation unit represents the whole program being
7903 compiled.  All public functions and variables with the exception of @code{main}
7904 and those merged by attribute @code{externally_visible} become static functions
7905 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.
7906 While this option is equivalent to proper use of the @code{static} keyword for
7907 programs consisting of a single file, in combination with option
7908 @option{-flto} this flag can be used to
7909 compile many smaller scale programs since the functions and variables become
7910 local for the whole combined compilation unit, not for the single source file
7911 itself.
7913 This option implies @option{-fwhole-file} for Fortran programs.
7915 @item -flto[=@var{n}]
7916 @opindex flto
7917 This option runs the standard link-time optimizer.  When invoked
7918 with source code, it generates GIMPLE (one of GCC's internal
7919 representations) and writes it to special ELF sections in the object
7920 file.  When the object files are linked together, all the function
7921 bodies are read from these ELF sections and instantiated as if they
7922 had been part of the same translation unit.
7924 To use the link-time optimizer, @option{-flto} needs to be specified at
7925 compile time and during the final link.  For example:
7927 @smallexample
7928 gcc -c -O2 -flto foo.c
7929 gcc -c -O2 -flto bar.c
7930 gcc -o myprog -flto -O2 foo.o bar.o
7931 @end smallexample
7933 The first two invocations to GCC save a bytecode representation
7934 of GIMPLE into special ELF sections inside @file{foo.o} and
7935 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
7936 @file{foo.o} and @file{bar.o}, merges the two files into a single
7937 internal image, and compiles the result as usual.  Since both
7938 @file{foo.o} and @file{bar.o} are merged into a single image, this
7939 causes all the interprocedural analyses and optimizations in GCC to
7940 work across the two files as if they were a single one.  This means,
7941 for example, that the inliner is able to inline functions in
7942 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7944 Another (simpler) way to enable link-time optimization is:
7946 @smallexample
7947 gcc -o myprog -flto -O2 foo.c bar.c
7948 @end smallexample
7950 The above generates bytecode for @file{foo.c} and @file{bar.c},
7951 merges them together into a single GIMPLE representation and optimizes
7952 them as usual to produce @file{myprog}.
7954 The only important thing to keep in mind is that to enable link-time
7955 optimizations the @option{-flto} flag needs to be passed to both the
7956 compile and the link commands.
7958 To make whole program optimization effective, it is necessary to make
7959 certain whole program assumptions.  The compiler needs to know
7960 what functions and variables can be accessed by libraries and runtime
7961 outside of the link-time optimized unit.  When supported by the linker,
7962 the linker plugin (see @option{-fuse-linker-plugin}) passes information
7963 to the compiler about used and externally visible symbols.  When
7964 the linker plugin is not available, @option{-fwhole-program} should be
7965 used to allow the compiler to make these assumptions, which leads
7966 to more aggressive optimization decisions.
7968 Note that when a file is compiled with @option{-flto}, the generated
7969 object file is larger than a regular object file because it 
7970 contains GIMPLE bytecodes and the usual final code.  This means that
7971 object files with LTO information can be linked as normal object
7972 files; if @option{-flto} is not passed to the linker, no
7973 interprocedural optimizations are applied.
7975 Additionally, the optimization flags used to compile individual files
7976 are not necessarily related to those used at link time.  For instance,
7978 @smallexample
7979 gcc -c -O0 -flto foo.c
7980 gcc -c -O0 -flto bar.c
7981 gcc -o myprog -flto -O3 foo.o bar.o
7982 @end smallexample
7984 This produces individual object files with unoptimized assembler
7985 code, but the resulting binary @file{myprog} is optimized at
7986 @option{-O3}.  If, instead, the final binary is generated without
7987 @option{-flto}, then @file{myprog} is not optimized.
7989 When producing the final binary with @option{-flto}, GCC only
7990 applies link-time optimizations to those files that contain bytecode.
7991 Therefore, you can mix and match object files and libraries with
7992 GIMPLE bytecodes and final object code.  GCC automatically selects
7993 which files to optimize in LTO mode and which files to link without
7994 further processing.
7996 There are some code generation flags preserved by GCC when
7997 generating bytecodes, as they need to be used during the final link
7998 stage.  Currently, the following options are saved into the GIMPLE
7999 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
8000 @option{-m} target flags.
8002 At link time, these options are read in and reapplied.  Note that the
8003 current implementation makes no attempt to recognize conflicting
8004 values for these options.  If different files have conflicting option
8005 values (e.g., one file is compiled with @option{-fPIC} and another
8006 isn't), the compiler simply uses the last value read from the
8007 bytecode files.  It is recommended, then, that you compile all the files
8008 participating in the same link with the same options.
8010 If LTO encounters objects with C linkage declared with incompatible
8011 types in separate translation units to be linked together (undefined
8012 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8013 issued.  The behavior is still undefined at run time.
8015 Another feature of LTO is that it is possible to apply interprocedural
8016 optimizations on files written in different languages.  This requires
8017 support in the language front end.  Currently, the C, C++ and
8018 Fortran front ends are capable of emitting GIMPLE bytecodes, so
8019 something like this should work:
8021 @smallexample
8022 gcc -c -flto foo.c
8023 g++ -c -flto bar.cc
8024 gfortran -c -flto baz.f90
8025 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8026 @end smallexample
8028 Notice that the final link is done with @command{g++} to get the C++
8029 runtime libraries and @option{-lgfortran} is added to get the Fortran
8030 runtime libraries.  In general, when mixing languages in LTO mode, you
8031 should use the same link command options as when mixing languages in a
8032 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8033 all the compile and link commands.
8035 If object files containing GIMPLE bytecode are stored in a library archive, say
8036 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8037 are using a linker with plugin support.  To enable this feature, use
8038 the flag @option{-fuse-linker-plugin} at link time:
8040 @smallexample
8041 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8042 @end smallexample
8044 With the linker plugin enabled, the linker extracts the needed
8045 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8046 to make them part of the aggregated GIMPLE image to be optimized.
8048 If you are not using a linker with plugin support and/or do not
8049 enable the linker plugin, then the objects inside @file{libfoo.a}
8050 are extracted and linked as usual, but they do not participate
8051 in the LTO optimization process.
8053 Link-time optimizations do not require the presence of the whole program to
8054 operate.  If the program does not require any symbols to be exported, it is
8055 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8056 the interprocedural optimizers to use more aggressive assumptions which may
8057 lead to improved optimization opportunities.
8058 Use of @option{-fwhole-program} is not needed when linker plugin is
8059 active (see @option{-fuse-linker-plugin}).
8061 The current implementation of LTO makes no
8062 attempt to generate bytecode that is portable between different
8063 types of hosts.  The bytecode files are versioned and there is a
8064 strict version check, so bytecode files generated in one version of
8065 GCC will not work with an older/newer version of GCC@.
8067 Link-time optimization does not work well with generation of debugging
8068 information.  Combining @option{-flto} with
8069 @option{-g} is currently experimental and expected to produce wrong
8070 results.
8072 If you specify the optional @var{n}, the optimization and code
8073 generation done at link time is executed in parallel using @var{n}
8074 parallel jobs by utilizing an installed @command{make} program.  The
8075 environment variable @env{MAKE} may be used to override the program
8076 used.  The default value for @var{n} is 1.
8078 You can also specify @option{-flto=jobserver} to use GNU make's
8079 job server mode to determine the number of parallel jobs. This
8080 is useful when the Makefile calling GCC is already executing in parallel.
8081 You must prepend a @samp{+} to the command recipe in the parent Makefile
8082 for this to work.  This option likely only works if @env{MAKE} is
8083 GNU make.
8085 This option is disabled by default
8087 @item -flto-partition=@var{alg}
8088 @opindex flto-partition
8089 Specify the partitioning algorithm used by the link-time optimizer.
8090 The value is either @code{1to1} to specify a partitioning mirroring
8091 the original source files or @code{balanced} to specify partitioning
8092 into equally sized chunks (whenever possible).  Specifying @code{none}
8093 as an algorithm disables partitioning and streaming completely. The
8094 default value is @code{balanced}.
8096 @item -flto-compression-level=@var{n}
8097 This option specifies the level of compression used for intermediate
8098 language written to LTO object files, and is only meaningful in
8099 conjunction with LTO mode (@option{-flto}).  Valid
8100 values are 0 (no compression) to 9 (maximum compression).  Values
8101 outside this range are clamped to either 0 or 9.  If the option is not
8102 given, a default balanced compression setting is used.
8104 @item -flto-report
8105 Prints a report with internal details on the workings of the link-time
8106 optimizer.  The contents of this report vary from version to version.
8107 It is meant to be useful to GCC developers when processing object
8108 files in LTO mode (via @option{-flto}).
8110 Disabled by default.
8112 @item -fuse-linker-plugin
8113 Enables the use of a linker plugin during link-time optimization.  This
8114 option relies on plugin support in the linker, which is available in gold
8115 or in GNU ld 2.21 or newer.
8117 This option enables the extraction of object files with GIMPLE bytecode out
8118 of library archives. This improves the quality of optimization by exposing
8119 more code to the link-time optimizer.  This information specifies what
8120 symbols can be accessed externally (by non-LTO object or during dynamic
8121 linking).  Resulting code quality improvements on binaries (and shared
8122 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8123 See @option{-flto} for a description of the effect of this flag and how to
8124 use it.
8126 This option is enabled by default when LTO support in GCC is enabled
8127 and GCC was configured for use with
8128 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8130 @item -ffat-lto-objects
8131 @opindex ffat-lto-objects
8132 Fat LTO objects are object files that contain both the intermediate language
8133 and the object code. This makes them usable for both LTO linking and normal
8134 linking. This option is effective only when compiling with @option{-flto}
8135 and is ignored at link time.
8137 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8138 requires the complete toolchain to be aware of LTO. It requires a linker with
8139 linker plugin support for basic functionality.  Additionally,
8140 @command{nm}, @command{ar} and @command{ranlib}
8141 need to support linker plugins to allow a full-featured build environment
8142 (capable of building static libraries etc).
8144 The default is @option{-ffat-lto-objects} but this default is intended to
8145 change in future releases when linker plugin enabled environments become more
8146 common.
8148 @item -fcompare-elim
8149 @opindex fcompare-elim
8150 After register allocation and post-register allocation instruction splitting,
8151 identify arithmetic instructions that compute processor flags similar to a
8152 comparison operation based on that arithmetic.  If possible, eliminate the
8153 explicit comparison operation.
8155 This pass only applies to certain targets that cannot explicitly represent
8156 the comparison operation before register allocation is complete.
8158 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8160 @item -fcprop-registers
8161 @opindex fcprop-registers
8162 After register allocation and post-register allocation instruction splitting,
8163 we perform a copy-propagation pass to try to reduce scheduling dependencies
8164 and occasionally eliminate the copy.
8166 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8168 @item -fprofile-correction
8169 @opindex fprofile-correction
8170 Profiles collected using an instrumented binary for multi-threaded programs may
8171 be inconsistent due to missed counter updates. When this option is specified,
8172 GCC uses heuristics to correct or smooth out such inconsistencies. By
8173 default, GCC emits an error message when an inconsistent profile is detected.
8175 @item -fprofile-dir=@var{path}
8176 @opindex fprofile-dir
8178 Set the directory to search for the profile data files in to @var{path}.
8179 This option affects only the profile data generated by
8180 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8181 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8182 and its related options.  Both absolute and relative paths can be used.
8183 By default, GCC uses the current directory as @var{path}, thus the
8184 profile data file appears in the same directory as the object file.
8186 @item -fprofile-generate
8187 @itemx -fprofile-generate=@var{path}
8188 @opindex fprofile-generate
8190 Enable options usually used for instrumenting application to produce
8191 profile useful for later recompilation with profile feedback based
8192 optimization.  You must use @option{-fprofile-generate} both when
8193 compiling and when linking your program.
8195 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8197 If @var{path} is specified, GCC looks at the @var{path} to find
8198 the profile feedback data files. See @option{-fprofile-dir}.
8200 @item -fprofile-use
8201 @itemx -fprofile-use=@var{path}
8202 @opindex fprofile-use
8203 Enable profile feedback directed optimizations, and optimizations
8204 generally profitable only with profile feedback available.
8206 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8207 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
8209 By default, GCC emits an error message if the feedback profiles do not
8210 match the source code.  This error can be turned into a warning by using
8211 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8212 code.
8214 If @var{path} is specified, GCC looks at the @var{path} to find
8215 the profile feedback data files. See @option{-fprofile-dir}.
8216 @end table
8218 The following options control compiler behavior regarding floating-point 
8219 arithmetic.  These options trade off between speed and
8220 correctness.  All must be specifically enabled.
8222 @table @gcctabopt
8223 @item -ffloat-store
8224 @opindex ffloat-store
8225 Do not store floating-point variables in registers, and inhibit other
8226 options that might change whether a floating-point value is taken from a
8227 register or memory.
8229 @cindex floating-point precision
8230 This option prevents undesirable excess precision on machines such as
8231 the 68000 where the floating registers (of the 68881) keep more
8232 precision than a @code{double} is supposed to have.  Similarly for the
8233 x86 architecture.  For most programs, the excess precision does only
8234 good, but a few programs rely on the precise definition of IEEE floating
8235 point.  Use @option{-ffloat-store} for such programs, after modifying
8236 them to store all pertinent intermediate computations into variables.
8238 @item -fexcess-precision=@var{style}
8239 @opindex fexcess-precision
8240 This option allows further control over excess precision on machines
8241 where floating-point registers have more precision than the IEEE
8242 @code{float} and @code{double} types and the processor does not
8243 support operations rounding to those types.  By default,
8244 @option{-fexcess-precision=fast} is in effect; this means that
8245 operations are carried out in the precision of the registers and that
8246 it is unpredictable when rounding to the types specified in the source
8247 code takes place.  When compiling C, if
8248 @option{-fexcess-precision=standard} is specified then excess
8249 precision follows the rules specified in ISO C99; in particular,
8250 both casts and assignments cause values to be rounded to their
8251 semantic types (whereas @option{-ffloat-store} only affects
8252 assignments).  This option is enabled by default for C if a strict
8253 conformance option such as @option{-std=c99} is used.
8255 @opindex mfpmath
8256 @option{-fexcess-precision=standard} is not implemented for languages
8257 other than C, and has no effect if
8258 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8259 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8260 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8261 semantics apply without excess precision, and in the latter, rounding
8262 is unpredictable.
8264 @item -ffast-math
8265 @opindex ffast-math
8266 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8267 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8268 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8270 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8272 This option is not turned on by any @option{-O} option besides
8273 @option{-Ofast} since it can result in incorrect output for programs
8274 that depend on an exact implementation of IEEE or ISO rules/specifications
8275 for math functions. It may, however, yield faster code for programs
8276 that do not require the guarantees of these specifications.
8278 @item -fno-math-errno
8279 @opindex fno-math-errno
8280 Do not set @code{errno} after calling math functions that are executed
8281 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8282 IEEE exceptions for math error handling may want to use this flag
8283 for speed while maintaining IEEE arithmetic compatibility.
8285 This option is not turned on by any @option{-O} option since
8286 it can result in incorrect output for programs that depend on
8287 an exact implementation of IEEE or ISO rules/specifications for
8288 math functions. It may, however, yield faster code for programs
8289 that do not require the guarantees of these specifications.
8291 The default is @option{-fmath-errno}.
8293 On Darwin systems, the math library never sets @code{errno}.  There is
8294 therefore no reason for the compiler to consider the possibility that
8295 it might, and @option{-fno-math-errno} is the default.
8297 @item -funsafe-math-optimizations
8298 @opindex funsafe-math-optimizations
8300 Allow optimizations for floating-point arithmetic that (a) assume
8301 that arguments and results are valid and (b) may violate IEEE or
8302 ANSI standards.  When used at link-time, it may include libraries
8303 or startup files that change the default FPU control word or other
8304 similar optimizations.
8306 This option is not turned on by any @option{-O} option since
8307 it can result in incorrect output for programs that depend on
8308 an exact implementation of IEEE or ISO rules/specifications for
8309 math functions. It may, however, yield faster code for programs
8310 that do not require the guarantees of these specifications.
8311 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8312 @option{-fassociative-math} and @option{-freciprocal-math}.
8314 The default is @option{-fno-unsafe-math-optimizations}.
8316 @item -fassociative-math
8317 @opindex fassociative-math
8319 Allow re-association of operands in series of floating-point operations.
8320 This violates the ISO C and C++ language standard by possibly changing
8321 computation result.  NOTE: re-ordering may change the sign of zero as
8322 well as ignore NaNs and inhibit or create underflow or overflow (and
8323 thus cannot be used on code that relies on rounding behavior like
8324 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8325 and thus may not be used when ordered comparisons are required.
8326 This option requires that both @option{-fno-signed-zeros} and
8327 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8328 much sense with @option{-frounding-math}. For Fortran the option
8329 is automatically enabled when both @option{-fno-signed-zeros} and
8330 @option{-fno-trapping-math} are in effect.
8332 The default is @option{-fno-associative-math}.
8334 @item -freciprocal-math
8335 @opindex freciprocal-math
8337 Allow the reciprocal of a value to be used instead of dividing by
8338 the value if this enables optimizations.  For example @code{x / y}
8339 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8340 is subject to common subexpression elimination.  Note that this loses
8341 precision and increases the number of flops operating on the value.
8343 The default is @option{-fno-reciprocal-math}.
8345 @item -ffinite-math-only
8346 @opindex ffinite-math-only
8347 Allow optimizations for floating-point arithmetic that assume
8348 that arguments and results are not NaNs or +-Infs.
8350 This option is not turned on by any @option{-O} option since
8351 it can result in incorrect output for programs that depend on
8352 an exact implementation of IEEE or ISO rules/specifications for
8353 math functions. It may, however, yield faster code for programs
8354 that do not require the guarantees of these specifications.
8356 The default is @option{-fno-finite-math-only}.
8358 @item -fno-signed-zeros
8359 @opindex fno-signed-zeros
8360 Allow optimizations for floating-point arithmetic that ignore the
8361 signedness of zero.  IEEE arithmetic specifies the behavior of
8362 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8363 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8364 This option implies that the sign of a zero result isn't significant.
8366 The default is @option{-fsigned-zeros}.
8368 @item -fno-trapping-math
8369 @opindex fno-trapping-math
8370 Compile code assuming that floating-point operations cannot generate
8371 user-visible traps.  These traps include division by zero, overflow,
8372 underflow, inexact result and invalid operation.  This option requires
8373 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8374 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8376 This option should never be turned on by any @option{-O} option since
8377 it can result in incorrect output for programs that depend on
8378 an exact implementation of IEEE or ISO rules/specifications for
8379 math functions.
8381 The default is @option{-ftrapping-math}.
8383 @item -frounding-math
8384 @opindex frounding-math
8385 Disable transformations and optimizations that assume default floating-point
8386 rounding behavior.  This is round-to-zero for all floating point
8387 to integer conversions, and round-to-nearest for all other arithmetic
8388 truncations.  This option should be specified for programs that change
8389 the FP rounding mode dynamically, or that may be executed with a
8390 non-default rounding mode.  This option disables constant folding of
8391 floating-point expressions at compile time (which may be affected by
8392 rounding mode) and arithmetic transformations that are unsafe in the
8393 presence of sign-dependent rounding modes.
8395 The default is @option{-fno-rounding-math}.
8397 This option is experimental and does not currently guarantee to
8398 disable all GCC optimizations that are affected by rounding mode.
8399 Future versions of GCC may provide finer control of this setting
8400 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8401 will be used to specify the default state for @code{FENV_ACCESS}.
8403 @item -fsignaling-nans
8404 @opindex fsignaling-nans
8405 Compile code assuming that IEEE signaling NaNs may generate user-visible
8406 traps during floating-point operations.  Setting this option disables
8407 optimizations that may change the number of exceptions visible with
8408 signaling NaNs.  This option implies @option{-ftrapping-math}.
8410 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8411 be defined.
8413 The default is @option{-fno-signaling-nans}.
8415 This option is experimental and does not currently guarantee to
8416 disable all GCC optimizations that affect signaling NaN behavior.
8418 @item -fsingle-precision-constant
8419 @opindex fsingle-precision-constant
8420 Treat floating-point constants as single precision instead of
8421 implicitly converting them to double-precision constants.
8423 @item -fcx-limited-range
8424 @opindex fcx-limited-range
8425 When enabled, this option states that a range reduction step is not
8426 needed when performing complex division.  Also, there is no checking
8427 whether the result of a complex multiplication or division is @code{NaN
8428 + I*NaN}, with an attempt to rescue the situation in that case.  The
8429 default is @option{-fno-cx-limited-range}, but is enabled by
8430 @option{-ffast-math}.
8432 This option controls the default setting of the ISO C99
8433 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8434 all languages.
8436 @item -fcx-fortran-rules
8437 @opindex fcx-fortran-rules
8438 Complex multiplication and division follow Fortran rules.  Range
8439 reduction is done as part of complex division, but there is no checking
8440 whether the result of a complex multiplication or division is @code{NaN
8441 + I*NaN}, with an attempt to rescue the situation in that case.
8443 The default is @option{-fno-cx-fortran-rules}.
8445 @end table
8447 The following options control optimizations that may improve
8448 performance, but are not enabled by any @option{-O} options.  This
8449 section includes experimental options that may produce broken code.
8451 @table @gcctabopt
8452 @item -fbranch-probabilities
8453 @opindex fbranch-probabilities
8454 After running a program compiled with @option{-fprofile-arcs}
8455 (@pxref{Debugging Options,, Options for Debugging Your Program or
8456 @command{gcc}}), you can compile it a second time using
8457 @option{-fbranch-probabilities}, to improve optimizations based on
8458 the number of times each branch was taken.  When the program
8459 compiled with @option{-fprofile-arcs} exits it saves arc execution
8460 counts to a file called @file{@var{sourcename}.gcda} for each source
8461 file.  The information in this data file is very dependent on the
8462 structure of the generated code, so you must use the same source code
8463 and the same optimization options for both compilations.
8465 With @option{-fbranch-probabilities}, GCC puts a
8466 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8467 These can be used to improve optimization.  Currently, they are only
8468 used in one place: in @file{reorg.c}, instead of guessing which path a
8469 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8470 exactly determine which path is taken more often.
8472 @item -fprofile-values
8473 @opindex fprofile-values
8474 If combined with @option{-fprofile-arcs}, it adds code so that some
8475 data about values of expressions in the program is gathered.
8477 With @option{-fbranch-probabilities}, it reads back the data gathered
8478 from profiling values of expressions for usage in optimizations.
8480 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8482 @item -fvpt
8483 @opindex fvpt
8484 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
8485 a code to gather information about values of expressions.
8487 With @option{-fbranch-probabilities}, it reads back the data gathered
8488 and actually performs the optimizations based on them.
8489 Currently the optimizations include specialization of division operation
8490 using the knowledge about the value of the denominator.
8492 @item -frename-registers
8493 @opindex frename-registers
8494 Attempt to avoid false dependencies in scheduled code by making use
8495 of registers left over after register allocation.  This optimization
8496 most benefits processors with lots of registers.  Depending on the
8497 debug information format adopted by the target, however, it can
8498 make debugging impossible, since variables no longer stay in
8499 a ``home register''.
8501 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8503 @item -ftracer
8504 @opindex ftracer
8505 Perform tail duplication to enlarge superblock size.  This transformation
8506 simplifies the control flow of the function allowing other optimizations to do
8507 better job.
8509 Enabled with @option{-fprofile-use}.
8511 @item -funroll-loops
8512 @opindex funroll-loops
8513 Unroll loops whose number of iterations can be determined at compile time or
8514 upon entry to the loop.  @option{-funroll-loops} implies
8515 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8516 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8517 small constant number of iterations).  This option makes code larger, and may
8518 or may not make it run faster.
8520 Enabled with @option{-fprofile-use}.
8522 @item -funroll-all-loops
8523 @opindex funroll-all-loops
8524 Unroll all loops, even if their number of iterations is uncertain when
8525 the loop is entered.  This usually makes programs run more slowly.
8526 @option{-funroll-all-loops} implies the same options as
8527 @option{-funroll-loops}.
8529 @item -fpeel-loops
8530 @opindex fpeel-loops
8531 Peels loops for which there is enough information that they do not
8532 roll much (from profile feedback).  It also turns on complete loop peeling
8533 (i.e.@: complete removal of loops with small constant number of iterations).
8535 Enabled with @option{-fprofile-use}.
8537 @item -fmove-loop-invariants
8538 @opindex fmove-loop-invariants
8539 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8540 at level @option{-O1}
8542 @item -funswitch-loops
8543 @opindex funswitch-loops
8544 Move branches with loop invariant conditions out of the loop, with duplicates
8545 of the loop on both branches (modified according to result of the condition).
8547 @item -ffunction-sections
8548 @itemx -fdata-sections
8549 @opindex ffunction-sections
8550 @opindex fdata-sections
8551 Place each function or data item into its own section in the output
8552 file if the target supports arbitrary sections.  The name of the
8553 function or the name of the data item determines the section's name
8554 in the output file.
8556 Use these options on systems where the linker can perform optimizations
8557 to improve locality of reference in the instruction space.  Most systems
8558 using the ELF object format and SPARC processors running Solaris 2 have
8559 linkers with such optimizations.  AIX may have these optimizations in
8560 the future.
8562 Only use these options when there are significant benefits from doing
8563 so.  When you specify these options, the assembler and linker
8564 create larger object and executable files and are also slower.
8565 You cannot use @code{gprof} on all systems if you
8566 specify this option, and you may have problems with debugging if
8567 you specify both this option and @option{-g}.
8569 @item -fbranch-target-load-optimize
8570 @opindex fbranch-target-load-optimize
8571 Perform branch target register load optimization before prologue / epilogue
8572 threading.
8573 The use of target registers can typically be exposed only during reload,
8574 thus hoisting loads out of loops and doing inter-block scheduling needs
8575 a separate optimization pass.
8577 @item -fbranch-target-load-optimize2
8578 @opindex fbranch-target-load-optimize2
8579 Perform branch target register load optimization after prologue / epilogue
8580 threading.
8582 @item -fbtr-bb-exclusive
8583 @opindex fbtr-bb-exclusive
8584 When performing branch target register load optimization, don't reuse
8585 branch target registers in within any basic block.
8587 @item -fstack-protector
8588 @opindex fstack-protector
8589 Emit extra code to check for buffer overflows, such as stack smashing
8590 attacks.  This is done by adding a guard variable to functions with
8591 vulnerable objects.  This includes functions that call @code{alloca}, and
8592 functions with buffers larger than 8 bytes.  The guards are initialized
8593 when a function is entered and then checked when the function exits.
8594 If a guard check fails, an error message is printed and the program exits.
8596 @item -fstack-protector-all
8597 @opindex fstack-protector-all
8598 Like @option{-fstack-protector} except that all functions are protected.
8600 @item -fsection-anchors
8601 @opindex fsection-anchors
8602 Try to reduce the number of symbolic address calculations by using
8603 shared ``anchor'' symbols to address nearby objects.  This transformation
8604 can help to reduce the number of GOT entries and GOT accesses on some
8605 targets.
8607 For example, the implementation of the following function @code{foo}:
8609 @smallexample
8610 static int a, b, c;
8611 int foo (void) @{ return a + b + c; @}
8612 @end smallexample
8614 @noindent
8615 usually calculates the addresses of all three variables, but if you
8616 compile it with @option{-fsection-anchors}, it accesses the variables
8617 from a common anchor point instead.  The effect is similar to the
8618 following pseudocode (which isn't valid C):
8620 @smallexample
8621 int foo (void)
8623   register int *xr = &x;
8624   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8626 @end smallexample
8628 Not all targets support this option.
8630 @item --param @var{name}=@var{value}
8631 @opindex param
8632 In some places, GCC uses various constants to control the amount of
8633 optimization that is done.  For example, GCC does not inline functions
8634 that contain more than a certain number of instructions.  You can
8635 control some of these constants on the command line using the
8636 @option{--param} option.
8638 The names of specific parameters, and the meaning of the values, are
8639 tied to the internals of the compiler, and are subject to change
8640 without notice in future releases.
8642 In each case, the @var{value} is an integer.  The allowable choices for
8643 @var{name} are given in the following table:
8645 @table @gcctabopt
8646 @item predictable-branch-outcome
8647 When branch is predicted to be taken with probability lower than this threshold
8648 (in percent), then it is considered well predictable. The default is 10.
8650 @item max-crossjump-edges
8651 The maximum number of incoming edges to consider for crossjumping.
8652 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8653 the number of edges incoming to each block.  Increasing values mean
8654 more aggressive optimization, making the compilation time increase with
8655 probably small improvement in executable size.
8657 @item min-crossjump-insns
8658 The minimum number of instructions that must be matched at the end
8659 of two blocks before crossjumping is performed on them.  This
8660 value is ignored in the case where all instructions in the block being
8661 crossjumped from are matched.  The default value is 5.
8663 @item max-grow-copy-bb-insns
8664 The maximum code size expansion factor when copying basic blocks
8665 instead of jumping.  The expansion is relative to a jump instruction.
8666 The default value is 8.
8668 @item max-goto-duplication-insns
8669 The maximum number of instructions to duplicate to a block that jumps
8670 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8671 passes, GCC factors computed gotos early in the compilation process,
8672 and unfactors them as late as possible.  Only computed jumps at the
8673 end of a basic blocks with no more than max-goto-duplication-insns are
8674 unfactored.  The default value is 8.
8676 @item max-delay-slot-insn-search
8677 The maximum number of instructions to consider when looking for an
8678 instruction to fill a delay slot.  If more than this arbitrary number of
8679 instructions are searched, the time savings from filling the delay slot
8680 are minimal, so stop searching.  Increasing values mean more
8681 aggressive optimization, making the compilation time increase with probably
8682 small improvement in execution time.
8684 @item max-delay-slot-live-search
8685 When trying to fill delay slots, the maximum number of instructions to
8686 consider when searching for a block with valid live register
8687 information.  Increasing this arbitrarily chosen value means more
8688 aggressive optimization, increasing the compilation time.  This parameter
8689 should be removed when the delay slot code is rewritten to maintain the
8690 control-flow graph.
8692 @item max-gcse-memory
8693 The approximate maximum amount of memory that can be allocated in
8694 order to perform the global common subexpression elimination
8695 optimization.  If more memory than specified is required, the
8696 optimization is not done.
8698 @item max-gcse-insertion-ratio
8699 If the ratio of expression insertions to deletions is larger than this value
8700 for any expression, then RTL PRE inserts or removes the expression and thus
8701 leaves partially redundant computations in the instruction stream.  The default value is 20.
8703 @item max-pending-list-length
8704 The maximum number of pending dependencies scheduling allows
8705 before flushing the current state and starting over.  Large functions
8706 with few branches or calls can create excessively large lists which
8707 needlessly consume memory and resources.
8709 @item max-modulo-backtrack-attempts
8710 The maximum number of backtrack attempts the scheduler should make
8711 when modulo scheduling a loop.  Larger values can exponentially increase
8712 compilation time.
8714 @item max-inline-insns-single
8715 Several parameters control the tree inliner used in GCC@.
8716 This number sets the maximum number of instructions (counted in GCC's
8717 internal representation) in a single function that the tree inliner
8718 considers for inlining.  This only affects functions declared
8719 inline and methods implemented in a class declaration (C++).
8720 The default value is 400.
8722 @item max-inline-insns-auto
8723 When you use @option{-finline-functions} (included in @option{-O3}),
8724 a lot of functions that would otherwise not be considered for inlining
8725 by the compiler are investigated.  To those functions, a different
8726 (more restrictive) limit compared to functions declared inline can
8727 be applied.
8728 The default value is 40.
8730 @item large-function-insns
8731 The limit specifying really large functions.  For functions larger than this
8732 limit after inlining, inlining is constrained by
8733 @option{--param large-function-growth}.  This parameter is useful primarily
8734 to avoid extreme compilation time caused by non-linear algorithms used by the
8735 back end.
8736 The default value is 2700.
8738 @item large-function-growth
8739 Specifies maximal growth of large function caused by inlining in percents.
8740 The default value is 100 which limits large function growth to 2.0 times
8741 the original size.
8743 @item large-unit-insns
8744 The limit specifying large translation unit.  Growth caused by inlining of
8745 units larger than this limit is limited by @option{--param inline-unit-growth}.
8746 For small units this might be too tight (consider unit consisting of function A
8747 that is inline and B that just calls A three time.  If B is small relative to
8748 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8749 large units consisting of small inlineable functions however the overall unit
8750 growth limit is needed to avoid exponential explosion of code size.  Thus for
8751 smaller units, the size is increased to @option{--param large-unit-insns}
8752 before applying @option{--param inline-unit-growth}.  The default is 10000
8754 @item inline-unit-growth
8755 Specifies maximal overall growth of the compilation unit caused by inlining.
8756 The default value is 30 which limits unit growth to 1.3 times the original
8757 size.
8759 @item ipcp-unit-growth
8760 Specifies maximal overall growth of the compilation unit caused by
8761 interprocedural constant propagation.  The default value is 10 which limits
8762 unit growth to 1.1 times the original size.
8764 @item large-stack-frame
8765 The limit specifying large stack frames.  While inlining the algorithm is trying
8766 to not grow past this limit too much.  Default value is 256 bytes.
8768 @item large-stack-frame-growth
8769 Specifies maximal growth of large stack frames caused by inlining in percents.
8770 The default value is 1000 which limits large stack frame growth to 11 times
8771 the original size.
8773 @item max-inline-insns-recursive
8774 @itemx max-inline-insns-recursive-auto
8775 Specifies maximum number of instructions out-of-line copy of self recursive inline
8776 function can grow into by performing recursive inlining.
8778 For functions declared inline @option{--param max-inline-insns-recursive} is
8779 taken into account.  For function not declared inline, recursive inlining
8780 happens only when @option{-finline-functions} (included in @option{-O3}) is
8781 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8782 default value is 450.
8784 @item max-inline-recursive-depth
8785 @itemx max-inline-recursive-depth-auto
8786 Specifies maximum recursion depth used by the recursive inlining.
8788 For functions declared inline @option{--param max-inline-recursive-depth} is
8789 taken into account.  For function not declared inline, recursive inlining
8790 happens only when @option{-finline-functions} (included in @option{-O3}) is
8791 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8792 default value is 8.
8794 @item min-inline-recursive-probability
8795 Recursive inlining is profitable only for function having deep recursion
8796 in average and can hurt for function having little recursion depth by
8797 increasing the prologue size or complexity of function body to other
8798 optimizers.
8800 When profile feedback is available (see @option{-fprofile-generate}) the actual
8801 recursion depth can be guessed from probability that function will recurse via
8802 given call expression.  This parameter limits inlining only to call expression
8803 whose probability exceeds given threshold (in percents).  The default value is
8806 @item early-inlining-insns
8807 Specify growth that early inliner can make.  In effect it increases amount of
8808 inlining for code having large abstraction penalty.  The default value is 10.
8810 @item max-early-inliner-iterations
8811 @itemx max-early-inliner-iterations
8812 Limit of iterations of early inliner.  This basically bounds number of nested
8813 indirect calls early inliner can resolve.  Deeper chains are still handled by
8814 late inlining.
8816 @item comdat-sharing-probability
8817 @itemx comdat-sharing-probability
8818 Probability (in percent) that C++ inline function with comdat visibility
8819 are shared across multiple compilation units.  The default value is 20.
8821 @item min-vect-loop-bound
8822 The minimum number of iterations under which a loop is not vectorized
8823 when @option{-ftree-vectorize} is used.  The number of iterations after
8824 vectorization needs to be greater than the value specified by this option
8825 to allow vectorization.  The default value is 0.
8827 @item gcse-cost-distance-ratio
8828 Scaling factor in calculation of maximum distance an expression
8829 can be moved by GCSE optimizations.  This is currently supported only in the
8830 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
8831 is with simple expressions, i.e., the expressions that have cost
8832 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
8833 hoisting of simple expressions.  The default value is 10.
8835 @item gcse-unrestricted-cost
8836 Cost, roughly measured as the cost of a single typical machine
8837 instruction, at which GCSE optimizations do not constrain
8838 the distance an expression can travel.  This is currently
8839 supported only in the code hoisting pass.  The lesser the cost,
8840 the more aggressive code hoisting is.  Specifying 0 
8841 allows all expressions to travel unrestricted distances.
8842 The default value is 3.
8844 @item max-hoist-depth
8845 The depth of search in the dominator tree for expressions to hoist.
8846 This is used to avoid quadratic behavior in hoisting algorithm.
8847 The value of 0 does not limit on the search, but may slow down compilation
8848 of huge functions.  The default value is 30.
8850 @item max-tail-merge-comparisons
8851 The maximum amount of similar bbs to compare a bb with.  This is used to
8852 avoid quadratic behavior in tree tail merging.  The default value is 10.
8854 @item max-tail-merge-iterations
8855 The maximum amount of iterations of the pass over the function.  This is used to
8856 limit compilation time in tree tail merging.  The default value is 2.
8858 @item max-unrolled-insns
8859 The maximum number of instructions that a loop should have if that loop
8860 is unrolled, and if the loop is unrolled, it determines how many times
8861 the loop code is unrolled.
8863 @item max-average-unrolled-insns
8864 The maximum number of instructions biased by probabilities of their execution
8865 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8866 it determines how many times the loop code is unrolled.
8868 @item max-unroll-times
8869 The maximum number of unrollings of a single loop.
8871 @item max-peeled-insns
8872 The maximum number of instructions that a loop should have if that loop
8873 is peeled, and if the loop is peeled, it determines how many times
8874 the loop code is peeled.
8876 @item max-peel-times
8877 The maximum number of peelings of a single loop.
8879 @item max-completely-peeled-insns
8880 The maximum number of insns of a completely peeled loop.
8882 @item max-completely-peel-times
8883 The maximum number of iterations of a loop to be suitable for complete peeling.
8885 @item max-completely-peel-loop-nest-depth
8886 The maximum depth of a loop nest suitable for complete peeling.
8888 @item max-unswitch-insns
8889 The maximum number of insns of an unswitched loop.
8891 @item max-unswitch-level
8892 The maximum number of branches unswitched in a single loop.
8894 @item lim-expensive
8895 The minimum cost of an expensive expression in the loop invariant motion.
8897 @item iv-consider-all-candidates-bound
8898 Bound on number of candidates for induction variables below that
8899 all candidates are considered for each use in induction variable
8900 optimizations.  Only the most relevant candidates are considered
8901 if there are more candidates, to avoid quadratic time complexity.
8903 @item iv-max-considered-uses
8904 The induction variable optimizations give up on loops that contain more
8905 induction variable uses.
8907 @item iv-always-prune-cand-set-bound
8908 If number of candidates in the set is smaller than this value,
8909 we always try to remove unnecessary ivs from the set during its
8910 optimization when a new iv is added to the set.
8912 @item scev-max-expr-size
8913 Bound on size of expressions used in the scalar evolutions analyzer.
8914 Large expressions slow the analyzer.
8916 @item scev-max-expr-complexity
8917 Bound on the complexity of the expressions in the scalar evolutions analyzer.
8918 Complex expressions slow the analyzer.
8920 @item omega-max-vars
8921 The maximum number of variables in an Omega constraint system.
8922 The default value is 128.
8924 @item omega-max-geqs
8925 The maximum number of inequalities in an Omega constraint system.
8926 The default value is 256.
8928 @item omega-max-eqs
8929 The maximum number of equalities in an Omega constraint system.
8930 The default value is 128.
8932 @item omega-max-wild-cards
8933 The maximum number of wildcard variables that the Omega solver is
8934 able to insert.  The default value is 18.
8936 @item omega-hash-table-size
8937 The size of the hash table in the Omega solver.  The default value is
8938 550.
8940 @item omega-max-keys
8941 The maximal number of keys used by the Omega solver.  The default
8942 value is 500.
8944 @item omega-eliminate-redundant-constraints
8945 When set to 1, use expensive methods to eliminate all redundant
8946 constraints.  The default value is 0.
8948 @item vect-max-version-for-alignment-checks
8949 The maximum number of run-time checks that can be performed when
8950 doing loop versioning for alignment in the vectorizer.  See option
8951 @option{-ftree-vect-loop-version} for more information.
8953 @item vect-max-version-for-alias-checks
8954 The maximum number of run-time checks that can be performed when
8955 doing loop versioning for alias in the vectorizer.  See option
8956 @option{-ftree-vect-loop-version} for more information.
8958 @item max-iterations-to-track
8960 The maximum number of iterations of a loop the brute force algorithm
8961 for analysis of # of iterations of the loop tries to evaluate.
8963 @item hot-bb-count-fraction
8964 Select fraction of the maximal count of repetitions of basic block in program
8965 given basic block needs to have to be considered hot.
8967 @item hot-bb-frequency-fraction
8968 Select fraction of the entry block frequency of executions of basic block in
8969 function given basic block needs to have to be considered hot.
8971 @item max-predicted-iterations
8972 The maximum number of loop iterations we predict statically.  This is useful
8973 in cases where a function contains a single loop with known bound and
8974 another loop with unknown bound.
8975 The known number of iterations is predicted correctly, while
8976 the unknown number of iterations average to roughly 10.  This means that the
8977 loop without bounds appears artificially cold relative to the other one.
8979 @item align-threshold
8981 Select fraction of the maximal frequency of executions of a basic block in
8982 a function to align the basic block.
8984 @item align-loop-iterations
8986 A loop expected to iterate at least the selected number of iterations is
8987 aligned.
8989 @item tracer-dynamic-coverage
8990 @itemx tracer-dynamic-coverage-feedback
8992 This value is used to limit superblock formation once the given percentage of
8993 executed instructions is covered.  This limits unnecessary code size
8994 expansion.
8996 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8997 feedback is available.  The real profiles (as opposed to statically estimated
8998 ones) are much less balanced allowing the threshold to be larger value.
9000 @item tracer-max-code-growth
9001 Stop tail duplication once code growth has reached given percentage.  This is
9002 a rather artificial limit, as most of the duplicates are eliminated later in
9003 cross jumping, so it may be set to much higher values than is the desired code
9004 growth.
9006 @item tracer-min-branch-ratio
9008 Stop reverse growth when the reverse probability of best edge is less than this
9009 threshold (in percent).
9011 @item tracer-min-branch-ratio
9012 @itemx tracer-min-branch-ratio-feedback
9014 Stop forward growth if the best edge has probability lower than this
9015 threshold.
9017 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9018 compilation for profile feedback and one for compilation without.  The value
9019 for compilation with profile feedback needs to be more conservative (higher) in
9020 order to make tracer effective.
9022 @item max-cse-path-length
9024 Maximum number of basic blocks on path that cse considers.  The default is 10.
9026 @item max-cse-insns
9027 The maximum instructions CSE process before flushing. The default is 1000.
9029 @item ggc-min-expand
9031 GCC uses a garbage collector to manage its own memory allocation.  This
9032 parameter specifies the minimum percentage by which the garbage
9033 collector's heap should be allowed to expand between collections.
9034 Tuning this may improve compilation speed; it has no effect on code
9035 generation.
9037 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9038 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9039 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9040 GCC is not able to calculate RAM on a particular platform, the lower
9041 bound of 30% is used.  Setting this parameter and
9042 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9043 every opportunity.  This is extremely slow, but can be useful for
9044 debugging.
9046 @item ggc-min-heapsize
9048 Minimum size of the garbage collector's heap before it begins bothering
9049 to collect garbage.  The first collection occurs after the heap expands
9050 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9051 tuning this may improve compilation speed, and has no effect on code
9052 generation.
9054 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9055 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9056 with a lower bound of 4096 (four megabytes) and an upper bound of
9057 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9058 particular platform, the lower bound is used.  Setting this parameter
9059 very large effectively disables garbage collection.  Setting this
9060 parameter and @option{ggc-min-expand} to zero causes a full collection
9061 to occur at every opportunity.
9063 @item max-reload-search-insns
9064 The maximum number of instruction reload should look backward for equivalent
9065 register.  Increasing values mean more aggressive optimization, making the
9066 compilation time increase with probably slightly better performance.
9067 The default value is 100.
9069 @item max-cselib-memory-locations
9070 The maximum number of memory locations cselib should take into account.
9071 Increasing values mean more aggressive optimization, making the compilation time
9072 increase with probably slightly better performance.  The default value is 500.
9074 @item reorder-blocks-duplicate
9075 @itemx reorder-blocks-duplicate-feedback
9077 Used by basic block reordering pass to decide whether to use unconditional
9078 branch or duplicate the code on its destination.  Code is duplicated when its
9079 estimated size is smaller than this value multiplied by the estimated size of
9080 unconditional jump in the hot spots of the program.
9082 The @option{reorder-block-duplicate-feedback} is used only when profile
9083 feedback is available and may be set to higher values than
9084 @option{reorder-block-duplicate} since information about the hot spots is more
9085 accurate.
9087 @item max-sched-ready-insns
9088 The maximum number of instructions ready to be issued the scheduler should
9089 consider at any given time during the first scheduling pass.  Increasing
9090 values mean more thorough searches, making the compilation time increase
9091 with probably little benefit.  The default value is 100.
9093 @item max-sched-region-blocks
9094 The maximum number of blocks in a region to be considered for
9095 interblock scheduling.  The default value is 10.
9097 @item max-pipeline-region-blocks
9098 The maximum number of blocks in a region to be considered for
9099 pipelining in the selective scheduler.  The default value is 15.
9101 @item max-sched-region-insns
9102 The maximum number of insns in a region to be considered for
9103 interblock scheduling.  The default value is 100.
9105 @item max-pipeline-region-insns
9106 The maximum number of insns in a region to be considered for
9107 pipelining in the selective scheduler.  The default value is 200.
9109 @item min-spec-prob
9110 The minimum probability (in percents) of reaching a source block
9111 for interblock speculative scheduling.  The default value is 40.
9113 @item max-sched-extend-regions-iters
9114 The maximum number of iterations through CFG to extend regions.
9115 A value of 0 (the default) disables region extensions.
9117 @item max-sched-insn-conflict-delay
9118 The maximum conflict delay for an insn to be considered for speculative motion.
9119 The default value is 3.
9121 @item sched-spec-prob-cutoff
9122 The minimal probability of speculation success (in percents), so that
9123 speculative insns are scheduled.
9124 The default value is 40.
9126 @item sched-mem-true-dep-cost
9127 Minimal distance (in CPU cycles) between store and load targeting same
9128 memory locations.  The default value is 1.
9130 @item selsched-max-lookahead
9131 The maximum size of the lookahead window of selective scheduling.  It is a
9132 depth of search for available instructions.
9133 The default value is 50.
9135 @item selsched-max-sched-times
9136 The maximum number of times that an instruction is scheduled during
9137 selective scheduling.  This is the limit on the number of iterations
9138 through which the instruction may be pipelined.  The default value is 2.
9140 @item selsched-max-insns-to-rename
9141 The maximum number of best instructions in the ready list that are considered
9142 for renaming in the selective scheduler.  The default value is 2.
9144 @item sms-min-sc
9145 The minimum value of stage count that swing modulo scheduler
9146 generates.  The default value is 2.
9148 @item max-last-value-rtl
9149 The maximum size measured as number of RTLs that can be recorded in an expression
9150 in combiner for a pseudo register as last known value of that register.  The default
9151 is 10000.
9153 @item integer-share-limit
9154 Small integer constants can use a shared data structure, reducing the
9155 compiler's memory usage and increasing its speed.  This sets the maximum
9156 value of a shared integer constant.  The default value is 256.
9158 @item min-virtual-mappings
9159 Specifies the minimum number of virtual mappings in the incremental
9160 SSA updater that should be registered to trigger the virtual mappings
9161 heuristic defined by virtual-mappings-ratio.  The default value is
9162 100.
9164 @item virtual-mappings-ratio
9165 If the number of virtual mappings is virtual-mappings-ratio bigger
9166 than the number of virtual symbols to be updated, then the incremental
9167 SSA updater switches to a full update for those symbols.  The default
9168 ratio is 3.
9170 @item ssp-buffer-size
9171 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9172 protection when @option{-fstack-protection} is used.
9174 @item max-jump-thread-duplication-stmts
9175 Maximum number of statements allowed in a block that needs to be
9176 duplicated when threading jumps.
9178 @item max-fields-for-field-sensitive
9179 Maximum number of fields in a structure treated in
9180 a field sensitive manner during pointer analysis.  The default is zero
9181 for @option{-O0} and @option{-O1},
9182 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9184 @item prefetch-latency
9185 Estimate on average number of instructions that are executed before
9186 prefetch finishes.  The distance we prefetch ahead is proportional
9187 to this constant.  Increasing this number may also lead to less
9188 streams being prefetched (see @option{simultaneous-prefetches}).
9190 @item simultaneous-prefetches
9191 Maximum number of prefetches that can run at the same time.
9193 @item l1-cache-line-size
9194 The size of cache line in L1 cache, in bytes.
9196 @item l1-cache-size
9197 The size of L1 cache, in kilobytes.
9199 @item l2-cache-size
9200 The size of L2 cache, in kilobytes.
9202 @item min-insn-to-prefetch-ratio
9203 The minimum ratio between the number of instructions and the
9204 number of prefetches to enable prefetching in a loop.
9206 @item prefetch-min-insn-to-mem-ratio
9207 The minimum ratio between the number of instructions and the
9208 number of memory references to enable prefetching in a loop.
9210 @item use-canonical-types
9211 Whether the compiler should use the ``canonical'' type system.  By
9212 default, this should always be 1, which uses a more efficient internal
9213 mechanism for comparing types in C++ and Objective-C++.  However, if
9214 bugs in the canonical type system are causing compilation failures,
9215 set this value to 0 to disable canonical types.
9217 @item switch-conversion-max-branch-ratio
9218 Switch initialization conversion refuses to create arrays that are
9219 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9220 branches in the switch.
9222 @item max-partial-antic-length
9223 Maximum length of the partial antic set computed during the tree
9224 partial redundancy elimination optimization (@option{-ftree-pre}) when
9225 optimizing at @option{-O3} and above.  For some sorts of source code
9226 the enhanced partial redundancy elimination optimization can run away,
9227 consuming all of the memory available on the host machine.  This
9228 parameter sets a limit on the length of the sets that are computed,
9229 which prevents the runaway behavior.  Setting a value of 0 for
9230 this parameter allows an unlimited set length.
9232 @item sccvn-max-scc-size
9233 Maximum size of a strongly connected component (SCC) during SCCVN
9234 processing.  If this limit is hit, SCCVN processing for the whole
9235 function is not done and optimizations depending on it are
9236 disabled.  The default maximum SCC size is 10000.
9238 @item ira-max-loops-num
9239 IRA uses regional register allocation by default.  If a function
9240 contains more loops than the number given by this parameter, only at most
9241 the given number of the most frequently-executed loops form regions
9242 for regional register allocation.  The default value of the
9243 parameter is 100.
9245 @item ira-max-conflict-table-size 
9246 Although IRA uses a sophisticated algorithm to compress the conflict
9247 table, the table can still require excessive amounts of memory for
9248 huge functions.  If the conflict table for a function could be more
9249 than the size in MB given by this parameter, the register allocator
9250 instead uses a faster, simpler, and lower-quality
9251 algorithm that does not require building a pseudo-register conflict table.  
9252 The default value of the parameter is 2000.
9254 @item ira-loop-reserved-regs
9255 IRA can be used to evaluate more accurate register pressure in loops
9256 for decisions to move loop invariants (see @option{-O3}).  The number
9257 of available registers reserved for some other purposes is given
9258 by this parameter.  The default value of the parameter is 2, which is
9259 the minimal number of registers needed by typical instructions.
9260 This value is the best found from numerous experiments.
9262 @item loop-invariant-max-bbs-in-loop
9263 Loop invariant motion can be very expensive, both in compilation time and
9264 in amount of needed compile-time memory, with very large loops.  Loops
9265 with more basic blocks than this parameter won't have loop invariant
9266 motion optimization performed on them.  The default value of the
9267 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9269 @item loop-max-datarefs-for-datadeps
9270 Building data dapendencies is expensive for very large loops.  This
9271 parameter limits the number of data references in loops that are
9272 considered for data dependence analysis.  These large loops are no
9273 handled by the optimizations using loop data dependencies.
9274 The default value is 1000.
9276 @item max-vartrack-size
9277 Sets a maximum number of hash table slots to use during variable
9278 tracking dataflow analysis of any function.  If this limit is exceeded
9279 with variable tracking at assignments enabled, analysis for that
9280 function is retried without it, after removing all debug insns from
9281 the function.  If the limit is exceeded even without debug insns, var
9282 tracking analysis is completely disabled for the function.  Setting
9283 the parameter to zero makes it unlimited.
9285 @item max-vartrack-expr-depth
9286 Sets a maximum number of recursion levels when attempting to map
9287 variable names or debug temporaries to value expressions.  This trades
9288 compilation time for more complete debug information.  If this is set too
9289 low, value expressions that are available and could be represented in
9290 debug information may end up not being used; setting this higher may
9291 enable the compiler to find more complex debug expressions, but compile
9292 time and memory use may grow.  The default is 12.
9294 @item min-nondebug-insn-uid
9295 Use uids starting at this parameter for nondebug insns.  The range below
9296 the parameter is reserved exclusively for debug insns created by
9297 @option{-fvar-tracking-assignments}, but debug insns may get
9298 (non-overlapping) uids above it if the reserved range is exhausted.
9300 @item ipa-sra-ptr-growth-factor
9301 IPA-SRA replaces a pointer to an aggregate with one or more new
9302 parameters only when their cumulative size is less or equal to
9303 @option{ipa-sra-ptr-growth-factor} times the size of the original
9304 pointer parameter.
9306 @item tm-max-aggregate-size
9307 When making copies of thread-local variables in a transaction, this
9308 parameter specifies the size in bytes after which variables are
9309 saved with the logging functions as opposed to save/restore code
9310 sequence pairs.  This option only applies when using
9311 @option{-fgnu-tm}.
9313 @item graphite-max-nb-scop-params
9314 To avoid exponential effects in the Graphite loop transforms, the
9315 number of parameters in a Static Control Part (SCoP) is bounded.  The
9316 default value is 10 parameters.  A variable whose value is unknown at
9317 compilation time and defined outside a SCoP is a parameter of the SCoP.
9319 @item graphite-max-bbs-per-function
9320 To avoid exponential effects in the detection of SCoPs, the size of
9321 the functions analyzed by Graphite is bounded.  The default value is
9322 100 basic blocks.
9324 @item loop-block-tile-size
9325 Loop blocking or strip mining transforms, enabled with
9326 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9327 loop in the loop nest by a given number of iterations.  The strip
9328 length can be changed using the @option{loop-block-tile-size}
9329 parameter.  The default value is 51 iterations.
9331 @item ipa-cp-value-list-size
9332 IPA-CP attempts to track all possible values and types passed to a function's
9333 parameter in order to propagate them and perform devirtualization.
9334 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9335 stores per one formal parameter of a function.
9337 @item lto-partitions
9338 Specify desired number of partitions produced during WHOPR compilation.
9339 The number of partitions should exceed the number of CPUs used for compilation.
9340 The default value is 32.
9342 @item lto-minpartition
9343 Size of minimal partition for WHOPR (in estimated instructions).
9344 This prevents expenses of splitting very small programs into too many
9345 partitions.
9347 @item cxx-max-namespaces-for-diagnostic-help
9348 The maximum number of namespaces to consult for suggestions when C++
9349 name lookup fails for an identifier.  The default is 1000.
9351 @item sink-frequency-threshold
9352 The maximum relative execution frequency (in percents) of the target block
9353 relative to a statement's original block to allow statement sinking of a
9354 statement.  Larger numbers result in more aggressive statement sinking.
9355 The default value is 75.  A small positive adjustment is applied for
9356 statements with memory operands as those are even more profitable so sink.
9358 @item max-stores-to-sink
9359 The maximum number of conditional stores paires that can be sunk.  Set to 0
9360 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9361 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9363 @item allow-load-data-races
9364 Allow optimizers to introduce new data races on loads.
9365 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9366 unless implicitly set by the @option{-fmemory-model=} option.
9368 @item allow-store-data-races
9369 Allow optimizers to introduce new data races on stores.
9370 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9371 unless implicitly set by the @option{-fmemory-model=} option.
9373 @item allow-packed-load-data-races
9374 Allow optimizers to introduce new data races on packed data loads.
9375 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9376 unless implicitly set by the @option{-fmemory-model=} option.
9378 @item allow-packed-store-data-races
9379 Allow optimizers to introduce new data races on packed data stores.
9380 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9381 unless implicitly set by the @option{-fmemory-model=} option.
9383 @item case-values-threshold
9384 The smallest number of different values for which it is best to use a
9385 jump-table instead of a tree of conditional branches.  If the value is
9386 0, use the default for the machine.  The default is 0.
9388 @item tree-reassoc-width
9389 Set the maximum number of instructions executed in parallel in
9390 reassociated tree. This parameter overrides target dependent
9391 heuristics used by default if has non zero value.
9393 @item sched-pressure-algorithm
9394 Choose between the two available implementations of
9395 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
9396 and is the more likely to prevent instructions from being reordered.
9397 Algorithm 2 was designed to be a compromise between the relatively
9398 conservative approach taken by algorithm 1 and the rather aggressive
9399 approach taken by the default scheduler.  It relies more heavily on
9400 having a regular register file and accurate register pressure classes.
9401 See @file{haifa-sched.c} in the GCC sources for more details.
9403 The default choice depends on the target.
9404 @end table
9405 @end table
9407 @node Preprocessor Options
9408 @section Options Controlling the Preprocessor
9409 @cindex preprocessor options
9410 @cindex options, preprocessor
9412 These options control the C preprocessor, which is run on each C source
9413 file before actual compilation.
9415 If you use the @option{-E} option, nothing is done except preprocessing.
9416 Some of these options make sense only together with @option{-E} because
9417 they cause the preprocessor output to be unsuitable for actual
9418 compilation.
9420 @table @gcctabopt
9421 @item -Wp,@var{option}
9422 @opindex Wp
9423 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9424 and pass @var{option} directly through to the preprocessor.  If
9425 @var{option} contains commas, it is split into multiple options at the
9426 commas.  However, many options are modified, translated or interpreted
9427 by the compiler driver before being passed to the preprocessor, and
9428 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9429 interface is undocumented and subject to change, so whenever possible
9430 you should avoid using @option{-Wp} and let the driver handle the
9431 options instead.
9433 @item -Xpreprocessor @var{option}
9434 @opindex Xpreprocessor
9435 Pass @var{option} as an option to the preprocessor.  You can use this to
9436 supply system-specific preprocessor options that GCC does not know how to
9437 recognize.
9439 If you want to pass an option that takes an argument, you must use
9440 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9442 @item -no-integrated-cpp
9443 @opindex no-integrated-cpp
9444 Perform preprocessing as a separate pass before compilation.
9445 By default, GCC performs preprocessing as an integrated part of
9446 input tokenization and parsing.
9447 If this option is provided, the appropriate language front end
9448 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9449 and Objective-C, respectively) is instead invoked twice,
9450 once for preprocessing only and once for actual compilation
9451 of the preprocessed input.
9452 This option may be useful in conjunction with the @option{-B} or
9453 @option{-wrapper} options to specify an alternate preprocessor or
9454 perform additional processing of the program source between
9455 normal preprocessing and compilation.
9456 @end table
9458 @include cppopts.texi
9460 @node Assembler Options
9461 @section Passing Options to the Assembler
9463 @c prevent bad page break with this line
9464 You can pass options to the assembler.
9466 @table @gcctabopt
9467 @item -Wa,@var{option}
9468 @opindex Wa
9469 Pass @var{option} as an option to the assembler.  If @var{option}
9470 contains commas, it is split into multiple options at the commas.
9472 @item -Xassembler @var{option}
9473 @opindex Xassembler
9474 Pass @var{option} as an option to the assembler.  You can use this to
9475 supply system-specific assembler options that GCC does not know how to
9476 recognize.
9478 If you want to pass an option that takes an argument, you must use
9479 @option{-Xassembler} twice, once for the option and once for the argument.
9481 @end table
9483 @node Link Options
9484 @section Options for Linking
9485 @cindex link options
9486 @cindex options, linking
9488 These options come into play when the compiler links object files into
9489 an executable output file.  They are meaningless if the compiler is
9490 not doing a link step.
9492 @table @gcctabopt
9493 @cindex file names
9494 @item @var{object-file-name}
9495 A file name that does not end in a special recognized suffix is
9496 considered to name an object file or library.  (Object files are
9497 distinguished from libraries by the linker according to the file
9498 contents.)  If linking is done, these object files are used as input
9499 to the linker.
9501 @item -c
9502 @itemx -S
9503 @itemx -E
9504 @opindex c
9505 @opindex S
9506 @opindex E
9507 If any of these options is used, then the linker is not run, and
9508 object file names should not be used as arguments.  @xref{Overall
9509 Options}.
9511 @cindex Libraries
9512 @item -l@var{library}
9513 @itemx -l @var{library}
9514 @opindex l
9515 Search the library named @var{library} when linking.  (The second
9516 alternative with the library as a separate argument is only for
9517 POSIX compliance and is not recommended.)
9519 It makes a difference where in the command you write this option; the
9520 linker searches and processes libraries and object files in the order they
9521 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9522 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9523 to functions in @samp{z}, those functions may not be loaded.
9525 The linker searches a standard list of directories for the library,
9526 which is actually a file named @file{lib@var{library}.a}.  The linker
9527 then uses this file as if it had been specified precisely by name.
9529 The directories searched include several standard system directories
9530 plus any that you specify with @option{-L}.
9532 Normally the files found this way are library files---archive files
9533 whose members are object files.  The linker handles an archive file by
9534 scanning through it for members which define symbols that have so far
9535 been referenced but not defined.  But if the file that is found is an
9536 ordinary object file, it is linked in the usual fashion.  The only
9537 difference between using an @option{-l} option and specifying a file name
9538 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9539 and searches several directories.
9541 @item -lobjc
9542 @opindex lobjc
9543 You need this special case of the @option{-l} option in order to
9544 link an Objective-C or Objective-C++ program.
9546 @item -nostartfiles
9547 @opindex nostartfiles
9548 Do not use the standard system startup files when linking.
9549 The standard system libraries are used normally, unless @option{-nostdlib}
9550 or @option{-nodefaultlibs} is used.
9552 @item -nodefaultlibs
9553 @opindex nodefaultlibs
9554 Do not use the standard system libraries when linking.
9555 Only the libraries you specify are passed to the linker, and options
9556 specifying linkage of the system libraries, such as @code{-static-libgcc}
9557 or @code{-shared-libgcc}, are ignored.  
9558 The standard startup files are used normally, unless @option{-nostartfiles}
9559 is used.  The compiler may generate calls to @code{memcmp},
9560 @code{memset}, @code{memcpy} and @code{memmove}.
9561 These entries are usually resolved by entries in
9562 libc.  These entry points should be supplied through some other
9563 mechanism when this option is specified.
9565 @item -nostdlib
9566 @opindex nostdlib
9567 Do not use the standard system startup files or libraries when linking.
9568 No startup files and only the libraries you specify are passed to
9569 the linker, and options specifying linkage of the system libraries, such as
9570 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
9572 The compiler may generate calls to @code{memcmp}, @code{memset},
9573 @code{memcpy} and @code{memmove}.
9574 These entries are usually resolved by entries in
9575 libc.  These entry points should be supplied through some other
9576 mechanism when this option is specified.
9578 @cindex @option{-lgcc}, use with @option{-nostdlib}
9579 @cindex @option{-nostdlib} and unresolved references
9580 @cindex unresolved references and @option{-nostdlib}
9581 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9582 @cindex @option{-nodefaultlibs} and unresolved references
9583 @cindex unresolved references and @option{-nodefaultlibs}
9584 One of the standard libraries bypassed by @option{-nostdlib} and
9585 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9586 which GCC uses to overcome shortcomings of particular machines, or special
9587 needs for some languages.
9588 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9589 Collection (GCC) Internals},
9590 for more discussion of @file{libgcc.a}.)
9591 In most cases, you need @file{libgcc.a} even when you want to avoid
9592 other standard libraries.  In other words, when you specify @option{-nostdlib}
9593 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9594 This ensures that you have no unresolved references to internal GCC
9595 library subroutines.
9596 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
9597 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
9598 GNU Compiler Collection (GCC) Internals}.)
9600 @item -pie
9601 @opindex pie
9602 Produce a position independent executable on targets that support it.
9603 For predictable results, you must also specify the same set of options
9604 used for compilation (@option{-fpie}, @option{-fPIE},
9605 or model suboptions) when you specify this linker option.
9607 @item -rdynamic
9608 @opindex rdynamic
9609 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9610 that support it. This instructs the linker to add all symbols, not
9611 only used ones, to the dynamic symbol table. This option is needed
9612 for some uses of @code{dlopen} or to allow obtaining backtraces
9613 from within a program.
9615 @item -s
9616 @opindex s
9617 Remove all symbol table and relocation information from the executable.
9619 @item -static
9620 @opindex static
9621 On systems that support dynamic linking, this prevents linking with the shared
9622 libraries.  On other systems, this option has no effect.
9624 @item -shared
9625 @opindex shared
9626 Produce a shared object which can then be linked with other objects to
9627 form an executable.  Not all systems support this option.  For predictable
9628 results, you must also specify the same set of options used for compilation
9629 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
9630 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
9631 needs to build supplementary stub code for constructors to work.  On
9632 multi-libbed systems, @samp{gcc -shared} must select the correct support
9633 libraries to link against.  Failing to supply the correct flags may lead
9634 to subtle defects.  Supplying them in cases where they are not necessary
9635 is innocuous.}
9637 @item -shared-libgcc
9638 @itemx -static-libgcc
9639 @opindex shared-libgcc
9640 @opindex static-libgcc
9641 On systems that provide @file{libgcc} as a shared library, these options
9642 force the use of either the shared or static version respectively.
9643 If no shared version of @file{libgcc} was built when the compiler was
9644 configured, these options have no effect.
9646 There are several situations in which an application should use the
9647 shared @file{libgcc} instead of the static version.  The most common
9648 of these is when the application wishes to throw and catch exceptions
9649 across different shared libraries.  In that case, each of the libraries
9650 as well as the application itself should use the shared @file{libgcc}.
9652 Therefore, the G++ and GCJ drivers automatically add
9653 @option{-shared-libgcc} whenever you build a shared library or a main
9654 executable, because C++ and Java programs typically use exceptions, so
9655 this is the right thing to do.
9657 If, instead, you use the GCC driver to create shared libraries, you may
9658 find that they are not always linked with the shared @file{libgcc}.
9659 If GCC finds, at its configuration time, that you have a non-GNU linker
9660 or a GNU linker that does not support option @option{--eh-frame-hdr},
9661 it links the shared version of @file{libgcc} into shared libraries
9662 by default.  Otherwise, it takes advantage of the linker and optimizes
9663 away the linking with the shared version of @file{libgcc}, linking with
9664 the static version of libgcc by default.  This allows exceptions to
9665 propagate through such shared libraries, without incurring relocation
9666 costs at library load time.
9668 However, if a library or main executable is supposed to throw or catch
9669 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9670 for the languages used in the program, or using the option
9671 @option{-shared-libgcc}, such that it is linked with the shared
9672 @file{libgcc}.
9674 @item -static-libstdc++
9675 When the @command{g++} program is used to link a C++ program, it
9676 normally automatically links against @option{libstdc++}.  If
9677 @file{libstdc++} is available as a shared library, and the
9678 @option{-static} option is not used, then this links against the
9679 shared version of @file{libstdc++}.  That is normally fine.  However, it
9680 is sometimes useful to freeze the version of @file{libstdc++} used by
9681 the program without going all the way to a fully static link.  The
9682 @option{-static-libstdc++} option directs the @command{g++} driver to
9683 link @file{libstdc++} statically, without necessarily linking other
9684 libraries statically.
9686 @item -symbolic
9687 @opindex symbolic
9688 Bind references to global symbols when building a shared object.  Warn
9689 about any unresolved references (unless overridden by the link editor
9690 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
9691 this option.
9693 @item -T @var{script}
9694 @opindex T
9695 @cindex linker script
9696 Use @var{script} as the linker script.  This option is supported by most
9697 systems using the GNU linker.  On some targets, such as bare-board
9698 targets without an operating system, the @option{-T} option may be required
9699 when linking to avoid references to undefined symbols.
9701 @item -Xlinker @var{option}
9702 @opindex Xlinker
9703 Pass @var{option} as an option to the linker.  You can use this to
9704 supply system-specific linker options that GCC does not recognize.
9706 If you want to pass an option that takes a separate argument, you must use
9707 @option{-Xlinker} twice, once for the option and once for the argument.
9708 For example, to pass @option{-assert definitions}, you must write
9709 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9710 @option{-Xlinker "-assert definitions"}, because this passes the entire
9711 string as a single argument, which is not what the linker expects.
9713 When using the GNU linker, it is usually more convenient to pass
9714 arguments to linker options using the @option{@var{option}=@var{value}}
9715 syntax than as separate arguments.  For example, you can specify
9716 @option{-Xlinker -Map=output.map} rather than
9717 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9718 this syntax for command-line options.
9720 @item -Wl,@var{option}
9721 @opindex Wl
9722 Pass @var{option} as an option to the linker.  If @var{option} contains
9723 commas, it is split into multiple options at the commas.  You can use this
9724 syntax to pass an argument to the option.
9725 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
9726 linker.  When using the GNU linker, you can also get the same effect with
9727 @option{-Wl,-Map=output.map}.
9729 @item -u @var{symbol}
9730 @opindex u
9731 Pretend the symbol @var{symbol} is undefined, to force linking of
9732 library modules to define it.  You can use @option{-u} multiple times with
9733 different symbols to force loading of additional library modules.
9734 @end table
9736 @node Directory Options
9737 @section Options for Directory Search
9738 @cindex directory options
9739 @cindex options, directory search
9740 @cindex search path
9742 These options specify directories to search for header files, for
9743 libraries and for parts of the compiler:
9745 @table @gcctabopt
9746 @item -I@var{dir}
9747 @opindex I
9748 Add the directory @var{dir} to the head of the list of directories to be
9749 searched for header files.  This can be used to override a system header
9750 file, substituting your own version, since these directories are
9751 searched before the system header file directories.  However, you should
9752 not use this option to add directories that contain vendor-supplied
9753 system header files (use @option{-isystem} for that).  If you use more than
9754 one @option{-I} option, the directories are scanned in left-to-right
9755 order; the standard system directories come after.
9757 If a standard system include directory, or a directory specified with
9758 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9759 option is ignored.  The directory is still searched but as a
9760 system directory at its normal position in the system include chain.
9761 This is to ensure that GCC's procedure to fix buggy system headers and
9762 the ordering for the @code{include_next} directive are not inadvertently changed.
9763 If you really need to change the search order for system directories,
9764 use the @option{-nostdinc} and/or @option{-isystem} options.
9766 @item -iplugindir=@var{dir}
9767 Set the directory to search for plugins that are passed
9768 by @option{-fplugin=@var{name}} instead of
9769 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
9770 to be used by the user, but only passed by the driver.
9772 @item -iquote@var{dir}
9773 @opindex iquote
9774 Add the directory @var{dir} to the head of the list of directories to
9775 be searched for header files only for the case of @samp{#include
9776 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9777 otherwise just like @option{-I}.
9779 @item -L@var{dir}
9780 @opindex L
9781 Add directory @var{dir} to the list of directories to be searched
9782 for @option{-l}.
9784 @item -B@var{prefix}
9785 @opindex B
9786 This option specifies where to find the executables, libraries,
9787 include files, and data files of the compiler itself.
9789 The compiler driver program runs one or more of the subprograms
9790 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
9791 @var{prefix} as a prefix for each program it tries to run, both with and
9792 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9794 For each subprogram to be run, the compiler driver first tries the
9795 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9796 is not specified, the driver tries two standard prefixes, 
9797 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9798 those results in a file name that is found, the unmodified program
9799 name is searched for using the directories specified in your
9800 @env{PATH} environment variable.
9802 The compiler checks to see if the path provided by the @option{-B}
9803 refers to a directory, and if necessary it adds a directory
9804 separator character at the end of the path.
9806 @option{-B} prefixes that effectively specify directory names also apply
9807 to libraries in the linker, because the compiler translates these
9808 options into @option{-L} options for the linker.  They also apply to
9809 includes files in the preprocessor, because the compiler translates these
9810 options into @option{-isystem} options for the preprocessor.  In this case,
9811 the compiler appends @samp{include} to the prefix.
9813 The runtime support file @file{libgcc.a} can also be searched for using
9814 the @option{-B} prefix, if needed.  If it is not found there, the two
9815 standard prefixes above are tried, and that is all.  The file is left
9816 out of the link if it is not found by those means.
9818 Another way to specify a prefix much like the @option{-B} prefix is to use
9819 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9820 Variables}.
9822 As a special kludge, if the path provided by @option{-B} is
9823 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9824 9, then it is replaced by @file{[dir/]include}.  This is to help
9825 with boot-strapping the compiler.
9827 @item -specs=@var{file}
9828 @opindex specs
9829 Process @var{file} after the compiler reads in the standard @file{specs}
9830 file, in order to override the defaults which the @command{gcc} driver
9831 program uses when determining what switches to pass to @command{cc1},
9832 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
9833 @option{-specs=@var{file}} can be specified on the command line, and they
9834 are processed in order, from left to right.
9836 @item --sysroot=@var{dir}
9837 @opindex sysroot
9838 Use @var{dir} as the logical root directory for headers and libraries.
9839 For example, if the compiler normally searches for headers in
9840 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
9841 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9843 If you use both this option and the @option{-isysroot} option, then
9844 the @option{--sysroot} option applies to libraries, but the
9845 @option{-isysroot} option applies to header files.
9847 The GNU linker (beginning with version 2.16) has the necessary support
9848 for this option.  If your linker does not support this option, the
9849 header file aspect of @option{--sysroot} still works, but the
9850 library aspect does not.
9852 @item -I-
9853 @opindex I-
9854 This option has been deprecated.  Please use @option{-iquote} instead for
9855 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9856 Any directories you specify with @option{-I} options before the @option{-I-}
9857 option are searched only for the case of @samp{#include "@var{file}"};
9858 they are not searched for @samp{#include <@var{file}>}.
9860 If additional directories are specified with @option{-I} options after
9861 the @option{-I-}, these directories are searched for all @samp{#include}
9862 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9863 this way.)
9865 In addition, the @option{-I-} option inhibits the use of the current
9866 directory (where the current input file came from) as the first search
9867 directory for @samp{#include "@var{file}"}.  There is no way to
9868 override this effect of @option{-I-}.  With @option{-I.} you can specify
9869 searching the directory that is current when the compiler is
9870 invoked.  That is not exactly the same as what the preprocessor does
9871 by default, but it is often satisfactory.
9873 @option{-I-} does not inhibit the use of the standard system directories
9874 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9875 independent.
9876 @end table
9878 @c man end
9880 @node Spec Files
9881 @section Specifying subprocesses and the switches to pass to them
9882 @cindex Spec Files
9884 @command{gcc} is a driver program.  It performs its job by invoking a
9885 sequence of other programs to do the work of compiling, assembling and
9886 linking.  GCC interprets its command-line parameters and uses these to
9887 deduce which programs it should invoke, and which command-line options
9888 it ought to place on their command lines.  This behavior is controlled
9889 by @dfn{spec strings}.  In most cases there is one spec string for each
9890 program that GCC can invoke, but a few programs have multiple spec
9891 strings to control their behavior.  The spec strings built into GCC can
9892 be overridden by using the @option{-specs=} command-line switch to specify
9893 a spec file.
9895 @dfn{Spec files} are plaintext files that are used to construct spec
9896 strings.  They consist of a sequence of directives separated by blank
9897 lines.  The type of directive is determined by the first non-whitespace
9898 character on the line, which can be one of the following:
9900 @table @code
9901 @item %@var{command}
9902 Issues a @var{command} to the spec file processor.  The commands that can
9903 appear here are:
9905 @table @code
9906 @item %include <@var{file}>
9907 @cindex @code{%include}
9908 Search for @var{file} and insert its text at the current point in the
9909 specs file.
9911 @item %include_noerr <@var{file}>
9912 @cindex @code{%include_noerr}
9913 Just like @samp{%include}, but do not generate an error message if the include
9914 file cannot be found.
9916 @item %rename @var{old_name} @var{new_name}
9917 @cindex @code{%rename}
9918 Rename the spec string @var{old_name} to @var{new_name}.
9920 @end table
9922 @item *[@var{spec_name}]:
9923 This tells the compiler to create, override or delete the named spec
9924 string.  All lines after this directive up to the next directive or
9925 blank line are considered to be the text for the spec string.  If this
9926 results in an empty string then the spec is deleted.  (Or, if the
9927 spec did not exist, then nothing happens.)  Otherwise, if the spec
9928 does not currently exist a new spec is created.  If the spec does
9929 exist then its contents are overridden by the text of this
9930 directive, unless the first character of that text is the @samp{+}
9931 character, in which case the text is appended to the spec.
9933 @item [@var{suffix}]:
9934 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9935 and up to the next directive or blank line are considered to make up the
9936 spec string for the indicated suffix.  When the compiler encounters an
9937 input file with the named suffix, it processes the spec string in
9938 order to work out how to compile that file.  For example:
9940 @smallexample
9941 .ZZ:
9942 z-compile -input %i
9943 @end smallexample
9945 This says that any input file whose name ends in @samp{.ZZ} should be
9946 passed to the program @samp{z-compile}, which should be invoked with the
9947 command-line switch @option{-input} and with the result of performing the
9948 @samp{%i} substitution.  (See below.)
9950 As an alternative to providing a spec string, the text that follows a
9951 suffix directive can be one of the following:
9953 @table @code
9954 @item @@@var{language}
9955 This says that the suffix is an alias for a known @var{language}.  This is
9956 similar to using the @option{-x} command-line switch to GCC to specify a
9957 language explicitly.  For example:
9959 @smallexample
9960 .ZZ:
9961 @@c++
9962 @end smallexample
9964 Says that .ZZ files are, in fact, C++ source files.
9966 @item #@var{name}
9967 This causes an error messages saying:
9969 @smallexample
9970 @var{name} compiler not installed on this system.
9971 @end smallexample
9972 @end table
9974 GCC already has an extensive list of suffixes built into it.
9975 This directive adds an entry to the end of the list of suffixes, but
9976 since the list is searched from the end backwards, it is effectively
9977 possible to override earlier entries using this technique.
9979 @end table
9981 GCC has the following spec strings built into it.  Spec files can
9982 override these strings or create their own.  Note that individual
9983 targets can also add their own spec strings to this list.
9985 @smallexample
9986 asm          Options to pass to the assembler
9987 asm_final    Options to pass to the assembler post-processor
9988 cpp          Options to pass to the C preprocessor
9989 cc1          Options to pass to the C compiler
9990 cc1plus      Options to pass to the C++ compiler
9991 endfile      Object files to include at the end of the link
9992 link         Options to pass to the linker
9993 lib          Libraries to include on the command line to the linker
9994 libgcc       Decides which GCC support library to pass to the linker
9995 linker       Sets the name of the linker
9996 predefines   Defines to be passed to the C preprocessor
9997 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9998              by default
9999 startfile    Object files to include at the start of the link
10000 @end smallexample
10002 Here is a small example of a spec file:
10004 @smallexample
10005 %rename lib                 old_lib
10007 *lib:
10008 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10009 @end smallexample
10011 This example renames the spec called @samp{lib} to @samp{old_lib} and
10012 then overrides the previous definition of @samp{lib} with a new one.
10013 The new definition adds in some extra command-line options before
10014 including the text of the old definition.
10016 @dfn{Spec strings} are a list of command-line options to be passed to their
10017 corresponding program.  In addition, the spec strings can contain
10018 @samp{%}-prefixed sequences to substitute variable text or to
10019 conditionally insert text into the command line.  Using these constructs
10020 it is possible to generate quite complex command lines.
10022 Here is a table of all defined @samp{%}-sequences for spec
10023 strings.  Note that spaces are not generated automatically around the
10024 results of expanding these sequences.  Therefore you can concatenate them
10025 together or combine them with constant text in a single argument.
10027 @table @code
10028 @item %%
10029 Substitute one @samp{%} into the program name or argument.
10031 @item %i
10032 Substitute the name of the input file being processed.
10034 @item %b
10035 Substitute the basename of the input file being processed.
10036 This is the substring up to (and not including) the last period
10037 and not including the directory.
10039 @item %B
10040 This is the same as @samp{%b}, but include the file suffix (text after
10041 the last period).
10043 @item %d
10044 Marks the argument containing or following the @samp{%d} as a
10045 temporary file name, so that that file is deleted if GCC exits
10046 successfully.  Unlike @samp{%g}, this contributes no text to the
10047 argument.
10049 @item %g@var{suffix}
10050 Substitute a file name that has suffix @var{suffix} and is chosen
10051 once per compilation, and mark the argument in the same way as
10052 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10053 name is now chosen in a way that is hard to predict even when previously
10054 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10055 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10056 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10057 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10058 was simply substituted with a file name chosen once per compilation,
10059 without regard to any appended suffix (which was therefore treated
10060 just like ordinary text), making such attacks more likely to succeed.
10062 @item %u@var{suffix}
10063 Like @samp{%g}, but generates a new temporary file name
10064 each time it appears instead of once per compilation.
10066 @item %U@var{suffix}
10067 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10068 new one if there is no such last file name.  In the absence of any
10069 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10070 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10071 involves the generation of two distinct file names, one
10072 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10073 simply substituted with a file name chosen for the previous @samp{%u},
10074 without regard to any appended suffix.
10076 @item %j@var{suffix}
10077 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10078 writable, and if @option{-save-temps} is not used; 
10079 otherwise, substitute the name
10080 of a temporary file, just like @samp{%u}.  This temporary file is not
10081 meant for communication between processes, but rather as a junk
10082 disposal mechanism.
10084 @item %|@var{suffix}
10085 @itemx %m@var{suffix}
10086 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10087 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10088 all.  These are the two most common ways to instruct a program that it
10089 should read from standard input or write to standard output.  If you
10090 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10091 construct: see for example @file{f/lang-specs.h}.
10093 @item %.@var{SUFFIX}
10094 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10095 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10096 terminated by the next space or %.
10098 @item %w
10099 Marks the argument containing or following the @samp{%w} as the
10100 designated output file of this compilation.  This puts the argument
10101 into the sequence of arguments that @samp{%o} substitutes.
10103 @item %o
10104 Substitutes the names of all the output files, with spaces
10105 automatically placed around them.  You should write spaces
10106 around the @samp{%o} as well or the results are undefined.
10107 @samp{%o} is for use in the specs for running the linker.
10108 Input files whose names have no recognized suffix are not compiled
10109 at all, but they are included among the output files, so they are
10110 linked.
10112 @item %O
10113 Substitutes the suffix for object files.  Note that this is
10114 handled specially when it immediately follows @samp{%g, %u, or %U},
10115 because of the need for those to form complete file names.  The
10116 handling is such that @samp{%O} is treated exactly as if it had already
10117 been substituted, except that @samp{%g, %u, and %U} do not currently
10118 support additional @var{suffix} characters following @samp{%O} as they do
10119 following, for example, @samp{.o}.
10121 @item %p
10122 Substitutes the standard macro predefinitions for the
10123 current target machine.  Use this when running @code{cpp}.
10125 @item %P
10126 Like @samp{%p}, but puts @samp{__} before and after the name of each
10127 predefined macro, except for macros that start with @samp{__} or with
10128 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10131 @item %I
10132 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10133 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10134 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10135 and @option{-imultilib} as necessary.
10137 @item %s
10138 Current argument is the name of a library or startup file of some sort.
10139 Search for that file in a standard list of directories and substitute
10140 the full name found.  The current working directory is included in the
10141 list of directories scanned.
10143 @item %T
10144 Current argument is the name of a linker script.  Search for that file
10145 in the current list of directories to scan for libraries. If the file
10146 is located insert a @option{--script} option into the command line
10147 followed by the full path name found.  If the file is not found then
10148 generate an error message.  Note: the current working directory is not
10149 searched.
10151 @item %e@var{str}
10152 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10153 Use this when inconsistent options are detected.
10155 @item %(@var{name})
10156 Substitute the contents of spec string @var{name} at this point.
10158 @item %x@{@var{option}@}
10159 Accumulate an option for @samp{%X}.
10161 @item %X
10162 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10163 spec string.
10165 @item %Y
10166 Output the accumulated assembler options specified by @option{-Wa}.
10168 @item %Z
10169 Output the accumulated preprocessor options specified by @option{-Wp}.
10171 @item %a
10172 Process the @code{asm} spec.  This is used to compute the
10173 switches to be passed to the assembler.
10175 @item %A
10176 Process the @code{asm_final} spec.  This is a spec string for
10177 passing switches to an assembler post-processor, if such a program is
10178 needed.
10180 @item %l
10181 Process the @code{link} spec.  This is the spec for computing the
10182 command line passed to the linker.  Typically it makes use of the
10183 @samp{%L %G %S %D and %E} sequences.
10185 @item %D
10186 Dump out a @option{-L} option for each directory that GCC believes might
10187 contain startup files.  If the target supports multilibs then the
10188 current multilib directory is prepended to each of these paths.
10190 @item %L
10191 Process the @code{lib} spec.  This is a spec string for deciding which
10192 libraries are included on the command line to the linker.
10194 @item %G
10195 Process the @code{libgcc} spec.  This is a spec string for deciding
10196 which GCC support library is included on the command line to the linker.
10198 @item %S
10199 Process the @code{startfile} spec.  This is a spec for deciding which
10200 object files are the first ones passed to the linker.  Typically
10201 this might be a file named @file{crt0.o}.
10203 @item %E
10204 Process the @code{endfile} spec.  This is a spec string that specifies
10205 the last object files that are passed to the linker.
10207 @item %C
10208 Process the @code{cpp} spec.  This is used to construct the arguments
10209 to be passed to the C preprocessor.
10211 @item %1
10212 Process the @code{cc1} spec.  This is used to construct the options to be
10213 passed to the actual C compiler (@samp{cc1}).
10215 @item %2
10216 Process the @code{cc1plus} spec.  This is used to construct the options to be
10217 passed to the actual C++ compiler (@samp{cc1plus}).
10219 @item %*
10220 Substitute the variable part of a matched option.  See below.
10221 Note that each comma in the substituted string is replaced by
10222 a single space.
10224 @item %<@code{S}
10225 Remove all occurrences of @code{-S} from the command line.  Note---this
10226 command is position dependent.  @samp{%} commands in the spec string
10227 before this one see @code{-S}, @samp{%} commands in the spec string
10228 after this one do not.
10230 @item %:@var{function}(@var{args})
10231 Call the named function @var{function}, passing it @var{args}.
10232 @var{args} is first processed as a nested spec string, then split
10233 into an argument vector in the usual fashion.  The function returns
10234 a string which is processed as if it had appeared literally as part
10235 of the current spec.
10237 The following built-in spec functions are provided:
10239 @table @code
10240 @item @code{getenv}
10241 The @code{getenv} spec function takes two arguments: an environment
10242 variable name and a string.  If the environment variable is not
10243 defined, a fatal error is issued.  Otherwise, the return value is the
10244 value of the environment variable concatenated with the string.  For
10245 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10247 @smallexample
10248 %:getenv(TOPDIR /include)
10249 @end smallexample
10251 expands to @file{/path/to/top/include}.
10253 @item @code{if-exists}
10254 The @code{if-exists} spec function takes one argument, an absolute
10255 pathname to a file.  If the file exists, @code{if-exists} returns the
10256 pathname.  Here is a small example of its usage:
10258 @smallexample
10259 *startfile:
10260 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10261 @end smallexample
10263 @item @code{if-exists-else}
10264 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10265 spec function, except that it takes two arguments.  The first argument is
10266 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10267 returns the pathname.  If it does not exist, it returns the second argument.
10268 This way, @code{if-exists-else} can be used to select one file or another,
10269 based on the existence of the first.  Here is a small example of its usage:
10271 @smallexample
10272 *startfile:
10273 crt0%O%s %:if-exists(crti%O%s) \
10274 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10275 @end smallexample
10277 @item @code{replace-outfile}
10278 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10279 first argument in the outfiles array and replaces it with the second argument.  Here
10280 is a small example of its usage:
10282 @smallexample
10283 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10284 @end smallexample
10286 @item @code{remove-outfile}
10287 The @code{remove-outfile} spec function takes one argument.  It looks for the
10288 first argument in the outfiles array and removes it.  Here is a small example
10289 its usage:
10291 @smallexample
10292 %:remove-outfile(-lm)
10293 @end smallexample
10295 @item @code{pass-through-libs}
10296 The @code{pass-through-libs} spec function takes any number of arguments.  It
10297 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10298 assumes are the names of linker input library archive files) and returns a
10299 result containing all the found arguments each prepended by
10300 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10301 intended to be passed to the LTO linker plugin.
10303 @smallexample
10304 %:pass-through-libs(%G %L %G)
10305 @end smallexample
10307 @item @code{print-asm-header}
10308 The @code{print-asm-header} function takes no arguments and simply
10309 prints a banner like:
10311 @smallexample
10312 Assembler options
10313 =================
10315 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10316 @end smallexample
10318 It is used to separate compiler options from assembler options
10319 in the @option{--target-help} output.
10320 @end table
10322 @item %@{@code{S}@}
10323 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10324 If that switch is not specified, this substitutes nothing.  Note that
10325 the leading dash is omitted when specifying this option, and it is
10326 automatically inserted if the substitution is performed.  Thus the spec
10327 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10328 and outputs the command-line option @option{-foo}.
10330 @item %W@{@code{S}@}
10331 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10332 deleted on failure.
10334 @item %@{@code{S}*@}
10335 Substitutes all the switches specified to GCC whose names start
10336 with @code{-S}, but which also take an argument.  This is used for
10337 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10338 GCC considers @option{-o foo} as being
10339 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
10340 text, including the space.  Thus two arguments are generated.
10342 @item %@{@code{S}*&@code{T}*@}
10343 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10344 (the order of @code{S} and @code{T} in the spec is not significant).
10345 There can be any number of ampersand-separated variables; for each the
10346 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10348 @item %@{@code{S}:@code{X}@}
10349 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10351 @item %@{!@code{S}:@code{X}@}
10352 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10354 @item %@{@code{S}*:@code{X}@}
10355 Substitutes @code{X} if one or more switches whose names start with
10356 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10357 once, no matter how many such switches appeared.  However, if @code{%*}
10358 appears somewhere in @code{X}, then @code{X} is substituted once
10359 for each matching switch, with the @code{%*} replaced by the part of
10360 that switch matching the @code{*}.
10362 @item %@{.@code{S}:@code{X}@}
10363 Substitutes @code{X}, if processing a file with suffix @code{S}.
10365 @item %@{!.@code{S}:@code{X}@}
10366 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10368 @item %@{,@code{S}:@code{X}@}
10369 Substitutes @code{X}, if processing a file for language @code{S}.
10371 @item %@{!,@code{S}:@code{X}@}
10372 Substitutes @code{X}, if not processing a file for language @code{S}.
10374 @item %@{@code{S}|@code{P}:@code{X}@}
10375 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10376 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10377 @code{*} sequences as well, although they have a stronger binding than
10378 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10379 alternatives must be starred, and only the first matching alternative
10380 is substituted.
10382 For example, a spec string like this:
10384 @smallexample
10385 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10386 @end smallexample
10388 @noindent
10389 outputs the following command-line options from the following input
10390 command-line options:
10392 @smallexample
10393 fred.c        -foo -baz
10394 jim.d         -bar -boggle
10395 -d fred.c     -foo -baz -boggle
10396 -d jim.d      -bar -baz -boggle
10397 @end smallexample
10399 @item %@{S:X; T:Y; :D@}
10401 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10402 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10403 be as many clauses as you need.  This may be combined with @code{.},
10404 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10407 @end table
10409 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10410 construct may contain other nested @samp{%} constructs or spaces, or
10411 even newlines.  They are processed as usual, as described above.
10412 Trailing white space in @code{X} is ignored.  White space may also
10413 appear anywhere on the left side of the colon in these constructs,
10414 except between @code{.} or @code{*} and the corresponding word.
10416 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10417 handled specifically in these constructs.  If another value of
10418 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10419 @option{-W} switch is found later in the command line, the earlier
10420 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10421 just one letter, which passes all matching options.
10423 The character @samp{|} at the beginning of the predicate text is used to
10424 indicate that a command should be piped to the following command, but
10425 only if @option{-pipe} is specified.
10427 It is built into GCC which switches take arguments and which do not.
10428 (You might think it would be useful to generalize this to allow each
10429 compiler's spec to say which switches take arguments.  But this cannot
10430 be done in a consistent fashion.  GCC cannot even decide which input
10431 files have been specified without knowing which switches take arguments,
10432 and it must know which input files to compile in order to tell which
10433 compilers to run).
10435 GCC also knows implicitly that arguments starting in @option{-l} are to be
10436 treated as compiler output files, and passed to the linker in their
10437 proper position among the other output files.
10439 @c man begin OPTIONS
10441 @node Target Options
10442 @section Specifying Target Machine and Compiler Version
10443 @cindex target options
10444 @cindex cross compiling
10445 @cindex specifying machine version
10446 @cindex specifying compiler version and target machine
10447 @cindex compiler version, specifying
10448 @cindex target machine, specifying
10450 The usual way to run GCC is to run the executable called @command{gcc}, or
10451 @command{@var{machine}-gcc} when cross-compiling, or
10452 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10453 one that was installed last.
10455 @node Submodel Options
10456 @section Hardware Models and Configurations
10457 @cindex submodel options
10458 @cindex specifying hardware config
10459 @cindex hardware models and configurations, specifying
10460 @cindex machine dependent options
10462 Each target machine types can have its own
10463 special options, starting with @samp{-m}, to choose among various
10464 hardware models or configurations---for example, 68010 vs 68020,
10465 floating coprocessor or none.  A single installed version of the
10466 compiler can compile for any model or configuration, according to the
10467 options specified.
10469 Some configurations of the compiler also support additional special
10470 options, usually for compatibility with other compilers on the same
10471 platform.
10473 @c This list is ordered alphanumerically by subsection name.
10474 @c It should be the same order and spelling as these options are listed
10475 @c in Machine Dependent Options
10477 @menu
10478 * Adapteva Epiphany Options::
10479 * ARM Options::
10480 * AVR Options::
10481 * Blackfin Options::
10482 * C6X Options::
10483 * CRIS Options::
10484 * CR16 Options::
10485 * Darwin Options::
10486 * DEC Alpha Options::
10487 * FR30 Options::
10488 * FRV Options::
10489 * GNU/Linux Options::
10490 * H8/300 Options::
10491 * HPPA Options::
10492 * i386 and x86-64 Options::
10493 * i386 and x86-64 Windows Options::
10494 * IA-64 Options::
10495 * LM32 Options::
10496 * M32C Options::
10497 * M32R/D Options::
10498 * M680x0 Options::
10499 * MCore Options::
10500 * MeP Options::
10501 * MicroBlaze Options::
10502 * MIPS Options::
10503 * MMIX Options::
10504 * MN10300 Options::
10505 * PDP-11 Options::
10506 * picoChip Options::
10507 * PowerPC Options::
10508 * RL78 Options::
10509 * RS/6000 and PowerPC Options::
10510 * RX Options::
10511 * S/390 and zSeries Options::
10512 * Score Options::
10513 * SH Options::
10514 * Solaris 2 Options::
10515 * SPARC Options::
10516 * SPU Options::
10517 * System V Options::
10518 * TILE-Gx Options::
10519 * TILEPro Options::
10520 * V850 Options::
10521 * VAX Options::
10522 * VMS Options::
10523 * VxWorks Options::
10524 * x86-64 Options::
10525 * Xstormy16 Options::
10526 * Xtensa Options::
10527 * zSeries Options::
10528 @end menu
10530 @node Adapteva Epiphany Options
10531 @subsection Adapteva Epiphany Options
10533 These @samp{-m} options are defined for Adapteva Epiphany:
10535 @table @gcctabopt
10536 @item -mhalf-reg-file
10537 @opindex mhalf-reg-file
10538 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
10539 That allows code to run on hardware variants that lack these registers.
10541 @item -mprefer-short-insn-regs
10542 @opindex mprefer-short-insn-regs
10543 Preferrentially allocate registers that allow short instruction generation.
10544 This can result in increasesd instruction count, so if this reduces or
10545 increases code size might vary from case to case.
10547 @item -mbranch-cost=@var{num}
10548 @opindex mbranch-cost
10549 Set the cost of branches to roughly @var{num} ``simple'' instructions.
10550 This cost is only a heuristic and is not guaranteed to produce
10551 consistent results across releases.
10553 @item -mcmove
10554 @opindex mcmove
10555 Enable the generation of conditional moves.
10557 @item -mnops=@var{num}
10558 @opindex mnops
10559 Emit @var{num} nops before every other generated instruction.
10561 @item -mno-soft-cmpsf
10562 @opindex mno-soft-cmpsf
10563 For single-precision floating-point comparisons, emit an @code{fsub} instruction
10564 and test the flags.  This is faster than a software comparison, but can
10565 get incorrect results in the presence of NaNs, or when two different small
10566 numbers are compared such that their difference is calculated as zero.
10567 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
10568 software comparisons.
10570 @item -mstack-offset=@var{num}
10571 @opindex mstack-offset
10572 Set the offset between the top of the stack and the stack pointer.
10573 E.g., a value of 8 means that the eight bytes in the range sp+0@dots{}sp+7
10574 can be used by leaf functions without stack allocation.
10575 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
10576 Note also that this option changes the ABI, compiling a program with a
10577 different stack offset than the libraries have been compiled with
10578 generally does not work.
10579 This option can be useful if you want to evaluate if a different stack
10580 offset would give you better code, but to actually use a different stack
10581 offset to build working programs, it is recommended to configure the
10582 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
10584 @item -mno-round-nearest
10585 @opindex mno-round-nearest
10586 Make the scheduler assume that the rounding mode has been set to
10587 truncating.  The default is @option{-mround-nearest}.
10589 @item -mlong-calls
10590 @opindex mlong-calls
10591 If not otherwise specified by an attribute, assume all calls might be beyond
10592 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
10593 function address into a register before performing a (otherwise direct) call.
10594 This is the default.
10596 @item -mshort-calls
10597 @opindex short-calls
10598 If not otherwise specified by an attribute, assume all direct calls are
10599 in the range of the @code{b} / @code{bl} instructions, so use these instructions
10600 for direct calls.  The default is @option{-mlong-calls}.
10602 @item -msmall16
10603 @opindex msmall16
10604 Assume addresses can be loaded as 16-bit unsigned values.  This does not
10605 apply to function addresses for which @option{-mlong-calls} semantics
10606 are in effect.
10608 @item -mfp-mode=@var{mode}
10609 @opindex mfp-mode
10610 Set the prevailing mode of the floating-point unit.
10611 This determines the floating-point mode that is provided and expected
10612 at function call and return time.  Making this mode match the mode you
10613 predominantly need at function start can make your programs smaller and
10614 faster by avoiding unnecessary mode switches.
10616 @var{mode} can be set to one the following values:
10618 @table @samp
10619 @item caller
10620 Any mode at function entry is valid, and retained or restored when
10621 the function returns, and when it calls other functions.
10622 This mode is useful for compiling libraries or other compilation units
10623 you might want to incorporate into different programs with different
10624 prevailing FPU modes, and the convenience of being able to use a single
10625 object file outweighs the size and speed overhead for any extra
10626 mode switching that might be needed, compared with what would be needed
10627 with a more specific choice of prevailing FPU mode.
10629 @item truncate
10630 This is the mode used for floating-point calculations with
10631 truncating (i.e.@: round towards zero) rounding mode.  That includes
10632 conversion from floating point to integer.
10634 @item round-nearest
10635 This is the mode used for floating-point calculations with
10636 round-to-nearest-or-even rounding mode.
10638 @item int
10639 This is the mode used to perform integer calculations in the FPU, e.g.@:
10640 integer multiply, or integer multiply-and-accumulate.
10641 @end table
10643 The default is @option{-mfp-mode=caller}
10645 @item -mnosplit-lohi
10646 @opindex mnosplit-lohi
10647 @item -mno-postinc
10648 @opindex mno-postinc
10649 @item -mno-postmodify
10650 @opindex mno-postmodify
10651 Code generation tweaks that disable, respectively, splitting of 32-bit
10652 loads, generation of post-increment addresses, and generation of
10653 post-modify addresses.  The defaults are @option{msplit-lohi},
10654 @option{-mpost-inc}, and @option{-mpost-modify}.
10656 @item -mnovect-double
10657 @opindex mno-vect-double
10658 Change the preferred SIMD mode to SImode.  The default is
10659 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
10661 @item -max-vect-align=@var{num}
10662 @opindex max-vect-align
10663 The maximum alignment for SIMD vector mode types.
10664 @var{num} may be 4 or 8.  The default is 8.
10665 Note that this is an ABI change, even though many library function
10666 interfaces are unaffected if they don't use SIMD vector modes
10667 in places that affect size and/or alignment of relevant types.
10669 @item -msplit-vecmove-early
10670 @opindex msplit-vecmove-early
10671 Split vector moves into single word moves before reload.  In theory this
10672 can give better register allocation, but so far the reverse seems to be
10673 generally the case.
10675 @item -m1reg-@var{reg}
10676 @opindex m1reg-
10677 Specify a register to hold the constant @minus{}1, which makes loading small negative
10678 constants and certain bitmasks faster.
10679 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
10680 which specify use of that register as a fixed register,
10681 and @samp{none}, which means that no register is used for this
10682 purpose.  The default is @option{-m1reg-none}.
10684 @end table
10686 @node ARM Options
10687 @subsection ARM Options
10688 @cindex ARM options
10690 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
10691 architectures:
10693 @table @gcctabopt
10694 @item -mabi=@var{name}
10695 @opindex mabi
10696 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
10697 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
10699 @item -mapcs-frame
10700 @opindex mapcs-frame
10701 Generate a stack frame that is compliant with the ARM Procedure Call
10702 Standard for all functions, even if this is not strictly necessary for
10703 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
10704 with this option causes the stack frames not to be generated for
10705 leaf functions.  The default is @option{-mno-apcs-frame}.
10707 @item -mapcs
10708 @opindex mapcs
10709 This is a synonym for @option{-mapcs-frame}.
10711 @ignore
10712 @c not currently implemented
10713 @item -mapcs-stack-check
10714 @opindex mapcs-stack-check
10715 Generate code to check the amount of stack space available upon entry to
10716 every function (that actually uses some stack space).  If there is
10717 insufficient space available then either the function
10718 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
10719 called, depending upon the amount of stack space required.  The runtime
10720 system is required to provide these functions.  The default is
10721 @option{-mno-apcs-stack-check}, since this produces smaller code.
10723 @c not currently implemented
10724 @item -mapcs-float
10725 @opindex mapcs-float
10726 Pass floating-point arguments using the floating-point registers.  This is
10727 one of the variants of the APCS@.  This option is recommended if the
10728 target hardware has a floating-point unit or if a lot of floating-point
10729 arithmetic is going to be performed by the code.  The default is
10730 @option{-mno-apcs-float}, since integer only code is slightly increased in
10731 size if @option{-mapcs-float} is used.
10733 @c not currently implemented
10734 @item -mapcs-reentrant
10735 @opindex mapcs-reentrant
10736 Generate reentrant, position independent code.  The default is
10737 @option{-mno-apcs-reentrant}.
10738 @end ignore
10740 @item -mthumb-interwork
10741 @opindex mthumb-interwork
10742 Generate code that supports calling between the ARM and Thumb
10743 instruction sets.  Without this option, on pre-v5 architectures, the
10744 two instruction sets cannot be reliably used inside one program.  The
10745 default is @option{-mno-thumb-interwork}, since slightly larger code
10746 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
10747 configurations this option is meaningless.
10749 @item -mno-sched-prolog
10750 @opindex mno-sched-prolog
10751 Prevent the reordering of instructions in the function prologue, or the
10752 merging of those instruction with the instructions in the function's
10753 body.  This means that all functions start with a recognizable set
10754 of instructions (or in fact one of a choice from a small set of
10755 different function prologues), and this information can be used to
10756 locate the start of functions inside an executable piece of code.  The
10757 default is @option{-msched-prolog}.
10759 @item -mfloat-abi=@var{name}
10760 @opindex mfloat-abi
10761 Specifies which floating-point ABI to use.  Permissible values
10762 are: @samp{soft}, @samp{softfp} and @samp{hard}.
10764 Specifying @samp{soft} causes GCC to generate output containing
10765 library calls for floating-point operations.
10766 @samp{softfp} allows the generation of code using hardware floating-point
10767 instructions, but still uses the soft-float calling conventions.
10768 @samp{hard} allows generation of floating-point instructions
10769 and uses FPU-specific calling conventions.
10771 The default depends on the specific target configuration.  Note that
10772 the hard-float and soft-float ABIs are not link-compatible; you must
10773 compile your entire program with the same ABI, and link with a
10774 compatible set of libraries.
10776 @item -mlittle-endian
10777 @opindex mlittle-endian
10778 Generate code for a processor running in little-endian mode.  This is
10779 the default for all standard configurations.
10781 @item -mbig-endian
10782 @opindex mbig-endian
10783 Generate code for a processor running in big-endian mode; the default is
10784 to compile code for a little-endian processor.
10786 @item -mwords-little-endian
10787 @opindex mwords-little-endian
10788 This option only applies when generating code for big-endian processors.
10789 Generate code for a little-endian word order but a big-endian byte
10790 order.  That is, a byte order of the form @samp{32107654}.  Note: this
10791 option should only be used if you require compatibility with code for
10792 big-endian ARM processors generated by versions of the compiler prior to
10793 2.8.  This option is now deprecated.
10795 @item -mcpu=@var{name}
10796 @opindex mcpu
10797 This specifies the name of the target ARM processor.  GCC uses this name
10798 to determine what kind of instructions it can emit when generating
10799 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
10800 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10801 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10802 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10803 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10804 @samp{arm720},
10805 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10806 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10807 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10808 @samp{strongarm1110},
10809 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10810 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10811 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10812 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10813 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10814 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10815 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10816 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
10817 @samp{cortex-a15}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
10818 @samp{cortex-m4}, @samp{cortex-m3},
10819 @samp{cortex-m1},
10820 @samp{cortex-m0},
10821 @samp{cortex-m0plus},
10822 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
10823 @samp{fa526}, @samp{fa626},
10824 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
10827 @option{-mcpu=generic-@var{arch}} is also permissible, and is
10828 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
10829 See @option{-mtune} for more information.
10831 @option{-mcpu=native} causes the compiler to auto-detect the CPU
10832 of the build computer.  At present, this feature is only supported on
10833 Linux, and not all architectures are recognized.  If the auto-detect is
10834 unsuccessful the option has no effect.
10836 @item -mtune=@var{name}
10837 @opindex mtune
10838 This option is very similar to the @option{-mcpu=} option, except that
10839 instead of specifying the actual target processor type, and hence
10840 restricting which instructions can be used, it specifies that GCC should
10841 tune the performance of the code as if the target were of the type
10842 specified in this option, but still choosing the instructions it
10843 generates based on the CPU specified by a @option{-mcpu=} option.
10844 For some ARM implementations better performance can be obtained by using
10845 this option.
10847 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
10848 performance for a blend of processors within architecture @var{arch}.
10849 The aim is to generate code that run well on the current most popular
10850 processors, balancing between optimizations that benefit some CPUs in the
10851 range, and avoiding performance pitfalls of other CPUs.  The effects of
10852 this option may change in future GCC versions as CPU models come and go.
10854 @option{-mtune=native} causes the compiler to auto-detect the CPU
10855 of the build computer.  At present, this feature is only supported on
10856 Linux, and not all architectures are recognized.  If the auto-detect is
10857 unsuccessful the option has no effect.
10859 @item -march=@var{name}
10860 @opindex march
10861 This specifies the name of the target ARM architecture.  GCC uses this
10862 name to determine what kind of instructions it can emit when generating
10863 assembly code.  This option can be used in conjunction with or instead
10864 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
10865 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10866 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10867 @samp{armv6}, @samp{armv6j},
10868 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10869 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10870 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10872 @option{-march=native} causes the compiler to auto-detect the architecture
10873 of the build computer.  At present, this feature is only supported on
10874 Linux, and not all architectures are recognized.  If the auto-detect is
10875 unsuccessful the option has no effect.
10877 @item -mfpu=@var{name}
10878 @opindex mfpu
10879 This specifies what floating-point hardware (or hardware emulation) is
10880 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
10881 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
10882 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
10883 @samp{vfpv4-d16}, @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10885 If @option{-msoft-float} is specified this specifies the format of
10886 floating-point values.
10888 If the selected floating-point hardware includes the NEON extension
10889 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10890 operations are not generated by GCC's auto-vectorization pass unless
10891 @option{-funsafe-math-optimizations} is also specified.  This is
10892 because NEON hardware does not fully implement the IEEE 754 standard for
10893 floating-point arithmetic (in particular denormal values are treated as
10894 zero), so the use of NEON instructions may lead to a loss of precision.
10896 @item -mfp16-format=@var{name}
10897 @opindex mfp16-format
10898 Specify the format of the @code{__fp16} half-precision floating-point type.
10899 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10900 the default is @samp{none}, in which case the @code{__fp16} type is not
10901 defined.  @xref{Half-Precision}, for more information.
10903 @item -mstructure-size-boundary=@var{n}
10904 @opindex mstructure-size-boundary
10905 The sizes of all structures and unions are rounded up to a multiple
10906 of the number of bits set by this option.  Permissible values are 8, 32
10907 and 64.  The default value varies for different toolchains.  For the COFF
10908 targeted toolchain the default value is 8.  A value of 64 is only allowed
10909 if the underlying ABI supports it.
10911 Specifying the larger number can produce faster, more efficient code, but
10912 can also increase the size of the program.  Different values are potentially
10913 incompatible.  Code compiled with one value cannot necessarily expect to
10914 work with code or libraries compiled with another value, if they exchange
10915 information using structures or unions.
10917 @item -mabort-on-noreturn
10918 @opindex mabort-on-noreturn
10919 Generate a call to the function @code{abort} at the end of a
10920 @code{noreturn} function.  It is executed if the function tries to
10921 return.
10923 @item -mlong-calls
10924 @itemx -mno-long-calls
10925 @opindex mlong-calls
10926 @opindex mno-long-calls
10927 Tells the compiler to perform function calls by first loading the
10928 address of the function into a register and then performing a subroutine
10929 call on this register.  This switch is needed if the target function
10930 lies outside of the 64-megabyte addressing range of the offset-based
10931 version of subroutine call instruction.
10933 Even if this switch is enabled, not all function calls are turned
10934 into long calls.  The heuristic is that static functions, functions
10935 that have the @samp{short-call} attribute, functions that are inside
10936 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
10937 definitions have already been compiled within the current compilation
10938 unit are not turned into long calls.  The exceptions to this rule are
10939 that weak function definitions, functions with the @samp{long-call}
10940 attribute or the @samp{section} attribute, and functions that are within
10941 the scope of a @samp{#pragma long_calls} directive are always
10942 turned into long calls.
10944 This feature is not enabled by default.  Specifying
10945 @option{-mno-long-calls} restores the default behavior, as does
10946 placing the function calls within the scope of a @samp{#pragma
10947 long_calls_off} directive.  Note these switches have no effect on how
10948 the compiler generates code to handle function calls via function
10949 pointers.
10951 @item -msingle-pic-base
10952 @opindex msingle-pic-base
10953 Treat the register used for PIC addressing as read-only, rather than
10954 loading it in the prologue for each function.  The runtime system is
10955 responsible for initializing this register with an appropriate value
10956 before execution begins.
10958 @item -mpic-register=@var{reg}
10959 @opindex mpic-register
10960 Specify the register to be used for PIC addressing.  The default is R10
10961 unless stack-checking is enabled, when R9 is used.
10963 @item -mcirrus-fix-invalid-insns
10964 @opindex mcirrus-fix-invalid-insns
10965 @opindex mno-cirrus-fix-invalid-insns
10966 Insert NOPs into the instruction stream to in order to work around
10967 problems with invalid Maverick instruction combinations.  This option
10968 is only valid if the @option{-mcpu=ep9312} option has been used to
10969 enable generation of instructions for the Cirrus Maverick floating-point
10970 co-processor.  This option is not enabled by default, since the
10971 problem is only present in older Maverick implementations.  The default
10972 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10973 switch.
10975 @item -mpoke-function-name
10976 @opindex mpoke-function-name
10977 Write the name of each function into the text section, directly
10978 preceding the function prologue.  The generated code is similar to this:
10980 @smallexample
10981      t0
10982          .ascii "arm_poke_function_name", 0
10983          .align
10984      t1
10985          .word 0xff000000 + (t1 - t0)
10986      arm_poke_function_name
10987          mov     ip, sp
10988          stmfd   sp!, @{fp, ip, lr, pc@}
10989          sub     fp, ip, #4
10990 @end smallexample
10992 When performing a stack backtrace, code can inspect the value of
10993 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10994 location @code{pc - 12} and the top 8 bits are set, then we know that
10995 there is a function name embedded immediately preceding this location
10996 and has length @code{((pc[-3]) & 0xff000000)}.
10998 @item -mthumb
10999 @itemx -marm
11000 @opindex marm
11001 @opindex mthumb
11003 Select between generating code that executes in ARM and Thumb
11004 states.  The default for most configurations is to generate code
11005 that executes in ARM state, but the default can be changed by
11006 configuring GCC with the @option{--with-mode=}@var{state}
11007 configure option.
11009 @item -mtpcs-frame
11010 @opindex mtpcs-frame
11011 Generate a stack frame that is compliant with the Thumb Procedure Call
11012 Standard for all non-leaf functions.  (A leaf function is one that does
11013 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
11015 @item -mtpcs-leaf-frame
11016 @opindex mtpcs-leaf-frame
11017 Generate a stack frame that is compliant with the Thumb Procedure Call
11018 Standard for all leaf functions.  (A leaf function is one that does
11019 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
11021 @item -mcallee-super-interworking
11022 @opindex mcallee-super-interworking
11023 Gives all externally visible functions in the file being compiled an ARM
11024 instruction set header which switches to Thumb mode before executing the
11025 rest of the function.  This allows these functions to be called from
11026 non-interworking code.  This option is not valid in AAPCS configurations
11027 because interworking is enabled by default.
11029 @item -mcaller-super-interworking
11030 @opindex mcaller-super-interworking
11031 Allows calls via function pointers (including virtual functions) to
11032 execute correctly regardless of whether the target code has been
11033 compiled for interworking or not.  There is a small overhead in the cost
11034 of executing a function pointer if this option is enabled.  This option
11035 is not valid in AAPCS configurations because interworking is enabled
11036 by default.
11038 @item -mtp=@var{name}
11039 @opindex mtp
11040 Specify the access model for the thread local storage pointer.  The valid
11041 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
11042 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
11043 (supported in the arm6k architecture), and @option{auto}, which uses the
11044 best available method for the selected processor.  The default setting is
11045 @option{auto}.
11047 @item -mtls-dialect=@var{dialect}
11048 @opindex mtls-dialect
11049 Specify the dialect to use for accessing thread local storage.  Two
11050 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
11051 @samp{gnu} dialect selects the original GNU scheme for supporting
11052 local and global dynamic TLS models.  The @samp{gnu2} dialect
11053 selects the GNU descriptor scheme, which provides better performance
11054 for shared libraries.  The GNU descriptor scheme is compatible with
11055 the original scheme, but does require new assembler, linker and
11056 library support.  Initial and local exec TLS models are unaffected by
11057 this option and always use the original scheme.
11059 @item -mword-relocations
11060 @opindex mword-relocations
11061 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
11062 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
11063 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
11064 is specified.
11066 @item -mfix-cortex-m3-ldrd
11067 @opindex mfix-cortex-m3-ldrd
11068 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
11069 with overlapping destination and base registers are used.  This option avoids
11070 generating these instructions.  This option is enabled by default when
11071 @option{-mcpu=cortex-m3} is specified.
11073 @item -munaligned-access
11074 @itemx -mno-unaligned-access
11075 @opindex munaligned-access
11076 @opindex mno-unaligned-access
11077 Enables (or disables) reading and writing of 16- and 32- bit values
11078 from addresses that are not 16- or 32- bit aligned.  By default
11079 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
11080 architectures, and enabled for all other architectures.  If unaligned
11081 access is not enabled then words in packed data structures will be
11082 accessed a byte at a time.
11084 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
11085 generated object file to either true or false, depending upon the
11086 setting of this option.  If unaligned access is enabled then the
11087 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
11088 defined.
11090 @end table
11092 @node AVR Options
11093 @subsection AVR Options
11094 @cindex AVR Options
11096 These options are defined for AVR implementations:
11098 @table @gcctabopt
11099 @item -mmcu=@var{mcu}
11100 @opindex mmcu
11101 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
11103 For a complete list of @var{mcu} values that are supported by @command{avr-gcc},
11104 see the compiler output when called with the @option{--help=target}
11105 command line option.
11106 The default for this option is@tie{}@code{avr2}.
11108 GCC supports the following AVR devices and ISAs:
11110 @include avr-mmcu.texi
11112 @item -maccumulate-args
11113 @opindex maccumulate-args
11114 Accumulate outgoing function arguments and acquire/release the needed
11115 stack space for outgoing function arguments once in function
11116 prologue/epilogue.  Without this option, outgoing arguments are pushed
11117 before calling a function and popped afterwards.
11119 Popping the arguments after the function call can be expensive on
11120 AVR so that accumulating the stack space might lead to smaller
11121 executables because arguments need not to be removed from the
11122 stack after such a function call.
11124 This option can lead to reduced code size for functions that perform
11125 several calls to functions that get their arguments on the stack like
11126 calls to printf-like functions.
11128 @item -mbranch-cost=@var{cost}
11129 @opindex mbranch-cost
11130 Set the branch costs for conditional branch instructions to
11131 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
11132 integers. The default branch cost is 0.
11134 @item -mcall-prologues
11135 @opindex mcall-prologues
11136 Functions prologues/epilogues are expanded as calls to appropriate
11137 subroutines.  Code size is smaller.
11139 @item -mint8
11140 @opindex mint8
11141 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
11142 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
11143 and @code{long long} is 4 bytes.  Please note that this option does not
11144 conform to the C standards, but it results in smaller code
11145 size.
11147 @item -mno-interrupts
11148 @opindex mno-interrupts
11149 Generated code is not compatible with hardware interrupts.
11150 Code size is smaller.
11152 @item -mrelax
11153 @opindex mrelax
11154 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11155 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11156 Setting @code{-mrelax} just adds the @code{--relax} option to the
11157 linker command line when the linker is called.
11159 Jump relaxing is performed by the linker because jump offsets are not
11160 known before code is located. Therefore, the assembler code generated by the
11161 compiler is the same, but the instructions in the executable may
11162 differ from instructions in the assembler code.
11164 Relaxing must be turned on if linker stubs are needed, see the
11165 section on @code{EIND} and linker stubs below.
11167 @item -mshort-calls
11168 @opindex mshort-calls
11169 Use @code{RCALL}/@code{RJMP} instructions even on devices with
11170 16@tie{}KiB or more of program memory, i.e.@: on devices that
11171 have the @code{CALL} and @code{JMP} instructions.
11172 See also the @code{-mrelax} command line option.
11174 @item -msp8
11175 @opindex msp8
11176 Treat the stack pointer register as an 8-bit register,
11177 i.e.@: assume the high byte of the stack pointer is zero.
11178 In general, you don't need to set this option by hand.
11180 This option is used internally by the compiler to select and
11181 build multilibs for architectures @code{avr2} and @code{avr25}.
11182 These architectures mix devices with and without @code{SPH}.
11183 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
11184 the compiler driver will add or remove this option from the compiler
11185 proper's command line, because the compiler then knows if the device
11186 or architecture has an 8-bit stack pointer and thus no @code{SPH}
11187 register or not.
11189 @item -mstrict-X
11190 @opindex mstrict-X
11191 Use address register @code{X} in a way proposed by the hardware.  This means
11192 that @code{X} is only used in indirect, post-increment or
11193 pre-decrement addressing.
11195 Without this option, the @code{X} register may be used in the same way
11196 as @code{Y} or @code{Z} which then is emulated by additional
11197 instructions.  
11198 For example, loading a value with @code{X+const} addressing with a
11199 small non-negative @code{const < 64} to a register @var{Rn} is
11200 performed as
11202 @example
11203 adiw r26, const   ; X += const
11204 ld   @var{Rn}, X        ; @var{Rn} = *X
11205 sbiw r26, const   ; X -= const
11206 @end example
11208 @item -mtiny-stack
11209 @opindex mtiny-stack
11210 Only change the lower 8@tie{}bits of the stack pointer.
11211 @end table
11213 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11214 @cindex @code{EIND}
11215 Pointers in the implementation are 16@tie{}bits wide.
11216 The address of a function or label is represented as word address so
11217 that indirect jumps and calls can target any code address in the
11218 range of 64@tie{}Ki words.
11220 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11221 bytes of program memory space, there is a special function register called
11222 @code{EIND} that serves as most significant part of the target address
11223 when @code{EICALL} or @code{EIJMP} instructions are used.
11225 Indirect jumps and calls on these devices are handled as follows by
11226 the compiler and are subject to some limitations:
11228 @itemize @bullet
11230 @item
11231 The compiler never sets @code{EIND}.
11233 @item
11234 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11235 instructions or might read @code{EIND} directly in order to emulate an
11236 indirect call/jump by means of a @code{RET} instruction.
11238 @item
11239 The compiler assumes that @code{EIND} never changes during the startup
11240 code or during the application. In particular, @code{EIND} is not
11241 saved/restored in function or interrupt service routine
11242 prologue/epilogue.
11244 @item
11245 For indirect calls to functions and computed goto, the linker
11246 generates @emph{stubs}. Stubs are jump pads sometimes also called
11247 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
11248 The stub contains a direct jump to the desired address.
11250 @item
11251 Linker relaxation must be turned on so that the linker will generate
11252 the stubs correctly an all situaltion. See the compiler option
11253 @code{-mrelax} and the linler option @code{--relax}.
11254 There are corner cases where the linker is supposed to generate stubs
11255 but aborts without relaxation and without a helpful error message.
11257 @item
11258 The default linker script is arranged for code with @code{EIND = 0}.
11259 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11260 linker script has to be used in order to place the sections whose
11261 name start with @code{.trampolines} into the segment where @code{EIND}
11262 points to.
11264 @item
11265 The startup code from libgcc never sets @code{EIND}.
11266 Notice that startup code is a blend of code from libgcc and AVR-LibC.
11267 For the impact of AVR-LibC on @code{EIND}, see the
11268 @w{@uref{http://nongnu.org/avr-libc/user-manual,AVR-LibC user manual}}.
11270 @item
11271 It is legitimate for user-specific startup code to set up @code{EIND}
11272 early, for example by means of initialization code located in
11273 section @code{.init3}. Such code runs prior to general startup code
11274 that initializes RAM and calls constructors, but after the bit
11275 of startup code from AVR-LibC that sets @code{EIND} to the segment
11276 where the vector table is located.
11277 @example
11278 #include <avr/io.h>
11280 static void
11281 __attribute__((section(".init3"),naked,used,no_instrument_function))
11282 init3_set_eind (void)
11284   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
11285                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
11287 @end example
11289 @noindent
11290 The @code{__trampolines_start} symbol is defined in the linker script.
11292 @item
11293 Stubs are generated automatically by the linker if
11294 the following two conditions are met:
11295 @itemize @minus
11297 @item The address of a label is taken by means of the @code{gs} modifier
11298 (short for @emph{generate stubs}) like so:
11299 @example
11300 LDI r24, lo8(gs(@var{func}))
11301 LDI r25, hi8(gs(@var{func}))
11302 @end example
11303 @item The final location of that label is in a code segment
11304 @emph{outside} the segment where the stubs are located.
11305 @end itemize
11307 @item
11308 The compiler emits such @code{gs} modifiers for code labels in the
11309 following situations:
11310 @itemize @minus
11311 @item Taking address of a function or code label.
11312 @item Computed goto.
11313 @item If prologue-save function is used, see @option{-mcall-prologues}
11314 command-line option.
11315 @item Switch/case dispatch tables. If you do not want such dispatch
11316 tables you can specify the @option{-fno-jump-tables} command-line option.
11317 @item C and C++ constructors/destructors called during startup/shutdown.
11318 @item If the tools hit a @code{gs()} modifier explained above.
11319 @end itemize
11321 @item
11322 Jumping to non-symbolic addresses like so is @emph{not} supported:
11324 @example
11325 int main (void)
11327     /* Call function at word address 0x2 */
11328     return ((int(*)(void)) 0x2)();
11330 @end example
11332 Instead, a stub has to be set up, i.e.@: the function has to be called
11333 through a symbol (@code{func_4} in the example):
11335 @example
11336 int main (void)
11338     extern int func_4 (void);
11340     /* Call function at byte address 0x4 */
11341     return func_4();
11343 @end example
11345 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11346 Alternatively, @code{func_4} can be defined in the linker script.
11347 @end itemize
11349 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11350 @cindex @code{RAMPD}
11351 @cindex @code{RAMPX}
11352 @cindex @code{RAMPY}
11353 @cindex @code{RAMPZ}
11354 Some AVR devices support memories larger than the 64@tie{}KiB range
11355 that can be accessed with 16-bit pointers.  To access memory locations
11356 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11357 register is used as high part of the address:
11358 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11359 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11360 register, respectively, to get a wide address. Similarly,
11361 @code{RAMPD} is used together with direct addressing.
11363 @itemize
11364 @item
11365 The startup code initializes the @code{RAMP} special function
11366 registers with zero.
11368 @item
11369 If a @ref{AVR Named Address Spaces,named address space} other than
11370 generic or @code{__flash} is used, then @code{RAMPZ} is set
11371 as needed before the operation.
11373 @item
11374 If the device supports RAM larger than 64@tie{KiB} and the compiler
11375 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11376 is reset to zero after the operation.
11378 @item
11379 If the device comes with a specific @code{RAMP} register, the ISR
11380 prologue/epilogue saves/restores that SFR and initializes it with
11381 zero in case the ISR code might (implicitly) use it.
11383 @item
11384 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
11385 If you use inline assembler to read from locations outside the
11386 16-bit address range and change one of the @code{RAMP} registers,
11387 you must reset it to zero after the access.
11389 @end itemize
11391 @subsubsection AVR Built-in Macros
11393 GCC defines several built-in macros so that the user code can test
11394 for the presence or absence of features.  Almost any of the following
11395 built-in macros are deduced from device capabilities and thus
11396 triggered by the @code{-mmcu=} command-line option.
11398 For even more AVR-specific built-in macros see
11399 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
11401 @table @code
11403 @item __AVR_@var{Device}__
11404 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
11405 the device's name. For example, @code{-mmcu=atmega8} defines the
11406 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
11407 @code{__AVR_ATtiny261A__}, etc.
11409 The built-in macros' names follow
11410 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
11411 the device name as from the AVR user manual. The difference between
11412 @var{Device} in the built-in macro and @var{device} in
11413 @code{-mmcu=@var{device}} is that the latter is always lowercase.
11415 @item __AVR_HAVE_ELPM__
11416 The device has the the @code{ELPM} instruction.
11418 @item __AVR_HAVE_ELPMX__
11419 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
11420 R@var{n},Z+} instructions.
11422 @item __AVR_HAVE_MOVW__
11423 The device has the @code{MOVW} instruction to perform 16-bit
11424 register-register moves.
11426 @item __AVR_HAVE_LPMX__
11427 The device has the @code{LPM R@var{n},Z} and
11428 @code{LPM R@var{n},Z+} instructions.
11430 @item __AVR_HAVE_MUL__
11431 The device has a hardware multiplier. 
11433 @item __AVR_HAVE_JMP_CALL__
11434 The device has the @code{JMP} and @code{CALL} instructions.
11435 This is the case for devices with at least 16@tie{}KiB of program
11436 memory and if @code{-mshort-calls} is not set.
11438 @item __AVR_HAVE_EIJMP_EICALL__
11439 @item __AVR_3_BYTE_PC__
11440 The device has the @code{EIJMP} and @code{EICALL} instructions.
11441 This is the case for devices with more than 128@tie{}KiB of program memory.
11442 This also means that the program counter
11443 (PC) is 3@tie{}bytes wide.
11445 @item __AVR_2_BYTE_PC__
11446 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
11447 with up to 128@tie{}KiB of program memory.
11449 @item __AVR_HAVE_8BIT_SP__
11450 @item __AVR_HAVE_16BIT_SP__
11451 The stack pointer (SP) register is treated as 8-bit respectively
11452 16-bit register by the compiler.
11453 The definition of these macros is affected by @code{-mtiny-stack}.
11455 @item __AVR_HAVE_SPH__
11456 @item __AVR_SP8__
11457 The device has the SPH (high part of stack pointer) special function
11458 register or has an 8-bit stack pointer, respectively.
11459 The definition of these macros is affected by @code{-mmcu=} and
11460 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
11461 by @code{-msp8}.
11463 @item __AVR_HAVE_RAMPD__
11464 @item __AVR_HAVE_RAMPX__
11465 @item __AVR_HAVE_RAMPY__
11466 @item __AVR_HAVE_RAMPZ__
11467 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
11468 @code{RAMPZ} special function register, respectively.
11470 @item __NO_INTERRUPTS__
11471 This macro reflects the @code{-mno-interrupts} command line option.
11473 @item __AVR_ERRATA_SKIP__
11474 @item __AVR_ERRATA_SKIP_JMP_CALL__
11475 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
11476 instructions because of a hardware erratum.  Skip instructions are
11477 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
11478 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
11479 set.
11481 @item __AVR_SFR_OFFSET__=@var{offset}
11482 Instructions that can address I/O special function registers directly
11483 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
11484 address as if addressed by an instruction to access RAM like @code{LD}
11485 or @code{STS}. This offset depends on the device architecture and has
11486 to be subtracted from the RAM address in order to get the
11487 respective I/O@tie{}address.
11489 @end table
11491 @node Blackfin Options
11492 @subsection Blackfin Options
11493 @cindex Blackfin Options
11495 @table @gcctabopt
11496 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11497 @opindex mcpu=
11498 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
11499 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11500 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11501 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11502 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11503 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11504 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11505 @samp{bf561}, @samp{bf592}.
11506 The optional @var{sirevision} specifies the silicon revision of the target
11507 Blackfin processor.  Any workarounds available for the targeted silicon revision
11508 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
11509 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
11510 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
11511 hexadecimal digits representing the major and minor numbers in the silicon
11512 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
11513 is not defined.  If @var{sirevision} is @samp{any}, the
11514 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
11515 If this optional @var{sirevision} is not used, GCC assumes the latest known
11516 silicon revision of the targeted Blackfin processor.
11518 Support for @samp{bf561} is incomplete.  For @samp{bf561},
11519 Only the processor macro is defined.
11520 Without this option, @samp{bf532} is used as the processor by default.
11521 The corresponding predefined processor macros for @var{cpu} is to
11522 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
11523 provided by libgloss to be linked in if @option{-msim} is not given.
11525 @item -msim
11526 @opindex msim
11527 Specifies that the program will be run on the simulator.  This causes
11528 the simulator BSP provided by libgloss to be linked in.  This option
11529 has effect only for @samp{bfin-elf} toolchain.
11530 Certain other options, such as @option{-mid-shared-library} and
11531 @option{-mfdpic}, imply @option{-msim}.
11533 @item -momit-leaf-frame-pointer
11534 @opindex momit-leaf-frame-pointer
11535 Don't keep the frame pointer in a register for leaf functions.  This
11536 avoids the instructions to save, set up and restore frame pointers and
11537 makes an extra register available in leaf functions.  The option
11538 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
11539 which might make debugging harder.
11541 @item -mspecld-anomaly
11542 @opindex mspecld-anomaly
11543 When enabled, the compiler ensures that the generated code does not
11544 contain speculative loads after jump instructions. If this option is used,
11545 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
11547 @item -mno-specld-anomaly
11548 @opindex mno-specld-anomaly
11549 Don't generate extra code to prevent speculative loads from occurring.
11551 @item -mcsync-anomaly
11552 @opindex mcsync-anomaly
11553 When enabled, the compiler ensures that the generated code does not
11554 contain CSYNC or SSYNC instructions too soon after conditional branches.
11555 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
11557 @item -mno-csync-anomaly
11558 @opindex mno-csync-anomaly
11559 Don't generate extra code to prevent CSYNC or SSYNC instructions from
11560 occurring too soon after a conditional branch.
11562 @item -mlow-64k
11563 @opindex mlow-64k
11564 When enabled, the compiler is free to take advantage of the knowledge that
11565 the entire program fits into the low 64k of memory.
11567 @item -mno-low-64k
11568 @opindex mno-low-64k
11569 Assume that the program is arbitrarily large.  This is the default.
11571 @item -mstack-check-l1
11572 @opindex mstack-check-l1
11573 Do stack checking using information placed into L1 scratchpad memory by the
11574 uClinux kernel.
11576 @item -mid-shared-library
11577 @opindex mid-shared-library
11578 Generate code that supports shared libraries via the library ID method.
11579 This allows for execute in place and shared libraries in an environment
11580 without virtual memory management.  This option implies @option{-fPIC}.
11581 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11583 @item -mno-id-shared-library
11584 @opindex mno-id-shared-library
11585 Generate code that doesn't assume ID based shared libraries are being used.
11586 This is the default.
11588 @item -mleaf-id-shared-library
11589 @opindex mleaf-id-shared-library
11590 Generate code that supports shared libraries via the library ID method,
11591 but assumes that this library or executable won't link against any other
11592 ID shared libraries.  That allows the compiler to use faster code for jumps
11593 and calls.
11595 @item -mno-leaf-id-shared-library
11596 @opindex mno-leaf-id-shared-library
11597 Do not assume that the code being compiled won't link against any ID shared
11598 libraries.  Slower code is generated for jump and call insns.
11600 @item -mshared-library-id=n
11601 @opindex mshared-library-id
11602 Specifies the identification number of the ID-based shared library being
11603 compiled.  Specifying a value of 0 generates more compact code; specifying
11604 other values forces the allocation of that number to the current
11605 library but is no more space- or time-efficient than omitting this option.
11607 @item -msep-data
11608 @opindex msep-data
11609 Generate code that allows the data segment to be located in a different
11610 area of memory from the text segment.  This allows for execute in place in
11611 an environment without virtual memory management by eliminating relocations
11612 against the text section.
11614 @item -mno-sep-data
11615 @opindex mno-sep-data
11616 Generate code that assumes that the data segment follows the text segment.
11617 This is the default.
11619 @item -mlong-calls
11620 @itemx -mno-long-calls
11621 @opindex mlong-calls
11622 @opindex mno-long-calls
11623 Tells the compiler to perform function calls by first loading the
11624 address of the function into a register and then performing a subroutine
11625 call on this register.  This switch is needed if the target function
11626 lies outside of the 24-bit addressing range of the offset-based
11627 version of subroutine call instruction.
11629 This feature is not enabled by default.  Specifying
11630 @option{-mno-long-calls} restores the default behavior.  Note these
11631 switches have no effect on how the compiler generates code to handle
11632 function calls via function pointers.
11634 @item -mfast-fp
11635 @opindex mfast-fp
11636 Link with the fast floating-point library. This library relaxes some of
11637 the IEEE floating-point standard's rules for checking inputs against
11638 Not-a-Number (NAN), in the interest of performance.
11640 @item -minline-plt
11641 @opindex minline-plt
11642 Enable inlining of PLT entries in function calls to functions that are
11643 not known to bind locally.  It has no effect without @option{-mfdpic}.
11645 @item -mmulticore
11646 @opindex mmulticore
11647 Build standalone application for multicore Blackfin processor. Proper
11648 start files and link scripts are used to support multicore.
11649 This option defines @code{__BFIN_MULTICORE}. It can only be used with
11650 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
11651 @option{-mcorea} or @option{-mcoreb}. If it's used without
11652 @option{-mcorea} or @option{-mcoreb}, single application/dual core
11653 programming model is used. In this model, the main function of Core B
11654 should be named as coreb_main. If it's used with @option{-mcorea} or
11655 @option{-mcoreb}, one application per core programming model is used.
11656 If this option is not used, single core application programming
11657 model is used.
11659 @item -mcorea
11660 @opindex mcorea
11661 Build standalone application for Core A of BF561 when using
11662 one application per core programming model. Proper start files
11663 and link scripts are used to support Core A. This option
11664 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
11666 @item -mcoreb
11667 @opindex mcoreb
11668 Build standalone application for Core B of BF561 when using
11669 one application per core programming model. Proper start files
11670 and link scripts are used to support Core B. This option
11671 defines @code{__BFIN_COREB}. When this option is used, coreb_main
11672 should be used instead of main. It must be used with
11673 @option{-mmulticore}.
11675 @item -msdram
11676 @opindex msdram
11677 Build standalone application for SDRAM. Proper start files and
11678 link scripts are used to put the application into SDRAM.
11679 Loader should initialize SDRAM before loading the application
11680 into SDRAM. This option defines @code{__BFIN_SDRAM}.
11682 @item -micplb
11683 @opindex micplb
11684 Assume that ICPLBs are enabled at run time.  This has an effect on certain
11685 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
11686 are enabled; for standalone applications the default is off.
11687 @end table
11689 @node C6X Options
11690 @subsection C6X Options
11691 @cindex C6X Options
11693 @table @gcctabopt
11694 @item -march=@var{name}
11695 @opindex march
11696 This specifies the name of the target architecture.  GCC uses this
11697 name to determine what kind of instructions it can emit when generating
11698 assembly code.  Permissible names are: @samp{c62x},
11699 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
11701 @item -mbig-endian
11702 @opindex mbig-endian
11703 Generate code for a big-endian target.
11705 @item -mlittle-endian
11706 @opindex mlittle-endian
11707 Generate code for a little-endian target.  This is the default.
11709 @item -msim
11710 @opindex msim
11711 Choose startup files and linker script suitable for the simulator.
11713 @item -msdata=default
11714 @opindex msdata=default
11715 Put small global and static data in the @samp{.neardata} section,
11716 which is pointed to by register @code{B14}.  Put small uninitialized
11717 global and static data in the @samp{.bss} section, which is adjacent
11718 to the @samp{.neardata} section.  Put small read-only data into the
11719 @samp{.rodata} section.  The corresponding sections used for large
11720 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
11722 @item -msdata=all
11723 @opindex msdata=all
11724 Put all data, not just small objets, into the sections reserved for
11725 small data, and use addressing relative to the @code{B14} register to
11726 access them.
11728 @item -msdata=none
11729 @opindex msdata=none
11730 Make no use of the sections reserved for small data, and use absolute
11731 addresses to access all data.  Put all initialized global and static
11732 data in the @samp{.fardata} section, and all uninitialized data in the
11733 @samp{.far} section.  Put all constant data into the @samp{.const}
11734 section.
11735 @end table
11737 @node CRIS Options
11738 @subsection CRIS Options
11739 @cindex CRIS Options
11741 These options are defined specifically for the CRIS ports.
11743 @table @gcctabopt
11744 @item -march=@var{architecture-type}
11745 @itemx -mcpu=@var{architecture-type}
11746 @opindex march
11747 @opindex mcpu
11748 Generate code for the specified architecture.  The choices for
11749 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
11750 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
11751 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
11752 @samp{v10}.
11754 @item -mtune=@var{architecture-type}
11755 @opindex mtune
11756 Tune to @var{architecture-type} everything applicable about the generated
11757 code, except for the ABI and the set of available instructions.  The
11758 choices for @var{architecture-type} are the same as for
11759 @option{-march=@var{architecture-type}}.
11761 @item -mmax-stack-frame=@var{n}
11762 @opindex mmax-stack-frame
11763 Warn when the stack frame of a function exceeds @var{n} bytes.
11765 @item -metrax4
11766 @itemx -metrax100
11767 @opindex metrax4
11768 @opindex metrax100
11769 The options @option{-metrax4} and @option{-metrax100} are synonyms for
11770 @option{-march=v3} and @option{-march=v8} respectively.
11772 @item -mmul-bug-workaround
11773 @itemx -mno-mul-bug-workaround
11774 @opindex mmul-bug-workaround
11775 @opindex mno-mul-bug-workaround
11776 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
11777 models where it applies.  This option is active by default.
11779 @item -mpdebug
11780 @opindex mpdebug
11781 Enable CRIS-specific verbose debug-related information in the assembly
11782 code.  This option also has the effect to turn off the @samp{#NO_APP}
11783 formatted-code indicator to the assembler at the beginning of the
11784 assembly file.
11786 @item -mcc-init
11787 @opindex mcc-init
11788 Do not use condition-code results from previous instruction; always emit
11789 compare and test instructions before use of condition codes.
11791 @item -mno-side-effects
11792 @opindex mno-side-effects
11793 Do not emit instructions with side-effects in addressing modes other than
11794 post-increment.
11796 @item -mstack-align
11797 @itemx -mno-stack-align
11798 @itemx -mdata-align
11799 @itemx -mno-data-align
11800 @itemx -mconst-align
11801 @itemx -mno-const-align
11802 @opindex mstack-align
11803 @opindex mno-stack-align
11804 @opindex mdata-align
11805 @opindex mno-data-align
11806 @opindex mconst-align
11807 @opindex mno-const-align
11808 These options (no-options) arranges (eliminate arrangements) for the
11809 stack-frame, individual data and constants to be aligned for the maximum
11810 single data access size for the chosen CPU model.  The default is to
11811 arrange for 32-bit alignment.  ABI details such as structure layout are
11812 not affected by these options.
11814 @item -m32-bit
11815 @itemx -m16-bit
11816 @itemx -m8-bit
11817 @opindex m32-bit
11818 @opindex m16-bit
11819 @opindex m8-bit
11820 Similar to the stack- data- and const-align options above, these options
11821 arrange for stack-frame, writable data and constants to all be 32-bit,
11822 16-bit or 8-bit aligned.  The default is 32-bit alignment.
11824 @item -mno-prologue-epilogue
11825 @itemx -mprologue-epilogue
11826 @opindex mno-prologue-epilogue
11827 @opindex mprologue-epilogue
11828 With @option{-mno-prologue-epilogue}, the normal function prologue and
11829 epilogue which set up the stack frame are omitted and no return
11830 instructions or return sequences are generated in the code.  Use this
11831 option only together with visual inspection of the compiled code: no
11832 warnings or errors are generated when call-saved registers must be saved,
11833 or storage for local variable needs to be allocated.
11835 @item -mno-gotplt
11836 @itemx -mgotplt
11837 @opindex mno-gotplt
11838 @opindex mgotplt
11839 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
11840 instruction sequences that load addresses for functions from the PLT part
11841 of the GOT rather than (traditional on other architectures) calls to the
11842 PLT@.  The default is @option{-mgotplt}.
11844 @item -melf
11845 @opindex melf
11846 Legacy no-op option only recognized with the cris-axis-elf and
11847 cris-axis-linux-gnu targets.
11849 @item -mlinux
11850 @opindex mlinux
11851 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
11853 @item -sim
11854 @opindex sim
11855 This option, recognized for the cris-axis-elf arranges
11856 to link with input-output functions from a simulator library.  Code,
11857 initialized data and zero-initialized data are allocated consecutively.
11859 @item -sim2
11860 @opindex sim2
11861 Like @option{-sim}, but pass linker options to locate initialized data at
11862 0x40000000 and zero-initialized data at 0x80000000.
11863 @end table
11865 @node CR16 Options
11866 @subsection CR16 Options
11867 @cindex CR16 Options
11869 These options are defined specifically for the CR16 ports.
11871 @table @gcctabopt
11873 @item -mmac
11874 @opindex mmac
11875 Enable the use of multiply-accumulate instructions. Disabled by default.
11877 @item -mcr16cplus
11878 @itemx -mcr16c
11879 @opindex mcr16cplus
11880 @opindex mcr16c
11881 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
11882 is default.
11884 @item -msim
11885 @opindex msim
11886 Links the library libsim.a which is in compatible with simulator. Applicable
11887 to ELF compiler only.
11889 @item -mint32
11890 @opindex mint32
11891 Choose integer type as 32-bit wide.
11893 @item -mbit-ops
11894 @opindex mbit-ops
11895 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
11897 @item -mdata-model=@var{model}
11898 @opindex mdata-model
11899 Choose a data model. The choices for @var{model} are @samp{near},
11900 @samp{far} or @samp{medium}. @samp{medium} is default.
11901 However, @samp{far} is not valid with @option{-mcr16c}, as the
11902 CR16C architecture does not support the far data model.
11903 @end table
11905 @node Darwin Options
11906 @subsection Darwin Options
11907 @cindex Darwin options
11909 These options are defined for all architectures running the Darwin operating
11910 system.
11912 FSF GCC on Darwin does not create ``fat'' object files; it creates
11913 an object file for the single architecture that GCC was built to
11914 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
11915 @option{-arch} options are used; it does so by running the compiler or
11916 linker multiple times and joining the results together with
11917 @file{lipo}.
11919 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
11920 @samp{i686}) is determined by the flags that specify the ISA
11921 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
11922 @option{-force_cpusubtype_ALL} option can be used to override this.
11924 The Darwin tools vary in their behavior when presented with an ISA
11925 mismatch.  The assembler, @file{as}, only permits instructions to
11926 be used that are valid for the subtype of the file it is generating,
11927 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
11928 The linker for shared libraries, @file{/usr/bin/libtool}, fails
11929 and prints an error if asked to create a shared library with a less
11930 restrictive subtype than its input files (for instance, trying to put
11931 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
11932 for executables, @command{ld}, quietly gives the executable the most
11933 restrictive subtype of any of its input files.
11935 @table @gcctabopt
11936 @item -F@var{dir}
11937 @opindex F
11938 Add the framework directory @var{dir} to the head of the list of
11939 directories to be searched for header files.  These directories are
11940 interleaved with those specified by @option{-I} options and are
11941 scanned in a left-to-right order.
11943 A framework directory is a directory with frameworks in it.  A
11944 framework is a directory with a @file{Headers} and/or
11945 @file{PrivateHeaders} directory contained directly in it that ends
11946 in @file{.framework}.  The name of a framework is the name of this
11947 directory excluding the @file{.framework}.  Headers associated with
11948 the framework are found in one of those two directories, with
11949 @file{Headers} being searched first.  A subframework is a framework
11950 directory that is in a framework's @file{Frameworks} directory.
11951 Includes of subframework headers can only appear in a header of a
11952 framework that contains the subframework, or in a sibling subframework
11953 header.  Two subframeworks are siblings if they occur in the same
11954 framework.  A subframework should not have the same name as a
11955 framework; a warning is issued if this is violated.  Currently a
11956 subframework cannot have subframeworks; in the future, the mechanism
11957 may be extended to support this.  The standard frameworks can be found
11958 in @file{/System/Library/Frameworks} and
11959 @file{/Library/Frameworks}.  An example include looks like
11960 @code{#include <Framework/header.h>}, where @file{Framework} denotes
11961 the name of the framework and @file{header.h} is found in the
11962 @file{PrivateHeaders} or @file{Headers} directory.
11964 @item -iframework@var{dir}
11965 @opindex iframework
11966 Like @option{-F} except the directory is a treated as a system
11967 directory.  The main difference between this @option{-iframework} and
11968 @option{-F} is that with @option{-iframework} the compiler does not
11969 warn about constructs contained within header files found via
11970 @var{dir}.  This option is valid only for the C family of languages.
11972 @item -gused
11973 @opindex gused
11974 Emit debugging information for symbols that are used.  For stabs
11975 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
11976 This is by default ON@.
11978 @item -gfull
11979 @opindex gfull
11980 Emit debugging information for all symbols and types.
11982 @item -mmacosx-version-min=@var{version}
11983 The earliest version of MacOS X that this executable will run on
11984 is @var{version}.  Typical values of @var{version} include @code{10.1},
11985 @code{10.2}, and @code{10.3.9}.
11987 If the compiler was built to use the system's headers by default,
11988 then the default for this option is the system version on which the
11989 compiler is running, otherwise the default is to make choices that
11990 are compatible with as many systems and code bases as possible.
11992 @item -mkernel
11993 @opindex mkernel
11994 Enable kernel development mode.  The @option{-mkernel} option sets
11995 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
11996 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
11997 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
11998 applicable.  This mode also sets @option{-mno-altivec},
11999 @option{-msoft-float}, @option{-fno-builtin} and
12000 @option{-mlong-branch} for PowerPC targets.
12002 @item -mone-byte-bool
12003 @opindex mone-byte-bool
12004 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
12005 By default @samp{sizeof(bool)} is @samp{4} when compiling for
12006 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
12007 option has no effect on x86.
12009 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
12010 to generate code that is not binary compatible with code generated
12011 without that switch.  Using this switch may require recompiling all
12012 other modules in a program, including system libraries.  Use this
12013 switch to conform to a non-default data model.
12015 @item -mfix-and-continue
12016 @itemx -ffix-and-continue
12017 @itemx -findirect-data
12018 @opindex mfix-and-continue
12019 @opindex ffix-and-continue
12020 @opindex findirect-data
12021 Generate code suitable for fast turn around development.  Needed to
12022 enable GDB to dynamically load @code{.o} files into already running
12023 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
12024 are provided for backwards compatibility.
12026 @item -all_load
12027 @opindex all_load
12028 Loads all members of static archive libraries.
12029 See man ld(1) for more information.
12031 @item -arch_errors_fatal
12032 @opindex arch_errors_fatal
12033 Cause the errors having to do with files that have the wrong architecture
12034 to be fatal.
12036 @item -bind_at_load
12037 @opindex bind_at_load
12038 Causes the output file to be marked such that the dynamic linker will
12039 bind all undefined references when the file is loaded or launched.
12041 @item -bundle
12042 @opindex bundle
12043 Produce a Mach-o bundle format file.
12044 See man ld(1) for more information.
12046 @item -bundle_loader @var{executable}
12047 @opindex bundle_loader
12048 This option specifies the @var{executable} that will load the build
12049 output file being linked.  See man ld(1) for more information.
12051 @item -dynamiclib
12052 @opindex dynamiclib
12053 When passed this option, GCC produces a dynamic library instead of
12054 an executable when linking, using the Darwin @file{libtool} command.
12056 @item -force_cpusubtype_ALL
12057 @opindex force_cpusubtype_ALL
12058 This causes GCC's output file to have the @var{ALL} subtype, instead of
12059 one controlled by the @option{-mcpu} or @option{-march} option.
12061 @item -allowable_client  @var{client_name}
12062 @itemx -client_name
12063 @itemx -compatibility_version
12064 @itemx -current_version
12065 @itemx -dead_strip
12066 @itemx -dependency-file
12067 @itemx -dylib_file
12068 @itemx -dylinker_install_name
12069 @itemx -dynamic
12070 @itemx -exported_symbols_list
12071 @itemx -filelist
12072 @need 800
12073 @itemx -flat_namespace
12074 @itemx -force_flat_namespace
12075 @itemx -headerpad_max_install_names
12076 @itemx -image_base
12077 @itemx -init
12078 @itemx -install_name
12079 @itemx -keep_private_externs
12080 @itemx -multi_module
12081 @itemx -multiply_defined
12082 @itemx -multiply_defined_unused
12083 @need 800
12084 @itemx -noall_load
12085 @itemx -no_dead_strip_inits_and_terms
12086 @itemx -nofixprebinding
12087 @itemx -nomultidefs
12088 @itemx -noprebind
12089 @itemx -noseglinkedit
12090 @itemx -pagezero_size
12091 @itemx -prebind
12092 @itemx -prebind_all_twolevel_modules
12093 @itemx -private_bundle
12094 @need 800
12095 @itemx -read_only_relocs
12096 @itemx -sectalign
12097 @itemx -sectobjectsymbols
12098 @itemx -whyload
12099 @itemx -seg1addr
12100 @itemx -sectcreate
12101 @itemx -sectobjectsymbols
12102 @itemx -sectorder
12103 @itemx -segaddr
12104 @itemx -segs_read_only_addr
12105 @need 800
12106 @itemx -segs_read_write_addr
12107 @itemx -seg_addr_table
12108 @itemx -seg_addr_table_filename
12109 @itemx -seglinkedit
12110 @itemx -segprot
12111 @itemx -segs_read_only_addr
12112 @itemx -segs_read_write_addr
12113 @itemx -single_module
12114 @itemx -static
12115 @itemx -sub_library
12116 @need 800
12117 @itemx -sub_umbrella
12118 @itemx -twolevel_namespace
12119 @itemx -umbrella
12120 @itemx -undefined
12121 @itemx -unexported_symbols_list
12122 @itemx -weak_reference_mismatches
12123 @itemx -whatsloaded
12124 @opindex allowable_client
12125 @opindex client_name
12126 @opindex compatibility_version
12127 @opindex current_version
12128 @opindex dead_strip
12129 @opindex dependency-file
12130 @opindex dylib_file
12131 @opindex dylinker_install_name
12132 @opindex dynamic
12133 @opindex exported_symbols_list
12134 @opindex filelist
12135 @opindex flat_namespace
12136 @opindex force_flat_namespace
12137 @opindex headerpad_max_install_names
12138 @opindex image_base
12139 @opindex init
12140 @opindex install_name
12141 @opindex keep_private_externs
12142 @opindex multi_module
12143 @opindex multiply_defined
12144 @opindex multiply_defined_unused
12145 @opindex noall_load
12146 @opindex no_dead_strip_inits_and_terms
12147 @opindex nofixprebinding
12148 @opindex nomultidefs
12149 @opindex noprebind
12150 @opindex noseglinkedit
12151 @opindex pagezero_size
12152 @opindex prebind
12153 @opindex prebind_all_twolevel_modules
12154 @opindex private_bundle
12155 @opindex read_only_relocs
12156 @opindex sectalign
12157 @opindex sectobjectsymbols
12158 @opindex whyload
12159 @opindex seg1addr
12160 @opindex sectcreate
12161 @opindex sectobjectsymbols
12162 @opindex sectorder
12163 @opindex segaddr
12164 @opindex segs_read_only_addr
12165 @opindex segs_read_write_addr
12166 @opindex seg_addr_table
12167 @opindex seg_addr_table_filename
12168 @opindex seglinkedit
12169 @opindex segprot
12170 @opindex segs_read_only_addr
12171 @opindex segs_read_write_addr
12172 @opindex single_module
12173 @opindex static
12174 @opindex sub_library
12175 @opindex sub_umbrella
12176 @opindex twolevel_namespace
12177 @opindex umbrella
12178 @opindex undefined
12179 @opindex unexported_symbols_list
12180 @opindex weak_reference_mismatches
12181 @opindex whatsloaded
12182 These options are passed to the Darwin linker.  The Darwin linker man page
12183 describes them in detail.
12184 @end table
12186 @node DEC Alpha Options
12187 @subsection DEC Alpha Options
12189 These @samp{-m} options are defined for the DEC Alpha implementations:
12191 @table @gcctabopt
12192 @item -mno-soft-float
12193 @itemx -msoft-float
12194 @opindex mno-soft-float
12195 @opindex msoft-float
12196 Use (do not use) the hardware floating-point instructions for
12197 floating-point operations.  When @option{-msoft-float} is specified,
12198 functions in @file{libgcc.a} are used to perform floating-point
12199 operations.  Unless they are replaced by routines that emulate the
12200 floating-point operations, or compiled in such a way as to call such
12201 emulations routines, these routines issue floating-point
12202 operations.   If you are compiling for an Alpha without floating-point
12203 operations, you must ensure that the library is built so as not to call
12204 them.
12206 Note that Alpha implementations without floating-point operations are
12207 required to have floating-point registers.
12209 @item -mfp-reg
12210 @itemx -mno-fp-regs
12211 @opindex mfp-reg
12212 @opindex mno-fp-regs
12213 Generate code that uses (does not use) the floating-point register set.
12214 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
12215 register set is not used, floating-point operands are passed in integer
12216 registers as if they were integers and floating-point results are passed
12217 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
12218 so any function with a floating-point argument or return value called by code
12219 compiled with @option{-mno-fp-regs} must also be compiled with that
12220 option.
12222 A typical use of this option is building a kernel that does not use,
12223 and hence need not save and restore, any floating-point registers.
12225 @item -mieee
12226 @opindex mieee
12227 The Alpha architecture implements floating-point hardware optimized for
12228 maximum performance.  It is mostly compliant with the IEEE floating-point
12229 standard.  However, for full compliance, software assistance is
12230 required.  This option generates code fully IEEE-compliant code
12231 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12232 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12233 defined during compilation.  The resulting code is less efficient but is
12234 able to correctly support denormalized numbers and exceptional IEEE
12235 values such as not-a-number and plus/minus infinity.  Other Alpha
12236 compilers call this option @option{-ieee_with_no_inexact}.
12238 @item -mieee-with-inexact
12239 @opindex mieee-with-inexact
12240 This is like @option{-mieee} except the generated code also maintains
12241 the IEEE @var{inexact-flag}.  Turning on this option causes the
12242 generated code to implement fully-compliant IEEE math.  In addition to
12243 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12244 macro.  On some Alpha implementations the resulting code may execute
12245 significantly slower than the code generated by default.  Since there is
12246 very little code that depends on the @var{inexact-flag}, you should
12247 normally not specify this option.  Other Alpha compilers call this
12248 option @option{-ieee_with_inexact}.
12250 @item -mfp-trap-mode=@var{trap-mode}
12251 @opindex mfp-trap-mode
12252 This option controls what floating-point related traps are enabled.
12253 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12254 The trap mode can be set to one of four values:
12256 @table @samp
12257 @item n
12258 This is the default (normal) setting.  The only traps that are enabled
12259 are the ones that cannot be disabled in software (e.g., division by zero
12260 trap).
12262 @item u
12263 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12264 as well.
12266 @item su
12267 Like @samp{u}, but the instructions are marked to be safe for software
12268 completion (see Alpha architecture manual for details).
12270 @item sui
12271 Like @samp{su}, but inexact traps are enabled as well.
12272 @end table
12274 @item -mfp-rounding-mode=@var{rounding-mode}
12275 @opindex mfp-rounding-mode
12276 Selects the IEEE rounding mode.  Other Alpha compilers call this option
12277 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
12280 @table @samp
12281 @item n
12282 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
12283 the nearest machine number or towards the even machine number in case
12284 of a tie.
12286 @item m
12287 Round towards minus infinity.
12289 @item c
12290 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
12292 @item d
12293 Dynamic rounding mode.  A field in the floating-point control register
12294 (@var{fpcr}, see Alpha architecture reference manual) controls the
12295 rounding mode in effect.  The C library initializes this register for
12296 rounding towards plus infinity.  Thus, unless your program modifies the
12297 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12298 @end table
12300 @item -mtrap-precision=@var{trap-precision}
12301 @opindex mtrap-precision
12302 In the Alpha architecture, floating-point traps are imprecise.  This
12303 means without software assistance it is impossible to recover from a
12304 floating trap and program execution normally needs to be terminated.
12305 GCC can generate code that can assist operating system trap handlers
12306 in determining the exact location that caused a floating-point trap.
12307 Depending on the requirements of an application, different levels of
12308 precisions can be selected:
12310 @table @samp
12311 @item p
12312 Program precision.  This option is the default and means a trap handler
12313 can only identify which program caused a floating-point exception.
12315 @item f
12316 Function precision.  The trap handler can determine the function that
12317 caused a floating-point exception.
12319 @item i
12320 Instruction precision.  The trap handler can determine the exact
12321 instruction that caused a floating-point exception.
12322 @end table
12324 Other Alpha compilers provide the equivalent options called
12325 @option{-scope_safe} and @option{-resumption_safe}.
12327 @item -mieee-conformant
12328 @opindex mieee-conformant
12329 This option marks the generated code as IEEE conformant.  You must not
12330 use this option unless you also specify @option{-mtrap-precision=i} and either
12331 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
12332 is to emit the line @samp{.eflag 48} in the function prologue of the
12333 generated assembly file.
12335 @item -mbuild-constants
12336 @opindex mbuild-constants
12337 Normally GCC examines a 32- or 64-bit integer constant to
12338 see if it can construct it from smaller constants in two or three
12339 instructions.  If it cannot, it outputs the constant as a literal and
12340 generates code to load it from the data segment at run time.
12342 Use this option to require GCC to construct @emph{all} integer constants
12343 using code, even if it takes more instructions (the maximum is six).
12345 You typically use this option to build a shared library dynamic
12346 loader.  Itself a shared library, it must relocate itself in memory
12347 before it can find the variables and constants in its own data segment.
12349 @item -mbwx
12350 @itemx -mno-bwx
12351 @itemx -mcix
12352 @itemx -mno-cix
12353 @itemx -mfix
12354 @itemx -mno-fix
12355 @itemx -mmax
12356 @itemx -mno-max
12357 @opindex mbwx
12358 @opindex mno-bwx
12359 @opindex mcix
12360 @opindex mno-cix
12361 @opindex mfix
12362 @opindex mno-fix
12363 @opindex mmax
12364 @opindex mno-max
12365 Indicate whether GCC should generate code to use the optional BWX,
12366 CIX, FIX and MAX instruction sets.  The default is to use the instruction
12367 sets supported by the CPU type specified via @option{-mcpu=} option or that
12368 of the CPU on which GCC was built if none is specified.
12370 @item -mfloat-vax
12371 @itemx -mfloat-ieee
12372 @opindex mfloat-vax
12373 @opindex mfloat-ieee
12374 Generate code that uses (does not use) VAX F and G floating-point
12375 arithmetic instead of IEEE single and double precision.
12377 @item -mexplicit-relocs
12378 @itemx -mno-explicit-relocs
12379 @opindex mexplicit-relocs
12380 @opindex mno-explicit-relocs
12381 Older Alpha assemblers provided no way to generate symbol relocations
12382 except via assembler macros.  Use of these macros does not allow
12383 optimal instruction scheduling.  GNU binutils as of version 2.12
12384 supports a new syntax that allows the compiler to explicitly mark
12385 which relocations should apply to which instructions.  This option
12386 is mostly useful for debugging, as GCC detects the capabilities of
12387 the assembler when it is built and sets the default accordingly.
12389 @item -msmall-data
12390 @itemx -mlarge-data
12391 @opindex msmall-data
12392 @opindex mlarge-data
12393 When @option{-mexplicit-relocs} is in effect, static data is
12394 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
12395 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
12396 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
12397 16-bit relocations off of the @code{$gp} register.  This limits the
12398 size of the small data area to 64KB, but allows the variables to be
12399 directly accessed via a single instruction.
12401 The default is @option{-mlarge-data}.  With this option the data area
12402 is limited to just below 2GB@.  Programs that require more than 2GB of
12403 data must use @code{malloc} or @code{mmap} to allocate the data in the
12404 heap instead of in the program's data segment.
12406 When generating code for shared libraries, @option{-fpic} implies
12407 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
12409 @item -msmall-text
12410 @itemx -mlarge-text
12411 @opindex msmall-text
12412 @opindex mlarge-text
12413 When @option{-msmall-text} is used, the compiler assumes that the
12414 code of the entire program (or shared library) fits in 4MB, and is
12415 thus reachable with a branch instruction.  When @option{-msmall-data}
12416 is used, the compiler can assume that all local symbols share the
12417 same @code{$gp} value, and thus reduce the number of instructions
12418 required for a function call from 4 to 1.
12420 The default is @option{-mlarge-text}.
12422 @item -mcpu=@var{cpu_type}
12423 @opindex mcpu
12424 Set the instruction set and instruction scheduling parameters for
12425 machine type @var{cpu_type}.  You can specify either the @samp{EV}
12426 style name or the corresponding chip number.  GCC supports scheduling
12427 parameters for the EV4, EV5 and EV6 family of processors and
12428 chooses the default values for the instruction set from the processor
12429 you specify.  If you do not specify a processor type, GCC defaults
12430 to the processor on which the compiler was built.
12432 Supported values for @var{cpu_type} are
12434 @table @samp
12435 @item ev4
12436 @itemx ev45
12437 @itemx 21064
12438 Schedules as an EV4 and has no instruction set extensions.
12440 @item ev5
12441 @itemx 21164
12442 Schedules as an EV5 and has no instruction set extensions.
12444 @item ev56
12445 @itemx 21164a
12446 Schedules as an EV5 and supports the BWX extension.
12448 @item pca56
12449 @itemx 21164pc
12450 @itemx 21164PC
12451 Schedules as an EV5 and supports the BWX and MAX extensions.
12453 @item ev6
12454 @itemx 21264
12455 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12457 @item ev67
12458 @itemx 21264a
12459 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12460 @end table
12462 Native toolchains also support the value @samp{native},
12463 which selects the best architecture option for the host processor.
12464 @option{-mcpu=native} has no effect if GCC does not recognize
12465 the processor.
12467 @item -mtune=@var{cpu_type}
12468 @opindex mtune
12469 Set only the instruction scheduling parameters for machine type
12470 @var{cpu_type}.  The instruction set is not changed.
12472 Native toolchains also support the value @samp{native},
12473 which selects the best architecture option for the host processor.
12474 @option{-mtune=native} has no effect if GCC does not recognize
12475 the processor.
12477 @item -mmemory-latency=@var{time}
12478 @opindex mmemory-latency
12479 Sets the latency the scheduler should assume for typical memory
12480 references as seen by the application.  This number is highly
12481 dependent on the memory access patterns used by the application
12482 and the size of the external cache on the machine.
12484 Valid options for @var{time} are
12486 @table @samp
12487 @item @var{number}
12488 A decimal number representing clock cycles.
12490 @item L1
12491 @itemx L2
12492 @itemx L3
12493 @itemx main
12494 The compiler contains estimates of the number of clock cycles for
12495 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12496 (also called Dcache, Scache, and Bcache), as well as to main memory.
12497 Note that L3 is only valid for EV5.
12499 @end table
12500 @end table
12502 @node FR30 Options
12503 @subsection FR30 Options
12504 @cindex FR30 Options
12506 These options are defined specifically for the FR30 port.
12508 @table @gcctabopt
12510 @item -msmall-model
12511 @opindex msmall-model
12512 Use the small address space model.  This can produce smaller code, but
12513 it does assume that all symbolic values and addresses fit into a
12514 20-bit range.
12516 @item -mno-lsim
12517 @opindex mno-lsim
12518 Assume that runtime support has been provided and so there is no need
12519 to include the simulator library (@file{libsim.a}) on the linker
12520 command line.
12522 @end table
12524 @node FRV Options
12525 @subsection FRV Options
12526 @cindex FRV Options
12528 @table @gcctabopt
12529 @item -mgpr-32
12530 @opindex mgpr-32
12532 Only use the first 32 general-purpose registers.
12534 @item -mgpr-64
12535 @opindex mgpr-64
12537 Use all 64 general-purpose registers.
12539 @item -mfpr-32
12540 @opindex mfpr-32
12542 Use only the first 32 floating-point registers.
12544 @item -mfpr-64
12545 @opindex mfpr-64
12547 Use all 64 floating-point registers.
12549 @item -mhard-float
12550 @opindex mhard-float
12552 Use hardware instructions for floating-point operations.
12554 @item -msoft-float
12555 @opindex msoft-float
12557 Use library routines for floating-point operations.
12559 @item -malloc-cc
12560 @opindex malloc-cc
12562 Dynamically allocate condition code registers.
12564 @item -mfixed-cc
12565 @opindex mfixed-cc
12567 Do not try to dynamically allocate condition code registers, only
12568 use @code{icc0} and @code{fcc0}.
12570 @item -mdword
12571 @opindex mdword
12573 Change ABI to use double word insns.
12575 @item -mno-dword
12576 @opindex mno-dword
12578 Do not use double word instructions.
12580 @item -mdouble
12581 @opindex mdouble
12583 Use floating-point double instructions.
12585 @item -mno-double
12586 @opindex mno-double
12588 Do not use floating-point double instructions.
12590 @item -mmedia
12591 @opindex mmedia
12593 Use media instructions.
12595 @item -mno-media
12596 @opindex mno-media
12598 Do not use media instructions.
12600 @item -mmuladd
12601 @opindex mmuladd
12603 Use multiply and add/subtract instructions.
12605 @item -mno-muladd
12606 @opindex mno-muladd
12608 Do not use multiply and add/subtract instructions.
12610 @item -mfdpic
12611 @opindex mfdpic
12613 Select the FDPIC ABI, which uses function descriptors to represent
12614 pointers to functions.  Without any PIC/PIE-related options, it
12615 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
12616 assumes GOT entries and small data are within a 12-bit range from the
12617 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
12618 are computed with 32 bits.
12619 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12621 @item -minline-plt
12622 @opindex minline-plt
12624 Enable inlining of PLT entries in function calls to functions that are
12625 not known to bind locally.  It has no effect without @option{-mfdpic}.
12626 It's enabled by default if optimizing for speed and compiling for
12627 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
12628 optimization option such as @option{-O3} or above is present in the
12629 command line.
12631 @item -mTLS
12632 @opindex mTLS
12634 Assume a large TLS segment when generating thread-local code.
12636 @item -mtls
12637 @opindex mtls
12639 Do not assume a large TLS segment when generating thread-local code.
12641 @item -mgprel-ro
12642 @opindex mgprel-ro
12644 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
12645 that is known to be in read-only sections.  It's enabled by default,
12646 except for @option{-fpic} or @option{-fpie}: even though it may help
12647 make the global offset table smaller, it trades 1 instruction for 4.
12648 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
12649 one of which may be shared by multiple symbols, and it avoids the need
12650 for a GOT entry for the referenced symbol, so it's more likely to be a
12651 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
12653 @item -multilib-library-pic
12654 @opindex multilib-library-pic
12656 Link with the (library, not FD) pic libraries.  It's implied by
12657 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
12658 @option{-fpic} without @option{-mfdpic}.  You should never have to use
12659 it explicitly.
12661 @item -mlinked-fp
12662 @opindex mlinked-fp
12664 Follow the EABI requirement of always creating a frame pointer whenever
12665 a stack frame is allocated.  This option is enabled by default and can
12666 be disabled with @option{-mno-linked-fp}.
12668 @item -mlong-calls
12669 @opindex mlong-calls
12671 Use indirect addressing to call functions outside the current
12672 compilation unit.  This allows the functions to be placed anywhere
12673 within the 32-bit address space.
12675 @item -malign-labels
12676 @opindex malign-labels
12678 Try to align labels to an 8-byte boundary by inserting nops into the
12679 previous packet.  This option only has an effect when VLIW packing
12680 is enabled.  It doesn't create new packets; it merely adds nops to
12681 existing ones.
12683 @item -mlibrary-pic
12684 @opindex mlibrary-pic
12686 Generate position-independent EABI code.
12688 @item -macc-4
12689 @opindex macc-4
12691 Use only the first four media accumulator registers.
12693 @item -macc-8
12694 @opindex macc-8
12696 Use all eight media accumulator registers.
12698 @item -mpack
12699 @opindex mpack
12701 Pack VLIW instructions.
12703 @item -mno-pack
12704 @opindex mno-pack
12706 Do not pack VLIW instructions.
12708 @item -mno-eflags
12709 @opindex mno-eflags
12711 Do not mark ABI switches in e_flags.
12713 @item -mcond-move
12714 @opindex mcond-move
12716 Enable the use of conditional-move instructions (default).
12718 This switch is mainly for debugging the compiler and will likely be removed
12719 in a future version.
12721 @item -mno-cond-move
12722 @opindex mno-cond-move
12724 Disable the use of conditional-move instructions.
12726 This switch is mainly for debugging the compiler and will likely be removed
12727 in a future version.
12729 @item -mscc
12730 @opindex mscc
12732 Enable the use of conditional set instructions (default).
12734 This switch is mainly for debugging the compiler and will likely be removed
12735 in a future version.
12737 @item -mno-scc
12738 @opindex mno-scc
12740 Disable the use of conditional set instructions.
12742 This switch is mainly for debugging the compiler and will likely be removed
12743 in a future version.
12745 @item -mcond-exec
12746 @opindex mcond-exec
12748 Enable the use of conditional execution (default).
12750 This switch is mainly for debugging the compiler and will likely be removed
12751 in a future version.
12753 @item -mno-cond-exec
12754 @opindex mno-cond-exec
12756 Disable the use of conditional execution.
12758 This switch is mainly for debugging the compiler and will likely be removed
12759 in a future version.
12761 @item -mvliw-branch
12762 @opindex mvliw-branch
12764 Run a pass to pack branches into VLIW instructions (default).
12766 This switch is mainly for debugging the compiler and will likely be removed
12767 in a future version.
12769 @item -mno-vliw-branch
12770 @opindex mno-vliw-branch
12772 Do not run a pass to pack branches into VLIW instructions.
12774 This switch is mainly for debugging the compiler and will likely be removed
12775 in a future version.
12777 @item -mmulti-cond-exec
12778 @opindex mmulti-cond-exec
12780 Enable optimization of @code{&&} and @code{||} in conditional execution
12781 (default).
12783 This switch is mainly for debugging the compiler and will likely be removed
12784 in a future version.
12786 @item -mno-multi-cond-exec
12787 @opindex mno-multi-cond-exec
12789 Disable optimization of @code{&&} and @code{||} in conditional execution.
12791 This switch is mainly for debugging the compiler and will likely be removed
12792 in a future version.
12794 @item -mnested-cond-exec
12795 @opindex mnested-cond-exec
12797 Enable nested conditional execution optimizations (default).
12799 This switch is mainly for debugging the compiler and will likely be removed
12800 in a future version.
12802 @item -mno-nested-cond-exec
12803 @opindex mno-nested-cond-exec
12805 Disable nested conditional execution optimizations.
12807 This switch is mainly for debugging the compiler and will likely be removed
12808 in a future version.
12810 @item -moptimize-membar
12811 @opindex moptimize-membar
12813 This switch removes redundant @code{membar} instructions from the
12814 compiler generated code.  It is enabled by default.
12816 @item -mno-optimize-membar
12817 @opindex mno-optimize-membar
12819 This switch disables the automatic removal of redundant @code{membar}
12820 instructions from the generated code.
12822 @item -mtomcat-stats
12823 @opindex mtomcat-stats
12825 Cause gas to print out tomcat statistics.
12827 @item -mcpu=@var{cpu}
12828 @opindex mcpu
12830 Select the processor type for which to generate code.  Possible values are
12831 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
12832 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
12834 @end table
12836 @node GNU/Linux Options
12837 @subsection GNU/Linux Options
12839 These @samp{-m} options are defined for GNU/Linux targets:
12841 @table @gcctabopt
12842 @item -mglibc
12843 @opindex mglibc
12844 Use the GNU C library.  This is the default except
12845 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
12847 @item -muclibc
12848 @opindex muclibc
12849 Use uClibc C library.  This is the default on
12850 @samp{*-*-linux-*uclibc*} targets.
12852 @item -mbionic
12853 @opindex mbionic
12854 Use Bionic C library.  This is the default on
12855 @samp{*-*-linux-*android*} targets.
12857 @item -mandroid
12858 @opindex mandroid
12859 Compile code compatible with Android platform.  This is the default on
12860 @samp{*-*-linux-*android*} targets.
12862 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
12863 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
12864 this option makes the GCC driver pass Android-specific options to the linker.
12865 Finally, this option causes the preprocessor macro @code{__ANDROID__}
12866 to be defined.
12868 @item -tno-android-cc
12869 @opindex tno-android-cc
12870 Disable compilation effects of @option{-mandroid}, i.e., do not enable
12871 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
12872 @option{-fno-rtti} by default.
12874 @item -tno-android-ld
12875 @opindex tno-android-ld
12876 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
12877 linking options to the linker.
12879 @end table
12881 @node H8/300 Options
12882 @subsection H8/300 Options
12884 These @samp{-m} options are defined for the H8/300 implementations:
12886 @table @gcctabopt
12887 @item -mrelax
12888 @opindex mrelax
12889 Shorten some address references at link time, when possible; uses the
12890 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
12891 ld, Using ld}, for a fuller description.
12893 @item -mh
12894 @opindex mh
12895 Generate code for the H8/300H@.
12897 @item -ms
12898 @opindex ms
12899 Generate code for the H8S@.
12901 @item -mn
12902 @opindex mn
12903 Generate code for the H8S and H8/300H in the normal mode.  This switch
12904 must be used either with @option{-mh} or @option{-ms}.
12906 @item -ms2600
12907 @opindex ms2600
12908 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
12910 @item -mexr
12911 @opindex mexr
12912 Extended registers are stored on stack before execution of function
12913 with monitor attribute. Default option is @option{-mexr}.
12914 This option is valid only for H8S targets.
12916 @item -mno-exr
12917 @opindex mno-exr
12918 Extended registers are not stored on stack before execution of function 
12919 with monitor attribute. Default option is @option{-mno-exr}. 
12920 This option is valid only for H8S targets.
12922 @item -mint32
12923 @opindex mint32
12924 Make @code{int} data 32 bits by default.
12926 @item -malign-300
12927 @opindex malign-300
12928 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
12929 The default for the H8/300H and H8S is to align longs and floats on
12930 4-byte boundaries.
12931 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
12932 This option has no effect on the H8/300.
12933 @end table
12935 @node HPPA Options
12936 @subsection HPPA Options
12937 @cindex HPPA Options
12939 These @samp{-m} options are defined for the HPPA family of computers:
12941 @table @gcctabopt
12942 @item -march=@var{architecture-type}
12943 @opindex march
12944 Generate code for the specified architecture.  The choices for
12945 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
12946 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
12947 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
12948 architecture option for your machine.  Code compiled for lower numbered
12949 architectures runs on higher numbered architectures, but not the
12950 other way around.
12952 @item -mpa-risc-1-0
12953 @itemx -mpa-risc-1-1
12954 @itemx -mpa-risc-2-0
12955 @opindex mpa-risc-1-0
12956 @opindex mpa-risc-1-1
12957 @opindex mpa-risc-2-0
12958 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
12960 @item -mbig-switch
12961 @opindex mbig-switch
12962 Generate code suitable for big switch tables.  Use this option only if
12963 the assembler/linker complain about out of range branches within a switch
12964 table.
12966 @item -mjump-in-delay
12967 @opindex mjump-in-delay
12968 Fill delay slots of function calls with unconditional jump instructions
12969 by modifying the return pointer for the function call to be the target
12970 of the conditional jump.
12972 @item -mdisable-fpregs
12973 @opindex mdisable-fpregs
12974 Prevent floating-point registers from being used in any manner.  This is
12975 necessary for compiling kernels that perform lazy context switching of
12976 floating-point registers.  If you use this option and attempt to perform
12977 floating-point operations, the compiler aborts.
12979 @item -mdisable-indexing
12980 @opindex mdisable-indexing
12981 Prevent the compiler from using indexing address modes.  This avoids some
12982 rather obscure problems when compiling MIG generated code under MACH@.
12984 @item -mno-space-regs
12985 @opindex mno-space-regs
12986 Generate code that assumes the target has no space registers.  This allows
12987 GCC to generate faster indirect calls and use unscaled index address modes.
12989 Such code is suitable for level 0 PA systems and kernels.
12991 @item -mfast-indirect-calls
12992 @opindex mfast-indirect-calls
12993 Generate code that assumes calls never cross space boundaries.  This
12994 allows GCC to emit code that performs faster indirect calls.
12996 This option does not work in the presence of shared libraries or nested
12997 functions.
12999 @item -mfixed-range=@var{register-range}
13000 @opindex mfixed-range
13001 Generate code treating the given register range as fixed registers.
13002 A fixed register is one that the register allocator can not use.  This is
13003 useful when compiling kernel code.  A register range is specified as
13004 two registers separated by a dash.  Multiple register ranges can be
13005 specified separated by a comma.
13007 @item -mlong-load-store
13008 @opindex mlong-load-store
13009 Generate 3-instruction load and store sequences as sometimes required by
13010 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
13011 the HP compilers.
13013 @item -mportable-runtime
13014 @opindex mportable-runtime
13015 Use the portable calling conventions proposed by HP for ELF systems.
13017 @item -mgas
13018 @opindex mgas
13019 Enable the use of assembler directives only GAS understands.
13021 @item -mschedule=@var{cpu-type}
13022 @opindex mschedule
13023 Schedule code according to the constraints for the machine type
13024 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
13025 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
13026 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
13027 proper scheduling option for your machine.  The default scheduling is
13028 @samp{8000}.
13030 @item -mlinker-opt
13031 @opindex mlinker-opt
13032 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
13033 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
13034 linkers in which they give bogus error messages when linking some programs.
13036 @item -msoft-float
13037 @opindex msoft-float
13038 Generate output containing library calls for floating point.
13039 @strong{Warning:} the requisite libraries are not available for all HPPA
13040 targets.  Normally the facilities of the machine's usual C compiler are
13041 used, but this cannot be done directly in cross-compilation.  You must make
13042 your own arrangements to provide suitable library functions for
13043 cross-compilation.
13045 @option{-msoft-float} changes the calling convention in the output file;
13046 therefore, it is only useful if you compile @emph{all} of a program with
13047 this option.  In particular, you need to compile @file{libgcc.a}, the
13048 library that comes with GCC, with @option{-msoft-float} in order for
13049 this to work.
13051 @item -msio
13052 @opindex msio
13053 Generate the predefine, @code{_SIO}, for server IO@.  The default is
13054 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
13055 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
13056 options are available under HP-UX and HI-UX@.
13058 @item -mgnu-ld
13059 @opindex mgnu-ld
13060 Use options specific to GNU @command{ld}.
13061 This passes @option{-shared} to @command{ld} when
13062 building a shared library.  It is the default when GCC is configured,
13063 explicitly or implicitly, with the GNU linker.  This option does not
13064 affect which @command{ld} is called; it only changes what parameters
13065 are passed to that @command{ld}.
13066 The @command{ld} that is called is determined by the
13067 @option{--with-ld} configure option, GCC's program search path, and
13068 finally by the user's @env{PATH}.  The linker used by GCC can be printed
13069 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
13070 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13072 @item -mhp-ld
13073 @opindex mhp-ld
13074 Use options specific to HP @command{ld}.
13075 This passes @option{-b} to @command{ld} when building
13076 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
13077 links.  It is the default when GCC is configured, explicitly or
13078 implicitly, with the HP linker.  This option does not affect
13079 which @command{ld} is called; it only changes what parameters are passed to that
13080 @command{ld}.
13081 The @command{ld} that is called is determined by the @option{--with-ld}
13082 configure option, GCC's program search path, and finally by the user's
13083 @env{PATH}.  The linker used by GCC can be printed using @samp{which
13084 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
13085 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13087 @item -mlong-calls
13088 @opindex mno-long-calls
13089 Generate code that uses long call sequences.  This ensures that a call
13090 is always able to reach linker generated stubs.  The default is to generate
13091 long calls only when the distance from the call site to the beginning
13092 of the function or translation unit, as the case may be, exceeds a
13093 predefined limit set by the branch type being used.  The limits for
13094 normal calls are 7,600,000 and 240,000 bytes, respectively for the
13095 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
13096 240,000 bytes.
13098 Distances are measured from the beginning of functions when using the
13099 @option{-ffunction-sections} option, or when using the @option{-mgas}
13100 and @option{-mno-portable-runtime} options together under HP-UX with
13101 the SOM linker.
13103 It is normally not desirable to use this option as it degrades
13104 performance.  However, it may be useful in large applications,
13105 particularly when partial linking is used to build the application.
13107 The types of long calls used depends on the capabilities of the
13108 assembler and linker, and the type of code being generated.  The
13109 impact on systems that support long absolute calls, and long pic
13110 symbol-difference or pc-relative calls should be relatively small.
13111 However, an indirect call is used on 32-bit ELF systems in pic code
13112 and it is quite long.
13114 @item -munix=@var{unix-std}
13115 @opindex march
13116 Generate compiler predefines and select a startfile for the specified
13117 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
13118 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
13119 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
13120 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
13121 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13122 and later.
13124 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13125 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13126 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13127 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13128 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13129 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13131 It is @emph{important} to note that this option changes the interfaces
13132 for various library routines.  It also affects the operational behavior
13133 of the C library.  Thus, @emph{extreme} care is needed in using this
13134 option.
13136 Library code that is intended to operate with more than one UNIX
13137 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13138 as appropriate.  Most GNU software doesn't provide this capability.
13140 @item -nolibdld
13141 @opindex nolibdld
13142 Suppress the generation of link options to search libdld.sl when the
13143 @option{-static} option is specified on HP-UX 10 and later.
13145 @item -static
13146 @opindex static
13147 The HP-UX implementation of setlocale in libc has a dependency on
13148 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
13149 when the @option{-static} option is specified, special link options
13150 are needed to resolve this dependency.
13152 On HP-UX 10 and later, the GCC driver adds the necessary options to
13153 link with libdld.sl when the @option{-static} option is specified.
13154 This causes the resulting binary to be dynamic.  On the 64-bit port,
13155 the linkers generate dynamic binaries by default in any case.  The
13156 @option{-nolibdld} option can be used to prevent the GCC driver from
13157 adding these link options.
13159 @item -threads
13160 @opindex threads
13161 Add support for multithreading with the @dfn{dce thread} library
13162 under HP-UX@.  This option sets flags for both the preprocessor and
13163 linker.
13164 @end table
13166 @node i386 and x86-64 Options
13167 @subsection Intel 386 and AMD x86-64 Options
13168 @cindex i386 Options
13169 @cindex x86-64 Options
13170 @cindex Intel 386 Options
13171 @cindex AMD x86-64 Options
13173 These @samp{-m} options are defined for the i386 and x86-64 family of
13174 computers:
13176 @table @gcctabopt
13178 @item -march=@var{cpu-type}
13179 @opindex march
13180 Generate instructions for the machine type @var{cpu-type}.  In contrast to
13181 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
13182 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13183 to generate code that may not run at all on processors other than the one
13184 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
13185 @option{-mtune=@var{cpu-type}}.
13187 The choices for @var{cpu-type} are:
13189 @table @samp
13190 @item native
13191 This selects the CPU to generate code for at compilation time by determining
13192 the processor type of the compiling machine.  Using @option{-march=native}
13193 enables all instruction subsets supported by the local machine (hence
13194 the result might not run on different machines).  Using @option{-mtune=native}
13195 produces code optimized for the local machine under the constraints
13196 of the selected instruction set.  
13198 @item i386
13199 Original Intel i386 CPU@.
13201 @item i486
13202 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
13204 @item i586
13205 @itemx pentium
13206 Intel Pentium CPU with no MMX support.
13208 @item pentium-mmx
13209 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13211 @item pentiumpro
13212 Intel Pentium Pro CPU@.
13214 @item i686
13215 When used with @option{-march}, the Pentium Pro
13216 instruction set is used, so the code runs on all i686 family chips.
13217 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13219 @item pentium2
13220 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13221 support.
13223 @item pentium3
13224 @itemx pentium3m
13225 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13226 set support.
13228 @item pentium-m
13229 Intel Pentium M; low-power version of Intel Pentium III CPU
13230 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
13232 @item pentium4
13233 @itemx pentium4m
13234 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13236 @item prescott
13237 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13238 set support.
13240 @item nocona
13241 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13242 SSE2 and SSE3 instruction set support.
13244 @item core2
13245 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13246 instruction set support.
13248 @item corei7
13249 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13250 and SSE4.2 instruction set support.
13252 @item corei7-avx
13253 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13254 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13256 @item core-avx-i
13257 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13258 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13259 set support.
13261 @item atom
13262 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13263 instruction set support.
13265 @item k6
13266 AMD K6 CPU with MMX instruction set support.
13268 @item k6-2
13269 @itemx k6-3
13270 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13272 @item athlon
13273 @itemx athlon-tbird
13274 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13275 support.
13277 @item athlon-4
13278 @itemx athlon-xp
13279 @itemx athlon-mp
13280 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13281 instruction set support.
13283 @item k8
13284 @itemx opteron
13285 @itemx athlon64
13286 @itemx athlon-fx
13287 Processors based on the AMD K8 core with x86-64 instruction set support,
13288 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13289 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13290 instruction set extensions.)
13292 @item k8-sse3
13293 @itemx opteron-sse3
13294 @itemx athlon64-sse3
13295 Improved versions of AMD K8 cores with SSE3 instruction set support.
13297 @item amdfam10
13298 @itemx barcelona
13299 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
13300 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13301 instruction set extensions.)
13303 @item bdver1
13304 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
13305 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13306 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13307 @item bdver2
13308 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13309 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13310 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13311 extensions.)
13313 @item btver1
13314 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
13315 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13316 instruction set extensions.)
13318 @item winchip-c6
13319 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13320 set support.
13322 @item winchip2
13323 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13324 instruction set support.
13326 @item c3
13327 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
13328 implemented for this chip.)
13330 @item c3-2
13331 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13332 (No scheduling is
13333 implemented for this chip.)
13335 @item geode
13336 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
13337 @end table
13339 @item -mtune=@var{cpu-type}
13340 @opindex mtune
13341 Tune to @var{cpu-type} everything applicable about the generated code, except
13342 for the ABI and the set of available instructions.  
13343 While picking a specific @var{cpu-type} schedules things appropriately
13344 for that particular chip, the compiler does not generate any code that
13345 cannot run on the default machine type unless you use a
13346 @option{-march=@var{cpu-type}} option.
13347 For example, if GCC is configured for i686-pc-linux-gnu
13348 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
13349 but still runs on i686 machines.
13351 The choices for @var{cpu-type} are the same as for @option{-march}.
13352 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
13354 @table @samp
13355 @item generic
13356 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
13357 If you know the CPU on which your code will run, then you should use
13358 the corresponding @option{-mtune} or @option{-march} option instead of
13359 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
13360 of your application will have, then you should use this option.
13362 As new processors are deployed in the marketplace, the behavior of this
13363 option will change.  Therefore, if you upgrade to a newer version of
13364 GCC, code generation controlled by this option will change to reflect
13365 the processors
13366 that are most common at the time that version of GCC is released.
13368 There is no @option{-march=generic} option because @option{-march}
13369 indicates the instruction set the compiler can use, and there is no
13370 generic instruction set applicable to all processors.  In contrast,
13371 @option{-mtune} indicates the processor (or, in this case, collection of
13372 processors) for which the code is optimized.
13373 @end table
13375 @item -mcpu=@var{cpu-type}
13376 @opindex mcpu
13377 A deprecated synonym for @option{-mtune}.
13379 @item -mfpmath=@var{unit}
13380 @opindex mfpmath
13381 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
13382 for @var{unit} are:
13384 @table @samp
13385 @item 387
13386 Use the standard 387 floating-point coprocessor present on the majority of chips and
13387 emulated otherwise.  Code compiled with this option runs almost everywhere.
13388 The temporary results are computed in 80-bit precision instead of the precision
13389 specified by the type, resulting in slightly different results compared to most
13390 of other chips.  See @option{-ffloat-store} for more detailed description.
13392 This is the default choice for i386 compiler.
13394 @item sse
13395 Use scalar floating-point instructions present in the SSE instruction set.
13396 This instruction set is supported by Pentium III and newer chips,
13397 and in the AMD line
13398 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
13399 instruction set supports only single-precision arithmetic, thus the double and
13400 extended-precision arithmetic are still done using 387.  A later version, present
13401 only in Pentium 4 and AMD x86-64 chips, supports double-precision
13402 arithmetic too.
13404 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
13405 or @option{-msse2} switches to enable SSE extensions and make this option
13406 effective.  For the x86-64 compiler, these extensions are enabled by default.
13408 The resulting code should be considerably faster in the majority of cases and avoid
13409 the numerical instability problems of 387 code, but may break some existing
13410 code that expects temporaries to be 80 bits.
13412 This is the default choice for the x86-64 compiler.
13414 @item sse,387
13415 @itemx sse+387
13416 @itemx both
13417 Attempt to utilize both instruction sets at once.  This effectively doubles the
13418 amount of available registers, and on chips with separate execution units for
13419 387 and SSE the execution resources too.  Use this option with care, as it is
13420 still experimental, because the GCC register allocator does not model separate
13421 functional units well, resulting in unstable performance.
13422 @end table
13424 @item -masm=@var{dialect}
13425 @opindex masm=@var{dialect}
13426 Output assembly instructions using selected @var{dialect}.  Supported
13427 choices are @samp{intel} or @samp{att} (the default).  Darwin does
13428 not support @samp{intel}.
13430 @item -mieee-fp
13431 @itemx -mno-ieee-fp
13432 @opindex mieee-fp
13433 @opindex mno-ieee-fp
13434 Control whether or not the compiler uses IEEE floating-point
13435 comparisons.  These correctly handle the case where the result of a
13436 comparison is unordered.
13438 @item -msoft-float
13439 @opindex msoft-float
13440 Generate output containing library calls for floating point.
13442 @strong{Warning:} the requisite libraries are not part of GCC@.
13443 Normally the facilities of the machine's usual C compiler are used, but
13444 this can't be done directly in cross-compilation.  You must make your
13445 own arrangements to provide suitable library functions for
13446 cross-compilation.
13448 On machines where a function returns floating-point results in the 80387
13449 register stack, some floating-point opcodes may be emitted even if
13450 @option{-msoft-float} is used.
13452 @item -mno-fp-ret-in-387
13453 @opindex mno-fp-ret-in-387
13454 Do not use the FPU registers for return values of functions.
13456 The usual calling convention has functions return values of types
13457 @code{float} and @code{double} in an FPU register, even if there
13458 is no FPU@.  The idea is that the operating system should emulate
13459 an FPU@.
13461 The option @option{-mno-fp-ret-in-387} causes such values to be returned
13462 in ordinary CPU registers instead.
13464 @item -mno-fancy-math-387
13465 @opindex mno-fancy-math-387
13466 Some 387 emulators do not support the @code{sin}, @code{cos} and
13467 @code{sqrt} instructions for the 387.  Specify this option to avoid
13468 generating those instructions.  This option is the default on FreeBSD,
13469 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
13470 indicates that the target CPU always has an FPU and so the
13471 instruction does not need emulation.  These
13472 instructions are not generated unless you also use the
13473 @option{-funsafe-math-optimizations} switch.
13475 @item -malign-double
13476 @itemx -mno-align-double
13477 @opindex malign-double
13478 @opindex mno-align-double
13479 Control whether GCC aligns @code{double}, @code{long double}, and
13480 @code{long long} variables on a two-word boundary or a one-word
13481 boundary.  Aligning @code{double} variables on a two-word boundary
13482 produces code that runs somewhat faster on a Pentium at the
13483 expense of more memory.
13485 On x86-64, @option{-malign-double} is enabled by default.
13487 @strong{Warning:} if you use the @option{-malign-double} switch,
13488 structures containing the above types are aligned differently than
13489 the published application binary interface specifications for the 386
13490 and are not binary compatible with structures in code compiled
13491 without that switch.
13493 @item -m96bit-long-double
13494 @itemx -m128bit-long-double
13495 @opindex m96bit-long-double
13496 @opindex m128bit-long-double
13497 These switches control the size of @code{long double} type.  The i386
13498 application binary interface specifies the size to be 96 bits,
13499 so @option{-m96bit-long-double} is the default in 32-bit mode.
13501 Modern architectures (Pentium and newer) prefer @code{long double}
13502 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
13503 conforming to the ABI, this is not possible.  So specifying
13504 @option{-m128bit-long-double} aligns @code{long double}
13505 to a 16-byte boundary by padding the @code{long double} with an additional
13506 32-bit zero.
13508 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
13509 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
13511 Notice that neither of these options enable any extra precision over the x87
13512 standard of 80 bits for a @code{long double}.
13514 @strong{Warning:} if you override the default value for your target ABI, this
13515 changes the size of 
13516 structures and arrays containing @code{long double} variables,
13517 as well as modifying the function calling convention for functions taking
13518 @code{long double}.  Hence they are not binary-compatible
13519 with code compiled without that switch.
13521 @item -mlarge-data-threshold=@var{threshold}
13522 @opindex mlarge-data-threshold
13523 When @option{-mcmodel=medium} is specified, data objects larger than
13524 @var{threshold} are placed in the large data section.  This value must be the
13525 same across all objects linked into the binary, and defaults to 65535.
13527 @item -mrtd
13528 @opindex mrtd
13529 Use a different function-calling convention, in which functions that
13530 take a fixed number of arguments return with the @code{ret @var{num}}
13531 instruction, which pops their arguments while returning.  This saves one
13532 instruction in the caller since there is no need to pop the arguments
13533 there.
13535 You can specify that an individual function is called with this calling
13536 sequence with the function attribute @samp{stdcall}.  You can also
13537 override the @option{-mrtd} option by using the function attribute
13538 @samp{cdecl}.  @xref{Function Attributes}.
13540 @strong{Warning:} this calling convention is incompatible with the one
13541 normally used on Unix, so you cannot use it if you need to call
13542 libraries compiled with the Unix compiler.
13544 Also, you must provide function prototypes for all functions that
13545 take variable numbers of arguments (including @code{printf});
13546 otherwise incorrect code is generated for calls to those
13547 functions.
13549 In addition, seriously incorrect code results if you call a
13550 function with too many arguments.  (Normally, extra arguments are
13551 harmlessly ignored.)
13553 @item -mregparm=@var{num}
13554 @opindex mregparm
13555 Control how many registers are used to pass integer arguments.  By
13556 default, no registers are used to pass arguments, and at most 3
13557 registers can be used.  You can control this behavior for a specific
13558 function by using the function attribute @samp{regparm}.
13559 @xref{Function Attributes}.
13561 @strong{Warning:} if you use this switch, and
13562 @var{num} is nonzero, then you must build all modules with the same
13563 value, including any libraries.  This includes the system libraries and
13564 startup modules.
13566 @item -msseregparm
13567 @opindex msseregparm
13568 Use SSE register passing conventions for float and double arguments
13569 and return values.  You can control this behavior for a specific
13570 function by using the function attribute @samp{sseregparm}.
13571 @xref{Function Attributes}.
13573 @strong{Warning:} if you use this switch then you must build all
13574 modules with the same value, including any libraries.  This includes
13575 the system libraries and startup modules.
13577 @item -mvect8-ret-in-mem
13578 @opindex mvect8-ret-in-mem
13579 Return 8-byte vectors in memory instead of MMX registers.  This is the
13580 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
13581 Studio compilers until version 12.  Later compiler versions (starting
13582 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
13583 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
13584 you need to remain compatible with existing code produced by those
13585 previous compiler versions or older versions of GCC@.
13587 @item -mpc32
13588 @itemx -mpc64
13589 @itemx -mpc80
13590 @opindex mpc32
13591 @opindex mpc64
13592 @opindex mpc80
13594 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
13595 is specified, the significands of results of floating-point operations are
13596 rounded to 24 bits (single precision); @option{-mpc64} rounds the
13597 significands of results of floating-point operations to 53 bits (double
13598 precision) and @option{-mpc80} rounds the significands of results of
13599 floating-point operations to 64 bits (extended double precision), which is
13600 the default.  When this option is used, floating-point operations in higher
13601 precisions are not available to the programmer without setting the FPU
13602 control word explicitly.
13604 Setting the rounding of floating-point operations to less than the default
13605 80 bits can speed some programs by 2% or more.  Note that some mathematical
13606 libraries assume that extended-precision (80-bit) floating-point operations
13607 are enabled by default; routines in such libraries could suffer significant
13608 loss of accuracy, typically through so-called ``catastrophic cancellation'',
13609 when this option is used to set the precision to less than extended precision.
13611 @item -mstackrealign
13612 @opindex mstackrealign
13613 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
13614 option generates an alternate prologue and epilogue that realigns the
13615 run-time stack if necessary.  This supports mixing legacy codes that keep
13616 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
13617 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
13618 applicable to individual functions.
13620 @item -mpreferred-stack-boundary=@var{num}
13621 @opindex mpreferred-stack-boundary
13622 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
13623 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
13624 the default is 4 (16 bytes or 128 bits).
13626 @strong{Warning:} When generating code for the x86-64 architecture with
13627 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
13628 used to keep the stack boundary aligned to 8 byte boundary.  Since
13629 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
13630 intended to be used in controlled environment where stack space is
13631 important limitation.  This option will lead to wrong code when functions
13632 compiled with 16 byte stack alignment (such as functions from a standard
13633 library) are called with misaligned stack.  In this case, SSE
13634 instructions may lead to misaligned memory access traps.  In addition,
13635 variable arguments will be handled incorrectly for 16 byte aligned
13636 objects (including x87 long double and __int128), leading to wrong
13637 results.  You must build all modules with
13638 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
13639 includes the system libraries and startup modules.
13641 @item -mincoming-stack-boundary=@var{num}
13642 @opindex mincoming-stack-boundary
13643 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
13644 boundary.  If @option{-mincoming-stack-boundary} is not specified,
13645 the one specified by @option{-mpreferred-stack-boundary} is used.
13647 On Pentium and Pentium Pro, @code{double} and @code{long double} values
13648 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
13649 suffer significant run time performance penalties.  On Pentium III, the
13650 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
13651 properly if it is not 16-byte aligned.
13653 To ensure proper alignment of this values on the stack, the stack boundary
13654 must be as aligned as that required by any value stored on the stack.
13655 Further, every function must be generated such that it keeps the stack
13656 aligned.  Thus calling a function compiled with a higher preferred
13657 stack boundary from a function compiled with a lower preferred stack
13658 boundary most likely misaligns the stack.  It is recommended that
13659 libraries that use callbacks always use the default setting.
13661 This extra alignment does consume extra stack space, and generally
13662 increases code size.  Code that is sensitive to stack space usage, such
13663 as embedded systems and operating system kernels, may want to reduce the
13664 preferred alignment to @option{-mpreferred-stack-boundary=2}.
13666 @item -mmmx
13667 @itemx -mno-mmx
13668 @itemx -msse
13669 @itemx -mno-sse
13670 @itemx -msse2
13671 @itemx -mno-sse2
13672 @itemx -msse3
13673 @itemx -mno-sse3
13674 @itemx -mssse3
13675 @itemx -mno-ssse3
13676 @itemx -msse4.1
13677 @need 800
13678 @itemx -mno-sse4.1
13679 @itemx -msse4.2
13680 @itemx -mno-sse4.2
13681 @itemx -msse4
13682 @itemx -mno-sse4
13683 @itemx -mavx
13684 @itemx -mno-avx
13685 @itemx -mavx2
13686 @itemx -mno-avx2
13687 @itemx -maes
13688 @itemx -mno-aes
13689 @itemx -mpclmul
13690 @need 800
13691 @itemx -mno-pclmul
13692 @itemx -mfsgsbase
13693 @itemx -mno-fsgsbase
13694 @itemx -mrdrnd
13695 @itemx -mno-rdrnd
13696 @itemx -mf16c
13697 @itemx -mno-f16c
13698 @itemx -mfma
13699 @itemx -mno-fma
13700 @itemx -msse4a
13701 @itemx -mno-sse4a
13702 @itemx -mfma4
13703 @need 800
13704 @itemx -mno-fma4
13705 @itemx -mxop
13706 @itemx -mno-xop
13707 @itemx -mlwp
13708 @itemx -mno-lwp
13709 @itemx -m3dnow
13710 @itemx -mno-3dnow
13711 @itemx -mpopcnt
13712 @itemx -mno-popcnt
13713 @itemx -mabm
13714 @itemx -mno-abm
13715 @itemx -mbmi
13716 @itemx -mbmi2
13717 @itemx -mno-bmi
13718 @itemx -mno-bmi2
13719 @itemx -mlzcnt
13720 @itemx -mno-lzcnt
13721 @itemx -mrtm
13722 @itemx -mtbm
13723 @itemx -mno-tbm
13724 @opindex mmmx
13725 @opindex mno-mmx
13726 @opindex msse
13727 @opindex mno-sse
13728 @opindex m3dnow
13729 @opindex mno-3dnow
13730 These switches enable or disable the use of instructions in the MMX, SSE,
13731 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
13732 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
13733 extended instruction sets.
13734 These extensions are also available as built-in functions: see
13735 @ref{X86 Built-in Functions}, for details of the functions enabled and
13736 disabled by these switches.
13738 To generate SSE/SSE2 instructions automatically from floating-point
13739 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
13741 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
13742 generates new AVX instructions or AVX equivalence for all SSEx instructions
13743 when needed.
13745 These options enable GCC to use these extended instructions in
13746 generated code, even without @option{-mfpmath=sse}.  Applications that
13747 perform run-time CPU detection must compile separate files for each
13748 supported architecture, using the appropriate flags.  In particular,
13749 the file containing the CPU detection code should be compiled without
13750 these options.
13752 @item -mcld
13753 @opindex mcld
13754 This option instructs GCC to emit a @code{cld} instruction in the prologue
13755 of functions that use string instructions.  String instructions depend on
13756 the DF flag to select between autoincrement or autodecrement mode.  While the
13757 ABI specifies the DF flag to be cleared on function entry, some operating
13758 systems violate this specification by not clearing the DF flag in their
13759 exception dispatchers.  The exception handler can be invoked with the DF flag
13760 set, which leads to wrong direction mode when string instructions are used.
13761 This option can be enabled by default on 32-bit x86 targets by configuring
13762 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
13763 instructions can be suppressed with the @option{-mno-cld} compiler option
13764 in this case.
13766 @item -mvzeroupper
13767 @opindex mvzeroupper
13768 This option instructs GCC to emit a @code{vzeroupper} instruction
13769 before a transfer of control flow out of the function to minimize
13770 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
13771 intrinsics.
13773 @item -mcx16
13774 @opindex mcx16
13775 This option enables GCC to generate @code{CMPXCHG16B} instructions.
13776 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
13777 (or oword) data types.  
13778 This is useful for high-resolution counters that can be updated
13779 by multiple processors (or cores).  This instruction is generated as part of
13780 atomic built-in functions: see @ref{__sync Builtins} or
13781 @ref{__atomic Builtins} for details.
13783 @item -msahf
13784 @opindex msahf
13785 This option enables generation of @code{SAHF} instructions in 64-bit code.
13786 Early Intel Pentium 4 CPUs with Intel 64 support,
13787 prior to the introduction of Pentium 4 G1 step in December 2005,
13788 lacked the @code{LAHF} and @code{SAHF} instructions
13789 which were supported by AMD64.
13790 These are load and store instructions, respectively, for certain status flags.
13791 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
13792 @code{drem}, and @code{remainder} built-in functions;
13793 see @ref{Other Builtins} for details.
13795 @item -mmovbe
13796 @opindex mmovbe
13797 This option enables use of the @code{movbe} instruction to implement
13798 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
13800 @item -mcrc32
13801 @opindex mcrc32
13802 This option enables built-in functions @code{__builtin_ia32_crc32qi},
13803 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
13804 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
13806 @item -mrecip
13807 @opindex mrecip
13808 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
13809 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
13810 with an additional Newton-Raphson step
13811 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
13812 (and their vectorized
13813 variants) for single-precision floating-point arguments.  These instructions
13814 are generated only when @option{-funsafe-math-optimizations} is enabled
13815 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
13816 Note that while the throughput of the sequence is higher than the throughput
13817 of the non-reciprocal instruction, the precision of the sequence can be
13818 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
13820 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
13821 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
13822 combination), and doesn't need @option{-mrecip}.
13824 Also note that GCC emits the above sequence with additional Newton-Raphson step
13825 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
13826 already with @option{-ffast-math} (or the above option combination), and
13827 doesn't need @option{-mrecip}.
13829 @item -mrecip=@var{opt}
13830 @opindex mrecip=opt
13831 This option controls which reciprocal estimate instructions
13832 may be used.  @var{opt} is a comma-separated list of options, which may
13833 be preceded by a @samp{!} to invert the option:
13835 @table @samp
13836 @item all
13837 Enable all estimate instructions.
13839 @item default
13840 Enable the default instructions, equivalent to @option{-mrecip}.
13842 @item none
13843 Disable all estimate instructions, equivalent to @option{-mno-recip}.
13845 @item div
13846 Enable the approximation for scalar division.
13848 @item vec-div
13849 Enable the approximation for vectorized division.
13851 @item sqrt
13852 Enable the approximation for scalar square root.
13854 @item vec-sqrt
13855 Enable the approximation for vectorized square root.
13856 @end table
13858 So, for example, @option{-mrecip=all,!sqrt} enables
13859 all of the reciprocal approximations, except for square root.
13861 @item -mveclibabi=@var{type}
13862 @opindex mveclibabi
13863 Specifies the ABI type to use for vectorizing intrinsics using an
13864 external library.  Supported values for @var{type} are @samp{svml} 
13865 for the Intel short
13866 vector math library and @samp{acml} for the AMD math core library.
13867 To use this option, both @option{-ftree-vectorize} and
13868 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
13869 ABI-compatible library must be specified at link time.
13871 GCC currently emits calls to @code{vmldExp2},
13872 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
13873 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
13874 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
13875 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
13876 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
13877 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
13878 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
13879 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
13880 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
13881 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
13882 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
13883 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
13884 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
13885 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
13886 when @option{-mveclibabi=acml} is used.  
13888 @item -mabi=@var{name}
13889 @opindex mabi
13890 Generate code for the specified calling convention.  Permissible values
13891 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
13892 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
13893 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
13894 You can control this behavior for a specific function by
13895 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
13896 @xref{Function Attributes}.
13898 @item -mtls-dialect=@var{type}
13899 @opindex mtls-dialect
13900 Generate code to access thread-local storage using the @samp{gnu} or
13901 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
13902 @samp{gnu2} is more efficient, but it may add compile- and run-time
13903 requirements that cannot be satisfied on all systems.
13905 @item -mpush-args
13906 @itemx -mno-push-args
13907 @opindex mpush-args
13908 @opindex mno-push-args
13909 Use PUSH operations to store outgoing parameters.  This method is shorter
13910 and usually equally fast as method using SUB/MOV operations and is enabled
13911 by default.  In some cases disabling it may improve performance because of
13912 improved scheduling and reduced dependencies.
13914 @item -maccumulate-outgoing-args
13915 @opindex maccumulate-outgoing-args
13916 If enabled, the maximum amount of space required for outgoing arguments is
13917 computed in the function prologue.  This is faster on most modern CPUs
13918 because of reduced dependencies, improved scheduling and reduced stack usage
13919 when the preferred stack boundary is not equal to 2.  The drawback is a notable
13920 increase in code size.  This switch implies @option{-mno-push-args}.
13922 @item -mthreads
13923 @opindex mthreads
13924 Support thread-safe exception handling on MinGW.  Programs that rely
13925 on thread-safe exception handling must compile and link all code with the
13926 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
13927 @code{-D_MT}; when linking, it links in a special thread helper library
13928 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
13930 @item -mno-align-stringops
13931 @opindex mno-align-stringops
13932 Do not align the destination of inlined string operations.  This switch reduces
13933 code size and improves performance in case the destination is already aligned,
13934 but GCC doesn't know about it.
13936 @item -minline-all-stringops
13937 @opindex minline-all-stringops
13938 By default GCC inlines string operations only when the destination is 
13939 known to be aligned to least a 4-byte boundary.  
13940 This enables more inlining and increases code
13941 size, but may improve performance of code that depends on fast
13942 @code{memcpy}, @code{strlen},
13943 and @code{memset} for short lengths.
13945 @item -minline-stringops-dynamically
13946 @opindex minline-stringops-dynamically
13947 For string operations of unknown size, use run-time checks with
13948 inline code for small blocks and a library call for large blocks.
13950 @item -mstringop-strategy=@var{alg}
13951 @opindex mstringop-strategy=@var{alg}
13952 Override the internal decision heuristic for the particular algorithm to use
13953 for inlining string operations.  The allowed values for @var{alg} are:
13955 @table @samp
13956 @item rep_byte
13957 @itemx rep_4byte
13958 @itemx rep_8byte
13959 Expand using i386 @code{rep} prefix of the specified size.
13961 @item byte_loop
13962 @itemx loop
13963 @itemx unrolled_loop
13964 Expand into an inline loop.
13966 @item libcall
13967 Always use a library call.
13968 @end table
13970 @item -momit-leaf-frame-pointer
13971 @opindex momit-leaf-frame-pointer
13972 Don't keep the frame pointer in a register for leaf functions.  This
13973 avoids the instructions to save, set up, and restore frame pointers and
13974 makes an extra register available in leaf functions.  The option
13975 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
13976 which might make debugging harder.
13978 @item -mtls-direct-seg-refs
13979 @itemx -mno-tls-direct-seg-refs
13980 @opindex mtls-direct-seg-refs
13981 Controls whether TLS variables may be accessed with offsets from the
13982 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
13983 or whether the thread base pointer must be added.  Whether or not this
13984 is valid depends on the operating system, and whether it maps the
13985 segment to cover the entire TLS area.
13987 For systems that use the GNU C Library, the default is on.
13989 @item -msse2avx
13990 @itemx -mno-sse2avx
13991 @opindex msse2avx
13992 Specify that the assembler should encode SSE instructions with VEX
13993 prefix.  The option @option{-mavx} turns this on by default.
13995 @item -mfentry
13996 @itemx -mno-fentry
13997 @opindex mfentry
13998 If profiling is active (@option{-pg}), put the profiling
13999 counter call before the prologue.
14000 Note: On x86 architectures the attribute @code{ms_hook_prologue}
14001 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
14003 @item -m8bit-idiv
14004 @itemx -mno-8bit-idiv
14005 @opindex 8bit-idiv
14006 On some processors, like Intel Atom, 8-bit unsigned integer divide is
14007 much faster than 32-bit/64-bit integer divide.  This option generates a
14008 run-time check.  If both dividend and divisor are within range of 0
14009 to 255, 8-bit unsigned integer divide is used instead of
14010 32-bit/64-bit integer divide.
14012 @item -mavx256-split-unaligned-load
14013 @itemx -mavx256-split-unaligned-store
14014 @opindex avx256-split-unaligned-load
14015 @opindex avx256-split-unaligned-store
14016 Split 32-byte AVX unaligned load and store.
14018 @end table
14020 These @samp{-m} switches are supported in addition to the above
14021 on x86-64 processors in 64-bit environments.
14023 @table @gcctabopt
14024 @item -m32
14025 @itemx -m64
14026 @itemx -mx32
14027 @opindex m32
14028 @opindex m64
14029 @opindex mx32
14030 Generate code for a 32-bit or 64-bit environment.
14031 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
14032 to 32 bits, and
14033 generates code that runs on any i386 system.
14035 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
14036 types to 64 bits, and generates code for the x86-64 architecture.
14037 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
14038 and @option{-mdynamic-no-pic} options.
14040 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
14041 to 32 bits, and
14042 generates code for the x86-64 architecture.
14044 @item -mno-red-zone
14045 @opindex mno-red-zone
14046 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
14047 by the x86-64 ABI; it is a 128-byte area beyond the location of the
14048 stack pointer that is not modified by signal or interrupt handlers
14049 and therefore can be used for temporary data without adjusting the stack
14050 pointer.  The flag @option{-mno-red-zone} disables this red zone.
14052 @item -mcmodel=small
14053 @opindex mcmodel=small
14054 Generate code for the small code model: the program and its symbols must
14055 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
14056 Programs can be statically or dynamically linked.  This is the default
14057 code model.
14059 @item -mcmodel=kernel
14060 @opindex mcmodel=kernel
14061 Generate code for the kernel code model.  The kernel runs in the
14062 negative 2 GB of the address space.
14063 This model has to be used for Linux kernel code.
14065 @item -mcmodel=medium
14066 @opindex mcmodel=medium
14067 Generate code for the medium model: the program is linked in the lower 2
14068 GB of the address space.  Small symbols are also placed there.  Symbols
14069 with sizes larger than @option{-mlarge-data-threshold} are put into
14070 large data or BSS sections and can be located above 2GB.  Programs can
14071 be statically or dynamically linked.
14073 @item -mcmodel=large
14074 @opindex mcmodel=large
14075 Generate code for the large model.  This model makes no assumptions
14076 about addresses and sizes of sections.
14078 @item -maddress-mode=long
14079 @opindex maddress-mode=long
14080 Generate code for long address mode.  This is only supported for 64-bit
14081 and x32 environments.  It is the default address mode for 64-bit
14082 environments.
14084 @item -maddress-mode=short
14085 @opindex maddress-mode=short
14086 Generate code for short address mode.  This is only supported for 32-bit
14087 and x32 environments.  It is the default address mode for 32-bit and
14088 x32 environments.
14089 @end table
14091 @node i386 and x86-64 Windows Options
14092 @subsection i386 and x86-64 Windows Options
14093 @cindex i386 and x86-64 Windows Options
14095 These additional options are available for Microsoft Windows targets:
14097 @table @gcctabopt
14098 @item -mconsole
14099 @opindex mconsole
14100 This option
14101 specifies that a console application is to be generated, by
14102 instructing the linker to set the PE header subsystem type
14103 required for console applications.
14104 This option is available for Cygwin and MinGW targets and is
14105 enabled by default on those targets.
14107 @item -mdll
14108 @opindex mdll
14109 This option is available for Cygwin and MinGW targets.  It
14110 specifies that a DLL---a dynamic link library---is to be
14111 generated, enabling the selection of the required runtime
14112 startup object and entry point.
14114 @item -mnop-fun-dllimport
14115 @opindex mnop-fun-dllimport
14116 This option is available for Cygwin and MinGW targets.  It
14117 specifies that the @code{dllimport} attribute should be ignored.
14119 @item -mthread
14120 @opindex mthread
14121 This option is available for MinGW targets. It specifies
14122 that MinGW-specific thread support is to be used.
14124 @item -municode
14125 @opindex municode
14126 This option is available for MinGW-w64 targets.  It causes
14127 the @code{UNICODE} preprocessor macro to be predefined, and
14128 chooses Unicode-capable runtime startup code.
14130 @item -mwin32
14131 @opindex mwin32
14132 This option is available for Cygwin and MinGW targets.  It
14133 specifies that the typical Microsoft Windows predefined macros are to
14134 be set in the pre-processor, but does not influence the choice
14135 of runtime library/startup code.
14137 @item -mwindows
14138 @opindex mwindows
14139 This option is available for Cygwin and MinGW targets.  It
14140 specifies that a GUI application is to be generated by
14141 instructing the linker to set the PE header subsystem type
14142 appropriately.
14144 @item -fno-set-stack-executable
14145 @opindex fno-set-stack-executable
14146 This option is available for MinGW targets. It specifies that
14147 the executable flag for the stack used by nested functions isn't
14148 set. This is necessary for binaries running in kernel mode of
14149 Microsoft Windows, as there the User32 API, which is used to set executable
14150 privileges, isn't available.
14152 @item -fwritable-relocated-rdata
14153 @opindex fno-writable-relocated-rdata
14154 This option is available for MinGW and Cygwin targets.  It specifies
14155 that relocated-data in read-only section is put into .data
14156 section.  This is a necessary for older runtimes not supporting
14157 modification of .rdata sections for pseudo-relocation.
14159 @item -mpe-aligned-commons
14160 @opindex mpe-aligned-commons
14161 This option is available for Cygwin and MinGW targets.  It
14162 specifies that the GNU extension to the PE file format that
14163 permits the correct alignment of COMMON variables should be
14164 used when generating code.  It is enabled by default if
14165 GCC detects that the target assembler found during configuration
14166 supports the feature.
14167 @end table
14169 See also under @ref{i386 and x86-64 Options} for standard options.
14171 @node IA-64 Options
14172 @subsection IA-64 Options
14173 @cindex IA-64 Options
14175 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14177 @table @gcctabopt
14178 @item -mbig-endian
14179 @opindex mbig-endian
14180 Generate code for a big-endian target.  This is the default for HP-UX@.
14182 @item -mlittle-endian
14183 @opindex mlittle-endian
14184 Generate code for a little-endian target.  This is the default for AIX5
14185 and GNU/Linux.
14187 @item -mgnu-as
14188 @itemx -mno-gnu-as
14189 @opindex mgnu-as
14190 @opindex mno-gnu-as
14191 Generate (or don't) code for the GNU assembler.  This is the default.
14192 @c Also, this is the default if the configure option @option{--with-gnu-as}
14193 @c is used.
14195 @item -mgnu-ld
14196 @itemx -mno-gnu-ld
14197 @opindex mgnu-ld
14198 @opindex mno-gnu-ld
14199 Generate (or don't) code for the GNU linker.  This is the default.
14200 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14201 @c is used.
14203 @item -mno-pic
14204 @opindex mno-pic
14205 Generate code that does not use a global pointer register.  The result
14206 is not position independent code, and violates the IA-64 ABI@.
14208 @item -mvolatile-asm-stop
14209 @itemx -mno-volatile-asm-stop
14210 @opindex mvolatile-asm-stop
14211 @opindex mno-volatile-asm-stop
14212 Generate (or don't) a stop bit immediately before and after volatile asm
14213 statements.
14215 @item -mregister-names
14216 @itemx -mno-register-names
14217 @opindex mregister-names
14218 @opindex mno-register-names
14219 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14220 the stacked registers.  This may make assembler output more readable.
14222 @item -mno-sdata
14223 @itemx -msdata
14224 @opindex mno-sdata
14225 @opindex msdata
14226 Disable (or enable) optimizations that use the small data section.  This may
14227 be useful for working around optimizer bugs.
14229 @item -mconstant-gp
14230 @opindex mconstant-gp
14231 Generate code that uses a single constant global pointer value.  This is
14232 useful when compiling kernel code.
14234 @item -mauto-pic
14235 @opindex mauto-pic
14236 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
14237 This is useful when compiling firmware code.
14239 @item -minline-float-divide-min-latency
14240 @opindex minline-float-divide-min-latency
14241 Generate code for inline divides of floating-point values
14242 using the minimum latency algorithm.
14244 @item -minline-float-divide-max-throughput
14245 @opindex minline-float-divide-max-throughput
14246 Generate code for inline divides of floating-point values
14247 using the maximum throughput algorithm.
14249 @item -mno-inline-float-divide
14250 @opindex mno-inline-float-divide
14251 Do not generate inline code for divides of floating-point values.
14253 @item -minline-int-divide-min-latency
14254 @opindex minline-int-divide-min-latency
14255 Generate code for inline divides of integer values
14256 using the minimum latency algorithm.
14258 @item -minline-int-divide-max-throughput
14259 @opindex minline-int-divide-max-throughput
14260 Generate code for inline divides of integer values
14261 using the maximum throughput algorithm.
14263 @item -mno-inline-int-divide
14264 @opindex mno-inline-int-divide
14265 Do not generate inline code for divides of integer values.
14267 @item -minline-sqrt-min-latency
14268 @opindex minline-sqrt-min-latency
14269 Generate code for inline square roots
14270 using the minimum latency algorithm.
14272 @item -minline-sqrt-max-throughput
14273 @opindex minline-sqrt-max-throughput
14274 Generate code for inline square roots
14275 using the maximum throughput algorithm.
14277 @item -mno-inline-sqrt
14278 @opindex mno-inline-sqrt
14279 Do not generate inline code for @code{sqrt}.
14281 @item -mfused-madd
14282 @itemx -mno-fused-madd
14283 @opindex mfused-madd
14284 @opindex mno-fused-madd
14285 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14286 instructions.  The default is to use these instructions.
14288 @item -mno-dwarf2-asm
14289 @itemx -mdwarf2-asm
14290 @opindex mno-dwarf2-asm
14291 @opindex mdwarf2-asm
14292 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14293 info.  This may be useful when not using the GNU assembler.
14295 @item -mearly-stop-bits
14296 @itemx -mno-early-stop-bits
14297 @opindex mearly-stop-bits
14298 @opindex mno-early-stop-bits
14299 Allow stop bits to be placed earlier than immediately preceding the
14300 instruction that triggered the stop bit.  This can improve instruction
14301 scheduling, but does not always do so.
14303 @item -mfixed-range=@var{register-range}
14304 @opindex mfixed-range
14305 Generate code treating the given register range as fixed registers.
14306 A fixed register is one that the register allocator cannot use.  This is
14307 useful when compiling kernel code.  A register range is specified as
14308 two registers separated by a dash.  Multiple register ranges can be
14309 specified separated by a comma.
14311 @item -mtls-size=@var{tls-size}
14312 @opindex mtls-size
14313 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
14316 @item -mtune=@var{cpu-type}
14317 @opindex mtune
14318 Tune the instruction scheduling for a particular CPU, Valid values are
14319 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
14320 and @samp{mckinley}.
14322 @item -milp32
14323 @itemx -mlp64
14324 @opindex milp32
14325 @opindex mlp64
14326 Generate code for a 32-bit or 64-bit environment.
14327 The 32-bit environment sets int, long and pointer to 32 bits.
14328 The 64-bit environment sets int to 32 bits and long and pointer
14329 to 64 bits.  These are HP-UX specific flags.
14331 @item -mno-sched-br-data-spec
14332 @itemx -msched-br-data-spec
14333 @opindex mno-sched-br-data-spec
14334 @opindex msched-br-data-spec
14335 (Dis/En)able data speculative scheduling before reload.
14336 This results in generation of @code{ld.a} instructions and
14337 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14338 The default is 'disable'.
14340 @item -msched-ar-data-spec
14341 @itemx -mno-sched-ar-data-spec
14342 @opindex msched-ar-data-spec
14343 @opindex mno-sched-ar-data-spec
14344 (En/Dis)able data speculative scheduling after reload.
14345 This results in generation of @code{ld.a} instructions and
14346 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14347 The default is 'enable'.
14349 @item -mno-sched-control-spec
14350 @itemx -msched-control-spec
14351 @opindex mno-sched-control-spec
14352 @opindex msched-control-spec
14353 (Dis/En)able control speculative scheduling.  This feature is
14354 available only during region scheduling (i.e.@: before reload).
14355 This results in generation of the @code{ld.s} instructions and
14356 the corresponding check instructions @code{chk.s}.
14357 The default is 'disable'.
14359 @item -msched-br-in-data-spec
14360 @itemx -mno-sched-br-in-data-spec
14361 @opindex msched-br-in-data-spec
14362 @opindex mno-sched-br-in-data-spec
14363 (En/Dis)able speculative scheduling of the instructions that
14364 are dependent on the data speculative loads before reload.
14365 This is effective only with @option{-msched-br-data-spec} enabled.
14366 The default is 'enable'.
14368 @item -msched-ar-in-data-spec
14369 @itemx -mno-sched-ar-in-data-spec
14370 @opindex msched-ar-in-data-spec
14371 @opindex mno-sched-ar-in-data-spec
14372 (En/Dis)able speculative scheduling of the instructions that
14373 are dependent on the data speculative loads after reload.
14374 This is effective only with @option{-msched-ar-data-spec} enabled.
14375 The default is 'enable'.
14377 @item -msched-in-control-spec
14378 @itemx -mno-sched-in-control-spec
14379 @opindex msched-in-control-spec
14380 @opindex mno-sched-in-control-spec
14381 (En/Dis)able speculative scheduling of the instructions that
14382 are dependent on the control speculative loads.
14383 This is effective only with @option{-msched-control-spec} enabled.
14384 The default is 'enable'.
14386 @item -mno-sched-prefer-non-data-spec-insns
14387 @itemx -msched-prefer-non-data-spec-insns
14388 @opindex mno-sched-prefer-non-data-spec-insns
14389 @opindex msched-prefer-non-data-spec-insns
14390 If enabled, data-speculative instructions are chosen for schedule
14391 only if there are no other choices at the moment.  This makes
14392 the use of the data speculation much more conservative.
14393 The default is 'disable'.
14395 @item -mno-sched-prefer-non-control-spec-insns
14396 @itemx -msched-prefer-non-control-spec-insns
14397 @opindex mno-sched-prefer-non-control-spec-insns
14398 @opindex msched-prefer-non-control-spec-insns
14399 If enabled, control-speculative instructions are chosen for schedule
14400 only if there are no other choices at the moment.  This makes
14401 the use of the control speculation much more conservative.
14402 The default is 'disable'.
14404 @item -mno-sched-count-spec-in-critical-path
14405 @itemx -msched-count-spec-in-critical-path
14406 @opindex mno-sched-count-spec-in-critical-path
14407 @opindex msched-count-spec-in-critical-path
14408 If enabled, speculative dependencies are considered during
14409 computation of the instructions priorities.  This makes the use of the
14410 speculation a bit more conservative.
14411 The default is 'disable'.
14413 @item -msched-spec-ldc
14414 @opindex msched-spec-ldc
14415 Use a simple data speculation check.  This option is on by default.
14417 @item -msched-control-spec-ldc
14418 @opindex msched-spec-ldc
14419 Use a simple check for control speculation.  This option is on by default.
14421 @item -msched-stop-bits-after-every-cycle
14422 @opindex msched-stop-bits-after-every-cycle
14423 Place a stop bit after every cycle when scheduling.  This option is on
14424 by default.
14426 @item -msched-fp-mem-deps-zero-cost
14427 @opindex msched-fp-mem-deps-zero-cost
14428 Assume that floating-point stores and loads are not likely to cause a conflict
14429 when placed into the same instruction group.  This option is disabled by
14430 default.
14432 @item -msel-sched-dont-check-control-spec
14433 @opindex msel-sched-dont-check-control-spec
14434 Generate checks for control speculation in selective scheduling.
14435 This flag is disabled by default.
14437 @item -msched-max-memory-insns=@var{max-insns}
14438 @opindex msched-max-memory-insns
14439 Limit on the number of memory insns per instruction group, giving lower
14440 priority to subsequent memory insns attempting to schedule in the same
14441 instruction group. Frequently useful to prevent cache bank conflicts.
14442 The default value is 1.
14444 @item -msched-max-memory-insns-hard-limit
14445 @opindex msched-max-memory-insns-hard-limit
14446 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
14447 disallowing more than that number in an instruction group.
14448 Otherwise, the limit is ``soft'', meaning that non-memory operations
14449 are preferred when the limit is reached, but memory operations may still
14450 be scheduled.
14452 @end table
14454 @node LM32 Options
14455 @subsection LM32 Options
14456 @cindex LM32 options
14458 These @option{-m} options are defined for the Lattice Mico32 architecture:
14460 @table @gcctabopt
14461 @item -mbarrel-shift-enabled
14462 @opindex mbarrel-shift-enabled
14463 Enable barrel-shift instructions.
14465 @item -mdivide-enabled
14466 @opindex mdivide-enabled
14467 Enable divide and modulus instructions.
14469 @item -mmultiply-enabled
14470 @opindex multiply-enabled
14471 Enable multiply instructions.
14473 @item -msign-extend-enabled
14474 @opindex msign-extend-enabled
14475 Enable sign extend instructions.
14477 @item -muser-enabled
14478 @opindex muser-enabled
14479 Enable user-defined instructions.
14481 @end table
14483 @node M32C Options
14484 @subsection M32C Options
14485 @cindex M32C options
14487 @table @gcctabopt
14488 @item -mcpu=@var{name}
14489 @opindex mcpu=
14490 Select the CPU for which code is generated.  @var{name} may be one of
14491 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
14492 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
14493 the M32C/80 series.
14495 @item -msim
14496 @opindex msim
14497 Specifies that the program will be run on the simulator.  This causes
14498 an alternate runtime library to be linked in which supports, for
14499 example, file I/O@.  You must not use this option when generating
14500 programs that will run on real hardware; you must provide your own
14501 runtime library for whatever I/O functions are needed.
14503 @item -memregs=@var{number}
14504 @opindex memregs=
14505 Specifies the number of memory-based pseudo-registers GCC uses
14506 during code generation.  These pseudo-registers are used like real
14507 registers, so there is a tradeoff between GCC's ability to fit the
14508 code into available registers, and the performance penalty of using
14509 memory instead of registers.  Note that all modules in a program must
14510 be compiled with the same value for this option.  Because of that, you
14511 must not use this option with the default runtime libraries gcc
14512 builds.
14514 @end table
14516 @node M32R/D Options
14517 @subsection M32R/D Options
14518 @cindex M32R/D options
14520 These @option{-m} options are defined for Renesas M32R/D architectures:
14522 @table @gcctabopt
14523 @item -m32r2
14524 @opindex m32r2
14525 Generate code for the M32R/2@.
14527 @item -m32rx
14528 @opindex m32rx
14529 Generate code for the M32R/X@.
14531 @item -m32r
14532 @opindex m32r
14533 Generate code for the M32R@.  This is the default.
14535 @item -mmodel=small
14536 @opindex mmodel=small
14537 Assume all objects live in the lower 16MB of memory (so that their addresses
14538 can be loaded with the @code{ld24} instruction), and assume all subroutines
14539 are reachable with the @code{bl} instruction.
14540 This is the default.
14542 The addressability of a particular object can be set with the
14543 @code{model} attribute.
14545 @item -mmodel=medium
14546 @opindex mmodel=medium
14547 Assume objects may be anywhere in the 32-bit address space (the compiler
14548 generates @code{seth/add3} instructions to load their addresses), and
14549 assume all subroutines are reachable with the @code{bl} instruction.
14551 @item -mmodel=large
14552 @opindex mmodel=large
14553 Assume objects may be anywhere in the 32-bit address space (the compiler
14554 generates @code{seth/add3} instructions to load their addresses), and
14555 assume subroutines may not be reachable with the @code{bl} instruction
14556 (the compiler generates the much slower @code{seth/add3/jl}
14557 instruction sequence).
14559 @item -msdata=none
14560 @opindex msdata=none
14561 Disable use of the small data area.  Variables are put into
14562 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
14563 @code{section} attribute has been specified).
14564 This is the default.
14566 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
14567 Objects may be explicitly put in the small data area with the
14568 @code{section} attribute using one of these sections.
14570 @item -msdata=sdata
14571 @opindex msdata=sdata
14572 Put small global and static data in the small data area, but do not
14573 generate special code to reference them.
14575 @item -msdata=use
14576 @opindex msdata=use
14577 Put small global and static data in the small data area, and generate
14578 special instructions to reference them.
14580 @item -G @var{num}
14581 @opindex G
14582 @cindex smaller data references
14583 Put global and static objects less than or equal to @var{num} bytes
14584 into the small data or bss sections instead of the normal data or bss
14585 sections.  The default value of @var{num} is 8.
14586 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
14587 for this option to have any effect.
14589 All modules should be compiled with the same @option{-G @var{num}} value.
14590 Compiling with different values of @var{num} may or may not work; if it
14591 doesn't the linker gives an error message---incorrect code is not
14592 generated.
14594 @item -mdebug
14595 @opindex mdebug
14596 Makes the M32R specific code in the compiler display some statistics
14597 that might help in debugging programs.
14599 @item -malign-loops
14600 @opindex malign-loops
14601 Align all loops to a 32-byte boundary.
14603 @item -mno-align-loops
14604 @opindex mno-align-loops
14605 Do not enforce a 32-byte alignment for loops.  This is the default.
14607 @item -missue-rate=@var{number}
14608 @opindex missue-rate=@var{number}
14609 Issue @var{number} instructions per cycle.  @var{number} can only be 1
14610 or 2.
14612 @item -mbranch-cost=@var{number}
14613 @opindex mbranch-cost=@var{number}
14614 @var{number} can only be 1 or 2.  If it is 1 then branches are
14615 preferred over conditional code, if it is 2, then the opposite applies.
14617 @item -mflush-trap=@var{number}
14618 @opindex mflush-trap=@var{number}
14619 Specifies the trap number to use to flush the cache.  The default is
14620 12.  Valid numbers are between 0 and 15 inclusive.
14622 @item -mno-flush-trap
14623 @opindex mno-flush-trap
14624 Specifies that the cache cannot be flushed by using a trap.
14626 @item -mflush-func=@var{name}
14627 @opindex mflush-func=@var{name}
14628 Specifies the name of the operating system function to call to flush
14629 the cache.  The default is @emph{_flush_cache}, but a function call
14630 is only used if a trap is not available.
14632 @item -mno-flush-func
14633 @opindex mno-flush-func
14634 Indicates that there is no OS function for flushing the cache.
14636 @end table
14638 @node M680x0 Options
14639 @subsection M680x0 Options
14640 @cindex M680x0 options
14642 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
14643 The default settings depend on which architecture was selected when
14644 the compiler was configured; the defaults for the most common choices
14645 are given below.
14647 @table @gcctabopt
14648 @item -march=@var{arch}
14649 @opindex march
14650 Generate code for a specific M680x0 or ColdFire instruction set
14651 architecture.  Permissible values of @var{arch} for M680x0
14652 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
14653 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
14654 architectures are selected according to Freescale's ISA classification
14655 and the permissible values are: @samp{isaa}, @samp{isaaplus},
14656 @samp{isab} and @samp{isac}.
14658 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
14659 code for a ColdFire target.  The @var{arch} in this macro is one of the
14660 @option{-march} arguments given above.
14662 When used together, @option{-march} and @option{-mtune} select code
14663 that runs on a family of similar processors but that is optimized
14664 for a particular microarchitecture.
14666 @item -mcpu=@var{cpu}
14667 @opindex mcpu
14668 Generate code for a specific M680x0 or ColdFire processor.
14669 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
14670 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
14671 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
14672 below, which also classifies the CPUs into families:
14674 @multitable @columnfractions 0.20 0.80
14675 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
14676 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51ag} @samp{51cn} @samp{51em} @samp{51je} @samp{51jf} @samp{51jg} @samp{51jm} @samp{51mm} @samp{51qe} @samp{51qm}
14677 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
14678 @item @samp{5206e} @tab @samp{5206e}
14679 @item @samp{5208} @tab @samp{5207} @samp{5208}
14680 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
14681 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
14682 @item @samp{5216} @tab @samp{5214} @samp{5216}
14683 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
14684 @item @samp{5225} @tab @samp{5224} @samp{5225}
14685 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
14686 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
14687 @item @samp{5249} @tab @samp{5249}
14688 @item @samp{5250} @tab @samp{5250}
14689 @item @samp{5271} @tab @samp{5270} @samp{5271}
14690 @item @samp{5272} @tab @samp{5272}
14691 @item @samp{5275} @tab @samp{5274} @samp{5275}
14692 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
14693 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
14694 @item @samp{5307} @tab @samp{5307}
14695 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
14696 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
14697 @item @samp{5407} @tab @samp{5407}
14698 @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}
14699 @end multitable
14701 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
14702 @var{arch} is compatible with @var{cpu}.  Other combinations of
14703 @option{-mcpu} and @option{-march} are rejected.
14705 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
14706 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
14707 where the value of @var{family} is given by the table above.
14709 @item -mtune=@var{tune}
14710 @opindex mtune
14711 Tune the code for a particular microarchitecture, within the
14712 constraints set by @option{-march} and @option{-mcpu}.
14713 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
14714 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
14715 and @samp{cpu32}.  The ColdFire microarchitectures
14716 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
14718 You can also use @option{-mtune=68020-40} for code that needs
14719 to run relatively well on 68020, 68030 and 68040 targets.
14720 @option{-mtune=68020-60} is similar but includes 68060 targets
14721 as well.  These two options select the same tuning decisions as
14722 @option{-m68020-40} and @option{-m68020-60} respectively.
14724 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
14725 when tuning for 680x0 architecture @var{arch}.  It also defines
14726 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
14727 option is used.  If GCC is tuning for a range of architectures,
14728 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
14729 it defines the macros for every architecture in the range.
14731 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
14732 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
14733 of the arguments given above.
14735 @item -m68000
14736 @itemx -mc68000
14737 @opindex m68000
14738 @opindex mc68000
14739 Generate output for a 68000.  This is the default
14740 when the compiler is configured for 68000-based systems.
14741 It is equivalent to @option{-march=68000}.
14743 Use this option for microcontrollers with a 68000 or EC000 core,
14744 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
14746 @item -m68010
14747 @opindex m68010
14748 Generate output for a 68010.  This is the default
14749 when the compiler is configured for 68010-based systems.
14750 It is equivalent to @option{-march=68010}.
14752 @item -m68020
14753 @itemx -mc68020
14754 @opindex m68020
14755 @opindex mc68020
14756 Generate output for a 68020.  This is the default
14757 when the compiler is configured for 68020-based systems.
14758 It is equivalent to @option{-march=68020}.
14760 @item -m68030
14761 @opindex m68030
14762 Generate output for a 68030.  This is the default when the compiler is
14763 configured for 68030-based systems.  It is equivalent to
14764 @option{-march=68030}.
14766 @item -m68040
14767 @opindex m68040
14768 Generate output for a 68040.  This is the default when the compiler is
14769 configured for 68040-based systems.  It is equivalent to
14770 @option{-march=68040}.
14772 This option inhibits the use of 68881/68882 instructions that have to be
14773 emulated by software on the 68040.  Use this option if your 68040 does not
14774 have code to emulate those instructions.
14776 @item -m68060
14777 @opindex m68060
14778 Generate output for a 68060.  This is the default when the compiler is
14779 configured for 68060-based systems.  It is equivalent to
14780 @option{-march=68060}.
14782 This option inhibits the use of 68020 and 68881/68882 instructions that
14783 have to be emulated by software on the 68060.  Use this option if your 68060
14784 does not have code to emulate those instructions.
14786 @item -mcpu32
14787 @opindex mcpu32
14788 Generate output for a CPU32.  This is the default
14789 when the compiler is configured for CPU32-based systems.
14790 It is equivalent to @option{-march=cpu32}.
14792 Use this option for microcontrollers with a
14793 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
14794 68336, 68340, 68341, 68349 and 68360.
14796 @item -m5200
14797 @opindex m5200
14798 Generate output for a 520X ColdFire CPU@.  This is the default
14799 when the compiler is configured for 520X-based systems.
14800 It is equivalent to @option{-mcpu=5206}, and is now deprecated
14801 in favor of that option.
14803 Use this option for microcontroller with a 5200 core, including
14804 the MCF5202, MCF5203, MCF5204 and MCF5206.
14806 @item -m5206e
14807 @opindex m5206e
14808 Generate output for a 5206e ColdFire CPU@.  The option is now
14809 deprecated in favor of the equivalent @option{-mcpu=5206e}.
14811 @item -m528x
14812 @opindex m528x
14813 Generate output for a member of the ColdFire 528X family.
14814 The option is now deprecated in favor of the equivalent
14815 @option{-mcpu=528x}.
14817 @item -m5307
14818 @opindex m5307
14819 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
14820 in favor of the equivalent @option{-mcpu=5307}.
14822 @item -m5407
14823 @opindex m5407
14824 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
14825 in favor of the equivalent @option{-mcpu=5407}.
14827 @item -mcfv4e
14828 @opindex mcfv4e
14829 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
14830 This includes use of hardware floating-point instructions.
14831 The option is equivalent to @option{-mcpu=547x}, and is now
14832 deprecated in favor of that option.
14834 @item -m68020-40
14835 @opindex m68020-40
14836 Generate output for a 68040, without using any of the new instructions.
14837 This results in code that can run relatively efficiently on either a
14838 68020/68881 or a 68030 or a 68040.  The generated code does use the
14839 68881 instructions that are emulated on the 68040.
14841 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
14843 @item -m68020-60
14844 @opindex m68020-60
14845 Generate output for a 68060, without using any of the new instructions.
14846 This results in code that can run relatively efficiently on either a
14847 68020/68881 or a 68030 or a 68040.  The generated code does use the
14848 68881 instructions that are emulated on the 68060.
14850 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
14852 @item -mhard-float
14853 @itemx -m68881
14854 @opindex mhard-float
14855 @opindex m68881
14856 Generate floating-point instructions.  This is the default for 68020
14857 and above, and for ColdFire devices that have an FPU@.  It defines the
14858 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
14859 on ColdFire targets.
14861 @item -msoft-float
14862 @opindex msoft-float
14863 Do not generate floating-point instructions; use library calls instead.
14864 This is the default for 68000, 68010, and 68832 targets.  It is also
14865 the default for ColdFire devices that have no FPU.
14867 @item -mdiv
14868 @itemx -mno-div
14869 @opindex mdiv
14870 @opindex mno-div
14871 Generate (do not generate) ColdFire hardware divide and remainder
14872 instructions.  If @option{-march} is used without @option{-mcpu},
14873 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
14874 architectures.  Otherwise, the default is taken from the target CPU
14875 (either the default CPU, or the one specified by @option{-mcpu}).  For
14876 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
14877 @option{-mcpu=5206e}.
14879 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
14881 @item -mshort
14882 @opindex mshort
14883 Consider type @code{int} to be 16 bits wide, like @code{short int}.
14884 Additionally, parameters passed on the stack are also aligned to a
14885 16-bit boundary even on targets whose API mandates promotion to 32-bit.
14887 @item -mno-short
14888 @opindex mno-short
14889 Do not consider type @code{int} to be 16 bits wide.  This is the default.
14891 @item -mnobitfield
14892 @itemx -mno-bitfield
14893 @opindex mnobitfield
14894 @opindex mno-bitfield
14895 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
14896 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
14898 @item -mbitfield
14899 @opindex mbitfield
14900 Do use the bit-field instructions.  The @option{-m68020} option implies
14901 @option{-mbitfield}.  This is the default if you use a configuration
14902 designed for a 68020.
14904 @item -mrtd
14905 @opindex mrtd
14906 Use a different function-calling convention, in which functions
14907 that take a fixed number of arguments return with the @code{rtd}
14908 instruction, which pops their arguments while returning.  This
14909 saves one instruction in the caller since there is no need to pop
14910 the arguments there.
14912 This calling convention is incompatible with the one normally
14913 used on Unix, so you cannot use it if you need to call libraries
14914 compiled with the Unix compiler.
14916 Also, you must provide function prototypes for all functions that
14917 take variable numbers of arguments (including @code{printf});
14918 otherwise incorrect code is generated for calls to those
14919 functions.
14921 In addition, seriously incorrect code results if you call a
14922 function with too many arguments.  (Normally, extra arguments are
14923 harmlessly ignored.)
14925 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
14926 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
14928 @item -mno-rtd
14929 @opindex mno-rtd
14930 Do not use the calling conventions selected by @option{-mrtd}.
14931 This is the default.
14933 @item -malign-int
14934 @itemx -mno-align-int
14935 @opindex malign-int
14936 @opindex mno-align-int
14937 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
14938 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
14939 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
14940 Aligning variables on 32-bit boundaries produces code that runs somewhat
14941 faster on processors with 32-bit busses at the expense of more memory.
14943 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
14944 aligns structures containing the above types differently than
14945 most published application binary interface specifications for the m68k.
14947 @item -mpcrel
14948 @opindex mpcrel
14949 Use the pc-relative addressing mode of the 68000 directly, instead of
14950 using a global offset table.  At present, this option implies @option{-fpic},
14951 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
14952 not presently supported with @option{-mpcrel}, though this could be supported for
14953 68020 and higher processors.
14955 @item -mno-strict-align
14956 @itemx -mstrict-align
14957 @opindex mno-strict-align
14958 @opindex mstrict-align
14959 Do not (do) assume that unaligned memory references are handled by
14960 the system.
14962 @item -msep-data
14963 Generate code that allows the data segment to be located in a different
14964 area of memory from the text segment.  This allows for execute in place in
14965 an environment without virtual memory management.  This option implies
14966 @option{-fPIC}.
14968 @item -mno-sep-data
14969 Generate code that assumes that the data segment follows the text segment.
14970 This is the default.
14972 @item -mid-shared-library
14973 Generate code that supports shared libraries via the library ID method.
14974 This allows for execute in place and shared libraries in an environment
14975 without virtual memory management.  This option implies @option{-fPIC}.
14977 @item -mno-id-shared-library
14978 Generate code that doesn't assume ID based shared libraries are being used.
14979 This is the default.
14981 @item -mshared-library-id=n
14982 Specifies the identification number of the ID-based shared library being
14983 compiled.  Specifying a value of 0 generates more compact code; specifying
14984 other values forces the allocation of that number to the current
14985 library, but is no more space- or time-efficient than omitting this option.
14987 @item -mxgot
14988 @itemx -mno-xgot
14989 @opindex mxgot
14990 @opindex mno-xgot
14991 When generating position-independent code for ColdFire, generate code
14992 that works if the GOT has more than 8192 entries.  This code is
14993 larger and slower than code generated without this option.  On M680x0
14994 processors, this option is not needed; @option{-fPIC} suffices.
14996 GCC normally uses a single instruction to load values from the GOT@.
14997 While this is relatively efficient, it only works if the GOT
14998 is smaller than about 64k.  Anything larger causes the linker
14999 to report an error such as:
15001 @cindex relocation truncated to fit (ColdFire)
15002 @smallexample
15003 relocation truncated to fit: R_68K_GOT16O foobar
15004 @end smallexample
15006 If this happens, you should recompile your code with @option{-mxgot}.
15007 It should then work with very large GOTs.  However, code generated with
15008 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
15009 the value of a global symbol.
15011 Note that some linkers, including newer versions of the GNU linker,
15012 can create multiple GOTs and sort GOT entries.  If you have such a linker,
15013 you should only need to use @option{-mxgot} when compiling a single
15014 object file that accesses more than 8192 GOT entries.  Very few do.
15016 These options have no effect unless GCC is generating
15017 position-independent code.
15019 @end table
15021 @node MCore Options
15022 @subsection MCore Options
15023 @cindex MCore options
15025 These are the @samp{-m} options defined for the Motorola M*Core
15026 processors.
15028 @table @gcctabopt
15030 @item -mhardlit
15031 @itemx -mno-hardlit
15032 @opindex mhardlit
15033 @opindex mno-hardlit
15034 Inline constants into the code stream if it can be done in two
15035 instructions or less.
15037 @item -mdiv
15038 @itemx -mno-div
15039 @opindex mdiv
15040 @opindex mno-div
15041 Use the divide instruction.  (Enabled by default).
15043 @item -mrelax-immediate
15044 @itemx -mno-relax-immediate
15045 @opindex mrelax-immediate
15046 @opindex mno-relax-immediate
15047 Allow arbitrary sized immediates in bit operations.
15049 @item -mwide-bitfields
15050 @itemx -mno-wide-bitfields
15051 @opindex mwide-bitfields
15052 @opindex mno-wide-bitfields
15053 Always treat bit-fields as int-sized.
15055 @item -m4byte-functions
15056 @itemx -mno-4byte-functions
15057 @opindex m4byte-functions
15058 @opindex mno-4byte-functions
15059 Force all functions to be aligned to a 4-byte boundary.
15061 @item -mcallgraph-data
15062 @itemx -mno-callgraph-data
15063 @opindex mcallgraph-data
15064 @opindex mno-callgraph-data
15065 Emit callgraph information.
15067 @item -mslow-bytes
15068 @itemx -mno-slow-bytes
15069 @opindex mslow-bytes
15070 @opindex mno-slow-bytes
15071 Prefer word access when reading byte quantities.
15073 @item -mlittle-endian
15074 @itemx -mbig-endian
15075 @opindex mlittle-endian
15076 @opindex mbig-endian
15077 Generate code for a little-endian target.
15079 @item -m210
15080 @itemx -m340
15081 @opindex m210
15082 @opindex m340
15083 Generate code for the 210 processor.
15085 @item -mno-lsim
15086 @opindex mno-lsim
15087 Assume that runtime support has been provided and so omit the
15088 simulator library (@file{libsim.a)} from the linker command line.
15090 @item -mstack-increment=@var{size}
15091 @opindex mstack-increment
15092 Set the maximum amount for a single stack increment operation.  Large
15093 values can increase the speed of programs that contain functions
15094 that need a large amount of stack space, but they can also trigger a
15095 segmentation fault if the stack is extended too much.  The default
15096 value is 0x1000.
15098 @end table
15100 @node MeP Options
15101 @subsection MeP Options
15102 @cindex MeP options
15104 @table @gcctabopt
15106 @item -mabsdiff
15107 @opindex mabsdiff
15108 Enables the @code{abs} instruction, which is the absolute difference
15109 between two registers.
15111 @item -mall-opts
15112 @opindex mall-opts
15113 Enables all the optional instructions---average, multiply, divide, bit
15114 operations, leading zero, absolute difference, min/max, clip, and
15115 saturation.
15118 @item -maverage
15119 @opindex maverage
15120 Enables the @code{ave} instruction, which computes the average of two
15121 registers.
15123 @item -mbased=@var{n}
15124 @opindex mbased=
15125 Variables of size @var{n} bytes or smaller are placed in the
15126 @code{.based} section by default.  Based variables use the @code{$tp}
15127 register as a base register, and there is a 128-byte limit to the
15128 @code{.based} section.
15130 @item -mbitops
15131 @opindex mbitops
15132 Enables the bit operation instructions---bit test (@code{btstm}), set
15133 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15134 test-and-set (@code{tas}).
15136 @item -mc=@var{name}
15137 @opindex mc=
15138 Selects which section constant data is placed in.  @var{name} may
15139 be @code{tiny}, @code{near}, or @code{far}.
15141 @item -mclip
15142 @opindex mclip
15143 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
15144 useful unless you also provide @code{-mminmax}.
15146 @item -mconfig=@var{name}
15147 @opindex mconfig=
15148 Selects one of the build-in core configurations.  Each MeP chip has
15149 one or more modules in it; each module has a core CPU and a variety of
15150 coprocessors, optional instructions, and peripherals.  The
15151 @code{MeP-Integrator} tool, not part of GCC, provides these
15152 configurations through this option; using this option is the same as
15153 using all the corresponding command-line options.  The default
15154 configuration is @code{default}.
15156 @item -mcop
15157 @opindex mcop
15158 Enables the coprocessor instructions.  By default, this is a 32-bit
15159 coprocessor.  Note that the coprocessor is normally enabled via the
15160 @code{-mconfig=} option.
15162 @item -mcop32
15163 @opindex mcop32
15164 Enables the 32-bit coprocessor's instructions.
15166 @item -mcop64
15167 @opindex mcop64
15168 Enables the 64-bit coprocessor's instructions.
15170 @item -mivc2
15171 @opindex mivc2
15172 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
15174 @item -mdc
15175 @opindex mdc
15176 Causes constant variables to be placed in the @code{.near} section.
15178 @item -mdiv
15179 @opindex mdiv
15180 Enables the @code{div} and @code{divu} instructions.
15182 @item -meb
15183 @opindex meb
15184 Generate big-endian code.
15186 @item -mel
15187 @opindex mel
15188 Generate little-endian code.
15190 @item -mio-volatile
15191 @opindex mio-volatile
15192 Tells the compiler that any variable marked with the @code{io}
15193 attribute is to be considered volatile.
15195 @item -ml
15196 @opindex ml
15197 Causes variables to be assigned to the @code{.far} section by default.
15199 @item -mleadz
15200 @opindex mleadz
15201 Enables the @code{leadz} (leading zero) instruction.
15203 @item -mm
15204 @opindex mm
15205 Causes variables to be assigned to the @code{.near} section by default.
15207 @item -mminmax
15208 @opindex mminmax
15209 Enables the @code{min} and @code{max} instructions.
15211 @item -mmult
15212 @opindex mmult
15213 Enables the multiplication and multiply-accumulate instructions.
15215 @item -mno-opts
15216 @opindex mno-opts
15217 Disables all the optional instructions enabled by @code{-mall-opts}.
15219 @item -mrepeat
15220 @opindex mrepeat
15221 Enables the @code{repeat} and @code{erepeat} instructions, used for
15222 low-overhead looping.
15224 @item -ms
15225 @opindex ms
15226 Causes all variables to default to the @code{.tiny} section.  Note
15227 that there is a 65536-byte limit to this section.  Accesses to these
15228 variables use the @code{%gp} base register.
15230 @item -msatur
15231 @opindex msatur
15232 Enables the saturation instructions.  Note that the compiler does not
15233 currently generate these itself, but this option is included for
15234 compatibility with other tools, like @code{as}.
15236 @item -msdram
15237 @opindex msdram
15238 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15240 @item -msim
15241 @opindex msim
15242 Link the simulator runtime libraries.
15244 @item -msimnovec
15245 @opindex msimnovec
15246 Link the simulator runtime libraries, excluding built-in support
15247 for reset and exception vectors and tables.
15249 @item -mtf
15250 @opindex mtf
15251 Causes all functions to default to the @code{.far} section.  Without
15252 this option, functions default to the @code{.near} section.
15254 @item -mtiny=@var{n}
15255 @opindex mtiny=
15256 Variables that are @var{n} bytes or smaller are allocated to the
15257 @code{.tiny} section.  These variables use the @code{$gp} base
15258 register.  The default for this option is 4, but note that there's a
15259 65536-byte limit to the @code{.tiny} section.
15261 @end table
15263 @node MicroBlaze Options
15264 @subsection MicroBlaze Options
15265 @cindex MicroBlaze Options
15267 @table @gcctabopt
15269 @item -msoft-float
15270 @opindex msoft-float
15271 Use software emulation for floating point (default).
15273 @item -mhard-float
15274 @opindex mhard-float
15275 Use hardware floating-point instructions.
15277 @item -mmemcpy
15278 @opindex mmemcpy
15279 Do not optimize block moves, use @code{memcpy}.
15281 @item -mno-clearbss
15282 @opindex mno-clearbss
15283 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
15285 @item -mcpu=@var{cpu-type}
15286 @opindex mcpu=
15287 Use features of and schedule code for given CPU.
15288 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15289 where @var{X} is a major version, @var{YY} is the minor version, and
15290 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
15291 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15293 @item -mxl-soft-mul
15294 @opindex mxl-soft-mul
15295 Use software multiply emulation (default).
15297 @item -mxl-soft-div
15298 @opindex mxl-soft-div
15299 Use software emulation for divides (default).
15301 @item -mxl-barrel-shift
15302 @opindex mxl-barrel-shift
15303 Use the hardware barrel shifter.
15305 @item -mxl-pattern-compare
15306 @opindex mxl-pattern-compare
15307 Use pattern compare instructions.
15309 @item -msmall-divides
15310 @opindex msmall-divides
15311 Use table lookup optimization for small signed integer divisions.
15313 @item -mxl-stack-check
15314 @opindex mxl-stack-check
15315 This option is deprecated.  Use @option{-fstack-check} instead.
15317 @item -mxl-gp-opt
15318 @opindex mxl-gp-opt
15319 Use GP-relative @code{.sdata}/@code{.sbss} sections.
15321 @item -mxl-multiply-high
15322 @opindex mxl-multiply-high
15323 Use multiply high instructions for high part of 32x32 multiply.
15325 @item -mxl-float-convert
15326 @opindex mxl-float-convert
15327 Use hardware floating-point conversion instructions.
15329 @item -mxl-float-sqrt
15330 @opindex mxl-float-sqrt
15331 Use hardware floating-point square root instruction.
15333 @item -mxl-mode-@var{app-model}
15334 Select application model @var{app-model}.  Valid models are
15335 @table @samp
15336 @item executable
15337 normal executable (default), uses startup code @file{crt0.o}.
15339 @item xmdstub
15340 for use with Xilinx Microprocessor Debugger (XMD) based
15341 software intrusive debug agent called xmdstub. This uses startup file
15342 @file{crt1.o} and sets the start address of the program to be 0x800.
15344 @item bootstrap
15345 for applications that are loaded using a bootloader.
15346 This model uses startup file @file{crt2.o} which does not contain a processor
15347 reset vector handler. This is suitable for transferring control on a
15348 processor reset to the bootloader rather than the application.
15350 @item novectors
15351 for applications that do not require any of the
15352 MicroBlaze vectors. This option may be useful for applications running
15353 within a monitoring application. This model uses @file{crt3.o} as a startup file.
15354 @end table
15356 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
15357 @option{-mxl-mode-@var{app-model}}.
15359 @end table
15361 @node MIPS Options
15362 @subsection MIPS Options
15363 @cindex MIPS options
15365 @table @gcctabopt
15367 @item -EB
15368 @opindex EB
15369 Generate big-endian code.
15371 @item -EL
15372 @opindex EL
15373 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
15374 configurations.
15376 @item -march=@var{arch}
15377 @opindex march
15378 Generate code that runs on @var{arch}, which can be the name of a
15379 generic MIPS ISA, or the name of a particular processor.
15380 The ISA names are:
15381 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
15382 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
15383 The processor names are:
15384 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
15385 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
15386 @samp{5kc}, @samp{5kf},
15387 @samp{20kc},
15388 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
15389 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
15390 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
15391 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
15392 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
15393 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
15394 @samp{m4k},
15395 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
15396 @samp{orion},
15397 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
15398 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
15399 @samp{rm7000}, @samp{rm9000},
15400 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
15401 @samp{sb1},
15402 @samp{sr71000},
15403 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
15404 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
15405 @samp{xlr} and @samp{xlp}.
15406 The special value @samp{from-abi} selects the
15407 most compatible architecture for the selected ABI (that is,
15408 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
15410 The native Linux/GNU toolchain also supports the value @samp{native},
15411 which selects the best architecture option for the host processor.
15412 @option{-march=native} has no effect if GCC does not recognize
15413 the processor.
15415 In processor names, a final @samp{000} can be abbreviated as @samp{k}
15416 (for example, @option{-march=r2k}).  Prefixes are optional, and
15417 @samp{vr} may be written @samp{r}.
15419 Names of the form @samp{@var{n}f2_1} refer to processors with
15420 FPUs clocked at half the rate of the core, names of the form
15421 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
15422 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
15423 processors with FPUs clocked a ratio of 3:2 with respect to the core.
15424 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
15425 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
15426 accepted as synonyms for @samp{@var{n}f1_1}.
15428 GCC defines two macros based on the value of this option.  The first
15429 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
15430 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
15431 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
15432 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
15433 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
15435 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
15436 above.  In other words, it has the full prefix and does not
15437 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
15438 the macro names the resolved architecture (either @samp{"mips1"} or
15439 @samp{"mips3"}).  It names the default architecture when no
15440 @option{-march} option is given.
15442 @item -mtune=@var{arch}
15443 @opindex mtune
15444 Optimize for @var{arch}.  Among other things, this option controls
15445 the way instructions are scheduled, and the perceived cost of arithmetic
15446 operations.  The list of @var{arch} values is the same as for
15447 @option{-march}.
15449 When this option is not used, GCC optimizes for the processor
15450 specified by @option{-march}.  By using @option{-march} and
15451 @option{-mtune} together, it is possible to generate code that
15452 runs on a family of processors, but optimize the code for one
15453 particular member of that family.
15455 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
15456 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
15457 @option{-march} ones described above.
15459 @item -mips1
15460 @opindex mips1
15461 Equivalent to @option{-march=mips1}.
15463 @item -mips2
15464 @opindex mips2
15465 Equivalent to @option{-march=mips2}.
15467 @item -mips3
15468 @opindex mips3
15469 Equivalent to @option{-march=mips3}.
15471 @item -mips4
15472 @opindex mips4
15473 Equivalent to @option{-march=mips4}.
15475 @item -mips32
15476 @opindex mips32
15477 Equivalent to @option{-march=mips32}.
15479 @item -mips32r2
15480 @opindex mips32r2
15481 Equivalent to @option{-march=mips32r2}.
15483 @item -mips64
15484 @opindex mips64
15485 Equivalent to @option{-march=mips64}.
15487 @item -mips64r2
15488 @opindex mips64r2
15489 Equivalent to @option{-march=mips64r2}.
15491 @item -mips16
15492 @itemx -mno-mips16
15493 @opindex mips16
15494 @opindex mno-mips16
15495 Generate (do not generate) MIPS16 code.  If GCC is targeting a
15496 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
15498 MIPS16 code generation can also be controlled on a per-function basis
15499 by means of @code{mips16} and @code{nomips16} attributes.
15500 @xref{Function Attributes}, for more information.
15502 @item -mflip-mips16
15503 @opindex mflip-mips16
15504 Generate MIPS16 code on alternating functions.  This option is provided
15505 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
15506 not intended for ordinary use in compiling user code.
15508 @item -minterlink-mips16
15509 @itemx -mno-interlink-mips16
15510 @opindex minterlink-mips16
15511 @opindex mno-interlink-mips16
15512 Require (do not require) that non-MIPS16 code be link-compatible with
15513 MIPS16 code.
15515 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
15516 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
15517 therefore disables direct jumps unless GCC knows that the target of the
15518 jump is not MIPS16.
15520 @item -mabi=32
15521 @itemx -mabi=o64
15522 @itemx -mabi=n32
15523 @itemx -mabi=64
15524 @itemx -mabi=eabi
15525 @opindex mabi=32
15526 @opindex mabi=o64
15527 @opindex mabi=n32
15528 @opindex mabi=64
15529 @opindex mabi=eabi
15530 Generate code for the given ABI@.
15532 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
15533 generates 64-bit code when you select a 64-bit architecture, but you
15534 can use @option{-mgp32} to get 32-bit code instead.
15536 For information about the O64 ABI, see
15537 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
15539 GCC supports a variant of the o32 ABI in which floating-point registers
15540 are 64 rather than 32 bits wide.  You can select this combination with
15541 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
15542 and @code{mfhc1} instructions and is therefore only supported for
15543 MIPS32R2 processors.
15545 The register assignments for arguments and return values remain the
15546 same, but each scalar value is passed in a single 64-bit register
15547 rather than a pair of 32-bit registers.  For example, scalar
15548 floating-point values are returned in @samp{$f0} only, not a
15549 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
15550 remains the same, but all 64 bits are saved.
15552 @item -mabicalls
15553 @itemx -mno-abicalls
15554 @opindex mabicalls
15555 @opindex mno-abicalls
15556 Generate (do not generate) code that is suitable for SVR4-style
15557 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
15558 systems.
15560 @item -mshared
15561 @itemx -mno-shared
15562 Generate (do not generate) code that is fully position-independent,
15563 and that can therefore be linked into shared libraries.  This option
15564 only affects @option{-mabicalls}.
15566 All @option{-mabicalls} code has traditionally been position-independent,
15567 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
15568 as an extension, the GNU toolchain allows executables to use absolute
15569 accesses for locally-binding symbols.  It can also use shorter GP
15570 initialization sequences and generate direct calls to locally-defined
15571 functions.  This mode is selected by @option{-mno-shared}.
15573 @option{-mno-shared} depends on binutils 2.16 or higher and generates
15574 objects that can only be linked by the GNU linker.  However, the option
15575 does not affect the ABI of the final executable; it only affects the ABI
15576 of relocatable objects.  Using @option{-mno-shared} generally makes
15577 executables both smaller and quicker.
15579 @option{-mshared} is the default.
15581 @item -mplt
15582 @itemx -mno-plt
15583 @opindex mplt
15584 @opindex mno-plt
15585 Assume (do not assume) that the static and dynamic linkers
15586 support PLTs and copy relocations.  This option only affects
15587 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
15588 has no effect without @option{-msym32}.
15590 You can make @option{-mplt} the default by configuring
15591 GCC with @option{--with-mips-plt}.  The default is
15592 @option{-mno-plt} otherwise.
15594 @item -mxgot
15595 @itemx -mno-xgot
15596 @opindex mxgot
15597 @opindex mno-xgot
15598 Lift (do not lift) the usual restrictions on the size of the global
15599 offset table.
15601 GCC normally uses a single instruction to load values from the GOT@.
15602 While this is relatively efficient, it only works if the GOT
15603 is smaller than about 64k.  Anything larger causes the linker
15604 to report an error such as:
15606 @cindex relocation truncated to fit (MIPS)
15607 @smallexample
15608 relocation truncated to fit: R_MIPS_GOT16 foobar
15609 @end smallexample
15611 If this happens, you should recompile your code with @option{-mxgot}.
15612 This works with very large GOTs, although the code is also
15613 less efficient, since it takes three instructions to fetch the
15614 value of a global symbol.
15616 Note that some linkers can create multiple GOTs.  If you have such a
15617 linker, you should only need to use @option{-mxgot} when a single object
15618 file accesses more than 64k's worth of GOT entries.  Very few do.
15620 These options have no effect unless GCC is generating position
15621 independent code.
15623 @item -mgp32
15624 @opindex mgp32
15625 Assume that general-purpose registers are 32 bits wide.
15627 @item -mgp64
15628 @opindex mgp64
15629 Assume that general-purpose registers are 64 bits wide.
15631 @item -mfp32
15632 @opindex mfp32
15633 Assume that floating-point registers are 32 bits wide.
15635 @item -mfp64
15636 @opindex mfp64
15637 Assume that floating-point registers are 64 bits wide.
15639 @item -mhard-float
15640 @opindex mhard-float
15641 Use floating-point coprocessor instructions.
15643 @item -msoft-float
15644 @opindex msoft-float
15645 Do not use floating-point coprocessor instructions.  Implement
15646 floating-point calculations using library calls instead.
15648 @item -msingle-float
15649 @opindex msingle-float
15650 Assume that the floating-point coprocessor only supports single-precision
15651 operations.
15653 @item -mdouble-float
15654 @opindex mdouble-float
15655 Assume that the floating-point coprocessor supports double-precision
15656 operations.  This is the default.
15658 @item -mllsc
15659 @itemx -mno-llsc
15660 @opindex mllsc
15661 @opindex mno-llsc
15662 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
15663 implement atomic memory built-in functions.  When neither option is
15664 specified, GCC uses the instructions if the target architecture
15665 supports them.
15667 @option{-mllsc} is useful if the runtime environment can emulate the
15668 instructions and @option{-mno-llsc} can be useful when compiling for
15669 nonstandard ISAs.  You can make either option the default by
15670 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
15671 respectively.  @option{--with-llsc} is the default for some
15672 configurations; see the installation documentation for details.
15674 @item -mdsp
15675 @itemx -mno-dsp
15676 @opindex mdsp
15677 @opindex mno-dsp
15678 Use (do not use) revision 1 of the MIPS DSP ASE@.
15679 @xref{MIPS DSP Built-in Functions}.  This option defines the
15680 preprocessor macro @samp{__mips_dsp}.  It also defines
15681 @samp{__mips_dsp_rev} to 1.
15683 @item -mdspr2
15684 @itemx -mno-dspr2
15685 @opindex mdspr2
15686 @opindex mno-dspr2
15687 Use (do not use) revision 2 of the MIPS DSP ASE@.
15688 @xref{MIPS DSP Built-in Functions}.  This option defines the
15689 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
15690 It also defines @samp{__mips_dsp_rev} to 2.
15692 @item -msmartmips
15693 @itemx -mno-smartmips
15694 @opindex msmartmips
15695 @opindex mno-smartmips
15696 Use (do not use) the MIPS SmartMIPS ASE.
15698 @item -mpaired-single
15699 @itemx -mno-paired-single
15700 @opindex mpaired-single
15701 @opindex mno-paired-single
15702 Use (do not use) paired-single floating-point instructions.
15703 @xref{MIPS Paired-Single Support}.  This option requires
15704 hardware floating-point support to be enabled.
15706 @item -mdmx
15707 @itemx -mno-mdmx
15708 @opindex mdmx
15709 @opindex mno-mdmx
15710 Use (do not use) MIPS Digital Media Extension instructions.
15711 This option can only be used when generating 64-bit code and requires
15712 hardware floating-point support to be enabled.
15714 @item -mips3d
15715 @itemx -mno-mips3d
15716 @opindex mips3d
15717 @opindex mno-mips3d
15718 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
15719 The option @option{-mips3d} implies @option{-mpaired-single}.
15721 @item -mmt
15722 @itemx -mno-mt
15723 @opindex mmt
15724 @opindex mno-mt
15725 Use (do not use) MT Multithreading instructions.
15727 @item -mmcu
15728 @itemx -mno-mcu
15729 @opindex mmcu
15730 @opindex mno-mcu
15731 Use (do not use) the MIPS MCU ASE instructions.
15733 @item -mlong64
15734 @opindex mlong64
15735 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
15736 an explanation of the default and the way that the pointer size is
15737 determined.
15739 @item -mlong32
15740 @opindex mlong32
15741 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
15743 The default size of @code{int}s, @code{long}s and pointers depends on
15744 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
15745 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
15746 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
15747 or the same size as integer registers, whichever is smaller.
15749 @item -msym32
15750 @itemx -mno-sym32
15751 @opindex msym32
15752 @opindex mno-sym32
15753 Assume (do not assume) that all symbols have 32-bit values, regardless
15754 of the selected ABI@.  This option is useful in combination with
15755 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
15756 to generate shorter and faster references to symbolic addresses.
15758 @item -G @var{num}
15759 @opindex G
15760 Put definitions of externally-visible data in a small data section
15761 if that data is no bigger than @var{num} bytes.  GCC can then access
15762 the data more efficiently; see @option{-mgpopt} for details.
15764 The default @option{-G} option depends on the configuration.
15766 @item -mlocal-sdata
15767 @itemx -mno-local-sdata
15768 @opindex mlocal-sdata
15769 @opindex mno-local-sdata
15770 Extend (do not extend) the @option{-G} behavior to local data too,
15771 such as to static variables in C@.  @option{-mlocal-sdata} is the
15772 default for all configurations.
15774 If the linker complains that an application is using too much small data,
15775 you might want to try rebuilding the less performance-critical parts with
15776 @option{-mno-local-sdata}.  You might also want to build large
15777 libraries with @option{-mno-local-sdata}, so that the libraries leave
15778 more room for the main program.
15780 @item -mextern-sdata
15781 @itemx -mno-extern-sdata
15782 @opindex mextern-sdata
15783 @opindex mno-extern-sdata
15784 Assume (do not assume) that externally-defined data is in
15785 a small data section if the size of that data is within the @option{-G} limit.
15786 @option{-mextern-sdata} is the default for all configurations.
15788 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
15789 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
15790 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
15791 is placed in a small data section.  If @var{Var} is defined by another
15792 module, you must either compile that module with a high-enough
15793 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
15794 definition.  If @var{Var} is common, you must link the application
15795 with a high-enough @option{-G} setting.
15797 The easiest way of satisfying these restrictions is to compile
15798 and link every module with the same @option{-G} option.  However,
15799 you may wish to build a library that supports several different
15800 small data limits.  You can do this by compiling the library with
15801 the highest supported @option{-G} setting and additionally using
15802 @option{-mno-extern-sdata} to stop the library from making assumptions
15803 about externally-defined data.
15805 @item -mgpopt
15806 @itemx -mno-gpopt
15807 @opindex mgpopt
15808 @opindex mno-gpopt
15809 Use (do not use) GP-relative accesses for symbols that are known to be
15810 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
15811 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
15812 configurations.
15814 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
15815 might not hold the value of @code{_gp}.  For example, if the code is
15816 part of a library that might be used in a boot monitor, programs that
15817 call boot monitor routines pass an unknown value in @code{$gp}.
15818 (In such situations, the boot monitor itself is usually compiled
15819 with @option{-G0}.)
15821 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
15822 @option{-mno-extern-sdata}.
15824 @item -membedded-data
15825 @itemx -mno-embedded-data
15826 @opindex membedded-data
15827 @opindex mno-embedded-data
15828 Allocate variables to the read-only data section first if possible, then
15829 next in the small data section if possible, otherwise in data.  This gives
15830 slightly slower code than the default, but reduces the amount of RAM required
15831 when executing, and thus may be preferred for some embedded systems.
15833 @item -muninit-const-in-rodata
15834 @itemx -mno-uninit-const-in-rodata
15835 @opindex muninit-const-in-rodata
15836 @opindex mno-uninit-const-in-rodata
15837 Put uninitialized @code{const} variables in the read-only data section.
15838 This option is only meaningful in conjunction with @option{-membedded-data}.
15840 @item -mcode-readable=@var{setting}
15841 @opindex mcode-readable
15842 Specify whether GCC may generate code that reads from executable sections.
15843 There are three possible settings:
15845 @table @gcctabopt
15846 @item -mcode-readable=yes
15847 Instructions may freely access executable sections.  This is the
15848 default setting.
15850 @item -mcode-readable=pcrel
15851 MIPS16 PC-relative load instructions can access executable sections,
15852 but other instructions must not do so.  This option is useful on 4KSc
15853 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
15854 It is also useful on processors that can be configured to have a dual
15855 instruction/data SRAM interface and that, like the M4K, automatically
15856 redirect PC-relative loads to the instruction RAM.
15858 @item -mcode-readable=no
15859 Instructions must not access executable sections.  This option can be
15860 useful on targets that are configured to have a dual instruction/data
15861 SRAM interface but that (unlike the M4K) do not automatically redirect
15862 PC-relative loads to the instruction RAM.
15863 @end table
15865 @item -msplit-addresses
15866 @itemx -mno-split-addresses
15867 @opindex msplit-addresses
15868 @opindex mno-split-addresses
15869 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
15870 relocation operators.  This option has been superseded by
15871 @option{-mexplicit-relocs} but is retained for backwards compatibility.
15873 @item -mexplicit-relocs
15874 @itemx -mno-explicit-relocs
15875 @opindex mexplicit-relocs
15876 @opindex mno-explicit-relocs
15877 Use (do not use) assembler relocation operators when dealing with symbolic
15878 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
15879 is to use assembler macros instead.
15881 @option{-mexplicit-relocs} is the default if GCC was configured
15882 to use an assembler that supports relocation operators.
15884 @item -mcheck-zero-division
15885 @itemx -mno-check-zero-division
15886 @opindex mcheck-zero-division
15887 @opindex mno-check-zero-division
15888 Trap (do not trap) on integer division by zero.
15890 The default is @option{-mcheck-zero-division}.
15892 @item -mdivide-traps
15893 @itemx -mdivide-breaks
15894 @opindex mdivide-traps
15895 @opindex mdivide-breaks
15896 MIPS systems check for division by zero by generating either a
15897 conditional trap or a break instruction.  Using traps results in
15898 smaller code, but is only supported on MIPS II and later.  Also, some
15899 versions of the Linux kernel have a bug that prevents trap from
15900 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
15901 allow conditional traps on architectures that support them and
15902 @option{-mdivide-breaks} to force the use of breaks.
15904 The default is usually @option{-mdivide-traps}, but this can be
15905 overridden at configure time using @option{--with-divide=breaks}.
15906 Divide-by-zero checks can be completely disabled using
15907 @option{-mno-check-zero-division}.
15909 @item -mmemcpy
15910 @itemx -mno-memcpy
15911 @opindex mmemcpy
15912 @opindex mno-memcpy
15913 Force (do not force) the use of @code{memcpy()} for non-trivial block
15914 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
15915 most constant-sized copies.
15917 @item -mlong-calls
15918 @itemx -mno-long-calls
15919 @opindex mlong-calls
15920 @opindex mno-long-calls
15921 Disable (do not disable) use of the @code{jal} instruction.  Calling
15922 functions using @code{jal} is more efficient but requires the caller
15923 and callee to be in the same 256 megabyte segment.
15925 This option has no effect on abicalls code.  The default is
15926 @option{-mno-long-calls}.
15928 @item -mmad
15929 @itemx -mno-mad
15930 @opindex mmad
15931 @opindex mno-mad
15932 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
15933 instructions, as provided by the R4650 ISA@.
15935 @item -mfused-madd
15936 @itemx -mno-fused-madd
15937 @opindex mfused-madd
15938 @opindex mno-fused-madd
15939 Enable (disable) use of the floating-point multiply-accumulate
15940 instructions, when they are available.  The default is
15941 @option{-mfused-madd}.
15943 When multiply-accumulate instructions are used, the intermediate
15944 product is calculated to infinite precision and is not subject to
15945 the FCSR Flush to Zero bit.  This may be undesirable in some
15946 circumstances.
15948 @item -nocpp
15949 @opindex nocpp
15950 Tell the MIPS assembler to not run its preprocessor over user
15951 assembler files (with a @samp{.s} suffix) when assembling them.
15953 @item -mfix-24k
15954 @item -mno-fix-24k
15955 @opindex mfix-24k
15956 @opindex mno-fix-24k
15957 Work around the 24K E48 (lost data on stores during refill) errata.
15958 The workarounds are implemented by the assembler rather than by GCC@.
15960 @item -mfix-r4000
15961 @itemx -mno-fix-r4000
15962 @opindex mfix-r4000
15963 @opindex mno-fix-r4000
15964 Work around certain R4000 CPU errata:
15965 @itemize @minus
15966 @item
15967 A double-word or a variable shift may give an incorrect result if executed
15968 immediately after starting an integer division.
15969 @item
15970 A double-word or a variable shift may give an incorrect result if executed
15971 while an integer multiplication is in progress.
15972 @item
15973 An integer division may give an incorrect result if started in a delay slot
15974 of a taken branch or a jump.
15975 @end itemize
15977 @item -mfix-r4400
15978 @itemx -mno-fix-r4400
15979 @opindex mfix-r4400
15980 @opindex mno-fix-r4400
15981 Work around certain R4400 CPU errata:
15982 @itemize @minus
15983 @item
15984 A double-word or a variable shift may give an incorrect result if executed
15985 immediately after starting an integer division.
15986 @end itemize
15988 @item -mfix-r10000
15989 @itemx -mno-fix-r10000
15990 @opindex mfix-r10000
15991 @opindex mno-fix-r10000
15992 Work around certain R10000 errata:
15993 @itemize @minus
15994 @item
15995 @code{ll}/@code{sc} sequences may not behave atomically on revisions
15996 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
15997 @end itemize
15999 This option can only be used if the target architecture supports
16000 branch-likely instructions.  @option{-mfix-r10000} is the default when
16001 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
16002 otherwise.
16004 @item -mfix-vr4120
16005 @itemx -mno-fix-vr4120
16006 @opindex mfix-vr4120
16007 Work around certain VR4120 errata:
16008 @itemize @minus
16009 @item
16010 @code{dmultu} does not always produce the correct result.
16011 @item
16012 @code{div} and @code{ddiv} do not always produce the correct result if one
16013 of the operands is negative.
16014 @end itemize
16015 The workarounds for the division errata rely on special functions in
16016 @file{libgcc.a}.  At present, these functions are only provided by
16017 the @code{mips64vr*-elf} configurations.
16019 Other VR4120 errata require a nop to be inserted between certain pairs of
16020 instructions.  These errata are handled by the assembler, not by GCC itself.
16022 @item -mfix-vr4130
16023 @opindex mfix-vr4130
16024 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
16025 workarounds are implemented by the assembler rather than by GCC,
16026 although GCC avoids using @code{mflo} and @code{mfhi} if the
16027 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
16028 instructions are available instead.
16030 @item -mfix-sb1
16031 @itemx -mno-fix-sb1
16032 @opindex mfix-sb1
16033 Work around certain SB-1 CPU core errata.
16034 (This flag currently works around the SB-1 revision 2
16035 ``F1'' and ``F2'' floating-point errata.)
16037 @item -mr10k-cache-barrier=@var{setting}
16038 @opindex mr10k-cache-barrier
16039 Specify whether GCC should insert cache barriers to avoid the
16040 side-effects of speculation on R10K processors.
16042 In common with many processors, the R10K tries to predict the outcome
16043 of a conditional branch and speculatively executes instructions from
16044 the ``taken'' branch.  It later aborts these instructions if the
16045 predicted outcome is wrong.  However, on the R10K, even aborted
16046 instructions can have side effects.
16048 This problem only affects kernel stores and, depending on the system,
16049 kernel loads.  As an example, a speculatively-executed store may load
16050 the target memory into cache and mark the cache line as dirty, even if
16051 the store itself is later aborted.  If a DMA operation writes to the
16052 same area of memory before the ``dirty'' line is flushed, the cached
16053 data overwrites the DMA-ed data.  See the R10K processor manual
16054 for a full description, including other potential problems.
16056 One workaround is to insert cache barrier instructions before every memory
16057 access that might be speculatively executed and that might have side
16058 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
16059 controls GCC's implementation of this workaround.  It assumes that
16060 aborted accesses to any byte in the following regions does not have
16061 side effects:
16063 @enumerate
16064 @item
16065 the memory occupied by the current function's stack frame;
16067 @item
16068 the memory occupied by an incoming stack argument;
16070 @item
16071 the memory occupied by an object with a link-time-constant address.
16072 @end enumerate
16074 It is the kernel's responsibility to ensure that speculative
16075 accesses to these regions are indeed safe.
16077 If the input program contains a function declaration such as:
16079 @smallexample
16080 void foo (void);
16081 @end smallexample
16083 then the implementation of @code{foo} must allow @code{j foo} and
16084 @code{jal foo} to be executed speculatively.  GCC honors this
16085 restriction for functions it compiles itself.  It expects non-GCC
16086 functions (such as hand-written assembly code) to do the same.
16088 The option has three forms:
16090 @table @gcctabopt
16091 @item -mr10k-cache-barrier=load-store
16092 Insert a cache barrier before a load or store that might be
16093 speculatively executed and that might have side effects even
16094 if aborted.
16096 @item -mr10k-cache-barrier=store
16097 Insert a cache barrier before a store that might be speculatively
16098 executed and that might have side effects even if aborted.
16100 @item -mr10k-cache-barrier=none
16101 Disable the insertion of cache barriers.  This is the default setting.
16102 @end table
16104 @item -mflush-func=@var{func}
16105 @itemx -mno-flush-func
16106 @opindex mflush-func
16107 Specifies the function to call to flush the I and D caches, or to not
16108 call any such function.  If called, the function must take the same
16109 arguments as the common @code{_flush_func()}, that is, the address of the
16110 memory range for which the cache is being flushed, the size of the
16111 memory range, and the number 3 (to flush both caches).  The default
16112 depends on the target GCC was configured for, but commonly is either
16113 @samp{_flush_func} or @samp{__cpu_flush}.
16115 @item mbranch-cost=@var{num}
16116 @opindex mbranch-cost
16117 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16118 This cost is only a heuristic and is not guaranteed to produce
16119 consistent results across releases.  A zero cost redundantly selects
16120 the default, which is based on the @option{-mtune} setting.
16122 @item -mbranch-likely
16123 @itemx -mno-branch-likely
16124 @opindex mbranch-likely
16125 @opindex mno-branch-likely
16126 Enable or disable use of Branch Likely instructions, regardless of the
16127 default for the selected architecture.  By default, Branch Likely
16128 instructions may be generated if they are supported by the selected
16129 architecture.  An exception is for the MIPS32 and MIPS64 architectures
16130 and processors that implement those architectures; for those, Branch
16131 Likely instructions are not be generated by default because the MIPS32
16132 and MIPS64 architectures specifically deprecate their use.
16134 @item -mfp-exceptions
16135 @itemx -mno-fp-exceptions
16136 @opindex mfp-exceptions
16137 Specifies whether FP exceptions are enabled.  This affects how
16138 FP instructions are scheduled for some processors.
16139 The default is that FP exceptions are
16140 enabled.
16142 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16143 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
16144 FP pipe.
16146 @item -mvr4130-align
16147 @itemx -mno-vr4130-align
16148 @opindex mvr4130-align
16149 The VR4130 pipeline is two-way superscalar, but can only issue two
16150 instructions together if the first one is 8-byte aligned.  When this
16151 option is enabled, GCC aligns pairs of instructions that it
16152 thinks should execute in parallel.
16154 This option only has an effect when optimizing for the VR4130.
16155 It normally makes code faster, but at the expense of making it bigger.
16156 It is enabled by default at optimization level @option{-O3}.
16158 @item -msynci
16159 @itemx -mno-synci
16160 @opindex msynci
16161 Enable (disable) generation of @code{synci} instructions on
16162 architectures that support it.  The @code{synci} instructions (if
16163 enabled) are generated when @code{__builtin___clear_cache()} is
16164 compiled.
16166 This option defaults to @code{-mno-synci}, but the default can be
16167 overridden by configuring with @code{--with-synci}.
16169 When compiling code for single processor systems, it is generally safe
16170 to use @code{synci}.  However, on many multi-core (SMP) systems, it
16171 does not invalidate the instruction caches on all cores and may lead
16172 to undefined behavior.
16174 @item -mrelax-pic-calls
16175 @itemx -mno-relax-pic-calls
16176 @opindex mrelax-pic-calls
16177 Try to turn PIC calls that are normally dispatched via register
16178 @code{$25} into direct calls.  This is only possible if the linker can
16179 resolve the destination at link-time and if the destination is within
16180 range for a direct call.
16182 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16183 an assembler and a linker that supports the @code{.reloc} assembly
16184 directive and @code{-mexplicit-relocs} is in effect.  With
16185 @code{-mno-explicit-relocs}, this optimization can be performed by the
16186 assembler and the linker alone without help from the compiler.
16188 @item -mmcount-ra-address
16189 @itemx -mno-mcount-ra-address
16190 @opindex mmcount-ra-address
16191 @opindex mno-mcount-ra-address
16192 Emit (do not emit) code that allows @code{_mcount} to modify the
16193 calling function's return address.  When enabled, this option extends
16194 the usual @code{_mcount} interface with a new @var{ra-address}
16195 parameter, which has type @code{intptr_t *} and is passed in register
16196 @code{$12}.  @code{_mcount} can then modify the return address by
16197 doing both of the following:
16198 @itemize
16199 @item
16200 Returning the new address in register @code{$31}.
16201 @item
16202 Storing the new address in @code{*@var{ra-address}},
16203 if @var{ra-address} is nonnull.
16204 @end itemize
16206 The default is @option{-mno-mcount-ra-address}.
16208 @end table
16210 @node MMIX Options
16211 @subsection MMIX Options
16212 @cindex MMIX Options
16214 These options are defined for the MMIX:
16216 @table @gcctabopt
16217 @item -mlibfuncs
16218 @itemx -mno-libfuncs
16219 @opindex mlibfuncs
16220 @opindex mno-libfuncs
16221 Specify that intrinsic library functions are being compiled, passing all
16222 values in registers, no matter the size.
16224 @item -mepsilon
16225 @itemx -mno-epsilon
16226 @opindex mepsilon
16227 @opindex mno-epsilon
16228 Generate floating-point comparison instructions that compare with respect
16229 to the @code{rE} epsilon register.
16231 @item -mabi=mmixware
16232 @itemx -mabi=gnu
16233 @opindex mabi=mmixware
16234 @opindex mabi=gnu
16235 Generate code that passes function parameters and return values that (in
16236 the called function) are seen as registers @code{$0} and up, as opposed to
16237 the GNU ABI which uses global registers @code{$231} and up.
16239 @item -mzero-extend
16240 @itemx -mno-zero-extend
16241 @opindex mzero-extend
16242 @opindex mno-zero-extend
16243 When reading data from memory in sizes shorter than 64 bits, use (do not
16244 use) zero-extending load instructions by default, rather than
16245 sign-extending ones.
16247 @item -mknuthdiv
16248 @itemx -mno-knuthdiv
16249 @opindex mknuthdiv
16250 @opindex mno-knuthdiv
16251 Make the result of a division yielding a remainder have the same sign as
16252 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
16253 remainder follows the sign of the dividend.  Both methods are
16254 arithmetically valid, the latter being almost exclusively used.
16256 @item -mtoplevel-symbols
16257 @itemx -mno-toplevel-symbols
16258 @opindex mtoplevel-symbols
16259 @opindex mno-toplevel-symbols
16260 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
16261 code can be used with the @code{PREFIX} assembly directive.
16263 @item -melf
16264 @opindex melf
16265 Generate an executable in the ELF format, rather than the default
16266 @samp{mmo} format used by the @command{mmix} simulator.
16268 @item -mbranch-predict
16269 @itemx -mno-branch-predict
16270 @opindex mbranch-predict
16271 @opindex mno-branch-predict
16272 Use (do not use) the probable-branch instructions, when static branch
16273 prediction indicates a probable branch.
16275 @item -mbase-addresses
16276 @itemx -mno-base-addresses
16277 @opindex mbase-addresses
16278 @opindex mno-base-addresses
16279 Generate (do not generate) code that uses @emph{base addresses}.  Using a
16280 base address automatically generates a request (handled by the assembler
16281 and the linker) for a constant to be set up in a global register.  The
16282 register is used for one or more base address requests within the range 0
16283 to 255 from the value held in the register.  The generally leads to short
16284 and fast code, but the number of different data items that can be
16285 addressed is limited.  This means that a program that uses lots of static
16286 data may require @option{-mno-base-addresses}.
16288 @item -msingle-exit
16289 @itemx -mno-single-exit
16290 @opindex msingle-exit
16291 @opindex mno-single-exit
16292 Force (do not force) generated code to have a single exit point in each
16293 function.
16294 @end table
16296 @node MN10300 Options
16297 @subsection MN10300 Options
16298 @cindex MN10300 options
16300 These @option{-m} options are defined for Matsushita MN10300 architectures:
16302 @table @gcctabopt
16303 @item -mmult-bug
16304 @opindex mmult-bug
16305 Generate code to avoid bugs in the multiply instructions for the MN10300
16306 processors.  This is the default.
16308 @item -mno-mult-bug
16309 @opindex mno-mult-bug
16310 Do not generate code to avoid bugs in the multiply instructions for the
16311 MN10300 processors.
16313 @item -mam33
16314 @opindex mam33
16315 Generate code using features specific to the AM33 processor.
16317 @item -mno-am33
16318 @opindex mno-am33
16319 Do not generate code using features specific to the AM33 processor.  This
16320 is the default.
16322 @item -mam33-2
16323 @opindex mam33-2
16324 Generate code using features specific to the AM33/2.0 processor.
16326 @item -mam34
16327 @opindex mam34
16328 Generate code using features specific to the AM34 processor.
16330 @item -mtune=@var{cpu-type}
16331 @opindex mtune
16332 Use the timing characteristics of the indicated CPU type when
16333 scheduling instructions.  This does not change the targeted processor
16334 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
16335 @samp{am33-2} or @samp{am34}.
16337 @item -mreturn-pointer-on-d0
16338 @opindex mreturn-pointer-on-d0
16339 When generating a function that returns a pointer, return the pointer
16340 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
16341 only in @code{a0}, and attempts to call such functions without a prototype
16342 result in errors.  Note that this option is on by default; use
16343 @option{-mno-return-pointer-on-d0} to disable it.
16345 @item -mno-crt0
16346 @opindex mno-crt0
16347 Do not link in the C run-time initialization object file.
16349 @item -mrelax
16350 @opindex mrelax
16351 Indicate to the linker that it should perform a relaxation optimization pass
16352 to shorten branches, calls and absolute memory addresses.  This option only
16353 has an effect when used on the command line for the final link step.
16355 This option makes symbolic debugging impossible.
16357 @item -mliw
16358 @opindex mliw
16359 Allow the compiler to generate @emph{Long Instruction Word}
16360 instructions if the target is the @samp{AM33} or later.  This is the
16361 default.  This option defines the preprocessor macro @samp{__LIW__}.
16363 @item -mnoliw
16364 @opindex mnoliw
16365 Do not allow the compiler to generate @emph{Long Instruction Word}
16366 instructions.  This option defines the preprocessor macro
16367 @samp{__NO_LIW__}.
16369 @item -msetlb
16370 @opindex msetlb
16371 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
16372 instructions if the target is the @samp{AM33} or later.  This is the
16373 default.  This option defines the preprocessor macro @samp{__SETLB__}.
16375 @item -mnosetlb
16376 @opindex mnosetlb
16377 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
16378 instructions.  This option defines the preprocessor macro
16379 @samp{__NO_SETLB__}.
16381 @end table
16383 @node PDP-11 Options
16384 @subsection PDP-11 Options
16385 @cindex PDP-11 Options
16387 These options are defined for the PDP-11:
16389 @table @gcctabopt
16390 @item -mfpu
16391 @opindex mfpu
16392 Use hardware FPP floating point.  This is the default.  (FIS floating
16393 point on the PDP-11/40 is not supported.)
16395 @item -msoft-float
16396 @opindex msoft-float
16397 Do not use hardware floating point.
16399 @item -mac0
16400 @opindex mac0
16401 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
16403 @item -mno-ac0
16404 @opindex mno-ac0
16405 Return floating-point results in memory.  This is the default.
16407 @item -m40
16408 @opindex m40
16409 Generate code for a PDP-11/40.
16411 @item -m45
16412 @opindex m45
16413 Generate code for a PDP-11/45.  This is the default.
16415 @item -m10
16416 @opindex m10
16417 Generate code for a PDP-11/10.
16419 @item -mbcopy-builtin
16420 @opindex mbcopy-builtin
16421 Use inline @code{movmemhi} patterns for copying memory.  This is the
16422 default.
16424 @item -mbcopy
16425 @opindex mbcopy
16426 Do not use inline @code{movmemhi} patterns for copying memory.
16428 @item -mint16
16429 @itemx -mno-int32
16430 @opindex mint16
16431 @opindex mno-int32
16432 Use 16-bit @code{int}.  This is the default.
16434 @item -mint32
16435 @itemx -mno-int16
16436 @opindex mint32
16437 @opindex mno-int16
16438 Use 32-bit @code{int}.
16440 @item -mfloat64
16441 @itemx -mno-float32
16442 @opindex mfloat64
16443 @opindex mno-float32
16444 Use 64-bit @code{float}.  This is the default.
16446 @item -mfloat32
16447 @itemx -mno-float64
16448 @opindex mfloat32
16449 @opindex mno-float64
16450 Use 32-bit @code{float}.
16452 @item -mabshi
16453 @opindex mabshi
16454 Use @code{abshi2} pattern.  This is the default.
16456 @item -mno-abshi
16457 @opindex mno-abshi
16458 Do not use @code{abshi2} pattern.
16460 @item -mbranch-expensive
16461 @opindex mbranch-expensive
16462 Pretend that branches are expensive.  This is for experimenting with
16463 code generation only.
16465 @item -mbranch-cheap
16466 @opindex mbranch-cheap
16467 Do not pretend that branches are expensive.  This is the default.
16469 @item -munix-asm
16470 @opindex munix-asm
16471 Use Unix assembler syntax.  This is the default when configured for
16472 @samp{pdp11-*-bsd}.
16474 @item -mdec-asm
16475 @opindex mdec-asm
16476 Use DEC assembler syntax.  This is the default when configured for any
16477 PDP-11 target other than @samp{pdp11-*-bsd}.
16478 @end table
16480 @node picoChip Options
16481 @subsection picoChip Options
16482 @cindex picoChip options
16484 These @samp{-m} options are defined for picoChip implementations:
16486 @table @gcctabopt
16488 @item -mae=@var{ae_type}
16489 @opindex mcpu
16490 Set the instruction set, register set, and instruction scheduling
16491 parameters for array element type @var{ae_type}.  Supported values
16492 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
16494 @option{-mae=ANY} selects a completely generic AE type.  Code
16495 generated with this option runs on any of the other AE types.  The
16496 code is not as efficient as it would be if compiled for a specific
16497 AE type, and some types of operation (e.g., multiplication) do not
16498 work properly on all types of AE.
16500 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
16501 for compiled code, and is the default.
16503 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
16504 option may suffer from poor performance of byte (char) manipulation,
16505 since the DSP AE does not provide hardware support for byte load/stores.
16507 @item -msymbol-as-address
16508 Enable the compiler to directly use a symbol name as an address in a
16509 load/store instruction, without first loading it into a
16510 register.  Typically, the use of this option generates larger
16511 programs, which run faster than when the option isn't used.  However, the
16512 results vary from program to program, so it is left as a user option,
16513 rather than being permanently enabled.
16515 @item -mno-inefficient-warnings
16516 Disables warnings about the generation of inefficient code.  These
16517 warnings can be generated, for example, when compiling code that
16518 performs byte-level memory operations on the MAC AE type.  The MAC AE has
16519 no hardware support for byte-level memory operations, so all byte
16520 load/stores must be synthesized from word load/store operations.  This is
16521 inefficient and a warning is generated to indicate
16522 that you should rewrite the code to avoid byte operations, or to target
16523 an AE type that has the necessary hardware support.  This option disables
16524 these warnings.
16526 @end table
16528 @node PowerPC Options
16529 @subsection PowerPC Options
16530 @cindex PowerPC options
16532 These are listed under @xref{RS/6000 and PowerPC Options}.
16534 @node RL78 Options
16535 @subsection RL78 Options
16536 @cindex RL78 Options
16538 @table @gcctabopt
16540 @item -msim
16541 @opindex msim
16542 Links in additional target libraries to support operation within a
16543 simulator.
16545 @item -mmul=none
16546 @itemx -mmul=g13
16547 @itemx -mmul=rl78
16548 @opindex mmul
16549 Specifies the type of hardware multiplication support to be used.  The
16550 default is @code{none}, which uses software multiplication functions.
16551 The @code{g13} option is for the hardware multiply/divide peripheral
16552 only on the RL78/G13 targets.  The @code{rl78} option is for the
16553 standard hardware multiplication defined in the RL78 software manual.
16555 @end table
16557 @node RS/6000 and PowerPC Options
16558 @subsection IBM RS/6000 and PowerPC Options
16559 @cindex RS/6000 and PowerPC Options
16560 @cindex IBM RS/6000 and PowerPC Options
16562 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
16563 @table @gcctabopt
16564 @item -mpowerpc
16565 @itemx -mno-powerpc
16566 @itemx -mpowerpc-gpopt
16567 @itemx -mno-powerpc-gpopt
16568 @itemx -mpowerpc-gfxopt
16569 @itemx -mno-powerpc-gfxopt
16570 @need 800
16571 @itemx -mpowerpc64
16572 @itemx -mno-powerpc64
16573 @itemx -mmfcrf
16574 @itemx -mno-mfcrf
16575 @itemx -mpopcntb
16576 @itemx -mno-popcntb
16577 @itemx -mpopcntd
16578 @itemx -mno-popcntd
16579 @itemx -mfprnd
16580 @itemx -mno-fprnd
16581 @need 800
16582 @itemx -mcmpb
16583 @itemx -mno-cmpb
16584 @itemx -mmfpgpr
16585 @itemx -mno-mfpgpr
16586 @itemx -mhard-dfp
16587 @itemx -mno-hard-dfp
16588 @opindex mpowerpc
16589 @opindex mno-powerpc
16590 @opindex mpowerpc-gpopt
16591 @opindex mno-powerpc-gpopt
16592 @opindex mpowerpc-gfxopt
16593 @opindex mno-powerpc-gfxopt
16594 @opindex mpowerpc64
16595 @opindex mno-powerpc64
16596 @opindex mmfcrf
16597 @opindex mno-mfcrf
16598 @opindex mpopcntb
16599 @opindex mno-popcntb
16600 @opindex mpopcntd
16601 @opindex mno-popcntd
16602 @opindex mfprnd
16603 @opindex mno-fprnd
16604 @opindex mcmpb
16605 @opindex mno-cmpb
16606 @opindex mmfpgpr
16607 @opindex mno-mfpgpr
16608 @opindex mhard-dfp
16609 @opindex mno-hard-dfp
16610 GCC supports two related instruction set architectures for the
16611 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
16612 instructions supported by the @samp{rios} chip set used in the original
16613 RS/6000 systems and the @dfn{PowerPC} instruction set is the
16614 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
16615 the IBM 4xx, 6xx, and follow-on microprocessors.
16617 Neither architecture is a subset of the other.  However there is a
16618 large common subset of instructions supported by both.  An MQ
16619 register is included in processors supporting the POWER architecture.
16621 You use these options to specify which instructions are available on the
16622 processor you are using.  The default value of these options is
16623 determined when configuring GCC@.  Specifying the
16624 @option{-mcpu=@var{cpu_type}} overrides the specification of these
16625 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
16626 rather than the options listed above.
16628 The @option{-mpowerpc} option allows GCC to generate instructions that
16629 are found only in the 32-bit subset of the PowerPC architecture.
16630 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
16631 GCC to use the optional PowerPC architecture instructions in the
16632 General Purpose group, including floating-point square root.  Specifying
16633 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
16634 use the optional PowerPC architecture instructions in the Graphics
16635 group, including floating-point select.
16637 The @option{-mmfcrf} option allows GCC to generate the move from
16638 condition register field instruction implemented on the POWER4
16639 processor and other processors that support the PowerPC V2.01
16640 architecture.
16641 The @option{-mpopcntb} option allows GCC to generate the popcount and
16642 double-precision FP reciprocal estimate instruction implemented on the
16643 POWER5 processor and other processors that support the PowerPC V2.02
16644 architecture.
16645 The @option{-mpopcntd} option allows GCC to generate the popcount
16646 instruction implemented on the POWER7 processor and other processors
16647 that support the PowerPC V2.06 architecture.
16648 The @option{-mfprnd} option allows GCC to generate the FP round to
16649 integer instructions implemented on the POWER5+ processor and other
16650 processors that support the PowerPC V2.03 architecture.
16651 The @option{-mcmpb} option allows GCC to generate the compare bytes
16652 instruction implemented on the POWER6 processor and other processors
16653 that support the PowerPC V2.05 architecture.
16654 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
16655 general-purpose register instructions implemented on the POWER6X
16656 processor and other processors that support the extended PowerPC V2.05
16657 architecture.
16658 The @option{-mhard-dfp} option allows GCC to generate the decimal
16659 floating-point instructions implemented on some POWER processors.
16661 The @option{-mpowerpc64} option allows GCC to generate the additional
16662 64-bit instructions that are found in the full PowerPC64 architecture
16663 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
16664 @option{-mno-powerpc64}.
16666 If you specify @option{-mno-powerpc}, GCC uses only the instructions
16667 in the common subset of both the POWER and PowerPC
16668 architectures plus some special AIX common-mode calls.
16670 @item -mnew-mnemonics
16671 @itemx -mold-mnemonics
16672 @opindex mnew-mnemonics
16673 @opindex mold-mnemonics
16674 Select which mnemonics to use in the generated assembler code.  With
16675 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
16676 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
16677 assembler mnemonics defined for the POWER architecture.  Instructions
16678 defined in only one architecture have only one mnemonic; GCC uses that
16679 mnemonic irrespective of which of these options is specified.
16681 GCC defaults to the mnemonics appropriate for the architecture in
16682 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
16683 value of these option.  Unless you are building a cross-compiler, you
16684 should normally not specify either @option{-mnew-mnemonics} or
16685 @option{-mold-mnemonics}, but should instead accept the default.
16687 @item -mcpu=@var{cpu_type}
16688 @opindex mcpu
16689 Set architecture type, register usage, choice of mnemonics, and
16690 instruction scheduling parameters for machine type @var{cpu_type}.
16691 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
16692 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
16693 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
16694 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
16695 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
16696 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
16697 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
16698 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
16699 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
16700 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{common}, @samp{powerpc},
16701 @samp{powerpc64}, and @samp{rs64}.
16703 @option{-mcpu=common} selects a completely generic processor.  Code
16704 generated under this option runs on any POWER or PowerPC processor.
16705 GCC uses only the instructions in the common subset of both
16706 architectures, and does not use the MQ register.  GCC assumes a generic
16707 processor model for scheduling purposes.
16709 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
16710 PowerPC (i.e., not MPC601) and 64-bit PowerPC architecture machine
16711 types, with an appropriate, generic processor model assumed for
16712 scheduling purposes.
16714 The other options specify a specific processor.  Code generated under
16715 those options runs best on that processor, and may not run at all on
16716 others.
16718 The @option{-mcpu} options automatically enable or disable the
16719 following options:
16721 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
16722 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpowerpc64 @gol
16723 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
16724 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
16726 The particular options set for any particular CPU varies between
16727 compiler versions, depending on what setting seems to produce optimal
16728 code for that CPU; it doesn't necessarily reflect the actual hardware's
16729 capabilities.  If you wish to set an individual option to a particular
16730 value, you may specify it after the @option{-mcpu} option, like
16731 @option{-mcpu=970 -mno-altivec}.
16733 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
16734 not enabled or disabled by the @option{-mcpu} option at present because
16735 AIX does not have full support for these options.  You may still
16736 enable or disable them individually if you're sure it'll work in your
16737 environment.
16739 @item -mtune=@var{cpu_type}
16740 @opindex mtune
16741 Set the instruction scheduling parameters for machine type
16742 @var{cpu_type}, but do not set the architecture type, register usage, or
16743 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} does.  The same
16744 values for @var{cpu_type} are used for @option{-mtune} as for
16745 @option{-mcpu}.  If both are specified, the code generated uses the
16746 architecture, registers, and mnemonics set by @option{-mcpu}, but the
16747 scheduling parameters set by @option{-mtune}.
16749 @item -mcmodel=small
16750 @opindex mcmodel=small
16751 Generate PowerPC64 code for the small model: The TOC is limited to
16752 64k.
16754 @item -mcmodel=medium
16755 @opindex mcmodel=medium
16756 Generate PowerPC64 code for the medium model: The TOC and other static
16757 data may be up to a total of 4G in size.
16759 @item -mcmodel=large
16760 @opindex mcmodel=large
16761 Generate PowerPC64 code for the large model: The TOC may be up to 4G
16762 in size.  Other data and code is only limited by the 64-bit address
16763 space.
16765 @item -maltivec
16766 @itemx -mno-altivec
16767 @opindex maltivec
16768 @opindex mno-altivec
16769 Generate code that uses (does not use) AltiVec instructions, and also
16770 enable the use of built-in functions that allow more direct access to
16771 the AltiVec instruction set.  You may also need to set
16772 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
16773 enhancements.
16775 @item -mvrsave
16776 @itemx -mno-vrsave
16777 @opindex mvrsave
16778 @opindex mno-vrsave
16779 Generate VRSAVE instructions when generating AltiVec code.
16781 @item -mgen-cell-microcode
16782 @opindex mgen-cell-microcode
16783 Generate Cell microcode instructions
16785 @item -mwarn-cell-microcode
16786 @opindex mwarn-cell-microcode
16787 Warning when a Cell microcode instruction is going to emitted.  An example
16788 of a Cell microcode instruction is a variable shift.
16790 @item -msecure-plt
16791 @opindex msecure-plt
16792 Generate code that allows @command{ld} and @command{ld.so}
16793 to build executables and shared
16794 libraries with non-executable @code{.plt} and @code{.got} sections.
16795 This is a PowerPC
16796 32-bit SYSV ABI option.
16798 @item -mbss-plt
16799 @opindex mbss-plt
16800 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
16801 fills in, and
16802 requires @code{.plt} and @code{.got}
16803 sections that are both writable and executable.
16804 This is a PowerPC 32-bit SYSV ABI option.
16806 @item -misel
16807 @itemx -mno-isel
16808 @opindex misel
16809 @opindex mno-isel
16810 This switch enables or disables the generation of ISEL instructions.
16812 @item -misel=@var{yes/no}
16813 This switch has been deprecated.  Use @option{-misel} and
16814 @option{-mno-isel} instead.
16816 @item -mspe
16817 @itemx -mno-spe
16818 @opindex mspe
16819 @opindex mno-spe
16820 This switch enables or disables the generation of SPE simd
16821 instructions.
16823 @item -mpaired
16824 @itemx -mno-paired
16825 @opindex mpaired
16826 @opindex mno-paired
16827 This switch enables or disables the generation of PAIRED simd
16828 instructions.
16830 @item -mspe=@var{yes/no}
16831 This option has been deprecated.  Use @option{-mspe} and
16832 @option{-mno-spe} instead.
16834 @item -mvsx
16835 @itemx -mno-vsx
16836 @opindex mvsx
16837 @opindex mno-vsx
16838 Generate code that uses (does not use) vector/scalar (VSX)
16839 instructions, and also enable the use of built-in functions that allow
16840 more direct access to the VSX instruction set.
16842 @item -mfloat-gprs=@var{yes/single/double/no}
16843 @itemx -mfloat-gprs
16844 @opindex mfloat-gprs
16845 This switch enables or disables the generation of floating-point
16846 operations on the general-purpose registers for architectures that
16847 support it.
16849 The argument @var{yes} or @var{single} enables the use of
16850 single-precision floating-point operations.
16852 The argument @var{double} enables the use of single and
16853 double-precision floating-point operations.
16855 The argument @var{no} disables floating-point operations on the
16856 general-purpose registers.
16858 This option is currently only available on the MPC854x.
16860 @item -m32
16861 @itemx -m64
16862 @opindex m32
16863 @opindex m64
16864 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
16865 targets (including GNU/Linux).  The 32-bit environment sets int, long
16866 and pointer to 32 bits and generates code that runs on any PowerPC
16867 variant.  The 64-bit environment sets int to 32 bits and long and
16868 pointer to 64 bits, and generates code for PowerPC64, as for
16869 @option{-mpowerpc64}.
16871 @item -mfull-toc
16872 @itemx -mno-fp-in-toc
16873 @itemx -mno-sum-in-toc
16874 @itemx -mminimal-toc
16875 @opindex mfull-toc
16876 @opindex mno-fp-in-toc
16877 @opindex mno-sum-in-toc
16878 @opindex mminimal-toc
16879 Modify generation of the TOC (Table Of Contents), which is created for
16880 every executable file.  The @option{-mfull-toc} option is selected by
16881 default.  In that case, GCC allocates at least one TOC entry for
16882 each unique non-automatic variable reference in your program.  GCC
16883 also places floating-point constants in the TOC@.  However, only
16884 16,384 entries are available in the TOC@.
16886 If you receive a linker error message that saying you have overflowed
16887 the available TOC space, you can reduce the amount of TOC space used
16888 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
16889 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
16890 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
16891 generate code to calculate the sum of an address and a constant at
16892 run time instead of putting that sum into the TOC@.  You may specify one
16893 or both of these options.  Each causes GCC to produce very slightly
16894 slower and larger code at the expense of conserving TOC space.
16896 If you still run out of space in the TOC even when you specify both of
16897 these options, specify @option{-mminimal-toc} instead.  This option causes
16898 GCC to make only one TOC entry for every file.  When you specify this
16899 option, GCC produces code that is slower and larger but which
16900 uses extremely little TOC space.  You may wish to use this option
16901 only on files that contain less frequently-executed code.
16903 @item -maix64
16904 @itemx -maix32
16905 @opindex maix64
16906 @opindex maix32
16907 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
16908 @code{long} type, and the infrastructure needed to support them.
16909 Specifying @option{-maix64} implies @option{-mpowerpc64} and
16910 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
16911 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
16913 @item -mxl-compat
16914 @itemx -mno-xl-compat
16915 @opindex mxl-compat
16916 @opindex mno-xl-compat
16917 Produce code that conforms more closely to IBM XL compiler semantics
16918 when using AIX-compatible ABI@.  Pass floating-point arguments to
16919 prototyped functions beyond the register save area (RSA) on the stack
16920 in addition to argument FPRs.  Do not assume that most significant
16921 double in 128-bit long double value is properly rounded when comparing
16922 values and converting to double.  Use XL symbol names for long double
16923 support routines.
16925 The AIX calling convention was extended but not initially documented to
16926 handle an obscure K&R C case of calling a function that takes the
16927 address of its arguments with fewer arguments than declared.  IBM XL
16928 compilers access floating-point arguments that do not fit in the
16929 RSA from the stack when a subroutine is compiled without
16930 optimization.  Because always storing floating-point arguments on the
16931 stack is inefficient and rarely needed, this option is not enabled by
16932 default and only is necessary when calling subroutines compiled by IBM
16933 XL compilers without optimization.
16935 @item -mpe
16936 @opindex mpe
16937 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
16938 application written to use message passing with special startup code to
16939 enable the application to run.  The system must have PE installed in the
16940 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
16941 must be overridden with the @option{-specs=} option to specify the
16942 appropriate directory location.  The Parallel Environment does not
16943 support threads, so the @option{-mpe} option and the @option{-pthread}
16944 option are incompatible.
16946 @item -malign-natural
16947 @itemx -malign-power
16948 @opindex malign-natural
16949 @opindex malign-power
16950 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
16951 @option{-malign-natural} overrides the ABI-defined alignment of larger
16952 types, such as floating-point doubles, on their natural size-based boundary.
16953 The option @option{-malign-power} instructs GCC to follow the ABI-specified
16954 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
16956 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
16957 is not supported.
16959 @item -msoft-float
16960 @itemx -mhard-float
16961 @opindex msoft-float
16962 @opindex mhard-float
16963 Generate code that does not use (uses) the floating-point register set.
16964 Software floating-point emulation is provided if you use the
16965 @option{-msoft-float} option, and pass the option to GCC when linking.
16967 @item -msingle-float
16968 @itemx -mdouble-float
16969 @opindex msingle-float
16970 @opindex mdouble-float
16971 Generate code for single- or double-precision floating-point operations.
16972 @option{-mdouble-float} implies @option{-msingle-float}.
16974 @item -msimple-fpu
16975 @opindex msimple-fpu
16976 Do not generate @code{sqrt} and @code{div} instructions for hardware
16977 floating-point unit.
16979 @item -mfpu=@var{name}
16980 @opindex mfpu
16981 Specify type of floating-point unit.  Valid values for @var{name} are
16982 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
16983 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
16984 @samp{sp_full} (equivalent to @option{-msingle-float}),
16985 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
16987 @item -mxilinx-fpu
16988 @opindex mxilinx-fpu
16989 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
16991 @item -mmultiple
16992 @itemx -mno-multiple
16993 @opindex mmultiple
16994 @opindex mno-multiple
16995 Generate code that uses (does not use) the load multiple word
16996 instructions and the store multiple word instructions.  These
16997 instructions are generated by default on POWER systems, and not
16998 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
16999 PowerPC systems, since those instructions do not work when the
17000 processor is in little-endian mode.  The exceptions are PPC740 and
17001 PPC750 which permit these instructions in little-endian mode.
17003 @item -mstring
17004 @itemx -mno-string
17005 @opindex mstring
17006 @opindex mno-string
17007 Generate code that uses (does not use) the load string instructions
17008 and the store string word instructions to save multiple registers and
17009 do small block moves.  These instructions are generated by default on
17010 POWER systems, and not generated on PowerPC systems.  Do not use
17011 @option{-mstring} on little-endian PowerPC systems, since those
17012 instructions do not work when the processor is in little-endian mode.
17013 The exceptions are PPC740 and PPC750 which permit these instructions
17014 in little-endian mode.
17016 @item -mupdate
17017 @itemx -mno-update
17018 @opindex mupdate
17019 @opindex mno-update
17020 Generate code that uses (does not use) the load or store instructions
17021 that update the base register to the address of the calculated memory
17022 location.  These instructions are generated by default.  If you use
17023 @option{-mno-update}, there is a small window between the time that the
17024 stack pointer is updated and the address of the previous frame is
17025 stored, which means code that walks the stack frame across interrupts or
17026 signals may get corrupted data.
17028 @item -mavoid-indexed-addresses
17029 @itemx -mno-avoid-indexed-addresses
17030 @opindex mavoid-indexed-addresses
17031 @opindex mno-avoid-indexed-addresses
17032 Generate code that tries to avoid (not avoid) the use of indexed load
17033 or store instructions. These instructions can incur a performance
17034 penalty on Power6 processors in certain situations, such as when
17035 stepping through large arrays that cross a 16M boundary.  This option
17036 is enabled by default when targeting Power6 and disabled otherwise.
17038 @item -mfused-madd
17039 @itemx -mno-fused-madd
17040 @opindex mfused-madd
17041 @opindex mno-fused-madd
17042 Generate code that uses (does not use) the floating-point multiply and
17043 accumulate instructions.  These instructions are generated by default
17044 if hardware floating point is used.  The machine-dependent
17045 @option{-mfused-madd} option is now mapped to the machine-independent
17046 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
17047 mapped to @option{-ffp-contract=off}.
17049 @item -mmulhw
17050 @itemx -mno-mulhw
17051 @opindex mmulhw
17052 @opindex mno-mulhw
17053 Generate code that uses (does not use) the half-word multiply and
17054 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
17055 These instructions are generated by default when targeting those
17056 processors.
17058 @item -mdlmzb
17059 @itemx -mno-dlmzb
17060 @opindex mdlmzb
17061 @opindex mno-dlmzb
17062 Generate code that uses (does not use) the string-search @samp{dlmzb}
17063 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
17064 generated by default when targeting those processors.
17066 @item -mno-bit-align
17067 @itemx -mbit-align
17068 @opindex mno-bit-align
17069 @opindex mbit-align
17070 On System V.4 and embedded PowerPC systems do not (do) force structures
17071 and unions that contain bit-fields to be aligned to the base type of the
17072 bit-field.
17074 For example, by default a structure containing nothing but 8
17075 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
17076 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
17077 the structure is aligned to a 1-byte boundary and is 1 byte in
17078 size.
17080 @item -mno-strict-align
17081 @itemx -mstrict-align
17082 @opindex mno-strict-align
17083 @opindex mstrict-align
17084 On System V.4 and embedded PowerPC systems do not (do) assume that
17085 unaligned memory references are handled by the system.
17087 @item -mrelocatable
17088 @itemx -mno-relocatable
17089 @opindex mrelocatable
17090 @opindex mno-relocatable
17091 Generate code that allows (does not allow) a static executable to be
17092 relocated to a different address at run time.  A simple embedded
17093 PowerPC system loader should relocate the entire contents of
17094 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
17095 a table of 32-bit addresses generated by this option.  For this to
17096 work, all objects linked together must be compiled with
17097 @option{-mrelocatable} or @option{-mrelocatable-lib}.
17098 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
17100 @item -mrelocatable-lib
17101 @itemx -mno-relocatable-lib
17102 @opindex mrelocatable-lib
17103 @opindex mno-relocatable-lib
17104 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
17105 @code{.fixup} section to allow static executables to be relocated at
17106 run time, but @option{-mrelocatable-lib} does not use the smaller stack
17107 alignment of @option{-mrelocatable}.  Objects compiled with
17108 @option{-mrelocatable-lib} may be linked with objects compiled with
17109 any combination of the @option{-mrelocatable} options.
17111 @item -mno-toc
17112 @itemx -mtoc
17113 @opindex mno-toc
17114 @opindex mtoc
17115 On System V.4 and embedded PowerPC systems do not (do) assume that
17116 register 2 contains a pointer to a global area pointing to the addresses
17117 used in the program.
17119 @item -mlittle
17120 @itemx -mlittle-endian
17121 @opindex mlittle
17122 @opindex mlittle-endian
17123 On System V.4 and embedded PowerPC systems compile code for the
17124 processor in little-endian mode.  The @option{-mlittle-endian} option is
17125 the same as @option{-mlittle}.
17127 @item -mbig
17128 @itemx -mbig-endian
17129 @opindex mbig
17130 @opindex mbig-endian
17131 On System V.4 and embedded PowerPC systems compile code for the
17132 processor in big-endian mode.  The @option{-mbig-endian} option is
17133 the same as @option{-mbig}.
17135 @item -mdynamic-no-pic
17136 @opindex mdynamic-no-pic
17137 On Darwin and Mac OS X systems, compile code so that it is not
17138 relocatable, but that its external references are relocatable.  The
17139 resulting code is suitable for applications, but not shared
17140 libraries.
17142 @item -msingle-pic-base
17143 @opindex msingle-pic-base
17144 Treat the register used for PIC addressing as read-only, rather than
17145 loading it in the prologue for each function.  The runtime system is
17146 responsible for initializing this register with an appropriate value
17147 before execution begins.
17149 @item -mprioritize-restricted-insns=@var{priority}
17150 @opindex mprioritize-restricted-insns
17151 This option controls the priority that is assigned to
17152 dispatch-slot restricted instructions during the second scheduling
17153 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
17154 or @samp{2} to assign no, highest, or second-highest (respectively) 
17155 priority to dispatch-slot restricted
17156 instructions.
17158 @item -msched-costly-dep=@var{dependence_type}
17159 @opindex msched-costly-dep
17160 This option controls which dependences are considered costly
17161 by the target during instruction scheduling.  The argument
17162 @var{dependence_type} takes one of the following values:
17164 @table @asis
17165 @item @samp{no}
17166 No dependence is costly.
17168 @item @samp{all}
17169 All dependences are costly.
17171 @item @samp{true_store_to_load}
17172 A true dependence from store to load is costly.
17174 @item @samp{store_to_load}
17175 Any dependence from store to load is costly.
17177 @item @var{number}
17178 Any dependence for which the latency is greater than or equal to 
17179 @var{number} is costly.
17180 @end table
17182 @item -minsert-sched-nops=@var{scheme}
17183 @opindex minsert-sched-nops
17184 This option controls which NOP insertion scheme is used during
17185 the second scheduling pass.  The argument @var{scheme} takes one of the
17186 following values:
17188 @table @asis
17189 @item @samp{no}
17190 Don't insert NOPs.
17192 @item @samp{pad}
17193 Pad with NOPs any dispatch group that has vacant issue slots,
17194 according to the scheduler's grouping.
17196 @item @samp{regroup_exact}
17197 Insert NOPs to force costly dependent insns into
17198 separate groups.  Insert exactly as many NOPs as needed to force an insn
17199 to a new group, according to the estimated processor grouping.
17201 @item @var{number}
17202 Insert NOPs to force costly dependent insns into
17203 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
17204 @end table
17206 @item -mcall-sysv
17207 @opindex mcall-sysv
17208 On System V.4 and embedded PowerPC systems compile code using calling
17209 conventions that adheres to the March 1995 draft of the System V
17210 Application Binary Interface, PowerPC processor supplement.  This is the
17211 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
17213 @item -mcall-sysv-eabi
17214 @itemx -mcall-eabi
17215 @opindex mcall-sysv-eabi
17216 @opindex mcall-eabi
17217 Specify both @option{-mcall-sysv} and @option{-meabi} options.
17219 @item -mcall-sysv-noeabi
17220 @opindex mcall-sysv-noeabi
17221 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
17223 @item -mcall-aixdesc
17224 @opindex m
17225 On System V.4 and embedded PowerPC systems compile code for the AIX
17226 operating system.
17228 @item -mcall-linux
17229 @opindex mcall-linux
17230 On System V.4 and embedded PowerPC systems compile code for the
17231 Linux-based GNU system.
17233 @item -mcall-freebsd
17234 @opindex mcall-freebsd
17235 On System V.4 and embedded PowerPC systems compile code for the
17236 FreeBSD operating system.
17238 @item -mcall-netbsd
17239 @opindex mcall-netbsd
17240 On System V.4 and embedded PowerPC systems compile code for the
17241 NetBSD operating system.
17243 @item -mcall-openbsd
17244 @opindex mcall-netbsd
17245 On System V.4 and embedded PowerPC systems compile code for the
17246 OpenBSD operating system.
17248 @item -maix-struct-return
17249 @opindex maix-struct-return
17250 Return all structures in memory (as specified by the AIX ABI)@.
17252 @item -msvr4-struct-return
17253 @opindex msvr4-struct-return
17254 Return structures smaller than 8 bytes in registers (as specified by the
17255 SVR4 ABI)@.
17257 @item -mabi=@var{abi-type}
17258 @opindex mabi
17259 Extend the current ABI with a particular extension, or remove such extension.
17260 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
17261 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
17263 @item -mabi=spe
17264 @opindex mabi=spe
17265 Extend the current ABI with SPE ABI extensions.  This does not change
17266 the default ABI, instead it adds the SPE ABI extensions to the current
17267 ABI@.
17269 @item -mabi=no-spe
17270 @opindex mabi=no-spe
17271 Disable Booke SPE ABI extensions for the current ABI@.
17273 @item -mabi=ibmlongdouble
17274 @opindex mabi=ibmlongdouble
17275 Change the current ABI to use IBM extended-precision long double.
17276 This is a PowerPC 32-bit SYSV ABI option.
17278 @item -mabi=ieeelongdouble
17279 @opindex mabi=ieeelongdouble
17280 Change the current ABI to use IEEE extended-precision long double.
17281 This is a PowerPC 32-bit Linux ABI option.
17283 @item -mprototype
17284 @itemx -mno-prototype
17285 @opindex mprototype
17286 @opindex mno-prototype
17287 On System V.4 and embedded PowerPC systems assume that all calls to
17288 variable argument functions are properly prototyped.  Otherwise, the
17289 compiler must insert an instruction before every non prototyped call to
17290 set or clear bit 6 of the condition code register (@var{CR}) to
17291 indicate whether floating-point values are passed in the floating-point
17292 registers in case the function takes variable arguments.  With
17293 @option{-mprototype}, only calls to prototyped variable argument functions
17294 set or clear the bit.
17296 @item -msim
17297 @opindex msim
17298 On embedded PowerPC systems, assume that the startup module is called
17299 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
17300 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
17301 configurations.
17303 @item -mmvme
17304 @opindex mmvme
17305 On embedded PowerPC systems, assume that the startup module is called
17306 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
17307 @file{libc.a}.
17309 @item -mads
17310 @opindex mads
17311 On embedded PowerPC systems, assume that the startup module is called
17312 @file{crt0.o} and the standard C libraries are @file{libads.a} and
17313 @file{libc.a}.
17315 @item -myellowknife
17316 @opindex myellowknife
17317 On embedded PowerPC systems, assume that the startup module is called
17318 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
17319 @file{libc.a}.
17321 @item -mvxworks
17322 @opindex mvxworks
17323 On System V.4 and embedded PowerPC systems, specify that you are
17324 compiling for a VxWorks system.
17326 @item -memb
17327 @opindex memb
17328 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
17329 header to indicate that @samp{eabi} extended relocations are used.
17331 @item -meabi
17332 @itemx -mno-eabi
17333 @opindex meabi
17334 @opindex mno-eabi
17335 On System V.4 and embedded PowerPC systems do (do not) adhere to the
17336 Embedded Applications Binary Interface (eabi) which is a set of
17337 modifications to the System V.4 specifications.  Selecting @option{-meabi}
17338 means that the stack is aligned to an 8-byte boundary, a function
17339 @code{__eabi} is called to from @code{main} to set up the eabi
17340 environment, and the @option{-msdata} option can use both @code{r2} and
17341 @code{r13} to point to two separate small data areas.  Selecting
17342 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
17343 do not call an initialization function from @code{main}, and the
17344 @option{-msdata} option only uses @code{r13} to point to a single
17345 small data area.  The @option{-meabi} option is on by default if you
17346 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
17348 @item -msdata=eabi
17349 @opindex msdata=eabi
17350 On System V.4 and embedded PowerPC systems, put small initialized
17351 @code{const} global and static data in the @samp{.sdata2} section, which
17352 is pointed to by register @code{r2}.  Put small initialized
17353 non-@code{const} global and static data in the @samp{.sdata} section,
17354 which is pointed to by register @code{r13}.  Put small uninitialized
17355 global and static data in the @samp{.sbss} section, which is adjacent to
17356 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
17357 incompatible with the @option{-mrelocatable} option.  The
17358 @option{-msdata=eabi} option also sets the @option{-memb} option.
17360 @item -msdata=sysv
17361 @opindex msdata=sysv
17362 On System V.4 and embedded PowerPC systems, put small global and static
17363 data in the @samp{.sdata} section, which is pointed to by register
17364 @code{r13}.  Put small uninitialized global and static data in the
17365 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
17366 The @option{-msdata=sysv} option is incompatible with the
17367 @option{-mrelocatable} option.
17369 @item -msdata=default
17370 @itemx -msdata
17371 @opindex msdata=default
17372 @opindex msdata
17373 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
17374 compile code the same as @option{-msdata=eabi}, otherwise compile code the
17375 same as @option{-msdata=sysv}.
17377 @item -msdata=data
17378 @opindex msdata=data
17379 On System V.4 and embedded PowerPC systems, put small global
17380 data in the @samp{.sdata} section.  Put small uninitialized global
17381 data in the @samp{.sbss} section.  Do not use register @code{r13}
17382 to address small data however.  This is the default behavior unless
17383 other @option{-msdata} options are used.
17385 @item -msdata=none
17386 @itemx -mno-sdata
17387 @opindex msdata=none
17388 @opindex mno-sdata
17389 On embedded PowerPC systems, put all initialized global and static data
17390 in the @samp{.data} section, and all uninitialized data in the
17391 @samp{.bss} section.
17393 @item -mblock-move-inline-limit=@var{num}
17394 @opindex mblock-move-inline-limit
17395 Inline all block moves (such as calls to @code{memcpy} or structure
17396 copies) less than or equal to @var{num} bytes.  The minimum value for
17397 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
17398 targets.  The default value is target-specific.
17400 @item -G @var{num}
17401 @opindex G
17402 @cindex smaller data references (PowerPC)
17403 @cindex .sdata/.sdata2 references (PowerPC)
17404 On embedded PowerPC systems, put global and static items less than or
17405 equal to @var{num} bytes into the small data or bss sections instead of
17406 the normal data or bss section.  By default, @var{num} is 8.  The
17407 @option{-G @var{num}} switch is also passed to the linker.
17408 All modules should be compiled with the same @option{-G @var{num}} value.
17410 @item -mregnames
17411 @itemx -mno-regnames
17412 @opindex mregnames
17413 @opindex mno-regnames
17414 On System V.4 and embedded PowerPC systems do (do not) emit register
17415 names in the assembly language output using symbolic forms.
17417 @item -mlongcall
17418 @itemx -mno-longcall
17419 @opindex mlongcall
17420 @opindex mno-longcall
17421 By default assume that all calls are far away so that a longer more
17422 expensive calling sequence is required.  This is required for calls
17423 further than 32 megabytes (33,554,432 bytes) from the current location.
17424 A short call is generated if the compiler knows
17425 the call cannot be that far away.  This setting can be overridden by
17426 the @code{shortcall} function attribute, or by @code{#pragma
17427 longcall(0)}.
17429 Some linkers are capable of detecting out-of-range calls and generating
17430 glue code on the fly.  On these systems, long calls are unnecessary and
17431 generate slower code.  As of this writing, the AIX linker can do this,
17432 as can the GNU linker for PowerPC/64.  It is planned to add this feature
17433 to the GNU linker for 32-bit PowerPC systems as well.
17435 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
17436 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
17437 addresses represent the callee and the branch island.  The
17438 Darwin/PPC linker prefers the first address and generates a @code{bl
17439 callee} if the PPC @code{bl} instruction reaches the callee directly;
17440 otherwise, the linker generates @code{bl L42} to call the branch
17441 island.  The branch island is appended to the body of the
17442 calling function; it computes the full 32-bit address of the callee
17443 and jumps to it.
17445 On Mach-O (Darwin) systems, this option directs the compiler emit to
17446 the glue for every direct call, and the Darwin linker decides whether
17447 to use or discard it.
17449 In the future, GCC may ignore all longcall specifications
17450 when the linker is known to generate glue.
17452 @item -mtls-markers
17453 @itemx -mno-tls-markers
17454 @opindex mtls-markers
17455 @opindex mno-tls-markers
17456 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
17457 specifying the function argument.  The relocation allows the linker to
17458 reliably associate function call with argument setup instructions for
17459 TLS optimization, which in turn allows GCC to better schedule the
17460 sequence.
17462 @item -pthread
17463 @opindex pthread
17464 Adds support for multithreading with the @dfn{pthreads} library.
17465 This option sets flags for both the preprocessor and linker.
17467 @item -mrecip
17468 @itemx -mno-recip
17469 @opindex mrecip
17470 This option enables use of the reciprocal estimate and
17471 reciprocal square root estimate instructions with additional
17472 Newton-Raphson steps to increase precision instead of doing a divide or
17473 square root and divide for floating-point arguments.  You should use
17474 the @option{-ffast-math} option when using @option{-mrecip} (or at
17475 least @option{-funsafe-math-optimizations},
17476 @option{-finite-math-only}, @option{-freciprocal-math} and
17477 @option{-fno-trapping-math}).  Note that while the throughput of the
17478 sequence is generally higher than the throughput of the non-reciprocal
17479 instruction, the precision of the sequence can be decreased by up to 2
17480 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
17481 roots.
17483 @item -mrecip=@var{opt}
17484 @opindex mrecip=opt
17485 This option allows to control which reciprocal estimate instructions
17486 may be used.  @var{opt} is a comma separated list of options, which may
17487 be preceded by a @code{!} to invert the option:
17488 @code{all}: enable all estimate instructions,
17489 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
17490 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
17491 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
17492 @code{divf}: enable the single-precision reciprocal approximation instructions;
17493 @code{divd}: enable the double-precision reciprocal approximation instructions;
17494 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
17495 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
17496 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
17498 So, for example, @option{-mrecip=all,!rsqrtd} enables
17499 all of the reciprocal estimate instructions, except for the
17500 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
17501 which handle the double-precision reciprocal square root calculations.
17503 @item -mrecip-precision
17504 @itemx -mno-recip-precision
17505 @opindex mrecip-precision
17506 Assume (do not assume) that the reciprocal estimate instructions
17507 provide higher-precision estimates than is mandated by the PowerPC
17508 ABI.  Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
17509 automatically selects @option{-mrecip-precision}.  The double-precision 
17510 square root estimate instructions are not generated by
17511 default on low-precision machines, since they do not provide an
17512 estimate that converges after three steps.
17514 @item -mveclibabi=@var{type}
17515 @opindex mveclibabi
17516 Specifies the ABI type to use for vectorizing intrinsics using an
17517 external library.  The only type supported at present is @code{mass},
17518 which specifies to use IBM's Mathematical Acceleration Subsystem
17519 (MASS) libraries for vectorizing intrinsics using external libraries.
17520 GCC currently emits calls to @code{acosd2}, @code{acosf4},
17521 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
17522 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
17523 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
17524 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
17525 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
17526 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
17527 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
17528 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
17529 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
17530 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
17531 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
17532 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
17533 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
17534 for power7.  Both @option{-ftree-vectorize} and
17535 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
17536 libraries must be specified at link time.
17538 @item -mfriz
17539 @itemx -mno-friz
17540 @opindex mfriz
17541 Generate (do not generate) the @code{friz} instruction when the
17542 @option{-funsafe-math-optimizations} option is used to optimize
17543 rounding of floating-point values to 64-bit integer and back to floating
17544 point.  The @code{friz} instruction does not return the same value if
17545 the floating-point number is too large to fit in an integer.
17547 @item -mpointers-to-nested-functions
17548 @itemx -mno-pointers-to-nested-functions
17549 @opindex mpointers-to-nested-functions
17550 Generate (do not generate) code to load up the static chain register
17551 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
17552 systems where a function pointer points to a 3-word descriptor giving
17553 the function address, TOC value to be loaded in register @var{r2}, and
17554 static chain value to be loaded in register @var{r11}.  The
17555 @option{-mpointers-to-nested-functions} is on by default.  You cannot
17556 call through pointers to nested functions or pointers
17557 to functions compiled in other languages that use the static chain if
17558 you use the @option{-mno-pointers-to-nested-functions}.
17560 @item -msave-toc-indirect
17561 @itemx -mno-save-toc-indirect
17562 @opindex msave-toc-indirect
17563 Generate (do not generate) code to save the TOC value in the reserved
17564 stack location in the function prologue if the function calls through
17565 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
17566 saved in the prologue, it is saved just before the call through the
17567 pointer.  The @option{-mno-save-toc-indirect} option is the default.
17568 @end table
17570 @node RX Options
17571 @subsection RX Options
17572 @cindex RX Options
17574 These command-line options are defined for RX targets:
17576 @table @gcctabopt
17577 @item -m64bit-doubles
17578 @itemx -m32bit-doubles
17579 @opindex m64bit-doubles
17580 @opindex m32bit-doubles
17581 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
17582 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
17583 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
17584 works on 32-bit values, which is why the default is
17585 @option{-m32bit-doubles}.
17587 @item -fpu
17588 @itemx -nofpu
17589 @opindex fpu
17590 @opindex nofpu
17591 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
17592 floating-point hardware.  The default is enabled for the @var{RX600}
17593 series and disabled for the @var{RX200} series.
17595 Floating-point instructions are only generated for 32-bit floating-point 
17596 values, however, so the FPU hardware is not used for doubles if the
17597 @option{-m64bit-doubles} option is used.
17599 @emph{Note} If the @option{-fpu} option is enabled then
17600 @option{-funsafe-math-optimizations} is also enabled automatically.
17601 This is because the RX FPU instructions are themselves unsafe.
17603 @item -mcpu=@var{name}
17604 @opindex -mcpu
17605 Selects the type of RX CPU to be targeted.  Currently three types are
17606 supported, the generic @var{RX600} and @var{RX200} series hardware and
17607 the specific @var{RX610} CPU.  The default is @var{RX600}.
17609 The only difference between @var{RX600} and @var{RX610} is that the
17610 @var{RX610} does not support the @code{MVTIPL} instruction.
17612 The @var{RX200} series does not have a hardware floating-point unit
17613 and so @option{-nofpu} is enabled by default when this type is
17614 selected.
17616 @item -mbig-endian-data
17617 @itemx -mlittle-endian-data
17618 @opindex mbig-endian-data
17619 @opindex mlittle-endian-data
17620 Store data (but not code) in the big-endian format.  The default is
17621 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
17622 format.
17624 @item -msmall-data-limit=@var{N}
17625 @opindex msmall-data-limit
17626 Specifies the maximum size in bytes of global and static variables
17627 which can be placed into the small data area.  Using the small data
17628 area can lead to smaller and faster code, but the size of area is
17629 limited and it is up to the programmer to ensure that the area does
17630 not overflow.  Also when the small data area is used one of the RX's
17631 registers (usually @code{r13}) is reserved for use pointing to this
17632 area, so it is no longer available for use by the compiler.  This
17633 could result in slower and/or larger code if variables are pushed onto
17634 the stack instead of being held in this register.
17636 Note, common variables (variables that have not been initialized) and
17637 constants are not placed into the small data area as they are assigned
17638 to other sections in the output executable.
17640 The default value is zero, which disables this feature.  Note, this
17641 feature is not enabled by default with higher optimization levels
17642 (@option{-O2} etc) because of the potentially detrimental effects of
17643 reserving a register.  It is up to the programmer to experiment and
17644 discover whether this feature is of benefit to their program.  See the
17645 description of the @option{-mpid} option for a description of how the
17646 actual register to hold the small data area pointer is chosen.
17648 @item -msim
17649 @itemx -mno-sim
17650 @opindex msim
17651 @opindex mno-sim
17652 Use the simulator runtime.  The default is to use the libgloss board
17653 specific runtime.
17655 @item -mas100-syntax
17656 @itemx -mno-as100-syntax
17657 @opindex mas100-syntax
17658 @opindex mno-as100-syntax
17659 When generating assembler output use a syntax that is compatible with
17660 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
17661 assembler but it has some restrictions so generating it is not the
17662 default option.
17664 @item -mmax-constant-size=@var{N}
17665 @opindex mmax-constant-size
17666 Specifies the maximum size, in bytes, of a constant that can be used as
17667 an operand in a RX instruction.  Although the RX instruction set does
17668 allow constants of up to 4 bytes in length to be used in instructions,
17669 a longer value equates to a longer instruction.  Thus in some
17670 circumstances it can be beneficial to restrict the size of constants
17671 that are used in instructions.  Constants that are too big are instead
17672 placed into a constant pool and referenced via register indirection.
17674 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
17675 or 4 means that constants of any size are allowed.
17677 @item -mrelax
17678 @opindex mrelax
17679 Enable linker relaxation.  Linker relaxation is a process whereby the
17680 linker attempts to reduce the size of a program by finding shorter
17681 versions of various instructions.  Disabled by default.
17683 @item -mint-register=@var{N}
17684 @opindex mint-register
17685 Specify the number of registers to reserve for fast interrupt handler
17686 functions.  The value @var{N} can be between 0 and 4.  A value of 1
17687 means that register @code{r13} is reserved for the exclusive use
17688 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
17689 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
17690 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
17691 A value of 0, the default, does not reserve any registers.
17693 @item -msave-acc-in-interrupts
17694 @opindex msave-acc-in-interrupts
17695 Specifies that interrupt handler functions should preserve the
17696 accumulator register.  This is only necessary if normal code might use
17697 the accumulator register, for example because it performs 64-bit
17698 multiplications.  The default is to ignore the accumulator as this
17699 makes the interrupt handlers faster.
17701 @item -mpid
17702 @itemx -mno-pid
17703 @opindex mpid
17704 @opindex mno-pid
17705 Enables the generation of position independent data.  When enabled any
17706 access to constant data is done via an offset from a base address
17707 held in a register.  This allows the location of constant data to be
17708 determined at run time without requiring the executable to be
17709 relocated, which is a benefit to embedded applications with tight
17710 memory constraints.  Data that can be modified is not affected by this
17711 option.
17713 Note, using this feature reserves a register, usually @code{r13}, for
17714 the constant data base address.  This can result in slower and/or
17715 larger code, especially in complicated functions.
17717 The actual register chosen to hold the constant data base address
17718 depends upon whether the @option{-msmall-data-limit} and/or the
17719 @option{-mint-register} command-line options are enabled.  Starting
17720 with register @code{r13} and proceeding downwards, registers are
17721 allocated first to satisfy the requirements of @option{-mint-register},
17722 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
17723 is possible for the small data area register to be @code{r8} if both
17724 @option{-mint-register=4} and @option{-mpid} are specified on the
17725 command line.
17727 By default this feature is not enabled.  The default can be restored
17728 via the @option{-mno-pid} command-line option.
17730 @end table
17732 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
17733 has special significance to the RX port when used with the
17734 @code{interrupt} function attribute.  This attribute indicates a
17735 function intended to process fast interrupts.  GCC ensures
17736 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
17737 and/or @code{r13} and only provided that the normal use of the
17738 corresponding registers have been restricted via the
17739 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
17740 options.
17742 @node S/390 and zSeries Options
17743 @subsection S/390 and zSeries Options
17744 @cindex S/390 and zSeries Options
17746 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
17748 @table @gcctabopt
17749 @item -mhard-float
17750 @itemx -msoft-float
17751 @opindex mhard-float
17752 @opindex msoft-float
17753 Use (do not use) the hardware floating-point instructions and registers
17754 for floating-point operations.  When @option{-msoft-float} is specified,
17755 functions in @file{libgcc.a} are used to perform floating-point
17756 operations.  When @option{-mhard-float} is specified, the compiler
17757 generates IEEE floating-point instructions.  This is the default.
17759 @item -mhard-dfp
17760 @itemx -mno-hard-dfp
17761 @opindex mhard-dfp
17762 @opindex mno-hard-dfp
17763 Use (do not use) the hardware decimal-floating-point instructions for
17764 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
17765 specified, functions in @file{libgcc.a} are used to perform
17766 decimal-floating-point operations.  When @option{-mhard-dfp} is
17767 specified, the compiler generates decimal-floating-point hardware
17768 instructions.  This is the default for @option{-march=z9-ec} or higher.
17770 @item -mlong-double-64
17771 @itemx -mlong-double-128
17772 @opindex mlong-double-64
17773 @opindex mlong-double-128
17774 These switches control the size of @code{long double} type. A size
17775 of 64 bits makes the @code{long double} type equivalent to the @code{double}
17776 type. This is the default.
17778 @item -mbackchain
17779 @itemx -mno-backchain
17780 @opindex mbackchain
17781 @opindex mno-backchain
17782 Store (do not store) the address of the caller's frame as backchain pointer
17783 into the callee's stack frame.
17784 A backchain may be needed to allow debugging using tools that do not understand
17785 DWARF 2 call frame information.
17786 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
17787 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
17788 the backchain is placed into the topmost word of the 96/160 byte register
17789 save area.
17791 In general, code compiled with @option{-mbackchain} is call-compatible with
17792 code compiled with @option{-mmo-backchain}; however, use of the backchain
17793 for debugging purposes usually requires that the whole binary is built with
17794 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
17795 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17796 to build a linux kernel use @option{-msoft-float}.
17798 The default is to not maintain the backchain.
17800 @item -mpacked-stack
17801 @itemx -mno-packed-stack
17802 @opindex mpacked-stack
17803 @opindex mno-packed-stack
17804 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
17805 specified, the compiler uses the all fields of the 96/160 byte register save
17806 area only for their default purpose; unused fields still take up stack space.
17807 When @option{-mpacked-stack} is specified, register save slots are densely
17808 packed at the top of the register save area; unused space is reused for other
17809 purposes, allowing for more efficient use of the available stack space.
17810 However, when @option{-mbackchain} is also in effect, the topmost word of
17811 the save area is always used to store the backchain, and the return address
17812 register is always saved two words below the backchain.
17814 As long as the stack frame backchain is not used, code generated with
17815 @option{-mpacked-stack} is call-compatible with code generated with
17816 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
17817 S/390 or zSeries generated code that uses the stack frame backchain at run
17818 time, not just for debugging purposes.  Such code is not call-compatible
17819 with code compiled with @option{-mpacked-stack}.  Also, note that the
17820 combination of @option{-mbackchain},
17821 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17822 to build a linux kernel use @option{-msoft-float}.
17824 The default is to not use the packed stack layout.
17826 @item -msmall-exec
17827 @itemx -mno-small-exec
17828 @opindex msmall-exec
17829 @opindex mno-small-exec
17830 Generate (or do not generate) code using the @code{bras} instruction
17831 to do subroutine calls.
17832 This only works reliably if the total executable size does not
17833 exceed 64k.  The default is to use the @code{basr} instruction instead,
17834 which does not have this limitation.
17836 @item -m64
17837 @itemx -m31
17838 @opindex m64
17839 @opindex m31
17840 When @option{-m31} is specified, generate code compliant to the
17841 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
17842 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
17843 particular to generate 64-bit instructions.  For the @samp{s390}
17844 targets, the default is @option{-m31}, while the @samp{s390x}
17845 targets default to @option{-m64}.
17847 @item -mzarch
17848 @itemx -mesa
17849 @opindex mzarch
17850 @opindex mesa
17851 When @option{-mzarch} is specified, generate code using the
17852 instructions available on z/Architecture.
17853 When @option{-mesa} is specified, generate code using the
17854 instructions available on ESA/390.  Note that @option{-mesa} is
17855 not possible with @option{-m64}.
17856 When generating code compliant to the GNU/Linux for S/390 ABI,
17857 the default is @option{-mesa}.  When generating code compliant
17858 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
17860 @item -mmvcle
17861 @itemx -mno-mvcle
17862 @opindex mmvcle
17863 @opindex mno-mvcle
17864 Generate (or do not generate) code using the @code{mvcle} instruction
17865 to perform block moves.  When @option{-mno-mvcle} is specified,
17866 use a @code{mvc} loop instead.  This is the default unless optimizing for
17867 size.
17869 @item -mdebug
17870 @itemx -mno-debug
17871 @opindex mdebug
17872 @opindex mno-debug
17873 Print (or do not print) additional debug information when compiling.
17874 The default is to not print debug information.
17876 @item -march=@var{cpu-type}
17877 @opindex march
17878 Generate code that runs on @var{cpu-type}, which is the name of a system
17879 representing a certain processor type.  Possible values for
17880 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
17881 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
17882 When generating code using the instructions available on z/Architecture,
17883 the default is @option{-march=z900}.  Otherwise, the default is
17884 @option{-march=g5}.
17886 @item -mtune=@var{cpu-type}
17887 @opindex mtune
17888 Tune to @var{cpu-type} everything applicable about the generated code,
17889 except for the ABI and the set of available instructions.
17890 The list of @var{cpu-type} values is the same as for @option{-march}.
17891 The default is the value used for @option{-march}.
17893 @item -mtpf-trace
17894 @itemx -mno-tpf-trace
17895 @opindex mtpf-trace
17896 @opindex mno-tpf-trace
17897 Generate code that adds (does not add) in TPF OS specific branches to trace
17898 routines in the operating system.  This option is off by default, even
17899 when compiling for the TPF OS@.
17901 @item -mfused-madd
17902 @itemx -mno-fused-madd
17903 @opindex mfused-madd
17904 @opindex mno-fused-madd
17905 Generate code that uses (does not use) the floating-point multiply and
17906 accumulate instructions.  These instructions are generated by default if
17907 hardware floating point is used.
17909 @item -mwarn-framesize=@var{framesize}
17910 @opindex mwarn-framesize
17911 Emit a warning if the current function exceeds the given frame size.  Because
17912 this is a compile-time check it doesn't need to be a real problem when the program
17913 runs.  It is intended to identify functions that most probably cause
17914 a stack overflow.  It is useful to be used in an environment with limited stack
17915 size e.g.@: the linux kernel.
17917 @item -mwarn-dynamicstack
17918 @opindex mwarn-dynamicstack
17919 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
17920 arrays.  This is generally a bad idea with a limited stack size.
17922 @item -mstack-guard=@var{stack-guard}
17923 @itemx -mstack-size=@var{stack-size}
17924 @opindex mstack-guard
17925 @opindex mstack-size
17926 If these options are provided the s390 back end emits additional instructions in
17927 the function prologue which trigger a trap if the stack size is @var{stack-guard}
17928 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
17929 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
17930 the frame size of the compiled function is chosen.
17931 These options are intended to be used to help debugging stack overflow problems.
17932 The additionally emitted code causes only little overhead and hence can also be
17933 used in production like systems without greater performance degradation.  The given
17934 values have to be exact powers of 2 and @var{stack-size} has to be greater than
17935 @var{stack-guard} without exceeding 64k.
17936 In order to be efficient the extra code makes the assumption that the stack starts
17937 at an address aligned to the value given by @var{stack-size}.
17938 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
17939 @end table
17941 @node Score Options
17942 @subsection Score Options
17943 @cindex Score Options
17945 These options are defined for Score implementations:
17947 @table @gcctabopt
17948 @item -meb
17949 @opindex meb
17950 Compile code for big-endian mode.  This is the default.
17952 @item -mel
17953 @opindex mel
17954 Compile code for little-endian mode.
17956 @item -mnhwloop
17957 @opindex mnhwloop
17958 Disable generate bcnz instruction.
17960 @item -muls
17961 @opindex muls
17962 Enable generate unaligned load and store instruction.
17964 @item -mmac
17965 @opindex mmac
17966 Enable the use of multiply-accumulate instructions. Disabled by default.
17968 @item -mscore5
17969 @opindex mscore5
17970 Specify the SCORE5 as the target architecture.
17972 @item -mscore5u
17973 @opindex mscore5u
17974 Specify the SCORE5U of the target architecture.
17976 @item -mscore7
17977 @opindex mscore7
17978 Specify the SCORE7 as the target architecture. This is the default.
17980 @item -mscore7d
17981 @opindex mscore7d
17982 Specify the SCORE7D as the target architecture.
17983 @end table
17985 @node SH Options
17986 @subsection SH Options
17988 These @samp{-m} options are defined for the SH implementations:
17990 @table @gcctabopt
17991 @item -m1
17992 @opindex m1
17993 Generate code for the SH1.
17995 @item -m2
17996 @opindex m2
17997 Generate code for the SH2.
17999 @item -m2e
18000 Generate code for the SH2e.
18002 @item -m2a-nofpu
18003 @opindex m2a-nofpu
18004 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
18005 that the floating-point unit is not used.
18007 @item -m2a-single-only
18008 @opindex m2a-single-only
18009 Generate code for the SH2a-FPU, in such a way that no double-precision
18010 floating-point operations are used.
18012 @item -m2a-single
18013 @opindex m2a-single
18014 Generate code for the SH2a-FPU assuming the floating-point unit is in
18015 single-precision mode by default.
18017 @item -m2a
18018 @opindex m2a
18019 Generate code for the SH2a-FPU assuming the floating-point unit is in
18020 double-precision mode by default.
18022 @item -m3
18023 @opindex m3
18024 Generate code for the SH3.
18026 @item -m3e
18027 @opindex m3e
18028 Generate code for the SH3e.
18030 @item -m4-nofpu
18031 @opindex m4-nofpu
18032 Generate code for the SH4 without a floating-point unit.
18034 @item -m4-single-only
18035 @opindex m4-single-only
18036 Generate code for the SH4 with a floating-point unit that only
18037 supports single-precision arithmetic.
18039 @item -m4-single
18040 @opindex m4-single
18041 Generate code for the SH4 assuming the floating-point unit is in
18042 single-precision mode by default.
18044 @item -m4
18045 @opindex m4
18046 Generate code for the SH4.
18048 @item -m4a-nofpu
18049 @opindex m4a-nofpu
18050 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
18051 floating-point unit is not used.
18053 @item -m4a-single-only
18054 @opindex m4a-single-only
18055 Generate code for the SH4a, in such a way that no double-precision
18056 floating-point operations are used.
18058 @item -m4a-single
18059 @opindex m4a-single
18060 Generate code for the SH4a assuming the floating-point unit is in
18061 single-precision mode by default.
18063 @item -m4a
18064 @opindex m4a
18065 Generate code for the SH4a.
18067 @item -m4al
18068 @opindex m4al
18069 Same as @option{-m4a-nofpu}, except that it implicitly passes
18070 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
18071 instructions at the moment.
18073 @item -mb
18074 @opindex mb
18075 Compile code for the processor in big-endian mode.
18077 @item -ml
18078 @opindex ml
18079 Compile code for the processor in little-endian mode.
18081 @item -mdalign
18082 @opindex mdalign
18083 Align doubles at 64-bit boundaries.  Note that this changes the calling
18084 conventions, and thus some functions from the standard C library do
18085 not work unless you recompile it first with @option{-mdalign}.
18087 @item -mrelax
18088 @opindex mrelax
18089 Shorten some address references at link time, when possible; uses the
18090 linker option @option{-relax}.
18092 @item -mbigtable
18093 @opindex mbigtable
18094 Use 32-bit offsets in @code{switch} tables.  The default is to use
18095 16-bit offsets.
18097 @item -mbitops
18098 @opindex mbitops
18099 Enable the use of bit manipulation instructions on SH2A.
18101 @item -mfmovd
18102 @opindex mfmovd
18103 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
18104 alignment constraints.
18106 @item -mhitachi
18107 @opindex mhitachi
18108 Comply with the calling conventions defined by Renesas.
18110 @item -mrenesas
18111 @opindex mhitachi
18112 Comply with the calling conventions defined by Renesas.
18114 @item -mno-renesas
18115 @opindex mhitachi
18116 Comply with the calling conventions defined for GCC before the Renesas
18117 conventions were available.  This option is the default for all
18118 targets of the SH toolchain.
18120 @item -mnomacsave
18121 @opindex mnomacsave
18122 Mark the @code{MAC} register as call-clobbered, even if
18123 @option{-mhitachi} is given.
18125 @item -mieee
18126 @item -mno-ieee
18127 @opindex mieee
18128 @opindex mnoieee
18129 Control the IEEE compliance of floating-point comparisons, which affects the
18130 handling of cases where the result of a comparison is unordered.  By default
18131 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
18132 enabled @option{-mno-ieee} is implicitly set, which results in faster
18133 floating-point greater-equal and less-equal comparisons.  The implcit settings
18134 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
18136 @item -minline-ic_invalidate
18137 @opindex minline-ic_invalidate
18138 Inline code to invalidate instruction cache entries after setting up
18139 nested function trampolines.
18140 This option has no effect if @option{-musermode} is in effect and the selected
18141 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
18142 instruction.
18143 If the selected code generation option does not allow the use of the @code{icbi}
18144 instruction, and @option{-musermode} is not in effect, the inlined code
18145 manipulates the instruction cache address array directly with an associative
18146 write.  This not only requires privileged mode at run time, but it also
18147 fails if the cache line had been mapped via the TLB and has become unmapped.
18149 @item -misize
18150 @opindex misize
18151 Dump instruction size and location in the assembly code.
18153 @item -mpadstruct
18154 @opindex mpadstruct
18155 This option is deprecated.  It pads structures to multiple of 4 bytes,
18156 which is incompatible with the SH ABI@.
18158 @item -msoft-atomic
18159 @opindex msoft-atomic
18160 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18161 built-in functions.  The generated atomic sequences require support from the 
18162 interrupt / exception handling code of the system and are only suitable for
18163 single-core systems.  They will not operate correctly on multi-core systems.
18164 This option is enabled by default when the target is @code{sh-*-linux*}.
18165 When the target is SH4A, this option will also partially utilize the hardware
18166 atomic instructions @code{movli.l} and @code{movco.l} to create more
18167 efficient code.
18168 For details on the atomic built-in functions see @ref{__atomic Builtins}.
18170 @item -mhard-atomic
18171 @opindex hard-atomic
18172 Generate hardware atomic sequences for the atomic built-in functions.  This
18173 is only available on SH4A and is suitable for multi-core systems.  Code
18174 compiled with this option will also be compatible with gUSA aware
18175 interrupt / exception handling systems.  In contrast to the
18176 @option{-msoft-atomic} option this will only use the instructions
18177 @code{movli.l} and @code{movco.l} to create atomic sequences.
18179 @item -menable-tas
18180 @opindex menable-tas
18181 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
18182 Notice that depending on the particular hardware and software configuration
18183 this can degrade overall performance due to the operand cache line flushes
18184 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
18185 processors the @code{tas.b} instruction must be used with caution since it
18186 can result in data corruption for certain cache configurations.
18188 @item -mspace
18189 @opindex mspace
18190 Optimize for space instead of speed.  Implied by @option{-Os}.
18192 @item -mprefergot
18193 @opindex mprefergot
18194 When generating position-independent code, emit function calls using
18195 the Global Offset Table instead of the Procedure Linkage Table.
18197 @item -musermode
18198 @opindex musermode
18199 Don't generate privileged mode only code.  This option
18200 implies @option{-mno-inline-ic_invalidate}
18201 if the inlined code would not work in user mode.
18202 This is the default when the target is @code{sh-*-linux*}.
18204 @item -multcost=@var{number}
18205 @opindex multcost=@var{number}
18206 Set the cost to assume for a multiply insn.
18208 @item -mdiv=@var{strategy}
18209 @opindex mdiv=@var{strategy}
18210 Set the division strategy to use for SHmedia code.  @var{strategy} must be
18211 one of: 
18213 @table @samp
18215 @item fp 
18216 Performs the operation in floating point.  This has a very high latency,
18217 but needs only a few instructions, so it might be a good choice if
18218 your code has enough easily-exploitable ILP to allow the compiler to
18219 schedule the floating-point instructions together with other instructions.
18220 Division by zero causes a floating-point exception.
18222 @item inv
18223 Uses integer operations to calculate the inverse of the divisor,
18224 and then multiplies the dividend with the inverse.  This strategy allows
18225 CSE and hoisting of the inverse calculation.  Division by zero calculates
18226 an unspecified result, but does not trap.
18228 @item inv:minlat
18229 A variant of @samp{inv} where, if no CSE or hoisting opportunities
18230 have been found, or if the entire operation has been hoisted to the same
18231 place, the last stages of the inverse calculation are intertwined with the
18232 final multiply to reduce the overall latency, at the expense of using a few
18233 more instructions, and thus offering fewer scheduling opportunities with
18234 other code.
18236 @item call
18237 Calls a library function that usually implements the @samp{inv:minlat}
18238 strategy.
18239 This gives high code density for @code{m5-*media-nofpu} compilations.
18241 @item call2
18242 Uses a different entry point of the same library function, where it
18243 assumes that a pointer to a lookup table has already been set up, which
18244 exposes the pointer load to CSE and code hoisting optimizations.
18246 @item inv:call
18247 @itemx inv:call2
18248 @itemx inv:fp
18249 Use the @samp{inv} algorithm for initial
18250 code generation, but if the code stays unoptimized, revert to the @samp{call},
18251 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
18252 potentially-trapping side effect of division by zero is carried by a
18253 separate instruction, so it is possible that all the integer instructions
18254 are hoisted out, but the marker for the side effect stays where it is.
18255 A recombination to floating-point operations or a call is not possible
18256 in that case.
18258 @item inv20u
18259 @itemx inv20l
18260 Variants of the @samp{inv:minlat} strategy.  In the case
18261 that the inverse calculation is not separated from the multiply, they speed
18262 up division where the dividend fits into 20 bits (plus sign where applicable)
18263 by inserting a test to skip a number of operations in this case; this test
18264 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
18265 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
18267 @end table
18269 @item -maccumulate-outgoing-args
18270 @opindex maccumulate-outgoing-args
18271 Reserve space once for outgoing arguments in the function prologue rather
18272 than around each call.  Generally beneficial for performance and size.  Also
18273 needed for unwinding to avoid changing the stack frame around conditional code.
18275 @item -mdivsi3_libfunc=@var{name}
18276 @opindex mdivsi3_libfunc=@var{name}
18277 Set the name of the library function used for 32-bit signed division to
18278 @var{name}.
18279 This only affects the name used in the @samp{call} and @samp{inv:call}
18280 division strategies, and the compiler still expects the same
18281 sets of input/output/clobbered registers as if this option were not present.
18283 @item -mfixed-range=@var{register-range}
18284 @opindex mfixed-range
18285 Generate code treating the given register range as fixed registers.
18286 A fixed register is one that the register allocator can not use.  This is
18287 useful when compiling kernel code.  A register range is specified as
18288 two registers separated by a dash.  Multiple register ranges can be
18289 specified separated by a comma.
18291 @item -mindexed-addressing
18292 @opindex mindexed-addressing
18293 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
18294 This is only safe if the hardware and/or OS implement 32-bit wrap-around
18295 semantics for the indexed addressing mode.  The architecture allows the
18296 implementation of processors with 64-bit MMU, which the OS could use to
18297 get 32-bit addressing, but since no current hardware implementation supports
18298 this or any other way to make the indexed addressing mode safe to use in
18299 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
18301 @item -mgettrcost=@var{number}
18302 @opindex mgettrcost=@var{number}
18303 Set the cost assumed for the @code{gettr} instruction to @var{number}.
18304 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
18306 @item -mpt-fixed
18307 @opindex mpt-fixed
18308 Assume @code{pt*} instructions won't trap.  This generally generates
18309 better-scheduled code, but is unsafe on current hardware.
18310 The current architecture
18311 definition says that @code{ptabs} and @code{ptrel} trap when the target 
18312 anded with 3 is 3.
18313 This has the unintentional effect of making it unsafe to schedule these
18314 instructions before a branch, or hoist them out of a loop.  For example,
18315 @code{__do_global_ctors}, a part of @file{libgcc}
18316 that runs constructors at program
18317 startup, calls functions in a list which is delimited by @minus{}1.  With the
18318 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
18319 That means that all the constructors run a bit more quickly, but when
18320 the loop comes to the end of the list, the program crashes because @code{ptabs}
18321 loads @minus{}1 into a target register.  
18323 Since this option is unsafe for any
18324 hardware implementing the current architecture specification, the default
18325 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
18326 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
18327 this deters register allocation from using target registers for storing
18328 ordinary integers.
18330 @item -minvalid-symbols
18331 @opindex minvalid-symbols
18332 Assume symbols might be invalid.  Ordinary function symbols generated by
18333 the compiler are always valid to load with
18334 @code{movi}/@code{shori}/@code{ptabs} or
18335 @code{movi}/@code{shori}/@code{ptrel},
18336 but with assembler and/or linker tricks it is possible
18337 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
18338 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
18339 It prevents cross-basic-block CSE, hoisting and most scheduling
18340 of symbol loads.  The default is @option{-mno-invalid-symbols}.
18342 @item -mbranch-cost=@var{num}
18343 @opindex mbranch-cost=@var{num}
18344 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
18345 make the compiler try to generate more branch-free code if possible.  
18346 If not specified the value is selected depending on the processor type that
18347 is being compiled for.
18349 @item -mzdcbranch
18350 @itemx -mno-zdcbranch
18351 @opindex mzdcbranch
18352 @opindex mno-zdcbranch
18353 Assume (do not assume) that zero displacement conditional branch instructions
18354 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
18355 compiler will try to prefer zero displacement branch code sequences.  This is
18356 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
18357 disabled by specifying @option{-mno-zdcbranch}.
18359 @item -mcbranchdi
18360 @opindex mcbranchdi
18361 Enable the @code{cbranchdi4} instruction pattern.
18363 @item -mcmpeqdi
18364 @opindex mcmpeqdi
18365 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
18366 is in effect.
18368 @item -mfused-madd
18369 @itemx -mno-fused-madd
18370 @opindex mfused-madd
18371 @opindex mno-fused-madd
18372 Generate code that uses (does not use) the floating-point multiply and
18373 accumulate instructions.  These instructions are generated by default
18374 if hardware floating point is used.  The machine-dependent
18375 @option{-mfused-madd} option is now mapped to the machine-independent
18376 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
18377 mapped to @option{-ffp-contract=off}.
18379 @item -mfsca
18380 @itemx -mno-fsca
18381 @opindex mfsca
18382 @opindex mno-fsca
18383 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
18384 and cosine approximations.  The option @code{-mfsca} must be used in
18385 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
18386 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
18387 approximations even if @code{-funsafe-math-optimizations} is in effect.
18389 @item -mfsrra
18390 @itemx -mno-fsrra
18391 @opindex mfsrra
18392 @opindex mno-fsrra
18393 Allow or disallow the compiler to emit the @code{fsrra} instruction for
18394 reciprocal square root approximations.  The option @code{-mfsrra} must be used
18395 in combination with @code{-funsafe-math-optimizations} and
18396 @code{-ffinite-math-only}.  It is enabled by default when generating code for
18397 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
18398 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
18399 in effect.
18401 @item -mpretend-cmove
18402 @opindex mpretend-cmove
18403 Prefer zero-displacement conditional branches for conditional move instruction
18404 patterns.  This can result in faster code on the SH4 processor.
18406 @end table
18408 @node Solaris 2 Options
18409 @subsection Solaris 2 Options
18410 @cindex Solaris 2 options
18412 These @samp{-m} options are supported on Solaris 2:
18414 @table @gcctabopt
18415 @item -mimpure-text
18416 @opindex mimpure-text
18417 @option{-mimpure-text}, used in addition to @option{-shared}, tells
18418 the compiler to not pass @option{-z text} to the linker when linking a
18419 shared object.  Using this option, you can link position-dependent
18420 code into a shared object.
18422 @option{-mimpure-text} suppresses the ``relocations remain against
18423 allocatable but non-writable sections'' linker error message.
18424 However, the necessary relocations trigger copy-on-write, and the
18425 shared object is not actually shared across processes.  Instead of
18426 using @option{-mimpure-text}, you should compile all source code with
18427 @option{-fpic} or @option{-fPIC}.
18429 @end table
18431 These switches are supported in addition to the above on Solaris 2:
18433 @table @gcctabopt
18434 @item -pthreads
18435 @opindex pthreads
18436 Add support for multithreading using the POSIX threads library.  This
18437 option sets flags for both the preprocessor and linker.  This option does
18438 not affect the thread safety of object code produced  by the compiler or
18439 that of libraries supplied with it.
18441 @item -pthread
18442 @opindex pthread
18443 This is a synonym for @option{-pthreads}.
18444 @end table
18446 @node SPARC Options
18447 @subsection SPARC Options
18448 @cindex SPARC options
18450 These @samp{-m} options are supported on the SPARC:
18452 @table @gcctabopt
18453 @item -mno-app-regs
18454 @itemx -mapp-regs
18455 @opindex mno-app-regs
18456 @opindex mapp-regs
18457 Specify @option{-mapp-regs} to generate output using the global registers
18458 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
18459 is the default.
18461 To be fully SVR4 ABI compliant at the cost of some performance loss,
18462 specify @option{-mno-app-regs}.  You should compile libraries and system
18463 software with this option.
18465 @item -mflat
18466 @itemx -mno-flat
18467 @opindex mflat
18468 @opindex mno-flat
18469 With @option{-mflat}, the compiler does not generate save/restore instructions
18470 and uses a ``flat'' or single register window model.  This model is compatible
18471 with the regular register window model.  The local registers and the input
18472 registers (0--5) are still treated as ``call-saved'' registers and are
18473 saved on the stack as needed.
18475 With @option{-mno-flat} (the default), the compiler generates save/restore
18476 instructions (except for leaf functions).  This is the normal operating mode.
18478 @item -mfpu
18479 @itemx -mhard-float
18480 @opindex mfpu
18481 @opindex mhard-float
18482 Generate output containing floating-point instructions.  This is the
18483 default.
18485 @item -mno-fpu
18486 @itemx -msoft-float
18487 @opindex mno-fpu
18488 @opindex msoft-float
18489 Generate output containing library calls for floating point.
18490 @strong{Warning:} the requisite libraries are not available for all SPARC
18491 targets.  Normally the facilities of the machine's usual C compiler are
18492 used, but this cannot be done directly in cross-compilation.  You must make
18493 your own arrangements to provide suitable library functions for
18494 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
18495 @samp{sparclite-*-*} do provide software floating-point support.
18497 @option{-msoft-float} changes the calling convention in the output file;
18498 therefore, it is only useful if you compile @emph{all} of a program with
18499 this option.  In particular, you need to compile @file{libgcc.a}, the
18500 library that comes with GCC, with @option{-msoft-float} in order for
18501 this to work.
18503 @item -mhard-quad-float
18504 @opindex mhard-quad-float
18505 Generate output containing quad-word (long double) floating-point
18506 instructions.
18508 @item -msoft-quad-float
18509 @opindex msoft-quad-float
18510 Generate output containing library calls for quad-word (long double)
18511 floating-point instructions.  The functions called are those specified
18512 in the SPARC ABI@.  This is the default.
18514 As of this writing, there are no SPARC implementations that have hardware
18515 support for the quad-word floating-point instructions.  They all invoke
18516 a trap handler for one of these instructions, and then the trap handler
18517 emulates the effect of the instruction.  Because of the trap handler overhead,
18518 this is much slower than calling the ABI library routines.  Thus the
18519 @option{-msoft-quad-float} option is the default.
18521 @item -mno-unaligned-doubles
18522 @itemx -munaligned-doubles
18523 @opindex mno-unaligned-doubles
18524 @opindex munaligned-doubles
18525 Assume that doubles have 8-byte alignment.  This is the default.
18527 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
18528 alignment only if they are contained in another type, or if they have an
18529 absolute address.  Otherwise, it assumes they have 4-byte alignment.
18530 Specifying this option avoids some rare compatibility problems with code
18531 generated by other compilers.  It is not the default because it results
18532 in a performance loss, especially for floating-point code.
18534 @item -mno-faster-structs
18535 @itemx -mfaster-structs
18536 @opindex mno-faster-structs
18537 @opindex mfaster-structs
18538 With @option{-mfaster-structs}, the compiler assumes that structures
18539 should have 8-byte alignment.  This enables the use of pairs of
18540 @code{ldd} and @code{std} instructions for copies in structure
18541 assignment, in place of twice as many @code{ld} and @code{st} pairs.
18542 However, the use of this changed alignment directly violates the SPARC
18543 ABI@.  Thus, it's intended only for use on targets where the developer
18544 acknowledges that their resulting code is not directly in line with
18545 the rules of the ABI@.
18547 @item -mcpu=@var{cpu_type}
18548 @opindex mcpu
18549 Set the instruction set, register set, and instruction scheduling parameters
18550 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
18551 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
18552 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
18553 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
18554 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
18555 and @samp{niagara4}.
18557 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
18558 which selects the best architecture option for the host processor.
18559 @option{-mcpu=native} has no effect if GCC does not recognize
18560 the processor.
18562 Default instruction scheduling parameters are used for values that select
18563 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
18564 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
18566 Here is a list of each supported architecture and their supported
18567 implementations.
18569 @table @asis
18570 @item v7
18571 cypress
18573 @item v8
18574 supersparc, hypersparc, leon
18576 @item sparclite
18577 f930, f934, sparclite86x
18579 @item sparclet
18580 tsc701
18582 @item v9
18583 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
18584 @end table
18586 By default (unless configured otherwise), GCC generates code for the V7
18587 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
18588 additionally optimizes it for the Cypress CY7C602 chip, as used in the
18589 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
18590 SPARCStation 1, 2, IPX etc.
18592 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
18593 architecture.  The only difference from V7 code is that the compiler emits
18594 the integer multiply and integer divide instructions which exist in SPARC-V8
18595 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
18596 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
18597 2000 series.
18599 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
18600 the SPARC architecture.  This adds the integer multiply, integer divide step
18601 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
18602 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
18603 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
18604 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
18605 MB86934 chip, which is the more recent SPARClite with FPU@.
18607 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
18608 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
18609 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
18610 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
18611 optimizes it for the TEMIC SPARClet chip.
18613 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
18614 architecture.  This adds 64-bit integer and floating-point move instructions,
18615 3 additional floating-point condition code registers and conditional move
18616 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
18617 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
18618 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
18619 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
18620 @option{-mcpu=niagara}, the compiler additionally optimizes it for
18621 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
18622 additionally optimizes it for Sun UltraSPARC T2 chips. With
18623 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
18624 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
18625 additionally optimizes it for Sun UltraSPARC T4 chips.
18627 @item -mtune=@var{cpu_type}
18628 @opindex mtune
18629 Set the instruction scheduling parameters for machine type
18630 @var{cpu_type}, but do not set the instruction set or register set that the
18631 option @option{-mcpu=@var{cpu_type}} does.
18633 The same values for @option{-mcpu=@var{cpu_type}} can be used for
18634 @option{-mtune=@var{cpu_type}}, but the only useful values are those
18635 that select a particular CPU implementation.  Those are @samp{cypress},
18636 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
18637 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
18638 @samp{niagara}, @samp{niagara2}, @samp{niagara3} and @samp{niagara4}.  With
18639 native Solaris and GNU/Linux toolchains, @samp{native} can also be used.
18641 @item -mv8plus
18642 @itemx -mno-v8plus
18643 @opindex mv8plus
18644 @opindex mno-v8plus
18645 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
18646 difference from the V8 ABI is that the global and out registers are
18647 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
18648 mode for all SPARC-V9 processors.
18650 @item -mvis
18651 @itemx -mno-vis
18652 @opindex mvis
18653 @opindex mno-vis
18654 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
18655 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
18657 @item -mvis2
18658 @itemx -mno-vis2
18659 @opindex mvis2
18660 @opindex mno-vis2
18661 With @option{-mvis2}, GCC generates code that takes advantage of
18662 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
18663 default is @option{-mvis2} when targeting a cpu that supports such
18664 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
18665 also sets @option{-mvis}.
18667 @item -mvis3
18668 @itemx -mno-vis3
18669 @opindex mvis3
18670 @opindex mno-vis3
18671 With @option{-mvis3}, GCC generates code that takes advantage of
18672 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
18673 default is @option{-mvis3} when targeting a cpu that supports such
18674 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
18675 also sets @option{-mvis2} and @option{-mvis}.
18677 @item -mpopc
18678 @itemx -mno-popc
18679 @opindex mpopc
18680 @opindex mno-popc
18681 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
18682 population count instruction.  The default is @option{-mpopc}
18683 when targeting a cpu that supports such instructions, such as Niagara-2 and
18684 later.
18686 @item -mfmaf
18687 @itemx -mno-fmaf
18688 @opindex mfmaf
18689 @opindex mno-fmaf
18690 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
18691 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
18692 when targeting a cpu that supports such instructions, such as Niagara-3 and
18693 later.
18695 @item -mfix-at697f
18696 @opindex mfix-at697f
18697 Enable the documented workaround for the single erratum of the Atmel AT697F
18698 processor (which corresponds to erratum #13 of the AT697E processor).
18699 @end table
18701 These @samp{-m} options are supported in addition to the above
18702 on SPARC-V9 processors in 64-bit environments:
18704 @table @gcctabopt
18705 @item -mlittle-endian
18706 @opindex mlittle-endian
18707 Generate code for a processor running in little-endian mode.  It is only
18708 available for a few configurations and most notably not on Solaris and Linux.
18710 @item -m32
18711 @itemx -m64
18712 @opindex m32
18713 @opindex m64
18714 Generate code for a 32-bit or 64-bit environment.
18715 The 32-bit environment sets int, long and pointer to 32 bits.
18716 The 64-bit environment sets int to 32 bits and long and pointer
18717 to 64 bits.
18719 @item -mcmodel=@var{which}
18720 @opindex mcmodel
18721 Set the code model to one of
18723 @table @samp
18724 @item medlow
18725 The Medium/Low code model: 64-bit addresses, programs
18726 must be linked in the low 32 bits of memory.  Programs can be statically
18727 or dynamically linked.
18729 @item medmid
18730 The Medium/Middle code model: 64-bit addresses, programs
18731 must be linked in the low 44 bits of memory, the text and data segments must
18732 be less than 2GB in size and the data segment must be located within 2GB of
18733 the text segment.
18735 @item medany
18736 The Medium/Anywhere code model: 64-bit addresses, programs
18737 may be linked anywhere in memory, the text and data segments must be less
18738 than 2GB in size and the data segment must be located within 2GB of the
18739 text segment.
18741 @item embmedany
18742 The Medium/Anywhere code model for embedded systems:
18743 64-bit addresses, the text and data segments must be less than 2GB in
18744 size, both starting anywhere in memory (determined at link time).  The
18745 global register %g4 points to the base of the data segment.  Programs
18746 are statically linked and PIC is not supported.
18747 @end table
18749 @item -mmemory-model=@var{mem-model}
18750 @opindex mmemory-model
18751 Set the memory model in force on the processor to one of
18753 @table @samp
18754 @item default
18755 The default memory model for the processor and operating system.
18757 @item rmo
18758 Relaxed Memory Order
18760 @item pso
18761 Partial Store Order
18763 @item tso
18764 Total Store Order
18766 @item sc
18767 Sequential Consistency
18768 @end table
18770 These memory models are formally defined in Appendix D of the Sparc V9
18771 architecture manual, as set in the processor's @code{PSTATE.MM} field.
18773 @item -mstack-bias
18774 @itemx -mno-stack-bias
18775 @opindex mstack-bias
18776 @opindex mno-stack-bias
18777 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
18778 frame pointer if present, are offset by @minus{}2047 which must be added back
18779 when making stack frame references.  This is the default in 64-bit mode.
18780 Otherwise, assume no such offset is present.
18781 @end table
18783 @node SPU Options
18784 @subsection SPU Options
18785 @cindex SPU options
18787 These @samp{-m} options are supported on the SPU:
18789 @table @gcctabopt
18790 @item -mwarn-reloc
18791 @itemx -merror-reloc
18792 @opindex mwarn-reloc
18793 @opindex merror-reloc
18795 The loader for SPU does not handle dynamic relocations.  By default, GCC
18796 gives an error when it generates code that requires a dynamic
18797 relocation.  @option{-mno-error-reloc} disables the error,
18798 @option{-mwarn-reloc} generates a warning instead.
18800 @item -msafe-dma
18801 @itemx -munsafe-dma
18802 @opindex msafe-dma
18803 @opindex munsafe-dma
18805 Instructions that initiate or test completion of DMA must not be
18806 reordered with respect to loads and stores of the memory that is being
18807 accessed.
18808 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
18809 memory accesses, but that can lead to inefficient code in places where the
18810 memory is known to not change.  Rather than mark the memory as volatile,
18811 you can use @option{-msafe-dma} to tell the compiler to treat
18812 the DMA instructions as potentially affecting all memory.  
18814 @item -mbranch-hints
18815 @opindex mbranch-hints
18817 By default, GCC generates a branch hint instruction to avoid
18818 pipeline stalls for always-taken or probably-taken branches.  A hint
18819 is not generated closer than 8 instructions away from its branch.
18820 There is little reason to disable them, except for debugging purposes,
18821 or to make an object a little bit smaller.
18823 @item -msmall-mem
18824 @itemx -mlarge-mem
18825 @opindex msmall-mem
18826 @opindex mlarge-mem
18828 By default, GCC generates code assuming that addresses are never larger
18829 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
18830 a full 32-bit address.
18832 @item -mstdmain
18833 @opindex mstdmain
18835 By default, GCC links against startup code that assumes the SPU-style
18836 main function interface (which has an unconventional parameter list).
18837 With @option{-mstdmain}, GCC links your program against startup
18838 code that assumes a C99-style interface to @code{main}, including a
18839 local copy of @code{argv} strings.
18841 @item -mfixed-range=@var{register-range}
18842 @opindex mfixed-range
18843 Generate code treating the given register range as fixed registers.
18844 A fixed register is one that the register allocator can not use.  This is
18845 useful when compiling kernel code.  A register range is specified as
18846 two registers separated by a dash.  Multiple register ranges can be
18847 specified separated by a comma.
18849 @item -mea32
18850 @itemx -mea64
18851 @opindex mea32
18852 @opindex mea64
18853 Compile code assuming that pointers to the PPU address space accessed
18854 via the @code{__ea} named address space qualifier are either 32 or 64
18855 bits wide.  The default is 32 bits.  As this is an ABI changing option,
18856 all object code in an executable must be compiled with the same setting.
18858 @item -maddress-space-conversion
18859 @itemx -mno-address-space-conversion
18860 @opindex maddress-space-conversion
18861 @opindex mno-address-space-conversion
18862 Allow/disallow treating the @code{__ea} address space as superset
18863 of the generic address space.  This enables explicit type casts
18864 between @code{__ea} and generic pointer as well as implicit
18865 conversions of generic pointers to @code{__ea} pointers.  The
18866 default is to allow address space pointer conversions.
18868 @item -mcache-size=@var{cache-size}
18869 @opindex mcache-size
18870 This option controls the version of libgcc that the compiler links to an
18871 executable and selects a software-managed cache for accessing variables
18872 in the @code{__ea} address space with a particular cache size.  Possible
18873 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
18874 and @samp{128}.  The default cache size is 64KB.
18876 @item -matomic-updates
18877 @itemx -mno-atomic-updates
18878 @opindex matomic-updates
18879 @opindex mno-atomic-updates
18880 This option controls the version of libgcc that the compiler links to an
18881 executable and selects whether atomic updates to the software-managed
18882 cache of PPU-side variables are used.  If you use atomic updates, changes
18883 to a PPU variable from SPU code using the @code{__ea} named address space
18884 qualifier do not interfere with changes to other PPU variables residing
18885 in the same cache line from PPU code.  If you do not use atomic updates,
18886 such interference may occur; however, writing back cache lines is
18887 more efficient.  The default behavior is to use atomic updates.
18889 @item -mdual-nops
18890 @itemx -mdual-nops=@var{n}
18891 @opindex mdual-nops
18892 By default, GCC inserts nops to increase dual issue when it expects
18893 it to increase performance.  @var{n} can be a value from 0 to 10.  A
18894 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
18895 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
18897 @item -mhint-max-nops=@var{n}
18898 @opindex mhint-max-nops
18899 Maximum number of nops to insert for a branch hint.  A branch hint must
18900 be at least 8 instructions away from the branch it is affecting.  GCC
18901 inserts up to @var{n} nops to enforce this, otherwise it does not
18902 generate the branch hint.
18904 @item -mhint-max-distance=@var{n}
18905 @opindex mhint-max-distance
18906 The encoding of the branch hint instruction limits the hint to be within
18907 256 instructions of the branch it is affecting.  By default, GCC makes
18908 sure it is within 125.
18910 @item -msafe-hints
18911 @opindex msafe-hints
18912 Work around a hardware bug that causes the SPU to stall indefinitely.
18913 By default, GCC inserts the @code{hbrp} instruction to make sure
18914 this stall won't happen.
18916 @end table
18918 @node System V Options
18919 @subsection Options for System V
18921 These additional options are available on System V Release 4 for
18922 compatibility with other compilers on those systems:
18924 @table @gcctabopt
18925 @item -G
18926 @opindex G
18927 Create a shared object.
18928 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
18930 @item -Qy
18931 @opindex Qy
18932 Identify the versions of each tool used by the compiler, in a
18933 @code{.ident} assembler directive in the output.
18935 @item -Qn
18936 @opindex Qn
18937 Refrain from adding @code{.ident} directives to the output file (this is
18938 the default).
18940 @item -YP,@var{dirs}
18941 @opindex YP
18942 Search the directories @var{dirs}, and no others, for libraries
18943 specified with @option{-l}.
18945 @item -Ym,@var{dir}
18946 @opindex Ym
18947 Look in the directory @var{dir} to find the M4 preprocessor.
18948 The assembler uses this option.
18949 @c This is supposed to go with a -Yd for predefined M4 macro files, but
18950 @c the generic assembler that comes with Solaris takes just -Ym.
18951 @end table
18953 @node TILE-Gx Options
18954 @subsection TILE-Gx Options
18955 @cindex TILE-Gx options
18957 These @samp{-m} options are supported on the TILE-Gx:
18959 @table @gcctabopt
18960 @item -mcpu=@var{name}
18961 @opindex mcpu
18962 Selects the type of CPU to be targeted.  Currently the only supported
18963 type is @samp{tilegx}.
18965 @item -m32
18966 @itemx -m64
18967 @opindex m32
18968 @opindex m64
18969 Generate code for a 32-bit or 64-bit environment.  The 32-bit
18970 environment sets int, long, and pointer to 32 bits.  The 64-bit
18971 environment sets int to 32 bits and long and pointer to 64 bits.
18972 @end table
18974 @node TILEPro Options
18975 @subsection TILEPro Options
18976 @cindex TILEPro options
18978 These @samp{-m} options are supported on the TILEPro:
18980 @table @gcctabopt
18981 @item -mcpu=@var{name}
18982 @opindex mcpu
18983 Selects the type of CPU to be targeted.  Currently the only supported
18984 type is @samp{tilepro}.
18986 @item -m32
18987 @opindex m32
18988 Generate code for a 32-bit environment, which sets int, long, and
18989 pointer to 32 bits.  This is the only supported behavior so the flag
18990 is essentially ignored.
18991 @end table
18993 @node V850 Options
18994 @subsection V850 Options
18995 @cindex V850 Options
18997 These @samp{-m} options are defined for V850 implementations:
18999 @table @gcctabopt
19000 @item -mlong-calls
19001 @itemx -mno-long-calls
19002 @opindex mlong-calls
19003 @opindex mno-long-calls
19004 Treat all calls as being far away (near).  If calls are assumed to be
19005 far away, the compiler always loads the function's address into a
19006 register, and calls indirect through the pointer.
19008 @item -mno-ep
19009 @itemx -mep
19010 @opindex mno-ep
19011 @opindex mep
19012 Do not optimize (do optimize) basic blocks that use the same index
19013 pointer 4 or more times to copy pointer into the @code{ep} register, and
19014 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
19015 option is on by default if you optimize.
19017 @item -mno-prolog-function
19018 @itemx -mprolog-function
19019 @opindex mno-prolog-function
19020 @opindex mprolog-function
19021 Do not use (do use) external functions to save and restore registers
19022 at the prologue and epilogue of a function.  The external functions
19023 are slower, but use less code space if more than one function saves
19024 the same number of registers.  The @option{-mprolog-function} option
19025 is on by default if you optimize.
19027 @item -mspace
19028 @opindex mspace
19029 Try to make the code as small as possible.  At present, this just turns
19030 on the @option{-mep} and @option{-mprolog-function} options.
19032 @item -mtda=@var{n}
19033 @opindex mtda
19034 Put static or global variables whose size is @var{n} bytes or less into
19035 the tiny data area that register @code{ep} points to.  The tiny data
19036 area can hold up to 256 bytes in total (128 bytes for byte references).
19038 @item -msda=@var{n}
19039 @opindex msda
19040 Put static or global variables whose size is @var{n} bytes or less into
19041 the small data area that register @code{gp} points to.  The small data
19042 area can hold up to 64 kilobytes.
19044 @item -mzda=@var{n}
19045 @opindex mzda
19046 Put static or global variables whose size is @var{n} bytes or less into
19047 the first 32 kilobytes of memory.
19049 @item -mv850
19050 @opindex mv850
19051 Specify that the target processor is the V850.
19053 @item -mbig-switch
19054 @opindex mbig-switch
19055 Generate code suitable for big switch tables.  Use this option only if
19056 the assembler/linker complain about out of range branches within a switch
19057 table.
19059 @item -mapp-regs
19060 @opindex mapp-regs
19061 This option causes r2 and r5 to be used in the code generated by
19062 the compiler.  This setting is the default.
19064 @item -mno-app-regs
19065 @opindex mno-app-regs
19066 This option causes r2 and r5 to be treated as fixed registers.
19068 @item -mv850e2v3
19069 @opindex mv850e2v3
19070 Specify that the target processor is the V850E2V3.  The preprocessor
19071 constant @samp{__v850e2v3__} is defined if
19072 this option is used.
19074 @item -mv850e2
19075 @opindex mv850e2
19076 Specify that the target processor is the V850E2.  The preprocessor
19077 constant @samp{__v850e2__} is defined if this option is used.
19079 @item -mv850e1
19080 @opindex mv850e1
19081 Specify that the target processor is the V850E1.  The preprocessor
19082 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
19083 this option is used.
19085 @item -mv850es
19086 @opindex mv850es
19087 Specify that the target processor is the V850ES.  This is an alias for
19088 the @option{-mv850e1} option.
19090 @item -mv850e
19091 @opindex mv850e
19092 Specify that the target processor is the V850E@.  The preprocessor
19093 constant @samp{__v850e__} is defined if this option is used.
19095 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
19096 nor @option{-mv850e2} nor @option{-mv850e2v3}
19097 are defined then a default target processor is chosen and the
19098 relevant @samp{__v850*__} preprocessor constant is defined.
19100 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
19101 defined, regardless of which processor variant is the target.
19103 @item -mdisable-callt
19104 @opindex mdisable-callt
19105 This option suppresses generation of the @code{CALLT} instruction for the
19106 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
19107 @option{-mno-disable-callt} which allows the @code{CALLT} instruction to be used.
19109 @end table
19111 @node VAX Options
19112 @subsection VAX Options
19113 @cindex VAX options
19115 These @samp{-m} options are defined for the VAX:
19117 @table @gcctabopt
19118 @item -munix
19119 @opindex munix
19120 Do not output certain jump instructions (@code{aobleq} and so on)
19121 that the Unix assembler for the VAX cannot handle across long
19122 ranges.
19124 @item -mgnu
19125 @opindex mgnu
19126 Do output those jump instructions, on the assumption that the
19127 GNU assembler is being used.
19129 @item -mg
19130 @opindex mg
19131 Output code for G-format floating-point numbers instead of D-format.
19132 @end table
19134 @node VMS Options
19135 @subsection VMS Options
19137 These @samp{-m} options are defined for the VMS implementations:
19139 @table @gcctabopt
19140 @item -mvms-return-codes
19141 @opindex mvms-return-codes
19142 Return VMS condition codes from @code{main}. The default is to return POSIX-style
19143 condition (e.g.@ error) codes.
19145 @item -mdebug-main=@var{prefix}
19146 @opindex mdebug-main=@var{prefix}
19147 Flag the first routine whose name starts with @var{prefix} as the main
19148 routine for the debugger.
19150 @item -mmalloc64
19151 @opindex mmalloc64
19152 Default to 64-bit memory allocation routines.
19154 @item -mpointer-size=@var{size}
19155 @opindex -mpointer-size=@var{size}
19156 Set the default size of pointers. Possible options for @var{size} are
19157 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
19158 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
19159 The later option disables @code{pragma pointer_size}.
19160 @end table
19162 @node VxWorks Options
19163 @subsection VxWorks Options
19164 @cindex VxWorks Options
19166 The options in this section are defined for all VxWorks targets.
19167 Options specific to the target hardware are listed with the other
19168 options for that target.
19170 @table @gcctabopt
19171 @item -mrtp
19172 @opindex mrtp
19173 GCC can generate code for both VxWorks kernels and real time processes
19174 (RTPs).  This option switches from the former to the latter.  It also
19175 defines the preprocessor macro @code{__RTP__}.
19177 @item -non-static
19178 @opindex non-static
19179 Link an RTP executable against shared libraries rather than static
19180 libraries.  The options @option{-static} and @option{-shared} can
19181 also be used for RTPs (@pxref{Link Options}); @option{-static}
19182 is the default.
19184 @item -Bstatic
19185 @itemx -Bdynamic
19186 @opindex Bstatic
19187 @opindex Bdynamic
19188 These options are passed down to the linker.  They are defined for
19189 compatibility with Diab.
19191 @item -Xbind-lazy
19192 @opindex Xbind-lazy
19193 Enable lazy binding of function calls.  This option is equivalent to
19194 @option{-Wl,-z,now} and is defined for compatibility with Diab.
19196 @item -Xbind-now
19197 @opindex Xbind-now
19198 Disable lazy binding of function calls.  This option is the default and
19199 is defined for compatibility with Diab.
19200 @end table
19202 @node x86-64 Options
19203 @subsection x86-64 Options
19204 @cindex x86-64 options
19206 These are listed under @xref{i386 and x86-64 Options}.
19208 @node Xstormy16 Options
19209 @subsection Xstormy16 Options
19210 @cindex Xstormy16 Options
19212 These options are defined for Xstormy16:
19214 @table @gcctabopt
19215 @item -msim
19216 @opindex msim
19217 Choose startup files and linker script suitable for the simulator.
19218 @end table
19220 @node Xtensa Options
19221 @subsection Xtensa Options
19222 @cindex Xtensa Options
19224 These options are supported for Xtensa targets:
19226 @table @gcctabopt
19227 @item -mconst16
19228 @itemx -mno-const16
19229 @opindex mconst16
19230 @opindex mno-const16
19231 Enable or disable use of @code{CONST16} instructions for loading
19232 constant values.  The @code{CONST16} instruction is currently not a
19233 standard option from Tensilica.  When enabled, @code{CONST16}
19234 instructions are always used in place of the standard @code{L32R}
19235 instructions.  The use of @code{CONST16} is enabled by default only if
19236 the @code{L32R} instruction is not available.
19238 @item -mfused-madd
19239 @itemx -mno-fused-madd
19240 @opindex mfused-madd
19241 @opindex mno-fused-madd
19242 Enable or disable use of fused multiply/add and multiply/subtract
19243 instructions in the floating-point option.  This has no effect if the
19244 floating-point option is not also enabled.  Disabling fused multiply/add
19245 and multiply/subtract instructions forces the compiler to use separate
19246 instructions for the multiply and add/subtract operations.  This may be
19247 desirable in some cases where strict IEEE 754-compliant results are
19248 required: the fused multiply add/subtract instructions do not round the
19249 intermediate result, thereby producing results with @emph{more} bits of
19250 precision than specified by the IEEE standard.  Disabling fused multiply
19251 add/subtract instructions also ensures that the program output is not
19252 sensitive to the compiler's ability to combine multiply and add/subtract
19253 operations.
19255 @item -mserialize-volatile
19256 @itemx -mno-serialize-volatile
19257 @opindex mserialize-volatile
19258 @opindex mno-serialize-volatile
19259 When this option is enabled, GCC inserts @code{MEMW} instructions before
19260 @code{volatile} memory references to guarantee sequential consistency.
19261 The default is @option{-mserialize-volatile}.  Use
19262 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
19264 @item -mforce-no-pic
19265 @opindex mforce-no-pic
19266 For targets, like GNU/Linux, where all user-mode Xtensa code must be
19267 position-independent code (PIC), this option disables PIC for compiling
19268 kernel code.
19270 @item -mtext-section-literals
19271 @itemx -mno-text-section-literals
19272 @opindex mtext-section-literals
19273 @opindex mno-text-section-literals
19274 Control the treatment of literal pools.  The default is
19275 @option{-mno-text-section-literals}, which places literals in a separate
19276 section in the output file.  This allows the literal pool to be placed
19277 in a data RAM/ROM, and it also allows the linker to combine literal
19278 pools from separate object files to remove redundant literals and
19279 improve code size.  With @option{-mtext-section-literals}, the literals
19280 are interspersed in the text section in order to keep them as close as
19281 possible to their references.  This may be necessary for large assembly
19282 files.
19284 @item -mtarget-align
19285 @itemx -mno-target-align
19286 @opindex mtarget-align
19287 @opindex mno-target-align
19288 When this option is enabled, GCC instructs the assembler to
19289 automatically align instructions to reduce branch penalties at the
19290 expense of some code density.  The assembler attempts to widen density
19291 instructions to align branch targets and the instructions following call
19292 instructions.  If there are not enough preceding safe density
19293 instructions to align a target, no widening is performed.  The
19294 default is @option{-mtarget-align}.  These options do not affect the
19295 treatment of auto-aligned instructions like @code{LOOP}, which the
19296 assembler always aligns, either by widening density instructions or
19297 by inserting NOP instructions.
19299 @item -mlongcalls
19300 @itemx -mno-longcalls
19301 @opindex mlongcalls
19302 @opindex mno-longcalls
19303 When this option is enabled, GCC instructs the assembler to translate
19304 direct calls to indirect calls unless it can determine that the target
19305 of a direct call is in the range allowed by the call instruction.  This
19306 translation typically occurs for calls to functions in other source
19307 files.  Specifically, the assembler translates a direct @code{CALL}
19308 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
19309 The default is @option{-mno-longcalls}.  This option should be used in
19310 programs where the call target can potentially be out of range.  This
19311 option is implemented in the assembler, not the compiler, so the
19312 assembly code generated by GCC still shows direct call
19313 instructions---look at the disassembled object code to see the actual
19314 instructions.  Note that the assembler uses an indirect call for
19315 every cross-file call, not just those that really are out of range.
19316 @end table
19318 @node zSeries Options
19319 @subsection zSeries Options
19320 @cindex zSeries options
19322 These are listed under @xref{S/390 and zSeries Options}.
19324 @node Code Gen Options
19325 @section Options for Code Generation Conventions
19326 @cindex code generation conventions
19327 @cindex options, code generation
19328 @cindex run-time options
19330 These machine-independent options control the interface conventions
19331 used in code generation.
19333 Most of them have both positive and negative forms; the negative form
19334 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
19335 one of the forms is listed---the one that is not the default.  You
19336 can figure out the other form by either removing @samp{no-} or adding
19339 @table @gcctabopt
19340 @item -fbounds-check
19341 @opindex fbounds-check
19342 For front ends that support it, generate additional code to check that
19343 indices used to access arrays are within the declared range.  This is
19344 currently only supported by the Java and Fortran front ends, where
19345 this option defaults to true and false respectively.
19347 @item -fstack-reuse=@var{reuse-level}
19348 @opindex fstack_reuse
19349 This option controls stack space reuse for user declared local/auto variables
19350 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
19351 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
19352 local variables and temporaries, @samp{named_vars} enables the reuse only for
19353 user defined local variables with names, and @samp{none} disables stack reuse
19354 completely. The default value is @samp{all}. The option is needed when the
19355 program extends the lifetime of a scoped local variable or a compiler generated
19356 temporary beyond the end point defined by the language.  When a lifetime of
19357 a variable ends, and if the variable lives in memory, the optimizing compiler
19358 has the freedom to reuse its stack space with other temporaries or scoped
19359 local variables whose live range does not overlap with it. Legacy code extending
19360 local lifetime will likely to break with the stack reuse optimization.
19362 For example,
19364 @smallexample
19365    int *p;
19366    @{
19367      int local1;
19369      p = &local1;
19370      local1 = 10;
19371      ....
19372    @}
19373    @{
19374       int local2;
19375       local2 = 20;
19376       ...
19377    @}
19379    if (*p == 10)  // out of scope use of local1
19380      @{
19382      @}
19383 @end smallexample
19385 Another example:
19386 @smallexample
19388    struct A
19389    @{
19390        A(int k) : i(k), j(k) @{ @}
19391        int i;
19392        int j;
19393    @};
19395    A *ap;
19397    void foo(const A& ar)
19398    @{
19399       ap = &ar;
19400    @}
19402    void bar()
19403    @{
19404       foo(A(10)); // temp object's lifetime ends when foo returns
19406       @{
19407         A a(20);
19408         ....
19409       @}
19410       ap->i+= 10;  // ap references out of scope temp whose space
19411                    // is reused with a. What is the value of ap->i?
19412    @}
19414 @end smallexample
19416 The lifetime of a compiler generated temporary is well defined by the C++
19417 standard. When a lifetime of a temporary ends, and if the temporary lives
19418 in memory, the optimizing compiler has the freedom to reuse its stack
19419 space with other temporaries or scoped local variables whose live range
19420 does not overlap with it. However some of the legacy code relies on
19421 the behavior of older compilers in which temporaries' stack space is
19422 not reused, the aggressive stack reuse can lead to runtime errors. This
19423 option is used to control the temporary stack reuse optimization.
19425 @item -ftrapv
19426 @opindex ftrapv
19427 This option generates traps for signed overflow on addition, subtraction,
19428 multiplication operations.
19430 @item -fwrapv
19431 @opindex fwrapv
19432 This option instructs the compiler to assume that signed arithmetic
19433 overflow of addition, subtraction and multiplication wraps around
19434 using twos-complement representation.  This flag enables some optimizations
19435 and disables others.  This option is enabled by default for the Java
19436 front end, as required by the Java language specification.
19438 @item -fexceptions
19439 @opindex fexceptions
19440 Enable exception handling.  Generates extra code needed to propagate
19441 exceptions.  For some targets, this implies GCC generates frame
19442 unwind information for all functions, which can produce significant data
19443 size overhead, although it does not affect execution.  If you do not
19444 specify this option, GCC enables it by default for languages like
19445 C++ that normally require exception handling, and disables it for
19446 languages like C that do not normally require it.  However, you may need
19447 to enable this option when compiling C code that needs to interoperate
19448 properly with exception handlers written in C++.  You may also wish to
19449 disable this option if you are compiling older C++ programs that don't
19450 use exception handling.
19452 @item -fnon-call-exceptions
19453 @opindex fnon-call-exceptions
19454 Generate code that allows trapping instructions to throw exceptions.
19455 Note that this requires platform-specific runtime support that does
19456 not exist everywhere.  Moreover, it only allows @emph{trapping}
19457 instructions to throw exceptions, i.e.@: memory references or floating-point
19458 instructions.  It does not allow exceptions to be thrown from
19459 arbitrary signal handlers such as @code{SIGALRM}.
19461 @item -fdelete-dead-exceptions
19462 @opindex fdelete-dead-exceptions
19463 Consider that instructions that may throw exceptions but don't otherwise
19464 contribute to the execution of the program can be optimized away.
19465 This option is enabled by default for the Ada front end, as permitted by
19466 the Ada language specification.
19467 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
19469 @item -funwind-tables
19470 @opindex funwind-tables
19471 Similar to @option{-fexceptions}, except that it just generates any needed
19472 static data, but does not affect the generated code in any other way.
19473 You normally do not need to enable this option; instead, a language processor
19474 that needs this handling enables it on your behalf.
19476 @item -fasynchronous-unwind-tables
19477 @opindex fasynchronous-unwind-tables
19478 Generate unwind table in DWARF 2 format, if supported by target machine.  The
19479 table is exact at each instruction boundary, so it can be used for stack
19480 unwinding from asynchronous events (such as debugger or garbage collector).
19482 @item -fpcc-struct-return
19483 @opindex fpcc-struct-return
19484 Return ``short'' @code{struct} and @code{union} values in memory like
19485 longer ones, rather than in registers.  This convention is less
19486 efficient, but it has the advantage of allowing intercallability between
19487 GCC-compiled files and files compiled with other compilers, particularly
19488 the Portable C Compiler (pcc).
19490 The precise convention for returning structures in memory depends
19491 on the target configuration macros.
19493 Short structures and unions are those whose size and alignment match
19494 that of some integer type.
19496 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
19497 switch is not binary compatible with code compiled with the
19498 @option{-freg-struct-return} switch.
19499 Use it to conform to a non-default application binary interface.
19501 @item -freg-struct-return
19502 @opindex freg-struct-return
19503 Return @code{struct} and @code{union} values in registers when possible.
19504 This is more efficient for small structures than
19505 @option{-fpcc-struct-return}.
19507 If you specify neither @option{-fpcc-struct-return} nor
19508 @option{-freg-struct-return}, GCC defaults to whichever convention is
19509 standard for the target.  If there is no standard convention, GCC
19510 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
19511 the principal compiler.  In those cases, we can choose the standard, and
19512 we chose the more efficient register return alternative.
19514 @strong{Warning:} code compiled with the @option{-freg-struct-return}
19515 switch is not binary compatible with code compiled with the
19516 @option{-fpcc-struct-return} switch.
19517 Use it to conform to a non-default application binary interface.
19519 @item -fshort-enums
19520 @opindex fshort-enums
19521 Allocate to an @code{enum} type only as many bytes as it needs for the
19522 declared range of possible values.  Specifically, the @code{enum} type
19523 is equivalent to the smallest integer type that has enough room.
19525 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
19526 code that is not binary compatible with code generated without that switch.
19527 Use it to conform to a non-default application binary interface.
19529 @item -fshort-double
19530 @opindex fshort-double
19531 Use the same size for @code{double} as for @code{float}.
19533 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
19534 code that is not binary compatible with code generated without that switch.
19535 Use it to conform to a non-default application binary interface.
19537 @item -fshort-wchar
19538 @opindex fshort-wchar
19539 Override the underlying type for @samp{wchar_t} to be @samp{short
19540 unsigned int} instead of the default for the target.  This option is
19541 useful for building programs to run under WINE@.
19543 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
19544 code that is not binary compatible with code generated without that switch.
19545 Use it to conform to a non-default application binary interface.
19547 @item -fno-common
19548 @opindex fno-common
19549 In C code, controls the placement of uninitialized global variables.
19550 Unix C compilers have traditionally permitted multiple definitions of
19551 such variables in different compilation units by placing the variables
19552 in a common block.
19553 This is the behavior specified by @option{-fcommon}, and is the default
19554 for GCC on most targets.
19555 On the other hand, this behavior is not required by ISO C, and on some
19556 targets may carry a speed or code size penalty on variable references.
19557 The @option{-fno-common} option specifies that the compiler should place
19558 uninitialized global variables in the data section of the object file,
19559 rather than generating them as common blocks.
19560 This has the effect that if the same variable is declared
19561 (without @code{extern}) in two different compilations,
19562 you get a multiple-definition error when you link them.
19563 In this case, you must compile with @option{-fcommon} instead.
19564 Compiling with @option{-fno-common} is useful on targets for which
19565 it provides better performance, or if you wish to verify that the
19566 program will work on other systems that always treat uninitialized
19567 variable declarations this way.
19569 @item -fno-ident
19570 @opindex fno-ident
19571 Ignore the @samp{#ident} directive.
19573 @item -finhibit-size-directive
19574 @opindex finhibit-size-directive
19575 Don't output a @code{.size} assembler directive, or anything else that
19576 would cause trouble if the function is split in the middle, and the
19577 two halves are placed at locations far apart in memory.  This option is
19578 used when compiling @file{crtstuff.c}; you should not need to use it
19579 for anything else.
19581 @item -fverbose-asm
19582 @opindex fverbose-asm
19583 Put extra commentary information in the generated assembly code to
19584 make it more readable.  This option is generally only of use to those
19585 who actually need to read the generated assembly code (perhaps while
19586 debugging the compiler itself).
19588 @option{-fno-verbose-asm}, the default, causes the
19589 extra information to be omitted and is useful when comparing two assembler
19590 files.
19592 @item -frecord-gcc-switches
19593 @opindex frecord-gcc-switches
19594 This switch causes the command line used to invoke the
19595 compiler to be recorded into the object file that is being created.
19596 This switch is only implemented on some targets and the exact format
19597 of the recording is target and binary file format dependent, but it
19598 usually takes the form of a section containing ASCII text.  This
19599 switch is related to the @option{-fverbose-asm} switch, but that
19600 switch only records information in the assembler output file as
19601 comments, so it never reaches the object file.
19602 See also @option{-grecord-gcc-switches} for another
19603 way of storing compiler options into the object file.
19605 @item -fpic
19606 @opindex fpic
19607 @cindex global offset table
19608 @cindex PIC
19609 Generate position-independent code (PIC) suitable for use in a shared
19610 library, if supported for the target machine.  Such code accesses all
19611 constant addresses through a global offset table (GOT)@.  The dynamic
19612 loader resolves the GOT entries when the program starts (the dynamic
19613 loader is not part of GCC; it is part of the operating system).  If
19614 the GOT size for the linked executable exceeds a machine-specific
19615 maximum size, you get an error message from the linker indicating that
19616 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
19617 instead.  (These maximums are 8k on the SPARC and 32k
19618 on the m68k and RS/6000.  The 386 has no such limit.)
19620 Position-independent code requires special support, and therefore works
19621 only on certain machines.  For the 386, GCC supports PIC for System V
19622 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
19623 position-independent.
19625 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19626 are defined to 1.
19628 @item -fPIC
19629 @opindex fPIC
19630 If supported for the target machine, emit position-independent code,
19631 suitable for dynamic linking and avoiding any limit on the size of the
19632 global offset table.  This option makes a difference on the m68k,
19633 PowerPC and SPARC@.
19635 Position-independent code requires special support, and therefore works
19636 only on certain machines.
19638 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19639 are defined to 2.
19641 @item -fpie
19642 @itemx -fPIE
19643 @opindex fpie
19644 @opindex fPIE
19645 These options are similar to @option{-fpic} and @option{-fPIC}, but
19646 generated position independent code can be only linked into executables.
19647 Usually these options are used when @option{-pie} GCC option is
19648 used during linking.
19650 @option{-fpie} and @option{-fPIE} both define the macros
19651 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
19652 for @option{-fpie} and 2 for @option{-fPIE}.
19654 @item -fno-jump-tables
19655 @opindex fno-jump-tables
19656 Do not use jump tables for switch statements even where it would be
19657 more efficient than other code generation strategies.  This option is
19658 of use in conjunction with @option{-fpic} or @option{-fPIC} for
19659 building code that forms part of a dynamic linker and cannot
19660 reference the address of a jump table.  On some targets, jump tables
19661 do not require a GOT and this option is not needed.
19663 @item -ffixed-@var{reg}
19664 @opindex ffixed
19665 Treat the register named @var{reg} as a fixed register; generated code
19666 should never refer to it (except perhaps as a stack pointer, frame
19667 pointer or in some other fixed role).
19669 @var{reg} must be the name of a register.  The register names accepted
19670 are machine-specific and are defined in the @code{REGISTER_NAMES}
19671 macro in the machine description macro file.
19673 This flag does not have a negative form, because it specifies a
19674 three-way choice.
19676 @item -fcall-used-@var{reg}
19677 @opindex fcall-used
19678 Treat the register named @var{reg} as an allocable register that is
19679 clobbered by function calls.  It may be allocated for temporaries or
19680 variables that do not live across a call.  Functions compiled this way
19681 do not save and restore the register @var{reg}.
19683 It is an error to use this flag with the frame pointer or stack pointer.
19684 Use of this flag for other registers that have fixed pervasive roles in
19685 the machine's execution model produces disastrous results.
19687 This flag does not have a negative form, because it specifies a
19688 three-way choice.
19690 @item -fcall-saved-@var{reg}
19691 @opindex fcall-saved
19692 Treat the register named @var{reg} as an allocable register saved by
19693 functions.  It may be allocated even for temporaries or variables that
19694 live across a call.  Functions compiled this way save and restore
19695 the register @var{reg} if they use it.
19697 It is an error to use this flag with the frame pointer or stack pointer.
19698 Use of this flag for other registers that have fixed pervasive roles in
19699 the machine's execution model produces disastrous results.
19701 A different sort of disaster results from the use of this flag for
19702 a register in which function values may be returned.
19704 This flag does not have a negative form, because it specifies a
19705 three-way choice.
19707 @item -fpack-struct[=@var{n}]
19708 @opindex fpack-struct
19709 Without a value specified, pack all structure members together without
19710 holes.  When a value is specified (which must be a small power of two), pack
19711 structure members according to this value, representing the maximum
19712 alignment (that is, objects with default alignment requirements larger than
19713 this are output potentially unaligned at the next fitting location.
19715 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
19716 code that is not binary compatible with code generated without that switch.
19717 Additionally, it makes the code suboptimal.
19718 Use it to conform to a non-default application binary interface.
19720 @item -finstrument-functions
19721 @opindex finstrument-functions
19722 Generate instrumentation calls for entry and exit to functions.  Just
19723 after function entry and just before function exit, the following
19724 profiling functions are called with the address of the current
19725 function and its call site.  (On some platforms,
19726 @code{__builtin_return_address} does not work beyond the current
19727 function, so the call site information may not be available to the
19728 profiling functions otherwise.)
19730 @smallexample
19731 void __cyg_profile_func_enter (void *this_fn,
19732                                void *call_site);
19733 void __cyg_profile_func_exit  (void *this_fn,
19734                                void *call_site);
19735 @end smallexample
19737 The first argument is the address of the start of the current function,
19738 which may be looked up exactly in the symbol table.
19740 This instrumentation is also done for functions expanded inline in other
19741 functions.  The profiling calls indicate where, conceptually, the
19742 inline function is entered and exited.  This means that addressable
19743 versions of such functions must be available.  If all your uses of a
19744 function are expanded inline, this may mean an additional expansion of
19745 code size.  If you use @samp{extern inline} in your C code, an
19746 addressable version of such functions must be provided.  (This is
19747 normally the case anyway, but if you get lucky and the optimizer always
19748 expands the functions inline, you might have gotten away without
19749 providing static copies.)
19751 A function may be given the attribute @code{no_instrument_function}, in
19752 which case this instrumentation is not done.  This can be used, for
19753 example, for the profiling functions listed above, high-priority
19754 interrupt routines, and any functions from which the profiling functions
19755 cannot safely be called (perhaps signal handlers, if the profiling
19756 routines generate output or allocate memory).
19758 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
19759 @opindex finstrument-functions-exclude-file-list
19761 Set the list of functions that are excluded from instrumentation (see
19762 the description of @code{-finstrument-functions}).  If the file that
19763 contains a function definition matches with one of @var{file}, then
19764 that function is not instrumented.  The match is done on substrings:
19765 if the @var{file} parameter is a substring of the file name, it is
19766 considered to be a match.
19768 For example:
19770 @smallexample
19771 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
19772 @end smallexample
19774 @noindent
19775 excludes any inline function defined in files whose pathnames
19776 contain @code{/bits/stl} or @code{include/sys}.
19778 If, for some reason, you want to include letter @code{','} in one of
19779 @var{sym}, write @code{'\,'}. For example,
19780 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
19781 (note the single quote surrounding the option).
19783 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
19784 @opindex finstrument-functions-exclude-function-list
19786 This is similar to @code{-finstrument-functions-exclude-file-list},
19787 but this option sets the list of function names to be excluded from
19788 instrumentation.  The function name to be matched is its user-visible
19789 name, such as @code{vector<int> blah(const vector<int> &)}, not the
19790 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
19791 match is done on substrings: if the @var{sym} parameter is a substring
19792 of the function name, it is considered to be a match.  For C99 and C++
19793 extended identifiers, the function name must be given in UTF-8, not
19794 using universal character names.
19796 @item -fstack-check
19797 @opindex fstack-check
19798 Generate code to verify that you do not go beyond the boundary of the
19799 stack.  You should specify this flag if you are running in an
19800 environment with multiple threads, but only rarely need to specify it in
19801 a single-threaded environment since stack overflow is automatically
19802 detected on nearly all systems if there is only one stack.
19804 Note that this switch does not actually cause checking to be done; the
19805 operating system or the language runtime must do that.  The switch causes
19806 generation of code to ensure that they see the stack being extended.
19808 You can additionally specify a string parameter: @code{no} means no
19809 checking, @code{generic} means force the use of old-style checking,
19810 @code{specific} means use the best checking method and is equivalent
19811 to bare @option{-fstack-check}.
19813 Old-style checking is a generic mechanism that requires no specific
19814 target support in the compiler but comes with the following drawbacks:
19816 @enumerate
19817 @item
19818 Modified allocation strategy for large objects: they are always
19819 allocated dynamically if their size exceeds a fixed threshold.
19821 @item
19822 Fixed limit on the size of the static frame of functions: when it is
19823 topped by a particular function, stack checking is not reliable and
19824 a warning is issued by the compiler.
19826 @item
19827 Inefficiency: because of both the modified allocation strategy and the
19828 generic implementation, the performances of the code are hampered.
19829 @end enumerate
19831 Note that old-style stack checking is also the fallback method for
19832 @code{specific} if no target support has been added in the compiler.
19834 @item -fstack-limit-register=@var{reg}
19835 @itemx -fstack-limit-symbol=@var{sym}
19836 @itemx -fno-stack-limit
19837 @opindex fstack-limit-register
19838 @opindex fstack-limit-symbol
19839 @opindex fno-stack-limit
19840 Generate code to ensure that the stack does not grow beyond a certain value,
19841 either the value of a register or the address of a symbol.  If a larger
19842 stack is required, a signal is raised at run time.  For most targets,
19843 the signal is raised before the stack overruns the boundary, so
19844 it is possible to catch the signal without taking special precautions.
19846 For instance, if the stack starts at absolute address @samp{0x80000000}
19847 and grows downwards, you can use the flags
19848 @option{-fstack-limit-symbol=__stack_limit} and
19849 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
19850 of 128KB@.  Note that this may only work with the GNU linker.
19852 @item -fsplit-stack
19853 @opindex fsplit-stack
19854 Generate code to automatically split the stack before it overflows.
19855 The resulting program has a discontiguous stack which can only
19856 overflow if the program is unable to allocate any more memory.  This
19857 is most useful when running threaded programs, as it is no longer
19858 necessary to calculate a good stack size to use for each thread.  This
19859 is currently only implemented for the i386 and x86_64 back ends running
19860 GNU/Linux.
19862 When code compiled with @option{-fsplit-stack} calls code compiled
19863 without @option{-fsplit-stack}, there may not be much stack space
19864 available for the latter code to run.  If compiling all code,
19865 including library code, with @option{-fsplit-stack} is not an option,
19866 then the linker can fix up these calls so that the code compiled
19867 without @option{-fsplit-stack} always has a large stack.  Support for
19868 this is implemented in the gold linker in GNU binutils release 2.21
19869 and later.
19871 @item -fleading-underscore
19872 @opindex fleading-underscore
19873 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
19874 change the way C symbols are represented in the object file.  One use
19875 is to help link with legacy assembly code.
19877 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
19878 generate code that is not binary compatible with code generated without that
19879 switch.  Use it to conform to a non-default application binary interface.
19880 Not all targets provide complete support for this switch.
19882 @item -ftls-model=@var{model}
19883 @opindex ftls-model
19884 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
19885 The @var{model} argument should be one of @code{global-dynamic},
19886 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
19888 The default without @option{-fpic} is @code{initial-exec}; with
19889 @option{-fpic} the default is @code{global-dynamic}.
19891 @item -fvisibility=@var{default|internal|hidden|protected}
19892 @opindex fvisibility
19893 Set the default ELF image symbol visibility to the specified option---all
19894 symbols are marked with this unless overridden within the code.
19895 Using this feature can very substantially improve linking and
19896 load times of shared object libraries, produce more optimized
19897 code, provide near-perfect API export and prevent symbol clashes.
19898 It is @strong{strongly} recommended that you use this in any shared objects
19899 you distribute.
19901 Despite the nomenclature, @code{default} always means public; i.e.,
19902 available to be linked against from outside the shared object.
19903 @code{protected} and @code{internal} are pretty useless in real-world
19904 usage so the only other commonly used option is @code{hidden}.
19905 The default if @option{-fvisibility} isn't specified is
19906 @code{default}, i.e., make every
19907 symbol public---this causes the same behavior as previous versions of
19908 GCC@.
19910 A good explanation of the benefits offered by ensuring ELF
19911 symbols have the correct visibility is given by ``How To Write
19912 Shared Libraries'' by Ulrich Drepper (which can be found at
19913 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
19914 solution made possible by this option to marking things hidden when
19915 the default is public is to make the default hidden and mark things
19916 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
19917 and @code{__attribute__ ((visibility("default")))} instead of
19918 @code{__declspec(dllexport)} you get almost identical semantics with
19919 identical syntax.  This is a great boon to those working with
19920 cross-platform projects.
19922 For those adding visibility support to existing code, you may find
19923 @samp{#pragma GCC visibility} of use.  This works by you enclosing
19924 the declarations you wish to set visibility for with (for example)
19925 @samp{#pragma GCC visibility push(hidden)} and
19926 @samp{#pragma GCC visibility pop}.
19927 Bear in mind that symbol visibility should be viewed @strong{as
19928 part of the API interface contract} and thus all new code should
19929 always specify visibility when it is not the default; i.e., declarations
19930 only for use within the local DSO should @strong{always} be marked explicitly
19931 as hidden as so to avoid PLT indirection overheads---making this
19932 abundantly clear also aids readability and self-documentation of the code.
19933 Note that due to ISO C++ specification requirements, @code{operator new} and
19934 @code{operator delete} must always be of default visibility.
19936 Be aware that headers from outside your project, in particular system
19937 headers and headers from any other library you use, may not be
19938 expecting to be compiled with visibility other than the default.  You
19939 may need to explicitly say @samp{#pragma GCC visibility push(default)}
19940 before including any such headers.
19942 @samp{extern} declarations are not affected by @option{-fvisibility}, so
19943 a lot of code can be recompiled with @option{-fvisibility=hidden} with
19944 no modifications.  However, this means that calls to @code{extern}
19945 functions with no explicit visibility use the PLT, so it is more
19946 effective to use @code{__attribute ((visibility))} and/or
19947 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
19948 declarations should be treated as hidden.
19950 Note that @option{-fvisibility} does affect C++ vague linkage
19951 entities. This means that, for instance, an exception class that is
19952 be thrown between DSOs must be explicitly marked with default
19953 visibility so that the @samp{type_info} nodes are unified between
19954 the DSOs.
19956 An overview of these techniques, their benefits and how to use them
19957 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
19959 @item -fstrict-volatile-bitfields
19960 @opindex fstrict-volatile-bitfields
19961 This option should be used if accesses to volatile bit-fields (or other
19962 structure fields, although the compiler usually honors those types
19963 anyway) should use a single access of the width of the
19964 field's type, aligned to a natural alignment if possible.  For
19965 example, targets with memory-mapped peripheral registers might require
19966 all such accesses to be 16 bits wide; with this flag the user could
19967 declare all peripheral bit-fields as @code{unsigned short} (assuming short
19968 is 16 bits on these targets) to force GCC to use 16-bit accesses
19969 instead of, perhaps, a more efficient 32-bit access.
19971 If this option is disabled, the compiler uses the most efficient
19972 instruction.  In the previous example, that might be a 32-bit load
19973 instruction, even though that accesses bytes that do not contain
19974 any portion of the bit-field, or memory-mapped registers unrelated to
19975 the one being updated.
19977 If the target requires strict alignment, and honoring the field
19978 type would require violating this alignment, a warning is issued.
19979 If the field has @code{packed} attribute, the access is done without
19980 honoring the field type.  If the field doesn't have @code{packed}
19981 attribute, the access is done honoring the field type.  In both cases,
19982 GCC assumes that the user knows something about the target hardware
19983 that it is unaware of.
19985 The default value of this option is determined by the application binary
19986 interface for the target processor.
19988 @item -fsync-libcalls
19989 @opindex fsync-libcalls
19990 This option controls whether any out-of-line instance of the @code{__sync}
19991 family of functions may be used to implement the C++11 @code{__atomic}
19992 family of functions.
19994 The default value of this option is enabled, thus the only useful form
19995 of the option is @option{-fno-sync-libcalls}.  This option is used in
19996 the implementation of the @file{libatomic} runtime library.
19998 @end table
20000 @c man end
20002 @node Environment Variables
20003 @section Environment Variables Affecting GCC
20004 @cindex environment variables
20006 @c man begin ENVIRONMENT
20007 This section describes several environment variables that affect how GCC
20008 operates.  Some of them work by specifying directories or prefixes to use
20009 when searching for various kinds of files.  Some are used to specify other
20010 aspects of the compilation environment.
20012 Note that you can also specify places to search using options such as
20013 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
20014 take precedence over places specified using environment variables, which
20015 in turn take precedence over those specified by the configuration of GCC@.
20016 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
20017 GNU Compiler Collection (GCC) Internals}.
20019 @table @env
20020 @item LANG
20021 @itemx LC_CTYPE
20022 @c @itemx LC_COLLATE
20023 @itemx LC_MESSAGES
20024 @c @itemx LC_MONETARY
20025 @c @itemx LC_NUMERIC
20026 @c @itemx LC_TIME
20027 @itemx LC_ALL
20028 @findex LANG
20029 @findex LC_CTYPE
20030 @c @findex LC_COLLATE
20031 @findex LC_MESSAGES
20032 @c @findex LC_MONETARY
20033 @c @findex LC_NUMERIC
20034 @c @findex LC_TIME
20035 @findex LC_ALL
20036 @cindex locale
20037 These environment variables control the way that GCC uses
20038 localization information which allows GCC to work with different
20039 national conventions.  GCC inspects the locale categories
20040 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
20041 so.  These locale categories can be set to any value supported by your
20042 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
20043 Kingdom encoded in UTF-8.
20045 The @env{LC_CTYPE} environment variable specifies character
20046 classification.  GCC uses it to determine the character boundaries in
20047 a string; this is needed for some multibyte encodings that contain quote
20048 and escape characters that are otherwise interpreted as a string
20049 end or escape.
20051 The @env{LC_MESSAGES} environment variable specifies the language to
20052 use in diagnostic messages.
20054 If the @env{LC_ALL} environment variable is set, it overrides the value
20055 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
20056 and @env{LC_MESSAGES} default to the value of the @env{LANG}
20057 environment variable.  If none of these variables are set, GCC
20058 defaults to traditional C English behavior.
20060 @item TMPDIR
20061 @findex TMPDIR
20062 If @env{TMPDIR} is set, it specifies the directory to use for temporary
20063 files.  GCC uses temporary files to hold the output of one stage of
20064 compilation which is to be used as input to the next stage: for example,
20065 the output of the preprocessor, which is the input to the compiler
20066 proper.
20068 @item GCC_COMPARE_DEBUG
20069 @findex GCC_COMPARE_DEBUG
20070 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
20071 @option{-fcompare-debug} to the compiler driver.  See the documentation
20072 of this option for more details.
20074 @item GCC_EXEC_PREFIX
20075 @findex GCC_EXEC_PREFIX
20076 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
20077 names of the subprograms executed by the compiler.  No slash is added
20078 when this prefix is combined with the name of a subprogram, but you can
20079 specify a prefix that ends with a slash if you wish.
20081 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
20082 an appropriate prefix to use based on the pathname it is invoked with.
20084 If GCC cannot find the subprogram using the specified prefix, it
20085 tries looking in the usual places for the subprogram.
20087 The default value of @env{GCC_EXEC_PREFIX} is
20088 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
20089 the installed compiler. In many cases @var{prefix} is the value
20090 of @code{prefix} when you ran the @file{configure} script.
20092 Other prefixes specified with @option{-B} take precedence over this prefix.
20094 This prefix is also used for finding files such as @file{crt0.o} that are
20095 used for linking.
20097 In addition, the prefix is used in an unusual way in finding the
20098 directories to search for header files.  For each of the standard
20099 directories whose name normally begins with @samp{/usr/local/lib/gcc}
20100 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
20101 replacing that beginning with the specified prefix to produce an
20102 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
20103 @file{foo/bar} just before it searches the standard directory 
20104 @file{/usr/local/lib/bar}.
20105 If a standard directory begins with the configured
20106 @var{prefix} then the value of @var{prefix} is replaced by
20107 @env{GCC_EXEC_PREFIX} when looking for header files.
20109 @item COMPILER_PATH
20110 @findex COMPILER_PATH
20111 The value of @env{COMPILER_PATH} is a colon-separated list of
20112 directories, much like @env{PATH}.  GCC tries the directories thus
20113 specified when searching for subprograms, if it can't find the
20114 subprograms using @env{GCC_EXEC_PREFIX}.
20116 @item LIBRARY_PATH
20117 @findex LIBRARY_PATH
20118 The value of @env{LIBRARY_PATH} is a colon-separated list of
20119 directories, much like @env{PATH}.  When configured as a native compiler,
20120 GCC tries the directories thus specified when searching for special
20121 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
20122 using GCC also uses these directories when searching for ordinary
20123 libraries for the @option{-l} option (but directories specified with
20124 @option{-L} come first).
20126 @item LANG
20127 @findex LANG
20128 @cindex locale definition
20129 This variable is used to pass locale information to the compiler.  One way in
20130 which this information is used is to determine the character set to be used
20131 when character literals, string literals and comments are parsed in C and C++.
20132 When the compiler is configured to allow multibyte characters,
20133 the following values for @env{LANG} are recognized:
20135 @table @samp
20136 @item C-JIS
20137 Recognize JIS characters.
20138 @item C-SJIS
20139 Recognize SJIS characters.
20140 @item C-EUCJP
20141 Recognize EUCJP characters.
20142 @end table
20144 If @env{LANG} is not defined, or if it has some other value, then the
20145 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
20146 recognize and translate multibyte characters.
20147 @end table
20149 @noindent
20150 Some additional environment variables affect the behavior of the
20151 preprocessor.
20153 @include cppenv.texi
20155 @c man end
20157 @node Precompiled Headers
20158 @section Using Precompiled Headers
20159 @cindex precompiled headers
20160 @cindex speed of compilation
20162 Often large projects have many header files that are included in every
20163 source file.  The time the compiler takes to process these header files
20164 over and over again can account for nearly all of the time required to
20165 build the project.  To make builds faster, GCC allows you to
20166 @dfn{precompile} a header file.
20168 To create a precompiled header file, simply compile it as you would any
20169 other file, if necessary using the @option{-x} option to make the driver
20170 treat it as a C or C++ header file.  You may want to use a
20171 tool like @command{make} to keep the precompiled header up-to-date when
20172 the headers it contains change.
20174 A precompiled header file is searched for when @code{#include} is
20175 seen in the compilation.  As it searches for the included file
20176 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
20177 compiler looks for a precompiled header in each directory just before it
20178 looks for the include file in that directory.  The name searched for is
20179 the name specified in the @code{#include} with @samp{.gch} appended.  If
20180 the precompiled header file can't be used, it is ignored.
20182 For instance, if you have @code{#include "all.h"}, and you have
20183 @file{all.h.gch} in the same directory as @file{all.h}, then the
20184 precompiled header file is used if possible, and the original
20185 header is used otherwise.
20187 Alternatively, you might decide to put the precompiled header file in a
20188 directory and use @option{-I} to ensure that directory is searched
20189 before (or instead of) the directory containing the original header.
20190 Then, if you want to check that the precompiled header file is always
20191 used, you can put a file of the same name as the original header in this
20192 directory containing an @code{#error} command.
20194 This also works with @option{-include}.  So yet another way to use
20195 precompiled headers, good for projects not designed with precompiled
20196 header files in mind, is to simply take most of the header files used by
20197 a project, include them from another header file, precompile that header
20198 file, and @option{-include} the precompiled header.  If the header files
20199 have guards against multiple inclusion, they are skipped because
20200 they've already been included (in the precompiled header).
20202 If you need to precompile the same header file for different
20203 languages, targets, or compiler options, you can instead make a
20204 @emph{directory} named like @file{all.h.gch}, and put each precompiled
20205 header in the directory, perhaps using @option{-o}.  It doesn't matter
20206 what you call the files in the directory; every precompiled header in
20207 the directory is considered.  The first precompiled header
20208 encountered in the directory that is valid for this compilation is
20209 used; they're searched in no particular order.
20211 There are many other possibilities, limited only by your imagination,
20212 good sense, and the constraints of your build system.
20214 A precompiled header file can be used only when these conditions apply:
20216 @itemize
20217 @item
20218 Only one precompiled header can be used in a particular compilation.
20220 @item
20221 A precompiled header can't be used once the first C token is seen.  You
20222 can have preprocessor directives before a precompiled header; you cannot
20223 include a precompiled header from inside another header.
20225 @item
20226 The precompiled header file must be produced for the same language as
20227 the current compilation.  You can't use a C precompiled header for a C++
20228 compilation.
20230 @item
20231 The precompiled header file must have been produced by the same compiler
20232 binary as the current compilation is using.
20234 @item
20235 Any macros defined before the precompiled header is included must
20236 either be defined in the same way as when the precompiled header was
20237 generated, or must not affect the precompiled header, which usually
20238 means that they don't appear in the precompiled header at all.
20240 The @option{-D} option is one way to define a macro before a
20241 precompiled header is included; using a @code{#define} can also do it.
20242 There are also some options that define macros implicitly, like
20243 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
20244 defined this way.
20246 @item If debugging information is output when using the precompiled
20247 header, using @option{-g} or similar, the same kind of debugging information
20248 must have been output when building the precompiled header.  However,
20249 a precompiled header built using @option{-g} can be used in a compilation
20250 when no debugging information is being output.
20252 @item The same @option{-m} options must generally be used when building
20253 and using the precompiled header.  @xref{Submodel Options},
20254 for any cases where this rule is relaxed.
20256 @item Each of the following options must be the same when building and using
20257 the precompiled header:
20259 @gccoptlist{-fexceptions}
20261 @item
20262 Some other command-line options starting with @option{-f},
20263 @option{-p}, or @option{-O} must be defined in the same way as when
20264 the precompiled header was generated.  At present, it's not clear
20265 which options are safe to change and which are not; the safest choice
20266 is to use exactly the same options when generating and using the
20267 precompiled header.  The following are known to be safe:
20269 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
20270 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
20271 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
20272 -pedantic-errors}
20274 @end itemize
20276 For all of these except the last, the compiler automatically
20277 ignores the precompiled header if the conditions aren't met.  If you
20278 find an option combination that doesn't work and doesn't cause the
20279 precompiled header to be ignored, please consider filing a bug report,
20280 see @ref{Bugs}.
20282 If you do use differing options when generating and using the
20283 precompiled header, the actual behavior is a mixture of the
20284 behavior for the options.  For instance, if you use @option{-g} to
20285 generate the precompiled header but not when using it, you may or may
20286 not get debugging information for routines in the precompiled header.