invoke.texi: Document -print-multiarch.
[official-gcc.git] / gcc / doc / invoke.texi
blobe019e3d2cdb659a89857193677281fa0b7d1a582
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{]} -fada-spec-parent=@var{arg} -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 -fext-numeric-literals @gol
201 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
202 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
203 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
204 -Weffc++  -Wstrict-null-sentinel @gol
205 -Wno-non-template-friend  -Wold-style-cast @gol
206 -Woverloaded-virtual  -Wno-pmf-conversions @gol
207 -Wsign-promo}
209 @item Objective-C and Objective-C++ Language Options
210 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
211 Objective-C and Objective-C++ Dialects}.
212 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
213 -fgnu-runtime  -fnext-runtime @gol
214 -fno-nil-receivers @gol
215 -fobjc-abi-version=@var{n} @gol
216 -fobjc-call-cxx-cdtors @gol
217 -fobjc-direct-dispatch @gol
218 -fobjc-exceptions @gol
219 -fobjc-gc @gol
220 -fobjc-nilcheck @gol
221 -fobjc-std=objc1 @gol
222 -freplace-objc-classes @gol
223 -fzero-link @gol
224 -gen-decls @gol
225 -Wassign-intercept @gol
226 -Wno-protocol  -Wselector @gol
227 -Wstrict-selector-match @gol
228 -Wundeclared-selector}
230 @item Language Independent Options
231 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
232 @gccoptlist{-fmessage-length=@var{n}  @gol
233 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
234 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
236 @item Warning Options
237 @xref{Warning Options,,Options to Request or Suppress Warnings}.
238 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
239 -pedantic-errors @gol
240 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
241 -Wno-attributes -Wno-builtin-macro-redefined @gol
242 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
243 -Wchar-subscripts -Wclobbered  -Wcomment @gol
244 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wno-deprecated  @gol
245 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
246 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
247 -Wno-endif-labels -Werror  -Werror=* @gol
248 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
249 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
250 -Wformat-security  -Wformat-y2k @gol
251 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
252 -Wignored-qualifiers @gol
253 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
254 -Winit-self  -Winline -Wmaybe-uninitialized @gol
255 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
256 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
257 -Wlogical-op -Wlong-long @gol
258 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
259 -Wmissing-include-dirs @gol
260 -Wno-mudflap @gol
261 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
262 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
263 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
264 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
265 -Wredundant-decls  -Wno-return-local-addr @gol
266 -Wreturn-type  -Wsequence-point  -Wshadow @gol
267 -Wsign-compare  -Wsign-conversion  -Wsizeof-pointer-memaccess @gol
268 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
269 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
270 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
271 -Wmissing-format-attribute @gol
272 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
273 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
274 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
275 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
276 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
277 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
278 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
279 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
280 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
282 @item C and Objective-C-only Warning Options
283 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
284 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
285 -Wold-style-declaration  -Wold-style-definition @gol
286 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
287 -Wdeclaration-after-statement -Wpointer-sign}
289 @item Debugging Options
290 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
291 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
292 -faddress-sanitizer -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
293 -fdisable-ipa-@var{pass_name} @gol
294 -fdisable-rtl-@var{pass_name} @gol
295 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
296 -fdisable-tree-@var{pass_name} @gol
297 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
298 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
299 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
300 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
301 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
302 -fdump-passes @gol
303 -fdump-statistics @gol
304 -fdump-tree-all @gol
305 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
306 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
307 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
308 -fdump-tree-ch @gol
309 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
318 -fdump-tree-nrv -fdump-tree-vect @gol
319 -fdump-tree-sink @gol
320 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
323 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
324 -ftree-vectorizer-verbose=@var{n} @gol
325 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
326 -fdump-final-insns=@var{file} @gol
327 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
328 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
329 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
330 -fenable-@var{kind}-@var{pass} @gol
331 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
332 -fdebug-types-section -fmem-report-wpa @gol
333 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
334 -fopt-info @gol
335 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
336 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
337 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
338 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
339 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
340 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
341 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
342 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
343 -gvms  -gxcoff  -gxcoff+ @gol
344 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
345 -fdebug-prefix-map=@var{old}=@var{new} @gol
346 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
347 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
348 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
349 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
350 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
351 -print-sysroot -print-sysroot-headers-suffix @gol
352 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
354 @item Optimization Options
355 @xref{Optimize Options,,Options that Control Optimization}.
356 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
357 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
358 -fassociative-math -fauto-inc-dec -fbranch-probabilities @gol
359 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
360 -fbtr-bb-exclusive -fcaller-saves @gol
361 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
362 -fcompare-elim -fcprop-registers -fcrossjumping @gol
363 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
364 -fcx-limited-range @gol
365 -fdata-sections -fdce -fdelayed-branch @gol
366 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
367 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
368 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
369 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
370 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
371 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
372 -fif-conversion2 -findirect-inlining @gol
373 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
374 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
375 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
376 -fira-algorithm=@var{algorithm} @gol
377 -fira-region=@var{region} -fira-hoist-pressure @gol
378 -fira-loop-pressure -fno-ira-share-save-slots @gol
379 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
380 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
381 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
382 -floop-parallelize-all -flto -flto-compression-level @gol
383 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
384 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
385 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
386 -fno-default-inline @gol
387 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
388 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
389 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
390 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
391 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
392 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
393 -fprefetch-loop-arrays -fprofile-report @gol
394 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
395 -fprofile-generate=@var{path} @gol
396 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
397 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
398 -freorder-blocks-and-partition -freorder-functions @gol
399 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
400 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
401 -fsched-spec-load -fsched-spec-load-dangerous @gol
402 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
403 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
404 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
405 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
406 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
407 -fselective-scheduling -fselective-scheduling2 @gol
408 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
409 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
410 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
411 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
412 -fthread-jumps -ftracer -ftree-bit-ccp @gol
413 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
414 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
415 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
416 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
417 -ftree-loop-if-convert-stores -ftree-loop-im @gol
418 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
419 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
420 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
421 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
422 -ftree-switch-conversion -ftree-tail-merge @gol
423 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
424 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
425 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
426 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
427 -fwhole-program -fwpa -fuse-linker-plugin @gol
428 --param @var{name}=@var{value}
429 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
431 @item Preprocessor Options
432 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
433 @gccoptlist{-A@var{question}=@var{answer} @gol
434 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
435 -C  -dD  -dI  -dM  -dN @gol
436 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
437 -idirafter @var{dir} @gol
438 -include @var{file}  -imacros @var{file} @gol
439 -iprefix @var{file}  -iwithprefix @var{dir} @gol
440 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
441 -imultilib @var{dir} -isysroot @var{dir} @gol
442 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
443 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
444 -remap -trigraphs  -undef  -U@var{macro}  @gol
445 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
447 @item Assembler Option
448 @xref{Assembler Options,,Passing Options to the Assembler}.
449 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
451 @item Linker Options
452 @xref{Link Options,,Options for Linking}.
453 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
454 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
455 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
456 -shared-libgcc  -symbolic @gol
457 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
458 -u @var{symbol}}
460 @item Directory Options
461 @xref{Directory Options,,Options for Directory Search}.
462 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
463 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
464 --sysroot=@var{dir} --no-sysroot-suffix}
466 @item Machine Dependent Options
467 @xref{Submodel Options,,Hardware Models and Configurations}.
468 @c This list is ordered alphanumerically by subsection name.
469 @c Try and put the significant identifier (CPU or system) first,
470 @c so users have a clue at guessing where the ones they want will be.
472 @emph{AArch64 Options}
473 @gccoptlist{-mbig-endian  -mlittle-endian @gol
474 -mgeneral-regs-only @gol
475 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
476 -mstrict-align @gol
477 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
478 -mtls-dialect=desc  -mtls-dialect=traditional @gol
479 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
481 @emph{Adapteva Epiphany Options}
482 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
483 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
484 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
485 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
486 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
487 -msplit-vecmove-early -m1reg-@var{reg}}
489 @emph{ARM Options}
490 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
491 -mabi=@var{name} @gol
492 -mapcs-stack-check  -mno-apcs-stack-check @gol
493 -mapcs-float  -mno-apcs-float @gol
494 -mapcs-reentrant  -mno-apcs-reentrant @gol
495 -msched-prolog  -mno-sched-prolog @gol
496 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
497 -mfloat-abi=@var{name} @gol
498 -mfp16-format=@var{name}
499 -mthumb-interwork  -mno-thumb-interwork @gol
500 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
501 -mstructure-size-boundary=@var{n} @gol
502 -mabort-on-noreturn @gol
503 -mlong-calls  -mno-long-calls @gol
504 -msingle-pic-base  -mno-single-pic-base @gol
505 -mpic-register=@var{reg} @gol
506 -mnop-fun-dllimport @gol
507 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
508 -mpoke-function-name @gol
509 -mthumb  -marm @gol
510 -mtpcs-frame  -mtpcs-leaf-frame @gol
511 -mcaller-super-interworking  -mcallee-super-interworking @gol
512 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
513 -mword-relocations @gol
514 -mfix-cortex-m3-ldrd @gol
515 -munaligned-access}
517 @emph{AVR Options}
518 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
519 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
520 -mstrict-X -mtiny-stack}
522 @emph{Blackfin Options}
523 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
524 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
525 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
526 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
527 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
528 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
529 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
530 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
531 -micplb}
533 @emph{C6X Options}
534 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
535 -msim -msdata=@var{sdata-type}}
537 @emph{CRIS Options}
538 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
539 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
540 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
541 -mstack-align  -mdata-align  -mconst-align @gol
542 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
543 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
544 -mmul-bug-workaround  -mno-mul-bug-workaround}
546 @emph{CR16 Options}
547 @gccoptlist{-mmac @gol
548 -mcr16cplus -mcr16c @gol
549 -msim -mint32 -mbit-ops
550 -mdata-model=@var{model}}
552 @emph{Darwin Options}
553 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
554 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
555 -client_name  -compatibility_version  -current_version @gol
556 -dead_strip @gol
557 -dependency-file  -dylib_file  -dylinker_install_name @gol
558 -dynamic  -dynamiclib  -exported_symbols_list @gol
559 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
560 -force_flat_namespace  -headerpad_max_install_names @gol
561 -iframework @gol
562 -image_base  -init  -install_name  -keep_private_externs @gol
563 -multi_module  -multiply_defined  -multiply_defined_unused @gol
564 -noall_load   -no_dead_strip_inits_and_terms @gol
565 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
566 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
567 -private_bundle  -read_only_relocs  -sectalign @gol
568 -sectobjectsymbols  -whyload  -seg1addr @gol
569 -sectcreate  -sectobjectsymbols  -sectorder @gol
570 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
571 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
572 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
573 -single_module  -static  -sub_library  -sub_umbrella @gol
574 -twolevel_namespace  -umbrella  -undefined @gol
575 -unexported_symbols_list  -weak_reference_mismatches @gol
576 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
577 -mkernel -mone-byte-bool}
579 @emph{DEC Alpha Options}
580 @gccoptlist{-mno-fp-regs  -msoft-float @gol
581 -mieee  -mieee-with-inexact  -mieee-conformant @gol
582 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
583 -mtrap-precision=@var{mode}  -mbuild-constants @gol
584 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
585 -mbwx  -mmax  -mfix  -mcix @gol
586 -mfloat-vax  -mfloat-ieee @gol
587 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
588 -msmall-text  -mlarge-text @gol
589 -mmemory-latency=@var{time}}
591 @emph{FR30 Options}
592 @gccoptlist{-msmall-model -mno-lsim}
594 @emph{FRV Options}
595 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
596 -mhard-float  -msoft-float @gol
597 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
598 -mdouble  -mno-double @gol
599 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
600 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
601 -mlinked-fp  -mlong-calls  -malign-labels @gol
602 -mlibrary-pic  -macc-4  -macc-8 @gol
603 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
604 -moptimize-membar -mno-optimize-membar @gol
605 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
606 -mvliw-branch  -mno-vliw-branch @gol
607 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
608 -mno-nested-cond-exec  -mtomcat-stats @gol
609 -mTLS -mtls @gol
610 -mcpu=@var{cpu}}
612 @emph{GNU/Linux Options}
613 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
614 -tno-android-cc -tno-android-ld}
616 @emph{H8/300 Options}
617 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
619 @emph{HPPA Options}
620 @gccoptlist{-march=@var{architecture-type} @gol
621 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
622 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
623 -mfixed-range=@var{register-range} @gol
624 -mjump-in-delay -mlinker-opt -mlong-calls @gol
625 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
626 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
627 -mno-jump-in-delay  -mno-long-load-store @gol
628 -mno-portable-runtime  -mno-soft-float @gol
629 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
630 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
631 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
632 -munix=@var{unix-std}  -nolibdld  -static  -threads}
634 @emph{i386 and x86-64 Options}
635 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
636 -mfpmath=@var{unit} @gol
637 -masm=@var{dialect}  -mno-fancy-math-387 @gol
638 -mno-fp-ret-in-387  -msoft-float @gol
639 -mno-wide-multiply  -mrtd  -malign-double @gol
640 -mpreferred-stack-boundary=@var{num} @gol
641 -mincoming-stack-boundary=@var{num} @gol
642 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
643 -mrecip -mrecip=@var{opt} @gol
644 -mvzeroupper -mprefer-avx128 @gol
645 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
646 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
647 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
648 -mbmi2 -mrtm -mlwp -mthreads @gol
649 -mno-align-stringops  -minline-all-stringops @gol
650 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
651 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
652 -m96bit-long-double -mlong-double-64 -mlong-double-80 @gol
653 -mregparm=@var{num}  -msseregparm @gol
654 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
655 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
656 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
657 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
658 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
659 -msse2avx -mfentry -m8bit-idiv @gol
660 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
662 @emph{i386 and x86-64 Windows Options}
663 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
664 -mnop-fun-dllimport -mthread @gol
665 -municode -mwin32 -mwindows -fno-set-stack-executable}
667 @emph{IA-64 Options}
668 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
669 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
670 -mconstant-gp  -mauto-pic  -mfused-madd @gol
671 -minline-float-divide-min-latency @gol
672 -minline-float-divide-max-throughput @gol
673 -mno-inline-float-divide @gol
674 -minline-int-divide-min-latency @gol
675 -minline-int-divide-max-throughput  @gol
676 -mno-inline-int-divide @gol
677 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
678 -mno-inline-sqrt @gol
679 -mdwarf2-asm -mearly-stop-bits @gol
680 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
681 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
682 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
683 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
684 -msched-spec-ldc -msched-spec-control-ldc @gol
685 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
686 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
687 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
688 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
690 @emph{LM32 Options}
691 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
692 -msign-extend-enabled -muser-enabled}
694 @emph{M32R/D Options}
695 @gccoptlist{-m32r2 -m32rx -m32r @gol
696 -mdebug @gol
697 -malign-loops -mno-align-loops @gol
698 -missue-rate=@var{number} @gol
699 -mbranch-cost=@var{number} @gol
700 -mmodel=@var{code-size-model-type} @gol
701 -msdata=@var{sdata-type} @gol
702 -mno-flush-func -mflush-func=@var{name} @gol
703 -mno-flush-trap -mflush-trap=@var{number} @gol
704 -G @var{num}}
706 @emph{M32C Options}
707 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
709 @emph{M680x0 Options}
710 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
711 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
712 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
713 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
714 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
715 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
716 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
717 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
718 -mxgot -mno-xgot}
720 @emph{MCore Options}
721 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
722 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
723 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
724 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
725 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
727 @emph{MeP Options}
728 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
729 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
730 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
731 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
732 -mtiny=@var{n}}
734 @emph{MicroBlaze Options}
735 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
736 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
737 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
738 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
739 -mxl-mode-@var{app-model}}
741 @emph{MIPS Options}
742 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
743 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
744 -mips64  -mips64r2 @gol
745 -mips16  -mno-mips16  -mflip-mips16 @gol
746 -minterlink-mips16  -mno-interlink-mips16 @gol
747 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
748 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
749 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
750 -mno-float -msingle-float  -mdouble-float  @gol
751 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
752 -mmcu -mmno-mcu @gol
753 -mfpu=@var{fpu-type} @gol
754 -msmartmips  -mno-smartmips @gol
755 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
756 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
757 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
758 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
759 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
760 -membedded-data  -mno-embedded-data @gol
761 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
762 -mcode-readable=@var{setting} @gol
763 -msplit-addresses  -mno-split-addresses @gol
764 -mexplicit-relocs  -mno-explicit-relocs @gol
765 -mcheck-zero-division  -mno-check-zero-division @gol
766 -mdivide-traps  -mdivide-breaks @gol
767 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
768 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
769 -mfix-24k -mno-fix-24k @gol
770 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
771 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
772 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
773 -mflush-func=@var{func}  -mno-flush-func @gol
774 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
775 -mfp-exceptions -mno-fp-exceptions @gol
776 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
777 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
779 @emph{MMIX Options}
780 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
781 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
782 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
783 -mno-base-addresses  -msingle-exit  -mno-single-exit}
785 @emph{MN10300 Options}
786 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
787 -mno-am33 -mam33 -mam33-2 -mam34 @gol
788 -mtune=@var{cpu-type} @gol
789 -mreturn-pointer-on-d0 @gol
790 -mno-crt0  -mrelax -mliw -msetlb}
792 @emph{Moxie Options}
793 @gccoptlist{-meb -mel -mno-crt0}
795 @emph{PDP-11 Options}
796 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
797 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
798 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
799 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
800 -mbranch-expensive  -mbranch-cheap @gol
801 -munix-asm  -mdec-asm}
803 @emph{picoChip Options}
804 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
805 -msymbol-as-address -mno-inefficient-warnings}
807 @emph{PowerPC Options}
808 See RS/6000 and PowerPC Options.
810 @emph{RL78 Options}
811 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
813 @emph{RS/6000 and PowerPC Options}
814 @gccoptlist{-mcpu=@var{cpu-type} @gol
815 -mtune=@var{cpu-type} @gol
816 -mcmodel=@var{code-model} @gol
817 -mpowerpc64 @gol
818 -maltivec  -mno-altivec @gol
819 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
820 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
821 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
822 -mfprnd  -mno-fprnd @gol
823 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
824 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
825 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
826 -malign-power  -malign-natural @gol
827 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
828 -msingle-float -mdouble-float -msimple-fpu @gol
829 -mstring  -mno-string  -mupdate  -mno-update @gol
830 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
831 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
832 -mstrict-align  -mno-strict-align  -mrelocatable @gol
833 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
834 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
835 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
836 -mprioritize-restricted-insns=@var{priority} @gol
837 -msched-costly-dep=@var{dependence_type} @gol
838 -minsert-sched-nops=@var{scheme} @gol
839 -mcall-sysv  -mcall-netbsd @gol
840 -maix-struct-return  -msvr4-struct-return @gol
841 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
842 -mblock-move-inline-limit=@var{num} @gol
843 -misel -mno-isel @gol
844 -misel=yes  -misel=no @gol
845 -mspe -mno-spe @gol
846 -mspe=yes  -mspe=no @gol
847 -mpaired @gol
848 -mgen-cell-microcode -mwarn-cell-microcode @gol
849 -mvrsave -mno-vrsave @gol
850 -mmulhw -mno-mulhw @gol
851 -mdlmzb -mno-dlmzb @gol
852 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
853 -mprototype  -mno-prototype @gol
854 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
855 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
856 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
857 -mno-recip-precision @gol
858 -mveclibabi=@var{type} -mfriz -mno-friz @gol
859 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
860 -msave-toc-indirect -mno-save-toc-indirect}
862 @emph{RX Options}
863 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
864 -mcpu=@gol
865 -mbig-endian-data -mlittle-endian-data @gol
866 -msmall-data @gol
867 -msim  -mno-sim@gol
868 -mas100-syntax -mno-as100-syntax@gol
869 -mrelax@gol
870 -mmax-constant-size=@gol
871 -mint-register=@gol
872 -mpid@gol
873 -mno-warn-multiple-fast-interrupts@gol
874 -msave-acc-in-interrupts}
876 @emph{S/390 and zSeries Options}
877 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
878 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
879 -mlong-double-64 -mlong-double-128 @gol
880 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
881 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
882 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
883 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
884 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
886 @emph{Score Options}
887 @gccoptlist{-meb -mel @gol
888 -mnhwloop @gol
889 -muls @gol
890 -mmac @gol
891 -mscore5 -mscore5u -mscore7 -mscore7d}
893 @emph{SH Options}
894 @gccoptlist{-m1  -m2  -m2e @gol
895 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
896 -m3  -m3e @gol
897 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
898 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
899 -m5-64media  -m5-64media-nofpu @gol
900 -m5-32media  -m5-32media-nofpu @gol
901 -m5-compact  -m5-compact-nofpu @gol
902 -mb  -ml  -mdalign  -mrelax @gol
903 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
904 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
905 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
906 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
907 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
908 -maccumulate-outgoing-args -minvalid-symbols @gol
909 -matomic-model=@var{atomic-model} @gol
910 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch -mcbranchdi -mcmpeqdi @gol
911 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
912 -mpretend-cmove -mtas}
914 @emph{Solaris 2 Options}
915 @gccoptlist{-mimpure-text  -mno-impure-text @gol
916 -pthreads -pthread}
918 @emph{SPARC Options}
919 @gccoptlist{-mcpu=@var{cpu-type} @gol
920 -mtune=@var{cpu-type} @gol
921 -mcmodel=@var{code-model} @gol
922 -mmemory-model=@var{mem-model} @gol
923 -m32  -m64  -mapp-regs  -mno-app-regs @gol
924 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
925 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
926 -mhard-quad-float  -msoft-quad-float @gol
927 -mlittle-endian @gol
928 -mstack-bias  -mno-stack-bias @gol
929 -munaligned-doubles  -mno-unaligned-doubles @gol
930 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
931 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
932 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
933 -mfix-at697f}
935 @emph{SPU Options}
936 @gccoptlist{-mwarn-reloc -merror-reloc @gol
937 -msafe-dma -munsafe-dma @gol
938 -mbranch-hints @gol
939 -msmall-mem -mlarge-mem -mstdmain @gol
940 -mfixed-range=@var{register-range} @gol
941 -mea32 -mea64 @gol
942 -maddress-space-conversion -mno-address-space-conversion @gol
943 -mcache-size=@var{cache-size} @gol
944 -matomic-updates -mno-atomic-updates}
946 @emph{System V Options}
947 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
949 @emph{TILE-Gx Options}
950 @gccoptlist{-mcpu=@var{cpu} -m32 -m64 -mcmodel=@var{code-model}}
952 @emph{TILEPro Options}
953 @gccoptlist{-mcpu=@var{cpu} -m32}
955 @emph{V850 Options}
956 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
957 -mprolog-function  -mno-prolog-function  -mspace @gol
958 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
959 -mapp-regs  -mno-app-regs @gol
960 -mdisable-callt  -mno-disable-callt @gol
961 -mv850e2v3 @gol
962 -mv850e2 @gol
963 -mv850e1 -mv850es @gol
964 -mv850e @gol
965 -mv850  -mbig-switch}
967 @emph{VAX Options}
968 @gccoptlist{-mg  -mgnu  -munix}
970 @emph{VMS Options}
971 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
972 -mpointer-size=@var{size}}
974 @emph{VxWorks Options}
975 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
976 -Xbind-lazy  -Xbind-now}
978 @emph{x86-64 Options}
979 See i386 and x86-64 Options.
981 @emph{Xstormy16 Options}
982 @gccoptlist{-msim}
984 @emph{Xtensa Options}
985 @gccoptlist{-mconst16 -mno-const16 @gol
986 -mfused-madd  -mno-fused-madd @gol
987 -mforce-no-pic @gol
988 -mserialize-volatile  -mno-serialize-volatile @gol
989 -mtext-section-literals  -mno-text-section-literals @gol
990 -mtarget-align  -mno-target-align @gol
991 -mlongcalls  -mno-longcalls}
993 @emph{zSeries Options}
994 See S/390 and zSeries Options.
996 @item Code Generation Options
997 @xref{Code Gen Options,,Options for Code Generation Conventions}.
998 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
999 -ffixed-@var{reg}  -fexceptions @gol
1000 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1001 -fasynchronous-unwind-tables @gol
1002 -finhibit-size-directive  -finstrument-functions @gol
1003 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1004 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1005 -fno-common  -fno-ident @gol
1006 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1007 -fno-jump-tables @gol
1008 -frecord-gcc-switches @gol
1009 -freg-struct-return  -fshort-enums @gol
1010 -fshort-double  -fshort-wchar @gol
1011 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1012 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1013 -fno-stack-limit -fsplit-stack @gol
1014 -fleading-underscore  -ftls-model=@var{model} @gol
1015 -fstack-reuse=@var{reuse_level} @gol
1016 -ftrapv  -fwrapv  -fbounds-check @gol
1017 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1018 @end table
1020 @menu
1021 * Overall Options::     Controlling the kind of output:
1022                         an executable, object files, assembler files,
1023                         or preprocessed source.
1024 * C Dialect Options::   Controlling the variant of C language compiled.
1025 * C++ Dialect Options:: Variations on C++.
1026 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1027                         and Objective-C++.
1028 * Language Independent Options:: Controlling how diagnostics should be
1029                         formatted.
1030 * Warning Options::     How picky should the compiler be?
1031 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
1032 * Optimize Options::    How much optimization?
1033 * Preprocessor Options:: Controlling header files and macro definitions.
1034                          Also, getting dependency information for Make.
1035 * Assembler Options::   Passing options to the assembler.
1036 * Link Options::        Specifying libraries and so on.
1037 * Directory Options::   Where to find header files and libraries.
1038                         Where to find the compiler executable files.
1039 * Spec Files::          How to pass switches to sub-processes.
1040 * Target Options::      Running a cross-compiler, or an old version of GCC.
1041 @end menu
1043 @node Overall Options
1044 @section Options Controlling the Kind of Output
1046 Compilation can involve up to four stages: preprocessing, compilation
1047 proper, assembly and linking, always in that order.  GCC is capable of
1048 preprocessing and compiling several files either into several
1049 assembler input files, or into one assembler input file; then each
1050 assembler input file produces an object file, and linking combines all
1051 the object files (those newly compiled, and those specified as input)
1052 into an executable file.
1054 @cindex file name suffix
1055 For any given input file, the file name suffix determines what kind of
1056 compilation is done:
1058 @table @gcctabopt
1059 @item @var{file}.c
1060 C source code that must be preprocessed.
1062 @item @var{file}.i
1063 C source code that should not be preprocessed.
1065 @item @var{file}.ii
1066 C++ source code that should not be preprocessed.
1068 @item @var{file}.m
1069 Objective-C source code.  Note that you must link with the @file{libobjc}
1070 library to make an Objective-C program work.
1072 @item @var{file}.mi
1073 Objective-C source code that should not be preprocessed.
1075 @item @var{file}.mm
1076 @itemx @var{file}.M
1077 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1078 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1079 to a literal capital M@.
1081 @item @var{file}.mii
1082 Objective-C++ source code that should not be preprocessed.
1084 @item @var{file}.h
1085 C, C++, Objective-C or Objective-C++ header file to be turned into a
1086 precompiled header (default), or C, C++ header file to be turned into an
1087 Ada spec (via the @option{-fdump-ada-spec} switch).
1089 @item @var{file}.cc
1090 @itemx @var{file}.cp
1091 @itemx @var{file}.cxx
1092 @itemx @var{file}.cpp
1093 @itemx @var{file}.CPP
1094 @itemx @var{file}.c++
1095 @itemx @var{file}.C
1096 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1097 the last two letters must both be literally @samp{x}.  Likewise,
1098 @samp{.C} refers to a literal capital C@.
1100 @item @var{file}.mm
1101 @itemx @var{file}.M
1102 Objective-C++ source code that must be preprocessed.
1104 @item @var{file}.mii
1105 Objective-C++ source code that should not be preprocessed.
1107 @item @var{file}.hh
1108 @itemx @var{file}.H
1109 @itemx @var{file}.hp
1110 @itemx @var{file}.hxx
1111 @itemx @var{file}.hpp
1112 @itemx @var{file}.HPP
1113 @itemx @var{file}.h++
1114 @itemx @var{file}.tcc
1115 C++ header file to be turned into a precompiled header or Ada spec.
1117 @item @var{file}.f
1118 @itemx @var{file}.for
1119 @itemx @var{file}.ftn
1120 Fixed form Fortran source code that should not be preprocessed.
1122 @item @var{file}.F
1123 @itemx @var{file}.FOR
1124 @itemx @var{file}.fpp
1125 @itemx @var{file}.FPP
1126 @itemx @var{file}.FTN
1127 Fixed form Fortran source code that must be preprocessed (with the traditional
1128 preprocessor).
1130 @item @var{file}.f90
1131 @itemx @var{file}.f95
1132 @itemx @var{file}.f03
1133 @itemx @var{file}.f08
1134 Free form Fortran source code that should not be preprocessed.
1136 @item @var{file}.F90
1137 @itemx @var{file}.F95
1138 @itemx @var{file}.F03
1139 @itemx @var{file}.F08
1140 Free form Fortran source code that must be preprocessed (with the
1141 traditional preprocessor).
1143 @item @var{file}.go
1144 Go source code.
1146 @c FIXME: Descriptions of Java file types.
1147 @c @var{file}.java
1148 @c @var{file}.class
1149 @c @var{file}.zip
1150 @c @var{file}.jar
1152 @item @var{file}.ads
1153 Ada source code file that contains a library unit declaration (a
1154 declaration of a package, subprogram, or generic, or a generic
1155 instantiation), or a library unit renaming declaration (a package,
1156 generic, or subprogram renaming declaration).  Such files are also
1157 called @dfn{specs}.
1159 @item @var{file}.adb
1160 Ada source code file containing a library unit body (a subprogram or
1161 package body).  Such files are also called @dfn{bodies}.
1163 @c GCC also knows about some suffixes for languages not yet included:
1164 @c Pascal:
1165 @c @var{file}.p
1166 @c @var{file}.pas
1167 @c Ratfor:
1168 @c @var{file}.r
1170 @item @var{file}.s
1171 Assembler code.
1173 @item @var{file}.S
1174 @itemx @var{file}.sx
1175 Assembler code that must be preprocessed.
1177 @item @var{other}
1178 An object file to be fed straight into linking.
1179 Any file name with no recognized suffix is treated this way.
1180 @end table
1182 @opindex x
1183 You can specify the input language explicitly with the @option{-x} option:
1185 @table @gcctabopt
1186 @item -x @var{language}
1187 Specify explicitly the @var{language} for the following input files
1188 (rather than letting the compiler choose a default based on the file
1189 name suffix).  This option applies to all following input files until
1190 the next @option{-x} option.  Possible values for @var{language} are:
1191 @smallexample
1192 c  c-header  cpp-output
1193 c++  c++-header  c++-cpp-output
1194 objective-c  objective-c-header  objective-c-cpp-output
1195 objective-c++ objective-c++-header objective-c++-cpp-output
1196 assembler  assembler-with-cpp
1198 f77  f77-cpp-input f95  f95-cpp-input
1200 java
1201 @end smallexample
1203 @item -x none
1204 Turn off any specification of a language, so that subsequent files are
1205 handled according to their file name suffixes (as they are if @option{-x}
1206 has not been used at all).
1208 @item -pass-exit-codes
1209 @opindex pass-exit-codes
1210 Normally the @command{gcc} program exits with the code of 1 if any
1211 phase of the compiler returns a non-success return code.  If you specify
1212 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1213 the numerically highest error produced by any phase returning an error
1214 indication.  The C, C++, and Fortran front ends return 4 if an internal
1215 compiler error is encountered.
1216 @end table
1218 If you only want some of the stages of compilation, you can use
1219 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1220 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1221 @command{gcc} is to stop.  Note that some combinations (for example,
1222 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1224 @table @gcctabopt
1225 @item -c
1226 @opindex c
1227 Compile or assemble the source files, but do not link.  The linking
1228 stage simply is not done.  The ultimate output is in the form of an
1229 object file for each source file.
1231 By default, the object file name for a source file is made by replacing
1232 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1234 Unrecognized input files, not requiring compilation or assembly, are
1235 ignored.
1237 @item -S
1238 @opindex S
1239 Stop after the stage of compilation proper; do not assemble.  The output
1240 is in the form of an assembler code file for each non-assembler input
1241 file specified.
1243 By default, the assembler file name for a source file is made by
1244 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1246 Input files that don't require compilation are ignored.
1248 @item -E
1249 @opindex E
1250 Stop after the preprocessing stage; do not run the compiler proper.  The
1251 output is in the form of preprocessed source code, which is sent to the
1252 standard output.
1254 Input files that don't require preprocessing are ignored.
1256 @cindex output file option
1257 @item -o @var{file}
1258 @opindex o
1259 Place output in file @var{file}.  This applies to whatever
1260 sort of output is being produced, whether it be an executable file,
1261 an object file, an assembler file or preprocessed C code.
1263 If @option{-o} is not specified, the default is to put an executable
1264 file in @file{a.out}, the object file for
1265 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1266 assembler file in @file{@var{source}.s}, a precompiled header file in
1267 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1268 standard output.
1270 @item -v
1271 @opindex v
1272 Print (on standard error output) the commands executed to run the stages
1273 of compilation.  Also print the version number of the compiler driver
1274 program and of the preprocessor and the compiler proper.
1276 @item -###
1277 @opindex ###
1278 Like @option{-v} except the commands are not executed and arguments
1279 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1280 This is useful for shell scripts to capture the driver-generated command lines.
1282 @item -pipe
1283 @opindex pipe
1284 Use pipes rather than temporary files for communication between the
1285 various stages of compilation.  This fails to work on some systems where
1286 the assembler is unable to read from a pipe; but the GNU assembler has
1287 no trouble.
1289 @item --help
1290 @opindex help
1291 Print (on the standard output) a description of the command-line options
1292 understood by @command{gcc}.  If the @option{-v} option is also specified
1293 then @option{--help} is also passed on to the various processes
1294 invoked by @command{gcc}, so that they can display the command-line options
1295 they accept.  If the @option{-Wextra} option has also been specified
1296 (prior to the @option{--help} option), then command-line options that
1297 have no documentation associated with them are also displayed.
1299 @item --target-help
1300 @opindex target-help
1301 Print (on the standard output) a description of target-specific command-line
1302 options for each tool.  For some targets extra target-specific
1303 information may also be printed.
1305 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1306 Print (on the standard output) a description of the command-line
1307 options understood by the compiler that fit into all specified classes
1308 and qualifiers.  These are the supported classes:
1310 @table @asis
1311 @item @samp{optimizers}
1312 Display all of the optimization options supported by the
1313 compiler.
1315 @item @samp{warnings}
1316 Display all of the options controlling warning messages
1317 produced by the compiler.
1319 @item @samp{target}
1320 Display target-specific options.  Unlike the
1321 @option{--target-help} option however, target-specific options of the
1322 linker and assembler are not displayed.  This is because those
1323 tools do not currently support the extended @option{--help=} syntax.
1325 @item @samp{params}
1326 Display the values recognized by the @option{--param}
1327 option.
1329 @item @var{language}
1330 Display the options supported for @var{language}, where
1331 @var{language} is the name of one of the languages supported in this
1332 version of GCC@.
1334 @item @samp{common}
1335 Display the options that are common to all languages.
1336 @end table
1338 These are the supported qualifiers:
1340 @table @asis
1341 @item @samp{undocumented}
1342 Display only those options that are undocumented.
1344 @item @samp{joined}
1345 Display options taking an argument that appears after an equal
1346 sign in the same continuous piece of text, such as:
1347 @samp{--help=target}.
1349 @item @samp{separate}
1350 Display options taking an argument that appears as a separate word
1351 following the original option, such as: @samp{-o output-file}.
1352 @end table
1354 Thus for example to display all the undocumented target-specific
1355 switches supported by the compiler, use:
1357 @smallexample
1358 --help=target,undocumented
1359 @end smallexample
1361 The sense of a qualifier can be inverted by prefixing it with the
1362 @samp{^} character, so for example to display all binary warning
1363 options (i.e., ones that are either on or off and that do not take an
1364 argument) that have a description, use:
1366 @smallexample
1367 --help=warnings,^joined,^undocumented
1368 @end smallexample
1370 The argument to @option{--help=} should not consist solely of inverted
1371 qualifiers.
1373 Combining several classes is possible, although this usually
1374 restricts the output so much that there is nothing to display.  One
1375 case where it does work, however, is when one of the classes is
1376 @var{target}.  For example, to display all the target-specific
1377 optimization options, use:
1379 @smallexample
1380 --help=target,optimizers
1381 @end smallexample
1383 The @option{--help=} option can be repeated on the command line.  Each
1384 successive use displays its requested class of options, skipping
1385 those that have already been displayed.
1387 If the @option{-Q} option appears on the command line before the
1388 @option{--help=} option, then the descriptive text displayed by
1389 @option{--help=} is changed.  Instead of describing the displayed
1390 options, an indication is given as to whether the option is enabled,
1391 disabled or set to a specific value (assuming that the compiler
1392 knows this at the point where the @option{--help=} option is used).
1394 Here is a truncated example from the ARM port of @command{gcc}:
1396 @smallexample
1397   % gcc -Q -mabi=2 --help=target -c
1398   The following options are target specific:
1399   -mabi=                                2
1400   -mabort-on-noreturn                   [disabled]
1401   -mapcs                                [disabled]
1402 @end smallexample
1404 The output is sensitive to the effects of previous command-line
1405 options, so for example it is possible to find out which optimizations
1406 are enabled at @option{-O2} by using:
1408 @smallexample
1409 -Q -O2 --help=optimizers
1410 @end smallexample
1412 Alternatively you can discover which binary optimizations are enabled
1413 by @option{-O3} by using:
1415 @smallexample
1416 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1417 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1418 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1419 @end smallexample
1421 @item -no-canonical-prefixes
1422 @opindex no-canonical-prefixes
1423 Do not expand any symbolic links, resolve references to @samp{/../}
1424 or @samp{/./}, or make the path absolute when generating a relative
1425 prefix.
1427 @item --version
1428 @opindex version
1429 Display the version number and copyrights of the invoked GCC@.
1431 @item -wrapper
1432 @opindex wrapper
1433 Invoke all subcommands under a wrapper program.  The name of the
1434 wrapper program and its parameters are passed as a comma separated
1435 list.
1437 @smallexample
1438 gcc -c t.c -wrapper gdb,--args
1439 @end smallexample
1441 @noindent
1442 This invokes all subprograms of @command{gcc} under
1443 @samp{gdb --args}, thus the invocation of @command{cc1} is
1444 @samp{gdb --args cc1 @dots{}}.
1446 @item -fplugin=@var{name}.so
1447 Load the plugin code in file @var{name}.so, assumed to be a
1448 shared object to be dlopen'd by the compiler.  The base name of
1449 the shared object file is used to identify the plugin for the
1450 purposes of argument parsing (See
1451 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1452 Each plugin should define the callback functions specified in the
1453 Plugins API.
1455 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1456 Define an argument called @var{key} with a value of @var{value}
1457 for the plugin called @var{name}.
1459 @item -fdump-ada-spec@r{[}-slim@r{]}
1460 For C and C++ source and include files, generate corresponding Ada
1461 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1462 GNAT User's Guide}, which provides detailed documentation on this feature.
1464 @item -fdump-go-spec=@var{file}
1465 For input files in any language, generate corresponding Go
1466 declarations in @var{file}.  This generates Go @code{const},
1467 @code{type}, @code{var}, and @code{func} declarations which may be a
1468 useful way to start writing a Go interface to code written in some
1469 other language.
1471 @include @value{srcdir}/../libiberty/at-file.texi
1472 @end table
1474 @node Invoking G++
1475 @section Compiling C++ Programs
1477 @cindex suffixes for C++ source
1478 @cindex C++ source file suffixes
1479 C++ source files conventionally use one of the suffixes @samp{.C},
1480 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1481 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1482 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1483 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1484 files with these names and compiles them as C++ programs even if you
1485 call the compiler the same way as for compiling C programs (usually
1486 with the name @command{gcc}).
1488 @findex g++
1489 @findex c++
1490 However, the use of @command{gcc} does not add the C++ library.
1491 @command{g++} is a program that calls GCC and automatically specifies linking
1492 against the C++ library.  It treats @samp{.c},
1493 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1494 files unless @option{-x} is used.  This program is also useful when
1495 precompiling a C header file with a @samp{.h} extension for use in C++
1496 compilations.  On many systems, @command{g++} is also installed with
1497 the name @command{c++}.
1499 @cindex invoking @command{g++}
1500 When you compile C++ programs, you may specify many of the same
1501 command-line options that you use for compiling programs in any
1502 language; or command-line options meaningful for C and related
1503 languages; or options that are meaningful only for C++ programs.
1504 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1505 explanations of options for languages related to C@.
1506 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1507 explanations of options that are meaningful only for C++ programs.
1509 @node C Dialect Options
1510 @section Options Controlling C Dialect
1511 @cindex dialect options
1512 @cindex language dialect options
1513 @cindex options, dialect
1515 The following options control the dialect of C (or languages derived
1516 from C, such as C++, Objective-C and Objective-C++) that the compiler
1517 accepts:
1519 @table @gcctabopt
1520 @cindex ANSI support
1521 @cindex ISO support
1522 @item -ansi
1523 @opindex ansi
1524 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1525 equivalent to @option{-std=c++98}.
1527 This turns off certain features of GCC that are incompatible with ISO
1528 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1529 such as the @code{asm} and @code{typeof} keywords, and
1530 predefined macros such as @code{unix} and @code{vax} that identify the
1531 type of system you are using.  It also enables the undesirable and
1532 rarely used ISO trigraph feature.  For the C compiler,
1533 it disables recognition of C++ style @samp{//} comments as well as
1534 the @code{inline} keyword.
1536 The alternate keywords @code{__asm__}, @code{__extension__},
1537 @code{__inline__} and @code{__typeof__} continue to work despite
1538 @option{-ansi}.  You would not want to use them in an ISO C program, of
1539 course, but it is useful to put them in header files that might be included
1540 in compilations done with @option{-ansi}.  Alternate predefined macros
1541 such as @code{__unix__} and @code{__vax__} are also available, with or
1542 without @option{-ansi}.
1544 The @option{-ansi} option does not cause non-ISO programs to be
1545 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1546 addition to @option{-ansi}.  @xref{Warning Options}.
1548 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1549 option is used.  Some header files may notice this macro and refrain
1550 from declaring certain functions or defining certain macros that the
1551 ISO standard doesn't call for; this is to avoid interfering with any
1552 programs that might use these names for other things.
1554 Functions that are normally built in but do not have semantics
1555 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1556 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1557 built-in functions provided by GCC}, for details of the functions
1558 affected.
1560 @item -std=
1561 @opindex std
1562 Determine the language standard. @xref{Standards,,Language Standards
1563 Supported by GCC}, for details of these standard versions.  This option
1564 is currently only supported when compiling C or C++.
1566 The compiler can accept several base standards, such as @samp{c90} or
1567 @samp{c++98}, and GNU dialects of those standards, such as
1568 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1569 compiler accepts all programs following that standard plus those
1570 using GNU extensions that do not contradict it.  For example,
1571 @option{-std=c90} turns off certain features of GCC that are
1572 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1573 keywords, but not other GNU extensions that do not have a meaning in
1574 ISO C90, such as omitting the middle term of a @code{?:}
1575 expression. On the other hand, when a GNU dialect of a standard is
1576 specified, all features supported by the compiler are enabled, even when
1577 those features change the meaning of the base standard.  As a result, some
1578 strict-conforming programs may be rejected.  The particular standard
1579 is used by @option{-Wpedantic} to identify which features are GNU
1580 extensions given that version of the standard. For example
1581 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1582 comments, while @option{-std=gnu99 -Wpedantic} does not.
1584 A value for this option must be provided; possible values are
1586 @table @samp
1587 @item c90
1588 @itemx c89
1589 @itemx iso9899:1990
1590 Support all ISO C90 programs (certain GNU extensions that conflict
1591 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1593 @item iso9899:199409
1594 ISO C90 as modified in amendment 1.
1596 @item c99
1597 @itemx c9x
1598 @itemx iso9899:1999
1599 @itemx iso9899:199x
1600 ISO C99.  Note that this standard is not yet fully supported; see
1601 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1602 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1604 @item c11
1605 @itemx c1x
1606 @itemx iso9899:2011
1607 ISO C11, the 2011 revision of the ISO C standard.
1608 Support is incomplete and experimental.  The name @samp{c1x} is
1609 deprecated.
1611 @item gnu90
1612 @itemx gnu89
1613 GNU dialect of ISO C90 (including some C99 features). This
1614 is the default for C code.
1616 @item gnu99
1617 @itemx gnu9x
1618 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1619 this will become the default.  The name @samp{gnu9x} is deprecated.
1621 @item gnu11
1622 @itemx gnu1x
1623 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1624 name @samp{gnu1x} is deprecated.
1626 @item c++98
1627 @itemx c++03
1628 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1629 additional defect reports. Same as @option{-ansi} for C++ code.
1631 @item gnu++98
1632 @itemx gnu++03
1633 GNU dialect of @option{-std=c++98}.  This is the default for
1634 C++ code.
1636 @item c++11
1637 @itemx c++0x
1638 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1639 experimental, and may change in incompatible ways in future releases.
1640 The name @samp{c++0x} is deprecated.
1642 @item gnu++11
1643 @itemx gnu++0x
1644 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1645 experimental, and may change in incompatible ways in future releases.
1646 The name @samp{gnu++0x} is deprecated.
1648 @item c++1y
1649 The next revision of the ISO C++ standard, tentatively planned for
1650 2017.  Support is highly experimental, and will almost certainly
1651 change in incompatible ways in future releases.
1653 @item gnu++1y
1654 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1655 and will almost certainly change in incompatible ways in future
1656 releases.
1657 @end table
1659 @item -fgnu89-inline
1660 @opindex fgnu89-inline
1661 The option @option{-fgnu89-inline} tells GCC to use the traditional
1662 GNU semantics for @code{inline} functions when in C99 mode.
1663 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1664 is accepted and ignored by GCC versions 4.1.3 up to but not including
1665 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1666 C99 mode.  Using this option is roughly equivalent to adding the
1667 @code{gnu_inline} function attribute to all inline functions
1668 (@pxref{Function Attributes}).
1670 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1671 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1672 specifies the default behavior).  This option was first supported in
1673 GCC 4.3.  This option is not supported in @option{-std=c90} or
1674 @option{-std=gnu90} mode.
1676 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1677 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1678 in effect for @code{inline} functions.  @xref{Common Predefined
1679 Macros,,,cpp,The C Preprocessor}.
1681 @item -aux-info @var{filename}
1682 @opindex aux-info
1683 Output to the given filename prototyped declarations for all functions
1684 declared and/or defined in a translation unit, including those in header
1685 files.  This option is silently ignored in any language other than C@.
1687 Besides declarations, the file indicates, in comments, the origin of
1688 each declaration (source file and line), whether the declaration was
1689 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1690 @samp{O} for old, respectively, in the first character after the line
1691 number and the colon), and whether it came from a declaration or a
1692 definition (@samp{C} or @samp{F}, respectively, in the following
1693 character).  In the case of function definitions, a K&R-style list of
1694 arguments followed by their declarations is also provided, inside
1695 comments, after the declaration.
1697 @item -fallow-parameterless-variadic-functions
1698 Accept variadic functions without named parameters.
1700 Although it is possible to define such a function, this is not very
1701 useful as it is not possible to read the arguments.  This is only
1702 supported for C as this construct is allowed by C++.
1704 @item -fno-asm
1705 @opindex fno-asm
1706 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1707 keyword, so that code can use these words as identifiers.  You can use
1708 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1709 instead.  @option{-ansi} implies @option{-fno-asm}.
1711 In C++, this switch only affects the @code{typeof} keyword, since
1712 @code{asm} and @code{inline} are standard keywords.  You may want to
1713 use the @option{-fno-gnu-keywords} flag instead, which has the same
1714 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1715 switch only affects the @code{asm} and @code{typeof} keywords, since
1716 @code{inline} is a standard keyword in ISO C99.
1718 @item -fno-builtin
1719 @itemx -fno-builtin-@var{function}
1720 @opindex fno-builtin
1721 @cindex built-in functions
1722 Don't recognize built-in functions that do not begin with
1723 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1724 functions provided by GCC}, for details of the functions affected,
1725 including those which are not built-in functions when @option{-ansi} or
1726 @option{-std} options for strict ISO C conformance are used because they
1727 do not have an ISO standard meaning.
1729 GCC normally generates special code to handle certain built-in functions
1730 more efficiently; for instance, calls to @code{alloca} may become single
1731 instructions which adjust the stack directly, and calls to @code{memcpy}
1732 may become inline copy loops.  The resulting code is often both smaller
1733 and faster, but since the function calls no longer appear as such, you
1734 cannot set a breakpoint on those calls, nor can you change the behavior
1735 of the functions by linking with a different library.  In addition,
1736 when a function is recognized as a built-in function, GCC may use
1737 information about that function to warn about problems with calls to
1738 that function, or to generate more efficient code, even if the
1739 resulting code still contains calls to that function.  For example,
1740 warnings are given with @option{-Wformat} for bad calls to
1741 @code{printf} when @code{printf} is built in and @code{strlen} is
1742 known not to modify global memory.
1744 With the @option{-fno-builtin-@var{function}} option
1745 only the built-in function @var{function} is
1746 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1747 function is named that is not built-in in this version of GCC, this
1748 option is ignored.  There is no corresponding
1749 @option{-fbuiltin-@var{function}} option; if you wish to enable
1750 built-in functions selectively when using @option{-fno-builtin} or
1751 @option{-ffreestanding}, you may define macros such as:
1753 @smallexample
1754 #define abs(n)          __builtin_abs ((n))
1755 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1756 @end smallexample
1758 @item -fhosted
1759 @opindex fhosted
1760 @cindex hosted environment
1762 Assert that compilation targets a hosted environment.  This implies
1763 @option{-fbuiltin}.  A hosted environment is one in which the
1764 entire standard library is available, and in which @code{main} has a return
1765 type of @code{int}.  Examples are nearly everything except a kernel.
1766 This is equivalent to @option{-fno-freestanding}.
1768 @item -ffreestanding
1769 @opindex ffreestanding
1770 @cindex hosted environment
1772 Assert that compilation targets a freestanding environment.  This
1773 implies @option{-fno-builtin}.  A freestanding environment
1774 is one in which the standard library may not exist, and program startup may
1775 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1776 This is equivalent to @option{-fno-hosted}.
1778 @xref{Standards,,Language Standards Supported by GCC}, for details of
1779 freestanding and hosted environments.
1781 @item -fopenmp
1782 @opindex fopenmp
1783 @cindex OpenMP parallel
1784 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1785 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1786 compiler generates parallel code according to the OpenMP Application
1787 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1788 implies @option{-pthread}, and thus is only supported on targets that
1789 have support for @option{-pthread}.
1791 @item -fgnu-tm
1792 @opindex fgnu-tm
1793 When the option @option{-fgnu-tm} is specified, the compiler
1794 generates code for the Linux variant of Intel's current Transactional
1795 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1796 an experimental feature whose interface may change in future versions
1797 of GCC, as the official specification changes.  Please note that not
1798 all architectures are supported for this feature.
1800 For more information on GCC's support for transactional memory,
1801 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1802 Transactional Memory Library}.
1804 Note that the transactional memory feature is not supported with
1805 non-call exceptions (@option{-fnon-call-exceptions}).
1807 @item -fms-extensions
1808 @opindex fms-extensions
1809 Accept some non-standard constructs used in Microsoft header files.
1811 In C++ code, this allows member names in structures to be similar
1812 to previous types declarations.
1814 @smallexample
1815 typedef int UOW;
1816 struct ABC @{
1817   UOW UOW;
1819 @end smallexample
1821 Some cases of unnamed fields in structures and unions are only
1822 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1823 fields within structs/unions}, for details.
1825 @item -fplan9-extensions
1826 Accept some non-standard constructs used in Plan 9 code.
1828 This enables @option{-fms-extensions}, permits passing pointers to
1829 structures with anonymous fields to functions that expect pointers to
1830 elements of the type of the field, and permits referring to anonymous
1831 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1832 struct/union fields within structs/unions}, for details.  This is only
1833 supported for C, not C++.
1835 @item -trigraphs
1836 @opindex trigraphs
1837 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1838 options for strict ISO C conformance) implies @option{-trigraphs}.
1840 @cindex traditional C language
1841 @cindex C language, traditional
1842 @item -traditional
1843 @itemx -traditional-cpp
1844 @opindex traditional-cpp
1845 @opindex traditional
1846 Formerly, these options caused GCC to attempt to emulate a pre-standard
1847 C compiler.  They are now only supported with the @option{-E} switch.
1848 The preprocessor continues to support a pre-standard mode.  See the GNU
1849 CPP manual for details.
1851 @item -fcond-mismatch
1852 @opindex fcond-mismatch
1853 Allow conditional expressions with mismatched types in the second and
1854 third arguments.  The value of such an expression is void.  This option
1855 is not supported for C++.
1857 @item -flax-vector-conversions
1858 @opindex flax-vector-conversions
1859 Allow implicit conversions between vectors with differing numbers of
1860 elements and/or incompatible element types.  This option should not be
1861 used for new code.
1863 @item -funsigned-char
1864 @opindex funsigned-char
1865 Let the type @code{char} be unsigned, like @code{unsigned char}.
1867 Each kind of machine has a default for what @code{char} should
1868 be.  It is either like @code{unsigned char} by default or like
1869 @code{signed char} by default.
1871 Ideally, a portable program should always use @code{signed char} or
1872 @code{unsigned char} when it depends on the signedness of an object.
1873 But many programs have been written to use plain @code{char} and
1874 expect it to be signed, or expect it to be unsigned, depending on the
1875 machines they were written for.  This option, and its inverse, let you
1876 make such a program work with the opposite default.
1878 The type @code{char} is always a distinct type from each of
1879 @code{signed char} or @code{unsigned char}, even though its behavior
1880 is always just like one of those two.
1882 @item -fsigned-char
1883 @opindex fsigned-char
1884 Let the type @code{char} be signed, like @code{signed char}.
1886 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1887 the negative form of @option{-funsigned-char}.  Likewise, the option
1888 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1890 @item -fsigned-bitfields
1891 @itemx -funsigned-bitfields
1892 @itemx -fno-signed-bitfields
1893 @itemx -fno-unsigned-bitfields
1894 @opindex fsigned-bitfields
1895 @opindex funsigned-bitfields
1896 @opindex fno-signed-bitfields
1897 @opindex fno-unsigned-bitfields
1898 These options control whether a bit-field is signed or unsigned, when the
1899 declaration does not use either @code{signed} or @code{unsigned}.  By
1900 default, such a bit-field is signed, because this is consistent: the
1901 basic integer types such as @code{int} are signed types.
1902 @end table
1904 @node C++ Dialect Options
1905 @section Options Controlling C++ Dialect
1907 @cindex compiler options, C++
1908 @cindex C++ options, command-line
1909 @cindex options, C++
1910 This section describes the command-line options that are only meaningful
1911 for C++ programs.  You can also use most of the GNU compiler options
1912 regardless of what language your program is in.  For example, you
1913 might compile a file @code{firstClass.C} like this:
1915 @smallexample
1916 g++ -g -frepo -O -c firstClass.C
1917 @end smallexample
1919 @noindent
1920 In this example, only @option{-frepo} is an option meant
1921 only for C++ programs; you can use the other options with any
1922 language supported by GCC@.
1924 Here is a list of options that are @emph{only} for compiling C++ programs:
1926 @table @gcctabopt
1928 @item -fabi-version=@var{n}
1929 @opindex fabi-version
1930 Use version @var{n} of the C++ ABI@.  The default is version 2.
1932 Version 0 refers to the version conforming most closely to
1933 the C++ ABI specification.  Therefore, the ABI obtained using version 0
1934 will change in different versions of G++ as ABI bugs are fixed.
1936 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
1938 Version 2 is the version of the C++ ABI that first appeared in G++ 3.4.  
1940 Version 3 corrects an error in mangling a constant address as a
1941 template argument.
1943 Version 4, which first appeared in G++ 4.5, implements a standard
1944 mangling for vector types.
1946 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1947 attribute const/volatile on function pointer types, decltype of a
1948 plain decl, and use of a function parameter in the declaration of
1949 another parameter.
1951 Version 6, which first appeared in G++ 4.7, corrects the promotion
1952 behavior of C++11 scoped enums and the mangling of template argument
1953 packs, const/static_cast, prefix ++ and --, and a class scope function
1954 used as a template argument.
1956 See also @option{-Wabi}.
1958 @item -fno-access-control
1959 @opindex fno-access-control
1960 Turn off all access checking.  This switch is mainly useful for working
1961 around bugs in the access control code.
1963 @item -fcheck-new
1964 @opindex fcheck-new
1965 Check that the pointer returned by @code{operator new} is non-null
1966 before attempting to modify the storage allocated.  This check is
1967 normally unnecessary because the C++ standard specifies that
1968 @code{operator new} only returns @code{0} if it is declared
1969 @samp{throw()}, in which case the compiler always checks the
1970 return value even without this option.  In all other cases, when
1971 @code{operator new} has a non-empty exception specification, memory
1972 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1973 @samp{new (nothrow)}.
1975 @item -fconstexpr-depth=@var{n}
1976 @opindex fconstexpr-depth
1977 Set the maximum nested evaluation depth for C++11 constexpr functions
1978 to @var{n}.  A limit is needed to detect endless recursion during
1979 constant expression evaluation.  The minimum specified by the standard
1980 is 512.
1982 @item -fdeduce-init-list
1983 @opindex fdeduce-init-list
1984 Enable deduction of a template type parameter as
1985 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
1987 @smallexample
1988 template <class T> auto forward(T t) -> decltype (realfn (t))
1990   return realfn (t);
1993 void f()
1995   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1997 @end smallexample
1999 This deduction was implemented as a possible extension to the
2000 originally proposed semantics for the C++11 standard, but was not part
2001 of the final standard, so it is disabled by default.  This option is
2002 deprecated, and may be removed in a future version of G++.
2004 @item -ffriend-injection
2005 @opindex ffriend-injection
2006 Inject friend functions into the enclosing namespace, so that they are
2007 visible outside the scope of the class in which they are declared.
2008 Friend functions were documented to work this way in the old Annotated
2009 C++ Reference Manual, and versions of G++ before 4.1 always worked
2010 that way.  However, in ISO C++ a friend function that is not declared
2011 in an enclosing scope can only be found using argument dependent
2012 lookup.  This option causes friends to be injected as they were in
2013 earlier releases.
2015 This option is for compatibility, and may be removed in a future
2016 release of G++.
2018 @item -fno-elide-constructors
2019 @opindex fno-elide-constructors
2020 The C++ standard allows an implementation to omit creating a temporary
2021 that is only used to initialize another object of the same type.
2022 Specifying this option disables that optimization, and forces G++ to
2023 call the copy constructor in all cases.
2025 @item -fno-enforce-eh-specs
2026 @opindex fno-enforce-eh-specs
2027 Don't generate code to check for violation of exception specifications
2028 at run time.  This option violates the C++ standard, but may be useful
2029 for reducing code size in production builds, much like defining
2030 @samp{NDEBUG}.  This does not give user code permission to throw
2031 exceptions in violation of the exception specifications; the compiler
2032 still optimizes based on the specifications, so throwing an
2033 unexpected exception results in undefined behavior at run time.
2035 @item -ffor-scope
2036 @itemx -fno-for-scope
2037 @opindex ffor-scope
2038 @opindex fno-for-scope
2039 If @option{-ffor-scope} is specified, the scope of variables declared in
2040 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2041 as specified by the C++ standard.
2042 If @option{-fno-for-scope} is specified, the scope of variables declared in
2043 a @i{for-init-statement} extends to the end of the enclosing scope,
2044 as was the case in old versions of G++, and other (traditional)
2045 implementations of C++.
2047 If neither flag is given, the default is to follow the standard,
2048 but to allow and give a warning for old-style code that would
2049 otherwise be invalid, or have different behavior.
2051 @item -fno-gnu-keywords
2052 @opindex fno-gnu-keywords
2053 Do not recognize @code{typeof} as a keyword, so that code can use this
2054 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2055 @option{-ansi} implies @option{-fno-gnu-keywords}.
2057 @item -fno-implicit-templates
2058 @opindex fno-implicit-templates
2059 Never emit code for non-inline templates that are instantiated
2060 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2061 @xref{Template Instantiation}, for more information.
2063 @item -fno-implicit-inline-templates
2064 @opindex fno-implicit-inline-templates
2065 Don't emit code for implicit instantiations of inline templates, either.
2066 The default is to handle inlines differently so that compiles with and
2067 without optimization need the same set of explicit instantiations.
2069 @item -fno-implement-inlines
2070 @opindex fno-implement-inlines
2071 To save space, do not emit out-of-line copies of inline functions
2072 controlled by @samp{#pragma implementation}.  This causes linker
2073 errors if these functions are not inlined everywhere they are called.
2075 @item -fms-extensions
2076 @opindex fms-extensions
2077 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2078 int and getting a pointer to member function via non-standard syntax.
2080 @item -fno-nonansi-builtins
2081 @opindex fno-nonansi-builtins
2082 Disable built-in declarations of functions that are not mandated by
2083 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2084 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2086 @item -fnothrow-opt
2087 @opindex fnothrow-opt
2088 Treat a @code{throw()} exception specification as if it were a
2089 @code{noexcept} specification to reduce or eliminate the text size
2090 overhead relative to a function with no exception specification.  If
2091 the function has local variables of types with non-trivial
2092 destructors, the exception specification actually makes the
2093 function smaller because the EH cleanups for those variables can be
2094 optimized away.  The semantic effect is that an exception thrown out of
2095 a function with such an exception specification results in a call
2096 to @code{terminate} rather than @code{unexpected}.
2098 @item -fno-operator-names
2099 @opindex fno-operator-names
2100 Do not treat the operator name keywords @code{and}, @code{bitand},
2101 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2102 synonyms as keywords.
2104 @item -fno-optional-diags
2105 @opindex fno-optional-diags
2106 Disable diagnostics that the standard says a compiler does not need to
2107 issue.  Currently, the only such diagnostic issued by G++ is the one for
2108 a name having multiple meanings within a class.
2110 @item -fpermissive
2111 @opindex fpermissive
2112 Downgrade some diagnostics about nonconformant code from errors to
2113 warnings.  Thus, using @option{-fpermissive} allows some
2114 nonconforming code to compile.
2116 @item -fno-pretty-templates
2117 @opindex fno-pretty-templates
2118 When an error message refers to a specialization of a function
2119 template, the compiler normally prints the signature of the
2120 template followed by the template arguments and any typedefs or
2121 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2122 rather than @code{void f(int)}) so that it's clear which template is
2123 involved.  When an error message refers to a specialization of a class
2124 template, the compiler omits any template arguments that match
2125 the default template arguments for that template.  If either of these
2126 behaviors make it harder to understand the error message rather than
2127 easier, you can use @option{-fno-pretty-templates} to disable them.
2129 @item -frepo
2130 @opindex frepo
2131 Enable automatic template instantiation at link time.  This option also
2132 implies @option{-fno-implicit-templates}.  @xref{Template
2133 Instantiation}, for more information.
2135 @item -fno-rtti
2136 @opindex fno-rtti
2137 Disable generation of information about every class with virtual
2138 functions for use by the C++ run-time type identification features
2139 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2140 of the language, you can save some space by using this flag.  Note that
2141 exception handling uses the same information, but G++ generates it as
2142 needed. The @samp{dynamic_cast} operator can still be used for casts that
2143 do not require run-time type information, i.e.@: casts to @code{void *} or to
2144 unambiguous base classes.
2146 @item -fstats
2147 @opindex fstats
2148 Emit statistics about front-end processing at the end of the compilation.
2149 This information is generally only useful to the G++ development team.
2151 @item -fstrict-enums
2152 @opindex fstrict-enums
2153 Allow the compiler to optimize using the assumption that a value of
2154 enumerated type can only be one of the values of the enumeration (as
2155 defined in the C++ standard; basically, a value that can be
2156 represented in the minimum number of bits needed to represent all the
2157 enumerators).  This assumption may not be valid if the program uses a
2158 cast to convert an arbitrary integer value to the enumerated type.
2160 @item -ftemplate-backtrace-limit=@var{n}
2161 @opindex ftemplate-backtrace-limit
2162 Set the maximum number of template instantiation notes for a single
2163 warning or error to @var{n}.  The default value is 10.
2165 @item -ftemplate-depth=@var{n}
2166 @opindex ftemplate-depth
2167 Set the maximum instantiation depth for template classes to @var{n}.
2168 A limit on the template instantiation depth is needed to detect
2169 endless recursions during template class instantiation.  ANSI/ISO C++
2170 conforming programs must not rely on a maximum depth greater than 17
2171 (changed to 1024 in C++11).  The default value is 900, as the compiler
2172 can run out of stack space before hitting 1024 in some situations.
2174 @item -fno-threadsafe-statics
2175 @opindex fno-threadsafe-statics
2176 Do not emit the extra code to use the routines specified in the C++
2177 ABI for thread-safe initialization of local statics.  You can use this
2178 option to reduce code size slightly in code that doesn't need to be
2179 thread-safe.
2181 @item -fuse-cxa-atexit
2182 @opindex fuse-cxa-atexit
2183 Register destructors for objects with static storage duration with the
2184 @code{__cxa_atexit} function rather than the @code{atexit} function.
2185 This option is required for fully standards-compliant handling of static
2186 destructors, but only works if your C library supports
2187 @code{__cxa_atexit}.
2189 @item -fno-use-cxa-get-exception-ptr
2190 @opindex fno-use-cxa-get-exception-ptr
2191 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2192 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2193 if the runtime routine is not available.
2195 @item -fvisibility-inlines-hidden
2196 @opindex fvisibility-inlines-hidden
2197 This switch declares that the user does not attempt to compare
2198 pointers to inline functions or methods where the addresses of the two functions
2199 are taken in different shared objects.
2201 The effect of this is that GCC may, effectively, mark inline methods with
2202 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2203 appear in the export table of a DSO and do not require a PLT indirection
2204 when used within the DSO@.  Enabling this option can have a dramatic effect
2205 on load and link times of a DSO as it massively reduces the size of the
2206 dynamic export table when the library makes heavy use of templates.
2208 The behavior of this switch is not quite the same as marking the
2209 methods as hidden directly, because it does not affect static variables
2210 local to the function or cause the compiler to deduce that
2211 the function is defined in only one shared object.
2213 You may mark a method as having a visibility explicitly to negate the
2214 effect of the switch for that method.  For example, if you do want to
2215 compare pointers to a particular inline method, you might mark it as
2216 having default visibility.  Marking the enclosing class with explicit
2217 visibility has no effect.
2219 Explicitly instantiated inline methods are unaffected by this option
2220 as their linkage might otherwise cross a shared library boundary.
2221 @xref{Template Instantiation}.
2223 @item -fvisibility-ms-compat
2224 @opindex fvisibility-ms-compat
2225 This flag attempts to use visibility settings to make GCC's C++
2226 linkage model compatible with that of Microsoft Visual Studio.
2228 The flag makes these changes to GCC's linkage model:
2230 @enumerate
2231 @item
2232 It sets the default visibility to @code{hidden}, like
2233 @option{-fvisibility=hidden}.
2235 @item
2236 Types, but not their members, are not hidden by default.
2238 @item
2239 The One Definition Rule is relaxed for types without explicit
2240 visibility specifications that are defined in more than one
2241 shared object: those declarations are permitted if they are
2242 permitted when this option is not used.
2243 @end enumerate
2245 In new code it is better to use @option{-fvisibility=hidden} and
2246 export those classes that are intended to be externally visible.
2247 Unfortunately it is possible for code to rely, perhaps accidentally,
2248 on the Visual Studio behavior.
2250 Among the consequences of these changes are that static data members
2251 of the same type with the same name but defined in different shared
2252 objects are different, so changing one does not change the other;
2253 and that pointers to function members defined in different shared
2254 objects may not compare equal.  When this flag is given, it is a
2255 violation of the ODR to define types with the same name differently.
2257 @item -fno-weak
2258 @opindex fno-weak
2259 Do not use weak symbol support, even if it is provided by the linker.
2260 By default, G++ uses weak symbols if they are available.  This
2261 option exists only for testing, and should not be used by end-users;
2262 it results in inferior code and has no benefits.  This option may
2263 be removed in a future release of G++.
2265 @item -nostdinc++
2266 @opindex nostdinc++
2267 Do not search for header files in the standard directories specific to
2268 C++, but do still search the other standard directories.  (This option
2269 is used when building the C++ library.)
2270 @end table
2272 In addition, these optimization, warning, and code generation options
2273 have meanings only for C++ programs:
2275 @table @gcctabopt
2276 @item -fno-default-inline
2277 @opindex fno-default-inline
2278 Do not assume @samp{inline} for functions defined inside a class scope.
2279 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2280 functions have linkage like inline functions; they just aren't
2281 inlined by default.
2283 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2284 @opindex Wabi
2285 @opindex Wno-abi
2286 Warn when G++ generates code that is probably not compatible with the
2287 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2288 all such cases, there are probably some cases that are not warned about,
2289 even though G++ is generating incompatible code.  There may also be
2290 cases where warnings are emitted even though the code that is generated
2291 is compatible.
2293 You should rewrite your code to avoid these warnings if you are
2294 concerned about the fact that code generated by G++ may not be binary
2295 compatible with code generated by other compilers.
2297 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2299 @itemize @bullet
2301 @item
2302 A template with a non-type template parameter of reference type is
2303 mangled incorrectly:
2304 @smallexample
2305 extern int N;
2306 template <int &> struct S @{@};
2307 void n (S<N>) @{2@}
2308 @end smallexample
2310 This is fixed in @option{-fabi-version=3}.
2312 @item
2313 SIMD vector types declared using @code{__attribute ((vector_size))} are
2314 mangled in a non-standard way that does not allow for overloading of
2315 functions taking vectors of different sizes.
2317 The mangling is changed in @option{-fabi-version=4}.
2318 @end itemize
2320 The known incompatibilities in @option{-fabi-version=1} include:
2322 @itemize @bullet
2324 @item
2325 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2326 pack data into the same byte as a base class.  For example:
2328 @smallexample
2329 struct A @{ virtual void f(); int f1 : 1; @};
2330 struct B : public A @{ int f2 : 1; @};
2331 @end smallexample
2333 @noindent
2334 In this case, G++ places @code{B::f2} into the same byte
2335 as @code{A::f1}; other compilers do not.  You can avoid this problem
2336 by explicitly padding @code{A} so that its size is a multiple of the
2337 byte size on your platform; that causes G++ and other compilers to
2338 lay out @code{B} identically.
2340 @item
2341 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2342 tail padding when laying out virtual bases.  For example:
2344 @smallexample
2345 struct A @{ virtual void f(); char c1; @};
2346 struct B @{ B(); char c2; @};
2347 struct C : public A, public virtual B @{@};
2348 @end smallexample
2350 @noindent
2351 In this case, G++ does not place @code{B} into the tail-padding for
2352 @code{A}; other compilers do.  You can avoid this problem by
2353 explicitly padding @code{A} so that its size is a multiple of its
2354 alignment (ignoring virtual base classes); that causes G++ and other
2355 compilers to lay out @code{C} identically.
2357 @item
2358 Incorrect handling of bit-fields with declared widths greater than that
2359 of their underlying types, when the bit-fields appear in a union.  For
2360 example:
2362 @smallexample
2363 union U @{ int i : 4096; @};
2364 @end smallexample
2366 @noindent
2367 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2368 union too small by the number of bits in an @code{int}.
2370 @item
2371 Empty classes can be placed at incorrect offsets.  For example:
2373 @smallexample
2374 struct A @{@};
2376 struct B @{
2377   A a;
2378   virtual void f ();
2381 struct C : public B, public A @{@};
2382 @end smallexample
2384 @noindent
2385 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2386 it should be placed at offset zero.  G++ mistakenly believes that the
2387 @code{A} data member of @code{B} is already at offset zero.
2389 @item
2390 Names of template functions whose types involve @code{typename} or
2391 template template parameters can be mangled incorrectly.
2393 @smallexample
2394 template <typename Q>
2395 void f(typename Q::X) @{@}
2397 template <template <typename> class Q>
2398 void f(typename Q<int>::X) @{@}
2399 @end smallexample
2401 @noindent
2402 Instantiations of these templates may be mangled incorrectly.
2404 @end itemize
2406 It also warns about psABI-related changes.  The known psABI changes at this
2407 point include:
2409 @itemize @bullet
2411 @item
2412 For SysV/x86-64, unions with @code{long double} members are 
2413 passed in memory as specified in psABI.  For example:
2415 @smallexample
2416 union U @{
2417   long double ld;
2418   int i;
2420 @end smallexample
2422 @noindent
2423 @code{union U} is always passed in memory.
2425 @end itemize
2427 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2428 @opindex Wctor-dtor-privacy
2429 @opindex Wno-ctor-dtor-privacy
2430 Warn when a class seems unusable because all the constructors or
2431 destructors in that class are private, and it has neither friends nor
2432 public static member functions.
2434 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2435 @opindex Wdelete-non-virtual-dtor
2436 @opindex Wno-delete-non-virtual-dtor
2437 Warn when @samp{delete} is used to destroy an instance of a class that
2438 has virtual functions and non-virtual destructor. It is unsafe to delete
2439 an instance of a derived class through a pointer to a base class if the
2440 base class does not have a virtual destructor.  This warning is enabled
2441 by @option{-Wall}.
2443 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2444 @opindex Wliteral-suffix
2445 @opindex Wno-literal-suffix
2446 Warn when a string or character literal is followed by a ud-suffix which does
2447 not begin with an underscore.  As a conforming extension, GCC treats such
2448 suffixes as separate preprocessing tokens in order to maintain backwards
2449 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2450 For example:
2452 @smallexample
2453 #define __STDC_FORMAT_MACROS
2454 #include <inttypes.h>
2455 #include <stdio.h>
2457 int main() @{
2458   int64_t i64 = 123;
2459   printf("My int64: %"PRId64"\n", i64);
2461 @end smallexample
2463 In this case, @code{PRId64} is treated as a separate preprocessing token.
2465 This warning is enabled by default.
2467 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2468 @opindex Wnarrowing
2469 @opindex Wno-narrowing
2470 Warn when a narrowing conversion prohibited by C++11 occurs within
2471 @samp{@{ @}}, e.g.
2473 @smallexample
2474 int i = @{ 2.2 @}; // error: narrowing from double to int
2475 @end smallexample
2477 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2479 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2480 required by the standard.  Note that this does not affect the meaning
2481 of well-formed code; narrowing conversions are still considered
2482 ill-formed in SFINAE context.
2484 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2485 @opindex Wnoexcept
2486 @opindex Wno-noexcept
2487 Warn when a noexcept-expression evaluates to false because of a call
2488 to a function that does not have a non-throwing exception
2489 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2490 the compiler to never throw an exception.
2492 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2493 @opindex Wnon-virtual-dtor
2494 @opindex Wno-non-virtual-dtor
2495 Warn when a class has virtual functions and an accessible non-virtual
2496 destructor, in which case it is possible but unsafe to delete
2497 an instance of a derived class through a pointer to the base class.
2498 This warning is also enabled if @option{-Weffc++} is specified.
2500 @item -Wreorder @r{(C++ and Objective-C++ only)}
2501 @opindex Wreorder
2502 @opindex Wno-reorder
2503 @cindex reordering, warning
2504 @cindex warning for reordering of member initializers
2505 Warn when the order of member initializers given in the code does not
2506 match the order in which they must be executed.  For instance:
2508 @smallexample
2509 struct A @{
2510   int i;
2511   int j;
2512   A(): j (0), i (1) @{ @}
2514 @end smallexample
2516 @noindent
2517 The compiler rearranges the member initializers for @samp{i}
2518 and @samp{j} to match the declaration order of the members, emitting
2519 a warning to that effect.  This warning is enabled by @option{-Wall}.
2521 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2522 @opindex fext-numeric-literals
2523 @opindex fno-ext-numeric-literals
2524 Accept imaginary, fixed-point, or machine-defined
2525 literal number suffixes as GNU extensions.
2526 When this option is turned off these suffixes are treated
2527 as C++11 user-defined literal numeric suffixes.
2528 This is on by default for all pre-C++11 dialects and all GNU dialects:
2529 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2530 @option{-std=gnu++1y}.
2531 This option is off by default
2532 for ISO C++11 onwards (@option{-std=c++11}, ...).
2533 @end table
2535 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2537 @table @gcctabopt
2538 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2539 @opindex Weffc++
2540 @opindex Wno-effc++
2541 Warn about violations of the following style guidelines from Scott Meyers'
2542 @cite{Effective C++, Second Edition} book:
2544 @itemize @bullet
2545 @item
2546 Item 11:  Define a copy constructor and an assignment operator for classes
2547 with dynamically-allocated memory.
2549 @item
2550 Item 12:  Prefer initialization to assignment in constructors.
2552 @item
2553 Item 14:  Make destructors virtual in base classes.
2555 @item
2556 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2558 @item
2559 Item 23:  Don't try to return a reference when you must return an object.
2561 @end itemize
2563 Also warn about violations of the following style guidelines from
2564 Scott Meyers' @cite{More Effective C++} book:
2566 @itemize @bullet
2567 @item
2568 Item 6:  Distinguish between prefix and postfix forms of increment and
2569 decrement operators.
2571 @item
2572 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2574 @end itemize
2576 When selecting this option, be aware that the standard library
2577 headers do not obey all of these guidelines; use @samp{grep -v}
2578 to filter out those warnings.
2580 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2581 @opindex Wstrict-null-sentinel
2582 @opindex Wno-strict-null-sentinel
2583 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2584 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2585 to @code{__null}.  Although it is a null pointer constant rather than a
2586 null pointer, it is guaranteed to be of the same size as a pointer.
2587 But this use is not portable across different compilers.
2589 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2590 @opindex Wno-non-template-friend
2591 @opindex Wnon-template-friend
2592 Disable warnings when non-templatized friend functions are declared
2593 within a template.  Since the advent of explicit template specification
2594 support in G++, if the name of the friend is an unqualified-id (i.e.,
2595 @samp{friend foo(int)}), the C++ language specification demands that the
2596 friend declare or define an ordinary, nontemplate function.  (Section
2597 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2598 could be interpreted as a particular specialization of a templatized
2599 function.  Because this non-conforming behavior is no longer the default
2600 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2601 check existing code for potential trouble spots and is on by default.
2602 This new compiler behavior can be turned off with
2603 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2604 but disables the helpful warning.
2606 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2607 @opindex Wold-style-cast
2608 @opindex Wno-old-style-cast
2609 Warn if an old-style (C-style) cast to a non-void type is used within
2610 a C++ program.  The new-style casts (@samp{dynamic_cast},
2611 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2612 less vulnerable to unintended effects and much easier to search for.
2614 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2615 @opindex Woverloaded-virtual
2616 @opindex Wno-overloaded-virtual
2617 @cindex overloaded virtual function, warning
2618 @cindex warning for overloaded virtual function
2619 Warn when a function declaration hides virtual functions from a
2620 base class.  For example, in:
2622 @smallexample
2623 struct A @{
2624   virtual void f();
2627 struct B: public A @{
2628   void f(int);
2630 @end smallexample
2632 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2633 like:
2635 @smallexample
2636 B* b;
2637 b->f();
2638 @end smallexample
2640 @noindent
2641 fails to compile.
2643 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2644 @opindex Wno-pmf-conversions
2645 @opindex Wpmf-conversions
2646 Disable the diagnostic for converting a bound pointer to member function
2647 to a plain pointer.
2649 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2650 @opindex Wsign-promo
2651 @opindex Wno-sign-promo
2652 Warn when overload resolution chooses a promotion from unsigned or
2653 enumerated type to a signed type, over a conversion to an unsigned type of
2654 the same size.  Previous versions of G++ tried to preserve
2655 unsignedness, but the standard mandates the current behavior.
2657 @smallexample
2658 struct A @{
2659   operator int ();
2660   A& operator = (int);
2663 main ()
2665   A a,b;
2666   a = b;
2668 @end smallexample
2670 @noindent
2671 In this example, G++ synthesizes a default @samp{A& operator =
2672 (const A&);}, while cfront uses the user-defined @samp{operator =}.
2673 @end table
2675 @node Objective-C and Objective-C++ Dialect Options
2676 @section Options Controlling Objective-C and Objective-C++ Dialects
2678 @cindex compiler options, Objective-C and Objective-C++
2679 @cindex Objective-C and Objective-C++ options, command-line
2680 @cindex options, Objective-C and Objective-C++
2681 (NOTE: This manual does not describe the Objective-C and Objective-C++
2682 languages themselves.  @xref{Standards,,Language Standards
2683 Supported by GCC}, for references.)
2685 This section describes the command-line options that are only meaningful
2686 for Objective-C and Objective-C++ programs.  You can also use most of
2687 the language-independent GNU compiler options.
2688 For example, you might compile a file @code{some_class.m} like this:
2690 @smallexample
2691 gcc -g -fgnu-runtime -O -c some_class.m
2692 @end smallexample
2694 @noindent
2695 In this example, @option{-fgnu-runtime} is an option meant only for
2696 Objective-C and Objective-C++ programs; you can use the other options with
2697 any language supported by GCC@.
2699 Note that since Objective-C is an extension of the C language, Objective-C
2700 compilations may also use options specific to the C front-end (e.g.,
2701 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2702 C++-specific options (e.g., @option{-Wabi}).
2704 Here is a list of options that are @emph{only} for compiling Objective-C
2705 and Objective-C++ programs:
2707 @table @gcctabopt
2708 @item -fconstant-string-class=@var{class-name}
2709 @opindex fconstant-string-class
2710 Use @var{class-name} as the name of the class to instantiate for each
2711 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2712 class name is @code{NXConstantString} if the GNU runtime is being used, and
2713 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2714 @option{-fconstant-cfstrings} option, if also present, overrides the
2715 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2716 to be laid out as constant CoreFoundation strings.
2718 @item -fgnu-runtime
2719 @opindex fgnu-runtime
2720 Generate object code compatible with the standard GNU Objective-C
2721 runtime.  This is the default for most types of systems.
2723 @item -fnext-runtime
2724 @opindex fnext-runtime
2725 Generate output compatible with the NeXT runtime.  This is the default
2726 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2727 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2728 used.
2730 @item -fno-nil-receivers
2731 @opindex fno-nil-receivers
2732 Assume that all Objective-C message dispatches (@code{[receiver
2733 message:arg]}) in this translation unit ensure that the receiver is
2734 not @code{nil}.  This allows for more efficient entry points in the
2735 runtime to be used.  This option is only available in conjunction with
2736 the NeXT runtime and ABI version 0 or 1.
2738 @item -fobjc-abi-version=@var{n}
2739 @opindex fobjc-abi-version
2740 Use version @var{n} of the Objective-C ABI for the selected runtime.
2741 This option is currently supported only for the NeXT runtime.  In that
2742 case, Version 0 is the traditional (32-bit) ABI without support for
2743 properties and other Objective-C 2.0 additions.  Version 1 is the
2744 traditional (32-bit) ABI with support for properties and other
2745 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2746 nothing is specified, the default is Version 0 on 32-bit target
2747 machines, and Version 2 on 64-bit target machines.
2749 @item -fobjc-call-cxx-cdtors
2750 @opindex fobjc-call-cxx-cdtors
2751 For each Objective-C class, check if any of its instance variables is a
2752 C++ object with a non-trivial default constructor.  If so, synthesize a
2753 special @code{- (id) .cxx_construct} instance method which runs
2754 non-trivial default constructors on any such instance variables, in order,
2755 and then return @code{self}.  Similarly, check if any instance variable
2756 is a C++ object with a non-trivial destructor, and if so, synthesize a
2757 special @code{- (void) .cxx_destruct} method which runs
2758 all such default destructors, in reverse order.
2760 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2761 methods thusly generated only operate on instance variables
2762 declared in the current Objective-C class, and not those inherited
2763 from superclasses.  It is the responsibility of the Objective-C
2764 runtime to invoke all such methods in an object's inheritance
2765 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2766 by the runtime immediately after a new object instance is allocated;
2767 the @code{- (void) .cxx_destruct} methods are invoked immediately
2768 before the runtime deallocates an object instance.
2770 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2771 support for invoking the @code{- (id) .cxx_construct} and
2772 @code{- (void) .cxx_destruct} methods.
2774 @item -fobjc-direct-dispatch
2775 @opindex fobjc-direct-dispatch
2776 Allow fast jumps to the message dispatcher.  On Darwin this is
2777 accomplished via the comm page.
2779 @item -fobjc-exceptions
2780 @opindex fobjc-exceptions
2781 Enable syntactic support for structured exception handling in
2782 Objective-C, similar to what is offered by C++ and Java.  This option
2783 is required to use the Objective-C keywords @code{@@try},
2784 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2785 @code{@@synchronized}.  This option is available with both the GNU
2786 runtime and the NeXT runtime (but not available in conjunction with
2787 the NeXT runtime on Mac OS X 10.2 and earlier).
2789 @item -fobjc-gc
2790 @opindex fobjc-gc
2791 Enable garbage collection (GC) in Objective-C and Objective-C++
2792 programs.  This option is only available with the NeXT runtime; the
2793 GNU runtime has a different garbage collection implementation that
2794 does not require special compiler flags.
2796 @item -fobjc-nilcheck
2797 @opindex fobjc-nilcheck
2798 For the NeXT runtime with version 2 of the ABI, check for a nil
2799 receiver in method invocations before doing the actual method call.
2800 This is the default and can be disabled using
2801 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2802 checked for nil in this way no matter what this flag is set to.
2803 Currently this flag does nothing when the GNU runtime, or an older
2804 version of the NeXT runtime ABI, is used.
2806 @item -fobjc-std=objc1
2807 @opindex fobjc-std
2808 Conform to the language syntax of Objective-C 1.0, the language
2809 recognized by GCC 4.0.  This only affects the Objective-C additions to
2810 the C/C++ language; it does not affect conformance to C/C++ standards,
2811 which is controlled by the separate C/C++ dialect option flags.  When
2812 this option is used with the Objective-C or Objective-C++ compiler,
2813 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2814 This is useful if you need to make sure that your Objective-C code can
2815 be compiled with older versions of GCC@.
2817 @item -freplace-objc-classes
2818 @opindex freplace-objc-classes
2819 Emit a special marker instructing @command{ld(1)} not to statically link in
2820 the resulting object file, and allow @command{dyld(1)} to load it in at
2821 run time instead.  This is used in conjunction with the Fix-and-Continue
2822 debugging mode, where the object file in question may be recompiled and
2823 dynamically reloaded in the course of program execution, without the need
2824 to restart the program itself.  Currently, Fix-and-Continue functionality
2825 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2826 and later.
2828 @item -fzero-link
2829 @opindex fzero-link
2830 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2831 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2832 compile time) with static class references that get initialized at load time,
2833 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2834 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2835 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2836 for individual class implementations to be modified during program execution.
2837 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2838 regardless of command-line options.
2840 @item -gen-decls
2841 @opindex gen-decls
2842 Dump interface declarations for all classes seen in the source file to a
2843 file named @file{@var{sourcename}.decl}.
2845 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2846 @opindex Wassign-intercept
2847 @opindex Wno-assign-intercept
2848 Warn whenever an Objective-C assignment is being intercepted by the
2849 garbage collector.
2851 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2852 @opindex Wno-protocol
2853 @opindex Wprotocol
2854 If a class is declared to implement a protocol, a warning is issued for
2855 every method in the protocol that is not implemented by the class.  The
2856 default behavior is to issue a warning for every method not explicitly
2857 implemented in the class, even if a method implementation is inherited
2858 from the superclass.  If you use the @option{-Wno-protocol} option, then
2859 methods inherited from the superclass are considered to be implemented,
2860 and no warning is issued for them.
2862 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2863 @opindex Wselector
2864 @opindex Wno-selector
2865 Warn if multiple methods of different types for the same selector are
2866 found during compilation.  The check is performed on the list of methods
2867 in the final stage of compilation.  Additionally, a check is performed
2868 for each selector appearing in a @code{@@selector(@dots{})}
2869 expression, and a corresponding method for that selector has been found
2870 during compilation.  Because these checks scan the method table only at
2871 the end of compilation, these warnings are not produced if the final
2872 stage of compilation is not reached, for example because an error is
2873 found during compilation, or because the @option{-fsyntax-only} option is
2874 being used.
2876 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2877 @opindex Wstrict-selector-match
2878 @opindex Wno-strict-selector-match
2879 Warn if multiple methods with differing argument and/or return types are
2880 found for a given selector when attempting to send a message using this
2881 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2882 is off (which is the default behavior), the compiler omits such warnings
2883 if any differences found are confined to types that share the same size
2884 and alignment.
2886 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2887 @opindex Wundeclared-selector
2888 @opindex Wno-undeclared-selector
2889 Warn if a @code{@@selector(@dots{})} expression referring to an
2890 undeclared selector is found.  A selector is considered undeclared if no
2891 method with that name has been declared before the
2892 @code{@@selector(@dots{})} expression, either explicitly in an
2893 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2894 an @code{@@implementation} section.  This option always performs its
2895 checks as soon as a @code{@@selector(@dots{})} expression is found,
2896 while @option{-Wselector} only performs its checks in the final stage of
2897 compilation.  This also enforces the coding style convention
2898 that methods and selectors must be declared before being used.
2900 @item -print-objc-runtime-info
2901 @opindex print-objc-runtime-info
2902 Generate C header describing the largest structure that is passed by
2903 value, if any.
2905 @end table
2907 @node Language Independent Options
2908 @section Options to Control Diagnostic Messages Formatting
2909 @cindex options to control diagnostics formatting
2910 @cindex diagnostic messages
2911 @cindex message formatting
2913 Traditionally, diagnostic messages have been formatted irrespective of
2914 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
2915 options described below
2916 to control the formatting algorithm for diagnostic messages, 
2917 e.g.@: how many characters per line, how often source location
2918 information should be reported.  Note that some language front ends may not
2919 honor these options.
2921 @table @gcctabopt
2922 @item -fmessage-length=@var{n}
2923 @opindex fmessage-length
2924 Try to format error messages so that they fit on lines of about @var{n}
2925 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2926 the front ends supported by GCC@.  If @var{n} is zero, then no
2927 line-wrapping is done; each error message appears on a single
2928 line.
2930 @item -fdiagnostics-show-location=once
2931 @opindex fdiagnostics-show-location
2932 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2933 reporter to emit source location information @emph{once}; that is, in
2934 case the message is too long to fit on a single physical line and has to
2935 be wrapped, the source location won't be emitted (as prefix) again,
2936 over and over, in subsequent continuation lines.  This is the default
2937 behavior.
2939 @item -fdiagnostics-show-location=every-line
2940 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2941 messages reporter to emit the same source location information (as
2942 prefix) for physical lines that result from the process of breaking
2943 a message which is too long to fit on a single line.
2945 @item -fno-diagnostics-show-option
2946 @opindex fno-diagnostics-show-option
2947 @opindex fdiagnostics-show-option
2948 By default, each diagnostic emitted includes text indicating the
2949 command-line option that directly controls the diagnostic (if such an
2950 option is known to the diagnostic machinery).  Specifying the
2951 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2953 @item -fno-diagnostics-show-caret
2954 @opindex fno-diagnostics-show-caret
2955 @opindex fdiagnostics-show-caret
2956 By default, each diagnostic emitted includes the original source line
2957 and a caret '^' indicating the column.  This option suppresses this
2958 information.
2960 @end table
2962 @node Warning Options
2963 @section Options to Request or Suppress Warnings
2964 @cindex options to control warnings
2965 @cindex warning messages
2966 @cindex messages, warning
2967 @cindex suppressing warnings
2969 Warnings are diagnostic messages that report constructions that
2970 are not inherently erroneous but that are risky or suggest there
2971 may have been an error.
2973 The following language-independent options do not enable specific
2974 warnings but control the kinds of diagnostics produced by GCC@.
2976 @table @gcctabopt
2977 @cindex syntax checking
2978 @item -fsyntax-only
2979 @opindex fsyntax-only
2980 Check the code for syntax errors, but don't do anything beyond that.
2982 @item -fmax-errors=@var{n}
2983 @opindex fmax-errors
2984 Limits the maximum number of error messages to @var{n}, at which point
2985 GCC bails out rather than attempting to continue processing the source
2986 code.  If @var{n} is 0 (the default), there is no limit on the number
2987 of error messages produced.  If @option{-Wfatal-errors} is also
2988 specified, then @option{-Wfatal-errors} takes precedence over this
2989 option.
2991 @item -w
2992 @opindex w
2993 Inhibit all warning messages.
2995 @item -Werror
2996 @opindex Werror
2997 @opindex Wno-error
2998 Make all warnings into errors.
3000 @item -Werror=
3001 @opindex Werror=
3002 @opindex Wno-error=
3003 Make the specified warning into an error.  The specifier for a warning
3004 is appended; for example @option{-Werror=switch} turns the warnings
3005 controlled by @option{-Wswitch} into errors.  This switch takes a
3006 negative form, to be used to negate @option{-Werror} for specific
3007 warnings; for example @option{-Wno-error=switch} makes
3008 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3009 is in effect.
3011 The warning message for each controllable warning includes the
3012 option that controls the warning.  That option can then be used with
3013 @option{-Werror=} and @option{-Wno-error=} as described above.
3014 (Printing of the option in the warning message can be disabled using the
3015 @option{-fno-diagnostics-show-option} flag.)
3017 Note that specifying @option{-Werror=}@var{foo} automatically implies
3018 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3019 imply anything.
3021 @item -Wfatal-errors
3022 @opindex Wfatal-errors
3023 @opindex Wno-fatal-errors
3024 This option causes the compiler to abort compilation on the first error
3025 occurred rather than trying to keep going and printing further error
3026 messages.
3028 @end table
3030 You can request many specific warnings with options beginning with
3031 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3032 implicit declarations.  Each of these specific warning options also
3033 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3034 example, @option{-Wno-implicit}.  This manual lists only one of the
3035 two forms, whichever is not the default.  For further
3036 language-specific options also refer to @ref{C++ Dialect Options} and
3037 @ref{Objective-C and Objective-C++ Dialect Options}.
3039 When an unrecognized warning option is requested (e.g.,
3040 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3041 that the option is not recognized.  However, if the @option{-Wno-} form
3042 is used, the behavior is slightly different: no diagnostic is
3043 produced for @option{-Wno-unknown-warning} unless other diagnostics
3044 are being produced.  This allows the use of new @option{-Wno-} options
3045 with old compilers, but if something goes wrong, the compiler
3046 warns that an unrecognized option is present.
3048 @table @gcctabopt
3049 @item -Wpedantic
3050 @itemx -pedantic
3051 @opindex pedantic
3052 @opindex Wpedantic
3053 Issue all the warnings demanded by strict ISO C and ISO C++;
3054 reject all programs that use forbidden extensions, and some other
3055 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3056 version of the ISO C standard specified by any @option{-std} option used.
3058 Valid ISO C and ISO C++ programs should compile properly with or without
3059 this option (though a rare few require @option{-ansi} or a
3060 @option{-std} option specifying the required version of ISO C)@.  However,
3061 without this option, certain GNU extensions and traditional C and C++
3062 features are supported as well.  With this option, they are rejected.
3064 @option{-Wpedantic} does not cause warning messages for use of the
3065 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3066 warnings are also disabled in the expression that follows
3067 @code{__extension__}.  However, only system header files should use
3068 these escape routes; application programs should avoid them.
3069 @xref{Alternate Keywords}.
3071 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3072 C conformance.  They soon find that it does not do quite what they want:
3073 it finds some non-ISO practices, but not all---only those for which
3074 ISO C @emph{requires} a diagnostic, and some others for which
3075 diagnostics have been added.
3077 A feature to report any failure to conform to ISO C might be useful in
3078 some instances, but would require considerable additional work and would
3079 be quite different from @option{-Wpedantic}.  We don't have plans to
3080 support such a feature in the near future.
3082 Where the standard specified with @option{-std} represents a GNU
3083 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3084 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3085 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3086 where they are required by the base standard.  (It does not make sense
3087 for such warnings to be given only for features not in the specified GNU
3088 C dialect, since by definition the GNU dialects of C include all
3089 features the compiler supports with the given option, and there would be
3090 nothing to warn about.)
3092 @item -pedantic-errors
3093 @opindex pedantic-errors
3094 Like @option{-Wpedantic}, except that errors are produced rather than
3095 warnings.
3097 @item -Wall
3098 @opindex Wall
3099 @opindex Wno-all
3100 This enables all the warnings about constructions that some users
3101 consider questionable, and that are easy to avoid (or modify to
3102 prevent the warning), even in conjunction with macros.  This also
3103 enables some language-specific warnings described in @ref{C++ Dialect
3104 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3106 @option{-Wall} turns on the following warning flags:
3108 @gccoptlist{-Waddress   @gol
3109 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3110 -Wc++11-compat  @gol
3111 -Wchar-subscripts  @gol
3112 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3113 -Wimplicit-int @r{(C and Objective-C only)} @gol
3114 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3115 -Wcomment  @gol
3116 -Wformat   @gol
3117 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3118 -Wmaybe-uninitialized @gol
3119 -Wmissing-braces @r{(only for C/ObjC)} @gol
3120 -Wnonnull  @gol
3121 -Wparentheses  @gol
3122 -Wpointer-sign  @gol
3123 -Wreorder   @gol
3124 -Wreturn-type  @gol
3125 -Wsequence-point  @gol
3126 -Wsign-compare @r{(only in C++)}  @gol
3127 -Wstrict-aliasing  @gol
3128 -Wstrict-overflow=1  @gol
3129 -Wswitch  @gol
3130 -Wtrigraphs  @gol
3131 -Wuninitialized  @gol
3132 -Wunknown-pragmas  @gol
3133 -Wunused-function  @gol
3134 -Wunused-label     @gol
3135 -Wunused-value     @gol
3136 -Wunused-variable  @gol
3137 -Wvolatile-register-var @gol
3140 Note that some warning flags are not implied by @option{-Wall}.  Some of
3141 them warn about constructions that users generally do not consider
3142 questionable, but which occasionally you might wish to check for;
3143 others warn about constructions that are necessary or hard to avoid in
3144 some cases, and there is no simple way to modify the code to suppress
3145 the warning. Some of them are enabled by @option{-Wextra} but many of
3146 them must be enabled individually.
3148 @item -Wextra
3149 @opindex W
3150 @opindex Wextra
3151 @opindex Wno-extra
3152 This enables some extra warning flags that are not enabled by
3153 @option{-Wall}. (This option used to be called @option{-W}.  The older
3154 name is still supported, but the newer name is more descriptive.)
3156 @gccoptlist{-Wclobbered  @gol
3157 -Wempty-body  @gol
3158 -Wignored-qualifiers @gol
3159 -Wmissing-field-initializers  @gol
3160 -Wmissing-parameter-type @r{(C only)}  @gol
3161 -Wold-style-declaration @r{(C only)}  @gol
3162 -Woverride-init  @gol
3163 -Wsign-compare  @gol
3164 -Wtype-limits  @gol
3165 -Wuninitialized  @gol
3166 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3167 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3170 The option @option{-Wextra} also prints warning messages for the
3171 following cases:
3173 @itemize @bullet
3175 @item
3176 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3177 @samp{>}, or @samp{>=}.
3179 @item
3180 (C++ only) An enumerator and a non-enumerator both appear in a
3181 conditional expression.
3183 @item
3184 (C++ only) Ambiguous virtual bases.
3186 @item
3187 (C++ only) Subscripting an array that has been declared @samp{register}.
3189 @item
3190 (C++ only) Taking the address of a variable that has been declared
3191 @samp{register}.
3193 @item
3194 (C++ only) A base class is not initialized in a derived class's copy
3195 constructor.
3197 @end itemize
3199 @item -Wchar-subscripts
3200 @opindex Wchar-subscripts
3201 @opindex Wno-char-subscripts
3202 Warn if an array subscript has type @code{char}.  This is a common cause
3203 of error, as programmers often forget that this type is signed on some
3204 machines.
3205 This warning is enabled by @option{-Wall}.
3207 @item -Wcomment
3208 @opindex Wcomment
3209 @opindex Wno-comment
3210 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3211 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3212 This warning is enabled by @option{-Wall}.
3214 @item -Wno-coverage-mismatch
3215 @opindex Wno-coverage-mismatch
3216 Warn if feedback profiles do not match when using the
3217 @option{-fprofile-use} option.
3218 If a source file is changed between compiling with @option{-fprofile-gen} and
3219 with @option{-fprofile-use}, the files with the profile feedback can fail
3220 to match the source file and GCC cannot use the profile feedback
3221 information.  By default, this warning is enabled and is treated as an
3222 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3223 warning or @option{-Wno-error=coverage-mismatch} can be used to
3224 disable the error.  Disabling the error for this warning can result in
3225 poorly optimized code and is useful only in the
3226 case of very minor changes such as bug fixes to an existing code-base.
3227 Completely disabling the warning is not recommended.
3229 @item -Wno-cpp
3230 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3232 Suppress warning messages emitted by @code{#warning} directives.
3234 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3235 @opindex Wdouble-promotion
3236 @opindex Wno-double-promotion
3237 Give a warning when a value of type @code{float} is implicitly
3238 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3239 floating-point unit implement @code{float} in hardware, but emulate
3240 @code{double} in software.  On such a machine, doing computations
3241 using @code{double} values is much more expensive because of the
3242 overhead required for software emulation.
3244 It is easy to accidentally do computations with @code{double} because
3245 floating-point literals are implicitly of type @code{double}.  For
3246 example, in:
3247 @smallexample
3248 @group
3249 float area(float radius)
3251    return 3.14159 * radius * radius;
3253 @end group
3254 @end smallexample
3255 the compiler performs the entire computation with @code{double}
3256 because the floating-point literal is a @code{double}.
3258 @item -Wformat
3259 @itemx -Wformat=@var{n}
3260 @opindex Wformat
3261 @opindex Wno-format
3262 @opindex ffreestanding
3263 @opindex fno-builtin
3264 @opindex Wformat=
3265 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3266 the arguments supplied have types appropriate to the format string
3267 specified, and that the conversions specified in the format string make
3268 sense.  This includes standard functions, and others specified by format
3269 attributes (@pxref{Function Attributes}), in the @code{printf},
3270 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3271 not in the C standard) families (or other target-specific families).
3272 Which functions are checked without format attributes having been
3273 specified depends on the standard version selected, and such checks of
3274 functions without the attribute specified are disabled by
3275 @option{-ffreestanding} or @option{-fno-builtin}.
3277 The formats are checked against the format features supported by GNU
3278 libc version 2.2.  These include all ISO C90 and C99 features, as well
3279 as features from the Single Unix Specification and some BSD and GNU
3280 extensions.  Other library implementations may not support all these
3281 features; GCC does not support warning about features that go beyond a
3282 particular library's limitations.  However, if @option{-Wpedantic} is used
3283 with @option{-Wformat}, warnings are given about format features not
3284 in the selected standard version (but not for @code{strfmon} formats,
3285 since those are not in any version of the C standard).  @xref{C Dialect
3286 Options,,Options Controlling C Dialect}.
3288 @table @gcctabopt
3289 @item -Wformat=1
3290 @itemx -Wformat
3291 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3292 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3293 @option{-Wformat} also checks for null format arguments for several
3294 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3295 aspects of this level of format checking can be disabled by the
3296 options: @option{-Wno-format-contains-nul},
3297 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3298 @option{-Wformat} is enabled by @option{-Wall}.
3300 @item -Wno-format-contains-nul
3301 @opindex Wno-format-contains-nul
3302 @opindex Wformat-contains-nul
3303 If @option{-Wformat} is specified, do not warn about format strings that
3304 contain NUL bytes.
3306 @item -Wno-format-extra-args
3307 @opindex Wno-format-extra-args
3308 @opindex Wformat-extra-args
3309 If @option{-Wformat} is specified, do not warn about excess arguments to a
3310 @code{printf} or @code{scanf} format function.  The C standard specifies
3311 that such arguments are ignored.
3313 Where the unused arguments lie between used arguments that are
3314 specified with @samp{$} operand number specifications, normally
3315 warnings are still given, since the implementation could not know what
3316 type to pass to @code{va_arg} to skip the unused arguments.  However,
3317 in the case of @code{scanf} formats, this option suppresses the
3318 warning if the unused arguments are all pointers, since the Single
3319 Unix Specification says that such unused arguments are allowed.
3321 @item -Wno-format-zero-length
3322 @opindex Wno-format-zero-length
3323 @opindex Wformat-zero-length
3324 If @option{-Wformat} is specified, do not warn about zero-length formats.
3325 The C standard specifies that zero-length formats are allowed.
3328 @item -Wformat=2
3329 Enable @option{-Wformat} plus additional format checks.  Currently
3330 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3331 -Wformat-y2k}.
3333 @item -Wformat-nonliteral
3334 @opindex Wformat-nonliteral
3335 @opindex Wno-format-nonliteral
3336 If @option{-Wformat} is specified, also warn if the format string is not a
3337 string literal and so cannot be checked, unless the format function
3338 takes its format arguments as a @code{va_list}.
3340 @item -Wformat-security
3341 @opindex Wformat-security
3342 @opindex Wno-format-security
3343 If @option{-Wformat} is specified, also warn about uses of format
3344 functions that represent possible security problems.  At present, this
3345 warns about calls to @code{printf} and @code{scanf} functions where the
3346 format string is not a string literal and there are no format arguments,
3347 as in @code{printf (foo);}.  This may be a security hole if the format
3348 string came from untrusted input and contains @samp{%n}.  (This is
3349 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3350 in future warnings may be added to @option{-Wformat-security} that are not
3351 included in @option{-Wformat-nonliteral}.)
3353 @item -Wformat-y2k
3354 @opindex Wformat-y2k
3355 @opindex Wno-format-y2k
3356 If @option{-Wformat} is specified, also warn about @code{strftime}
3357 formats that may yield only a two-digit year.
3358 @end table
3360 @item -Wnonnull
3361 @opindex Wnonnull
3362 @opindex Wno-nonnull
3363 Warn about passing a null pointer for arguments marked as
3364 requiring a non-null value by the @code{nonnull} function attribute.
3366 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3367 can be disabled with the @option{-Wno-nonnull} option.
3369 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3370 @opindex Winit-self
3371 @opindex Wno-init-self
3372 Warn about uninitialized variables that are initialized with themselves.
3373 Note this option can only be used with the @option{-Wuninitialized} option.
3375 For example, GCC warns about @code{i} being uninitialized in the
3376 following snippet only when @option{-Winit-self} has been specified:
3377 @smallexample
3378 @group
3379 int f()
3381   int i = i;
3382   return i;
3384 @end group
3385 @end smallexample
3387 This warning is enabled by @option{-Wall} in C++.
3389 @item -Wimplicit-int @r{(C and Objective-C only)}
3390 @opindex Wimplicit-int
3391 @opindex Wno-implicit-int
3392 Warn when a declaration does not specify a type.
3393 This warning is enabled by @option{-Wall}.
3395 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3396 @opindex Wimplicit-function-declaration
3397 @opindex Wno-implicit-function-declaration
3398 Give a warning whenever a function is used before being declared. In
3399 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3400 enabled by default and it is made into an error by
3401 @option{-pedantic-errors}. This warning is also enabled by
3402 @option{-Wall}.
3404 @item -Wimplicit @r{(C and Objective-C only)}
3405 @opindex Wimplicit
3406 @opindex Wno-implicit
3407 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3408 This warning is enabled by @option{-Wall}.
3410 @item -Wignored-qualifiers @r{(C and C++ only)}
3411 @opindex Wignored-qualifiers
3412 @opindex Wno-ignored-qualifiers
3413 Warn if the return type of a function has a type qualifier
3414 such as @code{const}.  For ISO C such a type qualifier has no effect,
3415 since the value returned by a function is not an lvalue.
3416 For C++, the warning is only emitted for scalar types or @code{void}.
3417 ISO C prohibits qualified @code{void} return types on function
3418 definitions, so such return types always receive a warning
3419 even without this option.
3421 This warning is also enabled by @option{-Wextra}.
3423 @item -Wmain
3424 @opindex Wmain
3425 @opindex Wno-main
3426 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3427 a function with external linkage, returning int, taking either zero
3428 arguments, two, or three arguments of appropriate types.  This warning
3429 is enabled by default in C++ and is enabled by either @option{-Wall}
3430 or @option{-Wpedantic}.
3432 @item -Wmissing-braces
3433 @opindex Wmissing-braces
3434 @opindex Wno-missing-braces
3435 Warn if an aggregate or union initializer is not fully bracketed.  In
3436 the following example, the initializer for @samp{a} is not fully
3437 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3438 enabled by @option{-Wall} in C.
3440 @smallexample
3441 int a[2][2] = @{ 0, 1, 2, 3 @};
3442 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3443 @end smallexample
3445 This warning is enabled by @option{-Wall}.
3447 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3448 @opindex Wmissing-include-dirs
3449 @opindex Wno-missing-include-dirs
3450 Warn if a user-supplied include directory does not exist.
3452 @item -Wparentheses
3453 @opindex Wparentheses
3454 @opindex Wno-parentheses
3455 Warn if parentheses are omitted in certain contexts, such
3456 as when there is an assignment in a context where a truth value
3457 is expected, or when operators are nested whose precedence people
3458 often get confused about.
3460 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3461 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3462 interpretation from that of ordinary mathematical notation.
3464 Also warn about constructions where there may be confusion to which
3465 @code{if} statement an @code{else} branch belongs.  Here is an example of
3466 such a case:
3468 @smallexample
3469 @group
3471   if (a)
3472     if (b)
3473       foo ();
3474   else
3475     bar ();
3477 @end group
3478 @end smallexample
3480 In C/C++, every @code{else} branch belongs to the innermost possible
3481 @code{if} statement, which in this example is @code{if (b)}.  This is
3482 often not what the programmer expected, as illustrated in the above
3483 example by indentation the programmer chose.  When there is the
3484 potential for this confusion, GCC issues a warning when this flag
3485 is specified.  To eliminate the warning, add explicit braces around
3486 the innermost @code{if} statement so there is no way the @code{else}
3487 can belong to the enclosing @code{if}.  The resulting code
3488 looks like this:
3490 @smallexample
3491 @group
3493   if (a)
3494     @{
3495       if (b)
3496         foo ();
3497       else
3498         bar ();
3499     @}
3501 @end group
3502 @end smallexample
3504 Also warn for dangerous uses of the GNU extension to
3505 @code{?:} with omitted middle operand. When the condition
3506 in the @code{?}: operator is a boolean expression, the omitted value is
3507 always 1.  Often programmers expect it to be a value computed
3508 inside the conditional expression instead.
3510 This warning is enabled by @option{-Wall}.
3512 @item -Wsequence-point
3513 @opindex Wsequence-point
3514 @opindex Wno-sequence-point
3515 Warn about code that may have undefined semantics because of violations
3516 of sequence point rules in the C and C++ standards.
3518 The C and C++ standards define the order in which expressions in a C/C++
3519 program are evaluated in terms of @dfn{sequence points}, which represent
3520 a partial ordering between the execution of parts of the program: those
3521 executed before the sequence point, and those executed after it.  These
3522 occur after the evaluation of a full expression (one which is not part
3523 of a larger expression), after the evaluation of the first operand of a
3524 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3525 function is called (but after the evaluation of its arguments and the
3526 expression denoting the called function), and in certain other places.
3527 Other than as expressed by the sequence point rules, the order of
3528 evaluation of subexpressions of an expression is not specified.  All
3529 these rules describe only a partial order rather than a total order,
3530 since, for example, if two functions are called within one expression
3531 with no sequence point between them, the order in which the functions
3532 are called is not specified.  However, the standards committee have
3533 ruled that function calls do not overlap.
3535 It is not specified when between sequence points modifications to the
3536 values of objects take effect.  Programs whose behavior depends on this
3537 have undefined behavior; the C and C++ standards specify that ``Between
3538 the previous and next sequence point an object shall have its stored
3539 value modified at most once by the evaluation of an expression.
3540 Furthermore, the prior value shall be read only to determine the value
3541 to be stored.''.  If a program breaks these rules, the results on any
3542 particular implementation are entirely unpredictable.
3544 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3545 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3546 diagnosed by this option, and it may give an occasional false positive
3547 result, but in general it has been found fairly effective at detecting
3548 this sort of problem in programs.
3550 The standard is worded confusingly, therefore there is some debate
3551 over the precise meaning of the sequence point rules in subtle cases.
3552 Links to discussions of the problem, including proposed formal
3553 definitions, may be found on the GCC readings page, at
3554 @uref{http://gcc.gnu.org/@/readings.html}.
3556 This warning is enabled by @option{-Wall} for C and C++.
3558 @item -Wno-return-local-addr
3559 @opindex Wno-return-local-addr
3560 @opindex Wreturn-local-addr
3561 Do not warn about returning a pointer (or in C++, a reference) to a
3562 variable that goes out of scope after the function returns.
3564 @item -Wreturn-type
3565 @opindex Wreturn-type
3566 @opindex Wno-return-type
3567 Warn whenever a function is defined with a return type that defaults
3568 to @code{int}.  Also warn about any @code{return} statement with no
3569 return value in a function whose return type is not @code{void}
3570 (falling off the end of the function body is considered returning
3571 without a value), and about a @code{return} statement with an
3572 expression in a function whose return type is @code{void}.
3574 For C++, a function without return type always produces a diagnostic
3575 message, even when @option{-Wno-return-type} is specified.  The only
3576 exceptions are @samp{main} and functions defined in system headers.
3578 This warning is enabled by @option{-Wall}.
3580 @item -Wswitch
3581 @opindex Wswitch
3582 @opindex Wno-switch
3583 Warn whenever a @code{switch} statement has an index of enumerated type
3584 and lacks a @code{case} for one or more of the named codes of that
3585 enumeration.  (The presence of a @code{default} label prevents this
3586 warning.)  @code{case} labels outside the enumeration range also
3587 provoke warnings when this option is used (even if there is a
3588 @code{default} label).
3589 This warning is enabled by @option{-Wall}.
3591 @item -Wswitch-default
3592 @opindex Wswitch-default
3593 @opindex Wno-switch-default
3594 Warn whenever a @code{switch} statement does not have a @code{default}
3595 case.
3597 @item -Wswitch-enum
3598 @opindex Wswitch-enum
3599 @opindex Wno-switch-enum
3600 Warn whenever a @code{switch} statement has an index of enumerated type
3601 and lacks a @code{case} for one or more of the named codes of that
3602 enumeration.  @code{case} labels outside the enumeration range also
3603 provoke warnings when this option is used.  The only difference
3604 between @option{-Wswitch} and this option is that this option gives a
3605 warning about an omitted enumeration code even if there is a
3606 @code{default} label.
3608 @item -Wsync-nand @r{(C and C++ only)}
3609 @opindex Wsync-nand
3610 @opindex Wno-sync-nand
3611 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3612 built-in functions are used.  These functions changed semantics in GCC 4.4.
3614 @item -Wtrigraphs
3615 @opindex Wtrigraphs
3616 @opindex Wno-trigraphs
3617 Warn if any trigraphs are encountered that might change the meaning of
3618 the program (trigraphs within comments are not warned about).
3619 This warning is enabled by @option{-Wall}.
3621 @item -Wunused-but-set-parameter
3622 @opindex Wunused-but-set-parameter
3623 @opindex Wno-unused-but-set-parameter
3624 Warn whenever a function parameter is assigned to, but otherwise unused
3625 (aside from its declaration).
3627 To suppress this warning use the @samp{unused} attribute
3628 (@pxref{Variable Attributes}).
3630 This warning is also enabled by @option{-Wunused} together with
3631 @option{-Wextra}.
3633 @item -Wunused-but-set-variable
3634 @opindex Wunused-but-set-variable
3635 @opindex Wno-unused-but-set-variable
3636 Warn whenever a local variable is assigned to, but otherwise unused
3637 (aside from its declaration).
3638 This warning is enabled by @option{-Wall}.
3640 To suppress this warning use the @samp{unused} attribute
3641 (@pxref{Variable Attributes}).
3643 This warning is also enabled by @option{-Wunused}, which is enabled
3644 by @option{-Wall}.
3646 @item -Wunused-function
3647 @opindex Wunused-function
3648 @opindex Wno-unused-function
3649 Warn whenever a static function is declared but not defined or a
3650 non-inline static function is unused.
3651 This warning is enabled by @option{-Wall}.
3653 @item -Wunused-label
3654 @opindex Wunused-label
3655 @opindex Wno-unused-label
3656 Warn whenever a label is declared but not used.
3657 This warning is enabled by @option{-Wall}.
3659 To suppress this warning use the @samp{unused} attribute
3660 (@pxref{Variable Attributes}).
3662 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3663 @opindex Wunused-local-typedefs
3664 Warn when a typedef locally defined in a function is not used.
3665 This warning is enabled by @option{-Wall}.
3667 @item -Wunused-parameter
3668 @opindex Wunused-parameter
3669 @opindex Wno-unused-parameter
3670 Warn whenever a function parameter is unused aside from its declaration.
3672 To suppress this warning use the @samp{unused} attribute
3673 (@pxref{Variable Attributes}).
3675 @item -Wno-unused-result
3676 @opindex Wunused-result
3677 @opindex Wno-unused-result
3678 Do not warn if a caller of a function marked with attribute
3679 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3680 its return value. The default is @option{-Wunused-result}.
3682 @item -Wunused-variable
3683 @opindex Wunused-variable
3684 @opindex Wno-unused-variable
3685 Warn whenever a local variable or non-constant static variable is unused
3686 aside from its declaration.
3687 This warning is enabled by @option{-Wall}.
3689 To suppress this warning use the @samp{unused} attribute
3690 (@pxref{Variable Attributes}).
3692 @item -Wunused-value
3693 @opindex Wunused-value
3694 @opindex Wno-unused-value
3695 Warn whenever a statement computes a result that is explicitly not
3696 used. To suppress this warning cast the unused expression to
3697 @samp{void}. This includes an expression-statement or the left-hand
3698 side of a comma expression that contains no side effects. For example,
3699 an expression such as @samp{x[i,j]} causes a warning, while
3700 @samp{x[(void)i,j]} does not.
3702 This warning is enabled by @option{-Wall}.
3704 @item -Wunused
3705 @opindex Wunused
3706 @opindex Wno-unused
3707 All the above @option{-Wunused} options combined.
3709 In order to get a warning about an unused function parameter, you must
3710 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3711 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3713 @item -Wuninitialized
3714 @opindex Wuninitialized
3715 @opindex Wno-uninitialized
3716 Warn if an automatic variable is used without first being initialized
3717 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3718 warn if a non-static reference or non-static @samp{const} member
3719 appears in a class without constructors.
3721 If you want to warn about code that uses the uninitialized value of the
3722 variable in its own initializer, use the @option{-Winit-self} option.
3724 These warnings occur for individual uninitialized or clobbered
3725 elements of structure, union or array variables as well as for
3726 variables that are uninitialized or clobbered as a whole.  They do
3727 not occur for variables or elements declared @code{volatile}.  Because
3728 these warnings depend on optimization, the exact variables or elements
3729 for which there are warnings depends on the precise optimization
3730 options and version of GCC used.
3732 Note that there may be no warning about a variable that is used only
3733 to compute a value that itself is never used, because such
3734 computations may be deleted by data flow analysis before the warnings
3735 are printed.
3737 @item -Wmaybe-uninitialized
3738 @opindex Wmaybe-uninitialized
3739 @opindex Wno-maybe-uninitialized
3740 For an automatic variable, if there exists a path from the function
3741 entry to a use of the variable that is initialized, but there exist
3742 some other paths for which the variable is not initialized, the compiler
3743 emits a warning if it cannot prove the uninitialized paths are not
3744 executed at run time. These warnings are made optional because GCC is
3745 not smart enough to see all the reasons why the code might be correct
3746 in spite of appearing to have an error.  Here is one example of how
3747 this can happen:
3749 @smallexample
3750 @group
3752   int x;
3753   switch (y)
3754     @{
3755     case 1: x = 1;
3756       break;
3757     case 2: x = 4;
3758       break;
3759     case 3: x = 5;
3760     @}
3761   foo (x);
3763 @end group
3764 @end smallexample
3766 @noindent
3767 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3768 always initialized, but GCC doesn't know this. To suppress the
3769 warning, you need to provide a default case with assert(0) or
3770 similar code.
3772 @cindex @code{longjmp} warnings
3773 This option also warns when a non-volatile automatic variable might be
3774 changed by a call to @code{longjmp}.  These warnings as well are possible
3775 only in optimizing compilation.
3777 The compiler sees only the calls to @code{setjmp}.  It cannot know
3778 where @code{longjmp} will be called; in fact, a signal handler could
3779 call it at any point in the code.  As a result, you may get a warning
3780 even when there is in fact no problem because @code{longjmp} cannot
3781 in fact be called at the place that would cause a problem.
3783 Some spurious warnings can be avoided if you declare all the functions
3784 you use that never return as @code{noreturn}.  @xref{Function
3785 Attributes}.
3787 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3789 @item -Wunknown-pragmas
3790 @opindex Wunknown-pragmas
3791 @opindex Wno-unknown-pragmas
3792 @cindex warning for unknown pragmas
3793 @cindex unknown pragmas, warning
3794 @cindex pragmas, warning of unknown
3795 Warn when a @code{#pragma} directive is encountered that is not understood by 
3796 GCC@.  If this command-line option is used, warnings are even issued
3797 for unknown pragmas in system header files.  This is not the case if
3798 the warnings are only enabled by the @option{-Wall} command-line option.
3800 @item -Wno-pragmas
3801 @opindex Wno-pragmas
3802 @opindex Wpragmas
3803 Do not warn about misuses of pragmas, such as incorrect parameters,
3804 invalid syntax, or conflicts between pragmas.  See also
3805 @option{-Wunknown-pragmas}.
3807 @item -Wstrict-aliasing
3808 @opindex Wstrict-aliasing
3809 @opindex Wno-strict-aliasing
3810 This option is only active when @option{-fstrict-aliasing} is active.
3811 It warns about code that might break the strict aliasing rules that the
3812 compiler is using for optimization.  The warning does not catch all
3813 cases, but does attempt to catch the more common pitfalls.  It is
3814 included in @option{-Wall}.
3815 It is equivalent to @option{-Wstrict-aliasing=3}
3817 @item -Wstrict-aliasing=n
3818 @opindex Wstrict-aliasing=n
3819 This option is only active when @option{-fstrict-aliasing} is active.
3820 It warns about code that might break the strict aliasing rules that the
3821 compiler is using for optimization.
3822 Higher levels correspond to higher accuracy (fewer false positives).
3823 Higher levels also correspond to more effort, similar to the way @option{-O} 
3824 works.
3825 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
3827 Level 1: Most aggressive, quick, least accurate.
3828 Possibly useful when higher levels
3829 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
3830 false negatives.  However, it has many false positives.
3831 Warns for all pointer conversions between possibly incompatible types,
3832 even if never dereferenced.  Runs in the front end only.
3834 Level 2: Aggressive, quick, not too precise.
3835 May still have many false positives (not as many as level 1 though),
3836 and few false negatives (but possibly more than level 1).
3837 Unlike level 1, it only warns when an address is taken.  Warns about
3838 incomplete types.  Runs in the front end only.
3840 Level 3 (default for @option{-Wstrict-aliasing}):
3841 Should have very few false positives and few false
3842 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3843 Takes care of the common pun+dereference pattern in the front end:
3844 @code{*(int*)&some_float}.
3845 If optimization is enabled, it also runs in the back end, where it deals
3846 with multiple statement cases using flow-sensitive points-to information.
3847 Only warns when the converted pointer is dereferenced.
3848 Does not warn about incomplete types.
3850 @item -Wstrict-overflow
3851 @itemx -Wstrict-overflow=@var{n}
3852 @opindex Wstrict-overflow
3853 @opindex Wno-strict-overflow
3854 This option is only active when @option{-fstrict-overflow} is active.
3855 It warns about cases where the compiler optimizes based on the
3856 assumption that signed overflow does not occur.  Note that it does not
3857 warn about all cases where the code might overflow: it only warns
3858 about cases where the compiler implements some optimization.  Thus
3859 this warning depends on the optimization level.
3861 An optimization that assumes that signed overflow does not occur is
3862 perfectly safe if the values of the variables involved are such that
3863 overflow never does, in fact, occur.  Therefore this warning can
3864 easily give a false positive: a warning about code that is not
3865 actually a problem.  To help focus on important issues, several
3866 warning levels are defined.  No warnings are issued for the use of
3867 undefined signed overflow when estimating how many iterations a loop
3868 requires, in particular when determining whether a loop will be
3869 executed at all.
3871 @table @gcctabopt
3872 @item -Wstrict-overflow=1
3873 Warn about cases that are both questionable and easy to avoid.  For
3874 example,  with @option{-fstrict-overflow}, the compiler simplifies
3875 @code{x + 1 > x} to @code{1}.  This level of
3876 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3877 are not, and must be explicitly requested.
3879 @item -Wstrict-overflow=2
3880 Also warn about other cases where a comparison is simplified to a
3881 constant.  For example: @code{abs (x) >= 0}.  This can only be
3882 simplified when @option{-fstrict-overflow} is in effect, because
3883 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3884 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3885 @option{-Wstrict-overflow=2}.
3887 @item -Wstrict-overflow=3
3888 Also warn about other cases where a comparison is simplified.  For
3889 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
3891 @item -Wstrict-overflow=4
3892 Also warn about other simplifications not covered by the above cases.
3893 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
3895 @item -Wstrict-overflow=5
3896 Also warn about cases where the compiler reduces the magnitude of a
3897 constant involved in a comparison.  For example: @code{x + 2 > y} is
3898 simplified to @code{x + 1 >= y}.  This is reported only at the
3899 highest warning level because this simplification applies to many
3900 comparisons, so this warning level gives a very large number of
3901 false positives.
3902 @end table
3904 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
3905 @opindex Wsuggest-attribute=
3906 @opindex Wno-suggest-attribute=
3907 Warn for cases where adding an attribute may be beneficial. The
3908 attributes currently supported are listed below.
3910 @table @gcctabopt
3911 @item -Wsuggest-attribute=pure
3912 @itemx -Wsuggest-attribute=const
3913 @itemx -Wsuggest-attribute=noreturn
3914 @opindex Wsuggest-attribute=pure
3915 @opindex Wno-suggest-attribute=pure
3916 @opindex Wsuggest-attribute=const
3917 @opindex Wno-suggest-attribute=const
3918 @opindex Wsuggest-attribute=noreturn
3919 @opindex Wno-suggest-attribute=noreturn
3921 Warn about functions that might be candidates for attributes
3922 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3923 functions visible in other compilation units or (in the case of @code{pure} and
3924 @code{const}) if it cannot prove that the function returns normally. A function
3925 returns normally if it doesn't contain an infinite loop or return abnormally
3926 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3927 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3928 higher.  Higher optimization levels improve the accuracy of the analysis.
3930 @item -Wsuggest-attribute=format
3931 @itemx -Wmissing-format-attribute
3932 @opindex Wsuggest-attribute=format
3933 @opindex Wmissing-format-attribute
3934 @opindex Wno-suggest-attribute=format
3935 @opindex Wno-missing-format-attribute
3936 @opindex Wformat
3937 @opindex Wno-format
3939 Warn about function pointers that might be candidates for @code{format}
3940 attributes.  Note these are only possible candidates, not absolute ones.
3941 GCC guesses that function pointers with @code{format} attributes that
3942 are used in assignment, initialization, parameter passing or return
3943 statements should have a corresponding @code{format} attribute in the
3944 resulting type.  I.e.@: the left-hand side of the assignment or
3945 initialization, the type of the parameter variable, or the return type
3946 of the containing function respectively should also have a @code{format}
3947 attribute to avoid the warning.
3949 GCC also warns about function definitions that might be
3950 candidates for @code{format} attributes.  Again, these are only
3951 possible candidates.  GCC guesses that @code{format} attributes
3952 might be appropriate for any function that calls a function like
3953 @code{vprintf} or @code{vscanf}, but this might not always be the
3954 case, and some functions for which @code{format} attributes are
3955 appropriate may not be detected.
3956 @end table
3958 @item -Warray-bounds
3959 @opindex Wno-array-bounds
3960 @opindex Warray-bounds
3961 This option is only active when @option{-ftree-vrp} is active
3962 (default for @option{-O2} and above). It warns about subscripts to arrays
3963 that are always out of bounds. This warning is enabled by @option{-Wall}.
3965 @item -Wno-div-by-zero
3966 @opindex Wno-div-by-zero
3967 @opindex Wdiv-by-zero
3968 Do not warn about compile-time integer division by zero.  Floating-point
3969 division by zero is not warned about, as it can be a legitimate way of
3970 obtaining infinities and NaNs.
3972 @item -Wsystem-headers
3973 @opindex Wsystem-headers
3974 @opindex Wno-system-headers
3975 @cindex warnings from system headers
3976 @cindex system headers, warnings from
3977 Print warning messages for constructs found in system header files.
3978 Warnings from system headers are normally suppressed, on the assumption
3979 that they usually do not indicate real problems and would only make the
3980 compiler output harder to read.  Using this command-line option tells
3981 GCC to emit warnings from system headers as if they occurred in user
3982 code.  However, note that using @option{-Wall} in conjunction with this
3983 option does @emph{not} warn about unknown pragmas in system
3984 headers---for that, @option{-Wunknown-pragmas} must also be used.
3986 @item -Wtrampolines
3987 @opindex Wtrampolines
3988 @opindex Wno-trampolines
3989  Warn about trampolines generated for pointers to nested functions.
3991  A trampoline is a small piece of data or code that is created at run
3992  time on the stack when the address of a nested function is taken, and
3993  is used to call the nested function indirectly.  For some targets, it
3994  is made up of data only and thus requires no special treatment.  But,
3995  for most targets, it is made up of code and thus requires the stack
3996  to be made executable in order for the program to work properly.
3998 @item -Wfloat-equal
3999 @opindex Wfloat-equal
4000 @opindex Wno-float-equal
4001 Warn if floating-point values are used in equality comparisons.
4003 The idea behind this is that sometimes it is convenient (for the
4004 programmer) to consider floating-point values as approximations to
4005 infinitely precise real numbers.  If you are doing this, then you need
4006 to compute (by analyzing the code, or in some other way) the maximum or
4007 likely maximum error that the computation introduces, and allow for it
4008 when performing comparisons (and when producing output, but that's a
4009 different problem).  In particular, instead of testing for equality, you
4010 should check to see whether the two values have ranges that overlap; and
4011 this is done with the relational operators, so equality comparisons are
4012 probably mistaken.
4014 @item -Wtraditional @r{(C and Objective-C only)}
4015 @opindex Wtraditional
4016 @opindex Wno-traditional
4017 Warn about certain constructs that behave differently in traditional and
4018 ISO C@.  Also warn about ISO C constructs that have no traditional C
4019 equivalent, and/or problematic constructs that should be avoided.
4021 @itemize @bullet
4022 @item
4023 Macro parameters that appear within string literals in the macro body.
4024 In traditional C macro replacement takes place within string literals,
4025 but in ISO C it does not.
4027 @item
4028 In traditional C, some preprocessor directives did not exist.
4029 Traditional preprocessors only considered a line to be a directive
4030 if the @samp{#} appeared in column 1 on the line.  Therefore
4031 @option{-Wtraditional} warns about directives that traditional C
4032 understands but ignores because the @samp{#} does not appear as the
4033 first character on the line.  It also suggests you hide directives like
4034 @samp{#pragma} not understood by traditional C by indenting them.  Some
4035 traditional implementations do not recognize @samp{#elif}, so this option
4036 suggests avoiding it altogether.
4038 @item
4039 A function-like macro that appears without arguments.
4041 @item
4042 The unary plus operator.
4044 @item
4045 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4046 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4047 constants.)  Note, these suffixes appear in macros defined in the system
4048 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4049 Use of these macros in user code might normally lead to spurious
4050 warnings, however GCC's integrated preprocessor has enough context to
4051 avoid warning in these cases.
4053 @item
4054 A function declared external in one block and then used after the end of
4055 the block.
4057 @item
4058 A @code{switch} statement has an operand of type @code{long}.
4060 @item
4061 A non-@code{static} function declaration follows a @code{static} one.
4062 This construct is not accepted by some traditional C compilers.
4064 @item
4065 The ISO type of an integer constant has a different width or
4066 signedness from its traditional type.  This warning is only issued if
4067 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4068 typically represent bit patterns, are not warned about.
4070 @item
4071 Usage of ISO string concatenation is detected.
4073 @item
4074 Initialization of automatic aggregates.
4076 @item
4077 Identifier conflicts with labels.  Traditional C lacks a separate
4078 namespace for labels.
4080 @item
4081 Initialization of unions.  If the initializer is zero, the warning is
4082 omitted.  This is done under the assumption that the zero initializer in
4083 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4084 initializer warnings and relies on default initialization to zero in the
4085 traditional C case.
4087 @item
4088 Conversions by prototypes between fixed/floating-point values and vice
4089 versa.  The absence of these prototypes when compiling with traditional
4090 C causes serious problems.  This is a subset of the possible
4091 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4093 @item
4094 Use of ISO C style function definitions.  This warning intentionally is
4095 @emph{not} issued for prototype declarations or variadic functions
4096 because these ISO C features appear in your code when using
4097 libiberty's traditional C compatibility macros, @code{PARAMS} and
4098 @code{VPARAMS}.  This warning is also bypassed for nested functions
4099 because that feature is already a GCC extension and thus not relevant to
4100 traditional C compatibility.
4101 @end itemize
4103 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4104 @opindex Wtraditional-conversion
4105 @opindex Wno-traditional-conversion
4106 Warn if a prototype causes a type conversion that is different from what
4107 would happen to the same argument in the absence of a prototype.  This
4108 includes conversions of fixed point to floating and vice versa, and
4109 conversions changing the width or signedness of a fixed-point argument
4110 except when the same as the default promotion.
4112 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4113 @opindex Wdeclaration-after-statement
4114 @opindex Wno-declaration-after-statement
4115 Warn when a declaration is found after a statement in a block.  This
4116 construct, known from C++, was introduced with ISO C99 and is by default
4117 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4118 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4120 @item -Wundef
4121 @opindex Wundef
4122 @opindex Wno-undef
4123 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4125 @item -Wno-endif-labels
4126 @opindex Wno-endif-labels
4127 @opindex Wendif-labels
4128 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4130 @item -Wshadow
4131 @opindex Wshadow
4132 @opindex Wno-shadow
4133 Warn whenever a local variable or type declaration shadows another variable,
4134 parameter, type, or class member (in C++), or whenever a built-in function
4135 is shadowed. Note that in C++, the compiler warns if a local variable
4136 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4138 @item -Wlarger-than=@var{len}
4139 @opindex Wlarger-than=@var{len}
4140 @opindex Wlarger-than-@var{len}
4141 Warn whenever an object of larger than @var{len} bytes is defined.
4143 @item -Wframe-larger-than=@var{len}
4144 @opindex Wframe-larger-than
4145 Warn if the size of a function frame is larger than @var{len} bytes.
4146 The computation done to determine the stack frame size is approximate
4147 and not conservative.
4148 The actual requirements may be somewhat greater than @var{len}
4149 even if you do not get a warning.  In addition, any space allocated
4150 via @code{alloca}, variable-length arrays, or related constructs
4151 is not included by the compiler when determining
4152 whether or not to issue a warning.
4154 @item -Wno-free-nonheap-object
4155 @opindex Wno-free-nonheap-object
4156 @opindex Wfree-nonheap-object
4157 Do not warn when attempting to free an object that was not allocated
4158 on the heap.
4160 @item -Wstack-usage=@var{len}
4161 @opindex Wstack-usage
4162 Warn if the stack usage of a function might be larger than @var{len} bytes.
4163 The computation done to determine the stack usage is conservative.
4164 Any space allocated via @code{alloca}, variable-length arrays, or related
4165 constructs is included by the compiler when determining whether or not to
4166 issue a warning.
4168 The message is in keeping with the output of @option{-fstack-usage}.
4170 @itemize
4171 @item
4172 If the stack usage is fully static but exceeds the specified amount, it's:
4174 @smallexample
4175   warning: stack usage is 1120 bytes
4176 @end smallexample
4177 @item
4178 If the stack usage is (partly) dynamic but bounded, it's:
4180 @smallexample
4181   warning: stack usage might be 1648 bytes
4182 @end smallexample
4183 @item
4184 If the stack usage is (partly) dynamic and not bounded, it's:
4186 @smallexample
4187   warning: stack usage might be unbounded
4188 @end smallexample
4189 @end itemize
4191 @item -Wunsafe-loop-optimizations
4192 @opindex Wunsafe-loop-optimizations
4193 @opindex Wno-unsafe-loop-optimizations
4194 Warn if the loop cannot be optimized because the compiler cannot
4195 assume anything on the bounds of the loop indices.  With
4196 @option{-funsafe-loop-optimizations} warn if the compiler makes
4197 such assumptions.
4199 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4200 @opindex Wno-pedantic-ms-format
4201 @opindex Wpedantic-ms-format
4202 When used in combination with @option{-Wformat}
4203 and @option{-pedantic} without GNU extensions, this option
4204 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4205 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4206 which depend on the MS runtime.
4208 @item -Wpointer-arith
4209 @opindex Wpointer-arith
4210 @opindex Wno-pointer-arith
4211 Warn about anything that depends on the ``size of'' a function type or
4212 of @code{void}.  GNU C assigns these types a size of 1, for
4213 convenience in calculations with @code{void *} pointers and pointers
4214 to functions.  In C++, warn also when an arithmetic operation involves
4215 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4217 @item -Wtype-limits
4218 @opindex Wtype-limits
4219 @opindex Wno-type-limits
4220 Warn if a comparison is always true or always false due to the limited
4221 range of the data type, but do not warn for constant expressions.  For
4222 example, warn if an unsigned variable is compared against zero with
4223 @samp{<} or @samp{>=}.  This warning is also enabled by
4224 @option{-Wextra}.
4226 @item -Wbad-function-cast @r{(C and Objective-C only)}
4227 @opindex Wbad-function-cast
4228 @opindex Wno-bad-function-cast
4229 Warn whenever a function call is cast to a non-matching type.
4230 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4232 @item -Wc++-compat @r{(C and Objective-C only)}
4233 Warn about ISO C constructs that are outside of the common subset of
4234 ISO C and ISO C++, e.g.@: request for implicit conversion from
4235 @code{void *} to a pointer to non-@code{void} type.
4237 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4238 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4239 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4240 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4241 enabled by @option{-Wall}.
4243 @item -Wcast-qual
4244 @opindex Wcast-qual
4245 @opindex Wno-cast-qual
4246 Warn whenever a pointer is cast so as to remove a type qualifier from
4247 the target type.  For example, warn if a @code{const char *} is cast
4248 to an ordinary @code{char *}.
4250 Also warn when making a cast that introduces a type qualifier in an
4251 unsafe way.  For example, casting @code{char **} to @code{const char **}
4252 is unsafe, as in this example:
4254 @smallexample
4255   /* p is char ** value.  */
4256   const char **q = (const char **) p;
4257   /* Assignment of readonly string to const char * is OK.  */
4258   *q = "string";
4259   /* Now char** pointer points to read-only memory.  */
4260   **p = 'b';
4261 @end smallexample
4263 @item -Wcast-align
4264 @opindex Wcast-align
4265 @opindex Wno-cast-align
4266 Warn whenever a pointer is cast such that the required alignment of the
4267 target is increased.  For example, warn if a @code{char *} is cast to
4268 an @code{int *} on machines where integers can only be accessed at
4269 two- or four-byte boundaries.
4271 @item -Wwrite-strings
4272 @opindex Wwrite-strings
4273 @opindex Wno-write-strings
4274 When compiling C, give string constants the type @code{const
4275 char[@var{length}]} so that copying the address of one into a
4276 non-@code{const} @code{char *} pointer produces a warning.  These
4277 warnings help you find at compile time code that can try to write
4278 into a string constant, but only if you have been very careful about
4279 using @code{const} in declarations and prototypes.  Otherwise, it is
4280 just a nuisance. This is why we did not make @option{-Wall} request
4281 these warnings.
4283 When compiling C++, warn about the deprecated conversion from string
4284 literals to @code{char *}.  This warning is enabled by default for C++
4285 programs.
4287 @item -Wclobbered
4288 @opindex Wclobbered
4289 @opindex Wno-clobbered
4290 Warn for variables that might be changed by @samp{longjmp} or
4291 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4293 @item -Wconversion
4294 @opindex Wconversion
4295 @opindex Wno-conversion
4296 Warn for implicit conversions that may alter a value. This includes
4297 conversions between real and integer, like @code{abs (x)} when
4298 @code{x} is @code{double}; conversions between signed and unsigned,
4299 like @code{unsigned ui = -1}; and conversions to smaller types, like
4300 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4301 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4302 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4303 conversions between signed and unsigned integers can be disabled by
4304 using @option{-Wno-sign-conversion}.
4306 For C++, also warn for confusing overload resolution for user-defined
4307 conversions; and conversions that never use a type conversion
4308 operator: conversions to @code{void}, the same type, a base class or a
4309 reference to them. Warnings about conversions between signed and
4310 unsigned integers are disabled by default in C++ unless
4311 @option{-Wsign-conversion} is explicitly enabled.
4313 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4314 @opindex Wconversion-null
4315 @opindex Wno-conversion-null
4316 Do not warn for conversions between @code{NULL} and non-pointer
4317 types. @option{-Wconversion-null} is enabled by default.
4319 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4320 @opindex Wzero-as-null-pointer-constant
4321 @opindex Wno-zero-as-null-pointer-constant
4322 Warn when a literal '0' is used as null pointer constant.  This can
4323 be useful to facilitate the conversion to @code{nullptr} in C++11.
4325 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4326 @opindex Wuseless-cast
4327 @opindex Wno-useless-cast
4328 Warn when an expression is casted to its own type.
4330 @item -Wempty-body
4331 @opindex Wempty-body
4332 @opindex Wno-empty-body
4333 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4334 while} statement.  This warning is also enabled by @option{-Wextra}.
4336 @item -Wenum-compare
4337 @opindex Wenum-compare
4338 @opindex Wno-enum-compare
4339 Warn about a comparison between values of different enumerated types.
4340 In C++ enumeral mismatches in conditional expressions are also
4341 diagnosed and the warning is enabled by default.  In C this warning is 
4342 enabled by @option{-Wall}.
4344 @item -Wjump-misses-init @r{(C, Objective-C only)}
4345 @opindex Wjump-misses-init
4346 @opindex Wno-jump-misses-init
4347 Warn if a @code{goto} statement or a @code{switch} statement jumps
4348 forward across the initialization of a variable, or jumps backward to a
4349 label after the variable has been initialized.  This only warns about
4350 variables that are initialized when they are declared.  This warning is
4351 only supported for C and Objective-C; in C++ this sort of branch is an
4352 error in any case.
4354 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4355 can be disabled with the @option{-Wno-jump-misses-init} option.
4357 @item -Wsign-compare
4358 @opindex Wsign-compare
4359 @opindex Wno-sign-compare
4360 @cindex warning for comparison of signed and unsigned values
4361 @cindex comparison of signed and unsigned values, warning
4362 @cindex signed and unsigned values, comparison warning
4363 Warn when a comparison between signed and unsigned values could produce
4364 an incorrect result when the signed value is converted to unsigned.
4365 This warning is also enabled by @option{-Wextra}; to get the other warnings
4366 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4368 @item -Wsign-conversion
4369 @opindex Wsign-conversion
4370 @opindex Wno-sign-conversion
4371 Warn for implicit conversions that may change the sign of an integer
4372 value, like assigning a signed integer expression to an unsigned
4373 integer variable. An explicit cast silences the warning. In C, this
4374 option is enabled also by @option{-Wconversion}.
4376 @item -Wsizeof-pointer-memaccess
4377 @opindex Wsizeof-pointer-memaccess
4378 @opindex Wno-sizeof-pointer-memaccess
4379 Warn for suspicious length parameters to certain string and memory built-in
4380 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4381 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4382 but a pointer, and suggests a possible fix, or about
4383 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4384 @option{-Wall}.
4386 @item -Waddress
4387 @opindex Waddress
4388 @opindex Wno-address
4389 Warn about suspicious uses of memory addresses. These include using
4390 the address of a function in a conditional expression, such as
4391 @code{void func(void); if (func)}, and comparisons against the memory
4392 address of a string literal, such as @code{if (x == "abc")}.  Such
4393 uses typically indicate a programmer error: the address of a function
4394 always evaluates to true, so their use in a conditional usually
4395 indicate that the programmer forgot the parentheses in a function
4396 call; and comparisons against string literals result in unspecified
4397 behavior and are not portable in C, so they usually indicate that the
4398 programmer intended to use @code{strcmp}.  This warning is enabled by
4399 @option{-Wall}.
4401 @item -Wlogical-op
4402 @opindex Wlogical-op
4403 @opindex Wno-logical-op
4404 Warn about suspicious uses of logical operators in expressions.
4405 This includes using logical operators in contexts where a
4406 bit-wise operator is likely to be expected.
4408 @item -Waggregate-return
4409 @opindex Waggregate-return
4410 @opindex Wno-aggregate-return
4411 Warn if any functions that return structures or unions are defined or
4412 called.  (In languages where you can return an array, this also elicits
4413 a warning.)
4415 @item -Wno-attributes
4416 @opindex Wno-attributes
4417 @opindex Wattributes
4418 Do not warn if an unexpected @code{__attribute__} is used, such as
4419 unrecognized attributes, function attributes applied to variables,
4420 etc.  This does not stop errors for incorrect use of supported
4421 attributes.
4423 @item -Wno-builtin-macro-redefined
4424 @opindex Wno-builtin-macro-redefined
4425 @opindex Wbuiltin-macro-redefined
4426 Do not warn if certain built-in macros are redefined.  This suppresses
4427 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4428 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4430 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4431 @opindex Wstrict-prototypes
4432 @opindex Wno-strict-prototypes
4433 Warn if a function is declared or defined without specifying the
4434 argument types.  (An old-style function definition is permitted without
4435 a warning if preceded by a declaration that specifies the argument
4436 types.)
4438 @item -Wold-style-declaration @r{(C and Objective-C only)}
4439 @opindex Wold-style-declaration
4440 @opindex Wno-old-style-declaration
4441 Warn for obsolescent usages, according to the C Standard, in a
4442 declaration. For example, warn if storage-class specifiers like
4443 @code{static} are not the first things in a declaration.  This warning
4444 is also enabled by @option{-Wextra}.
4446 @item -Wold-style-definition @r{(C and Objective-C only)}
4447 @opindex Wold-style-definition
4448 @opindex Wno-old-style-definition
4449 Warn if an old-style function definition is used.  A warning is given
4450 even if there is a previous prototype.
4452 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4453 @opindex Wmissing-parameter-type
4454 @opindex Wno-missing-parameter-type
4455 A function parameter is declared without a type specifier in K&R-style
4456 functions:
4458 @smallexample
4459 void foo(bar) @{ @}
4460 @end smallexample
4462 This warning is also enabled by @option{-Wextra}.
4464 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4465 @opindex Wmissing-prototypes
4466 @opindex Wno-missing-prototypes
4467 Warn if a global function is defined without a previous prototype
4468 declaration.  This warning is issued even if the definition itself
4469 provides a prototype.  Use this option to detect global functions
4470 that do not have a matching prototype declaration in a header file.
4471 This option is not valid for C++ because all function declarations
4472 provide prototypes and a non-matching declaration will declare an
4473 overload rather than conflict with an earlier declaration.
4474 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4476 @item -Wmissing-declarations
4477 @opindex Wmissing-declarations
4478 @opindex Wno-missing-declarations
4479 Warn if a global function is defined without a previous declaration.
4480 Do so even if the definition itself provides a prototype.
4481 Use this option to detect global functions that are not declared in
4482 header files.  In C, no warnings are issued for functions with previous
4483 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4484 missing prototypes.  In C++, no warnings are issued for function templates,
4485 or for inline functions, or for functions in anonymous namespaces.
4487 @item -Wmissing-field-initializers
4488 @opindex Wmissing-field-initializers
4489 @opindex Wno-missing-field-initializers
4490 @opindex W
4491 @opindex Wextra
4492 @opindex Wno-extra
4493 Warn if a structure's initializer has some fields missing.  For
4494 example, the following code causes such a warning, because
4495 @code{x.h} is implicitly zero:
4497 @smallexample
4498 struct s @{ int f, g, h; @};
4499 struct s x = @{ 3, 4 @};
4500 @end smallexample
4502 This option does not warn about designated initializers, so the following
4503 modification does not trigger a warning:
4505 @smallexample
4506 struct s @{ int f, g, h; @};
4507 struct s x = @{ .f = 3, .g = 4 @};
4508 @end smallexample
4510 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4511 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4513 @item -Wno-multichar
4514 @opindex Wno-multichar
4515 @opindex Wmultichar
4516 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4517 Usually they indicate a typo in the user's code, as they have
4518 implementation-defined values, and should not be used in portable code.
4520 @item -Wnormalized=<none|id|nfc|nfkc>
4521 @opindex Wnormalized=
4522 @cindex NFC
4523 @cindex NFKC
4524 @cindex character set, input normalization
4525 In ISO C and ISO C++, two identifiers are different if they are
4526 different sequences of characters.  However, sometimes when characters
4527 outside the basic ASCII character set are used, you can have two
4528 different character sequences that look the same.  To avoid confusion,
4529 the ISO 10646 standard sets out some @dfn{normalization rules} which
4530 when applied ensure that two sequences that look the same are turned into
4531 the same sequence.  GCC can warn you if you are using identifiers that
4532 have not been normalized; this option controls that warning.
4534 There are four levels of warning supported by GCC@.  The default is
4535 @option{-Wnormalized=nfc}, which warns about any identifier that is
4536 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4537 recommended form for most uses.
4539 Unfortunately, there are some characters allowed in identifiers by
4540 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4541 identifiers.  That is, there's no way to use these symbols in portable
4542 ISO C or C++ and have all your identifiers in NFC@.
4543 @option{-Wnormalized=id} suppresses the warning for these characters.
4544 It is hoped that future versions of the standards involved will correct
4545 this, which is why this option is not the default.
4547 You can switch the warning off for all characters by writing
4548 @option{-Wnormalized=none}.  You should only do this if you
4549 are using some other normalization scheme (like ``D''), because
4550 otherwise you can easily create bugs that are literally impossible to see.
4552 Some characters in ISO 10646 have distinct meanings but look identical
4553 in some fonts or display methodologies, especially once formatting has
4554 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4555 LETTER N'', displays just like a regular @code{n} that has been
4556 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4557 normalization scheme to convert all these into a standard form as
4558 well, and GCC warns if your code is not in NFKC if you use
4559 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4560 about every identifier that contains the letter O because it might be
4561 confused with the digit 0, and so is not the default, but may be
4562 useful as a local coding convention if the programming environment 
4563 cannot be fixed to display these characters distinctly.
4565 @item -Wno-deprecated
4566 @opindex Wno-deprecated
4567 @opindex Wdeprecated
4568 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4570 @item -Wno-deprecated-declarations
4571 @opindex Wno-deprecated-declarations
4572 @opindex Wdeprecated-declarations
4573 Do not warn about uses of functions (@pxref{Function Attributes}),
4574 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4575 Attributes}) marked as deprecated by using the @code{deprecated}
4576 attribute.
4578 @item -Wno-overflow
4579 @opindex Wno-overflow
4580 @opindex Woverflow
4581 Do not warn about compile-time overflow in constant expressions.
4583 @item -Woverride-init @r{(C and Objective-C only)}
4584 @opindex Woverride-init
4585 @opindex Wno-override-init
4586 @opindex W
4587 @opindex Wextra
4588 @opindex Wno-extra
4589 Warn if an initialized field without side effects is overridden when
4590 using designated initializers (@pxref{Designated Inits, , Designated
4591 Initializers}).
4593 This warning is included in @option{-Wextra}.  To get other
4594 @option{-Wextra} warnings without this one, use @option{-Wextra
4595 -Wno-override-init}.
4597 @item -Wpacked
4598 @opindex Wpacked
4599 @opindex Wno-packed
4600 Warn if a structure is given the packed attribute, but the packed
4601 attribute has no effect on the layout or size of the structure.
4602 Such structures may be mis-aligned for little benefit.  For
4603 instance, in this code, the variable @code{f.x} in @code{struct bar}
4604 is misaligned even though @code{struct bar} does not itself
4605 have the packed attribute:
4607 @smallexample
4608 @group
4609 struct foo @{
4610   int x;
4611   char a, b, c, d;
4612 @} __attribute__((packed));
4613 struct bar @{
4614   char z;
4615   struct foo f;
4617 @end group
4618 @end smallexample
4620 @item -Wpacked-bitfield-compat
4621 @opindex Wpacked-bitfield-compat
4622 @opindex Wno-packed-bitfield-compat
4623 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4624 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4625 the change can lead to differences in the structure layout.  GCC
4626 informs you when the offset of such a field has changed in GCC 4.4.
4627 For example there is no longer a 4-bit padding between field @code{a}
4628 and @code{b} in this structure:
4630 @smallexample
4631 struct foo
4633   char a:4;
4634   char b:8;
4635 @} __attribute__ ((packed));
4636 @end smallexample
4638 This warning is enabled by default.  Use
4639 @option{-Wno-packed-bitfield-compat} to disable this warning.
4641 @item -Wpadded
4642 @opindex Wpadded
4643 @opindex Wno-padded
4644 Warn if padding is included in a structure, either to align an element
4645 of the structure or to align the whole structure.  Sometimes when this
4646 happens it is possible to rearrange the fields of the structure to
4647 reduce the padding and so make the structure smaller.
4649 @item -Wredundant-decls
4650 @opindex Wredundant-decls
4651 @opindex Wno-redundant-decls
4652 Warn if anything is declared more than once in the same scope, even in
4653 cases where multiple declaration is valid and changes nothing.
4655 @item -Wnested-externs @r{(C and Objective-C only)}
4656 @opindex Wnested-externs
4657 @opindex Wno-nested-externs
4658 Warn if an @code{extern} declaration is encountered within a function.
4660 @item -Wno-inherited-variadic-ctor
4661 @opindex Winherited-variadic-ctor
4662 @opindex Wno-inherited-variadic-ctor
4663 Suppress warnings about use of C++11 inheriting constructors when the
4664 base class inherited from has a C variadic constructor; the warning is
4665 on by default because the ellipsis is not inherited.
4667 @item -Winline
4668 @opindex Winline
4669 @opindex Wno-inline
4670 Warn if a function that is declared as inline cannot be inlined.
4671 Even with this option, the compiler does not warn about failures to
4672 inline functions declared in system headers.
4674 The compiler uses a variety of heuristics to determine whether or not
4675 to inline a function.  For example, the compiler takes into account
4676 the size of the function being inlined and the amount of inlining
4677 that has already been done in the current function.  Therefore,
4678 seemingly insignificant changes in the source program can cause the
4679 warnings produced by @option{-Winline} to appear or disappear.
4681 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4682 @opindex Wno-invalid-offsetof
4683 @opindex Winvalid-offsetof
4684 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4685 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4686 to a non-POD type is undefined.  In existing C++ implementations,
4687 however, @samp{offsetof} typically gives meaningful results even when
4688 applied to certain kinds of non-POD types (such as a simple
4689 @samp{struct} that fails to be a POD type only by virtue of having a
4690 constructor).  This flag is for users who are aware that they are
4691 writing nonportable code and who have deliberately chosen to ignore the
4692 warning about it.
4694 The restrictions on @samp{offsetof} may be relaxed in a future version
4695 of the C++ standard.
4697 @item -Wno-int-to-pointer-cast
4698 @opindex Wno-int-to-pointer-cast
4699 @opindex Wint-to-pointer-cast
4700 Suppress warnings from casts to pointer type of an integer of a
4701 different size. In C++, casting to a pointer type of smaller size is
4702 an error. @option{Wint-to-pointer-cast} is enabled by default.
4705 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4706 @opindex Wno-pointer-to-int-cast
4707 @opindex Wpointer-to-int-cast
4708 Suppress warnings from casts from a pointer to an integer type of a
4709 different size.
4711 @item -Winvalid-pch
4712 @opindex Winvalid-pch
4713 @opindex Wno-invalid-pch
4714 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4715 the search path but can't be used.
4717 @item -Wlong-long
4718 @opindex Wlong-long
4719 @opindex Wno-long-long
4720 Warn if @samp{long long} type is used.  This is enabled by either
4721 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4722 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4724 @item -Wvariadic-macros
4725 @opindex Wvariadic-macros
4726 @opindex Wno-variadic-macros
4727 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4728 alternate syntax when in pedantic ISO C99 mode.  This is default.
4729 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4731 @item -Wvarargs
4732 @opindex Wvarargs
4733 @opindex Wno-varargs
4734 Warn upon questionable usage of the macros used to handle variable
4735 arguments like @samp{va_start}.  This is default.  To inhibit the
4736 warning messages, use @option{-Wno-varargs}.
4738 @item -Wvector-operation-performance
4739 @opindex Wvector-operation-performance
4740 @opindex Wno-vector-operation-performance
4741 Warn if vector operation is not implemented via SIMD capabilities of the
4742 architecture.  Mainly useful for the performance tuning.
4743 Vector operation can be implemented @code{piecewise}, which means that the
4744 scalar operation is performed on every vector element; 
4745 @code{in parallel}, which means that the vector operation is implemented
4746 using scalars of wider type, which normally is more performance efficient;
4747 and @code{as a single scalar}, which means that vector fits into a
4748 scalar type.
4750 @item -Wno-virtual-move-assign
4751 @opindex Wvirtual-move-assign
4752 @opindex Wno-virtual-move-assign
4753 Suppress warnings about inheriting from a virtual base with a
4754 non-trivial C++11 move assignment operator.  This is dangerous because
4755 if the virtual base is reachable along more than one path, it will be
4756 moved multiple times, which can mean both objects end up in the
4757 moved-from state.  If the move assignment operator is written to avoid
4758 moving from a moved-from object, this warning can be disabled.
4760 @item -Wvla
4761 @opindex Wvla
4762 @opindex Wno-vla
4763 Warn if variable length array is used in the code.
4764 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4765 the variable length array.
4767 @item -Wvolatile-register-var
4768 @opindex Wvolatile-register-var
4769 @opindex Wno-volatile-register-var
4770 Warn if a register variable is declared volatile.  The volatile
4771 modifier does not inhibit all optimizations that may eliminate reads
4772 and/or writes to register variables.  This warning is enabled by
4773 @option{-Wall}.
4775 @item -Wdisabled-optimization
4776 @opindex Wdisabled-optimization
4777 @opindex Wno-disabled-optimization
4778 Warn if a requested optimization pass is disabled.  This warning does
4779 not generally indicate that there is anything wrong with your code; it
4780 merely indicates that GCC's optimizers are unable to handle the code
4781 effectively.  Often, the problem is that your code is too big or too
4782 complex; GCC refuses to optimize programs when the optimization
4783 itself is likely to take inordinate amounts of time.
4785 @item -Wpointer-sign @r{(C and Objective-C only)}
4786 @opindex Wpointer-sign
4787 @opindex Wno-pointer-sign
4788 Warn for pointer argument passing or assignment with different signedness.
4789 This option is only supported for C and Objective-C@.  It is implied by
4790 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
4791 @option{-Wno-pointer-sign}.
4793 @item -Wstack-protector
4794 @opindex Wstack-protector
4795 @opindex Wno-stack-protector
4796 This option is only active when @option{-fstack-protector} is active.  It
4797 warns about functions that are not protected against stack smashing.
4799 @item -Wno-mudflap
4800 @opindex Wno-mudflap
4801 Suppress warnings about constructs that cannot be instrumented by
4802 @option{-fmudflap}.
4804 @item -Woverlength-strings
4805 @opindex Woverlength-strings
4806 @opindex Wno-overlength-strings
4807 Warn about string constants that are longer than the ``minimum
4808 maximum'' length specified in the C standard.  Modern compilers
4809 generally allow string constants that are much longer than the
4810 standard's minimum limit, but very portable programs should avoid
4811 using longer strings.
4813 The limit applies @emph{after} string constant concatenation, and does
4814 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4815 C99, it was raised to 4095.  C++98 does not specify a normative
4816 minimum maximum, so we do not diagnose overlength strings in C++@.
4818 This option is implied by @option{-Wpedantic}, and can be disabled with
4819 @option{-Wno-overlength-strings}.
4821 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4822 @opindex Wunsuffixed-float-constants
4824 Issue a warning for any floating constant that does not have
4825 a suffix.  When used together with @option{-Wsystem-headers} it
4826 warns about such constants in system header files.  This can be useful
4827 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4828 from the decimal floating-point extension to C99.
4829 @end table
4831 @node Debugging Options
4832 @section Options for Debugging Your Program or GCC
4833 @cindex options, debugging
4834 @cindex debugging information options
4836 GCC has various special options that are used for debugging
4837 either your program or GCC:
4839 @table @gcctabopt
4840 @item -g
4841 @opindex g
4842 Produce debugging information in the operating system's native format
4843 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4844 information.
4846 On most systems that use stabs format, @option{-g} enables use of extra
4847 debugging information that only GDB can use; this extra information
4848 makes debugging work better in GDB but probably makes other debuggers
4849 crash or
4850 refuse to read the program.  If you want to control for certain whether
4851 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4852 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4854 GCC allows you to use @option{-g} with
4855 @option{-O}.  The shortcuts taken by optimized code may occasionally
4856 produce surprising results: some variables you declared may not exist
4857 at all; flow of control may briefly move where you did not expect it;
4858 some statements may not be executed because they compute constant
4859 results or their values are already at hand; some statements may
4860 execute in different places because they have been moved out of loops.
4862 Nevertheless it proves possible to debug optimized output.  This makes
4863 it reasonable to use the optimizer for programs that might have bugs.
4865 The following options are useful when GCC is generated with the
4866 capability for more than one debugging format.
4868 @item -gsplit-dwarf
4869 @opindex gsplit-dwarf
4870 Separate as much dwarf debugging information as possible into a
4871 separate output file with the extension .dwo.  This option allows
4872 the build system to avoid linking files with debug information.  To
4873 be useful, this option requires a debugger capable of reading .dwo
4874 files.
4876 @item -ggdb
4877 @opindex ggdb
4878 Produce debugging information for use by GDB@.  This means to use the
4879 most expressive format available (DWARF 2, stabs, or the native format
4880 if neither of those are supported), including GDB extensions if at all
4881 possible.
4883 @item -gpubnames
4884 @opindex gpubnames
4885 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
4887 @item -gstabs
4888 @opindex gstabs
4889 Produce debugging information in stabs format (if that is supported),
4890 without GDB extensions.  This is the format used by DBX on most BSD
4891 systems.  On MIPS, Alpha and System V Release 4 systems this option
4892 produces stabs debugging output that is not understood by DBX or SDB@.
4893 On System V Release 4 systems this option requires the GNU assembler.
4895 @item -feliminate-unused-debug-symbols
4896 @opindex feliminate-unused-debug-symbols
4897 Produce debugging information in stabs format (if that is supported),
4898 for only symbols that are actually used.
4900 @item -femit-class-debug-always
4901 Instead of emitting debugging information for a C++ class in only one
4902 object file, emit it in all object files using the class.  This option
4903 should be used only with debuggers that are unable to handle the way GCC
4904 normally emits debugging information for classes because using this
4905 option increases the size of debugging information by as much as a
4906 factor of two.
4908 @item -fdebug-types-section
4909 @opindex fdebug-types-section
4910 @opindex fno-debug-types-section
4911 When using DWARF Version 4 or higher, type DIEs can be put into
4912 their own @code{.debug_types} section instead of making them part of the
4913 @code{.debug_info} section.  It is more efficient to put them in a separate
4914 comdat sections since the linker can then remove duplicates.
4915 But not all DWARF consumers support @code{.debug_types} sections yet
4916 and on some objects @code{.debug_types} produces larger instead of smaller
4917 debugging information.
4919 @item -gstabs+
4920 @opindex gstabs+
4921 Produce debugging information in stabs format (if that is supported),
4922 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4923 use of these extensions is likely to make other debuggers crash or
4924 refuse to read the program.
4926 @item -gcoff
4927 @opindex gcoff
4928 Produce debugging information in COFF format (if that is supported).
4929 This is the format used by SDB on most System V systems prior to
4930 System V Release 4.
4932 @item -gxcoff
4933 @opindex gxcoff
4934 Produce debugging information in XCOFF format (if that is supported).
4935 This is the format used by the DBX debugger on IBM RS/6000 systems.
4937 @item -gxcoff+
4938 @opindex gxcoff+
4939 Produce debugging information in XCOFF format (if that is supported),
4940 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4941 use of these extensions is likely to make other debuggers crash or
4942 refuse to read the program, and may cause assemblers other than the GNU
4943 assembler (GAS) to fail with an error.
4945 @item -gdwarf-@var{version}
4946 @opindex gdwarf-@var{version}
4947 Produce debugging information in DWARF format (if that is supported).
4948 The value of @var{version} may be either 2, 3 or 4; the default version
4949 for most targets is 4.
4951 Note that with DWARF Version 2, some ports require and always
4952 use some non-conflicting DWARF 3 extensions in the unwind tables.
4954 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4955 for maximum benefit.
4957 @item -grecord-gcc-switches
4958 @opindex grecord-gcc-switches
4959 This switch causes the command-line options used to invoke the
4960 compiler that may affect code generation to be appended to the
4961 DW_AT_producer attribute in DWARF debugging information.  The options
4962 are concatenated with spaces separating them from each other and from
4963 the compiler version.  See also @option{-frecord-gcc-switches} for another
4964 way of storing compiler options into the object file.  This is the default.
4966 @item -gno-record-gcc-switches
4967 @opindex gno-record-gcc-switches
4968 Disallow appending command-line options to the DW_AT_producer attribute
4969 in DWARF debugging information.
4971 @item -gstrict-dwarf
4972 @opindex gstrict-dwarf
4973 Disallow using extensions of later DWARF standard version than selected
4974 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4975 DWARF extensions from later standard versions is allowed.
4977 @item -gno-strict-dwarf
4978 @opindex gno-strict-dwarf
4979 Allow using extensions of later DWARF standard version than selected with
4980 @option{-gdwarf-@var{version}}.
4982 @item -gvms
4983 @opindex gvms
4984 Produce debugging information in Alpha/VMS debug format (if that is
4985 supported).  This is the format used by DEBUG on Alpha/VMS systems.
4987 @item -g@var{level}
4988 @itemx -ggdb@var{level}
4989 @itemx -gstabs@var{level}
4990 @itemx -gcoff@var{level}
4991 @itemx -gxcoff@var{level}
4992 @itemx -gvms@var{level}
4993 Request debugging information and also use @var{level} to specify how
4994 much information.  The default level is 2.
4996 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4997 @option{-g}.
4999 Level 1 produces minimal information, enough for making backtraces in
5000 parts of the program that you don't plan to debug.  This includes
5001 descriptions of functions and external variables, but no information
5002 about local variables and no line numbers.
5004 Level 3 includes extra information, such as all the macro definitions
5005 present in the program.  Some debuggers support macro expansion when
5006 you use @option{-g3}.
5008 @option{-gdwarf-2} does not accept a concatenated debug level, because
5009 GCC used to support an option @option{-gdwarf} that meant to generate
5010 debug information in version 1 of the DWARF format (which is very
5011 different from version 2), and it would have been too confusing.  That
5012 debug format is long obsolete, but the option cannot be changed now.
5013 Instead use an additional @option{-g@var{level}} option to change the
5014 debug level for DWARF.
5016 @item -gtoggle
5017 @opindex gtoggle
5018 Turn off generation of debug info, if leaving out this option
5019 generates it, or turn it on at level 2 otherwise.  The position of this
5020 argument in the command line does not matter; it takes effect after all
5021 other options are processed, and it does so only once, no matter how
5022 many times it is given.  This is mainly intended to be used with
5023 @option{-fcompare-debug}.
5025 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5026 @opindex fdump-final-insns
5027 Dump the final internal representation (RTL) to @var{file}.  If the
5028 optional argument is omitted (or if @var{file} is @code{.}), the name
5029 of the dump file is determined by appending @code{.gkd} to the
5030 compilation output file name.
5032 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5033 @opindex fcompare-debug
5034 @opindex fno-compare-debug
5035 If no error occurs during compilation, run the compiler a second time,
5036 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5037 passed to the second compilation.  Dump the final internal
5038 representation in both compilations, and print an error if they differ.
5040 If the equal sign is omitted, the default @option{-gtoggle} is used.
5042 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5043 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5044 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5045 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5046 is used.
5048 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5049 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5050 of the final representation and the second compilation, preventing even
5051 @env{GCC_COMPARE_DEBUG} from taking effect.
5053 To verify full coverage during @option{-fcompare-debug} testing, set
5054 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5055 which GCC rejects as an invalid option in any actual compilation
5056 (rather than preprocessing, assembly or linking).  To get just a
5057 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5058 not overridden} will do.
5060 @item -fcompare-debug-second
5061 @opindex fcompare-debug-second
5062 This option is implicitly passed to the compiler for the second
5063 compilation requested by @option{-fcompare-debug}, along with options to
5064 silence warnings, and omitting other options that would cause
5065 side-effect compiler outputs to files or to the standard output.  Dump
5066 files and preserved temporary files are renamed so as to contain the
5067 @code{.gk} additional extension during the second compilation, to avoid
5068 overwriting those generated by the first.
5070 When this option is passed to the compiler driver, it causes the
5071 @emph{first} compilation to be skipped, which makes it useful for little
5072 other than debugging the compiler proper.
5074 @item -feliminate-dwarf2-dups
5075 @opindex feliminate-dwarf2-dups
5076 Compress DWARF 2 debugging information by eliminating duplicated
5077 information about each symbol.  This option only makes sense when
5078 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5080 @item -femit-struct-debug-baseonly
5081 Emit debug information for struct-like types
5082 only when the base name of the compilation source file
5083 matches the base name of file in which the struct is defined.
5085 This option substantially reduces the size of debugging information,
5086 but at significant potential loss in type information to the debugger.
5087 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5088 See @option{-femit-struct-debug-detailed} for more detailed control.
5090 This option works only with DWARF 2.
5092 @item -femit-struct-debug-reduced
5093 Emit debug information for struct-like types
5094 only when the base name of the compilation source file
5095 matches the base name of file in which the type is defined,
5096 unless the struct is a template or defined in a system header.
5098 This option significantly reduces the size of debugging information,
5099 with some potential loss in type information to the debugger.
5100 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5101 See @option{-femit-struct-debug-detailed} for more detailed control.
5103 This option works only with DWARF 2.
5105 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5106 Specify the struct-like types
5107 for which the compiler generates debug information.
5108 The intent is to reduce duplicate struct debug information
5109 between different object files within the same program.
5111 This option is a detailed version of
5112 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5113 which serves for most needs.
5115 A specification has the syntax@*
5116 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5118 The optional first word limits the specification to
5119 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5120 A struct type is used directly when it is the type of a variable, member.
5121 Indirect uses arise through pointers to structs.
5122 That is, when use of an incomplete struct is valid, the use is indirect.
5123 An example is
5124 @samp{struct one direct; struct two * indirect;}.
5126 The optional second word limits the specification to
5127 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5128 Generic structs are a bit complicated to explain.
5129 For C++, these are non-explicit specializations of template classes,
5130 or non-template classes within the above.
5131 Other programming languages have generics,
5132 but @option{-femit-struct-debug-detailed} does not yet implement them.
5134 The third word specifies the source files for those
5135 structs for which the compiler should emit debug information.
5136 The values @samp{none} and @samp{any} have the normal meaning.
5137 The value @samp{base} means that
5138 the base of name of the file in which the type declaration appears
5139 must match the base of the name of the main compilation file.
5140 In practice, this means that when compiling @file{foo.c}, debug information
5141 is generated for types declared in that file and @file{foo.h},
5142 but not other header files.
5143 The value @samp{sys} means those types satisfying @samp{base}
5144 or declared in system or compiler headers.
5146 You may need to experiment to determine the best settings for your application.
5148 The default is @option{-femit-struct-debug-detailed=all}.
5150 This option works only with DWARF 2.
5152 @item -fno-merge-debug-strings
5153 @opindex fmerge-debug-strings
5154 @opindex fno-merge-debug-strings
5155 Direct the linker to not merge together strings in the debugging
5156 information that are identical in different object files.  Merging is
5157 not supported by all assemblers or linkers.  Merging decreases the size
5158 of the debug information in the output file at the cost of increasing
5159 link processing time.  Merging is enabled by default.
5161 @item -fdebug-prefix-map=@var{old}=@var{new}
5162 @opindex fdebug-prefix-map
5163 When compiling files in directory @file{@var{old}}, record debugging
5164 information describing them as in @file{@var{new}} instead.
5166 @item -fno-dwarf2-cfi-asm
5167 @opindex fdwarf2-cfi-asm
5168 @opindex fno-dwarf2-cfi-asm
5169 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5170 instead of using GAS @code{.cfi_*} directives.
5172 @cindex @command{prof}
5173 @item -p
5174 @opindex p
5175 Generate extra code to write profile information suitable for the
5176 analysis program @command{prof}.  You must use this option when compiling
5177 the source files you want data about, and you must also use it when
5178 linking.
5180 @cindex @command{gprof}
5181 @item -pg
5182 @opindex pg
5183 Generate extra code to write profile information suitable for the
5184 analysis program @command{gprof}.  You must use this option when compiling
5185 the source files you want data about, and you must also use it when
5186 linking.
5188 @item -Q
5189 @opindex Q
5190 Makes the compiler print out each function name as it is compiled, and
5191 print some statistics about each pass when it finishes.
5193 @item -ftime-report
5194 @opindex ftime-report
5195 Makes the compiler print some statistics about the time consumed by each
5196 pass when it finishes.
5198 @item -fmem-report
5199 @opindex fmem-report
5200 Makes the compiler print some statistics about permanent memory
5201 allocation when it finishes.
5203 @item -fmem-report-wpa
5204 @opindex fmem-report-wpa
5205 Makes the compiler print some statistics about permanent memory
5206 allocation for the WPA phase only.
5208 @item -fpre-ipa-mem-report
5209 @opindex fpre-ipa-mem-report
5210 @item -fpost-ipa-mem-report
5211 @opindex fpost-ipa-mem-report
5212 Makes the compiler print some statistics about permanent memory
5213 allocation before or after interprocedural optimization.
5215 @item -fprofile-report
5216 @opindex fprofile-report
5217 Makes the compiler print some statistics about consistency of the
5218 (estimated) profile and effect of individual passes.
5220 @item -fstack-usage
5221 @opindex fstack-usage
5222 Makes the compiler output stack usage information for the program, on a
5223 per-function basis.  The filename for the dump is made by appending
5224 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5225 the output file, if explicitly specified and it is not an executable,
5226 otherwise it is the basename of the source file.  An entry is made up
5227 of three fields:
5229 @itemize
5230 @item
5231 The name of the function.
5232 @item
5233 A number of bytes.
5234 @item
5235 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5236 @end itemize
5238 The qualifier @code{static} means that the function manipulates the stack
5239 statically: a fixed number of bytes are allocated for the frame on function
5240 entry and released on function exit; no stack adjustments are otherwise made
5241 in the function.  The second field is this fixed number of bytes.
5243 The qualifier @code{dynamic} means that the function manipulates the stack
5244 dynamically: in addition to the static allocation described above, stack
5245 adjustments are made in the body of the function, for example to push/pop
5246 arguments around function calls.  If the qualifier @code{bounded} is also
5247 present, the amount of these adjustments is bounded at compile time and
5248 the second field is an upper bound of the total amount of stack used by
5249 the function.  If it is not present, the amount of these adjustments is
5250 not bounded at compile time and the second field only represents the
5251 bounded part.
5253 @item -fprofile-arcs
5254 @opindex fprofile-arcs
5255 Add code so that program flow @dfn{arcs} are instrumented.  During
5256 execution the program records how many times each branch and call is
5257 executed and how many times it is taken or returns.  When the compiled
5258 program exits it saves this data to a file called
5259 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5260 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5261 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5262 @var{auxname} is generated from the name of the output file, if
5263 explicitly specified and it is not the final executable, otherwise it is
5264 the basename of the source file.  In both cases any suffix is removed
5265 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5266 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5267 @xref{Cross-profiling}.
5269 @cindex @command{gcov}
5270 @item --coverage
5271 @opindex coverage
5273 This option is used to compile and link code instrumented for coverage
5274 analysis.  The option is a synonym for @option{-fprofile-arcs}
5275 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5276 linking).  See the documentation for those options for more details.
5278 @itemize
5280 @item
5281 Compile the source files with @option{-fprofile-arcs} plus optimization
5282 and code generation options.  For test coverage analysis, use the
5283 additional @option{-ftest-coverage} option.  You do not need to profile
5284 every source file in a program.
5286 @item
5287 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5288 (the latter implies the former).
5290 @item
5291 Run the program on a representative workload to generate the arc profile
5292 information.  This may be repeated any number of times.  You can run
5293 concurrent instances of your program, and provided that the file system
5294 supports locking, the data files will be correctly updated.  Also
5295 @code{fork} calls are detected and correctly handled (double counting
5296 will not happen).
5298 @item
5299 For profile-directed optimizations, compile the source files again with
5300 the same optimization and code generation options plus
5301 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5302 Control Optimization}).
5304 @item
5305 For test coverage analysis, use @command{gcov} to produce human readable
5306 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5307 @command{gcov} documentation for further information.
5309 @end itemize
5311 With @option{-fprofile-arcs}, for each function of your program GCC
5312 creates a program flow graph, then finds a spanning tree for the graph.
5313 Only arcs that are not on the spanning tree have to be instrumented: the
5314 compiler adds code to count the number of times that these arcs are
5315 executed.  When an arc is the only exit or only entrance to a block, the
5316 instrumentation code can be added to the block; otherwise, a new basic
5317 block must be created to hold the instrumentation code.
5319 @need 2000
5320 @item -ftest-coverage
5321 @opindex ftest-coverage
5322 Produce a notes file that the @command{gcov} code-coverage utility
5323 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5324 show program coverage.  Each source file's note file is called
5325 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5326 above for a description of @var{auxname} and instructions on how to
5327 generate test coverage data.  Coverage data matches the source files
5328 more closely if you do not optimize.
5330 @item -fdbg-cnt-list
5331 @opindex fdbg-cnt-list
5332 Print the name and the counter upper bound for all debug counters.
5335 @item -fdbg-cnt=@var{counter-value-list}
5336 @opindex fdbg-cnt
5337 Set the internal debug counter upper bound.  @var{counter-value-list}
5338 is a comma-separated list of @var{name}:@var{value} pairs
5339 which sets the upper bound of each debug counter @var{name} to @var{value}.
5340 All debug counters have the initial upper bound of @code{UINT_MAX};
5341 thus @code{dbg_cnt()} returns true always unless the upper bound
5342 is set by this option.
5343 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5344 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5346 @item -fenable-@var{kind}-@var{pass}
5347 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5348 @opindex fdisable-
5349 @opindex fenable-
5351 This is a set of options that are used to explicitly disable/enable
5352 optimization passes.  These options are intended for use for debugging GCC.
5353 Compiler users should use regular options for enabling/disabling
5354 passes instead.
5356 @table @gcctabopt
5358 @item -fdisable-ipa-@var{pass}
5359 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5360 statically invoked in the compiler multiple times, the pass name should be
5361 appended with a sequential number starting from 1.
5363 @item -fdisable-rtl-@var{pass}
5364 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5365 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5366 statically invoked in the compiler multiple times, the pass name should be
5367 appended with a sequential number starting from 1.  @var{range-list} is a 
5368 comma-separated list of function ranges or assembler names.  Each range is a number
5369 pair separated by a colon.  The range is inclusive in both ends.  If the range
5370 is trivial, the number pair can be simplified as a single number.  If the
5371 function's cgraph node's @var{uid} falls within one of the specified ranges,
5372 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5373 function header of a dump file, and the pass names can be dumped by using
5374 option @option{-fdump-passes}.
5376 @item -fdisable-tree-@var{pass}
5377 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5378 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5379 option arguments.
5381 @item -fenable-ipa-@var{pass}
5382 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5383 statically invoked in the compiler multiple times, the pass name should be
5384 appended with a sequential number starting from 1.
5386 @item -fenable-rtl-@var{pass}
5387 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5388 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5389 description and examples.
5391 @item -fenable-tree-@var{pass}
5392 @itemx -fenable-tree-@var{pass}=@var{range-list}
5393 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5394 of option arguments.
5396 @end table
5398 Here are some examples showing uses of these options.
5400 @smallexample
5402 # disable ccp1 for all functions
5403    -fdisable-tree-ccp1
5404 # disable complete unroll for function whose cgraph node uid is 1
5405    -fenable-tree-cunroll=1
5406 # disable gcse2 for functions at the following ranges [1,1],
5407 # [300,400], and [400,1000]
5408 # disable gcse2 for functions foo and foo2
5409    -fdisable-rtl-gcse2=foo,foo2
5410 # disable early inlining
5411    -fdisable-tree-einline
5412 # disable ipa inlining
5413    -fdisable-ipa-inline
5414 # enable tree full unroll
5415    -fenable-tree-unroll
5417 @end smallexample
5419 @item -d@var{letters}
5420 @itemx -fdump-rtl-@var{pass}
5421 @itemx -fdump-rtl-@var{pass}=@var{filename}
5422 @opindex d
5423 Says to make debugging dumps during compilation at times specified by
5424 @var{letters}.  This is used for debugging the RTL-based passes of the
5425 compiler.  The file names for most of the dumps are made by appending
5426 a pass number and a word to the @var{dumpname}, and the files are
5427 created in the directory of the output file. In case of
5428 @option{=@var{filename}} option, the dump is output on the given file
5429 instead of the pass numbered dump files. Note that the pass number is
5430 computed statically as passes get registered into the pass manager.
5431 Thus the numbering is not related to the dynamic order of execution of
5432 passes.  In particular, a pass installed by a plugin could have a
5433 number over 200 even if it executed quite early.  @var{dumpname} is
5434 generated from the name of the output file, if explicitly specified
5435 and it is not an executable, otherwise it is the basename of the
5436 source file. These switches may have different effects when
5437 @option{-E} is used for preprocessing.
5439 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5440 @option{-d} option @var{letters}.  Here are the possible
5441 letters for use in @var{pass} and @var{letters}, and their meanings:
5443 @table @gcctabopt
5445 @item -fdump-rtl-alignments
5446 @opindex fdump-rtl-alignments
5447 Dump after branch alignments have been computed.
5449 @item -fdump-rtl-asmcons
5450 @opindex fdump-rtl-asmcons
5451 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5453 @item -fdump-rtl-auto_inc_dec
5454 @opindex fdump-rtl-auto_inc_dec
5455 Dump after auto-inc-dec discovery.  This pass is only run on
5456 architectures that have auto inc or auto dec instructions.
5458 @item -fdump-rtl-barriers
5459 @opindex fdump-rtl-barriers
5460 Dump after cleaning up the barrier instructions.
5462 @item -fdump-rtl-bbpart
5463 @opindex fdump-rtl-bbpart
5464 Dump after partitioning hot and cold basic blocks.
5466 @item -fdump-rtl-bbro
5467 @opindex fdump-rtl-bbro
5468 Dump after block reordering.
5470 @item -fdump-rtl-btl1
5471 @itemx -fdump-rtl-btl2
5472 @opindex fdump-rtl-btl2
5473 @opindex fdump-rtl-btl2
5474 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5475 after the two branch
5476 target load optimization passes.
5478 @item -fdump-rtl-bypass
5479 @opindex fdump-rtl-bypass
5480 Dump after jump bypassing and control flow optimizations.
5482 @item -fdump-rtl-combine
5483 @opindex fdump-rtl-combine
5484 Dump after the RTL instruction combination pass.
5486 @item -fdump-rtl-compgotos
5487 @opindex fdump-rtl-compgotos
5488 Dump after duplicating the computed gotos.
5490 @item -fdump-rtl-ce1
5491 @itemx -fdump-rtl-ce2
5492 @itemx -fdump-rtl-ce3
5493 @opindex fdump-rtl-ce1
5494 @opindex fdump-rtl-ce2
5495 @opindex fdump-rtl-ce3
5496 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5497 @option{-fdump-rtl-ce3} enable dumping after the three
5498 if conversion passes.
5500 @item -fdump-rtl-cprop_hardreg
5501 @opindex fdump-rtl-cprop_hardreg
5502 Dump after hard register copy propagation.
5504 @item -fdump-rtl-csa
5505 @opindex fdump-rtl-csa
5506 Dump after combining stack adjustments.
5508 @item -fdump-rtl-cse1
5509 @itemx -fdump-rtl-cse2
5510 @opindex fdump-rtl-cse1
5511 @opindex fdump-rtl-cse2
5512 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5513 the two common subexpression elimination passes.
5515 @item -fdump-rtl-dce
5516 @opindex fdump-rtl-dce
5517 Dump after the standalone dead code elimination passes.
5519 @item -fdump-rtl-dbr
5520 @opindex fdump-rtl-dbr
5521 Dump after delayed branch scheduling.
5523 @item -fdump-rtl-dce1
5524 @itemx -fdump-rtl-dce2
5525 @opindex fdump-rtl-dce1
5526 @opindex fdump-rtl-dce2
5527 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5528 the two dead store elimination passes.
5530 @item -fdump-rtl-eh
5531 @opindex fdump-rtl-eh
5532 Dump after finalization of EH handling code.
5534 @item -fdump-rtl-eh_ranges
5535 @opindex fdump-rtl-eh_ranges
5536 Dump after conversion of EH handling range regions.
5538 @item -fdump-rtl-expand
5539 @opindex fdump-rtl-expand
5540 Dump after RTL generation.
5542 @item -fdump-rtl-fwprop1
5543 @itemx -fdump-rtl-fwprop2
5544 @opindex fdump-rtl-fwprop1
5545 @opindex fdump-rtl-fwprop2
5546 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5547 dumping after the two forward propagation passes.
5549 @item -fdump-rtl-gcse1
5550 @itemx -fdump-rtl-gcse2
5551 @opindex fdump-rtl-gcse1
5552 @opindex fdump-rtl-gcse2
5553 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5554 after global common subexpression elimination.
5556 @item -fdump-rtl-init-regs
5557 @opindex fdump-rtl-init-regs
5558 Dump after the initialization of the registers.
5560 @item -fdump-rtl-initvals
5561 @opindex fdump-rtl-initvals
5562 Dump after the computation of the initial value sets.
5564 @item -fdump-rtl-into_cfglayout
5565 @opindex fdump-rtl-into_cfglayout
5566 Dump after converting to cfglayout mode.
5568 @item -fdump-rtl-ira
5569 @opindex fdump-rtl-ira
5570 Dump after iterated register allocation.
5572 @item -fdump-rtl-jump
5573 @opindex fdump-rtl-jump
5574 Dump after the second jump optimization.
5576 @item -fdump-rtl-loop2
5577 @opindex fdump-rtl-loop2
5578 @option{-fdump-rtl-loop2} enables dumping after the rtl
5579 loop optimization passes.
5581 @item -fdump-rtl-mach
5582 @opindex fdump-rtl-mach
5583 Dump after performing the machine dependent reorganization pass, if that
5584 pass exists.
5586 @item -fdump-rtl-mode_sw
5587 @opindex fdump-rtl-mode_sw
5588 Dump after removing redundant mode switches.
5590 @item -fdump-rtl-rnreg
5591 @opindex fdump-rtl-rnreg
5592 Dump after register renumbering.
5594 @item -fdump-rtl-outof_cfglayout
5595 @opindex fdump-rtl-outof_cfglayout
5596 Dump after converting from cfglayout mode.
5598 @item -fdump-rtl-peephole2
5599 @opindex fdump-rtl-peephole2
5600 Dump after the peephole pass.
5602 @item -fdump-rtl-postreload
5603 @opindex fdump-rtl-postreload
5604 Dump after post-reload optimizations.
5606 @itemx -fdump-rtl-pro_and_epilogue
5607 @opindex fdump-rtl-pro_and_epilogue
5608 Dump after generating the function prologues and epilogues.
5610 @item -fdump-rtl-regmove
5611 @opindex fdump-rtl-regmove
5612 Dump after the register move pass.
5614 @item -fdump-rtl-sched1
5615 @itemx -fdump-rtl-sched2
5616 @opindex fdump-rtl-sched1
5617 @opindex fdump-rtl-sched2
5618 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5619 after the basic block scheduling passes.
5621 @item -fdump-rtl-see
5622 @opindex fdump-rtl-see
5623 Dump after sign extension elimination.
5625 @item -fdump-rtl-seqabstr
5626 @opindex fdump-rtl-seqabstr
5627 Dump after common sequence discovery.
5629 @item -fdump-rtl-shorten
5630 @opindex fdump-rtl-shorten
5631 Dump after shortening branches.
5633 @item -fdump-rtl-sibling
5634 @opindex fdump-rtl-sibling
5635 Dump after sibling call optimizations.
5637 @item -fdump-rtl-split1
5638 @itemx -fdump-rtl-split2
5639 @itemx -fdump-rtl-split3
5640 @itemx -fdump-rtl-split4
5641 @itemx -fdump-rtl-split5
5642 @opindex fdump-rtl-split1
5643 @opindex fdump-rtl-split2
5644 @opindex fdump-rtl-split3
5645 @opindex fdump-rtl-split4
5646 @opindex fdump-rtl-split5
5647 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5648 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5649 @option{-fdump-rtl-split5} enable dumping after five rounds of
5650 instruction splitting.
5652 @item -fdump-rtl-sms
5653 @opindex fdump-rtl-sms
5654 Dump after modulo scheduling.  This pass is only run on some
5655 architectures.
5657 @item -fdump-rtl-stack
5658 @opindex fdump-rtl-stack
5659 Dump after conversion from GCC's ``flat register file'' registers to the
5660 x87's stack-like registers.  This pass is only run on x86 variants.
5662 @item -fdump-rtl-subreg1
5663 @itemx -fdump-rtl-subreg2
5664 @opindex fdump-rtl-subreg1
5665 @opindex fdump-rtl-subreg2
5666 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5667 the two subreg expansion passes.
5669 @item -fdump-rtl-unshare
5670 @opindex fdump-rtl-unshare
5671 Dump after all rtl has been unshared.
5673 @item -fdump-rtl-vartrack
5674 @opindex fdump-rtl-vartrack
5675 Dump after variable tracking.
5677 @item -fdump-rtl-vregs
5678 @opindex fdump-rtl-vregs
5679 Dump after converting virtual registers to hard registers.
5681 @item -fdump-rtl-web
5682 @opindex fdump-rtl-web
5683 Dump after live range splitting.
5685 @item -fdump-rtl-regclass
5686 @itemx -fdump-rtl-subregs_of_mode_init
5687 @itemx -fdump-rtl-subregs_of_mode_finish
5688 @itemx -fdump-rtl-dfinit
5689 @itemx -fdump-rtl-dfinish
5690 @opindex fdump-rtl-regclass
5691 @opindex fdump-rtl-subregs_of_mode_init
5692 @opindex fdump-rtl-subregs_of_mode_finish
5693 @opindex fdump-rtl-dfinit
5694 @opindex fdump-rtl-dfinish
5695 These dumps are defined but always produce empty files.
5697 @item -da
5698 @itemx -fdump-rtl-all
5699 @opindex da
5700 @opindex fdump-rtl-all
5701 Produce all the dumps listed above.
5703 @item -dA
5704 @opindex dA
5705 Annotate the assembler output with miscellaneous debugging information.
5707 @item -dD
5708 @opindex dD
5709 Dump all macro definitions, at the end of preprocessing, in addition to
5710 normal output.
5712 @item -dH
5713 @opindex dH
5714 Produce a core dump whenever an error occurs.
5716 @item -dp
5717 @opindex dp
5718 Annotate the assembler output with a comment indicating which
5719 pattern and alternative is used.  The length of each instruction is
5720 also printed.
5722 @item -dP
5723 @opindex dP
5724 Dump the RTL in the assembler output as a comment before each instruction.
5725 Also turns on @option{-dp} annotation.
5727 @item -dv
5728 @opindex dv
5729 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5730 dump a representation of the control flow graph suitable for viewing with VCG
5731 to @file{@var{file}.@var{pass}.vcg}.
5733 @item -dx
5734 @opindex dx
5735 Just generate RTL for a function instead of compiling it.  Usually used
5736 with @option{-fdump-rtl-expand}.
5737 @end table
5739 @item -fdump-noaddr
5740 @opindex fdump-noaddr
5741 When doing debugging dumps, suppress address output.  This makes it more
5742 feasible to use diff on debugging dumps for compiler invocations with
5743 different compiler binaries and/or different
5744 text / bss / data / heap / stack / dso start locations.
5746 @item -fdump-unnumbered
5747 @opindex fdump-unnumbered
5748 When doing debugging dumps, suppress instruction numbers and address output.
5749 This makes it more feasible to use diff on debugging dumps for compiler
5750 invocations with different options, in particular with and without
5751 @option{-g}.
5753 @item -fdump-unnumbered-links
5754 @opindex fdump-unnumbered-links
5755 When doing debugging dumps (see @option{-d} option above), suppress
5756 instruction numbers for the links to the previous and next instructions
5757 in a sequence.
5759 @item -fdump-translation-unit @r{(C++ only)}
5760 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5761 @opindex fdump-translation-unit
5762 Dump a representation of the tree structure for the entire translation
5763 unit to a file.  The file name is made by appending @file{.tu} to the
5764 source file name, and the file is created in the same directory as the
5765 output file.  If the @samp{-@var{options}} form is used, @var{options}
5766 controls the details of the dump as described for the
5767 @option{-fdump-tree} options.
5769 @item -fdump-class-hierarchy @r{(C++ only)}
5770 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5771 @opindex fdump-class-hierarchy
5772 Dump a representation of each class's hierarchy and virtual function
5773 table layout to a file.  The file name is made by appending
5774 @file{.class} to the source file name, and the file is created in the
5775 same directory as the output file.  If the @samp{-@var{options}} form
5776 is used, @var{options} controls the details of the dump as described
5777 for the @option{-fdump-tree} options.
5779 @item -fdump-ipa-@var{switch}
5780 @opindex fdump-ipa
5781 Control the dumping at various stages of inter-procedural analysis
5782 language tree to a file.  The file name is generated by appending a
5783 switch specific suffix to the source file name, and the file is created
5784 in the same directory as the output file.  The following dumps are
5785 possible:
5787 @table @samp
5788 @item all
5789 Enables all inter-procedural analysis dumps.
5791 @item cgraph
5792 Dumps information about call-graph optimization, unused function removal,
5793 and inlining decisions.
5795 @item inline
5796 Dump after function inlining.
5798 @end table
5800 @item -fdump-passes
5801 @opindex fdump-passes
5802 Dump the list of optimization passes that are turned on and off by
5803 the current command-line options.
5805 @item -fdump-statistics-@var{option}
5806 @opindex fdump-statistics
5807 Enable and control dumping of pass statistics in a separate file.  The
5808 file name is generated by appending a suffix ending in
5809 @samp{.statistics} to the source file name, and the file is created in
5810 the same directory as the output file.  If the @samp{-@var{option}}
5811 form is used, @samp{-stats} causes counters to be summed over the
5812 whole compilation unit while @samp{-details} dumps every event as
5813 the passes generate them.  The default with no option is to sum
5814 counters for each function compiled.
5816 @item -fdump-tree-@var{switch}
5817 @itemx -fdump-tree-@var{switch}-@var{options}
5818 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
5819 @opindex fdump-tree
5820 Control the dumping at various stages of processing the intermediate
5821 language tree to a file.  The file name is generated by appending a
5822 switch-specific suffix to the source file name, and the file is
5823 created in the same directory as the output file. In case of
5824 @option{=@var{filename}} option, the dump is output on the given file
5825 instead of the auto named dump files.  If the @samp{-@var{options}}
5826 form is used, @var{options} is a list of @samp{-} separated options
5827 which control the details of the dump.  Not all options are applicable
5828 to all dumps; those that are not meaningful are ignored.  The
5829 following options are available
5831 @table @samp
5832 @item address
5833 Print the address of each node.  Usually this is not meaningful as it
5834 changes according to the environment and source file.  Its primary use
5835 is for tying up a dump file with a debug environment.
5836 @item asmname
5837 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5838 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5839 use working backward from mangled names in the assembly file.
5840 @item slim
5841 Inhibit dumping of members of a scope or body of a function merely
5842 because that scope has been reached.  Only dump such items when they
5843 are directly reachable by some other path.  When dumping pretty-printed
5844 trees, this option inhibits dumping the bodies of control structures.
5845 @item raw
5846 Print a raw representation of the tree.  By default, trees are
5847 pretty-printed into a C-like representation.
5848 @item details
5849 Enable more detailed dumps (not honored by every dump option). Also
5850 include information from the optimization passes.
5851 @item stats
5852 Enable dumping various statistics about the pass (not honored by every dump
5853 option).
5854 @item blocks
5855 Enable showing basic block boundaries (disabled in raw dumps).
5856 @item vops
5857 Enable showing virtual operands for every statement.
5858 @item lineno
5859 Enable showing line numbers for statements.
5860 @item uid
5861 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5862 @item verbose
5863 Enable showing the tree dump for each statement.
5864 @item eh
5865 Enable showing the EH region number holding each statement.
5866 @item scev
5867 Enable showing scalar evolution analysis details.
5868 @item optimized
5869 Enable showing optimization information (only available in certain
5870 passes).
5871 @item missed
5872 Enable showing missed optimization information (only available in certain
5873 passes).
5874 @item notes
5875 Enable other detailed optimization information (only available in
5876 certain passes).
5877 @item =@var{filename}
5878 Instead of an auto named dump file, output into the given file
5879 name. The file names @file{stdout} and @file{stderr} are treated
5880 specially and are considered already open standard streams. For
5881 example,
5883 @smallexample
5884 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
5885      -fdump-tree-pre=stderr file.c
5886 @end smallexample
5888 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
5889 output on to @file{stderr}. If two conflicting dump filenames are
5890 given for the same pass, then the latter option overrides the earlier
5891 one.
5893 @item all
5894 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5895 and @option{lineno}.
5897 @item optall
5898 Turn on all optimization options, i.e., @option{optimized},
5899 @option{missed}, and @option{note}.
5900 @end table
5902 The following tree dumps are possible:
5903 @table @samp
5905 @item original
5906 @opindex fdump-tree-original
5907 Dump before any tree based optimization, to @file{@var{file}.original}.
5909 @item optimized
5910 @opindex fdump-tree-optimized
5911 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5913 @item gimple
5914 @opindex fdump-tree-gimple
5915 Dump each function before and after the gimplification pass to a file.  The
5916 file name is made by appending @file{.gimple} to the source file name.
5918 @item cfg
5919 @opindex fdump-tree-cfg
5920 Dump the control flow graph of each function to a file.  The file name is
5921 made by appending @file{.cfg} to the source file name.
5923 @item vcg
5924 @opindex fdump-tree-vcg
5925 Dump the control flow graph of each function to a file in VCG format.  The
5926 file name is made by appending @file{.vcg} to the source file name.  Note
5927 that if the file contains more than one function, the generated file cannot
5928 be used directly by VCG@.  You must cut and paste each function's
5929 graph into its own separate file first.
5931 @item ch
5932 @opindex fdump-tree-ch
5933 Dump each function after copying loop headers.  The file name is made by
5934 appending @file{.ch} to the source file name.
5936 @item ssa
5937 @opindex fdump-tree-ssa
5938 Dump SSA related information to a file.  The file name is made by appending
5939 @file{.ssa} to the source file name.
5941 @item alias
5942 @opindex fdump-tree-alias
5943 Dump aliasing information for each function.  The file name is made by
5944 appending @file{.alias} to the source file name.
5946 @item ccp
5947 @opindex fdump-tree-ccp
5948 Dump each function after CCP@.  The file name is made by appending
5949 @file{.ccp} to the source file name.
5951 @item storeccp
5952 @opindex fdump-tree-storeccp
5953 Dump each function after STORE-CCP@.  The file name is made by appending
5954 @file{.storeccp} to the source file name.
5956 @item pre
5957 @opindex fdump-tree-pre
5958 Dump trees after partial redundancy elimination.  The file name is made
5959 by appending @file{.pre} to the source file name.
5961 @item fre
5962 @opindex fdump-tree-fre
5963 Dump trees after full redundancy elimination.  The file name is made
5964 by appending @file{.fre} to the source file name.
5966 @item copyprop
5967 @opindex fdump-tree-copyprop
5968 Dump trees after copy propagation.  The file name is made
5969 by appending @file{.copyprop} to the source file name.
5971 @item store_copyprop
5972 @opindex fdump-tree-store_copyprop
5973 Dump trees after store copy-propagation.  The file name is made
5974 by appending @file{.store_copyprop} to the source file name.
5976 @item dce
5977 @opindex fdump-tree-dce
5978 Dump each function after dead code elimination.  The file name is made by
5979 appending @file{.dce} to the source file name.
5981 @item mudflap
5982 @opindex fdump-tree-mudflap
5983 Dump each function after adding mudflap instrumentation.  The file name is
5984 made by appending @file{.mudflap} to the source file name.
5986 @item sra
5987 @opindex fdump-tree-sra
5988 Dump each function after performing scalar replacement of aggregates.  The
5989 file name is made by appending @file{.sra} to the source file name.
5991 @item sink
5992 @opindex fdump-tree-sink
5993 Dump each function after performing code sinking.  The file name is made
5994 by appending @file{.sink} to the source file name.
5996 @item dom
5997 @opindex fdump-tree-dom
5998 Dump each function after applying dominator tree optimizations.  The file
5999 name is made by appending @file{.dom} to the source file name.
6001 @item dse
6002 @opindex fdump-tree-dse
6003 Dump each function after applying dead store elimination.  The file
6004 name is made by appending @file{.dse} to the source file name.
6006 @item phiopt
6007 @opindex fdump-tree-phiopt
6008 Dump each function after optimizing PHI nodes into straightline code.  The file
6009 name is made by appending @file{.phiopt} to the source file name.
6011 @item forwprop
6012 @opindex fdump-tree-forwprop
6013 Dump each function after forward propagating single use variables.  The file
6014 name is made by appending @file{.forwprop} to the source file name.
6016 @item copyrename
6017 @opindex fdump-tree-copyrename
6018 Dump each function after applying the copy rename optimization.  The file
6019 name is made by appending @file{.copyrename} to the source file name.
6021 @item nrv
6022 @opindex fdump-tree-nrv
6023 Dump each function after applying the named return value optimization on
6024 generic trees.  The file name is made by appending @file{.nrv} to the source
6025 file name.
6027 @item vect
6028 @opindex fdump-tree-vect
6029 Dump each function after applying vectorization of loops.  The file name is
6030 made by appending @file{.vect} to the source file name.
6032 @item slp
6033 @opindex fdump-tree-slp
6034 Dump each function after applying vectorization of basic blocks.  The file name
6035 is made by appending @file{.slp} to the source file name.
6037 @item vrp
6038 @opindex fdump-tree-vrp
6039 Dump each function after Value Range Propagation (VRP).  The file name
6040 is made by appending @file{.vrp} to the source file name.
6042 @item all
6043 @opindex fdump-tree-all
6044 Enable all the available tree dumps with the flags provided in this option.
6045 @end table
6047 @item -fopt-info
6048 @itemx -fopt-info-@var{options}
6049 @itemx -fopt-info-@var{options}=@var{filename}
6050 @opindex fopt-info
6051 Controls optimization dumps from various optimization passes. If the
6052 @samp{-@var{options}} form is used, @var{options} is a list of
6053 @samp{-} separated options to select the dump details and
6054 optimizations.  If @var{options} is not specified, it defaults to
6055 @option{all} for details and @option{optall} for optimization
6056 groups. If the @var{filename} is not specified, it defaults to
6057 @file{stderr}. Note that the output @var{filename} will be overwritten
6058 in case of multiple translation units. If a combined output from
6059 multiple translation units is desired, @file{stderr} should be used
6060 instead.
6062 The options can be divided into two groups, 1) options describing the
6063 verbosity of the dump, and 2) options describing which optimizations
6064 should be included. The options from both the groups can be freely
6065 mixed as they are non-overlapping. However, in case of any conflicts,
6066 the latter options override the earlier options on the command
6067 line. Though multiple -fopt-info options are accepted, only one of
6068 them can have @option{=filename}. If other filenames are provided then
6069 all but the first one are ignored.
6071 The dump verbosity has the following options
6073 @table @samp
6074 @item optimized
6075 Print information when an optimization is successfully applied. It is
6076 up to a pass to decide which information is relevant. For example, the
6077 vectorizer passes print the source location of loops which got
6078 successfully vectorized.
6079 @item missed
6080 Print information about missed optimizations. Individual passes
6081 control which informations to include in the output. For example,
6083 @smallexample
6084 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6085 @end smallexample
6087 will print information about missed optimization opportunities from
6088 vectorization passes on stderr.
6089 @item note
6090 Print verbose information about optimizations, such as certain
6091 transformations, more detailed messages about decisions etc.
6092 @item all
6093 Print detailed optimization information. This includes
6094 @var{optimized}, @var{missed}, and @var{note}.
6095 @end table
6097 The second set of options describes a group of optimizations and may
6098 include one or more of the following.
6100 @table @samp
6101 @item ipa
6102 Enable dumps from all interprocedural optimizations.
6103 @item loop
6104 Enable dumps from all loop optimizations.
6105 @item inline
6106 Enable dumps from all inlining optimizations.
6107 @item vec
6108 Enable dumps from all vectorization optimizations.
6109 @end table
6111 For example,
6112 @smallexample
6113 gcc -O3 -fopt-info-missed=missed.all
6114 @end smallexample
6116 outputs missed optimization report from all the passes into
6117 @file{missed.all}.
6119 As another example,
6120 @smallexample
6121 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6122 @end smallexample
6124 will output information about missed optimizations as well as
6125 optimized locations from all the inlining passes into
6126 @file{inline.txt}.
6128 If the @var{filename} is provided, then the dumps from all the
6129 applicable optimizations are concatenated into the @file{filename}.
6130 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6131 omitted, it defaults to @option{all-optall}, which means dump all
6132 available optimization info from all the passes. In the following
6133 example, all optimization info is output on to @file{stderr}.
6135 @smallexample
6136 gcc -O3 -fopt-info
6137 @end smallexample
6139 Note that @option{-fopt-info-vec-missed} behaves the same as
6140 @option{-fopt-info-missed-vec}.
6142 As another example, consider
6144 @smallexample
6145 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6146 @end smallexample
6148 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6149 in conflict since only one output file is allowed. In this case, only
6150 the first option takes effect and the subsequent options are
6151 ignored. Thus only the @file{vec.miss} is produced which cotaints
6152 dumps from the vectorizer about missed opportunities.
6154 @item -ftree-vectorizer-verbose=@var{n}
6155 @opindex ftree-vectorizer-verbose
6156 This option is deprecated and is implemented in terms of
6157 @option{-fopt-info}. Please use @option{-fopt-info-@var{kind}} form
6158 instead, where @var{kind} is one of the valid opt-info options. It
6159 prints additional optimization information.  For @var{n}=0 no
6160 diagnostic information is reported.  If @var{n}=1 the vectorizer
6161 reports each loop that got vectorized, and the total number of loops
6162 that got vectorized.  If @var{n}=2 the vectorizer reports locations
6163 which could not be vectorized and the reasons for those. For any
6164 higher verbosity levels all the analysis and transformation
6165 information from the vectorizer is reported.
6167 Note that the information output by @option{-ftree-vectorizer-verbose}
6168 option is sent to @file{stderr}. If the equivalent form
6169 @option{-fopt-info-@var{options}=@var{filename}} is used then the
6170 output is sent into @var{filename} instead.
6172 @item -frandom-seed=@var{string}
6173 @opindex frandom-seed
6174 This option provides a seed that GCC uses in place of
6175 random numbers in generating certain symbol names
6176 that have to be different in every compiled file.  It is also used to
6177 place unique stamps in coverage data files and the object files that
6178 produce them.  You can use the @option{-frandom-seed} option to produce
6179 reproducibly identical object files.
6181 The @var{string} should be different for every file you compile.
6183 @item -fsched-verbose=@var{n}
6184 @opindex fsched-verbose
6185 On targets that use instruction scheduling, this option controls the
6186 amount of debugging output the scheduler prints.  This information is
6187 written to standard error, unless @option{-fdump-rtl-sched1} or
6188 @option{-fdump-rtl-sched2} is specified, in which case it is output
6189 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6190 respectively.  However for @var{n} greater than nine, the output is
6191 always printed to standard error.
6193 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6194 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6195 For @var{n} greater than one, it also output basic block probabilities,
6196 detailed ready list information and unit/insn info.  For @var{n} greater
6197 than two, it includes RTL at abort point, control-flow and regions info.
6198 And for @var{n} over four, @option{-fsched-verbose} also includes
6199 dependence info.
6201 @item -save-temps
6202 @itemx -save-temps=cwd
6203 @opindex save-temps
6204 Store the usual ``temporary'' intermediate files permanently; place them
6205 in the current directory and name them based on the source file.  Thus,
6206 compiling @file{foo.c} with @option{-c -save-temps} produces files
6207 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6208 preprocessed @file{foo.i} output file even though the compiler now
6209 normally uses an integrated preprocessor.
6211 When used in combination with the @option{-x} command-line option,
6212 @option{-save-temps} is sensible enough to avoid over writing an
6213 input source file with the same extension as an intermediate file.
6214 The corresponding intermediate file may be obtained by renaming the
6215 source file before using @option{-save-temps}.
6217 If you invoke GCC in parallel, compiling several different source
6218 files that share a common base name in different subdirectories or the
6219 same source file compiled for multiple output destinations, it is
6220 likely that the different parallel compilers will interfere with each
6221 other, and overwrite the temporary files.  For instance:
6223 @smallexample
6224 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6225 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6226 @end smallexample
6228 may result in @file{foo.i} and @file{foo.o} being written to
6229 simultaneously by both compilers.
6231 @item -save-temps=obj
6232 @opindex save-temps=obj
6233 Store the usual ``temporary'' intermediate files permanently.  If the
6234 @option{-o} option is used, the temporary files are based on the
6235 object file.  If the @option{-o} option is not used, the
6236 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6238 For example:
6240 @smallexample
6241 gcc -save-temps=obj -c foo.c
6242 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6243 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6244 @end smallexample
6246 @noindent
6247 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6248 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6249 @file{dir2/yfoobar.o}.
6251 @item -time@r{[}=@var{file}@r{]}
6252 @opindex time
6253 Report the CPU time taken by each subprocess in the compilation
6254 sequence.  For C source files, this is the compiler proper and assembler
6255 (plus the linker if linking is done).
6257 Without the specification of an output file, the output looks like this:
6259 @smallexample
6260 # cc1 0.12 0.01
6261 # as 0.00 0.01
6262 @end smallexample
6264 The first number on each line is the ``user time'', that is time spent
6265 executing the program itself.  The second number is ``system time'',
6266 time spent executing operating system routines on behalf of the program.
6267 Both numbers are in seconds.
6269 With the specification of an output file, the output is appended to the
6270 named file, and it looks like this:
6272 @smallexample
6273 0.12 0.01 cc1 @var{options}
6274 0.00 0.01 as @var{options}
6275 @end smallexample
6277 The ``user time'' and the ``system time'' are moved before the program
6278 name, and the options passed to the program are displayed, so that one
6279 can later tell what file was being compiled, and with which options.
6281 @item -fvar-tracking
6282 @opindex fvar-tracking
6283 Run variable tracking pass.  It computes where variables are stored at each
6284 position in code.  Better debugging information is then generated
6285 (if the debugging information format supports this information).
6287 It is enabled by default when compiling with optimization (@option{-Os},
6288 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6289 the debug info format supports it.
6291 @item -fvar-tracking-assignments
6292 @opindex fvar-tracking-assignments
6293 @opindex fno-var-tracking-assignments
6294 Annotate assignments to user variables early in the compilation and
6295 attempt to carry the annotations over throughout the compilation all the
6296 way to the end, in an attempt to improve debug information while
6297 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6299 It can be enabled even if var-tracking is disabled, in which case
6300 annotations are created and maintained, but discarded at the end.
6302 @item -fvar-tracking-assignments-toggle
6303 @opindex fvar-tracking-assignments-toggle
6304 @opindex fno-var-tracking-assignments-toggle
6305 Toggle @option{-fvar-tracking-assignments}, in the same way that
6306 @option{-gtoggle} toggles @option{-g}.
6308 @item -print-file-name=@var{library}
6309 @opindex print-file-name
6310 Print the full absolute name of the library file @var{library} that
6311 would be used when linking---and don't do anything else.  With this
6312 option, GCC does not compile or link anything; it just prints the
6313 file name.
6315 @item -print-multi-directory
6316 @opindex print-multi-directory
6317 Print the directory name corresponding to the multilib selected by any
6318 other switches present in the command line.  This directory is supposed
6319 to exist in @env{GCC_EXEC_PREFIX}.
6321 @item -print-multi-lib
6322 @opindex print-multi-lib
6323 Print the mapping from multilib directory names to compiler switches
6324 that enable them.  The directory name is separated from the switches by
6325 @samp{;}, and each switch starts with an @samp{@@} instead of the
6326 @samp{-}, without spaces between multiple switches.  This is supposed to
6327 ease shell processing.
6329 @item -print-multi-os-directory
6330 @opindex print-multi-os-directory
6331 Print the path to OS libraries for the selected
6332 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6333 present in the @file{lib} subdirectory and no multilibs are used, this is
6334 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6335 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6336 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6337 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6339 @item -print-multiarch
6340 @opindex print-multiarch
6341 Print the path to OS libraries for the selected multiarch,
6342 relative to some @file{lib} subdirectory.
6344 @item -print-prog-name=@var{program}
6345 @opindex print-prog-name
6346 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6348 @item -print-libgcc-file-name
6349 @opindex print-libgcc-file-name
6350 Same as @option{-print-file-name=libgcc.a}.
6352 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6353 but you do want to link with @file{libgcc.a}.  You can do:
6355 @smallexample
6356 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6357 @end smallexample
6359 @item -print-search-dirs
6360 @opindex print-search-dirs
6361 Print the name of the configured installation directory and a list of
6362 program and library directories @command{gcc} searches---and don't do anything else.
6364 This is useful when @command{gcc} prints the error message
6365 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6366 To resolve this you either need to put @file{cpp0} and the other compiler
6367 components where @command{gcc} expects to find them, or you can set the environment
6368 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6369 Don't forget the trailing @samp{/}.
6370 @xref{Environment Variables}.
6372 @item -print-sysroot
6373 @opindex print-sysroot
6374 Print the target sysroot directory that is used during
6375 compilation.  This is the target sysroot specified either at configure
6376 time or using the @option{--sysroot} option, possibly with an extra
6377 suffix that depends on compilation options.  If no target sysroot is
6378 specified, the option prints nothing.
6380 @item -print-sysroot-headers-suffix
6381 @opindex print-sysroot-headers-suffix
6382 Print the suffix added to the target sysroot when searching for
6383 headers, or give an error if the compiler is not configured with such
6384 a suffix---and don't do anything else.
6386 @item -dumpmachine
6387 @opindex dumpmachine
6388 Print the compiler's target machine (for example,
6389 @samp{i686-pc-linux-gnu})---and don't do anything else.
6391 @item -dumpversion
6392 @opindex dumpversion
6393 Print the compiler version (for example, @samp{3.0})---and don't do
6394 anything else.
6396 @item -dumpspecs
6397 @opindex dumpspecs
6398 Print the compiler's built-in specs---and don't do anything else.  (This
6399 is used when GCC itself is being built.)  @xref{Spec Files}.
6401 @item -fno-eliminate-unused-debug-types
6402 @opindex feliminate-unused-debug-types
6403 @opindex fno-eliminate-unused-debug-types
6404 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
6405 output for types that are nowhere used in the source file being compiled.
6406 Sometimes it is useful to have GCC emit debugging
6407 information for all types declared in a compilation
6408 unit, regardless of whether or not they are actually used
6409 in that compilation unit, for example 
6410 if, in the debugger, you want to cast a value to a type that is
6411 not actually used in your program (but is declared).  More often,
6412 however, this results in a significant amount of wasted space.
6413 @end table
6415 @node Optimize Options
6416 @section Options That Control Optimization
6417 @cindex optimize options
6418 @cindex options, optimization
6420 These options control various sorts of optimizations.
6422 Without any optimization option, the compiler's goal is to reduce the
6423 cost of compilation and to make debugging produce the expected
6424 results.  Statements are independent: if you stop the program with a
6425 breakpoint between statements, you can then assign a new value to any
6426 variable or change the program counter to any other statement in the
6427 function and get exactly the results you expect from the source
6428 code.
6430 Turning on optimization flags makes the compiler attempt to improve
6431 the performance and/or code size at the expense of compilation time
6432 and possibly the ability to debug the program.
6434 The compiler performs optimization based on the knowledge it has of the
6435 program.  Compiling multiple files at once to a single output file mode allows
6436 the compiler to use information gained from all of the files when compiling
6437 each of them.
6439 Not all optimizations are controlled directly by a flag.  Only
6440 optimizations that have a flag are listed in this section.
6442 Most optimizations are only enabled if an @option{-O} level is set on
6443 the command line.  Otherwise they are disabled, even if individual
6444 optimization flags are specified.
6446 Depending on the target and how GCC was configured, a slightly different
6447 set of optimizations may be enabled at each @option{-O} level than
6448 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6449 to find out the exact set of optimizations that are enabled at each level.
6450 @xref{Overall Options}, for examples.
6452 @table @gcctabopt
6453 @item -O
6454 @itemx -O1
6455 @opindex O
6456 @opindex O1
6457 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6458 more memory for a large function.
6460 With @option{-O}, the compiler tries to reduce code size and execution
6461 time, without performing any optimizations that take a great deal of
6462 compilation time.
6464 @option{-O} turns on the following optimization flags:
6465 @gccoptlist{
6466 -fauto-inc-dec @gol
6467 -fcompare-elim @gol
6468 -fcprop-registers @gol
6469 -fdce @gol
6470 -fdefer-pop @gol
6471 -fdelayed-branch @gol
6472 -fdse @gol
6473 -fguess-branch-probability @gol
6474 -fif-conversion2 @gol
6475 -fif-conversion @gol
6476 -fipa-pure-const @gol
6477 -fipa-profile @gol
6478 -fipa-reference @gol
6479 -fmerge-constants
6480 -fsplit-wide-types @gol
6481 -ftree-bit-ccp @gol
6482 -ftree-builtin-call-dce @gol
6483 -ftree-ccp @gol
6484 -ftree-ch @gol
6485 -ftree-copyrename @gol
6486 -ftree-dce @gol
6487 -ftree-dominator-opts @gol
6488 -ftree-dse @gol
6489 -ftree-forwprop @gol
6490 -ftree-fre @gol
6491 -ftree-phiprop @gol
6492 -ftree-slsr @gol
6493 -ftree-sra @gol
6494 -ftree-pta @gol
6495 -ftree-ter @gol
6496 -funit-at-a-time}
6498 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6499 where doing so does not interfere with debugging.
6501 @item -O2
6502 @opindex O2
6503 Optimize even more.  GCC performs nearly all supported optimizations
6504 that do not involve a space-speed tradeoff.
6505 As compared to @option{-O}, this option increases both compilation time
6506 and the performance of the generated code.
6508 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6509 also turns on the following optimization flags:
6510 @gccoptlist{-fthread-jumps @gol
6511 -falign-functions  -falign-jumps @gol
6512 -falign-loops  -falign-labels @gol
6513 -fcaller-saves @gol
6514 -fcrossjumping @gol
6515 -fcse-follow-jumps  -fcse-skip-blocks @gol
6516 -fdelete-null-pointer-checks @gol
6517 -fdevirtualize @gol
6518 -fexpensive-optimizations @gol
6519 -fgcse  -fgcse-lm  @gol
6520 -fhoist-adjacent-loads @gol
6521 -finline-small-functions @gol
6522 -findirect-inlining @gol
6523 -fipa-sra @gol
6524 -foptimize-sibling-calls @gol
6525 -fpartial-inlining @gol
6526 -fpeephole2 @gol
6527 -fregmove @gol
6528 -freorder-blocks  -freorder-functions @gol
6529 -frerun-cse-after-loop  @gol
6530 -fsched-interblock  -fsched-spec @gol
6531 -fschedule-insns  -fschedule-insns2 @gol
6532 -fstrict-aliasing -fstrict-overflow @gol
6533 -ftree-switch-conversion -ftree-tail-merge @gol
6534 -ftree-pre @gol
6535 -ftree-vrp}
6537 Please note the warning under @option{-fgcse} about
6538 invoking @option{-O2} on programs that use computed gotos.
6540 @item -O3
6541 @opindex O3
6542 Optimize yet more.  @option{-O3} turns on all optimizations specified
6543 by @option{-O2} and also turns on the @option{-finline-functions},
6544 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6545 @option{-fgcse-after-reload}, @option{-ftree-vectorize},
6546 @option{-fvect-cost-model},
6547 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6549 @item -O0
6550 @opindex O0
6551 Reduce compilation time and make debugging produce the expected
6552 results.  This is the default.
6554 @item -Os
6555 @opindex Os
6556 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6557 do not typically increase code size.  It also performs further
6558 optimizations designed to reduce code size.
6560 @option{-Os} disables the following optimization flags:
6561 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6562 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6563 -fprefetch-loop-arrays  -ftree-vect-loop-version}
6565 @item -Ofast
6566 @opindex Ofast
6567 Disregard strict standards compliance.  @option{-Ofast} enables all
6568 @option{-O3} optimizations.  It also enables optimizations that are not
6569 valid for all standard-compliant programs.
6570 It turns on @option{-ffast-math} and the Fortran-specific
6571 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6573 @item -Og
6574 @opindex Og
6575 Optimize debugging experience.  @option{-Og} enables optimizations
6576 that do not interfere with debugging. It should be the optimization
6577 level of choice for the standard edit-compile-debug cycle, offering
6578 a reasonable level of optimization while maintaining fast compilation
6579 and a good debugging experience.
6581 If you use multiple @option{-O} options, with or without level numbers,
6582 the last such option is the one that is effective.
6583 @end table
6585 Options of the form @option{-f@var{flag}} specify machine-independent
6586 flags.  Most flags have both positive and negative forms; the negative
6587 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6588 below, only one of the forms is listed---the one you typically 
6589 use.  You can figure out the other form by either removing @samp{no-}
6590 or adding it.
6592 The following options control specific optimizations.  They are either
6593 activated by @option{-O} options or are related to ones that are.  You
6594 can use the following flags in the rare cases when ``fine-tuning'' of
6595 optimizations to be performed is desired.
6597 @table @gcctabopt
6598 @item -fno-default-inline
6599 @opindex fno-default-inline
6600 Do not make member functions inline by default merely because they are
6601 defined inside the class scope (C++ only).  Otherwise, when you specify
6602 @w{@option{-O}}, member functions defined inside class scope are compiled
6603 inline by default; i.e., you don't need to add @samp{inline} in front of
6604 the member function name.
6606 @item -fno-defer-pop
6607 @opindex fno-defer-pop
6608 Always pop the arguments to each function call as soon as that function
6609 returns.  For machines that must pop arguments after a function call,
6610 the compiler normally lets arguments accumulate on the stack for several
6611 function calls and pops them all at once.
6613 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6615 @item -fforward-propagate
6616 @opindex fforward-propagate
6617 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6618 instructions and checks if the result can be simplified.  If loop unrolling
6619 is active, two passes are performed and the second is scheduled after
6620 loop unrolling.
6622 This option is enabled by default at optimization levels @option{-O},
6623 @option{-O2}, @option{-O3}, @option{-Os}.
6625 @item -ffp-contract=@var{style}
6626 @opindex ffp-contract
6627 @option{-ffp-contract=off} disables floating-point expression contraction.
6628 @option{-ffp-contract=fast} enables floating-point expression contraction
6629 such as forming of fused multiply-add operations if the target has
6630 native support for them.
6631 @option{-ffp-contract=on} enables floating-point expression contraction
6632 if allowed by the language standard.  This is currently not implemented
6633 and treated equal to @option{-ffp-contract=off}.
6635 The default is @option{-ffp-contract=fast}.
6637 @item -fomit-frame-pointer
6638 @opindex fomit-frame-pointer
6639 Don't keep the frame pointer in a register for functions that
6640 don't need one.  This avoids the instructions to save, set up and
6641 restore frame pointers; it also makes an extra register available
6642 in many functions.  @strong{It also makes debugging impossible on
6643 some machines.}
6645 On some machines, such as the VAX, this flag has no effect, because
6646 the standard calling sequence automatically handles the frame pointer
6647 and nothing is saved by pretending it doesn't exist.  The
6648 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6649 whether a target machine supports this flag.  @xref{Registers,,Register
6650 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6652 Starting with GCC version 4.6, the default setting (when not optimizing for
6653 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6654 @option{-fomit-frame-pointer}.  The default can be reverted to
6655 @option{-fno-omit-frame-pointer} by configuring GCC with the
6656 @option{--enable-frame-pointer} configure option.
6658 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6660 @item -foptimize-sibling-calls
6661 @opindex foptimize-sibling-calls
6662 Optimize sibling and tail recursive calls.
6664 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6666 @item -fno-inline
6667 @opindex fno-inline
6668 Do not expand any functions inline apart from those marked with
6669 the @code{always_inline} attribute.  This is the default when not
6670 optimizing.
6672 Single functions can be exempted from inlining by marking them
6673 with the @code{noinline} attribute.
6675 @item -finline-small-functions
6676 @opindex finline-small-functions
6677 Integrate functions into their callers when their body is smaller than expected
6678 function call code (so overall size of program gets smaller).  The compiler
6679 heuristically decides which functions are simple enough to be worth integrating
6680 in this way.  This inlining applies to all functions, even those not declared
6681 inline.
6683 Enabled at level @option{-O2}.
6685 @item -findirect-inlining
6686 @opindex findirect-inlining
6687 Inline also indirect calls that are discovered to be known at compile
6688 time thanks to previous inlining.  This option has any effect only
6689 when inlining itself is turned on by the @option{-finline-functions}
6690 or @option{-finline-small-functions} options.
6692 Enabled at level @option{-O2}.
6694 @item -finline-functions
6695 @opindex finline-functions
6696 Consider all functions for inlining, even if they are not declared inline.
6697 The compiler heuristically decides which functions are worth integrating
6698 in this way.
6700 If all calls to a given function are integrated, and the function is
6701 declared @code{static}, then the function is normally not output as
6702 assembler code in its own right.
6704 Enabled at level @option{-O3}.
6706 @item -finline-functions-called-once
6707 @opindex finline-functions-called-once
6708 Consider all @code{static} functions called once for inlining into their
6709 caller even if they are not marked @code{inline}.  If a call to a given
6710 function is integrated, then the function is not output as assembler code
6711 in its own right.
6713 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6715 @item -fearly-inlining
6716 @opindex fearly-inlining
6717 Inline functions marked by @code{always_inline} and functions whose body seems
6718 smaller than the function call overhead early before doing
6719 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6720 makes profiling significantly cheaper and usually inlining faster on programs
6721 having large chains of nested wrapper functions.
6723 Enabled by default.
6725 @item -fipa-sra
6726 @opindex fipa-sra
6727 Perform interprocedural scalar replacement of aggregates, removal of
6728 unused parameters and replacement of parameters passed by reference
6729 by parameters passed by value.
6731 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6733 @item -finline-limit=@var{n}
6734 @opindex finline-limit
6735 By default, GCC limits the size of functions that can be inlined.  This flag
6736 allows coarse control of this limit.  @var{n} is the size of functions that
6737 can be inlined in number of pseudo instructions.
6739 Inlining is actually controlled by a number of parameters, which may be
6740 specified individually by using @option{--param @var{name}=@var{value}}.
6741 The @option{-finline-limit=@var{n}} option sets some of these parameters
6742 as follows:
6744 @table @gcctabopt
6745 @item max-inline-insns-single
6746 is set to @var{n}/2.
6747 @item max-inline-insns-auto
6748 is set to @var{n}/2.
6749 @end table
6751 See below for a documentation of the individual
6752 parameters controlling inlining and for the defaults of these parameters.
6754 @emph{Note:} there may be no value to @option{-finline-limit} that results
6755 in default behavior.
6757 @emph{Note:} pseudo instruction represents, in this particular context, an
6758 abstract measurement of function's size.  In no way does it represent a count
6759 of assembly instructions and as such its exact meaning might change from one
6760 release to an another.
6762 @item -fno-keep-inline-dllexport
6763 @opindex -fno-keep-inline-dllexport
6764 This is a more fine-grained version of @option{-fkeep-inline-functions},
6765 which applies only to functions that are declared using the @code{dllexport}
6766 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6767 Functions}.)
6769 @item -fkeep-inline-functions
6770 @opindex fkeep-inline-functions
6771 In C, emit @code{static} functions that are declared @code{inline}
6772 into the object file, even if the function has been inlined into all
6773 of its callers.  This switch does not affect functions using the
6774 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6775 inline functions into the object file.
6777 @item -fkeep-static-consts
6778 @opindex fkeep-static-consts
6779 Emit variables declared @code{static const} when optimization isn't turned
6780 on, even if the variables aren't referenced.
6782 GCC enables this option by default.  If you want to force the compiler to
6783 check if a variable is referenced, regardless of whether or not
6784 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6786 @item -fmerge-constants
6787 @opindex fmerge-constants
6788 Attempt to merge identical constants (string constants and floating-point
6789 constants) across compilation units.
6791 This option is the default for optimized compilation if the assembler and
6792 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6793 behavior.
6795 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6797 @item -fmerge-all-constants
6798 @opindex fmerge-all-constants
6799 Attempt to merge identical constants and identical variables.
6801 This option implies @option{-fmerge-constants}.  In addition to
6802 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6803 arrays or initialized constant variables with integral or floating-point
6804 types.  Languages like C or C++ require each variable, including multiple
6805 instances of the same variable in recursive calls, to have distinct locations,
6806 so using this option results in non-conforming
6807 behavior.
6809 @item -fmodulo-sched
6810 @opindex fmodulo-sched
6811 Perform swing modulo scheduling immediately before the first scheduling
6812 pass.  This pass looks at innermost loops and reorders their
6813 instructions by overlapping different iterations.
6815 @item -fmodulo-sched-allow-regmoves
6816 @opindex fmodulo-sched-allow-regmoves
6817 Perform more aggressive SMS-based modulo scheduling with register moves
6818 allowed.  By setting this flag certain anti-dependences edges are
6819 deleted, which triggers the generation of reg-moves based on the
6820 life-range analysis.  This option is effective only with
6821 @option{-fmodulo-sched} enabled.
6823 @item -fno-branch-count-reg
6824 @opindex fno-branch-count-reg
6825 Do not use ``decrement and branch'' instructions on a count register,
6826 but instead generate a sequence of instructions that decrement a
6827 register, compare it against zero, then branch based upon the result.
6828 This option is only meaningful on architectures that support such
6829 instructions, which include x86, PowerPC, IA-64 and S/390.
6831 The default is @option{-fbranch-count-reg}.
6833 @item -fno-function-cse
6834 @opindex fno-function-cse
6835 Do not put function addresses in registers; make each instruction that
6836 calls a constant function contain the function's address explicitly.
6838 This option results in less efficient code, but some strange hacks
6839 that alter the assembler output may be confused by the optimizations
6840 performed when this option is not used.
6842 The default is @option{-ffunction-cse}
6844 @item -fno-zero-initialized-in-bss
6845 @opindex fno-zero-initialized-in-bss
6846 If the target supports a BSS section, GCC by default puts variables that
6847 are initialized to zero into BSS@.  This can save space in the resulting
6848 code.
6850 This option turns off this behavior because some programs explicitly
6851 rely on variables going to the data section---e.g., so that the
6852 resulting executable can find the beginning of that section and/or make
6853 assumptions based on that.
6855 The default is @option{-fzero-initialized-in-bss}.
6857 @item -faddress-sanitizer
6858 Enable AddressSanitizer, a fast memory error detector.
6859 Memory access instructions will be instrumented to detect
6860 out-of-bounds and use-after-free bugs. So far only heap bugs will be detected.
6861 See @uref{http://code.google.com/p/address-sanitizer/} for more details.
6863 @item -fmudflap -fmudflapth -fmudflapir
6864 @opindex fmudflap
6865 @opindex fmudflapth
6866 @opindex fmudflapir
6867 @cindex bounds checking
6868 @cindex mudflap
6869 For front-ends that support it (C and C++), instrument all risky
6870 pointer/array dereferencing operations, some standard library
6871 string/heap functions, and some other associated constructs with
6872 range/validity tests.  Modules so instrumented should be immune to
6873 buffer overflows, invalid heap use, and some other classes of C/C++
6874 programming errors.  The instrumentation relies on a separate runtime
6875 library (@file{libmudflap}), which is linked into a program if
6876 @option{-fmudflap} is given at link time.  Run-time behavior of the
6877 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6878 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6879 for its options.
6881 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6882 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6883 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6884 instrumentation should ignore pointer reads.  This produces less
6885 instrumentation (and therefore faster execution) and still provides
6886 some protection against outright memory corrupting writes, but allows
6887 erroneously read data to propagate within a program.
6889 @item -fthread-jumps
6890 @opindex fthread-jumps
6891 Perform optimizations that check to see if a jump branches to a
6892 location where another comparison subsumed by the first is found.  If
6893 so, the first branch is redirected to either the destination of the
6894 second branch or a point immediately following it, depending on whether
6895 the condition is known to be true or false.
6897 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6899 @item -fsplit-wide-types
6900 @opindex fsplit-wide-types
6901 When using a type that occupies multiple registers, such as @code{long
6902 long} on a 32-bit system, split the registers apart and allocate them
6903 independently.  This normally generates better code for those types,
6904 but may make debugging more difficult.
6906 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6907 @option{-Os}.
6909 @item -fcse-follow-jumps
6910 @opindex fcse-follow-jumps
6911 In common subexpression elimination (CSE), scan through jump instructions
6912 when the target of the jump is not reached by any other path.  For
6913 example, when CSE encounters an @code{if} statement with an
6914 @code{else} clause, CSE follows the jump when the condition
6915 tested is false.
6917 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6919 @item -fcse-skip-blocks
6920 @opindex fcse-skip-blocks
6921 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6922 follow jumps that conditionally skip over blocks.  When CSE
6923 encounters a simple @code{if} statement with no else clause,
6924 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6925 body of the @code{if}.
6927 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6929 @item -frerun-cse-after-loop
6930 @opindex frerun-cse-after-loop
6931 Re-run common subexpression elimination after loop optimizations are
6932 performed.
6934 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6936 @item -fgcse
6937 @opindex fgcse
6938 Perform a global common subexpression elimination pass.
6939 This pass also performs global constant and copy propagation.
6941 @emph{Note:} When compiling a program using computed gotos, a GCC
6942 extension, you may get better run-time performance if you disable
6943 the global common subexpression elimination pass by adding
6944 @option{-fno-gcse} to the command line.
6946 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6948 @item -fgcse-lm
6949 @opindex fgcse-lm
6950 When @option{-fgcse-lm} is enabled, global common subexpression elimination
6951 attempts to move loads that are only killed by stores into themselves.  This
6952 allows a loop containing a load/store sequence to be changed to a load outside
6953 the loop, and a copy/store within the loop.
6955 Enabled by default when @option{-fgcse} is enabled.
6957 @item -fgcse-sm
6958 @opindex fgcse-sm
6959 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6960 global common subexpression elimination.  This pass attempts to move
6961 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6962 loops containing a load/store sequence can be changed to a load before
6963 the loop and a store after the loop.
6965 Not enabled at any optimization level.
6967 @item -fgcse-las
6968 @opindex fgcse-las
6969 When @option{-fgcse-las} is enabled, the global common subexpression
6970 elimination pass eliminates redundant loads that come after stores to the
6971 same memory location (both partial and full redundancies).
6973 Not enabled at any optimization level.
6975 @item -fgcse-after-reload
6976 @opindex fgcse-after-reload
6977 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6978 pass is performed after reload.  The purpose of this pass is to clean up
6979 redundant spilling.
6981 @item -funsafe-loop-optimizations
6982 @opindex funsafe-loop-optimizations
6983 This option tells the loop optimizer to assume that loop indices do not
6984 overflow, and that loops with nontrivial exit condition are not
6985 infinite.  This enables a wider range of loop optimizations even if
6986 the loop optimizer itself cannot prove that these assumptions are valid.
6987 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
6988 if it finds this kind of loop.
6990 @item -fcrossjumping
6991 @opindex fcrossjumping
6992 Perform cross-jumping transformation.
6993 This transformation unifies equivalent code and saves code size.  The
6994 resulting code may or may not perform better than without cross-jumping.
6996 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6998 @item -fauto-inc-dec
6999 @opindex fauto-inc-dec
7000 Combine increments or decrements of addresses with memory accesses.
7001 This pass is always skipped on architectures that do not have
7002 instructions to support this.  Enabled by default at @option{-O} and
7003 higher on architectures that support this.
7005 @item -fdce
7006 @opindex fdce
7007 Perform dead code elimination (DCE) on RTL@.
7008 Enabled by default at @option{-O} and higher.
7010 @item -fdse
7011 @opindex fdse
7012 Perform dead store elimination (DSE) on RTL@.
7013 Enabled by default at @option{-O} and higher.
7015 @item -fif-conversion
7016 @opindex fif-conversion
7017 Attempt to transform conditional jumps into branch-less equivalents.  This
7018 includes use of conditional moves, min, max, set flags and abs instructions, and
7019 some tricks doable by standard arithmetics.  The use of conditional execution
7020 on chips where it is available is controlled by @code{if-conversion2}.
7022 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7024 @item -fif-conversion2
7025 @opindex fif-conversion2
7026 Use conditional execution (where available) to transform conditional jumps into
7027 branch-less equivalents.
7029 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7031 @item -fdelete-null-pointer-checks
7032 @opindex fdelete-null-pointer-checks
7033 Assume that programs cannot safely dereference null pointers, and that
7034 no code or data element resides there.  This enables simple constant
7035 folding optimizations at all optimization levels.  In addition, other
7036 optimization passes in GCC use this flag to control global dataflow
7037 analyses that eliminate useless checks for null pointers; these assume
7038 that if a pointer is checked after it has already been dereferenced,
7039 it cannot be null.
7041 Note however that in some environments this assumption is not true.
7042 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7043 for programs that depend on that behavior.
7045 Some targets, especially embedded ones, disable this option at all levels.
7046 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7047 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7048 are enabled independently at different optimization levels.
7050 @item -fdevirtualize
7051 @opindex fdevirtualize
7052 Attempt to convert calls to virtual functions to direct calls.  This
7053 is done both within a procedure and interprocedurally as part of
7054 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7055 propagation (@option{-fipa-cp}).
7056 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7058 @item -fexpensive-optimizations
7059 @opindex fexpensive-optimizations
7060 Perform a number of minor optimizations that are relatively expensive.
7062 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7064 @item -free
7065 @opindex free
7066 Attempt to remove redundant extension instructions.  This is especially
7067 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7068 registers after writing to their lower 32-bit half.
7070 Enabled for x86 at levels @option{-O2}, @option{-O3}.
7072 @item -foptimize-register-move
7073 @itemx -fregmove
7074 @opindex foptimize-register-move
7075 @opindex fregmove
7076 Attempt to reassign register numbers in move instructions and as
7077 operands of other simple instructions in order to maximize the amount of
7078 register tying.  This is especially helpful on machines with two-operand
7079 instructions.
7081 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
7082 optimization.
7084 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7086 @item -fira-algorithm=@var{algorithm}
7087 Use the specified coloring algorithm for the integrated register
7088 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7089 specifies Chow's priority coloring, or @samp{CB}, which specifies
7090 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7091 for all architectures, but for those targets that do support it, it is
7092 the default because it generates better code.
7094 @item -fira-region=@var{region}
7095 Use specified regions for the integrated register allocator.  The
7096 @var{region} argument should be one of the following:
7098 @table @samp
7100 @item all
7101 Use all loops as register allocation regions.
7102 This can give the best results for machines with a small and/or
7103 irregular register set.
7105 @item mixed
7106 Use all loops except for loops with small register pressure 
7107 as the regions.  This value usually gives
7108 the best results in most cases and for most architectures,
7109 and is enabled by default when compiling with optimization for speed
7110 (@option{-O}, @option{-O2}, @dots{}).
7112 @item one
7113 Use all functions as a single region.  
7114 This typically results in the smallest code size, and is enabled by default for
7115 @option{-Os} or @option{-O0}.
7117 @end table
7119 @item -fira-hoist-pressure
7120 @opindex fira-hoist-pressure
7121 Use IRA to evaluate register pressure in the code hoisting pass for
7122 decisions to hoist expressions.  This option usually results in smaller
7123 code, but it can slow the compiler down.
7125 This option is enabled at level @option{-Os} for all targets.
7127 @item -fira-loop-pressure
7128 @opindex fira-loop-pressure
7129 Use IRA to evaluate register pressure in loops for decisions to move
7130 loop invariants.  This option usually results in generation
7131 of faster and smaller code on machines with large register files (>= 32
7132 registers), but it can slow the compiler down.
7134 This option is enabled at level @option{-O3} for some targets.
7136 @item -fno-ira-share-save-slots
7137 @opindex fno-ira-share-save-slots
7138 Disable sharing of stack slots used for saving call-used hard
7139 registers living through a call.  Each hard register gets a
7140 separate stack slot, and as a result function stack frames are
7141 larger.
7143 @item -fno-ira-share-spill-slots
7144 @opindex fno-ira-share-spill-slots
7145 Disable sharing of stack slots allocated for pseudo-registers.  Each
7146 pseudo-register that does not get a hard register gets a separate
7147 stack slot, and as a result function stack frames are larger.
7149 @item -fira-verbose=@var{n}
7150 @opindex fira-verbose
7151 Control the verbosity of the dump file for the integrated register allocator.
7152 The default value is 5.  If the value @var{n} is greater or equal to 10,
7153 the dump output is sent to stderr using the same format as @var{n} minus 10.
7155 @item -fdelayed-branch
7156 @opindex fdelayed-branch
7157 If supported for the target machine, attempt to reorder instructions
7158 to exploit instruction slots available after delayed branch
7159 instructions.
7161 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7163 @item -fschedule-insns
7164 @opindex fschedule-insns
7165 If supported for the target machine, attempt to reorder instructions to
7166 eliminate execution stalls due to required data being unavailable.  This
7167 helps machines that have slow floating point or memory load instructions
7168 by allowing other instructions to be issued until the result of the load
7169 or floating-point instruction is required.
7171 Enabled at levels @option{-O2}, @option{-O3}.
7173 @item -fschedule-insns2
7174 @opindex fschedule-insns2
7175 Similar to @option{-fschedule-insns}, but requests an additional pass of
7176 instruction scheduling after register allocation has been done.  This is
7177 especially useful on machines with a relatively small number of
7178 registers and where memory load instructions take more than one cycle.
7180 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7182 @item -fno-sched-interblock
7183 @opindex fno-sched-interblock
7184 Don't schedule instructions across basic blocks.  This is normally
7185 enabled by default when scheduling before register allocation, i.e.@:
7186 with @option{-fschedule-insns} or at @option{-O2} or higher.
7188 @item -fno-sched-spec
7189 @opindex fno-sched-spec
7190 Don't allow speculative motion of non-load instructions.  This is normally
7191 enabled by default when scheduling before register allocation, i.e.@:
7192 with @option{-fschedule-insns} or at @option{-O2} or higher.
7194 @item -fsched-pressure
7195 @opindex fsched-pressure
7196 Enable register pressure sensitive insn scheduling before register
7197 allocation.  This only makes sense when scheduling before register
7198 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7199 @option{-O2} or higher.  Usage of this option can improve the
7200 generated code and decrease its size by preventing register pressure
7201 increase above the number of available hard registers and subsequent
7202 spills in register allocation.
7204 @item -fsched-spec-load
7205 @opindex fsched-spec-load
7206 Allow speculative motion of some load instructions.  This only makes
7207 sense when scheduling before register allocation, i.e.@: with
7208 @option{-fschedule-insns} or at @option{-O2} or higher.
7210 @item -fsched-spec-load-dangerous
7211 @opindex fsched-spec-load-dangerous
7212 Allow speculative motion of more load instructions.  This only makes
7213 sense when scheduling before register allocation, i.e.@: with
7214 @option{-fschedule-insns} or at @option{-O2} or higher.
7216 @item -fsched-stalled-insns
7217 @itemx -fsched-stalled-insns=@var{n}
7218 @opindex fsched-stalled-insns
7219 Define how many insns (if any) can be moved prematurely from the queue
7220 of stalled insns into the ready list during the second scheduling pass.
7221 @option{-fno-sched-stalled-insns} means that no insns are moved
7222 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7223 on how many queued insns can be moved prematurely.
7224 @option{-fsched-stalled-insns} without a value is equivalent to
7225 @option{-fsched-stalled-insns=1}.
7227 @item -fsched-stalled-insns-dep
7228 @itemx -fsched-stalled-insns-dep=@var{n}
7229 @opindex fsched-stalled-insns-dep
7230 Define how many insn groups (cycles) are examined for a dependency
7231 on a stalled insn that is a candidate for premature removal from the queue
7232 of stalled insns.  This has an effect only during the second scheduling pass,
7233 and only if @option{-fsched-stalled-insns} is used.
7234 @option{-fno-sched-stalled-insns-dep} is equivalent to
7235 @option{-fsched-stalled-insns-dep=0}.
7236 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7237 @option{-fsched-stalled-insns-dep=1}.
7239 @item -fsched2-use-superblocks
7240 @opindex fsched2-use-superblocks
7241 When scheduling after register allocation, use superblock scheduling.
7242 This allows motion across basic block boundaries,
7243 resulting in faster schedules.  This option is experimental, as not all machine
7244 descriptions used by GCC model the CPU closely enough to avoid unreliable
7245 results from the algorithm.
7247 This only makes sense when scheduling after register allocation, i.e.@: with
7248 @option{-fschedule-insns2} or at @option{-O2} or higher.
7250 @item -fsched-group-heuristic
7251 @opindex fsched-group-heuristic
7252 Enable the group heuristic in the scheduler.  This heuristic favors
7253 the instruction that belongs to a schedule group.  This is enabled
7254 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7255 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7257 @item -fsched-critical-path-heuristic
7258 @opindex fsched-critical-path-heuristic
7259 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7260 instructions on the critical path.  This is enabled by default when
7261 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7262 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7264 @item -fsched-spec-insn-heuristic
7265 @opindex fsched-spec-insn-heuristic
7266 Enable the speculative instruction heuristic in the scheduler.  This
7267 heuristic favors speculative instructions with greater dependency weakness.
7268 This is enabled by default when scheduling is enabled, i.e.@:
7269 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7270 or at @option{-O2} or higher.
7272 @item -fsched-rank-heuristic
7273 @opindex fsched-rank-heuristic
7274 Enable the rank heuristic in the scheduler.  This heuristic favors
7275 the instruction belonging to a basic block with greater size or frequency.
7276 This is enabled by default when scheduling is enabled, i.e.@:
7277 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7278 at @option{-O2} or higher.
7280 @item -fsched-last-insn-heuristic
7281 @opindex fsched-last-insn-heuristic
7282 Enable the last-instruction heuristic in the scheduler.  This heuristic
7283 favors the instruction that is less dependent on the last instruction
7284 scheduled.  This is enabled by default when scheduling is enabled,
7285 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7286 at @option{-O2} or higher.
7288 @item -fsched-dep-count-heuristic
7289 @opindex fsched-dep-count-heuristic
7290 Enable the dependent-count heuristic in the scheduler.  This heuristic
7291 favors the instruction that has more instructions depending on it.
7292 This is enabled by default when scheduling is enabled, i.e.@:
7293 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7294 at @option{-O2} or higher.
7296 @item -freschedule-modulo-scheduled-loops
7297 @opindex freschedule-modulo-scheduled-loops
7298 Modulo scheduling is performed before traditional scheduling.  If a loop
7299 is modulo scheduled, later scheduling passes may change its schedule.  
7300 Use this option to control that behavior.
7302 @item -fselective-scheduling
7303 @opindex fselective-scheduling
7304 Schedule instructions using selective scheduling algorithm.  Selective
7305 scheduling runs instead of the first scheduler pass.
7307 @item -fselective-scheduling2
7308 @opindex fselective-scheduling2
7309 Schedule instructions using selective scheduling algorithm.  Selective
7310 scheduling runs instead of the second scheduler pass.
7312 @item -fsel-sched-pipelining
7313 @opindex fsel-sched-pipelining
7314 Enable software pipelining of innermost loops during selective scheduling.
7315 This option has no effect unless one of @option{-fselective-scheduling} or
7316 @option{-fselective-scheduling2} is turned on.
7318 @item -fsel-sched-pipelining-outer-loops
7319 @opindex fsel-sched-pipelining-outer-loops
7320 When pipelining loops during selective scheduling, also pipeline outer loops.
7321 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7323 @item -fshrink-wrap
7324 @opindex fshrink-wrap
7325 Emit function prologues only before parts of the function that need it,
7326 rather than at the top of the function.  This flag is enabled by default at
7327 @option{-O} and higher.
7329 @item -fcaller-saves
7330 @opindex fcaller-saves
7331 Enable allocation of values to registers that are clobbered by
7332 function calls, by emitting extra instructions to save and restore the
7333 registers around such calls.  Such allocation is done only when it
7334 seems to result in better code.
7336 This option is always enabled by default on certain machines, usually
7337 those which have no call-preserved registers to use instead.
7339 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7341 @item -fcombine-stack-adjustments
7342 @opindex fcombine-stack-adjustments
7343 Tracks stack adjustments (pushes and pops) and stack memory references
7344 and then tries to find ways to combine them.
7346 Enabled by default at @option{-O1} and higher.
7348 @item -fconserve-stack
7349 @opindex fconserve-stack
7350 Attempt to minimize stack usage.  The compiler attempts to use less
7351 stack space, even if that makes the program slower.  This option
7352 implies setting the @option{large-stack-frame} parameter to 100
7353 and the @option{large-stack-frame-growth} parameter to 400.
7355 @item -ftree-reassoc
7356 @opindex ftree-reassoc
7357 Perform reassociation on trees.  This flag is enabled by default
7358 at @option{-O} and higher.
7360 @item -ftree-pre
7361 @opindex ftree-pre
7362 Perform partial redundancy elimination (PRE) on trees.  This flag is
7363 enabled by default at @option{-O2} and @option{-O3}.
7365 @item -ftree-partial-pre
7366 @opindex ftree-partial-pre
7367 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7368 enabled by default at @option{-O3}.
7370 @item -ftree-forwprop
7371 @opindex ftree-forwprop
7372 Perform forward propagation on trees.  This flag is enabled by default
7373 at @option{-O} and higher.
7375 @item -ftree-fre
7376 @opindex ftree-fre
7377 Perform full redundancy elimination (FRE) on trees.  The difference
7378 between FRE and PRE is that FRE only considers expressions
7379 that are computed on all paths leading to the redundant computation.
7380 This analysis is faster than PRE, though it exposes fewer redundancies.
7381 This flag is enabled by default at @option{-O} and higher.
7383 @item -ftree-phiprop
7384 @opindex ftree-phiprop
7385 Perform hoisting of loads from conditional pointers on trees.  This
7386 pass is enabled by default at @option{-O} and higher.
7388 @item -fhoist-adjacent-loads
7389 @opindex hoist-adjacent-loads
7390 Speculatively hoist loads from both branches of an if-then-else if the
7391 loads are from adjacent locations in the same structure and the target
7392 architecture has a conditional move instruction.  This flag is enabled
7393 by default at @option{-O2} and higher.
7395 @item -ftree-copy-prop
7396 @opindex ftree-copy-prop
7397 Perform copy propagation on trees.  This pass eliminates unnecessary
7398 copy operations.  This flag is enabled by default at @option{-O} and
7399 higher.
7401 @item -fipa-pure-const
7402 @opindex fipa-pure-const
7403 Discover which functions are pure or constant.
7404 Enabled by default at @option{-O} and higher.
7406 @item -fipa-reference
7407 @opindex fipa-reference
7408 Discover which static variables do not escape the
7409 compilation unit.
7410 Enabled by default at @option{-O} and higher.
7412 @item -fipa-pta
7413 @opindex fipa-pta
7414 Perform interprocedural pointer analysis and interprocedural modification
7415 and reference analysis.  This option can cause excessive memory and
7416 compile-time usage on large compilation units.  It is not enabled by
7417 default at any optimization level.
7419 @item -fipa-profile
7420 @opindex fipa-profile
7421 Perform interprocedural profile propagation.  The functions called only from
7422 cold functions are marked as cold. Also functions executed once (such as
7423 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7424 functions and loop less parts of functions executed once are then optimized for
7425 size.
7426 Enabled by default at @option{-O} and higher.
7428 @item -fipa-cp
7429 @opindex fipa-cp
7430 Perform interprocedural constant propagation.
7431 This optimization analyzes the program to determine when values passed
7432 to functions are constants and then optimizes accordingly.
7433 This optimization can substantially increase performance
7434 if the application has constants passed to functions.
7435 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7437 @item -fipa-cp-clone
7438 @opindex fipa-cp-clone
7439 Perform function cloning to make interprocedural constant propagation stronger.
7440 When enabled, interprocedural constant propagation performs function cloning
7441 when externally visible function can be called with constant arguments.
7442 Because this optimization can create multiple copies of functions,
7443 it may significantly increase code size
7444 (see @option{--param ipcp-unit-growth=@var{value}}).
7445 This flag is enabled by default at @option{-O3}.
7447 @item -ftree-sink
7448 @opindex ftree-sink
7449 Perform forward store motion  on trees.  This flag is
7450 enabled by default at @option{-O} and higher.
7452 @item -ftree-bit-ccp
7453 @opindex ftree-bit-ccp
7454 Perform sparse conditional bit constant propagation on trees and propagate
7455 pointer alignment information.
7456 This pass only operates on local scalar variables and is enabled by default
7457 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7459 @item -ftree-ccp
7460 @opindex ftree-ccp
7461 Perform sparse conditional constant propagation (CCP) on trees.  This
7462 pass only operates on local scalar variables and is enabled by default
7463 at @option{-O} and higher.
7465 @item -ftree-switch-conversion
7466 Perform conversion of simple initializations in a switch to
7467 initializations from a scalar array.  This flag is enabled by default
7468 at @option{-O2} and higher.
7470 @item -ftree-tail-merge
7471 Look for identical code sequences.  When found, replace one with a jump to the
7472 other.  This optimization is known as tail merging or cross jumping.  This flag
7473 is enabled by default at @option{-O2} and higher.  The compilation time
7474 in this pass can
7475 be limited using @option{max-tail-merge-comparisons} parameter and
7476 @option{max-tail-merge-iterations} parameter.
7478 @item -ftree-dce
7479 @opindex ftree-dce
7480 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7481 default at @option{-O} and higher.
7483 @item -ftree-builtin-call-dce
7484 @opindex ftree-builtin-call-dce
7485 Perform conditional dead code elimination (DCE) for calls to built-in functions
7486 that may set @code{errno} but are otherwise side-effect free.  This flag is
7487 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7488 specified.
7490 @item -ftree-dominator-opts
7491 @opindex ftree-dominator-opts
7492 Perform a variety of simple scalar cleanups (constant/copy
7493 propagation, redundancy elimination, range propagation and expression
7494 simplification) based on a dominator tree traversal.  This also
7495 performs jump threading (to reduce jumps to jumps). This flag is
7496 enabled by default at @option{-O} and higher.
7498 @item -ftree-dse
7499 @opindex ftree-dse
7500 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7501 a memory location that is later overwritten by another store without
7502 any intervening loads.  In this case the earlier store can be deleted.  This
7503 flag is enabled by default at @option{-O} and higher.
7505 @item -ftree-ch
7506 @opindex ftree-ch
7507 Perform loop header copying on trees.  This is beneficial since it increases
7508 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7509 is enabled by default at @option{-O} and higher.  It is not enabled
7510 for @option{-Os}, since it usually increases code size.
7512 @item -ftree-loop-optimize
7513 @opindex ftree-loop-optimize
7514 Perform loop optimizations on trees.  This flag is enabled by default
7515 at @option{-O} and higher.
7517 @item -ftree-loop-linear
7518 @opindex ftree-loop-linear
7519 Perform loop interchange transformations on tree.  Same as
7520 @option{-floop-interchange}.  To use this code transformation, GCC has
7521 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7522 enable the Graphite loop transformation infrastructure.
7524 @item -floop-interchange
7525 @opindex floop-interchange
7526 Perform loop interchange transformations on loops.  Interchanging two
7527 nested loops switches the inner and outer loops.  For example, given a
7528 loop like:
7529 @smallexample
7530 DO J = 1, M
7531   DO I = 1, N
7532     A(J, I) = A(J, I) * C
7533   ENDDO
7534 ENDDO
7535 @end smallexample
7536 loop interchange transforms the loop as if it were written:
7537 @smallexample
7538 DO I = 1, N
7539   DO J = 1, M
7540     A(J, I) = A(J, I) * C
7541   ENDDO
7542 ENDDO
7543 @end smallexample
7544 which can be beneficial when @code{N} is larger than the caches,
7545 because in Fortran, the elements of an array are stored in memory
7546 contiguously by column, and the original loop iterates over rows,
7547 potentially creating at each access a cache miss.  This optimization
7548 applies to all the languages supported by GCC and is not limited to
7549 Fortran.  To use this code transformation, GCC has to be configured
7550 with @option{--with-ppl} and @option{--with-cloog} to enable the
7551 Graphite loop transformation infrastructure.
7553 @item -floop-strip-mine
7554 @opindex floop-strip-mine
7555 Perform loop strip mining transformations on loops.  Strip mining
7556 splits a loop into two nested loops.  The outer loop has strides
7557 equal to the strip size and the inner loop has strides of the
7558 original loop within a strip.  The strip length can be changed
7559 using the @option{loop-block-tile-size} parameter.  For example,
7560 given a loop like:
7561 @smallexample
7562 DO I = 1, N
7563   A(I) = A(I) + C
7564 ENDDO
7565 @end smallexample
7566 loop strip mining transforms the loop as if it were written:
7567 @smallexample
7568 DO II = 1, N, 51
7569   DO I = II, min (II + 50, N)
7570     A(I) = A(I) + C
7571   ENDDO
7572 ENDDO
7573 @end smallexample
7574 This optimization applies to all the languages supported by GCC and is
7575 not limited to Fortran.  To use this code transformation, GCC has to
7576 be configured with @option{--with-ppl} and @option{--with-cloog} to
7577 enable the Graphite loop transformation infrastructure.
7579 @item -floop-block
7580 @opindex floop-block
7581 Perform loop blocking transformations on loops.  Blocking strip mines
7582 each loop in the loop nest such that the memory accesses of the
7583 element loops fit inside caches.  The strip length can be changed
7584 using the @option{loop-block-tile-size} parameter.  For example, given
7585 a loop like:
7586 @smallexample
7587 DO I = 1, N
7588   DO J = 1, M
7589     A(J, I) = B(I) + C(J)
7590   ENDDO
7591 ENDDO
7592 @end smallexample
7593 loop blocking transforms the loop as if it were written:
7594 @smallexample
7595 DO II = 1, N, 51
7596   DO JJ = 1, M, 51
7597     DO I = II, min (II + 50, N)
7598       DO J = JJ, min (JJ + 50, M)
7599         A(J, I) = B(I) + C(J)
7600       ENDDO
7601     ENDDO
7602   ENDDO
7603 ENDDO
7604 @end smallexample
7605 which can be beneficial when @code{M} is larger than the caches,
7606 because the innermost loop iterates over a smaller amount of data
7607 which can be kept in the caches.  This optimization applies to all the
7608 languages supported by GCC and is not limited to Fortran.  To use this
7609 code transformation, GCC has to be configured with @option{--with-ppl}
7610 and @option{--with-cloog} to enable the Graphite loop transformation
7611 infrastructure.
7613 @item -fgraphite-identity
7614 @opindex fgraphite-identity
7615 Enable the identity transformation for graphite.  For every SCoP we generate
7616 the polyhedral representation and transform it back to gimple.  Using
7617 @option{-fgraphite-identity} we can check the costs or benefits of the
7618 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7619 are also performed by the code generator CLooG, like index splitting and
7620 dead code elimination in loops.
7622 @item -floop-nest-optimize
7623 @opindex floop-nest-optimize
7624 Enable the ISL based loop nest optimizer.  This is a generic loop nest
7625 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7626 structure optimized for data-locality and parallelism.  This option
7627 is experimental.
7629 @item -floop-parallelize-all
7630 @opindex floop-parallelize-all
7631 Use the Graphite data dependence analysis to identify loops that can
7632 be parallelized.  Parallelize all the loops that can be analyzed to
7633 not contain loop carried dependences without checking that it is
7634 profitable to parallelize the loops.
7636 @item -fcheck-data-deps
7637 @opindex fcheck-data-deps
7638 Compare the results of several data dependence analyzers.  This option
7639 is used for debugging the data dependence analyzers.
7641 @item -ftree-loop-if-convert
7642 Attempt to transform conditional jumps in the innermost loops to
7643 branch-less equivalents.  The intent is to remove control-flow from
7644 the innermost loops in order to improve the ability of the
7645 vectorization pass to handle these loops.  This is enabled by default
7646 if vectorization is enabled.
7648 @item -ftree-loop-if-convert-stores
7649 Attempt to also if-convert conditional jumps containing memory writes.
7650 This transformation can be unsafe for multi-threaded programs as it
7651 transforms conditional memory writes into unconditional memory writes.
7652 For example,
7653 @smallexample
7654 for (i = 0; i < N; i++)
7655   if (cond)
7656     A[i] = expr;
7657 @end smallexample
7658 is transformed to
7659 @smallexample
7660 for (i = 0; i < N; i++)
7661   A[i] = cond ? expr : A[i];
7662 @end smallexample
7663 potentially producing data races.
7665 @item -ftree-loop-distribution
7666 Perform loop distribution.  This flag can improve cache performance on
7667 big loop bodies and allow further loop optimizations, like
7668 parallelization or vectorization, to take place.  For example, the loop
7669 @smallexample
7670 DO I = 1, N
7671   A(I) = B(I) + C
7672   D(I) = E(I) * F
7673 ENDDO
7674 @end smallexample
7675 is transformed to
7676 @smallexample
7677 DO I = 1, N
7678    A(I) = B(I) + C
7679 ENDDO
7680 DO I = 1, N
7681    D(I) = E(I) * F
7682 ENDDO
7683 @end smallexample
7685 @item -ftree-loop-distribute-patterns
7686 Perform loop distribution of patterns that can be code generated with
7687 calls to a library.  This flag is enabled by default at @option{-O3}.
7689 This pass distributes the initialization loops and generates a call to
7690 memset zero.  For example, the loop
7691 @smallexample
7692 DO I = 1, N
7693   A(I) = 0
7694   B(I) = A(I) + I
7695 ENDDO
7696 @end smallexample
7697 is transformed to
7698 @smallexample
7699 DO I = 1, N
7700    A(I) = 0
7701 ENDDO
7702 DO I = 1, N
7703    B(I) = A(I) + I
7704 ENDDO
7705 @end smallexample
7706 and the initialization loop is transformed into a call to memset zero.
7708 @item -ftree-loop-im
7709 @opindex ftree-loop-im
7710 Perform loop invariant motion on trees.  This pass moves only invariants that
7711 are hard to handle at RTL level (function calls, operations that expand to
7712 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7713 operands of conditions that are invariant out of the loop, so that we can use
7714 just trivial invariantness analysis in loop unswitching.  The pass also includes
7715 store motion.
7717 @item -ftree-loop-ivcanon
7718 @opindex ftree-loop-ivcanon
7719 Create a canonical counter for number of iterations in loops for which
7720 determining number of iterations requires complicated analysis.  Later
7721 optimizations then may determine the number easily.  Useful especially
7722 in connection with unrolling.
7724 @item -fivopts
7725 @opindex fivopts
7726 Perform induction variable optimizations (strength reduction, induction
7727 variable merging and induction variable elimination) on trees.
7729 @item -ftree-parallelize-loops=n
7730 @opindex ftree-parallelize-loops
7731 Parallelize loops, i.e., split their iteration space to run in n threads.
7732 This is only possible for loops whose iterations are independent
7733 and can be arbitrarily reordered.  The optimization is only
7734 profitable on multiprocessor machines, for loops that are CPU-intensive,
7735 rather than constrained e.g.@: by memory bandwidth.  This option
7736 implies @option{-pthread}, and thus is only supported on targets
7737 that have support for @option{-pthread}.
7739 @item -ftree-pta
7740 @opindex ftree-pta
7741 Perform function-local points-to analysis on trees.  This flag is
7742 enabled by default at @option{-O} and higher.
7744 @item -ftree-sra
7745 @opindex ftree-sra
7746 Perform scalar replacement of aggregates.  This pass replaces structure
7747 references with scalars to prevent committing structures to memory too
7748 early.  This flag is enabled by default at @option{-O} and higher.
7750 @item -ftree-copyrename
7751 @opindex ftree-copyrename
7752 Perform copy renaming on trees.  This pass attempts to rename compiler
7753 temporaries to other variables at copy locations, usually resulting in
7754 variable names which more closely resemble the original variables.  This flag
7755 is enabled by default at @option{-O} and higher.
7757 @item -ftree-coalesce-inlined-vars
7758 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7759 combine small user-defined variables too, but only if they were inlined
7760 from other functions.  It is a more limited form of
7761 @option{-ftree-coalesce-vars}.  This may harm debug information of such
7762 inlined variables, but it will keep variables of the inlined-into
7763 function apart from each other, such that they are more likely to
7764 contain the expected values in a debugging session.  This was the
7765 default in GCC versions older than 4.7.
7767 @item -ftree-coalesce-vars
7768 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7769 combine small user-defined variables too, instead of just compiler
7770 temporaries.  This may severely limit the ability to debug an optimized
7771 program compiled with @option{-fno-var-tracking-assignments}.  In the
7772 negated form, this flag prevents SSA coalescing of user variables,
7773 including inlined ones.  This option is enabled by default.
7775 @item -ftree-ter
7776 @opindex ftree-ter
7777 Perform temporary expression replacement during the SSA->normal phase.  Single
7778 use/single def temporaries are replaced at their use location with their
7779 defining expression.  This results in non-GIMPLE code, but gives the expanders
7780 much more complex trees to work on resulting in better RTL generation.  This is
7781 enabled by default at @option{-O} and higher.
7783 @item -ftree-slsr
7784 @opindex ftree-slsr
7785 Perform straight-line strength reduction on trees.  This recognizes related
7786 expressions involving multiplications and replaces them by less expensive
7787 calculations when possible.  This is enabled by default at @option{-O} and
7788 higher.
7790 @item -ftree-vectorize
7791 @opindex ftree-vectorize
7792 Perform loop vectorization on trees. This flag is enabled by default at
7793 @option{-O3}.
7795 @item -ftree-slp-vectorize
7796 @opindex ftree-slp-vectorize
7797 Perform basic block vectorization on trees. This flag is enabled by default at
7798 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7800 @item -ftree-vect-loop-version
7801 @opindex ftree-vect-loop-version
7802 Perform loop versioning when doing loop vectorization on trees.  When a loop
7803 appears to be vectorizable except that data alignment or data dependence cannot
7804 be determined at compile time, then vectorized and non-vectorized versions of
7805 the loop are generated along with run-time checks for alignment or dependence
7806 to control which version is executed.  This option is enabled by default
7807 except at level @option{-Os} where it is disabled.
7809 @item -fvect-cost-model
7810 @opindex fvect-cost-model
7811 Enable cost model for vectorization.  This option is enabled by default at
7812 @option{-O3}.
7814 @item -ftree-vrp
7815 @opindex ftree-vrp
7816 Perform Value Range Propagation on trees.  This is similar to the
7817 constant propagation pass, but instead of values, ranges of values are
7818 propagated.  This allows the optimizers to remove unnecessary range
7819 checks like array bound checks and null pointer checks.  This is
7820 enabled by default at @option{-O2} and higher.  Null pointer check
7821 elimination is only done if @option{-fdelete-null-pointer-checks} is
7822 enabled.
7824 @item -ftracer
7825 @opindex ftracer
7826 Perform tail duplication to enlarge superblock size.  This transformation
7827 simplifies the control flow of the function allowing other optimizations to do
7828 a better job.
7830 @item -funroll-loops
7831 @opindex funroll-loops
7832 Unroll loops whose number of iterations can be determined at compile
7833 time or upon entry to the loop.  @option{-funroll-loops} implies
7834 @option{-frerun-cse-after-loop}.  This option makes code larger,
7835 and may or may not make it run faster.
7837 @item -funroll-all-loops
7838 @opindex funroll-all-loops
7839 Unroll all loops, even if their number of iterations is uncertain when
7840 the loop is entered.  This usually makes programs run more slowly.
7841 @option{-funroll-all-loops} implies the same options as
7842 @option{-funroll-loops},
7844 @item -fsplit-ivs-in-unroller
7845 @opindex fsplit-ivs-in-unroller
7846 Enables expression of values of induction variables in later iterations
7847 of the unrolled loop using the value in the first iteration.  This breaks
7848 long dependency chains, thus improving efficiency of the scheduling passes.
7850 A combination of @option{-fweb} and CSE is often sufficient to obtain the
7851 same effect.  However, that is not reliable in cases where the loop body
7852 is more complicated than a single basic block.  It also does not work at all
7853 on some architectures due to restrictions in the CSE pass.
7855 This optimization is enabled by default.
7857 @item -fvariable-expansion-in-unroller
7858 @opindex fvariable-expansion-in-unroller
7859 With this option, the compiler creates multiple copies of some
7860 local variables when unrolling a loop, which can result in superior code.
7862 @item -fpartial-inlining
7863 @opindex fpartial-inlining
7864 Inline parts of functions.  This option has any effect only
7865 when inlining itself is turned on by the @option{-finline-functions}
7866 or @option{-finline-small-functions} options.
7868 Enabled at level @option{-O2}.
7870 @item -fpredictive-commoning
7871 @opindex fpredictive-commoning
7872 Perform predictive commoning optimization, i.e., reusing computations
7873 (especially memory loads and stores) performed in previous
7874 iterations of loops.
7876 This option is enabled at level @option{-O3}.
7878 @item -fprefetch-loop-arrays
7879 @opindex fprefetch-loop-arrays
7880 If supported by the target machine, generate instructions to prefetch
7881 memory to improve the performance of loops that access large arrays.
7883 This option may generate better or worse code; results are highly
7884 dependent on the structure of loops within the source code.
7886 Disabled at level @option{-Os}.
7888 @item -fno-peephole
7889 @itemx -fno-peephole2
7890 @opindex fno-peephole
7891 @opindex fno-peephole2
7892 Disable any machine-specific peephole optimizations.  The difference
7893 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7894 are implemented in the compiler; some targets use one, some use the
7895 other, a few use both.
7897 @option{-fpeephole} is enabled by default.
7898 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7900 @item -fno-guess-branch-probability
7901 @opindex fno-guess-branch-probability
7902 Do not guess branch probabilities using heuristics.
7904 GCC uses heuristics to guess branch probabilities if they are
7905 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7906 heuristics are based on the control flow graph.  If some branch probabilities
7907 are specified by @samp{__builtin_expect}, then the heuristics are
7908 used to guess branch probabilities for the rest of the control flow graph,
7909 taking the @samp{__builtin_expect} info into account.  The interactions
7910 between the heuristics and @samp{__builtin_expect} can be complex, and in
7911 some cases, it may be useful to disable the heuristics so that the effects
7912 of @samp{__builtin_expect} are easier to understand.
7914 The default is @option{-fguess-branch-probability} at levels
7915 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7917 @item -freorder-blocks
7918 @opindex freorder-blocks
7919 Reorder basic blocks in the compiled function in order to reduce number of
7920 taken branches and improve code locality.
7922 Enabled at levels @option{-O2}, @option{-O3}.
7924 @item -freorder-blocks-and-partition
7925 @opindex freorder-blocks-and-partition
7926 In addition to reordering basic blocks in the compiled function, in order
7927 to reduce number of taken branches, partitions hot and cold basic blocks
7928 into separate sections of the assembly and .o files, to improve
7929 paging and cache locality performance.
7931 This optimization is automatically turned off in the presence of
7932 exception handling, for linkonce sections, for functions with a user-defined
7933 section attribute and on any architecture that does not support named
7934 sections.
7936 @item -freorder-functions
7937 @opindex freorder-functions
7938 Reorder functions in the object file in order to
7939 improve code locality.  This is implemented by using special
7940 subsections @code{.text.hot} for most frequently executed functions and
7941 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7942 the linker so object file format must support named sections and linker must
7943 place them in a reasonable way.
7945 Also profile feedback must be available to make this option effective.  See
7946 @option{-fprofile-arcs} for details.
7948 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7950 @item -fstrict-aliasing
7951 @opindex fstrict-aliasing
7952 Allow the compiler to assume the strictest aliasing rules applicable to
7953 the language being compiled.  For C (and C++), this activates
7954 optimizations based on the type of expressions.  In particular, an
7955 object of one type is assumed never to reside at the same address as an
7956 object of a different type, unless the types are almost the same.  For
7957 example, an @code{unsigned int} can alias an @code{int}, but not a
7958 @code{void*} or a @code{double}.  A character type may alias any other
7959 type.
7961 @anchor{Type-punning}Pay special attention to code like this:
7962 @smallexample
7963 union a_union @{
7964   int i;
7965   double d;
7968 int f() @{
7969   union a_union t;
7970   t.d = 3.0;
7971   return t.i;
7973 @end smallexample
7974 The practice of reading from a different union member than the one most
7975 recently written to (called ``type-punning'') is common.  Even with
7976 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7977 is accessed through the union type.  So, the code above works as
7978 expected.  @xref{Structures unions enumerations and bit-fields
7979 implementation}.  However, this code might not:
7980 @smallexample
7981 int f() @{
7982   union a_union t;
7983   int* ip;
7984   t.d = 3.0;
7985   ip = &t.i;
7986   return *ip;
7988 @end smallexample
7990 Similarly, access by taking the address, casting the resulting pointer
7991 and dereferencing the result has undefined behavior, even if the cast
7992 uses a union type, e.g.:
7993 @smallexample
7994 int f() @{
7995   double d = 3.0;
7996   return ((union a_union *) &d)->i;
7998 @end smallexample
8000 The @option{-fstrict-aliasing} option is enabled at levels
8001 @option{-O2}, @option{-O3}, @option{-Os}.
8003 @item -fstrict-overflow
8004 @opindex fstrict-overflow
8005 Allow the compiler to assume strict signed overflow rules, depending
8006 on the language being compiled.  For C (and C++) this means that
8007 overflow when doing arithmetic with signed numbers is undefined, which
8008 means that the compiler may assume that it does not happen.  This
8009 permits various optimizations.  For example, the compiler assumes
8010 that an expression like @code{i + 10 > i} is always true for
8011 signed @code{i}.  This assumption is only valid if signed overflow is
8012 undefined, as the expression is false if @code{i + 10} overflows when
8013 using twos complement arithmetic.  When this option is in effect any
8014 attempt to determine whether an operation on signed numbers 
8015 overflows must be written carefully to not actually involve overflow.
8017 This option also allows the compiler to assume strict pointer
8018 semantics: given a pointer to an object, if adding an offset to that
8019 pointer does not produce a pointer to the same object, the addition is
8020 undefined.  This permits the compiler to conclude that @code{p + u >
8021 p} is always true for a pointer @code{p} and unsigned integer
8022 @code{u}.  This assumption is only valid because pointer wraparound is
8023 undefined, as the expression is false if @code{p + u} overflows using
8024 twos complement arithmetic.
8026 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8027 that integer signed overflow is fully defined: it wraps.  When
8028 @option{-fwrapv} is used, there is no difference between
8029 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8030 integers.  With @option{-fwrapv} certain types of overflow are
8031 permitted.  For example, if the compiler gets an overflow when doing
8032 arithmetic on constants, the overflowed value can still be used with
8033 @option{-fwrapv}, but not otherwise.
8035 The @option{-fstrict-overflow} option is enabled at levels
8036 @option{-O2}, @option{-O3}, @option{-Os}.
8038 @item -falign-functions
8039 @itemx -falign-functions=@var{n}
8040 @opindex falign-functions
8041 Align the start of functions to the next power-of-two greater than
8042 @var{n}, skipping up to @var{n} bytes.  For instance,
8043 @option{-falign-functions=32} aligns functions to the next 32-byte
8044 boundary, but @option{-falign-functions=24} aligns to the next
8045 32-byte boundary only if this can be done by skipping 23 bytes or less.
8047 @option{-fno-align-functions} and @option{-falign-functions=1} are
8048 equivalent and mean that functions are not aligned.
8050 Some assemblers only support this flag when @var{n} is a power of two;
8051 in that case, it is rounded up.
8053 If @var{n} is not specified or is zero, use a machine-dependent default.
8055 Enabled at levels @option{-O2}, @option{-O3}.
8057 @item -falign-labels
8058 @itemx -falign-labels=@var{n}
8059 @opindex falign-labels
8060 Align all branch targets to a power-of-two boundary, skipping up to
8061 @var{n} bytes like @option{-falign-functions}.  This option can easily
8062 make code slower, because it must insert dummy operations for when the
8063 branch target is reached in the usual flow of the code.
8065 @option{-fno-align-labels} and @option{-falign-labels=1} are
8066 equivalent and mean that labels are not aligned.
8068 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8069 are greater than this value, then their values are used instead.
8071 If @var{n} is not specified or is zero, use a machine-dependent default
8072 which is very likely to be @samp{1}, meaning no alignment.
8074 Enabled at levels @option{-O2}, @option{-O3}.
8076 @item -falign-loops
8077 @itemx -falign-loops=@var{n}
8078 @opindex falign-loops
8079 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8080 like @option{-falign-functions}.  If the loops are
8081 executed many times, this makes up for any execution of the dummy
8082 operations.
8084 @option{-fno-align-loops} and @option{-falign-loops=1} are
8085 equivalent and mean that loops are not aligned.
8087 If @var{n} is not specified or is zero, use a machine-dependent default.
8089 Enabled at levels @option{-O2}, @option{-O3}.
8091 @item -falign-jumps
8092 @itemx -falign-jumps=@var{n}
8093 @opindex falign-jumps
8094 Align branch targets to a power-of-two boundary, for branch targets
8095 where the targets can only be reached by jumping, skipping up to @var{n}
8096 bytes like @option{-falign-functions}.  In this case, no dummy operations
8097 need be executed.
8099 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8100 equivalent and mean that loops are not aligned.
8102 If @var{n} is not specified or is zero, use a machine-dependent default.
8104 Enabled at levels @option{-O2}, @option{-O3}.
8106 @item -funit-at-a-time
8107 @opindex funit-at-a-time
8108 This option is left for compatibility reasons. @option{-funit-at-a-time}
8109 has no effect, while @option{-fno-unit-at-a-time} implies
8110 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8112 Enabled by default.
8114 @item -fno-toplevel-reorder
8115 @opindex fno-toplevel-reorder
8116 Do not reorder top-level functions, variables, and @code{asm}
8117 statements.  Output them in the same order that they appear in the
8118 input file.  When this option is used, unreferenced static variables
8119 are not removed.  This option is intended to support existing code
8120 that relies on a particular ordering.  For new code, it is better to
8121 use attributes.
8123 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8124 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8125 targets.
8127 @item -fweb
8128 @opindex fweb
8129 Constructs webs as commonly used for register allocation purposes and assign
8130 each web individual pseudo register.  This allows the register allocation pass
8131 to operate on pseudos directly, but also strengthens several other optimization
8132 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8133 however, make debugging impossible, since variables no longer stay in a
8134 ``home register''.
8136 Enabled by default with @option{-funroll-loops}.
8138 @item -fwhole-program
8139 @opindex fwhole-program
8140 Assume that the current compilation unit represents the whole program being
8141 compiled.  All public functions and variables with the exception of @code{main}
8142 and those merged by attribute @code{externally_visible} become static functions
8143 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.
8144 While this option is equivalent to proper use of the @code{static} keyword for
8145 programs consisting of a single file, in combination with option
8146 @option{-flto} this flag can be used to
8147 compile many smaller scale programs since the functions and variables become
8148 local for the whole combined compilation unit, not for the single source file
8149 itself.
8151 This option implies @option{-fwhole-file} for Fortran programs.
8153 @item -flto[=@var{n}]
8154 @opindex flto
8155 This option runs the standard link-time optimizer.  When invoked
8156 with source code, it generates GIMPLE (one of GCC's internal
8157 representations) and writes it to special ELF sections in the object
8158 file.  When the object files are linked together, all the function
8159 bodies are read from these ELF sections and instantiated as if they
8160 had been part of the same translation unit.
8162 To use the link-time optimizer, @option{-flto} needs to be specified at
8163 compile time and during the final link.  For example:
8165 @smallexample
8166 gcc -c -O2 -flto foo.c
8167 gcc -c -O2 -flto bar.c
8168 gcc -o myprog -flto -O2 foo.o bar.o
8169 @end smallexample
8171 The first two invocations to GCC save a bytecode representation
8172 of GIMPLE into special ELF sections inside @file{foo.o} and
8173 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8174 @file{foo.o} and @file{bar.o}, merges the two files into a single
8175 internal image, and compiles the result as usual.  Since both
8176 @file{foo.o} and @file{bar.o} are merged into a single image, this
8177 causes all the interprocedural analyses and optimizations in GCC to
8178 work across the two files as if they were a single one.  This means,
8179 for example, that the inliner is able to inline functions in
8180 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8182 Another (simpler) way to enable link-time optimization is:
8184 @smallexample
8185 gcc -o myprog -flto -O2 foo.c bar.c
8186 @end smallexample
8188 The above generates bytecode for @file{foo.c} and @file{bar.c},
8189 merges them together into a single GIMPLE representation and optimizes
8190 them as usual to produce @file{myprog}.
8192 The only important thing to keep in mind is that to enable link-time
8193 optimizations the @option{-flto} flag needs to be passed to both the
8194 compile and the link commands.
8196 To make whole program optimization effective, it is necessary to make
8197 certain whole program assumptions.  The compiler needs to know
8198 what functions and variables can be accessed by libraries and runtime
8199 outside of the link-time optimized unit.  When supported by the linker,
8200 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8201 to the compiler about used and externally visible symbols.  When
8202 the linker plugin is not available, @option{-fwhole-program} should be
8203 used to allow the compiler to make these assumptions, which leads
8204 to more aggressive optimization decisions.
8206 Note that when a file is compiled with @option{-flto}, the generated
8207 object file is larger than a regular object file because it 
8208 contains GIMPLE bytecodes and the usual final code.  This means that
8209 object files with LTO information can be linked as normal object
8210 files; if @option{-flto} is not passed to the linker, no
8211 interprocedural optimizations are applied.
8213 Additionally, the optimization flags used to compile individual files
8214 are not necessarily related to those used at link time.  For instance,
8216 @smallexample
8217 gcc -c -O0 -flto foo.c
8218 gcc -c -O0 -flto bar.c
8219 gcc -o myprog -flto -O3 foo.o bar.o
8220 @end smallexample
8222 This produces individual object files with unoptimized assembler
8223 code, but the resulting binary @file{myprog} is optimized at
8224 @option{-O3}.  If, instead, the final binary is generated without
8225 @option{-flto}, then @file{myprog} is not optimized.
8227 When producing the final binary with @option{-flto}, GCC only
8228 applies link-time optimizations to those files that contain bytecode.
8229 Therefore, you can mix and match object files and libraries with
8230 GIMPLE bytecodes and final object code.  GCC automatically selects
8231 which files to optimize in LTO mode and which files to link without
8232 further processing.
8234 There are some code generation flags preserved by GCC when
8235 generating bytecodes, as they need to be used during the final link
8236 stage.  Currently, the following options are saved into the GIMPLE
8237 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
8238 @option{-m} target flags.
8240 At link time, these options are read in and reapplied.  Note that the
8241 current implementation makes no attempt to recognize conflicting
8242 values for these options.  If different files have conflicting option
8243 values (e.g., one file is compiled with @option{-fPIC} and another
8244 isn't), the compiler simply uses the last value read from the
8245 bytecode files.  It is recommended, then, that you compile all the files
8246 participating in the same link with the same options.
8248 If LTO encounters objects with C linkage declared with incompatible
8249 types in separate translation units to be linked together (undefined
8250 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8251 issued.  The behavior is still undefined at run time.
8253 Another feature of LTO is that it is possible to apply interprocedural
8254 optimizations on files written in different languages.  This requires
8255 support in the language front end.  Currently, the C, C++ and
8256 Fortran front ends are capable of emitting GIMPLE bytecodes, so
8257 something like this should work:
8259 @smallexample
8260 gcc -c -flto foo.c
8261 g++ -c -flto bar.cc
8262 gfortran -c -flto baz.f90
8263 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8264 @end smallexample
8266 Notice that the final link is done with @command{g++} to get the C++
8267 runtime libraries and @option{-lgfortran} is added to get the Fortran
8268 runtime libraries.  In general, when mixing languages in LTO mode, you
8269 should use the same link command options as when mixing languages in a
8270 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8271 all the compile and link commands.
8273 If object files containing GIMPLE bytecode are stored in a library archive, say
8274 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8275 are using a linker with plugin support.  To enable this feature, use
8276 the flag @option{-fuse-linker-plugin} at link time:
8278 @smallexample
8279 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8280 @end smallexample
8282 With the linker plugin enabled, the linker extracts the needed
8283 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8284 to make them part of the aggregated GIMPLE image to be optimized.
8286 If you are not using a linker with plugin support and/or do not
8287 enable the linker plugin, then the objects inside @file{libfoo.a}
8288 are extracted and linked as usual, but they do not participate
8289 in the LTO optimization process.
8291 Link-time optimizations do not require the presence of the whole program to
8292 operate.  If the program does not require any symbols to be exported, it is
8293 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8294 the interprocedural optimizers to use more aggressive assumptions which may
8295 lead to improved optimization opportunities.
8296 Use of @option{-fwhole-program} is not needed when linker plugin is
8297 active (see @option{-fuse-linker-plugin}).
8299 The current implementation of LTO makes no
8300 attempt to generate bytecode that is portable between different
8301 types of hosts.  The bytecode files are versioned and there is a
8302 strict version check, so bytecode files generated in one version of
8303 GCC will not work with an older/newer version of GCC@.
8305 Link-time optimization does not work well with generation of debugging
8306 information.  Combining @option{-flto} with
8307 @option{-g} is currently experimental and expected to produce wrong
8308 results.
8310 If you specify the optional @var{n}, the optimization and code
8311 generation done at link time is executed in parallel using @var{n}
8312 parallel jobs by utilizing an installed @command{make} program.  The
8313 environment variable @env{MAKE} may be used to override the program
8314 used.  The default value for @var{n} is 1.
8316 You can also specify @option{-flto=jobserver} to use GNU make's
8317 job server mode to determine the number of parallel jobs. This
8318 is useful when the Makefile calling GCC is already executing in parallel.
8319 You must prepend a @samp{+} to the command recipe in the parent Makefile
8320 for this to work.  This option likely only works if @env{MAKE} is
8321 GNU make.
8323 This option is disabled by default.
8325 @item -flto-partition=@var{alg}
8326 @opindex flto-partition
8327 Specify the partitioning algorithm used by the link-time optimizer.
8328 The value is either @code{1to1} to specify a partitioning mirroring
8329 the original source files or @code{balanced} to specify partitioning
8330 into equally sized chunks (whenever possible) or @code{max} to create
8331 new partition for every symbol where possible.  Specifying @code{none}
8332 as an algorithm disables partitioning and streaming completely. 
8333 The default value is @code{balanced}. While @code{1to1} can be used
8334 as an workaround for various code ordering issues, the @code{max}
8335 partitioning is intended for internal testing only.
8337 @item -flto-compression-level=@var{n}
8338 This option specifies the level of compression used for intermediate
8339 language written to LTO object files, and is only meaningful in
8340 conjunction with LTO mode (@option{-flto}).  Valid
8341 values are 0 (no compression) to 9 (maximum compression).  Values
8342 outside this range are clamped to either 0 or 9.  If the option is not
8343 given, a default balanced compression setting is used.
8345 @item -flto-report
8346 Prints a report with internal details on the workings of the link-time
8347 optimizer.  The contents of this report vary from version to version.
8348 It is meant to be useful to GCC developers when processing object
8349 files in LTO mode (via @option{-flto}).
8351 Disabled by default.
8353 @item -fuse-linker-plugin
8354 Enables the use of a linker plugin during link-time optimization.  This
8355 option relies on plugin support in the linker, which is available in gold
8356 or in GNU ld 2.21 or newer.
8358 This option enables the extraction of object files with GIMPLE bytecode out
8359 of library archives. This improves the quality of optimization by exposing
8360 more code to the link-time optimizer.  This information specifies what
8361 symbols can be accessed externally (by non-LTO object or during dynamic
8362 linking).  Resulting code quality improvements on binaries (and shared
8363 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8364 See @option{-flto} for a description of the effect of this flag and how to
8365 use it.
8367 This option is enabled by default when LTO support in GCC is enabled
8368 and GCC was configured for use with
8369 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8371 @item -ffat-lto-objects
8372 @opindex ffat-lto-objects
8373 Fat LTO objects are object files that contain both the intermediate language
8374 and the object code. This makes them usable for both LTO linking and normal
8375 linking. This option is effective only when compiling with @option{-flto}
8376 and is ignored at link time.
8378 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8379 requires the complete toolchain to be aware of LTO. It requires a linker with
8380 linker plugin support for basic functionality.  Additionally,
8381 @command{nm}, @command{ar} and @command{ranlib}
8382 need to support linker plugins to allow a full-featured build environment
8383 (capable of building static libraries etc). gcc provides the @command{gcc-ar},
8384 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8385 to these tools. With non fat LTO makefiles need to be modified to use them.
8387 The default is @option{-ffat-lto-objects} but this default is intended to
8388 change in future releases when linker plugin enabled environments become more
8389 common.
8391 @item -fcompare-elim
8392 @opindex fcompare-elim
8393 After register allocation and post-register allocation instruction splitting,
8394 identify arithmetic instructions that compute processor flags similar to a
8395 comparison operation based on that arithmetic.  If possible, eliminate the
8396 explicit comparison operation.
8398 This pass only applies to certain targets that cannot explicitly represent
8399 the comparison operation before register allocation is complete.
8401 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8403 @item -fcprop-registers
8404 @opindex fcprop-registers
8405 After register allocation and post-register allocation instruction splitting,
8406 perform a copy-propagation pass to try to reduce scheduling dependencies
8407 and occasionally eliminate the copy.
8409 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8411 @item -fprofile-correction
8412 @opindex fprofile-correction
8413 Profiles collected using an instrumented binary for multi-threaded programs may
8414 be inconsistent due to missed counter updates. When this option is specified,
8415 GCC uses heuristics to correct or smooth out such inconsistencies. By
8416 default, GCC emits an error message when an inconsistent profile is detected.
8418 @item -fprofile-dir=@var{path}
8419 @opindex fprofile-dir
8421 Set the directory to search for the profile data files in to @var{path}.
8422 This option affects only the profile data generated by
8423 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8424 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8425 and its related options.  Both absolute and relative paths can be used.
8426 By default, GCC uses the current directory as @var{path}, thus the
8427 profile data file appears in the same directory as the object file.
8429 @item -fprofile-generate
8430 @itemx -fprofile-generate=@var{path}
8431 @opindex fprofile-generate
8433 Enable options usually used for instrumenting application to produce
8434 profile useful for later recompilation with profile feedback based
8435 optimization.  You must use @option{-fprofile-generate} both when
8436 compiling and when linking your program.
8438 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8440 If @var{path} is specified, GCC looks at the @var{path} to find
8441 the profile feedback data files. See @option{-fprofile-dir}.
8443 @item -fprofile-use
8444 @itemx -fprofile-use=@var{path}
8445 @opindex fprofile-use
8446 Enable profile feedback directed optimizations, and optimizations
8447 generally profitable only with profile feedback available.
8449 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8450 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
8451 @code{ftree-loop-distribute-patterns}
8453 By default, GCC emits an error message if the feedback profiles do not
8454 match the source code.  This error can be turned into a warning by using
8455 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8456 code.
8458 If @var{path} is specified, GCC looks at the @var{path} to find
8459 the profile feedback data files. See @option{-fprofile-dir}.
8460 @end table
8462 The following options control compiler behavior regarding floating-point 
8463 arithmetic.  These options trade off between speed and
8464 correctness.  All must be specifically enabled.
8466 @table @gcctabopt
8467 @item -ffloat-store
8468 @opindex ffloat-store
8469 Do not store floating-point variables in registers, and inhibit other
8470 options that might change whether a floating-point value is taken from a
8471 register or memory.
8473 @cindex floating-point precision
8474 This option prevents undesirable excess precision on machines such as
8475 the 68000 where the floating registers (of the 68881) keep more
8476 precision than a @code{double} is supposed to have.  Similarly for the
8477 x86 architecture.  For most programs, the excess precision does only
8478 good, but a few programs rely on the precise definition of IEEE floating
8479 point.  Use @option{-ffloat-store} for such programs, after modifying
8480 them to store all pertinent intermediate computations into variables.
8482 @item -fexcess-precision=@var{style}
8483 @opindex fexcess-precision
8484 This option allows further control over excess precision on machines
8485 where floating-point registers have more precision than the IEEE
8486 @code{float} and @code{double} types and the processor does not
8487 support operations rounding to those types.  By default,
8488 @option{-fexcess-precision=fast} is in effect; this means that
8489 operations are carried out in the precision of the registers and that
8490 it is unpredictable when rounding to the types specified in the source
8491 code takes place.  When compiling C, if
8492 @option{-fexcess-precision=standard} is specified then excess
8493 precision follows the rules specified in ISO C99; in particular,
8494 both casts and assignments cause values to be rounded to their
8495 semantic types (whereas @option{-ffloat-store} only affects
8496 assignments).  This option is enabled by default for C if a strict
8497 conformance option such as @option{-std=c99} is used.
8499 @opindex mfpmath
8500 @option{-fexcess-precision=standard} is not implemented for languages
8501 other than C, and has no effect if
8502 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8503 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8504 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8505 semantics apply without excess precision, and in the latter, rounding
8506 is unpredictable.
8508 @item -ffast-math
8509 @opindex ffast-math
8510 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8511 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8512 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8514 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8516 This option is not turned on by any @option{-O} option besides
8517 @option{-Ofast} since it can result in incorrect output for programs
8518 that depend on an exact implementation of IEEE or ISO rules/specifications
8519 for math functions. It may, however, yield faster code for programs
8520 that do not require the guarantees of these specifications.
8522 @item -fno-math-errno
8523 @opindex fno-math-errno
8524 Do not set @code{errno} after calling math functions that are executed
8525 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8526 IEEE exceptions for math error handling may want to use this flag
8527 for speed while maintaining IEEE arithmetic compatibility.
8529 This option is not turned on by any @option{-O} option since
8530 it can result in incorrect output for programs that depend on
8531 an exact implementation of IEEE or ISO rules/specifications for
8532 math functions. It may, however, yield faster code for programs
8533 that do not require the guarantees of these specifications.
8535 The default is @option{-fmath-errno}.
8537 On Darwin systems, the math library never sets @code{errno}.  There is
8538 therefore no reason for the compiler to consider the possibility that
8539 it might, and @option{-fno-math-errno} is the default.
8541 @item -funsafe-math-optimizations
8542 @opindex funsafe-math-optimizations
8544 Allow optimizations for floating-point arithmetic that (a) assume
8545 that arguments and results are valid and (b) may violate IEEE or
8546 ANSI standards.  When used at link-time, it may include libraries
8547 or startup files that change the default FPU control word or other
8548 similar optimizations.
8550 This option is not turned on by any @option{-O} option since
8551 it can result in incorrect output for programs that depend on
8552 an exact implementation of IEEE or ISO rules/specifications for
8553 math functions. It may, however, yield faster code for programs
8554 that do not require the guarantees of these specifications.
8555 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8556 @option{-fassociative-math} and @option{-freciprocal-math}.
8558 The default is @option{-fno-unsafe-math-optimizations}.
8560 @item -fassociative-math
8561 @opindex fassociative-math
8563 Allow re-association of operands in series of floating-point operations.
8564 This violates the ISO C and C++ language standard by possibly changing
8565 computation result.  NOTE: re-ordering may change the sign of zero as
8566 well as ignore NaNs and inhibit or create underflow or overflow (and
8567 thus cannot be used on code that relies on rounding behavior like
8568 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8569 and thus may not be used when ordered comparisons are required.
8570 This option requires that both @option{-fno-signed-zeros} and
8571 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8572 much sense with @option{-frounding-math}. For Fortran the option
8573 is automatically enabled when both @option{-fno-signed-zeros} and
8574 @option{-fno-trapping-math} are in effect.
8576 The default is @option{-fno-associative-math}.
8578 @item -freciprocal-math
8579 @opindex freciprocal-math
8581 Allow the reciprocal of a value to be used instead of dividing by
8582 the value if this enables optimizations.  For example @code{x / y}
8583 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8584 is subject to common subexpression elimination.  Note that this loses
8585 precision and increases the number of flops operating on the value.
8587 The default is @option{-fno-reciprocal-math}.
8589 @item -ffinite-math-only
8590 @opindex ffinite-math-only
8591 Allow optimizations for floating-point arithmetic that assume
8592 that arguments and results are not NaNs or +-Infs.
8594 This option is not turned on by any @option{-O} option since
8595 it can result in incorrect output for programs that depend on
8596 an exact implementation of IEEE or ISO rules/specifications for
8597 math functions. It may, however, yield faster code for programs
8598 that do not require the guarantees of these specifications.
8600 The default is @option{-fno-finite-math-only}.
8602 @item -fno-signed-zeros
8603 @opindex fno-signed-zeros
8604 Allow optimizations for floating-point arithmetic that ignore the
8605 signedness of zero.  IEEE arithmetic specifies the behavior of
8606 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8607 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8608 This option implies that the sign of a zero result isn't significant.
8610 The default is @option{-fsigned-zeros}.
8612 @item -fno-trapping-math
8613 @opindex fno-trapping-math
8614 Compile code assuming that floating-point operations cannot generate
8615 user-visible traps.  These traps include division by zero, overflow,
8616 underflow, inexact result and invalid operation.  This option requires
8617 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8618 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8620 This option should never be turned on by any @option{-O} option since
8621 it can result in incorrect output for programs that depend on
8622 an exact implementation of IEEE or ISO rules/specifications for
8623 math functions.
8625 The default is @option{-ftrapping-math}.
8627 @item -frounding-math
8628 @opindex frounding-math
8629 Disable transformations and optimizations that assume default floating-point
8630 rounding behavior.  This is round-to-zero for all floating point
8631 to integer conversions, and round-to-nearest for all other arithmetic
8632 truncations.  This option should be specified for programs that change
8633 the FP rounding mode dynamically, or that may be executed with a
8634 non-default rounding mode.  This option disables constant folding of
8635 floating-point expressions at compile time (which may be affected by
8636 rounding mode) and arithmetic transformations that are unsafe in the
8637 presence of sign-dependent rounding modes.
8639 The default is @option{-fno-rounding-math}.
8641 This option is experimental and does not currently guarantee to
8642 disable all GCC optimizations that are affected by rounding mode.
8643 Future versions of GCC may provide finer control of this setting
8644 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8645 will be used to specify the default state for @code{FENV_ACCESS}.
8647 @item -fsignaling-nans
8648 @opindex fsignaling-nans
8649 Compile code assuming that IEEE signaling NaNs may generate user-visible
8650 traps during floating-point operations.  Setting this option disables
8651 optimizations that may change the number of exceptions visible with
8652 signaling NaNs.  This option implies @option{-ftrapping-math}.
8654 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8655 be defined.
8657 The default is @option{-fno-signaling-nans}.
8659 This option is experimental and does not currently guarantee to
8660 disable all GCC optimizations that affect signaling NaN behavior.
8662 @item -fsingle-precision-constant
8663 @opindex fsingle-precision-constant
8664 Treat floating-point constants as single precision instead of
8665 implicitly converting them to double-precision constants.
8667 @item -fcx-limited-range
8668 @opindex fcx-limited-range
8669 When enabled, this option states that a range reduction step is not
8670 needed when performing complex division.  Also, there is no checking
8671 whether the result of a complex multiplication or division is @code{NaN
8672 + I*NaN}, with an attempt to rescue the situation in that case.  The
8673 default is @option{-fno-cx-limited-range}, but is enabled by
8674 @option{-ffast-math}.
8676 This option controls the default setting of the ISO C99
8677 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8678 all languages.
8680 @item -fcx-fortran-rules
8681 @opindex fcx-fortran-rules
8682 Complex multiplication and division follow Fortran rules.  Range
8683 reduction is done as part of complex division, but there is no checking
8684 whether the result of a complex multiplication or division is @code{NaN
8685 + I*NaN}, with an attempt to rescue the situation in that case.
8687 The default is @option{-fno-cx-fortran-rules}.
8689 @end table
8691 The following options control optimizations that may improve
8692 performance, but are not enabled by any @option{-O} options.  This
8693 section includes experimental options that may produce broken code.
8695 @table @gcctabopt
8696 @item -fbranch-probabilities
8697 @opindex fbranch-probabilities
8698 After running a program compiled with @option{-fprofile-arcs}
8699 (@pxref{Debugging Options,, Options for Debugging Your Program or
8700 @command{gcc}}), you can compile it a second time using
8701 @option{-fbranch-probabilities}, to improve optimizations based on
8702 the number of times each branch was taken.  When a program
8703 compiled with @option{-fprofile-arcs} exits, it saves arc execution
8704 counts to a file called @file{@var{sourcename}.gcda} for each source
8705 file.  The information in this data file is very dependent on the
8706 structure of the generated code, so you must use the same source code
8707 and the same optimization options for both compilations.
8709 With @option{-fbranch-probabilities}, GCC puts a
8710 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8711 These can be used to improve optimization.  Currently, they are only
8712 used in one place: in @file{reorg.c}, instead of guessing which path a
8713 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8714 exactly determine which path is taken more often.
8716 @item -fprofile-values
8717 @opindex fprofile-values
8718 If combined with @option{-fprofile-arcs}, it adds code so that some
8719 data about values of expressions in the program is gathered.
8721 With @option{-fbranch-probabilities}, it reads back the data gathered
8722 from profiling values of expressions for usage in optimizations.
8724 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8726 @item -fvpt
8727 @opindex fvpt
8728 If combined with @option{-fprofile-arcs}, this option instructs the compiler
8729 to add code to gather information about values of expressions.
8731 With @option{-fbranch-probabilities}, it reads back the data gathered
8732 and actually performs the optimizations based on them.
8733 Currently the optimizations include specialization of division operations
8734 using the knowledge about the value of the denominator.
8736 @item -frename-registers
8737 @opindex frename-registers
8738 Attempt to avoid false dependencies in scheduled code by making use
8739 of registers left over after register allocation.  This optimization
8740 most benefits processors with lots of registers.  Depending on the
8741 debug information format adopted by the target, however, it can
8742 make debugging impossible, since variables no longer stay in
8743 a ``home register''.
8745 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8747 @item -ftracer
8748 @opindex ftracer
8749 Perform tail duplication to enlarge superblock size.  This transformation
8750 simplifies the control flow of the function allowing other optimizations to do
8751 a better job.
8753 Enabled with @option{-fprofile-use}.
8755 @item -funroll-loops
8756 @opindex funroll-loops
8757 Unroll loops whose number of iterations can be determined at compile time or
8758 upon entry to the loop.  @option{-funroll-loops} implies
8759 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8760 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8761 a small constant number of iterations).  This option makes code larger, and may
8762 or may not make it run faster.
8764 Enabled with @option{-fprofile-use}.
8766 @item -funroll-all-loops
8767 @opindex funroll-all-loops
8768 Unroll all loops, even if their number of iterations is uncertain when
8769 the loop is entered.  This usually makes programs run more slowly.
8770 @option{-funroll-all-loops} implies the same options as
8771 @option{-funroll-loops}.
8773 @item -fpeel-loops
8774 @opindex fpeel-loops
8775 Peels loops for which there is enough information that they do not
8776 roll much (from profile feedback).  It also turns on complete loop peeling
8777 (i.e.@: complete removal of loops with small constant number of iterations).
8779 Enabled with @option{-fprofile-use}.
8781 @item -fmove-loop-invariants
8782 @opindex fmove-loop-invariants
8783 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8784 at level @option{-O1}
8786 @item -funswitch-loops
8787 @opindex funswitch-loops
8788 Move branches with loop invariant conditions out of the loop, with duplicates
8789 of the loop on both branches (modified according to result of the condition).
8791 @item -ffunction-sections
8792 @itemx -fdata-sections
8793 @opindex ffunction-sections
8794 @opindex fdata-sections
8795 Place each function or data item into its own section in the output
8796 file if the target supports arbitrary sections.  The name of the
8797 function or the name of the data item determines the section's name
8798 in the output file.
8800 Use these options on systems where the linker can perform optimizations
8801 to improve locality of reference in the instruction space.  Most systems
8802 using the ELF object format and SPARC processors running Solaris 2 have
8803 linkers with such optimizations.  AIX may have these optimizations in
8804 the future.
8806 Only use these options when there are significant benefits from doing
8807 so.  When you specify these options, the assembler and linker
8808 create larger object and executable files and are also slower.
8809 You cannot use @code{gprof} on all systems if you
8810 specify this option, and you may have problems with debugging if
8811 you specify both this option and @option{-g}.
8813 @item -fbranch-target-load-optimize
8814 @opindex fbranch-target-load-optimize
8815 Perform branch target register load optimization before prologue / epilogue
8816 threading.
8817 The use of target registers can typically be exposed only during reload,
8818 thus hoisting loads out of loops and doing inter-block scheduling needs
8819 a separate optimization pass.
8821 @item -fbranch-target-load-optimize2
8822 @opindex fbranch-target-load-optimize2
8823 Perform branch target register load optimization after prologue / epilogue
8824 threading.
8826 @item -fbtr-bb-exclusive
8827 @opindex fbtr-bb-exclusive
8828 When performing branch target register load optimization, don't reuse
8829 branch target registers within any basic block.
8831 @item -fstack-protector
8832 @opindex fstack-protector
8833 Emit extra code to check for buffer overflows, such as stack smashing
8834 attacks.  This is done by adding a guard variable to functions with
8835 vulnerable objects.  This includes functions that call @code{alloca}, and
8836 functions with buffers larger than 8 bytes.  The guards are initialized
8837 when a function is entered and then checked when the function exits.
8838 If a guard check fails, an error message is printed and the program exits.
8840 @item -fstack-protector-all
8841 @opindex fstack-protector-all
8842 Like @option{-fstack-protector} except that all functions are protected.
8844 @item -fsection-anchors
8845 @opindex fsection-anchors
8846 Try to reduce the number of symbolic address calculations by using
8847 shared ``anchor'' symbols to address nearby objects.  This transformation
8848 can help to reduce the number of GOT entries and GOT accesses on some
8849 targets.
8851 For example, the implementation of the following function @code{foo}:
8853 @smallexample
8854 static int a, b, c;
8855 int foo (void) @{ return a + b + c; @}
8856 @end smallexample
8858 @noindent
8859 usually calculates the addresses of all three variables, but if you
8860 compile it with @option{-fsection-anchors}, it accesses the variables
8861 from a common anchor point instead.  The effect is similar to the
8862 following pseudocode (which isn't valid C):
8864 @smallexample
8865 int foo (void)
8867   register int *xr = &x;
8868   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8870 @end smallexample
8872 Not all targets support this option.
8874 @item --param @var{name}=@var{value}
8875 @opindex param
8876 In some places, GCC uses various constants to control the amount of
8877 optimization that is done.  For example, GCC does not inline functions
8878 that contain more than a certain number of instructions.  You can
8879 control some of these constants on the command line using the
8880 @option{--param} option.
8882 The names of specific parameters, and the meaning of the values, are
8883 tied to the internals of the compiler, and are subject to change
8884 without notice in future releases.
8886 In each case, the @var{value} is an integer.  The allowable choices for
8887 @var{name} are:
8889 @table @gcctabopt
8890 @item predictable-branch-outcome
8891 When branch is predicted to be taken with probability lower than this threshold
8892 (in percent), then it is considered well predictable. The default is 10.
8894 @item max-crossjump-edges
8895 The maximum number of incoming edges to consider for cross-jumping.
8896 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8897 the number of edges incoming to each block.  Increasing values mean
8898 more aggressive optimization, making the compilation time increase with
8899 probably small improvement in executable size.
8901 @item min-crossjump-insns
8902 The minimum number of instructions that must be matched at the end
8903 of two blocks before cross-jumping is performed on them.  This
8904 value is ignored in the case where all instructions in the block being
8905 cross-jumped from are matched.  The default value is 5.
8907 @item max-grow-copy-bb-insns
8908 The maximum code size expansion factor when copying basic blocks
8909 instead of jumping.  The expansion is relative to a jump instruction.
8910 The default value is 8.
8912 @item max-goto-duplication-insns
8913 The maximum number of instructions to duplicate to a block that jumps
8914 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8915 passes, GCC factors computed gotos early in the compilation process,
8916 and unfactors them as late as possible.  Only computed jumps at the
8917 end of a basic blocks with no more than max-goto-duplication-insns are
8918 unfactored.  The default value is 8.
8920 @item max-delay-slot-insn-search
8921 The maximum number of instructions to consider when looking for an
8922 instruction to fill a delay slot.  If more than this arbitrary number of
8923 instructions are searched, the time savings from filling the delay slot
8924 are minimal, so stop searching.  Increasing values mean more
8925 aggressive optimization, making the compilation time increase with probably
8926 small improvement in execution time.
8928 @item max-delay-slot-live-search
8929 When trying to fill delay slots, the maximum number of instructions to
8930 consider when searching for a block with valid live register
8931 information.  Increasing this arbitrarily chosen value means more
8932 aggressive optimization, increasing the compilation time.  This parameter
8933 should be removed when the delay slot code is rewritten to maintain the
8934 control-flow graph.
8936 @item max-gcse-memory
8937 The approximate maximum amount of memory that can be allocated in
8938 order to perform the global common subexpression elimination
8939 optimization.  If more memory than specified is required, the
8940 optimization is not done.
8942 @item max-gcse-insertion-ratio
8943 If the ratio of expression insertions to deletions is larger than this value
8944 for any expression, then RTL PRE inserts or removes the expression and thus
8945 leaves partially redundant computations in the instruction stream.  The default value is 20.
8947 @item max-pending-list-length
8948 The maximum number of pending dependencies scheduling allows
8949 before flushing the current state and starting over.  Large functions
8950 with few branches or calls can create excessively large lists which
8951 needlessly consume memory and resources.
8953 @item max-modulo-backtrack-attempts
8954 The maximum number of backtrack attempts the scheduler should make
8955 when modulo scheduling a loop.  Larger values can exponentially increase
8956 compilation time.
8958 @item max-inline-insns-single
8959 Several parameters control the tree inliner used in GCC@.
8960 This number sets the maximum number of instructions (counted in GCC's
8961 internal representation) in a single function that the tree inliner
8962 considers for inlining.  This only affects functions declared
8963 inline and methods implemented in a class declaration (C++).
8964 The default value is 400.
8966 @item max-inline-insns-auto
8967 When you use @option{-finline-functions} (included in @option{-O3}),
8968 a lot of functions that would otherwise not be considered for inlining
8969 by the compiler are investigated.  To those functions, a different
8970 (more restrictive) limit compared to functions declared inline can
8971 be applied.
8972 The default value is 40.
8974 @item inline-min-speedup
8975 When estimated performance improvement of caller + callee runtime exceeds this
8976 threshold (in precent), the function can be inlined regardless the limit on
8977 @option{--param max-inline-insns-single} and @option{--param
8978 max-inline-insns-auto}.
8980 @item large-function-insns
8981 The limit specifying really large functions.  For functions larger than this
8982 limit after inlining, inlining is constrained by
8983 @option{--param large-function-growth}.  This parameter is useful primarily
8984 to avoid extreme compilation time caused by non-linear algorithms used by the
8985 back end.
8986 The default value is 2700.
8988 @item large-function-growth
8989 Specifies maximal growth of large function caused by inlining in percents.
8990 The default value is 100 which limits large function growth to 2.0 times
8991 the original size.
8993 @item large-unit-insns
8994 The limit specifying large translation unit.  Growth caused by inlining of
8995 units larger than this limit is limited by @option{--param inline-unit-growth}.
8996 For small units this might be too tight.
8997 For example, consider a unit consisting of function A
8998 that is inline and B that just calls A three times.  If B is small relative to
8999 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9000 large units consisting of small inlineable functions, however, the overall unit
9001 growth limit is needed to avoid exponential explosion of code size.  Thus for
9002 smaller units, the size is increased to @option{--param large-unit-insns}
9003 before applying @option{--param inline-unit-growth}.  The default is 10000.
9005 @item inline-unit-growth
9006 Specifies maximal overall growth of the compilation unit caused by inlining.
9007 The default value is 30 which limits unit growth to 1.3 times the original
9008 size.
9010 @item ipcp-unit-growth
9011 Specifies maximal overall growth of the compilation unit caused by
9012 interprocedural constant propagation.  The default value is 10 which limits
9013 unit growth to 1.1 times the original size.
9015 @item large-stack-frame
9016 The limit specifying large stack frames.  While inlining the algorithm is trying
9017 to not grow past this limit too much.  The default value is 256 bytes.
9019 @item large-stack-frame-growth
9020 Specifies maximal growth of large stack frames caused by inlining in percents.
9021 The default value is 1000 which limits large stack frame growth to 11 times
9022 the original size.
9024 @item max-inline-insns-recursive
9025 @itemx max-inline-insns-recursive-auto
9026 Specifies the maximum number of instructions an out-of-line copy of a
9027 self-recursive inline
9028 function can grow into by performing recursive inlining.
9030 For functions declared inline, @option{--param max-inline-insns-recursive} is
9031 taken into account.  For functions not declared inline, recursive inlining
9032 happens only when @option{-finline-functions} (included in @option{-O3}) is
9033 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9034 default value is 450.
9036 @item max-inline-recursive-depth
9037 @itemx max-inline-recursive-depth-auto
9038 Specifies the maximum recursion depth used for recursive inlining.
9040 For functions declared inline, @option{--param max-inline-recursive-depth} is
9041 taken into account.  For functions not declared inline, recursive inlining
9042 happens only when @option{-finline-functions} (included in @option{-O3}) is
9043 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9044 default value is 8.
9046 @item min-inline-recursive-probability
9047 Recursive inlining is profitable only for function having deep recursion
9048 in average and can hurt for function having little recursion depth by
9049 increasing the prologue size or complexity of function body to other
9050 optimizers.
9052 When profile feedback is available (see @option{-fprofile-generate}) the actual
9053 recursion depth can be guessed from probability that function recurses via a
9054 given call expression.  This parameter limits inlining only to call expressions
9055 whose probability exceeds the given threshold (in percents).
9056 The default value is 10.
9058 @item early-inlining-insns
9059 Specify growth that the early inliner can make.  In effect it increases
9060 the amount of inlining for code having a large abstraction penalty.
9061 The default value is 10.
9063 @item max-early-inliner-iterations
9064 @itemx max-early-inliner-iterations
9065 Limit of iterations of the early inliner.  This basically bounds
9066 the number of nested indirect calls the early inliner can resolve.
9067 Deeper chains are still handled by late inlining.
9069 @item comdat-sharing-probability
9070 @itemx comdat-sharing-probability
9071 Probability (in percent) that C++ inline function with comdat visibility
9072 are shared across multiple compilation units.  The default value is 20.
9074 @item min-vect-loop-bound
9075 The minimum number of iterations under which loops are not vectorized
9076 when @option{-ftree-vectorize} is used.  The number of iterations after
9077 vectorization needs to be greater than the value specified by this option
9078 to allow vectorization.  The default value is 0.
9080 @item gcse-cost-distance-ratio
9081 Scaling factor in calculation of maximum distance an expression
9082 can be moved by GCSE optimizations.  This is currently supported only in the
9083 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9084 is with simple expressions, i.e., the expressions that have cost
9085 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9086 hoisting of simple expressions.  The default value is 10.
9088 @item gcse-unrestricted-cost
9089 Cost, roughly measured as the cost of a single typical machine
9090 instruction, at which GCSE optimizations do not constrain
9091 the distance an expression can travel.  This is currently
9092 supported only in the code hoisting pass.  The lesser the cost,
9093 the more aggressive code hoisting is.  Specifying 0 
9094 allows all expressions to travel unrestricted distances.
9095 The default value is 3.
9097 @item max-hoist-depth
9098 The depth of search in the dominator tree for expressions to hoist.
9099 This is used to avoid quadratic behavior in hoisting algorithm.
9100 The value of 0 does not limit on the search, but may slow down compilation
9101 of huge functions.  The default value is 30.
9103 @item max-tail-merge-comparisons
9104 The maximum amount of similar bbs to compare a bb with.  This is used to
9105 avoid quadratic behavior in tree tail merging.  The default value is 10.
9107 @item max-tail-merge-iterations
9108 The maximum amount of iterations of the pass over the function.  This is used to
9109 limit compilation time in tree tail merging.  The default value is 2.
9111 @item max-unrolled-insns
9112 The maximum number of instructions that a loop may have to be unrolled.
9113 If a loop is unrolled, this parameter also determines how many times
9114 the loop code is unrolled.
9116 @item max-average-unrolled-insns
9117 The maximum number of instructions biased by probabilities of their execution
9118 that a loop may have to be unrolled.  If a loop is unrolled,
9119 this parameter also determines how many times the loop code is unrolled.
9121 @item max-unroll-times
9122 The maximum number of unrollings of a single loop.
9124 @item max-peeled-insns
9125 The maximum number of instructions that a loop may have to be peeled.
9126 If a loop is peeled, this parameter also determines how many times
9127 the loop code is peeled.
9129 @item max-peel-times
9130 The maximum number of peelings of a single loop.
9132 @item max-peel-branches
9133 The maximum number of branches on the hot path through the peeled sequence.
9135 @item max-completely-peeled-insns
9136 The maximum number of insns of a completely peeled loop.
9138 @item max-completely-peel-times
9139 The maximum number of iterations of a loop to be suitable for complete peeling.
9141 @item max-completely-peel-loop-nest-depth
9142 The maximum depth of a loop nest suitable for complete peeling.
9144 @item max-unswitch-insns
9145 The maximum number of insns of an unswitched loop.
9147 @item max-unswitch-level
9148 The maximum number of branches unswitched in a single loop.
9150 @item lim-expensive
9151 The minimum cost of an expensive expression in the loop invariant motion.
9153 @item iv-consider-all-candidates-bound
9154 Bound on number of candidates for induction variables, below which
9155 all candidates are considered for each use in induction variable
9156 optimizations.  If there are more candidates than this,
9157 only the most relevant ones are considered to avoid quadratic time complexity.
9159 @item iv-max-considered-uses
9160 The induction variable optimizations give up on loops that contain more
9161 induction variable uses.
9163 @item iv-always-prune-cand-set-bound
9164 If the number of candidates in the set is smaller than this value,
9165 always try to remove unnecessary ivs from the set
9166 when adding a new one.
9168 @item scev-max-expr-size
9169 Bound on size of expressions used in the scalar evolutions analyzer.
9170 Large expressions slow the analyzer.
9172 @item scev-max-expr-complexity
9173 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9174 Complex expressions slow the analyzer.
9176 @item omega-max-vars
9177 The maximum number of variables in an Omega constraint system.
9178 The default value is 128.
9180 @item omega-max-geqs
9181 The maximum number of inequalities in an Omega constraint system.
9182 The default value is 256.
9184 @item omega-max-eqs
9185 The maximum number of equalities in an Omega constraint system.
9186 The default value is 128.
9188 @item omega-max-wild-cards
9189 The maximum number of wildcard variables that the Omega solver is
9190 able to insert.  The default value is 18.
9192 @item omega-hash-table-size
9193 The size of the hash table in the Omega solver.  The default value is
9194 550.
9196 @item omega-max-keys
9197 The maximal number of keys used by the Omega solver.  The default
9198 value is 500.
9200 @item omega-eliminate-redundant-constraints
9201 When set to 1, use expensive methods to eliminate all redundant
9202 constraints.  The default value is 0.
9204 @item vect-max-version-for-alignment-checks
9205 The maximum number of run-time checks that can be performed when
9206 doing loop versioning for alignment in the vectorizer.  See option
9207 @option{-ftree-vect-loop-version} for more information.
9209 @item vect-max-version-for-alias-checks
9210 The maximum number of run-time checks that can be performed when
9211 doing loop versioning for alias in the vectorizer.  See option
9212 @option{-ftree-vect-loop-version} for more information.
9214 @item max-iterations-to-track
9215 The maximum number of iterations of a loop the brute-force algorithm
9216 for analysis of the number of iterations of the loop tries to evaluate.
9218 @item hot-bb-count-fraction
9219 Select fraction of the maximal count of repetitions of basic block in program
9220 given basic block needs to have to be considered hot.
9222 @item hot-bb-frequency-fraction
9223 Select fraction of the entry block frequency of executions of basic block in
9224 function given basic block needs to have to be considered hot.
9226 @item max-predicted-iterations
9227 The maximum number of loop iterations we predict statically.  This is useful
9228 in cases where a function contains a single loop with known bound and
9229 another loop with unknown bound.
9230 The known number of iterations is predicted correctly, while
9231 the unknown number of iterations average to roughly 10.  This means that the
9232 loop without bounds appears artificially cold relative to the other one.
9234 @item align-threshold
9236 Select fraction of the maximal frequency of executions of a basic block in
9237 a function to align the basic block.
9239 @item align-loop-iterations
9241 A loop expected to iterate at least the selected number of iterations is
9242 aligned.
9244 @item tracer-dynamic-coverage
9245 @itemx tracer-dynamic-coverage-feedback
9247 This value is used to limit superblock formation once the given percentage of
9248 executed instructions is covered.  This limits unnecessary code size
9249 expansion.
9251 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9252 feedback is available.  The real profiles (as opposed to statically estimated
9253 ones) are much less balanced allowing the threshold to be larger value.
9255 @item tracer-max-code-growth
9256 Stop tail duplication once code growth has reached given percentage.  This is
9257 a rather artificial limit, as most of the duplicates are eliminated later in
9258 cross jumping, so it may be set to much higher values than is the desired code
9259 growth.
9261 @item tracer-min-branch-ratio
9263 Stop reverse growth when the reverse probability of best edge is less than this
9264 threshold (in percent).
9266 @item tracer-min-branch-ratio
9267 @itemx tracer-min-branch-ratio-feedback
9269 Stop forward growth if the best edge has probability lower than this
9270 threshold.
9272 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9273 compilation for profile feedback and one for compilation without.  The value
9274 for compilation with profile feedback needs to be more conservative (higher) in
9275 order to make tracer effective.
9277 @item max-cse-path-length
9279 The maximum number of basic blocks on path that CSE considers.
9280 The default is 10.
9282 @item max-cse-insns
9283 The maximum number of instructions CSE processes before flushing.
9284 The default is 1000.
9286 @item ggc-min-expand
9288 GCC uses a garbage collector to manage its own memory allocation.  This
9289 parameter specifies the minimum percentage by which the garbage
9290 collector's heap should be allowed to expand between collections.
9291 Tuning this may improve compilation speed; it has no effect on code
9292 generation.
9294 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9295 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9296 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9297 GCC is not able to calculate RAM on a particular platform, the lower
9298 bound of 30% is used.  Setting this parameter and
9299 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9300 every opportunity.  This is extremely slow, but can be useful for
9301 debugging.
9303 @item ggc-min-heapsize
9305 Minimum size of the garbage collector's heap before it begins bothering
9306 to collect garbage.  The first collection occurs after the heap expands
9307 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9308 tuning this may improve compilation speed, and has no effect on code
9309 generation.
9311 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9312 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9313 with a lower bound of 4096 (four megabytes) and an upper bound of
9314 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9315 particular platform, the lower bound is used.  Setting this parameter
9316 very large effectively disables garbage collection.  Setting this
9317 parameter and @option{ggc-min-expand} to zero causes a full collection
9318 to occur at every opportunity.
9320 @item max-reload-search-insns
9321 The maximum number of instruction reload should look backward for equivalent
9322 register.  Increasing values mean more aggressive optimization, making the
9323 compilation time increase with probably slightly better performance.
9324 The default value is 100.
9326 @item max-cselib-memory-locations
9327 The maximum number of memory locations cselib should take into account.
9328 Increasing values mean more aggressive optimization, making the compilation time
9329 increase with probably slightly better performance.  The default value is 500.
9331 @item reorder-blocks-duplicate
9332 @itemx reorder-blocks-duplicate-feedback
9334 Used by the basic block reordering pass to decide whether to use unconditional
9335 branch or duplicate the code on its destination.  Code is duplicated when its
9336 estimated size is smaller than this value multiplied by the estimated size of
9337 unconditional jump in the hot spots of the program.
9339 The @option{reorder-block-duplicate-feedback} is used only when profile
9340 feedback is available.  It may be set to higher values than
9341 @option{reorder-block-duplicate} since information about the hot spots is more
9342 accurate.
9344 @item max-sched-ready-insns
9345 The maximum number of instructions ready to be issued the scheduler should
9346 consider at any given time during the first scheduling pass.  Increasing
9347 values mean more thorough searches, making the compilation time increase
9348 with probably little benefit.  The default value is 100.
9350 @item max-sched-region-blocks
9351 The maximum number of blocks in a region to be considered for
9352 interblock scheduling.  The default value is 10.
9354 @item max-pipeline-region-blocks
9355 The maximum number of blocks in a region to be considered for
9356 pipelining in the selective scheduler.  The default value is 15.
9358 @item max-sched-region-insns
9359 The maximum number of insns in a region to be considered for
9360 interblock scheduling.  The default value is 100.
9362 @item max-pipeline-region-insns
9363 The maximum number of insns in a region to be considered for
9364 pipelining in the selective scheduler.  The default value is 200.
9366 @item min-spec-prob
9367 The minimum probability (in percents) of reaching a source block
9368 for interblock speculative scheduling.  The default value is 40.
9370 @item max-sched-extend-regions-iters
9371 The maximum number of iterations through CFG to extend regions.
9372 A value of 0 (the default) disables region extensions.
9374 @item max-sched-insn-conflict-delay
9375 The maximum conflict delay for an insn to be considered for speculative motion.
9376 The default value is 3.
9378 @item sched-spec-prob-cutoff
9379 The minimal probability of speculation success (in percents), so that
9380 speculative insns are scheduled.
9381 The default value is 40.
9383 @item sched-spec-state-edge-prob-cutoff
9384 The minimum probability an edge must have for the scheduler to save its
9385 state across it.
9386 The default value is 10.
9388 @item sched-mem-true-dep-cost
9389 Minimal distance (in CPU cycles) between store and load targeting same
9390 memory locations.  The default value is 1.
9392 @item selsched-max-lookahead
9393 The maximum size of the lookahead window of selective scheduling.  It is a
9394 depth of search for available instructions.
9395 The default value is 50.
9397 @item selsched-max-sched-times
9398 The maximum number of times that an instruction is scheduled during
9399 selective scheduling.  This is the limit on the number of iterations
9400 through which the instruction may be pipelined.  The default value is 2.
9402 @item selsched-max-insns-to-rename
9403 The maximum number of best instructions in the ready list that are considered
9404 for renaming in the selective scheduler.  The default value is 2.
9406 @item sms-min-sc
9407 The minimum value of stage count that swing modulo scheduler
9408 generates.  The default value is 2.
9410 @item max-last-value-rtl
9411 The maximum size measured as number of RTLs that can be recorded in an expression
9412 in combiner for a pseudo register as last known value of that register.  The default
9413 is 10000.
9415 @item integer-share-limit
9416 Small integer constants can use a shared data structure, reducing the
9417 compiler's memory usage and increasing its speed.  This sets the maximum
9418 value of a shared integer constant.  The default value is 256.
9420 @item ssp-buffer-size
9421 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9422 protection when @option{-fstack-protection} is used.
9424 @item max-jump-thread-duplication-stmts
9425 Maximum number of statements allowed in a block that needs to be
9426 duplicated when threading jumps.
9428 @item max-fields-for-field-sensitive
9429 Maximum number of fields in a structure treated in
9430 a field sensitive manner during pointer analysis.  The default is zero
9431 for @option{-O0} and @option{-O1},
9432 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9434 @item prefetch-latency
9435 Estimate on average number of instructions that are executed before
9436 prefetch finishes.  The distance prefetched ahead is proportional
9437 to this constant.  Increasing this number may also lead to less
9438 streams being prefetched (see @option{simultaneous-prefetches}).
9440 @item simultaneous-prefetches
9441 Maximum number of prefetches that can run at the same time.
9443 @item l1-cache-line-size
9444 The size of cache line in L1 cache, in bytes.
9446 @item l1-cache-size
9447 The size of L1 cache, in kilobytes.
9449 @item l2-cache-size
9450 The size of L2 cache, in kilobytes.
9452 @item min-insn-to-prefetch-ratio
9453 The minimum ratio between the number of instructions and the
9454 number of prefetches to enable prefetching in a loop.
9456 @item prefetch-min-insn-to-mem-ratio
9457 The minimum ratio between the number of instructions and the
9458 number of memory references to enable prefetching in a loop.
9460 @item use-canonical-types
9461 Whether the compiler should use the ``canonical'' type system.  By
9462 default, this should always be 1, which uses a more efficient internal
9463 mechanism for comparing types in C++ and Objective-C++.  However, if
9464 bugs in the canonical type system are causing compilation failures,
9465 set this value to 0 to disable canonical types.
9467 @item switch-conversion-max-branch-ratio
9468 Switch initialization conversion refuses to create arrays that are
9469 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9470 branches in the switch.
9472 @item max-partial-antic-length
9473 Maximum length of the partial antic set computed during the tree
9474 partial redundancy elimination optimization (@option{-ftree-pre}) when
9475 optimizing at @option{-O3} and above.  For some sorts of source code
9476 the enhanced partial redundancy elimination optimization can run away,
9477 consuming all of the memory available on the host machine.  This
9478 parameter sets a limit on the length of the sets that are computed,
9479 which prevents the runaway behavior.  Setting a value of 0 for
9480 this parameter allows an unlimited set length.
9482 @item sccvn-max-scc-size
9483 Maximum size of a strongly connected component (SCC) during SCCVN
9484 processing.  If this limit is hit, SCCVN processing for the whole
9485 function is not done and optimizations depending on it are
9486 disabled.  The default maximum SCC size is 10000.
9488 @item sccvn-max-alias-queries-per-access
9489 Maximum number of alias-oracle queries we perform when looking for
9490 redundancies for loads and stores.  If this limit is hit the search
9491 is aborted and the load or store is not considered redundant.  The
9492 number of queries is algorithmically limited to the number of
9493 stores on all paths from the load to the function entry.
9494 The default maxmimum number of queries is 1000.
9496 @item ira-max-loops-num
9497 IRA uses regional register allocation by default.  If a function
9498 contains more loops than the number given by this parameter, only at most
9499 the given number of the most frequently-executed loops form regions
9500 for regional register allocation.  The default value of the
9501 parameter is 100.
9503 @item ira-max-conflict-table-size 
9504 Although IRA uses a sophisticated algorithm to compress the conflict
9505 table, the table can still require excessive amounts of memory for
9506 huge functions.  If the conflict table for a function could be more
9507 than the size in MB given by this parameter, the register allocator
9508 instead uses a faster, simpler, and lower-quality
9509 algorithm that does not require building a pseudo-register conflict table.  
9510 The default value of the parameter is 2000.
9512 @item ira-loop-reserved-regs
9513 IRA can be used to evaluate more accurate register pressure in loops
9514 for decisions to move loop invariants (see @option{-O3}).  The number
9515 of available registers reserved for some other purposes is given
9516 by this parameter.  The default value of the parameter is 2, which is
9517 the minimal number of registers needed by typical instructions.
9518 This value is the best found from numerous experiments.
9520 @item loop-invariant-max-bbs-in-loop
9521 Loop invariant motion can be very expensive, both in compilation time and
9522 in amount of needed compile-time memory, with very large loops.  Loops
9523 with more basic blocks than this parameter won't have loop invariant
9524 motion optimization performed on them.  The default value of the
9525 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9527 @item loop-max-datarefs-for-datadeps
9528 Building data dapendencies is expensive for very large loops.  This
9529 parameter limits the number of data references in loops that are
9530 considered for data dependence analysis.  These large loops are no
9531 handled by the optimizations using loop data dependencies.
9532 The default value is 1000.
9534 @item max-vartrack-size
9535 Sets a maximum number of hash table slots to use during variable
9536 tracking dataflow analysis of any function.  If this limit is exceeded
9537 with variable tracking at assignments enabled, analysis for that
9538 function is retried without it, after removing all debug insns from
9539 the function.  If the limit is exceeded even without debug insns, var
9540 tracking analysis is completely disabled for the function.  Setting
9541 the parameter to zero makes it unlimited.
9543 @item max-vartrack-expr-depth
9544 Sets a maximum number of recursion levels when attempting to map
9545 variable names or debug temporaries to value expressions.  This trades
9546 compilation time for more complete debug information.  If this is set too
9547 low, value expressions that are available and could be represented in
9548 debug information may end up not being used; setting this higher may
9549 enable the compiler to find more complex debug expressions, but compile
9550 time and memory use may grow.  The default is 12.
9552 @item min-nondebug-insn-uid
9553 Use uids starting at this parameter for nondebug insns.  The range below
9554 the parameter is reserved exclusively for debug insns created by
9555 @option{-fvar-tracking-assignments}, but debug insns may get
9556 (non-overlapping) uids above it if the reserved range is exhausted.
9558 @item ipa-sra-ptr-growth-factor
9559 IPA-SRA replaces a pointer to an aggregate with one or more new
9560 parameters only when their cumulative size is less or equal to
9561 @option{ipa-sra-ptr-growth-factor} times the size of the original
9562 pointer parameter.
9564 @item tm-max-aggregate-size
9565 When making copies of thread-local variables in a transaction, this
9566 parameter specifies the size in bytes after which variables are
9567 saved with the logging functions as opposed to save/restore code
9568 sequence pairs.  This option only applies when using
9569 @option{-fgnu-tm}.
9571 @item graphite-max-nb-scop-params
9572 To avoid exponential effects in the Graphite loop transforms, the
9573 number of parameters in a Static Control Part (SCoP) is bounded.  The
9574 default value is 10 parameters.  A variable whose value is unknown at
9575 compilation time and defined outside a SCoP is a parameter of the SCoP.
9577 @item graphite-max-bbs-per-function
9578 To avoid exponential effects in the detection of SCoPs, the size of
9579 the functions analyzed by Graphite is bounded.  The default value is
9580 100 basic blocks.
9582 @item loop-block-tile-size
9583 Loop blocking or strip mining transforms, enabled with
9584 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9585 loop in the loop nest by a given number of iterations.  The strip
9586 length can be changed using the @option{loop-block-tile-size}
9587 parameter.  The default value is 51 iterations.
9589 @item ipa-cp-value-list-size
9590 IPA-CP attempts to track all possible values and types passed to a function's
9591 parameter in order to propagate them and perform devirtualization.
9592 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9593 stores per one formal parameter of a function.
9595 @item lto-partitions
9596 Specify desired number of partitions produced during WHOPR compilation.
9597 The number of partitions should exceed the number of CPUs used for compilation.
9598 The default value is 32.
9600 @item lto-minpartition
9601 Size of minimal partition for WHOPR (in estimated instructions).
9602 This prevents expenses of splitting very small programs into too many
9603 partitions.
9605 @item cxx-max-namespaces-for-diagnostic-help
9606 The maximum number of namespaces to consult for suggestions when C++
9607 name lookup fails for an identifier.  The default is 1000.
9609 @item sink-frequency-threshold
9610 The maximum relative execution frequency (in percents) of the target block
9611 relative to a statement's original block to allow statement sinking of a
9612 statement.  Larger numbers result in more aggressive statement sinking.
9613 The default value is 75.  A small positive adjustment is applied for
9614 statements with memory operands as those are even more profitable so sink.
9616 @item max-stores-to-sink
9617 The maximum number of conditional stores paires that can be sunk.  Set to 0
9618 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9619 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9621 @item allow-load-data-races
9622 Allow optimizers to introduce new data races on loads.
9623 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9624 unless implicitly set by the @option{-fmemory-model=} option.
9626 @item allow-store-data-races
9627 Allow optimizers to introduce new data races on stores.
9628 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9629 unless implicitly set by the @option{-fmemory-model=} option.
9631 @item allow-packed-load-data-races
9632 Allow optimizers to introduce new data races on packed data loads.
9633 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9634 unless implicitly set by the @option{-fmemory-model=} option.
9636 @item allow-packed-store-data-races
9637 Allow optimizers to introduce new data races on packed data stores.
9638 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9639 unless implicitly set by the @option{-fmemory-model=} option.
9641 @item case-values-threshold
9642 The smallest number of different values for which it is best to use a
9643 jump-table instead of a tree of conditional branches.  If the value is
9644 0, use the default for the machine.  The default is 0.
9646 @item tree-reassoc-width
9647 Set the maximum number of instructions executed in parallel in
9648 reassociated tree. This parameter overrides target dependent
9649 heuristics used by default if has non zero value.
9651 @item sched-pressure-algorithm
9652 Choose between the two available implementations of
9653 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
9654 and is the more likely to prevent instructions from being reordered.
9655 Algorithm 2 was designed to be a compromise between the relatively
9656 conservative approach taken by algorithm 1 and the rather aggressive
9657 approach taken by the default scheduler.  It relies more heavily on
9658 having a regular register file and accurate register pressure classes.
9659 See @file{haifa-sched.c} in the GCC sources for more details.
9661 The default choice depends on the target.
9663 @item max-slsr-cand-scan
9664 Set the maximum number of existing candidates that will be considered when
9665 seeking a basis for a new straight-line strength reduction candidate.
9667 @end table
9668 @end table
9670 @node Preprocessor Options
9671 @section Options Controlling the Preprocessor
9672 @cindex preprocessor options
9673 @cindex options, preprocessor
9675 These options control the C preprocessor, which is run on each C source
9676 file before actual compilation.
9678 If you use the @option{-E} option, nothing is done except preprocessing.
9679 Some of these options make sense only together with @option{-E} because
9680 they cause the preprocessor output to be unsuitable for actual
9681 compilation.
9683 @table @gcctabopt
9684 @item -Wp,@var{option}
9685 @opindex Wp
9686 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9687 and pass @var{option} directly through to the preprocessor.  If
9688 @var{option} contains commas, it is split into multiple options at the
9689 commas.  However, many options are modified, translated or interpreted
9690 by the compiler driver before being passed to the preprocessor, and
9691 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9692 interface is undocumented and subject to change, so whenever possible
9693 you should avoid using @option{-Wp} and let the driver handle the
9694 options instead.
9696 @item -Xpreprocessor @var{option}
9697 @opindex Xpreprocessor
9698 Pass @var{option} as an option to the preprocessor.  You can use this to
9699 supply system-specific preprocessor options that GCC does not 
9700 recognize.
9702 If you want to pass an option that takes an argument, you must use
9703 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9705 @item -no-integrated-cpp
9706 @opindex no-integrated-cpp
9707 Perform preprocessing as a separate pass before compilation.
9708 By default, GCC performs preprocessing as an integrated part of
9709 input tokenization and parsing.
9710 If this option is provided, the appropriate language front end
9711 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9712 and Objective-C, respectively) is instead invoked twice,
9713 once for preprocessing only and once for actual compilation
9714 of the preprocessed input.
9715 This option may be useful in conjunction with the @option{-B} or
9716 @option{-wrapper} options to specify an alternate preprocessor or
9717 perform additional processing of the program source between
9718 normal preprocessing and compilation.
9719 @end table
9721 @include cppopts.texi
9723 @node Assembler Options
9724 @section Passing Options to the Assembler
9726 @c prevent bad page break with this line
9727 You can pass options to the assembler.
9729 @table @gcctabopt
9730 @item -Wa,@var{option}
9731 @opindex Wa
9732 Pass @var{option} as an option to the assembler.  If @var{option}
9733 contains commas, it is split into multiple options at the commas.
9735 @item -Xassembler @var{option}
9736 @opindex Xassembler
9737 Pass @var{option} as an option to the assembler.  You can use this to
9738 supply system-specific assembler options that GCC does not
9739 recognize.
9741 If you want to pass an option that takes an argument, you must use
9742 @option{-Xassembler} twice, once for the option and once for the argument.
9744 @end table
9746 @node Link Options
9747 @section Options for Linking
9748 @cindex link options
9749 @cindex options, linking
9751 These options come into play when the compiler links object files into
9752 an executable output file.  They are meaningless if the compiler is
9753 not doing a link step.
9755 @table @gcctabopt
9756 @cindex file names
9757 @item @var{object-file-name}
9758 A file name that does not end in a special recognized suffix is
9759 considered to name an object file or library.  (Object files are
9760 distinguished from libraries by the linker according to the file
9761 contents.)  If linking is done, these object files are used as input
9762 to the linker.
9764 @item -c
9765 @itemx -S
9766 @itemx -E
9767 @opindex c
9768 @opindex S
9769 @opindex E
9770 If any of these options is used, then the linker is not run, and
9771 object file names should not be used as arguments.  @xref{Overall
9772 Options}.
9774 @cindex Libraries
9775 @item -l@var{library}
9776 @itemx -l @var{library}
9777 @opindex l
9778 Search the library named @var{library} when linking.  (The second
9779 alternative with the library as a separate argument is only for
9780 POSIX compliance and is not recommended.)
9782 It makes a difference where in the command you write this option; the
9783 linker searches and processes libraries and object files in the order they
9784 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9785 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9786 to functions in @samp{z}, those functions may not be loaded.
9788 The linker searches a standard list of directories for the library,
9789 which is actually a file named @file{lib@var{library}.a}.  The linker
9790 then uses this file as if it had been specified precisely by name.
9792 The directories searched include several standard system directories
9793 plus any that you specify with @option{-L}.
9795 Normally the files found this way are library files---archive files
9796 whose members are object files.  The linker handles an archive file by
9797 scanning through it for members which define symbols that have so far
9798 been referenced but not defined.  But if the file that is found is an
9799 ordinary object file, it is linked in the usual fashion.  The only
9800 difference between using an @option{-l} option and specifying a file name
9801 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9802 and searches several directories.
9804 @item -lobjc
9805 @opindex lobjc
9806 You need this special case of the @option{-l} option in order to
9807 link an Objective-C or Objective-C++ program.
9809 @item -nostartfiles
9810 @opindex nostartfiles
9811 Do not use the standard system startup files when linking.
9812 The standard system libraries are used normally, unless @option{-nostdlib}
9813 or @option{-nodefaultlibs} is used.
9815 @item -nodefaultlibs
9816 @opindex nodefaultlibs
9817 Do not use the standard system libraries when linking.
9818 Only the libraries you specify are passed to the linker, and options
9819 specifying linkage of the system libraries, such as @code{-static-libgcc}
9820 or @code{-shared-libgcc}, are ignored.  
9821 The standard startup files are used normally, unless @option{-nostartfiles}
9822 is used.  
9824 The compiler may generate calls to @code{memcmp},
9825 @code{memset}, @code{memcpy} and @code{memmove}.
9826 These entries are usually resolved by entries in
9827 libc.  These entry points should be supplied through some other
9828 mechanism when this option is specified.
9830 @item -nostdlib
9831 @opindex nostdlib
9832 Do not use the standard system startup files or libraries when linking.
9833 No startup files and only the libraries you specify are passed to
9834 the linker, and options specifying linkage of the system libraries, such as
9835 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
9837 The compiler may generate calls to @code{memcmp}, @code{memset},
9838 @code{memcpy} and @code{memmove}.
9839 These entries are usually resolved by entries in
9840 libc.  These entry points should be supplied through some other
9841 mechanism when this option is specified.
9843 @cindex @option{-lgcc}, use with @option{-nostdlib}
9844 @cindex @option{-nostdlib} and unresolved references
9845 @cindex unresolved references and @option{-nostdlib}
9846 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9847 @cindex @option{-nodefaultlibs} and unresolved references
9848 @cindex unresolved references and @option{-nodefaultlibs}
9849 One of the standard libraries bypassed by @option{-nostdlib} and
9850 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9851 which GCC uses to overcome shortcomings of particular machines, or special
9852 needs for some languages.
9853 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9854 Collection (GCC) Internals},
9855 for more discussion of @file{libgcc.a}.)
9856 In most cases, you need @file{libgcc.a} even when you want to avoid
9857 other standard libraries.  In other words, when you specify @option{-nostdlib}
9858 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9859 This ensures that you have no unresolved references to internal GCC
9860 library subroutines.
9861 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
9862 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
9863 GNU Compiler Collection (GCC) Internals}.)
9865 @item -pie
9866 @opindex pie
9867 Produce a position independent executable on targets that support it.
9868 For predictable results, you must also specify the same set of options
9869 used for compilation (@option{-fpie}, @option{-fPIE},
9870 or model suboptions) when you specify this linker option.
9872 @item -rdynamic
9873 @opindex rdynamic
9874 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9875 that support it. This instructs the linker to add all symbols, not
9876 only used ones, to the dynamic symbol table. This option is needed
9877 for some uses of @code{dlopen} or to allow obtaining backtraces
9878 from within a program.
9880 @item -s
9881 @opindex s
9882 Remove all symbol table and relocation information from the executable.
9884 @item -static
9885 @opindex static
9886 On systems that support dynamic linking, this prevents linking with the shared
9887 libraries.  On other systems, this option has no effect.
9889 @item -shared
9890 @opindex shared
9891 Produce a shared object which can then be linked with other objects to
9892 form an executable.  Not all systems support this option.  For predictable
9893 results, you must also specify the same set of options used for compilation
9894 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
9895 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
9896 needs to build supplementary stub code for constructors to work.  On
9897 multi-libbed systems, @samp{gcc -shared} must select the correct support
9898 libraries to link against.  Failing to supply the correct flags may lead
9899 to subtle defects.  Supplying them in cases where they are not necessary
9900 is innocuous.}
9902 @item -shared-libgcc
9903 @itemx -static-libgcc
9904 @opindex shared-libgcc
9905 @opindex static-libgcc
9906 On systems that provide @file{libgcc} as a shared library, these options
9907 force the use of either the shared or static version, respectively.
9908 If no shared version of @file{libgcc} was built when the compiler was
9909 configured, these options have no effect.
9911 There are several situations in which an application should use the
9912 shared @file{libgcc} instead of the static version.  The most common
9913 of these is when the application wishes to throw and catch exceptions
9914 across different shared libraries.  In that case, each of the libraries
9915 as well as the application itself should use the shared @file{libgcc}.
9917 Therefore, the G++ and GCJ drivers automatically add
9918 @option{-shared-libgcc} whenever you build a shared library or a main
9919 executable, because C++ and Java programs typically use exceptions, so
9920 this is the right thing to do.
9922 If, instead, you use the GCC driver to create shared libraries, you may
9923 find that they are not always linked with the shared @file{libgcc}.
9924 If GCC finds, at its configuration time, that you have a non-GNU linker
9925 or a GNU linker that does not support option @option{--eh-frame-hdr},
9926 it links the shared version of @file{libgcc} into shared libraries
9927 by default.  Otherwise, it takes advantage of the linker and optimizes
9928 away the linking with the shared version of @file{libgcc}, linking with
9929 the static version of libgcc by default.  This allows exceptions to
9930 propagate through such shared libraries, without incurring relocation
9931 costs at library load time.
9933 However, if a library or main executable is supposed to throw or catch
9934 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9935 for the languages used in the program, or using the option
9936 @option{-shared-libgcc}, such that it is linked with the shared
9937 @file{libgcc}.
9939 @item -static-libstdc++
9940 When the @command{g++} program is used to link a C++ program, it
9941 normally automatically links against @option{libstdc++}.  If
9942 @file{libstdc++} is available as a shared library, and the
9943 @option{-static} option is not used, then this links against the
9944 shared version of @file{libstdc++}.  That is normally fine.  However, it
9945 is sometimes useful to freeze the version of @file{libstdc++} used by
9946 the program without going all the way to a fully static link.  The
9947 @option{-static-libstdc++} option directs the @command{g++} driver to
9948 link @file{libstdc++} statically, without necessarily linking other
9949 libraries statically.
9951 @item -symbolic
9952 @opindex symbolic
9953 Bind references to global symbols when building a shared object.  Warn
9954 about any unresolved references (unless overridden by the link editor
9955 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
9956 this option.
9958 @item -T @var{script}
9959 @opindex T
9960 @cindex linker script
9961 Use @var{script} as the linker script.  This option is supported by most
9962 systems using the GNU linker.  On some targets, such as bare-board
9963 targets without an operating system, the @option{-T} option may be required
9964 when linking to avoid references to undefined symbols.
9966 @item -Xlinker @var{option}
9967 @opindex Xlinker
9968 Pass @var{option} as an option to the linker.  You can use this to
9969 supply system-specific linker options that GCC does not recognize.
9971 If you want to pass an option that takes a separate argument, you must use
9972 @option{-Xlinker} twice, once for the option and once for the argument.
9973 For example, to pass @option{-assert definitions}, you must write
9974 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9975 @option{-Xlinker "-assert definitions"}, because this passes the entire
9976 string as a single argument, which is not what the linker expects.
9978 When using the GNU linker, it is usually more convenient to pass
9979 arguments to linker options using the @option{@var{option}=@var{value}}
9980 syntax than as separate arguments.  For example, you can specify
9981 @option{-Xlinker -Map=output.map} rather than
9982 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9983 this syntax for command-line options.
9985 @item -Wl,@var{option}
9986 @opindex Wl
9987 Pass @var{option} as an option to the linker.  If @var{option} contains
9988 commas, it is split into multiple options at the commas.  You can use this
9989 syntax to pass an argument to the option.
9990 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
9991 linker.  When using the GNU linker, you can also get the same effect with
9992 @option{-Wl,-Map=output.map}.
9994 @item -u @var{symbol}
9995 @opindex u
9996 Pretend the symbol @var{symbol} is undefined, to force linking of
9997 library modules to define it.  You can use @option{-u} multiple times with
9998 different symbols to force loading of additional library modules.
9999 @end table
10001 @node Directory Options
10002 @section Options for Directory Search
10003 @cindex directory options
10004 @cindex options, directory search
10005 @cindex search path
10007 These options specify directories to search for header files, for
10008 libraries and for parts of the compiler:
10010 @table @gcctabopt
10011 @item -I@var{dir}
10012 @opindex I
10013 Add the directory @var{dir} to the head of the list of directories to be
10014 searched for header files.  This can be used to override a system header
10015 file, substituting your own version, since these directories are
10016 searched before the system header file directories.  However, you should
10017 not use this option to add directories that contain vendor-supplied
10018 system header files (use @option{-isystem} for that).  If you use more than
10019 one @option{-I} option, the directories are scanned in left-to-right
10020 order; the standard system directories come after.
10022 If a standard system include directory, or a directory specified with
10023 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10024 option is ignored.  The directory is still searched but as a
10025 system directory at its normal position in the system include chain.
10026 This is to ensure that GCC's procedure to fix buggy system headers and
10027 the ordering for the @code{include_next} directive are not inadvertently changed.
10028 If you really need to change the search order for system directories,
10029 use the @option{-nostdinc} and/or @option{-isystem} options.
10031 @item -iplugindir=@var{dir}
10032 Set the directory to search for plugins that are passed
10033 by @option{-fplugin=@var{name}} instead of
10034 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10035 to be used by the user, but only passed by the driver.
10037 @item -iquote@var{dir}
10038 @opindex iquote
10039 Add the directory @var{dir} to the head of the list of directories to
10040 be searched for header files only for the case of @samp{#include
10041 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10042 otherwise just like @option{-I}.
10044 @item -L@var{dir}
10045 @opindex L
10046 Add directory @var{dir} to the list of directories to be searched
10047 for @option{-l}.
10049 @item -B@var{prefix}
10050 @opindex B
10051 This option specifies where to find the executables, libraries,
10052 include files, and data files of the compiler itself.
10054 The compiler driver program runs one or more of the subprograms
10055 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10056 @var{prefix} as a prefix for each program it tries to run, both with and
10057 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10059 For each subprogram to be run, the compiler driver first tries the
10060 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10061 is not specified, the driver tries two standard prefixes, 
10062 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10063 those results in a file name that is found, the unmodified program
10064 name is searched for using the directories specified in your
10065 @env{PATH} environment variable.
10067 The compiler checks to see if the path provided by the @option{-B}
10068 refers to a directory, and if necessary it adds a directory
10069 separator character at the end of the path.
10071 @option{-B} prefixes that effectively specify directory names also apply
10072 to libraries in the linker, because the compiler translates these
10073 options into @option{-L} options for the linker.  They also apply to
10074 includes files in the preprocessor, because the compiler translates these
10075 options into @option{-isystem} options for the preprocessor.  In this case,
10076 the compiler appends @samp{include} to the prefix.
10078 The runtime support file @file{libgcc.a} can also be searched for using
10079 the @option{-B} prefix, if needed.  If it is not found there, the two
10080 standard prefixes above are tried, and that is all.  The file is left
10081 out of the link if it is not found by those means.
10083 Another way to specify a prefix much like the @option{-B} prefix is to use
10084 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10085 Variables}.
10087 As a special kludge, if the path provided by @option{-B} is
10088 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10089 9, then it is replaced by @file{[dir/]include}.  This is to help
10090 with boot-strapping the compiler.
10092 @item -specs=@var{file}
10093 @opindex specs
10094 Process @var{file} after the compiler reads in the standard @file{specs}
10095 file, in order to override the defaults which the @command{gcc} driver
10096 program uses when determining what switches to pass to @command{cc1},
10097 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
10098 @option{-specs=@var{file}} can be specified on the command line, and they
10099 are processed in order, from left to right.
10101 @item --sysroot=@var{dir}
10102 @opindex sysroot
10103 Use @var{dir} as the logical root directory for headers and libraries.
10104 For example, if the compiler normally searches for headers in
10105 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10106 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10108 If you use both this option and the @option{-isysroot} option, then
10109 the @option{--sysroot} option applies to libraries, but the
10110 @option{-isysroot} option applies to header files.
10112 The GNU linker (beginning with version 2.16) has the necessary support
10113 for this option.  If your linker does not support this option, the
10114 header file aspect of @option{--sysroot} still works, but the
10115 library aspect does not.
10117 @item --no-sysroot-suffix
10118 @opindex no-sysroot-suffix
10119 For some targets, a suffix is added to the root directory specified
10120 with @option{--sysroot}, depending on the other options used, so that
10121 headers may for example be found in
10122 @file{@var{dir}/@var{suffix}/usr/include} instead of
10123 @file{@var{dir}/usr/include}.  This option disables the addition of
10124 such a suffix.
10126 @item -I-
10127 @opindex I-
10128 This option has been deprecated.  Please use @option{-iquote} instead for
10129 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10130 Any directories you specify with @option{-I} options before the @option{-I-}
10131 option are searched only for the case of @samp{#include "@var{file}"};
10132 they are not searched for @samp{#include <@var{file}>}.
10134 If additional directories are specified with @option{-I} options after
10135 the @option{-I-}, these directories are searched for all @samp{#include}
10136 directives.  (Ordinarily @emph{all} @option{-I} directories are used
10137 this way.)
10139 In addition, the @option{-I-} option inhibits the use of the current
10140 directory (where the current input file came from) as the first search
10141 directory for @samp{#include "@var{file}"}.  There is no way to
10142 override this effect of @option{-I-}.  With @option{-I.} you can specify
10143 searching the directory that is current when the compiler is
10144 invoked.  That is not exactly the same as what the preprocessor does
10145 by default, but it is often satisfactory.
10147 @option{-I-} does not inhibit the use of the standard system directories
10148 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
10149 independent.
10150 @end table
10152 @c man end
10154 @node Spec Files
10155 @section Specifying subprocesses and the switches to pass to them
10156 @cindex Spec Files
10158 @command{gcc} is a driver program.  It performs its job by invoking a
10159 sequence of other programs to do the work of compiling, assembling and
10160 linking.  GCC interprets its command-line parameters and uses these to
10161 deduce which programs it should invoke, and which command-line options
10162 it ought to place on their command lines.  This behavior is controlled
10163 by @dfn{spec strings}.  In most cases there is one spec string for each
10164 program that GCC can invoke, but a few programs have multiple spec
10165 strings to control their behavior.  The spec strings built into GCC can
10166 be overridden by using the @option{-specs=} command-line switch to specify
10167 a spec file.
10169 @dfn{Spec files} are plaintext files that are used to construct spec
10170 strings.  They consist of a sequence of directives separated by blank
10171 lines.  The type of directive is determined by the first non-whitespace
10172 character on the line, which can be one of the following:
10174 @table @code
10175 @item %@var{command}
10176 Issues a @var{command} to the spec file processor.  The commands that can
10177 appear here are:
10179 @table @code
10180 @item %include <@var{file}>
10181 @cindex @code{%include}
10182 Search for @var{file} and insert its text at the current point in the
10183 specs file.
10185 @item %include_noerr <@var{file}>
10186 @cindex @code{%include_noerr}
10187 Just like @samp{%include}, but do not generate an error message if the include
10188 file cannot be found.
10190 @item %rename @var{old_name} @var{new_name}
10191 @cindex @code{%rename}
10192 Rename the spec string @var{old_name} to @var{new_name}.
10194 @end table
10196 @item *[@var{spec_name}]:
10197 This tells the compiler to create, override or delete the named spec
10198 string.  All lines after this directive up to the next directive or
10199 blank line are considered to be the text for the spec string.  If this
10200 results in an empty string then the spec is deleted.  (Or, if the
10201 spec did not exist, then nothing happens.)  Otherwise, if the spec
10202 does not currently exist a new spec is created.  If the spec does
10203 exist then its contents are overridden by the text of this
10204 directive, unless the first character of that text is the @samp{+}
10205 character, in which case the text is appended to the spec.
10207 @item [@var{suffix}]:
10208 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
10209 and up to the next directive or blank line are considered to make up the
10210 spec string for the indicated suffix.  When the compiler encounters an
10211 input file with the named suffix, it processes the spec string in
10212 order to work out how to compile that file.  For example:
10214 @smallexample
10215 .ZZ:
10216 z-compile -input %i
10217 @end smallexample
10219 This says that any input file whose name ends in @samp{.ZZ} should be
10220 passed to the program @samp{z-compile}, which should be invoked with the
10221 command-line switch @option{-input} and with the result of performing the
10222 @samp{%i} substitution.  (See below.)
10224 As an alternative to providing a spec string, the text following a
10225 suffix directive can be one of the following:
10227 @table @code
10228 @item @@@var{language}
10229 This says that the suffix is an alias for a known @var{language}.  This is
10230 similar to using the @option{-x} command-line switch to GCC to specify a
10231 language explicitly.  For example:
10233 @smallexample
10234 .ZZ:
10235 @@c++
10236 @end smallexample
10238 Says that .ZZ files are, in fact, C++ source files.
10240 @item #@var{name}
10241 This causes an error messages saying:
10243 @smallexample
10244 @var{name} compiler not installed on this system.
10245 @end smallexample
10246 @end table
10248 GCC already has an extensive list of suffixes built into it.
10249 This directive adds an entry to the end of the list of suffixes, but
10250 since the list is searched from the end backwards, it is effectively
10251 possible to override earlier entries using this technique.
10253 @end table
10255 GCC has the following spec strings built into it.  Spec files can
10256 override these strings or create their own.  Note that individual
10257 targets can also add their own spec strings to this list.
10259 @smallexample
10260 asm          Options to pass to the assembler
10261 asm_final    Options to pass to the assembler post-processor
10262 cpp          Options to pass to the C preprocessor
10263 cc1          Options to pass to the C compiler
10264 cc1plus      Options to pass to the C++ compiler
10265 endfile      Object files to include at the end of the link
10266 link         Options to pass to the linker
10267 lib          Libraries to include on the command line to the linker
10268 libgcc       Decides which GCC support library to pass to the linker
10269 linker       Sets the name of the linker
10270 predefines   Defines to be passed to the C preprocessor
10271 signed_char  Defines to pass to CPP to say whether @code{char} is signed
10272              by default
10273 startfile    Object files to include at the start of the link
10274 @end smallexample
10276 Here is a small example of a spec file:
10278 @smallexample
10279 %rename lib                 old_lib
10281 *lib:
10282 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10283 @end smallexample
10285 This example renames the spec called @samp{lib} to @samp{old_lib} and
10286 then overrides the previous definition of @samp{lib} with a new one.
10287 The new definition adds in some extra command-line options before
10288 including the text of the old definition.
10290 @dfn{Spec strings} are a list of command-line options to be passed to their
10291 corresponding program.  In addition, the spec strings can contain
10292 @samp{%}-prefixed sequences to substitute variable text or to
10293 conditionally insert text into the command line.  Using these constructs
10294 it is possible to generate quite complex command lines.
10296 Here is a table of all defined @samp{%}-sequences for spec
10297 strings.  Note that spaces are not generated automatically around the
10298 results of expanding these sequences.  Therefore you can concatenate them
10299 together or combine them with constant text in a single argument.
10301 @table @code
10302 @item %%
10303 Substitute one @samp{%} into the program name or argument.
10305 @item %i
10306 Substitute the name of the input file being processed.
10308 @item %b
10309 Substitute the basename of the input file being processed.
10310 This is the substring up to (and not including) the last period
10311 and not including the directory.
10313 @item %B
10314 This is the same as @samp{%b}, but include the file suffix (text after
10315 the last period).
10317 @item %d
10318 Marks the argument containing or following the @samp{%d} as a
10319 temporary file name, so that that file is deleted if GCC exits
10320 successfully.  Unlike @samp{%g}, this contributes no text to the
10321 argument.
10323 @item %g@var{suffix}
10324 Substitute a file name that has suffix @var{suffix} and is chosen
10325 once per compilation, and mark the argument in the same way as
10326 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10327 name is now chosen in a way that is hard to predict even when previously
10328 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10329 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10330 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10331 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10332 was simply substituted with a file name chosen once per compilation,
10333 without regard to any appended suffix (which was therefore treated
10334 just like ordinary text), making such attacks more likely to succeed.
10336 @item %u@var{suffix}
10337 Like @samp{%g}, but generates a new temporary file name
10338 each time it appears instead of once per compilation.
10340 @item %U@var{suffix}
10341 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10342 new one if there is no such last file name.  In the absence of any
10343 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10344 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10345 involves the generation of two distinct file names, one
10346 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10347 simply substituted with a file name chosen for the previous @samp{%u},
10348 without regard to any appended suffix.
10350 @item %j@var{suffix}
10351 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10352 writable, and if @option{-save-temps} is not used; 
10353 otherwise, substitute the name
10354 of a temporary file, just like @samp{%u}.  This temporary file is not
10355 meant for communication between processes, but rather as a junk
10356 disposal mechanism.
10358 @item %|@var{suffix}
10359 @itemx %m@var{suffix}
10360 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10361 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10362 all.  These are the two most common ways to instruct a program that it
10363 should read from standard input or write to standard output.  If you
10364 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10365 construct: see for example @file{f/lang-specs.h}.
10367 @item %.@var{SUFFIX}
10368 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10369 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10370 terminated by the next space or %.
10372 @item %w
10373 Marks the argument containing or following the @samp{%w} as the
10374 designated output file of this compilation.  This puts the argument
10375 into the sequence of arguments that @samp{%o} substitutes.
10377 @item %o
10378 Substitutes the names of all the output files, with spaces
10379 automatically placed around them.  You should write spaces
10380 around the @samp{%o} as well or the results are undefined.
10381 @samp{%o} is for use in the specs for running the linker.
10382 Input files whose names have no recognized suffix are not compiled
10383 at all, but they are included among the output files, so they are
10384 linked.
10386 @item %O
10387 Substitutes the suffix for object files.  Note that this is
10388 handled specially when it immediately follows @samp{%g, %u, or %U},
10389 because of the need for those to form complete file names.  The
10390 handling is such that @samp{%O} is treated exactly as if it had already
10391 been substituted, except that @samp{%g, %u, and %U} do not currently
10392 support additional @var{suffix} characters following @samp{%O} as they do
10393 following, for example, @samp{.o}.
10395 @item %p
10396 Substitutes the standard macro predefinitions for the
10397 current target machine.  Use this when running @code{cpp}.
10399 @item %P
10400 Like @samp{%p}, but puts @samp{__} before and after the name of each
10401 predefined macro, except for macros that start with @samp{__} or with
10402 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10405 @item %I
10406 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10407 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10408 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10409 and @option{-imultilib} as necessary.
10411 @item %s
10412 Current argument is the name of a library or startup file of some sort.
10413 Search for that file in a standard list of directories and substitute
10414 the full name found.  The current working directory is included in the
10415 list of directories scanned.
10417 @item %T
10418 Current argument is the name of a linker script.  Search for that file
10419 in the current list of directories to scan for libraries. If the file
10420 is located insert a @option{--script} option into the command line
10421 followed by the full path name found.  If the file is not found then
10422 generate an error message.  Note: the current working directory is not
10423 searched.
10425 @item %e@var{str}
10426 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10427 Use this when inconsistent options are detected.
10429 @item %(@var{name})
10430 Substitute the contents of spec string @var{name} at this point.
10432 @item %x@{@var{option}@}
10433 Accumulate an option for @samp{%X}.
10435 @item %X
10436 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10437 spec string.
10439 @item %Y
10440 Output the accumulated assembler options specified by @option{-Wa}.
10442 @item %Z
10443 Output the accumulated preprocessor options specified by @option{-Wp}.
10445 @item %a
10446 Process the @code{asm} spec.  This is used to compute the
10447 switches to be passed to the assembler.
10449 @item %A
10450 Process the @code{asm_final} spec.  This is a spec string for
10451 passing switches to an assembler post-processor, if such a program is
10452 needed.
10454 @item %l
10455 Process the @code{link} spec.  This is the spec for computing the
10456 command line passed to the linker.  Typically it makes use of the
10457 @samp{%L %G %S %D and %E} sequences.
10459 @item %D
10460 Dump out a @option{-L} option for each directory that GCC believes might
10461 contain startup files.  If the target supports multilibs then the
10462 current multilib directory is prepended to each of these paths.
10464 @item %L
10465 Process the @code{lib} spec.  This is a spec string for deciding which
10466 libraries are included on the command line to the linker.
10468 @item %G
10469 Process the @code{libgcc} spec.  This is a spec string for deciding
10470 which GCC support library is included on the command line to the linker.
10472 @item %S
10473 Process the @code{startfile} spec.  This is a spec for deciding which
10474 object files are the first ones passed to the linker.  Typically
10475 this might be a file named @file{crt0.o}.
10477 @item %E
10478 Process the @code{endfile} spec.  This is a spec string that specifies
10479 the last object files that are passed to the linker.
10481 @item %C
10482 Process the @code{cpp} spec.  This is used to construct the arguments
10483 to be passed to the C preprocessor.
10485 @item %1
10486 Process the @code{cc1} spec.  This is used to construct the options to be
10487 passed to the actual C compiler (@samp{cc1}).
10489 @item %2
10490 Process the @code{cc1plus} spec.  This is used to construct the options to be
10491 passed to the actual C++ compiler (@samp{cc1plus}).
10493 @item %*
10494 Substitute the variable part of a matched option.  See below.
10495 Note that each comma in the substituted string is replaced by
10496 a single space.
10498 @item %<@code{S}
10499 Remove all occurrences of @code{-S} from the command line.  Note---this
10500 command is position dependent.  @samp{%} commands in the spec string
10501 before this one see @code{-S}, @samp{%} commands in the spec string
10502 after this one do not.
10504 @item %:@var{function}(@var{args})
10505 Call the named function @var{function}, passing it @var{args}.
10506 @var{args} is first processed as a nested spec string, then split
10507 into an argument vector in the usual fashion.  The function returns
10508 a string which is processed as if it had appeared literally as part
10509 of the current spec.
10511 The following built-in spec functions are provided:
10513 @table @code
10514 @item @code{getenv}
10515 The @code{getenv} spec function takes two arguments: an environment
10516 variable name and a string.  If the environment variable is not
10517 defined, a fatal error is issued.  Otherwise, the return value is the
10518 value of the environment variable concatenated with the string.  For
10519 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10521 @smallexample
10522 %:getenv(TOPDIR /include)
10523 @end smallexample
10525 expands to @file{/path/to/top/include}.
10527 @item @code{if-exists}
10528 The @code{if-exists} spec function takes one argument, an absolute
10529 pathname to a file.  If the file exists, @code{if-exists} returns the
10530 pathname.  Here is a small example of its usage:
10532 @smallexample
10533 *startfile:
10534 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10535 @end smallexample
10537 @item @code{if-exists-else}
10538 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10539 spec function, except that it takes two arguments.  The first argument is
10540 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10541 returns the pathname.  If it does not exist, it returns the second argument.
10542 This way, @code{if-exists-else} can be used to select one file or another,
10543 based on the existence of the first.  Here is a small example of its usage:
10545 @smallexample
10546 *startfile:
10547 crt0%O%s %:if-exists(crti%O%s) \
10548 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10549 @end smallexample
10551 @item @code{replace-outfile}
10552 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10553 first argument in the outfiles array and replaces it with the second argument.  Here
10554 is a small example of its usage:
10556 @smallexample
10557 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10558 @end smallexample
10560 @item @code{remove-outfile}
10561 The @code{remove-outfile} spec function takes one argument.  It looks for the
10562 first argument in the outfiles array and removes it.  Here is a small example
10563 its usage:
10565 @smallexample
10566 %:remove-outfile(-lm)
10567 @end smallexample
10569 @item @code{pass-through-libs}
10570 The @code{pass-through-libs} spec function takes any number of arguments.  It
10571 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10572 assumes are the names of linker input library archive files) and returns a
10573 result containing all the found arguments each prepended by
10574 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10575 intended to be passed to the LTO linker plugin.
10577 @smallexample
10578 %:pass-through-libs(%G %L %G)
10579 @end smallexample
10581 @item @code{print-asm-header}
10582 The @code{print-asm-header} function takes no arguments and simply
10583 prints a banner like:
10585 @smallexample
10586 Assembler options
10587 =================
10589 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10590 @end smallexample
10592 It is used to separate compiler options from assembler options
10593 in the @option{--target-help} output.
10594 @end table
10596 @item %@{@code{S}@}
10597 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10598 If that switch is not specified, this substitutes nothing.  Note that
10599 the leading dash is omitted when specifying this option, and it is
10600 automatically inserted if the substitution is performed.  Thus the spec
10601 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10602 and outputs the command-line option @option{-foo}.
10604 @item %W@{@code{S}@}
10605 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10606 deleted on failure.
10608 @item %@{@code{S}*@}
10609 Substitutes all the switches specified to GCC whose names start
10610 with @code{-S}, but which also take an argument.  This is used for
10611 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10612 GCC considers @option{-o foo} as being
10613 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
10614 text, including the space.  Thus two arguments are generated.
10616 @item %@{@code{S}*&@code{T}*@}
10617 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10618 (the order of @code{S} and @code{T} in the spec is not significant).
10619 There can be any number of ampersand-separated variables; for each the
10620 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10622 @item %@{@code{S}:@code{X}@}
10623 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10625 @item %@{!@code{S}:@code{X}@}
10626 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10628 @item %@{@code{S}*:@code{X}@}
10629 Substitutes @code{X} if one or more switches whose names start with
10630 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10631 once, no matter how many such switches appeared.  However, if @code{%*}
10632 appears somewhere in @code{X}, then @code{X} is substituted once
10633 for each matching switch, with the @code{%*} replaced by the part of
10634 that switch matching the @code{*}.
10636 @item %@{.@code{S}:@code{X}@}
10637 Substitutes @code{X}, if processing a file with suffix @code{S}.
10639 @item %@{!.@code{S}:@code{X}@}
10640 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10642 @item %@{,@code{S}:@code{X}@}
10643 Substitutes @code{X}, if processing a file for language @code{S}.
10645 @item %@{!,@code{S}:@code{X}@}
10646 Substitutes @code{X}, if not processing a file for language @code{S}.
10648 @item %@{@code{S}|@code{P}:@code{X}@}
10649 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10650 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10651 @code{*} sequences as well, although they have a stronger binding than
10652 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10653 alternatives must be starred, and only the first matching alternative
10654 is substituted.
10656 For example, a spec string like this:
10658 @smallexample
10659 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10660 @end smallexample
10662 @noindent
10663 outputs the following command-line options from the following input
10664 command-line options:
10666 @smallexample
10667 fred.c        -foo -baz
10668 jim.d         -bar -boggle
10669 -d fred.c     -foo -baz -boggle
10670 -d jim.d      -bar -baz -boggle
10671 @end smallexample
10673 @item %@{S:X; T:Y; :D@}
10675 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10676 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10677 be as many clauses as you need.  This may be combined with @code{.},
10678 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10681 @end table
10683 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10684 construct may contain other nested @samp{%} constructs or spaces, or
10685 even newlines.  They are processed as usual, as described above.
10686 Trailing white space in @code{X} is ignored.  White space may also
10687 appear anywhere on the left side of the colon in these constructs,
10688 except between @code{.} or @code{*} and the corresponding word.
10690 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10691 handled specifically in these constructs.  If another value of
10692 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10693 @option{-W} switch is found later in the command line, the earlier
10694 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10695 just one letter, which passes all matching options.
10697 The character @samp{|} at the beginning of the predicate text is used to
10698 indicate that a command should be piped to the following command, but
10699 only if @option{-pipe} is specified.
10701 It is built into GCC which switches take arguments and which do not.
10702 (You might think it would be useful to generalize this to allow each
10703 compiler's spec to say which switches take arguments.  But this cannot
10704 be done in a consistent fashion.  GCC cannot even decide which input
10705 files have been specified without knowing which switches take arguments,
10706 and it must know which input files to compile in order to tell which
10707 compilers to run).
10709 GCC also knows implicitly that arguments starting in @option{-l} are to be
10710 treated as compiler output files, and passed to the linker in their
10711 proper position among the other output files.
10713 @c man begin OPTIONS
10715 @node Target Options
10716 @section Specifying Target Machine and Compiler Version
10717 @cindex target options
10718 @cindex cross compiling
10719 @cindex specifying machine version
10720 @cindex specifying compiler version and target machine
10721 @cindex compiler version, specifying
10722 @cindex target machine, specifying
10724 The usual way to run GCC is to run the executable called @command{gcc}, or
10725 @command{@var{machine}-gcc} when cross-compiling, or
10726 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10727 one that was installed last.
10729 @node Submodel Options
10730 @section Hardware Models and Configurations
10731 @cindex submodel options
10732 @cindex specifying hardware config
10733 @cindex hardware models and configurations, specifying
10734 @cindex machine dependent options
10736 Each target machine types can have its own
10737 special options, starting with @samp{-m}, to choose among various
10738 hardware models or configurations---for example, 68010 vs 68020,
10739 floating coprocessor or none.  A single installed version of the
10740 compiler can compile for any model or configuration, according to the
10741 options specified.
10743 Some configurations of the compiler also support additional special
10744 options, usually for compatibility with other compilers on the same
10745 platform.
10747 @c This list is ordered alphanumerically by subsection name.
10748 @c It should be the same order and spelling as these options are listed
10749 @c in Machine Dependent Options
10751 @menu
10752 * AArch64 Options::
10753 * Adapteva Epiphany Options::
10754 * ARM Options::
10755 * AVR Options::
10756 * Blackfin Options::
10757 * C6X Options::
10758 * CRIS Options::
10759 * CR16 Options::
10760 * Darwin Options::
10761 * DEC Alpha Options::
10762 * FR30 Options::
10763 * FRV Options::
10764 * GNU/Linux Options::
10765 * H8/300 Options::
10766 * HPPA Options::
10767 * i386 and x86-64 Options::
10768 * i386 and x86-64 Windows Options::
10769 * IA-64 Options::
10770 * LM32 Options::
10771 * M32C Options::
10772 * M32R/D Options::
10773 * M680x0 Options::
10774 * MCore Options::
10775 * MeP Options::
10776 * MicroBlaze Options::
10777 * MIPS Options::
10778 * MMIX Options::
10779 * MN10300 Options::
10780 * Moxie Options::
10781 * PDP-11 Options::
10782 * picoChip Options::
10783 * PowerPC Options::
10784 * RL78 Options::
10785 * RS/6000 and PowerPC Options::
10786 * RX Options::
10787 * S/390 and zSeries Options::
10788 * Score Options::
10789 * SH Options::
10790 * Solaris 2 Options::
10791 * SPARC Options::
10792 * SPU Options::
10793 * System V Options::
10794 * TILE-Gx Options::
10795 * TILEPro Options::
10796 * V850 Options::
10797 * VAX Options::
10798 * VMS Options::
10799 * VxWorks Options::
10800 * x86-64 Options::
10801 * Xstormy16 Options::
10802 * Xtensa Options::
10803 * zSeries Options::
10804 @end menu
10806 @node Adapteva Epiphany Options
10807 @subsection Adapteva Epiphany Options
10809 These @samp{-m} options are defined for Adapteva Epiphany:
10811 @table @gcctabopt
10812 @item -mhalf-reg-file
10813 @opindex mhalf-reg-file
10814 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
10815 That allows code to run on hardware variants that lack these registers.
10817 @item -mprefer-short-insn-regs
10818 @opindex mprefer-short-insn-regs
10819 Preferrentially allocate registers that allow short instruction generation.
10820 This can result in increased instruction count, so this may either reduce or
10821 increase overall code size.
10823 @item -mbranch-cost=@var{num}
10824 @opindex mbranch-cost
10825 Set the cost of branches to roughly @var{num} ``simple'' instructions.
10826 This cost is only a heuristic and is not guaranteed to produce
10827 consistent results across releases.
10829 @item -mcmove
10830 @opindex mcmove
10831 Enable the generation of conditional moves.
10833 @item -mnops=@var{num}
10834 @opindex mnops
10835 Emit @var{num} NOPs before every other generated instruction.
10837 @item -mno-soft-cmpsf
10838 @opindex mno-soft-cmpsf
10839 For single-precision floating-point comparisons, emit an @code{fsub} instruction
10840 and test the flags.  This is faster than a software comparison, but can
10841 get incorrect results in the presence of NaNs, or when two different small
10842 numbers are compared such that their difference is calculated as zero.
10843 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
10844 software comparisons.
10846 @item -mstack-offset=@var{num}
10847 @opindex mstack-offset
10848 Set the offset between the top of the stack and the stack pointer.
10849 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
10850 can be used by leaf functions without stack allocation.
10851 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
10852 Note also that this option changes the ABI; compiling a program with a
10853 different stack offset than the libraries have been compiled with
10854 generally does not work.
10855 This option can be useful if you want to evaluate if a different stack
10856 offset would give you better code, but to actually use a different stack
10857 offset to build working programs, it is recommended to configure the
10858 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
10860 @item -mno-round-nearest
10861 @opindex mno-round-nearest
10862 Make the scheduler assume that the rounding mode has been set to
10863 truncating.  The default is @option{-mround-nearest}.
10865 @item -mlong-calls
10866 @opindex mlong-calls
10867 If not otherwise specified by an attribute, assume all calls might be beyond
10868 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
10869 function address into a register before performing a (otherwise direct) call.
10870 This is the default.
10872 @item -mshort-calls
10873 @opindex short-calls
10874 If not otherwise specified by an attribute, assume all direct calls are
10875 in the range of the @code{b} / @code{bl} instructions, so use these instructions
10876 for direct calls.  The default is @option{-mlong-calls}.
10878 @item -msmall16
10879 @opindex msmall16
10880 Assume addresses can be loaded as 16-bit unsigned values.  This does not
10881 apply to function addresses for which @option{-mlong-calls} semantics
10882 are in effect.
10884 @item -mfp-mode=@var{mode}
10885 @opindex mfp-mode
10886 Set the prevailing mode of the floating-point unit.
10887 This determines the floating-point mode that is provided and expected
10888 at function call and return time.  Making this mode match the mode you
10889 predominantly need at function start can make your programs smaller and
10890 faster by avoiding unnecessary mode switches.
10892 @var{mode} can be set to one the following values:
10894 @table @samp
10895 @item caller
10896 Any mode at function entry is valid, and retained or restored when
10897 the function returns, and when it calls other functions.
10898 This mode is useful for compiling libraries or other compilation units
10899 you might want to incorporate into different programs with different
10900 prevailing FPU modes, and the convenience of being able to use a single
10901 object file outweighs the size and speed overhead for any extra
10902 mode switching that might be needed, compared with what would be needed
10903 with a more specific choice of prevailing FPU mode.
10905 @item truncate
10906 This is the mode used for floating-point calculations with
10907 truncating (i.e.@: round towards zero) rounding mode.  That includes
10908 conversion from floating point to integer.
10910 @item round-nearest
10911 This is the mode used for floating-point calculations with
10912 round-to-nearest-or-even rounding mode.
10914 @item int
10915 This is the mode used to perform integer calculations in the FPU, e.g.@:
10916 integer multiply, or integer multiply-and-accumulate.
10917 @end table
10919 The default is @option{-mfp-mode=caller}
10921 @item -mnosplit-lohi
10922 @itemx -mno-postinc
10923 @itemx -mno-postmodify
10924 @opindex mnosplit-lohi
10925 @opindex mno-postinc
10926 @opindex mno-postmodify
10927 Code generation tweaks that disable, respectively, splitting of 32-bit
10928 loads, generation of post-increment addresses, and generation of
10929 post-modify addresses.  The defaults are @option{msplit-lohi},
10930 @option{-mpost-inc}, and @option{-mpost-modify}.
10932 @item -mnovect-double
10933 @opindex mno-vect-double
10934 Change the preferred SIMD mode to SImode.  The default is
10935 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
10937 @item -max-vect-align=@var{num}
10938 @opindex max-vect-align
10939 The maximum alignment for SIMD vector mode types.
10940 @var{num} may be 4 or 8.  The default is 8.
10941 Note that this is an ABI change, even though many library function
10942 interfaces are unaffected if they don't use SIMD vector modes
10943 in places that affect size and/or alignment of relevant types.
10945 @item -msplit-vecmove-early
10946 @opindex msplit-vecmove-early
10947 Split vector moves into single word moves before reload.  In theory this
10948 can give better register allocation, but so far the reverse seems to be
10949 generally the case.
10951 @item -m1reg-@var{reg}
10952 @opindex m1reg-
10953 Specify a register to hold the constant @minus{}1, which makes loading small negative
10954 constants and certain bitmasks faster.
10955 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
10956 which specify use of that register as a fixed register,
10957 and @samp{none}, which means that no register is used for this
10958 purpose.  The default is @option{-m1reg-none}.
10960 @end table
10962 @node AArch64 Options
10963 @subsection AArch64 Options
10964 @cindex AArch64 Options
10966 These options are defined for AArch64 implementations:
10968 @table @gcctabopt
10970 @item -mbig-endian
10971 @opindex mbig-endian
10972 Generate big-endian code.  This is the default when GCC is configured for an
10973 @samp{aarch64_be-*-*} target.
10975 @item -mgeneral-regs-only
10976 @opindex mgeneral-regs-only
10977 Generate code which uses only the general registers.
10979 @item -mlittle-endian
10980 @opindex mlittle-endian
10981 Generate little-endian code.  This is the default when GCC is configured for an
10982 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
10984 @item -mcmodel=tiny
10985 @opindex mcmodel=tiny
10986 Generate code for the tiny code model.  The program and its statically defined
10987 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
10988 be statically or dynamically linked.  This model is not fully implemented and
10989 mostly treated as @samp{small}.
10991 @item -mcmodel=small
10992 @opindex mcmodel=small
10993 Generate code for the small code model.  The program and its statically defined
10994 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
10995 be statically or dynamically linked.  This is the default code model.
10997 @item -mcmodel=large
10998 @opindex mcmodel=large
10999 Generate code for the large code model.  This makes no assumptions about
11000 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11001 statically linked only.
11003 @item -mstrict-align
11004 @opindex mstrict-align
11005 Do not assume that unaligned memory references will be handled by the system.
11007 @item -momit-leaf-frame-pointer
11008 @itemx -mno-omit-leaf-frame-pointer
11009 @opindex momit-leaf-frame-pointer
11010 @opindex mno-omit-leaf-frame-pointer
11011 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11012 default.
11014 @item -mtls-dialect=desc
11015 @opindex mtls-dialect=desc
11016 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11017 of TLS variables.  This is the default.
11019 @item -mtls-dialect=traditional
11020 @opindex mtls-dialect=traditional
11021 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11022 of TLS variables.
11024 @item -march=@var{name}
11025 @opindex march
11026 Specify the name of the target architecture, optionally suffixed by one or
11027 more feature modifiers.  This option has the form
11028 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11029 only value for @var{arch} is @samp{armv8-a}.  The possible values for
11030 @var{feature} are documented in the sub-section below.
11032 Where conflicting feature modifiers are specified, the right-most feature is
11033 used.
11035 GCC uses this name to determine what kind of instructions it can emit when
11036 generating assembly code.  This option can be used in conjunction with or
11037 instead of the @option{-mcpu=} option.
11039 @item -mcpu=@var{name}
11040 @opindex mcpu
11041 Specify the name of the target processor, optionally suffixed by one or more
11042 feature modifiers.  This option has the form
11043 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11044 possible values for @var{cpu} are @samp{generic}, @samp{large}.  The
11045 possible values for @var{feature} are documented in the sub-section
11046 below.
11048 Where conflicting feature modifiers are specified, the right-most feature is
11049 used.
11051 GCC uses this name to determine what kind of instructions it can emit when
11052 generating assembly code.
11054 @item -mtune=@var{name}
11055 @opindex mtune
11056 Specify the name of the processor to tune the performance for.  The code will
11057 be tuned as if the target processor were of the type specified in this option,
11058 but still using instructions compatible with the target processor specified
11059 by a @option{-mcpu=} option.  This option cannot be suffixed by feature
11060 modifiers.
11062 @end table
11064 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
11065 @cindex @option{-march} feature modifiers
11066 @cindex @option{-mcpu} feature modifiers
11067 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
11068 the following:
11070 @table @samp
11071 @item crypto
11072 Enable Crypto extension.  This implies Advanced SIMD is enabled.
11073 @item fp
11074 Enable floating-point instructions.
11075 @item simd
11076 Enable Advanced SIMD instructions.  This implies floating-point instructions
11077 are enabled.  This is the default for all current possible values for options
11078 @option{-march} and @option{-mcpu=}.
11079 @end table
11081 @node ARM Options
11082 @subsection ARM Options
11083 @cindex ARM options
11085 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
11086 architectures:
11088 @table @gcctabopt
11089 @item -mabi=@var{name}
11090 @opindex mabi
11091 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
11092 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
11094 @item -mapcs-frame
11095 @opindex mapcs-frame
11096 Generate a stack frame that is compliant with the ARM Procedure Call
11097 Standard for all functions, even if this is not strictly necessary for
11098 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
11099 with this option causes the stack frames not to be generated for
11100 leaf functions.  The default is @option{-mno-apcs-frame}.
11102 @item -mapcs
11103 @opindex mapcs
11104 This is a synonym for @option{-mapcs-frame}.
11106 @ignore
11107 @c not currently implemented
11108 @item -mapcs-stack-check
11109 @opindex mapcs-stack-check
11110 Generate code to check the amount of stack space available upon entry to
11111 every function (that actually uses some stack space).  If there is
11112 insufficient space available then either the function
11113 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
11114 called, depending upon the amount of stack space required.  The runtime
11115 system is required to provide these functions.  The default is
11116 @option{-mno-apcs-stack-check}, since this produces smaller code.
11118 @c not currently implemented
11119 @item -mapcs-float
11120 @opindex mapcs-float
11121 Pass floating-point arguments using the floating-point registers.  This is
11122 one of the variants of the APCS@.  This option is recommended if the
11123 target hardware has a floating-point unit or if a lot of floating-point
11124 arithmetic is going to be performed by the code.  The default is
11125 @option{-mno-apcs-float}, since the size of integer-only code is 
11126 slightly increased if @option{-mapcs-float} is used.
11128 @c not currently implemented
11129 @item -mapcs-reentrant
11130 @opindex mapcs-reentrant
11131 Generate reentrant, position-independent code.  The default is
11132 @option{-mno-apcs-reentrant}.
11133 @end ignore
11135 @item -mthumb-interwork
11136 @opindex mthumb-interwork
11137 Generate code that supports calling between the ARM and Thumb
11138 instruction sets.  Without this option, on pre-v5 architectures, the
11139 two instruction sets cannot be reliably used inside one program.  The
11140 default is @option{-mno-thumb-interwork}, since slightly larger code
11141 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
11142 configurations this option is meaningless.
11144 @item -mno-sched-prolog
11145 @opindex mno-sched-prolog
11146 Prevent the reordering of instructions in the function prologue, or the
11147 merging of those instruction with the instructions in the function's
11148 body.  This means that all functions start with a recognizable set
11149 of instructions (or in fact one of a choice from a small set of
11150 different function prologues), and this information can be used to
11151 locate the start of functions inside an executable piece of code.  The
11152 default is @option{-msched-prolog}.
11154 @item -mfloat-abi=@var{name}
11155 @opindex mfloat-abi
11156 Specifies which floating-point ABI to use.  Permissible values
11157 are: @samp{soft}, @samp{softfp} and @samp{hard}.
11159 Specifying @samp{soft} causes GCC to generate output containing
11160 library calls for floating-point operations.
11161 @samp{softfp} allows the generation of code using hardware floating-point
11162 instructions, but still uses the soft-float calling conventions.
11163 @samp{hard} allows generation of floating-point instructions
11164 and uses FPU-specific calling conventions.
11166 The default depends on the specific target configuration.  Note that
11167 the hard-float and soft-float ABIs are not link-compatible; you must
11168 compile your entire program with the same ABI, and link with a
11169 compatible set of libraries.
11171 @item -mlittle-endian
11172 @opindex mlittle-endian
11173 Generate code for a processor running in little-endian mode.  This is
11174 the default for all standard configurations.
11176 @item -mbig-endian
11177 @opindex mbig-endian
11178 Generate code for a processor running in big-endian mode; the default is
11179 to compile code for a little-endian processor.
11181 @item -mwords-little-endian
11182 @opindex mwords-little-endian
11183 This option only applies when generating code for big-endian processors.
11184 Generate code for a little-endian word order but a big-endian byte
11185 order.  That is, a byte order of the form @samp{32107654}.  Note: this
11186 option should only be used if you require compatibility with code for
11187 big-endian ARM processors generated by versions of the compiler prior to
11188 2.8.  This option is now deprecated.
11190 @item -mcpu=@var{name}
11191 @opindex mcpu
11192 This specifies the name of the target ARM processor.  GCC uses this name
11193 to determine what kind of instructions it can emit when generating
11194 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
11195 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
11196 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
11197 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
11198 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
11199 @samp{arm720},
11200 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
11201 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
11202 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
11203 @samp{strongarm1110},
11204 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
11205 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
11206 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
11207 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
11208 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
11209 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
11210 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
11211 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
11212 @samp{cortex-a15}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
11213 @samp{cortex-m4}, @samp{cortex-m3},
11214 @samp{cortex-m1},
11215 @samp{cortex-m0},
11216 @samp{cortex-m0plus},
11217 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
11218 @samp{fa526}, @samp{fa626},
11219 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
11222 @option{-mcpu=generic-@var{arch}} is also permissible, and is
11223 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
11224 See @option{-mtune} for more information.
11226 @option{-mcpu=native} causes the compiler to auto-detect the CPU
11227 of the build computer.  At present, this feature is only supported on
11228 Linux, and not all architectures are recognized.  If the auto-detect is
11229 unsuccessful the option has no effect.
11231 @item -mtune=@var{name}
11232 @opindex mtune
11233 This option is very similar to the @option{-mcpu=} option, except that
11234 instead of specifying the actual target processor type, and hence
11235 restricting which instructions can be used, it specifies that GCC should
11236 tune the performance of the code as if the target were of the type
11237 specified in this option, but still choosing the instructions it
11238 generates based on the CPU specified by a @option{-mcpu=} option.
11239 For some ARM implementations better performance can be obtained by using
11240 this option.
11242 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
11243 performance for a blend of processors within architecture @var{arch}.
11244 The aim is to generate code that run well on the current most popular
11245 processors, balancing between optimizations that benefit some CPUs in the
11246 range, and avoiding performance pitfalls of other CPUs.  The effects of
11247 this option may change in future GCC versions as CPU models come and go.
11249 @option{-mtune=native} causes the compiler to auto-detect the CPU
11250 of the build computer.  At present, this feature is only supported on
11251 Linux, and not all architectures are recognized.  If the auto-detect is
11252 unsuccessful the option has no effect.
11254 @item -march=@var{name}
11255 @opindex march
11256 This specifies the name of the target ARM architecture.  GCC uses this
11257 name to determine what kind of instructions it can emit when generating
11258 assembly code.  This option can be used in conjunction with or instead
11259 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
11260 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
11261 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
11262 @samp{armv6}, @samp{armv6j},
11263 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
11264 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
11265 @samp{armv8-a},
11266 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
11268 @option{-march=native} causes the compiler to auto-detect the architecture
11269 of the build computer.  At present, this feature is only supported on
11270 Linux, and not all architectures are recognized.  If the auto-detect is
11271 unsuccessful the option has no effect.
11273 @item -mfpu=@var{name}
11274 @opindex mfpu
11275 This specifies what floating-point hardware (or hardware emulation) is
11276 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
11277 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
11278 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
11279 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
11280 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
11282 If @option{-msoft-float} is specified this specifies the format of
11283 floating-point values.
11285 If the selected floating-point hardware includes the NEON extension
11286 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
11287 operations are not generated by GCC's auto-vectorization pass unless
11288 @option{-funsafe-math-optimizations} is also specified.  This is
11289 because NEON hardware does not fully implement the IEEE 754 standard for
11290 floating-point arithmetic (in particular denormal values are treated as
11291 zero), so the use of NEON instructions may lead to a loss of precision.
11293 @item -mfp16-format=@var{name}
11294 @opindex mfp16-format
11295 Specify the format of the @code{__fp16} half-precision floating-point type.
11296 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
11297 the default is @samp{none}, in which case the @code{__fp16} type is not
11298 defined.  @xref{Half-Precision}, for more information.
11300 @item -mstructure-size-boundary=@var{n}
11301 @opindex mstructure-size-boundary
11302 The sizes of all structures and unions are rounded up to a multiple
11303 of the number of bits set by this option.  Permissible values are 8, 32
11304 and 64.  The default value varies for different toolchains.  For the COFF
11305 targeted toolchain the default value is 8.  A value of 64 is only allowed
11306 if the underlying ABI supports it.
11308 Specifying a larger number can produce faster, more efficient code, but
11309 can also increase the size of the program.  Different values are potentially
11310 incompatible.  Code compiled with one value cannot necessarily expect to
11311 work with code or libraries compiled with another value, if they exchange
11312 information using structures or unions.
11314 @item -mabort-on-noreturn
11315 @opindex mabort-on-noreturn
11316 Generate a call to the function @code{abort} at the end of a
11317 @code{noreturn} function.  It is executed if the function tries to
11318 return.
11320 @item -mlong-calls
11321 @itemx -mno-long-calls
11322 @opindex mlong-calls
11323 @opindex mno-long-calls
11324 Tells the compiler to perform function calls by first loading the
11325 address of the function into a register and then performing a subroutine
11326 call on this register.  This switch is needed if the target function
11327 lies outside of the 64-megabyte addressing range of the offset-based
11328 version of subroutine call instruction.
11330 Even if this switch is enabled, not all function calls are turned
11331 into long calls.  The heuristic is that static functions, functions
11332 that have the @samp{short-call} attribute, functions that are inside
11333 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
11334 definitions have already been compiled within the current compilation
11335 unit are not turned into long calls.  The exceptions to this rule are
11336 that weak function definitions, functions with the @samp{long-call}
11337 attribute or the @samp{section} attribute, and functions that are within
11338 the scope of a @samp{#pragma long_calls} directive are always
11339 turned into long calls.
11341 This feature is not enabled by default.  Specifying
11342 @option{-mno-long-calls} restores the default behavior, as does
11343 placing the function calls within the scope of a @samp{#pragma
11344 long_calls_off} directive.  Note these switches have no effect on how
11345 the compiler generates code to handle function calls via function
11346 pointers.
11348 @item -msingle-pic-base
11349 @opindex msingle-pic-base
11350 Treat the register used for PIC addressing as read-only, rather than
11351 loading it in the prologue for each function.  The runtime system is
11352 responsible for initializing this register with an appropriate value
11353 before execution begins.
11355 @item -mpic-register=@var{reg}
11356 @opindex mpic-register
11357 Specify the register to be used for PIC addressing.  The default is R10
11358 unless stack-checking is enabled, when R9 is used.
11360 @item -mcirrus-fix-invalid-insns
11361 @opindex mcirrus-fix-invalid-insns
11362 @opindex mno-cirrus-fix-invalid-insns
11363 Insert NOPs into the instruction stream to in order to work around
11364 problems with invalid Maverick instruction combinations.  This option
11365 is only valid if the @option{-mcpu=ep9312} option has been used to
11366 enable generation of instructions for the Cirrus Maverick floating-point
11367 co-processor.  This option is not enabled by default, since the
11368 problem is only present in older Maverick implementations.  The default
11369 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
11370 switch.
11372 @item -mpoke-function-name
11373 @opindex mpoke-function-name
11374 Write the name of each function into the text section, directly
11375 preceding the function prologue.  The generated code is similar to this:
11377 @smallexample
11378      t0
11379          .ascii "arm_poke_function_name", 0
11380          .align
11381      t1
11382          .word 0xff000000 + (t1 - t0)
11383      arm_poke_function_name
11384          mov     ip, sp
11385          stmfd   sp!, @{fp, ip, lr, pc@}
11386          sub     fp, ip, #4
11387 @end smallexample
11389 When performing a stack backtrace, code can inspect the value of
11390 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
11391 location @code{pc - 12} and the top 8 bits are set, then we know that
11392 there is a function name embedded immediately preceding this location
11393 and has length @code{((pc[-3]) & 0xff000000)}.
11395 @item -mthumb
11396 @itemx -marm
11397 @opindex marm
11398 @opindex mthumb
11400 Select between generating code that executes in ARM and Thumb
11401 states.  The default for most configurations is to generate code
11402 that executes in ARM state, but the default can be changed by
11403 configuring GCC with the @option{--with-mode=}@var{state}
11404 configure option.
11406 @item -mtpcs-frame
11407 @opindex mtpcs-frame
11408 Generate a stack frame that is compliant with the Thumb Procedure Call
11409 Standard for all non-leaf functions.  (A leaf function is one that does
11410 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
11412 @item -mtpcs-leaf-frame
11413 @opindex mtpcs-leaf-frame
11414 Generate a stack frame that is compliant with the Thumb Procedure Call
11415 Standard for all leaf functions.  (A leaf function is one that does
11416 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
11418 @item -mcallee-super-interworking
11419 @opindex mcallee-super-interworking
11420 Gives all externally visible functions in the file being compiled an ARM
11421 instruction set header which switches to Thumb mode before executing the
11422 rest of the function.  This allows these functions to be called from
11423 non-interworking code.  This option is not valid in AAPCS configurations
11424 because interworking is enabled by default.
11426 @item -mcaller-super-interworking
11427 @opindex mcaller-super-interworking
11428 Allows calls via function pointers (including virtual functions) to
11429 execute correctly regardless of whether the target code has been
11430 compiled for interworking or not.  There is a small overhead in the cost
11431 of executing a function pointer if this option is enabled.  This option
11432 is not valid in AAPCS configurations because interworking is enabled
11433 by default.
11435 @item -mtp=@var{name}
11436 @opindex mtp
11437 Specify the access model for the thread local storage pointer.  The valid
11438 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
11439 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
11440 (supported in the arm6k architecture), and @option{auto}, which uses the
11441 best available method for the selected processor.  The default setting is
11442 @option{auto}.
11444 @item -mtls-dialect=@var{dialect}
11445 @opindex mtls-dialect
11446 Specify the dialect to use for accessing thread local storage.  Two
11447 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
11448 @samp{gnu} dialect selects the original GNU scheme for supporting
11449 local and global dynamic TLS models.  The @samp{gnu2} dialect
11450 selects the GNU descriptor scheme, which provides better performance
11451 for shared libraries.  The GNU descriptor scheme is compatible with
11452 the original scheme, but does require new assembler, linker and
11453 library support.  Initial and local exec TLS models are unaffected by
11454 this option and always use the original scheme.
11456 @item -mword-relocations
11457 @opindex mword-relocations
11458 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
11459 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
11460 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
11461 is specified.
11463 @item -mfix-cortex-m3-ldrd
11464 @opindex mfix-cortex-m3-ldrd
11465 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
11466 with overlapping destination and base registers are used.  This option avoids
11467 generating these instructions.  This option is enabled by default when
11468 @option{-mcpu=cortex-m3} is specified.
11470 @item -munaligned-access
11471 @itemx -mno-unaligned-access
11472 @opindex munaligned-access
11473 @opindex mno-unaligned-access
11474 Enables (or disables) reading and writing of 16- and 32- bit values
11475 from addresses that are not 16- or 32- bit aligned.  By default
11476 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
11477 architectures, and enabled for all other architectures.  If unaligned
11478 access is not enabled then words in packed data structures will be
11479 accessed a byte at a time.
11481 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
11482 generated object file to either true or false, depending upon the
11483 setting of this option.  If unaligned access is enabled then the
11484 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
11485 defined.
11487 @end table
11489 @node AVR Options
11490 @subsection AVR Options
11491 @cindex AVR Options
11493 These options are defined for AVR implementations:
11495 @table @gcctabopt
11496 @item -mmcu=@var{mcu}
11497 @opindex mmcu
11498 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
11500 The default for this option is@tie{}@code{avr2}.
11502 GCC supports the following AVR devices and ISAs:
11504 @include avr-mmcu.texi
11506 @item -maccumulate-args
11507 @opindex maccumulate-args
11508 Accumulate outgoing function arguments and acquire/release the needed
11509 stack space for outgoing function arguments once in function
11510 prologue/epilogue.  Without this option, outgoing arguments are pushed
11511 before calling a function and popped afterwards.
11513 Popping the arguments after the function call can be expensive on
11514 AVR so that accumulating the stack space might lead to smaller
11515 executables because arguments need not to be removed from the
11516 stack after such a function call.
11518 This option can lead to reduced code size for functions that perform
11519 several calls to functions that get their arguments on the stack like
11520 calls to printf-like functions.
11522 @item -mbranch-cost=@var{cost}
11523 @opindex mbranch-cost
11524 Set the branch costs for conditional branch instructions to
11525 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
11526 integers. The default branch cost is 0.
11528 @item -mcall-prologues
11529 @opindex mcall-prologues
11530 Functions prologues/epilogues are expanded as calls to appropriate
11531 subroutines.  Code size is smaller.
11533 @item -mint8
11534 @opindex mint8
11535 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
11536 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
11537 and @code{long long} is 4 bytes.  Please note that this option does not
11538 conform to the C standards, but it results in smaller code
11539 size.
11541 @item -mno-interrupts
11542 @opindex mno-interrupts
11543 Generated code is not compatible with hardware interrupts.
11544 Code size is smaller.
11546 @item -mrelax
11547 @opindex mrelax
11548 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11549 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11550 Setting @code{-mrelax} just adds the @code{--relax} option to the
11551 linker command line when the linker is called.
11553 Jump relaxing is performed by the linker because jump offsets are not
11554 known before code is located. Therefore, the assembler code generated by the
11555 compiler is the same, but the instructions in the executable may
11556 differ from instructions in the assembler code.
11558 Relaxing must be turned on if linker stubs are needed, see the
11559 section on @code{EIND} and linker stubs below.
11561 @item -msp8
11562 @opindex msp8
11563 Treat the stack pointer register as an 8-bit register,
11564 i.e.@: assume the high byte of the stack pointer is zero.
11565 In general, you don't need to set this option by hand.
11567 This option is used internally by the compiler to select and
11568 build multilibs for architectures @code{avr2} and @code{avr25}.
11569 These architectures mix devices with and without @code{SPH}.
11570 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
11571 the compiler driver will add or remove this option from the compiler
11572 proper's command line, because the compiler then knows if the device
11573 or architecture has an 8-bit stack pointer and thus no @code{SPH}
11574 register or not.
11576 @item -mstrict-X
11577 @opindex mstrict-X
11578 Use address register @code{X} in a way proposed by the hardware.  This means
11579 that @code{X} is only used in indirect, post-increment or
11580 pre-decrement addressing.
11582 Without this option, the @code{X} register may be used in the same way
11583 as @code{Y} or @code{Z} which then is emulated by additional
11584 instructions.  
11585 For example, loading a value with @code{X+const} addressing with a
11586 small non-negative @code{const < 64} to a register @var{Rn} is
11587 performed as
11589 @example
11590 adiw r26, const   ; X += const
11591 ld   @var{Rn}, X        ; @var{Rn} = *X
11592 sbiw r26, const   ; X -= const
11593 @end example
11595 @item -mtiny-stack
11596 @opindex mtiny-stack
11597 Only change the lower 8@tie{}bits of the stack pointer.
11598 @end table
11600 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11601 @cindex @code{EIND}
11602 Pointers in the implementation are 16@tie{}bits wide.
11603 The address of a function or label is represented as word address so
11604 that indirect jumps and calls can target any code address in the
11605 range of 64@tie{}Ki words.
11607 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11608 bytes of program memory space, there is a special function register called
11609 @code{EIND} that serves as most significant part of the target address
11610 when @code{EICALL} or @code{EIJMP} instructions are used.
11612 Indirect jumps and calls on these devices are handled as follows by
11613 the compiler and are subject to some limitations:
11615 @itemize @bullet
11617 @item
11618 The compiler never sets @code{EIND}.
11620 @item
11621 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11622 instructions or might read @code{EIND} directly in order to emulate an
11623 indirect call/jump by means of a @code{RET} instruction.
11625 @item
11626 The compiler assumes that @code{EIND} never changes during the startup
11627 code or during the application. In particular, @code{EIND} is not
11628 saved/restored in function or interrupt service routine
11629 prologue/epilogue.
11631 @item
11632 For indirect calls to functions and computed goto, the linker
11633 generates @emph{stubs}. Stubs are jump pads sometimes also called
11634 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
11635 The stub contains a direct jump to the desired address.
11637 @item
11638 Linker relaxation must be turned on so that the linker will generate
11639 the stubs correctly an all situaltion. See the compiler option
11640 @code{-mrelax} and the linler option @code{--relax}.
11641 There are corner cases where the linker is supposed to generate stubs
11642 but aborts without relaxation and without a helpful error message.
11644 @item
11645 The default linker script is arranged for code with @code{EIND = 0}.
11646 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11647 linker script has to be used in order to place the sections whose
11648 name start with @code{.trampolines} into the segment where @code{EIND}
11649 points to.
11651 @item
11652 The startup code from libgcc never sets @code{EIND}.
11653 Notice that startup code is a blend of code from libgcc and AVR-LibC.
11654 For the impact of AVR-LibC on @code{EIND}, see the
11655 @w{@uref{http://nongnu.org/avr-libc/user-manual,AVR-LibC user manual}}.
11657 @item
11658 It is legitimate for user-specific startup code to set up @code{EIND}
11659 early, for example by means of initialization code located in
11660 section @code{.init3}. Such code runs prior to general startup code
11661 that initializes RAM and calls constructors, but after the bit
11662 of startup code from AVR-LibC that sets @code{EIND} to the segment
11663 where the vector table is located.
11664 @example
11665 #include <avr/io.h>
11667 static void
11668 __attribute__((section(".init3"),naked,used,no_instrument_function))
11669 init3_set_eind (void)
11671   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
11672                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
11674 @end example
11676 @noindent
11677 The @code{__trampolines_start} symbol is defined in the linker script.
11679 @item
11680 Stubs are generated automatically by the linker if
11681 the following two conditions are met:
11682 @itemize @minus
11684 @item The address of a label is taken by means of the @code{gs} modifier
11685 (short for @emph{generate stubs}) like so:
11686 @example
11687 LDI r24, lo8(gs(@var{func}))
11688 LDI r25, hi8(gs(@var{func}))
11689 @end example
11690 @item The final location of that label is in a code segment
11691 @emph{outside} the segment where the stubs are located.
11692 @end itemize
11694 @item
11695 The compiler emits such @code{gs} modifiers for code labels in the
11696 following situations:
11697 @itemize @minus
11698 @item Taking address of a function or code label.
11699 @item Computed goto.
11700 @item If prologue-save function is used, see @option{-mcall-prologues}
11701 command-line option.
11702 @item Switch/case dispatch tables. If you do not want such dispatch
11703 tables you can specify the @option{-fno-jump-tables} command-line option.
11704 @item C and C++ constructors/destructors called during startup/shutdown.
11705 @item If the tools hit a @code{gs()} modifier explained above.
11706 @end itemize
11708 @item
11709 Jumping to non-symbolic addresses like so is @emph{not} supported:
11711 @example
11712 int main (void)
11714     /* Call function at word address 0x2 */
11715     return ((int(*)(void)) 0x2)();
11717 @end example
11719 Instead, a stub has to be set up, i.e.@: the function has to be called
11720 through a symbol (@code{func_4} in the example):
11722 @example
11723 int main (void)
11725     extern int func_4 (void);
11727     /* Call function at byte address 0x4 */
11728     return func_4();
11730 @end example
11732 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11733 Alternatively, @code{func_4} can be defined in the linker script.
11734 @end itemize
11736 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11737 @cindex @code{RAMPD}
11738 @cindex @code{RAMPX}
11739 @cindex @code{RAMPY}
11740 @cindex @code{RAMPZ}
11741 Some AVR devices support memories larger than the 64@tie{}KiB range
11742 that can be accessed with 16-bit pointers.  To access memory locations
11743 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11744 register is used as high part of the address:
11745 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11746 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11747 register, respectively, to get a wide address. Similarly,
11748 @code{RAMPD} is used together with direct addressing.
11750 @itemize
11751 @item
11752 The startup code initializes the @code{RAMP} special function
11753 registers with zero.
11755 @item
11756 If a @ref{AVR Named Address Spaces,named address space} other than
11757 generic or @code{__flash} is used, then @code{RAMPZ} is set
11758 as needed before the operation.
11760 @item
11761 If the device supports RAM larger than 64@tie{KiB} and the compiler
11762 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11763 is reset to zero after the operation.
11765 @item
11766 If the device comes with a specific @code{RAMP} register, the ISR
11767 prologue/epilogue saves/restores that SFR and initializes it with
11768 zero in case the ISR code might (implicitly) use it.
11770 @item
11771 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
11772 If you use inline assembler to read from locations outside the
11773 16-bit address range and change one of the @code{RAMP} registers,
11774 you must reset it to zero after the access.
11776 @end itemize
11778 @subsubsection AVR Built-in Macros
11780 GCC defines several built-in macros so that the user code can test
11781 for the presence or absence of features.  Almost any of the following
11782 built-in macros are deduced from device capabilities and thus
11783 triggered by the @code{-mmcu=} command-line option.
11785 For even more AVR-specific built-in macros see
11786 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
11788 @table @code
11790 @item __AVR_ARCH__
11791 Build-in macro that resolves to a decimal number that identifies the
11792 architecture and depends on the @code{-mmcu=@var{mcu}} option.
11793 Possible values are:
11795 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
11796 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
11797 @code{105}, @code{106}, @code{107}
11799 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
11800 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
11801 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
11802 @code{avrxmega6}, @code{avrxmega7}, respectively.
11803 If @var{mcu} specifies a device, this built-in macro is set
11804 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
11805 defined to @code{4}.
11807 @item __AVR_@var{Device}__
11808 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
11809 the device's name. For example, @code{-mmcu=atmega8} defines the
11810 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
11811 @code{__AVR_ATtiny261A__}, etc.
11813 The built-in macros' names follow
11814 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
11815 the device name as from the AVR user manual. The difference between
11816 @var{Device} in the built-in macro and @var{device} in
11817 @code{-mmcu=@var{device}} is that the latter is always lowercase.
11819 If @var{device} is not a device but only a core architecture like
11820 @code{avr51}, this macro will not be defined.
11822 @item __AVR_HAVE_ELPM__
11823 The device has the the @code{ELPM} instruction.
11825 @item __AVR_HAVE_ELPMX__
11826 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
11827 R@var{n},Z+} instructions.
11829 @item __AVR_HAVE_MOVW__
11830 The device has the @code{MOVW} instruction to perform 16-bit
11831 register-register moves.
11833 @item __AVR_HAVE_LPMX__
11834 The device has the @code{LPM R@var{n},Z} and
11835 @code{LPM R@var{n},Z+} instructions.
11837 @item __AVR_HAVE_MUL__
11838 The device has a hardware multiplier. 
11840 @item __AVR_HAVE_JMP_CALL__
11841 The device has the @code{JMP} and @code{CALL} instructions.
11842 This is the case for devices with at least 16@tie{}KiB of program
11843 memory.
11845 @item __AVR_HAVE_EIJMP_EICALL__
11846 @itemx __AVR_3_BYTE_PC__
11847 The device has the @code{EIJMP} and @code{EICALL} instructions.
11848 This is the case for devices with more than 128@tie{}KiB of program memory.
11849 This also means that the program counter
11850 (PC) is 3@tie{}bytes wide.
11852 @item __AVR_2_BYTE_PC__
11853 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
11854 with up to 128@tie{}KiB of program memory.
11856 @item __AVR_HAVE_8BIT_SP__
11857 @itemx __AVR_HAVE_16BIT_SP__
11858 The stack pointer (SP) register is treated as 8-bit respectively
11859 16-bit register by the compiler.
11860 The definition of these macros is affected by @code{-mtiny-stack}.
11862 @item __AVR_HAVE_SPH__
11863 @itemx __AVR_SP8__
11864 The device has the SPH (high part of stack pointer) special function
11865 register or has an 8-bit stack pointer, respectively.
11866 The definition of these macros is affected by @code{-mmcu=} and
11867 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
11868 by @code{-msp8}.
11870 @item __AVR_HAVE_RAMPD__
11871 @itemx __AVR_HAVE_RAMPX__
11872 @itemx __AVR_HAVE_RAMPY__
11873 @itemx __AVR_HAVE_RAMPZ__
11874 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
11875 @code{RAMPZ} special function register, respectively.
11877 @item __NO_INTERRUPTS__
11878 This macro reflects the @code{-mno-interrupts} command line option.
11880 @item __AVR_ERRATA_SKIP__
11881 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
11882 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
11883 instructions because of a hardware erratum.  Skip instructions are
11884 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
11885 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
11886 set.
11888 @item __AVR_SFR_OFFSET__=@var{offset}
11889 Instructions that can address I/O special function registers directly
11890 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
11891 address as if addressed by an instruction to access RAM like @code{LD}
11892 or @code{STS}. This offset depends on the device architecture and has
11893 to be subtracted from the RAM address in order to get the
11894 respective I/O@tie{}address.
11896 @item __WITH_AVRLIBC__
11897 The compiler is configured to be used together with AVR-Libc.
11898 See the @code{--with-avrlibc} configure option.
11900 @end table
11902 @node Blackfin Options
11903 @subsection Blackfin Options
11904 @cindex Blackfin Options
11906 @table @gcctabopt
11907 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11908 @opindex mcpu=
11909 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
11910 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11911 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11912 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11913 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11914 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11915 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11916 @samp{bf561}, @samp{bf592}.
11918 The optional @var{sirevision} specifies the silicon revision of the target
11919 Blackfin processor.  Any workarounds available for the targeted silicon revision
11920 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
11921 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
11922 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
11923 hexadecimal digits representing the major and minor numbers in the silicon
11924 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
11925 is not defined.  If @var{sirevision} is @samp{any}, the
11926 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
11927 If this optional @var{sirevision} is not used, GCC assumes the latest known
11928 silicon revision of the targeted Blackfin processor.
11930 GCC defines a preprocessor macro for the specified @var{cpu}.
11931 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
11932 provided by libgloss to be linked in if @option{-msim} is not given.
11934 Without this option, @samp{bf532} is used as the processor by default.
11936 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
11937 only the preprocessor macro is defined.
11939 @item -msim
11940 @opindex msim
11941 Specifies that the program will be run on the simulator.  This causes
11942 the simulator BSP provided by libgloss to be linked in.  This option
11943 has effect only for @samp{bfin-elf} toolchain.
11944 Certain other options, such as @option{-mid-shared-library} and
11945 @option{-mfdpic}, imply @option{-msim}.
11947 @item -momit-leaf-frame-pointer
11948 @opindex momit-leaf-frame-pointer
11949 Don't keep the frame pointer in a register for leaf functions.  This
11950 avoids the instructions to save, set up and restore frame pointers and
11951 makes an extra register available in leaf functions.  The option
11952 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
11953 which might make debugging harder.
11955 @item -mspecld-anomaly
11956 @opindex mspecld-anomaly
11957 When enabled, the compiler ensures that the generated code does not
11958 contain speculative loads after jump instructions. If this option is used,
11959 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
11961 @item -mno-specld-anomaly
11962 @opindex mno-specld-anomaly
11963 Don't generate extra code to prevent speculative loads from occurring.
11965 @item -mcsync-anomaly
11966 @opindex mcsync-anomaly
11967 When enabled, the compiler ensures that the generated code does not
11968 contain CSYNC or SSYNC instructions too soon after conditional branches.
11969 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
11971 @item -mno-csync-anomaly
11972 @opindex mno-csync-anomaly
11973 Don't generate extra code to prevent CSYNC or SSYNC instructions from
11974 occurring too soon after a conditional branch.
11976 @item -mlow-64k
11977 @opindex mlow-64k
11978 When enabled, the compiler is free to take advantage of the knowledge that
11979 the entire program fits into the low 64k of memory.
11981 @item -mno-low-64k
11982 @opindex mno-low-64k
11983 Assume that the program is arbitrarily large.  This is the default.
11985 @item -mstack-check-l1
11986 @opindex mstack-check-l1
11987 Do stack checking using information placed into L1 scratchpad memory by the
11988 uClinux kernel.
11990 @item -mid-shared-library
11991 @opindex mid-shared-library
11992 Generate code that supports shared libraries via the library ID method.
11993 This allows for execute in place and shared libraries in an environment
11994 without virtual memory management.  This option implies @option{-fPIC}.
11995 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11997 @item -mno-id-shared-library
11998 @opindex mno-id-shared-library
11999 Generate code that doesn't assume ID-based shared libraries are being used.
12000 This is the default.
12002 @item -mleaf-id-shared-library
12003 @opindex mleaf-id-shared-library
12004 Generate code that supports shared libraries via the library ID method,
12005 but assumes that this library or executable won't link against any other
12006 ID shared libraries.  That allows the compiler to use faster code for jumps
12007 and calls.
12009 @item -mno-leaf-id-shared-library
12010 @opindex mno-leaf-id-shared-library
12011 Do not assume that the code being compiled won't link against any ID shared
12012 libraries.  Slower code is generated for jump and call insns.
12014 @item -mshared-library-id=n
12015 @opindex mshared-library-id
12016 Specifies the identification number of the ID-based shared library being
12017 compiled.  Specifying a value of 0 generates more compact code; specifying
12018 other values forces the allocation of that number to the current
12019 library but is no more space- or time-efficient than omitting this option.
12021 @item -msep-data
12022 @opindex msep-data
12023 Generate code that allows the data segment to be located in a different
12024 area of memory from the text segment.  This allows for execute in place in
12025 an environment without virtual memory management by eliminating relocations
12026 against the text section.
12028 @item -mno-sep-data
12029 @opindex mno-sep-data
12030 Generate code that assumes that the data segment follows the text segment.
12031 This is the default.
12033 @item -mlong-calls
12034 @itemx -mno-long-calls
12035 @opindex mlong-calls
12036 @opindex mno-long-calls
12037 Tells the compiler to perform function calls by first loading the
12038 address of the function into a register and then performing a subroutine
12039 call on this register.  This switch is needed if the target function
12040 lies outside of the 24-bit addressing range of the offset-based
12041 version of subroutine call instruction.
12043 This feature is not enabled by default.  Specifying
12044 @option{-mno-long-calls} restores the default behavior.  Note these
12045 switches have no effect on how the compiler generates code to handle
12046 function calls via function pointers.
12048 @item -mfast-fp
12049 @opindex mfast-fp
12050 Link with the fast floating-point library. This library relaxes some of
12051 the IEEE floating-point standard's rules for checking inputs against
12052 Not-a-Number (NAN), in the interest of performance.
12054 @item -minline-plt
12055 @opindex minline-plt
12056 Enable inlining of PLT entries in function calls to functions that are
12057 not known to bind locally.  It has no effect without @option{-mfdpic}.
12059 @item -mmulticore
12060 @opindex mmulticore
12061 Build a standalone application for multicore Blackfin processors. 
12062 This option causes proper start files and link scripts supporting 
12063 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
12064 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
12066 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
12067 selects the one-application-per-core programming model.  Without
12068 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
12069 programming model is used. In this model, the main function of Core B
12070 should be named as @code{coreb_main}.
12072 If this option is not used, the single-core application programming
12073 model is used.
12075 @item -mcorea
12076 @opindex mcorea
12077 Build a standalone application for Core A of BF561 when using
12078 the one-application-per-core programming model. Proper start files
12079 and link scripts are used to support Core A, and the macro
12080 @code{__BFIN_COREA} is defined.
12081 This option can only be used in conjunction with @option{-mmulticore}.
12083 @item -mcoreb
12084 @opindex mcoreb
12085 Build a standalone application for Core B of BF561 when using
12086 the one-application-per-core programming model. Proper start files
12087 and link scripts are used to support Core B, and the macro
12088 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
12089 should be used instead of @code{main}. 
12090 This option can only be used in conjunction with @option{-mmulticore}.
12092 @item -msdram
12093 @opindex msdram
12094 Build a standalone application for SDRAM. Proper start files and
12095 link scripts are used to put the application into SDRAM, and the macro
12096 @code{__BFIN_SDRAM} is defined.
12097 The loader should initialize SDRAM before loading the application.
12099 @item -micplb
12100 @opindex micplb
12101 Assume that ICPLBs are enabled at run time.  This has an effect on certain
12102 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
12103 are enabled; for standalone applications the default is off.
12104 @end table
12106 @node C6X Options
12107 @subsection C6X Options
12108 @cindex C6X Options
12110 @table @gcctabopt
12111 @item -march=@var{name}
12112 @opindex march
12113 This specifies the name of the target architecture.  GCC uses this
12114 name to determine what kind of instructions it can emit when generating
12115 assembly code.  Permissible names are: @samp{c62x},
12116 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
12118 @item -mbig-endian
12119 @opindex mbig-endian
12120 Generate code for a big-endian target.
12122 @item -mlittle-endian
12123 @opindex mlittle-endian
12124 Generate code for a little-endian target.  This is the default.
12126 @item -msim
12127 @opindex msim
12128 Choose startup files and linker script suitable for the simulator.
12130 @item -msdata=default
12131 @opindex msdata=default
12132 Put small global and static data in the @samp{.neardata} section,
12133 which is pointed to by register @code{B14}.  Put small uninitialized
12134 global and static data in the @samp{.bss} section, which is adjacent
12135 to the @samp{.neardata} section.  Put small read-only data into the
12136 @samp{.rodata} section.  The corresponding sections used for large
12137 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
12139 @item -msdata=all
12140 @opindex msdata=all
12141 Put all data, not just small objects, into the sections reserved for
12142 small data, and use addressing relative to the @code{B14} register to
12143 access them.
12145 @item -msdata=none
12146 @opindex msdata=none
12147 Make no use of the sections reserved for small data, and use absolute
12148 addresses to access all data.  Put all initialized global and static
12149 data in the @samp{.fardata} section, and all uninitialized data in the
12150 @samp{.far} section.  Put all constant data into the @samp{.const}
12151 section.
12152 @end table
12154 @node CRIS Options
12155 @subsection CRIS Options
12156 @cindex CRIS Options
12158 These options are defined specifically for the CRIS ports.
12160 @table @gcctabopt
12161 @item -march=@var{architecture-type}
12162 @itemx -mcpu=@var{architecture-type}
12163 @opindex march
12164 @opindex mcpu
12165 Generate code for the specified architecture.  The choices for
12166 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
12167 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
12168 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
12169 @samp{v10}.
12171 @item -mtune=@var{architecture-type}
12172 @opindex mtune
12173 Tune to @var{architecture-type} everything applicable about the generated
12174 code, except for the ABI and the set of available instructions.  The
12175 choices for @var{architecture-type} are the same as for
12176 @option{-march=@var{architecture-type}}.
12178 @item -mmax-stack-frame=@var{n}
12179 @opindex mmax-stack-frame
12180 Warn when the stack frame of a function exceeds @var{n} bytes.
12182 @item -metrax4
12183 @itemx -metrax100
12184 @opindex metrax4
12185 @opindex metrax100
12186 The options @option{-metrax4} and @option{-metrax100} are synonyms for
12187 @option{-march=v3} and @option{-march=v8} respectively.
12189 @item -mmul-bug-workaround
12190 @itemx -mno-mul-bug-workaround
12191 @opindex mmul-bug-workaround
12192 @opindex mno-mul-bug-workaround
12193 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
12194 models where it applies.  This option is active by default.
12196 @item -mpdebug
12197 @opindex mpdebug
12198 Enable CRIS-specific verbose debug-related information in the assembly
12199 code.  This option also has the effect of turning off the @samp{#NO_APP}
12200 formatted-code indicator to the assembler at the beginning of the
12201 assembly file.
12203 @item -mcc-init
12204 @opindex mcc-init
12205 Do not use condition-code results from previous instruction; always emit
12206 compare and test instructions before use of condition codes.
12208 @item -mno-side-effects
12209 @opindex mno-side-effects
12210 Do not emit instructions with side effects in addressing modes other than
12211 post-increment.
12213 @item -mstack-align
12214 @itemx -mno-stack-align
12215 @itemx -mdata-align
12216 @itemx -mno-data-align
12217 @itemx -mconst-align
12218 @itemx -mno-const-align
12219 @opindex mstack-align
12220 @opindex mno-stack-align
12221 @opindex mdata-align
12222 @opindex mno-data-align
12223 @opindex mconst-align
12224 @opindex mno-const-align
12225 These options (@samp{no-} options) arrange (eliminate arrangements) for the
12226 stack frame, individual data and constants to be aligned for the maximum
12227 single data access size for the chosen CPU model.  The default is to
12228 arrange for 32-bit alignment.  ABI details such as structure layout are
12229 not affected by these options.
12231 @item -m32-bit
12232 @itemx -m16-bit
12233 @itemx -m8-bit
12234 @opindex m32-bit
12235 @opindex m16-bit
12236 @opindex m8-bit
12237 Similar to the stack- data- and const-align options above, these options
12238 arrange for stack frame, writable data and constants to all be 32-bit,
12239 16-bit or 8-bit aligned.  The default is 32-bit alignment.
12241 @item -mno-prologue-epilogue
12242 @itemx -mprologue-epilogue
12243 @opindex mno-prologue-epilogue
12244 @opindex mprologue-epilogue
12245 With @option{-mno-prologue-epilogue}, the normal function prologue and
12246 epilogue which set up the stack frame are omitted and no return
12247 instructions or return sequences are generated in the code.  Use this
12248 option only together with visual inspection of the compiled code: no
12249 warnings or errors are generated when call-saved registers must be saved,
12250 or storage for local variables needs to be allocated.
12252 @item -mno-gotplt
12253 @itemx -mgotplt
12254 @opindex mno-gotplt
12255 @opindex mgotplt
12256 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
12257 instruction sequences that load addresses for functions from the PLT part
12258 of the GOT rather than (traditional on other architectures) calls to the
12259 PLT@.  The default is @option{-mgotplt}.
12261 @item -melf
12262 @opindex melf
12263 Legacy no-op option only recognized with the cris-axis-elf and
12264 cris-axis-linux-gnu targets.
12266 @item -mlinux
12267 @opindex mlinux
12268 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
12270 @item -sim
12271 @opindex sim
12272 This option, recognized for the cris-axis-elf, arranges
12273 to link with input-output functions from a simulator library.  Code,
12274 initialized data and zero-initialized data are allocated consecutively.
12276 @item -sim2
12277 @opindex sim2
12278 Like @option{-sim}, but pass linker options to locate initialized data at
12279 0x40000000 and zero-initialized data at 0x80000000.
12280 @end table
12282 @node CR16 Options
12283 @subsection CR16 Options
12284 @cindex CR16 Options
12286 These options are defined specifically for the CR16 ports.
12288 @table @gcctabopt
12290 @item -mmac
12291 @opindex mmac
12292 Enable the use of multiply-accumulate instructions. Disabled by default.
12294 @item -mcr16cplus
12295 @itemx -mcr16c
12296 @opindex mcr16cplus
12297 @opindex mcr16c
12298 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
12299 is default.
12301 @item -msim
12302 @opindex msim
12303 Links the library libsim.a which is in compatible with simulator. Applicable
12304 to ELF compiler only.
12306 @item -mint32
12307 @opindex mint32
12308 Choose integer type as 32-bit wide.
12310 @item -mbit-ops
12311 @opindex mbit-ops
12312 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
12314 @item -mdata-model=@var{model}
12315 @opindex mdata-model
12316 Choose a data model. The choices for @var{model} are @samp{near},
12317 @samp{far} or @samp{medium}. @samp{medium} is default.
12318 However, @samp{far} is not valid with @option{-mcr16c}, as the
12319 CR16C architecture does not support the far data model.
12320 @end table
12322 @node Darwin Options
12323 @subsection Darwin Options
12324 @cindex Darwin options
12326 These options are defined for all architectures running the Darwin operating
12327 system.
12329 FSF GCC on Darwin does not create ``fat'' object files; it creates
12330 an object file for the single architecture that GCC was built to
12331 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
12332 @option{-arch} options are used; it does so by running the compiler or
12333 linker multiple times and joining the results together with
12334 @file{lipo}.
12336 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
12337 @samp{i686}) is determined by the flags that specify the ISA
12338 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
12339 @option{-force_cpusubtype_ALL} option can be used to override this.
12341 The Darwin tools vary in their behavior when presented with an ISA
12342 mismatch.  The assembler, @file{as}, only permits instructions to
12343 be used that are valid for the subtype of the file it is generating,
12344 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
12345 The linker for shared libraries, @file{/usr/bin/libtool}, fails
12346 and prints an error if asked to create a shared library with a less
12347 restrictive subtype than its input files (for instance, trying to put
12348 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
12349 for executables, @command{ld}, quietly gives the executable the most
12350 restrictive subtype of any of its input files.
12352 @table @gcctabopt
12353 @item -F@var{dir}
12354 @opindex F
12355 Add the framework directory @var{dir} to the head of the list of
12356 directories to be searched for header files.  These directories are
12357 interleaved with those specified by @option{-I} options and are
12358 scanned in a left-to-right order.
12360 A framework directory is a directory with frameworks in it.  A
12361 framework is a directory with a @file{Headers} and/or
12362 @file{PrivateHeaders} directory contained directly in it that ends
12363 in @file{.framework}.  The name of a framework is the name of this
12364 directory excluding the @file{.framework}.  Headers associated with
12365 the framework are found in one of those two directories, with
12366 @file{Headers} being searched first.  A subframework is a framework
12367 directory that is in a framework's @file{Frameworks} directory.
12368 Includes of subframework headers can only appear in a header of a
12369 framework that contains the subframework, or in a sibling subframework
12370 header.  Two subframeworks are siblings if they occur in the same
12371 framework.  A subframework should not have the same name as a
12372 framework; a warning is issued if this is violated.  Currently a
12373 subframework cannot have subframeworks; in the future, the mechanism
12374 may be extended to support this.  The standard frameworks can be found
12375 in @file{/System/Library/Frameworks} and
12376 @file{/Library/Frameworks}.  An example include looks like
12377 @code{#include <Framework/header.h>}, where @file{Framework} denotes
12378 the name of the framework and @file{header.h} is found in the
12379 @file{PrivateHeaders} or @file{Headers} directory.
12381 @item -iframework@var{dir}
12382 @opindex iframework
12383 Like @option{-F} except the directory is a treated as a system
12384 directory.  The main difference between this @option{-iframework} and
12385 @option{-F} is that with @option{-iframework} the compiler does not
12386 warn about constructs contained within header files found via
12387 @var{dir}.  This option is valid only for the C family of languages.
12389 @item -gused
12390 @opindex gused
12391 Emit debugging information for symbols that are used.  For stabs
12392 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
12393 This is by default ON@.
12395 @item -gfull
12396 @opindex gfull
12397 Emit debugging information for all symbols and types.
12399 @item -mmacosx-version-min=@var{version}
12400 The earliest version of MacOS X that this executable will run on
12401 is @var{version}.  Typical values of @var{version} include @code{10.1},
12402 @code{10.2}, and @code{10.3.9}.
12404 If the compiler was built to use the system's headers by default,
12405 then the default for this option is the system version on which the
12406 compiler is running, otherwise the default is to make choices that
12407 are compatible with as many systems and code bases as possible.
12409 @item -mkernel
12410 @opindex mkernel
12411 Enable kernel development mode.  The @option{-mkernel} option sets
12412 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
12413 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
12414 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
12415 applicable.  This mode also sets @option{-mno-altivec},
12416 @option{-msoft-float}, @option{-fno-builtin} and
12417 @option{-mlong-branch} for PowerPC targets.
12419 @item -mone-byte-bool
12420 @opindex mone-byte-bool
12421 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
12422 By default @samp{sizeof(bool)} is @samp{4} when compiling for
12423 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
12424 option has no effect on x86.
12426 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
12427 to generate code that is not binary compatible with code generated
12428 without that switch.  Using this switch may require recompiling all
12429 other modules in a program, including system libraries.  Use this
12430 switch to conform to a non-default data model.
12432 @item -mfix-and-continue
12433 @itemx -ffix-and-continue
12434 @itemx -findirect-data
12435 @opindex mfix-and-continue
12436 @opindex ffix-and-continue
12437 @opindex findirect-data
12438 Generate code suitable for fast turnaround development, such as to
12439 allow GDB to dynamically load @code{.o} files into already-running
12440 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
12441 are provided for backwards compatibility.
12443 @item -all_load
12444 @opindex all_load
12445 Loads all members of static archive libraries.
12446 See man ld(1) for more information.
12448 @item -arch_errors_fatal
12449 @opindex arch_errors_fatal
12450 Cause the errors having to do with files that have the wrong architecture
12451 to be fatal.
12453 @item -bind_at_load
12454 @opindex bind_at_load
12455 Causes the output file to be marked such that the dynamic linker will
12456 bind all undefined references when the file is loaded or launched.
12458 @item -bundle
12459 @opindex bundle
12460 Produce a Mach-o bundle format file.
12461 See man ld(1) for more information.
12463 @item -bundle_loader @var{executable}
12464 @opindex bundle_loader
12465 This option specifies the @var{executable} that will load the build
12466 output file being linked.  See man ld(1) for more information.
12468 @item -dynamiclib
12469 @opindex dynamiclib
12470 When passed this option, GCC produces a dynamic library instead of
12471 an executable when linking, using the Darwin @file{libtool} command.
12473 @item -force_cpusubtype_ALL
12474 @opindex force_cpusubtype_ALL
12475 This causes GCC's output file to have the @var{ALL} subtype, instead of
12476 one controlled by the @option{-mcpu} or @option{-march} option.
12478 @item -allowable_client  @var{client_name}
12479 @itemx -client_name
12480 @itemx -compatibility_version
12481 @itemx -current_version
12482 @itemx -dead_strip
12483 @itemx -dependency-file
12484 @itemx -dylib_file
12485 @itemx -dylinker_install_name
12486 @itemx -dynamic
12487 @itemx -exported_symbols_list
12488 @itemx -filelist
12489 @need 800
12490 @itemx -flat_namespace
12491 @itemx -force_flat_namespace
12492 @itemx -headerpad_max_install_names
12493 @itemx -image_base
12494 @itemx -init
12495 @itemx -install_name
12496 @itemx -keep_private_externs
12497 @itemx -multi_module
12498 @itemx -multiply_defined
12499 @itemx -multiply_defined_unused
12500 @need 800
12501 @itemx -noall_load
12502 @itemx -no_dead_strip_inits_and_terms
12503 @itemx -nofixprebinding
12504 @itemx -nomultidefs
12505 @itemx -noprebind
12506 @itemx -noseglinkedit
12507 @itemx -pagezero_size
12508 @itemx -prebind
12509 @itemx -prebind_all_twolevel_modules
12510 @itemx -private_bundle
12511 @need 800
12512 @itemx -read_only_relocs
12513 @itemx -sectalign
12514 @itemx -sectobjectsymbols
12515 @itemx -whyload
12516 @itemx -seg1addr
12517 @itemx -sectcreate
12518 @itemx -sectobjectsymbols
12519 @itemx -sectorder
12520 @itemx -segaddr
12521 @itemx -segs_read_only_addr
12522 @need 800
12523 @itemx -segs_read_write_addr
12524 @itemx -seg_addr_table
12525 @itemx -seg_addr_table_filename
12526 @itemx -seglinkedit
12527 @itemx -segprot
12528 @itemx -segs_read_only_addr
12529 @itemx -segs_read_write_addr
12530 @itemx -single_module
12531 @itemx -static
12532 @itemx -sub_library
12533 @need 800
12534 @itemx -sub_umbrella
12535 @itemx -twolevel_namespace
12536 @itemx -umbrella
12537 @itemx -undefined
12538 @itemx -unexported_symbols_list
12539 @itemx -weak_reference_mismatches
12540 @itemx -whatsloaded
12541 @opindex allowable_client
12542 @opindex client_name
12543 @opindex compatibility_version
12544 @opindex current_version
12545 @opindex dead_strip
12546 @opindex dependency-file
12547 @opindex dylib_file
12548 @opindex dylinker_install_name
12549 @opindex dynamic
12550 @opindex exported_symbols_list
12551 @opindex filelist
12552 @opindex flat_namespace
12553 @opindex force_flat_namespace
12554 @opindex headerpad_max_install_names
12555 @opindex image_base
12556 @opindex init
12557 @opindex install_name
12558 @opindex keep_private_externs
12559 @opindex multi_module
12560 @opindex multiply_defined
12561 @opindex multiply_defined_unused
12562 @opindex noall_load
12563 @opindex no_dead_strip_inits_and_terms
12564 @opindex nofixprebinding
12565 @opindex nomultidefs
12566 @opindex noprebind
12567 @opindex noseglinkedit
12568 @opindex pagezero_size
12569 @opindex prebind
12570 @opindex prebind_all_twolevel_modules
12571 @opindex private_bundle
12572 @opindex read_only_relocs
12573 @opindex sectalign
12574 @opindex sectobjectsymbols
12575 @opindex whyload
12576 @opindex seg1addr
12577 @opindex sectcreate
12578 @opindex sectobjectsymbols
12579 @opindex sectorder
12580 @opindex segaddr
12581 @opindex segs_read_only_addr
12582 @opindex segs_read_write_addr
12583 @opindex seg_addr_table
12584 @opindex seg_addr_table_filename
12585 @opindex seglinkedit
12586 @opindex segprot
12587 @opindex segs_read_only_addr
12588 @opindex segs_read_write_addr
12589 @opindex single_module
12590 @opindex static
12591 @opindex sub_library
12592 @opindex sub_umbrella
12593 @opindex twolevel_namespace
12594 @opindex umbrella
12595 @opindex undefined
12596 @opindex unexported_symbols_list
12597 @opindex weak_reference_mismatches
12598 @opindex whatsloaded
12599 These options are passed to the Darwin linker.  The Darwin linker man page
12600 describes them in detail.
12601 @end table
12603 @node DEC Alpha Options
12604 @subsection DEC Alpha Options
12606 These @samp{-m} options are defined for the DEC Alpha implementations:
12608 @table @gcctabopt
12609 @item -mno-soft-float
12610 @itemx -msoft-float
12611 @opindex mno-soft-float
12612 @opindex msoft-float
12613 Use (do not use) the hardware floating-point instructions for
12614 floating-point operations.  When @option{-msoft-float} is specified,
12615 functions in @file{libgcc.a} are used to perform floating-point
12616 operations.  Unless they are replaced by routines that emulate the
12617 floating-point operations, or compiled in such a way as to call such
12618 emulations routines, these routines issue floating-point
12619 operations.   If you are compiling for an Alpha without floating-point
12620 operations, you must ensure that the library is built so as not to call
12621 them.
12623 Note that Alpha implementations without floating-point operations are
12624 required to have floating-point registers.
12626 @item -mfp-reg
12627 @itemx -mno-fp-regs
12628 @opindex mfp-reg
12629 @opindex mno-fp-regs
12630 Generate code that uses (does not use) the floating-point register set.
12631 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
12632 register set is not used, floating-point operands are passed in integer
12633 registers as if they were integers and floating-point results are passed
12634 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
12635 so any function with a floating-point argument or return value called by code
12636 compiled with @option{-mno-fp-regs} must also be compiled with that
12637 option.
12639 A typical use of this option is building a kernel that does not use,
12640 and hence need not save and restore, any floating-point registers.
12642 @item -mieee
12643 @opindex mieee
12644 The Alpha architecture implements floating-point hardware optimized for
12645 maximum performance.  It is mostly compliant with the IEEE floating-point
12646 standard.  However, for full compliance, software assistance is
12647 required.  This option generates code fully IEEE-compliant code
12648 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12649 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12650 defined during compilation.  The resulting code is less efficient but is
12651 able to correctly support denormalized numbers and exceptional IEEE
12652 values such as not-a-number and plus/minus infinity.  Other Alpha
12653 compilers call this option @option{-ieee_with_no_inexact}.
12655 @item -mieee-with-inexact
12656 @opindex mieee-with-inexact
12657 This is like @option{-mieee} except the generated code also maintains
12658 the IEEE @var{inexact-flag}.  Turning on this option causes the
12659 generated code to implement fully-compliant IEEE math.  In addition to
12660 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12661 macro.  On some Alpha implementations the resulting code may execute
12662 significantly slower than the code generated by default.  Since there is
12663 very little code that depends on the @var{inexact-flag}, you should
12664 normally not specify this option.  Other Alpha compilers call this
12665 option @option{-ieee_with_inexact}.
12667 @item -mfp-trap-mode=@var{trap-mode}
12668 @opindex mfp-trap-mode
12669 This option controls what floating-point related traps are enabled.
12670 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12671 The trap mode can be set to one of four values:
12673 @table @samp
12674 @item n
12675 This is the default (normal) setting.  The only traps that are enabled
12676 are the ones that cannot be disabled in software (e.g., division by zero
12677 trap).
12679 @item u
12680 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12681 as well.
12683 @item su
12684 Like @samp{u}, but the instructions are marked to be safe for software
12685 completion (see Alpha architecture manual for details).
12687 @item sui
12688 Like @samp{su}, but inexact traps are enabled as well.
12689 @end table
12691 @item -mfp-rounding-mode=@var{rounding-mode}
12692 @opindex mfp-rounding-mode
12693 Selects the IEEE rounding mode.  Other Alpha compilers call this option
12694 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
12697 @table @samp
12698 @item n
12699 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
12700 the nearest machine number or towards the even machine number in case
12701 of a tie.
12703 @item m
12704 Round towards minus infinity.
12706 @item c
12707 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
12709 @item d
12710 Dynamic rounding mode.  A field in the floating-point control register
12711 (@var{fpcr}, see Alpha architecture reference manual) controls the
12712 rounding mode in effect.  The C library initializes this register for
12713 rounding towards plus infinity.  Thus, unless your program modifies the
12714 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12715 @end table
12717 @item -mtrap-precision=@var{trap-precision}
12718 @opindex mtrap-precision
12719 In the Alpha architecture, floating-point traps are imprecise.  This
12720 means without software assistance it is impossible to recover from a
12721 floating trap and program execution normally needs to be terminated.
12722 GCC can generate code that can assist operating system trap handlers
12723 in determining the exact location that caused a floating-point trap.
12724 Depending on the requirements of an application, different levels of
12725 precisions can be selected:
12727 @table @samp
12728 @item p
12729 Program precision.  This option is the default and means a trap handler
12730 can only identify which program caused a floating-point exception.
12732 @item f
12733 Function precision.  The trap handler can determine the function that
12734 caused a floating-point exception.
12736 @item i
12737 Instruction precision.  The trap handler can determine the exact
12738 instruction that caused a floating-point exception.
12739 @end table
12741 Other Alpha compilers provide the equivalent options called
12742 @option{-scope_safe} and @option{-resumption_safe}.
12744 @item -mieee-conformant
12745 @opindex mieee-conformant
12746 This option marks the generated code as IEEE conformant.  You must not
12747 use this option unless you also specify @option{-mtrap-precision=i} and either
12748 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
12749 is to emit the line @samp{.eflag 48} in the function prologue of the
12750 generated assembly file.
12752 @item -mbuild-constants
12753 @opindex mbuild-constants
12754 Normally GCC examines a 32- or 64-bit integer constant to
12755 see if it can construct it from smaller constants in two or three
12756 instructions.  If it cannot, it outputs the constant as a literal and
12757 generates code to load it from the data segment at run time.
12759 Use this option to require GCC to construct @emph{all} integer constants
12760 using code, even if it takes more instructions (the maximum is six).
12762 You typically use this option to build a shared library dynamic
12763 loader.  Itself a shared library, it must relocate itself in memory
12764 before it can find the variables and constants in its own data segment.
12766 @item -mbwx
12767 @itemx -mno-bwx
12768 @itemx -mcix
12769 @itemx -mno-cix
12770 @itemx -mfix
12771 @itemx -mno-fix
12772 @itemx -mmax
12773 @itemx -mno-max
12774 @opindex mbwx
12775 @opindex mno-bwx
12776 @opindex mcix
12777 @opindex mno-cix
12778 @opindex mfix
12779 @opindex mno-fix
12780 @opindex mmax
12781 @opindex mno-max
12782 Indicate whether GCC should generate code to use the optional BWX,
12783 CIX, FIX and MAX instruction sets.  The default is to use the instruction
12784 sets supported by the CPU type specified via @option{-mcpu=} option or that
12785 of the CPU on which GCC was built if none is specified.
12787 @item -mfloat-vax
12788 @itemx -mfloat-ieee
12789 @opindex mfloat-vax
12790 @opindex mfloat-ieee
12791 Generate code that uses (does not use) VAX F and G floating-point
12792 arithmetic instead of IEEE single and double precision.
12794 @item -mexplicit-relocs
12795 @itemx -mno-explicit-relocs
12796 @opindex mexplicit-relocs
12797 @opindex mno-explicit-relocs
12798 Older Alpha assemblers provided no way to generate symbol relocations
12799 except via assembler macros.  Use of these macros does not allow
12800 optimal instruction scheduling.  GNU binutils as of version 2.12
12801 supports a new syntax that allows the compiler to explicitly mark
12802 which relocations should apply to which instructions.  This option
12803 is mostly useful for debugging, as GCC detects the capabilities of
12804 the assembler when it is built and sets the default accordingly.
12806 @item -msmall-data
12807 @itemx -mlarge-data
12808 @opindex msmall-data
12809 @opindex mlarge-data
12810 When @option{-mexplicit-relocs} is in effect, static data is
12811 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
12812 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
12813 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
12814 16-bit relocations off of the @code{$gp} register.  This limits the
12815 size of the small data area to 64KB, but allows the variables to be
12816 directly accessed via a single instruction.
12818 The default is @option{-mlarge-data}.  With this option the data area
12819 is limited to just below 2GB@.  Programs that require more than 2GB of
12820 data must use @code{malloc} or @code{mmap} to allocate the data in the
12821 heap instead of in the program's data segment.
12823 When generating code for shared libraries, @option{-fpic} implies
12824 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
12826 @item -msmall-text
12827 @itemx -mlarge-text
12828 @opindex msmall-text
12829 @opindex mlarge-text
12830 When @option{-msmall-text} is used, the compiler assumes that the
12831 code of the entire program (or shared library) fits in 4MB, and is
12832 thus reachable with a branch instruction.  When @option{-msmall-data}
12833 is used, the compiler can assume that all local symbols share the
12834 same @code{$gp} value, and thus reduce the number of instructions
12835 required for a function call from 4 to 1.
12837 The default is @option{-mlarge-text}.
12839 @item -mcpu=@var{cpu_type}
12840 @opindex mcpu
12841 Set the instruction set and instruction scheduling parameters for
12842 machine type @var{cpu_type}.  You can specify either the @samp{EV}
12843 style name or the corresponding chip number.  GCC supports scheduling
12844 parameters for the EV4, EV5 and EV6 family of processors and
12845 chooses the default values for the instruction set from the processor
12846 you specify.  If you do not specify a processor type, GCC defaults
12847 to the processor on which the compiler was built.
12849 Supported values for @var{cpu_type} are
12851 @table @samp
12852 @item ev4
12853 @itemx ev45
12854 @itemx 21064
12855 Schedules as an EV4 and has no instruction set extensions.
12857 @item ev5
12858 @itemx 21164
12859 Schedules as an EV5 and has no instruction set extensions.
12861 @item ev56
12862 @itemx 21164a
12863 Schedules as an EV5 and supports the BWX extension.
12865 @item pca56
12866 @itemx 21164pc
12867 @itemx 21164PC
12868 Schedules as an EV5 and supports the BWX and MAX extensions.
12870 @item ev6
12871 @itemx 21264
12872 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12874 @item ev67
12875 @itemx 21264a
12876 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12877 @end table
12879 Native toolchains also support the value @samp{native},
12880 which selects the best architecture option for the host processor.
12881 @option{-mcpu=native} has no effect if GCC does not recognize
12882 the processor.
12884 @item -mtune=@var{cpu_type}
12885 @opindex mtune
12886 Set only the instruction scheduling parameters for machine type
12887 @var{cpu_type}.  The instruction set is not changed.
12889 Native toolchains also support the value @samp{native},
12890 which selects the best architecture option for the host processor.
12891 @option{-mtune=native} has no effect if GCC does not recognize
12892 the processor.
12894 @item -mmemory-latency=@var{time}
12895 @opindex mmemory-latency
12896 Sets the latency the scheduler should assume for typical memory
12897 references as seen by the application.  This number is highly
12898 dependent on the memory access patterns used by the application
12899 and the size of the external cache on the machine.
12901 Valid options for @var{time} are
12903 @table @samp
12904 @item @var{number}
12905 A decimal number representing clock cycles.
12907 @item L1
12908 @itemx L2
12909 @itemx L3
12910 @itemx main
12911 The compiler contains estimates of the number of clock cycles for
12912 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12913 (also called Dcache, Scache, and Bcache), as well as to main memory.
12914 Note that L3 is only valid for EV5.
12916 @end table
12917 @end table
12919 @node FR30 Options
12920 @subsection FR30 Options
12921 @cindex FR30 Options
12923 These options are defined specifically for the FR30 port.
12925 @table @gcctabopt
12927 @item -msmall-model
12928 @opindex msmall-model
12929 Use the small address space model.  This can produce smaller code, but
12930 it does assume that all symbolic values and addresses fit into a
12931 20-bit range.
12933 @item -mno-lsim
12934 @opindex mno-lsim
12935 Assume that runtime support has been provided and so there is no need
12936 to include the simulator library (@file{libsim.a}) on the linker
12937 command line.
12939 @end table
12941 @node FRV Options
12942 @subsection FRV Options
12943 @cindex FRV Options
12945 @table @gcctabopt
12946 @item -mgpr-32
12947 @opindex mgpr-32
12949 Only use the first 32 general-purpose registers.
12951 @item -mgpr-64
12952 @opindex mgpr-64
12954 Use all 64 general-purpose registers.
12956 @item -mfpr-32
12957 @opindex mfpr-32
12959 Use only the first 32 floating-point registers.
12961 @item -mfpr-64
12962 @opindex mfpr-64
12964 Use all 64 floating-point registers.
12966 @item -mhard-float
12967 @opindex mhard-float
12969 Use hardware instructions for floating-point operations.
12971 @item -msoft-float
12972 @opindex msoft-float
12974 Use library routines for floating-point operations.
12976 @item -malloc-cc
12977 @opindex malloc-cc
12979 Dynamically allocate condition code registers.
12981 @item -mfixed-cc
12982 @opindex mfixed-cc
12984 Do not try to dynamically allocate condition code registers, only
12985 use @code{icc0} and @code{fcc0}.
12987 @item -mdword
12988 @opindex mdword
12990 Change ABI to use double word insns.
12992 @item -mno-dword
12993 @opindex mno-dword
12995 Do not use double word instructions.
12997 @item -mdouble
12998 @opindex mdouble
13000 Use floating-point double instructions.
13002 @item -mno-double
13003 @opindex mno-double
13005 Do not use floating-point double instructions.
13007 @item -mmedia
13008 @opindex mmedia
13010 Use media instructions.
13012 @item -mno-media
13013 @opindex mno-media
13015 Do not use media instructions.
13017 @item -mmuladd
13018 @opindex mmuladd
13020 Use multiply and add/subtract instructions.
13022 @item -mno-muladd
13023 @opindex mno-muladd
13025 Do not use multiply and add/subtract instructions.
13027 @item -mfdpic
13028 @opindex mfdpic
13030 Select the FDPIC ABI, which uses function descriptors to represent
13031 pointers to functions.  Without any PIC/PIE-related options, it
13032 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
13033 assumes GOT entries and small data are within a 12-bit range from the
13034 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
13035 are computed with 32 bits.
13036 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13038 @item -minline-plt
13039 @opindex minline-plt
13041 Enable inlining of PLT entries in function calls to functions that are
13042 not known to bind locally.  It has no effect without @option{-mfdpic}.
13043 It's enabled by default if optimizing for speed and compiling for
13044 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
13045 optimization option such as @option{-O3} or above is present in the
13046 command line.
13048 @item -mTLS
13049 @opindex mTLS
13051 Assume a large TLS segment when generating thread-local code.
13053 @item -mtls
13054 @opindex mtls
13056 Do not assume a large TLS segment when generating thread-local code.
13058 @item -mgprel-ro
13059 @opindex mgprel-ro
13061 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
13062 that is known to be in read-only sections.  It's enabled by default,
13063 except for @option{-fpic} or @option{-fpie}: even though it may help
13064 make the global offset table smaller, it trades 1 instruction for 4.
13065 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
13066 one of which may be shared by multiple symbols, and it avoids the need
13067 for a GOT entry for the referenced symbol, so it's more likely to be a
13068 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
13070 @item -multilib-library-pic
13071 @opindex multilib-library-pic
13073 Link with the (library, not FD) pic libraries.  It's implied by
13074 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
13075 @option{-fpic} without @option{-mfdpic}.  You should never have to use
13076 it explicitly.
13078 @item -mlinked-fp
13079 @opindex mlinked-fp
13081 Follow the EABI requirement of always creating a frame pointer whenever
13082 a stack frame is allocated.  This option is enabled by default and can
13083 be disabled with @option{-mno-linked-fp}.
13085 @item -mlong-calls
13086 @opindex mlong-calls
13088 Use indirect addressing to call functions outside the current
13089 compilation unit.  This allows the functions to be placed anywhere
13090 within the 32-bit address space.
13092 @item -malign-labels
13093 @opindex malign-labels
13095 Try to align labels to an 8-byte boundary by inserting NOPs into the
13096 previous packet.  This option only has an effect when VLIW packing
13097 is enabled.  It doesn't create new packets; it merely adds NOPs to
13098 existing ones.
13100 @item -mlibrary-pic
13101 @opindex mlibrary-pic
13103 Generate position-independent EABI code.
13105 @item -macc-4
13106 @opindex macc-4
13108 Use only the first four media accumulator registers.
13110 @item -macc-8
13111 @opindex macc-8
13113 Use all eight media accumulator registers.
13115 @item -mpack
13116 @opindex mpack
13118 Pack VLIW instructions.
13120 @item -mno-pack
13121 @opindex mno-pack
13123 Do not pack VLIW instructions.
13125 @item -mno-eflags
13126 @opindex mno-eflags
13128 Do not mark ABI switches in e_flags.
13130 @item -mcond-move
13131 @opindex mcond-move
13133 Enable the use of conditional-move instructions (default).
13135 This switch is mainly for debugging the compiler and will likely be removed
13136 in a future version.
13138 @item -mno-cond-move
13139 @opindex mno-cond-move
13141 Disable the use of conditional-move instructions.
13143 This switch is mainly for debugging the compiler and will likely be removed
13144 in a future version.
13146 @item -mscc
13147 @opindex mscc
13149 Enable the use of conditional set instructions (default).
13151 This switch is mainly for debugging the compiler and will likely be removed
13152 in a future version.
13154 @item -mno-scc
13155 @opindex mno-scc
13157 Disable the use of conditional set instructions.
13159 This switch is mainly for debugging the compiler and will likely be removed
13160 in a future version.
13162 @item -mcond-exec
13163 @opindex mcond-exec
13165 Enable the use of conditional execution (default).
13167 This switch is mainly for debugging the compiler and will likely be removed
13168 in a future version.
13170 @item -mno-cond-exec
13171 @opindex mno-cond-exec
13173 Disable the use of conditional execution.
13175 This switch is mainly for debugging the compiler and will likely be removed
13176 in a future version.
13178 @item -mvliw-branch
13179 @opindex mvliw-branch
13181 Run a pass to pack branches into VLIW instructions (default).
13183 This switch is mainly for debugging the compiler and will likely be removed
13184 in a future version.
13186 @item -mno-vliw-branch
13187 @opindex mno-vliw-branch
13189 Do not run a pass to pack branches into VLIW instructions.
13191 This switch is mainly for debugging the compiler and will likely be removed
13192 in a future version.
13194 @item -mmulti-cond-exec
13195 @opindex mmulti-cond-exec
13197 Enable optimization of @code{&&} and @code{||} in conditional execution
13198 (default).
13200 This switch is mainly for debugging the compiler and will likely be removed
13201 in a future version.
13203 @item -mno-multi-cond-exec
13204 @opindex mno-multi-cond-exec
13206 Disable optimization of @code{&&} and @code{||} in conditional execution.
13208 This switch is mainly for debugging the compiler and will likely be removed
13209 in a future version.
13211 @item -mnested-cond-exec
13212 @opindex mnested-cond-exec
13214 Enable nested conditional execution optimizations (default).
13216 This switch is mainly for debugging the compiler and will likely be removed
13217 in a future version.
13219 @item -mno-nested-cond-exec
13220 @opindex mno-nested-cond-exec
13222 Disable nested conditional execution optimizations.
13224 This switch is mainly for debugging the compiler and will likely be removed
13225 in a future version.
13227 @item -moptimize-membar
13228 @opindex moptimize-membar
13230 This switch removes redundant @code{membar} instructions from the
13231 compiler-generated code.  It is enabled by default.
13233 @item -mno-optimize-membar
13234 @opindex mno-optimize-membar
13236 This switch disables the automatic removal of redundant @code{membar}
13237 instructions from the generated code.
13239 @item -mtomcat-stats
13240 @opindex mtomcat-stats
13242 Cause gas to print out tomcat statistics.
13244 @item -mcpu=@var{cpu}
13245 @opindex mcpu
13247 Select the processor type for which to generate code.  Possible values are
13248 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
13249 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
13251 @end table
13253 @node GNU/Linux Options
13254 @subsection GNU/Linux Options
13256 These @samp{-m} options are defined for GNU/Linux targets:
13258 @table @gcctabopt
13259 @item -mglibc
13260 @opindex mglibc
13261 Use the GNU C library.  This is the default except
13262 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
13264 @item -muclibc
13265 @opindex muclibc
13266 Use uClibc C library.  This is the default on
13267 @samp{*-*-linux-*uclibc*} targets.
13269 @item -mbionic
13270 @opindex mbionic
13271 Use Bionic C library.  This is the default on
13272 @samp{*-*-linux-*android*} targets.
13274 @item -mandroid
13275 @opindex mandroid
13276 Compile code compatible with Android platform.  This is the default on
13277 @samp{*-*-linux-*android*} targets.
13279 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
13280 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
13281 this option makes the GCC driver pass Android-specific options to the linker.
13282 Finally, this option causes the preprocessor macro @code{__ANDROID__}
13283 to be defined.
13285 @item -tno-android-cc
13286 @opindex tno-android-cc
13287 Disable compilation effects of @option{-mandroid}, i.e., do not enable
13288 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
13289 @option{-fno-rtti} by default.
13291 @item -tno-android-ld
13292 @opindex tno-android-ld
13293 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
13294 linking options to the linker.
13296 @end table
13298 @node H8/300 Options
13299 @subsection H8/300 Options
13301 These @samp{-m} options are defined for the H8/300 implementations:
13303 @table @gcctabopt
13304 @item -mrelax
13305 @opindex mrelax
13306 Shorten some address references at link time, when possible; uses the
13307 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
13308 ld, Using ld}, for a fuller description.
13310 @item -mh
13311 @opindex mh
13312 Generate code for the H8/300H@.
13314 @item -ms
13315 @opindex ms
13316 Generate code for the H8S@.
13318 @item -mn
13319 @opindex mn
13320 Generate code for the H8S and H8/300H in the normal mode.  This switch
13321 must be used either with @option{-mh} or @option{-ms}.
13323 @item -ms2600
13324 @opindex ms2600
13325 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
13327 @item -mexr
13328 @opindex mexr
13329 Extended registers are stored on stack before execution of function
13330 with monitor attribute. Default option is @option{-mexr}.
13331 This option is valid only for H8S targets.
13333 @item -mno-exr
13334 @opindex mno-exr
13335 Extended registers are not stored on stack before execution of function 
13336 with monitor attribute. Default option is @option{-mno-exr}. 
13337 This option is valid only for H8S targets.
13339 @item -mint32
13340 @opindex mint32
13341 Make @code{int} data 32 bits by default.
13343 @item -malign-300
13344 @opindex malign-300
13345 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
13346 The default for the H8/300H and H8S is to align longs and floats on
13347 4-byte boundaries.
13348 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
13349 This option has no effect on the H8/300.
13350 @end table
13352 @node HPPA Options
13353 @subsection HPPA Options
13354 @cindex HPPA Options
13356 These @samp{-m} options are defined for the HPPA family of computers:
13358 @table @gcctabopt
13359 @item -march=@var{architecture-type}
13360 @opindex march
13361 Generate code for the specified architecture.  The choices for
13362 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
13363 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
13364 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
13365 architecture option for your machine.  Code compiled for lower numbered
13366 architectures runs on higher numbered architectures, but not the
13367 other way around.
13369 @item -mpa-risc-1-0
13370 @itemx -mpa-risc-1-1
13371 @itemx -mpa-risc-2-0
13372 @opindex mpa-risc-1-0
13373 @opindex mpa-risc-1-1
13374 @opindex mpa-risc-2-0
13375 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
13377 @item -mbig-switch
13378 @opindex mbig-switch
13379 Generate code suitable for big switch tables.  Use this option only if
13380 the assembler/linker complain about out-of-range branches within a switch
13381 table.
13383 @item -mjump-in-delay
13384 @opindex mjump-in-delay
13385 Fill delay slots of function calls with unconditional jump instructions
13386 by modifying the return pointer for the function call to be the target
13387 of the conditional jump.
13389 @item -mdisable-fpregs
13390 @opindex mdisable-fpregs
13391 Prevent floating-point registers from being used in any manner.  This is
13392 necessary for compiling kernels that perform lazy context switching of
13393 floating-point registers.  If you use this option and attempt to perform
13394 floating-point operations, the compiler aborts.
13396 @item -mdisable-indexing
13397 @opindex mdisable-indexing
13398 Prevent the compiler from using indexing address modes.  This avoids some
13399 rather obscure problems when compiling MIG generated code under MACH@.
13401 @item -mno-space-regs
13402 @opindex mno-space-regs
13403 Generate code that assumes the target has no space registers.  This allows
13404 GCC to generate faster indirect calls and use unscaled index address modes.
13406 Such code is suitable for level 0 PA systems and kernels.
13408 @item -mfast-indirect-calls
13409 @opindex mfast-indirect-calls
13410 Generate code that assumes calls never cross space boundaries.  This
13411 allows GCC to emit code that performs faster indirect calls.
13413 This option does not work in the presence of shared libraries or nested
13414 functions.
13416 @item -mfixed-range=@var{register-range}
13417 @opindex mfixed-range
13418 Generate code treating the given register range as fixed registers.
13419 A fixed register is one that the register allocator cannot use.  This is
13420 useful when compiling kernel code.  A register range is specified as
13421 two registers separated by a dash.  Multiple register ranges can be
13422 specified separated by a comma.
13424 @item -mlong-load-store
13425 @opindex mlong-load-store
13426 Generate 3-instruction load and store sequences as sometimes required by
13427 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
13428 the HP compilers.
13430 @item -mportable-runtime
13431 @opindex mportable-runtime
13432 Use the portable calling conventions proposed by HP for ELF systems.
13434 @item -mgas
13435 @opindex mgas
13436 Enable the use of assembler directives only GAS understands.
13438 @item -mschedule=@var{cpu-type}
13439 @opindex mschedule
13440 Schedule code according to the constraints for the machine type
13441 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
13442 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
13443 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
13444 proper scheduling option for your machine.  The default scheduling is
13445 @samp{8000}.
13447 @item -mlinker-opt
13448 @opindex mlinker-opt
13449 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
13450 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
13451 linkers in which they give bogus error messages when linking some programs.
13453 @item -msoft-float
13454 @opindex msoft-float
13455 Generate output containing library calls for floating point.
13456 @strong{Warning:} the requisite libraries are not available for all HPPA
13457 targets.  Normally the facilities of the machine's usual C compiler are
13458 used, but this cannot be done directly in cross-compilation.  You must make
13459 your own arrangements to provide suitable library functions for
13460 cross-compilation.
13462 @option{-msoft-float} changes the calling convention in the output file;
13463 therefore, it is only useful if you compile @emph{all} of a program with
13464 this option.  In particular, you need to compile @file{libgcc.a}, the
13465 library that comes with GCC, with @option{-msoft-float} in order for
13466 this to work.
13468 @item -msio
13469 @opindex msio
13470 Generate the predefine, @code{_SIO}, for server IO@.  The default is
13471 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
13472 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
13473 options are available under HP-UX and HI-UX@.
13475 @item -mgnu-ld
13476 @opindex mgnu-ld
13477 Use options specific to GNU @command{ld}.
13478 This passes @option{-shared} to @command{ld} when
13479 building a shared library.  It is the default when GCC is configured,
13480 explicitly or implicitly, with the GNU linker.  This option does not
13481 affect which @command{ld} is called; it only changes what parameters
13482 are passed to that @command{ld}.
13483 The @command{ld} that is called is determined by the
13484 @option{--with-ld} configure option, GCC's program search path, and
13485 finally by the user's @env{PATH}.  The linker used by GCC can be printed
13486 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
13487 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13489 @item -mhp-ld
13490 @opindex mhp-ld
13491 Use options specific to HP @command{ld}.
13492 This passes @option{-b} to @command{ld} when building
13493 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
13494 links.  It is the default when GCC is configured, explicitly or
13495 implicitly, with the HP linker.  This option does not affect
13496 which @command{ld} is called; it only changes what parameters are passed to that
13497 @command{ld}.
13498 The @command{ld} that is called is determined by the @option{--with-ld}
13499 configure option, GCC's program search path, and finally by the user's
13500 @env{PATH}.  The linker used by GCC can be printed using @samp{which
13501 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
13502 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13504 @item -mlong-calls
13505 @opindex mno-long-calls
13506 Generate code that uses long call sequences.  This ensures that a call
13507 is always able to reach linker generated stubs.  The default is to generate
13508 long calls only when the distance from the call site to the beginning
13509 of the function or translation unit, as the case may be, exceeds a
13510 predefined limit set by the branch type being used.  The limits for
13511 normal calls are 7,600,000 and 240,000 bytes, respectively for the
13512 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
13513 240,000 bytes.
13515 Distances are measured from the beginning of functions when using the
13516 @option{-ffunction-sections} option, or when using the @option{-mgas}
13517 and @option{-mno-portable-runtime} options together under HP-UX with
13518 the SOM linker.
13520 It is normally not desirable to use this option as it degrades
13521 performance.  However, it may be useful in large applications,
13522 particularly when partial linking is used to build the application.
13524 The types of long calls used depends on the capabilities of the
13525 assembler and linker, and the type of code being generated.  The
13526 impact on systems that support long absolute calls, and long pic
13527 symbol-difference or pc-relative calls should be relatively small.
13528 However, an indirect call is used on 32-bit ELF systems in pic code
13529 and it is quite long.
13531 @item -munix=@var{unix-std}
13532 @opindex march
13533 Generate compiler predefines and select a startfile for the specified
13534 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
13535 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
13536 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
13537 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
13538 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13539 and later.
13541 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13542 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13543 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13544 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13545 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13546 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13548 It is @emph{important} to note that this option changes the interfaces
13549 for various library routines.  It also affects the operational behavior
13550 of the C library.  Thus, @emph{extreme} care is needed in using this
13551 option.
13553 Library code that is intended to operate with more than one UNIX
13554 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13555 as appropriate.  Most GNU software doesn't provide this capability.
13557 @item -nolibdld
13558 @opindex nolibdld
13559 Suppress the generation of link options to search libdld.sl when the
13560 @option{-static} option is specified on HP-UX 10 and later.
13562 @item -static
13563 @opindex static
13564 The HP-UX implementation of setlocale in libc has a dependency on
13565 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
13566 when the @option{-static} option is specified, special link options
13567 are needed to resolve this dependency.
13569 On HP-UX 10 and later, the GCC driver adds the necessary options to
13570 link with libdld.sl when the @option{-static} option is specified.
13571 This causes the resulting binary to be dynamic.  On the 64-bit port,
13572 the linkers generate dynamic binaries by default in any case.  The
13573 @option{-nolibdld} option can be used to prevent the GCC driver from
13574 adding these link options.
13576 @item -threads
13577 @opindex threads
13578 Add support for multithreading with the @dfn{dce thread} library
13579 under HP-UX@.  This option sets flags for both the preprocessor and
13580 linker.
13581 @end table
13583 @node i386 and x86-64 Options
13584 @subsection Intel 386 and AMD x86-64 Options
13585 @cindex i386 Options
13586 @cindex x86-64 Options
13587 @cindex Intel 386 Options
13588 @cindex AMD x86-64 Options
13590 These @samp{-m} options are defined for the i386 and x86-64 family of
13591 computers:
13593 @table @gcctabopt
13595 @item -march=@var{cpu-type}
13596 @opindex march
13597 Generate instructions for the machine type @var{cpu-type}.  In contrast to
13598 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
13599 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13600 to generate code that may not run at all on processors other than the one
13601 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
13602 @option{-mtune=@var{cpu-type}}.
13604 The choices for @var{cpu-type} are:
13606 @table @samp
13607 @item native
13608 This selects the CPU to generate code for at compilation time by determining
13609 the processor type of the compiling machine.  Using @option{-march=native}
13610 enables all instruction subsets supported by the local machine (hence
13611 the result might not run on different machines).  Using @option{-mtune=native}
13612 produces code optimized for the local machine under the constraints
13613 of the selected instruction set.  
13615 @item i386
13616 Original Intel i386 CPU@.
13618 @item i486
13619 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
13621 @item i586
13622 @itemx pentium
13623 Intel Pentium CPU with no MMX support.
13625 @item pentium-mmx
13626 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13628 @item pentiumpro
13629 Intel Pentium Pro CPU@.
13631 @item i686
13632 When used with @option{-march}, the Pentium Pro
13633 instruction set is used, so the code runs on all i686 family chips.
13634 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13636 @item pentium2
13637 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13638 support.
13640 @item pentium3
13641 @itemx pentium3m
13642 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13643 set support.
13645 @item pentium-m
13646 Intel Pentium M; low-power version of Intel Pentium III CPU
13647 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
13649 @item pentium4
13650 @itemx pentium4m
13651 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13653 @item prescott
13654 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13655 set support.
13657 @item nocona
13658 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13659 SSE2 and SSE3 instruction set support.
13661 @item core2
13662 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13663 instruction set support.
13665 @item corei7
13666 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13667 and SSE4.2 instruction set support.
13669 @item corei7-avx
13670 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13671 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13673 @item core-avx-i
13674 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13675 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13676 set support.
13678 @item atom
13679 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13680 instruction set support.
13682 @item k6
13683 AMD K6 CPU with MMX instruction set support.
13685 @item k6-2
13686 @itemx k6-3
13687 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13689 @item athlon
13690 @itemx athlon-tbird
13691 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13692 support.
13694 @item athlon-4
13695 @itemx athlon-xp
13696 @itemx athlon-mp
13697 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13698 instruction set support.
13700 @item k8
13701 @itemx opteron
13702 @itemx athlon64
13703 @itemx athlon-fx
13704 Processors based on the AMD K8 core with x86-64 instruction set support,
13705 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13706 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13707 instruction set extensions.)
13709 @item k8-sse3
13710 @itemx opteron-sse3
13711 @itemx athlon64-sse3
13712 Improved versions of AMD K8 cores with SSE3 instruction set support.
13714 @item amdfam10
13715 @itemx barcelona
13716 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
13717 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13718 instruction set extensions.)
13720 @item bdver1
13721 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
13722 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13723 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13724 @item bdver2
13725 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13726 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13727 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13728 extensions.)
13730 @item btver1
13731 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
13732 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13733 instruction set extensions.)
13735 @item btver2
13736 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
13737 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
13738 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
13740 @item winchip-c6
13741 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13742 set support.
13744 @item winchip2
13745 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13746 instruction set support.
13748 @item c3
13749 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
13750 implemented for this chip.)
13752 @item c3-2
13753 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13754 (No scheduling is
13755 implemented for this chip.)
13757 @item geode
13758 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
13759 @end table
13761 @item -mtune=@var{cpu-type}
13762 @opindex mtune
13763 Tune to @var{cpu-type} everything applicable about the generated code, except
13764 for the ABI and the set of available instructions.  
13765 While picking a specific @var{cpu-type} schedules things appropriately
13766 for that particular chip, the compiler does not generate any code that
13767 cannot run on the default machine type unless you use a
13768 @option{-march=@var{cpu-type}} option.
13769 For example, if GCC is configured for i686-pc-linux-gnu
13770 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
13771 but still runs on i686 machines.
13773 The choices for @var{cpu-type} are the same as for @option{-march}.
13774 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
13776 @table @samp
13777 @item generic
13778 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
13779 If you know the CPU on which your code will run, then you should use
13780 the corresponding @option{-mtune} or @option{-march} option instead of
13781 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
13782 of your application will have, then you should use this option.
13784 As new processors are deployed in the marketplace, the behavior of this
13785 option will change.  Therefore, if you upgrade to a newer version of
13786 GCC, code generation controlled by this option will change to reflect
13787 the processors
13788 that are most common at the time that version of GCC is released.
13790 There is no @option{-march=generic} option because @option{-march}
13791 indicates the instruction set the compiler can use, and there is no
13792 generic instruction set applicable to all processors.  In contrast,
13793 @option{-mtune} indicates the processor (or, in this case, collection of
13794 processors) for which the code is optimized.
13795 @end table
13797 @item -mcpu=@var{cpu-type}
13798 @opindex mcpu
13799 A deprecated synonym for @option{-mtune}.
13801 @item -mfpmath=@var{unit}
13802 @opindex mfpmath
13803 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
13804 for @var{unit} are:
13806 @table @samp
13807 @item 387
13808 Use the standard 387 floating-point coprocessor present on the majority of chips and
13809 emulated otherwise.  Code compiled with this option runs almost everywhere.
13810 The temporary results are computed in 80-bit precision instead of the precision
13811 specified by the type, resulting in slightly different results compared to most
13812 of other chips.  See @option{-ffloat-store} for more detailed description.
13814 This is the default choice for i386 compiler.
13816 @item sse
13817 Use scalar floating-point instructions present in the SSE instruction set.
13818 This instruction set is supported by Pentium III and newer chips,
13819 and in the AMD line
13820 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
13821 instruction set supports only single-precision arithmetic, thus the double and
13822 extended-precision arithmetic are still done using 387.  A later version, present
13823 only in Pentium 4 and AMD x86-64 chips, supports double-precision
13824 arithmetic too.
13826 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
13827 or @option{-msse2} switches to enable SSE extensions and make this option
13828 effective.  For the x86-64 compiler, these extensions are enabled by default.
13830 The resulting code should be considerably faster in the majority of cases and avoid
13831 the numerical instability problems of 387 code, but may break some existing
13832 code that expects temporaries to be 80 bits.
13834 This is the default choice for the x86-64 compiler.
13836 @item sse,387
13837 @itemx sse+387
13838 @itemx both
13839 Attempt to utilize both instruction sets at once.  This effectively doubles the
13840 amount of available registers, and on chips with separate execution units for
13841 387 and SSE the execution resources too.  Use this option with care, as it is
13842 still experimental, because the GCC register allocator does not model separate
13843 functional units well, resulting in unstable performance.
13844 @end table
13846 @item -masm=@var{dialect}
13847 @opindex masm=@var{dialect}
13848 Output assembly instructions using selected @var{dialect}.  Supported
13849 choices are @samp{intel} or @samp{att} (the default).  Darwin does
13850 not support @samp{intel}.
13852 @item -mieee-fp
13853 @itemx -mno-ieee-fp
13854 @opindex mieee-fp
13855 @opindex mno-ieee-fp
13856 Control whether or not the compiler uses IEEE floating-point
13857 comparisons.  These correctly handle the case where the result of a
13858 comparison is unordered.
13860 @item -msoft-float
13861 @opindex msoft-float
13862 Generate output containing library calls for floating point.
13864 @strong{Warning:} the requisite libraries are not part of GCC@.
13865 Normally the facilities of the machine's usual C compiler are used, but
13866 this can't be done directly in cross-compilation.  You must make your
13867 own arrangements to provide suitable library functions for
13868 cross-compilation.
13870 On machines where a function returns floating-point results in the 80387
13871 register stack, some floating-point opcodes may be emitted even if
13872 @option{-msoft-float} is used.
13874 @item -mno-fp-ret-in-387
13875 @opindex mno-fp-ret-in-387
13876 Do not use the FPU registers for return values of functions.
13878 The usual calling convention has functions return values of types
13879 @code{float} and @code{double} in an FPU register, even if there
13880 is no FPU@.  The idea is that the operating system should emulate
13881 an FPU@.
13883 The option @option{-mno-fp-ret-in-387} causes such values to be returned
13884 in ordinary CPU registers instead.
13886 @item -mno-fancy-math-387
13887 @opindex mno-fancy-math-387
13888 Some 387 emulators do not support the @code{sin}, @code{cos} and
13889 @code{sqrt} instructions for the 387.  Specify this option to avoid
13890 generating those instructions.  This option is the default on FreeBSD,
13891 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
13892 indicates that the target CPU always has an FPU and so the
13893 instruction does not need emulation.  These
13894 instructions are not generated unless you also use the
13895 @option{-funsafe-math-optimizations} switch.
13897 @item -malign-double
13898 @itemx -mno-align-double
13899 @opindex malign-double
13900 @opindex mno-align-double
13901 Control whether GCC aligns @code{double}, @code{long double}, and
13902 @code{long long} variables on a two-word boundary or a one-word
13903 boundary.  Aligning @code{double} variables on a two-word boundary
13904 produces code that runs somewhat faster on a Pentium at the
13905 expense of more memory.
13907 On x86-64, @option{-malign-double} is enabled by default.
13909 @strong{Warning:} if you use the @option{-malign-double} switch,
13910 structures containing the above types are aligned differently than
13911 the published application binary interface specifications for the 386
13912 and are not binary compatible with structures in code compiled
13913 without that switch.
13915 @item -m96bit-long-double
13916 @itemx -m128bit-long-double
13917 @opindex m96bit-long-double
13918 @opindex m128bit-long-double
13919 These switches control the size of @code{long double} type.  The i386
13920 application binary interface specifies the size to be 96 bits,
13921 so @option{-m96bit-long-double} is the default in 32-bit mode.
13923 Modern architectures (Pentium and newer) prefer @code{long double}
13924 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
13925 conforming to the ABI, this is not possible.  So specifying
13926 @option{-m128bit-long-double} aligns @code{long double}
13927 to a 16-byte boundary by padding the @code{long double} with an additional
13928 32-bit zero.
13930 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
13931 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
13933 Notice that neither of these options enable any extra precision over the x87
13934 standard of 80 bits for a @code{long double}.
13936 @strong{Warning:} if you override the default value for your target ABI, this
13937 changes the size of 
13938 structures and arrays containing @code{long double} variables,
13939 as well as modifying the function calling convention for functions taking
13940 @code{long double}.  Hence they are not binary-compatible
13941 with code compiled without that switch.
13943 @item -mlong-double-64
13944 @itemx -mlong-double-80
13945 @opindex mlong-double-64
13946 @opindex mlong-double-80
13947 These switches control the size of @code{long double} type. A size
13948 of 64 bits makes the @code{long double} type equivalent to the @code{double}
13949 type. This is the default for Bionic C library.
13951 @strong{Warning:} if you override the default value for your target ABI, this
13952 changes the size of
13953 structures and arrays containing @code{long double} variables,
13954 as well as modifying the function calling convention for functions taking
13955 @code{long double}.  Hence they are not binary-compatible
13956 with code compiled without that switch.
13958 @item -mlarge-data-threshold=@var{threshold}
13959 @opindex mlarge-data-threshold
13960 When @option{-mcmodel=medium} is specified, data objects larger than
13961 @var{threshold} are placed in the large data section.  This value must be the
13962 same across all objects linked into the binary, and defaults to 65535.
13964 @item -mrtd
13965 @opindex mrtd
13966 Use a different function-calling convention, in which functions that
13967 take a fixed number of arguments return with the @code{ret @var{num}}
13968 instruction, which pops their arguments while returning.  This saves one
13969 instruction in the caller since there is no need to pop the arguments
13970 there.
13972 You can specify that an individual function is called with this calling
13973 sequence with the function attribute @samp{stdcall}.  You can also
13974 override the @option{-mrtd} option by using the function attribute
13975 @samp{cdecl}.  @xref{Function Attributes}.
13977 @strong{Warning:} this calling convention is incompatible with the one
13978 normally used on Unix, so you cannot use it if you need to call
13979 libraries compiled with the Unix compiler.
13981 Also, you must provide function prototypes for all functions that
13982 take variable numbers of arguments (including @code{printf});
13983 otherwise incorrect code is generated for calls to those
13984 functions.
13986 In addition, seriously incorrect code results if you call a
13987 function with too many arguments.  (Normally, extra arguments are
13988 harmlessly ignored.)
13990 @item -mregparm=@var{num}
13991 @opindex mregparm
13992 Control how many registers are used to pass integer arguments.  By
13993 default, no registers are used to pass arguments, and at most 3
13994 registers can be used.  You can control this behavior for a specific
13995 function by using the function attribute @samp{regparm}.
13996 @xref{Function Attributes}.
13998 @strong{Warning:} if you use this switch, and
13999 @var{num} is nonzero, then you must build all modules with the same
14000 value, including any libraries.  This includes the system libraries and
14001 startup modules.
14003 @item -msseregparm
14004 @opindex msseregparm
14005 Use SSE register passing conventions for float and double arguments
14006 and return values.  You can control this behavior for a specific
14007 function by using the function attribute @samp{sseregparm}.
14008 @xref{Function Attributes}.
14010 @strong{Warning:} if you use this switch then you must build all
14011 modules with the same value, including any libraries.  This includes
14012 the system libraries and startup modules.
14014 @item -mvect8-ret-in-mem
14015 @opindex mvect8-ret-in-mem
14016 Return 8-byte vectors in memory instead of MMX registers.  This is the
14017 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
14018 Studio compilers until version 12.  Later compiler versions (starting
14019 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
14020 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
14021 you need to remain compatible with existing code produced by those
14022 previous compiler versions or older versions of GCC@.
14024 @item -mpc32
14025 @itemx -mpc64
14026 @itemx -mpc80
14027 @opindex mpc32
14028 @opindex mpc64
14029 @opindex mpc80
14031 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
14032 is specified, the significands of results of floating-point operations are
14033 rounded to 24 bits (single precision); @option{-mpc64} rounds the
14034 significands of results of floating-point operations to 53 bits (double
14035 precision) and @option{-mpc80} rounds the significands of results of
14036 floating-point operations to 64 bits (extended double precision), which is
14037 the default.  When this option is used, floating-point operations in higher
14038 precisions are not available to the programmer without setting the FPU
14039 control word explicitly.
14041 Setting the rounding of floating-point operations to less than the default
14042 80 bits can speed some programs by 2% or more.  Note that some mathematical
14043 libraries assume that extended-precision (80-bit) floating-point operations
14044 are enabled by default; routines in such libraries could suffer significant
14045 loss of accuracy, typically through so-called ``catastrophic cancellation'',
14046 when this option is used to set the precision to less than extended precision.
14048 @item -mstackrealign
14049 @opindex mstackrealign
14050 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
14051 option generates an alternate prologue and epilogue that realigns the
14052 run-time stack if necessary.  This supports mixing legacy codes that keep
14053 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
14054 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
14055 applicable to individual functions.
14057 @item -mpreferred-stack-boundary=@var{num}
14058 @opindex mpreferred-stack-boundary
14059 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
14060 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
14061 the default is 4 (16 bytes or 128 bits).
14063 @strong{Warning:} When generating code for the x86-64 architecture with
14064 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
14065 used to keep the stack boundary aligned to 8 byte boundary.  Since
14066 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
14067 intended to be used in controlled environment where stack space is
14068 important limitation.  This option will lead to wrong code when functions
14069 compiled with 16 byte stack alignment (such as functions from a standard
14070 library) are called with misaligned stack.  In this case, SSE
14071 instructions may lead to misaligned memory access traps.  In addition,
14072 variable arguments will be handled incorrectly for 16 byte aligned
14073 objects (including x87 long double and __int128), leading to wrong
14074 results.  You must build all modules with
14075 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
14076 includes the system libraries and startup modules.
14078 @item -mincoming-stack-boundary=@var{num}
14079 @opindex mincoming-stack-boundary
14080 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
14081 boundary.  If @option{-mincoming-stack-boundary} is not specified,
14082 the one specified by @option{-mpreferred-stack-boundary} is used.
14084 On Pentium and Pentium Pro, @code{double} and @code{long double} values
14085 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
14086 suffer significant run time performance penalties.  On Pentium III, the
14087 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
14088 properly if it is not 16-byte aligned.
14090 To ensure proper alignment of this values on the stack, the stack boundary
14091 must be as aligned as that required by any value stored on the stack.
14092 Further, every function must be generated such that it keeps the stack
14093 aligned.  Thus calling a function compiled with a higher preferred
14094 stack boundary from a function compiled with a lower preferred stack
14095 boundary most likely misaligns the stack.  It is recommended that
14096 libraries that use callbacks always use the default setting.
14098 This extra alignment does consume extra stack space, and generally
14099 increases code size.  Code that is sensitive to stack space usage, such
14100 as embedded systems and operating system kernels, may want to reduce the
14101 preferred alignment to @option{-mpreferred-stack-boundary=2}.
14103 @item -mmmx
14104 @itemx -mno-mmx
14105 @itemx -msse
14106 @itemx -mno-sse
14107 @itemx -msse2
14108 @itemx -mno-sse2
14109 @itemx -msse3
14110 @itemx -mno-sse3
14111 @itemx -mssse3
14112 @itemx -mno-ssse3
14113 @itemx -msse4.1
14114 @need 800
14115 @itemx -mno-sse4.1
14116 @itemx -msse4.2
14117 @itemx -mno-sse4.2
14118 @itemx -msse4
14119 @itemx -mno-sse4
14120 @itemx -mavx
14121 @itemx -mno-avx
14122 @itemx -mavx2
14123 @itemx -mno-avx2
14124 @itemx -maes
14125 @itemx -mno-aes
14126 @itemx -mpclmul
14127 @need 800
14128 @itemx -mno-pclmul
14129 @itemx -mfsgsbase
14130 @itemx -mno-fsgsbase
14131 @itemx -mrdrnd
14132 @itemx -mno-rdrnd
14133 @itemx -mf16c
14134 @itemx -mno-f16c
14135 @itemx -mfma
14136 @itemx -mno-fma
14137 @itemx -msse4a
14138 @itemx -mno-sse4a
14139 @itemx -mfma4
14140 @need 800
14141 @itemx -mno-fma4
14142 @itemx -mxop
14143 @itemx -mno-xop
14144 @itemx -mlwp
14145 @itemx -mno-lwp
14146 @itemx -m3dnow
14147 @itemx -mno-3dnow
14148 @itemx -mpopcnt
14149 @itemx -mno-popcnt
14150 @itemx -mabm
14151 @itemx -mno-abm
14152 @itemx -mbmi
14153 @itemx -mbmi2
14154 @itemx -mno-bmi
14155 @itemx -mno-bmi2
14156 @itemx -mlzcnt
14157 @itemx -mno-lzcnt
14158 @itemx -mrtm
14159 @itemx -mtbm
14160 @itemx -mno-tbm
14161 @opindex mmmx
14162 @opindex mno-mmx
14163 @opindex msse
14164 @opindex mno-sse
14165 @opindex m3dnow
14166 @opindex mno-3dnow
14167 These switches enable or disable the use of instructions in the MMX, SSE,
14168 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
14169 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
14170 extended instruction sets.
14171 These extensions are also available as built-in functions: see
14172 @ref{X86 Built-in Functions}, for details of the functions enabled and
14173 disabled by these switches.
14175 To generate SSE/SSE2 instructions automatically from floating-point
14176 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
14178 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
14179 generates new AVX instructions or AVX equivalence for all SSEx instructions
14180 when needed.
14182 These options enable GCC to use these extended instructions in
14183 generated code, even without @option{-mfpmath=sse}.  Applications that
14184 perform run-time CPU detection must compile separate files for each
14185 supported architecture, using the appropriate flags.  In particular,
14186 the file containing the CPU detection code should be compiled without
14187 these options.
14189 @item -mcld
14190 @opindex mcld
14191 This option instructs GCC to emit a @code{cld} instruction in the prologue
14192 of functions that use string instructions.  String instructions depend on
14193 the DF flag to select between autoincrement or autodecrement mode.  While the
14194 ABI specifies the DF flag to be cleared on function entry, some operating
14195 systems violate this specification by not clearing the DF flag in their
14196 exception dispatchers.  The exception handler can be invoked with the DF flag
14197 set, which leads to wrong direction mode when string instructions are used.
14198 This option can be enabled by default on 32-bit x86 targets by configuring
14199 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
14200 instructions can be suppressed with the @option{-mno-cld} compiler option
14201 in this case.
14203 @item -mvzeroupper
14204 @opindex mvzeroupper
14205 This option instructs GCC to emit a @code{vzeroupper} instruction
14206 before a transfer of control flow out of the function to minimize
14207 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
14208 intrinsics.
14210 @item -mprefer-avx128
14211 @opindex mprefer-avx128
14212 This option instructs GCC to use 128-bit AVX instructions instead of
14213 256-bit AVX instructions in the auto-vectorizer.
14215 @item -mcx16
14216 @opindex mcx16
14217 This option enables GCC to generate @code{CMPXCHG16B} instructions.
14218 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
14219 (or oword) data types.  
14220 This is useful for high-resolution counters that can be updated
14221 by multiple processors (or cores).  This instruction is generated as part of
14222 atomic built-in functions: see @ref{__sync Builtins} or
14223 @ref{__atomic Builtins} for details.
14225 @item -msahf
14226 @opindex msahf
14227 This option enables generation of @code{SAHF} instructions in 64-bit code.
14228 Early Intel Pentium 4 CPUs with Intel 64 support,
14229 prior to the introduction of Pentium 4 G1 step in December 2005,
14230 lacked the @code{LAHF} and @code{SAHF} instructions
14231 which were supported by AMD64.
14232 These are load and store instructions, respectively, for certain status flags.
14233 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
14234 @code{drem}, and @code{remainder} built-in functions;
14235 see @ref{Other Builtins} for details.
14237 @item -mmovbe
14238 @opindex mmovbe
14239 This option enables use of the @code{movbe} instruction to implement
14240 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
14242 @item -mcrc32
14243 @opindex mcrc32
14244 This option enables built-in functions @code{__builtin_ia32_crc32qi},
14245 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
14246 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
14248 @item -mrecip
14249 @opindex mrecip
14250 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
14251 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
14252 with an additional Newton-Raphson step
14253 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
14254 (and their vectorized
14255 variants) for single-precision floating-point arguments.  These instructions
14256 are generated only when @option{-funsafe-math-optimizations} is enabled
14257 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
14258 Note that while the throughput of the sequence is higher than the throughput
14259 of the non-reciprocal instruction, the precision of the sequence can be
14260 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
14262 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
14263 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
14264 combination), and doesn't need @option{-mrecip}.
14266 Also note that GCC emits the above sequence with additional Newton-Raphson step
14267 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
14268 already with @option{-ffast-math} (or the above option combination), and
14269 doesn't need @option{-mrecip}.
14271 @item -mrecip=@var{opt}
14272 @opindex mrecip=opt
14273 This option controls which reciprocal estimate instructions
14274 may be used.  @var{opt} is a comma-separated list of options, which may
14275 be preceded by a @samp{!} to invert the option:
14277 @table @samp
14278 @item all
14279 Enable all estimate instructions.
14281 @item default
14282 Enable the default instructions, equivalent to @option{-mrecip}.
14284 @item none
14285 Disable all estimate instructions, equivalent to @option{-mno-recip}.
14287 @item div
14288 Enable the approximation for scalar division.
14290 @item vec-div
14291 Enable the approximation for vectorized division.
14293 @item sqrt
14294 Enable the approximation for scalar square root.
14296 @item vec-sqrt
14297 Enable the approximation for vectorized square root.
14298 @end table
14300 So, for example, @option{-mrecip=all,!sqrt} enables
14301 all of the reciprocal approximations, except for square root.
14303 @item -mveclibabi=@var{type}
14304 @opindex mveclibabi
14305 Specifies the ABI type to use for vectorizing intrinsics using an
14306 external library.  Supported values for @var{type} are @samp{svml} 
14307 for the Intel short
14308 vector math library and @samp{acml} for the AMD math core library.
14309 To use this option, both @option{-ftree-vectorize} and
14310 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
14311 ABI-compatible library must be specified at link time.
14313 GCC currently emits calls to @code{vmldExp2},
14314 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
14315 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
14316 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
14317 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
14318 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
14319 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
14320 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
14321 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
14322 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
14323 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
14324 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
14325 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
14326 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
14327 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
14328 when @option{-mveclibabi=acml} is used.  
14330 @item -mabi=@var{name}
14331 @opindex mabi
14332 Generate code for the specified calling convention.  Permissible values
14333 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
14334 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
14335 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
14336 You can control this behavior for a specific function by
14337 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
14338 @xref{Function Attributes}.
14340 @item -mtls-dialect=@var{type}
14341 @opindex mtls-dialect
14342 Generate code to access thread-local storage using the @samp{gnu} or
14343 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
14344 @samp{gnu2} is more efficient, but it may add compile- and run-time
14345 requirements that cannot be satisfied on all systems.
14347 @item -mpush-args
14348 @itemx -mno-push-args
14349 @opindex mpush-args
14350 @opindex mno-push-args
14351 Use PUSH operations to store outgoing parameters.  This method is shorter
14352 and usually equally fast as method using SUB/MOV operations and is enabled
14353 by default.  In some cases disabling it may improve performance because of
14354 improved scheduling and reduced dependencies.
14356 @item -maccumulate-outgoing-args
14357 @opindex maccumulate-outgoing-args
14358 If enabled, the maximum amount of space required for outgoing arguments is
14359 computed in the function prologue.  This is faster on most modern CPUs
14360 because of reduced dependencies, improved scheduling and reduced stack usage
14361 when the preferred stack boundary is not equal to 2.  The drawback is a notable
14362 increase in code size.  This switch implies @option{-mno-push-args}.
14364 @item -mthreads
14365 @opindex mthreads
14366 Support thread-safe exception handling on MinGW.  Programs that rely
14367 on thread-safe exception handling must compile and link all code with the
14368 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
14369 @code{-D_MT}; when linking, it links in a special thread helper library
14370 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
14372 @item -mno-align-stringops
14373 @opindex mno-align-stringops
14374 Do not align the destination of inlined string operations.  This switch reduces
14375 code size and improves performance in case the destination is already aligned,
14376 but GCC doesn't know about it.
14378 @item -minline-all-stringops
14379 @opindex minline-all-stringops
14380 By default GCC inlines string operations only when the destination is 
14381 known to be aligned to least a 4-byte boundary.  
14382 This enables more inlining and increases code
14383 size, but may improve performance of code that depends on fast
14384 @code{memcpy}, @code{strlen},
14385 and @code{memset} for short lengths.
14387 @item -minline-stringops-dynamically
14388 @opindex minline-stringops-dynamically
14389 For string operations of unknown size, use run-time checks with
14390 inline code for small blocks and a library call for large blocks.
14392 @item -mstringop-strategy=@var{alg}
14393 @opindex mstringop-strategy=@var{alg}
14394 Override the internal decision heuristic for the particular algorithm to use
14395 for inlining string operations.  The allowed values for @var{alg} are:
14397 @table @samp
14398 @item rep_byte
14399 @itemx rep_4byte
14400 @itemx rep_8byte
14401 Expand using i386 @code{rep} prefix of the specified size.
14403 @item byte_loop
14404 @itemx loop
14405 @itemx unrolled_loop
14406 Expand into an inline loop.
14408 @item libcall
14409 Always use a library call.
14410 @end table
14412 @item -momit-leaf-frame-pointer
14413 @opindex momit-leaf-frame-pointer
14414 Don't keep the frame pointer in a register for leaf functions.  This
14415 avoids the instructions to save, set up, and restore frame pointers and
14416 makes an extra register available in leaf functions.  The option
14417 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
14418 which might make debugging harder.
14420 @item -mtls-direct-seg-refs
14421 @itemx -mno-tls-direct-seg-refs
14422 @opindex mtls-direct-seg-refs
14423 Controls whether TLS variables may be accessed with offsets from the
14424 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
14425 or whether the thread base pointer must be added.  Whether or not this
14426 is valid depends on the operating system, and whether it maps the
14427 segment to cover the entire TLS area.
14429 For systems that use the GNU C Library, the default is on.
14431 @item -msse2avx
14432 @itemx -mno-sse2avx
14433 @opindex msse2avx
14434 Specify that the assembler should encode SSE instructions with VEX
14435 prefix.  The option @option{-mavx} turns this on by default.
14437 @item -mfentry
14438 @itemx -mno-fentry
14439 @opindex mfentry
14440 If profiling is active (@option{-pg}), put the profiling
14441 counter call before the prologue.
14442 Note: On x86 architectures the attribute @code{ms_hook_prologue}
14443 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
14445 @item -m8bit-idiv
14446 @itemx -mno-8bit-idiv
14447 @opindex 8bit-idiv
14448 On some processors, like Intel Atom, 8-bit unsigned integer divide is
14449 much faster than 32-bit/64-bit integer divide.  This option generates a
14450 run-time check.  If both dividend and divisor are within range of 0
14451 to 255, 8-bit unsigned integer divide is used instead of
14452 32-bit/64-bit integer divide.
14454 @item -mavx256-split-unaligned-load
14455 @itemx -mavx256-split-unaligned-store
14456 @opindex avx256-split-unaligned-load
14457 @opindex avx256-split-unaligned-store
14458 Split 32-byte AVX unaligned load and store.
14460 @end table
14462 These @samp{-m} switches are supported in addition to the above
14463 on x86-64 processors in 64-bit environments.
14465 @table @gcctabopt
14466 @item -m32
14467 @itemx -m64
14468 @itemx -mx32
14469 @opindex m32
14470 @opindex m64
14471 @opindex mx32
14472 Generate code for a 32-bit or 64-bit environment.
14473 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
14474 to 32 bits, and
14475 generates code that runs on any i386 system.
14477 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
14478 types to 64 bits, and generates code for the x86-64 architecture.
14479 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
14480 and @option{-mdynamic-no-pic} options.
14482 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
14483 to 32 bits, and
14484 generates code for the x86-64 architecture.
14486 @item -mno-red-zone
14487 @opindex mno-red-zone
14488 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
14489 by the x86-64 ABI; it is a 128-byte area beyond the location of the
14490 stack pointer that is not modified by signal or interrupt handlers
14491 and therefore can be used for temporary data without adjusting the stack
14492 pointer.  The flag @option{-mno-red-zone} disables this red zone.
14494 @item -mcmodel=small
14495 @opindex mcmodel=small
14496 Generate code for the small code model: the program and its symbols must
14497 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
14498 Programs can be statically or dynamically linked.  This is the default
14499 code model.
14501 @item -mcmodel=kernel
14502 @opindex mcmodel=kernel
14503 Generate code for the kernel code model.  The kernel runs in the
14504 negative 2 GB of the address space.
14505 This model has to be used for Linux kernel code.
14507 @item -mcmodel=medium
14508 @opindex mcmodel=medium
14509 Generate code for the medium model: the program is linked in the lower 2
14510 GB of the address space.  Small symbols are also placed there.  Symbols
14511 with sizes larger than @option{-mlarge-data-threshold} are put into
14512 large data or BSS sections and can be located above 2GB.  Programs can
14513 be statically or dynamically linked.
14515 @item -mcmodel=large
14516 @opindex mcmodel=large
14517 Generate code for the large model.  This model makes no assumptions
14518 about addresses and sizes of sections.
14520 @item -maddress-mode=long
14521 @opindex maddress-mode=long
14522 Generate code for long address mode.  This is only supported for 64-bit
14523 and x32 environments.  It is the default address mode for 64-bit
14524 environments.
14526 @item -maddress-mode=short
14527 @opindex maddress-mode=short
14528 Generate code for short address mode.  This is only supported for 32-bit
14529 and x32 environments.  It is the default address mode for 32-bit and
14530 x32 environments.
14531 @end table
14533 @node i386 and x86-64 Windows Options
14534 @subsection i386 and x86-64 Windows Options
14535 @cindex i386 and x86-64 Windows Options
14537 These additional options are available for Microsoft Windows targets:
14539 @table @gcctabopt
14540 @item -mconsole
14541 @opindex mconsole
14542 This option
14543 specifies that a console application is to be generated, by
14544 instructing the linker to set the PE header subsystem type
14545 required for console applications.
14546 This option is available for Cygwin and MinGW targets and is
14547 enabled by default on those targets.
14549 @item -mdll
14550 @opindex mdll
14551 This option is available for Cygwin and MinGW targets.  It
14552 specifies that a DLL---a dynamic link library---is to be
14553 generated, enabling the selection of the required runtime
14554 startup object and entry point.
14556 @item -mnop-fun-dllimport
14557 @opindex mnop-fun-dllimport
14558 This option is available for Cygwin and MinGW targets.  It
14559 specifies that the @code{dllimport} attribute should be ignored.
14561 @item -mthread
14562 @opindex mthread
14563 This option is available for MinGW targets. It specifies
14564 that MinGW-specific thread support is to be used.
14566 @item -municode
14567 @opindex municode
14568 This option is available for MinGW-w64 targets.  It causes
14569 the @code{UNICODE} preprocessor macro to be predefined, and
14570 chooses Unicode-capable runtime startup code.
14572 @item -mwin32
14573 @opindex mwin32
14574 This option is available for Cygwin and MinGW targets.  It
14575 specifies that the typical Microsoft Windows predefined macros are to
14576 be set in the pre-processor, but does not influence the choice
14577 of runtime library/startup code.
14579 @item -mwindows
14580 @opindex mwindows
14581 This option is available for Cygwin and MinGW targets.  It
14582 specifies that a GUI application is to be generated by
14583 instructing the linker to set the PE header subsystem type
14584 appropriately.
14586 @item -fno-set-stack-executable
14587 @opindex fno-set-stack-executable
14588 This option is available for MinGW targets. It specifies that
14589 the executable flag for the stack used by nested functions isn't
14590 set. This is necessary for binaries running in kernel mode of
14591 Microsoft Windows, as there the User32 API, which is used to set executable
14592 privileges, isn't available.
14594 @item -fwritable-relocated-rdata
14595 @opindex fno-writable-relocated-rdata
14596 This option is available for MinGW and Cygwin targets.  It specifies
14597 that relocated-data in read-only section is put into .data
14598 section.  This is a necessary for older runtimes not supporting
14599 modification of .rdata sections for pseudo-relocation.
14601 @item -mpe-aligned-commons
14602 @opindex mpe-aligned-commons
14603 This option is available for Cygwin and MinGW targets.  It
14604 specifies that the GNU extension to the PE file format that
14605 permits the correct alignment of COMMON variables should be
14606 used when generating code.  It is enabled by default if
14607 GCC detects that the target assembler found during configuration
14608 supports the feature.
14609 @end table
14611 See also under @ref{i386 and x86-64 Options} for standard options.
14613 @node IA-64 Options
14614 @subsection IA-64 Options
14615 @cindex IA-64 Options
14617 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14619 @table @gcctabopt
14620 @item -mbig-endian
14621 @opindex mbig-endian
14622 Generate code for a big-endian target.  This is the default for HP-UX@.
14624 @item -mlittle-endian
14625 @opindex mlittle-endian
14626 Generate code for a little-endian target.  This is the default for AIX5
14627 and GNU/Linux.
14629 @item -mgnu-as
14630 @itemx -mno-gnu-as
14631 @opindex mgnu-as
14632 @opindex mno-gnu-as
14633 Generate (or don't) code for the GNU assembler.  This is the default.
14634 @c Also, this is the default if the configure option @option{--with-gnu-as}
14635 @c is used.
14637 @item -mgnu-ld
14638 @itemx -mno-gnu-ld
14639 @opindex mgnu-ld
14640 @opindex mno-gnu-ld
14641 Generate (or don't) code for the GNU linker.  This is the default.
14642 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14643 @c is used.
14645 @item -mno-pic
14646 @opindex mno-pic
14647 Generate code that does not use a global pointer register.  The result
14648 is not position independent code, and violates the IA-64 ABI@.
14650 @item -mvolatile-asm-stop
14651 @itemx -mno-volatile-asm-stop
14652 @opindex mvolatile-asm-stop
14653 @opindex mno-volatile-asm-stop
14654 Generate (or don't) a stop bit immediately before and after volatile asm
14655 statements.
14657 @item -mregister-names
14658 @itemx -mno-register-names
14659 @opindex mregister-names
14660 @opindex mno-register-names
14661 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14662 the stacked registers.  This may make assembler output more readable.
14664 @item -mno-sdata
14665 @itemx -msdata
14666 @opindex mno-sdata
14667 @opindex msdata
14668 Disable (or enable) optimizations that use the small data section.  This may
14669 be useful for working around optimizer bugs.
14671 @item -mconstant-gp
14672 @opindex mconstant-gp
14673 Generate code that uses a single constant global pointer value.  This is
14674 useful when compiling kernel code.
14676 @item -mauto-pic
14677 @opindex mauto-pic
14678 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
14679 This is useful when compiling firmware code.
14681 @item -minline-float-divide-min-latency
14682 @opindex minline-float-divide-min-latency
14683 Generate code for inline divides of floating-point values
14684 using the minimum latency algorithm.
14686 @item -minline-float-divide-max-throughput
14687 @opindex minline-float-divide-max-throughput
14688 Generate code for inline divides of floating-point values
14689 using the maximum throughput algorithm.
14691 @item -mno-inline-float-divide
14692 @opindex mno-inline-float-divide
14693 Do not generate inline code for divides of floating-point values.
14695 @item -minline-int-divide-min-latency
14696 @opindex minline-int-divide-min-latency
14697 Generate code for inline divides of integer values
14698 using the minimum latency algorithm.
14700 @item -minline-int-divide-max-throughput
14701 @opindex minline-int-divide-max-throughput
14702 Generate code for inline divides of integer values
14703 using the maximum throughput algorithm.
14705 @item -mno-inline-int-divide
14706 @opindex mno-inline-int-divide
14707 Do not generate inline code for divides of integer values.
14709 @item -minline-sqrt-min-latency
14710 @opindex minline-sqrt-min-latency
14711 Generate code for inline square roots
14712 using the minimum latency algorithm.
14714 @item -minline-sqrt-max-throughput
14715 @opindex minline-sqrt-max-throughput
14716 Generate code for inline square roots
14717 using the maximum throughput algorithm.
14719 @item -mno-inline-sqrt
14720 @opindex mno-inline-sqrt
14721 Do not generate inline code for @code{sqrt}.
14723 @item -mfused-madd
14724 @itemx -mno-fused-madd
14725 @opindex mfused-madd
14726 @opindex mno-fused-madd
14727 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14728 instructions.  The default is to use these instructions.
14730 @item -mno-dwarf2-asm
14731 @itemx -mdwarf2-asm
14732 @opindex mno-dwarf2-asm
14733 @opindex mdwarf2-asm
14734 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14735 info.  This may be useful when not using the GNU assembler.
14737 @item -mearly-stop-bits
14738 @itemx -mno-early-stop-bits
14739 @opindex mearly-stop-bits
14740 @opindex mno-early-stop-bits
14741 Allow stop bits to be placed earlier than immediately preceding the
14742 instruction that triggered the stop bit.  This can improve instruction
14743 scheduling, but does not always do so.
14745 @item -mfixed-range=@var{register-range}
14746 @opindex mfixed-range
14747 Generate code treating the given register range as fixed registers.
14748 A fixed register is one that the register allocator cannot use.  This is
14749 useful when compiling kernel code.  A register range is specified as
14750 two registers separated by a dash.  Multiple register ranges can be
14751 specified separated by a comma.
14753 @item -mtls-size=@var{tls-size}
14754 @opindex mtls-size
14755 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
14758 @item -mtune=@var{cpu-type}
14759 @opindex mtune
14760 Tune the instruction scheduling for a particular CPU, Valid values are
14761 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
14762 and @samp{mckinley}.
14764 @item -milp32
14765 @itemx -mlp64
14766 @opindex milp32
14767 @opindex mlp64
14768 Generate code for a 32-bit or 64-bit environment.
14769 The 32-bit environment sets int, long and pointer to 32 bits.
14770 The 64-bit environment sets int to 32 bits and long and pointer
14771 to 64 bits.  These are HP-UX specific flags.
14773 @item -mno-sched-br-data-spec
14774 @itemx -msched-br-data-spec
14775 @opindex mno-sched-br-data-spec
14776 @opindex msched-br-data-spec
14777 (Dis/En)able data speculative scheduling before reload.
14778 This results in generation of @code{ld.a} instructions and
14779 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14780 The default is 'disable'.
14782 @item -msched-ar-data-spec
14783 @itemx -mno-sched-ar-data-spec
14784 @opindex msched-ar-data-spec
14785 @opindex mno-sched-ar-data-spec
14786 (En/Dis)able data speculative scheduling after reload.
14787 This results in generation of @code{ld.a} instructions and
14788 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14789 The default is 'enable'.
14791 @item -mno-sched-control-spec
14792 @itemx -msched-control-spec
14793 @opindex mno-sched-control-spec
14794 @opindex msched-control-spec
14795 (Dis/En)able control speculative scheduling.  This feature is
14796 available only during region scheduling (i.e.@: before reload).
14797 This results in generation of the @code{ld.s} instructions and
14798 the corresponding check instructions @code{chk.s}.
14799 The default is 'disable'.
14801 @item -msched-br-in-data-spec
14802 @itemx -mno-sched-br-in-data-spec
14803 @opindex msched-br-in-data-spec
14804 @opindex mno-sched-br-in-data-spec
14805 (En/Dis)able speculative scheduling of the instructions that
14806 are dependent on the data speculative loads before reload.
14807 This is effective only with @option{-msched-br-data-spec} enabled.
14808 The default is 'enable'.
14810 @item -msched-ar-in-data-spec
14811 @itemx -mno-sched-ar-in-data-spec
14812 @opindex msched-ar-in-data-spec
14813 @opindex mno-sched-ar-in-data-spec
14814 (En/Dis)able speculative scheduling of the instructions that
14815 are dependent on the data speculative loads after reload.
14816 This is effective only with @option{-msched-ar-data-spec} enabled.
14817 The default is 'enable'.
14819 @item -msched-in-control-spec
14820 @itemx -mno-sched-in-control-spec
14821 @opindex msched-in-control-spec
14822 @opindex mno-sched-in-control-spec
14823 (En/Dis)able speculative scheduling of the instructions that
14824 are dependent on the control speculative loads.
14825 This is effective only with @option{-msched-control-spec} enabled.
14826 The default is 'enable'.
14828 @item -mno-sched-prefer-non-data-spec-insns
14829 @itemx -msched-prefer-non-data-spec-insns
14830 @opindex mno-sched-prefer-non-data-spec-insns
14831 @opindex msched-prefer-non-data-spec-insns
14832 If enabled, data-speculative instructions are chosen for schedule
14833 only if there are no other choices at the moment.  This makes
14834 the use of the data speculation much more conservative.
14835 The default is 'disable'.
14837 @item -mno-sched-prefer-non-control-spec-insns
14838 @itemx -msched-prefer-non-control-spec-insns
14839 @opindex mno-sched-prefer-non-control-spec-insns
14840 @opindex msched-prefer-non-control-spec-insns
14841 If enabled, control-speculative instructions are chosen for schedule
14842 only if there are no other choices at the moment.  This makes
14843 the use of the control speculation much more conservative.
14844 The default is 'disable'.
14846 @item -mno-sched-count-spec-in-critical-path
14847 @itemx -msched-count-spec-in-critical-path
14848 @opindex mno-sched-count-spec-in-critical-path
14849 @opindex msched-count-spec-in-critical-path
14850 If enabled, speculative dependencies are considered during
14851 computation of the instructions priorities.  This makes the use of the
14852 speculation a bit more conservative.
14853 The default is 'disable'.
14855 @item -msched-spec-ldc
14856 @opindex msched-spec-ldc
14857 Use a simple data speculation check.  This option is on by default.
14859 @item -msched-control-spec-ldc
14860 @opindex msched-spec-ldc
14861 Use a simple check for control speculation.  This option is on by default.
14863 @item -msched-stop-bits-after-every-cycle
14864 @opindex msched-stop-bits-after-every-cycle
14865 Place a stop bit after every cycle when scheduling.  This option is on
14866 by default.
14868 @item -msched-fp-mem-deps-zero-cost
14869 @opindex msched-fp-mem-deps-zero-cost
14870 Assume that floating-point stores and loads are not likely to cause a conflict
14871 when placed into the same instruction group.  This option is disabled by
14872 default.
14874 @item -msel-sched-dont-check-control-spec
14875 @opindex msel-sched-dont-check-control-spec
14876 Generate checks for control speculation in selective scheduling.
14877 This flag is disabled by default.
14879 @item -msched-max-memory-insns=@var{max-insns}
14880 @opindex msched-max-memory-insns
14881 Limit on the number of memory insns per instruction group, giving lower
14882 priority to subsequent memory insns attempting to schedule in the same
14883 instruction group. Frequently useful to prevent cache bank conflicts.
14884 The default value is 1.
14886 @item -msched-max-memory-insns-hard-limit
14887 @opindex msched-max-memory-insns-hard-limit
14888 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
14889 disallowing more than that number in an instruction group.
14890 Otherwise, the limit is ``soft'', meaning that non-memory operations
14891 are preferred when the limit is reached, but memory operations may still
14892 be scheduled.
14894 @end table
14896 @node LM32 Options
14897 @subsection LM32 Options
14898 @cindex LM32 options
14900 These @option{-m} options are defined for the LatticeMico32 architecture:
14902 @table @gcctabopt
14903 @item -mbarrel-shift-enabled
14904 @opindex mbarrel-shift-enabled
14905 Enable barrel-shift instructions.
14907 @item -mdivide-enabled
14908 @opindex mdivide-enabled
14909 Enable divide and modulus instructions.
14911 @item -mmultiply-enabled
14912 @opindex multiply-enabled
14913 Enable multiply instructions.
14915 @item -msign-extend-enabled
14916 @opindex msign-extend-enabled
14917 Enable sign extend instructions.
14919 @item -muser-enabled
14920 @opindex muser-enabled
14921 Enable user-defined instructions.
14923 @end table
14925 @node M32C Options
14926 @subsection M32C Options
14927 @cindex M32C options
14929 @table @gcctabopt
14930 @item -mcpu=@var{name}
14931 @opindex mcpu=
14932 Select the CPU for which code is generated.  @var{name} may be one of
14933 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
14934 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
14935 the M32C/80 series.
14937 @item -msim
14938 @opindex msim
14939 Specifies that the program will be run on the simulator.  This causes
14940 an alternate runtime library to be linked in which supports, for
14941 example, file I/O@.  You must not use this option when generating
14942 programs that will run on real hardware; you must provide your own
14943 runtime library for whatever I/O functions are needed.
14945 @item -memregs=@var{number}
14946 @opindex memregs=
14947 Specifies the number of memory-based pseudo-registers GCC uses
14948 during code generation.  These pseudo-registers are used like real
14949 registers, so there is a tradeoff between GCC's ability to fit the
14950 code into available registers, and the performance penalty of using
14951 memory instead of registers.  Note that all modules in a program must
14952 be compiled with the same value for this option.  Because of that, you
14953 must not use this option with GCC's default runtime libraries.
14955 @end table
14957 @node M32R/D Options
14958 @subsection M32R/D Options
14959 @cindex M32R/D options
14961 These @option{-m} options are defined for Renesas M32R/D architectures:
14963 @table @gcctabopt
14964 @item -m32r2
14965 @opindex m32r2
14966 Generate code for the M32R/2@.
14968 @item -m32rx
14969 @opindex m32rx
14970 Generate code for the M32R/X@.
14972 @item -m32r
14973 @opindex m32r
14974 Generate code for the M32R@.  This is the default.
14976 @item -mmodel=small
14977 @opindex mmodel=small
14978 Assume all objects live in the lower 16MB of memory (so that their addresses
14979 can be loaded with the @code{ld24} instruction), and assume all subroutines
14980 are reachable with the @code{bl} instruction.
14981 This is the default.
14983 The addressability of a particular object can be set with the
14984 @code{model} attribute.
14986 @item -mmodel=medium
14987 @opindex mmodel=medium
14988 Assume objects may be anywhere in the 32-bit address space (the compiler
14989 generates @code{seth/add3} instructions to load their addresses), and
14990 assume all subroutines are reachable with the @code{bl} instruction.
14992 @item -mmodel=large
14993 @opindex mmodel=large
14994 Assume objects may be anywhere in the 32-bit address space (the compiler
14995 generates @code{seth/add3} instructions to load their addresses), and
14996 assume subroutines may not be reachable with the @code{bl} instruction
14997 (the compiler generates the much slower @code{seth/add3/jl}
14998 instruction sequence).
15000 @item -msdata=none
15001 @opindex msdata=none
15002 Disable use of the small data area.  Variables are put into
15003 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
15004 @code{section} attribute has been specified).
15005 This is the default.
15007 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
15008 Objects may be explicitly put in the small data area with the
15009 @code{section} attribute using one of these sections.
15011 @item -msdata=sdata
15012 @opindex msdata=sdata
15013 Put small global and static data in the small data area, but do not
15014 generate special code to reference them.
15016 @item -msdata=use
15017 @opindex msdata=use
15018 Put small global and static data in the small data area, and generate
15019 special instructions to reference them.
15021 @item -G @var{num}
15022 @opindex G
15023 @cindex smaller data references
15024 Put global and static objects less than or equal to @var{num} bytes
15025 into the small data or BSS sections instead of the normal data or BSS
15026 sections.  The default value of @var{num} is 8.
15027 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
15028 for this option to have any effect.
15030 All modules should be compiled with the same @option{-G @var{num}} value.
15031 Compiling with different values of @var{num} may or may not work; if it
15032 doesn't the linker gives an error message---incorrect code is not
15033 generated.
15035 @item -mdebug
15036 @opindex mdebug
15037 Makes the M32R-specific code in the compiler display some statistics
15038 that might help in debugging programs.
15040 @item -malign-loops
15041 @opindex malign-loops
15042 Align all loops to a 32-byte boundary.
15044 @item -mno-align-loops
15045 @opindex mno-align-loops
15046 Do not enforce a 32-byte alignment for loops.  This is the default.
15048 @item -missue-rate=@var{number}
15049 @opindex missue-rate=@var{number}
15050 Issue @var{number} instructions per cycle.  @var{number} can only be 1
15051 or 2.
15053 @item -mbranch-cost=@var{number}
15054 @opindex mbranch-cost=@var{number}
15055 @var{number} can only be 1 or 2.  If it is 1 then branches are
15056 preferred over conditional code, if it is 2, then the opposite applies.
15058 @item -mflush-trap=@var{number}
15059 @opindex mflush-trap=@var{number}
15060 Specifies the trap number to use to flush the cache.  The default is
15061 12.  Valid numbers are between 0 and 15 inclusive.
15063 @item -mno-flush-trap
15064 @opindex mno-flush-trap
15065 Specifies that the cache cannot be flushed by using a trap.
15067 @item -mflush-func=@var{name}
15068 @opindex mflush-func=@var{name}
15069 Specifies the name of the operating system function to call to flush
15070 the cache.  The default is @emph{_flush_cache}, but a function call
15071 is only used if a trap is not available.
15073 @item -mno-flush-func
15074 @opindex mno-flush-func
15075 Indicates that there is no OS function for flushing the cache.
15077 @end table
15079 @node M680x0 Options
15080 @subsection M680x0 Options
15081 @cindex M680x0 options
15083 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
15084 The default settings depend on which architecture was selected when
15085 the compiler was configured; the defaults for the most common choices
15086 are given below.
15088 @table @gcctabopt
15089 @item -march=@var{arch}
15090 @opindex march
15091 Generate code for a specific M680x0 or ColdFire instruction set
15092 architecture.  Permissible values of @var{arch} for M680x0
15093 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
15094 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
15095 architectures are selected according to Freescale's ISA classification
15096 and the permissible values are: @samp{isaa}, @samp{isaaplus},
15097 @samp{isab} and @samp{isac}.
15099 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
15100 code for a ColdFire target.  The @var{arch} in this macro is one of the
15101 @option{-march} arguments given above.
15103 When used together, @option{-march} and @option{-mtune} select code
15104 that runs on a family of similar processors but that is optimized
15105 for a particular microarchitecture.
15107 @item -mcpu=@var{cpu}
15108 @opindex mcpu
15109 Generate code for a specific M680x0 or ColdFire processor.
15110 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
15111 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
15112 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
15113 below, which also classifies the CPUs into families:
15115 @multitable @columnfractions 0.20 0.80
15116 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
15117 @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}
15118 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
15119 @item @samp{5206e} @tab @samp{5206e}
15120 @item @samp{5208} @tab @samp{5207} @samp{5208}
15121 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
15122 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
15123 @item @samp{5216} @tab @samp{5214} @samp{5216}
15124 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
15125 @item @samp{5225} @tab @samp{5224} @samp{5225}
15126 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
15127 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
15128 @item @samp{5249} @tab @samp{5249}
15129 @item @samp{5250} @tab @samp{5250}
15130 @item @samp{5271} @tab @samp{5270} @samp{5271}
15131 @item @samp{5272} @tab @samp{5272}
15132 @item @samp{5275} @tab @samp{5274} @samp{5275}
15133 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
15134 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
15135 @item @samp{5307} @tab @samp{5307}
15136 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
15137 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
15138 @item @samp{5407} @tab @samp{5407}
15139 @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}
15140 @end multitable
15142 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
15143 @var{arch} is compatible with @var{cpu}.  Other combinations of
15144 @option{-mcpu} and @option{-march} are rejected.
15146 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
15147 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
15148 where the value of @var{family} is given by the table above.
15150 @item -mtune=@var{tune}
15151 @opindex mtune
15152 Tune the code for a particular microarchitecture within the
15153 constraints set by @option{-march} and @option{-mcpu}.
15154 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
15155 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
15156 and @samp{cpu32}.  The ColdFire microarchitectures
15157 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
15159 You can also use @option{-mtune=68020-40} for code that needs
15160 to run relatively well on 68020, 68030 and 68040 targets.
15161 @option{-mtune=68020-60} is similar but includes 68060 targets
15162 as well.  These two options select the same tuning decisions as
15163 @option{-m68020-40} and @option{-m68020-60} respectively.
15165 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
15166 when tuning for 680x0 architecture @var{arch}.  It also defines
15167 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
15168 option is used.  If GCC is tuning for a range of architectures,
15169 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
15170 it defines the macros for every architecture in the range.
15172 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
15173 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
15174 of the arguments given above.
15176 @item -m68000
15177 @itemx -mc68000
15178 @opindex m68000
15179 @opindex mc68000
15180 Generate output for a 68000.  This is the default
15181 when the compiler is configured for 68000-based systems.
15182 It is equivalent to @option{-march=68000}.
15184 Use this option for microcontrollers with a 68000 or EC000 core,
15185 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
15187 @item -m68010
15188 @opindex m68010
15189 Generate output for a 68010.  This is the default
15190 when the compiler is configured for 68010-based systems.
15191 It is equivalent to @option{-march=68010}.
15193 @item -m68020
15194 @itemx -mc68020
15195 @opindex m68020
15196 @opindex mc68020
15197 Generate output for a 68020.  This is the default
15198 when the compiler is configured for 68020-based systems.
15199 It is equivalent to @option{-march=68020}.
15201 @item -m68030
15202 @opindex m68030
15203 Generate output for a 68030.  This is the default when the compiler is
15204 configured for 68030-based systems.  It is equivalent to
15205 @option{-march=68030}.
15207 @item -m68040
15208 @opindex m68040
15209 Generate output for a 68040.  This is the default when the compiler is
15210 configured for 68040-based systems.  It is equivalent to
15211 @option{-march=68040}.
15213 This option inhibits the use of 68881/68882 instructions that have to be
15214 emulated by software on the 68040.  Use this option if your 68040 does not
15215 have code to emulate those instructions.
15217 @item -m68060
15218 @opindex m68060
15219 Generate output for a 68060.  This is the default when the compiler is
15220 configured for 68060-based systems.  It is equivalent to
15221 @option{-march=68060}.
15223 This option inhibits the use of 68020 and 68881/68882 instructions that
15224 have to be emulated by software on the 68060.  Use this option if your 68060
15225 does not have code to emulate those instructions.
15227 @item -mcpu32
15228 @opindex mcpu32
15229 Generate output for a CPU32.  This is the default
15230 when the compiler is configured for CPU32-based systems.
15231 It is equivalent to @option{-march=cpu32}.
15233 Use this option for microcontrollers with a
15234 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
15235 68336, 68340, 68341, 68349 and 68360.
15237 @item -m5200
15238 @opindex m5200
15239 Generate output for a 520X ColdFire CPU@.  This is the default
15240 when the compiler is configured for 520X-based systems.
15241 It is equivalent to @option{-mcpu=5206}, and is now deprecated
15242 in favor of that option.
15244 Use this option for microcontroller with a 5200 core, including
15245 the MCF5202, MCF5203, MCF5204 and MCF5206.
15247 @item -m5206e
15248 @opindex m5206e
15249 Generate output for a 5206e ColdFire CPU@.  The option is now
15250 deprecated in favor of the equivalent @option{-mcpu=5206e}.
15252 @item -m528x
15253 @opindex m528x
15254 Generate output for a member of the ColdFire 528X family.
15255 The option is now deprecated in favor of the equivalent
15256 @option{-mcpu=528x}.
15258 @item -m5307
15259 @opindex m5307
15260 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
15261 in favor of the equivalent @option{-mcpu=5307}.
15263 @item -m5407
15264 @opindex m5407
15265 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
15266 in favor of the equivalent @option{-mcpu=5407}.
15268 @item -mcfv4e
15269 @opindex mcfv4e
15270 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
15271 This includes use of hardware floating-point instructions.
15272 The option is equivalent to @option{-mcpu=547x}, and is now
15273 deprecated in favor of that option.
15275 @item -m68020-40
15276 @opindex m68020-40
15277 Generate output for a 68040, without using any of the new instructions.
15278 This results in code that can run relatively efficiently on either a
15279 68020/68881 or a 68030 or a 68040.  The generated code does use the
15280 68881 instructions that are emulated on the 68040.
15282 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
15284 @item -m68020-60
15285 @opindex m68020-60
15286 Generate output for a 68060, without using any of the new instructions.
15287 This results in code that can run relatively efficiently on either a
15288 68020/68881 or a 68030 or a 68040.  The generated code does use the
15289 68881 instructions that are emulated on the 68060.
15291 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
15293 @item -mhard-float
15294 @itemx -m68881
15295 @opindex mhard-float
15296 @opindex m68881
15297 Generate floating-point instructions.  This is the default for 68020
15298 and above, and for ColdFire devices that have an FPU@.  It defines the
15299 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
15300 on ColdFire targets.
15302 @item -msoft-float
15303 @opindex msoft-float
15304 Do not generate floating-point instructions; use library calls instead.
15305 This is the default for 68000, 68010, and 68832 targets.  It is also
15306 the default for ColdFire devices that have no FPU.
15308 @item -mdiv
15309 @itemx -mno-div
15310 @opindex mdiv
15311 @opindex mno-div
15312 Generate (do not generate) ColdFire hardware divide and remainder
15313 instructions.  If @option{-march} is used without @option{-mcpu},
15314 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
15315 architectures.  Otherwise, the default is taken from the target CPU
15316 (either the default CPU, or the one specified by @option{-mcpu}).  For
15317 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
15318 @option{-mcpu=5206e}.
15320 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
15322 @item -mshort
15323 @opindex mshort
15324 Consider type @code{int} to be 16 bits wide, like @code{short int}.
15325 Additionally, parameters passed on the stack are also aligned to a
15326 16-bit boundary even on targets whose API mandates promotion to 32-bit.
15328 @item -mno-short
15329 @opindex mno-short
15330 Do not consider type @code{int} to be 16 bits wide.  This is the default.
15332 @item -mnobitfield
15333 @itemx -mno-bitfield
15334 @opindex mnobitfield
15335 @opindex mno-bitfield
15336 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
15337 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
15339 @item -mbitfield
15340 @opindex mbitfield
15341 Do use the bit-field instructions.  The @option{-m68020} option implies
15342 @option{-mbitfield}.  This is the default if you use a configuration
15343 designed for a 68020.
15345 @item -mrtd
15346 @opindex mrtd
15347 Use a different function-calling convention, in which functions
15348 that take a fixed number of arguments return with the @code{rtd}
15349 instruction, which pops their arguments while returning.  This
15350 saves one instruction in the caller since there is no need to pop
15351 the arguments there.
15353 This calling convention is incompatible with the one normally
15354 used on Unix, so you cannot use it if you need to call libraries
15355 compiled with the Unix compiler.
15357 Also, you must provide function prototypes for all functions that
15358 take variable numbers of arguments (including @code{printf});
15359 otherwise incorrect code is generated for calls to those
15360 functions.
15362 In addition, seriously incorrect code results if you call a
15363 function with too many arguments.  (Normally, extra arguments are
15364 harmlessly ignored.)
15366 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
15367 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
15369 @item -mno-rtd
15370 @opindex mno-rtd
15371 Do not use the calling conventions selected by @option{-mrtd}.
15372 This is the default.
15374 @item -malign-int
15375 @itemx -mno-align-int
15376 @opindex malign-int
15377 @opindex mno-align-int
15378 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
15379 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
15380 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
15381 Aligning variables on 32-bit boundaries produces code that runs somewhat
15382 faster on processors with 32-bit busses at the expense of more memory.
15384 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
15385 aligns structures containing the above types differently than
15386 most published application binary interface specifications for the m68k.
15388 @item -mpcrel
15389 @opindex mpcrel
15390 Use the pc-relative addressing mode of the 68000 directly, instead of
15391 using a global offset table.  At present, this option implies @option{-fpic},
15392 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
15393 not presently supported with @option{-mpcrel}, though this could be supported for
15394 68020 and higher processors.
15396 @item -mno-strict-align
15397 @itemx -mstrict-align
15398 @opindex mno-strict-align
15399 @opindex mstrict-align
15400 Do not (do) assume that unaligned memory references are handled by
15401 the system.
15403 @item -msep-data
15404 Generate code that allows the data segment to be located in a different
15405 area of memory from the text segment.  This allows for execute-in-place in
15406 an environment without virtual memory management.  This option implies
15407 @option{-fPIC}.
15409 @item -mno-sep-data
15410 Generate code that assumes that the data segment follows the text segment.
15411 This is the default.
15413 @item -mid-shared-library
15414 Generate code that supports shared libraries via the library ID method.
15415 This allows for execute-in-place and shared libraries in an environment
15416 without virtual memory management.  This option implies @option{-fPIC}.
15418 @item -mno-id-shared-library
15419 Generate code that doesn't assume ID-based shared libraries are being used.
15420 This is the default.
15422 @item -mshared-library-id=n
15423 Specifies the identification number of the ID-based shared library being
15424 compiled.  Specifying a value of 0 generates more compact code; specifying
15425 other values forces the allocation of that number to the current
15426 library, but is no more space- or time-efficient than omitting this option.
15428 @item -mxgot
15429 @itemx -mno-xgot
15430 @opindex mxgot
15431 @opindex mno-xgot
15432 When generating position-independent code for ColdFire, generate code
15433 that works if the GOT has more than 8192 entries.  This code is
15434 larger and slower than code generated without this option.  On M680x0
15435 processors, this option is not needed; @option{-fPIC} suffices.
15437 GCC normally uses a single instruction to load values from the GOT@.
15438 While this is relatively efficient, it only works if the GOT
15439 is smaller than about 64k.  Anything larger causes the linker
15440 to report an error such as:
15442 @cindex relocation truncated to fit (ColdFire)
15443 @smallexample
15444 relocation truncated to fit: R_68K_GOT16O foobar
15445 @end smallexample
15447 If this happens, you should recompile your code with @option{-mxgot}.
15448 It should then work with very large GOTs.  However, code generated with
15449 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
15450 the value of a global symbol.
15452 Note that some linkers, including newer versions of the GNU linker,
15453 can create multiple GOTs and sort GOT entries.  If you have such a linker,
15454 you should only need to use @option{-mxgot} when compiling a single
15455 object file that accesses more than 8192 GOT entries.  Very few do.
15457 These options have no effect unless GCC is generating
15458 position-independent code.
15460 @end table
15462 @node MCore Options
15463 @subsection MCore Options
15464 @cindex MCore options
15466 These are the @samp{-m} options defined for the Motorola M*Core
15467 processors.
15469 @table @gcctabopt
15471 @item -mhardlit
15472 @itemx -mno-hardlit
15473 @opindex mhardlit
15474 @opindex mno-hardlit
15475 Inline constants into the code stream if it can be done in two
15476 instructions or less.
15478 @item -mdiv
15479 @itemx -mno-div
15480 @opindex mdiv
15481 @opindex mno-div
15482 Use the divide instruction.  (Enabled by default).
15484 @item -mrelax-immediate
15485 @itemx -mno-relax-immediate
15486 @opindex mrelax-immediate
15487 @opindex mno-relax-immediate
15488 Allow arbitrary-sized immediates in bit operations.
15490 @item -mwide-bitfields
15491 @itemx -mno-wide-bitfields
15492 @opindex mwide-bitfields
15493 @opindex mno-wide-bitfields
15494 Always treat bit-fields as @code{int}-sized.
15496 @item -m4byte-functions
15497 @itemx -mno-4byte-functions
15498 @opindex m4byte-functions
15499 @opindex mno-4byte-functions
15500 Force all functions to be aligned to a 4-byte boundary.
15502 @item -mcallgraph-data
15503 @itemx -mno-callgraph-data
15504 @opindex mcallgraph-data
15505 @opindex mno-callgraph-data
15506 Emit callgraph information.
15508 @item -mslow-bytes
15509 @itemx -mno-slow-bytes
15510 @opindex mslow-bytes
15511 @opindex mno-slow-bytes
15512 Prefer word access when reading byte quantities.
15514 @item -mlittle-endian
15515 @itemx -mbig-endian
15516 @opindex mlittle-endian
15517 @opindex mbig-endian
15518 Generate code for a little-endian target.
15520 @item -m210
15521 @itemx -m340
15522 @opindex m210
15523 @opindex m340
15524 Generate code for the 210 processor.
15526 @item -mno-lsim
15527 @opindex mno-lsim
15528 Assume that runtime support has been provided and so omit the
15529 simulator library (@file{libsim.a)} from the linker command line.
15531 @item -mstack-increment=@var{size}
15532 @opindex mstack-increment
15533 Set the maximum amount for a single stack increment operation.  Large
15534 values can increase the speed of programs that contain functions
15535 that need a large amount of stack space, but they can also trigger a
15536 segmentation fault if the stack is extended too much.  The default
15537 value is 0x1000.
15539 @end table
15541 @node MeP Options
15542 @subsection MeP Options
15543 @cindex MeP options
15545 @table @gcctabopt
15547 @item -mabsdiff
15548 @opindex mabsdiff
15549 Enables the @code{abs} instruction, which is the absolute difference
15550 between two registers.
15552 @item -mall-opts
15553 @opindex mall-opts
15554 Enables all the optional instructions---average, multiply, divide, bit
15555 operations, leading zero, absolute difference, min/max, clip, and
15556 saturation.
15559 @item -maverage
15560 @opindex maverage
15561 Enables the @code{ave} instruction, which computes the average of two
15562 registers.
15564 @item -mbased=@var{n}
15565 @opindex mbased=
15566 Variables of size @var{n} bytes or smaller are placed in the
15567 @code{.based} section by default.  Based variables use the @code{$tp}
15568 register as a base register, and there is a 128-byte limit to the
15569 @code{.based} section.
15571 @item -mbitops
15572 @opindex mbitops
15573 Enables the bit operation instructions---bit test (@code{btstm}), set
15574 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15575 test-and-set (@code{tas}).
15577 @item -mc=@var{name}
15578 @opindex mc=
15579 Selects which section constant data is placed in.  @var{name} may
15580 be @code{tiny}, @code{near}, or @code{far}.
15582 @item -mclip
15583 @opindex mclip
15584 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
15585 useful unless you also provide @code{-mminmax}.
15587 @item -mconfig=@var{name}
15588 @opindex mconfig=
15589 Selects one of the built-in core configurations.  Each MeP chip has
15590 one or more modules in it; each module has a core CPU and a variety of
15591 coprocessors, optional instructions, and peripherals.  The
15592 @code{MeP-Integrator} tool, not part of GCC, provides these
15593 configurations through this option; using this option is the same as
15594 using all the corresponding command-line options.  The default
15595 configuration is @code{default}.
15597 @item -mcop
15598 @opindex mcop
15599 Enables the coprocessor instructions.  By default, this is a 32-bit
15600 coprocessor.  Note that the coprocessor is normally enabled via the
15601 @code{-mconfig=} option.
15603 @item -mcop32
15604 @opindex mcop32
15605 Enables the 32-bit coprocessor's instructions.
15607 @item -mcop64
15608 @opindex mcop64
15609 Enables the 64-bit coprocessor's instructions.
15611 @item -mivc2
15612 @opindex mivc2
15613 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
15615 @item -mdc
15616 @opindex mdc
15617 Causes constant variables to be placed in the @code{.near} section.
15619 @item -mdiv
15620 @opindex mdiv
15621 Enables the @code{div} and @code{divu} instructions.
15623 @item -meb
15624 @opindex meb
15625 Generate big-endian code.
15627 @item -mel
15628 @opindex mel
15629 Generate little-endian code.
15631 @item -mio-volatile
15632 @opindex mio-volatile
15633 Tells the compiler that any variable marked with the @code{io}
15634 attribute is to be considered volatile.
15636 @item -ml
15637 @opindex ml
15638 Causes variables to be assigned to the @code{.far} section by default.
15640 @item -mleadz
15641 @opindex mleadz
15642 Enables the @code{leadz} (leading zero) instruction.
15644 @item -mm
15645 @opindex mm
15646 Causes variables to be assigned to the @code{.near} section by default.
15648 @item -mminmax
15649 @opindex mminmax
15650 Enables the @code{min} and @code{max} instructions.
15652 @item -mmult
15653 @opindex mmult
15654 Enables the multiplication and multiply-accumulate instructions.
15656 @item -mno-opts
15657 @opindex mno-opts
15658 Disables all the optional instructions enabled by @code{-mall-opts}.
15660 @item -mrepeat
15661 @opindex mrepeat
15662 Enables the @code{repeat} and @code{erepeat} instructions, used for
15663 low-overhead looping.
15665 @item -ms
15666 @opindex ms
15667 Causes all variables to default to the @code{.tiny} section.  Note
15668 that there is a 65536-byte limit to this section.  Accesses to these
15669 variables use the @code{%gp} base register.
15671 @item -msatur
15672 @opindex msatur
15673 Enables the saturation instructions.  Note that the compiler does not
15674 currently generate these itself, but this option is included for
15675 compatibility with other tools, like @code{as}.
15677 @item -msdram
15678 @opindex msdram
15679 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15681 @item -msim
15682 @opindex msim
15683 Link the simulator runtime libraries.
15685 @item -msimnovec
15686 @opindex msimnovec
15687 Link the simulator runtime libraries, excluding built-in support
15688 for reset and exception vectors and tables.
15690 @item -mtf
15691 @opindex mtf
15692 Causes all functions to default to the @code{.far} section.  Without
15693 this option, functions default to the @code{.near} section.
15695 @item -mtiny=@var{n}
15696 @opindex mtiny=
15697 Variables that are @var{n} bytes or smaller are allocated to the
15698 @code{.tiny} section.  These variables use the @code{$gp} base
15699 register.  The default for this option is 4, but note that there's a
15700 65536-byte limit to the @code{.tiny} section.
15702 @end table
15704 @node MicroBlaze Options
15705 @subsection MicroBlaze Options
15706 @cindex MicroBlaze Options
15708 @table @gcctabopt
15710 @item -msoft-float
15711 @opindex msoft-float
15712 Use software emulation for floating point (default).
15714 @item -mhard-float
15715 @opindex mhard-float
15716 Use hardware floating-point instructions.
15718 @item -mmemcpy
15719 @opindex mmemcpy
15720 Do not optimize block moves, use @code{memcpy}.
15722 @item -mno-clearbss
15723 @opindex mno-clearbss
15724 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
15726 @item -mcpu=@var{cpu-type}
15727 @opindex mcpu=
15728 Use features of, and schedule code for, the given CPU.
15729 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15730 where @var{X} is a major version, @var{YY} is the minor version, and
15731 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
15732 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15734 @item -mxl-soft-mul
15735 @opindex mxl-soft-mul
15736 Use software multiply emulation (default).
15738 @item -mxl-soft-div
15739 @opindex mxl-soft-div
15740 Use software emulation for divides (default).
15742 @item -mxl-barrel-shift
15743 @opindex mxl-barrel-shift
15744 Use the hardware barrel shifter.
15746 @item -mxl-pattern-compare
15747 @opindex mxl-pattern-compare
15748 Use pattern compare instructions.
15750 @item -msmall-divides
15751 @opindex msmall-divides
15752 Use table lookup optimization for small signed integer divisions.
15754 @item -mxl-stack-check
15755 @opindex mxl-stack-check
15756 This option is deprecated.  Use @option{-fstack-check} instead.
15758 @item -mxl-gp-opt
15759 @opindex mxl-gp-opt
15760 Use GP-relative @code{.sdata}/@code{.sbss} sections.
15762 @item -mxl-multiply-high
15763 @opindex mxl-multiply-high
15764 Use multiply high instructions for high part of 32x32 multiply.
15766 @item -mxl-float-convert
15767 @opindex mxl-float-convert
15768 Use hardware floating-point conversion instructions.
15770 @item -mxl-float-sqrt
15771 @opindex mxl-float-sqrt
15772 Use hardware floating-point square root instruction.
15774 @item -mxl-mode-@var{app-model}
15775 Select application model @var{app-model}.  Valid models are
15776 @table @samp
15777 @item executable
15778 normal executable (default), uses startup code @file{crt0.o}.
15780 @item xmdstub
15781 for use with Xilinx Microprocessor Debugger (XMD) based
15782 software intrusive debug agent called xmdstub. This uses startup file
15783 @file{crt1.o} and sets the start address of the program to 0x800.
15785 @item bootstrap
15786 for applications that are loaded using a bootloader.
15787 This model uses startup file @file{crt2.o} which does not contain a processor
15788 reset vector handler. This is suitable for transferring control on a
15789 processor reset to the bootloader rather than the application.
15791 @item novectors
15792 for applications that do not require any of the
15793 MicroBlaze vectors. This option may be useful for applications running
15794 within a monitoring application. This model uses @file{crt3.o} as a startup file.
15795 @end table
15797 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
15798 @option{-mxl-mode-@var{app-model}}.
15800 @end table
15802 @node MIPS Options
15803 @subsection MIPS Options
15804 @cindex MIPS options
15806 @table @gcctabopt
15808 @item -EB
15809 @opindex EB
15810 Generate big-endian code.
15812 @item -EL
15813 @opindex EL
15814 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
15815 configurations.
15817 @item -march=@var{arch}
15818 @opindex march
15819 Generate code that runs on @var{arch}, which can be the name of a
15820 generic MIPS ISA, or the name of a particular processor.
15821 The ISA names are:
15822 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
15823 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
15824 The processor names are:
15825 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
15826 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
15827 @samp{5kc}, @samp{5kf},
15828 @samp{20kc},
15829 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
15830 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
15831 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
15832 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
15833 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
15834 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
15835 @samp{m4k},
15836 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
15837 @samp{orion},
15838 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
15839 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
15840 @samp{rm7000}, @samp{rm9000},
15841 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
15842 @samp{sb1},
15843 @samp{sr71000},
15844 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
15845 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
15846 @samp{xlr} and @samp{xlp}.
15847 The special value @samp{from-abi} selects the
15848 most compatible architecture for the selected ABI (that is,
15849 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
15851 The native Linux/GNU toolchain also supports the value @samp{native},
15852 which selects the best architecture option for the host processor.
15853 @option{-march=native} has no effect if GCC does not recognize
15854 the processor.
15856 In processor names, a final @samp{000} can be abbreviated as @samp{k}
15857 (for example, @option{-march=r2k}).  Prefixes are optional, and
15858 @samp{vr} may be written @samp{r}.
15860 Names of the form @samp{@var{n}f2_1} refer to processors with
15861 FPUs clocked at half the rate of the core, names of the form
15862 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
15863 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
15864 processors with FPUs clocked a ratio of 3:2 with respect to the core.
15865 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
15866 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
15867 accepted as synonyms for @samp{@var{n}f1_1}.
15869 GCC defines two macros based on the value of this option.  The first
15870 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
15871 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
15872 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
15873 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
15874 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
15876 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
15877 above.  In other words, it has the full prefix and does not
15878 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
15879 the macro names the resolved architecture (either @samp{"mips1"} or
15880 @samp{"mips3"}).  It names the default architecture when no
15881 @option{-march} option is given.
15883 @item -mtune=@var{arch}
15884 @opindex mtune
15885 Optimize for @var{arch}.  Among other things, this option controls
15886 the way instructions are scheduled, and the perceived cost of arithmetic
15887 operations.  The list of @var{arch} values is the same as for
15888 @option{-march}.
15890 When this option is not used, GCC optimizes for the processor
15891 specified by @option{-march}.  By using @option{-march} and
15892 @option{-mtune} together, it is possible to generate code that
15893 runs on a family of processors, but optimize the code for one
15894 particular member of that family.
15896 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
15897 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
15898 @option{-march} ones described above.
15900 @item -mips1
15901 @opindex mips1
15902 Equivalent to @option{-march=mips1}.
15904 @item -mips2
15905 @opindex mips2
15906 Equivalent to @option{-march=mips2}.
15908 @item -mips3
15909 @opindex mips3
15910 Equivalent to @option{-march=mips3}.
15912 @item -mips4
15913 @opindex mips4
15914 Equivalent to @option{-march=mips4}.
15916 @item -mips32
15917 @opindex mips32
15918 Equivalent to @option{-march=mips32}.
15920 @item -mips32r2
15921 @opindex mips32r2
15922 Equivalent to @option{-march=mips32r2}.
15924 @item -mips64
15925 @opindex mips64
15926 Equivalent to @option{-march=mips64}.
15928 @item -mips64r2
15929 @opindex mips64r2
15930 Equivalent to @option{-march=mips64r2}.
15932 @item -mips16
15933 @itemx -mno-mips16
15934 @opindex mips16
15935 @opindex mno-mips16
15936 Generate (do not generate) MIPS16 code.  If GCC is targeting a
15937 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
15939 MIPS16 code generation can also be controlled on a per-function basis
15940 by means of @code{mips16} and @code{nomips16} attributes.
15941 @xref{Function Attributes}, for more information.
15943 @item -mflip-mips16
15944 @opindex mflip-mips16
15945 Generate MIPS16 code on alternating functions.  This option is provided
15946 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
15947 not intended for ordinary use in compiling user code.
15949 @item -minterlink-mips16
15950 @itemx -mno-interlink-mips16
15951 @opindex minterlink-mips16
15952 @opindex mno-interlink-mips16
15953 Require (do not require) that non-MIPS16 code be link-compatible with
15954 MIPS16 code.
15956 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
15957 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
15958 therefore disables direct jumps unless GCC knows that the target of the
15959 jump is not MIPS16.
15961 @item -mabi=32
15962 @itemx -mabi=o64
15963 @itemx -mabi=n32
15964 @itemx -mabi=64
15965 @itemx -mabi=eabi
15966 @opindex mabi=32
15967 @opindex mabi=o64
15968 @opindex mabi=n32
15969 @opindex mabi=64
15970 @opindex mabi=eabi
15971 Generate code for the given ABI@.
15973 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
15974 generates 64-bit code when you select a 64-bit architecture, but you
15975 can use @option{-mgp32} to get 32-bit code instead.
15977 For information about the O64 ABI, see
15978 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
15980 GCC supports a variant of the o32 ABI in which floating-point registers
15981 are 64 rather than 32 bits wide.  You can select this combination with
15982 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
15983 and @code{mfhc1} instructions and is therefore only supported for
15984 MIPS32R2 processors.
15986 The register assignments for arguments and return values remain the
15987 same, but each scalar value is passed in a single 64-bit register
15988 rather than a pair of 32-bit registers.  For example, scalar
15989 floating-point values are returned in @samp{$f0} only, not a
15990 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
15991 remains the same, but all 64 bits are saved.
15993 @item -mabicalls
15994 @itemx -mno-abicalls
15995 @opindex mabicalls
15996 @opindex mno-abicalls
15997 Generate (do not generate) code that is suitable for SVR4-style
15998 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
15999 systems.
16001 @item -mshared
16002 @itemx -mno-shared
16003 Generate (do not generate) code that is fully position-independent,
16004 and that can therefore be linked into shared libraries.  This option
16005 only affects @option{-mabicalls}.
16007 All @option{-mabicalls} code has traditionally been position-independent,
16008 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
16009 as an extension, the GNU toolchain allows executables to use absolute
16010 accesses for locally-binding symbols.  It can also use shorter GP
16011 initialization sequences and generate direct calls to locally-defined
16012 functions.  This mode is selected by @option{-mno-shared}.
16014 @option{-mno-shared} depends on binutils 2.16 or higher and generates
16015 objects that can only be linked by the GNU linker.  However, the option
16016 does not affect the ABI of the final executable; it only affects the ABI
16017 of relocatable objects.  Using @option{-mno-shared} generally makes
16018 executables both smaller and quicker.
16020 @option{-mshared} is the default.
16022 @item -mplt
16023 @itemx -mno-plt
16024 @opindex mplt
16025 @opindex mno-plt
16026 Assume (do not assume) that the static and dynamic linkers
16027 support PLTs and copy relocations.  This option only affects
16028 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
16029 has no effect without @option{-msym32}.
16031 You can make @option{-mplt} the default by configuring
16032 GCC with @option{--with-mips-plt}.  The default is
16033 @option{-mno-plt} otherwise.
16035 @item -mxgot
16036 @itemx -mno-xgot
16037 @opindex mxgot
16038 @opindex mno-xgot
16039 Lift (do not lift) the usual restrictions on the size of the global
16040 offset table.
16042 GCC normally uses a single instruction to load values from the GOT@.
16043 While this is relatively efficient, it only works if the GOT
16044 is smaller than about 64k.  Anything larger causes the linker
16045 to report an error such as:
16047 @cindex relocation truncated to fit (MIPS)
16048 @smallexample
16049 relocation truncated to fit: R_MIPS_GOT16 foobar
16050 @end smallexample
16052 If this happens, you should recompile your code with @option{-mxgot}.
16053 This works with very large GOTs, although the code is also
16054 less efficient, since it takes three instructions to fetch the
16055 value of a global symbol.
16057 Note that some linkers can create multiple GOTs.  If you have such a
16058 linker, you should only need to use @option{-mxgot} when a single object
16059 file accesses more than 64k's worth of GOT entries.  Very few do.
16061 These options have no effect unless GCC is generating position
16062 independent code.
16064 @item -mgp32
16065 @opindex mgp32
16066 Assume that general-purpose registers are 32 bits wide.
16068 @item -mgp64
16069 @opindex mgp64
16070 Assume that general-purpose registers are 64 bits wide.
16072 @item -mfp32
16073 @opindex mfp32
16074 Assume that floating-point registers are 32 bits wide.
16076 @item -mfp64
16077 @opindex mfp64
16078 Assume that floating-point registers are 64 bits wide.
16080 @item -mhard-float
16081 @opindex mhard-float
16082 Use floating-point coprocessor instructions.
16084 @item -msoft-float
16085 @opindex msoft-float
16086 Do not use floating-point coprocessor instructions.  Implement
16087 floating-point calculations using library calls instead.
16089 @item -mno-float
16090 @opindex mno-float
16091 Equivalent to @option{-msoft-float}, but additionally asserts that the
16092 program being compiled does not perform any floating-point operations.
16093 This option is presently supported only by some bare-metal MIPS
16094 configurations, where it may select a special set of libraries
16095 that lack all floating-point support (including, for example, the
16096 floating-point @code{printf} formats).  
16097 If code compiled with @code{-mno-float} accidentally contains
16098 floating-point operations, it is likely to suffer a link-time
16099 or run-time failure.
16101 @item -msingle-float
16102 @opindex msingle-float
16103 Assume that the floating-point coprocessor only supports single-precision
16104 operations.
16106 @item -mdouble-float
16107 @opindex mdouble-float
16108 Assume that the floating-point coprocessor supports double-precision
16109 operations.  This is the default.
16111 @item -mllsc
16112 @itemx -mno-llsc
16113 @opindex mllsc
16114 @opindex mno-llsc
16115 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
16116 implement atomic memory built-in functions.  When neither option is
16117 specified, GCC uses the instructions if the target architecture
16118 supports them.
16120 @option{-mllsc} is useful if the runtime environment can emulate the
16121 instructions and @option{-mno-llsc} can be useful when compiling for
16122 nonstandard ISAs.  You can make either option the default by
16123 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
16124 respectively.  @option{--with-llsc} is the default for some
16125 configurations; see the installation documentation for details.
16127 @item -mdsp
16128 @itemx -mno-dsp
16129 @opindex mdsp
16130 @opindex mno-dsp
16131 Use (do not use) revision 1 of the MIPS DSP ASE@.
16132 @xref{MIPS DSP Built-in Functions}.  This option defines the
16133 preprocessor macro @samp{__mips_dsp}.  It also defines
16134 @samp{__mips_dsp_rev} to 1.
16136 @item -mdspr2
16137 @itemx -mno-dspr2
16138 @opindex mdspr2
16139 @opindex mno-dspr2
16140 Use (do not use) revision 2 of the MIPS DSP ASE@.
16141 @xref{MIPS DSP Built-in Functions}.  This option defines the
16142 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
16143 It also defines @samp{__mips_dsp_rev} to 2.
16145 @item -msmartmips
16146 @itemx -mno-smartmips
16147 @opindex msmartmips
16148 @opindex mno-smartmips
16149 Use (do not use) the MIPS SmartMIPS ASE.
16151 @item -mpaired-single
16152 @itemx -mno-paired-single
16153 @opindex mpaired-single
16154 @opindex mno-paired-single
16155 Use (do not use) paired-single floating-point instructions.
16156 @xref{MIPS Paired-Single Support}.  This option requires
16157 hardware floating-point support to be enabled.
16159 @item -mdmx
16160 @itemx -mno-mdmx
16161 @opindex mdmx
16162 @opindex mno-mdmx
16163 Use (do not use) MIPS Digital Media Extension instructions.
16164 This option can only be used when generating 64-bit code and requires
16165 hardware floating-point support to be enabled.
16167 @item -mips3d
16168 @itemx -mno-mips3d
16169 @opindex mips3d
16170 @opindex mno-mips3d
16171 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
16172 The option @option{-mips3d} implies @option{-mpaired-single}.
16174 @item -mmt
16175 @itemx -mno-mt
16176 @opindex mmt
16177 @opindex mno-mt
16178 Use (do not use) MT Multithreading instructions.
16180 @item -mmcu
16181 @itemx -mno-mcu
16182 @opindex mmcu
16183 @opindex mno-mcu
16184 Use (do not use) the MIPS MCU ASE instructions.
16186 @item -mlong64
16187 @opindex mlong64
16188 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
16189 an explanation of the default and the way that the pointer size is
16190 determined.
16192 @item -mlong32
16193 @opindex mlong32
16194 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
16196 The default size of @code{int}s, @code{long}s and pointers depends on
16197 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
16198 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
16199 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
16200 or the same size as integer registers, whichever is smaller.
16202 @item -msym32
16203 @itemx -mno-sym32
16204 @opindex msym32
16205 @opindex mno-sym32
16206 Assume (do not assume) that all symbols have 32-bit values, regardless
16207 of the selected ABI@.  This option is useful in combination with
16208 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
16209 to generate shorter and faster references to symbolic addresses.
16211 @item -G @var{num}
16212 @opindex G
16213 Put definitions of externally-visible data in a small data section
16214 if that data is no bigger than @var{num} bytes.  GCC can then generate
16215 more efficient accesses to the data; see @option{-mgpopt} for details.
16217 The default @option{-G} option depends on the configuration.
16219 @item -mlocal-sdata
16220 @itemx -mno-local-sdata
16221 @opindex mlocal-sdata
16222 @opindex mno-local-sdata
16223 Extend (do not extend) the @option{-G} behavior to local data too,
16224 such as to static variables in C@.  @option{-mlocal-sdata} is the
16225 default for all configurations.
16227 If the linker complains that an application is using too much small data,
16228 you might want to try rebuilding the less performance-critical parts with
16229 @option{-mno-local-sdata}.  You might also want to build large
16230 libraries with @option{-mno-local-sdata}, so that the libraries leave
16231 more room for the main program.
16233 @item -mextern-sdata
16234 @itemx -mno-extern-sdata
16235 @opindex mextern-sdata
16236 @opindex mno-extern-sdata
16237 Assume (do not assume) that externally-defined data is in
16238 a small data section if the size of that data is within the @option{-G} limit.
16239 @option{-mextern-sdata} is the default for all configurations.
16241 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
16242 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
16243 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
16244 is placed in a small data section.  If @var{Var} is defined by another
16245 module, you must either compile that module with a high-enough
16246 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
16247 definition.  If @var{Var} is common, you must link the application
16248 with a high-enough @option{-G} setting.
16250 The easiest way of satisfying these restrictions is to compile
16251 and link every module with the same @option{-G} option.  However,
16252 you may wish to build a library that supports several different
16253 small data limits.  You can do this by compiling the library with
16254 the highest supported @option{-G} setting and additionally using
16255 @option{-mno-extern-sdata} to stop the library from making assumptions
16256 about externally-defined data.
16258 @item -mgpopt
16259 @itemx -mno-gpopt
16260 @opindex mgpopt
16261 @opindex mno-gpopt
16262 Use (do not use) GP-relative accesses for symbols that are known to be
16263 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
16264 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
16265 configurations.
16267 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
16268 might not hold the value of @code{_gp}.  For example, if the code is
16269 part of a library that might be used in a boot monitor, programs that
16270 call boot monitor routines pass an unknown value in @code{$gp}.
16271 (In such situations, the boot monitor itself is usually compiled
16272 with @option{-G0}.)
16274 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
16275 @option{-mno-extern-sdata}.
16277 @item -membedded-data
16278 @itemx -mno-embedded-data
16279 @opindex membedded-data
16280 @opindex mno-embedded-data
16281 Allocate variables to the read-only data section first if possible, then
16282 next in the small data section if possible, otherwise in data.  This gives
16283 slightly slower code than the default, but reduces the amount of RAM required
16284 when executing, and thus may be preferred for some embedded systems.
16286 @item -muninit-const-in-rodata
16287 @itemx -mno-uninit-const-in-rodata
16288 @opindex muninit-const-in-rodata
16289 @opindex mno-uninit-const-in-rodata
16290 Put uninitialized @code{const} variables in the read-only data section.
16291 This option is only meaningful in conjunction with @option{-membedded-data}.
16293 @item -mcode-readable=@var{setting}
16294 @opindex mcode-readable
16295 Specify whether GCC may generate code that reads from executable sections.
16296 There are three possible settings:
16298 @table @gcctabopt
16299 @item -mcode-readable=yes
16300 Instructions may freely access executable sections.  This is the
16301 default setting.
16303 @item -mcode-readable=pcrel
16304 MIPS16 PC-relative load instructions can access executable sections,
16305 but other instructions must not do so.  This option is useful on 4KSc
16306 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
16307 It is also useful on processors that can be configured to have a dual
16308 instruction/data SRAM interface and that, like the M4K, automatically
16309 redirect PC-relative loads to the instruction RAM.
16311 @item -mcode-readable=no
16312 Instructions must not access executable sections.  This option can be
16313 useful on targets that are configured to have a dual instruction/data
16314 SRAM interface but that (unlike the M4K) do not automatically redirect
16315 PC-relative loads to the instruction RAM.
16316 @end table
16318 @item -msplit-addresses
16319 @itemx -mno-split-addresses
16320 @opindex msplit-addresses
16321 @opindex mno-split-addresses
16322 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
16323 relocation operators.  This option has been superseded by
16324 @option{-mexplicit-relocs} but is retained for backwards compatibility.
16326 @item -mexplicit-relocs
16327 @itemx -mno-explicit-relocs
16328 @opindex mexplicit-relocs
16329 @opindex mno-explicit-relocs
16330 Use (do not use) assembler relocation operators when dealing with symbolic
16331 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
16332 is to use assembler macros instead.
16334 @option{-mexplicit-relocs} is the default if GCC was configured
16335 to use an assembler that supports relocation operators.
16337 @item -mcheck-zero-division
16338 @itemx -mno-check-zero-division
16339 @opindex mcheck-zero-division
16340 @opindex mno-check-zero-division
16341 Trap (do not trap) on integer division by zero.
16343 The default is @option{-mcheck-zero-division}.
16345 @item -mdivide-traps
16346 @itemx -mdivide-breaks
16347 @opindex mdivide-traps
16348 @opindex mdivide-breaks
16349 MIPS systems check for division by zero by generating either a
16350 conditional trap or a break instruction.  Using traps results in
16351 smaller code, but is only supported on MIPS II and later.  Also, some
16352 versions of the Linux kernel have a bug that prevents trap from
16353 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
16354 allow conditional traps on architectures that support them and
16355 @option{-mdivide-breaks} to force the use of breaks.
16357 The default is usually @option{-mdivide-traps}, but this can be
16358 overridden at configure time using @option{--with-divide=breaks}.
16359 Divide-by-zero checks can be completely disabled using
16360 @option{-mno-check-zero-division}.
16362 @item -mmemcpy
16363 @itemx -mno-memcpy
16364 @opindex mmemcpy
16365 @opindex mno-memcpy
16366 Force (do not force) the use of @code{memcpy()} for non-trivial block
16367 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
16368 most constant-sized copies.
16370 @item -mlong-calls
16371 @itemx -mno-long-calls
16372 @opindex mlong-calls
16373 @opindex mno-long-calls
16374 Disable (do not disable) use of the @code{jal} instruction.  Calling
16375 functions using @code{jal} is more efficient but requires the caller
16376 and callee to be in the same 256 megabyte segment.
16378 This option has no effect on abicalls code.  The default is
16379 @option{-mno-long-calls}.
16381 @item -mmad
16382 @itemx -mno-mad
16383 @opindex mmad
16384 @opindex mno-mad
16385 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
16386 instructions, as provided by the R4650 ISA@.
16388 @item -mfused-madd
16389 @itemx -mno-fused-madd
16390 @opindex mfused-madd
16391 @opindex mno-fused-madd
16392 Enable (disable) use of the floating-point multiply-accumulate
16393 instructions, when they are available.  The default is
16394 @option{-mfused-madd}.
16396 When multiply-accumulate instructions are used, the intermediate
16397 product is calculated to infinite precision and is not subject to
16398 the FCSR Flush to Zero bit.  This may be undesirable in some
16399 circumstances.
16401 @item -nocpp
16402 @opindex nocpp
16403 Tell the MIPS assembler to not run its preprocessor over user
16404 assembler files (with a @samp{.s} suffix) when assembling them.
16406 @item -mfix-24k
16407 @item -mno-fix-24k
16408 @opindex mfix-24k
16409 @opindex mno-fix-24k
16410 Work around the 24K E48 (lost data on stores during refill) errata.
16411 The workarounds are implemented by the assembler rather than by GCC@.
16413 @item -mfix-r4000
16414 @itemx -mno-fix-r4000
16415 @opindex mfix-r4000
16416 @opindex mno-fix-r4000
16417 Work around certain R4000 CPU errata:
16418 @itemize @minus
16419 @item
16420 A double-word or a variable shift may give an incorrect result if executed
16421 immediately after starting an integer division.
16422 @item
16423 A double-word or a variable shift may give an incorrect result if executed
16424 while an integer multiplication is in progress.
16425 @item
16426 An integer division may give an incorrect result if started in a delay slot
16427 of a taken branch or a jump.
16428 @end itemize
16430 @item -mfix-r4400
16431 @itemx -mno-fix-r4400
16432 @opindex mfix-r4400
16433 @opindex mno-fix-r4400
16434 Work around certain R4400 CPU errata:
16435 @itemize @minus
16436 @item
16437 A double-word or a variable shift may give an incorrect result if executed
16438 immediately after starting an integer division.
16439 @end itemize
16441 @item -mfix-r10000
16442 @itemx -mno-fix-r10000
16443 @opindex mfix-r10000
16444 @opindex mno-fix-r10000
16445 Work around certain R10000 errata:
16446 @itemize @minus
16447 @item
16448 @code{ll}/@code{sc} sequences may not behave atomically on revisions
16449 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
16450 @end itemize
16452 This option can only be used if the target architecture supports
16453 branch-likely instructions.  @option{-mfix-r10000} is the default when
16454 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
16455 otherwise.
16457 @item -mfix-vr4120
16458 @itemx -mno-fix-vr4120
16459 @opindex mfix-vr4120
16460 Work around certain VR4120 errata:
16461 @itemize @minus
16462 @item
16463 @code{dmultu} does not always produce the correct result.
16464 @item
16465 @code{div} and @code{ddiv} do not always produce the correct result if one
16466 of the operands is negative.
16467 @end itemize
16468 The workarounds for the division errata rely on special functions in
16469 @file{libgcc.a}.  At present, these functions are only provided by
16470 the @code{mips64vr*-elf} configurations.
16472 Other VR4120 errata require a NOP to be inserted between certain pairs of
16473 instructions.  These errata are handled by the assembler, not by GCC itself.
16475 @item -mfix-vr4130
16476 @opindex mfix-vr4130
16477 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
16478 workarounds are implemented by the assembler rather than by GCC,
16479 although GCC avoids using @code{mflo} and @code{mfhi} if the
16480 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
16481 instructions are available instead.
16483 @item -mfix-sb1
16484 @itemx -mno-fix-sb1
16485 @opindex mfix-sb1
16486 Work around certain SB-1 CPU core errata.
16487 (This flag currently works around the SB-1 revision 2
16488 ``F1'' and ``F2'' floating-point errata.)
16490 @item -mr10k-cache-barrier=@var{setting}
16491 @opindex mr10k-cache-barrier
16492 Specify whether GCC should insert cache barriers to avoid the
16493 side-effects of speculation on R10K processors.
16495 In common with many processors, the R10K tries to predict the outcome
16496 of a conditional branch and speculatively executes instructions from
16497 the ``taken'' branch.  It later aborts these instructions if the
16498 predicted outcome is wrong.  However, on the R10K, even aborted
16499 instructions can have side effects.
16501 This problem only affects kernel stores and, depending on the system,
16502 kernel loads.  As an example, a speculatively-executed store may load
16503 the target memory into cache and mark the cache line as dirty, even if
16504 the store itself is later aborted.  If a DMA operation writes to the
16505 same area of memory before the ``dirty'' line is flushed, the cached
16506 data overwrites the DMA-ed data.  See the R10K processor manual
16507 for a full description, including other potential problems.
16509 One workaround is to insert cache barrier instructions before every memory
16510 access that might be speculatively executed and that might have side
16511 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
16512 controls GCC's implementation of this workaround.  It assumes that
16513 aborted accesses to any byte in the following regions does not have
16514 side effects:
16516 @enumerate
16517 @item
16518 the memory occupied by the current function's stack frame;
16520 @item
16521 the memory occupied by an incoming stack argument;
16523 @item
16524 the memory occupied by an object with a link-time-constant address.
16525 @end enumerate
16527 It is the kernel's responsibility to ensure that speculative
16528 accesses to these regions are indeed safe.
16530 If the input program contains a function declaration such as:
16532 @smallexample
16533 void foo (void);
16534 @end smallexample
16536 then the implementation of @code{foo} must allow @code{j foo} and
16537 @code{jal foo} to be executed speculatively.  GCC honors this
16538 restriction for functions it compiles itself.  It expects non-GCC
16539 functions (such as hand-written assembly code) to do the same.
16541 The option has three forms:
16543 @table @gcctabopt
16544 @item -mr10k-cache-barrier=load-store
16545 Insert a cache barrier before a load or store that might be
16546 speculatively executed and that might have side effects even
16547 if aborted.
16549 @item -mr10k-cache-barrier=store
16550 Insert a cache barrier before a store that might be speculatively
16551 executed and that might have side effects even if aborted.
16553 @item -mr10k-cache-barrier=none
16554 Disable the insertion of cache barriers.  This is the default setting.
16555 @end table
16557 @item -mflush-func=@var{func}
16558 @itemx -mno-flush-func
16559 @opindex mflush-func
16560 Specifies the function to call to flush the I and D caches, or to not
16561 call any such function.  If called, the function must take the same
16562 arguments as the common @code{_flush_func()}, that is, the address of the
16563 memory range for which the cache is being flushed, the size of the
16564 memory range, and the number 3 (to flush both caches).  The default
16565 depends on the target GCC was configured for, but commonly is either
16566 @samp{_flush_func} or @samp{__cpu_flush}.
16568 @item mbranch-cost=@var{num}
16569 @opindex mbranch-cost
16570 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16571 This cost is only a heuristic and is not guaranteed to produce
16572 consistent results across releases.  A zero cost redundantly selects
16573 the default, which is based on the @option{-mtune} setting.
16575 @item -mbranch-likely
16576 @itemx -mno-branch-likely
16577 @opindex mbranch-likely
16578 @opindex mno-branch-likely
16579 Enable or disable use of Branch Likely instructions, regardless of the
16580 default for the selected architecture.  By default, Branch Likely
16581 instructions may be generated if they are supported by the selected
16582 architecture.  An exception is for the MIPS32 and MIPS64 architectures
16583 and processors that implement those architectures; for those, Branch
16584 Likely instructions are not be generated by default because the MIPS32
16585 and MIPS64 architectures specifically deprecate their use.
16587 @item -mfp-exceptions
16588 @itemx -mno-fp-exceptions
16589 @opindex mfp-exceptions
16590 Specifies whether FP exceptions are enabled.  This affects how
16591 FP instructions are scheduled for some processors.
16592 The default is that FP exceptions are
16593 enabled.
16595 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16596 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
16597 FP pipe.
16599 @item -mvr4130-align
16600 @itemx -mno-vr4130-align
16601 @opindex mvr4130-align
16602 The VR4130 pipeline is two-way superscalar, but can only issue two
16603 instructions together if the first one is 8-byte aligned.  When this
16604 option is enabled, GCC aligns pairs of instructions that it
16605 thinks should execute in parallel.
16607 This option only has an effect when optimizing for the VR4130.
16608 It normally makes code faster, but at the expense of making it bigger.
16609 It is enabled by default at optimization level @option{-O3}.
16611 @item -msynci
16612 @itemx -mno-synci
16613 @opindex msynci
16614 Enable (disable) generation of @code{synci} instructions on
16615 architectures that support it.  The @code{synci} instructions (if
16616 enabled) are generated when @code{__builtin___clear_cache()} is
16617 compiled.
16619 This option defaults to @code{-mno-synci}, but the default can be
16620 overridden by configuring with @code{--with-synci}.
16622 When compiling code for single processor systems, it is generally safe
16623 to use @code{synci}.  However, on many multi-core (SMP) systems, it
16624 does not invalidate the instruction caches on all cores and may lead
16625 to undefined behavior.
16627 @item -mrelax-pic-calls
16628 @itemx -mno-relax-pic-calls
16629 @opindex mrelax-pic-calls
16630 Try to turn PIC calls that are normally dispatched via register
16631 @code{$25} into direct calls.  This is only possible if the linker can
16632 resolve the destination at link-time and if the destination is within
16633 range for a direct call.
16635 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16636 an assembler and a linker that support the @code{.reloc} assembly
16637 directive and @code{-mexplicit-relocs} is in effect.  With
16638 @code{-mno-explicit-relocs}, this optimization can be performed by the
16639 assembler and the linker alone without help from the compiler.
16641 @item -mmcount-ra-address
16642 @itemx -mno-mcount-ra-address
16643 @opindex mmcount-ra-address
16644 @opindex mno-mcount-ra-address
16645 Emit (do not emit) code that allows @code{_mcount} to modify the
16646 calling function's return address.  When enabled, this option extends
16647 the usual @code{_mcount} interface with a new @var{ra-address}
16648 parameter, which has type @code{intptr_t *} and is passed in register
16649 @code{$12}.  @code{_mcount} can then modify the return address by
16650 doing both of the following:
16651 @itemize
16652 @item
16653 Returning the new address in register @code{$31}.
16654 @item
16655 Storing the new address in @code{*@var{ra-address}},
16656 if @var{ra-address} is nonnull.
16657 @end itemize
16659 The default is @option{-mno-mcount-ra-address}.
16661 @end table
16663 @node MMIX Options
16664 @subsection MMIX Options
16665 @cindex MMIX Options
16667 These options are defined for the MMIX:
16669 @table @gcctabopt
16670 @item -mlibfuncs
16671 @itemx -mno-libfuncs
16672 @opindex mlibfuncs
16673 @opindex mno-libfuncs
16674 Specify that intrinsic library functions are being compiled, passing all
16675 values in registers, no matter the size.
16677 @item -mepsilon
16678 @itemx -mno-epsilon
16679 @opindex mepsilon
16680 @opindex mno-epsilon
16681 Generate floating-point comparison instructions that compare with respect
16682 to the @code{rE} epsilon register.
16684 @item -mabi=mmixware
16685 @itemx -mabi=gnu
16686 @opindex mabi=mmixware
16687 @opindex mabi=gnu
16688 Generate code that passes function parameters and return values that (in
16689 the called function) are seen as registers @code{$0} and up, as opposed to
16690 the GNU ABI which uses global registers @code{$231} and up.
16692 @item -mzero-extend
16693 @itemx -mno-zero-extend
16694 @opindex mzero-extend
16695 @opindex mno-zero-extend
16696 When reading data from memory in sizes shorter than 64 bits, use (do not
16697 use) zero-extending load instructions by default, rather than
16698 sign-extending ones.
16700 @item -mknuthdiv
16701 @itemx -mno-knuthdiv
16702 @opindex mknuthdiv
16703 @opindex mno-knuthdiv
16704 Make the result of a division yielding a remainder have the same sign as
16705 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
16706 remainder follows the sign of the dividend.  Both methods are
16707 arithmetically valid, the latter being almost exclusively used.
16709 @item -mtoplevel-symbols
16710 @itemx -mno-toplevel-symbols
16711 @opindex mtoplevel-symbols
16712 @opindex mno-toplevel-symbols
16713 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
16714 code can be used with the @code{PREFIX} assembly directive.
16716 @item -melf
16717 @opindex melf
16718 Generate an executable in the ELF format, rather than the default
16719 @samp{mmo} format used by the @command{mmix} simulator.
16721 @item -mbranch-predict
16722 @itemx -mno-branch-predict
16723 @opindex mbranch-predict
16724 @opindex mno-branch-predict
16725 Use (do not use) the probable-branch instructions, when static branch
16726 prediction indicates a probable branch.
16728 @item -mbase-addresses
16729 @itemx -mno-base-addresses
16730 @opindex mbase-addresses
16731 @opindex mno-base-addresses
16732 Generate (do not generate) code that uses @emph{base addresses}.  Using a
16733 base address automatically generates a request (handled by the assembler
16734 and the linker) for a constant to be set up in a global register.  The
16735 register is used for one or more base address requests within the range 0
16736 to 255 from the value held in the register.  The generally leads to short
16737 and fast code, but the number of different data items that can be
16738 addressed is limited.  This means that a program that uses lots of static
16739 data may require @option{-mno-base-addresses}.
16741 @item -msingle-exit
16742 @itemx -mno-single-exit
16743 @opindex msingle-exit
16744 @opindex mno-single-exit
16745 Force (do not force) generated code to have a single exit point in each
16746 function.
16747 @end table
16749 @node MN10300 Options
16750 @subsection MN10300 Options
16751 @cindex MN10300 options
16753 These @option{-m} options are defined for Matsushita MN10300 architectures:
16755 @table @gcctabopt
16756 @item -mmult-bug
16757 @opindex mmult-bug
16758 Generate code to avoid bugs in the multiply instructions for the MN10300
16759 processors.  This is the default.
16761 @item -mno-mult-bug
16762 @opindex mno-mult-bug
16763 Do not generate code to avoid bugs in the multiply instructions for the
16764 MN10300 processors.
16766 @item -mam33
16767 @opindex mam33
16768 Generate code using features specific to the AM33 processor.
16770 @item -mno-am33
16771 @opindex mno-am33
16772 Do not generate code using features specific to the AM33 processor.  This
16773 is the default.
16775 @item -mam33-2
16776 @opindex mam33-2
16777 Generate code using features specific to the AM33/2.0 processor.
16779 @item -mam34
16780 @opindex mam34
16781 Generate code using features specific to the AM34 processor.
16783 @item -mtune=@var{cpu-type}
16784 @opindex mtune
16785 Use the timing characteristics of the indicated CPU type when
16786 scheduling instructions.  This does not change the targeted processor
16787 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
16788 @samp{am33-2} or @samp{am34}.
16790 @item -mreturn-pointer-on-d0
16791 @opindex mreturn-pointer-on-d0
16792 When generating a function that returns a pointer, return the pointer
16793 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
16794 only in @code{a0}, and attempts to call such functions without a prototype
16795 result in errors.  Note that this option is on by default; use
16796 @option{-mno-return-pointer-on-d0} to disable it.
16798 @item -mno-crt0
16799 @opindex mno-crt0
16800 Do not link in the C run-time initialization object file.
16802 @item -mrelax
16803 @opindex mrelax
16804 Indicate to the linker that it should perform a relaxation optimization pass
16805 to shorten branches, calls and absolute memory addresses.  This option only
16806 has an effect when used on the command line for the final link step.
16808 This option makes symbolic debugging impossible.
16810 @item -mliw
16811 @opindex mliw
16812 Allow the compiler to generate @emph{Long Instruction Word}
16813 instructions if the target is the @samp{AM33} or later.  This is the
16814 default.  This option defines the preprocessor macro @samp{__LIW__}.
16816 @item -mnoliw
16817 @opindex mnoliw
16818 Do not allow the compiler to generate @emph{Long Instruction Word}
16819 instructions.  This option defines the preprocessor macro
16820 @samp{__NO_LIW__}.
16822 @item -msetlb
16823 @opindex msetlb
16824 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
16825 instructions if the target is the @samp{AM33} or later.  This is the
16826 default.  This option defines the preprocessor macro @samp{__SETLB__}.
16828 @item -mnosetlb
16829 @opindex mnosetlb
16830 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
16831 instructions.  This option defines the preprocessor macro
16832 @samp{__NO_SETLB__}.
16834 @end table
16836 @node Moxie Options
16837 @subsection Moxie Options
16838 @cindex Moxie Options
16840 @table @gcctabopt
16842 @item -meb
16843 @opindex meb
16844 Generate big-endian code.  This is the default for @samp{moxie-*-*}
16845 configurations.
16847 @item -mel
16848 @opindex mel
16849 Generate little-endian code.
16851 @item -mno-crt0
16852 @opindex mno-crt0
16853 Do not link in the C run-time initialization object file.
16855 @end table
16857 @node PDP-11 Options
16858 @subsection PDP-11 Options
16859 @cindex PDP-11 Options
16861 These options are defined for the PDP-11:
16863 @table @gcctabopt
16864 @item -mfpu
16865 @opindex mfpu
16866 Use hardware FPP floating point.  This is the default.  (FIS floating
16867 point on the PDP-11/40 is not supported.)
16869 @item -msoft-float
16870 @opindex msoft-float
16871 Do not use hardware floating point.
16873 @item -mac0
16874 @opindex mac0
16875 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
16877 @item -mno-ac0
16878 @opindex mno-ac0
16879 Return floating-point results in memory.  This is the default.
16881 @item -m40
16882 @opindex m40
16883 Generate code for a PDP-11/40.
16885 @item -m45
16886 @opindex m45
16887 Generate code for a PDP-11/45.  This is the default.
16889 @item -m10
16890 @opindex m10
16891 Generate code for a PDP-11/10.
16893 @item -mbcopy-builtin
16894 @opindex mbcopy-builtin
16895 Use inline @code{movmemhi} patterns for copying memory.  This is the
16896 default.
16898 @item -mbcopy
16899 @opindex mbcopy
16900 Do not use inline @code{movmemhi} patterns for copying memory.
16902 @item -mint16
16903 @itemx -mno-int32
16904 @opindex mint16
16905 @opindex mno-int32
16906 Use 16-bit @code{int}.  This is the default.
16908 @item -mint32
16909 @itemx -mno-int16
16910 @opindex mint32
16911 @opindex mno-int16
16912 Use 32-bit @code{int}.
16914 @item -mfloat64
16915 @itemx -mno-float32
16916 @opindex mfloat64
16917 @opindex mno-float32
16918 Use 64-bit @code{float}.  This is the default.
16920 @item -mfloat32
16921 @itemx -mno-float64
16922 @opindex mfloat32
16923 @opindex mno-float64
16924 Use 32-bit @code{float}.
16926 @item -mabshi
16927 @opindex mabshi
16928 Use @code{abshi2} pattern.  This is the default.
16930 @item -mno-abshi
16931 @opindex mno-abshi
16932 Do not use @code{abshi2} pattern.
16934 @item -mbranch-expensive
16935 @opindex mbranch-expensive
16936 Pretend that branches are expensive.  This is for experimenting with
16937 code generation only.
16939 @item -mbranch-cheap
16940 @opindex mbranch-cheap
16941 Do not pretend that branches are expensive.  This is the default.
16943 @item -munix-asm
16944 @opindex munix-asm
16945 Use Unix assembler syntax.  This is the default when configured for
16946 @samp{pdp11-*-bsd}.
16948 @item -mdec-asm
16949 @opindex mdec-asm
16950 Use DEC assembler syntax.  This is the default when configured for any
16951 PDP-11 target other than @samp{pdp11-*-bsd}.
16952 @end table
16954 @node picoChip Options
16955 @subsection picoChip Options
16956 @cindex picoChip options
16958 These @samp{-m} options are defined for picoChip implementations:
16960 @table @gcctabopt
16962 @item -mae=@var{ae_type}
16963 @opindex mcpu
16964 Set the instruction set, register set, and instruction scheduling
16965 parameters for array element type @var{ae_type}.  Supported values
16966 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
16968 @option{-mae=ANY} selects a completely generic AE type.  Code
16969 generated with this option runs on any of the other AE types.  The
16970 code is not as efficient as it would be if compiled for a specific
16971 AE type, and some types of operation (e.g., multiplication) do not
16972 work properly on all types of AE.
16974 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
16975 for compiled code, and is the default.
16977 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
16978 option may suffer from poor performance of byte (char) manipulation,
16979 since the DSP AE does not provide hardware support for byte load/stores.
16981 @item -msymbol-as-address
16982 Enable the compiler to directly use a symbol name as an address in a
16983 load/store instruction, without first loading it into a
16984 register.  Typically, the use of this option generates larger
16985 programs, which run faster than when the option isn't used.  However, the
16986 results vary from program to program, so it is left as a user option,
16987 rather than being permanently enabled.
16989 @item -mno-inefficient-warnings
16990 Disables warnings about the generation of inefficient code.  These
16991 warnings can be generated, for example, when compiling code that
16992 performs byte-level memory operations on the MAC AE type.  The MAC AE has
16993 no hardware support for byte-level memory operations, so all byte
16994 load/stores must be synthesized from word load/store operations.  This is
16995 inefficient and a warning is generated to indicate
16996 that you should rewrite the code to avoid byte operations, or to target
16997 an AE type that has the necessary hardware support.  This option disables
16998 these warnings.
17000 @end table
17002 @node PowerPC Options
17003 @subsection PowerPC Options
17004 @cindex PowerPC options
17006 These are listed under @xref{RS/6000 and PowerPC Options}.
17008 @node RL78 Options
17009 @subsection RL78 Options
17010 @cindex RL78 Options
17012 @table @gcctabopt
17014 @item -msim
17015 @opindex msim
17016 Links in additional target libraries to support operation within a
17017 simulator.
17019 @item -mmul=none
17020 @itemx -mmul=g13
17021 @itemx -mmul=rl78
17022 @opindex mmul
17023 Specifies the type of hardware multiplication support to be used.  The
17024 default is @code{none}, which uses software multiplication functions.
17025 The @code{g13} option is for the hardware multiply/divide peripheral
17026 only on the RL78/G13 targets.  The @code{rl78} option is for the
17027 standard hardware multiplication defined in the RL78 software manual.
17029 @end table
17031 @node RS/6000 and PowerPC Options
17032 @subsection IBM RS/6000 and PowerPC Options
17033 @cindex RS/6000 and PowerPC Options
17034 @cindex IBM RS/6000 and PowerPC Options
17036 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
17037 @table @gcctabopt
17038 @item -mpowerpc-gpopt
17039 @itemx -mno-powerpc-gpopt
17040 @itemx -mpowerpc-gfxopt
17041 @itemx -mno-powerpc-gfxopt
17042 @need 800
17043 @itemx -mpowerpc64
17044 @itemx -mno-powerpc64
17045 @itemx -mmfcrf
17046 @itemx -mno-mfcrf
17047 @itemx -mpopcntb
17048 @itemx -mno-popcntb
17049 @itemx -mpopcntd
17050 @itemx -mno-popcntd
17051 @itemx -mfprnd
17052 @itemx -mno-fprnd
17053 @need 800
17054 @itemx -mcmpb
17055 @itemx -mno-cmpb
17056 @itemx -mmfpgpr
17057 @itemx -mno-mfpgpr
17058 @itemx -mhard-dfp
17059 @itemx -mno-hard-dfp
17060 @opindex mpowerpc-gpopt
17061 @opindex mno-powerpc-gpopt
17062 @opindex mpowerpc-gfxopt
17063 @opindex mno-powerpc-gfxopt
17064 @opindex mpowerpc64
17065 @opindex mno-powerpc64
17066 @opindex mmfcrf
17067 @opindex mno-mfcrf
17068 @opindex mpopcntb
17069 @opindex mno-popcntb
17070 @opindex mpopcntd
17071 @opindex mno-popcntd
17072 @opindex mfprnd
17073 @opindex mno-fprnd
17074 @opindex mcmpb
17075 @opindex mno-cmpb
17076 @opindex mmfpgpr
17077 @opindex mno-mfpgpr
17078 @opindex mhard-dfp
17079 @opindex mno-hard-dfp
17080 You use these options to specify which instructions are available on the
17081 processor you are using.  The default value of these options is
17082 determined when configuring GCC@.  Specifying the
17083 @option{-mcpu=@var{cpu_type}} overrides the specification of these
17084 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
17085 rather than the options listed above.
17087 Specifying @option{-mpowerpc-gpopt} allows
17088 GCC to use the optional PowerPC architecture instructions in the
17089 General Purpose group, including floating-point square root.  Specifying
17090 @option{-mpowerpc-gfxopt} allows GCC to
17091 use the optional PowerPC architecture instructions in the Graphics
17092 group, including floating-point select.
17094 The @option{-mmfcrf} option allows GCC to generate the move from
17095 condition register field instruction implemented on the POWER4
17096 processor and other processors that support the PowerPC V2.01
17097 architecture.
17098 The @option{-mpopcntb} option allows GCC to generate the popcount and
17099 double-precision FP reciprocal estimate instruction implemented on the
17100 POWER5 processor and other processors that support the PowerPC V2.02
17101 architecture.
17102 The @option{-mpopcntd} option allows GCC to generate the popcount
17103 instruction implemented on the POWER7 processor and other processors
17104 that support the PowerPC V2.06 architecture.
17105 The @option{-mfprnd} option allows GCC to generate the FP round to
17106 integer instructions implemented on the POWER5+ processor and other
17107 processors that support the PowerPC V2.03 architecture.
17108 The @option{-mcmpb} option allows GCC to generate the compare bytes
17109 instruction implemented on the POWER6 processor and other processors
17110 that support the PowerPC V2.05 architecture.
17111 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
17112 general-purpose register instructions implemented on the POWER6X
17113 processor and other processors that support the extended PowerPC V2.05
17114 architecture.
17115 The @option{-mhard-dfp} option allows GCC to generate the decimal
17116 floating-point instructions implemented on some POWER processors.
17118 The @option{-mpowerpc64} option allows GCC to generate the additional
17119 64-bit instructions that are found in the full PowerPC64 architecture
17120 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
17121 @option{-mno-powerpc64}.
17123 @item -mcpu=@var{cpu_type}
17124 @opindex mcpu
17125 Set architecture type, register usage, and
17126 instruction scheduling parameters for machine type @var{cpu_type}.
17127 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
17128 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
17129 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
17130 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
17131 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
17132 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
17133 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
17134 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
17135 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
17136 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
17137 @samp{powerpc64}, and @samp{rs64}.
17139 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
17140 PowerPC and 64-bit PowerPC architecture machine
17141 types, with an appropriate, generic processor model assumed for
17142 scheduling purposes.
17144 The other options specify a specific processor.  Code generated under
17145 those options runs best on that processor, and may not run at all on
17146 others.
17148 The @option{-mcpu} options automatically enable or disable the
17149 following options:
17151 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
17152 -mpopcntb -mpopcntd  -mpowerpc64 @gol
17153 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
17154 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
17156 The particular options set for any particular CPU varies between
17157 compiler versions, depending on what setting seems to produce optimal
17158 code for that CPU; it doesn't necessarily reflect the actual hardware's
17159 capabilities.  If you wish to set an individual option to a particular
17160 value, you may specify it after the @option{-mcpu} option, like
17161 @option{-mcpu=970 -mno-altivec}.
17163 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
17164 not enabled or disabled by the @option{-mcpu} option at present because
17165 AIX does not have full support for these options.  You may still
17166 enable or disable them individually if you're sure it'll work in your
17167 environment.
17169 @item -mtune=@var{cpu_type}
17170 @opindex mtune
17171 Set the instruction scheduling parameters for machine type
17172 @var{cpu_type}, but do not set the architecture type or register usage,
17173 as @option{-mcpu=@var{cpu_type}} does.  The same
17174 values for @var{cpu_type} are used for @option{-mtune} as for
17175 @option{-mcpu}.  If both are specified, the code generated uses the
17176 architecture and registers set by @option{-mcpu}, but the
17177 scheduling parameters set by @option{-mtune}.
17179 @item -mcmodel=small
17180 @opindex mcmodel=small
17181 Generate PowerPC64 code for the small model: The TOC is limited to
17182 64k.
17184 @item -mcmodel=medium
17185 @opindex mcmodel=medium
17186 Generate PowerPC64 code for the medium model: The TOC and other static
17187 data may be up to a total of 4G in size.
17189 @item -mcmodel=large
17190 @opindex mcmodel=large
17191 Generate PowerPC64 code for the large model: The TOC may be up to 4G
17192 in size.  Other data and code is only limited by the 64-bit address
17193 space.
17195 @item -maltivec
17196 @itemx -mno-altivec
17197 @opindex maltivec
17198 @opindex mno-altivec
17199 Generate code that uses (does not use) AltiVec instructions, and also
17200 enable the use of built-in functions that allow more direct access to
17201 the AltiVec instruction set.  You may also need to set
17202 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
17203 enhancements.
17205 @item -mvrsave
17206 @itemx -mno-vrsave
17207 @opindex mvrsave
17208 @opindex mno-vrsave
17209 Generate VRSAVE instructions when generating AltiVec code.
17211 @item -mgen-cell-microcode
17212 @opindex mgen-cell-microcode
17213 Generate Cell microcode instructions.
17215 @item -mwarn-cell-microcode
17216 @opindex mwarn-cell-microcode
17217 Warn when a Cell microcode instruction is emitted.  An example
17218 of a Cell microcode instruction is a variable shift.
17220 @item -msecure-plt
17221 @opindex msecure-plt
17222 Generate code that allows @command{ld} and @command{ld.so}
17223 to build executables and shared
17224 libraries with non-executable @code{.plt} and @code{.got} sections.
17225 This is a PowerPC
17226 32-bit SYSV ABI option.
17228 @item -mbss-plt
17229 @opindex mbss-plt
17230 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
17231 fills in, and
17232 requires @code{.plt} and @code{.got}
17233 sections that are both writable and executable.
17234 This is a PowerPC 32-bit SYSV ABI option.
17236 @item -misel
17237 @itemx -mno-isel
17238 @opindex misel
17239 @opindex mno-isel
17240 This switch enables or disables the generation of ISEL instructions.
17242 @item -misel=@var{yes/no}
17243 This switch has been deprecated.  Use @option{-misel} and
17244 @option{-mno-isel} instead.
17246 @item -mspe
17247 @itemx -mno-spe
17248 @opindex mspe
17249 @opindex mno-spe
17250 This switch enables or disables the generation of SPE simd
17251 instructions.
17253 @item -mpaired
17254 @itemx -mno-paired
17255 @opindex mpaired
17256 @opindex mno-paired
17257 This switch enables or disables the generation of PAIRED simd
17258 instructions.
17260 @item -mspe=@var{yes/no}
17261 This option has been deprecated.  Use @option{-mspe} and
17262 @option{-mno-spe} instead.
17264 @item -mvsx
17265 @itemx -mno-vsx
17266 @opindex mvsx
17267 @opindex mno-vsx
17268 Generate code that uses (does not use) vector/scalar (VSX)
17269 instructions, and also enable the use of built-in functions that allow
17270 more direct access to the VSX instruction set.
17272 @item -mfloat-gprs=@var{yes/single/double/no}
17273 @itemx -mfloat-gprs
17274 @opindex mfloat-gprs
17275 This switch enables or disables the generation of floating-point
17276 operations on the general-purpose registers for architectures that
17277 support it.
17279 The argument @var{yes} or @var{single} enables the use of
17280 single-precision floating-point operations.
17282 The argument @var{double} enables the use of single and
17283 double-precision floating-point operations.
17285 The argument @var{no} disables floating-point operations on the
17286 general-purpose registers.
17288 This option is currently only available on the MPC854x.
17290 @item -m32
17291 @itemx -m64
17292 @opindex m32
17293 @opindex m64
17294 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
17295 targets (including GNU/Linux).  The 32-bit environment sets int, long
17296 and pointer to 32 bits and generates code that runs on any PowerPC
17297 variant.  The 64-bit environment sets int to 32 bits and long and
17298 pointer to 64 bits, and generates code for PowerPC64, as for
17299 @option{-mpowerpc64}.
17301 @item -mfull-toc
17302 @itemx -mno-fp-in-toc
17303 @itemx -mno-sum-in-toc
17304 @itemx -mminimal-toc
17305 @opindex mfull-toc
17306 @opindex mno-fp-in-toc
17307 @opindex mno-sum-in-toc
17308 @opindex mminimal-toc
17309 Modify generation of the TOC (Table Of Contents), which is created for
17310 every executable file.  The @option{-mfull-toc} option is selected by
17311 default.  In that case, GCC allocates at least one TOC entry for
17312 each unique non-automatic variable reference in your program.  GCC
17313 also places floating-point constants in the TOC@.  However, only
17314 16,384 entries are available in the TOC@.
17316 If you receive a linker error message that saying you have overflowed
17317 the available TOC space, you can reduce the amount of TOC space used
17318 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
17319 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
17320 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
17321 generate code to calculate the sum of an address and a constant at
17322 run time instead of putting that sum into the TOC@.  You may specify one
17323 or both of these options.  Each causes GCC to produce very slightly
17324 slower and larger code at the expense of conserving TOC space.
17326 If you still run out of space in the TOC even when you specify both of
17327 these options, specify @option{-mminimal-toc} instead.  This option causes
17328 GCC to make only one TOC entry for every file.  When you specify this
17329 option, GCC produces code that is slower and larger but which
17330 uses extremely little TOC space.  You may wish to use this option
17331 only on files that contain less frequently-executed code.
17333 @item -maix64
17334 @itemx -maix32
17335 @opindex maix64
17336 @opindex maix32
17337 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
17338 @code{long} type, and the infrastructure needed to support them.
17339 Specifying @option{-maix64} implies @option{-mpowerpc64},
17340 while @option{-maix32} disables the 64-bit ABI and
17341 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
17343 @item -mxl-compat
17344 @itemx -mno-xl-compat
17345 @opindex mxl-compat
17346 @opindex mno-xl-compat
17347 Produce code that conforms more closely to IBM XL compiler semantics
17348 when using AIX-compatible ABI@.  Pass floating-point arguments to
17349 prototyped functions beyond the register save area (RSA) on the stack
17350 in addition to argument FPRs.  Do not assume that most significant
17351 double in 128-bit long double value is properly rounded when comparing
17352 values and converting to double.  Use XL symbol names for long double
17353 support routines.
17355 The AIX calling convention was extended but not initially documented to
17356 handle an obscure K&R C case of calling a function that takes the
17357 address of its arguments with fewer arguments than declared.  IBM XL
17358 compilers access floating-point arguments that do not fit in the
17359 RSA from the stack when a subroutine is compiled without
17360 optimization.  Because always storing floating-point arguments on the
17361 stack is inefficient and rarely needed, this option is not enabled by
17362 default and only is necessary when calling subroutines compiled by IBM
17363 XL compilers without optimization.
17365 @item -mpe
17366 @opindex mpe
17367 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
17368 application written to use message passing with special startup code to
17369 enable the application to run.  The system must have PE installed in the
17370 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
17371 must be overridden with the @option{-specs=} option to specify the
17372 appropriate directory location.  The Parallel Environment does not
17373 support threads, so the @option{-mpe} option and the @option{-pthread}
17374 option are incompatible.
17376 @item -malign-natural
17377 @itemx -malign-power
17378 @opindex malign-natural
17379 @opindex malign-power
17380 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
17381 @option{-malign-natural} overrides the ABI-defined alignment of larger
17382 types, such as floating-point doubles, on their natural size-based boundary.
17383 The option @option{-malign-power} instructs GCC to follow the ABI-specified
17384 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
17386 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
17387 is not supported.
17389 @item -msoft-float
17390 @itemx -mhard-float
17391 @opindex msoft-float
17392 @opindex mhard-float
17393 Generate code that does not use (uses) the floating-point register set.
17394 Software floating-point emulation is provided if you use the
17395 @option{-msoft-float} option, and pass the option to GCC when linking.
17397 @item -msingle-float
17398 @itemx -mdouble-float
17399 @opindex msingle-float
17400 @opindex mdouble-float
17401 Generate code for single- or double-precision floating-point operations.
17402 @option{-mdouble-float} implies @option{-msingle-float}.
17404 @item -msimple-fpu
17405 @opindex msimple-fpu
17406 Do not generate @code{sqrt} and @code{div} instructions for hardware
17407 floating-point unit.
17409 @item -mfpu=@var{name}
17410 @opindex mfpu
17411 Specify type of floating-point unit.  Valid values for @var{name} are
17412 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
17413 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
17414 @samp{sp_full} (equivalent to @option{-msingle-float}),
17415 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
17417 @item -mxilinx-fpu
17418 @opindex mxilinx-fpu
17419 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
17421 @item -mmultiple
17422 @itemx -mno-multiple
17423 @opindex mmultiple
17424 @opindex mno-multiple
17425 Generate code that uses (does not use) the load multiple word
17426 instructions and the store multiple word instructions.  These
17427 instructions are generated by default on POWER systems, and not
17428 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
17429 PowerPC systems, since those instructions do not work when the
17430 processor is in little-endian mode.  The exceptions are PPC740 and
17431 PPC750 which permit these instructions in little-endian mode.
17433 @item -mstring
17434 @itemx -mno-string
17435 @opindex mstring
17436 @opindex mno-string
17437 Generate code that uses (does not use) the load string instructions
17438 and the store string word instructions to save multiple registers and
17439 do small block moves.  These instructions are generated by default on
17440 POWER systems, and not generated on PowerPC systems.  Do not use
17441 @option{-mstring} on little-endian PowerPC systems, since those
17442 instructions do not work when the processor is in little-endian mode.
17443 The exceptions are PPC740 and PPC750 which permit these instructions
17444 in little-endian mode.
17446 @item -mupdate
17447 @itemx -mno-update
17448 @opindex mupdate
17449 @opindex mno-update
17450 Generate code that uses (does not use) the load or store instructions
17451 that update the base register to the address of the calculated memory
17452 location.  These instructions are generated by default.  If you use
17453 @option{-mno-update}, there is a small window between the time that the
17454 stack pointer is updated and the address of the previous frame is
17455 stored, which means code that walks the stack frame across interrupts or
17456 signals may get corrupted data.
17458 @item -mavoid-indexed-addresses
17459 @itemx -mno-avoid-indexed-addresses
17460 @opindex mavoid-indexed-addresses
17461 @opindex mno-avoid-indexed-addresses
17462 Generate code that tries to avoid (not avoid) the use of indexed load
17463 or store instructions. These instructions can incur a performance
17464 penalty on Power6 processors in certain situations, such as when
17465 stepping through large arrays that cross a 16M boundary.  This option
17466 is enabled by default when targeting Power6 and disabled otherwise.
17468 @item -mfused-madd
17469 @itemx -mno-fused-madd
17470 @opindex mfused-madd
17471 @opindex mno-fused-madd
17472 Generate code that uses (does not use) the floating-point multiply and
17473 accumulate instructions.  These instructions are generated by default
17474 if hardware floating point is used.  The machine-dependent
17475 @option{-mfused-madd} option is now mapped to the machine-independent
17476 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
17477 mapped to @option{-ffp-contract=off}.
17479 @item -mmulhw
17480 @itemx -mno-mulhw
17481 @opindex mmulhw
17482 @opindex mno-mulhw
17483 Generate code that uses (does not use) the half-word multiply and
17484 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
17485 These instructions are generated by default when targeting those
17486 processors.
17488 @item -mdlmzb
17489 @itemx -mno-dlmzb
17490 @opindex mdlmzb
17491 @opindex mno-dlmzb
17492 Generate code that uses (does not use) the string-search @samp{dlmzb}
17493 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
17494 generated by default when targeting those processors.
17496 @item -mno-bit-align
17497 @itemx -mbit-align
17498 @opindex mno-bit-align
17499 @opindex mbit-align
17500 On System V.4 and embedded PowerPC systems do not (do) force structures
17501 and unions that contain bit-fields to be aligned to the base type of the
17502 bit-field.
17504 For example, by default a structure containing nothing but 8
17505 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
17506 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
17507 the structure is aligned to a 1-byte boundary and is 1 byte in
17508 size.
17510 @item -mno-strict-align
17511 @itemx -mstrict-align
17512 @opindex mno-strict-align
17513 @opindex mstrict-align
17514 On System V.4 and embedded PowerPC systems do not (do) assume that
17515 unaligned memory references are handled by the system.
17517 @item -mrelocatable
17518 @itemx -mno-relocatable
17519 @opindex mrelocatable
17520 @opindex mno-relocatable
17521 Generate code that allows (does not allow) a static executable to be
17522 relocated to a different address at run time.  A simple embedded
17523 PowerPC system loader should relocate the entire contents of
17524 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
17525 a table of 32-bit addresses generated by this option.  For this to
17526 work, all objects linked together must be compiled with
17527 @option{-mrelocatable} or @option{-mrelocatable-lib}.
17528 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
17530 @item -mrelocatable-lib
17531 @itemx -mno-relocatable-lib
17532 @opindex mrelocatable-lib
17533 @opindex mno-relocatable-lib
17534 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
17535 @code{.fixup} section to allow static executables to be relocated at
17536 run time, but @option{-mrelocatable-lib} does not use the smaller stack
17537 alignment of @option{-mrelocatable}.  Objects compiled with
17538 @option{-mrelocatable-lib} may be linked with objects compiled with
17539 any combination of the @option{-mrelocatable} options.
17541 @item -mno-toc
17542 @itemx -mtoc
17543 @opindex mno-toc
17544 @opindex mtoc
17545 On System V.4 and embedded PowerPC systems do not (do) assume that
17546 register 2 contains a pointer to a global area pointing to the addresses
17547 used in the program.
17549 @item -mlittle
17550 @itemx -mlittle-endian
17551 @opindex mlittle
17552 @opindex mlittle-endian
17553 On System V.4 and embedded PowerPC systems compile code for the
17554 processor in little-endian mode.  The @option{-mlittle-endian} option is
17555 the same as @option{-mlittle}.
17557 @item -mbig
17558 @itemx -mbig-endian
17559 @opindex mbig
17560 @opindex mbig-endian
17561 On System V.4 and embedded PowerPC systems compile code for the
17562 processor in big-endian mode.  The @option{-mbig-endian} option is
17563 the same as @option{-mbig}.
17565 @item -mdynamic-no-pic
17566 @opindex mdynamic-no-pic
17567 On Darwin and Mac OS X systems, compile code so that it is not
17568 relocatable, but that its external references are relocatable.  The
17569 resulting code is suitable for applications, but not shared
17570 libraries.
17572 @item -msingle-pic-base
17573 @opindex msingle-pic-base
17574 Treat the register used for PIC addressing as read-only, rather than
17575 loading it in the prologue for each function.  The runtime system is
17576 responsible for initializing this register with an appropriate value
17577 before execution begins.
17579 @item -mprioritize-restricted-insns=@var{priority}
17580 @opindex mprioritize-restricted-insns
17581 This option controls the priority that is assigned to
17582 dispatch-slot restricted instructions during the second scheduling
17583 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
17584 or @samp{2} to assign no, highest, or second-highest (respectively) 
17585 priority to dispatch-slot restricted
17586 instructions.
17588 @item -msched-costly-dep=@var{dependence_type}
17589 @opindex msched-costly-dep
17590 This option controls which dependences are considered costly
17591 by the target during instruction scheduling.  The argument
17592 @var{dependence_type} takes one of the following values:
17594 @table @asis
17595 @item @samp{no}
17596 No dependence is costly.
17598 @item @samp{all}
17599 All dependences are costly.
17601 @item @samp{true_store_to_load}
17602 A true dependence from store to load is costly.
17604 @item @samp{store_to_load}
17605 Any dependence from store to load is costly.
17607 @item @var{number}
17608 Any dependence for which the latency is greater than or equal to 
17609 @var{number} is costly.
17610 @end table
17612 @item -minsert-sched-nops=@var{scheme}
17613 @opindex minsert-sched-nops
17614 This option controls which NOP insertion scheme is used during
17615 the second scheduling pass.  The argument @var{scheme} takes one of the
17616 following values:
17618 @table @asis
17619 @item @samp{no}
17620 Don't insert NOPs.
17622 @item @samp{pad}
17623 Pad with NOPs any dispatch group that has vacant issue slots,
17624 according to the scheduler's grouping.
17626 @item @samp{regroup_exact}
17627 Insert NOPs to force costly dependent insns into
17628 separate groups.  Insert exactly as many NOPs as needed to force an insn
17629 to a new group, according to the estimated processor grouping.
17631 @item @var{number}
17632 Insert NOPs to force costly dependent insns into
17633 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
17634 @end table
17636 @item -mcall-sysv
17637 @opindex mcall-sysv
17638 On System V.4 and embedded PowerPC systems compile code using calling
17639 conventions that adhere to the March 1995 draft of the System V
17640 Application Binary Interface, PowerPC processor supplement.  This is the
17641 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
17643 @item -mcall-sysv-eabi
17644 @itemx -mcall-eabi
17645 @opindex mcall-sysv-eabi
17646 @opindex mcall-eabi
17647 Specify both @option{-mcall-sysv} and @option{-meabi} options.
17649 @item -mcall-sysv-noeabi
17650 @opindex mcall-sysv-noeabi
17651 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
17653 @item -mcall-aixdesc
17654 @opindex m
17655 On System V.4 and embedded PowerPC systems compile code for the AIX
17656 operating system.
17658 @item -mcall-linux
17659 @opindex mcall-linux
17660 On System V.4 and embedded PowerPC systems compile code for the
17661 Linux-based GNU system.
17663 @item -mcall-freebsd
17664 @opindex mcall-freebsd
17665 On System V.4 and embedded PowerPC systems compile code for the
17666 FreeBSD operating system.
17668 @item -mcall-netbsd
17669 @opindex mcall-netbsd
17670 On System V.4 and embedded PowerPC systems compile code for the
17671 NetBSD operating system.
17673 @item -mcall-openbsd
17674 @opindex mcall-netbsd
17675 On System V.4 and embedded PowerPC systems compile code for the
17676 OpenBSD operating system.
17678 @item -maix-struct-return
17679 @opindex maix-struct-return
17680 Return all structures in memory (as specified by the AIX ABI)@.
17682 @item -msvr4-struct-return
17683 @opindex msvr4-struct-return
17684 Return structures smaller than 8 bytes in registers (as specified by the
17685 SVR4 ABI)@.
17687 @item -mabi=@var{abi-type}
17688 @opindex mabi
17689 Extend the current ABI with a particular extension, or remove such extension.
17690 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
17691 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
17693 @item -mabi=spe
17694 @opindex mabi=spe
17695 Extend the current ABI with SPE ABI extensions.  This does not change
17696 the default ABI, instead it adds the SPE ABI extensions to the current
17697 ABI@.
17699 @item -mabi=no-spe
17700 @opindex mabi=no-spe
17701 Disable Book-E SPE ABI extensions for the current ABI@.
17703 @item -mabi=ibmlongdouble
17704 @opindex mabi=ibmlongdouble
17705 Change the current ABI to use IBM extended-precision long double.
17706 This is a PowerPC 32-bit SYSV ABI option.
17708 @item -mabi=ieeelongdouble
17709 @opindex mabi=ieeelongdouble
17710 Change the current ABI to use IEEE extended-precision long double.
17711 This is a PowerPC 32-bit Linux ABI option.
17713 @item -mprototype
17714 @itemx -mno-prototype
17715 @opindex mprototype
17716 @opindex mno-prototype
17717 On System V.4 and embedded PowerPC systems assume that all calls to
17718 variable argument functions are properly prototyped.  Otherwise, the
17719 compiler must insert an instruction before every non-prototyped call to
17720 set or clear bit 6 of the condition code register (@var{CR}) to
17721 indicate whether floating-point values are passed in the floating-point
17722 registers in case the function takes variable arguments.  With
17723 @option{-mprototype}, only calls to prototyped variable argument functions
17724 set or clear the bit.
17726 @item -msim
17727 @opindex msim
17728 On embedded PowerPC systems, assume that the startup module is called
17729 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
17730 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
17731 configurations.
17733 @item -mmvme
17734 @opindex mmvme
17735 On embedded PowerPC systems, assume that the startup module is called
17736 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
17737 @file{libc.a}.
17739 @item -mads
17740 @opindex mads
17741 On embedded PowerPC systems, assume that the startup module is called
17742 @file{crt0.o} and the standard C libraries are @file{libads.a} and
17743 @file{libc.a}.
17745 @item -myellowknife
17746 @opindex myellowknife
17747 On embedded PowerPC systems, assume that the startup module is called
17748 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
17749 @file{libc.a}.
17751 @item -mvxworks
17752 @opindex mvxworks
17753 On System V.4 and embedded PowerPC systems, specify that you are
17754 compiling for a VxWorks system.
17756 @item -memb
17757 @opindex memb
17758 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
17759 header to indicate that @samp{eabi} extended relocations are used.
17761 @item -meabi
17762 @itemx -mno-eabi
17763 @opindex meabi
17764 @opindex mno-eabi
17765 On System V.4 and embedded PowerPC systems do (do not) adhere to the
17766 Embedded Applications Binary Interface (EABI), which is a set of
17767 modifications to the System V.4 specifications.  Selecting @option{-meabi}
17768 means that the stack is aligned to an 8-byte boundary, a function
17769 @code{__eabi} is called from @code{main} to set up the EABI
17770 environment, and the @option{-msdata} option can use both @code{r2} and
17771 @code{r13} to point to two separate small data areas.  Selecting
17772 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
17773 no EABI initialization function is called from @code{main}, and the
17774 @option{-msdata} option only uses @code{r13} to point to a single
17775 small data area.  The @option{-meabi} option is on by default if you
17776 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
17778 @item -msdata=eabi
17779 @opindex msdata=eabi
17780 On System V.4 and embedded PowerPC systems, put small initialized
17781 @code{const} global and static data in the @samp{.sdata2} section, which
17782 is pointed to by register @code{r2}.  Put small initialized
17783 non-@code{const} global and static data in the @samp{.sdata} section,
17784 which is pointed to by register @code{r13}.  Put small uninitialized
17785 global and static data in the @samp{.sbss} section, which is adjacent to
17786 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
17787 incompatible with the @option{-mrelocatable} option.  The
17788 @option{-msdata=eabi} option also sets the @option{-memb} option.
17790 @item -msdata=sysv
17791 @opindex msdata=sysv
17792 On System V.4 and embedded PowerPC systems, put small global and static
17793 data in the @samp{.sdata} section, which is pointed to by register
17794 @code{r13}.  Put small uninitialized global and static data in the
17795 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
17796 The @option{-msdata=sysv} option is incompatible with the
17797 @option{-mrelocatable} option.
17799 @item -msdata=default
17800 @itemx -msdata
17801 @opindex msdata=default
17802 @opindex msdata
17803 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
17804 compile code the same as @option{-msdata=eabi}, otherwise compile code the
17805 same as @option{-msdata=sysv}.
17807 @item -msdata=data
17808 @opindex msdata=data
17809 On System V.4 and embedded PowerPC systems, put small global
17810 data in the @samp{.sdata} section.  Put small uninitialized global
17811 data in the @samp{.sbss} section.  Do not use register @code{r13}
17812 to address small data however.  This is the default behavior unless
17813 other @option{-msdata} options are used.
17815 @item -msdata=none
17816 @itemx -mno-sdata
17817 @opindex msdata=none
17818 @opindex mno-sdata
17819 On embedded PowerPC systems, put all initialized global and static data
17820 in the @samp{.data} section, and all uninitialized data in the
17821 @samp{.bss} section.
17823 @item -mblock-move-inline-limit=@var{num}
17824 @opindex mblock-move-inline-limit
17825 Inline all block moves (such as calls to @code{memcpy} or structure
17826 copies) less than or equal to @var{num} bytes.  The minimum value for
17827 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
17828 targets.  The default value is target-specific.
17830 @item -G @var{num}
17831 @opindex G
17832 @cindex smaller data references (PowerPC)
17833 @cindex .sdata/.sdata2 references (PowerPC)
17834 On embedded PowerPC systems, put global and static items less than or
17835 equal to @var{num} bytes into the small data or BSS sections instead of
17836 the normal data or BSS section.  By default, @var{num} is 8.  The
17837 @option{-G @var{num}} switch is also passed to the linker.
17838 All modules should be compiled with the same @option{-G @var{num}} value.
17840 @item -mregnames
17841 @itemx -mno-regnames
17842 @opindex mregnames
17843 @opindex mno-regnames
17844 On System V.4 and embedded PowerPC systems do (do not) emit register
17845 names in the assembly language output using symbolic forms.
17847 @item -mlongcall
17848 @itemx -mno-longcall
17849 @opindex mlongcall
17850 @opindex mno-longcall
17851 By default assume that all calls are far away so that a longer and more
17852 expensive calling sequence is required.  This is required for calls
17853 farther than 32 megabytes (33,554,432 bytes) from the current location.
17854 A short call is generated if the compiler knows
17855 the call cannot be that far away.  This setting can be overridden by
17856 the @code{shortcall} function attribute, or by @code{#pragma
17857 longcall(0)}.
17859 Some linkers are capable of detecting out-of-range calls and generating
17860 glue code on the fly.  On these systems, long calls are unnecessary and
17861 generate slower code.  As of this writing, the AIX linker can do this,
17862 as can the GNU linker for PowerPC/64.  It is planned to add this feature
17863 to the GNU linker for 32-bit PowerPC systems as well.
17865 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
17866 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
17867 addresses represent the callee and the branch island.  The
17868 Darwin/PPC linker prefers the first address and generates a @code{bl
17869 callee} if the PPC @code{bl} instruction reaches the callee directly;
17870 otherwise, the linker generates @code{bl L42} to call the branch
17871 island.  The branch island is appended to the body of the
17872 calling function; it computes the full 32-bit address of the callee
17873 and jumps to it.
17875 On Mach-O (Darwin) systems, this option directs the compiler emit to
17876 the glue for every direct call, and the Darwin linker decides whether
17877 to use or discard it.
17879 In the future, GCC may ignore all longcall specifications
17880 when the linker is known to generate glue.
17882 @item -mtls-markers
17883 @itemx -mno-tls-markers
17884 @opindex mtls-markers
17885 @opindex mno-tls-markers
17886 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
17887 specifying the function argument.  The relocation allows the linker to
17888 reliably associate function call with argument setup instructions for
17889 TLS optimization, which in turn allows GCC to better schedule the
17890 sequence.
17892 @item -pthread
17893 @opindex pthread
17894 Adds support for multithreading with the @dfn{pthreads} library.
17895 This option sets flags for both the preprocessor and linker.
17897 @item -mrecip
17898 @itemx -mno-recip
17899 @opindex mrecip
17900 This option enables use of the reciprocal estimate and
17901 reciprocal square root estimate instructions with additional
17902 Newton-Raphson steps to increase precision instead of doing a divide or
17903 square root and divide for floating-point arguments.  You should use
17904 the @option{-ffast-math} option when using @option{-mrecip} (or at
17905 least @option{-funsafe-math-optimizations},
17906 @option{-finite-math-only}, @option{-freciprocal-math} and
17907 @option{-fno-trapping-math}).  Note that while the throughput of the
17908 sequence is generally higher than the throughput of the non-reciprocal
17909 instruction, the precision of the sequence can be decreased by up to 2
17910 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
17911 roots.
17913 @item -mrecip=@var{opt}
17914 @opindex mrecip=opt
17915 This option controls which reciprocal estimate instructions
17916 may be used.  @var{opt} is a comma-separated list of options, which may
17917 be preceded by a @code{!} to invert the option:
17918 @code{all}: enable all estimate instructions,
17919 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
17920 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
17921 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
17922 @code{divf}: enable the single-precision reciprocal approximation instructions;
17923 @code{divd}: enable the double-precision reciprocal approximation instructions;
17924 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
17925 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
17926 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
17928 So, for example, @option{-mrecip=all,!rsqrtd} enables
17929 all of the reciprocal estimate instructions, except for the
17930 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
17931 which handle the double-precision reciprocal square root calculations.
17933 @item -mrecip-precision
17934 @itemx -mno-recip-precision
17935 @opindex mrecip-precision
17936 Assume (do not assume) that the reciprocal estimate instructions
17937 provide higher-precision estimates than is mandated by the PowerPC
17938 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
17939 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
17940 The double-precision square root estimate instructions are not generated by
17941 default on low-precision machines, since they do not provide an
17942 estimate that converges after three steps.
17944 @item -mveclibabi=@var{type}
17945 @opindex mveclibabi
17946 Specifies the ABI type to use for vectorizing intrinsics using an
17947 external library.  The only type supported at present is @code{mass},
17948 which specifies to use IBM's Mathematical Acceleration Subsystem
17949 (MASS) libraries for vectorizing intrinsics using external libraries.
17950 GCC currently emits calls to @code{acosd2}, @code{acosf4},
17951 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
17952 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
17953 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
17954 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
17955 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
17956 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
17957 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
17958 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
17959 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
17960 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
17961 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
17962 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
17963 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
17964 for power7.  Both @option{-ftree-vectorize} and
17965 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
17966 libraries must be specified at link time.
17968 @item -mfriz
17969 @itemx -mno-friz
17970 @opindex mfriz
17971 Generate (do not generate) the @code{friz} instruction when the
17972 @option{-funsafe-math-optimizations} option is used to optimize
17973 rounding of floating-point values to 64-bit integer and back to floating
17974 point.  The @code{friz} instruction does not return the same value if
17975 the floating-point number is too large to fit in an integer.
17977 @item -mpointers-to-nested-functions
17978 @itemx -mno-pointers-to-nested-functions
17979 @opindex mpointers-to-nested-functions
17980 Generate (do not generate) code to load up the static chain register
17981 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
17982 systems where a function pointer points to a 3-word descriptor giving
17983 the function address, TOC value to be loaded in register @var{r2}, and
17984 static chain value to be loaded in register @var{r11}.  The
17985 @option{-mpointers-to-nested-functions} is on by default.  You cannot
17986 call through pointers to nested functions or pointers
17987 to functions compiled in other languages that use the static chain if
17988 you use the @option{-mno-pointers-to-nested-functions}.
17990 @item -msave-toc-indirect
17991 @itemx -mno-save-toc-indirect
17992 @opindex msave-toc-indirect
17993 Generate (do not generate) code to save the TOC value in the reserved
17994 stack location in the function prologue if the function calls through
17995 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
17996 saved in the prologue, it is saved just before the call through the
17997 pointer.  The @option{-mno-save-toc-indirect} option is the default.
17998 @end table
18000 @node RX Options
18001 @subsection RX Options
18002 @cindex RX Options
18004 These command-line options are defined for RX targets:
18006 @table @gcctabopt
18007 @item -m64bit-doubles
18008 @itemx -m32bit-doubles
18009 @opindex m64bit-doubles
18010 @opindex m32bit-doubles
18011 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
18012 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
18013 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
18014 works on 32-bit values, which is why the default is
18015 @option{-m32bit-doubles}.
18017 @item -fpu
18018 @itemx -nofpu
18019 @opindex fpu
18020 @opindex nofpu
18021 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
18022 floating-point hardware.  The default is enabled for the @var{RX600}
18023 series and disabled for the @var{RX200} series.
18025 Floating-point instructions are only generated for 32-bit floating-point 
18026 values, however, so the FPU hardware is not used for doubles if the
18027 @option{-m64bit-doubles} option is used.
18029 @emph{Note} If the @option{-fpu} option is enabled then
18030 @option{-funsafe-math-optimizations} is also enabled automatically.
18031 This is because the RX FPU instructions are themselves unsafe.
18033 @item -mcpu=@var{name}
18034 @opindex -mcpu
18035 Selects the type of RX CPU to be targeted.  Currently three types are
18036 supported, the generic @var{RX600} and @var{RX200} series hardware and
18037 the specific @var{RX610} CPU.  The default is @var{RX600}.
18039 The only difference between @var{RX600} and @var{RX610} is that the
18040 @var{RX610} does not support the @code{MVTIPL} instruction.
18042 The @var{RX200} series does not have a hardware floating-point unit
18043 and so @option{-nofpu} is enabled by default when this type is
18044 selected.
18046 @item -mbig-endian-data
18047 @itemx -mlittle-endian-data
18048 @opindex mbig-endian-data
18049 @opindex mlittle-endian-data
18050 Store data (but not code) in the big-endian format.  The default is
18051 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
18052 format.
18054 @item -msmall-data-limit=@var{N}
18055 @opindex msmall-data-limit
18056 Specifies the maximum size in bytes of global and static variables
18057 which can be placed into the small data area.  Using the small data
18058 area can lead to smaller and faster code, but the size of area is
18059 limited and it is up to the programmer to ensure that the area does
18060 not overflow.  Also when the small data area is used one of the RX's
18061 registers (usually @code{r13}) is reserved for use pointing to this
18062 area, so it is no longer available for use by the compiler.  This
18063 could result in slower and/or larger code if variables are pushed onto
18064 the stack instead of being held in this register.
18066 Note, common variables (variables that have not been initialized) and
18067 constants are not placed into the small data area as they are assigned
18068 to other sections in the output executable.
18070 The default value is zero, which disables this feature.  Note, this
18071 feature is not enabled by default with higher optimization levels
18072 (@option{-O2} etc) because of the potentially detrimental effects of
18073 reserving a register.  It is up to the programmer to experiment and
18074 discover whether this feature is of benefit to their program.  See the
18075 description of the @option{-mpid} option for a description of how the
18076 actual register to hold the small data area pointer is chosen.
18078 @item -msim
18079 @itemx -mno-sim
18080 @opindex msim
18081 @opindex mno-sim
18082 Use the simulator runtime.  The default is to use the libgloss
18083 board-specific runtime.
18085 @item -mas100-syntax
18086 @itemx -mno-as100-syntax
18087 @opindex mas100-syntax
18088 @opindex mno-as100-syntax
18089 When generating assembler output use a syntax that is compatible with
18090 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
18091 assembler, but it has some restrictions so it is not generated by default.
18093 @item -mmax-constant-size=@var{N}
18094 @opindex mmax-constant-size
18095 Specifies the maximum size, in bytes, of a constant that can be used as
18096 an operand in a RX instruction.  Although the RX instruction set does
18097 allow constants of up to 4 bytes in length to be used in instructions,
18098 a longer value equates to a longer instruction.  Thus in some
18099 circumstances it can be beneficial to restrict the size of constants
18100 that are used in instructions.  Constants that are too big are instead
18101 placed into a constant pool and referenced via register indirection.
18103 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
18104 or 4 means that constants of any size are allowed.
18106 @item -mrelax
18107 @opindex mrelax
18108 Enable linker relaxation.  Linker relaxation is a process whereby the
18109 linker attempts to reduce the size of a program by finding shorter
18110 versions of various instructions.  Disabled by default.
18112 @item -mint-register=@var{N}
18113 @opindex mint-register
18114 Specify the number of registers to reserve for fast interrupt handler
18115 functions.  The value @var{N} can be between 0 and 4.  A value of 1
18116 means that register @code{r13} is reserved for the exclusive use
18117 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
18118 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
18119 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
18120 A value of 0, the default, does not reserve any registers.
18122 @item -msave-acc-in-interrupts
18123 @opindex msave-acc-in-interrupts
18124 Specifies that interrupt handler functions should preserve the
18125 accumulator register.  This is only necessary if normal code might use
18126 the accumulator register, for example because it performs 64-bit
18127 multiplications.  The default is to ignore the accumulator as this
18128 makes the interrupt handlers faster.
18130 @item -mpid
18131 @itemx -mno-pid
18132 @opindex mpid
18133 @opindex mno-pid
18134 Enables the generation of position independent data.  When enabled any
18135 access to constant data is done via an offset from a base address
18136 held in a register.  This allows the location of constant data to be
18137 determined at run time without requiring the executable to be
18138 relocated, which is a benefit to embedded applications with tight
18139 memory constraints.  Data that can be modified is not affected by this
18140 option.
18142 Note, using this feature reserves a register, usually @code{r13}, for
18143 the constant data base address.  This can result in slower and/or
18144 larger code, especially in complicated functions.
18146 The actual register chosen to hold the constant data base address
18147 depends upon whether the @option{-msmall-data-limit} and/or the
18148 @option{-mint-register} command-line options are enabled.  Starting
18149 with register @code{r13} and proceeding downwards, registers are
18150 allocated first to satisfy the requirements of @option{-mint-register},
18151 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
18152 is possible for the small data area register to be @code{r8} if both
18153 @option{-mint-register=4} and @option{-mpid} are specified on the
18154 command line.
18156 By default this feature is not enabled.  The default can be restored
18157 via the @option{-mno-pid} command-line option.
18159 @item -mno-warn-multiple-fast-interrupts
18160 @itemx -mwarn-multiple-fast-interrupts
18161 @opindex mno-warn-multiple-fast-interrupts
18162 @opindex mwarn-multiple-fast-interrupts
18163 Prevents GCC from issuing a warning message if it finds more than one
18164 fast interrupt handler when it is compiling a file.  The default is to
18165 issue a warning for each extra fast interrupt handler found, as the RX
18166 only supports one such interrupt.
18168 @end table
18170 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
18171 has special significance to the RX port when used with the
18172 @code{interrupt} function attribute.  This attribute indicates a
18173 function intended to process fast interrupts.  GCC ensures
18174 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
18175 and/or @code{r13} and only provided that the normal use of the
18176 corresponding registers have been restricted via the
18177 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
18178 options.
18180 @node S/390 and zSeries Options
18181 @subsection S/390 and zSeries Options
18182 @cindex S/390 and zSeries Options
18184 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
18186 @table @gcctabopt
18187 @item -mhard-float
18188 @itemx -msoft-float
18189 @opindex mhard-float
18190 @opindex msoft-float
18191 Use (do not use) the hardware floating-point instructions and registers
18192 for floating-point operations.  When @option{-msoft-float} is specified,
18193 functions in @file{libgcc.a} are used to perform floating-point
18194 operations.  When @option{-mhard-float} is specified, the compiler
18195 generates IEEE floating-point instructions.  This is the default.
18197 @item -mhard-dfp
18198 @itemx -mno-hard-dfp
18199 @opindex mhard-dfp
18200 @opindex mno-hard-dfp
18201 Use (do not use) the hardware decimal-floating-point instructions for
18202 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
18203 specified, functions in @file{libgcc.a} are used to perform
18204 decimal-floating-point operations.  When @option{-mhard-dfp} is
18205 specified, the compiler generates decimal-floating-point hardware
18206 instructions.  This is the default for @option{-march=z9-ec} or higher.
18208 @item -mlong-double-64
18209 @itemx -mlong-double-128
18210 @opindex mlong-double-64
18211 @opindex mlong-double-128
18212 These switches control the size of @code{long double} type. A size
18213 of 64 bits makes the @code{long double} type equivalent to the @code{double}
18214 type. This is the default.
18216 @item -mbackchain
18217 @itemx -mno-backchain
18218 @opindex mbackchain
18219 @opindex mno-backchain
18220 Store (do not store) the address of the caller's frame as backchain pointer
18221 into the callee's stack frame.
18222 A backchain may be needed to allow debugging using tools that do not understand
18223 DWARF 2 call frame information.
18224 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
18225 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
18226 the backchain is placed into the topmost word of the 96/160 byte register
18227 save area.
18229 In general, code compiled with @option{-mbackchain} is call-compatible with
18230 code compiled with @option{-mmo-backchain}; however, use of the backchain
18231 for debugging purposes usually requires that the whole binary is built with
18232 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
18233 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
18234 to build a linux kernel use @option{-msoft-float}.
18236 The default is to not maintain the backchain.
18238 @item -mpacked-stack
18239 @itemx -mno-packed-stack
18240 @opindex mpacked-stack
18241 @opindex mno-packed-stack
18242 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
18243 specified, the compiler uses the all fields of the 96/160 byte register save
18244 area only for their default purpose; unused fields still take up stack space.
18245 When @option{-mpacked-stack} is specified, register save slots are densely
18246 packed at the top of the register save area; unused space is reused for other
18247 purposes, allowing for more efficient use of the available stack space.
18248 However, when @option{-mbackchain} is also in effect, the topmost word of
18249 the save area is always used to store the backchain, and the return address
18250 register is always saved two words below the backchain.
18252 As long as the stack frame backchain is not used, code generated with
18253 @option{-mpacked-stack} is call-compatible with code generated with
18254 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
18255 S/390 or zSeries generated code that uses the stack frame backchain at run
18256 time, not just for debugging purposes.  Such code is not call-compatible
18257 with code compiled with @option{-mpacked-stack}.  Also, note that the
18258 combination of @option{-mbackchain},
18259 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
18260 to build a linux kernel use @option{-msoft-float}.
18262 The default is to not use the packed stack layout.
18264 @item -msmall-exec
18265 @itemx -mno-small-exec
18266 @opindex msmall-exec
18267 @opindex mno-small-exec
18268 Generate (or do not generate) code using the @code{bras} instruction
18269 to do subroutine calls.
18270 This only works reliably if the total executable size does not
18271 exceed 64k.  The default is to use the @code{basr} instruction instead,
18272 which does not have this limitation.
18274 @item -m64
18275 @itemx -m31
18276 @opindex m64
18277 @opindex m31
18278 When @option{-m31} is specified, generate code compliant to the
18279 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
18280 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
18281 particular to generate 64-bit instructions.  For the @samp{s390}
18282 targets, the default is @option{-m31}, while the @samp{s390x}
18283 targets default to @option{-m64}.
18285 @item -mzarch
18286 @itemx -mesa
18287 @opindex mzarch
18288 @opindex mesa
18289 When @option{-mzarch} is specified, generate code using the
18290 instructions available on z/Architecture.
18291 When @option{-mesa} is specified, generate code using the
18292 instructions available on ESA/390.  Note that @option{-mesa} is
18293 not possible with @option{-m64}.
18294 When generating code compliant to the GNU/Linux for S/390 ABI,
18295 the default is @option{-mesa}.  When generating code compliant
18296 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
18298 @item -mmvcle
18299 @itemx -mno-mvcle
18300 @opindex mmvcle
18301 @opindex mno-mvcle
18302 Generate (or do not generate) code using the @code{mvcle} instruction
18303 to perform block moves.  When @option{-mno-mvcle} is specified,
18304 use a @code{mvc} loop instead.  This is the default unless optimizing for
18305 size.
18307 @item -mdebug
18308 @itemx -mno-debug
18309 @opindex mdebug
18310 @opindex mno-debug
18311 Print (or do not print) additional debug information when compiling.
18312 The default is to not print debug information.
18314 @item -march=@var{cpu-type}
18315 @opindex march
18316 Generate code that runs on @var{cpu-type}, which is the name of a system
18317 representing a certain processor type.  Possible values for
18318 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
18319 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
18320 When generating code using the instructions available on z/Architecture,
18321 the default is @option{-march=z900}.  Otherwise, the default is
18322 @option{-march=g5}.
18324 @item -mtune=@var{cpu-type}
18325 @opindex mtune
18326 Tune to @var{cpu-type} everything applicable about the generated code,
18327 except for the ABI and the set of available instructions.
18328 The list of @var{cpu-type} values is the same as for @option{-march}.
18329 The default is the value used for @option{-march}.
18331 @item -mtpf-trace
18332 @itemx -mno-tpf-trace
18333 @opindex mtpf-trace
18334 @opindex mno-tpf-trace
18335 Generate code that adds (does not add) in TPF OS specific branches to trace
18336 routines in the operating system.  This option is off by default, even
18337 when compiling for the TPF OS@.
18339 @item -mfused-madd
18340 @itemx -mno-fused-madd
18341 @opindex mfused-madd
18342 @opindex mno-fused-madd
18343 Generate code that uses (does not use) the floating-point multiply and
18344 accumulate instructions.  These instructions are generated by default if
18345 hardware floating point is used.
18347 @item -mwarn-framesize=@var{framesize}
18348 @opindex mwarn-framesize
18349 Emit a warning if the current function exceeds the given frame size.  Because
18350 this is a compile-time check it doesn't need to be a real problem when the program
18351 runs.  It is intended to identify functions that most probably cause
18352 a stack overflow.  It is useful to be used in an environment with limited stack
18353 size e.g.@: the linux kernel.
18355 @item -mwarn-dynamicstack
18356 @opindex mwarn-dynamicstack
18357 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
18358 arrays.  This is generally a bad idea with a limited stack size.
18360 @item -mstack-guard=@var{stack-guard}
18361 @itemx -mstack-size=@var{stack-size}
18362 @opindex mstack-guard
18363 @opindex mstack-size
18364 If these options are provided the S/390 back end emits additional instructions in
18365 the function prologue that trigger a trap if the stack size is @var{stack-guard}
18366 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
18367 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
18368 the frame size of the compiled function is chosen.
18369 These options are intended to be used to help debugging stack overflow problems.
18370 The additionally emitted code causes only little overhead and hence can also be
18371 used in production-like systems without greater performance degradation.  The given
18372 values have to be exact powers of 2 and @var{stack-size} has to be greater than
18373 @var{stack-guard} without exceeding 64k.
18374 In order to be efficient the extra code makes the assumption that the stack starts
18375 at an address aligned to the value given by @var{stack-size}.
18376 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
18377 @end table
18379 @node Score Options
18380 @subsection Score Options
18381 @cindex Score Options
18383 These options are defined for Score implementations:
18385 @table @gcctabopt
18386 @item -meb
18387 @opindex meb
18388 Compile code for big-endian mode.  This is the default.
18390 @item -mel
18391 @opindex mel
18392 Compile code for little-endian mode.
18394 @item -mnhwloop
18395 @opindex mnhwloop
18396 Disable generation of @code{bcnz} instructions.
18398 @item -muls
18399 @opindex muls
18400 Enable generation of unaligned load and store instructions.
18402 @item -mmac
18403 @opindex mmac
18404 Enable the use of multiply-accumulate instructions. Disabled by default.
18406 @item -mscore5
18407 @opindex mscore5
18408 Specify the SCORE5 as the target architecture.
18410 @item -mscore5u
18411 @opindex mscore5u
18412 Specify the SCORE5U of the target architecture.
18414 @item -mscore7
18415 @opindex mscore7
18416 Specify the SCORE7 as the target architecture. This is the default.
18418 @item -mscore7d
18419 @opindex mscore7d
18420 Specify the SCORE7D as the target architecture.
18421 @end table
18423 @node SH Options
18424 @subsection SH Options
18426 These @samp{-m} options are defined for the SH implementations:
18428 @table @gcctabopt
18429 @item -m1
18430 @opindex m1
18431 Generate code for the SH1.
18433 @item -m2
18434 @opindex m2
18435 Generate code for the SH2.
18437 @item -m2e
18438 Generate code for the SH2e.
18440 @item -m2a-nofpu
18441 @opindex m2a-nofpu
18442 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
18443 that the floating-point unit is not used.
18445 @item -m2a-single-only
18446 @opindex m2a-single-only
18447 Generate code for the SH2a-FPU, in such a way that no double-precision
18448 floating-point operations are used.
18450 @item -m2a-single
18451 @opindex m2a-single
18452 Generate code for the SH2a-FPU assuming the floating-point unit is in
18453 single-precision mode by default.
18455 @item -m2a
18456 @opindex m2a
18457 Generate code for the SH2a-FPU assuming the floating-point unit is in
18458 double-precision mode by default.
18460 @item -m3
18461 @opindex m3
18462 Generate code for the SH3.
18464 @item -m3e
18465 @opindex m3e
18466 Generate code for the SH3e.
18468 @item -m4-nofpu
18469 @opindex m4-nofpu
18470 Generate code for the SH4 without a floating-point unit.
18472 @item -m4-single-only
18473 @opindex m4-single-only
18474 Generate code for the SH4 with a floating-point unit that only
18475 supports single-precision arithmetic.
18477 @item -m4-single
18478 @opindex m4-single
18479 Generate code for the SH4 assuming the floating-point unit is in
18480 single-precision mode by default.
18482 @item -m4
18483 @opindex m4
18484 Generate code for the SH4.
18486 @item -m4a-nofpu
18487 @opindex m4a-nofpu
18488 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
18489 floating-point unit is not used.
18491 @item -m4a-single-only
18492 @opindex m4a-single-only
18493 Generate code for the SH4a, in such a way that no double-precision
18494 floating-point operations are used.
18496 @item -m4a-single
18497 @opindex m4a-single
18498 Generate code for the SH4a assuming the floating-point unit is in
18499 single-precision mode by default.
18501 @item -m4a
18502 @opindex m4a
18503 Generate code for the SH4a.
18505 @item -m4al
18506 @opindex m4al
18507 Same as @option{-m4a-nofpu}, except that it implicitly passes
18508 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
18509 instructions at the moment.
18511 @item -mb
18512 @opindex mb
18513 Compile code for the processor in big-endian mode.
18515 @item -ml
18516 @opindex ml
18517 Compile code for the processor in little-endian mode.
18519 @item -mdalign
18520 @opindex mdalign
18521 Align doubles at 64-bit boundaries.  Note that this changes the calling
18522 conventions, and thus some functions from the standard C library do
18523 not work unless you recompile it first with @option{-mdalign}.
18525 @item -mrelax
18526 @opindex mrelax
18527 Shorten some address references at link time, when possible; uses the
18528 linker option @option{-relax}.
18530 @item -mbigtable
18531 @opindex mbigtable
18532 Use 32-bit offsets in @code{switch} tables.  The default is to use
18533 16-bit offsets.
18535 @item -mbitops
18536 @opindex mbitops
18537 Enable the use of bit manipulation instructions on SH2A.
18539 @item -mfmovd
18540 @opindex mfmovd
18541 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
18542 alignment constraints.
18544 @item -mhitachi
18545 @opindex mhitachi
18546 Comply with the calling conventions defined by Renesas.
18548 @item -mrenesas
18549 @opindex mhitachi
18550 Comply with the calling conventions defined by Renesas.
18552 @item -mno-renesas
18553 @opindex mhitachi
18554 Comply with the calling conventions defined for GCC before the Renesas
18555 conventions were available.  This option is the default for all
18556 targets of the SH toolchain.
18558 @item -mnomacsave
18559 @opindex mnomacsave
18560 Mark the @code{MAC} register as call-clobbered, even if
18561 @option{-mhitachi} is given.
18563 @item -mieee
18564 @itemx -mno-ieee
18565 @opindex mieee
18566 @opindex mnoieee
18567 Control the IEEE compliance of floating-point comparisons, which affects the
18568 handling of cases where the result of a comparison is unordered.  By default
18569 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
18570 enabled @option{-mno-ieee} is implicitly set, which results in faster
18571 floating-point greater-equal and less-equal comparisons.  The implcit settings
18572 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
18574 @item -minline-ic_invalidate
18575 @opindex minline-ic_invalidate
18576 Inline code to invalidate instruction cache entries after setting up
18577 nested function trampolines.
18578 This option has no effect if @option{-musermode} is in effect and the selected
18579 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
18580 instruction.
18581 If the selected code generation option does not allow the use of the @code{icbi}
18582 instruction, and @option{-musermode} is not in effect, the inlined code
18583 manipulates the instruction cache address array directly with an associative
18584 write.  This not only requires privileged mode at run time, but it also
18585 fails if the cache line had been mapped via the TLB and has become unmapped.
18587 @item -misize
18588 @opindex misize
18589 Dump instruction size and location in the assembly code.
18591 @item -mpadstruct
18592 @opindex mpadstruct
18593 This option is deprecated.  It pads structures to multiple of 4 bytes,
18594 which is incompatible with the SH ABI@.
18596 @item -matomic-model=@var{model}
18597 @opindex matomic-model=@var{model}
18598 Sets the model of atomic operations and additional parameters as a comma
18599 separated list.  For details on the atomic built-in functions see
18600 @ref{__atomic Builtins}.  The following models and parameters are supported:
18602 @table @samp
18604 @item none
18605 Disable compiler generated atomic sequences and emit library calls for atomic
18606 operations.  This is the default if the target is not @code{sh-*-linux*}.
18608 @item soft-gusa
18609 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18610 built-in functions.  The generated atomic sequences require additional support
18611 from the interrupt/exception handling code of the system and are only suitable
18612 for SH3* and SH4* single-core systems.  This option is enabled by default when
18613 the target is @code{sh-*-linux*} and SH3* or SH4*.  When the target is SH4A,
18614 this option will also partially utilize the hardware atomic instructions
18615 @code{movli.l} and @code{movco.l} to create more efficient code, unless
18616 @samp{strict} is specified.  
18618 @item soft-tcb
18619 Generate software atomic sequences that use a variable in the thread control
18620 block.  This is a variation of the gUSA sequences which can also be used on
18621 SH1* and SH2* targets.  The generated atomic sequences require additional
18622 support from the interrupt/exception handling code of the system and are only
18623 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
18624 parameter has to be specified as well.
18626 @item soft-imask
18627 Generate software atomic sequences that temporarily disable interrupts by
18628 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
18629 in privileged mode and is only suitable for single-core systems.  Additional
18630 support from the interrupt/exception handling code of the system is not
18631 required.  This model is enabled by default when the target is
18632 @code{sh-*-linux*} and SH1* or SH2*.
18634 @item hard-llcs
18635 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
18636 instructions only.  This is only available on SH4A and is suitable for
18637 multi-core systems.  Since the hardware instructions support only 32 bit atomic
18638 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
18639 Code compiled with this option will also be compatible with other software
18640 atomic model interrupt/exception handling systems if executed on an SH4A
18641 system.  Additional support from the interrupt/exception handling code of the
18642 system is not required for this model.
18644 @item gbr-offset=
18645 This parameter specifies the offset in bytes of the variable in the thread
18646 control block structure that should be used by the generated atomic sequences
18647 when the @samp{soft-tcb} model has been selected.  For other models this
18648 parameter is ignored.  The specified value must be an integer multiple of four
18649 and in the range 0-1020.
18651 @item strict
18652 This parameter prevents mixed usage of multiple atomic models, even though they
18653 would be compatible, and will make the compiler generate atomic sequences of the
18654 specified model only.
18656 @end table
18658 @item -mtas
18659 @opindex mtas
18660 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
18661 Notice that depending on the particular hardware and software configuration
18662 this can degrade overall performance due to the operand cache line flushes
18663 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
18664 processors the @code{tas.b} instruction must be used with caution since it
18665 can result in data corruption for certain cache configurations.
18667 @item -mspace
18668 @opindex mspace
18669 Optimize for space instead of speed.  Implied by @option{-Os}.
18671 @item -mprefergot
18672 @opindex mprefergot
18673 When generating position-independent code, emit function calls using
18674 the Global Offset Table instead of the Procedure Linkage Table.
18676 @item -musermode
18677 @opindex musermode
18678 Don't generate privileged mode only code.  This option
18679 implies @option{-mno-inline-ic_invalidate}
18680 if the inlined code would not work in user mode.
18681 This is the default when the target is @code{sh-*-linux*}.
18683 @item -multcost=@var{number}
18684 @opindex multcost=@var{number}
18685 Set the cost to assume for a multiply insn.
18687 @item -mdiv=@var{strategy}
18688 @opindex mdiv=@var{strategy}
18689 Set the division strategy to use for SHmedia code.  @var{strategy} must be
18690 one of: 
18692 @table @samp
18694 @item fp 
18695 Performs the operation in floating point.  This has a very high latency,
18696 but needs only a few instructions, so it might be a good choice if
18697 your code has enough easily-exploitable ILP to allow the compiler to
18698 schedule the floating-point instructions together with other instructions.
18699 Division by zero causes a floating-point exception.
18701 @item inv
18702 Uses integer operations to calculate the inverse of the divisor,
18703 and then multiplies the dividend with the inverse.  This strategy allows
18704 CSE and hoisting of the inverse calculation.  Division by zero calculates
18705 an unspecified result, but does not trap.
18707 @item inv:minlat
18708 A variant of @samp{inv} where, if no CSE or hoisting opportunities
18709 have been found, or if the entire operation has been hoisted to the same
18710 place, the last stages of the inverse calculation are intertwined with the
18711 final multiply to reduce the overall latency, at the expense of using a few
18712 more instructions, and thus offering fewer scheduling opportunities with
18713 other code.
18715 @item call
18716 Calls a library function that usually implements the @samp{inv:minlat}
18717 strategy.
18718 This gives high code density for @code{m5-*media-nofpu} compilations.
18720 @item call2
18721 Uses a different entry point of the same library function, where it
18722 assumes that a pointer to a lookup table has already been set up, which
18723 exposes the pointer load to CSE and code hoisting optimizations.
18725 @item inv:call
18726 @itemx inv:call2
18727 @itemx inv:fp
18728 Use the @samp{inv} algorithm for initial
18729 code generation, but if the code stays unoptimized, revert to the @samp{call},
18730 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
18731 potentially-trapping side effect of division by zero is carried by a
18732 separate instruction, so it is possible that all the integer instructions
18733 are hoisted out, but the marker for the side effect stays where it is.
18734 A recombination to floating-point operations or a call is not possible
18735 in that case.
18737 @item inv20u
18738 @itemx inv20l
18739 Variants of the @samp{inv:minlat} strategy.  In the case
18740 that the inverse calculation is not separated from the multiply, they speed
18741 up division where the dividend fits into 20 bits (plus sign where applicable)
18742 by inserting a test to skip a number of operations in this case; this test
18743 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
18744 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
18746 @end table
18748 @item -maccumulate-outgoing-args
18749 @opindex maccumulate-outgoing-args
18750 Reserve space once for outgoing arguments in the function prologue rather
18751 than around each call.  Generally beneficial for performance and size.  Also
18752 needed for unwinding to avoid changing the stack frame around conditional code.
18754 @item -mdivsi3_libfunc=@var{name}
18755 @opindex mdivsi3_libfunc=@var{name}
18756 Set the name of the library function used for 32-bit signed division to
18757 @var{name}.
18758 This only affects the name used in the @samp{call} and @samp{inv:call}
18759 division strategies, and the compiler still expects the same
18760 sets of input/output/clobbered registers as if this option were not present.
18762 @item -mfixed-range=@var{register-range}
18763 @opindex mfixed-range
18764 Generate code treating the given register range as fixed registers.
18765 A fixed register is one that the register allocator can not use.  This is
18766 useful when compiling kernel code.  A register range is specified as
18767 two registers separated by a dash.  Multiple register ranges can be
18768 specified separated by a comma.
18770 @item -mindexed-addressing
18771 @opindex mindexed-addressing
18772 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
18773 This is only safe if the hardware and/or OS implement 32-bit wrap-around
18774 semantics for the indexed addressing mode.  The architecture allows the
18775 implementation of processors with 64-bit MMU, which the OS could use to
18776 get 32-bit addressing, but since no current hardware implementation supports
18777 this or any other way to make the indexed addressing mode safe to use in
18778 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
18780 @item -mgettrcost=@var{number}
18781 @opindex mgettrcost=@var{number}
18782 Set the cost assumed for the @code{gettr} instruction to @var{number}.
18783 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
18785 @item -mpt-fixed
18786 @opindex mpt-fixed
18787 Assume @code{pt*} instructions won't trap.  This generally generates
18788 better-scheduled code, but is unsafe on current hardware.
18789 The current architecture
18790 definition says that @code{ptabs} and @code{ptrel} trap when the target 
18791 anded with 3 is 3.
18792 This has the unintentional effect of making it unsafe to schedule these
18793 instructions before a branch, or hoist them out of a loop.  For example,
18794 @code{__do_global_ctors}, a part of @file{libgcc}
18795 that runs constructors at program
18796 startup, calls functions in a list which is delimited by @minus{}1.  With the
18797 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
18798 That means that all the constructors run a bit more quickly, but when
18799 the loop comes to the end of the list, the program crashes because @code{ptabs}
18800 loads @minus{}1 into a target register.  
18802 Since this option is unsafe for any
18803 hardware implementing the current architecture specification, the default
18804 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
18805 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
18806 this deters register allocation from using target registers for storing
18807 ordinary integers.
18809 @item -minvalid-symbols
18810 @opindex minvalid-symbols
18811 Assume symbols might be invalid.  Ordinary function symbols generated by
18812 the compiler are always valid to load with
18813 @code{movi}/@code{shori}/@code{ptabs} or
18814 @code{movi}/@code{shori}/@code{ptrel},
18815 but with assembler and/or linker tricks it is possible
18816 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
18817 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
18818 It prevents cross-basic-block CSE, hoisting and most scheduling
18819 of symbol loads.  The default is @option{-mno-invalid-symbols}.
18821 @item -mbranch-cost=@var{num}
18822 @opindex mbranch-cost=@var{num}
18823 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
18824 make the compiler try to generate more branch-free code if possible.  
18825 If not specified the value is selected depending on the processor type that
18826 is being compiled for.
18828 @item -mzdcbranch
18829 @itemx -mno-zdcbranch
18830 @opindex mzdcbranch
18831 @opindex mno-zdcbranch
18832 Assume (do not assume) that zero displacement conditional branch instructions
18833 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
18834 compiler will try to prefer zero displacement branch code sequences.  This is
18835 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
18836 disabled by specifying @option{-mno-zdcbranch}.
18838 @item -mcbranchdi
18839 @opindex mcbranchdi
18840 Enable the @code{cbranchdi4} instruction pattern.
18842 @item -mcmpeqdi
18843 @opindex mcmpeqdi
18844 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
18845 is in effect.
18847 @item -mfused-madd
18848 @itemx -mno-fused-madd
18849 @opindex mfused-madd
18850 @opindex mno-fused-madd
18851 Generate code that uses (does not use) the floating-point multiply and
18852 accumulate instructions.  These instructions are generated by default
18853 if hardware floating point is used.  The machine-dependent
18854 @option{-mfused-madd} option is now mapped to the machine-independent
18855 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
18856 mapped to @option{-ffp-contract=off}.
18858 @item -mfsca
18859 @itemx -mno-fsca
18860 @opindex mfsca
18861 @opindex mno-fsca
18862 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
18863 and cosine approximations.  The option @code{-mfsca} must be used in
18864 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
18865 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
18866 approximations even if @code{-funsafe-math-optimizations} is in effect.
18868 @item -mfsrra
18869 @itemx -mno-fsrra
18870 @opindex mfsrra
18871 @opindex mno-fsrra
18872 Allow or disallow the compiler to emit the @code{fsrra} instruction for
18873 reciprocal square root approximations.  The option @code{-mfsrra} must be used
18874 in combination with @code{-funsafe-math-optimizations} and
18875 @code{-ffinite-math-only}.  It is enabled by default when generating code for
18876 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
18877 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
18878 in effect.
18880 @item -mpretend-cmove
18881 @opindex mpretend-cmove
18882 Prefer zero-displacement conditional branches for conditional move instruction
18883 patterns.  This can result in faster code on the SH4 processor.
18885 @end table
18887 @node Solaris 2 Options
18888 @subsection Solaris 2 Options
18889 @cindex Solaris 2 options
18891 These @samp{-m} options are supported on Solaris 2:
18893 @table @gcctabopt
18894 @item -mimpure-text
18895 @opindex mimpure-text
18896 @option{-mimpure-text}, used in addition to @option{-shared}, tells
18897 the compiler to not pass @option{-z text} to the linker when linking a
18898 shared object.  Using this option, you can link position-dependent
18899 code into a shared object.
18901 @option{-mimpure-text} suppresses the ``relocations remain against
18902 allocatable but non-writable sections'' linker error message.
18903 However, the necessary relocations trigger copy-on-write, and the
18904 shared object is not actually shared across processes.  Instead of
18905 using @option{-mimpure-text}, you should compile all source code with
18906 @option{-fpic} or @option{-fPIC}.
18908 @end table
18910 These switches are supported in addition to the above on Solaris 2:
18912 @table @gcctabopt
18913 @item -pthreads
18914 @opindex pthreads
18915 Add support for multithreading using the POSIX threads library.  This
18916 option sets flags for both the preprocessor and linker.  This option does
18917 not affect the thread safety of object code produced  by the compiler or
18918 that of libraries supplied with it.
18920 @item -pthread
18921 @opindex pthread
18922 This is a synonym for @option{-pthreads}.
18923 @end table
18925 @node SPARC Options
18926 @subsection SPARC Options
18927 @cindex SPARC options
18929 These @samp{-m} options are supported on the SPARC:
18931 @table @gcctabopt
18932 @item -mno-app-regs
18933 @itemx -mapp-regs
18934 @opindex mno-app-regs
18935 @opindex mapp-regs
18936 Specify @option{-mapp-regs} to generate output using the global registers
18937 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
18938 is the default.
18940 To be fully SVR4 ABI-compliant at the cost of some performance loss,
18941 specify @option{-mno-app-regs}.  You should compile libraries and system
18942 software with this option.
18944 @item -mflat
18945 @itemx -mno-flat
18946 @opindex mflat
18947 @opindex mno-flat
18948 With @option{-mflat}, the compiler does not generate save/restore instructions
18949 and uses a ``flat'' or single register window model.  This model is compatible
18950 with the regular register window model.  The local registers and the input
18951 registers (0--5) are still treated as ``call-saved'' registers and are
18952 saved on the stack as needed.
18954 With @option{-mno-flat} (the default), the compiler generates save/restore
18955 instructions (except for leaf functions).  This is the normal operating mode.
18957 @item -mfpu
18958 @itemx -mhard-float
18959 @opindex mfpu
18960 @opindex mhard-float
18961 Generate output containing floating-point instructions.  This is the
18962 default.
18964 @item -mno-fpu
18965 @itemx -msoft-float
18966 @opindex mno-fpu
18967 @opindex msoft-float
18968 Generate output containing library calls for floating point.
18969 @strong{Warning:} the requisite libraries are not available for all SPARC
18970 targets.  Normally the facilities of the machine's usual C compiler are
18971 used, but this cannot be done directly in cross-compilation.  You must make
18972 your own arrangements to provide suitable library functions for
18973 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
18974 @samp{sparclite-*-*} do provide software floating-point support.
18976 @option{-msoft-float} changes the calling convention in the output file;
18977 therefore, it is only useful if you compile @emph{all} of a program with
18978 this option.  In particular, you need to compile @file{libgcc.a}, the
18979 library that comes with GCC, with @option{-msoft-float} in order for
18980 this to work.
18982 @item -mhard-quad-float
18983 @opindex mhard-quad-float
18984 Generate output containing quad-word (long double) floating-point
18985 instructions.
18987 @item -msoft-quad-float
18988 @opindex msoft-quad-float
18989 Generate output containing library calls for quad-word (long double)
18990 floating-point instructions.  The functions called are those specified
18991 in the SPARC ABI@.  This is the default.
18993 As of this writing, there are no SPARC implementations that have hardware
18994 support for the quad-word floating-point instructions.  They all invoke
18995 a trap handler for one of these instructions, and then the trap handler
18996 emulates the effect of the instruction.  Because of the trap handler overhead,
18997 this is much slower than calling the ABI library routines.  Thus the
18998 @option{-msoft-quad-float} option is the default.
19000 @item -mno-unaligned-doubles
19001 @itemx -munaligned-doubles
19002 @opindex mno-unaligned-doubles
19003 @opindex munaligned-doubles
19004 Assume that doubles have 8-byte alignment.  This is the default.
19006 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
19007 alignment only if they are contained in another type, or if they have an
19008 absolute address.  Otherwise, it assumes they have 4-byte alignment.
19009 Specifying this option avoids some rare compatibility problems with code
19010 generated by other compilers.  It is not the default because it results
19011 in a performance loss, especially for floating-point code.
19013 @item -mno-faster-structs
19014 @itemx -mfaster-structs
19015 @opindex mno-faster-structs
19016 @opindex mfaster-structs
19017 With @option{-mfaster-structs}, the compiler assumes that structures
19018 should have 8-byte alignment.  This enables the use of pairs of
19019 @code{ldd} and @code{std} instructions for copies in structure
19020 assignment, in place of twice as many @code{ld} and @code{st} pairs.
19021 However, the use of this changed alignment directly violates the SPARC
19022 ABI@.  Thus, it's intended only for use on targets where the developer
19023 acknowledges that their resulting code is not directly in line with
19024 the rules of the ABI@.
19026 @item -mcpu=@var{cpu_type}
19027 @opindex mcpu
19028 Set the instruction set, register set, and instruction scheduling parameters
19029 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
19030 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
19031 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
19032 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
19033 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
19034 and @samp{niagara4}.
19036 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
19037 which selects the best architecture option for the host processor.
19038 @option{-mcpu=native} has no effect if GCC does not recognize
19039 the processor.
19041 Default instruction scheduling parameters are used for values that select
19042 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
19043 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
19045 Here is a list of each supported architecture and their supported
19046 implementations.
19048 @table @asis
19049 @item v7
19050 cypress
19052 @item v8
19053 supersparc, hypersparc, leon
19055 @item sparclite
19056 f930, f934, sparclite86x
19058 @item sparclet
19059 tsc701
19061 @item v9
19062 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
19063 @end table
19065 By default (unless configured otherwise), GCC generates code for the V7
19066 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
19067 additionally optimizes it for the Cypress CY7C602 chip, as used in the
19068 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
19069 SPARCStation 1, 2, IPX etc.
19071 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
19072 architecture.  The only difference from V7 code is that the compiler emits
19073 the integer multiply and integer divide instructions which exist in SPARC-V8
19074 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
19075 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
19076 2000 series.
19078 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
19079 the SPARC architecture.  This adds the integer multiply, integer divide step
19080 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
19081 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
19082 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
19083 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
19084 MB86934 chip, which is the more recent SPARClite with FPU@.
19086 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
19087 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
19088 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
19089 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
19090 optimizes it for the TEMIC SPARClet chip.
19092 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
19093 architecture.  This adds 64-bit integer and floating-point move instructions,
19094 3 additional floating-point condition code registers and conditional move
19095 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
19096 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
19097 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
19098 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
19099 @option{-mcpu=niagara}, the compiler additionally optimizes it for
19100 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
19101 additionally optimizes it for Sun UltraSPARC T2 chips. With
19102 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
19103 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
19104 additionally optimizes it for Sun UltraSPARC T4 chips.
19106 @item -mtune=@var{cpu_type}
19107 @opindex mtune
19108 Set the instruction scheduling parameters for machine type
19109 @var{cpu_type}, but do not set the instruction set or register set that the
19110 option @option{-mcpu=@var{cpu_type}} does.
19112 The same values for @option{-mcpu=@var{cpu_type}} can be used for
19113 @option{-mtune=@var{cpu_type}}, but the only useful values are those
19114 that select a particular CPU implementation.  Those are @samp{cypress},
19115 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
19116 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
19117 @samp{niagara}, @samp{niagara2}, @samp{niagara3} and @samp{niagara4}.  With
19118 native Solaris and GNU/Linux toolchains, @samp{native} can also be used.
19120 @item -mv8plus
19121 @itemx -mno-v8plus
19122 @opindex mv8plus
19123 @opindex mno-v8plus
19124 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
19125 difference from the V8 ABI is that the global and out registers are
19126 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
19127 mode for all SPARC-V9 processors.
19129 @item -mvis
19130 @itemx -mno-vis
19131 @opindex mvis
19132 @opindex mno-vis
19133 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
19134 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
19136 @item -mvis2
19137 @itemx -mno-vis2
19138 @opindex mvis2
19139 @opindex mno-vis2
19140 With @option{-mvis2}, GCC generates code that takes advantage of
19141 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
19142 default is @option{-mvis2} when targeting a cpu that supports such
19143 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
19144 also sets @option{-mvis}.
19146 @item -mvis3
19147 @itemx -mno-vis3
19148 @opindex mvis3
19149 @opindex mno-vis3
19150 With @option{-mvis3}, GCC generates code that takes advantage of
19151 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
19152 default is @option{-mvis3} when targeting a cpu that supports such
19153 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
19154 also sets @option{-mvis2} and @option{-mvis}.
19156 @item -mpopc
19157 @itemx -mno-popc
19158 @opindex mpopc
19159 @opindex mno-popc
19160 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
19161 population count instruction.  The default is @option{-mpopc}
19162 when targeting a cpu that supports such instructions, such as Niagara-2 and
19163 later.
19165 @item -mfmaf
19166 @itemx -mno-fmaf
19167 @opindex mfmaf
19168 @opindex mno-fmaf
19169 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
19170 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
19171 when targeting a cpu that supports such instructions, such as Niagara-3 and
19172 later.
19174 @item -mfix-at697f
19175 @opindex mfix-at697f
19176 Enable the documented workaround for the single erratum of the Atmel AT697F
19177 processor (which corresponds to erratum #13 of the AT697E processor).
19178 @end table
19180 These @samp{-m} options are supported in addition to the above
19181 on SPARC-V9 processors in 64-bit environments:
19183 @table @gcctabopt
19184 @item -mlittle-endian
19185 @opindex mlittle-endian
19186 Generate code for a processor running in little-endian mode.  It is only
19187 available for a few configurations and most notably not on Solaris and Linux.
19189 @item -m32
19190 @itemx -m64
19191 @opindex m32
19192 @opindex m64
19193 Generate code for a 32-bit or 64-bit environment.
19194 The 32-bit environment sets int, long and pointer to 32 bits.
19195 The 64-bit environment sets int to 32 bits and long and pointer
19196 to 64 bits.
19198 @item -mcmodel=@var{which}
19199 @opindex mcmodel
19200 Set the code model to one of
19202 @table @samp
19203 @item medlow
19204 The Medium/Low code model: 64-bit addresses, programs
19205 must be linked in the low 32 bits of memory.  Programs can be statically
19206 or dynamically linked.
19208 @item medmid
19209 The Medium/Middle code model: 64-bit addresses, programs
19210 must be linked in the low 44 bits of memory, the text and data segments must
19211 be less than 2GB in size and the data segment must be located within 2GB of
19212 the text segment.
19214 @item medany
19215 The Medium/Anywhere code model: 64-bit addresses, programs
19216 may be linked anywhere in memory, the text and data segments must be less
19217 than 2GB in size and the data segment must be located within 2GB of the
19218 text segment.
19220 @item embmedany
19221 The Medium/Anywhere code model for embedded systems:
19222 64-bit addresses, the text and data segments must be less than 2GB in
19223 size, both starting anywhere in memory (determined at link time).  The
19224 global register %g4 points to the base of the data segment.  Programs
19225 are statically linked and PIC is not supported.
19226 @end table
19228 @item -mmemory-model=@var{mem-model}
19229 @opindex mmemory-model
19230 Set the memory model in force on the processor to one of
19232 @table @samp
19233 @item default
19234 The default memory model for the processor and operating system.
19236 @item rmo
19237 Relaxed Memory Order
19239 @item pso
19240 Partial Store Order
19242 @item tso
19243 Total Store Order
19245 @item sc
19246 Sequential Consistency
19247 @end table
19249 These memory models are formally defined in Appendix D of the Sparc V9
19250 architecture manual, as set in the processor's @code{PSTATE.MM} field.
19252 @item -mstack-bias
19253 @itemx -mno-stack-bias
19254 @opindex mstack-bias
19255 @opindex mno-stack-bias
19256 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
19257 frame pointer if present, are offset by @minus{}2047 which must be added back
19258 when making stack frame references.  This is the default in 64-bit mode.
19259 Otherwise, assume no such offset is present.
19260 @end table
19262 @node SPU Options
19263 @subsection SPU Options
19264 @cindex SPU options
19266 These @samp{-m} options are supported on the SPU:
19268 @table @gcctabopt
19269 @item -mwarn-reloc
19270 @itemx -merror-reloc
19271 @opindex mwarn-reloc
19272 @opindex merror-reloc
19274 The loader for SPU does not handle dynamic relocations.  By default, GCC
19275 gives an error when it generates code that requires a dynamic
19276 relocation.  @option{-mno-error-reloc} disables the error,
19277 @option{-mwarn-reloc} generates a warning instead.
19279 @item -msafe-dma
19280 @itemx -munsafe-dma
19281 @opindex msafe-dma
19282 @opindex munsafe-dma
19284 Instructions that initiate or test completion of DMA must not be
19285 reordered with respect to loads and stores of the memory that is being
19286 accessed.
19287 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
19288 memory accesses, but that can lead to inefficient code in places where the
19289 memory is known to not change.  Rather than mark the memory as volatile,
19290 you can use @option{-msafe-dma} to tell the compiler to treat
19291 the DMA instructions as potentially affecting all memory.  
19293 @item -mbranch-hints
19294 @opindex mbranch-hints
19296 By default, GCC generates a branch hint instruction to avoid
19297 pipeline stalls for always-taken or probably-taken branches.  A hint
19298 is not generated closer than 8 instructions away from its branch.
19299 There is little reason to disable them, except for debugging purposes,
19300 or to make an object a little bit smaller.
19302 @item -msmall-mem
19303 @itemx -mlarge-mem
19304 @opindex msmall-mem
19305 @opindex mlarge-mem
19307 By default, GCC generates code assuming that addresses are never larger
19308 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
19309 a full 32-bit address.
19311 @item -mstdmain
19312 @opindex mstdmain
19314 By default, GCC links against startup code that assumes the SPU-style
19315 main function interface (which has an unconventional parameter list).
19316 With @option{-mstdmain}, GCC links your program against startup
19317 code that assumes a C99-style interface to @code{main}, including a
19318 local copy of @code{argv} strings.
19320 @item -mfixed-range=@var{register-range}
19321 @opindex mfixed-range
19322 Generate code treating the given register range as fixed registers.
19323 A fixed register is one that the register allocator cannot use.  This is
19324 useful when compiling kernel code.  A register range is specified as
19325 two registers separated by a dash.  Multiple register ranges can be
19326 specified separated by a comma.
19328 @item -mea32
19329 @itemx -mea64
19330 @opindex mea32
19331 @opindex mea64
19332 Compile code assuming that pointers to the PPU address space accessed
19333 via the @code{__ea} named address space qualifier are either 32 or 64
19334 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
19335 all object code in an executable must be compiled with the same setting.
19337 @item -maddress-space-conversion
19338 @itemx -mno-address-space-conversion
19339 @opindex maddress-space-conversion
19340 @opindex mno-address-space-conversion
19341 Allow/disallow treating the @code{__ea} address space as superset
19342 of the generic address space.  This enables explicit type casts
19343 between @code{__ea} and generic pointer as well as implicit
19344 conversions of generic pointers to @code{__ea} pointers.  The
19345 default is to allow address space pointer conversions.
19347 @item -mcache-size=@var{cache-size}
19348 @opindex mcache-size
19349 This option controls the version of libgcc that the compiler links to an
19350 executable and selects a software-managed cache for accessing variables
19351 in the @code{__ea} address space with a particular cache size.  Possible
19352 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
19353 and @samp{128}.  The default cache size is 64KB.
19355 @item -matomic-updates
19356 @itemx -mno-atomic-updates
19357 @opindex matomic-updates
19358 @opindex mno-atomic-updates
19359 This option controls the version of libgcc that the compiler links to an
19360 executable and selects whether atomic updates to the software-managed
19361 cache of PPU-side variables are used.  If you use atomic updates, changes
19362 to a PPU variable from SPU code using the @code{__ea} named address space
19363 qualifier do not interfere with changes to other PPU variables residing
19364 in the same cache line from PPU code.  If you do not use atomic updates,
19365 such interference may occur; however, writing back cache lines is
19366 more efficient.  The default behavior is to use atomic updates.
19368 @item -mdual-nops
19369 @itemx -mdual-nops=@var{n}
19370 @opindex mdual-nops
19371 By default, GCC inserts nops to increase dual issue when it expects
19372 it to increase performance.  @var{n} can be a value from 0 to 10.  A
19373 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
19374 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
19376 @item -mhint-max-nops=@var{n}
19377 @opindex mhint-max-nops
19378 Maximum number of nops to insert for a branch hint.  A branch hint must
19379 be at least 8 instructions away from the branch it is affecting.  GCC
19380 inserts up to @var{n} nops to enforce this, otherwise it does not
19381 generate the branch hint.
19383 @item -mhint-max-distance=@var{n}
19384 @opindex mhint-max-distance
19385 The encoding of the branch hint instruction limits the hint to be within
19386 256 instructions of the branch it is affecting.  By default, GCC makes
19387 sure it is within 125.
19389 @item -msafe-hints
19390 @opindex msafe-hints
19391 Work around a hardware bug that causes the SPU to stall indefinitely.
19392 By default, GCC inserts the @code{hbrp} instruction to make sure
19393 this stall won't happen.
19395 @end table
19397 @node System V Options
19398 @subsection Options for System V
19400 These additional options are available on System V Release 4 for
19401 compatibility with other compilers on those systems:
19403 @table @gcctabopt
19404 @item -G
19405 @opindex G
19406 Create a shared object.
19407 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
19409 @item -Qy
19410 @opindex Qy
19411 Identify the versions of each tool used by the compiler, in a
19412 @code{.ident} assembler directive in the output.
19414 @item -Qn
19415 @opindex Qn
19416 Refrain from adding @code{.ident} directives to the output file (this is
19417 the default).
19419 @item -YP,@var{dirs}
19420 @opindex YP
19421 Search the directories @var{dirs}, and no others, for libraries
19422 specified with @option{-l}.
19424 @item -Ym,@var{dir}
19425 @opindex Ym
19426 Look in the directory @var{dir} to find the M4 preprocessor.
19427 The assembler uses this option.
19428 @c This is supposed to go with a -Yd for predefined M4 macro files, but
19429 @c the generic assembler that comes with Solaris takes just -Ym.
19430 @end table
19432 @node TILE-Gx Options
19433 @subsection TILE-Gx Options
19434 @cindex TILE-Gx options
19436 These @samp{-m} options are supported on the TILE-Gx:
19438 @table @gcctabopt
19439 @item -mcmodel=small
19440 @opindex mcmodel=small
19441 Generate code for the small model.  The distance for direct calls is
19442 limited to 500M in either direction.  PC-relative addresses are 32
19443 bits.  Absolute addresses support the full address range.
19445 @item -mcmodel=large
19446 @opindex mcmodel=large
19447 Generate code for the large model.  There is no limitation on call
19448 distance, pc-relative addresses, or absolute addresses.
19450 @item -mcpu=@var{name}
19451 @opindex mcpu
19452 Selects the type of CPU to be targeted.  Currently the only supported
19453 type is @samp{tilegx}.
19455 @item -m32
19456 @itemx -m64
19457 @opindex m32
19458 @opindex m64
19459 Generate code for a 32-bit or 64-bit environment.  The 32-bit
19460 environment sets int, long, and pointer to 32 bits.  The 64-bit
19461 environment sets int to 32 bits and long and pointer to 64 bits.
19462 @end table
19464 @node TILEPro Options
19465 @subsection TILEPro Options
19466 @cindex TILEPro options
19468 These @samp{-m} options are supported on the TILEPro:
19470 @table @gcctabopt
19471 @item -mcpu=@var{name}
19472 @opindex mcpu
19473 Selects the type of CPU to be targeted.  Currently the only supported
19474 type is @samp{tilepro}.
19476 @item -m32
19477 @opindex m32
19478 Generate code for a 32-bit environment, which sets int, long, and
19479 pointer to 32 bits.  This is the only supported behavior so the flag
19480 is essentially ignored.
19481 @end table
19483 @node V850 Options
19484 @subsection V850 Options
19485 @cindex V850 Options
19487 These @samp{-m} options are defined for V850 implementations:
19489 @table @gcctabopt
19490 @item -mlong-calls
19491 @itemx -mno-long-calls
19492 @opindex mlong-calls
19493 @opindex mno-long-calls
19494 Treat all calls as being far away (near).  If calls are assumed to be
19495 far away, the compiler always loads the function's address into a
19496 register, and calls indirect through the pointer.
19498 @item -mno-ep
19499 @itemx -mep
19500 @opindex mno-ep
19501 @opindex mep
19502 Do not optimize (do optimize) basic blocks that use the same index
19503 pointer 4 or more times to copy pointer into the @code{ep} register, and
19504 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
19505 option is on by default if you optimize.
19507 @item -mno-prolog-function
19508 @itemx -mprolog-function
19509 @opindex mno-prolog-function
19510 @opindex mprolog-function
19511 Do not use (do use) external functions to save and restore registers
19512 at the prologue and epilogue of a function.  The external functions
19513 are slower, but use less code space if more than one function saves
19514 the same number of registers.  The @option{-mprolog-function} option
19515 is on by default if you optimize.
19517 @item -mspace
19518 @opindex mspace
19519 Try to make the code as small as possible.  At present, this just turns
19520 on the @option{-mep} and @option{-mprolog-function} options.
19522 @item -mtda=@var{n}
19523 @opindex mtda
19524 Put static or global variables whose size is @var{n} bytes or less into
19525 the tiny data area that register @code{ep} points to.  The tiny data
19526 area can hold up to 256 bytes in total (128 bytes for byte references).
19528 @item -msda=@var{n}
19529 @opindex msda
19530 Put static or global variables whose size is @var{n} bytes or less into
19531 the small data area that register @code{gp} points to.  The small data
19532 area can hold up to 64 kilobytes.
19534 @item -mzda=@var{n}
19535 @opindex mzda
19536 Put static or global variables whose size is @var{n} bytes or less into
19537 the first 32 kilobytes of memory.
19539 @item -mv850
19540 @opindex mv850
19541 Specify that the target processor is the V850.
19543 @item -mbig-switch
19544 @opindex mbig-switch
19545 Generate code suitable for big switch tables.  Use this option only if
19546 the assembler/linker complain about out of range branches within a switch
19547 table.
19549 @item -mapp-regs
19550 @opindex mapp-regs
19551 This option causes r2 and r5 to be used in the code generated by
19552 the compiler.  This setting is the default.
19554 @item -mno-app-regs
19555 @opindex mno-app-regs
19556 This option causes r2 and r5 to be treated as fixed registers.
19558 @item -mv850e2v3
19559 @opindex mv850e2v3
19560 Specify that the target processor is the V850E2V3.  The preprocessor
19561 constant @samp{__v850e2v3__} is defined if
19562 this option is used.
19564 @item -mv850e2
19565 @opindex mv850e2
19566 Specify that the target processor is the V850E2.  The preprocessor
19567 constant @samp{__v850e2__} is defined if this option is used.
19569 @item -mv850e1
19570 @opindex mv850e1
19571 Specify that the target processor is the V850E1.  The preprocessor
19572 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
19573 this option is used.
19575 @item -mv850es
19576 @opindex mv850es
19577 Specify that the target processor is the V850ES.  This is an alias for
19578 the @option{-mv850e1} option.
19580 @item -mv850e
19581 @opindex mv850e
19582 Specify that the target processor is the V850E@.  The preprocessor
19583 constant @samp{__v850e__} is defined if this option is used.
19585 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
19586 nor @option{-mv850e2} nor @option{-mv850e2v3}
19587 are defined then a default target processor is chosen and the
19588 relevant @samp{__v850*__} preprocessor constant is defined.
19590 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
19591 defined, regardless of which processor variant is the target.
19593 @item -mdisable-callt
19594 @opindex mdisable-callt
19595 This option suppresses generation of the @code{CALLT} instruction for the
19596 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
19597 @option{-mno-disable-callt} which allows the @code{CALLT} instruction to be used.
19599 @end table
19601 @node VAX Options
19602 @subsection VAX Options
19603 @cindex VAX options
19605 These @samp{-m} options are defined for the VAX:
19607 @table @gcctabopt
19608 @item -munix
19609 @opindex munix
19610 Do not output certain jump instructions (@code{aobleq} and so on)
19611 that the Unix assembler for the VAX cannot handle across long
19612 ranges.
19614 @item -mgnu
19615 @opindex mgnu
19616 Do output those jump instructions, on the assumption that the
19617 GNU assembler is being used.
19619 @item -mg
19620 @opindex mg
19621 Output code for G-format floating-point numbers instead of D-format.
19622 @end table
19624 @node VMS Options
19625 @subsection VMS Options
19627 These @samp{-m} options are defined for the VMS implementations:
19629 @table @gcctabopt
19630 @item -mvms-return-codes
19631 @opindex mvms-return-codes
19632 Return VMS condition codes from @code{main}. The default is to return POSIX-style
19633 condition (e.g.@ error) codes.
19635 @item -mdebug-main=@var{prefix}
19636 @opindex mdebug-main=@var{prefix}
19637 Flag the first routine whose name starts with @var{prefix} as the main
19638 routine for the debugger.
19640 @item -mmalloc64
19641 @opindex mmalloc64
19642 Default to 64-bit memory allocation routines.
19644 @item -mpointer-size=@var{size}
19645 @opindex -mpointer-size=@var{size}
19646 Set the default size of pointers. Possible options for @var{size} are
19647 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
19648 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
19649 The later option disables @code{pragma pointer_size}.
19650 @end table
19652 @node VxWorks Options
19653 @subsection VxWorks Options
19654 @cindex VxWorks Options
19656 The options in this section are defined for all VxWorks targets.
19657 Options specific to the target hardware are listed with the other
19658 options for that target.
19660 @table @gcctabopt
19661 @item -mrtp
19662 @opindex mrtp
19663 GCC can generate code for both VxWorks kernels and real time processes
19664 (RTPs).  This option switches from the former to the latter.  It also
19665 defines the preprocessor macro @code{__RTP__}.
19667 @item -non-static
19668 @opindex non-static
19669 Link an RTP executable against shared libraries rather than static
19670 libraries.  The options @option{-static} and @option{-shared} can
19671 also be used for RTPs (@pxref{Link Options}); @option{-static}
19672 is the default.
19674 @item -Bstatic
19675 @itemx -Bdynamic
19676 @opindex Bstatic
19677 @opindex Bdynamic
19678 These options are passed down to the linker.  They are defined for
19679 compatibility with Diab.
19681 @item -Xbind-lazy
19682 @opindex Xbind-lazy
19683 Enable lazy binding of function calls.  This option is equivalent to
19684 @option{-Wl,-z,now} and is defined for compatibility with Diab.
19686 @item -Xbind-now
19687 @opindex Xbind-now
19688 Disable lazy binding of function calls.  This option is the default and
19689 is defined for compatibility with Diab.
19690 @end table
19692 @node x86-64 Options
19693 @subsection x86-64 Options
19694 @cindex x86-64 options
19696 These are listed under @xref{i386 and x86-64 Options}.
19698 @node Xstormy16 Options
19699 @subsection Xstormy16 Options
19700 @cindex Xstormy16 Options
19702 These options are defined for Xstormy16:
19704 @table @gcctabopt
19705 @item -msim
19706 @opindex msim
19707 Choose startup files and linker script suitable for the simulator.
19708 @end table
19710 @node Xtensa Options
19711 @subsection Xtensa Options
19712 @cindex Xtensa Options
19714 These options are supported for Xtensa targets:
19716 @table @gcctabopt
19717 @item -mconst16
19718 @itemx -mno-const16
19719 @opindex mconst16
19720 @opindex mno-const16
19721 Enable or disable use of @code{CONST16} instructions for loading
19722 constant values.  The @code{CONST16} instruction is currently not a
19723 standard option from Tensilica.  When enabled, @code{CONST16}
19724 instructions are always used in place of the standard @code{L32R}
19725 instructions.  The use of @code{CONST16} is enabled by default only if
19726 the @code{L32R} instruction is not available.
19728 @item -mfused-madd
19729 @itemx -mno-fused-madd
19730 @opindex mfused-madd
19731 @opindex mno-fused-madd
19732 Enable or disable use of fused multiply/add and multiply/subtract
19733 instructions in the floating-point option.  This has no effect if the
19734 floating-point option is not also enabled.  Disabling fused multiply/add
19735 and multiply/subtract instructions forces the compiler to use separate
19736 instructions for the multiply and add/subtract operations.  This may be
19737 desirable in some cases where strict IEEE 754-compliant results are
19738 required: the fused multiply add/subtract instructions do not round the
19739 intermediate result, thereby producing results with @emph{more} bits of
19740 precision than specified by the IEEE standard.  Disabling fused multiply
19741 add/subtract instructions also ensures that the program output is not
19742 sensitive to the compiler's ability to combine multiply and add/subtract
19743 operations.
19745 @item -mserialize-volatile
19746 @itemx -mno-serialize-volatile
19747 @opindex mserialize-volatile
19748 @opindex mno-serialize-volatile
19749 When this option is enabled, GCC inserts @code{MEMW} instructions before
19750 @code{volatile} memory references to guarantee sequential consistency.
19751 The default is @option{-mserialize-volatile}.  Use
19752 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
19754 @item -mforce-no-pic
19755 @opindex mforce-no-pic
19756 For targets, like GNU/Linux, where all user-mode Xtensa code must be
19757 position-independent code (PIC), this option disables PIC for compiling
19758 kernel code.
19760 @item -mtext-section-literals
19761 @itemx -mno-text-section-literals
19762 @opindex mtext-section-literals
19763 @opindex mno-text-section-literals
19764 Control the treatment of literal pools.  The default is
19765 @option{-mno-text-section-literals}, which places literals in a separate
19766 section in the output file.  This allows the literal pool to be placed
19767 in a data RAM/ROM, and it also allows the linker to combine literal
19768 pools from separate object files to remove redundant literals and
19769 improve code size.  With @option{-mtext-section-literals}, the literals
19770 are interspersed in the text section in order to keep them as close as
19771 possible to their references.  This may be necessary for large assembly
19772 files.
19774 @item -mtarget-align
19775 @itemx -mno-target-align
19776 @opindex mtarget-align
19777 @opindex mno-target-align
19778 When this option is enabled, GCC instructs the assembler to
19779 automatically align instructions to reduce branch penalties at the
19780 expense of some code density.  The assembler attempts to widen density
19781 instructions to align branch targets and the instructions following call
19782 instructions.  If there are not enough preceding safe density
19783 instructions to align a target, no widening is performed.  The
19784 default is @option{-mtarget-align}.  These options do not affect the
19785 treatment of auto-aligned instructions like @code{LOOP}, which the
19786 assembler always aligns, either by widening density instructions or
19787 by inserting NOP instructions.
19789 @item -mlongcalls
19790 @itemx -mno-longcalls
19791 @opindex mlongcalls
19792 @opindex mno-longcalls
19793 When this option is enabled, GCC instructs the assembler to translate
19794 direct calls to indirect calls unless it can determine that the target
19795 of a direct call is in the range allowed by the call instruction.  This
19796 translation typically occurs for calls to functions in other source
19797 files.  Specifically, the assembler translates a direct @code{CALL}
19798 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
19799 The default is @option{-mno-longcalls}.  This option should be used in
19800 programs where the call target can potentially be out of range.  This
19801 option is implemented in the assembler, not the compiler, so the
19802 assembly code generated by GCC still shows direct call
19803 instructions---look at the disassembled object code to see the actual
19804 instructions.  Note that the assembler uses an indirect call for
19805 every cross-file call, not just those that really are out of range.
19806 @end table
19808 @node zSeries Options
19809 @subsection zSeries Options
19810 @cindex zSeries options
19812 These are listed under @xref{S/390 and zSeries Options}.
19814 @node Code Gen Options
19815 @section Options for Code Generation Conventions
19816 @cindex code generation conventions
19817 @cindex options, code generation
19818 @cindex run-time options
19820 These machine-independent options control the interface conventions
19821 used in code generation.
19823 Most of them have both positive and negative forms; the negative form
19824 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
19825 one of the forms is listed---the one that is not the default.  You
19826 can figure out the other form by either removing @samp{no-} or adding
19829 @table @gcctabopt
19830 @item -fbounds-check
19831 @opindex fbounds-check
19832 For front ends that support it, generate additional code to check that
19833 indices used to access arrays are within the declared range.  This is
19834 currently only supported by the Java and Fortran front ends, where
19835 this option defaults to true and false respectively.
19837 @item -fstack-reuse=@var{reuse-level}
19838 @opindex fstack_reuse
19839 This option controls stack space reuse for user declared local/auto variables
19840 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
19841 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
19842 local variables and temporaries, @samp{named_vars} enables the reuse only for
19843 user defined local variables with names, and @samp{none} disables stack reuse
19844 completely. The default value is @samp{all}. The option is needed when the
19845 program extends the lifetime of a scoped local variable or a compiler generated
19846 temporary beyond the end point defined by the language.  When a lifetime of
19847 a variable ends, and if the variable lives in memory, the optimizing compiler
19848 has the freedom to reuse its stack space with other temporaries or scoped
19849 local variables whose live range does not overlap with it. Legacy code extending
19850 local lifetime will likely to break with the stack reuse optimization.
19852 For example,
19854 @smallexample
19855    int *p;
19856    @{
19857      int local1;
19859      p = &local1;
19860      local1 = 10;
19861      ....
19862    @}
19863    @{
19864       int local2;
19865       local2 = 20;
19866       ...
19867    @}
19869    if (*p == 10)  // out of scope use of local1
19870      @{
19872      @}
19873 @end smallexample
19875 Another example:
19876 @smallexample
19878    struct A
19879    @{
19880        A(int k) : i(k), j(k) @{ @}
19881        int i;
19882        int j;
19883    @};
19885    A *ap;
19887    void foo(const A& ar)
19888    @{
19889       ap = &ar;
19890    @}
19892    void bar()
19893    @{
19894       foo(A(10)); // temp object's lifetime ends when foo returns
19896       @{
19897         A a(20);
19898         ....
19899       @}
19900       ap->i+= 10;  // ap references out of scope temp whose space
19901                    // is reused with a. What is the value of ap->i?
19902    @}
19904 @end smallexample
19906 The lifetime of a compiler generated temporary is well defined by the C++
19907 standard. When a lifetime of a temporary ends, and if the temporary lives
19908 in memory, the optimizing compiler has the freedom to reuse its stack
19909 space with other temporaries or scoped local variables whose live range
19910 does not overlap with it. However some of the legacy code relies on
19911 the behavior of older compilers in which temporaries' stack space is
19912 not reused, the aggressive stack reuse can lead to runtime errors. This
19913 option is used to control the temporary stack reuse optimization.
19915 @item -ftrapv
19916 @opindex ftrapv
19917 This option generates traps for signed overflow on addition, subtraction,
19918 multiplication operations.
19920 @item -fwrapv
19921 @opindex fwrapv
19922 This option instructs the compiler to assume that signed arithmetic
19923 overflow of addition, subtraction and multiplication wraps around
19924 using twos-complement representation.  This flag enables some optimizations
19925 and disables others.  This option is enabled by default for the Java
19926 front end, as required by the Java language specification.
19928 @item -fexceptions
19929 @opindex fexceptions
19930 Enable exception handling.  Generates extra code needed to propagate
19931 exceptions.  For some targets, this implies GCC generates frame
19932 unwind information for all functions, which can produce significant data
19933 size overhead, although it does not affect execution.  If you do not
19934 specify this option, GCC enables it by default for languages like
19935 C++ that normally require exception handling, and disables it for
19936 languages like C that do not normally require it.  However, you may need
19937 to enable this option when compiling C code that needs to interoperate
19938 properly with exception handlers written in C++.  You may also wish to
19939 disable this option if you are compiling older C++ programs that don't
19940 use exception handling.
19942 @item -fnon-call-exceptions
19943 @opindex fnon-call-exceptions
19944 Generate code that allows trapping instructions to throw exceptions.
19945 Note that this requires platform-specific runtime support that does
19946 not exist everywhere.  Moreover, it only allows @emph{trapping}
19947 instructions to throw exceptions, i.e.@: memory references or floating-point
19948 instructions.  It does not allow exceptions to be thrown from
19949 arbitrary signal handlers such as @code{SIGALRM}.
19951 @item -fdelete-dead-exceptions
19952 @opindex fdelete-dead-exceptions
19953 Consider that instructions that may throw exceptions but don't otherwise
19954 contribute to the execution of the program can be optimized away.
19955 This option is enabled by default for the Ada front end, as permitted by
19956 the Ada language specification.
19957 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
19959 @item -funwind-tables
19960 @opindex funwind-tables
19961 Similar to @option{-fexceptions}, except that it just generates any needed
19962 static data, but does not affect the generated code in any other way.
19963 You normally do not need to enable this option; instead, a language processor
19964 that needs this handling enables it on your behalf.
19966 @item -fasynchronous-unwind-tables
19967 @opindex fasynchronous-unwind-tables
19968 Generate unwind table in DWARF 2 format, if supported by target machine.  The
19969 table is exact at each instruction boundary, so it can be used for stack
19970 unwinding from asynchronous events (such as debugger or garbage collector).
19972 @item -fpcc-struct-return
19973 @opindex fpcc-struct-return
19974 Return ``short'' @code{struct} and @code{union} values in memory like
19975 longer ones, rather than in registers.  This convention is less
19976 efficient, but it has the advantage of allowing intercallability between
19977 GCC-compiled files and files compiled with other compilers, particularly
19978 the Portable C Compiler (pcc).
19980 The precise convention for returning structures in memory depends
19981 on the target configuration macros.
19983 Short structures and unions are those whose size and alignment match
19984 that of some integer type.
19986 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
19987 switch is not binary compatible with code compiled with the
19988 @option{-freg-struct-return} switch.
19989 Use it to conform to a non-default application binary interface.
19991 @item -freg-struct-return
19992 @opindex freg-struct-return
19993 Return @code{struct} and @code{union} values in registers when possible.
19994 This is more efficient for small structures than
19995 @option{-fpcc-struct-return}.
19997 If you specify neither @option{-fpcc-struct-return} nor
19998 @option{-freg-struct-return}, GCC defaults to whichever convention is
19999 standard for the target.  If there is no standard convention, GCC
20000 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
20001 the principal compiler.  In those cases, we can choose the standard, and
20002 we chose the more efficient register return alternative.
20004 @strong{Warning:} code compiled with the @option{-freg-struct-return}
20005 switch is not binary compatible with code compiled with the
20006 @option{-fpcc-struct-return} switch.
20007 Use it to conform to a non-default application binary interface.
20009 @item -fshort-enums
20010 @opindex fshort-enums
20011 Allocate to an @code{enum} type only as many bytes as it needs for the
20012 declared range of possible values.  Specifically, the @code{enum} type
20013 is equivalent to the smallest integer type that has enough room.
20015 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
20016 code that is not binary compatible with code generated without that switch.
20017 Use it to conform to a non-default application binary interface.
20019 @item -fshort-double
20020 @opindex fshort-double
20021 Use the same size for @code{double} as for @code{float}.
20023 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
20024 code that is not binary compatible with code generated without that switch.
20025 Use it to conform to a non-default application binary interface.
20027 @item -fshort-wchar
20028 @opindex fshort-wchar
20029 Override the underlying type for @samp{wchar_t} to be @samp{short
20030 unsigned int} instead of the default for the target.  This option is
20031 useful for building programs to run under WINE@.
20033 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
20034 code that is not binary compatible with code generated without that switch.
20035 Use it to conform to a non-default application binary interface.
20037 @item -fno-common
20038 @opindex fno-common
20039 In C code, controls the placement of uninitialized global variables.
20040 Unix C compilers have traditionally permitted multiple definitions of
20041 such variables in different compilation units by placing the variables
20042 in a common block.
20043 This is the behavior specified by @option{-fcommon}, and is the default
20044 for GCC on most targets.
20045 On the other hand, this behavior is not required by ISO C, and on some
20046 targets may carry a speed or code size penalty on variable references.
20047 The @option{-fno-common} option specifies that the compiler should place
20048 uninitialized global variables in the data section of the object file,
20049 rather than generating them as common blocks.
20050 This has the effect that if the same variable is declared
20051 (without @code{extern}) in two different compilations,
20052 you get a multiple-definition error when you link them.
20053 In this case, you must compile with @option{-fcommon} instead.
20054 Compiling with @option{-fno-common} is useful on targets for which
20055 it provides better performance, or if you wish to verify that the
20056 program will work on other systems that always treat uninitialized
20057 variable declarations this way.
20059 @item -fno-ident
20060 @opindex fno-ident
20061 Ignore the @samp{#ident} directive.
20063 @item -finhibit-size-directive
20064 @opindex finhibit-size-directive
20065 Don't output a @code{.size} assembler directive, or anything else that
20066 would cause trouble if the function is split in the middle, and the
20067 two halves are placed at locations far apart in memory.  This option is
20068 used when compiling @file{crtstuff.c}; you should not need to use it
20069 for anything else.
20071 @item -fverbose-asm
20072 @opindex fverbose-asm
20073 Put extra commentary information in the generated assembly code to
20074 make it more readable.  This option is generally only of use to those
20075 who actually need to read the generated assembly code (perhaps while
20076 debugging the compiler itself).
20078 @option{-fno-verbose-asm}, the default, causes the
20079 extra information to be omitted and is useful when comparing two assembler
20080 files.
20082 @item -frecord-gcc-switches
20083 @opindex frecord-gcc-switches
20084 This switch causes the command line used to invoke the
20085 compiler to be recorded into the object file that is being created.
20086 This switch is only implemented on some targets and the exact format
20087 of the recording is target and binary file format dependent, but it
20088 usually takes the form of a section containing ASCII text.  This
20089 switch is related to the @option{-fverbose-asm} switch, but that
20090 switch only records information in the assembler output file as
20091 comments, so it never reaches the object file.
20092 See also @option{-grecord-gcc-switches} for another
20093 way of storing compiler options into the object file.
20095 @item -fpic
20096 @opindex fpic
20097 @cindex global offset table
20098 @cindex PIC
20099 Generate position-independent code (PIC) suitable for use in a shared
20100 library, if supported for the target machine.  Such code accesses all
20101 constant addresses through a global offset table (GOT)@.  The dynamic
20102 loader resolves the GOT entries when the program starts (the dynamic
20103 loader is not part of GCC; it is part of the operating system).  If
20104 the GOT size for the linked executable exceeds a machine-specific
20105 maximum size, you get an error message from the linker indicating that
20106 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
20107 instead.  (These maximums are 8k on the SPARC and 32k
20108 on the m68k and RS/6000.  The 386 has no such limit.)
20110 Position-independent code requires special support, and therefore works
20111 only on certain machines.  For the 386, GCC supports PIC for System V
20112 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
20113 position-independent.
20115 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20116 are defined to 1.
20118 @item -fPIC
20119 @opindex fPIC
20120 If supported for the target machine, emit position-independent code,
20121 suitable for dynamic linking and avoiding any limit on the size of the
20122 global offset table.  This option makes a difference on the m68k,
20123 PowerPC and SPARC@.
20125 Position-independent code requires special support, and therefore works
20126 only on certain machines.
20128 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20129 are defined to 2.
20131 @item -fpie
20132 @itemx -fPIE
20133 @opindex fpie
20134 @opindex fPIE
20135 These options are similar to @option{-fpic} and @option{-fPIC}, but
20136 generated position independent code can be only linked into executables.
20137 Usually these options are used when @option{-pie} GCC option is
20138 used during linking.
20140 @option{-fpie} and @option{-fPIE} both define the macros
20141 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
20142 for @option{-fpie} and 2 for @option{-fPIE}.
20144 @item -fno-jump-tables
20145 @opindex fno-jump-tables
20146 Do not use jump tables for switch statements even where it would be
20147 more efficient than other code generation strategies.  This option is
20148 of use in conjunction with @option{-fpic} or @option{-fPIC} for
20149 building code that forms part of a dynamic linker and cannot
20150 reference the address of a jump table.  On some targets, jump tables
20151 do not require a GOT and this option is not needed.
20153 @item -ffixed-@var{reg}
20154 @opindex ffixed
20155 Treat the register named @var{reg} as a fixed register; generated code
20156 should never refer to it (except perhaps as a stack pointer, frame
20157 pointer or in some other fixed role).
20159 @var{reg} must be the name of a register.  The register names accepted
20160 are machine-specific and are defined in the @code{REGISTER_NAMES}
20161 macro in the machine description macro file.
20163 This flag does not have a negative form, because it specifies a
20164 three-way choice.
20166 @item -fcall-used-@var{reg}
20167 @opindex fcall-used
20168 Treat the register named @var{reg} as an allocable register that is
20169 clobbered by function calls.  It may be allocated for temporaries or
20170 variables that do not live across a call.  Functions compiled this way
20171 do not save and restore the register @var{reg}.
20173 It is an error to use this flag with the frame pointer or stack pointer.
20174 Use of this flag for other registers that have fixed pervasive roles in
20175 the machine's execution model produces disastrous results.
20177 This flag does not have a negative form, because it specifies a
20178 three-way choice.
20180 @item -fcall-saved-@var{reg}
20181 @opindex fcall-saved
20182 Treat the register named @var{reg} as an allocable register saved by
20183 functions.  It may be allocated even for temporaries or variables that
20184 live across a call.  Functions compiled this way save and restore
20185 the register @var{reg} if they use it.
20187 It is an error to use this flag with the frame pointer or stack pointer.
20188 Use of this flag for other registers that have fixed pervasive roles in
20189 the machine's execution model produces disastrous results.
20191 A different sort of disaster results from the use of this flag for
20192 a register in which function values may be returned.
20194 This flag does not have a negative form, because it specifies a
20195 three-way choice.
20197 @item -fpack-struct[=@var{n}]
20198 @opindex fpack-struct
20199 Without a value specified, pack all structure members together without
20200 holes.  When a value is specified (which must be a small power of two), pack
20201 structure members according to this value, representing the maximum
20202 alignment (that is, objects with default alignment requirements larger than
20203 this are output potentially unaligned at the next fitting location.
20205 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
20206 code that is not binary compatible with code generated without that switch.
20207 Additionally, it makes the code suboptimal.
20208 Use it to conform to a non-default application binary interface.
20210 @item -finstrument-functions
20211 @opindex finstrument-functions
20212 Generate instrumentation calls for entry and exit to functions.  Just
20213 after function entry and just before function exit, the following
20214 profiling functions are called with the address of the current
20215 function and its call site.  (On some platforms,
20216 @code{__builtin_return_address} does not work beyond the current
20217 function, so the call site information may not be available to the
20218 profiling functions otherwise.)
20220 @smallexample
20221 void __cyg_profile_func_enter (void *this_fn,
20222                                void *call_site);
20223 void __cyg_profile_func_exit  (void *this_fn,
20224                                void *call_site);
20225 @end smallexample
20227 The first argument is the address of the start of the current function,
20228 which may be looked up exactly in the symbol table.
20230 This instrumentation is also done for functions expanded inline in other
20231 functions.  The profiling calls indicate where, conceptually, the
20232 inline function is entered and exited.  This means that addressable
20233 versions of such functions must be available.  If all your uses of a
20234 function are expanded inline, this may mean an additional expansion of
20235 code size.  If you use @samp{extern inline} in your C code, an
20236 addressable version of such functions must be provided.  (This is
20237 normally the case anyway, but if you get lucky and the optimizer always
20238 expands the functions inline, you might have gotten away without
20239 providing static copies.)
20241 A function may be given the attribute @code{no_instrument_function}, in
20242 which case this instrumentation is not done.  This can be used, for
20243 example, for the profiling functions listed above, high-priority
20244 interrupt routines, and any functions from which the profiling functions
20245 cannot safely be called (perhaps signal handlers, if the profiling
20246 routines generate output or allocate memory).
20248 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
20249 @opindex finstrument-functions-exclude-file-list
20251 Set the list of functions that are excluded from instrumentation (see
20252 the description of @code{-finstrument-functions}).  If the file that
20253 contains a function definition matches with one of @var{file}, then
20254 that function is not instrumented.  The match is done on substrings:
20255 if the @var{file} parameter is a substring of the file name, it is
20256 considered to be a match.
20258 For example:
20260 @smallexample
20261 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
20262 @end smallexample
20264 @noindent
20265 excludes any inline function defined in files whose pathnames
20266 contain @code{/bits/stl} or @code{include/sys}.
20268 If, for some reason, you want to include letter @code{','} in one of
20269 @var{sym}, write @code{'\,'}. For example,
20270 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
20271 (note the single quote surrounding the option).
20273 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
20274 @opindex finstrument-functions-exclude-function-list
20276 This is similar to @code{-finstrument-functions-exclude-file-list},
20277 but this option sets the list of function names to be excluded from
20278 instrumentation.  The function name to be matched is its user-visible
20279 name, such as @code{vector<int> blah(const vector<int> &)}, not the
20280 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
20281 match is done on substrings: if the @var{sym} parameter is a substring
20282 of the function name, it is considered to be a match.  For C99 and C++
20283 extended identifiers, the function name must be given in UTF-8, not
20284 using universal character names.
20286 @item -fstack-check
20287 @opindex fstack-check
20288 Generate code to verify that you do not go beyond the boundary of the
20289 stack.  You should specify this flag if you are running in an
20290 environment with multiple threads, but you only rarely need to specify it in
20291 a single-threaded environment since stack overflow is automatically
20292 detected on nearly all systems if there is only one stack.
20294 Note that this switch does not actually cause checking to be done; the
20295 operating system or the language runtime must do that.  The switch causes
20296 generation of code to ensure that they see the stack being extended.
20298 You can additionally specify a string parameter: @code{no} means no
20299 checking, @code{generic} means force the use of old-style checking,
20300 @code{specific} means use the best checking method and is equivalent
20301 to bare @option{-fstack-check}.
20303 Old-style checking is a generic mechanism that requires no specific
20304 target support in the compiler but comes with the following drawbacks:
20306 @enumerate
20307 @item
20308 Modified allocation strategy for large objects: they are always
20309 allocated dynamically if their size exceeds a fixed threshold.
20311 @item
20312 Fixed limit on the size of the static frame of functions: when it is
20313 topped by a particular function, stack checking is not reliable and
20314 a warning is issued by the compiler.
20316 @item
20317 Inefficiency: because of both the modified allocation strategy and the
20318 generic implementation, code performance is hampered.
20319 @end enumerate
20321 Note that old-style stack checking is also the fallback method for
20322 @code{specific} if no target support has been added in the compiler.
20324 @item -fstack-limit-register=@var{reg}
20325 @itemx -fstack-limit-symbol=@var{sym}
20326 @itemx -fno-stack-limit
20327 @opindex fstack-limit-register
20328 @opindex fstack-limit-symbol
20329 @opindex fno-stack-limit
20330 Generate code to ensure that the stack does not grow beyond a certain value,
20331 either the value of a register or the address of a symbol.  If a larger
20332 stack is required, a signal is raised at run time.  For most targets,
20333 the signal is raised before the stack overruns the boundary, so
20334 it is possible to catch the signal without taking special precautions.
20336 For instance, if the stack starts at absolute address @samp{0x80000000}
20337 and grows downwards, you can use the flags
20338 @option{-fstack-limit-symbol=__stack_limit} and
20339 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
20340 of 128KB@.  Note that this may only work with the GNU linker.
20342 @item -fsplit-stack
20343 @opindex fsplit-stack
20344 Generate code to automatically split the stack before it overflows.
20345 The resulting program has a discontiguous stack which can only
20346 overflow if the program is unable to allocate any more memory.  This
20347 is most useful when running threaded programs, as it is no longer
20348 necessary to calculate a good stack size to use for each thread.  This
20349 is currently only implemented for the i386 and x86_64 back ends running
20350 GNU/Linux.
20352 When code compiled with @option{-fsplit-stack} calls code compiled
20353 without @option{-fsplit-stack}, there may not be much stack space
20354 available for the latter code to run.  If compiling all code,
20355 including library code, with @option{-fsplit-stack} is not an option,
20356 then the linker can fix up these calls so that the code compiled
20357 without @option{-fsplit-stack} always has a large stack.  Support for
20358 this is implemented in the gold linker in GNU binutils release 2.21
20359 and later.
20361 @item -fleading-underscore
20362 @opindex fleading-underscore
20363 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
20364 change the way C symbols are represented in the object file.  One use
20365 is to help link with legacy assembly code.
20367 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
20368 generate code that is not binary compatible with code generated without that
20369 switch.  Use it to conform to a non-default application binary interface.
20370 Not all targets provide complete support for this switch.
20372 @item -ftls-model=@var{model}
20373 @opindex ftls-model
20374 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
20375 The @var{model} argument should be one of @code{global-dynamic},
20376 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
20378 The default without @option{-fpic} is @code{initial-exec}; with
20379 @option{-fpic} the default is @code{global-dynamic}.
20381 @item -fvisibility=@var{default|internal|hidden|protected}
20382 @opindex fvisibility
20383 Set the default ELF image symbol visibility to the specified option---all
20384 symbols are marked with this unless overridden within the code.
20385 Using this feature can very substantially improve linking and
20386 load times of shared object libraries, produce more optimized
20387 code, provide near-perfect API export and prevent symbol clashes.
20388 It is @strong{strongly} recommended that you use this in any shared objects
20389 you distribute.
20391 Despite the nomenclature, @code{default} always means public; i.e.,
20392 available to be linked against from outside the shared object.
20393 @code{protected} and @code{internal} are pretty useless in real-world
20394 usage so the only other commonly used option is @code{hidden}.
20395 The default if @option{-fvisibility} isn't specified is
20396 @code{default}, i.e., make every
20397 symbol public---this causes the same behavior as previous versions of
20398 GCC@.
20400 A good explanation of the benefits offered by ensuring ELF
20401 symbols have the correct visibility is given by ``How To Write
20402 Shared Libraries'' by Ulrich Drepper (which can be found at
20403 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
20404 solution made possible by this option to marking things hidden when
20405 the default is public is to make the default hidden and mark things
20406 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
20407 and @code{__attribute__ ((visibility("default")))} instead of
20408 @code{__declspec(dllexport)} you get almost identical semantics with
20409 identical syntax.  This is a great boon to those working with
20410 cross-platform projects.
20412 For those adding visibility support to existing code, you may find
20413 @samp{#pragma GCC visibility} of use.  This works by you enclosing
20414 the declarations you wish to set visibility for with (for example)
20415 @samp{#pragma GCC visibility push(hidden)} and
20416 @samp{#pragma GCC visibility pop}.
20417 Bear in mind that symbol visibility should be viewed @strong{as
20418 part of the API interface contract} and thus all new code should
20419 always specify visibility when it is not the default; i.e., declarations
20420 only for use within the local DSO should @strong{always} be marked explicitly
20421 as hidden as so to avoid PLT indirection overheads---making this
20422 abundantly clear also aids readability and self-documentation of the code.
20423 Note that due to ISO C++ specification requirements, @code{operator new} and
20424 @code{operator delete} must always be of default visibility.
20426 Be aware that headers from outside your project, in particular system
20427 headers and headers from any other library you use, may not be
20428 expecting to be compiled with visibility other than the default.  You
20429 may need to explicitly say @samp{#pragma GCC visibility push(default)}
20430 before including any such headers.
20432 @samp{extern} declarations are not affected by @option{-fvisibility}, so
20433 a lot of code can be recompiled with @option{-fvisibility=hidden} with
20434 no modifications.  However, this means that calls to @code{extern}
20435 functions with no explicit visibility use the PLT, so it is more
20436 effective to use @code{__attribute ((visibility))} and/or
20437 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
20438 declarations should be treated as hidden.
20440 Note that @option{-fvisibility} does affect C++ vague linkage
20441 entities. This means that, for instance, an exception class that is
20442 be thrown between DSOs must be explicitly marked with default
20443 visibility so that the @samp{type_info} nodes are unified between
20444 the DSOs.
20446 An overview of these techniques, their benefits and how to use them
20447 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
20449 @item -fstrict-volatile-bitfields
20450 @opindex fstrict-volatile-bitfields
20451 This option should be used if accesses to volatile bit-fields (or other
20452 structure fields, although the compiler usually honors those types
20453 anyway) should use a single access of the width of the
20454 field's type, aligned to a natural alignment if possible.  For
20455 example, targets with memory-mapped peripheral registers might require
20456 all such accesses to be 16 bits wide; with this flag you can
20457 declare all peripheral bit-fields as @code{unsigned short} (assuming short
20458 is 16 bits on these targets) to force GCC to use 16-bit accesses
20459 instead of, perhaps, a more efficient 32-bit access.
20461 If this option is disabled, the compiler uses the most efficient
20462 instruction.  In the previous example, that might be a 32-bit load
20463 instruction, even though that accesses bytes that do not contain
20464 any portion of the bit-field, or memory-mapped registers unrelated to
20465 the one being updated.
20467 If the target requires strict alignment, and honoring the field
20468 type would require violating this alignment, a warning is issued.
20469 If the field has @code{packed} attribute, the access is done without
20470 honoring the field type.  If the field doesn't have @code{packed}
20471 attribute, the access is done honoring the field type.  In both cases,
20472 GCC assumes that the user knows something about the target hardware
20473 that it is unaware of.
20475 The default value of this option is determined by the application binary
20476 interface for the target processor.
20478 @item -fsync-libcalls
20479 @opindex fsync-libcalls
20480 This option controls whether any out-of-line instance of the @code{__sync}
20481 family of functions may be used to implement the C++11 @code{__atomic}
20482 family of functions.
20484 The default value of this option is enabled, thus the only useful form
20485 of the option is @option{-fno-sync-libcalls}.  This option is used in
20486 the implementation of the @file{libatomic} runtime library.
20488 @end table
20490 @c man end
20492 @node Environment Variables
20493 @section Environment Variables Affecting GCC
20494 @cindex environment variables
20496 @c man begin ENVIRONMENT
20497 This section describes several environment variables that affect how GCC
20498 operates.  Some of them work by specifying directories or prefixes to use
20499 when searching for various kinds of files.  Some are used to specify other
20500 aspects of the compilation environment.
20502 Note that you can also specify places to search using options such as
20503 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
20504 take precedence over places specified using environment variables, which
20505 in turn take precedence over those specified by the configuration of GCC@.
20506 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
20507 GNU Compiler Collection (GCC) Internals}.
20509 @table @env
20510 @item LANG
20511 @itemx LC_CTYPE
20512 @c @itemx LC_COLLATE
20513 @itemx LC_MESSAGES
20514 @c @itemx LC_MONETARY
20515 @c @itemx LC_NUMERIC
20516 @c @itemx LC_TIME
20517 @itemx LC_ALL
20518 @findex LANG
20519 @findex LC_CTYPE
20520 @c @findex LC_COLLATE
20521 @findex LC_MESSAGES
20522 @c @findex LC_MONETARY
20523 @c @findex LC_NUMERIC
20524 @c @findex LC_TIME
20525 @findex LC_ALL
20526 @cindex locale
20527 These environment variables control the way that GCC uses
20528 localization information which allows GCC to work with different
20529 national conventions.  GCC inspects the locale categories
20530 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
20531 so.  These locale categories can be set to any value supported by your
20532 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
20533 Kingdom encoded in UTF-8.
20535 The @env{LC_CTYPE} environment variable specifies character
20536 classification.  GCC uses it to determine the character boundaries in
20537 a string; this is needed for some multibyte encodings that contain quote
20538 and escape characters that are otherwise interpreted as a string
20539 end or escape.
20541 The @env{LC_MESSAGES} environment variable specifies the language to
20542 use in diagnostic messages.
20544 If the @env{LC_ALL} environment variable is set, it overrides the value
20545 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
20546 and @env{LC_MESSAGES} default to the value of the @env{LANG}
20547 environment variable.  If none of these variables are set, GCC
20548 defaults to traditional C English behavior.
20550 @item TMPDIR
20551 @findex TMPDIR
20552 If @env{TMPDIR} is set, it specifies the directory to use for temporary
20553 files.  GCC uses temporary files to hold the output of one stage of
20554 compilation which is to be used as input to the next stage: for example,
20555 the output of the preprocessor, which is the input to the compiler
20556 proper.
20558 @item GCC_COMPARE_DEBUG
20559 @findex GCC_COMPARE_DEBUG
20560 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
20561 @option{-fcompare-debug} to the compiler driver.  See the documentation
20562 of this option for more details.
20564 @item GCC_EXEC_PREFIX
20565 @findex GCC_EXEC_PREFIX
20566 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
20567 names of the subprograms executed by the compiler.  No slash is added
20568 when this prefix is combined with the name of a subprogram, but you can
20569 specify a prefix that ends with a slash if you wish.
20571 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
20572 an appropriate prefix to use based on the pathname it is invoked with.
20574 If GCC cannot find the subprogram using the specified prefix, it
20575 tries looking in the usual places for the subprogram.
20577 The default value of @env{GCC_EXEC_PREFIX} is
20578 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
20579 the installed compiler. In many cases @var{prefix} is the value
20580 of @code{prefix} when you ran the @file{configure} script.
20582 Other prefixes specified with @option{-B} take precedence over this prefix.
20584 This prefix is also used for finding files such as @file{crt0.o} that are
20585 used for linking.
20587 In addition, the prefix is used in an unusual way in finding the
20588 directories to search for header files.  For each of the standard
20589 directories whose name normally begins with @samp{/usr/local/lib/gcc}
20590 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
20591 replacing that beginning with the specified prefix to produce an
20592 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
20593 @file{foo/bar} just before it searches the standard directory 
20594 @file{/usr/local/lib/bar}.
20595 If a standard directory begins with the configured
20596 @var{prefix} then the value of @var{prefix} is replaced by
20597 @env{GCC_EXEC_PREFIX} when looking for header files.
20599 @item COMPILER_PATH
20600 @findex COMPILER_PATH
20601 The value of @env{COMPILER_PATH} is a colon-separated list of
20602 directories, much like @env{PATH}.  GCC tries the directories thus
20603 specified when searching for subprograms, if it can't find the
20604 subprograms using @env{GCC_EXEC_PREFIX}.
20606 @item LIBRARY_PATH
20607 @findex LIBRARY_PATH
20608 The value of @env{LIBRARY_PATH} is a colon-separated list of
20609 directories, much like @env{PATH}.  When configured as a native compiler,
20610 GCC tries the directories thus specified when searching for special
20611 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
20612 using GCC also uses these directories when searching for ordinary
20613 libraries for the @option{-l} option (but directories specified with
20614 @option{-L} come first).
20616 @item LANG
20617 @findex LANG
20618 @cindex locale definition
20619 This variable is used to pass locale information to the compiler.  One way in
20620 which this information is used is to determine the character set to be used
20621 when character literals, string literals and comments are parsed in C and C++.
20622 When the compiler is configured to allow multibyte characters,
20623 the following values for @env{LANG} are recognized:
20625 @table @samp
20626 @item C-JIS
20627 Recognize JIS characters.
20628 @item C-SJIS
20629 Recognize SJIS characters.
20630 @item C-EUCJP
20631 Recognize EUCJP characters.
20632 @end table
20634 If @env{LANG} is not defined, or if it has some other value, then the
20635 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
20636 recognize and translate multibyte characters.
20637 @end table
20639 @noindent
20640 Some additional environment variables affect the behavior of the
20641 preprocessor.
20643 @include cppenv.texi
20645 @c man end
20647 @node Precompiled Headers
20648 @section Using Precompiled Headers
20649 @cindex precompiled headers
20650 @cindex speed of compilation
20652 Often large projects have many header files that are included in every
20653 source file.  The time the compiler takes to process these header files
20654 over and over again can account for nearly all of the time required to
20655 build the project.  To make builds faster, GCC allows you to
20656 @dfn{precompile} a header file.
20658 To create a precompiled header file, simply compile it as you would any
20659 other file, if necessary using the @option{-x} option to make the driver
20660 treat it as a C or C++ header file.  You may want to use a
20661 tool like @command{make} to keep the precompiled header up-to-date when
20662 the headers it contains change.
20664 A precompiled header file is searched for when @code{#include} is
20665 seen in the compilation.  As it searches for the included file
20666 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
20667 compiler looks for a precompiled header in each directory just before it
20668 looks for the include file in that directory.  The name searched for is
20669 the name specified in the @code{#include} with @samp{.gch} appended.  If
20670 the precompiled header file can't be used, it is ignored.
20672 For instance, if you have @code{#include "all.h"}, and you have
20673 @file{all.h.gch} in the same directory as @file{all.h}, then the
20674 precompiled header file is used if possible, and the original
20675 header is used otherwise.
20677 Alternatively, you might decide to put the precompiled header file in a
20678 directory and use @option{-I} to ensure that directory is searched
20679 before (or instead of) the directory containing the original header.
20680 Then, if you want to check that the precompiled header file is always
20681 used, you can put a file of the same name as the original header in this
20682 directory containing an @code{#error} command.
20684 This also works with @option{-include}.  So yet another way to use
20685 precompiled headers, good for projects not designed with precompiled
20686 header files in mind, is to simply take most of the header files used by
20687 a project, include them from another header file, precompile that header
20688 file, and @option{-include} the precompiled header.  If the header files
20689 have guards against multiple inclusion, they are skipped because
20690 they've already been included (in the precompiled header).
20692 If you need to precompile the same header file for different
20693 languages, targets, or compiler options, you can instead make a
20694 @emph{directory} named like @file{all.h.gch}, and put each precompiled
20695 header in the directory, perhaps using @option{-o}.  It doesn't matter
20696 what you call the files in the directory; every precompiled header in
20697 the directory is considered.  The first precompiled header
20698 encountered in the directory that is valid for this compilation is
20699 used; they're searched in no particular order.
20701 There are many other possibilities, limited only by your imagination,
20702 good sense, and the constraints of your build system.
20704 A precompiled header file can be used only when these conditions apply:
20706 @itemize
20707 @item
20708 Only one precompiled header can be used in a particular compilation.
20710 @item
20711 A precompiled header can't be used once the first C token is seen.  You
20712 can have preprocessor directives before a precompiled header; you cannot
20713 include a precompiled header from inside another header.
20715 @item
20716 The precompiled header file must be produced for the same language as
20717 the current compilation.  You can't use a C precompiled header for a C++
20718 compilation.
20720 @item
20721 The precompiled header file must have been produced by the same compiler
20722 binary as the current compilation is using.
20724 @item
20725 Any macros defined before the precompiled header is included must
20726 either be defined in the same way as when the precompiled header was
20727 generated, or must not affect the precompiled header, which usually
20728 means that they don't appear in the precompiled header at all.
20730 The @option{-D} option is one way to define a macro before a
20731 precompiled header is included; using a @code{#define} can also do it.
20732 There are also some options that define macros implicitly, like
20733 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
20734 defined this way.
20736 @item If debugging information is output when using the precompiled
20737 header, using @option{-g} or similar, the same kind of debugging information
20738 must have been output when building the precompiled header.  However,
20739 a precompiled header built using @option{-g} can be used in a compilation
20740 when no debugging information is being output.
20742 @item The same @option{-m} options must generally be used when building
20743 and using the precompiled header.  @xref{Submodel Options},
20744 for any cases where this rule is relaxed.
20746 @item Each of the following options must be the same when building and using
20747 the precompiled header:
20749 @gccoptlist{-fexceptions}
20751 @item
20752 Some other command-line options starting with @option{-f},
20753 @option{-p}, or @option{-O} must be defined in the same way as when
20754 the precompiled header was generated.  At present, it's not clear
20755 which options are safe to change and which are not; the safest choice
20756 is to use exactly the same options when generating and using the
20757 precompiled header.  The following are known to be safe:
20759 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
20760 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
20761 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
20762 -pedantic-errors}
20764 @end itemize
20766 For all of these except the last, the compiler automatically
20767 ignores the precompiled header if the conditions aren't met.  If you
20768 find an option combination that doesn't work and doesn't cause the
20769 precompiled header to be ignored, please consider filing a bug report,
20770 see @ref{Bugs}.
20772 If you do use differing options when generating and using the
20773 precompiled header, the actual behavior is a mixture of the
20774 behavior for the options.  For instance, if you use @option{-g} to
20775 generate the precompiled header but not when using it, you may or may
20776 not get debugging information for routines in the precompiled header.