c-family/
[official-gcc.git] / gcc / doc / invoke.texi
bloba6baee7cda19b37425f68d6a619a05e11c2ba29f
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 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
202 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
203 -Weffc++  -Wstrict-null-sentinel @gol
204 -Wno-non-template-friend  -Wold-style-cast @gol
205 -Woverloaded-virtual  -Wno-pmf-conversions @gol
206 -Wsign-promo}
208 @item Objective-C and Objective-C++ Language Options
209 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
210 Objective-C and Objective-C++ Dialects}.
211 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
212 -fgnu-runtime  -fnext-runtime @gol
213 -fno-nil-receivers @gol
214 -fobjc-abi-version=@var{n} @gol
215 -fobjc-call-cxx-cdtors @gol
216 -fobjc-direct-dispatch @gol
217 -fobjc-exceptions @gol
218 -fobjc-gc @gol
219 -fobjc-nilcheck @gol
220 -fobjc-std=objc1 @gol
221 -freplace-objc-classes @gol
222 -fzero-link @gol
223 -gen-decls @gol
224 -Wassign-intercept @gol
225 -Wno-protocol  -Wselector @gol
226 -Wstrict-selector-match @gol
227 -Wundeclared-selector}
229 @item Language Independent Options
230 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
231 @gccoptlist{-fmessage-length=@var{n}  @gol
232 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
233 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
235 @item Warning Options
236 @xref{Warning Options,,Options to Request or Suppress Warnings}.
237 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
238 -pedantic-errors @gol
239 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
240 -Wno-attributes -Wno-builtin-macro-redefined @gol
241 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
242 -Wchar-subscripts -Wclobbered  -Wcomment @gol
243 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wno-deprecated  @gol
244 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
245 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
246 -Wno-endif-labels -Werror  -Werror=* @gol
247 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
248 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
249 -Wformat-security  -Wformat-y2k @gol
250 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
251 -Wignored-qualifiers @gol
252 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
253 -Winit-self  -Winline -Wmaybe-uninitialized @gol
254 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
255 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
256 -Wlogical-op -Wlong-long @gol
257 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
258 -Wmissing-include-dirs @gol
259 -Wno-mudflap @gol
260 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
261 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
262 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
263 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
264 -Wredundant-decls @gol
265 -Wreturn-type  -Wsequence-point  -Wshadow @gol
266 -Wsign-compare  -Wsign-conversion  -Wsizeof-pointer-memaccess @gol
267 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
268 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
269 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
270 -Wmissing-format-attribute @gol
271 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
272 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
273 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
274 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
275 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
276 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
277 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
278 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
279 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
281 @item C and Objective-C-only Warning Options
282 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
283 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
284 -Wold-style-declaration  -Wold-style-definition @gol
285 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
286 -Wdeclaration-after-statement -Wpointer-sign}
288 @item Debugging Options
289 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
290 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
291 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
292 -fdisable-ipa-@var{pass_name} @gol
293 -fdisable-rtl-@var{pass_name} @gol
294 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
295 -fdisable-tree-@var{pass_name} @gol
296 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
297 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
298 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
299 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
300 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
301 -fdump-passes @gol
302 -fdump-statistics @gol
303 -fdump-tree-all @gol
304 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
305 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
307 -fdump-tree-ch @gol
308 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-nrv -fdump-tree-vect @gol
318 -fdump-tree-sink @gol
319 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
323 -ftree-vectorizer-verbose=@var{n} @gol
324 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
325 -fdump-final-insns=@var{file} @gol
326 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
327 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
328 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
329 -fenable-@var{kind}-@var{pass} @gol
330 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
331 -fdebug-types-section -fmem-report-wpa @gol
332 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
333 -fopt-info @gol
334 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
335 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
336 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
337 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
338 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
339 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
340 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
341 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
342 -gvms  -gxcoff  -gxcoff+ @gol
343 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
344 -fdebug-prefix-map=@var{old}=@var{new} @gol
345 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
346 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
347 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
348 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
349 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
350 -print-sysroot -print-sysroot-headers-suffix @gol
351 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
353 @item Optimization Options
354 @xref{Optimize Options,,Options that Control Optimization}.
355 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
356 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
357 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
358 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
359 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
360 -fcompare-elim -fcprop-registers -fcrossjumping @gol
361 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
362 -fcx-limited-range @gol
363 -fdata-sections -fdce -fdelayed-branch @gol
364 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
365 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
366 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
367 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
368 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
369 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
370 -fif-conversion2 -findirect-inlining @gol
371 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
372 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
373 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
374 -fira-algorithm=@var{algorithm} @gol
375 -fira-region=@var{region} -fira-hoist-pressure @gol
376 -fira-loop-pressure -fno-ira-share-save-slots @gol
377 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
378 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
379 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
380 -floop-parallelize-all -flto -flto-compression-level @gol
381 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
382 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
383 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
384 -fno-default-inline @gol
385 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
386 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
387 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
388 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
389 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
390 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
391 -fprefetch-loop-arrays -fprofile-report @gol
392 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
393 -fprofile-generate=@var{path} @gol
394 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
395 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
396 -freorder-blocks-and-partition -freorder-functions @gol
397 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
398 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
399 -fsched-spec-load -fsched-spec-load-dangerous @gol
400 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
401 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
402 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
403 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
404 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
405 -fselective-scheduling -fselective-scheduling2 @gol
406 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
407 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
408 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
409 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
410 -fthread-jumps -ftracer -ftree-bit-ccp @gol
411 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
412 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
413 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
414 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
415 -ftree-loop-if-convert-stores -ftree-loop-im @gol
416 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
417 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
418 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
419 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
420 -ftree-switch-conversion -ftree-tail-merge @gol
421 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
422 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
423 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
424 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
425 -fwhole-program -fwpa -fuse-linker-plugin @gol
426 --param @var{name}=@var{value}
427 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
429 @item Preprocessor Options
430 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
431 @gccoptlist{-A@var{question}=@var{answer} @gol
432 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
433 -C  -dD  -dI  -dM  -dN @gol
434 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
435 -idirafter @var{dir} @gol
436 -include @var{file}  -imacros @var{file} @gol
437 -iprefix @var{file}  -iwithprefix @var{dir} @gol
438 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
439 -imultilib @var{dir} -isysroot @var{dir} @gol
440 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
441 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
442 -remap -trigraphs  -undef  -U@var{macro}  @gol
443 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
445 @item Assembler Option
446 @xref{Assembler Options,,Passing Options to the Assembler}.
447 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
449 @item Linker Options
450 @xref{Link Options,,Options for Linking}.
451 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
452 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
453 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
454 -shared-libgcc  -symbolic @gol
455 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
456 -u @var{symbol}}
458 @item Directory Options
459 @xref{Directory Options,,Options for Directory Search}.
460 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
461 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
462 --sysroot=@var{dir} --no-sysroot-suffix}
464 @item Machine Dependent Options
465 @xref{Submodel Options,,Hardware Models and Configurations}.
466 @c This list is ordered alphanumerically by subsection name.
467 @c Try and put the significant identifier (CPU or system) first,
468 @c so users have a clue at guessing where the ones they want will be.
470 @emph{AArch64 Options}
471 @gccoptlist{-mbig-endian  -mlittle-endian @gol
472 -mgeneral-regs-only @gol
473 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
474 -mstrict-align @gol
475 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
476 -mtls-dialect=desc  -mtls-dialect=traditional @gol
477 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
479 @emph{Adapteva Epiphany Options}
480 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
481 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
482 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
483 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
484 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
485 -msplit-vecmove-early -m1reg-@var{reg}}
487 @emph{ARM Options}
488 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
489 -mabi=@var{name} @gol
490 -mapcs-stack-check  -mno-apcs-stack-check @gol
491 -mapcs-float  -mno-apcs-float @gol
492 -mapcs-reentrant  -mno-apcs-reentrant @gol
493 -msched-prolog  -mno-sched-prolog @gol
494 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
495 -mfloat-abi=@var{name} @gol
496 -mfp16-format=@var{name}
497 -mthumb-interwork  -mno-thumb-interwork @gol
498 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
499 -mstructure-size-boundary=@var{n} @gol
500 -mabort-on-noreturn @gol
501 -mlong-calls  -mno-long-calls @gol
502 -msingle-pic-base  -mno-single-pic-base @gol
503 -mpic-register=@var{reg} @gol
504 -mnop-fun-dllimport @gol
505 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
506 -mpoke-function-name @gol
507 -mthumb  -marm @gol
508 -mtpcs-frame  -mtpcs-leaf-frame @gol
509 -mcaller-super-interworking  -mcallee-super-interworking @gol
510 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
511 -mword-relocations @gol
512 -mfix-cortex-m3-ldrd @gol
513 -munaligned-access}
515 @emph{AVR Options}
516 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
517 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
518 -mstrict-X -mtiny-stack}
520 @emph{Blackfin Options}
521 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
522 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
523 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
524 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
525 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
526 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
527 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
528 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
529 -micplb}
531 @emph{C6X Options}
532 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
533 -msim -msdata=@var{sdata-type}}
535 @emph{CRIS Options}
536 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
537 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
538 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
539 -mstack-align  -mdata-align  -mconst-align @gol
540 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
541 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
542 -mmul-bug-workaround  -mno-mul-bug-workaround}
544 @emph{CR16 Options}
545 @gccoptlist{-mmac @gol
546 -mcr16cplus -mcr16c @gol
547 -msim -mint32 -mbit-ops
548 -mdata-model=@var{model}}
550 @emph{Darwin Options}
551 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
552 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
553 -client_name  -compatibility_version  -current_version @gol
554 -dead_strip @gol
555 -dependency-file  -dylib_file  -dylinker_install_name @gol
556 -dynamic  -dynamiclib  -exported_symbols_list @gol
557 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
558 -force_flat_namespace  -headerpad_max_install_names @gol
559 -iframework @gol
560 -image_base  -init  -install_name  -keep_private_externs @gol
561 -multi_module  -multiply_defined  -multiply_defined_unused @gol
562 -noall_load   -no_dead_strip_inits_and_terms @gol
563 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
564 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
565 -private_bundle  -read_only_relocs  -sectalign @gol
566 -sectobjectsymbols  -whyload  -seg1addr @gol
567 -sectcreate  -sectobjectsymbols  -sectorder @gol
568 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
569 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
570 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
571 -single_module  -static  -sub_library  -sub_umbrella @gol
572 -twolevel_namespace  -umbrella  -undefined @gol
573 -unexported_symbols_list  -weak_reference_mismatches @gol
574 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
575 -mkernel -mone-byte-bool}
577 @emph{DEC Alpha Options}
578 @gccoptlist{-mno-fp-regs  -msoft-float @gol
579 -mieee  -mieee-with-inexact  -mieee-conformant @gol
580 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
581 -mtrap-precision=@var{mode}  -mbuild-constants @gol
582 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
583 -mbwx  -mmax  -mfix  -mcix @gol
584 -mfloat-vax  -mfloat-ieee @gol
585 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
586 -msmall-text  -mlarge-text @gol
587 -mmemory-latency=@var{time}}
589 @emph{FR30 Options}
590 @gccoptlist{-msmall-model -mno-lsim}
592 @emph{FRV Options}
593 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
594 -mhard-float  -msoft-float @gol
595 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
596 -mdouble  -mno-double @gol
597 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
598 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
599 -mlinked-fp  -mlong-calls  -malign-labels @gol
600 -mlibrary-pic  -macc-4  -macc-8 @gol
601 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
602 -moptimize-membar -mno-optimize-membar @gol
603 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
604 -mvliw-branch  -mno-vliw-branch @gol
605 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
606 -mno-nested-cond-exec  -mtomcat-stats @gol
607 -mTLS -mtls @gol
608 -mcpu=@var{cpu}}
610 @emph{GNU/Linux Options}
611 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
612 -tno-android-cc -tno-android-ld}
614 @emph{H8/300 Options}
615 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
617 @emph{HPPA Options}
618 @gccoptlist{-march=@var{architecture-type} @gol
619 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
620 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
621 -mfixed-range=@var{register-range} @gol
622 -mjump-in-delay -mlinker-opt -mlong-calls @gol
623 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
624 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
625 -mno-jump-in-delay  -mno-long-load-store @gol
626 -mno-portable-runtime  -mno-soft-float @gol
627 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
628 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
629 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
630 -munix=@var{unix-std}  -nolibdld  -static  -threads}
632 @emph{i386 and x86-64 Options}
633 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
634 -mfpmath=@var{unit} @gol
635 -masm=@var{dialect}  -mno-fancy-math-387 @gol
636 -mno-fp-ret-in-387  -msoft-float @gol
637 -mno-wide-multiply  -mrtd  -malign-double @gol
638 -mpreferred-stack-boundary=@var{num} @gol
639 -mincoming-stack-boundary=@var{num} @gol
640 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
641 -mrecip -mrecip=@var{opt} @gol
642 -mvzeroupper -mprefer-avx128 @gol
643 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
644 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
645 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
646 -mbmi2 -mrtm -mlwp -mthreads @gol
647 -mno-align-stringops  -minline-all-stringops @gol
648 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
649 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
650 -m96bit-long-double -mlong-double-64 -mlong-double-80 @gol
651 -mregparm=@var{num}  -msseregparm @gol
652 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
653 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
654 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
655 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
656 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
657 -msse2avx -mfentry -m8bit-idiv @gol
658 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
660 @emph{i386 and x86-64 Windows Options}
661 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
662 -mnop-fun-dllimport -mthread @gol
663 -municode -mwin32 -mwindows -fno-set-stack-executable}
665 @emph{IA-64 Options}
666 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
667 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
668 -mconstant-gp  -mauto-pic  -mfused-madd @gol
669 -minline-float-divide-min-latency @gol
670 -minline-float-divide-max-throughput @gol
671 -mno-inline-float-divide @gol
672 -minline-int-divide-min-latency @gol
673 -minline-int-divide-max-throughput  @gol
674 -mno-inline-int-divide @gol
675 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
676 -mno-inline-sqrt @gol
677 -mdwarf2-asm -mearly-stop-bits @gol
678 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
679 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
680 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
681 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
682 -msched-spec-ldc -msched-spec-control-ldc @gol
683 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
684 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
685 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
686 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
688 @emph{LM32 Options}
689 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
690 -msign-extend-enabled -muser-enabled}
692 @emph{M32R/D Options}
693 @gccoptlist{-m32r2 -m32rx -m32r @gol
694 -mdebug @gol
695 -malign-loops -mno-align-loops @gol
696 -missue-rate=@var{number} @gol
697 -mbranch-cost=@var{number} @gol
698 -mmodel=@var{code-size-model-type} @gol
699 -msdata=@var{sdata-type} @gol
700 -mno-flush-func -mflush-func=@var{name} @gol
701 -mno-flush-trap -mflush-trap=@var{number} @gol
702 -G @var{num}}
704 @emph{M32C Options}
705 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
707 @emph{M680x0 Options}
708 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
709 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
710 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
711 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
712 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
713 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
714 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
715 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
716 -mxgot -mno-xgot}
718 @emph{MCore Options}
719 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
720 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
721 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
722 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
723 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
725 @emph{MeP Options}
726 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
727 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
728 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
729 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
730 -mtiny=@var{n}}
732 @emph{MicroBlaze Options}
733 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
734 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
735 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
736 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
737 -mxl-mode-@var{app-model}}
739 @emph{MIPS Options}
740 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
741 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
742 -mips64  -mips64r2 @gol
743 -mips16  -mno-mips16  -mflip-mips16 @gol
744 -minterlink-mips16  -mno-interlink-mips16 @gol
745 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
746 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
747 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
748 -mno-float -msingle-float  -mdouble-float  @gol
749 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
750 -mmcu -mmno-mcu @gol
751 -mfpu=@var{fpu-type} @gol
752 -msmartmips  -mno-smartmips @gol
753 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
754 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
755 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
756 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
757 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
758 -membedded-data  -mno-embedded-data @gol
759 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
760 -mcode-readable=@var{setting} @gol
761 -msplit-addresses  -mno-split-addresses @gol
762 -mexplicit-relocs  -mno-explicit-relocs @gol
763 -mcheck-zero-division  -mno-check-zero-division @gol
764 -mdivide-traps  -mdivide-breaks @gol
765 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
766 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
767 -mfix-24k -mno-fix-24k @gol
768 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
769 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
770 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
771 -mflush-func=@var{func}  -mno-flush-func @gol
772 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
773 -mfp-exceptions -mno-fp-exceptions @gol
774 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
775 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
777 @emph{MMIX Options}
778 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
779 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
780 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
781 -mno-base-addresses  -msingle-exit  -mno-single-exit}
783 @emph{MN10300 Options}
784 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
785 -mno-am33 -mam33 -mam33-2 -mam34 @gol
786 -mtune=@var{cpu-type} @gol
787 -mreturn-pointer-on-d0 @gol
788 -mno-crt0  -mrelax -mliw -msetlb}
790 @emph{Moxie Options}
791 @gccoptlist{-meb -mel -mno-crt0}
793 @emph{PDP-11 Options}
794 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
795 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
796 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
797 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
798 -mbranch-expensive  -mbranch-cheap @gol
799 -munix-asm  -mdec-asm}
801 @emph{picoChip Options}
802 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
803 -msymbol-as-address -mno-inefficient-warnings}
805 @emph{PowerPC Options}
806 See RS/6000 and PowerPC Options.
808 @emph{RL78 Options}
809 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
811 @emph{RS/6000 and PowerPC Options}
812 @gccoptlist{-mcpu=@var{cpu-type} @gol
813 -mtune=@var{cpu-type} @gol
814 -mcmodel=@var{code-model} @gol
815 -mpowerpc64 @gol
816 -maltivec  -mno-altivec @gol
817 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
818 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
819 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
820 -mfprnd  -mno-fprnd @gol
821 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
822 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
823 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
824 -malign-power  -malign-natural @gol
825 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
826 -msingle-float -mdouble-float -msimple-fpu @gol
827 -mstring  -mno-string  -mupdate  -mno-update @gol
828 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
829 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
830 -mstrict-align  -mno-strict-align  -mrelocatable @gol
831 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
832 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
833 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
834 -mprioritize-restricted-insns=@var{priority} @gol
835 -msched-costly-dep=@var{dependence_type} @gol
836 -minsert-sched-nops=@var{scheme} @gol
837 -mcall-sysv  -mcall-netbsd @gol
838 -maix-struct-return  -msvr4-struct-return @gol
839 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
840 -mblock-move-inline-limit=@var{num} @gol
841 -misel -mno-isel @gol
842 -misel=yes  -misel=no @gol
843 -mspe -mno-spe @gol
844 -mspe=yes  -mspe=no @gol
845 -mpaired @gol
846 -mgen-cell-microcode -mwarn-cell-microcode @gol
847 -mvrsave -mno-vrsave @gol
848 -mmulhw -mno-mulhw @gol
849 -mdlmzb -mno-dlmzb @gol
850 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
851 -mprototype  -mno-prototype @gol
852 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
853 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
854 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
855 -mno-recip-precision @gol
856 -mveclibabi=@var{type} -mfriz -mno-friz @gol
857 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
858 -msave-toc-indirect -mno-save-toc-indirect}
860 @emph{RX Options}
861 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
862 -mcpu=@gol
863 -mbig-endian-data -mlittle-endian-data @gol
864 -msmall-data @gol
865 -msim  -mno-sim@gol
866 -mas100-syntax -mno-as100-syntax@gol
867 -mrelax@gol
868 -mmax-constant-size=@gol
869 -mint-register=@gol
870 -mpid@gol
871 -mno-warn-multiple-fast-interrupts@gol
872 -msave-acc-in-interrupts}
874 @emph{S/390 and zSeries Options}
875 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
876 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
877 -mlong-double-64 -mlong-double-128 @gol
878 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
879 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
880 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
881 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
882 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
884 @emph{Score Options}
885 @gccoptlist{-meb -mel @gol
886 -mnhwloop @gol
887 -muls @gol
888 -mmac @gol
889 -mscore5 -mscore5u -mscore7 -mscore7d}
891 @emph{SH Options}
892 @gccoptlist{-m1  -m2  -m2e @gol
893 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
894 -m3  -m3e @gol
895 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
896 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
897 -m5-64media  -m5-64media-nofpu @gol
898 -m5-32media  -m5-32media-nofpu @gol
899 -m5-compact  -m5-compact-nofpu @gol
900 -mb  -ml  -mdalign  -mrelax @gol
901 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
902 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
903 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
904 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
905 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
906 -maccumulate-outgoing-args -minvalid-symbols @gol
907 -matomic-model=@var{atomic-model} @gol
908 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch -mcbranchdi -mcmpeqdi @gol
909 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
910 -mpretend-cmove -mtas}
912 @emph{Solaris 2 Options}
913 @gccoptlist{-mimpure-text  -mno-impure-text @gol
914 -pthreads -pthread}
916 @emph{SPARC Options}
917 @gccoptlist{-mcpu=@var{cpu-type} @gol
918 -mtune=@var{cpu-type} @gol
919 -mcmodel=@var{code-model} @gol
920 -mmemory-model=@var{mem-model} @gol
921 -m32  -m64  -mapp-regs  -mno-app-regs @gol
922 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
923 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
924 -mhard-quad-float  -msoft-quad-float @gol
925 -mlittle-endian @gol
926 -mstack-bias  -mno-stack-bias @gol
927 -munaligned-doubles  -mno-unaligned-doubles @gol
928 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
929 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
930 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
931 -mfix-at697f}
933 @emph{SPU Options}
934 @gccoptlist{-mwarn-reloc -merror-reloc @gol
935 -msafe-dma -munsafe-dma @gol
936 -mbranch-hints @gol
937 -msmall-mem -mlarge-mem -mstdmain @gol
938 -mfixed-range=@var{register-range} @gol
939 -mea32 -mea64 @gol
940 -maddress-space-conversion -mno-address-space-conversion @gol
941 -mcache-size=@var{cache-size} @gol
942 -matomic-updates -mno-atomic-updates}
944 @emph{System V Options}
945 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
947 @emph{TILE-Gx Options}
948 @gccoptlist{-mcpu=@var{cpu} -m32 -m64 -mcmodel=@var{code-model}}
950 @emph{TILEPro Options}
951 @gccoptlist{-mcpu=@var{cpu} -m32}
953 @emph{V850 Options}
954 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
955 -mprolog-function  -mno-prolog-function  -mspace @gol
956 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
957 -mapp-regs  -mno-app-regs @gol
958 -mdisable-callt  -mno-disable-callt @gol
959 -mv850e2v3 @gol
960 -mv850e2 @gol
961 -mv850e1 -mv850es @gol
962 -mv850e @gol
963 -mv850  -mbig-switch}
965 @emph{VAX Options}
966 @gccoptlist{-mg  -mgnu  -munix}
968 @emph{VMS Options}
969 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
970 -mpointer-size=@var{size}}
972 @emph{VxWorks Options}
973 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
974 -Xbind-lazy  -Xbind-now}
976 @emph{x86-64 Options}
977 See i386 and x86-64 Options.
979 @emph{Xstormy16 Options}
980 @gccoptlist{-msim}
982 @emph{Xtensa Options}
983 @gccoptlist{-mconst16 -mno-const16 @gol
984 -mfused-madd  -mno-fused-madd @gol
985 -mforce-no-pic @gol
986 -mserialize-volatile  -mno-serialize-volatile @gol
987 -mtext-section-literals  -mno-text-section-literals @gol
988 -mtarget-align  -mno-target-align @gol
989 -mlongcalls  -mno-longcalls}
991 @emph{zSeries Options}
992 See S/390 and zSeries Options.
994 @item Code Generation Options
995 @xref{Code Gen Options,,Options for Code Generation Conventions}.
996 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
997 -ffixed-@var{reg}  -fexceptions @gol
998 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
999 -fasynchronous-unwind-tables @gol
1000 -finhibit-size-directive  -finstrument-functions @gol
1001 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1002 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1003 -fno-common  -fno-ident @gol
1004 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1005 -fno-jump-tables @gol
1006 -frecord-gcc-switches @gol
1007 -freg-struct-return  -fshort-enums @gol
1008 -fshort-double  -fshort-wchar @gol
1009 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1010 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1011 -fno-stack-limit -fsplit-stack @gol
1012 -fleading-underscore  -ftls-model=@var{model} @gol
1013 -fstack-reuse=@var{reuse_level} @gol
1014 -ftrapv  -fwrapv  -fbounds-check @gol
1015 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1016 @end table
1018 @menu
1019 * Overall Options::     Controlling the kind of output:
1020                         an executable, object files, assembler files,
1021                         or preprocessed source.
1022 * C Dialect Options::   Controlling the variant of C language compiled.
1023 * C++ Dialect Options:: Variations on C++.
1024 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1025                         and Objective-C++.
1026 * Language Independent Options:: Controlling how diagnostics should be
1027                         formatted.
1028 * Warning Options::     How picky should the compiler be?
1029 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
1030 * Optimize Options::    How much optimization?
1031 * Preprocessor Options:: Controlling header files and macro definitions.
1032                          Also, getting dependency information for Make.
1033 * Assembler Options::   Passing options to the assembler.
1034 * Link Options::        Specifying libraries and so on.
1035 * Directory Options::   Where to find header files and libraries.
1036                         Where to find the compiler executable files.
1037 * Spec Files::          How to pass switches to sub-processes.
1038 * Target Options::      Running a cross-compiler, or an old version of GCC.
1039 @end menu
1041 @node Overall Options
1042 @section Options Controlling the Kind of Output
1044 Compilation can involve up to four stages: preprocessing, compilation
1045 proper, assembly and linking, always in that order.  GCC is capable of
1046 preprocessing and compiling several files either into several
1047 assembler input files, or into one assembler input file; then each
1048 assembler input file produces an object file, and linking combines all
1049 the object files (those newly compiled, and those specified as input)
1050 into an executable file.
1052 @cindex file name suffix
1053 For any given input file, the file name suffix determines what kind of
1054 compilation is done:
1056 @table @gcctabopt
1057 @item @var{file}.c
1058 C source code that must be preprocessed.
1060 @item @var{file}.i
1061 C source code that should not be preprocessed.
1063 @item @var{file}.ii
1064 C++ source code that should not be preprocessed.
1066 @item @var{file}.m
1067 Objective-C source code.  Note that you must link with the @file{libobjc}
1068 library to make an Objective-C program work.
1070 @item @var{file}.mi
1071 Objective-C source code that should not be preprocessed.
1073 @item @var{file}.mm
1074 @itemx @var{file}.M
1075 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1076 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1077 to a literal capital M@.
1079 @item @var{file}.mii
1080 Objective-C++ source code that should not be preprocessed.
1082 @item @var{file}.h
1083 C, C++, Objective-C or Objective-C++ header file to be turned into a
1084 precompiled header (default), or C, C++ header file to be turned into an
1085 Ada spec (via the @option{-fdump-ada-spec} switch).
1087 @item @var{file}.cc
1088 @itemx @var{file}.cp
1089 @itemx @var{file}.cxx
1090 @itemx @var{file}.cpp
1091 @itemx @var{file}.CPP
1092 @itemx @var{file}.c++
1093 @itemx @var{file}.C
1094 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1095 the last two letters must both be literally @samp{x}.  Likewise,
1096 @samp{.C} refers to a literal capital C@.
1098 @item @var{file}.mm
1099 @itemx @var{file}.M
1100 Objective-C++ source code that must be preprocessed.
1102 @item @var{file}.mii
1103 Objective-C++ source code that should not be preprocessed.
1105 @item @var{file}.hh
1106 @itemx @var{file}.H
1107 @itemx @var{file}.hp
1108 @itemx @var{file}.hxx
1109 @itemx @var{file}.hpp
1110 @itemx @var{file}.HPP
1111 @itemx @var{file}.h++
1112 @itemx @var{file}.tcc
1113 C++ header file to be turned into a precompiled header or Ada spec.
1115 @item @var{file}.f
1116 @itemx @var{file}.for
1117 @itemx @var{file}.ftn
1118 Fixed form Fortran source code that should not be preprocessed.
1120 @item @var{file}.F
1121 @itemx @var{file}.FOR
1122 @itemx @var{file}.fpp
1123 @itemx @var{file}.FPP
1124 @itemx @var{file}.FTN
1125 Fixed form Fortran source code that must be preprocessed (with the traditional
1126 preprocessor).
1128 @item @var{file}.f90
1129 @itemx @var{file}.f95
1130 @itemx @var{file}.f03
1131 @itemx @var{file}.f08
1132 Free form Fortran source code that should not be preprocessed.
1134 @item @var{file}.F90
1135 @itemx @var{file}.F95
1136 @itemx @var{file}.F03
1137 @itemx @var{file}.F08
1138 Free form Fortran source code that must be preprocessed (with the
1139 traditional preprocessor).
1141 @item @var{file}.go
1142 Go source code.
1144 @c FIXME: Descriptions of Java file types.
1145 @c @var{file}.java
1146 @c @var{file}.class
1147 @c @var{file}.zip
1148 @c @var{file}.jar
1150 @item @var{file}.ads
1151 Ada source code file that contains a library unit declaration (a
1152 declaration of a package, subprogram, or generic, or a generic
1153 instantiation), or a library unit renaming declaration (a package,
1154 generic, or subprogram renaming declaration).  Such files are also
1155 called @dfn{specs}.
1157 @item @var{file}.adb
1158 Ada source code file containing a library unit body (a subprogram or
1159 package body).  Such files are also called @dfn{bodies}.
1161 @c GCC also knows about some suffixes for languages not yet included:
1162 @c Pascal:
1163 @c @var{file}.p
1164 @c @var{file}.pas
1165 @c Ratfor:
1166 @c @var{file}.r
1168 @item @var{file}.s
1169 Assembler code.
1171 @item @var{file}.S
1172 @itemx @var{file}.sx
1173 Assembler code that must be preprocessed.
1175 @item @var{other}
1176 An object file to be fed straight into linking.
1177 Any file name with no recognized suffix is treated this way.
1178 @end table
1180 @opindex x
1181 You can specify the input language explicitly with the @option{-x} option:
1183 @table @gcctabopt
1184 @item -x @var{language}
1185 Specify explicitly the @var{language} for the following input files
1186 (rather than letting the compiler choose a default based on the file
1187 name suffix).  This option applies to all following input files until
1188 the next @option{-x} option.  Possible values for @var{language} are:
1189 @smallexample
1190 c  c-header  cpp-output
1191 c++  c++-header  c++-cpp-output
1192 objective-c  objective-c-header  objective-c-cpp-output
1193 objective-c++ objective-c++-header objective-c++-cpp-output
1194 assembler  assembler-with-cpp
1196 f77  f77-cpp-input f95  f95-cpp-input
1198 java
1199 @end smallexample
1201 @item -x none
1202 Turn off any specification of a language, so that subsequent files are
1203 handled according to their file name suffixes (as they are if @option{-x}
1204 has not been used at all).
1206 @item -pass-exit-codes
1207 @opindex pass-exit-codes
1208 Normally the @command{gcc} program exits with the code of 1 if any
1209 phase of the compiler returns a non-success return code.  If you specify
1210 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1211 the numerically highest error produced by any phase returning an error
1212 indication.  The C, C++, and Fortran front ends return 4 if an internal
1213 compiler error is encountered.
1214 @end table
1216 If you only want some of the stages of compilation, you can use
1217 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1218 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1219 @command{gcc} is to stop.  Note that some combinations (for example,
1220 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1222 @table @gcctabopt
1223 @item -c
1224 @opindex c
1225 Compile or assemble the source files, but do not link.  The linking
1226 stage simply is not done.  The ultimate output is in the form of an
1227 object file for each source file.
1229 By default, the object file name for a source file is made by replacing
1230 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1232 Unrecognized input files, not requiring compilation or assembly, are
1233 ignored.
1235 @item -S
1236 @opindex S
1237 Stop after the stage of compilation proper; do not assemble.  The output
1238 is in the form of an assembler code file for each non-assembler input
1239 file specified.
1241 By default, the assembler file name for a source file is made by
1242 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1244 Input files that don't require compilation are ignored.
1246 @item -E
1247 @opindex E
1248 Stop after the preprocessing stage; do not run the compiler proper.  The
1249 output is in the form of preprocessed source code, which is sent to the
1250 standard output.
1252 Input files that don't require preprocessing are ignored.
1254 @cindex output file option
1255 @item -o @var{file}
1256 @opindex o
1257 Place output in file @var{file}.  This applies to whatever
1258 sort of output is being produced, whether it be an executable file,
1259 an object file, an assembler file or preprocessed C code.
1261 If @option{-o} is not specified, the default is to put an executable
1262 file in @file{a.out}, the object file for
1263 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1264 assembler file in @file{@var{source}.s}, a precompiled header file in
1265 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1266 standard output.
1268 @item -v
1269 @opindex v
1270 Print (on standard error output) the commands executed to run the stages
1271 of compilation.  Also print the version number of the compiler driver
1272 program and of the preprocessor and the compiler proper.
1274 @item -###
1275 @opindex ###
1276 Like @option{-v} except the commands are not executed and arguments
1277 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1278 This is useful for shell scripts to capture the driver-generated command lines.
1280 @item -pipe
1281 @opindex pipe
1282 Use pipes rather than temporary files for communication between the
1283 various stages of compilation.  This fails to work on some systems where
1284 the assembler is unable to read from a pipe; but the GNU assembler has
1285 no trouble.
1287 @item --help
1288 @opindex help
1289 Print (on the standard output) a description of the command-line options
1290 understood by @command{gcc}.  If the @option{-v} option is also specified
1291 then @option{--help} is also passed on to the various processes
1292 invoked by @command{gcc}, so that they can display the command-line options
1293 they accept.  If the @option{-Wextra} option has also been specified
1294 (prior to the @option{--help} option), then command-line options that
1295 have no documentation associated with them are also displayed.
1297 @item --target-help
1298 @opindex target-help
1299 Print (on the standard output) a description of target-specific command-line
1300 options for each tool.  For some targets extra target-specific
1301 information may also be printed.
1303 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1304 Print (on the standard output) a description of the command-line
1305 options understood by the compiler that fit into all specified classes
1306 and qualifiers.  These are the supported classes:
1308 @table @asis
1309 @item @samp{optimizers}
1310 Display all of the optimization options supported by the
1311 compiler.
1313 @item @samp{warnings}
1314 Display all of the options controlling warning messages
1315 produced by the compiler.
1317 @item @samp{target}
1318 Display target-specific options.  Unlike the
1319 @option{--target-help} option however, target-specific options of the
1320 linker and assembler are not displayed.  This is because those
1321 tools do not currently support the extended @option{--help=} syntax.
1323 @item @samp{params}
1324 Display the values recognized by the @option{--param}
1325 option.
1327 @item @var{language}
1328 Display the options supported for @var{language}, where
1329 @var{language} is the name of one of the languages supported in this
1330 version of GCC@.
1332 @item @samp{common}
1333 Display the options that are common to all languages.
1334 @end table
1336 These are the supported qualifiers:
1338 @table @asis
1339 @item @samp{undocumented}
1340 Display only those options that are undocumented.
1342 @item @samp{joined}
1343 Display options taking an argument that appears after an equal
1344 sign in the same continuous piece of text, such as:
1345 @samp{--help=target}.
1347 @item @samp{separate}
1348 Display options taking an argument that appears as a separate word
1349 following the original option, such as: @samp{-o output-file}.
1350 @end table
1352 Thus for example to display all the undocumented target-specific
1353 switches supported by the compiler, use:
1355 @smallexample
1356 --help=target,undocumented
1357 @end smallexample
1359 The sense of a qualifier can be inverted by prefixing it with the
1360 @samp{^} character, so for example to display all binary warning
1361 options (i.e., ones that are either on or off and that do not take an
1362 argument) that have a description, use:
1364 @smallexample
1365 --help=warnings,^joined,^undocumented
1366 @end smallexample
1368 The argument to @option{--help=} should not consist solely of inverted
1369 qualifiers.
1371 Combining several classes is possible, although this usually
1372 restricts the output so much that there is nothing to display.  One
1373 case where it does work, however, is when one of the classes is
1374 @var{target}.  For example, to display all the target-specific
1375 optimization options, use:
1377 @smallexample
1378 --help=target,optimizers
1379 @end smallexample
1381 The @option{--help=} option can be repeated on the command line.  Each
1382 successive use displays its requested class of options, skipping
1383 those that have already been displayed.
1385 If the @option{-Q} option appears on the command line before the
1386 @option{--help=} option, then the descriptive text displayed by
1387 @option{--help=} is changed.  Instead of describing the displayed
1388 options, an indication is given as to whether the option is enabled,
1389 disabled or set to a specific value (assuming that the compiler
1390 knows this at the point where the @option{--help=} option is used).
1392 Here is a truncated example from the ARM port of @command{gcc}:
1394 @smallexample
1395   % gcc -Q -mabi=2 --help=target -c
1396   The following options are target specific:
1397   -mabi=                                2
1398   -mabort-on-noreturn                   [disabled]
1399   -mapcs                                [disabled]
1400 @end smallexample
1402 The output is sensitive to the effects of previous command-line
1403 options, so for example it is possible to find out which optimizations
1404 are enabled at @option{-O2} by using:
1406 @smallexample
1407 -Q -O2 --help=optimizers
1408 @end smallexample
1410 Alternatively you can discover which binary optimizations are enabled
1411 by @option{-O3} by using:
1413 @smallexample
1414 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1415 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1416 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1417 @end smallexample
1419 @item -no-canonical-prefixes
1420 @opindex no-canonical-prefixes
1421 Do not expand any symbolic links, resolve references to @samp{/../}
1422 or @samp{/./}, or make the path absolute when generating a relative
1423 prefix.
1425 @item --version
1426 @opindex version
1427 Display the version number and copyrights of the invoked GCC@.
1429 @item -wrapper
1430 @opindex wrapper
1431 Invoke all subcommands under a wrapper program.  The name of the
1432 wrapper program and its parameters are passed as a comma separated
1433 list.
1435 @smallexample
1436 gcc -c t.c -wrapper gdb,--args
1437 @end smallexample
1439 @noindent
1440 This invokes all subprograms of @command{gcc} under
1441 @samp{gdb --args}, thus the invocation of @command{cc1} is
1442 @samp{gdb --args cc1 @dots{}}.
1444 @item -fplugin=@var{name}.so
1445 Load the plugin code in file @var{name}.so, assumed to be a
1446 shared object to be dlopen'd by the compiler.  The base name of
1447 the shared object file is used to identify the plugin for the
1448 purposes of argument parsing (See
1449 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1450 Each plugin should define the callback functions specified in the
1451 Plugins API.
1453 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1454 Define an argument called @var{key} with a value of @var{value}
1455 for the plugin called @var{name}.
1457 @item -fdump-ada-spec@r{[}-slim@r{]}
1458 For C and C++ source and include files, generate corresponding Ada
1459 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1460 GNAT User's Guide}, which provides detailed documentation on this feature.
1462 @item -fdump-go-spec=@var{file}
1463 For input files in any language, generate corresponding Go
1464 declarations in @var{file}.  This generates Go @code{const},
1465 @code{type}, @code{var}, and @code{func} declarations which may be a
1466 useful way to start writing a Go interface to code written in some
1467 other language.
1469 @include @value{srcdir}/../libiberty/at-file.texi
1470 @end table
1472 @node Invoking G++
1473 @section Compiling C++ Programs
1475 @cindex suffixes for C++ source
1476 @cindex C++ source file suffixes
1477 C++ source files conventionally use one of the suffixes @samp{.C},
1478 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1479 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1480 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1481 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1482 files with these names and compiles them as C++ programs even if you
1483 call the compiler the same way as for compiling C programs (usually
1484 with the name @command{gcc}).
1486 @findex g++
1487 @findex c++
1488 However, the use of @command{gcc} does not add the C++ library.
1489 @command{g++} is a program that calls GCC and automatically specifies linking
1490 against the C++ library.  It treats @samp{.c},
1491 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1492 files unless @option{-x} is used.  This program is also useful when
1493 precompiling a C header file with a @samp{.h} extension for use in C++
1494 compilations.  On many systems, @command{g++} is also installed with
1495 the name @command{c++}.
1497 @cindex invoking @command{g++}
1498 When you compile C++ programs, you may specify many of the same
1499 command-line options that you use for compiling programs in any
1500 language; or command-line options meaningful for C and related
1501 languages; or options that are meaningful only for C++ programs.
1502 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1503 explanations of options for languages related to C@.
1504 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1505 explanations of options that are meaningful only for C++ programs.
1507 @node C Dialect Options
1508 @section Options Controlling C Dialect
1509 @cindex dialect options
1510 @cindex language dialect options
1511 @cindex options, dialect
1513 The following options control the dialect of C (or languages derived
1514 from C, such as C++, Objective-C and Objective-C++) that the compiler
1515 accepts:
1517 @table @gcctabopt
1518 @cindex ANSI support
1519 @cindex ISO support
1520 @item -ansi
1521 @opindex ansi
1522 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1523 equivalent to @option{-std=c++98}.
1525 This turns off certain features of GCC that are incompatible with ISO
1526 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1527 such as the @code{asm} and @code{typeof} keywords, and
1528 predefined macros such as @code{unix} and @code{vax} that identify the
1529 type of system you are using.  It also enables the undesirable and
1530 rarely used ISO trigraph feature.  For the C compiler,
1531 it disables recognition of C++ style @samp{//} comments as well as
1532 the @code{inline} keyword.
1534 The alternate keywords @code{__asm__}, @code{__extension__},
1535 @code{__inline__} and @code{__typeof__} continue to work despite
1536 @option{-ansi}.  You would not want to use them in an ISO C program, of
1537 course, but it is useful to put them in header files that might be included
1538 in compilations done with @option{-ansi}.  Alternate predefined macros
1539 such as @code{__unix__} and @code{__vax__} are also available, with or
1540 without @option{-ansi}.
1542 The @option{-ansi} option does not cause non-ISO programs to be
1543 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1544 addition to @option{-ansi}.  @xref{Warning Options}.
1546 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1547 option is used.  Some header files may notice this macro and refrain
1548 from declaring certain functions or defining certain macros that the
1549 ISO standard doesn't call for; this is to avoid interfering with any
1550 programs that might use these names for other things.
1552 Functions that are normally built in but do not have semantics
1553 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1554 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1555 built-in functions provided by GCC}, for details of the functions
1556 affected.
1558 @item -std=
1559 @opindex std
1560 Determine the language standard. @xref{Standards,,Language Standards
1561 Supported by GCC}, for details of these standard versions.  This option
1562 is currently only supported when compiling C or C++.
1564 The compiler can accept several base standards, such as @samp{c90} or
1565 @samp{c++98}, and GNU dialects of those standards, such as
1566 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1567 compiler accepts all programs following that standard plus those
1568 using GNU extensions that do not contradict it.  For example,
1569 @option{-std=c90} turns off certain features of GCC that are
1570 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1571 keywords, but not other GNU extensions that do not have a meaning in
1572 ISO C90, such as omitting the middle term of a @code{?:}
1573 expression. On the other hand, when a GNU dialect of a standard is
1574 specified, all features supported by the compiler are enabled, even when
1575 those features change the meaning of the base standard.  As a result, some
1576 strict-conforming programs may be rejected.  The particular standard
1577 is used by @option{-Wpedantic} to identify which features are GNU
1578 extensions given that version of the standard. For example
1579 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1580 comments, while @option{-std=gnu99 -Wpedantic} does not.
1582 A value for this option must be provided; possible values are
1584 @table @samp
1585 @item c90
1586 @itemx c89
1587 @itemx iso9899:1990
1588 Support all ISO C90 programs (certain GNU extensions that conflict
1589 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1591 @item iso9899:199409
1592 ISO C90 as modified in amendment 1.
1594 @item c99
1595 @itemx c9x
1596 @itemx iso9899:1999
1597 @itemx iso9899:199x
1598 ISO C99.  Note that this standard is not yet fully supported; see
1599 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1600 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1602 @item c11
1603 @itemx c1x
1604 @itemx iso9899:2011
1605 ISO C11, the 2011 revision of the ISO C standard.
1606 Support is incomplete and experimental.  The name @samp{c1x} is
1607 deprecated.
1609 @item gnu90
1610 @itemx gnu89
1611 GNU dialect of ISO C90 (including some C99 features). This
1612 is the default for C code.
1614 @item gnu99
1615 @itemx gnu9x
1616 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1617 this will become the default.  The name @samp{gnu9x} is deprecated.
1619 @item gnu11
1620 @item gnu1x
1621 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1622 name @samp{gnu1x} is deprecated.
1624 @item c++98
1625 @itemx c++03
1626 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1627 additional defect reports. Same as @option{-ansi} for C++ code.
1629 @item gnu++98
1630 @itemx gnu++03
1631 GNU dialect of @option{-std=c++98}.  This is the default for
1632 C++ code.
1634 @item c++11
1635 @itemx c++0x
1636 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1637 experimental, and may change in incompatible ways in future releases.
1638 The name @samp{c++0x} is deprecated.
1640 @item gnu++11
1641 @itemx gnu++0x
1642 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1643 experimental, and may change in incompatible ways in future releases.
1644 The name @samp{gnu++0x} is deprecated.
1646 @item c++1y
1647 The next revision of the ISO C++ standard, tentatively planned for
1648 2017.  Support is highly experimental, and will almost certainly
1649 change in incompatible ways in future releases.
1651 @item gnu++1y
1652 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1653 and will almost certainly change in incompatible ways in future
1654 releases.
1655 @end table
1657 @item -fgnu89-inline
1658 @opindex fgnu89-inline
1659 The option @option{-fgnu89-inline} tells GCC to use the traditional
1660 GNU semantics for @code{inline} functions when in C99 mode.
1661 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1662 is accepted and ignored by GCC versions 4.1.3 up to but not including
1663 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1664 C99 mode.  Using this option is roughly equivalent to adding the
1665 @code{gnu_inline} function attribute to all inline functions
1666 (@pxref{Function Attributes}).
1668 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1669 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1670 specifies the default behavior).  This option was first supported in
1671 GCC 4.3.  This option is not supported in @option{-std=c90} or
1672 @option{-std=gnu90} mode.
1674 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1675 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1676 in effect for @code{inline} functions.  @xref{Common Predefined
1677 Macros,,,cpp,The C Preprocessor}.
1679 @item -aux-info @var{filename}
1680 @opindex aux-info
1681 Output to the given filename prototyped declarations for all functions
1682 declared and/or defined in a translation unit, including those in header
1683 files.  This option is silently ignored in any language other than C@.
1685 Besides declarations, the file indicates, in comments, the origin of
1686 each declaration (source file and line), whether the declaration was
1687 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1688 @samp{O} for old, respectively, in the first character after the line
1689 number and the colon), and whether it came from a declaration or a
1690 definition (@samp{C} or @samp{F}, respectively, in the following
1691 character).  In the case of function definitions, a K&R-style list of
1692 arguments followed by their declarations is also provided, inside
1693 comments, after the declaration.
1695 @item -fallow-parameterless-variadic-functions
1696 Accept variadic functions without named parameters.
1698 Although it is possible to define such a function, this is not very
1699 useful as it is not possible to read the arguments.  This is only
1700 supported for C as this construct is allowed by C++.
1702 @item -fno-asm
1703 @opindex fno-asm
1704 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1705 keyword, so that code can use these words as identifiers.  You can use
1706 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1707 instead.  @option{-ansi} implies @option{-fno-asm}.
1709 In C++, this switch only affects the @code{typeof} keyword, since
1710 @code{asm} and @code{inline} are standard keywords.  You may want to
1711 use the @option{-fno-gnu-keywords} flag instead, which has the same
1712 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1713 switch only affects the @code{asm} and @code{typeof} keywords, since
1714 @code{inline} is a standard keyword in ISO C99.
1716 @item -fno-builtin
1717 @itemx -fno-builtin-@var{function}
1718 @opindex fno-builtin
1719 @cindex built-in functions
1720 Don't recognize built-in functions that do not begin with
1721 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1722 functions provided by GCC}, for details of the functions affected,
1723 including those which are not built-in functions when @option{-ansi} or
1724 @option{-std} options for strict ISO C conformance are used because they
1725 do not have an ISO standard meaning.
1727 GCC normally generates special code to handle certain built-in functions
1728 more efficiently; for instance, calls to @code{alloca} may become single
1729 instructions which adjust the stack directly, and calls to @code{memcpy}
1730 may become inline copy loops.  The resulting code is often both smaller
1731 and faster, but since the function calls no longer appear as such, you
1732 cannot set a breakpoint on those calls, nor can you change the behavior
1733 of the functions by linking with a different library.  In addition,
1734 when a function is recognized as a built-in function, GCC may use
1735 information about that function to warn about problems with calls to
1736 that function, or to generate more efficient code, even if the
1737 resulting code still contains calls to that function.  For example,
1738 warnings are given with @option{-Wformat} for bad calls to
1739 @code{printf} when @code{printf} is built in and @code{strlen} is
1740 known not to modify global memory.
1742 With the @option{-fno-builtin-@var{function}} option
1743 only the built-in function @var{function} is
1744 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1745 function is named that is not built-in in this version of GCC, this
1746 option is ignored.  There is no corresponding
1747 @option{-fbuiltin-@var{function}} option; if you wish to enable
1748 built-in functions selectively when using @option{-fno-builtin} or
1749 @option{-ffreestanding}, you may define macros such as:
1751 @smallexample
1752 #define abs(n)          __builtin_abs ((n))
1753 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1754 @end smallexample
1756 @item -fhosted
1757 @opindex fhosted
1758 @cindex hosted environment
1760 Assert that compilation targets a hosted environment.  This implies
1761 @option{-fbuiltin}.  A hosted environment is one in which the
1762 entire standard library is available, and in which @code{main} has a return
1763 type of @code{int}.  Examples are nearly everything except a kernel.
1764 This is equivalent to @option{-fno-freestanding}.
1766 @item -ffreestanding
1767 @opindex ffreestanding
1768 @cindex hosted environment
1770 Assert that compilation targets a freestanding environment.  This
1771 implies @option{-fno-builtin}.  A freestanding environment
1772 is one in which the standard library may not exist, and program startup may
1773 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1774 This is equivalent to @option{-fno-hosted}.
1776 @xref{Standards,,Language Standards Supported by GCC}, for details of
1777 freestanding and hosted environments.
1779 @item -fopenmp
1780 @opindex fopenmp
1781 @cindex OpenMP parallel
1782 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1783 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1784 compiler generates parallel code according to the OpenMP Application
1785 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1786 implies @option{-pthread}, and thus is only supported on targets that
1787 have support for @option{-pthread}.
1789 @item -fgnu-tm
1790 @opindex fgnu-tm
1791 When the option @option{-fgnu-tm} is specified, the compiler
1792 generates code for the Linux variant of Intel's current Transactional
1793 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1794 an experimental feature whose interface may change in future versions
1795 of GCC, as the official specification changes.  Please note that not
1796 all architectures are supported for this feature.
1798 For more information on GCC's support for transactional memory,
1799 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1800 Transactional Memory Library}.
1802 Note that the transactional memory feature is not supported with
1803 non-call exceptions (@option{-fnon-call-exceptions}).
1805 @item -fms-extensions
1806 @opindex fms-extensions
1807 Accept some non-standard constructs used in Microsoft header files.
1809 In C++ code, this allows member names in structures to be similar
1810 to previous types declarations.
1812 @smallexample
1813 typedef int UOW;
1814 struct ABC @{
1815   UOW UOW;
1817 @end smallexample
1819 Some cases of unnamed fields in structures and unions are only
1820 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1821 fields within structs/unions}, for details.
1823 @item -fplan9-extensions
1824 Accept some non-standard constructs used in Plan 9 code.
1826 This enables @option{-fms-extensions}, permits passing pointers to
1827 structures with anonymous fields to functions that expect pointers to
1828 elements of the type of the field, and permits referring to anonymous
1829 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1830 struct/union fields within structs/unions}, for details.  This is only
1831 supported for C, not C++.
1833 @item -trigraphs
1834 @opindex trigraphs
1835 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1836 options for strict ISO C conformance) implies @option{-trigraphs}.
1838 @cindex traditional C language
1839 @cindex C language, traditional
1840 @item -traditional
1841 @itemx -traditional-cpp
1842 @opindex traditional-cpp
1843 @opindex traditional
1844 Formerly, these options caused GCC to attempt to emulate a pre-standard
1845 C compiler.  They are now only supported with the @option{-E} switch.
1846 The preprocessor continues to support a pre-standard mode.  See the GNU
1847 CPP manual for details.
1849 @item -fcond-mismatch
1850 @opindex fcond-mismatch
1851 Allow conditional expressions with mismatched types in the second and
1852 third arguments.  The value of such an expression is void.  This option
1853 is not supported for C++.
1855 @item -flax-vector-conversions
1856 @opindex flax-vector-conversions
1857 Allow implicit conversions between vectors with differing numbers of
1858 elements and/or incompatible element types.  This option should not be
1859 used for new code.
1861 @item -funsigned-char
1862 @opindex funsigned-char
1863 Let the type @code{char} be unsigned, like @code{unsigned char}.
1865 Each kind of machine has a default for what @code{char} should
1866 be.  It is either like @code{unsigned char} by default or like
1867 @code{signed char} by default.
1869 Ideally, a portable program should always use @code{signed char} or
1870 @code{unsigned char} when it depends on the signedness of an object.
1871 But many programs have been written to use plain @code{char} and
1872 expect it to be signed, or expect it to be unsigned, depending on the
1873 machines they were written for.  This option, and its inverse, let you
1874 make such a program work with the opposite default.
1876 The type @code{char} is always a distinct type from each of
1877 @code{signed char} or @code{unsigned char}, even though its behavior
1878 is always just like one of those two.
1880 @item -fsigned-char
1881 @opindex fsigned-char
1882 Let the type @code{char} be signed, like @code{signed char}.
1884 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1885 the negative form of @option{-funsigned-char}.  Likewise, the option
1886 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1888 @item -fsigned-bitfields
1889 @itemx -funsigned-bitfields
1890 @itemx -fno-signed-bitfields
1891 @itemx -fno-unsigned-bitfields
1892 @opindex fsigned-bitfields
1893 @opindex funsigned-bitfields
1894 @opindex fno-signed-bitfields
1895 @opindex fno-unsigned-bitfields
1896 These options control whether a bit-field is signed or unsigned, when the
1897 declaration does not use either @code{signed} or @code{unsigned}.  By
1898 default, such a bit-field is signed, because this is consistent: the
1899 basic integer types such as @code{int} are signed types.
1900 @end table
1902 @node C++ Dialect Options
1903 @section Options Controlling C++ Dialect
1905 @cindex compiler options, C++
1906 @cindex C++ options, command-line
1907 @cindex options, C++
1908 This section describes the command-line options that are only meaningful
1909 for C++ programs.  You can also use most of the GNU compiler options
1910 regardless of what language your program is in.  For example, you
1911 might compile a file @code{firstClass.C} like this:
1913 @smallexample
1914 g++ -g -frepo -O -c firstClass.C
1915 @end smallexample
1917 @noindent
1918 In this example, only @option{-frepo} is an option meant
1919 only for C++ programs; you can use the other options with any
1920 language supported by GCC@.
1922 Here is a list of options that are @emph{only} for compiling C++ programs:
1924 @table @gcctabopt
1926 @item -fabi-version=@var{n}
1927 @opindex fabi-version
1928 Use version @var{n} of the C++ ABI@.  The default is version 2.
1930 Version 0 refers to the version conforming most closely to
1931 the C++ ABI specification.  Therefore, the ABI obtained using version 0
1932 will change in different versions of G++ as ABI bugs are fixed.
1934 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
1936 Version 2 is the version of the C++ ABI that first appeared in G++ 3.4.  
1938 Version 3 corrects an error in mangling a constant address as a
1939 template argument.
1941 Version 4, which first appeared in G++ 4.5, implements a standard
1942 mangling for vector types.
1944 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1945 attribute const/volatile on function pointer types, decltype of a
1946 plain decl, and use of a function parameter in the declaration of
1947 another parameter.
1949 Version 6, which first appeared in G++ 4.7, corrects the promotion
1950 behavior of C++11 scoped enums and the mangling of template argument
1951 packs, const/static_cast, prefix ++ and --, and a class scope function
1952 used as a template argument.
1954 See also @option{-Wabi}.
1956 @item -fno-access-control
1957 @opindex fno-access-control
1958 Turn off all access checking.  This switch is mainly useful for working
1959 around bugs in the access control code.
1961 @item -fcheck-new
1962 @opindex fcheck-new
1963 Check that the pointer returned by @code{operator new} is non-null
1964 before attempting to modify the storage allocated.  This check is
1965 normally unnecessary because the C++ standard specifies that
1966 @code{operator new} only returns @code{0} if it is declared
1967 @samp{throw()}, in which case the compiler always checks the
1968 return value even without this option.  In all other cases, when
1969 @code{operator new} has a non-empty exception specification, memory
1970 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1971 @samp{new (nothrow)}.
1973 @item -fconstexpr-depth=@var{n}
1974 @opindex fconstexpr-depth
1975 Set the maximum nested evaluation depth for C++11 constexpr functions
1976 to @var{n}.  A limit is needed to detect endless recursion during
1977 constant expression evaluation.  The minimum specified by the standard
1978 is 512.
1980 @item -fdeduce-init-list
1981 @opindex fdeduce-init-list
1982 Enable deduction of a template type parameter as
1983 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
1985 @smallexample
1986 template <class T> auto forward(T t) -> decltype (realfn (t))
1988   return realfn (t);
1991 void f()
1993   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1995 @end smallexample
1997 This deduction was implemented as a possible extension to the
1998 originally proposed semantics for the C++11 standard, but was not part
1999 of the final standard, so it is disabled by default.  This option is
2000 deprecated, and may be removed in a future version of G++.
2002 @item -ffriend-injection
2003 @opindex ffriend-injection
2004 Inject friend functions into the enclosing namespace, so that they are
2005 visible outside the scope of the class in which they are declared.
2006 Friend functions were documented to work this way in the old Annotated
2007 C++ Reference Manual, and versions of G++ before 4.1 always worked
2008 that way.  However, in ISO C++ a friend function that is not declared
2009 in an enclosing scope can only be found using argument dependent
2010 lookup.  This option causes friends to be injected as they were in
2011 earlier releases.
2013 This option is for compatibility, and may be removed in a future
2014 release of G++.
2016 @item -fno-elide-constructors
2017 @opindex fno-elide-constructors
2018 The C++ standard allows an implementation to omit creating a temporary
2019 that is only used to initialize another object of the same type.
2020 Specifying this option disables that optimization, and forces G++ to
2021 call the copy constructor in all cases.
2023 @item -fno-enforce-eh-specs
2024 @opindex fno-enforce-eh-specs
2025 Don't generate code to check for violation of exception specifications
2026 at run time.  This option violates the C++ standard, but may be useful
2027 for reducing code size in production builds, much like defining
2028 @samp{NDEBUG}.  This does not give user code permission to throw
2029 exceptions in violation of the exception specifications; the compiler
2030 still optimizes based on the specifications, so throwing an
2031 unexpected exception results in undefined behavior at run time.
2033 @item -ffor-scope
2034 @itemx -fno-for-scope
2035 @opindex ffor-scope
2036 @opindex fno-for-scope
2037 If @option{-ffor-scope} is specified, the scope of variables declared in
2038 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2039 as specified by the C++ standard.
2040 If @option{-fno-for-scope} is specified, the scope of variables declared in
2041 a @i{for-init-statement} extends to the end of the enclosing scope,
2042 as was the case in old versions of G++, and other (traditional)
2043 implementations of C++.
2045 If neither flag is given, the default is to follow the standard,
2046 but to allow and give a warning for old-style code that would
2047 otherwise be invalid, or have different behavior.
2049 @item -fno-gnu-keywords
2050 @opindex fno-gnu-keywords
2051 Do not recognize @code{typeof} as a keyword, so that code can use this
2052 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2053 @option{-ansi} implies @option{-fno-gnu-keywords}.
2055 @item -fno-implicit-templates
2056 @opindex fno-implicit-templates
2057 Never emit code for non-inline templates that are instantiated
2058 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2059 @xref{Template Instantiation}, for more information.
2061 @item -fno-implicit-inline-templates
2062 @opindex fno-implicit-inline-templates
2063 Don't emit code for implicit instantiations of inline templates, either.
2064 The default is to handle inlines differently so that compiles with and
2065 without optimization need the same set of explicit instantiations.
2067 @item -fno-implement-inlines
2068 @opindex fno-implement-inlines
2069 To save space, do not emit out-of-line copies of inline functions
2070 controlled by @samp{#pragma implementation}.  This causes linker
2071 errors if these functions are not inlined everywhere they are called.
2073 @item -fms-extensions
2074 @opindex fms-extensions
2075 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2076 int and getting a pointer to member function via non-standard syntax.
2078 @item -fno-nonansi-builtins
2079 @opindex fno-nonansi-builtins
2080 Disable built-in declarations of functions that are not mandated by
2081 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2082 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2084 @item -fnothrow-opt
2085 @opindex fnothrow-opt
2086 Treat a @code{throw()} exception specification as if it were a
2087 @code{noexcept} specification to reduce or eliminate the text size
2088 overhead relative to a function with no exception specification.  If
2089 the function has local variables of types with non-trivial
2090 destructors, the exception specification actually makes the
2091 function smaller because the EH cleanups for those variables can be
2092 optimized away.  The semantic effect is that an exception thrown out of
2093 a function with such an exception specification results in a call
2094 to @code{terminate} rather than @code{unexpected}.
2096 @item -fno-operator-names
2097 @opindex fno-operator-names
2098 Do not treat the operator name keywords @code{and}, @code{bitand},
2099 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2100 synonyms as keywords.
2102 @item -fno-optional-diags
2103 @opindex fno-optional-diags
2104 Disable diagnostics that the standard says a compiler does not need to
2105 issue.  Currently, the only such diagnostic issued by G++ is the one for
2106 a name having multiple meanings within a class.
2108 @item -fpermissive
2109 @opindex fpermissive
2110 Downgrade some diagnostics about nonconformant code from errors to
2111 warnings.  Thus, using @option{-fpermissive} allows some
2112 nonconforming code to compile.
2114 @item -fno-pretty-templates
2115 @opindex fno-pretty-templates
2116 When an error message refers to a specialization of a function
2117 template, the compiler normally prints the signature of the
2118 template followed by the template arguments and any typedefs or
2119 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2120 rather than @code{void f(int)}) so that it's clear which template is
2121 involved.  When an error message refers to a specialization of a class
2122 template, the compiler omits any template arguments that match
2123 the default template arguments for that template.  If either of these
2124 behaviors make it harder to understand the error message rather than
2125 easier, you can use @option{-fno-pretty-templates} to disable them.
2127 @item -frepo
2128 @opindex frepo
2129 Enable automatic template instantiation at link time.  This option also
2130 implies @option{-fno-implicit-templates}.  @xref{Template
2131 Instantiation}, for more information.
2133 @item -fno-rtti
2134 @opindex fno-rtti
2135 Disable generation of information about every class with virtual
2136 functions for use by the C++ run-time type identification features
2137 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2138 of the language, you can save some space by using this flag.  Note that
2139 exception handling uses the same information, but G++ generates it as
2140 needed. The @samp{dynamic_cast} operator can still be used for casts that
2141 do not require run-time type information, i.e.@: casts to @code{void *} or to
2142 unambiguous base classes.
2144 @item -fstats
2145 @opindex fstats
2146 Emit statistics about front-end processing at the end of the compilation.
2147 This information is generally only useful to the G++ development team.
2149 @item -fstrict-enums
2150 @opindex fstrict-enums
2151 Allow the compiler to optimize using the assumption that a value of
2152 enumerated type can only be one of the values of the enumeration (as
2153 defined in the C++ standard; basically, a value that can be
2154 represented in the minimum number of bits needed to represent all the
2155 enumerators).  This assumption may not be valid if the program uses a
2156 cast to convert an arbitrary integer value to the enumerated type.
2158 @item -ftemplate-backtrace-limit=@var{n}
2159 @opindex ftemplate-backtrace-limit
2160 Set the maximum number of template instantiation notes for a single
2161 warning or error to @var{n}.  The default value is 10.
2163 @item -ftemplate-depth=@var{n}
2164 @opindex ftemplate-depth
2165 Set the maximum instantiation depth for template classes to @var{n}.
2166 A limit on the template instantiation depth is needed to detect
2167 endless recursions during template class instantiation.  ANSI/ISO C++
2168 conforming programs must not rely on a maximum depth greater than 17
2169 (changed to 1024 in C++11).  The default value is 900, as the compiler
2170 can run out of stack space before hitting 1024 in some situations.
2172 @item -fno-threadsafe-statics
2173 @opindex fno-threadsafe-statics
2174 Do not emit the extra code to use the routines specified in the C++
2175 ABI for thread-safe initialization of local statics.  You can use this
2176 option to reduce code size slightly in code that doesn't need to be
2177 thread-safe.
2179 @item -fuse-cxa-atexit
2180 @opindex fuse-cxa-atexit
2181 Register destructors for objects with static storage duration with the
2182 @code{__cxa_atexit} function rather than the @code{atexit} function.
2183 This option is required for fully standards-compliant handling of static
2184 destructors, but only works if your C library supports
2185 @code{__cxa_atexit}.
2187 @item -fno-use-cxa-get-exception-ptr
2188 @opindex fno-use-cxa-get-exception-ptr
2189 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2190 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2191 if the runtime routine is not available.
2193 @item -fvisibility-inlines-hidden
2194 @opindex fvisibility-inlines-hidden
2195 This switch declares that the user does not attempt to compare
2196 pointers to inline functions or methods where the addresses of the two functions
2197 are taken in different shared objects.
2199 The effect of this is that GCC may, effectively, mark inline methods with
2200 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2201 appear in the export table of a DSO and do not require a PLT indirection
2202 when used within the DSO@.  Enabling this option can have a dramatic effect
2203 on load and link times of a DSO as it massively reduces the size of the
2204 dynamic export table when the library makes heavy use of templates.
2206 The behavior of this switch is not quite the same as marking the
2207 methods as hidden directly, because it does not affect static variables
2208 local to the function or cause the compiler to deduce that
2209 the function is defined in only one shared object.
2211 You may mark a method as having a visibility explicitly to negate the
2212 effect of the switch for that method.  For example, if you do want to
2213 compare pointers to a particular inline method, you might mark it as
2214 having default visibility.  Marking the enclosing class with explicit
2215 visibility has no effect.
2217 Explicitly instantiated inline methods are unaffected by this option
2218 as their linkage might otherwise cross a shared library boundary.
2219 @xref{Template Instantiation}.
2221 @item -fvisibility-ms-compat
2222 @opindex fvisibility-ms-compat
2223 This flag attempts to use visibility settings to make GCC's C++
2224 linkage model compatible with that of Microsoft Visual Studio.
2226 The flag makes these changes to GCC's linkage model:
2228 @enumerate
2229 @item
2230 It sets the default visibility to @code{hidden}, like
2231 @option{-fvisibility=hidden}.
2233 @item
2234 Types, but not their members, are not hidden by default.
2236 @item
2237 The One Definition Rule is relaxed for types without explicit
2238 visibility specifications that are defined in more than one
2239 shared object: those declarations are permitted if they are
2240 permitted when this option is not used.
2241 @end enumerate
2243 In new code it is better to use @option{-fvisibility=hidden} and
2244 export those classes that are intended to be externally visible.
2245 Unfortunately it is possible for code to rely, perhaps accidentally,
2246 on the Visual Studio behavior.
2248 Among the consequences of these changes are that static data members
2249 of the same type with the same name but defined in different shared
2250 objects are different, so changing one does not change the other;
2251 and that pointers to function members defined in different shared
2252 objects may not compare equal.  When this flag is given, it is a
2253 violation of the ODR to define types with the same name differently.
2255 @item -fno-weak
2256 @opindex fno-weak
2257 Do not use weak symbol support, even if it is provided by the linker.
2258 By default, G++ uses weak symbols if they are available.  This
2259 option exists only for testing, and should not be used by end-users;
2260 it results in inferior code and has no benefits.  This option may
2261 be removed in a future release of G++.
2263 @item -nostdinc++
2264 @opindex nostdinc++
2265 Do not search for header files in the standard directories specific to
2266 C++, but do still search the other standard directories.  (This option
2267 is used when building the C++ library.)
2268 @end table
2270 In addition, these optimization, warning, and code generation options
2271 have meanings only for C++ programs:
2273 @table @gcctabopt
2274 @item -fno-default-inline
2275 @opindex fno-default-inline
2276 Do not assume @samp{inline} for functions defined inside a class scope.
2277 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2278 functions have linkage like inline functions; they just aren't
2279 inlined by default.
2281 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2282 @opindex Wabi
2283 @opindex Wno-abi
2284 Warn when G++ generates code that is probably not compatible with the
2285 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2286 all such cases, there are probably some cases that are not warned about,
2287 even though G++ is generating incompatible code.  There may also be
2288 cases where warnings are emitted even though the code that is generated
2289 is compatible.
2291 You should rewrite your code to avoid these warnings if you are
2292 concerned about the fact that code generated by G++ may not be binary
2293 compatible with code generated by other compilers.
2295 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2297 @itemize @bullet
2299 @item
2300 A template with a non-type template parameter of reference type is
2301 mangled incorrectly:
2302 @smallexample
2303 extern int N;
2304 template <int &> struct S @{@};
2305 void n (S<N>) @{2@}
2306 @end smallexample
2308 This is fixed in @option{-fabi-version=3}.
2310 @item
2311 SIMD vector types declared using @code{__attribute ((vector_size))} are
2312 mangled in a non-standard way that does not allow for overloading of
2313 functions taking vectors of different sizes.
2315 The mangling is changed in @option{-fabi-version=4}.
2316 @end itemize
2318 The known incompatibilities in @option{-fabi-version=1} include:
2320 @itemize @bullet
2322 @item
2323 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2324 pack data into the same byte as a base class.  For example:
2326 @smallexample
2327 struct A @{ virtual void f(); int f1 : 1; @};
2328 struct B : public A @{ int f2 : 1; @};
2329 @end smallexample
2331 @noindent
2332 In this case, G++ places @code{B::f2} into the same byte
2333 as @code{A::f1}; other compilers do not.  You can avoid this problem
2334 by explicitly padding @code{A} so that its size is a multiple of the
2335 byte size on your platform; that causes G++ and other compilers to
2336 lay out @code{B} identically.
2338 @item
2339 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2340 tail padding when laying out virtual bases.  For example:
2342 @smallexample
2343 struct A @{ virtual void f(); char c1; @};
2344 struct B @{ B(); char c2; @};
2345 struct C : public A, public virtual B @{@};
2346 @end smallexample
2348 @noindent
2349 In this case, G++ does not place @code{B} into the tail-padding for
2350 @code{A}; other compilers do.  You can avoid this problem by
2351 explicitly padding @code{A} so that its size is a multiple of its
2352 alignment (ignoring virtual base classes); that causes G++ and other
2353 compilers to lay out @code{C} identically.
2355 @item
2356 Incorrect handling of bit-fields with declared widths greater than that
2357 of their underlying types, when the bit-fields appear in a union.  For
2358 example:
2360 @smallexample
2361 union U @{ int i : 4096; @};
2362 @end smallexample
2364 @noindent
2365 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2366 union too small by the number of bits in an @code{int}.
2368 @item
2369 Empty classes can be placed at incorrect offsets.  For example:
2371 @smallexample
2372 struct A @{@};
2374 struct B @{
2375   A a;
2376   virtual void f ();
2379 struct C : public B, public A @{@};
2380 @end smallexample
2382 @noindent
2383 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2384 it should be placed at offset zero.  G++ mistakenly believes that the
2385 @code{A} data member of @code{B} is already at offset zero.
2387 @item
2388 Names of template functions whose types involve @code{typename} or
2389 template template parameters can be mangled incorrectly.
2391 @smallexample
2392 template <typename Q>
2393 void f(typename Q::X) @{@}
2395 template <template <typename> class Q>
2396 void f(typename Q<int>::X) @{@}
2397 @end smallexample
2399 @noindent
2400 Instantiations of these templates may be mangled incorrectly.
2402 @end itemize
2404 It also warns about psABI-related changes.  The known psABI changes at this
2405 point include:
2407 @itemize @bullet
2409 @item
2410 For SysV/x86-64, unions with @code{long double} members are 
2411 passed in memory as specified in psABI.  For example:
2413 @smallexample
2414 union U @{
2415   long double ld;
2416   int i;
2418 @end smallexample
2420 @noindent
2421 @code{union U} is always passed in memory.
2423 @end itemize
2425 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2426 @opindex Wctor-dtor-privacy
2427 @opindex Wno-ctor-dtor-privacy
2428 Warn when a class seems unusable because all the constructors or
2429 destructors in that class are private, and it has neither friends nor
2430 public static member functions.
2432 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2433 @opindex Wdelete-non-virtual-dtor
2434 @opindex Wno-delete-non-virtual-dtor
2435 Warn when @samp{delete} is used to destroy an instance of a class that
2436 has virtual functions and non-virtual destructor. It is unsafe to delete
2437 an instance of a derived class through a pointer to a base class if the
2438 base class does not have a virtual destructor.  This warning is enabled
2439 by @option{-Wall}.
2441 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2442 @opindex Wliteral-suffix
2443 @opindex Wno-literal-suffix
2444 Warn when a string or character literal is followed by a ud-suffix which does
2445 not begin with an underscore.  As a conforming extension, GCC treats such
2446 suffixes as separate preprocessing tokens in order to maintain backwards
2447 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2448 For example:
2450 @smallexample
2451 #define __STDC_FORMAT_MACROS
2452 #include <inttypes.h>
2453 #include <stdio.h>
2455 int main() @{
2456   int64_t i64 = 123;
2457   printf("My int64: %"PRId64"\n", i64);
2459 @end smallexample
2461 In this case, @code{PRId64} is treated as a separate preprocessing token.
2463 This warning is enabled by default.
2465 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2466 @opindex Wnarrowing
2467 @opindex Wno-narrowing
2468 Warn when a narrowing conversion prohibited by C++11 occurs within
2469 @samp{@{ @}}, e.g.
2471 @smallexample
2472 int i = @{ 2.2 @}; // error: narrowing from double to int
2473 @end smallexample
2475 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2477 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2478 required by the standard.  Note that this does not affect the meaning
2479 of well-formed code; narrowing conversions are still considered
2480 ill-formed in SFINAE context.
2482 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2483 @opindex Wnoexcept
2484 @opindex Wno-noexcept
2485 Warn when a noexcept-expression evaluates to false because of a call
2486 to a function that does not have a non-throwing exception
2487 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2488 the compiler to never throw an exception.
2490 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2491 @opindex Wnon-virtual-dtor
2492 @opindex Wno-non-virtual-dtor
2493 Warn when a class has virtual functions and an accessible non-virtual
2494 destructor, in which case it is possible but unsafe to delete
2495 an instance of a derived class through a pointer to the base class.
2496 This warning is also enabled if @option{-Weffc++} is specified.
2498 @item -Wreorder @r{(C++ and Objective-C++ only)}
2499 @opindex Wreorder
2500 @opindex Wno-reorder
2501 @cindex reordering, warning
2502 @cindex warning for reordering of member initializers
2503 Warn when the order of member initializers given in the code does not
2504 match the order in which they must be executed.  For instance:
2506 @smallexample
2507 struct A @{
2508   int i;
2509   int j;
2510   A(): j (0), i (1) @{ @}
2512 @end smallexample
2514 @noindent
2515 The compiler rearranges the member initializers for @samp{i}
2516 and @samp{j} to match the declaration order of the members, emitting
2517 a warning to that effect.  This warning is enabled by @option{-Wall}.
2518 @end table
2520 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2522 @table @gcctabopt
2523 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2524 @opindex Weffc++
2525 @opindex Wno-effc++
2526 Warn about violations of the following style guidelines from Scott Meyers'
2527 @cite{Effective C++, Second Edition} book:
2529 @itemize @bullet
2530 @item
2531 Item 11:  Define a copy constructor and an assignment operator for classes
2532 with dynamically-allocated memory.
2534 @item
2535 Item 12:  Prefer initialization to assignment in constructors.
2537 @item
2538 Item 14:  Make destructors virtual in base classes.
2540 @item
2541 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2543 @item
2544 Item 23:  Don't try to return a reference when you must return an object.
2546 @end itemize
2548 Also warn about violations of the following style guidelines from
2549 Scott Meyers' @cite{More Effective C++} book:
2551 @itemize @bullet
2552 @item
2553 Item 6:  Distinguish between prefix and postfix forms of increment and
2554 decrement operators.
2556 @item
2557 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2559 @end itemize
2561 When selecting this option, be aware that the standard library
2562 headers do not obey all of these guidelines; use @samp{grep -v}
2563 to filter out those warnings.
2565 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2566 @opindex Wstrict-null-sentinel
2567 @opindex Wno-strict-null-sentinel
2568 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2569 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2570 to @code{__null}.  Although it is a null pointer constant rather than a
2571 null pointer, it is guaranteed to be of the same size as a pointer.
2572 But this use is not portable across different compilers.
2574 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2575 @opindex Wno-non-template-friend
2576 @opindex Wnon-template-friend
2577 Disable warnings when non-templatized friend functions are declared
2578 within a template.  Since the advent of explicit template specification
2579 support in G++, if the name of the friend is an unqualified-id (i.e.,
2580 @samp{friend foo(int)}), the C++ language specification demands that the
2581 friend declare or define an ordinary, nontemplate function.  (Section
2582 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2583 could be interpreted as a particular specialization of a templatized
2584 function.  Because this non-conforming behavior is no longer the default
2585 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2586 check existing code for potential trouble spots and is on by default.
2587 This new compiler behavior can be turned off with
2588 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2589 but disables the helpful warning.
2591 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2592 @opindex Wold-style-cast
2593 @opindex Wno-old-style-cast
2594 Warn if an old-style (C-style) cast to a non-void type is used within
2595 a C++ program.  The new-style casts (@samp{dynamic_cast},
2596 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2597 less vulnerable to unintended effects and much easier to search for.
2599 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2600 @opindex Woverloaded-virtual
2601 @opindex Wno-overloaded-virtual
2602 @cindex overloaded virtual function, warning
2603 @cindex warning for overloaded virtual function
2604 Warn when a function declaration hides virtual functions from a
2605 base class.  For example, in:
2607 @smallexample
2608 struct A @{
2609   virtual void f();
2612 struct B: public A @{
2613   void f(int);
2615 @end smallexample
2617 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2618 like:
2620 @smallexample
2621 B* b;
2622 b->f();
2623 @end smallexample
2625 @noindent
2626 fails to compile.
2628 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2629 @opindex Wno-pmf-conversions
2630 @opindex Wpmf-conversions
2631 Disable the diagnostic for converting a bound pointer to member function
2632 to a plain pointer.
2634 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2635 @opindex Wsign-promo
2636 @opindex Wno-sign-promo
2637 Warn when overload resolution chooses a promotion from unsigned or
2638 enumerated type to a signed type, over a conversion to an unsigned type of
2639 the same size.  Previous versions of G++ tried to preserve
2640 unsignedness, but the standard mandates the current behavior.
2642 @smallexample
2643 struct A @{
2644   operator int ();
2645   A& operator = (int);
2648 main ()
2650   A a,b;
2651   a = b;
2653 @end smallexample
2655 @noindent
2656 In this example, G++ synthesizes a default @samp{A& operator =
2657 (const A&);}, while cfront uses the user-defined @samp{operator =}.
2658 @end table
2660 @node Objective-C and Objective-C++ Dialect Options
2661 @section Options Controlling Objective-C and Objective-C++ Dialects
2663 @cindex compiler options, Objective-C and Objective-C++
2664 @cindex Objective-C and Objective-C++ options, command-line
2665 @cindex options, Objective-C and Objective-C++
2666 (NOTE: This manual does not describe the Objective-C and Objective-C++
2667 languages themselves.  @xref{Standards,,Language Standards
2668 Supported by GCC}, for references.)
2670 This section describes the command-line options that are only meaningful
2671 for Objective-C and Objective-C++ programs.  You can also use most of
2672 the language-independent GNU compiler options.
2673 For example, you might compile a file @code{some_class.m} like this:
2675 @smallexample
2676 gcc -g -fgnu-runtime -O -c some_class.m
2677 @end smallexample
2679 @noindent
2680 In this example, @option{-fgnu-runtime} is an option meant only for
2681 Objective-C and Objective-C++ programs; you can use the other options with
2682 any language supported by GCC@.
2684 Note that since Objective-C is an extension of the C language, Objective-C
2685 compilations may also use options specific to the C front-end (e.g.,
2686 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2687 C++-specific options (e.g., @option{-Wabi}).
2689 Here is a list of options that are @emph{only} for compiling Objective-C
2690 and Objective-C++ programs:
2692 @table @gcctabopt
2693 @item -fconstant-string-class=@var{class-name}
2694 @opindex fconstant-string-class
2695 Use @var{class-name} as the name of the class to instantiate for each
2696 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2697 class name is @code{NXConstantString} if the GNU runtime is being used, and
2698 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2699 @option{-fconstant-cfstrings} option, if also present, overrides the
2700 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2701 to be laid out as constant CoreFoundation strings.
2703 @item -fgnu-runtime
2704 @opindex fgnu-runtime
2705 Generate object code compatible with the standard GNU Objective-C
2706 runtime.  This is the default for most types of systems.
2708 @item -fnext-runtime
2709 @opindex fnext-runtime
2710 Generate output compatible with the NeXT runtime.  This is the default
2711 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2712 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2713 used.
2715 @item -fno-nil-receivers
2716 @opindex fno-nil-receivers
2717 Assume that all Objective-C message dispatches (@code{[receiver
2718 message:arg]}) in this translation unit ensure that the receiver is
2719 not @code{nil}.  This allows for more efficient entry points in the
2720 runtime to be used.  This option is only available in conjunction with
2721 the NeXT runtime and ABI version 0 or 1.
2723 @item -fobjc-abi-version=@var{n}
2724 @opindex fobjc-abi-version
2725 Use version @var{n} of the Objective-C ABI for the selected runtime.
2726 This option is currently supported only for the NeXT runtime.  In that
2727 case, Version 0 is the traditional (32-bit) ABI without support for
2728 properties and other Objective-C 2.0 additions.  Version 1 is the
2729 traditional (32-bit) ABI with support for properties and other
2730 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2731 nothing is specified, the default is Version 0 on 32-bit target
2732 machines, and Version 2 on 64-bit target machines.
2734 @item -fobjc-call-cxx-cdtors
2735 @opindex fobjc-call-cxx-cdtors
2736 For each Objective-C class, check if any of its instance variables is a
2737 C++ object with a non-trivial default constructor.  If so, synthesize a
2738 special @code{- (id) .cxx_construct} instance method which runs
2739 non-trivial default constructors on any such instance variables, in order,
2740 and then return @code{self}.  Similarly, check if any instance variable
2741 is a C++ object with a non-trivial destructor, and if so, synthesize a
2742 special @code{- (void) .cxx_destruct} method which runs
2743 all such default destructors, in reverse order.
2745 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2746 methods thusly generated only operate on instance variables
2747 declared in the current Objective-C class, and not those inherited
2748 from superclasses.  It is the responsibility of the Objective-C
2749 runtime to invoke all such methods in an object's inheritance
2750 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2751 by the runtime immediately after a new object instance is allocated;
2752 the @code{- (void) .cxx_destruct} methods are invoked immediately
2753 before the runtime deallocates an object instance.
2755 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2756 support for invoking the @code{- (id) .cxx_construct} and
2757 @code{- (void) .cxx_destruct} methods.
2759 @item -fobjc-direct-dispatch
2760 @opindex fobjc-direct-dispatch
2761 Allow fast jumps to the message dispatcher.  On Darwin this is
2762 accomplished via the comm page.
2764 @item -fobjc-exceptions
2765 @opindex fobjc-exceptions
2766 Enable syntactic support for structured exception handling in
2767 Objective-C, similar to what is offered by C++ and Java.  This option
2768 is required to use the Objective-C keywords @code{@@try},
2769 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2770 @code{@@synchronized}.  This option is available with both the GNU
2771 runtime and the NeXT runtime (but not available in conjunction with
2772 the NeXT runtime on Mac OS X 10.2 and earlier).
2774 @item -fobjc-gc
2775 @opindex fobjc-gc
2776 Enable garbage collection (GC) in Objective-C and Objective-C++
2777 programs.  This option is only available with the NeXT runtime; the
2778 GNU runtime has a different garbage collection implementation that
2779 does not require special compiler flags.
2781 @item -fobjc-nilcheck
2782 @opindex fobjc-nilcheck
2783 For the NeXT runtime with version 2 of the ABI, check for a nil
2784 receiver in method invocations before doing the actual method call.
2785 This is the default and can be disabled using
2786 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2787 checked for nil in this way no matter what this flag is set to.
2788 Currently this flag does nothing when the GNU runtime, or an older
2789 version of the NeXT runtime ABI, is used.
2791 @item -fobjc-std=objc1
2792 @opindex fobjc-std
2793 Conform to the language syntax of Objective-C 1.0, the language
2794 recognized by GCC 4.0.  This only affects the Objective-C additions to
2795 the C/C++ language; it does not affect conformance to C/C++ standards,
2796 which is controlled by the separate C/C++ dialect option flags.  When
2797 this option is used with the Objective-C or Objective-C++ compiler,
2798 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2799 This is useful if you need to make sure that your Objective-C code can
2800 be compiled with older versions of GCC@.
2802 @item -freplace-objc-classes
2803 @opindex freplace-objc-classes
2804 Emit a special marker instructing @command{ld(1)} not to statically link in
2805 the resulting object file, and allow @command{dyld(1)} to load it in at
2806 run time instead.  This is used in conjunction with the Fix-and-Continue
2807 debugging mode, where the object file in question may be recompiled and
2808 dynamically reloaded in the course of program execution, without the need
2809 to restart the program itself.  Currently, Fix-and-Continue functionality
2810 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2811 and later.
2813 @item -fzero-link
2814 @opindex fzero-link
2815 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2816 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2817 compile time) with static class references that get initialized at load time,
2818 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2819 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2820 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2821 for individual class implementations to be modified during program execution.
2822 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2823 regardless of command-line options.
2825 @item -gen-decls
2826 @opindex gen-decls
2827 Dump interface declarations for all classes seen in the source file to a
2828 file named @file{@var{sourcename}.decl}.
2830 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2831 @opindex Wassign-intercept
2832 @opindex Wno-assign-intercept
2833 Warn whenever an Objective-C assignment is being intercepted by the
2834 garbage collector.
2836 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2837 @opindex Wno-protocol
2838 @opindex Wprotocol
2839 If a class is declared to implement a protocol, a warning is issued for
2840 every method in the protocol that is not implemented by the class.  The
2841 default behavior is to issue a warning for every method not explicitly
2842 implemented in the class, even if a method implementation is inherited
2843 from the superclass.  If you use the @option{-Wno-protocol} option, then
2844 methods inherited from the superclass are considered to be implemented,
2845 and no warning is issued for them.
2847 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2848 @opindex Wselector
2849 @opindex Wno-selector
2850 Warn if multiple methods of different types for the same selector are
2851 found during compilation.  The check is performed on the list of methods
2852 in the final stage of compilation.  Additionally, a check is performed
2853 for each selector appearing in a @code{@@selector(@dots{})}
2854 expression, and a corresponding method for that selector has been found
2855 during compilation.  Because these checks scan the method table only at
2856 the end of compilation, these warnings are not produced if the final
2857 stage of compilation is not reached, for example because an error is
2858 found during compilation, or because the @option{-fsyntax-only} option is
2859 being used.
2861 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2862 @opindex Wstrict-selector-match
2863 @opindex Wno-strict-selector-match
2864 Warn if multiple methods with differing argument and/or return types are
2865 found for a given selector when attempting to send a message using this
2866 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2867 is off (which is the default behavior), the compiler omits such warnings
2868 if any differences found are confined to types that share the same size
2869 and alignment.
2871 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2872 @opindex Wundeclared-selector
2873 @opindex Wno-undeclared-selector
2874 Warn if a @code{@@selector(@dots{})} expression referring to an
2875 undeclared selector is found.  A selector is considered undeclared if no
2876 method with that name has been declared before the
2877 @code{@@selector(@dots{})} expression, either explicitly in an
2878 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2879 an @code{@@implementation} section.  This option always performs its
2880 checks as soon as a @code{@@selector(@dots{})} expression is found,
2881 while @option{-Wselector} only performs its checks in the final stage of
2882 compilation.  This also enforces the coding style convention
2883 that methods and selectors must be declared before being used.
2885 @item -print-objc-runtime-info
2886 @opindex print-objc-runtime-info
2887 Generate C header describing the largest structure that is passed by
2888 value, if any.
2890 @end table
2892 @node Language Independent Options
2893 @section Options to Control Diagnostic Messages Formatting
2894 @cindex options to control diagnostics formatting
2895 @cindex diagnostic messages
2896 @cindex message formatting
2898 Traditionally, diagnostic messages have been formatted irrespective of
2899 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
2900 options described below
2901 to control the formatting algorithm for diagnostic messages, 
2902 e.g.@: how many characters per line, how often source location
2903 information should be reported.  Note that some language front ends may not
2904 honor these options.
2906 @table @gcctabopt
2907 @item -fmessage-length=@var{n}
2908 @opindex fmessage-length
2909 Try to format error messages so that they fit on lines of about @var{n}
2910 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2911 the front ends supported by GCC@.  If @var{n} is zero, then no
2912 line-wrapping is done; each error message appears on a single
2913 line.
2915 @item -fdiagnostics-show-location=once
2916 @opindex fdiagnostics-show-location
2917 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2918 reporter to emit source location information @emph{once}; that is, in
2919 case the message is too long to fit on a single physical line and has to
2920 be wrapped, the source location won't be emitted (as prefix) again,
2921 over and over, in subsequent continuation lines.  This is the default
2922 behavior.
2924 @item -fdiagnostics-show-location=every-line
2925 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2926 messages reporter to emit the same source location information (as
2927 prefix) for physical lines that result from the process of breaking
2928 a message which is too long to fit on a single line.
2930 @item -fno-diagnostics-show-option
2931 @opindex fno-diagnostics-show-option
2932 @opindex fdiagnostics-show-option
2933 By default, each diagnostic emitted includes text indicating the
2934 command-line option that directly controls the diagnostic (if such an
2935 option is known to the diagnostic machinery).  Specifying the
2936 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2938 @item -fno-diagnostics-show-caret
2939 @opindex fno-diagnostics-show-caret
2940 @opindex fdiagnostics-show-caret
2941 By default, each diagnostic emitted includes the original source line
2942 and a caret '^' indicating the column.  This option suppresses this
2943 information.
2945 @end table
2947 @node Warning Options
2948 @section Options to Request or Suppress Warnings
2949 @cindex options to control warnings
2950 @cindex warning messages
2951 @cindex messages, warning
2952 @cindex suppressing warnings
2954 Warnings are diagnostic messages that report constructions that
2955 are not inherently erroneous but that are risky or suggest there
2956 may have been an error.
2958 The following language-independent options do not enable specific
2959 warnings but control the kinds of diagnostics produced by GCC@.
2961 @table @gcctabopt
2962 @cindex syntax checking
2963 @item -fsyntax-only
2964 @opindex fsyntax-only
2965 Check the code for syntax errors, but don't do anything beyond that.
2967 @item -fmax-errors=@var{n}
2968 @opindex fmax-errors
2969 Limits the maximum number of error messages to @var{n}, at which point
2970 GCC bails out rather than attempting to continue processing the source
2971 code.  If @var{n} is 0 (the default), there is no limit on the number
2972 of error messages produced.  If @option{-Wfatal-errors} is also
2973 specified, then @option{-Wfatal-errors} takes precedence over this
2974 option.
2976 @item -w
2977 @opindex w
2978 Inhibit all warning messages.
2980 @item -Werror
2981 @opindex Werror
2982 @opindex Wno-error
2983 Make all warnings into errors.
2985 @item -Werror=
2986 @opindex Werror=
2987 @opindex Wno-error=
2988 Make the specified warning into an error.  The specifier for a warning
2989 is appended; for example @option{-Werror=switch} turns the warnings
2990 controlled by @option{-Wswitch} into errors.  This switch takes a
2991 negative form, to be used to negate @option{-Werror} for specific
2992 warnings; for example @option{-Wno-error=switch} makes
2993 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2994 is in effect.
2996 The warning message for each controllable warning includes the
2997 option that controls the warning.  That option can then be used with
2998 @option{-Werror=} and @option{-Wno-error=} as described above.
2999 (Printing of the option in the warning message can be disabled using the
3000 @option{-fno-diagnostics-show-option} flag.)
3002 Note that specifying @option{-Werror=}@var{foo} automatically implies
3003 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3004 imply anything.
3006 @item -Wfatal-errors
3007 @opindex Wfatal-errors
3008 @opindex Wno-fatal-errors
3009 This option causes the compiler to abort compilation on the first error
3010 occurred rather than trying to keep going and printing further error
3011 messages.
3013 @end table
3015 You can request many specific warnings with options beginning with
3016 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3017 implicit declarations.  Each of these specific warning options also
3018 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3019 example, @option{-Wno-implicit}.  This manual lists only one of the
3020 two forms, whichever is not the default.  For further
3021 language-specific options also refer to @ref{C++ Dialect Options} and
3022 @ref{Objective-C and Objective-C++ Dialect Options}.
3024 When an unrecognized warning option is requested (e.g.,
3025 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3026 that the option is not recognized.  However, if the @option{-Wno-} form
3027 is used, the behavior is slightly different: no diagnostic is
3028 produced for @option{-Wno-unknown-warning} unless other diagnostics
3029 are being produced.  This allows the use of new @option{-Wno-} options
3030 with old compilers, but if something goes wrong, the compiler
3031 warns that an unrecognized option is present.
3033 @table @gcctabopt
3034 @item -Wpedantic
3035 @itemx -pedantic
3036 @opindex pedantic
3037 @opindex Wpedantic
3038 Issue all the warnings demanded by strict ISO C and ISO C++;
3039 reject all programs that use forbidden extensions, and some other
3040 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3041 version of the ISO C standard specified by any @option{-std} option used.
3043 Valid ISO C and ISO C++ programs should compile properly with or without
3044 this option (though a rare few require @option{-ansi} or a
3045 @option{-std} option specifying the required version of ISO C)@.  However,
3046 without this option, certain GNU extensions and traditional C and C++
3047 features are supported as well.  With this option, they are rejected.
3049 @option{-Wpedantic} does not cause warning messages for use of the
3050 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3051 warnings are also disabled in the expression that follows
3052 @code{__extension__}.  However, only system header files should use
3053 these escape routes; application programs should avoid them.
3054 @xref{Alternate Keywords}.
3056 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3057 C conformance.  They soon find that it does not do quite what they want:
3058 it finds some non-ISO practices, but not all---only those for which
3059 ISO C @emph{requires} a diagnostic, and some others for which
3060 diagnostics have been added.
3062 A feature to report any failure to conform to ISO C might be useful in
3063 some instances, but would require considerable additional work and would
3064 be quite different from @option{-Wpedantic}.  We don't have plans to
3065 support such a feature in the near future.
3067 Where the standard specified with @option{-std} represents a GNU
3068 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3069 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3070 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3071 where they are required by the base standard.  (It does not make sense
3072 for such warnings to be given only for features not in the specified GNU
3073 C dialect, since by definition the GNU dialects of C include all
3074 features the compiler supports with the given option, and there would be
3075 nothing to warn about.)
3077 @item -pedantic-errors
3078 @opindex pedantic-errors
3079 Like @option{-Wpedantic}, except that errors are produced rather than
3080 warnings.
3082 @item -Wall
3083 @opindex Wall
3084 @opindex Wno-all
3085 This enables all the warnings about constructions that some users
3086 consider questionable, and that are easy to avoid (or modify to
3087 prevent the warning), even in conjunction with macros.  This also
3088 enables some language-specific warnings described in @ref{C++ Dialect
3089 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3091 @option{-Wall} turns on the following warning flags:
3093 @gccoptlist{-Waddress   @gol
3094 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3095 -Wc++11-compat  @gol
3096 -Wchar-subscripts  @gol
3097 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3098 -Wimplicit-int @r{(C and Objective-C only)} @gol
3099 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3100 -Wcomment  @gol
3101 -Wformat   @gol
3102 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3103 -Wmaybe-uninitialized @gol
3104 -Wmissing-braces @r{(only for C/ObjC)} @gol
3105 -Wnonnull  @gol
3106 -Wparentheses  @gol
3107 -Wpointer-sign  @gol
3108 -Wreorder   @gol
3109 -Wreturn-type  @gol
3110 -Wsequence-point  @gol
3111 -Wsign-compare @r{(only in C++)}  @gol
3112 -Wstrict-aliasing  @gol
3113 -Wstrict-overflow=1  @gol
3114 -Wswitch  @gol
3115 -Wtrigraphs  @gol
3116 -Wuninitialized  @gol
3117 -Wunknown-pragmas  @gol
3118 -Wunused-function  @gol
3119 -Wunused-label     @gol
3120 -Wunused-value     @gol
3121 -Wunused-variable  @gol
3122 -Wvolatile-register-var @gol
3125 Note that some warning flags are not implied by @option{-Wall}.  Some of
3126 them warn about constructions that users generally do not consider
3127 questionable, but which occasionally you might wish to check for;
3128 others warn about constructions that are necessary or hard to avoid in
3129 some cases, and there is no simple way to modify the code to suppress
3130 the warning. Some of them are enabled by @option{-Wextra} but many of
3131 them must be enabled individually.
3133 @item -Wextra
3134 @opindex W
3135 @opindex Wextra
3136 @opindex Wno-extra
3137 This enables some extra warning flags that are not enabled by
3138 @option{-Wall}. (This option used to be called @option{-W}.  The older
3139 name is still supported, but the newer name is more descriptive.)
3141 @gccoptlist{-Wclobbered  @gol
3142 -Wempty-body  @gol
3143 -Wignored-qualifiers @gol
3144 -Wmissing-field-initializers  @gol
3145 -Wmissing-parameter-type @r{(C only)}  @gol
3146 -Wold-style-declaration @r{(C only)}  @gol
3147 -Woverride-init  @gol
3148 -Wsign-compare  @gol
3149 -Wtype-limits  @gol
3150 -Wuninitialized  @gol
3151 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3152 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3155 The option @option{-Wextra} also prints warning messages for the
3156 following cases:
3158 @itemize @bullet
3160 @item
3161 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3162 @samp{>}, or @samp{>=}.
3164 @item
3165 (C++ only) An enumerator and a non-enumerator both appear in a
3166 conditional expression.
3168 @item
3169 (C++ only) Ambiguous virtual bases.
3171 @item
3172 (C++ only) Subscripting an array that has been declared @samp{register}.
3174 @item
3175 (C++ only) Taking the address of a variable that has been declared
3176 @samp{register}.
3178 @item
3179 (C++ only) A base class is not initialized in a derived class's copy
3180 constructor.
3182 @end itemize
3184 @item -Wchar-subscripts
3185 @opindex Wchar-subscripts
3186 @opindex Wno-char-subscripts
3187 Warn if an array subscript has type @code{char}.  This is a common cause
3188 of error, as programmers often forget that this type is signed on some
3189 machines.
3190 This warning is enabled by @option{-Wall}.
3192 @item -Wcomment
3193 @opindex Wcomment
3194 @opindex Wno-comment
3195 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3196 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3197 This warning is enabled by @option{-Wall}.
3199 @item -Wno-coverage-mismatch
3200 @opindex Wno-coverage-mismatch
3201 Warn if feedback profiles do not match when using the
3202 @option{-fprofile-use} option.
3203 If a source file is changed between compiling with @option{-fprofile-gen} and
3204 with @option{-fprofile-use}, the files with the profile feedback can fail
3205 to match the source file and GCC cannot use the profile feedback
3206 information.  By default, this warning is enabled and is treated as an
3207 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3208 warning or @option{-Wno-error=coverage-mismatch} can be used to
3209 disable the error.  Disabling the error for this warning can result in
3210 poorly optimized code and is useful only in the
3211 case of very minor changes such as bug fixes to an existing code-base.
3212 Completely disabling the warning is not recommended.
3214 @item -Wno-cpp
3215 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3217 Suppress warning messages emitted by @code{#warning} directives.
3219 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3220 @opindex Wdouble-promotion
3221 @opindex Wno-double-promotion
3222 Give a warning when a value of type @code{float} is implicitly
3223 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3224 floating-point unit implement @code{float} in hardware, but emulate
3225 @code{double} in software.  On such a machine, doing computations
3226 using @code{double} values is much more expensive because of the
3227 overhead required for software emulation.
3229 It is easy to accidentally do computations with @code{double} because
3230 floating-point literals are implicitly of type @code{double}.  For
3231 example, in:
3232 @smallexample
3233 @group
3234 float area(float radius)
3236    return 3.14159 * radius * radius;
3238 @end group
3239 @end smallexample
3240 the compiler performs the entire computation with @code{double}
3241 because the floating-point literal is a @code{double}.
3243 @item -Wformat
3244 @opindex Wformat
3245 @opindex Wno-format
3246 @opindex ffreestanding
3247 @opindex fno-builtin
3248 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3249 the arguments supplied have types appropriate to the format string
3250 specified, and that the conversions specified in the format string make
3251 sense.  This includes standard functions, and others specified by format
3252 attributes (@pxref{Function Attributes}), in the @code{printf},
3253 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3254 not in the C standard) families (or other target-specific families).
3255 Which functions are checked without format attributes having been
3256 specified depends on the standard version selected, and such checks of
3257 functions without the attribute specified are disabled by
3258 @option{-ffreestanding} or @option{-fno-builtin}.
3260 The formats are checked against the format features supported by GNU
3261 libc version 2.2.  These include all ISO C90 and C99 features, as well
3262 as features from the Single Unix Specification and some BSD and GNU
3263 extensions.  Other library implementations may not support all these
3264 features; GCC does not support warning about features that go beyond a
3265 particular library's limitations.  However, if @option{-Wpedantic} is used
3266 with @option{-Wformat}, warnings are given about format features not
3267 in the selected standard version (but not for @code{strfmon} formats,
3268 since those are not in any version of the C standard).  @xref{C Dialect
3269 Options,,Options Controlling C Dialect}.
3271 Since @option{-Wformat} also checks for null format arguments for
3272 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3274 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3275 aspects of format checking, the options @option{-Wformat-y2k},
3276 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3277 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3278 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3280 @item -Wformat-y2k
3281 @opindex Wformat-y2k
3282 @opindex Wno-format-y2k
3283 If @option{-Wformat} is specified, also warn about @code{strftime}
3284 formats that may yield only a two-digit year.
3286 @item -Wno-format-contains-nul
3287 @opindex Wno-format-contains-nul
3288 @opindex Wformat-contains-nul
3289 If @option{-Wformat} is specified, do not warn about format strings that
3290 contain NUL bytes.
3292 @item -Wno-format-extra-args
3293 @opindex Wno-format-extra-args
3294 @opindex Wformat-extra-args
3295 If @option{-Wformat} is specified, do not warn about excess arguments to a
3296 @code{printf} or @code{scanf} format function.  The C standard specifies
3297 that such arguments are ignored.
3299 Where the unused arguments lie between used arguments that are
3300 specified with @samp{$} operand number specifications, normally
3301 warnings are still given, since the implementation could not know what
3302 type to pass to @code{va_arg} to skip the unused arguments.  However,
3303 in the case of @code{scanf} formats, this option suppresses the
3304 warning if the unused arguments are all pointers, since the Single
3305 Unix Specification says that such unused arguments are allowed.
3307 @item -Wno-format-zero-length
3308 @opindex Wno-format-zero-length
3309 @opindex Wformat-zero-length
3310 If @option{-Wformat} is specified, do not warn about zero-length formats.
3311 The C standard specifies that zero-length formats are allowed.
3313 @item -Wformat-nonliteral
3314 @opindex Wformat-nonliteral
3315 @opindex Wno-format-nonliteral
3316 If @option{-Wformat} is specified, also warn if the format string is not a
3317 string literal and so cannot be checked, unless the format function
3318 takes its format arguments as a @code{va_list}.
3320 @item -Wformat-security
3321 @opindex Wformat-security
3322 @opindex Wno-format-security
3323 If @option{-Wformat} is specified, also warn about uses of format
3324 functions that represent possible security problems.  At present, this
3325 warns about calls to @code{printf} and @code{scanf} functions where the
3326 format string is not a string literal and there are no format arguments,
3327 as in @code{printf (foo);}.  This may be a security hole if the format
3328 string came from untrusted input and contains @samp{%n}.  (This is
3329 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3330 in future warnings may be added to @option{-Wformat-security} that are not
3331 included in @option{-Wformat-nonliteral}.)
3333 @item -Wformat=2
3334 @opindex Wformat=2
3335 @opindex Wno-format=2
3336 Enable @option{-Wformat} plus format checks not included in
3337 @option{-Wformat}.  Currently equivalent to @option{-Wformat
3338 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3340 @item -Wnonnull
3341 @opindex Wnonnull
3342 @opindex Wno-nonnull
3343 Warn about passing a null pointer for arguments marked as
3344 requiring a non-null value by the @code{nonnull} function attribute.
3346 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3347 can be disabled with the @option{-Wno-nonnull} option.
3349 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3350 @opindex Winit-self
3351 @opindex Wno-init-self
3352 Warn about uninitialized variables that are initialized with themselves.
3353 Note this option can only be used with the @option{-Wuninitialized} option.
3355 For example, GCC warns about @code{i} being uninitialized in the
3356 following snippet only when @option{-Winit-self} has been specified:
3357 @smallexample
3358 @group
3359 int f()
3361   int i = i;
3362   return i;
3364 @end group
3365 @end smallexample
3367 This warning is enabled by @option{-Wall} in C++.
3369 @item -Wimplicit-int @r{(C and Objective-C only)}
3370 @opindex Wimplicit-int
3371 @opindex Wno-implicit-int
3372 Warn when a declaration does not specify a type.
3373 This warning is enabled by @option{-Wall}.
3375 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3376 @opindex Wimplicit-function-declaration
3377 @opindex Wno-implicit-function-declaration
3378 Give a warning whenever a function is used before being declared. In
3379 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3380 enabled by default and it is made into an error by
3381 @option{-pedantic-errors}. This warning is also enabled by
3382 @option{-Wall}.
3384 @item -Wimplicit @r{(C and Objective-C only)}
3385 @opindex Wimplicit
3386 @opindex Wno-implicit
3387 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3388 This warning is enabled by @option{-Wall}.
3390 @item -Wignored-qualifiers @r{(C and C++ only)}
3391 @opindex Wignored-qualifiers
3392 @opindex Wno-ignored-qualifiers
3393 Warn if the return type of a function has a type qualifier
3394 such as @code{const}.  For ISO C such a type qualifier has no effect,
3395 since the value returned by a function is not an lvalue.
3396 For C++, the warning is only emitted for scalar types or @code{void}.
3397 ISO C prohibits qualified @code{void} return types on function
3398 definitions, so such return types always receive a warning
3399 even without this option.
3401 This warning is also enabled by @option{-Wextra}.
3403 @item -Wmain
3404 @opindex Wmain
3405 @opindex Wno-main
3406 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3407 a function with external linkage, returning int, taking either zero
3408 arguments, two, or three arguments of appropriate types.  This warning
3409 is enabled by default in C++ and is enabled by either @option{-Wall}
3410 or @option{-Wpedantic}.
3412 @item -Wmissing-braces
3413 @opindex Wmissing-braces
3414 @opindex Wno-missing-braces
3415 Warn if an aggregate or union initializer is not fully bracketed.  In
3416 the following example, the initializer for @samp{a} is not fully
3417 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3418 enabled by @option{-Wall} in C.
3420 @smallexample
3421 int a[2][2] = @{ 0, 1, 2, 3 @};
3422 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3423 @end smallexample
3425 This warning is enabled by @option{-Wall}.
3427 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3428 @opindex Wmissing-include-dirs
3429 @opindex Wno-missing-include-dirs
3430 Warn if a user-supplied include directory does not exist.
3432 @item -Wparentheses
3433 @opindex Wparentheses
3434 @opindex Wno-parentheses
3435 Warn if parentheses are omitted in certain contexts, such
3436 as when there is an assignment in a context where a truth value
3437 is expected, or when operators are nested whose precedence people
3438 often get confused about.
3440 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3441 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3442 interpretation from that of ordinary mathematical notation.
3444 Also warn about constructions where there may be confusion to which
3445 @code{if} statement an @code{else} branch belongs.  Here is an example of
3446 such a case:
3448 @smallexample
3449 @group
3451   if (a)
3452     if (b)
3453       foo ();
3454   else
3455     bar ();
3457 @end group
3458 @end smallexample
3460 In C/C++, every @code{else} branch belongs to the innermost possible
3461 @code{if} statement, which in this example is @code{if (b)}.  This is
3462 often not what the programmer expected, as illustrated in the above
3463 example by indentation the programmer chose.  When there is the
3464 potential for this confusion, GCC issues a warning when this flag
3465 is specified.  To eliminate the warning, add explicit braces around
3466 the innermost @code{if} statement so there is no way the @code{else}
3467 can belong to the enclosing @code{if}.  The resulting code
3468 looks like this:
3470 @smallexample
3471 @group
3473   if (a)
3474     @{
3475       if (b)
3476         foo ();
3477       else
3478         bar ();
3479     @}
3481 @end group
3482 @end smallexample
3484 Also warn for dangerous uses of the GNU extension to
3485 @code{?:} with omitted middle operand. When the condition
3486 in the @code{?}: operator is a boolean expression, the omitted value is
3487 always 1.  Often programmers expect it to be a value computed
3488 inside the conditional expression instead.
3490 This warning is enabled by @option{-Wall}.
3492 @item -Wsequence-point
3493 @opindex Wsequence-point
3494 @opindex Wno-sequence-point
3495 Warn about code that may have undefined semantics because of violations
3496 of sequence point rules in the C and C++ standards.
3498 The C and C++ standards define the order in which expressions in a C/C++
3499 program are evaluated in terms of @dfn{sequence points}, which represent
3500 a partial ordering between the execution of parts of the program: those
3501 executed before the sequence point, and those executed after it.  These
3502 occur after the evaluation of a full expression (one which is not part
3503 of a larger expression), after the evaluation of the first operand of a
3504 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3505 function is called (but after the evaluation of its arguments and the
3506 expression denoting the called function), and in certain other places.
3507 Other than as expressed by the sequence point rules, the order of
3508 evaluation of subexpressions of an expression is not specified.  All
3509 these rules describe only a partial order rather than a total order,
3510 since, for example, if two functions are called within one expression
3511 with no sequence point between them, the order in which the functions
3512 are called is not specified.  However, the standards committee have
3513 ruled that function calls do not overlap.
3515 It is not specified when between sequence points modifications to the
3516 values of objects take effect.  Programs whose behavior depends on this
3517 have undefined behavior; the C and C++ standards specify that ``Between
3518 the previous and next sequence point an object shall have its stored
3519 value modified at most once by the evaluation of an expression.
3520 Furthermore, the prior value shall be read only to determine the value
3521 to be stored.''.  If a program breaks these rules, the results on any
3522 particular implementation are entirely unpredictable.
3524 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3525 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3526 diagnosed by this option, and it may give an occasional false positive
3527 result, but in general it has been found fairly effective at detecting
3528 this sort of problem in programs.
3530 The standard is worded confusingly, therefore there is some debate
3531 over the precise meaning of the sequence point rules in subtle cases.
3532 Links to discussions of the problem, including proposed formal
3533 definitions, may be found on the GCC readings page, at
3534 @uref{http://gcc.gnu.org/@/readings.html}.
3536 This warning is enabled by @option{-Wall} for C and C++.
3538 @item -Wreturn-type
3539 @opindex Wreturn-type
3540 @opindex Wno-return-type
3541 Warn whenever a function is defined with a return type that defaults
3542 to @code{int}.  Also warn about any @code{return} statement with no
3543 return value in a function whose return type is not @code{void}
3544 (falling off the end of the function body is considered returning
3545 without a value), and about a @code{return} statement with an
3546 expression in a function whose return type is @code{void}.
3548 For C++, a function without return type always produces a diagnostic
3549 message, even when @option{-Wno-return-type} is specified.  The only
3550 exceptions are @samp{main} and functions defined in system headers.
3552 This warning is enabled by @option{-Wall}.
3554 @item -Wswitch
3555 @opindex Wswitch
3556 @opindex Wno-switch
3557 Warn whenever a @code{switch} statement has an index of enumerated type
3558 and lacks a @code{case} for one or more of the named codes of that
3559 enumeration.  (The presence of a @code{default} label prevents this
3560 warning.)  @code{case} labels outside the enumeration range also
3561 provoke warnings when this option is used (even if there is a
3562 @code{default} label).
3563 This warning is enabled by @option{-Wall}.
3565 @item -Wswitch-default
3566 @opindex Wswitch-default
3567 @opindex Wno-switch-default
3568 Warn whenever a @code{switch} statement does not have a @code{default}
3569 case.
3571 @item -Wswitch-enum
3572 @opindex Wswitch-enum
3573 @opindex Wno-switch-enum
3574 Warn whenever a @code{switch} statement has an index of enumerated type
3575 and lacks a @code{case} for one or more of the named codes of that
3576 enumeration.  @code{case} labels outside the enumeration range also
3577 provoke warnings when this option is used.  The only difference
3578 between @option{-Wswitch} and this option is that this option gives a
3579 warning about an omitted enumeration code even if there is a
3580 @code{default} label.
3582 @item -Wsync-nand @r{(C and C++ only)}
3583 @opindex Wsync-nand
3584 @opindex Wno-sync-nand
3585 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3586 built-in functions are used.  These functions changed semantics in GCC 4.4.
3588 @item -Wtrigraphs
3589 @opindex Wtrigraphs
3590 @opindex Wno-trigraphs
3591 Warn if any trigraphs are encountered that might change the meaning of
3592 the program (trigraphs within comments are not warned about).
3593 This warning is enabled by @option{-Wall}.
3595 @item -Wunused-but-set-parameter
3596 @opindex Wunused-but-set-parameter
3597 @opindex Wno-unused-but-set-parameter
3598 Warn whenever a function parameter is assigned to, but otherwise unused
3599 (aside from its declaration).
3601 To suppress this warning use the @samp{unused} attribute
3602 (@pxref{Variable Attributes}).
3604 This warning is also enabled by @option{-Wunused} together with
3605 @option{-Wextra}.
3607 @item -Wunused-but-set-variable
3608 @opindex Wunused-but-set-variable
3609 @opindex Wno-unused-but-set-variable
3610 Warn whenever a local variable is assigned to, but otherwise unused
3611 (aside from its declaration).
3612 This warning is enabled by @option{-Wall}.
3614 To suppress this warning use the @samp{unused} attribute
3615 (@pxref{Variable Attributes}).
3617 This warning is also enabled by @option{-Wunused}, which is enabled
3618 by @option{-Wall}.
3620 @item -Wunused-function
3621 @opindex Wunused-function
3622 @opindex Wno-unused-function
3623 Warn whenever a static function is declared but not defined or a
3624 non-inline static function is unused.
3625 This warning is enabled by @option{-Wall}.
3627 @item -Wunused-label
3628 @opindex Wunused-label
3629 @opindex Wno-unused-label
3630 Warn whenever a label is declared but not used.
3631 This warning is enabled by @option{-Wall}.
3633 To suppress this warning use the @samp{unused} attribute
3634 (@pxref{Variable Attributes}).
3636 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3637 @opindex Wunused-local-typedefs
3638 Warn when a typedef locally defined in a function is not used.
3639 This warning is enabled by @option{-Wall}.
3641 @item -Wunused-parameter
3642 @opindex Wunused-parameter
3643 @opindex Wno-unused-parameter
3644 Warn whenever a function parameter is unused aside from its declaration.
3646 To suppress this warning use the @samp{unused} attribute
3647 (@pxref{Variable Attributes}).
3649 @item -Wno-unused-result
3650 @opindex Wunused-result
3651 @opindex Wno-unused-result
3652 Do not warn if a caller of a function marked with attribute
3653 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3654 its return value. The default is @option{-Wunused-result}.
3656 @item -Wunused-variable
3657 @opindex Wunused-variable
3658 @opindex Wno-unused-variable
3659 Warn whenever a local variable or non-constant static variable is unused
3660 aside from its declaration.
3661 This warning is enabled by @option{-Wall}.
3663 To suppress this warning use the @samp{unused} attribute
3664 (@pxref{Variable Attributes}).
3666 @item -Wunused-value
3667 @opindex Wunused-value
3668 @opindex Wno-unused-value
3669 Warn whenever a statement computes a result that is explicitly not
3670 used. To suppress this warning cast the unused expression to
3671 @samp{void}. This includes an expression-statement or the left-hand
3672 side of a comma expression that contains no side effects. For example,
3673 an expression such as @samp{x[i,j]} causes a warning, while
3674 @samp{x[(void)i,j]} does not.
3676 This warning is enabled by @option{-Wall}.
3678 @item -Wunused
3679 @opindex Wunused
3680 @opindex Wno-unused
3681 All the above @option{-Wunused} options combined.
3683 In order to get a warning about an unused function parameter, you must
3684 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3685 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3687 @item -Wuninitialized
3688 @opindex Wuninitialized
3689 @opindex Wno-uninitialized
3690 Warn if an automatic variable is used without first being initialized
3691 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3692 warn if a non-static reference or non-static @samp{const} member
3693 appears in a class without constructors.
3695 If you want to warn about code that uses the uninitialized value of the
3696 variable in its own initializer, use the @option{-Winit-self} option.
3698 These warnings occur for individual uninitialized or clobbered
3699 elements of structure, union or array variables as well as for
3700 variables that are uninitialized or clobbered as a whole.  They do
3701 not occur for variables or elements declared @code{volatile}.  Because
3702 these warnings depend on optimization, the exact variables or elements
3703 for which there are warnings depends on the precise optimization
3704 options and version of GCC used.
3706 Note that there may be no warning about a variable that is used only
3707 to compute a value that itself is never used, because such
3708 computations may be deleted by data flow analysis before the warnings
3709 are printed.
3711 @item -Wmaybe-uninitialized
3712 @opindex Wmaybe-uninitialized
3713 @opindex Wno-maybe-uninitialized
3714 For an automatic variable, if there exists a path from the function
3715 entry to a use of the variable that is initialized, but there exist
3716 some other paths for which the variable is not initialized, the compiler
3717 emits a warning if it cannot prove the uninitialized paths are not
3718 executed at run time. These warnings are made optional because GCC is
3719 not smart enough to see all the reasons why the code might be correct
3720 in spite of appearing to have an error.  Here is one example of how
3721 this can happen:
3723 @smallexample
3724 @group
3726   int x;
3727   switch (y)
3728     @{
3729     case 1: x = 1;
3730       break;
3731     case 2: x = 4;
3732       break;
3733     case 3: x = 5;
3734     @}
3735   foo (x);
3737 @end group
3738 @end smallexample
3740 @noindent
3741 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3742 always initialized, but GCC doesn't know this. To suppress the
3743 warning, you need to provide a default case with assert(0) or
3744 similar code.
3746 @cindex @code{longjmp} warnings
3747 This option also warns when a non-volatile automatic variable might be
3748 changed by a call to @code{longjmp}.  These warnings as well are possible
3749 only in optimizing compilation.
3751 The compiler sees only the calls to @code{setjmp}.  It cannot know
3752 where @code{longjmp} will be called; in fact, a signal handler could
3753 call it at any point in the code.  As a result, you may get a warning
3754 even when there is in fact no problem because @code{longjmp} cannot
3755 in fact be called at the place that would cause a problem.
3757 Some spurious warnings can be avoided if you declare all the functions
3758 you use that never return as @code{noreturn}.  @xref{Function
3759 Attributes}.
3761 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3763 @item -Wunknown-pragmas
3764 @opindex Wunknown-pragmas
3765 @opindex Wno-unknown-pragmas
3766 @cindex warning for unknown pragmas
3767 @cindex unknown pragmas, warning
3768 @cindex pragmas, warning of unknown
3769 Warn when a @code{#pragma} directive is encountered that is not understood by 
3770 GCC@.  If this command-line option is used, warnings are even issued
3771 for unknown pragmas in system header files.  This is not the case if
3772 the warnings are only enabled by the @option{-Wall} command-line option.
3774 @item -Wno-pragmas
3775 @opindex Wno-pragmas
3776 @opindex Wpragmas
3777 Do not warn about misuses of pragmas, such as incorrect parameters,
3778 invalid syntax, or conflicts between pragmas.  See also
3779 @option{-Wunknown-pragmas}.
3781 @item -Wstrict-aliasing
3782 @opindex Wstrict-aliasing
3783 @opindex Wno-strict-aliasing
3784 This option is only active when @option{-fstrict-aliasing} is active.
3785 It warns about code that might break the strict aliasing rules that the
3786 compiler is using for optimization.  The warning does not catch all
3787 cases, but does attempt to catch the more common pitfalls.  It is
3788 included in @option{-Wall}.
3789 It is equivalent to @option{-Wstrict-aliasing=3}
3791 @item -Wstrict-aliasing=n
3792 @opindex Wstrict-aliasing=n
3793 @opindex Wno-strict-aliasing=n
3794 This option is only active when @option{-fstrict-aliasing} is active.
3795 It warns about code that might break the strict aliasing rules that the
3796 compiler is using for optimization.
3797 Higher levels correspond to higher accuracy (fewer false positives).
3798 Higher levels also correspond to more effort, similar to the way @option{-O} 
3799 works.
3800 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
3802 Level 1: Most aggressive, quick, least accurate.
3803 Possibly useful when higher levels
3804 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
3805 false negatives.  However, it has many false positives.
3806 Warns for all pointer conversions between possibly incompatible types,
3807 even if never dereferenced.  Runs in the front end only.
3809 Level 2: Aggressive, quick, not too precise.
3810 May still have many false positives (not as many as level 1 though),
3811 and few false negatives (but possibly more than level 1).
3812 Unlike level 1, it only warns when an address is taken.  Warns about
3813 incomplete types.  Runs in the front end only.
3815 Level 3 (default for @option{-Wstrict-aliasing}):
3816 Should have very few false positives and few false
3817 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3818 Takes care of the common pun+dereference pattern in the front end:
3819 @code{*(int*)&some_float}.
3820 If optimization is enabled, it also runs in the back end, where it deals
3821 with multiple statement cases using flow-sensitive points-to information.
3822 Only warns when the converted pointer is dereferenced.
3823 Does not warn about incomplete types.
3825 @item -Wstrict-overflow
3826 @itemx -Wstrict-overflow=@var{n}
3827 @opindex Wstrict-overflow
3828 @opindex Wno-strict-overflow
3829 This option is only active when @option{-fstrict-overflow} is active.
3830 It warns about cases where the compiler optimizes based on the
3831 assumption that signed overflow does not occur.  Note that it does not
3832 warn about all cases where the code might overflow: it only warns
3833 about cases where the compiler implements some optimization.  Thus
3834 this warning depends on the optimization level.
3836 An optimization that assumes that signed overflow does not occur is
3837 perfectly safe if the values of the variables involved are such that
3838 overflow never does, in fact, occur.  Therefore this warning can
3839 easily give a false positive: a warning about code that is not
3840 actually a problem.  To help focus on important issues, several
3841 warning levels are defined.  No warnings are issued for the use of
3842 undefined signed overflow when estimating how many iterations a loop
3843 requires, in particular when determining whether a loop will be
3844 executed at all.
3846 @table @gcctabopt
3847 @item -Wstrict-overflow=1
3848 Warn about cases that are both questionable and easy to avoid.  For
3849 example,  with @option{-fstrict-overflow}, the compiler simplifies
3850 @code{x + 1 > x} to @code{1}.  This level of
3851 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3852 are not, and must be explicitly requested.
3854 @item -Wstrict-overflow=2
3855 Also warn about other cases where a comparison is simplified to a
3856 constant.  For example: @code{abs (x) >= 0}.  This can only be
3857 simplified when @option{-fstrict-overflow} is in effect, because
3858 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3859 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3860 @option{-Wstrict-overflow=2}.
3862 @item -Wstrict-overflow=3
3863 Also warn about other cases where a comparison is simplified.  For
3864 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
3866 @item -Wstrict-overflow=4
3867 Also warn about other simplifications not covered by the above cases.
3868 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
3870 @item -Wstrict-overflow=5
3871 Also warn about cases where the compiler reduces the magnitude of a
3872 constant involved in a comparison.  For example: @code{x + 2 > y} is
3873 simplified to @code{x + 1 >= y}.  This is reported only at the
3874 highest warning level because this simplification applies to many
3875 comparisons, so this warning level gives a very large number of
3876 false positives.
3877 @end table
3879 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
3880 @opindex Wsuggest-attribute=
3881 @opindex Wno-suggest-attribute=
3882 Warn for cases where adding an attribute may be beneficial. The
3883 attributes currently supported are listed below.
3885 @table @gcctabopt
3886 @item -Wsuggest-attribute=pure
3887 @itemx -Wsuggest-attribute=const
3888 @itemx -Wsuggest-attribute=noreturn
3889 @opindex Wsuggest-attribute=pure
3890 @opindex Wno-suggest-attribute=pure
3891 @opindex Wsuggest-attribute=const
3892 @opindex Wno-suggest-attribute=const
3893 @opindex Wsuggest-attribute=noreturn
3894 @opindex Wno-suggest-attribute=noreturn
3896 Warn about functions that might be candidates for attributes
3897 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3898 functions visible in other compilation units or (in the case of @code{pure} and
3899 @code{const}) if it cannot prove that the function returns normally. A function
3900 returns normally if it doesn't contain an infinite loop or return abnormally
3901 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3902 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3903 higher.  Higher optimization levels improve the accuracy of the analysis.
3905 @item -Wsuggest-attribute=format
3906 @itemx -Wmissing-format-attribute
3907 @opindex Wsuggest-attribute=format
3908 @opindex Wmissing-format-attribute
3909 @opindex Wno-suggest-attribute=format
3910 @opindex Wno-missing-format-attribute
3911 @opindex Wformat
3912 @opindex Wno-format
3914 Warn about function pointers that might be candidates for @code{format}
3915 attributes.  Note these are only possible candidates, not absolute ones.
3916 GCC guesses that function pointers with @code{format} attributes that
3917 are used in assignment, initialization, parameter passing or return
3918 statements should have a corresponding @code{format} attribute in the
3919 resulting type.  I.e.@: the left-hand side of the assignment or
3920 initialization, the type of the parameter variable, or the return type
3921 of the containing function respectively should also have a @code{format}
3922 attribute to avoid the warning.
3924 GCC also warns about function definitions that might be
3925 candidates for @code{format} attributes.  Again, these are only
3926 possible candidates.  GCC guesses that @code{format} attributes
3927 might be appropriate for any function that calls a function like
3928 @code{vprintf} or @code{vscanf}, but this might not always be the
3929 case, and some functions for which @code{format} attributes are
3930 appropriate may not be detected.
3931 @end table
3933 @item -Warray-bounds
3934 @opindex Wno-array-bounds
3935 @opindex Warray-bounds
3936 This option is only active when @option{-ftree-vrp} is active
3937 (default for @option{-O2} and above). It warns about subscripts to arrays
3938 that are always out of bounds. This warning is enabled by @option{-Wall}.
3940 @item -Wno-div-by-zero
3941 @opindex Wno-div-by-zero
3942 @opindex Wdiv-by-zero
3943 Do not warn about compile-time integer division by zero.  Floating-point
3944 division by zero is not warned about, as it can be a legitimate way of
3945 obtaining infinities and NaNs.
3947 @item -Wsystem-headers
3948 @opindex Wsystem-headers
3949 @opindex Wno-system-headers
3950 @cindex warnings from system headers
3951 @cindex system headers, warnings from
3952 Print warning messages for constructs found in system header files.
3953 Warnings from system headers are normally suppressed, on the assumption
3954 that they usually do not indicate real problems and would only make the
3955 compiler output harder to read.  Using this command-line option tells
3956 GCC to emit warnings from system headers as if they occurred in user
3957 code.  However, note that using @option{-Wall} in conjunction with this
3958 option does @emph{not} warn about unknown pragmas in system
3959 headers---for that, @option{-Wunknown-pragmas} must also be used.
3961 @item -Wtrampolines
3962 @opindex Wtrampolines
3963 @opindex Wno-trampolines
3964  Warn about trampolines generated for pointers to nested functions.
3966  A trampoline is a small piece of data or code that is created at run
3967  time on the stack when the address of a nested function is taken, and
3968  is used to call the nested function indirectly.  For some targets, it
3969  is made up of data only and thus requires no special treatment.  But,
3970  for most targets, it is made up of code and thus requires the stack
3971  to be made executable in order for the program to work properly.
3973 @item -Wfloat-equal
3974 @opindex Wfloat-equal
3975 @opindex Wno-float-equal
3976 Warn if floating-point values are used in equality comparisons.
3978 The idea behind this is that sometimes it is convenient (for the
3979 programmer) to consider floating-point values as approximations to
3980 infinitely precise real numbers.  If you are doing this, then you need
3981 to compute (by analyzing the code, or in some other way) the maximum or
3982 likely maximum error that the computation introduces, and allow for it
3983 when performing comparisons (and when producing output, but that's a
3984 different problem).  In particular, instead of testing for equality, you
3985 should check to see whether the two values have ranges that overlap; and
3986 this is done with the relational operators, so equality comparisons are
3987 probably mistaken.
3989 @item -Wtraditional @r{(C and Objective-C only)}
3990 @opindex Wtraditional
3991 @opindex Wno-traditional
3992 Warn about certain constructs that behave differently in traditional and
3993 ISO C@.  Also warn about ISO C constructs that have no traditional C
3994 equivalent, and/or problematic constructs that should be avoided.
3996 @itemize @bullet
3997 @item
3998 Macro parameters that appear within string literals in the macro body.
3999 In traditional C macro replacement takes place within string literals,
4000 but in ISO C it does not.
4002 @item
4003 In traditional C, some preprocessor directives did not exist.
4004 Traditional preprocessors only considered a line to be a directive
4005 if the @samp{#} appeared in column 1 on the line.  Therefore
4006 @option{-Wtraditional} warns about directives that traditional C
4007 understands but ignores because the @samp{#} does not appear as the
4008 first character on the line.  It also suggests you hide directives like
4009 @samp{#pragma} not understood by traditional C by indenting them.  Some
4010 traditional implementations do not recognize @samp{#elif}, so this option
4011 suggests avoiding it altogether.
4013 @item
4014 A function-like macro that appears without arguments.
4016 @item
4017 The unary plus operator.
4019 @item
4020 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4021 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4022 constants.)  Note, these suffixes appear in macros defined in the system
4023 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4024 Use of these macros in user code might normally lead to spurious
4025 warnings, however GCC's integrated preprocessor has enough context to
4026 avoid warning in these cases.
4028 @item
4029 A function declared external in one block and then used after the end of
4030 the block.
4032 @item
4033 A @code{switch} statement has an operand of type @code{long}.
4035 @item
4036 A non-@code{static} function declaration follows a @code{static} one.
4037 This construct is not accepted by some traditional C compilers.
4039 @item
4040 The ISO type of an integer constant has a different width or
4041 signedness from its traditional type.  This warning is only issued if
4042 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4043 typically represent bit patterns, are not warned about.
4045 @item
4046 Usage of ISO string concatenation is detected.
4048 @item
4049 Initialization of automatic aggregates.
4051 @item
4052 Identifier conflicts with labels.  Traditional C lacks a separate
4053 namespace for labels.
4055 @item
4056 Initialization of unions.  If the initializer is zero, the warning is
4057 omitted.  This is done under the assumption that the zero initializer in
4058 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4059 initializer warnings and relies on default initialization to zero in the
4060 traditional C case.
4062 @item
4063 Conversions by prototypes between fixed/floating-point values and vice
4064 versa.  The absence of these prototypes when compiling with traditional
4065 C causes serious problems.  This is a subset of the possible
4066 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4068 @item
4069 Use of ISO C style function definitions.  This warning intentionally is
4070 @emph{not} issued for prototype declarations or variadic functions
4071 because these ISO C features appear in your code when using
4072 libiberty's traditional C compatibility macros, @code{PARAMS} and
4073 @code{VPARAMS}.  This warning is also bypassed for nested functions
4074 because that feature is already a GCC extension and thus not relevant to
4075 traditional C compatibility.
4076 @end itemize
4078 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4079 @opindex Wtraditional-conversion
4080 @opindex Wno-traditional-conversion
4081 Warn if a prototype causes a type conversion that is different from what
4082 would happen to the same argument in the absence of a prototype.  This
4083 includes conversions of fixed point to floating and vice versa, and
4084 conversions changing the width or signedness of a fixed-point argument
4085 except when the same as the default promotion.
4087 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4088 @opindex Wdeclaration-after-statement
4089 @opindex Wno-declaration-after-statement
4090 Warn when a declaration is found after a statement in a block.  This
4091 construct, known from C++, was introduced with ISO C99 and is by default
4092 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4093 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4095 @item -Wundef
4096 @opindex Wundef
4097 @opindex Wno-undef
4098 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4100 @item -Wno-endif-labels
4101 @opindex Wno-endif-labels
4102 @opindex Wendif-labels
4103 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4105 @item -Wshadow
4106 @opindex Wshadow
4107 @opindex Wno-shadow
4108 Warn whenever a local variable or type declaration shadows another variable,
4109 parameter, type, or class member (in C++), or whenever a built-in function
4110 is shadowed. Note that in C++, the compiler warns if a local variable
4111 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4113 @item -Wlarger-than=@var{len}
4114 @opindex Wlarger-than=@var{len}
4115 @opindex Wlarger-than-@var{len}
4116 Warn whenever an object of larger than @var{len} bytes is defined.
4118 @item -Wframe-larger-than=@var{len}
4119 @opindex Wframe-larger-than
4120 Warn if the size of a function frame is larger than @var{len} bytes.
4121 The computation done to determine the stack frame size is approximate
4122 and not conservative.
4123 The actual requirements may be somewhat greater than @var{len}
4124 even if you do not get a warning.  In addition, any space allocated
4125 via @code{alloca}, variable-length arrays, or related constructs
4126 is not included by the compiler when determining
4127 whether or not to issue a warning.
4129 @item -Wno-free-nonheap-object
4130 @opindex Wno-free-nonheap-object
4131 @opindex Wfree-nonheap-object
4132 Do not warn when attempting to free an object that was not allocated
4133 on the heap.
4135 @item -Wstack-usage=@var{len}
4136 @opindex Wstack-usage
4137 Warn if the stack usage of a function might be larger than @var{len} bytes.
4138 The computation done to determine the stack usage is conservative.
4139 Any space allocated via @code{alloca}, variable-length arrays, or related
4140 constructs is included by the compiler when determining whether or not to
4141 issue a warning.
4143 The message is in keeping with the output of @option{-fstack-usage}.
4145 @itemize
4146 @item
4147 If the stack usage is fully static but exceeds the specified amount, it's:
4149 @smallexample
4150   warning: stack usage is 1120 bytes
4151 @end smallexample
4152 @item
4153 If the stack usage is (partly) dynamic but bounded, it's:
4155 @smallexample
4156   warning: stack usage might be 1648 bytes
4157 @end smallexample
4158 @item
4159 If the stack usage is (partly) dynamic and not bounded, it's:
4161 @smallexample
4162   warning: stack usage might be unbounded
4163 @end smallexample
4164 @end itemize
4166 @item -Wunsafe-loop-optimizations
4167 @opindex Wunsafe-loop-optimizations
4168 @opindex Wno-unsafe-loop-optimizations
4169 Warn if the loop cannot be optimized because the compiler cannot
4170 assume anything on the bounds of the loop indices.  With
4171 @option{-funsafe-loop-optimizations} warn if the compiler makes
4172 such assumptions.
4174 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4175 @opindex Wno-pedantic-ms-format
4176 @opindex Wpedantic-ms-format
4177 When used in combination with @option{-Wformat}
4178 and @option{-pedantic} without GNU extensions, this option
4179 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4180 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4181 which depend on the MS runtime.
4183 @item -Wpointer-arith
4184 @opindex Wpointer-arith
4185 @opindex Wno-pointer-arith
4186 Warn about anything that depends on the ``size of'' a function type or
4187 of @code{void}.  GNU C assigns these types a size of 1, for
4188 convenience in calculations with @code{void *} pointers and pointers
4189 to functions.  In C++, warn also when an arithmetic operation involves
4190 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4192 @item -Wtype-limits
4193 @opindex Wtype-limits
4194 @opindex Wno-type-limits
4195 Warn if a comparison is always true or always false due to the limited
4196 range of the data type, but do not warn for constant expressions.  For
4197 example, warn if an unsigned variable is compared against zero with
4198 @samp{<} or @samp{>=}.  This warning is also enabled by
4199 @option{-Wextra}.
4201 @item -Wbad-function-cast @r{(C and Objective-C only)}
4202 @opindex Wbad-function-cast
4203 @opindex Wno-bad-function-cast
4204 Warn whenever a function call is cast to a non-matching type.
4205 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4207 @item -Wc++-compat @r{(C and Objective-C only)}
4208 Warn about ISO C constructs that are outside of the common subset of
4209 ISO C and ISO C++, e.g.@: request for implicit conversion from
4210 @code{void *} to a pointer to non-@code{void} type.
4212 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4213 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4214 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4215 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4216 enabled by @option{-Wall}.
4218 @item -Wcast-qual
4219 @opindex Wcast-qual
4220 @opindex Wno-cast-qual
4221 Warn whenever a pointer is cast so as to remove a type qualifier from
4222 the target type.  For example, warn if a @code{const char *} is cast
4223 to an ordinary @code{char *}.
4225 Also warn when making a cast that introduces a type qualifier in an
4226 unsafe way.  For example, casting @code{char **} to @code{const char **}
4227 is unsafe, as in this example:
4229 @smallexample
4230   /* p is char ** value.  */
4231   const char **q = (const char **) p;
4232   /* Assignment of readonly string to const char * is OK.  */
4233   *q = "string";
4234   /* Now char** pointer points to read-only memory.  */
4235   **p = 'b';
4236 @end smallexample
4238 @item -Wcast-align
4239 @opindex Wcast-align
4240 @opindex Wno-cast-align
4241 Warn whenever a pointer is cast such that the required alignment of the
4242 target is increased.  For example, warn if a @code{char *} is cast to
4243 an @code{int *} on machines where integers can only be accessed at
4244 two- or four-byte boundaries.
4246 @item -Wwrite-strings
4247 @opindex Wwrite-strings
4248 @opindex Wno-write-strings
4249 When compiling C, give string constants the type @code{const
4250 char[@var{length}]} so that copying the address of one into a
4251 non-@code{const} @code{char *} pointer produces a warning.  These
4252 warnings help you find at compile time code that can try to write
4253 into a string constant, but only if you have been very careful about
4254 using @code{const} in declarations and prototypes.  Otherwise, it is
4255 just a nuisance. This is why we did not make @option{-Wall} request
4256 these warnings.
4258 When compiling C++, warn about the deprecated conversion from string
4259 literals to @code{char *}.  This warning is enabled by default for C++
4260 programs.
4262 @item -Wclobbered
4263 @opindex Wclobbered
4264 @opindex Wno-clobbered
4265 Warn for variables that might be changed by @samp{longjmp} or
4266 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4268 @item -Wconversion
4269 @opindex Wconversion
4270 @opindex Wno-conversion
4271 Warn for implicit conversions that may alter a value. This includes
4272 conversions between real and integer, like @code{abs (x)} when
4273 @code{x} is @code{double}; conversions between signed and unsigned,
4274 like @code{unsigned ui = -1}; and conversions to smaller types, like
4275 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4276 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4277 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4278 conversions between signed and unsigned integers can be disabled by
4279 using @option{-Wno-sign-conversion}.
4281 For C++, also warn for confusing overload resolution for user-defined
4282 conversions; and conversions that never use a type conversion
4283 operator: conversions to @code{void}, the same type, a base class or a
4284 reference to them. Warnings about conversions between signed and
4285 unsigned integers are disabled by default in C++ unless
4286 @option{-Wsign-conversion} is explicitly enabled.
4288 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4289 @opindex Wconversion-null
4290 @opindex Wno-conversion-null
4291 Do not warn for conversions between @code{NULL} and non-pointer
4292 types. @option{-Wconversion-null} is enabled by default.
4294 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4295 @opindex Wzero-as-null-pointer-constant
4296 @opindex Wno-zero-as-null-pointer-constant
4297 Warn when a literal '0' is used as null pointer constant.  This can
4298 be useful to facilitate the conversion to @code{nullptr} in C++11.
4300 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4301 @opindex Wuseless-cast
4302 @opindex Wno-useless-cast
4303 Warn when an expression is casted to its own type.
4305 @item -Wempty-body
4306 @opindex Wempty-body
4307 @opindex Wno-empty-body
4308 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4309 while} statement.  This warning is also enabled by @option{-Wextra}.
4311 @item -Wenum-compare
4312 @opindex Wenum-compare
4313 @opindex Wno-enum-compare
4314 Warn about a comparison between values of different enumerated types.
4315 In C++ enumeral mismatches in conditional expressions are also
4316 diagnosed and the warning is enabled by default.  In C this warning is 
4317 enabled by @option{-Wall}.
4319 @item -Wjump-misses-init @r{(C, Objective-C only)}
4320 @opindex Wjump-misses-init
4321 @opindex Wno-jump-misses-init
4322 Warn if a @code{goto} statement or a @code{switch} statement jumps
4323 forward across the initialization of a variable, or jumps backward to a
4324 label after the variable has been initialized.  This only warns about
4325 variables that are initialized when they are declared.  This warning is
4326 only supported for C and Objective-C; in C++ this sort of branch is an
4327 error in any case.
4329 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4330 can be disabled with the @option{-Wno-jump-misses-init} option.
4332 @item -Wsign-compare
4333 @opindex Wsign-compare
4334 @opindex Wno-sign-compare
4335 @cindex warning for comparison of signed and unsigned values
4336 @cindex comparison of signed and unsigned values, warning
4337 @cindex signed and unsigned values, comparison warning
4338 Warn when a comparison between signed and unsigned values could produce
4339 an incorrect result when the signed value is converted to unsigned.
4340 This warning is also enabled by @option{-Wextra}; to get the other warnings
4341 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4343 @item -Wsign-conversion
4344 @opindex Wsign-conversion
4345 @opindex Wno-sign-conversion
4346 Warn for implicit conversions that may change the sign of an integer
4347 value, like assigning a signed integer expression to an unsigned
4348 integer variable. An explicit cast silences the warning. In C, this
4349 option is enabled also by @option{-Wconversion}.
4351 @item -Wsizeof-pointer-memaccess
4352 @opindex Wsizeof-pointer-memaccess
4353 @opindex Wno-sizeof-pointer-memaccess
4354 Warn for suspicious length parameters to certain string and memory built-in
4355 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4356 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4357 but a pointer, and suggests a possible fix, or about
4358 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4359 @option{-Wall}.
4361 @item -Waddress
4362 @opindex Waddress
4363 @opindex Wno-address
4364 Warn about suspicious uses of memory addresses. These include using
4365 the address of a function in a conditional expression, such as
4366 @code{void func(void); if (func)}, and comparisons against the memory
4367 address of a string literal, such as @code{if (x == "abc")}.  Such
4368 uses typically indicate a programmer error: the address of a function
4369 always evaluates to true, so their use in a conditional usually
4370 indicate that the programmer forgot the parentheses in a function
4371 call; and comparisons against string literals result in unspecified
4372 behavior and are not portable in C, so they usually indicate that the
4373 programmer intended to use @code{strcmp}.  This warning is enabled by
4374 @option{-Wall}.
4376 @item -Wlogical-op
4377 @opindex Wlogical-op
4378 @opindex Wno-logical-op
4379 Warn about suspicious uses of logical operators in expressions.
4380 This includes using logical operators in contexts where a
4381 bit-wise operator is likely to be expected.
4383 @item -Waggregate-return
4384 @opindex Waggregate-return
4385 @opindex Wno-aggregate-return
4386 Warn if any functions that return structures or unions are defined or
4387 called.  (In languages where you can return an array, this also elicits
4388 a warning.)
4390 @item -Wno-attributes
4391 @opindex Wno-attributes
4392 @opindex Wattributes
4393 Do not warn if an unexpected @code{__attribute__} is used, such as
4394 unrecognized attributes, function attributes applied to variables,
4395 etc.  This does not stop errors for incorrect use of supported
4396 attributes.
4398 @item -Wno-builtin-macro-redefined
4399 @opindex Wno-builtin-macro-redefined
4400 @opindex Wbuiltin-macro-redefined
4401 Do not warn if certain built-in macros are redefined.  This suppresses
4402 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4403 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4405 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4406 @opindex Wstrict-prototypes
4407 @opindex Wno-strict-prototypes
4408 Warn if a function is declared or defined without specifying the
4409 argument types.  (An old-style function definition is permitted without
4410 a warning if preceded by a declaration that specifies the argument
4411 types.)
4413 @item -Wold-style-declaration @r{(C and Objective-C only)}
4414 @opindex Wold-style-declaration
4415 @opindex Wno-old-style-declaration
4416 Warn for obsolescent usages, according to the C Standard, in a
4417 declaration. For example, warn if storage-class specifiers like
4418 @code{static} are not the first things in a declaration.  This warning
4419 is also enabled by @option{-Wextra}.
4421 @item -Wold-style-definition @r{(C and Objective-C only)}
4422 @opindex Wold-style-definition
4423 @opindex Wno-old-style-definition
4424 Warn if an old-style function definition is used.  A warning is given
4425 even if there is a previous prototype.
4427 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4428 @opindex Wmissing-parameter-type
4429 @opindex Wno-missing-parameter-type
4430 A function parameter is declared without a type specifier in K&R-style
4431 functions:
4433 @smallexample
4434 void foo(bar) @{ @}
4435 @end smallexample
4437 This warning is also enabled by @option{-Wextra}.
4439 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4440 @opindex Wmissing-prototypes
4441 @opindex Wno-missing-prototypes
4442 Warn if a global function is defined without a previous prototype
4443 declaration.  This warning is issued even if the definition itself
4444 provides a prototype.  Use this option to detect global functions
4445 that do not have a matching prototype declaration in a header file.
4446 This option is not valid for C++ because all function declarations
4447 provide prototypes and a non-matching declaration will declare an
4448 overload rather than conflict with an earlier declaration.
4449 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4451 @item -Wmissing-declarations
4452 @opindex Wmissing-declarations
4453 @opindex Wno-missing-declarations
4454 Warn if a global function is defined without a previous declaration.
4455 Do so even if the definition itself provides a prototype.
4456 Use this option to detect global functions that are not declared in
4457 header files.  In C, no warnings are issued for functions with previous
4458 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4459 missing prototypes.  In C++, no warnings are issued for function templates,
4460 or for inline functions, or for functions in anonymous namespaces.
4462 @item -Wmissing-field-initializers
4463 @opindex Wmissing-field-initializers
4464 @opindex Wno-missing-field-initializers
4465 @opindex W
4466 @opindex Wextra
4467 @opindex Wno-extra
4468 Warn if a structure's initializer has some fields missing.  For
4469 example, the following code causes such a warning, because
4470 @code{x.h} is implicitly zero:
4472 @smallexample
4473 struct s @{ int f, g, h; @};
4474 struct s x = @{ 3, 4 @};
4475 @end smallexample
4477 This option does not warn about designated initializers, so the following
4478 modification does not trigger a warning:
4480 @smallexample
4481 struct s @{ int f, g, h; @};
4482 struct s x = @{ .f = 3, .g = 4 @};
4483 @end smallexample
4485 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4486 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4488 @item -Wno-multichar
4489 @opindex Wno-multichar
4490 @opindex Wmultichar
4491 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4492 Usually they indicate a typo in the user's code, as they have
4493 implementation-defined values, and should not be used in portable code.
4495 @item -Wnormalized=<none|id|nfc|nfkc>
4496 @opindex Wnormalized=
4497 @cindex NFC
4498 @cindex NFKC
4499 @cindex character set, input normalization
4500 In ISO C and ISO C++, two identifiers are different if they are
4501 different sequences of characters.  However, sometimes when characters
4502 outside the basic ASCII character set are used, you can have two
4503 different character sequences that look the same.  To avoid confusion,
4504 the ISO 10646 standard sets out some @dfn{normalization rules} which
4505 when applied ensure that two sequences that look the same are turned into
4506 the same sequence.  GCC can warn you if you are using identifiers that
4507 have not been normalized; this option controls that warning.
4509 There are four levels of warning supported by GCC@.  The default is
4510 @option{-Wnormalized=nfc}, which warns about any identifier that is
4511 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4512 recommended form for most uses.
4514 Unfortunately, there are some characters allowed in identifiers by
4515 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4516 identifiers.  That is, there's no way to use these symbols in portable
4517 ISO C or C++ and have all your identifiers in NFC@.
4518 @option{-Wnormalized=id} suppresses the warning for these characters.
4519 It is hoped that future versions of the standards involved will correct
4520 this, which is why this option is not the default.
4522 You can switch the warning off for all characters by writing
4523 @option{-Wnormalized=none}.  You should only do this if you
4524 are using some other normalization scheme (like ``D''), because
4525 otherwise you can easily create bugs that are literally impossible to see.
4527 Some characters in ISO 10646 have distinct meanings but look identical
4528 in some fonts or display methodologies, especially once formatting has
4529 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4530 LETTER N'', displays just like a regular @code{n} that has been
4531 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4532 normalization scheme to convert all these into a standard form as
4533 well, and GCC warns if your code is not in NFKC if you use
4534 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4535 about every identifier that contains the letter O because it might be
4536 confused with the digit 0, and so is not the default, but may be
4537 useful as a local coding convention if the programming environment 
4538 cannot be fixed to display these characters distinctly.
4540 @item -Wno-deprecated
4541 @opindex Wno-deprecated
4542 @opindex Wdeprecated
4543 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4545 @item -Wno-deprecated-declarations
4546 @opindex Wno-deprecated-declarations
4547 @opindex Wdeprecated-declarations
4548 Do not warn about uses of functions (@pxref{Function Attributes}),
4549 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4550 Attributes}) marked as deprecated by using the @code{deprecated}
4551 attribute.
4553 @item -Wno-overflow
4554 @opindex Wno-overflow
4555 @opindex Woverflow
4556 Do not warn about compile-time overflow in constant expressions.
4558 @item -Woverride-init @r{(C and Objective-C only)}
4559 @opindex Woverride-init
4560 @opindex Wno-override-init
4561 @opindex W
4562 @opindex Wextra
4563 @opindex Wno-extra
4564 Warn if an initialized field without side effects is overridden when
4565 using designated initializers (@pxref{Designated Inits, , Designated
4566 Initializers}).
4568 This warning is included in @option{-Wextra}.  To get other
4569 @option{-Wextra} warnings without this one, use @option{-Wextra
4570 -Wno-override-init}.
4572 @item -Wpacked
4573 @opindex Wpacked
4574 @opindex Wno-packed
4575 Warn if a structure is given the packed attribute, but the packed
4576 attribute has no effect on the layout or size of the structure.
4577 Such structures may be mis-aligned for little benefit.  For
4578 instance, in this code, the variable @code{f.x} in @code{struct bar}
4579 is misaligned even though @code{struct bar} does not itself
4580 have the packed attribute:
4582 @smallexample
4583 @group
4584 struct foo @{
4585   int x;
4586   char a, b, c, d;
4587 @} __attribute__((packed));
4588 struct bar @{
4589   char z;
4590   struct foo f;
4592 @end group
4593 @end smallexample
4595 @item -Wpacked-bitfield-compat
4596 @opindex Wpacked-bitfield-compat
4597 @opindex Wno-packed-bitfield-compat
4598 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4599 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4600 the change can lead to differences in the structure layout.  GCC
4601 informs you when the offset of such a field has changed in GCC 4.4.
4602 For example there is no longer a 4-bit padding between field @code{a}
4603 and @code{b} in this structure:
4605 @smallexample
4606 struct foo
4608   char a:4;
4609   char b:8;
4610 @} __attribute__ ((packed));
4611 @end smallexample
4613 This warning is enabled by default.  Use
4614 @option{-Wno-packed-bitfield-compat} to disable this warning.
4616 @item -Wpadded
4617 @opindex Wpadded
4618 @opindex Wno-padded
4619 Warn if padding is included in a structure, either to align an element
4620 of the structure or to align the whole structure.  Sometimes when this
4621 happens it is possible to rearrange the fields of the structure to
4622 reduce the padding and so make the structure smaller.
4624 @item -Wredundant-decls
4625 @opindex Wredundant-decls
4626 @opindex Wno-redundant-decls
4627 Warn if anything is declared more than once in the same scope, even in
4628 cases where multiple declaration is valid and changes nothing.
4630 @item -Wnested-externs @r{(C and Objective-C only)}
4631 @opindex Wnested-externs
4632 @opindex Wno-nested-externs
4633 Warn if an @code{extern} declaration is encountered within a function.
4635 @item -Wno-inherited-variadic-ctor
4636 @opindex Winherited-variadic-ctor
4637 @opindex Wno-inherited-variadic-ctor
4638 Suppress warnings about use of C++11 inheriting constructors when the
4639 base class inherited from has a C variadic constructor; the warning is
4640 on by default because the ellipsis is not inherited.
4642 @item -Winline
4643 @opindex Winline
4644 @opindex Wno-inline
4645 Warn if a function that is declared as inline cannot be inlined.
4646 Even with this option, the compiler does not warn about failures to
4647 inline functions declared in system headers.
4649 The compiler uses a variety of heuristics to determine whether or not
4650 to inline a function.  For example, the compiler takes into account
4651 the size of the function being inlined and the amount of inlining
4652 that has already been done in the current function.  Therefore,
4653 seemingly insignificant changes in the source program can cause the
4654 warnings produced by @option{-Winline} to appear or disappear.
4656 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4657 @opindex Wno-invalid-offsetof
4658 @opindex Winvalid-offsetof
4659 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4660 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4661 to a non-POD type is undefined.  In existing C++ implementations,
4662 however, @samp{offsetof} typically gives meaningful results even when
4663 applied to certain kinds of non-POD types (such as a simple
4664 @samp{struct} that fails to be a POD type only by virtue of having a
4665 constructor).  This flag is for users who are aware that they are
4666 writing nonportable code and who have deliberately chosen to ignore the
4667 warning about it.
4669 The restrictions on @samp{offsetof} may be relaxed in a future version
4670 of the C++ standard.
4672 @item -Wno-int-to-pointer-cast
4673 @opindex Wno-int-to-pointer-cast
4674 @opindex Wint-to-pointer-cast
4675 Suppress warnings from casts to pointer type of an integer of a
4676 different size. In C++, casting to a pointer type of smaller size is
4677 an error. @option{Wint-to-pointer-cast} is enabled by default.
4680 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4681 @opindex Wno-pointer-to-int-cast
4682 @opindex Wpointer-to-int-cast
4683 Suppress warnings from casts from a pointer to an integer type of a
4684 different size.
4686 @item -Winvalid-pch
4687 @opindex Winvalid-pch
4688 @opindex Wno-invalid-pch
4689 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4690 the search path but can't be used.
4692 @item -Wlong-long
4693 @opindex Wlong-long
4694 @opindex Wno-long-long
4695 Warn if @samp{long long} type is used.  This is enabled by either
4696 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4697 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4699 @item -Wvariadic-macros
4700 @opindex Wvariadic-macros
4701 @opindex Wno-variadic-macros
4702 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4703 alternate syntax when in pedantic ISO C99 mode.  This is default.
4704 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4706 @item -Wvarargs
4707 @opindex Wvarargs
4708 @opindex Wno-varargs
4709 Warn upon questionable usage of the macros used to handle variable
4710 arguments like @samp{va_start}.  This is default.  To inhibit the
4711 warning messages, use @option{-Wno-varargs}.
4713 @item -Wvector-operation-performance
4714 @opindex Wvector-operation-performance
4715 @opindex Wno-vector-operation-performance
4716 Warn if vector operation is not implemented via SIMD capabilities of the
4717 architecture.  Mainly useful for the performance tuning.
4718 Vector operation can be implemented @code{piecewise}, which means that the
4719 scalar operation is performed on every vector element; 
4720 @code{in parallel}, which means that the vector operation is implemented
4721 using scalars of wider type, which normally is more performance efficient;
4722 and @code{as a single scalar}, which means that vector fits into a
4723 scalar type.
4725 @item -Wvla
4726 @opindex Wvla
4727 @opindex Wno-vla
4728 Warn if variable length array is used in the code.
4729 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4730 the variable length array.
4732 @item -Wvolatile-register-var
4733 @opindex Wvolatile-register-var
4734 @opindex Wno-volatile-register-var
4735 Warn if a register variable is declared volatile.  The volatile
4736 modifier does not inhibit all optimizations that may eliminate reads
4737 and/or writes to register variables.  This warning is enabled by
4738 @option{-Wall}.
4740 @item -Wdisabled-optimization
4741 @opindex Wdisabled-optimization
4742 @opindex Wno-disabled-optimization
4743 Warn if a requested optimization pass is disabled.  This warning does
4744 not generally indicate that there is anything wrong with your code; it
4745 merely indicates that GCC's optimizers are unable to handle the code
4746 effectively.  Often, the problem is that your code is too big or too
4747 complex; GCC refuses to optimize programs when the optimization
4748 itself is likely to take inordinate amounts of time.
4750 @item -Wpointer-sign @r{(C and Objective-C only)}
4751 @opindex Wpointer-sign
4752 @opindex Wno-pointer-sign
4753 Warn for pointer argument passing or assignment with different signedness.
4754 This option is only supported for C and Objective-C@.  It is implied by
4755 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
4756 @option{-Wno-pointer-sign}.
4758 @item -Wstack-protector
4759 @opindex Wstack-protector
4760 @opindex Wno-stack-protector
4761 This option is only active when @option{-fstack-protector} is active.  It
4762 warns about functions that are not protected against stack smashing.
4764 @item -Wno-mudflap
4765 @opindex Wno-mudflap
4766 Suppress warnings about constructs that cannot be instrumented by
4767 @option{-fmudflap}.
4769 @item -Woverlength-strings
4770 @opindex Woverlength-strings
4771 @opindex Wno-overlength-strings
4772 Warn about string constants that are longer than the ``minimum
4773 maximum'' length specified in the C standard.  Modern compilers
4774 generally allow string constants that are much longer than the
4775 standard's minimum limit, but very portable programs should avoid
4776 using longer strings.
4778 The limit applies @emph{after} string constant concatenation, and does
4779 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4780 C99, it was raised to 4095.  C++98 does not specify a normative
4781 minimum maximum, so we do not diagnose overlength strings in C++@.
4783 This option is implied by @option{-Wpedantic}, and can be disabled with
4784 @option{-Wno-overlength-strings}.
4786 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4787 @opindex Wunsuffixed-float-constants
4789 Issue a warning for any floating constant that does not have
4790 a suffix.  When used together with @option{-Wsystem-headers} it
4791 warns about such constants in system header files.  This can be useful
4792 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4793 from the decimal floating-point extension to C99.
4794 @end table
4796 @node Debugging Options
4797 @section Options for Debugging Your Program or GCC
4798 @cindex options, debugging
4799 @cindex debugging information options
4801 GCC has various special options that are used for debugging
4802 either your program or GCC:
4804 @table @gcctabopt
4805 @item -g
4806 @opindex g
4807 Produce debugging information in the operating system's native format
4808 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4809 information.
4811 On most systems that use stabs format, @option{-g} enables use of extra
4812 debugging information that only GDB can use; this extra information
4813 makes debugging work better in GDB but probably makes other debuggers
4814 crash or
4815 refuse to read the program.  If you want to control for certain whether
4816 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4817 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4819 GCC allows you to use @option{-g} with
4820 @option{-O}.  The shortcuts taken by optimized code may occasionally
4821 produce surprising results: some variables you declared may not exist
4822 at all; flow of control may briefly move where you did not expect it;
4823 some statements may not be executed because they compute constant
4824 results or their values are already at hand; some statements may
4825 execute in different places because they have been moved out of loops.
4827 Nevertheless it proves possible to debug optimized output.  This makes
4828 it reasonable to use the optimizer for programs that might have bugs.
4830 The following options are useful when GCC is generated with the
4831 capability for more than one debugging format.
4833 @item -ggdb
4834 @opindex ggdb
4835 Produce debugging information for use by GDB@.  This means to use the
4836 most expressive format available (DWARF 2, stabs, or the native format
4837 if neither of those are supported), including GDB extensions if at all
4838 possible.
4840 @item -gpubnames
4841 @opindex gpubnames
4842 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
4844 @item -gstabs
4845 @opindex gstabs
4846 Produce debugging information in stabs format (if that is supported),
4847 without GDB extensions.  This is the format used by DBX on most BSD
4848 systems.  On MIPS, Alpha and System V Release 4 systems this option
4849 produces stabs debugging output that is not understood by DBX or SDB@.
4850 On System V Release 4 systems this option requires the GNU assembler.
4852 @item -feliminate-unused-debug-symbols
4853 @opindex feliminate-unused-debug-symbols
4854 Produce debugging information in stabs format (if that is supported),
4855 for only symbols that are actually used.
4857 @item -femit-class-debug-always
4858 Instead of emitting debugging information for a C++ class in only one
4859 object file, emit it in all object files using the class.  This option
4860 should be used only with debuggers that are unable to handle the way GCC
4861 normally emits debugging information for classes because using this
4862 option increases the size of debugging information by as much as a
4863 factor of two.
4865 @item -fdebug-types-section
4866 @opindex fdebug-types-section
4867 @opindex fno-debug-types-section
4868 When using DWARF Version 4 or higher, type DIEs can be put into
4869 their own @code{.debug_types} section instead of making them part of the
4870 @code{.debug_info} section.  It is more efficient to put them in a separate
4871 comdat sections since the linker can then remove duplicates.
4872 But not all DWARF consumers support @code{.debug_types} sections yet
4873 and on some objects @code{.debug_types} produces larger instead of smaller
4874 debugging information.
4876 @item -gstabs+
4877 @opindex gstabs+
4878 Produce debugging information in stabs format (if that is supported),
4879 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4880 use of these extensions is likely to make other debuggers crash or
4881 refuse to read the program.
4883 @item -gcoff
4884 @opindex gcoff
4885 Produce debugging information in COFF format (if that is supported).
4886 This is the format used by SDB on most System V systems prior to
4887 System V Release 4.
4889 @item -gxcoff
4890 @opindex gxcoff
4891 Produce debugging information in XCOFF format (if that is supported).
4892 This is the format used by the DBX debugger on IBM RS/6000 systems.
4894 @item -gxcoff+
4895 @opindex gxcoff+
4896 Produce debugging information in XCOFF format (if that is supported),
4897 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4898 use of these extensions is likely to make other debuggers crash or
4899 refuse to read the program, and may cause assemblers other than the GNU
4900 assembler (GAS) to fail with an error.
4902 @item -gdwarf-@var{version}
4903 @opindex gdwarf-@var{version}
4904 Produce debugging information in DWARF format (if that is supported).
4905 The value of @var{version} may be either 2, 3 or 4; the default version
4906 for most targets is 4.
4908 Note that with DWARF Version 2, some ports require and always
4909 use some non-conflicting DWARF 3 extensions in the unwind tables.
4911 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4912 for maximum benefit.
4914 @item -grecord-gcc-switches
4915 @opindex grecord-gcc-switches
4916 This switch causes the command-line options used to invoke the
4917 compiler that may affect code generation to be appended to the
4918 DW_AT_producer attribute in DWARF debugging information.  The options
4919 are concatenated with spaces separating them from each other and from
4920 the compiler version.  See also @option{-frecord-gcc-switches} for another
4921 way of storing compiler options into the object file.  This is the default.
4923 @item -gno-record-gcc-switches
4924 @opindex gno-record-gcc-switches
4925 Disallow appending command-line options to the DW_AT_producer attribute
4926 in DWARF debugging information.
4928 @item -gstrict-dwarf
4929 @opindex gstrict-dwarf
4930 Disallow using extensions of later DWARF standard version than selected
4931 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4932 DWARF extensions from later standard versions is allowed.
4934 @item -gno-strict-dwarf
4935 @opindex gno-strict-dwarf
4936 Allow using extensions of later DWARF standard version than selected with
4937 @option{-gdwarf-@var{version}}.
4939 @item -gvms
4940 @opindex gvms
4941 Produce debugging information in Alpha/VMS debug format (if that is
4942 supported).  This is the format used by DEBUG on Alpha/VMS systems.
4944 @item -g@var{level}
4945 @itemx -ggdb@var{level}
4946 @itemx -gstabs@var{level}
4947 @itemx -gcoff@var{level}
4948 @itemx -gxcoff@var{level}
4949 @itemx -gvms@var{level}
4950 Request debugging information and also use @var{level} to specify how
4951 much information.  The default level is 2.
4953 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4954 @option{-g}.
4956 Level 1 produces minimal information, enough for making backtraces in
4957 parts of the program that you don't plan to debug.  This includes
4958 descriptions of functions and external variables, but no information
4959 about local variables and no line numbers.
4961 Level 3 includes extra information, such as all the macro definitions
4962 present in the program.  Some debuggers support macro expansion when
4963 you use @option{-g3}.
4965 @option{-gdwarf-2} does not accept a concatenated debug level, because
4966 GCC used to support an option @option{-gdwarf} that meant to generate
4967 debug information in version 1 of the DWARF format (which is very
4968 different from version 2), and it would have been too confusing.  That
4969 debug format is long obsolete, but the option cannot be changed now.
4970 Instead use an additional @option{-g@var{level}} option to change the
4971 debug level for DWARF.
4973 @item -gtoggle
4974 @opindex gtoggle
4975 Turn off generation of debug info, if leaving out this option
4976 generates it, or turn it on at level 2 otherwise.  The position of this
4977 argument in the command line does not matter; it takes effect after all
4978 other options are processed, and it does so only once, no matter how
4979 many times it is given.  This is mainly intended to be used with
4980 @option{-fcompare-debug}.
4982 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4983 @opindex fdump-final-insns
4984 Dump the final internal representation (RTL) to @var{file}.  If the
4985 optional argument is omitted (or if @var{file} is @code{.}), the name
4986 of the dump file is determined by appending @code{.gkd} to the
4987 compilation output file name.
4989 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4990 @opindex fcompare-debug
4991 @opindex fno-compare-debug
4992 If no error occurs during compilation, run the compiler a second time,
4993 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4994 passed to the second compilation.  Dump the final internal
4995 representation in both compilations, and print an error if they differ.
4997 If the equal sign is omitted, the default @option{-gtoggle} is used.
4999 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5000 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5001 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5002 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5003 is used.
5005 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5006 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5007 of the final representation and the second compilation, preventing even
5008 @env{GCC_COMPARE_DEBUG} from taking effect.
5010 To verify full coverage during @option{-fcompare-debug} testing, set
5011 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5012 which GCC rejects as an invalid option in any actual compilation
5013 (rather than preprocessing, assembly or linking).  To get just a
5014 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5015 not overridden} will do.
5017 @item -fcompare-debug-second
5018 @opindex fcompare-debug-second
5019 This option is implicitly passed to the compiler for the second
5020 compilation requested by @option{-fcompare-debug}, along with options to
5021 silence warnings, and omitting other options that would cause
5022 side-effect compiler outputs to files or to the standard output.  Dump
5023 files and preserved temporary files are renamed so as to contain the
5024 @code{.gk} additional extension during the second compilation, to avoid
5025 overwriting those generated by the first.
5027 When this option is passed to the compiler driver, it causes the
5028 @emph{first} compilation to be skipped, which makes it useful for little
5029 other than debugging the compiler proper.
5031 @item -feliminate-dwarf2-dups
5032 @opindex feliminate-dwarf2-dups
5033 Compress DWARF 2 debugging information by eliminating duplicated
5034 information about each symbol.  This option only makes sense when
5035 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5037 @item -femit-struct-debug-baseonly
5038 Emit debug information for struct-like types
5039 only when the base name of the compilation source file
5040 matches the base name of file in which the struct is defined.
5042 This option substantially reduces the size of debugging information,
5043 but at significant potential loss in type information to the debugger.
5044 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5045 See @option{-femit-struct-debug-detailed} for more detailed control.
5047 This option works only with DWARF 2.
5049 @item -femit-struct-debug-reduced
5050 Emit debug information for struct-like types
5051 only when the base name of the compilation source file
5052 matches the base name of file in which the type is defined,
5053 unless the struct is a template or defined in a system header.
5055 This option significantly reduces the size of debugging information,
5056 with some potential loss in type information to the debugger.
5057 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5058 See @option{-femit-struct-debug-detailed} for more detailed control.
5060 This option works only with DWARF 2.
5062 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5063 Specify the struct-like types
5064 for which the compiler generates debug information.
5065 The intent is to reduce duplicate struct debug information
5066 between different object files within the same program.
5068 This option is a detailed version of
5069 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5070 which serves for most needs.
5072 A specification has the syntax@*
5073 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5075 The optional first word limits the specification to
5076 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5077 A struct type is used directly when it is the type of a variable, member.
5078 Indirect uses arise through pointers to structs.
5079 That is, when use of an incomplete struct is valid, the use is indirect.
5080 An example is
5081 @samp{struct one direct; struct two * indirect;}.
5083 The optional second word limits the specification to
5084 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5085 Generic structs are a bit complicated to explain.
5086 For C++, these are non-explicit specializations of template classes,
5087 or non-template classes within the above.
5088 Other programming languages have generics,
5089 but @option{-femit-struct-debug-detailed} does not yet implement them.
5091 The third word specifies the source files for those
5092 structs for which the compiler should emit debug information.
5093 The values @samp{none} and @samp{any} have the normal meaning.
5094 The value @samp{base} means that
5095 the base of name of the file in which the type declaration appears
5096 must match the base of the name of the main compilation file.
5097 In practice, this means that when compiling @file{foo.c}, debug information
5098 is generated for types declared in that file and @file{foo.h},
5099 but not other header files.
5100 The value @samp{sys} means those types satisfying @samp{base}
5101 or declared in system or compiler headers.
5103 You may need to experiment to determine the best settings for your application.
5105 The default is @option{-femit-struct-debug-detailed=all}.
5107 This option works only with DWARF 2.
5109 @item -fno-merge-debug-strings
5110 @opindex fmerge-debug-strings
5111 @opindex fno-merge-debug-strings
5112 Direct the linker to not merge together strings in the debugging
5113 information that are identical in different object files.  Merging is
5114 not supported by all assemblers or linkers.  Merging decreases the size
5115 of the debug information in the output file at the cost of increasing
5116 link processing time.  Merging is enabled by default.
5118 @item -fdebug-prefix-map=@var{old}=@var{new}
5119 @opindex fdebug-prefix-map
5120 When compiling files in directory @file{@var{old}}, record debugging
5121 information describing them as in @file{@var{new}} instead.
5123 @item -fno-dwarf2-cfi-asm
5124 @opindex fdwarf2-cfi-asm
5125 @opindex fno-dwarf2-cfi-asm
5126 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5127 instead of using GAS @code{.cfi_*} directives.
5129 @cindex @command{prof}
5130 @item -p
5131 @opindex p
5132 Generate extra code to write profile information suitable for the
5133 analysis program @command{prof}.  You must use this option when compiling
5134 the source files you want data about, and you must also use it when
5135 linking.
5137 @cindex @command{gprof}
5138 @item -pg
5139 @opindex pg
5140 Generate extra code to write profile information suitable for the
5141 analysis program @command{gprof}.  You must use this option when compiling
5142 the source files you want data about, and you must also use it when
5143 linking.
5145 @item -Q
5146 @opindex Q
5147 Makes the compiler print out each function name as it is compiled, and
5148 print some statistics about each pass when it finishes.
5150 @item -ftime-report
5151 @opindex ftime-report
5152 Makes the compiler print some statistics about the time consumed by each
5153 pass when it finishes.
5155 @item -fmem-report
5156 @opindex fmem-report
5157 Makes the compiler print some statistics about permanent memory
5158 allocation when it finishes.
5160 @item -fmem-report-wpa
5161 @opindex fmem-report-wpa
5162 Makes the compiler print some statistics about permanent memory
5163 allocation for the WPA phase only.
5165 @item -fpre-ipa-mem-report
5166 @opindex fpre-ipa-mem-report
5167 @item -fpost-ipa-mem-report
5168 @opindex fpost-ipa-mem-report
5169 Makes the compiler print some statistics about permanent memory
5170 allocation before or after interprocedural optimization.
5172 @item -fprofile-report
5173 @opindex fprofile-report
5174 Makes the compiler print some statistics about consistency of the
5175 (estimated) profile and effect of individual passes.
5177 @item -fstack-usage
5178 @opindex fstack-usage
5179 Makes the compiler output stack usage information for the program, on a
5180 per-function basis.  The filename for the dump is made by appending
5181 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5182 the output file, if explicitly specified and it is not an executable,
5183 otherwise it is the basename of the source file.  An entry is made up
5184 of three fields:
5186 @itemize
5187 @item
5188 The name of the function.
5189 @item
5190 A number of bytes.
5191 @item
5192 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5193 @end itemize
5195 The qualifier @code{static} means that the function manipulates the stack
5196 statically: a fixed number of bytes are allocated for the frame on function
5197 entry and released on function exit; no stack adjustments are otherwise made
5198 in the function.  The second field is this fixed number of bytes.
5200 The qualifier @code{dynamic} means that the function manipulates the stack
5201 dynamically: in addition to the static allocation described above, stack
5202 adjustments are made in the body of the function, for example to push/pop
5203 arguments around function calls.  If the qualifier @code{bounded} is also
5204 present, the amount of these adjustments is bounded at compile time and
5205 the second field is an upper bound of the total amount of stack used by
5206 the function.  If it is not present, the amount of these adjustments is
5207 not bounded at compile time and the second field only represents the
5208 bounded part.
5210 @item -fprofile-arcs
5211 @opindex fprofile-arcs
5212 Add code so that program flow @dfn{arcs} are instrumented.  During
5213 execution the program records how many times each branch and call is
5214 executed and how many times it is taken or returns.  When the compiled
5215 program exits it saves this data to a file called
5216 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5217 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5218 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5219 @var{auxname} is generated from the name of the output file, if
5220 explicitly specified and it is not the final executable, otherwise it is
5221 the basename of the source file.  In both cases any suffix is removed
5222 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5223 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5224 @xref{Cross-profiling}.
5226 @cindex @command{gcov}
5227 @item --coverage
5228 @opindex coverage
5230 This option is used to compile and link code instrumented for coverage
5231 analysis.  The option is a synonym for @option{-fprofile-arcs}
5232 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5233 linking).  See the documentation for those options for more details.
5235 @itemize
5237 @item
5238 Compile the source files with @option{-fprofile-arcs} plus optimization
5239 and code generation options.  For test coverage analysis, use the
5240 additional @option{-ftest-coverage} option.  You do not need to profile
5241 every source file in a program.
5243 @item
5244 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5245 (the latter implies the former).
5247 @item
5248 Run the program on a representative workload to generate the arc profile
5249 information.  This may be repeated any number of times.  You can run
5250 concurrent instances of your program, and provided that the file system
5251 supports locking, the data files will be correctly updated.  Also
5252 @code{fork} calls are detected and correctly handled (double counting
5253 will not happen).
5255 @item
5256 For profile-directed optimizations, compile the source files again with
5257 the same optimization and code generation options plus
5258 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5259 Control Optimization}).
5261 @item
5262 For test coverage analysis, use @command{gcov} to produce human readable
5263 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5264 @command{gcov} documentation for further information.
5266 @end itemize
5268 With @option{-fprofile-arcs}, for each function of your program GCC
5269 creates a program flow graph, then finds a spanning tree for the graph.
5270 Only arcs that are not on the spanning tree have to be instrumented: the
5271 compiler adds code to count the number of times that these arcs are
5272 executed.  When an arc is the only exit or only entrance to a block, the
5273 instrumentation code can be added to the block; otherwise, a new basic
5274 block must be created to hold the instrumentation code.
5276 @need 2000
5277 @item -ftest-coverage
5278 @opindex ftest-coverage
5279 Produce a notes file that the @command{gcov} code-coverage utility
5280 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5281 show program coverage.  Each source file's note file is called
5282 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5283 above for a description of @var{auxname} and instructions on how to
5284 generate test coverage data.  Coverage data matches the source files
5285 more closely if you do not optimize.
5287 @item -fdbg-cnt-list
5288 @opindex fdbg-cnt-list
5289 Print the name and the counter upper bound for all debug counters.
5292 @item -fdbg-cnt=@var{counter-value-list}
5293 @opindex fdbg-cnt
5294 Set the internal debug counter upper bound.  @var{counter-value-list}
5295 is a comma-separated list of @var{name}:@var{value} pairs
5296 which sets the upper bound of each debug counter @var{name} to @var{value}.
5297 All debug counters have the initial upper bound of @code{UINT_MAX};
5298 thus @code{dbg_cnt()} returns true always unless the upper bound
5299 is set by this option.
5300 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5301 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5303 @itemx -fenable-@var{kind}-@var{pass}
5304 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5305 @opindex fdisable-
5306 @opindex fenable-
5308 This is a set of options that are used to explicitly disable/enable
5309 optimization passes.  These options are intended for use for debugging GCC.
5310 Compiler users should use regular options for enabling/disabling
5311 passes instead.
5313 @table @gcctabopt
5315 @item -fdisable-ipa-@var{pass}
5316 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5317 statically invoked in the compiler multiple times, the pass name should be
5318 appended with a sequential number starting from 1.
5320 @item -fdisable-rtl-@var{pass}
5321 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5322 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5323 statically invoked in the compiler multiple times, the pass name should be
5324 appended with a sequential number starting from 1.  @var{range-list} is a 
5325 comma-separated list of function ranges or assembler names.  Each range is a number
5326 pair separated by a colon.  The range is inclusive in both ends.  If the range
5327 is trivial, the number pair can be simplified as a single number.  If the
5328 function's cgraph node's @var{uid} falls within one of the specified ranges,
5329 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5330 function header of a dump file, and the pass names can be dumped by using
5331 option @option{-fdump-passes}.
5333 @item -fdisable-tree-@var{pass}
5334 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5335 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5336 option arguments.
5338 @item -fenable-ipa-@var{pass}
5339 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5340 statically invoked in the compiler multiple times, the pass name should be
5341 appended with a sequential number starting from 1.
5343 @item -fenable-rtl-@var{pass}
5344 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5345 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5346 description and examples.
5348 @item -fenable-tree-@var{pass}
5349 @itemx -fenable-tree-@var{pass}=@var{range-list}
5350 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5351 of option arguments.
5353 @end table
5355 Here are some examples showing uses of these options.
5357 @smallexample
5359 # disable ccp1 for all functions
5360    -fdisable-tree-ccp1
5361 # disable complete unroll for function whose cgraph node uid is 1
5362    -fenable-tree-cunroll=1
5363 # disable gcse2 for functions at the following ranges [1,1],
5364 # [300,400], and [400,1000]
5365 # disable gcse2 for functions foo and foo2
5366    -fdisable-rtl-gcse2=foo,foo2
5367 # disable early inlining
5368    -fdisable-tree-einline
5369 # disable ipa inlining
5370    -fdisable-ipa-inline
5371 # enable tree full unroll
5372    -fenable-tree-unroll
5374 @end smallexample
5376 @item -d@var{letters}
5377 @itemx -fdump-rtl-@var{pass}
5378 @itemx -fdump-rtl-@var{pass}=@var{filename}
5379 @opindex d
5380 Says to make debugging dumps during compilation at times specified by
5381 @var{letters}.  This is used for debugging the RTL-based passes of the
5382 compiler.  The file names for most of the dumps are made by appending
5383 a pass number and a word to the @var{dumpname}, and the files are
5384 created in the directory of the output file. In case of
5385 @option{=@var{filename}} option, the dump is output on the given file
5386 instead of the pass numbered dump files. Note that the pass number is
5387 computed statically as passes get registered into the pass manager.
5388 Thus the numbering is not related to the dynamic order of execution of
5389 passes.  In particular, a pass installed by a plugin could have a
5390 number over 200 even if it executed quite early.  @var{dumpname} is
5391 generated from the name of the output file, if explicitly specified
5392 and it is not an executable, otherwise it is the basename of the
5393 source file. These switches may have different effects when
5394 @option{-E} is used for preprocessing.
5396 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5397 @option{-d} option @var{letters}.  Here are the possible
5398 letters for use in @var{pass} and @var{letters}, and their meanings:
5400 @table @gcctabopt
5402 @item -fdump-rtl-alignments
5403 @opindex fdump-rtl-alignments
5404 Dump after branch alignments have been computed.
5406 @item -fdump-rtl-asmcons
5407 @opindex fdump-rtl-asmcons
5408 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5410 @item -fdump-rtl-auto_inc_dec
5411 @opindex fdump-rtl-auto_inc_dec
5412 Dump after auto-inc-dec discovery.  This pass is only run on
5413 architectures that have auto inc or auto dec instructions.
5415 @item -fdump-rtl-barriers
5416 @opindex fdump-rtl-barriers
5417 Dump after cleaning up the barrier instructions.
5419 @item -fdump-rtl-bbpart
5420 @opindex fdump-rtl-bbpart
5421 Dump after partitioning hot and cold basic blocks.
5423 @item -fdump-rtl-bbro
5424 @opindex fdump-rtl-bbro
5425 Dump after block reordering.
5427 @item -fdump-rtl-btl1
5428 @itemx -fdump-rtl-btl2
5429 @opindex fdump-rtl-btl2
5430 @opindex fdump-rtl-btl2
5431 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5432 after the two branch
5433 target load optimization passes.
5435 @item -fdump-rtl-bypass
5436 @opindex fdump-rtl-bypass
5437 Dump after jump bypassing and control flow optimizations.
5439 @item -fdump-rtl-combine
5440 @opindex fdump-rtl-combine
5441 Dump after the RTL instruction combination pass.
5443 @item -fdump-rtl-compgotos
5444 @opindex fdump-rtl-compgotos
5445 Dump after duplicating the computed gotos.
5447 @item -fdump-rtl-ce1
5448 @itemx -fdump-rtl-ce2
5449 @itemx -fdump-rtl-ce3
5450 @opindex fdump-rtl-ce1
5451 @opindex fdump-rtl-ce2
5452 @opindex fdump-rtl-ce3
5453 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5454 @option{-fdump-rtl-ce3} enable dumping after the three
5455 if conversion passes.
5457 @itemx -fdump-rtl-cprop_hardreg
5458 @opindex fdump-rtl-cprop_hardreg
5459 Dump after hard register copy propagation.
5461 @itemx -fdump-rtl-csa
5462 @opindex fdump-rtl-csa
5463 Dump after combining stack adjustments.
5465 @item -fdump-rtl-cse1
5466 @itemx -fdump-rtl-cse2
5467 @opindex fdump-rtl-cse1
5468 @opindex fdump-rtl-cse2
5469 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5470 the two common subexpression elimination passes.
5472 @itemx -fdump-rtl-dce
5473 @opindex fdump-rtl-dce
5474 Dump after the standalone dead code elimination passes.
5476 @itemx -fdump-rtl-dbr
5477 @opindex fdump-rtl-dbr
5478 Dump after delayed branch scheduling.
5480 @item -fdump-rtl-dce1
5481 @itemx -fdump-rtl-dce2
5482 @opindex fdump-rtl-dce1
5483 @opindex fdump-rtl-dce2
5484 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5485 the two dead store elimination passes.
5487 @item -fdump-rtl-eh
5488 @opindex fdump-rtl-eh
5489 Dump after finalization of EH handling code.
5491 @item -fdump-rtl-eh_ranges
5492 @opindex fdump-rtl-eh_ranges
5493 Dump after conversion of EH handling range regions.
5495 @item -fdump-rtl-expand
5496 @opindex fdump-rtl-expand
5497 Dump after RTL generation.
5499 @item -fdump-rtl-fwprop1
5500 @itemx -fdump-rtl-fwprop2
5501 @opindex fdump-rtl-fwprop1
5502 @opindex fdump-rtl-fwprop2
5503 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5504 dumping after the two forward propagation passes.
5506 @item -fdump-rtl-gcse1
5507 @itemx -fdump-rtl-gcse2
5508 @opindex fdump-rtl-gcse1
5509 @opindex fdump-rtl-gcse2
5510 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5511 after global common subexpression elimination.
5513 @item -fdump-rtl-init-regs
5514 @opindex fdump-rtl-init-regs
5515 Dump after the initialization of the registers.
5517 @item -fdump-rtl-initvals
5518 @opindex fdump-rtl-initvals
5519 Dump after the computation of the initial value sets.
5521 @itemx -fdump-rtl-into_cfglayout
5522 @opindex fdump-rtl-into_cfglayout
5523 Dump after converting to cfglayout mode.
5525 @item -fdump-rtl-ira
5526 @opindex fdump-rtl-ira
5527 Dump after iterated register allocation.
5529 @item -fdump-rtl-jump
5530 @opindex fdump-rtl-jump
5531 Dump after the second jump optimization.
5533 @item -fdump-rtl-loop2
5534 @opindex fdump-rtl-loop2
5535 @option{-fdump-rtl-loop2} enables dumping after the rtl
5536 loop optimization passes.
5538 @item -fdump-rtl-mach
5539 @opindex fdump-rtl-mach
5540 Dump after performing the machine dependent reorganization pass, if that
5541 pass exists.
5543 @item -fdump-rtl-mode_sw
5544 @opindex fdump-rtl-mode_sw
5545 Dump after removing redundant mode switches.
5547 @item -fdump-rtl-rnreg
5548 @opindex fdump-rtl-rnreg
5549 Dump after register renumbering.
5551 @itemx -fdump-rtl-outof_cfglayout
5552 @opindex fdump-rtl-outof_cfglayout
5553 Dump after converting from cfglayout mode.
5555 @item -fdump-rtl-peephole2
5556 @opindex fdump-rtl-peephole2
5557 Dump after the peephole pass.
5559 @item -fdump-rtl-postreload
5560 @opindex fdump-rtl-postreload
5561 Dump after post-reload optimizations.
5563 @itemx -fdump-rtl-pro_and_epilogue
5564 @opindex fdump-rtl-pro_and_epilogue
5565 Dump after generating the function prologues and epilogues.
5567 @item -fdump-rtl-regmove
5568 @opindex fdump-rtl-regmove
5569 Dump after the register move pass.
5571 @item -fdump-rtl-sched1
5572 @itemx -fdump-rtl-sched2
5573 @opindex fdump-rtl-sched1
5574 @opindex fdump-rtl-sched2
5575 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5576 after the basic block scheduling passes.
5578 @item -fdump-rtl-see
5579 @opindex fdump-rtl-see
5580 Dump after sign extension elimination.
5582 @item -fdump-rtl-seqabstr
5583 @opindex fdump-rtl-seqabstr
5584 Dump after common sequence discovery.
5586 @item -fdump-rtl-shorten
5587 @opindex fdump-rtl-shorten
5588 Dump after shortening branches.
5590 @item -fdump-rtl-sibling
5591 @opindex fdump-rtl-sibling
5592 Dump after sibling call optimizations.
5594 @item -fdump-rtl-split1
5595 @itemx -fdump-rtl-split2
5596 @itemx -fdump-rtl-split3
5597 @itemx -fdump-rtl-split4
5598 @itemx -fdump-rtl-split5
5599 @opindex fdump-rtl-split1
5600 @opindex fdump-rtl-split2
5601 @opindex fdump-rtl-split3
5602 @opindex fdump-rtl-split4
5603 @opindex fdump-rtl-split5
5604 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5605 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5606 @option{-fdump-rtl-split5} enable dumping after five rounds of
5607 instruction splitting.
5609 @item -fdump-rtl-sms
5610 @opindex fdump-rtl-sms
5611 Dump after modulo scheduling.  This pass is only run on some
5612 architectures.
5614 @item -fdump-rtl-stack
5615 @opindex fdump-rtl-stack
5616 Dump after conversion from GCC's ``flat register file'' registers to the
5617 x87's stack-like registers.  This pass is only run on x86 variants.
5619 @item -fdump-rtl-subreg1
5620 @itemx -fdump-rtl-subreg2
5621 @opindex fdump-rtl-subreg1
5622 @opindex fdump-rtl-subreg2
5623 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5624 the two subreg expansion passes.
5626 @item -fdump-rtl-unshare
5627 @opindex fdump-rtl-unshare
5628 Dump after all rtl has been unshared.
5630 @item -fdump-rtl-vartrack
5631 @opindex fdump-rtl-vartrack
5632 Dump after variable tracking.
5634 @item -fdump-rtl-vregs
5635 @opindex fdump-rtl-vregs
5636 Dump after converting virtual registers to hard registers.
5638 @item -fdump-rtl-web
5639 @opindex fdump-rtl-web
5640 Dump after live range splitting.
5642 @item -fdump-rtl-regclass
5643 @itemx -fdump-rtl-subregs_of_mode_init
5644 @itemx -fdump-rtl-subregs_of_mode_finish
5645 @itemx -fdump-rtl-dfinit
5646 @itemx -fdump-rtl-dfinish
5647 @opindex fdump-rtl-regclass
5648 @opindex fdump-rtl-subregs_of_mode_init
5649 @opindex fdump-rtl-subregs_of_mode_finish
5650 @opindex fdump-rtl-dfinit
5651 @opindex fdump-rtl-dfinish
5652 These dumps are defined but always produce empty files.
5654 @item -da
5655 @itemx -fdump-rtl-all
5656 @opindex da
5657 @opindex fdump-rtl-all
5658 Produce all the dumps listed above.
5660 @item -dA
5661 @opindex dA
5662 Annotate the assembler output with miscellaneous debugging information.
5664 @item -dD
5665 @opindex dD
5666 Dump all macro definitions, at the end of preprocessing, in addition to
5667 normal output.
5669 @item -dH
5670 @opindex dH
5671 Produce a core dump whenever an error occurs.
5673 @item -dp
5674 @opindex dp
5675 Annotate the assembler output with a comment indicating which
5676 pattern and alternative is used.  The length of each instruction is
5677 also printed.
5679 @item -dP
5680 @opindex dP
5681 Dump the RTL in the assembler output as a comment before each instruction.
5682 Also turns on @option{-dp} annotation.
5684 @item -dv
5685 @opindex dv
5686 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5687 dump a representation of the control flow graph suitable for viewing with VCG
5688 to @file{@var{file}.@var{pass}.vcg}.
5690 @item -dx
5691 @opindex dx
5692 Just generate RTL for a function instead of compiling it.  Usually used
5693 with @option{-fdump-rtl-expand}.
5694 @end table
5696 @item -fdump-noaddr
5697 @opindex fdump-noaddr
5698 When doing debugging dumps, suppress address output.  This makes it more
5699 feasible to use diff on debugging dumps for compiler invocations with
5700 different compiler binaries and/or different
5701 text / bss / data / heap / stack / dso start locations.
5703 @item -fdump-unnumbered
5704 @opindex fdump-unnumbered
5705 When doing debugging dumps, suppress instruction numbers and address output.
5706 This makes it more feasible to use diff on debugging dumps for compiler
5707 invocations with different options, in particular with and without
5708 @option{-g}.
5710 @item -fdump-unnumbered-links
5711 @opindex fdump-unnumbered-links
5712 When doing debugging dumps (see @option{-d} option above), suppress
5713 instruction numbers for the links to the previous and next instructions
5714 in a sequence.
5716 @item -fdump-translation-unit @r{(C++ only)}
5717 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5718 @opindex fdump-translation-unit
5719 Dump a representation of the tree structure for the entire translation
5720 unit to a file.  The file name is made by appending @file{.tu} to the
5721 source file name, and the file is created in the same directory as the
5722 output file.  If the @samp{-@var{options}} form is used, @var{options}
5723 controls the details of the dump as described for the
5724 @option{-fdump-tree} options.
5726 @item -fdump-class-hierarchy @r{(C++ only)}
5727 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5728 @opindex fdump-class-hierarchy
5729 Dump a representation of each class's hierarchy and virtual function
5730 table layout to a file.  The file name is made by appending
5731 @file{.class} to the source file name, and the file is created in the
5732 same directory as the output file.  If the @samp{-@var{options}} form
5733 is used, @var{options} controls the details of the dump as described
5734 for the @option{-fdump-tree} options.
5736 @item -fdump-ipa-@var{switch}
5737 @opindex fdump-ipa
5738 Control the dumping at various stages of inter-procedural analysis
5739 language tree to a file.  The file name is generated by appending a
5740 switch specific suffix to the source file name, and the file is created
5741 in the same directory as the output file.  The following dumps are
5742 possible:
5744 @table @samp
5745 @item all
5746 Enables all inter-procedural analysis dumps.
5748 @item cgraph
5749 Dumps information about call-graph optimization, unused function removal,
5750 and inlining decisions.
5752 @item inline
5753 Dump after function inlining.
5755 @end table
5757 @item -fdump-passes
5758 @opindex fdump-passes
5759 Dump the list of optimization passes that are turned on and off by
5760 the current command-line options.
5762 @item -fdump-statistics-@var{option}
5763 @opindex fdump-statistics
5764 Enable and control dumping of pass statistics in a separate file.  The
5765 file name is generated by appending a suffix ending in
5766 @samp{.statistics} to the source file name, and the file is created in
5767 the same directory as the output file.  If the @samp{-@var{option}}
5768 form is used, @samp{-stats} causes counters to be summed over the
5769 whole compilation unit while @samp{-details} dumps every event as
5770 the passes generate them.  The default with no option is to sum
5771 counters for each function compiled.
5773 @item -fdump-tree-@var{switch}
5774 @itemx -fdump-tree-@var{switch}-@var{options}
5775 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
5776 @opindex fdump-tree
5777 Control the dumping at various stages of processing the intermediate
5778 language tree to a file.  The file name is generated by appending a
5779 switch-specific suffix to the source file name, and the file is
5780 created in the same directory as the output file. In case of
5781 @option{=@var{filename}} option, the dump is output on the given file
5782 instead of the auto named dump files.  If the @samp{-@var{options}}
5783 form is used, @var{options} is a list of @samp{-} separated options
5784 which control the details of the dump.  Not all options are applicable
5785 to all dumps; those that are not meaningful are ignored.  The
5786 following options are available
5788 @table @samp
5789 @item address
5790 Print the address of each node.  Usually this is not meaningful as it
5791 changes according to the environment and source file.  Its primary use
5792 is for tying up a dump file with a debug environment.
5793 @item asmname
5794 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5795 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5796 use working backward from mangled names in the assembly file.
5797 @item slim
5798 Inhibit dumping of members of a scope or body of a function merely
5799 because that scope has been reached.  Only dump such items when they
5800 are directly reachable by some other path.  When dumping pretty-printed
5801 trees, this option inhibits dumping the bodies of control structures.
5802 @item raw
5803 Print a raw representation of the tree.  By default, trees are
5804 pretty-printed into a C-like representation.
5805 @item details
5806 Enable more detailed dumps (not honored by every dump option). Also
5807 include information from the optimization passes.
5808 @item stats
5809 Enable dumping various statistics about the pass (not honored by every dump
5810 option).
5811 @item blocks
5812 Enable showing basic block boundaries (disabled in raw dumps).
5813 @item vops
5814 Enable showing virtual operands for every statement.
5815 @item lineno
5816 Enable showing line numbers for statements.
5817 @item uid
5818 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5819 @item verbose
5820 Enable showing the tree dump for each statement.
5821 @item eh
5822 Enable showing the EH region number holding each statement.
5823 @item scev
5824 Enable showing scalar evolution analysis details.
5825 @item optimized
5826 Enable showing optimization information (only available in certain
5827 passes).
5828 @item missed
5829 Enable showing missed optimization information (only available in certain
5830 passes).
5831 @item notes
5832 Enable other detailed optimization information (only available in
5833 certain passes).
5834 @item =@var{filename}
5835 Instead of an auto named dump file, output into the given file
5836 name. The file names @file{stdout} and @file{stderr} are treated
5837 specially and are considered already open standard streams. For
5838 example,
5840 @smallexample
5841 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
5842      -fdump-tree-pre=stderr file.c
5843 @end smallexample
5845 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
5846 output on to @file{stderr}. If two conflicting dump filenames are
5847 given for the same pass, then the latter option overrides the earlier
5848 one.
5850 @item all
5851 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5852 and @option{lineno}.
5854 @item optall
5855 Turn on all optimization options, i.e., @option{optimized},
5856 @option{missed}, and @option{note}.
5857 @end table
5859 The following tree dumps are possible:
5860 @table @samp
5862 @item original
5863 @opindex fdump-tree-original
5864 Dump before any tree based optimization, to @file{@var{file}.original}.
5866 @item optimized
5867 @opindex fdump-tree-optimized
5868 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5870 @item gimple
5871 @opindex fdump-tree-gimple
5872 Dump each function before and after the gimplification pass to a file.  The
5873 file name is made by appending @file{.gimple} to the source file name.
5875 @item cfg
5876 @opindex fdump-tree-cfg
5877 Dump the control flow graph of each function to a file.  The file name is
5878 made by appending @file{.cfg} to the source file name.
5880 @item vcg
5881 @opindex fdump-tree-vcg
5882 Dump the control flow graph of each function to a file in VCG format.  The
5883 file name is made by appending @file{.vcg} to the source file name.  Note
5884 that if the file contains more than one function, the generated file cannot
5885 be used directly by VCG@.  You must cut and paste each function's
5886 graph into its own separate file first.
5888 @item ch
5889 @opindex fdump-tree-ch
5890 Dump each function after copying loop headers.  The file name is made by
5891 appending @file{.ch} to the source file name.
5893 @item ssa
5894 @opindex fdump-tree-ssa
5895 Dump SSA related information to a file.  The file name is made by appending
5896 @file{.ssa} to the source file name.
5898 @item alias
5899 @opindex fdump-tree-alias
5900 Dump aliasing information for each function.  The file name is made by
5901 appending @file{.alias} to the source file name.
5903 @item ccp
5904 @opindex fdump-tree-ccp
5905 Dump each function after CCP@.  The file name is made by appending
5906 @file{.ccp} to the source file name.
5908 @item storeccp
5909 @opindex fdump-tree-storeccp
5910 Dump each function after STORE-CCP@.  The file name is made by appending
5911 @file{.storeccp} to the source file name.
5913 @item pre
5914 @opindex fdump-tree-pre
5915 Dump trees after partial redundancy elimination.  The file name is made
5916 by appending @file{.pre} to the source file name.
5918 @item fre
5919 @opindex fdump-tree-fre
5920 Dump trees after full redundancy elimination.  The file name is made
5921 by appending @file{.fre} to the source file name.
5923 @item copyprop
5924 @opindex fdump-tree-copyprop
5925 Dump trees after copy propagation.  The file name is made
5926 by appending @file{.copyprop} to the source file name.
5928 @item store_copyprop
5929 @opindex fdump-tree-store_copyprop
5930 Dump trees after store copy-propagation.  The file name is made
5931 by appending @file{.store_copyprop} to the source file name.
5933 @item dce
5934 @opindex fdump-tree-dce
5935 Dump each function after dead code elimination.  The file name is made by
5936 appending @file{.dce} to the source file name.
5938 @item mudflap
5939 @opindex fdump-tree-mudflap
5940 Dump each function after adding mudflap instrumentation.  The file name is
5941 made by appending @file{.mudflap} to the source file name.
5943 @item sra
5944 @opindex fdump-tree-sra
5945 Dump each function after performing scalar replacement of aggregates.  The
5946 file name is made by appending @file{.sra} to the source file name.
5948 @item sink
5949 @opindex fdump-tree-sink
5950 Dump each function after performing code sinking.  The file name is made
5951 by appending @file{.sink} to the source file name.
5953 @item dom
5954 @opindex fdump-tree-dom
5955 Dump each function after applying dominator tree optimizations.  The file
5956 name is made by appending @file{.dom} to the source file name.
5958 @item dse
5959 @opindex fdump-tree-dse
5960 Dump each function after applying dead store elimination.  The file
5961 name is made by appending @file{.dse} to the source file name.
5963 @item phiopt
5964 @opindex fdump-tree-phiopt
5965 Dump each function after optimizing PHI nodes into straightline code.  The file
5966 name is made by appending @file{.phiopt} to the source file name.
5968 @item forwprop
5969 @opindex fdump-tree-forwprop
5970 Dump each function after forward propagating single use variables.  The file
5971 name is made by appending @file{.forwprop} to the source file name.
5973 @item copyrename
5974 @opindex fdump-tree-copyrename
5975 Dump each function after applying the copy rename optimization.  The file
5976 name is made by appending @file{.copyrename} to the source file name.
5978 @item nrv
5979 @opindex fdump-tree-nrv
5980 Dump each function after applying the named return value optimization on
5981 generic trees.  The file name is made by appending @file{.nrv} to the source
5982 file name.
5984 @item vect
5985 @opindex fdump-tree-vect
5986 Dump each function after applying vectorization of loops.  The file name is
5987 made by appending @file{.vect} to the source file name.
5989 @item slp
5990 @opindex fdump-tree-slp
5991 Dump each function after applying vectorization of basic blocks.  The file name
5992 is made by appending @file{.slp} to the source file name.
5994 @item vrp
5995 @opindex fdump-tree-vrp
5996 Dump each function after Value Range Propagation (VRP).  The file name
5997 is made by appending @file{.vrp} to the source file name.
5999 @item all
6000 @opindex fdump-tree-all
6001 Enable all the available tree dumps with the flags provided in this option.
6002 @end table
6004 @item -fopt-info
6005 @itemx -fopt-info-@var{options}
6006 @itemx -fopt-info-@var{options}=@var{filename}
6007 @opindex fopt-info
6008 Controls optimization dumps from all the passes. If the
6009 @samp{-@var{options}} form is used, @var{options} is a list of
6010 @samp{-} separated options to control the dump details.  If
6011 @var{options} is not specified, it defaults to @option{optall}. If the
6012 @var{filename} is not specified, it defaults to @file{stderr}. Note
6013 that the output @var{filename} will be overwritten in case of multiple
6014 translation units. If a combined output from multiple translation
6015 units is desired, @file{stderr} should be used instead.
6017 The following options are available
6019 @table @samp
6020 @item optimized
6021 Print information when an optimization is successfully applied. It is
6022 up to a pass to decide which information is relevant. For example, the
6023 vectorizer pass prints the location of loop which got vectorized.
6024 @item missed
6025 Print information about missed optimizations. Individual passes
6026 control which information to include in the output. For example,
6028 @smallexample
6029 gcc -O2 -ftree-vectorize -fopt-info-missed
6030 @end smallexample
6032 will print information about missed optimization opportunities on
6033 stderr.
6034 @item note
6035 Print verbose information about optimizations, such as certain
6036 transformations, more detailed messages about decisions etc.
6037 @item optall
6038 Print detailed optimization information. This includes
6039 @var{optimized}, @var{missed}, and @var{note}. For example,
6041 @smallexample
6042 gcc -O2 -ftree-vectorize -fopt-info-optall=opt.all
6043 @end smallexample
6045 outputs detailed optimization report from all the passes into
6046 @file{opt.all}.
6047 @end table
6049 It applies the dump options to all the passes. If the @var{filename}
6050 is provided, the dump from all the passes is concatenated, otherwise
6051 the dump is output onto @file{stderr}. If @var{options} is omitted, it
6052 defaults to @option{optall}.
6054 @smallexample
6055 gcc -O3 -fopt-info-optimized-missed=optdump.txt
6056 @end smallexample
6058 This will output information about missed optimizations as well as
6059 optimized locations from all the passes into @file{optdump.txt}.
6061 @item -ftree-vectorizer-verbose=@var{n}
6062 @opindex ftree-vectorizer-verbose
6063 This option is deprecated and is implemented in terms of
6064 @option{-fopt-info}. Please use @option{-fopt-info-@var{kind}} form
6065 instead, where @var{kind} is one of the valid opt-info options. It
6066 prints additional optimization information.  For @var{n}=0 no
6067 diagnostic information is reported.  If @var{n}=1 the vectorizer
6068 reports each loop that got vectorized, and the total number of loops
6069 that got vectorized.  If @var{n}=2 the vectorizer reports locations
6070 which could not be vectorized and the reasons for those. For any
6071 higher verbosity levels all the analysis and transformation
6072 information from the vectorizer is reported.
6074 Note that the information output by @option{-ftree-vectorizer-verbose}
6075 option is sent to @file{stderr}. If the equivalent form
6076 @option{-fopt-info-@var{options}=@var{filename}} is used then the
6077 output is sent into @var{filename} instead.
6079 @item -frandom-seed=@var{string}
6080 @opindex frandom-seed
6081 This option provides a seed that GCC uses in place of
6082 random numbers in generating certain symbol names
6083 that have to be different in every compiled file.  It is also used to
6084 place unique stamps in coverage data files and the object files that
6085 produce them.  You can use the @option{-frandom-seed} option to produce
6086 reproducibly identical object files.
6088 The @var{string} should be different for every file you compile.
6090 @item -fsched-verbose=@var{n}
6091 @opindex fsched-verbose
6092 On targets that use instruction scheduling, this option controls the
6093 amount of debugging output the scheduler prints.  This information is
6094 written to standard error, unless @option{-fdump-rtl-sched1} or
6095 @option{-fdump-rtl-sched2} is specified, in which case it is output
6096 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6097 respectively.  However for @var{n} greater than nine, the output is
6098 always printed to standard error.
6100 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6101 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6102 For @var{n} greater than one, it also output basic block probabilities,
6103 detailed ready list information and unit/insn info.  For @var{n} greater
6104 than two, it includes RTL at abort point, control-flow and regions info.
6105 And for @var{n} over four, @option{-fsched-verbose} also includes
6106 dependence info.
6108 @item -save-temps
6109 @itemx -save-temps=cwd
6110 @opindex save-temps
6111 Store the usual ``temporary'' intermediate files permanently; place them
6112 in the current directory and name them based on the source file.  Thus,
6113 compiling @file{foo.c} with @option{-c -save-temps} produces files
6114 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6115 preprocessed @file{foo.i} output file even though the compiler now
6116 normally uses an integrated preprocessor.
6118 When used in combination with the @option{-x} command-line option,
6119 @option{-save-temps} is sensible enough to avoid over writing an
6120 input source file with the same extension as an intermediate file.
6121 The corresponding intermediate file may be obtained by renaming the
6122 source file before using @option{-save-temps}.
6124 If you invoke GCC in parallel, compiling several different source
6125 files that share a common base name in different subdirectories or the
6126 same source file compiled for multiple output destinations, it is
6127 likely that the different parallel compilers will interfere with each
6128 other, and overwrite the temporary files.  For instance:
6130 @smallexample
6131 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6132 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6133 @end smallexample
6135 may result in @file{foo.i} and @file{foo.o} being written to
6136 simultaneously by both compilers.
6138 @item -save-temps=obj
6139 @opindex save-temps=obj
6140 Store the usual ``temporary'' intermediate files permanently.  If the
6141 @option{-o} option is used, the temporary files are based on the
6142 object file.  If the @option{-o} option is not used, the
6143 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6145 For example:
6147 @smallexample
6148 gcc -save-temps=obj -c foo.c
6149 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6150 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6151 @end smallexample
6153 @noindent
6154 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6155 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6156 @file{dir2/yfoobar.o}.
6158 @item -time@r{[}=@var{file}@r{]}
6159 @opindex time
6160 Report the CPU time taken by each subprocess in the compilation
6161 sequence.  For C source files, this is the compiler proper and assembler
6162 (plus the linker if linking is done).
6164 Without the specification of an output file, the output looks like this:
6166 @smallexample
6167 # cc1 0.12 0.01
6168 # as 0.00 0.01
6169 @end smallexample
6171 The first number on each line is the ``user time'', that is time spent
6172 executing the program itself.  The second number is ``system time'',
6173 time spent executing operating system routines on behalf of the program.
6174 Both numbers are in seconds.
6176 With the specification of an output file, the output is appended to the
6177 named file, and it looks like this:
6179 @smallexample
6180 0.12 0.01 cc1 @var{options}
6181 0.00 0.01 as @var{options}
6182 @end smallexample
6184 The ``user time'' and the ``system time'' are moved before the program
6185 name, and the options passed to the program are displayed, so that one
6186 can later tell what file was being compiled, and with which options.
6188 @item -fvar-tracking
6189 @opindex fvar-tracking
6190 Run variable tracking pass.  It computes where variables are stored at each
6191 position in code.  Better debugging information is then generated
6192 (if the debugging information format supports this information).
6194 It is enabled by default when compiling with optimization (@option{-Os},
6195 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6196 the debug info format supports it.
6198 @item -fvar-tracking-assignments
6199 @opindex fvar-tracking-assignments
6200 @opindex fno-var-tracking-assignments
6201 Annotate assignments to user variables early in the compilation and
6202 attempt to carry the annotations over throughout the compilation all the
6203 way to the end, in an attempt to improve debug information while
6204 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6206 It can be enabled even if var-tracking is disabled, in which case
6207 annotations are created and maintained, but discarded at the end.
6209 @item -fvar-tracking-assignments-toggle
6210 @opindex fvar-tracking-assignments-toggle
6211 @opindex fno-var-tracking-assignments-toggle
6212 Toggle @option{-fvar-tracking-assignments}, in the same way that
6213 @option{-gtoggle} toggles @option{-g}.
6215 @item -print-file-name=@var{library}
6216 @opindex print-file-name
6217 Print the full absolute name of the library file @var{library} that
6218 would be used when linking---and don't do anything else.  With this
6219 option, GCC does not compile or link anything; it just prints the
6220 file name.
6222 @item -print-multi-directory
6223 @opindex print-multi-directory
6224 Print the directory name corresponding to the multilib selected by any
6225 other switches present in the command line.  This directory is supposed
6226 to exist in @env{GCC_EXEC_PREFIX}.
6228 @item -print-multi-lib
6229 @opindex print-multi-lib
6230 Print the mapping from multilib directory names to compiler switches
6231 that enable them.  The directory name is separated from the switches by
6232 @samp{;}, and each switch starts with an @samp{@@} instead of the
6233 @samp{-}, without spaces between multiple switches.  This is supposed to
6234 ease shell processing.
6236 @item -print-multi-os-directory
6237 @opindex print-multi-os-directory
6238 Print the path to OS libraries for the selected
6239 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6240 present in the @file{lib} subdirectory and no multilibs are used, this is
6241 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6242 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6243 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6244 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6246 @item -print-prog-name=@var{program}
6247 @opindex print-prog-name
6248 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6250 @item -print-libgcc-file-name
6251 @opindex print-libgcc-file-name
6252 Same as @option{-print-file-name=libgcc.a}.
6254 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6255 but you do want to link with @file{libgcc.a}.  You can do:
6257 @smallexample
6258 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6259 @end smallexample
6261 @item -print-search-dirs
6262 @opindex print-search-dirs
6263 Print the name of the configured installation directory and a list of
6264 program and library directories @command{gcc} searches---and don't do anything else.
6266 This is useful when @command{gcc} prints the error message
6267 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6268 To resolve this you either need to put @file{cpp0} and the other compiler
6269 components where @command{gcc} expects to find them, or you can set the environment
6270 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6271 Don't forget the trailing @samp{/}.
6272 @xref{Environment Variables}.
6274 @item -print-sysroot
6275 @opindex print-sysroot
6276 Print the target sysroot directory that is used during
6277 compilation.  This is the target sysroot specified either at configure
6278 time or using the @option{--sysroot} option, possibly with an extra
6279 suffix that depends on compilation options.  If no target sysroot is
6280 specified, the option prints nothing.
6282 @item -print-sysroot-headers-suffix
6283 @opindex print-sysroot-headers-suffix
6284 Print the suffix added to the target sysroot when searching for
6285 headers, or give an error if the compiler is not configured with such
6286 a suffix---and don't do anything else.
6288 @item -dumpmachine
6289 @opindex dumpmachine
6290 Print the compiler's target machine (for example,
6291 @samp{i686-pc-linux-gnu})---and don't do anything else.
6293 @item -dumpversion
6294 @opindex dumpversion
6295 Print the compiler version (for example, @samp{3.0})---and don't do
6296 anything else.
6298 @item -dumpspecs
6299 @opindex dumpspecs
6300 Print the compiler's built-in specs---and don't do anything else.  (This
6301 is used when GCC itself is being built.)  @xref{Spec Files}.
6303 @item -fno-eliminate-unused-debug-types
6304 @opindex feliminate-unused-debug-types
6305 @opindex fno-eliminate-unused-debug-types
6306 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
6307 output for types that are nowhere used in the source file being compiled.
6308 Sometimes it is useful to have GCC emit debugging
6309 information for all types declared in a compilation
6310 unit, regardless of whether or not they are actually used
6311 in that compilation unit, for example 
6312 if, in the debugger, you want to cast a value to a type that is
6313 not actually used in your program (but is declared).  More often,
6314 however, this results in a significant amount of wasted space.
6315 @end table
6317 @node Optimize Options
6318 @section Options That Control Optimization
6319 @cindex optimize options
6320 @cindex options, optimization
6322 These options control various sorts of optimizations.
6324 Without any optimization option, the compiler's goal is to reduce the
6325 cost of compilation and to make debugging produce the expected
6326 results.  Statements are independent: if you stop the program with a
6327 breakpoint between statements, you can then assign a new value to any
6328 variable or change the program counter to any other statement in the
6329 function and get exactly the results you expect from the source
6330 code.
6332 Turning on optimization flags makes the compiler attempt to improve
6333 the performance and/or code size at the expense of compilation time
6334 and possibly the ability to debug the program.
6336 The compiler performs optimization based on the knowledge it has of the
6337 program.  Compiling multiple files at once to a single output file mode allows
6338 the compiler to use information gained from all of the files when compiling
6339 each of them.
6341 Not all optimizations are controlled directly by a flag.  Only
6342 optimizations that have a flag are listed in this section.
6344 Most optimizations are only enabled if an @option{-O} level is set on
6345 the command line.  Otherwise they are disabled, even if individual
6346 optimization flags are specified.
6348 Depending on the target and how GCC was configured, a slightly different
6349 set of optimizations may be enabled at each @option{-O} level than
6350 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6351 to find out the exact set of optimizations that are enabled at each level.
6352 @xref{Overall Options}, for examples.
6354 @table @gcctabopt
6355 @item -O
6356 @itemx -O1
6357 @opindex O
6358 @opindex O1
6359 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6360 more memory for a large function.
6362 With @option{-O}, the compiler tries to reduce code size and execution
6363 time, without performing any optimizations that take a great deal of
6364 compilation time.
6366 @option{-O} turns on the following optimization flags:
6367 @gccoptlist{
6368 -fauto-inc-dec @gol
6369 -fcompare-elim @gol
6370 -fcprop-registers @gol
6371 -fdce @gol
6372 -fdefer-pop @gol
6373 -fdelayed-branch @gol
6374 -fdse @gol
6375 -fguess-branch-probability @gol
6376 -fif-conversion2 @gol
6377 -fif-conversion @gol
6378 -fipa-pure-const @gol
6379 -fipa-profile @gol
6380 -fipa-reference @gol
6381 -fmerge-constants
6382 -fsplit-wide-types @gol
6383 -ftree-bit-ccp @gol
6384 -ftree-builtin-call-dce @gol
6385 -ftree-ccp @gol
6386 -ftree-ch @gol
6387 -ftree-copyrename @gol
6388 -ftree-dce @gol
6389 -ftree-dominator-opts @gol
6390 -ftree-dse @gol
6391 -ftree-forwprop @gol
6392 -ftree-fre @gol
6393 -ftree-phiprop @gol
6394 -ftree-slsr @gol
6395 -ftree-sra @gol
6396 -ftree-pta @gol
6397 -ftree-ter @gol
6398 -funit-at-a-time}
6400 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6401 where doing so does not interfere with debugging.
6403 @item -O2
6404 @opindex O2
6405 Optimize even more.  GCC performs nearly all supported optimizations
6406 that do not involve a space-speed tradeoff.
6407 As compared to @option{-O}, this option increases both compilation time
6408 and the performance of the generated code.
6410 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6411 also turns on the following optimization flags:
6412 @gccoptlist{-fthread-jumps @gol
6413 -falign-functions  -falign-jumps @gol
6414 -falign-loops  -falign-labels @gol
6415 -fcaller-saves @gol
6416 -fcrossjumping @gol
6417 -fcse-follow-jumps  -fcse-skip-blocks @gol
6418 -fdelete-null-pointer-checks @gol
6419 -fdevirtualize @gol
6420 -fexpensive-optimizations @gol
6421 -fgcse  -fgcse-lm  @gol
6422 -fhoist-adjacent-loads @gol
6423 -finline-small-functions @gol
6424 -findirect-inlining @gol
6425 -fipa-sra @gol
6426 -foptimize-sibling-calls @gol
6427 -fpartial-inlining @gol
6428 -fpeephole2 @gol
6429 -fregmove @gol
6430 -freorder-blocks  -freorder-functions @gol
6431 -frerun-cse-after-loop  @gol
6432 -fsched-interblock  -fsched-spec @gol
6433 -fschedule-insns  -fschedule-insns2 @gol
6434 -fstrict-aliasing -fstrict-overflow @gol
6435 -ftree-switch-conversion -ftree-tail-merge @gol
6436 -ftree-pre @gol
6437 -ftree-vrp}
6439 Please note the warning under @option{-fgcse} about
6440 invoking @option{-O2} on programs that use computed gotos.
6442 @item -O3
6443 @opindex O3
6444 Optimize yet more.  @option{-O3} turns on all optimizations specified
6445 by @option{-O2} and also turns on the @option{-finline-functions},
6446 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6447 @option{-fgcse-after-reload}, @option{-ftree-vectorize},
6448 @option{-fvect-cost-model},
6449 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6451 @item -O0
6452 @opindex O0
6453 Reduce compilation time and make debugging produce the expected
6454 results.  This is the default.
6456 @item -Os
6457 @opindex Os
6458 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6459 do not typically increase code size.  It also performs further
6460 optimizations designed to reduce code size.
6462 @option{-Os} disables the following optimization flags:
6463 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6464 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6465 -fprefetch-loop-arrays  -ftree-vect-loop-version}
6467 @item -Ofast
6468 @opindex Ofast
6469 Disregard strict standards compliance.  @option{-Ofast} enables all
6470 @option{-O3} optimizations.  It also enables optimizations that are not
6471 valid for all standard-compliant programs.
6472 It turns on @option{-ffast-math} and the Fortran-specific
6473 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6475 @item -Og
6476 @opindex Og
6477 Optimize debugging experience.  @option{-Og} enables optimizations
6478 that do not interfere with debugging. It should be the optimization
6479 level of choice for the standard edit-compile-debug cycle, offering
6480 a reasonable level of optimization while maintaining fast compilation
6481 and a good debugging experience.
6483 If you use multiple @option{-O} options, with or without level numbers,
6484 the last such option is the one that is effective.
6485 @end table
6487 Options of the form @option{-f@var{flag}} specify machine-independent
6488 flags.  Most flags have both positive and negative forms; the negative
6489 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6490 below, only one of the forms is listed---the one you typically 
6491 use.  You can figure out the other form by either removing @samp{no-}
6492 or adding it.
6494 The following options control specific optimizations.  They are either
6495 activated by @option{-O} options or are related to ones that are.  You
6496 can use the following flags in the rare cases when ``fine-tuning'' of
6497 optimizations to be performed is desired.
6499 @table @gcctabopt
6500 @item -fno-default-inline
6501 @opindex fno-default-inline
6502 Do not make member functions inline by default merely because they are
6503 defined inside the class scope (C++ only).  Otherwise, when you specify
6504 @w{@option{-O}}, member functions defined inside class scope are compiled
6505 inline by default; i.e., you don't need to add @samp{inline} in front of
6506 the member function name.
6508 @item -fno-defer-pop
6509 @opindex fno-defer-pop
6510 Always pop the arguments to each function call as soon as that function
6511 returns.  For machines that must pop arguments after a function call,
6512 the compiler normally lets arguments accumulate on the stack for several
6513 function calls and pops them all at once.
6515 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6517 @item -fforward-propagate
6518 @opindex fforward-propagate
6519 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6520 instructions and checks if the result can be simplified.  If loop unrolling
6521 is active, two passes are performed and the second is scheduled after
6522 loop unrolling.
6524 This option is enabled by default at optimization levels @option{-O},
6525 @option{-O2}, @option{-O3}, @option{-Os}.
6527 @item -ffp-contract=@var{style}
6528 @opindex ffp-contract
6529 @option{-ffp-contract=off} disables floating-point expression contraction.
6530 @option{-ffp-contract=fast} enables floating-point expression contraction
6531 such as forming of fused multiply-add operations if the target has
6532 native support for them.
6533 @option{-ffp-contract=on} enables floating-point expression contraction
6534 if allowed by the language standard.  This is currently not implemented
6535 and treated equal to @option{-ffp-contract=off}.
6537 The default is @option{-ffp-contract=fast}.
6539 @item -fomit-frame-pointer
6540 @opindex fomit-frame-pointer
6541 Don't keep the frame pointer in a register for functions that
6542 don't need one.  This avoids the instructions to save, set up and
6543 restore frame pointers; it also makes an extra register available
6544 in many functions.  @strong{It also makes debugging impossible on
6545 some machines.}
6547 On some machines, such as the VAX, this flag has no effect, because
6548 the standard calling sequence automatically handles the frame pointer
6549 and nothing is saved by pretending it doesn't exist.  The
6550 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6551 whether a target machine supports this flag.  @xref{Registers,,Register
6552 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6554 Starting with GCC version 4.6, the default setting (when not optimizing for
6555 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6556 @option{-fomit-frame-pointer}.  The default can be reverted to
6557 @option{-fno-omit-frame-pointer} by configuring GCC with the
6558 @option{--enable-frame-pointer} configure option.
6560 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6562 @item -foptimize-sibling-calls
6563 @opindex foptimize-sibling-calls
6564 Optimize sibling and tail recursive calls.
6566 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6568 @item -fno-inline
6569 @opindex fno-inline
6570 Do not expand any functions inline apart from those marked with
6571 the @code{always_inline} attribute.  This is the default when not
6572 optimizing.
6574 Single functions can be exempted from inlining by marking them
6575 with the @code{noinline} attribute.
6577 @item -finline-small-functions
6578 @opindex finline-small-functions
6579 Integrate functions into their callers when their body is smaller than expected
6580 function call code (so overall size of program gets smaller).  The compiler
6581 heuristically decides which functions are simple enough to be worth integrating
6582 in this way.  This inlining applies to all functions, even those not declared
6583 inline.
6585 Enabled at level @option{-O2}.
6587 @item -findirect-inlining
6588 @opindex findirect-inlining
6589 Inline also indirect calls that are discovered to be known at compile
6590 time thanks to previous inlining.  This option has any effect only
6591 when inlining itself is turned on by the @option{-finline-functions}
6592 or @option{-finline-small-functions} options.
6594 Enabled at level @option{-O2}.
6596 @item -finline-functions
6597 @opindex finline-functions
6598 Consider all functions for inlining, even if they are not declared inline.
6599 The compiler heuristically decides which functions are worth integrating
6600 in this way.
6602 If all calls to a given function are integrated, and the function is
6603 declared @code{static}, then the function is normally not output as
6604 assembler code in its own right.
6606 Enabled at level @option{-O3}.
6608 @item -finline-functions-called-once
6609 @opindex finline-functions-called-once
6610 Consider all @code{static} functions called once for inlining into their
6611 caller even if they are not marked @code{inline}.  If a call to a given
6612 function is integrated, then the function is not output as assembler code
6613 in its own right.
6615 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6617 @item -fearly-inlining
6618 @opindex fearly-inlining
6619 Inline functions marked by @code{always_inline} and functions whose body seems
6620 smaller than the function call overhead early before doing
6621 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6622 makes profiling significantly cheaper and usually inlining faster on programs
6623 having large chains of nested wrapper functions.
6625 Enabled by default.
6627 @item -fipa-sra
6628 @opindex fipa-sra
6629 Perform interprocedural scalar replacement of aggregates, removal of
6630 unused parameters and replacement of parameters passed by reference
6631 by parameters passed by value.
6633 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6635 @item -finline-limit=@var{n}
6636 @opindex finline-limit
6637 By default, GCC limits the size of functions that can be inlined.  This flag
6638 allows coarse control of this limit.  @var{n} is the size of functions that
6639 can be inlined in number of pseudo instructions.
6641 Inlining is actually controlled by a number of parameters, which may be
6642 specified individually by using @option{--param @var{name}=@var{value}}.
6643 The @option{-finline-limit=@var{n}} option sets some of these parameters
6644 as follows:
6646 @table @gcctabopt
6647 @item max-inline-insns-single
6648 is set to @var{n}/2.
6649 @item max-inline-insns-auto
6650 is set to @var{n}/2.
6651 @end table
6653 See below for a documentation of the individual
6654 parameters controlling inlining and for the defaults of these parameters.
6656 @emph{Note:} there may be no value to @option{-finline-limit} that results
6657 in default behavior.
6659 @emph{Note:} pseudo instruction represents, in this particular context, an
6660 abstract measurement of function's size.  In no way does it represent a count
6661 of assembly instructions and as such its exact meaning might change from one
6662 release to an another.
6664 @item -fno-keep-inline-dllexport
6665 @opindex -fno-keep-inline-dllexport
6666 This is a more fine-grained version of @option{-fkeep-inline-functions},
6667 which applies only to functions that are declared using the @code{dllexport}
6668 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6669 Functions}.)
6671 @item -fkeep-inline-functions
6672 @opindex fkeep-inline-functions
6673 In C, emit @code{static} functions that are declared @code{inline}
6674 into the object file, even if the function has been inlined into all
6675 of its callers.  This switch does not affect functions using the
6676 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6677 inline functions into the object file.
6679 @item -fkeep-static-consts
6680 @opindex fkeep-static-consts
6681 Emit variables declared @code{static const} when optimization isn't turned
6682 on, even if the variables aren't referenced.
6684 GCC enables this option by default.  If you want to force the compiler to
6685 check if a variable is referenced, regardless of whether or not
6686 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6688 @item -fmerge-constants
6689 @opindex fmerge-constants
6690 Attempt to merge identical constants (string constants and floating-point
6691 constants) across compilation units.
6693 This option is the default for optimized compilation if the assembler and
6694 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6695 behavior.
6697 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6699 @item -fmerge-all-constants
6700 @opindex fmerge-all-constants
6701 Attempt to merge identical constants and identical variables.
6703 This option implies @option{-fmerge-constants}.  In addition to
6704 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6705 arrays or initialized constant variables with integral or floating-point
6706 types.  Languages like C or C++ require each variable, including multiple
6707 instances of the same variable in recursive calls, to have distinct locations,
6708 so using this option results in non-conforming
6709 behavior.
6711 @item -fmodulo-sched
6712 @opindex fmodulo-sched
6713 Perform swing modulo scheduling immediately before the first scheduling
6714 pass.  This pass looks at innermost loops and reorders their
6715 instructions by overlapping different iterations.
6717 @item -fmodulo-sched-allow-regmoves
6718 @opindex fmodulo-sched-allow-regmoves
6719 Perform more aggressive SMS-based modulo scheduling with register moves
6720 allowed.  By setting this flag certain anti-dependences edges are
6721 deleted, which triggers the generation of reg-moves based on the
6722 life-range analysis.  This option is effective only with
6723 @option{-fmodulo-sched} enabled.
6725 @item -fno-branch-count-reg
6726 @opindex fno-branch-count-reg
6727 Do not use ``decrement and branch'' instructions on a count register,
6728 but instead generate a sequence of instructions that decrement a
6729 register, compare it against zero, then branch based upon the result.
6730 This option is only meaningful on architectures that support such
6731 instructions, which include x86, PowerPC, IA-64 and S/390.
6733 The default is @option{-fbranch-count-reg}.
6735 @item -fno-function-cse
6736 @opindex fno-function-cse
6737 Do not put function addresses in registers; make each instruction that
6738 calls a constant function contain the function's address explicitly.
6740 This option results in less efficient code, but some strange hacks
6741 that alter the assembler output may be confused by the optimizations
6742 performed when this option is not used.
6744 The default is @option{-ffunction-cse}
6746 @item -fno-zero-initialized-in-bss
6747 @opindex fno-zero-initialized-in-bss
6748 If the target supports a BSS section, GCC by default puts variables that
6749 are initialized to zero into BSS@.  This can save space in the resulting
6750 code.
6752 This option turns off this behavior because some programs explicitly
6753 rely on variables going to the data section---e.g., so that the
6754 resulting executable can find the beginning of that section and/or make
6755 assumptions based on that.
6757 The default is @option{-fzero-initialized-in-bss}.
6759 @item -fmudflap -fmudflapth -fmudflapir
6760 @opindex fmudflap
6761 @opindex fmudflapth
6762 @opindex fmudflapir
6763 @cindex bounds checking
6764 @cindex mudflap
6765 For front-ends that support it (C and C++), instrument all risky
6766 pointer/array dereferencing operations, some standard library
6767 string/heap functions, and some other associated constructs with
6768 range/validity tests.  Modules so instrumented should be immune to
6769 buffer overflows, invalid heap use, and some other classes of C/C++
6770 programming errors.  The instrumentation relies on a separate runtime
6771 library (@file{libmudflap}), which is linked into a program if
6772 @option{-fmudflap} is given at link time.  Run-time behavior of the
6773 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6774 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6775 for its options.
6777 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6778 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6779 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6780 instrumentation should ignore pointer reads.  This produces less
6781 instrumentation (and therefore faster execution) and still provides
6782 some protection against outright memory corrupting writes, but allows
6783 erroneously read data to propagate within a program.
6785 @item -fthread-jumps
6786 @opindex fthread-jumps
6787 Perform optimizations that check to see if a jump branches to a
6788 location where another comparison subsumed by the first is found.  If
6789 so, the first branch is redirected to either the destination of the
6790 second branch or a point immediately following it, depending on whether
6791 the condition is known to be true or false.
6793 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6795 @item -fsplit-wide-types
6796 @opindex fsplit-wide-types
6797 When using a type that occupies multiple registers, such as @code{long
6798 long} on a 32-bit system, split the registers apart and allocate them
6799 independently.  This normally generates better code for those types,
6800 but may make debugging more difficult.
6802 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6803 @option{-Os}.
6805 @item -fcse-follow-jumps
6806 @opindex fcse-follow-jumps
6807 In common subexpression elimination (CSE), scan through jump instructions
6808 when the target of the jump is not reached by any other path.  For
6809 example, when CSE encounters an @code{if} statement with an
6810 @code{else} clause, CSE follows the jump when the condition
6811 tested is false.
6813 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6815 @item -fcse-skip-blocks
6816 @opindex fcse-skip-blocks
6817 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6818 follow jumps that conditionally skip over blocks.  When CSE
6819 encounters a simple @code{if} statement with no else clause,
6820 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6821 body of the @code{if}.
6823 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6825 @item -frerun-cse-after-loop
6826 @opindex frerun-cse-after-loop
6827 Re-run common subexpression elimination after loop optimizations are
6828 performed.
6830 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6832 @item -fgcse
6833 @opindex fgcse
6834 Perform a global common subexpression elimination pass.
6835 This pass also performs global constant and copy propagation.
6837 @emph{Note:} When compiling a program using computed gotos, a GCC
6838 extension, you may get better run-time performance if you disable
6839 the global common subexpression elimination pass by adding
6840 @option{-fno-gcse} to the command line.
6842 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6844 @item -fgcse-lm
6845 @opindex fgcse-lm
6846 When @option{-fgcse-lm} is enabled, global common subexpression elimination
6847 attempts to move loads that are only killed by stores into themselves.  This
6848 allows a loop containing a load/store sequence to be changed to a load outside
6849 the loop, and a copy/store within the loop.
6851 Enabled by default when @option{-fgcse} is enabled.
6853 @item -fgcse-sm
6854 @opindex fgcse-sm
6855 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6856 global common subexpression elimination.  This pass attempts to move
6857 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6858 loops containing a load/store sequence can be changed to a load before
6859 the loop and a store after the loop.
6861 Not enabled at any optimization level.
6863 @item -fgcse-las
6864 @opindex fgcse-las
6865 When @option{-fgcse-las} is enabled, the global common subexpression
6866 elimination pass eliminates redundant loads that come after stores to the
6867 same memory location (both partial and full redundancies).
6869 Not enabled at any optimization level.
6871 @item -fgcse-after-reload
6872 @opindex fgcse-after-reload
6873 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6874 pass is performed after reload.  The purpose of this pass is to clean up
6875 redundant spilling.
6877 @item -funsafe-loop-optimizations
6878 @opindex funsafe-loop-optimizations
6879 This option tells the loop optimizer to assume that loop indices do not
6880 overflow, and that loops with nontrivial exit condition are not
6881 infinite.  This enables a wider range of loop optimizations even if
6882 the loop optimizer itself cannot prove that these assumptions are valid.
6883 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
6884 if it finds this kind of loop.
6886 @item -fcrossjumping
6887 @opindex fcrossjumping
6888 Perform cross-jumping transformation.
6889 This transformation unifies equivalent code and saves code size.  The
6890 resulting code may or may not perform better than without cross-jumping.
6892 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6894 @item -fauto-inc-dec
6895 @opindex fauto-inc-dec
6896 Combine increments or decrements of addresses with memory accesses.
6897 This pass is always skipped on architectures that do not have
6898 instructions to support this.  Enabled by default at @option{-O} and
6899 higher on architectures that support this.
6901 @item -fdce
6902 @opindex fdce
6903 Perform dead code elimination (DCE) on RTL@.
6904 Enabled by default at @option{-O} and higher.
6906 @item -fdse
6907 @opindex fdse
6908 Perform dead store elimination (DSE) on RTL@.
6909 Enabled by default at @option{-O} and higher.
6911 @item -fif-conversion
6912 @opindex fif-conversion
6913 Attempt to transform conditional jumps into branch-less equivalents.  This
6914 includes use of conditional moves, min, max, set flags and abs instructions, and
6915 some tricks doable by standard arithmetics.  The use of conditional execution
6916 on chips where it is available is controlled by @code{if-conversion2}.
6918 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6920 @item -fif-conversion2
6921 @opindex fif-conversion2
6922 Use conditional execution (where available) to transform conditional jumps into
6923 branch-less equivalents.
6925 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6927 @item -fdelete-null-pointer-checks
6928 @opindex fdelete-null-pointer-checks
6929 Assume that programs cannot safely dereference null pointers, and that
6930 no code or data element resides there.  This enables simple constant
6931 folding optimizations at all optimization levels.  In addition, other
6932 optimization passes in GCC use this flag to control global dataflow
6933 analyses that eliminate useless checks for null pointers; these assume
6934 that if a pointer is checked after it has already been dereferenced,
6935 it cannot be null.
6937 Note however that in some environments this assumption is not true.
6938 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6939 for programs that depend on that behavior.
6941 Some targets, especially embedded ones, disable this option at all levels.
6942 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6943 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6944 are enabled independently at different optimization levels.
6946 @item -fdevirtualize
6947 @opindex fdevirtualize
6948 Attempt to convert calls to virtual functions to direct calls.  This
6949 is done both within a procedure and interprocedurally as part of
6950 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
6951 propagation (@option{-fipa-cp}).
6952 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6954 @item -fexpensive-optimizations
6955 @opindex fexpensive-optimizations
6956 Perform a number of minor optimizations that are relatively expensive.
6958 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6960 @item -free
6961 @opindex free
6962 Attempt to remove redundant extension instructions.  This is especially
6963 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
6964 registers after writing to their lower 32-bit half.
6966 Enabled for x86 at levels @option{-O2}, @option{-O3}.
6968 @item -foptimize-register-move
6969 @itemx -fregmove
6970 @opindex foptimize-register-move
6971 @opindex fregmove
6972 Attempt to reassign register numbers in move instructions and as
6973 operands of other simple instructions in order to maximize the amount of
6974 register tying.  This is especially helpful on machines with two-operand
6975 instructions.
6977 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6978 optimization.
6980 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6982 @item -fira-algorithm=@var{algorithm}
6983 Use the specified coloring algorithm for the integrated register
6984 allocator.  The @var{algorithm} argument can be @samp{priority}, which
6985 specifies Chow's priority coloring, or @samp{CB}, which specifies
6986 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
6987 for all architectures, but for those targets that do support it, it is
6988 the default because it generates better code.
6990 @item -fira-region=@var{region}
6991 Use specified regions for the integrated register allocator.  The
6992 @var{region} argument should be one of the following:
6994 @table @samp
6996 @item all
6997 Use all loops as register allocation regions.
6998 This can give the best results for machines with a small and/or
6999 irregular register set.
7001 @item mixed
7002 Use all loops except for loops with small register pressure 
7003 as the regions.  This value usually gives
7004 the best results in most cases and for most architectures,
7005 and is enabled by default when compiling with optimization for speed
7006 (@option{-O}, @option{-O2}, @dots{}).
7008 @item one
7009 Use all functions as a single region.  
7010 This typically results in the smallest code size, and is enabled by default for
7011 @option{-Os} or @option{-O0}.
7013 @end table
7015 @item -fira-hoist-pressure
7016 @opindex fira-hoist-pressure
7017 Use IRA to evaluate register pressure in the code hoisting pass for
7018 decisions to hoist expressions.  This option usually results in smaller
7019 code, but it can slow the compiler down.
7021 This option is enabled at level @option{-Os} for all targets.
7023 @item -fira-loop-pressure
7024 @opindex fira-loop-pressure
7025 Use IRA to evaluate register pressure in loops for decisions to move
7026 loop invariants.  This option usually results in generation
7027 of faster and smaller code on machines with large register files (>= 32
7028 registers), but it can slow the compiler down.
7030 This option is enabled at level @option{-O3} for some targets.
7032 @item -fno-ira-share-save-slots
7033 @opindex fno-ira-share-save-slots
7034 Disable sharing of stack slots used for saving call-used hard
7035 registers living through a call.  Each hard register gets a
7036 separate stack slot, and as a result function stack frames are
7037 larger.
7039 @item -fno-ira-share-spill-slots
7040 @opindex fno-ira-share-spill-slots
7041 Disable sharing of stack slots allocated for pseudo-registers.  Each
7042 pseudo-register that does not get a hard register gets a separate
7043 stack slot, and as a result function stack frames are larger.
7045 @item -fira-verbose=@var{n}
7046 @opindex fira-verbose
7047 Control the verbosity of the dump file for the integrated register allocator.
7048 The default value is 5.  If the value @var{n} is greater or equal to 10,
7049 the dump output is sent to stderr using the same format as @var{n} minus 10.
7051 @item -fdelayed-branch
7052 @opindex fdelayed-branch
7053 If supported for the target machine, attempt to reorder instructions
7054 to exploit instruction slots available after delayed branch
7055 instructions.
7057 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7059 @item -fschedule-insns
7060 @opindex fschedule-insns
7061 If supported for the target machine, attempt to reorder instructions to
7062 eliminate execution stalls due to required data being unavailable.  This
7063 helps machines that have slow floating point or memory load instructions
7064 by allowing other instructions to be issued until the result of the load
7065 or floating-point instruction is required.
7067 Enabled at levels @option{-O2}, @option{-O3}.
7069 @item -fschedule-insns2
7070 @opindex fschedule-insns2
7071 Similar to @option{-fschedule-insns}, but requests an additional pass of
7072 instruction scheduling after register allocation has been done.  This is
7073 especially useful on machines with a relatively small number of
7074 registers and where memory load instructions take more than one cycle.
7076 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7078 @item -fno-sched-interblock
7079 @opindex fno-sched-interblock
7080 Don't schedule instructions across basic blocks.  This is normally
7081 enabled by default when scheduling before register allocation, i.e.@:
7082 with @option{-fschedule-insns} or at @option{-O2} or higher.
7084 @item -fno-sched-spec
7085 @opindex fno-sched-spec
7086 Don't allow speculative motion of non-load instructions.  This is normally
7087 enabled by default when scheduling before register allocation, i.e.@:
7088 with @option{-fschedule-insns} or at @option{-O2} or higher.
7090 @item -fsched-pressure
7091 @opindex fsched-pressure
7092 Enable register pressure sensitive insn scheduling before register
7093 allocation.  This only makes sense when scheduling before register
7094 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7095 @option{-O2} or higher.  Usage of this option can improve the
7096 generated code and decrease its size by preventing register pressure
7097 increase above the number of available hard registers and subsequent
7098 spills in register allocation.
7100 @item -fsched-spec-load
7101 @opindex fsched-spec-load
7102 Allow speculative motion of some load instructions.  This only makes
7103 sense when scheduling before register allocation, i.e.@: with
7104 @option{-fschedule-insns} or at @option{-O2} or higher.
7106 @item -fsched-spec-load-dangerous
7107 @opindex fsched-spec-load-dangerous
7108 Allow speculative motion of more load instructions.  This only makes
7109 sense when scheduling before register allocation, i.e.@: with
7110 @option{-fschedule-insns} or at @option{-O2} or higher.
7112 @item -fsched-stalled-insns
7113 @itemx -fsched-stalled-insns=@var{n}
7114 @opindex fsched-stalled-insns
7115 Define how many insns (if any) can be moved prematurely from the queue
7116 of stalled insns into the ready list during the second scheduling pass.
7117 @option{-fno-sched-stalled-insns} means that no insns are moved
7118 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7119 on how many queued insns can be moved prematurely.
7120 @option{-fsched-stalled-insns} without a value is equivalent to
7121 @option{-fsched-stalled-insns=1}.
7123 @item -fsched-stalled-insns-dep
7124 @itemx -fsched-stalled-insns-dep=@var{n}
7125 @opindex fsched-stalled-insns-dep
7126 Define how many insn groups (cycles) are examined for a dependency
7127 on a stalled insn that is a candidate for premature removal from the queue
7128 of stalled insns.  This has an effect only during the second scheduling pass,
7129 and only if @option{-fsched-stalled-insns} is used.
7130 @option{-fno-sched-stalled-insns-dep} is equivalent to
7131 @option{-fsched-stalled-insns-dep=0}.
7132 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7133 @option{-fsched-stalled-insns-dep=1}.
7135 @item -fsched2-use-superblocks
7136 @opindex fsched2-use-superblocks
7137 When scheduling after register allocation, use superblock scheduling.
7138 This allows motion across basic block boundaries,
7139 resulting in faster schedules.  This option is experimental, as not all machine
7140 descriptions used by GCC model the CPU closely enough to avoid unreliable
7141 results from the algorithm.
7143 This only makes sense when scheduling after register allocation, i.e.@: with
7144 @option{-fschedule-insns2} or at @option{-O2} or higher.
7146 @item -fsched-group-heuristic
7147 @opindex fsched-group-heuristic
7148 Enable the group heuristic in the scheduler.  This heuristic favors
7149 the instruction that belongs to a schedule group.  This is enabled
7150 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7151 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7153 @item -fsched-critical-path-heuristic
7154 @opindex fsched-critical-path-heuristic
7155 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7156 instructions on the critical path.  This is enabled by default when
7157 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7158 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7160 @item -fsched-spec-insn-heuristic
7161 @opindex fsched-spec-insn-heuristic
7162 Enable the speculative instruction heuristic in the scheduler.  This
7163 heuristic favors speculative instructions with greater dependency weakness.
7164 This is enabled by default when scheduling is enabled, i.e.@:
7165 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7166 or at @option{-O2} or higher.
7168 @item -fsched-rank-heuristic
7169 @opindex fsched-rank-heuristic
7170 Enable the rank heuristic in the scheduler.  This heuristic favors
7171 the instruction belonging to a basic block with greater size or frequency.
7172 This is enabled by default when scheduling is enabled, i.e.@:
7173 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7174 at @option{-O2} or higher.
7176 @item -fsched-last-insn-heuristic
7177 @opindex fsched-last-insn-heuristic
7178 Enable the last-instruction heuristic in the scheduler.  This heuristic
7179 favors the instruction that is less dependent on the last instruction
7180 scheduled.  This is enabled by default when scheduling is enabled,
7181 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7182 at @option{-O2} or higher.
7184 @item -fsched-dep-count-heuristic
7185 @opindex fsched-dep-count-heuristic
7186 Enable the dependent-count heuristic in the scheduler.  This heuristic
7187 favors the instruction that has more instructions depending on it.
7188 This is enabled by default when scheduling is enabled, i.e.@:
7189 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7190 at @option{-O2} or higher.
7192 @item -freschedule-modulo-scheduled-loops
7193 @opindex freschedule-modulo-scheduled-loops
7194 Modulo scheduling is performed before traditional scheduling.  If a loop
7195 is modulo scheduled, later scheduling passes may change its schedule.  
7196 Use this option to control that behavior.
7198 @item -fselective-scheduling
7199 @opindex fselective-scheduling
7200 Schedule instructions using selective scheduling algorithm.  Selective
7201 scheduling runs instead of the first scheduler pass.
7203 @item -fselective-scheduling2
7204 @opindex fselective-scheduling2
7205 Schedule instructions using selective scheduling algorithm.  Selective
7206 scheduling runs instead of the second scheduler pass.
7208 @item -fsel-sched-pipelining
7209 @opindex fsel-sched-pipelining
7210 Enable software pipelining of innermost loops during selective scheduling.
7211 This option has no effect unless one of @option{-fselective-scheduling} or
7212 @option{-fselective-scheduling2} is turned on.
7214 @item -fsel-sched-pipelining-outer-loops
7215 @opindex fsel-sched-pipelining-outer-loops
7216 When pipelining loops during selective scheduling, also pipeline outer loops.
7217 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7219 @item -fshrink-wrap
7220 @opindex fshrink-wrap
7221 Emit function prologues only before parts of the function that need it,
7222 rather than at the top of the function.  This flag is enabled by default at
7223 @option{-O} and higher.
7225 @item -fcaller-saves
7226 @opindex fcaller-saves
7227 Enable allocation of values to registers that are clobbered by
7228 function calls, by emitting extra instructions to save and restore the
7229 registers around such calls.  Such allocation is done only when it
7230 seems to result in better code.
7232 This option is always enabled by default on certain machines, usually
7233 those which have no call-preserved registers to use instead.
7235 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7237 @item -fcombine-stack-adjustments
7238 @opindex fcombine-stack-adjustments
7239 Tracks stack adjustments (pushes and pops) and stack memory references
7240 and then tries to find ways to combine them.
7242 Enabled by default at @option{-O1} and higher.
7244 @item -fconserve-stack
7245 @opindex fconserve-stack
7246 Attempt to minimize stack usage.  The compiler attempts to use less
7247 stack space, even if that makes the program slower.  This option
7248 implies setting the @option{large-stack-frame} parameter to 100
7249 and the @option{large-stack-frame-growth} parameter to 400.
7251 @item -ftree-reassoc
7252 @opindex ftree-reassoc
7253 Perform reassociation on trees.  This flag is enabled by default
7254 at @option{-O} and higher.
7256 @item -ftree-pre
7257 @opindex ftree-pre
7258 Perform partial redundancy elimination (PRE) on trees.  This flag is
7259 enabled by default at @option{-O2} and @option{-O3}.
7261 @item -ftree-partial-pre
7262 @opindex ftree-partial-pre
7263 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7264 enabled by default at @option{-O3}.
7266 @item -ftree-forwprop
7267 @opindex ftree-forwprop
7268 Perform forward propagation on trees.  This flag is enabled by default
7269 at @option{-O} and higher.
7271 @item -ftree-fre
7272 @opindex ftree-fre
7273 Perform full redundancy elimination (FRE) on trees.  The difference
7274 between FRE and PRE is that FRE only considers expressions
7275 that are computed on all paths leading to the redundant computation.
7276 This analysis is faster than PRE, though it exposes fewer redundancies.
7277 This flag is enabled by default at @option{-O} and higher.
7279 @item -ftree-phiprop
7280 @opindex ftree-phiprop
7281 Perform hoisting of loads from conditional pointers on trees.  This
7282 pass is enabled by default at @option{-O} and higher.
7284 @item -fhoist-adjacent-loads
7285 @opindex hoist-adjacent-loads
7286 Speculatively hoist loads from both branches of an if-then-else if the
7287 loads are from adjacent locations in the same structure and the target
7288 architecture has a conditional move instruction.  This flag is enabled
7289 by default at @option{-O2} and higher.
7291 @item -ftree-copy-prop
7292 @opindex ftree-copy-prop
7293 Perform copy propagation on trees.  This pass eliminates unnecessary
7294 copy operations.  This flag is enabled by default at @option{-O} and
7295 higher.
7297 @item -fipa-pure-const
7298 @opindex fipa-pure-const
7299 Discover which functions are pure or constant.
7300 Enabled by default at @option{-O} and higher.
7302 @item -fipa-reference
7303 @opindex fipa-reference
7304 Discover which static variables do not escape the
7305 compilation unit.
7306 Enabled by default at @option{-O} and higher.
7308 @item -fipa-pta
7309 @opindex fipa-pta
7310 Perform interprocedural pointer analysis and interprocedural modification
7311 and reference analysis.  This option can cause excessive memory and
7312 compile-time usage on large compilation units.  It is not enabled by
7313 default at any optimization level.
7315 @item -fipa-profile
7316 @opindex fipa-profile
7317 Perform interprocedural profile propagation.  The functions called only from
7318 cold functions are marked as cold. Also functions executed once (such as
7319 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7320 functions and loop less parts of functions executed once are then optimized for
7321 size.
7322 Enabled by default at @option{-O} and higher.
7324 @item -fipa-cp
7325 @opindex fipa-cp
7326 Perform interprocedural constant propagation.
7327 This optimization analyzes the program to determine when values passed
7328 to functions are constants and then optimizes accordingly.
7329 This optimization can substantially increase performance
7330 if the application has constants passed to functions.
7331 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7333 @item -fipa-cp-clone
7334 @opindex fipa-cp-clone
7335 Perform function cloning to make interprocedural constant propagation stronger.
7336 When enabled, interprocedural constant propagation performs function cloning
7337 when externally visible function can be called with constant arguments.
7338 Because this optimization can create multiple copies of functions,
7339 it may significantly increase code size
7340 (see @option{--param ipcp-unit-growth=@var{value}}).
7341 This flag is enabled by default at @option{-O3}.
7343 @item -ftree-sink
7344 @opindex ftree-sink
7345 Perform forward store motion  on trees.  This flag is
7346 enabled by default at @option{-O} and higher.
7348 @item -ftree-bit-ccp
7349 @opindex ftree-bit-ccp
7350 Perform sparse conditional bit constant propagation on trees and propagate
7351 pointer alignment information.
7352 This pass only operates on local scalar variables and is enabled by default
7353 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7355 @item -ftree-ccp
7356 @opindex ftree-ccp
7357 Perform sparse conditional constant propagation (CCP) on trees.  This
7358 pass only operates on local scalar variables and is enabled by default
7359 at @option{-O} and higher.
7361 @item -ftree-switch-conversion
7362 Perform conversion of simple initializations in a switch to
7363 initializations from a scalar array.  This flag is enabled by default
7364 at @option{-O2} and higher.
7366 @item -ftree-tail-merge
7367 Look for identical code sequences.  When found, replace one with a jump to the
7368 other.  This optimization is known as tail merging or cross jumping.  This flag
7369 is enabled by default at @option{-O2} and higher.  The compilation time
7370 in this pass can
7371 be limited using @option{max-tail-merge-comparisons} parameter and
7372 @option{max-tail-merge-iterations} parameter.
7374 @item -ftree-dce
7375 @opindex ftree-dce
7376 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7377 default at @option{-O} and higher.
7379 @item -ftree-builtin-call-dce
7380 @opindex ftree-builtin-call-dce
7381 Perform conditional dead code elimination (DCE) for calls to built-in functions
7382 that may set @code{errno} but are otherwise side-effect free.  This flag is
7383 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7384 specified.
7386 @item -ftree-dominator-opts
7387 @opindex ftree-dominator-opts
7388 Perform a variety of simple scalar cleanups (constant/copy
7389 propagation, redundancy elimination, range propagation and expression
7390 simplification) based on a dominator tree traversal.  This also
7391 performs jump threading (to reduce jumps to jumps). This flag is
7392 enabled by default at @option{-O} and higher.
7394 @item -ftree-dse
7395 @opindex ftree-dse
7396 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7397 a memory location that is later overwritten by another store without
7398 any intervening loads.  In this case the earlier store can be deleted.  This
7399 flag is enabled by default at @option{-O} and higher.
7401 @item -ftree-ch
7402 @opindex ftree-ch
7403 Perform loop header copying on trees.  This is beneficial since it increases
7404 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7405 is enabled by default at @option{-O} and higher.  It is not enabled
7406 for @option{-Os}, since it usually increases code size.
7408 @item -ftree-loop-optimize
7409 @opindex ftree-loop-optimize
7410 Perform loop optimizations on trees.  This flag is enabled by default
7411 at @option{-O} and higher.
7413 @item -ftree-loop-linear
7414 @opindex ftree-loop-linear
7415 Perform loop interchange transformations on tree.  Same as
7416 @option{-floop-interchange}.  To use this code transformation, GCC has
7417 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7418 enable the Graphite loop transformation infrastructure.
7420 @item -floop-interchange
7421 @opindex floop-interchange
7422 Perform loop interchange transformations on loops.  Interchanging two
7423 nested loops switches the inner and outer loops.  For example, given a
7424 loop like:
7425 @smallexample
7426 DO J = 1, M
7427   DO I = 1, N
7428     A(J, I) = A(J, I) * C
7429   ENDDO
7430 ENDDO
7431 @end smallexample
7432 loop interchange transforms the loop as if it were written:
7433 @smallexample
7434 DO I = 1, N
7435   DO J = 1, M
7436     A(J, I) = A(J, I) * C
7437   ENDDO
7438 ENDDO
7439 @end smallexample
7440 which can be beneficial when @code{N} is larger than the caches,
7441 because in Fortran, the elements of an array are stored in memory
7442 contiguously by column, and the original loop iterates over rows,
7443 potentially creating at each access a cache miss.  This optimization
7444 applies to all the languages supported by GCC and is not limited to
7445 Fortran.  To use this code transformation, GCC has to be configured
7446 with @option{--with-ppl} and @option{--with-cloog} to enable the
7447 Graphite loop transformation infrastructure.
7449 @item -floop-strip-mine
7450 @opindex floop-strip-mine
7451 Perform loop strip mining transformations on loops.  Strip mining
7452 splits a loop into two nested loops.  The outer loop has strides
7453 equal to the strip size and the inner loop has strides of the
7454 original loop within a strip.  The strip length can be changed
7455 using the @option{loop-block-tile-size} parameter.  For example,
7456 given a loop like:
7457 @smallexample
7458 DO I = 1, N
7459   A(I) = A(I) + C
7460 ENDDO
7461 @end smallexample
7462 loop strip mining transforms the loop as if it were written:
7463 @smallexample
7464 DO II = 1, N, 51
7465   DO I = II, min (II + 50, N)
7466     A(I) = A(I) + C
7467   ENDDO
7468 ENDDO
7469 @end smallexample
7470 This optimization applies to all the languages supported by GCC and is
7471 not limited to Fortran.  To use this code transformation, GCC has to
7472 be configured with @option{--with-ppl} and @option{--with-cloog} to
7473 enable the Graphite loop transformation infrastructure.
7475 @item -floop-block
7476 @opindex floop-block
7477 Perform loop blocking transformations on loops.  Blocking strip mines
7478 each loop in the loop nest such that the memory accesses of the
7479 element loops fit inside caches.  The strip length can be changed
7480 using the @option{loop-block-tile-size} parameter.  For example, given
7481 a loop like:
7482 @smallexample
7483 DO I = 1, N
7484   DO J = 1, M
7485     A(J, I) = B(I) + C(J)
7486   ENDDO
7487 ENDDO
7488 @end smallexample
7489 loop blocking transforms the loop as if it were written:
7490 @smallexample
7491 DO II = 1, N, 51
7492   DO JJ = 1, M, 51
7493     DO I = II, min (II + 50, N)
7494       DO J = JJ, min (JJ + 50, M)
7495         A(J, I) = B(I) + C(J)
7496       ENDDO
7497     ENDDO
7498   ENDDO
7499 ENDDO
7500 @end smallexample
7501 which can be beneficial when @code{M} is larger than the caches,
7502 because the innermost loop iterates over a smaller amount of data
7503 which can be kept in the caches.  This optimization applies to all the
7504 languages supported by GCC and is not limited to Fortran.  To use this
7505 code transformation, GCC has to be configured with @option{--with-ppl}
7506 and @option{--with-cloog} to enable the Graphite loop transformation
7507 infrastructure.
7509 @item -fgraphite-identity
7510 @opindex fgraphite-identity
7511 Enable the identity transformation for graphite.  For every SCoP we generate
7512 the polyhedral representation and transform it back to gimple.  Using
7513 @option{-fgraphite-identity} we can check the costs or benefits of the
7514 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7515 are also performed by the code generator CLooG, like index splitting and
7516 dead code elimination in loops.
7518 @item -floop-nest-optimize
7519 @opindex floop-nest-optimize
7520 Enable the ISL based loop nest optimizer.  This is a generic loop nest
7521 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7522 structure optimized for data-locality and parallelism.  This option
7523 is experimental.
7525 @item -floop-parallelize-all
7526 @opindex floop-parallelize-all
7527 Use the Graphite data dependence analysis to identify loops that can
7528 be parallelized.  Parallelize all the loops that can be analyzed to
7529 not contain loop carried dependences without checking that it is
7530 profitable to parallelize the loops.
7532 @item -fcheck-data-deps
7533 @opindex fcheck-data-deps
7534 Compare the results of several data dependence analyzers.  This option
7535 is used for debugging the data dependence analyzers.
7537 @item -ftree-loop-if-convert
7538 Attempt to transform conditional jumps in the innermost loops to
7539 branch-less equivalents.  The intent is to remove control-flow from
7540 the innermost loops in order to improve the ability of the
7541 vectorization pass to handle these loops.  This is enabled by default
7542 if vectorization is enabled.
7544 @item -ftree-loop-if-convert-stores
7545 Attempt to also if-convert conditional jumps containing memory writes.
7546 This transformation can be unsafe for multi-threaded programs as it
7547 transforms conditional memory writes into unconditional memory writes.
7548 For example,
7549 @smallexample
7550 for (i = 0; i < N; i++)
7551   if (cond)
7552     A[i] = expr;
7553 @end smallexample
7554 is transformed to
7555 @smallexample
7556 for (i = 0; i < N; i++)
7557   A[i] = cond ? expr : A[i];
7558 @end smallexample
7559 potentially producing data races.
7561 @item -ftree-loop-distribution
7562 Perform loop distribution.  This flag can improve cache performance on
7563 big loop bodies and allow further loop optimizations, like
7564 parallelization or vectorization, to take place.  For example, the loop
7565 @smallexample
7566 DO I = 1, N
7567   A(I) = B(I) + C
7568   D(I) = E(I) * F
7569 ENDDO
7570 @end smallexample
7571 is transformed to
7572 @smallexample
7573 DO I = 1, N
7574    A(I) = B(I) + C
7575 ENDDO
7576 DO I = 1, N
7577    D(I) = E(I) * F
7578 ENDDO
7579 @end smallexample
7581 @item -ftree-loop-distribute-patterns
7582 Perform loop distribution of patterns that can be code generated with
7583 calls to a library.  This flag is enabled by default at @option{-O3}.
7585 This pass distributes the initialization loops and generates a call to
7586 memset zero.  For example, the loop
7587 @smallexample
7588 DO I = 1, N
7589   A(I) = 0
7590   B(I) = A(I) + I
7591 ENDDO
7592 @end smallexample
7593 is transformed to
7594 @smallexample
7595 DO I = 1, N
7596    A(I) = 0
7597 ENDDO
7598 DO I = 1, N
7599    B(I) = A(I) + I
7600 ENDDO
7601 @end smallexample
7602 and the initialization loop is transformed into a call to memset zero.
7604 @item -ftree-loop-im
7605 @opindex ftree-loop-im
7606 Perform loop invariant motion on trees.  This pass moves only invariants that
7607 are hard to handle at RTL level (function calls, operations that expand to
7608 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7609 operands of conditions that are invariant out of the loop, so that we can use
7610 just trivial invariantness analysis in loop unswitching.  The pass also includes
7611 store motion.
7613 @item -ftree-loop-ivcanon
7614 @opindex ftree-loop-ivcanon
7615 Create a canonical counter for number of iterations in loops for which
7616 determining number of iterations requires complicated analysis.  Later
7617 optimizations then may determine the number easily.  Useful especially
7618 in connection with unrolling.
7620 @item -fivopts
7621 @opindex fivopts
7622 Perform induction variable optimizations (strength reduction, induction
7623 variable merging and induction variable elimination) on trees.
7625 @item -ftree-parallelize-loops=n
7626 @opindex ftree-parallelize-loops
7627 Parallelize loops, i.e., split their iteration space to run in n threads.
7628 This is only possible for loops whose iterations are independent
7629 and can be arbitrarily reordered.  The optimization is only
7630 profitable on multiprocessor machines, for loops that are CPU-intensive,
7631 rather than constrained e.g.@: by memory bandwidth.  This option
7632 implies @option{-pthread}, and thus is only supported on targets
7633 that have support for @option{-pthread}.
7635 @item -ftree-pta
7636 @opindex ftree-pta
7637 Perform function-local points-to analysis on trees.  This flag is
7638 enabled by default at @option{-O} and higher.
7640 @item -ftree-sra
7641 @opindex ftree-sra
7642 Perform scalar replacement of aggregates.  This pass replaces structure
7643 references with scalars to prevent committing structures to memory too
7644 early.  This flag is enabled by default at @option{-O} and higher.
7646 @item -ftree-copyrename
7647 @opindex ftree-copyrename
7648 Perform copy renaming on trees.  This pass attempts to rename compiler
7649 temporaries to other variables at copy locations, usually resulting in
7650 variable names which more closely resemble the original variables.  This flag
7651 is enabled by default at @option{-O} and higher.
7653 @item -ftree-coalesce-inlined-vars
7654 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7655 combine small user-defined variables too, but only if they were inlined
7656 from other functions.  It is a more limited form of
7657 @option{-ftree-coalesce-vars}.  This may harm debug information of such
7658 inlined variables, but it will keep variables of the inlined-into
7659 function apart from each other, such that they are more likely to
7660 contain the expected values in a debugging session.  This was the
7661 default in GCC versions older than 4.7.
7663 @item -ftree-coalesce-vars
7664 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7665 combine small user-defined variables too, instead of just compiler
7666 temporaries.  This may severely limit the ability to debug an optimized
7667 program compiled with @option{-fno-var-tracking-assignments}.  In the
7668 negated form, this flag prevents SSA coalescing of user variables,
7669 including inlined ones.  This option is enabled by default.
7671 @item -ftree-ter
7672 @opindex ftree-ter
7673 Perform temporary expression replacement during the SSA->normal phase.  Single
7674 use/single def temporaries are replaced at their use location with their
7675 defining expression.  This results in non-GIMPLE code, but gives the expanders
7676 much more complex trees to work on resulting in better RTL generation.  This is
7677 enabled by default at @option{-O} and higher.
7679 @item -ftree-slsr
7680 @opindex ftree-slsr
7681 Perform straight-line strength reduction on trees.  This recognizes related
7682 expressions involving multiplications and replaces them by less expensive
7683 calculations when possible.  This is enabled by default at @option{-O} and
7684 higher.
7686 @item -ftree-vectorize
7687 @opindex ftree-vectorize
7688 Perform loop vectorization on trees. This flag is enabled by default at
7689 @option{-O3}.
7691 @item -ftree-slp-vectorize
7692 @opindex ftree-slp-vectorize
7693 Perform basic block vectorization on trees. This flag is enabled by default at
7694 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7696 @item -ftree-vect-loop-version
7697 @opindex ftree-vect-loop-version
7698 Perform loop versioning when doing loop vectorization on trees.  When a loop
7699 appears to be vectorizable except that data alignment or data dependence cannot
7700 be determined at compile time, then vectorized and non-vectorized versions of
7701 the loop are generated along with run-time checks for alignment or dependence
7702 to control which version is executed.  This option is enabled by default
7703 except at level @option{-Os} where it is disabled.
7705 @item -fvect-cost-model
7706 @opindex fvect-cost-model
7707 Enable cost model for vectorization.  This option is enabled by default at
7708 @option{-O3}.
7710 @item -ftree-vrp
7711 @opindex ftree-vrp
7712 Perform Value Range Propagation on trees.  This is similar to the
7713 constant propagation pass, but instead of values, ranges of values are
7714 propagated.  This allows the optimizers to remove unnecessary range
7715 checks like array bound checks and null pointer checks.  This is
7716 enabled by default at @option{-O2} and higher.  Null pointer check
7717 elimination is only done if @option{-fdelete-null-pointer-checks} is
7718 enabled.
7720 @item -ftracer
7721 @opindex ftracer
7722 Perform tail duplication to enlarge superblock size.  This transformation
7723 simplifies the control flow of the function allowing other optimizations to do
7724 a better job.
7726 @item -funroll-loops
7727 @opindex funroll-loops
7728 Unroll loops whose number of iterations can be determined at compile
7729 time or upon entry to the loop.  @option{-funroll-loops} implies
7730 @option{-frerun-cse-after-loop}.  This option makes code larger,
7731 and may or may not make it run faster.
7733 @item -funroll-all-loops
7734 @opindex funroll-all-loops
7735 Unroll all loops, even if their number of iterations is uncertain when
7736 the loop is entered.  This usually makes programs run more slowly.
7737 @option{-funroll-all-loops} implies the same options as
7738 @option{-funroll-loops},
7740 @item -fsplit-ivs-in-unroller
7741 @opindex fsplit-ivs-in-unroller
7742 Enables expression of values of induction variables in later iterations
7743 of the unrolled loop using the value in the first iteration.  This breaks
7744 long dependency chains, thus improving efficiency of the scheduling passes.
7746 A combination of @option{-fweb} and CSE is often sufficient to obtain the
7747 same effect.  However, that is not reliable in cases where the loop body
7748 is more complicated than a single basic block.  It also does not work at all
7749 on some architectures due to restrictions in the CSE pass.
7751 This optimization is enabled by default.
7753 @item -fvariable-expansion-in-unroller
7754 @opindex fvariable-expansion-in-unroller
7755 With this option, the compiler creates multiple copies of some
7756 local variables when unrolling a loop, which can result in superior code.
7758 @item -fpartial-inlining
7759 @opindex fpartial-inlining
7760 Inline parts of functions.  This option has any effect only
7761 when inlining itself is turned on by the @option{-finline-functions}
7762 or @option{-finline-small-functions} options.
7764 Enabled at level @option{-O2}.
7766 @item -fpredictive-commoning
7767 @opindex fpredictive-commoning
7768 Perform predictive commoning optimization, i.e., reusing computations
7769 (especially memory loads and stores) performed in previous
7770 iterations of loops.
7772 This option is enabled at level @option{-O3}.
7774 @item -fprefetch-loop-arrays
7775 @opindex fprefetch-loop-arrays
7776 If supported by the target machine, generate instructions to prefetch
7777 memory to improve the performance of loops that access large arrays.
7779 This option may generate better or worse code; results are highly
7780 dependent on the structure of loops within the source code.
7782 Disabled at level @option{-Os}.
7784 @item -fno-peephole
7785 @itemx -fno-peephole2
7786 @opindex fno-peephole
7787 @opindex fno-peephole2
7788 Disable any machine-specific peephole optimizations.  The difference
7789 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7790 are implemented in the compiler; some targets use one, some use the
7791 other, a few use both.
7793 @option{-fpeephole} is enabled by default.
7794 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7796 @item -fno-guess-branch-probability
7797 @opindex fno-guess-branch-probability
7798 Do not guess branch probabilities using heuristics.
7800 GCC uses heuristics to guess branch probabilities if they are
7801 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7802 heuristics are based on the control flow graph.  If some branch probabilities
7803 are specified by @samp{__builtin_expect}, then the heuristics are
7804 used to guess branch probabilities for the rest of the control flow graph,
7805 taking the @samp{__builtin_expect} info into account.  The interactions
7806 between the heuristics and @samp{__builtin_expect} can be complex, and in
7807 some cases, it may be useful to disable the heuristics so that the effects
7808 of @samp{__builtin_expect} are easier to understand.
7810 The default is @option{-fguess-branch-probability} at levels
7811 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7813 @item -freorder-blocks
7814 @opindex freorder-blocks
7815 Reorder basic blocks in the compiled function in order to reduce number of
7816 taken branches and improve code locality.
7818 Enabled at levels @option{-O2}, @option{-O3}.
7820 @item -freorder-blocks-and-partition
7821 @opindex freorder-blocks-and-partition
7822 In addition to reordering basic blocks in the compiled function, in order
7823 to reduce number of taken branches, partitions hot and cold basic blocks
7824 into separate sections of the assembly and .o files, to improve
7825 paging and cache locality performance.
7827 This optimization is automatically turned off in the presence of
7828 exception handling, for linkonce sections, for functions with a user-defined
7829 section attribute and on any architecture that does not support named
7830 sections.
7832 @item -freorder-functions
7833 @opindex freorder-functions
7834 Reorder functions in the object file in order to
7835 improve code locality.  This is implemented by using special
7836 subsections @code{.text.hot} for most frequently executed functions and
7837 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7838 the linker so object file format must support named sections and linker must
7839 place them in a reasonable way.
7841 Also profile feedback must be available to make this option effective.  See
7842 @option{-fprofile-arcs} for details.
7844 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7846 @item -fstrict-aliasing
7847 @opindex fstrict-aliasing
7848 Allow the compiler to assume the strictest aliasing rules applicable to
7849 the language being compiled.  For C (and C++), this activates
7850 optimizations based on the type of expressions.  In particular, an
7851 object of one type is assumed never to reside at the same address as an
7852 object of a different type, unless the types are almost the same.  For
7853 example, an @code{unsigned int} can alias an @code{int}, but not a
7854 @code{void*} or a @code{double}.  A character type may alias any other
7855 type.
7857 @anchor{Type-punning}Pay special attention to code like this:
7858 @smallexample
7859 union a_union @{
7860   int i;
7861   double d;
7864 int f() @{
7865   union a_union t;
7866   t.d = 3.0;
7867   return t.i;
7869 @end smallexample
7870 The practice of reading from a different union member than the one most
7871 recently written to (called ``type-punning'') is common.  Even with
7872 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7873 is accessed through the union type.  So, the code above works as
7874 expected.  @xref{Structures unions enumerations and bit-fields
7875 implementation}.  However, this code might not:
7876 @smallexample
7877 int f() @{
7878   union a_union t;
7879   int* ip;
7880   t.d = 3.0;
7881   ip = &t.i;
7882   return *ip;
7884 @end smallexample
7886 Similarly, access by taking the address, casting the resulting pointer
7887 and dereferencing the result has undefined behavior, even if the cast
7888 uses a union type, e.g.:
7889 @smallexample
7890 int f() @{
7891   double d = 3.0;
7892   return ((union a_union *) &d)->i;
7894 @end smallexample
7896 The @option{-fstrict-aliasing} option is enabled at levels
7897 @option{-O2}, @option{-O3}, @option{-Os}.
7899 @item -fstrict-overflow
7900 @opindex fstrict-overflow
7901 Allow the compiler to assume strict signed overflow rules, depending
7902 on the language being compiled.  For C (and C++) this means that
7903 overflow when doing arithmetic with signed numbers is undefined, which
7904 means that the compiler may assume that it does not happen.  This
7905 permits various optimizations.  For example, the compiler assumes
7906 that an expression like @code{i + 10 > i} is always true for
7907 signed @code{i}.  This assumption is only valid if signed overflow is
7908 undefined, as the expression is false if @code{i + 10} overflows when
7909 using twos complement arithmetic.  When this option is in effect any
7910 attempt to determine whether an operation on signed numbers 
7911 overflows must be written carefully to not actually involve overflow.
7913 This option also allows the compiler to assume strict pointer
7914 semantics: given a pointer to an object, if adding an offset to that
7915 pointer does not produce a pointer to the same object, the addition is
7916 undefined.  This permits the compiler to conclude that @code{p + u >
7917 p} is always true for a pointer @code{p} and unsigned integer
7918 @code{u}.  This assumption is only valid because pointer wraparound is
7919 undefined, as the expression is false if @code{p + u} overflows using
7920 twos complement arithmetic.
7922 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7923 that integer signed overflow is fully defined: it wraps.  When
7924 @option{-fwrapv} is used, there is no difference between
7925 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7926 integers.  With @option{-fwrapv} certain types of overflow are
7927 permitted.  For example, if the compiler gets an overflow when doing
7928 arithmetic on constants, the overflowed value can still be used with
7929 @option{-fwrapv}, but not otherwise.
7931 The @option{-fstrict-overflow} option is enabled at levels
7932 @option{-O2}, @option{-O3}, @option{-Os}.
7934 @item -falign-functions
7935 @itemx -falign-functions=@var{n}
7936 @opindex falign-functions
7937 Align the start of functions to the next power-of-two greater than
7938 @var{n}, skipping up to @var{n} bytes.  For instance,
7939 @option{-falign-functions=32} aligns functions to the next 32-byte
7940 boundary, but @option{-falign-functions=24} aligns to the next
7941 32-byte boundary only if this can be done by skipping 23 bytes or less.
7943 @option{-fno-align-functions} and @option{-falign-functions=1} are
7944 equivalent and mean that functions are not aligned.
7946 Some assemblers only support this flag when @var{n} is a power of two;
7947 in that case, it is rounded up.
7949 If @var{n} is not specified or is zero, use a machine-dependent default.
7951 Enabled at levels @option{-O2}, @option{-O3}.
7953 @item -falign-labels
7954 @itemx -falign-labels=@var{n}
7955 @opindex falign-labels
7956 Align all branch targets to a power-of-two boundary, skipping up to
7957 @var{n} bytes like @option{-falign-functions}.  This option can easily
7958 make code slower, because it must insert dummy operations for when the
7959 branch target is reached in the usual flow of the code.
7961 @option{-fno-align-labels} and @option{-falign-labels=1} are
7962 equivalent and mean that labels are not aligned.
7964 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7965 are greater than this value, then their values are used instead.
7967 If @var{n} is not specified or is zero, use a machine-dependent default
7968 which is very likely to be @samp{1}, meaning no alignment.
7970 Enabled at levels @option{-O2}, @option{-O3}.
7972 @item -falign-loops
7973 @itemx -falign-loops=@var{n}
7974 @opindex falign-loops
7975 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7976 like @option{-falign-functions}.  If the loops are
7977 executed many times, this makes up for any execution of the dummy
7978 operations.
7980 @option{-fno-align-loops} and @option{-falign-loops=1} are
7981 equivalent and mean that loops are not aligned.
7983 If @var{n} is not specified or is zero, use a machine-dependent default.
7985 Enabled at levels @option{-O2}, @option{-O3}.
7987 @item -falign-jumps
7988 @itemx -falign-jumps=@var{n}
7989 @opindex falign-jumps
7990 Align branch targets to a power-of-two boundary, for branch targets
7991 where the targets can only be reached by jumping, skipping up to @var{n}
7992 bytes like @option{-falign-functions}.  In this case, no dummy operations
7993 need be executed.
7995 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7996 equivalent and mean that loops are not aligned.
7998 If @var{n} is not specified or is zero, use a machine-dependent default.
8000 Enabled at levels @option{-O2}, @option{-O3}.
8002 @item -funit-at-a-time
8003 @opindex funit-at-a-time
8004 This option is left for compatibility reasons. @option{-funit-at-a-time}
8005 has no effect, while @option{-fno-unit-at-a-time} implies
8006 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8008 Enabled by default.
8010 @item -fno-toplevel-reorder
8011 @opindex fno-toplevel-reorder
8012 Do not reorder top-level functions, variables, and @code{asm}
8013 statements.  Output them in the same order that they appear in the
8014 input file.  When this option is used, unreferenced static variables
8015 are not removed.  This option is intended to support existing code
8016 that relies on a particular ordering.  For new code, it is better to
8017 use attributes.
8019 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8020 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8021 targets.
8023 @item -fweb
8024 @opindex fweb
8025 Constructs webs as commonly used for register allocation purposes and assign
8026 each web individual pseudo register.  This allows the register allocation pass
8027 to operate on pseudos directly, but also strengthens several other optimization
8028 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8029 however, make debugging impossible, since variables no longer stay in a
8030 ``home register''.
8032 Enabled by default with @option{-funroll-loops}.
8034 @item -fwhole-program
8035 @opindex fwhole-program
8036 Assume that the current compilation unit represents the whole program being
8037 compiled.  All public functions and variables with the exception of @code{main}
8038 and those merged by attribute @code{externally_visible} become static functions
8039 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.
8040 While this option is equivalent to proper use of the @code{static} keyword for
8041 programs consisting of a single file, in combination with option
8042 @option{-flto} this flag can be used to
8043 compile many smaller scale programs since the functions and variables become
8044 local for the whole combined compilation unit, not for the single source file
8045 itself.
8047 This option implies @option{-fwhole-file} for Fortran programs.
8049 @item -flto[=@var{n}]
8050 @opindex flto
8051 This option runs the standard link-time optimizer.  When invoked
8052 with source code, it generates GIMPLE (one of GCC's internal
8053 representations) and writes it to special ELF sections in the object
8054 file.  When the object files are linked together, all the function
8055 bodies are read from these ELF sections and instantiated as if they
8056 had been part of the same translation unit.
8058 To use the link-time optimizer, @option{-flto} needs to be specified at
8059 compile time and during the final link.  For example:
8061 @smallexample
8062 gcc -c -O2 -flto foo.c
8063 gcc -c -O2 -flto bar.c
8064 gcc -o myprog -flto -O2 foo.o bar.o
8065 @end smallexample
8067 The first two invocations to GCC save a bytecode representation
8068 of GIMPLE into special ELF sections inside @file{foo.o} and
8069 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8070 @file{foo.o} and @file{bar.o}, merges the two files into a single
8071 internal image, and compiles the result as usual.  Since both
8072 @file{foo.o} and @file{bar.o} are merged into a single image, this
8073 causes all the interprocedural analyses and optimizations in GCC to
8074 work across the two files as if they were a single one.  This means,
8075 for example, that the inliner is able to inline functions in
8076 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8078 Another (simpler) way to enable link-time optimization is:
8080 @smallexample
8081 gcc -o myprog -flto -O2 foo.c bar.c
8082 @end smallexample
8084 The above generates bytecode for @file{foo.c} and @file{bar.c},
8085 merges them together into a single GIMPLE representation and optimizes
8086 them as usual to produce @file{myprog}.
8088 The only important thing to keep in mind is that to enable link-time
8089 optimizations the @option{-flto} flag needs to be passed to both the
8090 compile and the link commands.
8092 To make whole program optimization effective, it is necessary to make
8093 certain whole program assumptions.  The compiler needs to know
8094 what functions and variables can be accessed by libraries and runtime
8095 outside of the link-time optimized unit.  When supported by the linker,
8096 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8097 to the compiler about used and externally visible symbols.  When
8098 the linker plugin is not available, @option{-fwhole-program} should be
8099 used to allow the compiler to make these assumptions, which leads
8100 to more aggressive optimization decisions.
8102 Note that when a file is compiled with @option{-flto}, the generated
8103 object file is larger than a regular object file because it 
8104 contains GIMPLE bytecodes and the usual final code.  This means that
8105 object files with LTO information can be linked as normal object
8106 files; if @option{-flto} is not passed to the linker, no
8107 interprocedural optimizations are applied.
8109 Additionally, the optimization flags used to compile individual files
8110 are not necessarily related to those used at link time.  For instance,
8112 @smallexample
8113 gcc -c -O0 -flto foo.c
8114 gcc -c -O0 -flto bar.c
8115 gcc -o myprog -flto -O3 foo.o bar.o
8116 @end smallexample
8118 This produces individual object files with unoptimized assembler
8119 code, but the resulting binary @file{myprog} is optimized at
8120 @option{-O3}.  If, instead, the final binary is generated without
8121 @option{-flto}, then @file{myprog} is not optimized.
8123 When producing the final binary with @option{-flto}, GCC only
8124 applies link-time optimizations to those files that contain bytecode.
8125 Therefore, you can mix and match object files and libraries with
8126 GIMPLE bytecodes and final object code.  GCC automatically selects
8127 which files to optimize in LTO mode and which files to link without
8128 further processing.
8130 There are some code generation flags preserved by GCC when
8131 generating bytecodes, as they need to be used during the final link
8132 stage.  Currently, the following options are saved into the GIMPLE
8133 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
8134 @option{-m} target flags.
8136 At link time, these options are read in and reapplied.  Note that the
8137 current implementation makes no attempt to recognize conflicting
8138 values for these options.  If different files have conflicting option
8139 values (e.g., one file is compiled with @option{-fPIC} and another
8140 isn't), the compiler simply uses the last value read from the
8141 bytecode files.  It is recommended, then, that you compile all the files
8142 participating in the same link with the same options.
8144 If LTO encounters objects with C linkage declared with incompatible
8145 types in separate translation units to be linked together (undefined
8146 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8147 issued.  The behavior is still undefined at run time.
8149 Another feature of LTO is that it is possible to apply interprocedural
8150 optimizations on files written in different languages.  This requires
8151 support in the language front end.  Currently, the C, C++ and
8152 Fortran front ends are capable of emitting GIMPLE bytecodes, so
8153 something like this should work:
8155 @smallexample
8156 gcc -c -flto foo.c
8157 g++ -c -flto bar.cc
8158 gfortran -c -flto baz.f90
8159 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8160 @end smallexample
8162 Notice that the final link is done with @command{g++} to get the C++
8163 runtime libraries and @option{-lgfortran} is added to get the Fortran
8164 runtime libraries.  In general, when mixing languages in LTO mode, you
8165 should use the same link command options as when mixing languages in a
8166 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8167 all the compile and link commands.
8169 If object files containing GIMPLE bytecode are stored in a library archive, say
8170 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8171 are using a linker with plugin support.  To enable this feature, use
8172 the flag @option{-fuse-linker-plugin} at link time:
8174 @smallexample
8175 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8176 @end smallexample
8178 With the linker plugin enabled, the linker extracts the needed
8179 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8180 to make them part of the aggregated GIMPLE image to be optimized.
8182 If you are not using a linker with plugin support and/or do not
8183 enable the linker plugin, then the objects inside @file{libfoo.a}
8184 are extracted and linked as usual, but they do not participate
8185 in the LTO optimization process.
8187 Link-time optimizations do not require the presence of the whole program to
8188 operate.  If the program does not require any symbols to be exported, it is
8189 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8190 the interprocedural optimizers to use more aggressive assumptions which may
8191 lead to improved optimization opportunities.
8192 Use of @option{-fwhole-program} is not needed when linker plugin is
8193 active (see @option{-fuse-linker-plugin}).
8195 The current implementation of LTO makes no
8196 attempt to generate bytecode that is portable between different
8197 types of hosts.  The bytecode files are versioned and there is a
8198 strict version check, so bytecode files generated in one version of
8199 GCC will not work with an older/newer version of GCC@.
8201 Link-time optimization does not work well with generation of debugging
8202 information.  Combining @option{-flto} with
8203 @option{-g} is currently experimental and expected to produce wrong
8204 results.
8206 If you specify the optional @var{n}, the optimization and code
8207 generation done at link time is executed in parallel using @var{n}
8208 parallel jobs by utilizing an installed @command{make} program.  The
8209 environment variable @env{MAKE} may be used to override the program
8210 used.  The default value for @var{n} is 1.
8212 You can also specify @option{-flto=jobserver} to use GNU make's
8213 job server mode to determine the number of parallel jobs. This
8214 is useful when the Makefile calling GCC is already executing in parallel.
8215 You must prepend a @samp{+} to the command recipe in the parent Makefile
8216 for this to work.  This option likely only works if @env{MAKE} is
8217 GNU make.
8219 This option is disabled by default.
8221 @item -flto-partition=@var{alg}
8222 @opindex flto-partition
8223 Specify the partitioning algorithm used by the link-time optimizer.
8224 The value is either @code{1to1} to specify a partitioning mirroring
8225 the original source files or @code{balanced} to specify partitioning
8226 into equally sized chunks (whenever possible) or @code{max} to create
8227 new partition for every symbol where possible.  Specifying @code{none}
8228 as an algorithm disables partitioning and streaming completely. 
8229 The default value is @code{balanced}. While @code{1to1} can be used
8230 as an workaround for various code ordering issues, the @code{max}
8231 partitioning is intended for internal testing only.
8233 @item -flto-compression-level=@var{n}
8234 This option specifies the level of compression used for intermediate
8235 language written to LTO object files, and is only meaningful in
8236 conjunction with LTO mode (@option{-flto}).  Valid
8237 values are 0 (no compression) to 9 (maximum compression).  Values
8238 outside this range are clamped to either 0 or 9.  If the option is not
8239 given, a default balanced compression setting is used.
8241 @item -flto-report
8242 Prints a report with internal details on the workings of the link-time
8243 optimizer.  The contents of this report vary from version to version.
8244 It is meant to be useful to GCC developers when processing object
8245 files in LTO mode (via @option{-flto}).
8247 Disabled by default.
8249 @item -fuse-linker-plugin
8250 Enables the use of a linker plugin during link-time optimization.  This
8251 option relies on plugin support in the linker, which is available in gold
8252 or in GNU ld 2.21 or newer.
8254 This option enables the extraction of object files with GIMPLE bytecode out
8255 of library archives. This improves the quality of optimization by exposing
8256 more code to the link-time optimizer.  This information specifies what
8257 symbols can be accessed externally (by non-LTO object or during dynamic
8258 linking).  Resulting code quality improvements on binaries (and shared
8259 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8260 See @option{-flto} for a description of the effect of this flag and how to
8261 use it.
8263 This option is enabled by default when LTO support in GCC is enabled
8264 and GCC was configured for use with
8265 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8267 @item -ffat-lto-objects
8268 @opindex ffat-lto-objects
8269 Fat LTO objects are object files that contain both the intermediate language
8270 and the object code. This makes them usable for both LTO linking and normal
8271 linking. This option is effective only when compiling with @option{-flto}
8272 and is ignored at link time.
8274 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8275 requires the complete toolchain to be aware of LTO. It requires a linker with
8276 linker plugin support for basic functionality.  Additionally,
8277 @command{nm}, @command{ar} and @command{ranlib}
8278 need to support linker plugins to allow a full-featured build environment
8279 (capable of building static libraries etc). gcc provides the @command{gcc-ar},
8280 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8281 to these tools. With non fat LTO makefiles need to be modified to use them.
8283 The default is @option{-ffat-lto-objects} but this default is intended to
8284 change in future releases when linker plugin enabled environments become more
8285 common.
8287 @item -fcompare-elim
8288 @opindex fcompare-elim
8289 After register allocation and post-register allocation instruction splitting,
8290 identify arithmetic instructions that compute processor flags similar to a
8291 comparison operation based on that arithmetic.  If possible, eliminate the
8292 explicit comparison operation.
8294 This pass only applies to certain targets that cannot explicitly represent
8295 the comparison operation before register allocation is complete.
8297 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8299 @item -fcprop-registers
8300 @opindex fcprop-registers
8301 After register allocation and post-register allocation instruction splitting,
8302 perform a copy-propagation pass to try to reduce scheduling dependencies
8303 and occasionally eliminate the copy.
8305 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8307 @item -fprofile-correction
8308 @opindex fprofile-correction
8309 Profiles collected using an instrumented binary for multi-threaded programs may
8310 be inconsistent due to missed counter updates. When this option is specified,
8311 GCC uses heuristics to correct or smooth out such inconsistencies. By
8312 default, GCC emits an error message when an inconsistent profile is detected.
8314 @item -fprofile-dir=@var{path}
8315 @opindex fprofile-dir
8317 Set the directory to search for the profile data files in to @var{path}.
8318 This option affects only the profile data generated by
8319 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8320 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8321 and its related options.  Both absolute and relative paths can be used.
8322 By default, GCC uses the current directory as @var{path}, thus the
8323 profile data file appears in the same directory as the object file.
8325 @item -fprofile-generate
8326 @itemx -fprofile-generate=@var{path}
8327 @opindex fprofile-generate
8329 Enable options usually used for instrumenting application to produce
8330 profile useful for later recompilation with profile feedback based
8331 optimization.  You must use @option{-fprofile-generate} both when
8332 compiling and when linking your program.
8334 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8336 If @var{path} is specified, GCC looks at the @var{path} to find
8337 the profile feedback data files. See @option{-fprofile-dir}.
8339 @item -fprofile-use
8340 @itemx -fprofile-use=@var{path}
8341 @opindex fprofile-use
8342 Enable profile feedback directed optimizations, and optimizations
8343 generally profitable only with profile feedback available.
8345 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8346 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
8348 By default, GCC emits an error message if the feedback profiles do not
8349 match the source code.  This error can be turned into a warning by using
8350 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8351 code.
8353 If @var{path} is specified, GCC looks at the @var{path} to find
8354 the profile feedback data files. See @option{-fprofile-dir}.
8355 @end table
8357 The following options control compiler behavior regarding floating-point 
8358 arithmetic.  These options trade off between speed and
8359 correctness.  All must be specifically enabled.
8361 @table @gcctabopt
8362 @item -ffloat-store
8363 @opindex ffloat-store
8364 Do not store floating-point variables in registers, and inhibit other
8365 options that might change whether a floating-point value is taken from a
8366 register or memory.
8368 @cindex floating-point precision
8369 This option prevents undesirable excess precision on machines such as
8370 the 68000 where the floating registers (of the 68881) keep more
8371 precision than a @code{double} is supposed to have.  Similarly for the
8372 x86 architecture.  For most programs, the excess precision does only
8373 good, but a few programs rely on the precise definition of IEEE floating
8374 point.  Use @option{-ffloat-store} for such programs, after modifying
8375 them to store all pertinent intermediate computations into variables.
8377 @item -fexcess-precision=@var{style}
8378 @opindex fexcess-precision
8379 This option allows further control over excess precision on machines
8380 where floating-point registers have more precision than the IEEE
8381 @code{float} and @code{double} types and the processor does not
8382 support operations rounding to those types.  By default,
8383 @option{-fexcess-precision=fast} is in effect; this means that
8384 operations are carried out in the precision of the registers and that
8385 it is unpredictable when rounding to the types specified in the source
8386 code takes place.  When compiling C, if
8387 @option{-fexcess-precision=standard} is specified then excess
8388 precision follows the rules specified in ISO C99; in particular,
8389 both casts and assignments cause values to be rounded to their
8390 semantic types (whereas @option{-ffloat-store} only affects
8391 assignments).  This option is enabled by default for C if a strict
8392 conformance option such as @option{-std=c99} is used.
8394 @opindex mfpmath
8395 @option{-fexcess-precision=standard} is not implemented for languages
8396 other than C, and has no effect if
8397 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8398 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8399 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8400 semantics apply without excess precision, and in the latter, rounding
8401 is unpredictable.
8403 @item -ffast-math
8404 @opindex ffast-math
8405 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8406 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8407 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8409 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8411 This option is not turned on by any @option{-O} option besides
8412 @option{-Ofast} since it can result in incorrect output for programs
8413 that depend on an exact implementation of IEEE or ISO rules/specifications
8414 for math functions. It may, however, yield faster code for programs
8415 that do not require the guarantees of these specifications.
8417 @item -fno-math-errno
8418 @opindex fno-math-errno
8419 Do not set @code{errno} after calling math functions that are executed
8420 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8421 IEEE exceptions for math error handling may want to use this flag
8422 for speed while maintaining IEEE arithmetic compatibility.
8424 This option is not turned on by any @option{-O} option since
8425 it can result in incorrect output for programs that depend on
8426 an exact implementation of IEEE or ISO rules/specifications for
8427 math functions. It may, however, yield faster code for programs
8428 that do not require the guarantees of these specifications.
8430 The default is @option{-fmath-errno}.
8432 On Darwin systems, the math library never sets @code{errno}.  There is
8433 therefore no reason for the compiler to consider the possibility that
8434 it might, and @option{-fno-math-errno} is the default.
8436 @item -funsafe-math-optimizations
8437 @opindex funsafe-math-optimizations
8439 Allow optimizations for floating-point arithmetic that (a) assume
8440 that arguments and results are valid and (b) may violate IEEE or
8441 ANSI standards.  When used at link-time, it may include libraries
8442 or startup files that change the default FPU control word or other
8443 similar optimizations.
8445 This option is not turned on by any @option{-O} option since
8446 it can result in incorrect output for programs that depend on
8447 an exact implementation of IEEE or ISO rules/specifications for
8448 math functions. It may, however, yield faster code for programs
8449 that do not require the guarantees of these specifications.
8450 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8451 @option{-fassociative-math} and @option{-freciprocal-math}.
8453 The default is @option{-fno-unsafe-math-optimizations}.
8455 @item -fassociative-math
8456 @opindex fassociative-math
8458 Allow re-association of operands in series of floating-point operations.
8459 This violates the ISO C and C++ language standard by possibly changing
8460 computation result.  NOTE: re-ordering may change the sign of zero as
8461 well as ignore NaNs and inhibit or create underflow or overflow (and
8462 thus cannot be used on code that relies on rounding behavior like
8463 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8464 and thus may not be used when ordered comparisons are required.
8465 This option requires that both @option{-fno-signed-zeros} and
8466 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8467 much sense with @option{-frounding-math}. For Fortran the option
8468 is automatically enabled when both @option{-fno-signed-zeros} and
8469 @option{-fno-trapping-math} are in effect.
8471 The default is @option{-fno-associative-math}.
8473 @item -freciprocal-math
8474 @opindex freciprocal-math
8476 Allow the reciprocal of a value to be used instead of dividing by
8477 the value if this enables optimizations.  For example @code{x / y}
8478 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8479 is subject to common subexpression elimination.  Note that this loses
8480 precision and increases the number of flops operating on the value.
8482 The default is @option{-fno-reciprocal-math}.
8484 @item -ffinite-math-only
8485 @opindex ffinite-math-only
8486 Allow optimizations for floating-point arithmetic that assume
8487 that arguments and results are not NaNs or +-Infs.
8489 This option is not turned on by any @option{-O} option since
8490 it can result in incorrect output for programs that depend on
8491 an exact implementation of IEEE or ISO rules/specifications for
8492 math functions. It may, however, yield faster code for programs
8493 that do not require the guarantees of these specifications.
8495 The default is @option{-fno-finite-math-only}.
8497 @item -fno-signed-zeros
8498 @opindex fno-signed-zeros
8499 Allow optimizations for floating-point arithmetic that ignore the
8500 signedness of zero.  IEEE arithmetic specifies the behavior of
8501 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8502 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8503 This option implies that the sign of a zero result isn't significant.
8505 The default is @option{-fsigned-zeros}.
8507 @item -fno-trapping-math
8508 @opindex fno-trapping-math
8509 Compile code assuming that floating-point operations cannot generate
8510 user-visible traps.  These traps include division by zero, overflow,
8511 underflow, inexact result and invalid operation.  This option requires
8512 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8513 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8515 This option should never be turned on by any @option{-O} option since
8516 it can result in incorrect output for programs that depend on
8517 an exact implementation of IEEE or ISO rules/specifications for
8518 math functions.
8520 The default is @option{-ftrapping-math}.
8522 @item -frounding-math
8523 @opindex frounding-math
8524 Disable transformations and optimizations that assume default floating-point
8525 rounding behavior.  This is round-to-zero for all floating point
8526 to integer conversions, and round-to-nearest for all other arithmetic
8527 truncations.  This option should be specified for programs that change
8528 the FP rounding mode dynamically, or that may be executed with a
8529 non-default rounding mode.  This option disables constant folding of
8530 floating-point expressions at compile time (which may be affected by
8531 rounding mode) and arithmetic transformations that are unsafe in the
8532 presence of sign-dependent rounding modes.
8534 The default is @option{-fno-rounding-math}.
8536 This option is experimental and does not currently guarantee to
8537 disable all GCC optimizations that are affected by rounding mode.
8538 Future versions of GCC may provide finer control of this setting
8539 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8540 will be used to specify the default state for @code{FENV_ACCESS}.
8542 @item -fsignaling-nans
8543 @opindex fsignaling-nans
8544 Compile code assuming that IEEE signaling NaNs may generate user-visible
8545 traps during floating-point operations.  Setting this option disables
8546 optimizations that may change the number of exceptions visible with
8547 signaling NaNs.  This option implies @option{-ftrapping-math}.
8549 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8550 be defined.
8552 The default is @option{-fno-signaling-nans}.
8554 This option is experimental and does not currently guarantee to
8555 disable all GCC optimizations that affect signaling NaN behavior.
8557 @item -fsingle-precision-constant
8558 @opindex fsingle-precision-constant
8559 Treat floating-point constants as single precision instead of
8560 implicitly converting them to double-precision constants.
8562 @item -fcx-limited-range
8563 @opindex fcx-limited-range
8564 When enabled, this option states that a range reduction step is not
8565 needed when performing complex division.  Also, there is no checking
8566 whether the result of a complex multiplication or division is @code{NaN
8567 + I*NaN}, with an attempt to rescue the situation in that case.  The
8568 default is @option{-fno-cx-limited-range}, but is enabled by
8569 @option{-ffast-math}.
8571 This option controls the default setting of the ISO C99
8572 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8573 all languages.
8575 @item -fcx-fortran-rules
8576 @opindex fcx-fortran-rules
8577 Complex multiplication and division follow Fortran rules.  Range
8578 reduction is done as part of complex division, but there is no checking
8579 whether the result of a complex multiplication or division is @code{NaN
8580 + I*NaN}, with an attempt to rescue the situation in that case.
8582 The default is @option{-fno-cx-fortran-rules}.
8584 @end table
8586 The following options control optimizations that may improve
8587 performance, but are not enabled by any @option{-O} options.  This
8588 section includes experimental options that may produce broken code.
8590 @table @gcctabopt
8591 @item -fbranch-probabilities
8592 @opindex fbranch-probabilities
8593 After running a program compiled with @option{-fprofile-arcs}
8594 (@pxref{Debugging Options,, Options for Debugging Your Program or
8595 @command{gcc}}), you can compile it a second time using
8596 @option{-fbranch-probabilities}, to improve optimizations based on
8597 the number of times each branch was taken.  When a program
8598 compiled with @option{-fprofile-arcs} exits, it saves arc execution
8599 counts to a file called @file{@var{sourcename}.gcda} for each source
8600 file.  The information in this data file is very dependent on the
8601 structure of the generated code, so you must use the same source code
8602 and the same optimization options for both compilations.
8604 With @option{-fbranch-probabilities}, GCC puts a
8605 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8606 These can be used to improve optimization.  Currently, they are only
8607 used in one place: in @file{reorg.c}, instead of guessing which path a
8608 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8609 exactly determine which path is taken more often.
8611 @item -fprofile-values
8612 @opindex fprofile-values
8613 If combined with @option{-fprofile-arcs}, it adds code so that some
8614 data about values of expressions in the program is gathered.
8616 With @option{-fbranch-probabilities}, it reads back the data gathered
8617 from profiling values of expressions for usage in optimizations.
8619 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8621 @item -fvpt
8622 @opindex fvpt
8623 If combined with @option{-fprofile-arcs}, this option instructs the compiler
8624 to add code to gather information about values of expressions.
8626 With @option{-fbranch-probabilities}, it reads back the data gathered
8627 and actually performs the optimizations based on them.
8628 Currently the optimizations include specialization of division operations
8629 using the knowledge about the value of the denominator.
8631 @item -frename-registers
8632 @opindex frename-registers
8633 Attempt to avoid false dependencies in scheduled code by making use
8634 of registers left over after register allocation.  This optimization
8635 most benefits processors with lots of registers.  Depending on the
8636 debug information format adopted by the target, however, it can
8637 make debugging impossible, since variables no longer stay in
8638 a ``home register''.
8640 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8642 @item -ftracer
8643 @opindex ftracer
8644 Perform tail duplication to enlarge superblock size.  This transformation
8645 simplifies the control flow of the function allowing other optimizations to do
8646 a better job.
8648 Enabled with @option{-fprofile-use}.
8650 @item -funroll-loops
8651 @opindex funroll-loops
8652 Unroll loops whose number of iterations can be determined at compile time or
8653 upon entry to the loop.  @option{-funroll-loops} implies
8654 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8655 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8656 a small constant number of iterations).  This option makes code larger, and may
8657 or may not make it run faster.
8659 Enabled with @option{-fprofile-use}.
8661 @item -funroll-all-loops
8662 @opindex funroll-all-loops
8663 Unroll all loops, even if their number of iterations is uncertain when
8664 the loop is entered.  This usually makes programs run more slowly.
8665 @option{-funroll-all-loops} implies the same options as
8666 @option{-funroll-loops}.
8668 @item -fpeel-loops
8669 @opindex fpeel-loops
8670 Peels loops for which there is enough information that they do not
8671 roll much (from profile feedback).  It also turns on complete loop peeling
8672 (i.e.@: complete removal of loops with small constant number of iterations).
8674 Enabled with @option{-fprofile-use}.
8676 @item -fmove-loop-invariants
8677 @opindex fmove-loop-invariants
8678 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8679 at level @option{-O1}
8681 @item -funswitch-loops
8682 @opindex funswitch-loops
8683 Move branches with loop invariant conditions out of the loop, with duplicates
8684 of the loop on both branches (modified according to result of the condition).
8686 @item -ffunction-sections
8687 @itemx -fdata-sections
8688 @opindex ffunction-sections
8689 @opindex fdata-sections
8690 Place each function or data item into its own section in the output
8691 file if the target supports arbitrary sections.  The name of the
8692 function or the name of the data item determines the section's name
8693 in the output file.
8695 Use these options on systems where the linker can perform optimizations
8696 to improve locality of reference in the instruction space.  Most systems
8697 using the ELF object format and SPARC processors running Solaris 2 have
8698 linkers with such optimizations.  AIX may have these optimizations in
8699 the future.
8701 Only use these options when there are significant benefits from doing
8702 so.  When you specify these options, the assembler and linker
8703 create larger object and executable files and are also slower.
8704 You cannot use @code{gprof} on all systems if you
8705 specify this option, and you may have problems with debugging if
8706 you specify both this option and @option{-g}.
8708 @item -fbranch-target-load-optimize
8709 @opindex fbranch-target-load-optimize
8710 Perform branch target register load optimization before prologue / epilogue
8711 threading.
8712 The use of target registers can typically be exposed only during reload,
8713 thus hoisting loads out of loops and doing inter-block scheduling needs
8714 a separate optimization pass.
8716 @item -fbranch-target-load-optimize2
8717 @opindex fbranch-target-load-optimize2
8718 Perform branch target register load optimization after prologue / epilogue
8719 threading.
8721 @item -fbtr-bb-exclusive
8722 @opindex fbtr-bb-exclusive
8723 When performing branch target register load optimization, don't reuse
8724 branch target registers within any basic block.
8726 @item -fstack-protector
8727 @opindex fstack-protector
8728 Emit extra code to check for buffer overflows, such as stack smashing
8729 attacks.  This is done by adding a guard variable to functions with
8730 vulnerable objects.  This includes functions that call @code{alloca}, and
8731 functions with buffers larger than 8 bytes.  The guards are initialized
8732 when a function is entered and then checked when the function exits.
8733 If a guard check fails, an error message is printed and the program exits.
8735 @item -fstack-protector-all
8736 @opindex fstack-protector-all
8737 Like @option{-fstack-protector} except that all functions are protected.
8739 @item -fsection-anchors
8740 @opindex fsection-anchors
8741 Try to reduce the number of symbolic address calculations by using
8742 shared ``anchor'' symbols to address nearby objects.  This transformation
8743 can help to reduce the number of GOT entries and GOT accesses on some
8744 targets.
8746 For example, the implementation of the following function @code{foo}:
8748 @smallexample
8749 static int a, b, c;
8750 int foo (void) @{ return a + b + c; @}
8751 @end smallexample
8753 @noindent
8754 usually calculates the addresses of all three variables, but if you
8755 compile it with @option{-fsection-anchors}, it accesses the variables
8756 from a common anchor point instead.  The effect is similar to the
8757 following pseudocode (which isn't valid C):
8759 @smallexample
8760 int foo (void)
8762   register int *xr = &x;
8763   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8765 @end smallexample
8767 Not all targets support this option.
8769 @item --param @var{name}=@var{value}
8770 @opindex param
8771 In some places, GCC uses various constants to control the amount of
8772 optimization that is done.  For example, GCC does not inline functions
8773 that contain more than a certain number of instructions.  You can
8774 control some of these constants on the command line using the
8775 @option{--param} option.
8777 The names of specific parameters, and the meaning of the values, are
8778 tied to the internals of the compiler, and are subject to change
8779 without notice in future releases.
8781 In each case, the @var{value} is an integer.  The allowable choices for
8782 @var{name} are:
8784 @table @gcctabopt
8785 @item predictable-branch-outcome
8786 When branch is predicted to be taken with probability lower than this threshold
8787 (in percent), then it is considered well predictable. The default is 10.
8789 @item max-crossjump-edges
8790 The maximum number of incoming edges to consider for cross-jumping.
8791 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8792 the number of edges incoming to each block.  Increasing values mean
8793 more aggressive optimization, making the compilation time increase with
8794 probably small improvement in executable size.
8796 @item min-crossjump-insns
8797 The minimum number of instructions that must be matched at the end
8798 of two blocks before cross-jumping is performed on them.  This
8799 value is ignored in the case where all instructions in the block being
8800 cross-jumped from are matched.  The default value is 5.
8802 @item max-grow-copy-bb-insns
8803 The maximum code size expansion factor when copying basic blocks
8804 instead of jumping.  The expansion is relative to a jump instruction.
8805 The default value is 8.
8807 @item max-goto-duplication-insns
8808 The maximum number of instructions to duplicate to a block that jumps
8809 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8810 passes, GCC factors computed gotos early in the compilation process,
8811 and unfactors them as late as possible.  Only computed jumps at the
8812 end of a basic blocks with no more than max-goto-duplication-insns are
8813 unfactored.  The default value is 8.
8815 @item max-delay-slot-insn-search
8816 The maximum number of instructions to consider when looking for an
8817 instruction to fill a delay slot.  If more than this arbitrary number of
8818 instructions are searched, the time savings from filling the delay slot
8819 are minimal, so stop searching.  Increasing values mean more
8820 aggressive optimization, making the compilation time increase with probably
8821 small improvement in execution time.
8823 @item max-delay-slot-live-search
8824 When trying to fill delay slots, the maximum number of instructions to
8825 consider when searching for a block with valid live register
8826 information.  Increasing this arbitrarily chosen value means more
8827 aggressive optimization, increasing the compilation time.  This parameter
8828 should be removed when the delay slot code is rewritten to maintain the
8829 control-flow graph.
8831 @item max-gcse-memory
8832 The approximate maximum amount of memory that can be allocated in
8833 order to perform the global common subexpression elimination
8834 optimization.  If more memory than specified is required, the
8835 optimization is not done.
8837 @item max-gcse-insertion-ratio
8838 If the ratio of expression insertions to deletions is larger than this value
8839 for any expression, then RTL PRE inserts or removes the expression and thus
8840 leaves partially redundant computations in the instruction stream.  The default value is 20.
8842 @item max-pending-list-length
8843 The maximum number of pending dependencies scheduling allows
8844 before flushing the current state and starting over.  Large functions
8845 with few branches or calls can create excessively large lists which
8846 needlessly consume memory and resources.
8848 @item max-modulo-backtrack-attempts
8849 The maximum number of backtrack attempts the scheduler should make
8850 when modulo scheduling a loop.  Larger values can exponentially increase
8851 compilation time.
8853 @item max-inline-insns-single
8854 Several parameters control the tree inliner used in GCC@.
8855 This number sets the maximum number of instructions (counted in GCC's
8856 internal representation) in a single function that the tree inliner
8857 considers for inlining.  This only affects functions declared
8858 inline and methods implemented in a class declaration (C++).
8859 The default value is 400.
8861 @item max-inline-insns-auto
8862 When you use @option{-finline-functions} (included in @option{-O3}),
8863 a lot of functions that would otherwise not be considered for inlining
8864 by the compiler are investigated.  To those functions, a different
8865 (more restrictive) limit compared to functions declared inline can
8866 be applied.
8867 The default value is 40.
8869 @item large-function-insns
8870 The limit specifying really large functions.  For functions larger than this
8871 limit after inlining, inlining is constrained by
8872 @option{--param large-function-growth}.  This parameter is useful primarily
8873 to avoid extreme compilation time caused by non-linear algorithms used by the
8874 back end.
8875 The default value is 2700.
8877 @item large-function-growth
8878 Specifies maximal growth of large function caused by inlining in percents.
8879 The default value is 100 which limits large function growth to 2.0 times
8880 the original size.
8882 @item large-unit-insns
8883 The limit specifying large translation unit.  Growth caused by inlining of
8884 units larger than this limit is limited by @option{--param inline-unit-growth}.
8885 For small units this might be too tight.
8886 For example, consider a unit consisting of function A
8887 that is inline and B that just calls A three times.  If B is small relative to
8888 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8889 large units consisting of small inlineable functions, however, the overall unit
8890 growth limit is needed to avoid exponential explosion of code size.  Thus for
8891 smaller units, the size is increased to @option{--param large-unit-insns}
8892 before applying @option{--param inline-unit-growth}.  The default is 10000.
8894 @item inline-unit-growth
8895 Specifies maximal overall growth of the compilation unit caused by inlining.
8896 The default value is 30 which limits unit growth to 1.3 times the original
8897 size.
8899 @item ipcp-unit-growth
8900 Specifies maximal overall growth of the compilation unit caused by
8901 interprocedural constant propagation.  The default value is 10 which limits
8902 unit growth to 1.1 times the original size.
8904 @item large-stack-frame
8905 The limit specifying large stack frames.  While inlining the algorithm is trying
8906 to not grow past this limit too much.  The default value is 256 bytes.
8908 @item large-stack-frame-growth
8909 Specifies maximal growth of large stack frames caused by inlining in percents.
8910 The default value is 1000 which limits large stack frame growth to 11 times
8911 the original size.
8913 @item max-inline-insns-recursive
8914 @itemx max-inline-insns-recursive-auto
8915 Specifies the maximum number of instructions an out-of-line copy of a
8916 self-recursive inline
8917 function can grow into by performing recursive inlining.
8919 For functions declared inline, @option{--param max-inline-insns-recursive} is
8920 taken into account.  For functions not declared inline, recursive inlining
8921 happens only when @option{-finline-functions} (included in @option{-O3}) is
8922 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8923 default value is 450.
8925 @item max-inline-recursive-depth
8926 @itemx max-inline-recursive-depth-auto
8927 Specifies the maximum recursion depth used for recursive inlining.
8929 For functions declared inline, @option{--param max-inline-recursive-depth} is
8930 taken into account.  For functions not declared inline, recursive inlining
8931 happens only when @option{-finline-functions} (included in @option{-O3}) is
8932 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8933 default value is 8.
8935 @item min-inline-recursive-probability
8936 Recursive inlining is profitable only for function having deep recursion
8937 in average and can hurt for function having little recursion depth by
8938 increasing the prologue size or complexity of function body to other
8939 optimizers.
8941 When profile feedback is available (see @option{-fprofile-generate}) the actual
8942 recursion depth can be guessed from probability that function recurses via a
8943 given call expression.  This parameter limits inlining only to call expressions
8944 whose probability exceeds the given threshold (in percents).
8945 The default value is 10.
8947 @item early-inlining-insns
8948 Specify growth that the early inliner can make.  In effect it increases
8949 the amount of inlining for code having a large abstraction penalty.
8950 The default value is 10.
8952 @item max-early-inliner-iterations
8953 @itemx max-early-inliner-iterations
8954 Limit of iterations of the early inliner.  This basically bounds
8955 the number of nested indirect calls the early inliner can resolve.
8956 Deeper chains are still handled by late inlining.
8958 @item comdat-sharing-probability
8959 @itemx comdat-sharing-probability
8960 Probability (in percent) that C++ inline function with comdat visibility
8961 are shared across multiple compilation units.  The default value is 20.
8963 @item min-vect-loop-bound
8964 The minimum number of iterations under which loops are not vectorized
8965 when @option{-ftree-vectorize} is used.  The number of iterations after
8966 vectorization needs to be greater than the value specified by this option
8967 to allow vectorization.  The default value is 0.
8969 @item gcse-cost-distance-ratio
8970 Scaling factor in calculation of maximum distance an expression
8971 can be moved by GCSE optimizations.  This is currently supported only in the
8972 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
8973 is with simple expressions, i.e., the expressions that have cost
8974 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
8975 hoisting of simple expressions.  The default value is 10.
8977 @item gcse-unrestricted-cost
8978 Cost, roughly measured as the cost of a single typical machine
8979 instruction, at which GCSE optimizations do not constrain
8980 the distance an expression can travel.  This is currently
8981 supported only in the code hoisting pass.  The lesser the cost,
8982 the more aggressive code hoisting is.  Specifying 0 
8983 allows all expressions to travel unrestricted distances.
8984 The default value is 3.
8986 @item max-hoist-depth
8987 The depth of search in the dominator tree for expressions to hoist.
8988 This is used to avoid quadratic behavior in hoisting algorithm.
8989 The value of 0 does not limit on the search, but may slow down compilation
8990 of huge functions.  The default value is 30.
8992 @item max-tail-merge-comparisons
8993 The maximum amount of similar bbs to compare a bb with.  This is used to
8994 avoid quadratic behavior in tree tail merging.  The default value is 10.
8996 @item max-tail-merge-iterations
8997 The maximum amount of iterations of the pass over the function.  This is used to
8998 limit compilation time in tree tail merging.  The default value is 2.
9000 @item max-unrolled-insns
9001 The maximum number of instructions that a loop may have to be unrolled.
9002 If a loop is unrolled, this parameter also determines how many times
9003 the loop code is unrolled.
9005 @item max-average-unrolled-insns
9006 The maximum number of instructions biased by probabilities of their execution
9007 that a loop may have to be unrolled.  If a loop is unrolled,
9008 this parameter also determines how many times the loop code is unrolled.
9010 @item max-unroll-times
9011 The maximum number of unrollings of a single loop.
9013 @item max-peeled-insns
9014 The maximum number of instructions that a loop may have to be peeled.
9015 If a loop is peeled, this parameter also determines how many times
9016 the loop code is peeled.
9018 @item max-peel-times
9019 The maximum number of peelings of a single loop.
9021 @item max-completely-peeled-insns
9022 The maximum number of insns of a completely peeled loop.
9024 @item max-completely-peel-times
9025 The maximum number of iterations of a loop to be suitable for complete peeling.
9027 @item max-completely-peel-loop-nest-depth
9028 The maximum depth of a loop nest suitable for complete peeling.
9030 @item max-unswitch-insns
9031 The maximum number of insns of an unswitched loop.
9033 @item max-unswitch-level
9034 The maximum number of branches unswitched in a single loop.
9036 @item lim-expensive
9037 The minimum cost of an expensive expression in the loop invariant motion.
9039 @item iv-consider-all-candidates-bound
9040 Bound on number of candidates for induction variables, below which
9041 all candidates are considered for each use in induction variable
9042 optimizations.  If there are more candidates than this,
9043 only the most relevant ones are considered to avoid quadratic time complexity.
9045 @item iv-max-considered-uses
9046 The induction variable optimizations give up on loops that contain more
9047 induction variable uses.
9049 @item iv-always-prune-cand-set-bound
9050 If the number of candidates in the set is smaller than this value,
9051 always try to remove unnecessary ivs from the set
9052 when adding a new one.
9054 @item scev-max-expr-size
9055 Bound on size of expressions used in the scalar evolutions analyzer.
9056 Large expressions slow the analyzer.
9058 @item scev-max-expr-complexity
9059 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9060 Complex expressions slow the analyzer.
9062 @item omega-max-vars
9063 The maximum number of variables in an Omega constraint system.
9064 The default value is 128.
9066 @item omega-max-geqs
9067 The maximum number of inequalities in an Omega constraint system.
9068 The default value is 256.
9070 @item omega-max-eqs
9071 The maximum number of equalities in an Omega constraint system.
9072 The default value is 128.
9074 @item omega-max-wild-cards
9075 The maximum number of wildcard variables that the Omega solver is
9076 able to insert.  The default value is 18.
9078 @item omega-hash-table-size
9079 The size of the hash table in the Omega solver.  The default value is
9080 550.
9082 @item omega-max-keys
9083 The maximal number of keys used by the Omega solver.  The default
9084 value is 500.
9086 @item omega-eliminate-redundant-constraints
9087 When set to 1, use expensive methods to eliminate all redundant
9088 constraints.  The default value is 0.
9090 @item vect-max-version-for-alignment-checks
9091 The maximum number of run-time checks that can be performed when
9092 doing loop versioning for alignment in the vectorizer.  See option
9093 @option{-ftree-vect-loop-version} for more information.
9095 @item vect-max-version-for-alias-checks
9096 The maximum number of run-time checks that can be performed when
9097 doing loop versioning for alias in the vectorizer.  See option
9098 @option{-ftree-vect-loop-version} for more information.
9100 @item max-iterations-to-track
9101 The maximum number of iterations of a loop the brute-force algorithm
9102 for analysis of the number of iterations of the loop tries to evaluate.
9104 @item hot-bb-count-fraction
9105 Select fraction of the maximal count of repetitions of basic block in program
9106 given basic block needs to have to be considered hot.
9108 @item hot-bb-frequency-fraction
9109 Select fraction of the entry block frequency of executions of basic block in
9110 function given basic block needs to have to be considered hot.
9112 @item max-predicted-iterations
9113 The maximum number of loop iterations we predict statically.  This is useful
9114 in cases where a function contains a single loop with known bound and
9115 another loop with unknown bound.
9116 The known number of iterations is predicted correctly, while
9117 the unknown number of iterations average to roughly 10.  This means that the
9118 loop without bounds appears artificially cold relative to the other one.
9120 @item align-threshold
9122 Select fraction of the maximal frequency of executions of a basic block in
9123 a function to align the basic block.
9125 @item align-loop-iterations
9127 A loop expected to iterate at least the selected number of iterations is
9128 aligned.
9130 @item tracer-dynamic-coverage
9131 @itemx tracer-dynamic-coverage-feedback
9133 This value is used to limit superblock formation once the given percentage of
9134 executed instructions is covered.  This limits unnecessary code size
9135 expansion.
9137 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9138 feedback is available.  The real profiles (as opposed to statically estimated
9139 ones) are much less balanced allowing the threshold to be larger value.
9141 @item tracer-max-code-growth
9142 Stop tail duplication once code growth has reached given percentage.  This is
9143 a rather artificial limit, as most of the duplicates are eliminated later in
9144 cross jumping, so it may be set to much higher values than is the desired code
9145 growth.
9147 @item tracer-min-branch-ratio
9149 Stop reverse growth when the reverse probability of best edge is less than this
9150 threshold (in percent).
9152 @item tracer-min-branch-ratio
9153 @itemx tracer-min-branch-ratio-feedback
9155 Stop forward growth if the best edge has probability lower than this
9156 threshold.
9158 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9159 compilation for profile feedback and one for compilation without.  The value
9160 for compilation with profile feedback needs to be more conservative (higher) in
9161 order to make tracer effective.
9163 @item max-cse-path-length
9165 The maximum number of basic blocks on path that CSE considers.
9166 The default is 10.
9168 @item max-cse-insns
9169 The maximum number of instructions CSE processes before flushing.
9170 The default is 1000.
9172 @item ggc-min-expand
9174 GCC uses a garbage collector to manage its own memory allocation.  This
9175 parameter specifies the minimum percentage by which the garbage
9176 collector's heap should be allowed to expand between collections.
9177 Tuning this may improve compilation speed; it has no effect on code
9178 generation.
9180 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9181 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9182 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9183 GCC is not able to calculate RAM on a particular platform, the lower
9184 bound of 30% is used.  Setting this parameter and
9185 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9186 every opportunity.  This is extremely slow, but can be useful for
9187 debugging.
9189 @item ggc-min-heapsize
9191 Minimum size of the garbage collector's heap before it begins bothering
9192 to collect garbage.  The first collection occurs after the heap expands
9193 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9194 tuning this may improve compilation speed, and has no effect on code
9195 generation.
9197 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9198 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9199 with a lower bound of 4096 (four megabytes) and an upper bound of
9200 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9201 particular platform, the lower bound is used.  Setting this parameter
9202 very large effectively disables garbage collection.  Setting this
9203 parameter and @option{ggc-min-expand} to zero causes a full collection
9204 to occur at every opportunity.
9206 @item max-reload-search-insns
9207 The maximum number of instruction reload should look backward for equivalent
9208 register.  Increasing values mean more aggressive optimization, making the
9209 compilation time increase with probably slightly better performance.
9210 The default value is 100.
9212 @item max-cselib-memory-locations
9213 The maximum number of memory locations cselib should take into account.
9214 Increasing values mean more aggressive optimization, making the compilation time
9215 increase with probably slightly better performance.  The default value is 500.
9217 @item reorder-blocks-duplicate
9218 @itemx reorder-blocks-duplicate-feedback
9220 Used by the basic block reordering pass to decide whether to use unconditional
9221 branch or duplicate the code on its destination.  Code is duplicated when its
9222 estimated size is smaller than this value multiplied by the estimated size of
9223 unconditional jump in the hot spots of the program.
9225 The @option{reorder-block-duplicate-feedback} is used only when profile
9226 feedback is available.  It may be set to higher values than
9227 @option{reorder-block-duplicate} since information about the hot spots is more
9228 accurate.
9230 @item max-sched-ready-insns
9231 The maximum number of instructions ready to be issued the scheduler should
9232 consider at any given time during the first scheduling pass.  Increasing
9233 values mean more thorough searches, making the compilation time increase
9234 with probably little benefit.  The default value is 100.
9236 @item max-sched-region-blocks
9237 The maximum number of blocks in a region to be considered for
9238 interblock scheduling.  The default value is 10.
9240 @item max-pipeline-region-blocks
9241 The maximum number of blocks in a region to be considered for
9242 pipelining in the selective scheduler.  The default value is 15.
9244 @item max-sched-region-insns
9245 The maximum number of insns in a region to be considered for
9246 interblock scheduling.  The default value is 100.
9248 @item max-pipeline-region-insns
9249 The maximum number of insns in a region to be considered for
9250 pipelining in the selective scheduler.  The default value is 200.
9252 @item min-spec-prob
9253 The minimum probability (in percents) of reaching a source block
9254 for interblock speculative scheduling.  The default value is 40.
9256 @item max-sched-extend-regions-iters
9257 The maximum number of iterations through CFG to extend regions.
9258 A value of 0 (the default) disables region extensions.
9260 @item max-sched-insn-conflict-delay
9261 The maximum conflict delay for an insn to be considered for speculative motion.
9262 The default value is 3.
9264 @item sched-spec-prob-cutoff
9265 The minimal probability of speculation success (in percents), so that
9266 speculative insns are scheduled.
9267 The default value is 40.
9269 @item sched-spec-state-edge-prob-cutoff
9270 The minimum probability an edge must have for the scheduler to save its
9271 state across it.
9272 The default value is 10.
9274 @item sched-mem-true-dep-cost
9275 Minimal distance (in CPU cycles) between store and load targeting same
9276 memory locations.  The default value is 1.
9278 @item selsched-max-lookahead
9279 The maximum size of the lookahead window of selective scheduling.  It is a
9280 depth of search for available instructions.
9281 The default value is 50.
9283 @item selsched-max-sched-times
9284 The maximum number of times that an instruction is scheduled during
9285 selective scheduling.  This is the limit on the number of iterations
9286 through which the instruction may be pipelined.  The default value is 2.
9288 @item selsched-max-insns-to-rename
9289 The maximum number of best instructions in the ready list that are considered
9290 for renaming in the selective scheduler.  The default value is 2.
9292 @item sms-min-sc
9293 The minimum value of stage count that swing modulo scheduler
9294 generates.  The default value is 2.
9296 @item max-last-value-rtl
9297 The maximum size measured as number of RTLs that can be recorded in an expression
9298 in combiner for a pseudo register as last known value of that register.  The default
9299 is 10000.
9301 @item integer-share-limit
9302 Small integer constants can use a shared data structure, reducing the
9303 compiler's memory usage and increasing its speed.  This sets the maximum
9304 value of a shared integer constant.  The default value is 256.
9306 @item ssp-buffer-size
9307 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9308 protection when @option{-fstack-protection} is used.
9310 @item max-jump-thread-duplication-stmts
9311 Maximum number of statements allowed in a block that needs to be
9312 duplicated when threading jumps.
9314 @item max-fields-for-field-sensitive
9315 Maximum number of fields in a structure treated in
9316 a field sensitive manner during pointer analysis.  The default is zero
9317 for @option{-O0} and @option{-O1},
9318 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9320 @item prefetch-latency
9321 Estimate on average number of instructions that are executed before
9322 prefetch finishes.  The distance prefetched ahead is proportional
9323 to this constant.  Increasing this number may also lead to less
9324 streams being prefetched (see @option{simultaneous-prefetches}).
9326 @item simultaneous-prefetches
9327 Maximum number of prefetches that can run at the same time.
9329 @item l1-cache-line-size
9330 The size of cache line in L1 cache, in bytes.
9332 @item l1-cache-size
9333 The size of L1 cache, in kilobytes.
9335 @item l2-cache-size
9336 The size of L2 cache, in kilobytes.
9338 @item min-insn-to-prefetch-ratio
9339 The minimum ratio between the number of instructions and the
9340 number of prefetches to enable prefetching in a loop.
9342 @item prefetch-min-insn-to-mem-ratio
9343 The minimum ratio between the number of instructions and the
9344 number of memory references to enable prefetching in a loop.
9346 @item use-canonical-types
9347 Whether the compiler should use the ``canonical'' type system.  By
9348 default, this should always be 1, which uses a more efficient internal
9349 mechanism for comparing types in C++ and Objective-C++.  However, if
9350 bugs in the canonical type system are causing compilation failures,
9351 set this value to 0 to disable canonical types.
9353 @item switch-conversion-max-branch-ratio
9354 Switch initialization conversion refuses to create arrays that are
9355 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9356 branches in the switch.
9358 @item max-partial-antic-length
9359 Maximum length of the partial antic set computed during the tree
9360 partial redundancy elimination optimization (@option{-ftree-pre}) when
9361 optimizing at @option{-O3} and above.  For some sorts of source code
9362 the enhanced partial redundancy elimination optimization can run away,
9363 consuming all of the memory available on the host machine.  This
9364 parameter sets a limit on the length of the sets that are computed,
9365 which prevents the runaway behavior.  Setting a value of 0 for
9366 this parameter allows an unlimited set length.
9368 @item sccvn-max-scc-size
9369 Maximum size of a strongly connected component (SCC) during SCCVN
9370 processing.  If this limit is hit, SCCVN processing for the whole
9371 function is not done and optimizations depending on it are
9372 disabled.  The default maximum SCC size is 10000.
9374 @item sccvn-max-alias-queries-per-access
9375 Maximum number of alias-oracle queries we perform when looking for
9376 redundancies for loads and stores.  If this limit is hit the search
9377 is aborted and the load or store is not considered redundant.  The
9378 number of queries is algorithmically limited to the number of
9379 stores on all paths from the load to the function entry.
9380 The default maxmimum number of queries is 1000.
9382 @item ira-max-loops-num
9383 IRA uses regional register allocation by default.  If a function
9384 contains more loops than the number given by this parameter, only at most
9385 the given number of the most frequently-executed loops form regions
9386 for regional register allocation.  The default value of the
9387 parameter is 100.
9389 @item ira-max-conflict-table-size 
9390 Although IRA uses a sophisticated algorithm to compress the conflict
9391 table, the table can still require excessive amounts of memory for
9392 huge functions.  If the conflict table for a function could be more
9393 than the size in MB given by this parameter, the register allocator
9394 instead uses a faster, simpler, and lower-quality
9395 algorithm that does not require building a pseudo-register conflict table.  
9396 The default value of the parameter is 2000.
9398 @item ira-loop-reserved-regs
9399 IRA can be used to evaluate more accurate register pressure in loops
9400 for decisions to move loop invariants (see @option{-O3}).  The number
9401 of available registers reserved for some other purposes is given
9402 by this parameter.  The default value of the parameter is 2, which is
9403 the minimal number of registers needed by typical instructions.
9404 This value is the best found from numerous experiments.
9406 @item loop-invariant-max-bbs-in-loop
9407 Loop invariant motion can be very expensive, both in compilation time and
9408 in amount of needed compile-time memory, with very large loops.  Loops
9409 with more basic blocks than this parameter won't have loop invariant
9410 motion optimization performed on them.  The default value of the
9411 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9413 @item loop-max-datarefs-for-datadeps
9414 Building data dapendencies is expensive for very large loops.  This
9415 parameter limits the number of data references in loops that are
9416 considered for data dependence analysis.  These large loops are no
9417 handled by the optimizations using loop data dependencies.
9418 The default value is 1000.
9420 @item max-vartrack-size
9421 Sets a maximum number of hash table slots to use during variable
9422 tracking dataflow analysis of any function.  If this limit is exceeded
9423 with variable tracking at assignments enabled, analysis for that
9424 function is retried without it, after removing all debug insns from
9425 the function.  If the limit is exceeded even without debug insns, var
9426 tracking analysis is completely disabled for the function.  Setting
9427 the parameter to zero makes it unlimited.
9429 @item max-vartrack-expr-depth
9430 Sets a maximum number of recursion levels when attempting to map
9431 variable names or debug temporaries to value expressions.  This trades
9432 compilation time for more complete debug information.  If this is set too
9433 low, value expressions that are available and could be represented in
9434 debug information may end up not being used; setting this higher may
9435 enable the compiler to find more complex debug expressions, but compile
9436 time and memory use may grow.  The default is 12.
9438 @item min-nondebug-insn-uid
9439 Use uids starting at this parameter for nondebug insns.  The range below
9440 the parameter is reserved exclusively for debug insns created by
9441 @option{-fvar-tracking-assignments}, but debug insns may get
9442 (non-overlapping) uids above it if the reserved range is exhausted.
9444 @item ipa-sra-ptr-growth-factor
9445 IPA-SRA replaces a pointer to an aggregate with one or more new
9446 parameters only when their cumulative size is less or equal to
9447 @option{ipa-sra-ptr-growth-factor} times the size of the original
9448 pointer parameter.
9450 @item tm-max-aggregate-size
9451 When making copies of thread-local variables in a transaction, this
9452 parameter specifies the size in bytes after which variables are
9453 saved with the logging functions as opposed to save/restore code
9454 sequence pairs.  This option only applies when using
9455 @option{-fgnu-tm}.
9457 @item graphite-max-nb-scop-params
9458 To avoid exponential effects in the Graphite loop transforms, the
9459 number of parameters in a Static Control Part (SCoP) is bounded.  The
9460 default value is 10 parameters.  A variable whose value is unknown at
9461 compilation time and defined outside a SCoP is a parameter of the SCoP.
9463 @item graphite-max-bbs-per-function
9464 To avoid exponential effects in the detection of SCoPs, the size of
9465 the functions analyzed by Graphite is bounded.  The default value is
9466 100 basic blocks.
9468 @item loop-block-tile-size
9469 Loop blocking or strip mining transforms, enabled with
9470 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9471 loop in the loop nest by a given number of iterations.  The strip
9472 length can be changed using the @option{loop-block-tile-size}
9473 parameter.  The default value is 51 iterations.
9475 @item ipa-cp-value-list-size
9476 IPA-CP attempts to track all possible values and types passed to a function's
9477 parameter in order to propagate them and perform devirtualization.
9478 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9479 stores per one formal parameter of a function.
9481 @item lto-partitions
9482 Specify desired number of partitions produced during WHOPR compilation.
9483 The number of partitions should exceed the number of CPUs used for compilation.
9484 The default value is 32.
9486 @item lto-minpartition
9487 Size of minimal partition for WHOPR (in estimated instructions).
9488 This prevents expenses of splitting very small programs into too many
9489 partitions.
9491 @item cxx-max-namespaces-for-diagnostic-help
9492 The maximum number of namespaces to consult for suggestions when C++
9493 name lookup fails for an identifier.  The default is 1000.
9495 @item sink-frequency-threshold
9496 The maximum relative execution frequency (in percents) of the target block
9497 relative to a statement's original block to allow statement sinking of a
9498 statement.  Larger numbers result in more aggressive statement sinking.
9499 The default value is 75.  A small positive adjustment is applied for
9500 statements with memory operands as those are even more profitable so sink.
9502 @item max-stores-to-sink
9503 The maximum number of conditional stores paires that can be sunk.  Set to 0
9504 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9505 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9507 @item allow-load-data-races
9508 Allow optimizers to introduce new data races on loads.
9509 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9510 unless implicitly set by the @option{-fmemory-model=} option.
9512 @item allow-store-data-races
9513 Allow optimizers to introduce new data races on stores.
9514 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9515 unless implicitly set by the @option{-fmemory-model=} option.
9517 @item allow-packed-load-data-races
9518 Allow optimizers to introduce new data races on packed data loads.
9519 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9520 unless implicitly set by the @option{-fmemory-model=} option.
9522 @item allow-packed-store-data-races
9523 Allow optimizers to introduce new data races on packed data stores.
9524 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9525 unless implicitly set by the @option{-fmemory-model=} option.
9527 @item case-values-threshold
9528 The smallest number of different values for which it is best to use a
9529 jump-table instead of a tree of conditional branches.  If the value is
9530 0, use the default for the machine.  The default is 0.
9532 @item tree-reassoc-width
9533 Set the maximum number of instructions executed in parallel in
9534 reassociated tree. This parameter overrides target dependent
9535 heuristics used by default if has non zero value.
9537 @item sched-pressure-algorithm
9538 Choose between the two available implementations of
9539 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
9540 and is the more likely to prevent instructions from being reordered.
9541 Algorithm 2 was designed to be a compromise between the relatively
9542 conservative approach taken by algorithm 1 and the rather aggressive
9543 approach taken by the default scheduler.  It relies more heavily on
9544 having a regular register file and accurate register pressure classes.
9545 See @file{haifa-sched.c} in the GCC sources for more details.
9547 The default choice depends on the target.
9549 @item max-slsr-cand-scan
9550 Set the maximum number of existing candidates that will be considered when
9551 seeking a basis for a new straight-line strength reduction candidate.
9553 @end table
9554 @end table
9556 @node Preprocessor Options
9557 @section Options Controlling the Preprocessor
9558 @cindex preprocessor options
9559 @cindex options, preprocessor
9561 These options control the C preprocessor, which is run on each C source
9562 file before actual compilation.
9564 If you use the @option{-E} option, nothing is done except preprocessing.
9565 Some of these options make sense only together with @option{-E} because
9566 they cause the preprocessor output to be unsuitable for actual
9567 compilation.
9569 @table @gcctabopt
9570 @item -Wp,@var{option}
9571 @opindex Wp
9572 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9573 and pass @var{option} directly through to the preprocessor.  If
9574 @var{option} contains commas, it is split into multiple options at the
9575 commas.  However, many options are modified, translated or interpreted
9576 by the compiler driver before being passed to the preprocessor, and
9577 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9578 interface is undocumented and subject to change, so whenever possible
9579 you should avoid using @option{-Wp} and let the driver handle the
9580 options instead.
9582 @item -Xpreprocessor @var{option}
9583 @opindex Xpreprocessor
9584 Pass @var{option} as an option to the preprocessor.  You can use this to
9585 supply system-specific preprocessor options that GCC does not 
9586 recognize.
9588 If you want to pass an option that takes an argument, you must use
9589 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9591 @item -no-integrated-cpp
9592 @opindex no-integrated-cpp
9593 Perform preprocessing as a separate pass before compilation.
9594 By default, GCC performs preprocessing as an integrated part of
9595 input tokenization and parsing.
9596 If this option is provided, the appropriate language front end
9597 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9598 and Objective-C, respectively) is instead invoked twice,
9599 once for preprocessing only and once for actual compilation
9600 of the preprocessed input.
9601 This option may be useful in conjunction with the @option{-B} or
9602 @option{-wrapper} options to specify an alternate preprocessor or
9603 perform additional processing of the program source between
9604 normal preprocessing and compilation.
9605 @end table
9607 @include cppopts.texi
9609 @node Assembler Options
9610 @section Passing Options to the Assembler
9612 @c prevent bad page break with this line
9613 You can pass options to the assembler.
9615 @table @gcctabopt
9616 @item -Wa,@var{option}
9617 @opindex Wa
9618 Pass @var{option} as an option to the assembler.  If @var{option}
9619 contains commas, it is split into multiple options at the commas.
9621 @item -Xassembler @var{option}
9622 @opindex Xassembler
9623 Pass @var{option} as an option to the assembler.  You can use this to
9624 supply system-specific assembler options that GCC does not
9625 recognize.
9627 If you want to pass an option that takes an argument, you must use
9628 @option{-Xassembler} twice, once for the option and once for the argument.
9630 @end table
9632 @node Link Options
9633 @section Options for Linking
9634 @cindex link options
9635 @cindex options, linking
9637 These options come into play when the compiler links object files into
9638 an executable output file.  They are meaningless if the compiler is
9639 not doing a link step.
9641 @table @gcctabopt
9642 @cindex file names
9643 @item @var{object-file-name}
9644 A file name that does not end in a special recognized suffix is
9645 considered to name an object file or library.  (Object files are
9646 distinguished from libraries by the linker according to the file
9647 contents.)  If linking is done, these object files are used as input
9648 to the linker.
9650 @item -c
9651 @itemx -S
9652 @itemx -E
9653 @opindex c
9654 @opindex S
9655 @opindex E
9656 If any of these options is used, then the linker is not run, and
9657 object file names should not be used as arguments.  @xref{Overall
9658 Options}.
9660 @cindex Libraries
9661 @item -l@var{library}
9662 @itemx -l @var{library}
9663 @opindex l
9664 Search the library named @var{library} when linking.  (The second
9665 alternative with the library as a separate argument is only for
9666 POSIX compliance and is not recommended.)
9668 It makes a difference where in the command you write this option; the
9669 linker searches and processes libraries and object files in the order they
9670 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9671 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9672 to functions in @samp{z}, those functions may not be loaded.
9674 The linker searches a standard list of directories for the library,
9675 which is actually a file named @file{lib@var{library}.a}.  The linker
9676 then uses this file as if it had been specified precisely by name.
9678 The directories searched include several standard system directories
9679 plus any that you specify with @option{-L}.
9681 Normally the files found this way are library files---archive files
9682 whose members are object files.  The linker handles an archive file by
9683 scanning through it for members which define symbols that have so far
9684 been referenced but not defined.  But if the file that is found is an
9685 ordinary object file, it is linked in the usual fashion.  The only
9686 difference between using an @option{-l} option and specifying a file name
9687 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9688 and searches several directories.
9690 @item -lobjc
9691 @opindex lobjc
9692 You need this special case of the @option{-l} option in order to
9693 link an Objective-C or Objective-C++ program.
9695 @item -nostartfiles
9696 @opindex nostartfiles
9697 Do not use the standard system startup files when linking.
9698 The standard system libraries are used normally, unless @option{-nostdlib}
9699 or @option{-nodefaultlibs} is used.
9701 @item -nodefaultlibs
9702 @opindex nodefaultlibs
9703 Do not use the standard system libraries when linking.
9704 Only the libraries you specify are passed to the linker, and options
9705 specifying linkage of the system libraries, such as @code{-static-libgcc}
9706 or @code{-shared-libgcc}, are ignored.  
9707 The standard startup files are used normally, unless @option{-nostartfiles}
9708 is used.  
9710 The compiler may generate calls to @code{memcmp},
9711 @code{memset}, @code{memcpy} and @code{memmove}.
9712 These entries are usually resolved by entries in
9713 libc.  These entry points should be supplied through some other
9714 mechanism when this option is specified.
9716 @item -nostdlib
9717 @opindex nostdlib
9718 Do not use the standard system startup files or libraries when linking.
9719 No startup files and only the libraries you specify are passed to
9720 the linker, and options specifying linkage of the system libraries, such as
9721 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
9723 The compiler may generate calls to @code{memcmp}, @code{memset},
9724 @code{memcpy} and @code{memmove}.
9725 These entries are usually resolved by entries in
9726 libc.  These entry points should be supplied through some other
9727 mechanism when this option is specified.
9729 @cindex @option{-lgcc}, use with @option{-nostdlib}
9730 @cindex @option{-nostdlib} and unresolved references
9731 @cindex unresolved references and @option{-nostdlib}
9732 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9733 @cindex @option{-nodefaultlibs} and unresolved references
9734 @cindex unresolved references and @option{-nodefaultlibs}
9735 One of the standard libraries bypassed by @option{-nostdlib} and
9736 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9737 which GCC uses to overcome shortcomings of particular machines, or special
9738 needs for some languages.
9739 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9740 Collection (GCC) Internals},
9741 for more discussion of @file{libgcc.a}.)
9742 In most cases, you need @file{libgcc.a} even when you want to avoid
9743 other standard libraries.  In other words, when you specify @option{-nostdlib}
9744 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9745 This ensures that you have no unresolved references to internal GCC
9746 library subroutines.
9747 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
9748 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
9749 GNU Compiler Collection (GCC) Internals}.)
9751 @item -pie
9752 @opindex pie
9753 Produce a position independent executable on targets that support it.
9754 For predictable results, you must also specify the same set of options
9755 used for compilation (@option{-fpie}, @option{-fPIE},
9756 or model suboptions) when you specify this linker option.
9758 @item -rdynamic
9759 @opindex rdynamic
9760 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9761 that support it. This instructs the linker to add all symbols, not
9762 only used ones, to the dynamic symbol table. This option is needed
9763 for some uses of @code{dlopen} or to allow obtaining backtraces
9764 from within a program.
9766 @item -s
9767 @opindex s
9768 Remove all symbol table and relocation information from the executable.
9770 @item -static
9771 @opindex static
9772 On systems that support dynamic linking, this prevents linking with the shared
9773 libraries.  On other systems, this option has no effect.
9775 @item -shared
9776 @opindex shared
9777 Produce a shared object which can then be linked with other objects to
9778 form an executable.  Not all systems support this option.  For predictable
9779 results, you must also specify the same set of options used for compilation
9780 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
9781 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
9782 needs to build supplementary stub code for constructors to work.  On
9783 multi-libbed systems, @samp{gcc -shared} must select the correct support
9784 libraries to link against.  Failing to supply the correct flags may lead
9785 to subtle defects.  Supplying them in cases where they are not necessary
9786 is innocuous.}
9788 @item -shared-libgcc
9789 @itemx -static-libgcc
9790 @opindex shared-libgcc
9791 @opindex static-libgcc
9792 On systems that provide @file{libgcc} as a shared library, these options
9793 force the use of either the shared or static version, respectively.
9794 If no shared version of @file{libgcc} was built when the compiler was
9795 configured, these options have no effect.
9797 There are several situations in which an application should use the
9798 shared @file{libgcc} instead of the static version.  The most common
9799 of these is when the application wishes to throw and catch exceptions
9800 across different shared libraries.  In that case, each of the libraries
9801 as well as the application itself should use the shared @file{libgcc}.
9803 Therefore, the G++ and GCJ drivers automatically add
9804 @option{-shared-libgcc} whenever you build a shared library or a main
9805 executable, because C++ and Java programs typically use exceptions, so
9806 this is the right thing to do.
9808 If, instead, you use the GCC driver to create shared libraries, you may
9809 find that they are not always linked with the shared @file{libgcc}.
9810 If GCC finds, at its configuration time, that you have a non-GNU linker
9811 or a GNU linker that does not support option @option{--eh-frame-hdr},
9812 it links the shared version of @file{libgcc} into shared libraries
9813 by default.  Otherwise, it takes advantage of the linker and optimizes
9814 away the linking with the shared version of @file{libgcc}, linking with
9815 the static version of libgcc by default.  This allows exceptions to
9816 propagate through such shared libraries, without incurring relocation
9817 costs at library load time.
9819 However, if a library or main executable is supposed to throw or catch
9820 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9821 for the languages used in the program, or using the option
9822 @option{-shared-libgcc}, such that it is linked with the shared
9823 @file{libgcc}.
9825 @item -static-libstdc++
9826 When the @command{g++} program is used to link a C++ program, it
9827 normally automatically links against @option{libstdc++}.  If
9828 @file{libstdc++} is available as a shared library, and the
9829 @option{-static} option is not used, then this links against the
9830 shared version of @file{libstdc++}.  That is normally fine.  However, it
9831 is sometimes useful to freeze the version of @file{libstdc++} used by
9832 the program without going all the way to a fully static link.  The
9833 @option{-static-libstdc++} option directs the @command{g++} driver to
9834 link @file{libstdc++} statically, without necessarily linking other
9835 libraries statically.
9837 @item -symbolic
9838 @opindex symbolic
9839 Bind references to global symbols when building a shared object.  Warn
9840 about any unresolved references (unless overridden by the link editor
9841 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
9842 this option.
9844 @item -T @var{script}
9845 @opindex T
9846 @cindex linker script
9847 Use @var{script} as the linker script.  This option is supported by most
9848 systems using the GNU linker.  On some targets, such as bare-board
9849 targets without an operating system, the @option{-T} option may be required
9850 when linking to avoid references to undefined symbols.
9852 @item -Xlinker @var{option}
9853 @opindex Xlinker
9854 Pass @var{option} as an option to the linker.  You can use this to
9855 supply system-specific linker options that GCC does not recognize.
9857 If you want to pass an option that takes a separate argument, you must use
9858 @option{-Xlinker} twice, once for the option and once for the argument.
9859 For example, to pass @option{-assert definitions}, you must write
9860 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9861 @option{-Xlinker "-assert definitions"}, because this passes the entire
9862 string as a single argument, which is not what the linker expects.
9864 When using the GNU linker, it is usually more convenient to pass
9865 arguments to linker options using the @option{@var{option}=@var{value}}
9866 syntax than as separate arguments.  For example, you can specify
9867 @option{-Xlinker -Map=output.map} rather than
9868 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9869 this syntax for command-line options.
9871 @item -Wl,@var{option}
9872 @opindex Wl
9873 Pass @var{option} as an option to the linker.  If @var{option} contains
9874 commas, it is split into multiple options at the commas.  You can use this
9875 syntax to pass an argument to the option.
9876 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
9877 linker.  When using the GNU linker, you can also get the same effect with
9878 @option{-Wl,-Map=output.map}.
9880 @item -u @var{symbol}
9881 @opindex u
9882 Pretend the symbol @var{symbol} is undefined, to force linking of
9883 library modules to define it.  You can use @option{-u} multiple times with
9884 different symbols to force loading of additional library modules.
9885 @end table
9887 @node Directory Options
9888 @section Options for Directory Search
9889 @cindex directory options
9890 @cindex options, directory search
9891 @cindex search path
9893 These options specify directories to search for header files, for
9894 libraries and for parts of the compiler:
9896 @table @gcctabopt
9897 @item -I@var{dir}
9898 @opindex I
9899 Add the directory @var{dir} to the head of the list of directories to be
9900 searched for header files.  This can be used to override a system header
9901 file, substituting your own version, since these directories are
9902 searched before the system header file directories.  However, you should
9903 not use this option to add directories that contain vendor-supplied
9904 system header files (use @option{-isystem} for that).  If you use more than
9905 one @option{-I} option, the directories are scanned in left-to-right
9906 order; the standard system directories come after.
9908 If a standard system include directory, or a directory specified with
9909 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9910 option is ignored.  The directory is still searched but as a
9911 system directory at its normal position in the system include chain.
9912 This is to ensure that GCC's procedure to fix buggy system headers and
9913 the ordering for the @code{include_next} directive are not inadvertently changed.
9914 If you really need to change the search order for system directories,
9915 use the @option{-nostdinc} and/or @option{-isystem} options.
9917 @item -iplugindir=@var{dir}
9918 Set the directory to search for plugins that are passed
9919 by @option{-fplugin=@var{name}} instead of
9920 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
9921 to be used by the user, but only passed by the driver.
9923 @item -iquote@var{dir}
9924 @opindex iquote
9925 Add the directory @var{dir} to the head of the list of directories to
9926 be searched for header files only for the case of @samp{#include
9927 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9928 otherwise just like @option{-I}.
9930 @item -L@var{dir}
9931 @opindex L
9932 Add directory @var{dir} to the list of directories to be searched
9933 for @option{-l}.
9935 @item -B@var{prefix}
9936 @opindex B
9937 This option specifies where to find the executables, libraries,
9938 include files, and data files of the compiler itself.
9940 The compiler driver program runs one or more of the subprograms
9941 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
9942 @var{prefix} as a prefix for each program it tries to run, both with and
9943 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9945 For each subprogram to be run, the compiler driver first tries the
9946 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9947 is not specified, the driver tries two standard prefixes, 
9948 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9949 those results in a file name that is found, the unmodified program
9950 name is searched for using the directories specified in your
9951 @env{PATH} environment variable.
9953 The compiler checks to see if the path provided by the @option{-B}
9954 refers to a directory, and if necessary it adds a directory
9955 separator character at the end of the path.
9957 @option{-B} prefixes that effectively specify directory names also apply
9958 to libraries in the linker, because the compiler translates these
9959 options into @option{-L} options for the linker.  They also apply to
9960 includes files in the preprocessor, because the compiler translates these
9961 options into @option{-isystem} options for the preprocessor.  In this case,
9962 the compiler appends @samp{include} to the prefix.
9964 The runtime support file @file{libgcc.a} can also be searched for using
9965 the @option{-B} prefix, if needed.  If it is not found there, the two
9966 standard prefixes above are tried, and that is all.  The file is left
9967 out of the link if it is not found by those means.
9969 Another way to specify a prefix much like the @option{-B} prefix is to use
9970 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9971 Variables}.
9973 As a special kludge, if the path provided by @option{-B} is
9974 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9975 9, then it is replaced by @file{[dir/]include}.  This is to help
9976 with boot-strapping the compiler.
9978 @item -specs=@var{file}
9979 @opindex specs
9980 Process @var{file} after the compiler reads in the standard @file{specs}
9981 file, in order to override the defaults which the @command{gcc} driver
9982 program uses when determining what switches to pass to @command{cc1},
9983 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
9984 @option{-specs=@var{file}} can be specified on the command line, and they
9985 are processed in order, from left to right.
9987 @item --sysroot=@var{dir}
9988 @opindex sysroot
9989 Use @var{dir} as the logical root directory for headers and libraries.
9990 For example, if the compiler normally searches for headers in
9991 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
9992 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9994 If you use both this option and the @option{-isysroot} option, then
9995 the @option{--sysroot} option applies to libraries, but the
9996 @option{-isysroot} option applies to header files.
9998 The GNU linker (beginning with version 2.16) has the necessary support
9999 for this option.  If your linker does not support this option, the
10000 header file aspect of @option{--sysroot} still works, but the
10001 library aspect does not.
10003 @item --no-sysroot-suffix
10004 @opindex no-sysroot-suffix
10005 For some targets, a suffix is added to the root directory specified
10006 with @option{--sysroot}, depending on the other options used, so that
10007 headers may for example be found in
10008 @file{@var{dir}/@var{suffix}/usr/include} instead of
10009 @file{@var{dir}/usr/include}.  This option disables the addition of
10010 such a suffix.
10012 @item -I-
10013 @opindex I-
10014 This option has been deprecated.  Please use @option{-iquote} instead for
10015 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10016 Any directories you specify with @option{-I} options before the @option{-I-}
10017 option are searched only for the case of @samp{#include "@var{file}"};
10018 they are not searched for @samp{#include <@var{file}>}.
10020 If additional directories are specified with @option{-I} options after
10021 the @option{-I-}, these directories are searched for all @samp{#include}
10022 directives.  (Ordinarily @emph{all} @option{-I} directories are used
10023 this way.)
10025 In addition, the @option{-I-} option inhibits the use of the current
10026 directory (where the current input file came from) as the first search
10027 directory for @samp{#include "@var{file}"}.  There is no way to
10028 override this effect of @option{-I-}.  With @option{-I.} you can specify
10029 searching the directory that is current when the compiler is
10030 invoked.  That is not exactly the same as what the preprocessor does
10031 by default, but it is often satisfactory.
10033 @option{-I-} does not inhibit the use of the standard system directories
10034 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
10035 independent.
10036 @end table
10038 @c man end
10040 @node Spec Files
10041 @section Specifying subprocesses and the switches to pass to them
10042 @cindex Spec Files
10044 @command{gcc} is a driver program.  It performs its job by invoking a
10045 sequence of other programs to do the work of compiling, assembling and
10046 linking.  GCC interprets its command-line parameters and uses these to
10047 deduce which programs it should invoke, and which command-line options
10048 it ought to place on their command lines.  This behavior is controlled
10049 by @dfn{spec strings}.  In most cases there is one spec string for each
10050 program that GCC can invoke, but a few programs have multiple spec
10051 strings to control their behavior.  The spec strings built into GCC can
10052 be overridden by using the @option{-specs=} command-line switch to specify
10053 a spec file.
10055 @dfn{Spec files} are plaintext files that are used to construct spec
10056 strings.  They consist of a sequence of directives separated by blank
10057 lines.  The type of directive is determined by the first non-whitespace
10058 character on the line, which can be one of the following:
10060 @table @code
10061 @item %@var{command}
10062 Issues a @var{command} to the spec file processor.  The commands that can
10063 appear here are:
10065 @table @code
10066 @item %include <@var{file}>
10067 @cindex @code{%include}
10068 Search for @var{file} and insert its text at the current point in the
10069 specs file.
10071 @item %include_noerr <@var{file}>
10072 @cindex @code{%include_noerr}
10073 Just like @samp{%include}, but do not generate an error message if the include
10074 file cannot be found.
10076 @item %rename @var{old_name} @var{new_name}
10077 @cindex @code{%rename}
10078 Rename the spec string @var{old_name} to @var{new_name}.
10080 @end table
10082 @item *[@var{spec_name}]:
10083 This tells the compiler to create, override or delete the named spec
10084 string.  All lines after this directive up to the next directive or
10085 blank line are considered to be the text for the spec string.  If this
10086 results in an empty string then the spec is deleted.  (Or, if the
10087 spec did not exist, then nothing happens.)  Otherwise, if the spec
10088 does not currently exist a new spec is created.  If the spec does
10089 exist then its contents are overridden by the text of this
10090 directive, unless the first character of that text is the @samp{+}
10091 character, in which case the text is appended to the spec.
10093 @item [@var{suffix}]:
10094 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
10095 and up to the next directive or blank line are considered to make up the
10096 spec string for the indicated suffix.  When the compiler encounters an
10097 input file with the named suffix, it processes the spec string in
10098 order to work out how to compile that file.  For example:
10100 @smallexample
10101 .ZZ:
10102 z-compile -input %i
10103 @end smallexample
10105 This says that any input file whose name ends in @samp{.ZZ} should be
10106 passed to the program @samp{z-compile}, which should be invoked with the
10107 command-line switch @option{-input} and with the result of performing the
10108 @samp{%i} substitution.  (See below.)
10110 As an alternative to providing a spec string, the text following a
10111 suffix directive can be one of the following:
10113 @table @code
10114 @item @@@var{language}
10115 This says that the suffix is an alias for a known @var{language}.  This is
10116 similar to using the @option{-x} command-line switch to GCC to specify a
10117 language explicitly.  For example:
10119 @smallexample
10120 .ZZ:
10121 @@c++
10122 @end smallexample
10124 Says that .ZZ files are, in fact, C++ source files.
10126 @item #@var{name}
10127 This causes an error messages saying:
10129 @smallexample
10130 @var{name} compiler not installed on this system.
10131 @end smallexample
10132 @end table
10134 GCC already has an extensive list of suffixes built into it.
10135 This directive adds an entry to the end of the list of suffixes, but
10136 since the list is searched from the end backwards, it is effectively
10137 possible to override earlier entries using this technique.
10139 @end table
10141 GCC has the following spec strings built into it.  Spec files can
10142 override these strings or create their own.  Note that individual
10143 targets can also add their own spec strings to this list.
10145 @smallexample
10146 asm          Options to pass to the assembler
10147 asm_final    Options to pass to the assembler post-processor
10148 cpp          Options to pass to the C preprocessor
10149 cc1          Options to pass to the C compiler
10150 cc1plus      Options to pass to the C++ compiler
10151 endfile      Object files to include at the end of the link
10152 link         Options to pass to the linker
10153 lib          Libraries to include on the command line to the linker
10154 libgcc       Decides which GCC support library to pass to the linker
10155 linker       Sets the name of the linker
10156 predefines   Defines to be passed to the C preprocessor
10157 signed_char  Defines to pass to CPP to say whether @code{char} is signed
10158              by default
10159 startfile    Object files to include at the start of the link
10160 @end smallexample
10162 Here is a small example of a spec file:
10164 @smallexample
10165 %rename lib                 old_lib
10167 *lib:
10168 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10169 @end smallexample
10171 This example renames the spec called @samp{lib} to @samp{old_lib} and
10172 then overrides the previous definition of @samp{lib} with a new one.
10173 The new definition adds in some extra command-line options before
10174 including the text of the old definition.
10176 @dfn{Spec strings} are a list of command-line options to be passed to their
10177 corresponding program.  In addition, the spec strings can contain
10178 @samp{%}-prefixed sequences to substitute variable text or to
10179 conditionally insert text into the command line.  Using these constructs
10180 it is possible to generate quite complex command lines.
10182 Here is a table of all defined @samp{%}-sequences for spec
10183 strings.  Note that spaces are not generated automatically around the
10184 results of expanding these sequences.  Therefore you can concatenate them
10185 together or combine them with constant text in a single argument.
10187 @table @code
10188 @item %%
10189 Substitute one @samp{%} into the program name or argument.
10191 @item %i
10192 Substitute the name of the input file being processed.
10194 @item %b
10195 Substitute the basename of the input file being processed.
10196 This is the substring up to (and not including) the last period
10197 and not including the directory.
10199 @item %B
10200 This is the same as @samp{%b}, but include the file suffix (text after
10201 the last period).
10203 @item %d
10204 Marks the argument containing or following the @samp{%d} as a
10205 temporary file name, so that that file is deleted if GCC exits
10206 successfully.  Unlike @samp{%g}, this contributes no text to the
10207 argument.
10209 @item %g@var{suffix}
10210 Substitute a file name that has suffix @var{suffix} and is chosen
10211 once per compilation, and mark the argument in the same way as
10212 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10213 name is now chosen in a way that is hard to predict even when previously
10214 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10215 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10216 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10217 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10218 was simply substituted with a file name chosen once per compilation,
10219 without regard to any appended suffix (which was therefore treated
10220 just like ordinary text), making such attacks more likely to succeed.
10222 @item %u@var{suffix}
10223 Like @samp{%g}, but generates a new temporary file name
10224 each time it appears instead of once per compilation.
10226 @item %U@var{suffix}
10227 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10228 new one if there is no such last file name.  In the absence of any
10229 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10230 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10231 involves the generation of two distinct file names, one
10232 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10233 simply substituted with a file name chosen for the previous @samp{%u},
10234 without regard to any appended suffix.
10236 @item %j@var{suffix}
10237 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10238 writable, and if @option{-save-temps} is not used; 
10239 otherwise, substitute the name
10240 of a temporary file, just like @samp{%u}.  This temporary file is not
10241 meant for communication between processes, but rather as a junk
10242 disposal mechanism.
10244 @item %|@var{suffix}
10245 @itemx %m@var{suffix}
10246 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10247 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10248 all.  These are the two most common ways to instruct a program that it
10249 should read from standard input or write to standard output.  If you
10250 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10251 construct: see for example @file{f/lang-specs.h}.
10253 @item %.@var{SUFFIX}
10254 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10255 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10256 terminated by the next space or %.
10258 @item %w
10259 Marks the argument containing or following the @samp{%w} as the
10260 designated output file of this compilation.  This puts the argument
10261 into the sequence of arguments that @samp{%o} substitutes.
10263 @item %o
10264 Substitutes the names of all the output files, with spaces
10265 automatically placed around them.  You should write spaces
10266 around the @samp{%o} as well or the results are undefined.
10267 @samp{%o} is for use in the specs for running the linker.
10268 Input files whose names have no recognized suffix are not compiled
10269 at all, but they are included among the output files, so they are
10270 linked.
10272 @item %O
10273 Substitutes the suffix for object files.  Note that this is
10274 handled specially when it immediately follows @samp{%g, %u, or %U},
10275 because of the need for those to form complete file names.  The
10276 handling is such that @samp{%O} is treated exactly as if it had already
10277 been substituted, except that @samp{%g, %u, and %U} do not currently
10278 support additional @var{suffix} characters following @samp{%O} as they do
10279 following, for example, @samp{.o}.
10281 @item %p
10282 Substitutes the standard macro predefinitions for the
10283 current target machine.  Use this when running @code{cpp}.
10285 @item %P
10286 Like @samp{%p}, but puts @samp{__} before and after the name of each
10287 predefined macro, except for macros that start with @samp{__} or with
10288 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10291 @item %I
10292 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10293 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10294 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10295 and @option{-imultilib} as necessary.
10297 @item %s
10298 Current argument is the name of a library or startup file of some sort.
10299 Search for that file in a standard list of directories and substitute
10300 the full name found.  The current working directory is included in the
10301 list of directories scanned.
10303 @item %T
10304 Current argument is the name of a linker script.  Search for that file
10305 in the current list of directories to scan for libraries. If the file
10306 is located insert a @option{--script} option into the command line
10307 followed by the full path name found.  If the file is not found then
10308 generate an error message.  Note: the current working directory is not
10309 searched.
10311 @item %e@var{str}
10312 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10313 Use this when inconsistent options are detected.
10315 @item %(@var{name})
10316 Substitute the contents of spec string @var{name} at this point.
10318 @item %x@{@var{option}@}
10319 Accumulate an option for @samp{%X}.
10321 @item %X
10322 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10323 spec string.
10325 @item %Y
10326 Output the accumulated assembler options specified by @option{-Wa}.
10328 @item %Z
10329 Output the accumulated preprocessor options specified by @option{-Wp}.
10331 @item %a
10332 Process the @code{asm} spec.  This is used to compute the
10333 switches to be passed to the assembler.
10335 @item %A
10336 Process the @code{asm_final} spec.  This is a spec string for
10337 passing switches to an assembler post-processor, if such a program is
10338 needed.
10340 @item %l
10341 Process the @code{link} spec.  This is the spec for computing the
10342 command line passed to the linker.  Typically it makes use of the
10343 @samp{%L %G %S %D and %E} sequences.
10345 @item %D
10346 Dump out a @option{-L} option for each directory that GCC believes might
10347 contain startup files.  If the target supports multilibs then the
10348 current multilib directory is prepended to each of these paths.
10350 @item %L
10351 Process the @code{lib} spec.  This is a spec string for deciding which
10352 libraries are included on the command line to the linker.
10354 @item %G
10355 Process the @code{libgcc} spec.  This is a spec string for deciding
10356 which GCC support library is included on the command line to the linker.
10358 @item %S
10359 Process the @code{startfile} spec.  This is a spec for deciding which
10360 object files are the first ones passed to the linker.  Typically
10361 this might be a file named @file{crt0.o}.
10363 @item %E
10364 Process the @code{endfile} spec.  This is a spec string that specifies
10365 the last object files that are passed to the linker.
10367 @item %C
10368 Process the @code{cpp} spec.  This is used to construct the arguments
10369 to be passed to the C preprocessor.
10371 @item %1
10372 Process the @code{cc1} spec.  This is used to construct the options to be
10373 passed to the actual C compiler (@samp{cc1}).
10375 @item %2
10376 Process the @code{cc1plus} spec.  This is used to construct the options to be
10377 passed to the actual C++ compiler (@samp{cc1plus}).
10379 @item %*
10380 Substitute the variable part of a matched option.  See below.
10381 Note that each comma in the substituted string is replaced by
10382 a single space.
10384 @item %<@code{S}
10385 Remove all occurrences of @code{-S} from the command line.  Note---this
10386 command is position dependent.  @samp{%} commands in the spec string
10387 before this one see @code{-S}, @samp{%} commands in the spec string
10388 after this one do not.
10390 @item %:@var{function}(@var{args})
10391 Call the named function @var{function}, passing it @var{args}.
10392 @var{args} is first processed as a nested spec string, then split
10393 into an argument vector in the usual fashion.  The function returns
10394 a string which is processed as if it had appeared literally as part
10395 of the current spec.
10397 The following built-in spec functions are provided:
10399 @table @code
10400 @item @code{getenv}
10401 The @code{getenv} spec function takes two arguments: an environment
10402 variable name and a string.  If the environment variable is not
10403 defined, a fatal error is issued.  Otherwise, the return value is the
10404 value of the environment variable concatenated with the string.  For
10405 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10407 @smallexample
10408 %:getenv(TOPDIR /include)
10409 @end smallexample
10411 expands to @file{/path/to/top/include}.
10413 @item @code{if-exists}
10414 The @code{if-exists} spec function takes one argument, an absolute
10415 pathname to a file.  If the file exists, @code{if-exists} returns the
10416 pathname.  Here is a small example of its usage:
10418 @smallexample
10419 *startfile:
10420 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10421 @end smallexample
10423 @item @code{if-exists-else}
10424 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10425 spec function, except that it takes two arguments.  The first argument is
10426 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10427 returns the pathname.  If it does not exist, it returns the second argument.
10428 This way, @code{if-exists-else} can be used to select one file or another,
10429 based on the existence of the first.  Here is a small example of its usage:
10431 @smallexample
10432 *startfile:
10433 crt0%O%s %:if-exists(crti%O%s) \
10434 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10435 @end smallexample
10437 @item @code{replace-outfile}
10438 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10439 first argument in the outfiles array and replaces it with the second argument.  Here
10440 is a small example of its usage:
10442 @smallexample
10443 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10444 @end smallexample
10446 @item @code{remove-outfile}
10447 The @code{remove-outfile} spec function takes one argument.  It looks for the
10448 first argument in the outfiles array and removes it.  Here is a small example
10449 its usage:
10451 @smallexample
10452 %:remove-outfile(-lm)
10453 @end smallexample
10455 @item @code{pass-through-libs}
10456 The @code{pass-through-libs} spec function takes any number of arguments.  It
10457 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10458 assumes are the names of linker input library archive files) and returns a
10459 result containing all the found arguments each prepended by
10460 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10461 intended to be passed to the LTO linker plugin.
10463 @smallexample
10464 %:pass-through-libs(%G %L %G)
10465 @end smallexample
10467 @item @code{print-asm-header}
10468 The @code{print-asm-header} function takes no arguments and simply
10469 prints a banner like:
10471 @smallexample
10472 Assembler options
10473 =================
10475 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10476 @end smallexample
10478 It is used to separate compiler options from assembler options
10479 in the @option{--target-help} output.
10480 @end table
10482 @item %@{@code{S}@}
10483 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10484 If that switch is not specified, this substitutes nothing.  Note that
10485 the leading dash is omitted when specifying this option, and it is
10486 automatically inserted if the substitution is performed.  Thus the spec
10487 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10488 and outputs the command-line option @option{-foo}.
10490 @item %W@{@code{S}@}
10491 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10492 deleted on failure.
10494 @item %@{@code{S}*@}
10495 Substitutes all the switches specified to GCC whose names start
10496 with @code{-S}, but which also take an argument.  This is used for
10497 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10498 GCC considers @option{-o foo} as being
10499 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
10500 text, including the space.  Thus two arguments are generated.
10502 @item %@{@code{S}*&@code{T}*@}
10503 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10504 (the order of @code{S} and @code{T} in the spec is not significant).
10505 There can be any number of ampersand-separated variables; for each the
10506 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10508 @item %@{@code{S}:@code{X}@}
10509 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10511 @item %@{!@code{S}:@code{X}@}
10512 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10514 @item %@{@code{S}*:@code{X}@}
10515 Substitutes @code{X} if one or more switches whose names start with
10516 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10517 once, no matter how many such switches appeared.  However, if @code{%*}
10518 appears somewhere in @code{X}, then @code{X} is substituted once
10519 for each matching switch, with the @code{%*} replaced by the part of
10520 that switch matching the @code{*}.
10522 @item %@{.@code{S}:@code{X}@}
10523 Substitutes @code{X}, if processing a file with suffix @code{S}.
10525 @item %@{!.@code{S}:@code{X}@}
10526 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10528 @item %@{,@code{S}:@code{X}@}
10529 Substitutes @code{X}, if processing a file for language @code{S}.
10531 @item %@{!,@code{S}:@code{X}@}
10532 Substitutes @code{X}, if not processing a file for language @code{S}.
10534 @item %@{@code{S}|@code{P}:@code{X}@}
10535 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10536 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10537 @code{*} sequences as well, although they have a stronger binding than
10538 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10539 alternatives must be starred, and only the first matching alternative
10540 is substituted.
10542 For example, a spec string like this:
10544 @smallexample
10545 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10546 @end smallexample
10548 @noindent
10549 outputs the following command-line options from the following input
10550 command-line options:
10552 @smallexample
10553 fred.c        -foo -baz
10554 jim.d         -bar -boggle
10555 -d fred.c     -foo -baz -boggle
10556 -d jim.d      -bar -baz -boggle
10557 @end smallexample
10559 @item %@{S:X; T:Y; :D@}
10561 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10562 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10563 be as many clauses as you need.  This may be combined with @code{.},
10564 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10567 @end table
10569 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10570 construct may contain other nested @samp{%} constructs or spaces, or
10571 even newlines.  They are processed as usual, as described above.
10572 Trailing white space in @code{X} is ignored.  White space may also
10573 appear anywhere on the left side of the colon in these constructs,
10574 except between @code{.} or @code{*} and the corresponding word.
10576 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10577 handled specifically in these constructs.  If another value of
10578 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10579 @option{-W} switch is found later in the command line, the earlier
10580 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10581 just one letter, which passes all matching options.
10583 The character @samp{|} at the beginning of the predicate text is used to
10584 indicate that a command should be piped to the following command, but
10585 only if @option{-pipe} is specified.
10587 It is built into GCC which switches take arguments and which do not.
10588 (You might think it would be useful to generalize this to allow each
10589 compiler's spec to say which switches take arguments.  But this cannot
10590 be done in a consistent fashion.  GCC cannot even decide which input
10591 files have been specified without knowing which switches take arguments,
10592 and it must know which input files to compile in order to tell which
10593 compilers to run).
10595 GCC also knows implicitly that arguments starting in @option{-l} are to be
10596 treated as compiler output files, and passed to the linker in their
10597 proper position among the other output files.
10599 @c man begin OPTIONS
10601 @node Target Options
10602 @section Specifying Target Machine and Compiler Version
10603 @cindex target options
10604 @cindex cross compiling
10605 @cindex specifying machine version
10606 @cindex specifying compiler version and target machine
10607 @cindex compiler version, specifying
10608 @cindex target machine, specifying
10610 The usual way to run GCC is to run the executable called @command{gcc}, or
10611 @command{@var{machine}-gcc} when cross-compiling, or
10612 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10613 one that was installed last.
10615 @node Submodel Options
10616 @section Hardware Models and Configurations
10617 @cindex submodel options
10618 @cindex specifying hardware config
10619 @cindex hardware models and configurations, specifying
10620 @cindex machine dependent options
10622 Each target machine types can have its own
10623 special options, starting with @samp{-m}, to choose among various
10624 hardware models or configurations---for example, 68010 vs 68020,
10625 floating coprocessor or none.  A single installed version of the
10626 compiler can compile for any model or configuration, according to the
10627 options specified.
10629 Some configurations of the compiler also support additional special
10630 options, usually for compatibility with other compilers on the same
10631 platform.
10633 @c This list is ordered alphanumerically by subsection name.
10634 @c It should be the same order and spelling as these options are listed
10635 @c in Machine Dependent Options
10637 @menu
10638 * AArch64 Options::
10639 * Adapteva Epiphany Options::
10640 * ARM Options::
10641 * AVR Options::
10642 * Blackfin Options::
10643 * C6X Options::
10644 * CRIS Options::
10645 * CR16 Options::
10646 * Darwin Options::
10647 * DEC Alpha Options::
10648 * FR30 Options::
10649 * FRV Options::
10650 * GNU/Linux Options::
10651 * H8/300 Options::
10652 * HPPA Options::
10653 * i386 and x86-64 Options::
10654 * i386 and x86-64 Windows Options::
10655 * IA-64 Options::
10656 * LM32 Options::
10657 * M32C Options::
10658 * M32R/D Options::
10659 * M680x0 Options::
10660 * MCore Options::
10661 * MeP Options::
10662 * MicroBlaze Options::
10663 * MIPS Options::
10664 * MMIX Options::
10665 * MN10300 Options::
10666 * Moxie Options::
10667 * PDP-11 Options::
10668 * picoChip Options::
10669 * PowerPC Options::
10670 * RL78 Options::
10671 * RS/6000 and PowerPC Options::
10672 * RX Options::
10673 * S/390 and zSeries Options::
10674 * Score Options::
10675 * SH Options::
10676 * Solaris 2 Options::
10677 * SPARC Options::
10678 * SPU Options::
10679 * System V Options::
10680 * TILE-Gx Options::
10681 * TILEPro Options::
10682 * V850 Options::
10683 * VAX Options::
10684 * VMS Options::
10685 * VxWorks Options::
10686 * x86-64 Options::
10687 * Xstormy16 Options::
10688 * Xtensa Options::
10689 * zSeries Options::
10690 @end menu
10692 @node Adapteva Epiphany Options
10693 @subsection Adapteva Epiphany Options
10695 These @samp{-m} options are defined for Adapteva Epiphany:
10697 @table @gcctabopt
10698 @item -mhalf-reg-file
10699 @opindex mhalf-reg-file
10700 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
10701 That allows code to run on hardware variants that lack these registers.
10703 @item -mprefer-short-insn-regs
10704 @opindex mprefer-short-insn-regs
10705 Preferrentially allocate registers that allow short instruction generation.
10706 This can result in increased instruction count, so this may either reduce or
10707 increase overall code size.
10709 @item -mbranch-cost=@var{num}
10710 @opindex mbranch-cost
10711 Set the cost of branches to roughly @var{num} ``simple'' instructions.
10712 This cost is only a heuristic and is not guaranteed to produce
10713 consistent results across releases.
10715 @item -mcmove
10716 @opindex mcmove
10717 Enable the generation of conditional moves.
10719 @item -mnops=@var{num}
10720 @opindex mnops
10721 Emit @var{num} NOPs before every other generated instruction.
10723 @item -mno-soft-cmpsf
10724 @opindex mno-soft-cmpsf
10725 For single-precision floating-point comparisons, emit an @code{fsub} instruction
10726 and test the flags.  This is faster than a software comparison, but can
10727 get incorrect results in the presence of NaNs, or when two different small
10728 numbers are compared such that their difference is calculated as zero.
10729 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
10730 software comparisons.
10732 @item -mstack-offset=@var{num}
10733 @opindex mstack-offset
10734 Set the offset between the top of the stack and the stack pointer.
10735 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
10736 can be used by leaf functions without stack allocation.
10737 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
10738 Note also that this option changes the ABI; compiling a program with a
10739 different stack offset than the libraries have been compiled with
10740 generally does not work.
10741 This option can be useful if you want to evaluate if a different stack
10742 offset would give you better code, but to actually use a different stack
10743 offset to build working programs, it is recommended to configure the
10744 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
10746 @item -mno-round-nearest
10747 @opindex mno-round-nearest
10748 Make the scheduler assume that the rounding mode has been set to
10749 truncating.  The default is @option{-mround-nearest}.
10751 @item -mlong-calls
10752 @opindex mlong-calls
10753 If not otherwise specified by an attribute, assume all calls might be beyond
10754 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
10755 function address into a register before performing a (otherwise direct) call.
10756 This is the default.
10758 @item -mshort-calls
10759 @opindex short-calls
10760 If not otherwise specified by an attribute, assume all direct calls are
10761 in the range of the @code{b} / @code{bl} instructions, so use these instructions
10762 for direct calls.  The default is @option{-mlong-calls}.
10764 @item -msmall16
10765 @opindex msmall16
10766 Assume addresses can be loaded as 16-bit unsigned values.  This does not
10767 apply to function addresses for which @option{-mlong-calls} semantics
10768 are in effect.
10770 @item -mfp-mode=@var{mode}
10771 @opindex mfp-mode
10772 Set the prevailing mode of the floating-point unit.
10773 This determines the floating-point mode that is provided and expected
10774 at function call and return time.  Making this mode match the mode you
10775 predominantly need at function start can make your programs smaller and
10776 faster by avoiding unnecessary mode switches.
10778 @var{mode} can be set to one the following values:
10780 @table @samp
10781 @item caller
10782 Any mode at function entry is valid, and retained or restored when
10783 the function returns, and when it calls other functions.
10784 This mode is useful for compiling libraries or other compilation units
10785 you might want to incorporate into different programs with different
10786 prevailing FPU modes, and the convenience of being able to use a single
10787 object file outweighs the size and speed overhead for any extra
10788 mode switching that might be needed, compared with what would be needed
10789 with a more specific choice of prevailing FPU mode.
10791 @item truncate
10792 This is the mode used for floating-point calculations with
10793 truncating (i.e.@: round towards zero) rounding mode.  That includes
10794 conversion from floating point to integer.
10796 @item round-nearest
10797 This is the mode used for floating-point calculations with
10798 round-to-nearest-or-even rounding mode.
10800 @item int
10801 This is the mode used to perform integer calculations in the FPU, e.g.@:
10802 integer multiply, or integer multiply-and-accumulate.
10803 @end table
10805 The default is @option{-mfp-mode=caller}
10807 @item -mnosplit-lohi
10808 @opindex mnosplit-lohi
10809 @item -mno-postinc
10810 @opindex mno-postinc
10811 @item -mno-postmodify
10812 @opindex mno-postmodify
10813 Code generation tweaks that disable, respectively, splitting of 32-bit
10814 loads, generation of post-increment addresses, and generation of
10815 post-modify addresses.  The defaults are @option{msplit-lohi},
10816 @option{-mpost-inc}, and @option{-mpost-modify}.
10818 @item -mnovect-double
10819 @opindex mno-vect-double
10820 Change the preferred SIMD mode to SImode.  The default is
10821 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
10823 @item -max-vect-align=@var{num}
10824 @opindex max-vect-align
10825 The maximum alignment for SIMD vector mode types.
10826 @var{num} may be 4 or 8.  The default is 8.
10827 Note that this is an ABI change, even though many library function
10828 interfaces are unaffected if they don't use SIMD vector modes
10829 in places that affect size and/or alignment of relevant types.
10831 @item -msplit-vecmove-early
10832 @opindex msplit-vecmove-early
10833 Split vector moves into single word moves before reload.  In theory this
10834 can give better register allocation, but so far the reverse seems to be
10835 generally the case.
10837 @item -m1reg-@var{reg}
10838 @opindex m1reg-
10839 Specify a register to hold the constant @minus{}1, which makes loading small negative
10840 constants and certain bitmasks faster.
10841 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
10842 which specify use of that register as a fixed register,
10843 and @samp{none}, which means that no register is used for this
10844 purpose.  The default is @option{-m1reg-none}.
10846 @end table
10848 @node AArch64 Options
10849 @subsection AArch64 Options
10850 @cindex AArch64 Options
10852 These options are defined for AArch64 implementations:
10854 @table @gcctabopt
10856 @item -mbig-endian
10857 @opindex mbig-endian
10858 Generate big-endian code.  This is the default when GCC is configured for an
10859 @samp{aarch64_be-*-*} target.
10861 @item -mgeneral-regs-only
10862 @opindex mgeneral-regs-only
10863 Generate code which uses only the general registers.
10865 @item -mlittle-endian
10866 @opindex mlittle-endian
10867 Generate little-endian code.  This is the default when GCC is configured for an
10868 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
10870 @item -mcmodel=tiny
10871 @opindex mcmodel=tiny
10872 Generate code for the tiny code model.  The program and its statically defined
10873 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
10874 be statically or dynamically linked.  This model is not fully implemented and
10875 mostly treated as @samp{small}.
10877 @item -mcmodel=small
10878 @opindex mcmodel=small
10879 Generate code for the small code model.  The program and its statically defined
10880 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
10881 be statically or dynamically linked.  This is the default code model.
10883 @item -mcmodel=large
10884 @opindex mcmodel=large
10885 Generate code for the large code model.  This makes no assumptions about
10886 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
10887 statically linked only.
10889 @item -mstrict-align
10890 @opindex mstrict-align
10891 Do not assume that unaligned memory references will be handled by the system.
10893 @item -momit-leaf-frame-pointer
10894 @item -mno-omit-leaf-frame-pointer
10895 @opindex momit-leaf-frame-pointer
10896 @opindex mno-omit-leaf-frame-pointer
10897 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
10898 default.
10900 @item -mtls-dialect=desc
10901 @opindex mtls-dialect=desc
10902 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
10903 of TLS variables.  This is the default.
10905 @item -mtls-dialect=traditional
10906 @opindex mtls-dialect=traditional
10907 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
10908 of TLS variables.
10910 @item -march=@var{name}
10911 @opindex march
10912 Specify the name of the target architecture, optionally suffixed by one or
10913 more feature modifiers.  This option has the form
10914 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
10915 only value for @var{arch} is @samp{armv8-a}.  The possible values for
10916 @var{feature} are documented in the sub-section below.
10918 Where conflicting feature modifiers are specified, the right-most feature is
10919 used.
10921 GCC uses this name to determine what kind of instructions it can emit when
10922 generating assembly code.  This option can be used in conjunction with or
10923 instead of the @option{-mcpu=} option.
10925 @item -mcpu=@var{name}
10926 @opindex mcpu
10927 Specify the name of the target processor, optionally suffixed by one or more
10928 feature modifiers.  This option has the form
10929 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
10930 possible values for @var{cpu} are @samp{generic}, @samp{large}.  The
10931 possible values for @var{feature} are documented in the sub-section
10932 below.
10934 Where conflicting feature modifiers are specified, the right-most feature is
10935 used.
10937 GCC uses this name to determine what kind of instructions it can emit when
10938 generating assembly code.
10940 @item -mtune=@var{name}
10941 @opindex mtune
10942 Specify the name of the processor to tune the performance for.  The code will
10943 be tuned as if the target processor were of the type specified in this option,
10944 but still using instructions compatible with the target processor specified
10945 by a @option{-mcpu=} option.  This option cannot be suffixed by feature
10946 modifiers.
10948 @end table
10950 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
10951 @cindex @option{-march} feature modifiers
10952 @cindex @option{-mcpu} feature modifiers
10953 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
10954 the following:
10956 @table @samp
10957 @item crypto
10958 Enable Crypto extension.  This implies Advanced SIMD is enabled.
10959 @item fp
10960 Enable floating-point instructions.
10961 @item simd
10962 Enable Advanced SIMD instructions.  This implies floating-point instructions
10963 are enabled.  This is the default for all current possible values for options
10964 @option{-march} and @option{-mcpu=}.
10965 @end table
10967 @node ARM Options
10968 @subsection ARM Options
10969 @cindex ARM options
10971 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
10972 architectures:
10974 @table @gcctabopt
10975 @item -mabi=@var{name}
10976 @opindex mabi
10977 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
10978 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
10980 @item -mapcs-frame
10981 @opindex mapcs-frame
10982 Generate a stack frame that is compliant with the ARM Procedure Call
10983 Standard for all functions, even if this is not strictly necessary for
10984 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
10985 with this option causes the stack frames not to be generated for
10986 leaf functions.  The default is @option{-mno-apcs-frame}.
10988 @item -mapcs
10989 @opindex mapcs
10990 This is a synonym for @option{-mapcs-frame}.
10992 @ignore
10993 @c not currently implemented
10994 @item -mapcs-stack-check
10995 @opindex mapcs-stack-check
10996 Generate code to check the amount of stack space available upon entry to
10997 every function (that actually uses some stack space).  If there is
10998 insufficient space available then either the function
10999 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
11000 called, depending upon the amount of stack space required.  The runtime
11001 system is required to provide these functions.  The default is
11002 @option{-mno-apcs-stack-check}, since this produces smaller code.
11004 @c not currently implemented
11005 @item -mapcs-float
11006 @opindex mapcs-float
11007 Pass floating-point arguments using the floating-point registers.  This is
11008 one of the variants of the APCS@.  This option is recommended if the
11009 target hardware has a floating-point unit or if a lot of floating-point
11010 arithmetic is going to be performed by the code.  The default is
11011 @option{-mno-apcs-float}, since the size of integer-only code is 
11012 slightly increased if @option{-mapcs-float} is used.
11014 @c not currently implemented
11015 @item -mapcs-reentrant
11016 @opindex mapcs-reentrant
11017 Generate reentrant, position-independent code.  The default is
11018 @option{-mno-apcs-reentrant}.
11019 @end ignore
11021 @item -mthumb-interwork
11022 @opindex mthumb-interwork
11023 Generate code that supports calling between the ARM and Thumb
11024 instruction sets.  Without this option, on pre-v5 architectures, the
11025 two instruction sets cannot be reliably used inside one program.  The
11026 default is @option{-mno-thumb-interwork}, since slightly larger code
11027 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
11028 configurations this option is meaningless.
11030 @item -mno-sched-prolog
11031 @opindex mno-sched-prolog
11032 Prevent the reordering of instructions in the function prologue, or the
11033 merging of those instruction with the instructions in the function's
11034 body.  This means that all functions start with a recognizable set
11035 of instructions (or in fact one of a choice from a small set of
11036 different function prologues), and this information can be used to
11037 locate the start of functions inside an executable piece of code.  The
11038 default is @option{-msched-prolog}.
11040 @item -mfloat-abi=@var{name}
11041 @opindex mfloat-abi
11042 Specifies which floating-point ABI to use.  Permissible values
11043 are: @samp{soft}, @samp{softfp} and @samp{hard}.
11045 Specifying @samp{soft} causes GCC to generate output containing
11046 library calls for floating-point operations.
11047 @samp{softfp} allows the generation of code using hardware floating-point
11048 instructions, but still uses the soft-float calling conventions.
11049 @samp{hard} allows generation of floating-point instructions
11050 and uses FPU-specific calling conventions.
11052 The default depends on the specific target configuration.  Note that
11053 the hard-float and soft-float ABIs are not link-compatible; you must
11054 compile your entire program with the same ABI, and link with a
11055 compatible set of libraries.
11057 @item -mlittle-endian
11058 @opindex mlittle-endian
11059 Generate code for a processor running in little-endian mode.  This is
11060 the default for all standard configurations.
11062 @item -mbig-endian
11063 @opindex mbig-endian
11064 Generate code for a processor running in big-endian mode; the default is
11065 to compile code for a little-endian processor.
11067 @item -mwords-little-endian
11068 @opindex mwords-little-endian
11069 This option only applies when generating code for big-endian processors.
11070 Generate code for a little-endian word order but a big-endian byte
11071 order.  That is, a byte order of the form @samp{32107654}.  Note: this
11072 option should only be used if you require compatibility with code for
11073 big-endian ARM processors generated by versions of the compiler prior to
11074 2.8.  This option is now deprecated.
11076 @item -mcpu=@var{name}
11077 @opindex mcpu
11078 This specifies the name of the target ARM processor.  GCC uses this name
11079 to determine what kind of instructions it can emit when generating
11080 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
11081 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
11082 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
11083 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
11084 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
11085 @samp{arm720},
11086 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
11087 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
11088 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
11089 @samp{strongarm1110},
11090 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
11091 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
11092 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
11093 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
11094 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
11095 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
11096 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
11097 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
11098 @samp{cortex-a15}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
11099 @samp{cortex-m4}, @samp{cortex-m3},
11100 @samp{cortex-m1},
11101 @samp{cortex-m0},
11102 @samp{cortex-m0plus},
11103 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
11104 @samp{fa526}, @samp{fa626},
11105 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
11108 @option{-mcpu=generic-@var{arch}} is also permissible, and is
11109 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
11110 See @option{-mtune} for more information.
11112 @option{-mcpu=native} causes the compiler to auto-detect the CPU
11113 of the build computer.  At present, this feature is only supported on
11114 Linux, and not all architectures are recognized.  If the auto-detect is
11115 unsuccessful the option has no effect.
11117 @item -mtune=@var{name}
11118 @opindex mtune
11119 This option is very similar to the @option{-mcpu=} option, except that
11120 instead of specifying the actual target processor type, and hence
11121 restricting which instructions can be used, it specifies that GCC should
11122 tune the performance of the code as if the target were of the type
11123 specified in this option, but still choosing the instructions it
11124 generates based on the CPU specified by a @option{-mcpu=} option.
11125 For some ARM implementations better performance can be obtained by using
11126 this option.
11128 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
11129 performance for a blend of processors within architecture @var{arch}.
11130 The aim is to generate code that run well on the current most popular
11131 processors, balancing between optimizations that benefit some CPUs in the
11132 range, and avoiding performance pitfalls of other CPUs.  The effects of
11133 this option may change in future GCC versions as CPU models come and go.
11135 @option{-mtune=native} causes the compiler to auto-detect the CPU
11136 of the build computer.  At present, this feature is only supported on
11137 Linux, and not all architectures are recognized.  If the auto-detect is
11138 unsuccessful the option has no effect.
11140 @item -march=@var{name}
11141 @opindex march
11142 This specifies the name of the target ARM architecture.  GCC uses this
11143 name to determine what kind of instructions it can emit when generating
11144 assembly code.  This option can be used in conjunction with or instead
11145 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
11146 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
11147 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
11148 @samp{armv6}, @samp{armv6j},
11149 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
11150 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
11151 @samp{armv8-a},
11152 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
11154 @option{-march=native} causes the compiler to auto-detect the architecture
11155 of the build computer.  At present, this feature is only supported on
11156 Linux, and not all architectures are recognized.  If the auto-detect is
11157 unsuccessful the option has no effect.
11159 @item -mfpu=@var{name}
11160 @opindex mfpu
11161 This specifies what floating-point hardware (or hardware emulation) is
11162 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
11163 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
11164 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
11165 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
11166 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
11168 If @option{-msoft-float} is specified this specifies the format of
11169 floating-point values.
11171 If the selected floating-point hardware includes the NEON extension
11172 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
11173 operations are not generated by GCC's auto-vectorization pass unless
11174 @option{-funsafe-math-optimizations} is also specified.  This is
11175 because NEON hardware does not fully implement the IEEE 754 standard for
11176 floating-point arithmetic (in particular denormal values are treated as
11177 zero), so the use of NEON instructions may lead to a loss of precision.
11179 @item -mfp16-format=@var{name}
11180 @opindex mfp16-format
11181 Specify the format of the @code{__fp16} half-precision floating-point type.
11182 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
11183 the default is @samp{none}, in which case the @code{__fp16} type is not
11184 defined.  @xref{Half-Precision}, for more information.
11186 @item -mstructure-size-boundary=@var{n}
11187 @opindex mstructure-size-boundary
11188 The sizes of all structures and unions are rounded up to a multiple
11189 of the number of bits set by this option.  Permissible values are 8, 32
11190 and 64.  The default value varies for different toolchains.  For the COFF
11191 targeted toolchain the default value is 8.  A value of 64 is only allowed
11192 if the underlying ABI supports it.
11194 Specifying a larger number can produce faster, more efficient code, but
11195 can also increase the size of the program.  Different values are potentially
11196 incompatible.  Code compiled with one value cannot necessarily expect to
11197 work with code or libraries compiled with another value, if they exchange
11198 information using structures or unions.
11200 @item -mabort-on-noreturn
11201 @opindex mabort-on-noreturn
11202 Generate a call to the function @code{abort} at the end of a
11203 @code{noreturn} function.  It is executed if the function tries to
11204 return.
11206 @item -mlong-calls
11207 @itemx -mno-long-calls
11208 @opindex mlong-calls
11209 @opindex mno-long-calls
11210 Tells the compiler to perform function calls by first loading the
11211 address of the function into a register and then performing a subroutine
11212 call on this register.  This switch is needed if the target function
11213 lies outside of the 64-megabyte addressing range of the offset-based
11214 version of subroutine call instruction.
11216 Even if this switch is enabled, not all function calls are turned
11217 into long calls.  The heuristic is that static functions, functions
11218 that have the @samp{short-call} attribute, functions that are inside
11219 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
11220 definitions have already been compiled within the current compilation
11221 unit are not turned into long calls.  The exceptions to this rule are
11222 that weak function definitions, functions with the @samp{long-call}
11223 attribute or the @samp{section} attribute, and functions that are within
11224 the scope of a @samp{#pragma long_calls} directive are always
11225 turned into long calls.
11227 This feature is not enabled by default.  Specifying
11228 @option{-mno-long-calls} restores the default behavior, as does
11229 placing the function calls within the scope of a @samp{#pragma
11230 long_calls_off} directive.  Note these switches have no effect on how
11231 the compiler generates code to handle function calls via function
11232 pointers.
11234 @item -msingle-pic-base
11235 @opindex msingle-pic-base
11236 Treat the register used for PIC addressing as read-only, rather than
11237 loading it in the prologue for each function.  The runtime system is
11238 responsible for initializing this register with an appropriate value
11239 before execution begins.
11241 @item -mpic-register=@var{reg}
11242 @opindex mpic-register
11243 Specify the register to be used for PIC addressing.  The default is R10
11244 unless stack-checking is enabled, when R9 is used.
11246 @item -mcirrus-fix-invalid-insns
11247 @opindex mcirrus-fix-invalid-insns
11248 @opindex mno-cirrus-fix-invalid-insns
11249 Insert NOPs into the instruction stream to in order to work around
11250 problems with invalid Maverick instruction combinations.  This option
11251 is only valid if the @option{-mcpu=ep9312} option has been used to
11252 enable generation of instructions for the Cirrus Maverick floating-point
11253 co-processor.  This option is not enabled by default, since the
11254 problem is only present in older Maverick implementations.  The default
11255 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
11256 switch.
11258 @item -mpoke-function-name
11259 @opindex mpoke-function-name
11260 Write the name of each function into the text section, directly
11261 preceding the function prologue.  The generated code is similar to this:
11263 @smallexample
11264      t0
11265          .ascii "arm_poke_function_name", 0
11266          .align
11267      t1
11268          .word 0xff000000 + (t1 - t0)
11269      arm_poke_function_name
11270          mov     ip, sp
11271          stmfd   sp!, @{fp, ip, lr, pc@}
11272          sub     fp, ip, #4
11273 @end smallexample
11275 When performing a stack backtrace, code can inspect the value of
11276 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
11277 location @code{pc - 12} and the top 8 bits are set, then we know that
11278 there is a function name embedded immediately preceding this location
11279 and has length @code{((pc[-3]) & 0xff000000)}.
11281 @item -mthumb
11282 @itemx -marm
11283 @opindex marm
11284 @opindex mthumb
11286 Select between generating code that executes in ARM and Thumb
11287 states.  The default for most configurations is to generate code
11288 that executes in ARM state, but the default can be changed by
11289 configuring GCC with the @option{--with-mode=}@var{state}
11290 configure option.
11292 @item -mtpcs-frame
11293 @opindex mtpcs-frame
11294 Generate a stack frame that is compliant with the Thumb Procedure Call
11295 Standard for all non-leaf functions.  (A leaf function is one that does
11296 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
11298 @item -mtpcs-leaf-frame
11299 @opindex mtpcs-leaf-frame
11300 Generate a stack frame that is compliant with the Thumb Procedure Call
11301 Standard for all leaf functions.  (A leaf function is one that does
11302 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
11304 @item -mcallee-super-interworking
11305 @opindex mcallee-super-interworking
11306 Gives all externally visible functions in the file being compiled an ARM
11307 instruction set header which switches to Thumb mode before executing the
11308 rest of the function.  This allows these functions to be called from
11309 non-interworking code.  This option is not valid in AAPCS configurations
11310 because interworking is enabled by default.
11312 @item -mcaller-super-interworking
11313 @opindex mcaller-super-interworking
11314 Allows calls via function pointers (including virtual functions) to
11315 execute correctly regardless of whether the target code has been
11316 compiled for interworking or not.  There is a small overhead in the cost
11317 of executing a function pointer if this option is enabled.  This option
11318 is not valid in AAPCS configurations because interworking is enabled
11319 by default.
11321 @item -mtp=@var{name}
11322 @opindex mtp
11323 Specify the access model for the thread local storage pointer.  The valid
11324 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
11325 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
11326 (supported in the arm6k architecture), and @option{auto}, which uses the
11327 best available method for the selected processor.  The default setting is
11328 @option{auto}.
11330 @item -mtls-dialect=@var{dialect}
11331 @opindex mtls-dialect
11332 Specify the dialect to use for accessing thread local storage.  Two
11333 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
11334 @samp{gnu} dialect selects the original GNU scheme for supporting
11335 local and global dynamic TLS models.  The @samp{gnu2} dialect
11336 selects the GNU descriptor scheme, which provides better performance
11337 for shared libraries.  The GNU descriptor scheme is compatible with
11338 the original scheme, but does require new assembler, linker and
11339 library support.  Initial and local exec TLS models are unaffected by
11340 this option and always use the original scheme.
11342 @item -mword-relocations
11343 @opindex mword-relocations
11344 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
11345 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
11346 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
11347 is specified.
11349 @item -mfix-cortex-m3-ldrd
11350 @opindex mfix-cortex-m3-ldrd
11351 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
11352 with overlapping destination and base registers are used.  This option avoids
11353 generating these instructions.  This option is enabled by default when
11354 @option{-mcpu=cortex-m3} is specified.
11356 @item -munaligned-access
11357 @itemx -mno-unaligned-access
11358 @opindex munaligned-access
11359 @opindex mno-unaligned-access
11360 Enables (or disables) reading and writing of 16- and 32- bit values
11361 from addresses that are not 16- or 32- bit aligned.  By default
11362 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
11363 architectures, and enabled for all other architectures.  If unaligned
11364 access is not enabled then words in packed data structures will be
11365 accessed a byte at a time.
11367 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
11368 generated object file to either true or false, depending upon the
11369 setting of this option.  If unaligned access is enabled then the
11370 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
11371 defined.
11373 @end table
11375 @node AVR Options
11376 @subsection AVR Options
11377 @cindex AVR Options
11379 These options are defined for AVR implementations:
11381 @table @gcctabopt
11382 @item -mmcu=@var{mcu}
11383 @opindex mmcu
11384 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
11386 The default for this option is@tie{}@code{avr2}.
11388 GCC supports the following AVR devices and ISAs:
11390 @include avr-mmcu.texi
11392 @item -maccumulate-args
11393 @opindex maccumulate-args
11394 Accumulate outgoing function arguments and acquire/release the needed
11395 stack space for outgoing function arguments once in function
11396 prologue/epilogue.  Without this option, outgoing arguments are pushed
11397 before calling a function and popped afterwards.
11399 Popping the arguments after the function call can be expensive on
11400 AVR so that accumulating the stack space might lead to smaller
11401 executables because arguments need not to be removed from the
11402 stack after such a function call.
11404 This option can lead to reduced code size for functions that perform
11405 several calls to functions that get their arguments on the stack like
11406 calls to printf-like functions.
11408 @item -mbranch-cost=@var{cost}
11409 @opindex mbranch-cost
11410 Set the branch costs for conditional branch instructions to
11411 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
11412 integers. The default branch cost is 0.
11414 @item -mcall-prologues
11415 @opindex mcall-prologues
11416 Functions prologues/epilogues are expanded as calls to appropriate
11417 subroutines.  Code size is smaller.
11419 @item -mint8
11420 @opindex mint8
11421 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
11422 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
11423 and @code{long long} is 4 bytes.  Please note that this option does not
11424 conform to the C standards, but it results in smaller code
11425 size.
11427 @item -mno-interrupts
11428 @opindex mno-interrupts
11429 Generated code is not compatible with hardware interrupts.
11430 Code size is smaller.
11432 @item -mrelax
11433 @opindex mrelax
11434 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11435 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11436 Setting @code{-mrelax} just adds the @code{--relax} option to the
11437 linker command line when the linker is called.
11439 Jump relaxing is performed by the linker because jump offsets are not
11440 known before code is located. Therefore, the assembler code generated by the
11441 compiler is the same, but the instructions in the executable may
11442 differ from instructions in the assembler code.
11444 Relaxing must be turned on if linker stubs are needed, see the
11445 section on @code{EIND} and linker stubs below.
11447 @item -msp8
11448 @opindex msp8
11449 Treat the stack pointer register as an 8-bit register,
11450 i.e.@: assume the high byte of the stack pointer is zero.
11451 In general, you don't need to set this option by hand.
11453 This option is used internally by the compiler to select and
11454 build multilibs for architectures @code{avr2} and @code{avr25}.
11455 These architectures mix devices with and without @code{SPH}.
11456 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
11457 the compiler driver will add or remove this option from the compiler
11458 proper's command line, because the compiler then knows if the device
11459 or architecture has an 8-bit stack pointer and thus no @code{SPH}
11460 register or not.
11462 @item -mstrict-X
11463 @opindex mstrict-X
11464 Use address register @code{X} in a way proposed by the hardware.  This means
11465 that @code{X} is only used in indirect, post-increment or
11466 pre-decrement addressing.
11468 Without this option, the @code{X} register may be used in the same way
11469 as @code{Y} or @code{Z} which then is emulated by additional
11470 instructions.  
11471 For example, loading a value with @code{X+const} addressing with a
11472 small non-negative @code{const < 64} to a register @var{Rn} is
11473 performed as
11475 @example
11476 adiw r26, const   ; X += const
11477 ld   @var{Rn}, X        ; @var{Rn} = *X
11478 sbiw r26, const   ; X -= const
11479 @end example
11481 @item -mtiny-stack
11482 @opindex mtiny-stack
11483 Only change the lower 8@tie{}bits of the stack pointer.
11484 @end table
11486 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11487 @cindex @code{EIND}
11488 Pointers in the implementation are 16@tie{}bits wide.
11489 The address of a function or label is represented as word address so
11490 that indirect jumps and calls can target any code address in the
11491 range of 64@tie{}Ki words.
11493 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11494 bytes of program memory space, there is a special function register called
11495 @code{EIND} that serves as most significant part of the target address
11496 when @code{EICALL} or @code{EIJMP} instructions are used.
11498 Indirect jumps and calls on these devices are handled as follows by
11499 the compiler and are subject to some limitations:
11501 @itemize @bullet
11503 @item
11504 The compiler never sets @code{EIND}.
11506 @item
11507 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11508 instructions or might read @code{EIND} directly in order to emulate an
11509 indirect call/jump by means of a @code{RET} instruction.
11511 @item
11512 The compiler assumes that @code{EIND} never changes during the startup
11513 code or during the application. In particular, @code{EIND} is not
11514 saved/restored in function or interrupt service routine
11515 prologue/epilogue.
11517 @item
11518 For indirect calls to functions and computed goto, the linker
11519 generates @emph{stubs}. Stubs are jump pads sometimes also called
11520 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
11521 The stub contains a direct jump to the desired address.
11523 @item
11524 Linker relaxation must be turned on so that the linker will generate
11525 the stubs correctly an all situaltion. See the compiler option
11526 @code{-mrelax} and the linler option @code{--relax}.
11527 There are corner cases where the linker is supposed to generate stubs
11528 but aborts without relaxation and without a helpful error message.
11530 @item
11531 The default linker script is arranged for code with @code{EIND = 0}.
11532 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11533 linker script has to be used in order to place the sections whose
11534 name start with @code{.trampolines} into the segment where @code{EIND}
11535 points to.
11537 @item
11538 The startup code from libgcc never sets @code{EIND}.
11539 Notice that startup code is a blend of code from libgcc and AVR-LibC.
11540 For the impact of AVR-LibC on @code{EIND}, see the
11541 @w{@uref{http://nongnu.org/avr-libc/user-manual,AVR-LibC user manual}}.
11543 @item
11544 It is legitimate for user-specific startup code to set up @code{EIND}
11545 early, for example by means of initialization code located in
11546 section @code{.init3}. Such code runs prior to general startup code
11547 that initializes RAM and calls constructors, but after the bit
11548 of startup code from AVR-LibC that sets @code{EIND} to the segment
11549 where the vector table is located.
11550 @example
11551 #include <avr/io.h>
11553 static void
11554 __attribute__((section(".init3"),naked,used,no_instrument_function))
11555 init3_set_eind (void)
11557   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
11558                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
11560 @end example
11562 @noindent
11563 The @code{__trampolines_start} symbol is defined in the linker script.
11565 @item
11566 Stubs are generated automatically by the linker if
11567 the following two conditions are met:
11568 @itemize @minus
11570 @item The address of a label is taken by means of the @code{gs} modifier
11571 (short for @emph{generate stubs}) like so:
11572 @example
11573 LDI r24, lo8(gs(@var{func}))
11574 LDI r25, hi8(gs(@var{func}))
11575 @end example
11576 @item The final location of that label is in a code segment
11577 @emph{outside} the segment where the stubs are located.
11578 @end itemize
11580 @item
11581 The compiler emits such @code{gs} modifiers for code labels in the
11582 following situations:
11583 @itemize @minus
11584 @item Taking address of a function or code label.
11585 @item Computed goto.
11586 @item If prologue-save function is used, see @option{-mcall-prologues}
11587 command-line option.
11588 @item Switch/case dispatch tables. If you do not want such dispatch
11589 tables you can specify the @option{-fno-jump-tables} command-line option.
11590 @item C and C++ constructors/destructors called during startup/shutdown.
11591 @item If the tools hit a @code{gs()} modifier explained above.
11592 @end itemize
11594 @item
11595 Jumping to non-symbolic addresses like so is @emph{not} supported:
11597 @example
11598 int main (void)
11600     /* Call function at word address 0x2 */
11601     return ((int(*)(void)) 0x2)();
11603 @end example
11605 Instead, a stub has to be set up, i.e.@: the function has to be called
11606 through a symbol (@code{func_4} in the example):
11608 @example
11609 int main (void)
11611     extern int func_4 (void);
11613     /* Call function at byte address 0x4 */
11614     return func_4();
11616 @end example
11618 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11619 Alternatively, @code{func_4} can be defined in the linker script.
11620 @end itemize
11622 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11623 @cindex @code{RAMPD}
11624 @cindex @code{RAMPX}
11625 @cindex @code{RAMPY}
11626 @cindex @code{RAMPZ}
11627 Some AVR devices support memories larger than the 64@tie{}KiB range
11628 that can be accessed with 16-bit pointers.  To access memory locations
11629 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11630 register is used as high part of the address:
11631 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11632 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11633 register, respectively, to get a wide address. Similarly,
11634 @code{RAMPD} is used together with direct addressing.
11636 @itemize
11637 @item
11638 The startup code initializes the @code{RAMP} special function
11639 registers with zero.
11641 @item
11642 If a @ref{AVR Named Address Spaces,named address space} other than
11643 generic or @code{__flash} is used, then @code{RAMPZ} is set
11644 as needed before the operation.
11646 @item
11647 If the device supports RAM larger than 64@tie{KiB} and the compiler
11648 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11649 is reset to zero after the operation.
11651 @item
11652 If the device comes with a specific @code{RAMP} register, the ISR
11653 prologue/epilogue saves/restores that SFR and initializes it with
11654 zero in case the ISR code might (implicitly) use it.
11656 @item
11657 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
11658 If you use inline assembler to read from locations outside the
11659 16-bit address range and change one of the @code{RAMP} registers,
11660 you must reset it to zero after the access.
11662 @end itemize
11664 @subsubsection AVR Built-in Macros
11666 GCC defines several built-in macros so that the user code can test
11667 for the presence or absence of features.  Almost any of the following
11668 built-in macros are deduced from device capabilities and thus
11669 triggered by the @code{-mmcu=} command-line option.
11671 For even more AVR-specific built-in macros see
11672 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
11674 @table @code
11676 @item __AVR_ARCH__
11677 Build-in macro that resolves to a decimal number that identifies the
11678 architecture and depends on the @code{-mmcu=@var{mcu}} option.
11679 Possible values are:
11681 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
11682 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
11683 @code{105}, @code{106}, @code{107}
11685 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
11686 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
11687 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
11688 @code{avrxmega6}, @code{avrxmega7}, respectively.
11689 If @var{mcu} specifies a device, this built-in macro is set
11690 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
11691 defined to @code{4}.
11693 @item __AVR_@var{Device}__
11694 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
11695 the device's name. For example, @code{-mmcu=atmega8} defines the
11696 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
11697 @code{__AVR_ATtiny261A__}, etc.
11699 The built-in macros' names follow
11700 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
11701 the device name as from the AVR user manual. The difference between
11702 @var{Device} in the built-in macro and @var{device} in
11703 @code{-mmcu=@var{device}} is that the latter is always lowercase.
11705 If @var{device} is not a device but only a core architecture like
11706 @code{avr51}, this macro will not be defined.
11708 @item __AVR_HAVE_ELPM__
11709 The device has the the @code{ELPM} instruction.
11711 @item __AVR_HAVE_ELPMX__
11712 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
11713 R@var{n},Z+} instructions.
11715 @item __AVR_HAVE_MOVW__
11716 The device has the @code{MOVW} instruction to perform 16-bit
11717 register-register moves.
11719 @item __AVR_HAVE_LPMX__
11720 The device has the @code{LPM R@var{n},Z} and
11721 @code{LPM R@var{n},Z+} instructions.
11723 @item __AVR_HAVE_MUL__
11724 The device has a hardware multiplier. 
11726 @item __AVR_HAVE_JMP_CALL__
11727 The device has the @code{JMP} and @code{CALL} instructions.
11728 This is the case for devices with at least 16@tie{}KiB of program
11729 memory.
11731 @item __AVR_HAVE_EIJMP_EICALL__
11732 @item __AVR_3_BYTE_PC__
11733 The device has the @code{EIJMP} and @code{EICALL} instructions.
11734 This is the case for devices with more than 128@tie{}KiB of program memory.
11735 This also means that the program counter
11736 (PC) is 3@tie{}bytes wide.
11738 @item __AVR_2_BYTE_PC__
11739 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
11740 with up to 128@tie{}KiB of program memory.
11742 @item __AVR_HAVE_8BIT_SP__
11743 @item __AVR_HAVE_16BIT_SP__
11744 The stack pointer (SP) register is treated as 8-bit respectively
11745 16-bit register by the compiler.
11746 The definition of these macros is affected by @code{-mtiny-stack}.
11748 @item __AVR_HAVE_SPH__
11749 @item __AVR_SP8__
11750 The device has the SPH (high part of stack pointer) special function
11751 register or has an 8-bit stack pointer, respectively.
11752 The definition of these macros is affected by @code{-mmcu=} and
11753 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
11754 by @code{-msp8}.
11756 @item __AVR_HAVE_RAMPD__
11757 @item __AVR_HAVE_RAMPX__
11758 @item __AVR_HAVE_RAMPY__
11759 @item __AVR_HAVE_RAMPZ__
11760 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
11761 @code{RAMPZ} special function register, respectively.
11763 @item __NO_INTERRUPTS__
11764 This macro reflects the @code{-mno-interrupts} command line option.
11766 @item __AVR_ERRATA_SKIP__
11767 @item __AVR_ERRATA_SKIP_JMP_CALL__
11768 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
11769 instructions because of a hardware erratum.  Skip instructions are
11770 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
11771 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
11772 set.
11774 @item __AVR_SFR_OFFSET__=@var{offset}
11775 Instructions that can address I/O special function registers directly
11776 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
11777 address as if addressed by an instruction to access RAM like @code{LD}
11778 or @code{STS}. This offset depends on the device architecture and has
11779 to be subtracted from the RAM address in order to get the
11780 respective I/O@tie{}address.
11782 @item __WITH_AVRLIBC__
11783 The compiler is configured to be used together with AVR-Libc.
11784 See the @code{--with-avrlibc} configure option.
11786 @end table
11788 @node Blackfin Options
11789 @subsection Blackfin Options
11790 @cindex Blackfin Options
11792 @table @gcctabopt
11793 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11794 @opindex mcpu=
11795 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
11796 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11797 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11798 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11799 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11800 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11801 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11802 @samp{bf561}, @samp{bf592}.
11804 The optional @var{sirevision} specifies the silicon revision of the target
11805 Blackfin processor.  Any workarounds available for the targeted silicon revision
11806 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
11807 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
11808 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
11809 hexadecimal digits representing the major and minor numbers in the silicon
11810 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
11811 is not defined.  If @var{sirevision} is @samp{any}, the
11812 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
11813 If this optional @var{sirevision} is not used, GCC assumes the latest known
11814 silicon revision of the targeted Blackfin processor.
11816 GCC defines a preprocessor macro for the specified @var{cpu}.
11817 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
11818 provided by libgloss to be linked in if @option{-msim} is not given.
11820 Without this option, @samp{bf532} is used as the processor by default.
11822 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
11823 only the preprocessor macro is defined.
11825 @item -msim
11826 @opindex msim
11827 Specifies that the program will be run on the simulator.  This causes
11828 the simulator BSP provided by libgloss to be linked in.  This option
11829 has effect only for @samp{bfin-elf} toolchain.
11830 Certain other options, such as @option{-mid-shared-library} and
11831 @option{-mfdpic}, imply @option{-msim}.
11833 @item -momit-leaf-frame-pointer
11834 @opindex momit-leaf-frame-pointer
11835 Don't keep the frame pointer in a register for leaf functions.  This
11836 avoids the instructions to save, set up and restore frame pointers and
11837 makes an extra register available in leaf functions.  The option
11838 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
11839 which might make debugging harder.
11841 @item -mspecld-anomaly
11842 @opindex mspecld-anomaly
11843 When enabled, the compiler ensures that the generated code does not
11844 contain speculative loads after jump instructions. If this option is used,
11845 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
11847 @item -mno-specld-anomaly
11848 @opindex mno-specld-anomaly
11849 Don't generate extra code to prevent speculative loads from occurring.
11851 @item -mcsync-anomaly
11852 @opindex mcsync-anomaly
11853 When enabled, the compiler ensures that the generated code does not
11854 contain CSYNC or SSYNC instructions too soon after conditional branches.
11855 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
11857 @item -mno-csync-anomaly
11858 @opindex mno-csync-anomaly
11859 Don't generate extra code to prevent CSYNC or SSYNC instructions from
11860 occurring too soon after a conditional branch.
11862 @item -mlow-64k
11863 @opindex mlow-64k
11864 When enabled, the compiler is free to take advantage of the knowledge that
11865 the entire program fits into the low 64k of memory.
11867 @item -mno-low-64k
11868 @opindex mno-low-64k
11869 Assume that the program is arbitrarily large.  This is the default.
11871 @item -mstack-check-l1
11872 @opindex mstack-check-l1
11873 Do stack checking using information placed into L1 scratchpad memory by the
11874 uClinux kernel.
11876 @item -mid-shared-library
11877 @opindex mid-shared-library
11878 Generate code that supports shared libraries via the library ID method.
11879 This allows for execute in place and shared libraries in an environment
11880 without virtual memory management.  This option implies @option{-fPIC}.
11881 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11883 @item -mno-id-shared-library
11884 @opindex mno-id-shared-library
11885 Generate code that doesn't assume ID-based shared libraries are being used.
11886 This is the default.
11888 @item -mleaf-id-shared-library
11889 @opindex mleaf-id-shared-library
11890 Generate code that supports shared libraries via the library ID method,
11891 but assumes that this library or executable won't link against any other
11892 ID shared libraries.  That allows the compiler to use faster code for jumps
11893 and calls.
11895 @item -mno-leaf-id-shared-library
11896 @opindex mno-leaf-id-shared-library
11897 Do not assume that the code being compiled won't link against any ID shared
11898 libraries.  Slower code is generated for jump and call insns.
11900 @item -mshared-library-id=n
11901 @opindex mshared-library-id
11902 Specifies the identification number of the ID-based shared library being
11903 compiled.  Specifying a value of 0 generates more compact code; specifying
11904 other values forces the allocation of that number to the current
11905 library but is no more space- or time-efficient than omitting this option.
11907 @item -msep-data
11908 @opindex msep-data
11909 Generate code that allows the data segment to be located in a different
11910 area of memory from the text segment.  This allows for execute in place in
11911 an environment without virtual memory management by eliminating relocations
11912 against the text section.
11914 @item -mno-sep-data
11915 @opindex mno-sep-data
11916 Generate code that assumes that the data segment follows the text segment.
11917 This is the default.
11919 @item -mlong-calls
11920 @itemx -mno-long-calls
11921 @opindex mlong-calls
11922 @opindex mno-long-calls
11923 Tells the compiler to perform function calls by first loading the
11924 address of the function into a register and then performing a subroutine
11925 call on this register.  This switch is needed if the target function
11926 lies outside of the 24-bit addressing range of the offset-based
11927 version of subroutine call instruction.
11929 This feature is not enabled by default.  Specifying
11930 @option{-mno-long-calls} restores the default behavior.  Note these
11931 switches have no effect on how the compiler generates code to handle
11932 function calls via function pointers.
11934 @item -mfast-fp
11935 @opindex mfast-fp
11936 Link with the fast floating-point library. This library relaxes some of
11937 the IEEE floating-point standard's rules for checking inputs against
11938 Not-a-Number (NAN), in the interest of performance.
11940 @item -minline-plt
11941 @opindex minline-plt
11942 Enable inlining of PLT entries in function calls to functions that are
11943 not known to bind locally.  It has no effect without @option{-mfdpic}.
11945 @item -mmulticore
11946 @opindex mmulticore
11947 Build a standalone application for multicore Blackfin processors. 
11948 This option causes proper start files and link scripts supporting 
11949 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
11950 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
11952 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
11953 selects the one-application-per-core programming model.  Without
11954 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
11955 programming model is used. In this model, the main function of Core B
11956 should be named as @code{coreb_main}.
11958 If this option is not used, the single-core application programming
11959 model is used.
11961 @item -mcorea
11962 @opindex mcorea
11963 Build a standalone application for Core A of BF561 when using
11964 the one-application-per-core programming model. Proper start files
11965 and link scripts are used to support Core A, and the macro
11966 @code{__BFIN_COREA} is defined.
11967 This option can only be used in conjunction with @option{-mmulticore}.
11969 @item -mcoreb
11970 @opindex mcoreb
11971 Build a standalone application for Core B of BF561 when using
11972 the one-application-per-core programming model. Proper start files
11973 and link scripts are used to support Core B, and the macro
11974 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
11975 should be used instead of @code{main}. 
11976 This option can only be used in conjunction with @option{-mmulticore}.
11978 @item -msdram
11979 @opindex msdram
11980 Build a standalone application for SDRAM. Proper start files and
11981 link scripts are used to put the application into SDRAM, and the macro
11982 @code{__BFIN_SDRAM} is defined.
11983 The loader should initialize SDRAM before loading the application.
11985 @item -micplb
11986 @opindex micplb
11987 Assume that ICPLBs are enabled at run time.  This has an effect on certain
11988 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
11989 are enabled; for standalone applications the default is off.
11990 @end table
11992 @node C6X Options
11993 @subsection C6X Options
11994 @cindex C6X Options
11996 @table @gcctabopt
11997 @item -march=@var{name}
11998 @opindex march
11999 This specifies the name of the target architecture.  GCC uses this
12000 name to determine what kind of instructions it can emit when generating
12001 assembly code.  Permissible names are: @samp{c62x},
12002 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
12004 @item -mbig-endian
12005 @opindex mbig-endian
12006 Generate code for a big-endian target.
12008 @item -mlittle-endian
12009 @opindex mlittle-endian
12010 Generate code for a little-endian target.  This is the default.
12012 @item -msim
12013 @opindex msim
12014 Choose startup files and linker script suitable for the simulator.
12016 @item -msdata=default
12017 @opindex msdata=default
12018 Put small global and static data in the @samp{.neardata} section,
12019 which is pointed to by register @code{B14}.  Put small uninitialized
12020 global and static data in the @samp{.bss} section, which is adjacent
12021 to the @samp{.neardata} section.  Put small read-only data into the
12022 @samp{.rodata} section.  The corresponding sections used for large
12023 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
12025 @item -msdata=all
12026 @opindex msdata=all
12027 Put all data, not just small objects, into the sections reserved for
12028 small data, and use addressing relative to the @code{B14} register to
12029 access them.
12031 @item -msdata=none
12032 @opindex msdata=none
12033 Make no use of the sections reserved for small data, and use absolute
12034 addresses to access all data.  Put all initialized global and static
12035 data in the @samp{.fardata} section, and all uninitialized data in the
12036 @samp{.far} section.  Put all constant data into the @samp{.const}
12037 section.
12038 @end table
12040 @node CRIS Options
12041 @subsection CRIS Options
12042 @cindex CRIS Options
12044 These options are defined specifically for the CRIS ports.
12046 @table @gcctabopt
12047 @item -march=@var{architecture-type}
12048 @itemx -mcpu=@var{architecture-type}
12049 @opindex march
12050 @opindex mcpu
12051 Generate code for the specified architecture.  The choices for
12052 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
12053 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
12054 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
12055 @samp{v10}.
12057 @item -mtune=@var{architecture-type}
12058 @opindex mtune
12059 Tune to @var{architecture-type} everything applicable about the generated
12060 code, except for the ABI and the set of available instructions.  The
12061 choices for @var{architecture-type} are the same as for
12062 @option{-march=@var{architecture-type}}.
12064 @item -mmax-stack-frame=@var{n}
12065 @opindex mmax-stack-frame
12066 Warn when the stack frame of a function exceeds @var{n} bytes.
12068 @item -metrax4
12069 @itemx -metrax100
12070 @opindex metrax4
12071 @opindex metrax100
12072 The options @option{-metrax4} and @option{-metrax100} are synonyms for
12073 @option{-march=v3} and @option{-march=v8} respectively.
12075 @item -mmul-bug-workaround
12076 @itemx -mno-mul-bug-workaround
12077 @opindex mmul-bug-workaround
12078 @opindex mno-mul-bug-workaround
12079 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
12080 models where it applies.  This option is active by default.
12082 @item -mpdebug
12083 @opindex mpdebug
12084 Enable CRIS-specific verbose debug-related information in the assembly
12085 code.  This option also has the effect of turning off the @samp{#NO_APP}
12086 formatted-code indicator to the assembler at the beginning of the
12087 assembly file.
12089 @item -mcc-init
12090 @opindex mcc-init
12091 Do not use condition-code results from previous instruction; always emit
12092 compare and test instructions before use of condition codes.
12094 @item -mno-side-effects
12095 @opindex mno-side-effects
12096 Do not emit instructions with side effects in addressing modes other than
12097 post-increment.
12099 @item -mstack-align
12100 @itemx -mno-stack-align
12101 @itemx -mdata-align
12102 @itemx -mno-data-align
12103 @itemx -mconst-align
12104 @itemx -mno-const-align
12105 @opindex mstack-align
12106 @opindex mno-stack-align
12107 @opindex mdata-align
12108 @opindex mno-data-align
12109 @opindex mconst-align
12110 @opindex mno-const-align
12111 These options (@samp{no-} options) arrange (eliminate arrangements) for the
12112 stack frame, individual data and constants to be aligned for the maximum
12113 single data access size for the chosen CPU model.  The default is to
12114 arrange for 32-bit alignment.  ABI details such as structure layout are
12115 not affected by these options.
12117 @item -m32-bit
12118 @itemx -m16-bit
12119 @itemx -m8-bit
12120 @opindex m32-bit
12121 @opindex m16-bit
12122 @opindex m8-bit
12123 Similar to the stack- data- and const-align options above, these options
12124 arrange for stack frame, writable data and constants to all be 32-bit,
12125 16-bit or 8-bit aligned.  The default is 32-bit alignment.
12127 @item -mno-prologue-epilogue
12128 @itemx -mprologue-epilogue
12129 @opindex mno-prologue-epilogue
12130 @opindex mprologue-epilogue
12131 With @option{-mno-prologue-epilogue}, the normal function prologue and
12132 epilogue which set up the stack frame are omitted and no return
12133 instructions or return sequences are generated in the code.  Use this
12134 option only together with visual inspection of the compiled code: no
12135 warnings or errors are generated when call-saved registers must be saved,
12136 or storage for local variables needs to be allocated.
12138 @item -mno-gotplt
12139 @itemx -mgotplt
12140 @opindex mno-gotplt
12141 @opindex mgotplt
12142 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
12143 instruction sequences that load addresses for functions from the PLT part
12144 of the GOT rather than (traditional on other architectures) calls to the
12145 PLT@.  The default is @option{-mgotplt}.
12147 @item -melf
12148 @opindex melf
12149 Legacy no-op option only recognized with the cris-axis-elf and
12150 cris-axis-linux-gnu targets.
12152 @item -mlinux
12153 @opindex mlinux
12154 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
12156 @item -sim
12157 @opindex sim
12158 This option, recognized for the cris-axis-elf, arranges
12159 to link with input-output functions from a simulator library.  Code,
12160 initialized data and zero-initialized data are allocated consecutively.
12162 @item -sim2
12163 @opindex sim2
12164 Like @option{-sim}, but pass linker options to locate initialized data at
12165 0x40000000 and zero-initialized data at 0x80000000.
12166 @end table
12168 @node CR16 Options
12169 @subsection CR16 Options
12170 @cindex CR16 Options
12172 These options are defined specifically for the CR16 ports.
12174 @table @gcctabopt
12176 @item -mmac
12177 @opindex mmac
12178 Enable the use of multiply-accumulate instructions. Disabled by default.
12180 @item -mcr16cplus
12181 @itemx -mcr16c
12182 @opindex mcr16cplus
12183 @opindex mcr16c
12184 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
12185 is default.
12187 @item -msim
12188 @opindex msim
12189 Links the library libsim.a which is in compatible with simulator. Applicable
12190 to ELF compiler only.
12192 @item -mint32
12193 @opindex mint32
12194 Choose integer type as 32-bit wide.
12196 @item -mbit-ops
12197 @opindex mbit-ops
12198 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
12200 @item -mdata-model=@var{model}
12201 @opindex mdata-model
12202 Choose a data model. The choices for @var{model} are @samp{near},
12203 @samp{far} or @samp{medium}. @samp{medium} is default.
12204 However, @samp{far} is not valid with @option{-mcr16c}, as the
12205 CR16C architecture does not support the far data model.
12206 @end table
12208 @node Darwin Options
12209 @subsection Darwin Options
12210 @cindex Darwin options
12212 These options are defined for all architectures running the Darwin operating
12213 system.
12215 FSF GCC on Darwin does not create ``fat'' object files; it creates
12216 an object file for the single architecture that GCC was built to
12217 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
12218 @option{-arch} options are used; it does so by running the compiler or
12219 linker multiple times and joining the results together with
12220 @file{lipo}.
12222 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
12223 @samp{i686}) is determined by the flags that specify the ISA
12224 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
12225 @option{-force_cpusubtype_ALL} option can be used to override this.
12227 The Darwin tools vary in their behavior when presented with an ISA
12228 mismatch.  The assembler, @file{as}, only permits instructions to
12229 be used that are valid for the subtype of the file it is generating,
12230 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
12231 The linker for shared libraries, @file{/usr/bin/libtool}, fails
12232 and prints an error if asked to create a shared library with a less
12233 restrictive subtype than its input files (for instance, trying to put
12234 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
12235 for executables, @command{ld}, quietly gives the executable the most
12236 restrictive subtype of any of its input files.
12238 @table @gcctabopt
12239 @item -F@var{dir}
12240 @opindex F
12241 Add the framework directory @var{dir} to the head of the list of
12242 directories to be searched for header files.  These directories are
12243 interleaved with those specified by @option{-I} options and are
12244 scanned in a left-to-right order.
12246 A framework directory is a directory with frameworks in it.  A
12247 framework is a directory with a @file{Headers} and/or
12248 @file{PrivateHeaders} directory contained directly in it that ends
12249 in @file{.framework}.  The name of a framework is the name of this
12250 directory excluding the @file{.framework}.  Headers associated with
12251 the framework are found in one of those two directories, with
12252 @file{Headers} being searched first.  A subframework is a framework
12253 directory that is in a framework's @file{Frameworks} directory.
12254 Includes of subframework headers can only appear in a header of a
12255 framework that contains the subframework, or in a sibling subframework
12256 header.  Two subframeworks are siblings if they occur in the same
12257 framework.  A subframework should not have the same name as a
12258 framework; a warning is issued if this is violated.  Currently a
12259 subframework cannot have subframeworks; in the future, the mechanism
12260 may be extended to support this.  The standard frameworks can be found
12261 in @file{/System/Library/Frameworks} and
12262 @file{/Library/Frameworks}.  An example include looks like
12263 @code{#include <Framework/header.h>}, where @file{Framework} denotes
12264 the name of the framework and @file{header.h} is found in the
12265 @file{PrivateHeaders} or @file{Headers} directory.
12267 @item -iframework@var{dir}
12268 @opindex iframework
12269 Like @option{-F} except the directory is a treated as a system
12270 directory.  The main difference between this @option{-iframework} and
12271 @option{-F} is that with @option{-iframework} the compiler does not
12272 warn about constructs contained within header files found via
12273 @var{dir}.  This option is valid only for the C family of languages.
12275 @item -gused
12276 @opindex gused
12277 Emit debugging information for symbols that are used.  For stabs
12278 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
12279 This is by default ON@.
12281 @item -gfull
12282 @opindex gfull
12283 Emit debugging information for all symbols and types.
12285 @item -mmacosx-version-min=@var{version}
12286 The earliest version of MacOS X that this executable will run on
12287 is @var{version}.  Typical values of @var{version} include @code{10.1},
12288 @code{10.2}, and @code{10.3.9}.
12290 If the compiler was built to use the system's headers by default,
12291 then the default for this option is the system version on which the
12292 compiler is running, otherwise the default is to make choices that
12293 are compatible with as many systems and code bases as possible.
12295 @item -mkernel
12296 @opindex mkernel
12297 Enable kernel development mode.  The @option{-mkernel} option sets
12298 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
12299 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
12300 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
12301 applicable.  This mode also sets @option{-mno-altivec},
12302 @option{-msoft-float}, @option{-fno-builtin} and
12303 @option{-mlong-branch} for PowerPC targets.
12305 @item -mone-byte-bool
12306 @opindex mone-byte-bool
12307 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
12308 By default @samp{sizeof(bool)} is @samp{4} when compiling for
12309 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
12310 option has no effect on x86.
12312 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
12313 to generate code that is not binary compatible with code generated
12314 without that switch.  Using this switch may require recompiling all
12315 other modules in a program, including system libraries.  Use this
12316 switch to conform to a non-default data model.
12318 @item -mfix-and-continue
12319 @itemx -ffix-and-continue
12320 @itemx -findirect-data
12321 @opindex mfix-and-continue
12322 @opindex ffix-and-continue
12323 @opindex findirect-data
12324 Generate code suitable for fast turnaround development, such as to
12325 allow GDB to dynamically load @code{.o} files into already-running
12326 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
12327 are provided for backwards compatibility.
12329 @item -all_load
12330 @opindex all_load
12331 Loads all members of static archive libraries.
12332 See man ld(1) for more information.
12334 @item -arch_errors_fatal
12335 @opindex arch_errors_fatal
12336 Cause the errors having to do with files that have the wrong architecture
12337 to be fatal.
12339 @item -bind_at_load
12340 @opindex bind_at_load
12341 Causes the output file to be marked such that the dynamic linker will
12342 bind all undefined references when the file is loaded or launched.
12344 @item -bundle
12345 @opindex bundle
12346 Produce a Mach-o bundle format file.
12347 See man ld(1) for more information.
12349 @item -bundle_loader @var{executable}
12350 @opindex bundle_loader
12351 This option specifies the @var{executable} that will load the build
12352 output file being linked.  See man ld(1) for more information.
12354 @item -dynamiclib
12355 @opindex dynamiclib
12356 When passed this option, GCC produces a dynamic library instead of
12357 an executable when linking, using the Darwin @file{libtool} command.
12359 @item -force_cpusubtype_ALL
12360 @opindex force_cpusubtype_ALL
12361 This causes GCC's output file to have the @var{ALL} subtype, instead of
12362 one controlled by the @option{-mcpu} or @option{-march} option.
12364 @item -allowable_client  @var{client_name}
12365 @itemx -client_name
12366 @itemx -compatibility_version
12367 @itemx -current_version
12368 @itemx -dead_strip
12369 @itemx -dependency-file
12370 @itemx -dylib_file
12371 @itemx -dylinker_install_name
12372 @itemx -dynamic
12373 @itemx -exported_symbols_list
12374 @itemx -filelist
12375 @need 800
12376 @itemx -flat_namespace
12377 @itemx -force_flat_namespace
12378 @itemx -headerpad_max_install_names
12379 @itemx -image_base
12380 @itemx -init
12381 @itemx -install_name
12382 @itemx -keep_private_externs
12383 @itemx -multi_module
12384 @itemx -multiply_defined
12385 @itemx -multiply_defined_unused
12386 @need 800
12387 @itemx -noall_load
12388 @itemx -no_dead_strip_inits_and_terms
12389 @itemx -nofixprebinding
12390 @itemx -nomultidefs
12391 @itemx -noprebind
12392 @itemx -noseglinkedit
12393 @itemx -pagezero_size
12394 @itemx -prebind
12395 @itemx -prebind_all_twolevel_modules
12396 @itemx -private_bundle
12397 @need 800
12398 @itemx -read_only_relocs
12399 @itemx -sectalign
12400 @itemx -sectobjectsymbols
12401 @itemx -whyload
12402 @itemx -seg1addr
12403 @itemx -sectcreate
12404 @itemx -sectobjectsymbols
12405 @itemx -sectorder
12406 @itemx -segaddr
12407 @itemx -segs_read_only_addr
12408 @need 800
12409 @itemx -segs_read_write_addr
12410 @itemx -seg_addr_table
12411 @itemx -seg_addr_table_filename
12412 @itemx -seglinkedit
12413 @itemx -segprot
12414 @itemx -segs_read_only_addr
12415 @itemx -segs_read_write_addr
12416 @itemx -single_module
12417 @itemx -static
12418 @itemx -sub_library
12419 @need 800
12420 @itemx -sub_umbrella
12421 @itemx -twolevel_namespace
12422 @itemx -umbrella
12423 @itemx -undefined
12424 @itemx -unexported_symbols_list
12425 @itemx -weak_reference_mismatches
12426 @itemx -whatsloaded
12427 @opindex allowable_client
12428 @opindex client_name
12429 @opindex compatibility_version
12430 @opindex current_version
12431 @opindex dead_strip
12432 @opindex dependency-file
12433 @opindex dylib_file
12434 @opindex dylinker_install_name
12435 @opindex dynamic
12436 @opindex exported_symbols_list
12437 @opindex filelist
12438 @opindex flat_namespace
12439 @opindex force_flat_namespace
12440 @opindex headerpad_max_install_names
12441 @opindex image_base
12442 @opindex init
12443 @opindex install_name
12444 @opindex keep_private_externs
12445 @opindex multi_module
12446 @opindex multiply_defined
12447 @opindex multiply_defined_unused
12448 @opindex noall_load
12449 @opindex no_dead_strip_inits_and_terms
12450 @opindex nofixprebinding
12451 @opindex nomultidefs
12452 @opindex noprebind
12453 @opindex noseglinkedit
12454 @opindex pagezero_size
12455 @opindex prebind
12456 @opindex prebind_all_twolevel_modules
12457 @opindex private_bundle
12458 @opindex read_only_relocs
12459 @opindex sectalign
12460 @opindex sectobjectsymbols
12461 @opindex whyload
12462 @opindex seg1addr
12463 @opindex sectcreate
12464 @opindex sectobjectsymbols
12465 @opindex sectorder
12466 @opindex segaddr
12467 @opindex segs_read_only_addr
12468 @opindex segs_read_write_addr
12469 @opindex seg_addr_table
12470 @opindex seg_addr_table_filename
12471 @opindex seglinkedit
12472 @opindex segprot
12473 @opindex segs_read_only_addr
12474 @opindex segs_read_write_addr
12475 @opindex single_module
12476 @opindex static
12477 @opindex sub_library
12478 @opindex sub_umbrella
12479 @opindex twolevel_namespace
12480 @opindex umbrella
12481 @opindex undefined
12482 @opindex unexported_symbols_list
12483 @opindex weak_reference_mismatches
12484 @opindex whatsloaded
12485 These options are passed to the Darwin linker.  The Darwin linker man page
12486 describes them in detail.
12487 @end table
12489 @node DEC Alpha Options
12490 @subsection DEC Alpha Options
12492 These @samp{-m} options are defined for the DEC Alpha implementations:
12494 @table @gcctabopt
12495 @item -mno-soft-float
12496 @itemx -msoft-float
12497 @opindex mno-soft-float
12498 @opindex msoft-float
12499 Use (do not use) the hardware floating-point instructions for
12500 floating-point operations.  When @option{-msoft-float} is specified,
12501 functions in @file{libgcc.a} are used to perform floating-point
12502 operations.  Unless they are replaced by routines that emulate the
12503 floating-point operations, or compiled in such a way as to call such
12504 emulations routines, these routines issue floating-point
12505 operations.   If you are compiling for an Alpha without floating-point
12506 operations, you must ensure that the library is built so as not to call
12507 them.
12509 Note that Alpha implementations without floating-point operations are
12510 required to have floating-point registers.
12512 @item -mfp-reg
12513 @itemx -mno-fp-regs
12514 @opindex mfp-reg
12515 @opindex mno-fp-regs
12516 Generate code that uses (does not use) the floating-point register set.
12517 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
12518 register set is not used, floating-point operands are passed in integer
12519 registers as if they were integers and floating-point results are passed
12520 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
12521 so any function with a floating-point argument or return value called by code
12522 compiled with @option{-mno-fp-regs} must also be compiled with that
12523 option.
12525 A typical use of this option is building a kernel that does not use,
12526 and hence need not save and restore, any floating-point registers.
12528 @item -mieee
12529 @opindex mieee
12530 The Alpha architecture implements floating-point hardware optimized for
12531 maximum performance.  It is mostly compliant with the IEEE floating-point
12532 standard.  However, for full compliance, software assistance is
12533 required.  This option generates code fully IEEE-compliant code
12534 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12535 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12536 defined during compilation.  The resulting code is less efficient but is
12537 able to correctly support denormalized numbers and exceptional IEEE
12538 values such as not-a-number and plus/minus infinity.  Other Alpha
12539 compilers call this option @option{-ieee_with_no_inexact}.
12541 @item -mieee-with-inexact
12542 @opindex mieee-with-inexact
12543 This is like @option{-mieee} except the generated code also maintains
12544 the IEEE @var{inexact-flag}.  Turning on this option causes the
12545 generated code to implement fully-compliant IEEE math.  In addition to
12546 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12547 macro.  On some Alpha implementations the resulting code may execute
12548 significantly slower than the code generated by default.  Since there is
12549 very little code that depends on the @var{inexact-flag}, you should
12550 normally not specify this option.  Other Alpha compilers call this
12551 option @option{-ieee_with_inexact}.
12553 @item -mfp-trap-mode=@var{trap-mode}
12554 @opindex mfp-trap-mode
12555 This option controls what floating-point related traps are enabled.
12556 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12557 The trap mode can be set to one of four values:
12559 @table @samp
12560 @item n
12561 This is the default (normal) setting.  The only traps that are enabled
12562 are the ones that cannot be disabled in software (e.g., division by zero
12563 trap).
12565 @item u
12566 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12567 as well.
12569 @item su
12570 Like @samp{u}, but the instructions are marked to be safe for software
12571 completion (see Alpha architecture manual for details).
12573 @item sui
12574 Like @samp{su}, but inexact traps are enabled as well.
12575 @end table
12577 @item -mfp-rounding-mode=@var{rounding-mode}
12578 @opindex mfp-rounding-mode
12579 Selects the IEEE rounding mode.  Other Alpha compilers call this option
12580 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
12583 @table @samp
12584 @item n
12585 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
12586 the nearest machine number or towards the even machine number in case
12587 of a tie.
12589 @item m
12590 Round towards minus infinity.
12592 @item c
12593 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
12595 @item d
12596 Dynamic rounding mode.  A field in the floating-point control register
12597 (@var{fpcr}, see Alpha architecture reference manual) controls the
12598 rounding mode in effect.  The C library initializes this register for
12599 rounding towards plus infinity.  Thus, unless your program modifies the
12600 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12601 @end table
12603 @item -mtrap-precision=@var{trap-precision}
12604 @opindex mtrap-precision
12605 In the Alpha architecture, floating-point traps are imprecise.  This
12606 means without software assistance it is impossible to recover from a
12607 floating trap and program execution normally needs to be terminated.
12608 GCC can generate code that can assist operating system trap handlers
12609 in determining the exact location that caused a floating-point trap.
12610 Depending on the requirements of an application, different levels of
12611 precisions can be selected:
12613 @table @samp
12614 @item p
12615 Program precision.  This option is the default and means a trap handler
12616 can only identify which program caused a floating-point exception.
12618 @item f
12619 Function precision.  The trap handler can determine the function that
12620 caused a floating-point exception.
12622 @item i
12623 Instruction precision.  The trap handler can determine the exact
12624 instruction that caused a floating-point exception.
12625 @end table
12627 Other Alpha compilers provide the equivalent options called
12628 @option{-scope_safe} and @option{-resumption_safe}.
12630 @item -mieee-conformant
12631 @opindex mieee-conformant
12632 This option marks the generated code as IEEE conformant.  You must not
12633 use this option unless you also specify @option{-mtrap-precision=i} and either
12634 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
12635 is to emit the line @samp{.eflag 48} in the function prologue of the
12636 generated assembly file.
12638 @item -mbuild-constants
12639 @opindex mbuild-constants
12640 Normally GCC examines a 32- or 64-bit integer constant to
12641 see if it can construct it from smaller constants in two or three
12642 instructions.  If it cannot, it outputs the constant as a literal and
12643 generates code to load it from the data segment at run time.
12645 Use this option to require GCC to construct @emph{all} integer constants
12646 using code, even if it takes more instructions (the maximum is six).
12648 You typically use this option to build a shared library dynamic
12649 loader.  Itself a shared library, it must relocate itself in memory
12650 before it can find the variables and constants in its own data segment.
12652 @item -mbwx
12653 @itemx -mno-bwx
12654 @itemx -mcix
12655 @itemx -mno-cix
12656 @itemx -mfix
12657 @itemx -mno-fix
12658 @itemx -mmax
12659 @itemx -mno-max
12660 @opindex mbwx
12661 @opindex mno-bwx
12662 @opindex mcix
12663 @opindex mno-cix
12664 @opindex mfix
12665 @opindex mno-fix
12666 @opindex mmax
12667 @opindex mno-max
12668 Indicate whether GCC should generate code to use the optional BWX,
12669 CIX, FIX and MAX instruction sets.  The default is to use the instruction
12670 sets supported by the CPU type specified via @option{-mcpu=} option or that
12671 of the CPU on which GCC was built if none is specified.
12673 @item -mfloat-vax
12674 @itemx -mfloat-ieee
12675 @opindex mfloat-vax
12676 @opindex mfloat-ieee
12677 Generate code that uses (does not use) VAX F and G floating-point
12678 arithmetic instead of IEEE single and double precision.
12680 @item -mexplicit-relocs
12681 @itemx -mno-explicit-relocs
12682 @opindex mexplicit-relocs
12683 @opindex mno-explicit-relocs
12684 Older Alpha assemblers provided no way to generate symbol relocations
12685 except via assembler macros.  Use of these macros does not allow
12686 optimal instruction scheduling.  GNU binutils as of version 2.12
12687 supports a new syntax that allows the compiler to explicitly mark
12688 which relocations should apply to which instructions.  This option
12689 is mostly useful for debugging, as GCC detects the capabilities of
12690 the assembler when it is built and sets the default accordingly.
12692 @item -msmall-data
12693 @itemx -mlarge-data
12694 @opindex msmall-data
12695 @opindex mlarge-data
12696 When @option{-mexplicit-relocs} is in effect, static data is
12697 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
12698 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
12699 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
12700 16-bit relocations off of the @code{$gp} register.  This limits the
12701 size of the small data area to 64KB, but allows the variables to be
12702 directly accessed via a single instruction.
12704 The default is @option{-mlarge-data}.  With this option the data area
12705 is limited to just below 2GB@.  Programs that require more than 2GB of
12706 data must use @code{malloc} or @code{mmap} to allocate the data in the
12707 heap instead of in the program's data segment.
12709 When generating code for shared libraries, @option{-fpic} implies
12710 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
12712 @item -msmall-text
12713 @itemx -mlarge-text
12714 @opindex msmall-text
12715 @opindex mlarge-text
12716 When @option{-msmall-text} is used, the compiler assumes that the
12717 code of the entire program (or shared library) fits in 4MB, and is
12718 thus reachable with a branch instruction.  When @option{-msmall-data}
12719 is used, the compiler can assume that all local symbols share the
12720 same @code{$gp} value, and thus reduce the number of instructions
12721 required for a function call from 4 to 1.
12723 The default is @option{-mlarge-text}.
12725 @item -mcpu=@var{cpu_type}
12726 @opindex mcpu
12727 Set the instruction set and instruction scheduling parameters for
12728 machine type @var{cpu_type}.  You can specify either the @samp{EV}
12729 style name or the corresponding chip number.  GCC supports scheduling
12730 parameters for the EV4, EV5 and EV6 family of processors and
12731 chooses the default values for the instruction set from the processor
12732 you specify.  If you do not specify a processor type, GCC defaults
12733 to the processor on which the compiler was built.
12735 Supported values for @var{cpu_type} are
12737 @table @samp
12738 @item ev4
12739 @itemx ev45
12740 @itemx 21064
12741 Schedules as an EV4 and has no instruction set extensions.
12743 @item ev5
12744 @itemx 21164
12745 Schedules as an EV5 and has no instruction set extensions.
12747 @item ev56
12748 @itemx 21164a
12749 Schedules as an EV5 and supports the BWX extension.
12751 @item pca56
12752 @itemx 21164pc
12753 @itemx 21164PC
12754 Schedules as an EV5 and supports the BWX and MAX extensions.
12756 @item ev6
12757 @itemx 21264
12758 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12760 @item ev67
12761 @itemx 21264a
12762 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12763 @end table
12765 Native toolchains also support the value @samp{native},
12766 which selects the best architecture option for the host processor.
12767 @option{-mcpu=native} has no effect if GCC does not recognize
12768 the processor.
12770 @item -mtune=@var{cpu_type}
12771 @opindex mtune
12772 Set only the instruction scheduling parameters for machine type
12773 @var{cpu_type}.  The instruction set is not changed.
12775 Native toolchains also support the value @samp{native},
12776 which selects the best architecture option for the host processor.
12777 @option{-mtune=native} has no effect if GCC does not recognize
12778 the processor.
12780 @item -mmemory-latency=@var{time}
12781 @opindex mmemory-latency
12782 Sets the latency the scheduler should assume for typical memory
12783 references as seen by the application.  This number is highly
12784 dependent on the memory access patterns used by the application
12785 and the size of the external cache on the machine.
12787 Valid options for @var{time} are
12789 @table @samp
12790 @item @var{number}
12791 A decimal number representing clock cycles.
12793 @item L1
12794 @itemx L2
12795 @itemx L3
12796 @itemx main
12797 The compiler contains estimates of the number of clock cycles for
12798 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12799 (also called Dcache, Scache, and Bcache), as well as to main memory.
12800 Note that L3 is only valid for EV5.
12802 @end table
12803 @end table
12805 @node FR30 Options
12806 @subsection FR30 Options
12807 @cindex FR30 Options
12809 These options are defined specifically for the FR30 port.
12811 @table @gcctabopt
12813 @item -msmall-model
12814 @opindex msmall-model
12815 Use the small address space model.  This can produce smaller code, but
12816 it does assume that all symbolic values and addresses fit into a
12817 20-bit range.
12819 @item -mno-lsim
12820 @opindex mno-lsim
12821 Assume that runtime support has been provided and so there is no need
12822 to include the simulator library (@file{libsim.a}) on the linker
12823 command line.
12825 @end table
12827 @node FRV Options
12828 @subsection FRV Options
12829 @cindex FRV Options
12831 @table @gcctabopt
12832 @item -mgpr-32
12833 @opindex mgpr-32
12835 Only use the first 32 general-purpose registers.
12837 @item -mgpr-64
12838 @opindex mgpr-64
12840 Use all 64 general-purpose registers.
12842 @item -mfpr-32
12843 @opindex mfpr-32
12845 Use only the first 32 floating-point registers.
12847 @item -mfpr-64
12848 @opindex mfpr-64
12850 Use all 64 floating-point registers.
12852 @item -mhard-float
12853 @opindex mhard-float
12855 Use hardware instructions for floating-point operations.
12857 @item -msoft-float
12858 @opindex msoft-float
12860 Use library routines for floating-point operations.
12862 @item -malloc-cc
12863 @opindex malloc-cc
12865 Dynamically allocate condition code registers.
12867 @item -mfixed-cc
12868 @opindex mfixed-cc
12870 Do not try to dynamically allocate condition code registers, only
12871 use @code{icc0} and @code{fcc0}.
12873 @item -mdword
12874 @opindex mdword
12876 Change ABI to use double word insns.
12878 @item -mno-dword
12879 @opindex mno-dword
12881 Do not use double word instructions.
12883 @item -mdouble
12884 @opindex mdouble
12886 Use floating-point double instructions.
12888 @item -mno-double
12889 @opindex mno-double
12891 Do not use floating-point double instructions.
12893 @item -mmedia
12894 @opindex mmedia
12896 Use media instructions.
12898 @item -mno-media
12899 @opindex mno-media
12901 Do not use media instructions.
12903 @item -mmuladd
12904 @opindex mmuladd
12906 Use multiply and add/subtract instructions.
12908 @item -mno-muladd
12909 @opindex mno-muladd
12911 Do not use multiply and add/subtract instructions.
12913 @item -mfdpic
12914 @opindex mfdpic
12916 Select the FDPIC ABI, which uses function descriptors to represent
12917 pointers to functions.  Without any PIC/PIE-related options, it
12918 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
12919 assumes GOT entries and small data are within a 12-bit range from the
12920 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
12921 are computed with 32 bits.
12922 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12924 @item -minline-plt
12925 @opindex minline-plt
12927 Enable inlining of PLT entries in function calls to functions that are
12928 not known to bind locally.  It has no effect without @option{-mfdpic}.
12929 It's enabled by default if optimizing for speed and compiling for
12930 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
12931 optimization option such as @option{-O3} or above is present in the
12932 command line.
12934 @item -mTLS
12935 @opindex mTLS
12937 Assume a large TLS segment when generating thread-local code.
12939 @item -mtls
12940 @opindex mtls
12942 Do not assume a large TLS segment when generating thread-local code.
12944 @item -mgprel-ro
12945 @opindex mgprel-ro
12947 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
12948 that is known to be in read-only sections.  It's enabled by default,
12949 except for @option{-fpic} or @option{-fpie}: even though it may help
12950 make the global offset table smaller, it trades 1 instruction for 4.
12951 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
12952 one of which may be shared by multiple symbols, and it avoids the need
12953 for a GOT entry for the referenced symbol, so it's more likely to be a
12954 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
12956 @item -multilib-library-pic
12957 @opindex multilib-library-pic
12959 Link with the (library, not FD) pic libraries.  It's implied by
12960 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
12961 @option{-fpic} without @option{-mfdpic}.  You should never have to use
12962 it explicitly.
12964 @item -mlinked-fp
12965 @opindex mlinked-fp
12967 Follow the EABI requirement of always creating a frame pointer whenever
12968 a stack frame is allocated.  This option is enabled by default and can
12969 be disabled with @option{-mno-linked-fp}.
12971 @item -mlong-calls
12972 @opindex mlong-calls
12974 Use indirect addressing to call functions outside the current
12975 compilation unit.  This allows the functions to be placed anywhere
12976 within the 32-bit address space.
12978 @item -malign-labels
12979 @opindex malign-labels
12981 Try to align labels to an 8-byte boundary by inserting NOPs into the
12982 previous packet.  This option only has an effect when VLIW packing
12983 is enabled.  It doesn't create new packets; it merely adds NOPs to
12984 existing ones.
12986 @item -mlibrary-pic
12987 @opindex mlibrary-pic
12989 Generate position-independent EABI code.
12991 @item -macc-4
12992 @opindex macc-4
12994 Use only the first four media accumulator registers.
12996 @item -macc-8
12997 @opindex macc-8
12999 Use all eight media accumulator registers.
13001 @item -mpack
13002 @opindex mpack
13004 Pack VLIW instructions.
13006 @item -mno-pack
13007 @opindex mno-pack
13009 Do not pack VLIW instructions.
13011 @item -mno-eflags
13012 @opindex mno-eflags
13014 Do not mark ABI switches in e_flags.
13016 @item -mcond-move
13017 @opindex mcond-move
13019 Enable the use of conditional-move instructions (default).
13021 This switch is mainly for debugging the compiler and will likely be removed
13022 in a future version.
13024 @item -mno-cond-move
13025 @opindex mno-cond-move
13027 Disable the use of conditional-move instructions.
13029 This switch is mainly for debugging the compiler and will likely be removed
13030 in a future version.
13032 @item -mscc
13033 @opindex mscc
13035 Enable the use of conditional set instructions (default).
13037 This switch is mainly for debugging the compiler and will likely be removed
13038 in a future version.
13040 @item -mno-scc
13041 @opindex mno-scc
13043 Disable the use of conditional set instructions.
13045 This switch is mainly for debugging the compiler and will likely be removed
13046 in a future version.
13048 @item -mcond-exec
13049 @opindex mcond-exec
13051 Enable the use of conditional execution (default).
13053 This switch is mainly for debugging the compiler and will likely be removed
13054 in a future version.
13056 @item -mno-cond-exec
13057 @opindex mno-cond-exec
13059 Disable the use of conditional execution.
13061 This switch is mainly for debugging the compiler and will likely be removed
13062 in a future version.
13064 @item -mvliw-branch
13065 @opindex mvliw-branch
13067 Run a pass to pack branches into VLIW instructions (default).
13069 This switch is mainly for debugging the compiler and will likely be removed
13070 in a future version.
13072 @item -mno-vliw-branch
13073 @opindex mno-vliw-branch
13075 Do not run a pass to pack branches into VLIW instructions.
13077 This switch is mainly for debugging the compiler and will likely be removed
13078 in a future version.
13080 @item -mmulti-cond-exec
13081 @opindex mmulti-cond-exec
13083 Enable optimization of @code{&&} and @code{||} in conditional execution
13084 (default).
13086 This switch is mainly for debugging the compiler and will likely be removed
13087 in a future version.
13089 @item -mno-multi-cond-exec
13090 @opindex mno-multi-cond-exec
13092 Disable optimization of @code{&&} and @code{||} in conditional execution.
13094 This switch is mainly for debugging the compiler and will likely be removed
13095 in a future version.
13097 @item -mnested-cond-exec
13098 @opindex mnested-cond-exec
13100 Enable nested conditional execution optimizations (default).
13102 This switch is mainly for debugging the compiler and will likely be removed
13103 in a future version.
13105 @item -mno-nested-cond-exec
13106 @opindex mno-nested-cond-exec
13108 Disable nested conditional execution optimizations.
13110 This switch is mainly for debugging the compiler and will likely be removed
13111 in a future version.
13113 @item -moptimize-membar
13114 @opindex moptimize-membar
13116 This switch removes redundant @code{membar} instructions from the
13117 compiler-generated code.  It is enabled by default.
13119 @item -mno-optimize-membar
13120 @opindex mno-optimize-membar
13122 This switch disables the automatic removal of redundant @code{membar}
13123 instructions from the generated code.
13125 @item -mtomcat-stats
13126 @opindex mtomcat-stats
13128 Cause gas to print out tomcat statistics.
13130 @item -mcpu=@var{cpu}
13131 @opindex mcpu
13133 Select the processor type for which to generate code.  Possible values are
13134 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
13135 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
13137 @end table
13139 @node GNU/Linux Options
13140 @subsection GNU/Linux Options
13142 These @samp{-m} options are defined for GNU/Linux targets:
13144 @table @gcctabopt
13145 @item -mglibc
13146 @opindex mglibc
13147 Use the GNU C library.  This is the default except
13148 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
13150 @item -muclibc
13151 @opindex muclibc
13152 Use uClibc C library.  This is the default on
13153 @samp{*-*-linux-*uclibc*} targets.
13155 @item -mbionic
13156 @opindex mbionic
13157 Use Bionic C library.  This is the default on
13158 @samp{*-*-linux-*android*} targets.
13160 @item -mandroid
13161 @opindex mandroid
13162 Compile code compatible with Android platform.  This is the default on
13163 @samp{*-*-linux-*android*} targets.
13165 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
13166 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
13167 this option makes the GCC driver pass Android-specific options to the linker.
13168 Finally, this option causes the preprocessor macro @code{__ANDROID__}
13169 to be defined.
13171 @item -tno-android-cc
13172 @opindex tno-android-cc
13173 Disable compilation effects of @option{-mandroid}, i.e., do not enable
13174 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
13175 @option{-fno-rtti} by default.
13177 @item -tno-android-ld
13178 @opindex tno-android-ld
13179 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
13180 linking options to the linker.
13182 @end table
13184 @node H8/300 Options
13185 @subsection H8/300 Options
13187 These @samp{-m} options are defined for the H8/300 implementations:
13189 @table @gcctabopt
13190 @item -mrelax
13191 @opindex mrelax
13192 Shorten some address references at link time, when possible; uses the
13193 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
13194 ld, Using ld}, for a fuller description.
13196 @item -mh
13197 @opindex mh
13198 Generate code for the H8/300H@.
13200 @item -ms
13201 @opindex ms
13202 Generate code for the H8S@.
13204 @item -mn
13205 @opindex mn
13206 Generate code for the H8S and H8/300H in the normal mode.  This switch
13207 must be used either with @option{-mh} or @option{-ms}.
13209 @item -ms2600
13210 @opindex ms2600
13211 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
13213 @item -mexr
13214 @opindex mexr
13215 Extended registers are stored on stack before execution of function
13216 with monitor attribute. Default option is @option{-mexr}.
13217 This option is valid only for H8S targets.
13219 @item -mno-exr
13220 @opindex mno-exr
13221 Extended registers are not stored on stack before execution of function 
13222 with monitor attribute. Default option is @option{-mno-exr}. 
13223 This option is valid only for H8S targets.
13225 @item -mint32
13226 @opindex mint32
13227 Make @code{int} data 32 bits by default.
13229 @item -malign-300
13230 @opindex malign-300
13231 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
13232 The default for the H8/300H and H8S is to align longs and floats on
13233 4-byte boundaries.
13234 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
13235 This option has no effect on the H8/300.
13236 @end table
13238 @node HPPA Options
13239 @subsection HPPA Options
13240 @cindex HPPA Options
13242 These @samp{-m} options are defined for the HPPA family of computers:
13244 @table @gcctabopt
13245 @item -march=@var{architecture-type}
13246 @opindex march
13247 Generate code for the specified architecture.  The choices for
13248 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
13249 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
13250 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
13251 architecture option for your machine.  Code compiled for lower numbered
13252 architectures runs on higher numbered architectures, but not the
13253 other way around.
13255 @item -mpa-risc-1-0
13256 @itemx -mpa-risc-1-1
13257 @itemx -mpa-risc-2-0
13258 @opindex mpa-risc-1-0
13259 @opindex mpa-risc-1-1
13260 @opindex mpa-risc-2-0
13261 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
13263 @item -mbig-switch
13264 @opindex mbig-switch
13265 Generate code suitable for big switch tables.  Use this option only if
13266 the assembler/linker complain about out-of-range branches within a switch
13267 table.
13269 @item -mjump-in-delay
13270 @opindex mjump-in-delay
13271 Fill delay slots of function calls with unconditional jump instructions
13272 by modifying the return pointer for the function call to be the target
13273 of the conditional jump.
13275 @item -mdisable-fpregs
13276 @opindex mdisable-fpregs
13277 Prevent floating-point registers from being used in any manner.  This is
13278 necessary for compiling kernels that perform lazy context switching of
13279 floating-point registers.  If you use this option and attempt to perform
13280 floating-point operations, the compiler aborts.
13282 @item -mdisable-indexing
13283 @opindex mdisable-indexing
13284 Prevent the compiler from using indexing address modes.  This avoids some
13285 rather obscure problems when compiling MIG generated code under MACH@.
13287 @item -mno-space-regs
13288 @opindex mno-space-regs
13289 Generate code that assumes the target has no space registers.  This allows
13290 GCC to generate faster indirect calls and use unscaled index address modes.
13292 Such code is suitable for level 0 PA systems and kernels.
13294 @item -mfast-indirect-calls
13295 @opindex mfast-indirect-calls
13296 Generate code that assumes calls never cross space boundaries.  This
13297 allows GCC to emit code that performs faster indirect calls.
13299 This option does not work in the presence of shared libraries or nested
13300 functions.
13302 @item -mfixed-range=@var{register-range}
13303 @opindex mfixed-range
13304 Generate code treating the given register range as fixed registers.
13305 A fixed register is one that the register allocator cannot use.  This is
13306 useful when compiling kernel code.  A register range is specified as
13307 two registers separated by a dash.  Multiple register ranges can be
13308 specified separated by a comma.
13310 @item -mlong-load-store
13311 @opindex mlong-load-store
13312 Generate 3-instruction load and store sequences as sometimes required by
13313 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
13314 the HP compilers.
13316 @item -mportable-runtime
13317 @opindex mportable-runtime
13318 Use the portable calling conventions proposed by HP for ELF systems.
13320 @item -mgas
13321 @opindex mgas
13322 Enable the use of assembler directives only GAS understands.
13324 @item -mschedule=@var{cpu-type}
13325 @opindex mschedule
13326 Schedule code according to the constraints for the machine type
13327 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
13328 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
13329 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
13330 proper scheduling option for your machine.  The default scheduling is
13331 @samp{8000}.
13333 @item -mlinker-opt
13334 @opindex mlinker-opt
13335 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
13336 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
13337 linkers in which they give bogus error messages when linking some programs.
13339 @item -msoft-float
13340 @opindex msoft-float
13341 Generate output containing library calls for floating point.
13342 @strong{Warning:} the requisite libraries are not available for all HPPA
13343 targets.  Normally the facilities of the machine's usual C compiler are
13344 used, but this cannot be done directly in cross-compilation.  You must make
13345 your own arrangements to provide suitable library functions for
13346 cross-compilation.
13348 @option{-msoft-float} changes the calling convention in the output file;
13349 therefore, it is only useful if you compile @emph{all} of a program with
13350 this option.  In particular, you need to compile @file{libgcc.a}, the
13351 library that comes with GCC, with @option{-msoft-float} in order for
13352 this to work.
13354 @item -msio
13355 @opindex msio
13356 Generate the predefine, @code{_SIO}, for server IO@.  The default is
13357 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
13358 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
13359 options are available under HP-UX and HI-UX@.
13361 @item -mgnu-ld
13362 @opindex mgnu-ld
13363 Use options specific to GNU @command{ld}.
13364 This passes @option{-shared} to @command{ld} when
13365 building a shared library.  It is the default when GCC is configured,
13366 explicitly or implicitly, with the GNU linker.  This option does not
13367 affect which @command{ld} is called; it only changes what parameters
13368 are passed to that @command{ld}.
13369 The @command{ld} that is called is determined by the
13370 @option{--with-ld} configure option, GCC's program search path, and
13371 finally by the user's @env{PATH}.  The linker used by GCC can be printed
13372 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
13373 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13375 @item -mhp-ld
13376 @opindex mhp-ld
13377 Use options specific to HP @command{ld}.
13378 This passes @option{-b} to @command{ld} when building
13379 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
13380 links.  It is the default when GCC is configured, explicitly or
13381 implicitly, with the HP linker.  This option does not affect
13382 which @command{ld} is called; it only changes what parameters are passed to that
13383 @command{ld}.
13384 The @command{ld} that is called is determined by the @option{--with-ld}
13385 configure option, GCC's program search path, and finally by the user's
13386 @env{PATH}.  The linker used by GCC can be printed using @samp{which
13387 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
13388 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13390 @item -mlong-calls
13391 @opindex mno-long-calls
13392 Generate code that uses long call sequences.  This ensures that a call
13393 is always able to reach linker generated stubs.  The default is to generate
13394 long calls only when the distance from the call site to the beginning
13395 of the function or translation unit, as the case may be, exceeds a
13396 predefined limit set by the branch type being used.  The limits for
13397 normal calls are 7,600,000 and 240,000 bytes, respectively for the
13398 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
13399 240,000 bytes.
13401 Distances are measured from the beginning of functions when using the
13402 @option{-ffunction-sections} option, or when using the @option{-mgas}
13403 and @option{-mno-portable-runtime} options together under HP-UX with
13404 the SOM linker.
13406 It is normally not desirable to use this option as it degrades
13407 performance.  However, it may be useful in large applications,
13408 particularly when partial linking is used to build the application.
13410 The types of long calls used depends on the capabilities of the
13411 assembler and linker, and the type of code being generated.  The
13412 impact on systems that support long absolute calls, and long pic
13413 symbol-difference or pc-relative calls should be relatively small.
13414 However, an indirect call is used on 32-bit ELF systems in pic code
13415 and it is quite long.
13417 @item -munix=@var{unix-std}
13418 @opindex march
13419 Generate compiler predefines and select a startfile for the specified
13420 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
13421 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
13422 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
13423 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
13424 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13425 and later.
13427 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13428 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13429 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13430 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13431 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13432 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13434 It is @emph{important} to note that this option changes the interfaces
13435 for various library routines.  It also affects the operational behavior
13436 of the C library.  Thus, @emph{extreme} care is needed in using this
13437 option.
13439 Library code that is intended to operate with more than one UNIX
13440 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13441 as appropriate.  Most GNU software doesn't provide this capability.
13443 @item -nolibdld
13444 @opindex nolibdld
13445 Suppress the generation of link options to search libdld.sl when the
13446 @option{-static} option is specified on HP-UX 10 and later.
13448 @item -static
13449 @opindex static
13450 The HP-UX implementation of setlocale in libc has a dependency on
13451 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
13452 when the @option{-static} option is specified, special link options
13453 are needed to resolve this dependency.
13455 On HP-UX 10 and later, the GCC driver adds the necessary options to
13456 link with libdld.sl when the @option{-static} option is specified.
13457 This causes the resulting binary to be dynamic.  On the 64-bit port,
13458 the linkers generate dynamic binaries by default in any case.  The
13459 @option{-nolibdld} option can be used to prevent the GCC driver from
13460 adding these link options.
13462 @item -threads
13463 @opindex threads
13464 Add support for multithreading with the @dfn{dce thread} library
13465 under HP-UX@.  This option sets flags for both the preprocessor and
13466 linker.
13467 @end table
13469 @node i386 and x86-64 Options
13470 @subsection Intel 386 and AMD x86-64 Options
13471 @cindex i386 Options
13472 @cindex x86-64 Options
13473 @cindex Intel 386 Options
13474 @cindex AMD x86-64 Options
13476 These @samp{-m} options are defined for the i386 and x86-64 family of
13477 computers:
13479 @table @gcctabopt
13481 @item -march=@var{cpu-type}
13482 @opindex march
13483 Generate instructions for the machine type @var{cpu-type}.  In contrast to
13484 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
13485 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13486 to generate code that may not run at all on processors other than the one
13487 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
13488 @option{-mtune=@var{cpu-type}}.
13490 The choices for @var{cpu-type} are:
13492 @table @samp
13493 @item native
13494 This selects the CPU to generate code for at compilation time by determining
13495 the processor type of the compiling machine.  Using @option{-march=native}
13496 enables all instruction subsets supported by the local machine (hence
13497 the result might not run on different machines).  Using @option{-mtune=native}
13498 produces code optimized for the local machine under the constraints
13499 of the selected instruction set.  
13501 @item i386
13502 Original Intel i386 CPU@.
13504 @item i486
13505 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
13507 @item i586
13508 @itemx pentium
13509 Intel Pentium CPU with no MMX support.
13511 @item pentium-mmx
13512 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13514 @item pentiumpro
13515 Intel Pentium Pro CPU@.
13517 @item i686
13518 When used with @option{-march}, the Pentium Pro
13519 instruction set is used, so the code runs on all i686 family chips.
13520 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13522 @item pentium2
13523 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13524 support.
13526 @item pentium3
13527 @itemx pentium3m
13528 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13529 set support.
13531 @item pentium-m
13532 Intel Pentium M; low-power version of Intel Pentium III CPU
13533 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
13535 @item pentium4
13536 @itemx pentium4m
13537 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13539 @item prescott
13540 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13541 set support.
13543 @item nocona
13544 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13545 SSE2 and SSE3 instruction set support.
13547 @item core2
13548 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13549 instruction set support.
13551 @item corei7
13552 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13553 and SSE4.2 instruction set support.
13555 @item corei7-avx
13556 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13557 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13559 @item core-avx-i
13560 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13561 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13562 set support.
13564 @item atom
13565 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13566 instruction set support.
13568 @item k6
13569 AMD K6 CPU with MMX instruction set support.
13571 @item k6-2
13572 @itemx k6-3
13573 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13575 @item athlon
13576 @itemx athlon-tbird
13577 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13578 support.
13580 @item athlon-4
13581 @itemx athlon-xp
13582 @itemx athlon-mp
13583 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13584 instruction set support.
13586 @item k8
13587 @itemx opteron
13588 @itemx athlon64
13589 @itemx athlon-fx
13590 Processors based on the AMD K8 core with x86-64 instruction set support,
13591 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13592 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13593 instruction set extensions.)
13595 @item k8-sse3
13596 @itemx opteron-sse3
13597 @itemx athlon64-sse3
13598 Improved versions of AMD K8 cores with SSE3 instruction set support.
13600 @item amdfam10
13601 @itemx barcelona
13602 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
13603 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13604 instruction set extensions.)
13606 @item bdver1
13607 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
13608 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13609 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13610 @item bdver2
13611 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13612 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13613 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13614 extensions.)
13616 @item btver1
13617 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
13618 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13619 instruction set extensions.)
13621 @item btver2
13622 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
13623 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
13624 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
13626 @item winchip-c6
13627 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13628 set support.
13630 @item winchip2
13631 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13632 instruction set support.
13634 @item c3
13635 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
13636 implemented for this chip.)
13638 @item c3-2
13639 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13640 (No scheduling is
13641 implemented for this chip.)
13643 @item geode
13644 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
13645 @end table
13647 @item -mtune=@var{cpu-type}
13648 @opindex mtune
13649 Tune to @var{cpu-type} everything applicable about the generated code, except
13650 for the ABI and the set of available instructions.  
13651 While picking a specific @var{cpu-type} schedules things appropriately
13652 for that particular chip, the compiler does not generate any code that
13653 cannot run on the default machine type unless you use a
13654 @option{-march=@var{cpu-type}} option.
13655 For example, if GCC is configured for i686-pc-linux-gnu
13656 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
13657 but still runs on i686 machines.
13659 The choices for @var{cpu-type} are the same as for @option{-march}.
13660 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
13662 @table @samp
13663 @item generic
13664 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
13665 If you know the CPU on which your code will run, then you should use
13666 the corresponding @option{-mtune} or @option{-march} option instead of
13667 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
13668 of your application will have, then you should use this option.
13670 As new processors are deployed in the marketplace, the behavior of this
13671 option will change.  Therefore, if you upgrade to a newer version of
13672 GCC, code generation controlled by this option will change to reflect
13673 the processors
13674 that are most common at the time that version of GCC is released.
13676 There is no @option{-march=generic} option because @option{-march}
13677 indicates the instruction set the compiler can use, and there is no
13678 generic instruction set applicable to all processors.  In contrast,
13679 @option{-mtune} indicates the processor (or, in this case, collection of
13680 processors) for which the code is optimized.
13681 @end table
13683 @item -mcpu=@var{cpu-type}
13684 @opindex mcpu
13685 A deprecated synonym for @option{-mtune}.
13687 @item -mfpmath=@var{unit}
13688 @opindex mfpmath
13689 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
13690 for @var{unit} are:
13692 @table @samp
13693 @item 387
13694 Use the standard 387 floating-point coprocessor present on the majority of chips and
13695 emulated otherwise.  Code compiled with this option runs almost everywhere.
13696 The temporary results are computed in 80-bit precision instead of the precision
13697 specified by the type, resulting in slightly different results compared to most
13698 of other chips.  See @option{-ffloat-store} for more detailed description.
13700 This is the default choice for i386 compiler.
13702 @item sse
13703 Use scalar floating-point instructions present in the SSE instruction set.
13704 This instruction set is supported by Pentium III and newer chips,
13705 and in the AMD line
13706 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
13707 instruction set supports only single-precision arithmetic, thus the double and
13708 extended-precision arithmetic are still done using 387.  A later version, present
13709 only in Pentium 4 and AMD x86-64 chips, supports double-precision
13710 arithmetic too.
13712 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
13713 or @option{-msse2} switches to enable SSE extensions and make this option
13714 effective.  For the x86-64 compiler, these extensions are enabled by default.
13716 The resulting code should be considerably faster in the majority of cases and avoid
13717 the numerical instability problems of 387 code, but may break some existing
13718 code that expects temporaries to be 80 bits.
13720 This is the default choice for the x86-64 compiler.
13722 @item sse,387
13723 @itemx sse+387
13724 @itemx both
13725 Attempt to utilize both instruction sets at once.  This effectively doubles the
13726 amount of available registers, and on chips with separate execution units for
13727 387 and SSE the execution resources too.  Use this option with care, as it is
13728 still experimental, because the GCC register allocator does not model separate
13729 functional units well, resulting in unstable performance.
13730 @end table
13732 @item -masm=@var{dialect}
13733 @opindex masm=@var{dialect}
13734 Output assembly instructions using selected @var{dialect}.  Supported
13735 choices are @samp{intel} or @samp{att} (the default).  Darwin does
13736 not support @samp{intel}.
13738 @item -mieee-fp
13739 @itemx -mno-ieee-fp
13740 @opindex mieee-fp
13741 @opindex mno-ieee-fp
13742 Control whether or not the compiler uses IEEE floating-point
13743 comparisons.  These correctly handle the case where the result of a
13744 comparison is unordered.
13746 @item -msoft-float
13747 @opindex msoft-float
13748 Generate output containing library calls for floating point.
13750 @strong{Warning:} the requisite libraries are not part of GCC@.
13751 Normally the facilities of the machine's usual C compiler are used, but
13752 this can't be done directly in cross-compilation.  You must make your
13753 own arrangements to provide suitable library functions for
13754 cross-compilation.
13756 On machines where a function returns floating-point results in the 80387
13757 register stack, some floating-point opcodes may be emitted even if
13758 @option{-msoft-float} is used.
13760 @item -mno-fp-ret-in-387
13761 @opindex mno-fp-ret-in-387
13762 Do not use the FPU registers for return values of functions.
13764 The usual calling convention has functions return values of types
13765 @code{float} and @code{double} in an FPU register, even if there
13766 is no FPU@.  The idea is that the operating system should emulate
13767 an FPU@.
13769 The option @option{-mno-fp-ret-in-387} causes such values to be returned
13770 in ordinary CPU registers instead.
13772 @item -mno-fancy-math-387
13773 @opindex mno-fancy-math-387
13774 Some 387 emulators do not support the @code{sin}, @code{cos} and
13775 @code{sqrt} instructions for the 387.  Specify this option to avoid
13776 generating those instructions.  This option is the default on FreeBSD,
13777 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
13778 indicates that the target CPU always has an FPU and so the
13779 instruction does not need emulation.  These
13780 instructions are not generated unless you also use the
13781 @option{-funsafe-math-optimizations} switch.
13783 @item -malign-double
13784 @itemx -mno-align-double
13785 @opindex malign-double
13786 @opindex mno-align-double
13787 Control whether GCC aligns @code{double}, @code{long double}, and
13788 @code{long long} variables on a two-word boundary or a one-word
13789 boundary.  Aligning @code{double} variables on a two-word boundary
13790 produces code that runs somewhat faster on a Pentium at the
13791 expense of more memory.
13793 On x86-64, @option{-malign-double} is enabled by default.
13795 @strong{Warning:} if you use the @option{-malign-double} switch,
13796 structures containing the above types are aligned differently than
13797 the published application binary interface specifications for the 386
13798 and are not binary compatible with structures in code compiled
13799 without that switch.
13801 @item -m96bit-long-double
13802 @itemx -m128bit-long-double
13803 @opindex m96bit-long-double
13804 @opindex m128bit-long-double
13805 These switches control the size of @code{long double} type.  The i386
13806 application binary interface specifies the size to be 96 bits,
13807 so @option{-m96bit-long-double} is the default in 32-bit mode.
13809 Modern architectures (Pentium and newer) prefer @code{long double}
13810 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
13811 conforming to the ABI, this is not possible.  So specifying
13812 @option{-m128bit-long-double} aligns @code{long double}
13813 to a 16-byte boundary by padding the @code{long double} with an additional
13814 32-bit zero.
13816 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
13817 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
13819 Notice that neither of these options enable any extra precision over the x87
13820 standard of 80 bits for a @code{long double}.
13822 @strong{Warning:} if you override the default value for your target ABI, this
13823 changes the size of 
13824 structures and arrays containing @code{long double} variables,
13825 as well as modifying the function calling convention for functions taking
13826 @code{long double}.  Hence they are not binary-compatible
13827 with code compiled without that switch.
13829 @item -mlong-double-64
13830 @itemx -mlong-double-80
13831 @opindex mlong-double-64
13832 @opindex mlong-double-80
13833 These switches control the size of @code{long double} type. A size
13834 of 64 bits makes the @code{long double} type equivalent to the @code{double}
13835 type. This is the default for Bionic C library.
13837 @strong{Warning:} if you override the default value for your target ABI, this
13838 changes the size of
13839 structures and arrays containing @code{long double} variables,
13840 as well as modifying the function calling convention for functions taking
13841 @code{long double}.  Hence they are not binary-compatible
13842 with code compiled without that switch.
13844 @item -mlarge-data-threshold=@var{threshold}
13845 @opindex mlarge-data-threshold
13846 When @option{-mcmodel=medium} is specified, data objects larger than
13847 @var{threshold} are placed in the large data section.  This value must be the
13848 same across all objects linked into the binary, and defaults to 65535.
13850 @item -mrtd
13851 @opindex mrtd
13852 Use a different function-calling convention, in which functions that
13853 take a fixed number of arguments return with the @code{ret @var{num}}
13854 instruction, which pops their arguments while returning.  This saves one
13855 instruction in the caller since there is no need to pop the arguments
13856 there.
13858 You can specify that an individual function is called with this calling
13859 sequence with the function attribute @samp{stdcall}.  You can also
13860 override the @option{-mrtd} option by using the function attribute
13861 @samp{cdecl}.  @xref{Function Attributes}.
13863 @strong{Warning:} this calling convention is incompatible with the one
13864 normally used on Unix, so you cannot use it if you need to call
13865 libraries compiled with the Unix compiler.
13867 Also, you must provide function prototypes for all functions that
13868 take variable numbers of arguments (including @code{printf});
13869 otherwise incorrect code is generated for calls to those
13870 functions.
13872 In addition, seriously incorrect code results if you call a
13873 function with too many arguments.  (Normally, extra arguments are
13874 harmlessly ignored.)
13876 @item -mregparm=@var{num}
13877 @opindex mregparm
13878 Control how many registers are used to pass integer arguments.  By
13879 default, no registers are used to pass arguments, and at most 3
13880 registers can be used.  You can control this behavior for a specific
13881 function by using the function attribute @samp{regparm}.
13882 @xref{Function Attributes}.
13884 @strong{Warning:} if you use this switch, and
13885 @var{num} is nonzero, then you must build all modules with the same
13886 value, including any libraries.  This includes the system libraries and
13887 startup modules.
13889 @item -msseregparm
13890 @opindex msseregparm
13891 Use SSE register passing conventions for float and double arguments
13892 and return values.  You can control this behavior for a specific
13893 function by using the function attribute @samp{sseregparm}.
13894 @xref{Function Attributes}.
13896 @strong{Warning:} if you use this switch then you must build all
13897 modules with the same value, including any libraries.  This includes
13898 the system libraries and startup modules.
13900 @item -mvect8-ret-in-mem
13901 @opindex mvect8-ret-in-mem
13902 Return 8-byte vectors in memory instead of MMX registers.  This is the
13903 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
13904 Studio compilers until version 12.  Later compiler versions (starting
13905 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
13906 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
13907 you need to remain compatible with existing code produced by those
13908 previous compiler versions or older versions of GCC@.
13910 @item -mpc32
13911 @itemx -mpc64
13912 @itemx -mpc80
13913 @opindex mpc32
13914 @opindex mpc64
13915 @opindex mpc80
13917 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
13918 is specified, the significands of results of floating-point operations are
13919 rounded to 24 bits (single precision); @option{-mpc64} rounds the
13920 significands of results of floating-point operations to 53 bits (double
13921 precision) and @option{-mpc80} rounds the significands of results of
13922 floating-point operations to 64 bits (extended double precision), which is
13923 the default.  When this option is used, floating-point operations in higher
13924 precisions are not available to the programmer without setting the FPU
13925 control word explicitly.
13927 Setting the rounding of floating-point operations to less than the default
13928 80 bits can speed some programs by 2% or more.  Note that some mathematical
13929 libraries assume that extended-precision (80-bit) floating-point operations
13930 are enabled by default; routines in such libraries could suffer significant
13931 loss of accuracy, typically through so-called ``catastrophic cancellation'',
13932 when this option is used to set the precision to less than extended precision.
13934 @item -mstackrealign
13935 @opindex mstackrealign
13936 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
13937 option generates an alternate prologue and epilogue that realigns the
13938 run-time stack if necessary.  This supports mixing legacy codes that keep
13939 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
13940 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
13941 applicable to individual functions.
13943 @item -mpreferred-stack-boundary=@var{num}
13944 @opindex mpreferred-stack-boundary
13945 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
13946 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
13947 the default is 4 (16 bytes or 128 bits).
13949 @strong{Warning:} When generating code for the x86-64 architecture with
13950 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
13951 used to keep the stack boundary aligned to 8 byte boundary.  Since
13952 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
13953 intended to be used in controlled environment where stack space is
13954 important limitation.  This option will lead to wrong code when functions
13955 compiled with 16 byte stack alignment (such as functions from a standard
13956 library) are called with misaligned stack.  In this case, SSE
13957 instructions may lead to misaligned memory access traps.  In addition,
13958 variable arguments will be handled incorrectly for 16 byte aligned
13959 objects (including x87 long double and __int128), leading to wrong
13960 results.  You must build all modules with
13961 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
13962 includes the system libraries and startup modules.
13964 @item -mincoming-stack-boundary=@var{num}
13965 @opindex mincoming-stack-boundary
13966 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
13967 boundary.  If @option{-mincoming-stack-boundary} is not specified,
13968 the one specified by @option{-mpreferred-stack-boundary} is used.
13970 On Pentium and Pentium Pro, @code{double} and @code{long double} values
13971 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
13972 suffer significant run time performance penalties.  On Pentium III, the
13973 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
13974 properly if it is not 16-byte aligned.
13976 To ensure proper alignment of this values on the stack, the stack boundary
13977 must be as aligned as that required by any value stored on the stack.
13978 Further, every function must be generated such that it keeps the stack
13979 aligned.  Thus calling a function compiled with a higher preferred
13980 stack boundary from a function compiled with a lower preferred stack
13981 boundary most likely misaligns the stack.  It is recommended that
13982 libraries that use callbacks always use the default setting.
13984 This extra alignment does consume extra stack space, and generally
13985 increases code size.  Code that is sensitive to stack space usage, such
13986 as embedded systems and operating system kernels, may want to reduce the
13987 preferred alignment to @option{-mpreferred-stack-boundary=2}.
13989 @item -mmmx
13990 @itemx -mno-mmx
13991 @itemx -msse
13992 @itemx -mno-sse
13993 @itemx -msse2
13994 @itemx -mno-sse2
13995 @itemx -msse3
13996 @itemx -mno-sse3
13997 @itemx -mssse3
13998 @itemx -mno-ssse3
13999 @itemx -msse4.1
14000 @need 800
14001 @itemx -mno-sse4.1
14002 @itemx -msse4.2
14003 @itemx -mno-sse4.2
14004 @itemx -msse4
14005 @itemx -mno-sse4
14006 @itemx -mavx
14007 @itemx -mno-avx
14008 @itemx -mavx2
14009 @itemx -mno-avx2
14010 @itemx -maes
14011 @itemx -mno-aes
14012 @itemx -mpclmul
14013 @need 800
14014 @itemx -mno-pclmul
14015 @itemx -mfsgsbase
14016 @itemx -mno-fsgsbase
14017 @itemx -mrdrnd
14018 @itemx -mno-rdrnd
14019 @itemx -mf16c
14020 @itemx -mno-f16c
14021 @itemx -mfma
14022 @itemx -mno-fma
14023 @itemx -msse4a
14024 @itemx -mno-sse4a
14025 @itemx -mfma4
14026 @need 800
14027 @itemx -mno-fma4
14028 @itemx -mxop
14029 @itemx -mno-xop
14030 @itemx -mlwp
14031 @itemx -mno-lwp
14032 @itemx -m3dnow
14033 @itemx -mno-3dnow
14034 @itemx -mpopcnt
14035 @itemx -mno-popcnt
14036 @itemx -mabm
14037 @itemx -mno-abm
14038 @itemx -mbmi
14039 @itemx -mbmi2
14040 @itemx -mno-bmi
14041 @itemx -mno-bmi2
14042 @itemx -mlzcnt
14043 @itemx -mno-lzcnt
14044 @itemx -mrtm
14045 @itemx -mtbm
14046 @itemx -mno-tbm
14047 @opindex mmmx
14048 @opindex mno-mmx
14049 @opindex msse
14050 @opindex mno-sse
14051 @opindex m3dnow
14052 @opindex mno-3dnow
14053 These switches enable or disable the use of instructions in the MMX, SSE,
14054 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
14055 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
14056 extended instruction sets.
14057 These extensions are also available as built-in functions: see
14058 @ref{X86 Built-in Functions}, for details of the functions enabled and
14059 disabled by these switches.
14061 To generate SSE/SSE2 instructions automatically from floating-point
14062 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
14064 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
14065 generates new AVX instructions or AVX equivalence for all SSEx instructions
14066 when needed.
14068 These options enable GCC to use these extended instructions in
14069 generated code, even without @option{-mfpmath=sse}.  Applications that
14070 perform run-time CPU detection must compile separate files for each
14071 supported architecture, using the appropriate flags.  In particular,
14072 the file containing the CPU detection code should be compiled without
14073 these options.
14075 @item -mcld
14076 @opindex mcld
14077 This option instructs GCC to emit a @code{cld} instruction in the prologue
14078 of functions that use string instructions.  String instructions depend on
14079 the DF flag to select between autoincrement or autodecrement mode.  While the
14080 ABI specifies the DF flag to be cleared on function entry, some operating
14081 systems violate this specification by not clearing the DF flag in their
14082 exception dispatchers.  The exception handler can be invoked with the DF flag
14083 set, which leads to wrong direction mode when string instructions are used.
14084 This option can be enabled by default on 32-bit x86 targets by configuring
14085 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
14086 instructions can be suppressed with the @option{-mno-cld} compiler option
14087 in this case.
14089 @item -mvzeroupper
14090 @opindex mvzeroupper
14091 This option instructs GCC to emit a @code{vzeroupper} instruction
14092 before a transfer of control flow out of the function to minimize
14093 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
14094 intrinsics.
14096 @item -mprefer-avx128
14097 @opindex mprefer-avx128
14098 This option instructs GCC to use 128-bit AVX instructions instead of
14099 256-bit AVX instructions in the auto-vectorizer.
14101 @item -mcx16
14102 @opindex mcx16
14103 This option enables GCC to generate @code{CMPXCHG16B} instructions.
14104 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
14105 (or oword) data types.  
14106 This is useful for high-resolution counters that can be updated
14107 by multiple processors (or cores).  This instruction is generated as part of
14108 atomic built-in functions: see @ref{__sync Builtins} or
14109 @ref{__atomic Builtins} for details.
14111 @item -msahf
14112 @opindex msahf
14113 This option enables generation of @code{SAHF} instructions in 64-bit code.
14114 Early Intel Pentium 4 CPUs with Intel 64 support,
14115 prior to the introduction of Pentium 4 G1 step in December 2005,
14116 lacked the @code{LAHF} and @code{SAHF} instructions
14117 which were supported by AMD64.
14118 These are load and store instructions, respectively, for certain status flags.
14119 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
14120 @code{drem}, and @code{remainder} built-in functions;
14121 see @ref{Other Builtins} for details.
14123 @item -mmovbe
14124 @opindex mmovbe
14125 This option enables use of the @code{movbe} instruction to implement
14126 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
14128 @item -mcrc32
14129 @opindex mcrc32
14130 This option enables built-in functions @code{__builtin_ia32_crc32qi},
14131 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
14132 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
14134 @item -mrecip
14135 @opindex mrecip
14136 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
14137 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
14138 with an additional Newton-Raphson step
14139 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
14140 (and their vectorized
14141 variants) for single-precision floating-point arguments.  These instructions
14142 are generated only when @option{-funsafe-math-optimizations} is enabled
14143 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
14144 Note that while the throughput of the sequence is higher than the throughput
14145 of the non-reciprocal instruction, the precision of the sequence can be
14146 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
14148 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
14149 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
14150 combination), and doesn't need @option{-mrecip}.
14152 Also note that GCC emits the above sequence with additional Newton-Raphson step
14153 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
14154 already with @option{-ffast-math} (or the above option combination), and
14155 doesn't need @option{-mrecip}.
14157 @item -mrecip=@var{opt}
14158 @opindex mrecip=opt
14159 This option controls which reciprocal estimate instructions
14160 may be used.  @var{opt} is a comma-separated list of options, which may
14161 be preceded by a @samp{!} to invert the option:
14163 @table @samp
14164 @item all
14165 Enable all estimate instructions.
14167 @item default
14168 Enable the default instructions, equivalent to @option{-mrecip}.
14170 @item none
14171 Disable all estimate instructions, equivalent to @option{-mno-recip}.
14173 @item div
14174 Enable the approximation for scalar division.
14176 @item vec-div
14177 Enable the approximation for vectorized division.
14179 @item sqrt
14180 Enable the approximation for scalar square root.
14182 @item vec-sqrt
14183 Enable the approximation for vectorized square root.
14184 @end table
14186 So, for example, @option{-mrecip=all,!sqrt} enables
14187 all of the reciprocal approximations, except for square root.
14189 @item -mveclibabi=@var{type}
14190 @opindex mveclibabi
14191 Specifies the ABI type to use for vectorizing intrinsics using an
14192 external library.  Supported values for @var{type} are @samp{svml} 
14193 for the Intel short
14194 vector math library and @samp{acml} for the AMD math core library.
14195 To use this option, both @option{-ftree-vectorize} and
14196 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
14197 ABI-compatible library must be specified at link time.
14199 GCC currently emits calls to @code{vmldExp2},
14200 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
14201 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
14202 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
14203 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
14204 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
14205 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
14206 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
14207 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
14208 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
14209 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
14210 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
14211 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
14212 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
14213 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
14214 when @option{-mveclibabi=acml} is used.  
14216 @item -mabi=@var{name}
14217 @opindex mabi
14218 Generate code for the specified calling convention.  Permissible values
14219 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
14220 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
14221 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
14222 You can control this behavior for a specific function by
14223 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
14224 @xref{Function Attributes}.
14226 @item -mtls-dialect=@var{type}
14227 @opindex mtls-dialect
14228 Generate code to access thread-local storage using the @samp{gnu} or
14229 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
14230 @samp{gnu2} is more efficient, but it may add compile- and run-time
14231 requirements that cannot be satisfied on all systems.
14233 @item -mpush-args
14234 @itemx -mno-push-args
14235 @opindex mpush-args
14236 @opindex mno-push-args
14237 Use PUSH operations to store outgoing parameters.  This method is shorter
14238 and usually equally fast as method using SUB/MOV operations and is enabled
14239 by default.  In some cases disabling it may improve performance because of
14240 improved scheduling and reduced dependencies.
14242 @item -maccumulate-outgoing-args
14243 @opindex maccumulate-outgoing-args
14244 If enabled, the maximum amount of space required for outgoing arguments is
14245 computed in the function prologue.  This is faster on most modern CPUs
14246 because of reduced dependencies, improved scheduling and reduced stack usage
14247 when the preferred stack boundary is not equal to 2.  The drawback is a notable
14248 increase in code size.  This switch implies @option{-mno-push-args}.
14250 @item -mthreads
14251 @opindex mthreads
14252 Support thread-safe exception handling on MinGW.  Programs that rely
14253 on thread-safe exception handling must compile and link all code with the
14254 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
14255 @code{-D_MT}; when linking, it links in a special thread helper library
14256 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
14258 @item -mno-align-stringops
14259 @opindex mno-align-stringops
14260 Do not align the destination of inlined string operations.  This switch reduces
14261 code size and improves performance in case the destination is already aligned,
14262 but GCC doesn't know about it.
14264 @item -minline-all-stringops
14265 @opindex minline-all-stringops
14266 By default GCC inlines string operations only when the destination is 
14267 known to be aligned to least a 4-byte boundary.  
14268 This enables more inlining and increases code
14269 size, but may improve performance of code that depends on fast
14270 @code{memcpy}, @code{strlen},
14271 and @code{memset} for short lengths.
14273 @item -minline-stringops-dynamically
14274 @opindex minline-stringops-dynamically
14275 For string operations of unknown size, use run-time checks with
14276 inline code for small blocks and a library call for large blocks.
14278 @item -mstringop-strategy=@var{alg}
14279 @opindex mstringop-strategy=@var{alg}
14280 Override the internal decision heuristic for the particular algorithm to use
14281 for inlining string operations.  The allowed values for @var{alg} are:
14283 @table @samp
14284 @item rep_byte
14285 @itemx rep_4byte
14286 @itemx rep_8byte
14287 Expand using i386 @code{rep} prefix of the specified size.
14289 @item byte_loop
14290 @itemx loop
14291 @itemx unrolled_loop
14292 Expand into an inline loop.
14294 @item libcall
14295 Always use a library call.
14296 @end table
14298 @item -momit-leaf-frame-pointer
14299 @opindex momit-leaf-frame-pointer
14300 Don't keep the frame pointer in a register for leaf functions.  This
14301 avoids the instructions to save, set up, and restore frame pointers and
14302 makes an extra register available in leaf functions.  The option
14303 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
14304 which might make debugging harder.
14306 @item -mtls-direct-seg-refs
14307 @itemx -mno-tls-direct-seg-refs
14308 @opindex mtls-direct-seg-refs
14309 Controls whether TLS variables may be accessed with offsets from the
14310 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
14311 or whether the thread base pointer must be added.  Whether or not this
14312 is valid depends on the operating system, and whether it maps the
14313 segment to cover the entire TLS area.
14315 For systems that use the GNU C Library, the default is on.
14317 @item -msse2avx
14318 @itemx -mno-sse2avx
14319 @opindex msse2avx
14320 Specify that the assembler should encode SSE instructions with VEX
14321 prefix.  The option @option{-mavx} turns this on by default.
14323 @item -mfentry
14324 @itemx -mno-fentry
14325 @opindex mfentry
14326 If profiling is active (@option{-pg}), put the profiling
14327 counter call before the prologue.
14328 Note: On x86 architectures the attribute @code{ms_hook_prologue}
14329 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
14331 @item -m8bit-idiv
14332 @itemx -mno-8bit-idiv
14333 @opindex 8bit-idiv
14334 On some processors, like Intel Atom, 8-bit unsigned integer divide is
14335 much faster than 32-bit/64-bit integer divide.  This option generates a
14336 run-time check.  If both dividend and divisor are within range of 0
14337 to 255, 8-bit unsigned integer divide is used instead of
14338 32-bit/64-bit integer divide.
14340 @item -mavx256-split-unaligned-load
14341 @itemx -mavx256-split-unaligned-store
14342 @opindex avx256-split-unaligned-load
14343 @opindex avx256-split-unaligned-store
14344 Split 32-byte AVX unaligned load and store.
14346 @end table
14348 These @samp{-m} switches are supported in addition to the above
14349 on x86-64 processors in 64-bit environments.
14351 @table @gcctabopt
14352 @item -m32
14353 @itemx -m64
14354 @itemx -mx32
14355 @opindex m32
14356 @opindex m64
14357 @opindex mx32
14358 Generate code for a 32-bit or 64-bit environment.
14359 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
14360 to 32 bits, and
14361 generates code that runs on any i386 system.
14363 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
14364 types to 64 bits, and generates code for the x86-64 architecture.
14365 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
14366 and @option{-mdynamic-no-pic} options.
14368 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
14369 to 32 bits, and
14370 generates code for the x86-64 architecture.
14372 @item -mno-red-zone
14373 @opindex mno-red-zone
14374 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
14375 by the x86-64 ABI; it is a 128-byte area beyond the location of the
14376 stack pointer that is not modified by signal or interrupt handlers
14377 and therefore can be used for temporary data without adjusting the stack
14378 pointer.  The flag @option{-mno-red-zone} disables this red zone.
14380 @item -mcmodel=small
14381 @opindex mcmodel=small
14382 Generate code for the small code model: the program and its symbols must
14383 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
14384 Programs can be statically or dynamically linked.  This is the default
14385 code model.
14387 @item -mcmodel=kernel
14388 @opindex mcmodel=kernel
14389 Generate code for the kernel code model.  The kernel runs in the
14390 negative 2 GB of the address space.
14391 This model has to be used for Linux kernel code.
14393 @item -mcmodel=medium
14394 @opindex mcmodel=medium
14395 Generate code for the medium model: the program is linked in the lower 2
14396 GB of the address space.  Small symbols are also placed there.  Symbols
14397 with sizes larger than @option{-mlarge-data-threshold} are put into
14398 large data or BSS sections and can be located above 2GB.  Programs can
14399 be statically or dynamically linked.
14401 @item -mcmodel=large
14402 @opindex mcmodel=large
14403 Generate code for the large model.  This model makes no assumptions
14404 about addresses and sizes of sections.
14406 @item -maddress-mode=long
14407 @opindex maddress-mode=long
14408 Generate code for long address mode.  This is only supported for 64-bit
14409 and x32 environments.  It is the default address mode for 64-bit
14410 environments.
14412 @item -maddress-mode=short
14413 @opindex maddress-mode=short
14414 Generate code for short address mode.  This is only supported for 32-bit
14415 and x32 environments.  It is the default address mode for 32-bit and
14416 x32 environments.
14417 @end table
14419 @node i386 and x86-64 Windows Options
14420 @subsection i386 and x86-64 Windows Options
14421 @cindex i386 and x86-64 Windows Options
14423 These additional options are available for Microsoft Windows targets:
14425 @table @gcctabopt
14426 @item -mconsole
14427 @opindex mconsole
14428 This option
14429 specifies that a console application is to be generated, by
14430 instructing the linker to set the PE header subsystem type
14431 required for console applications.
14432 This option is available for Cygwin and MinGW targets and is
14433 enabled by default on those targets.
14435 @item -mdll
14436 @opindex mdll
14437 This option is available for Cygwin and MinGW targets.  It
14438 specifies that a DLL---a dynamic link library---is to be
14439 generated, enabling the selection of the required runtime
14440 startup object and entry point.
14442 @item -mnop-fun-dllimport
14443 @opindex mnop-fun-dllimport
14444 This option is available for Cygwin and MinGW targets.  It
14445 specifies that the @code{dllimport} attribute should be ignored.
14447 @item -mthread
14448 @opindex mthread
14449 This option is available for MinGW targets. It specifies
14450 that MinGW-specific thread support is to be used.
14452 @item -municode
14453 @opindex municode
14454 This option is available for MinGW-w64 targets.  It causes
14455 the @code{UNICODE} preprocessor macro to be predefined, and
14456 chooses Unicode-capable runtime startup code.
14458 @item -mwin32
14459 @opindex mwin32
14460 This option is available for Cygwin and MinGW targets.  It
14461 specifies that the typical Microsoft Windows predefined macros are to
14462 be set in the pre-processor, but does not influence the choice
14463 of runtime library/startup code.
14465 @item -mwindows
14466 @opindex mwindows
14467 This option is available for Cygwin and MinGW targets.  It
14468 specifies that a GUI application is to be generated by
14469 instructing the linker to set the PE header subsystem type
14470 appropriately.
14472 @item -fno-set-stack-executable
14473 @opindex fno-set-stack-executable
14474 This option is available for MinGW targets. It specifies that
14475 the executable flag for the stack used by nested functions isn't
14476 set. This is necessary for binaries running in kernel mode of
14477 Microsoft Windows, as there the User32 API, which is used to set executable
14478 privileges, isn't available.
14480 @item -fwritable-relocated-rdata
14481 @opindex fno-writable-relocated-rdata
14482 This option is available for MinGW and Cygwin targets.  It specifies
14483 that relocated-data in read-only section is put into .data
14484 section.  This is a necessary for older runtimes not supporting
14485 modification of .rdata sections for pseudo-relocation.
14487 @item -mpe-aligned-commons
14488 @opindex mpe-aligned-commons
14489 This option is available for Cygwin and MinGW targets.  It
14490 specifies that the GNU extension to the PE file format that
14491 permits the correct alignment of COMMON variables should be
14492 used when generating code.  It is enabled by default if
14493 GCC detects that the target assembler found during configuration
14494 supports the feature.
14495 @end table
14497 See also under @ref{i386 and x86-64 Options} for standard options.
14499 @node IA-64 Options
14500 @subsection IA-64 Options
14501 @cindex IA-64 Options
14503 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14505 @table @gcctabopt
14506 @item -mbig-endian
14507 @opindex mbig-endian
14508 Generate code for a big-endian target.  This is the default for HP-UX@.
14510 @item -mlittle-endian
14511 @opindex mlittle-endian
14512 Generate code for a little-endian target.  This is the default for AIX5
14513 and GNU/Linux.
14515 @item -mgnu-as
14516 @itemx -mno-gnu-as
14517 @opindex mgnu-as
14518 @opindex mno-gnu-as
14519 Generate (or don't) code for the GNU assembler.  This is the default.
14520 @c Also, this is the default if the configure option @option{--with-gnu-as}
14521 @c is used.
14523 @item -mgnu-ld
14524 @itemx -mno-gnu-ld
14525 @opindex mgnu-ld
14526 @opindex mno-gnu-ld
14527 Generate (or don't) code for the GNU linker.  This is the default.
14528 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14529 @c is used.
14531 @item -mno-pic
14532 @opindex mno-pic
14533 Generate code that does not use a global pointer register.  The result
14534 is not position independent code, and violates the IA-64 ABI@.
14536 @item -mvolatile-asm-stop
14537 @itemx -mno-volatile-asm-stop
14538 @opindex mvolatile-asm-stop
14539 @opindex mno-volatile-asm-stop
14540 Generate (or don't) a stop bit immediately before and after volatile asm
14541 statements.
14543 @item -mregister-names
14544 @itemx -mno-register-names
14545 @opindex mregister-names
14546 @opindex mno-register-names
14547 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14548 the stacked registers.  This may make assembler output more readable.
14550 @item -mno-sdata
14551 @itemx -msdata
14552 @opindex mno-sdata
14553 @opindex msdata
14554 Disable (or enable) optimizations that use the small data section.  This may
14555 be useful for working around optimizer bugs.
14557 @item -mconstant-gp
14558 @opindex mconstant-gp
14559 Generate code that uses a single constant global pointer value.  This is
14560 useful when compiling kernel code.
14562 @item -mauto-pic
14563 @opindex mauto-pic
14564 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
14565 This is useful when compiling firmware code.
14567 @item -minline-float-divide-min-latency
14568 @opindex minline-float-divide-min-latency
14569 Generate code for inline divides of floating-point values
14570 using the minimum latency algorithm.
14572 @item -minline-float-divide-max-throughput
14573 @opindex minline-float-divide-max-throughput
14574 Generate code for inline divides of floating-point values
14575 using the maximum throughput algorithm.
14577 @item -mno-inline-float-divide
14578 @opindex mno-inline-float-divide
14579 Do not generate inline code for divides of floating-point values.
14581 @item -minline-int-divide-min-latency
14582 @opindex minline-int-divide-min-latency
14583 Generate code for inline divides of integer values
14584 using the minimum latency algorithm.
14586 @item -minline-int-divide-max-throughput
14587 @opindex minline-int-divide-max-throughput
14588 Generate code for inline divides of integer values
14589 using the maximum throughput algorithm.
14591 @item -mno-inline-int-divide
14592 @opindex mno-inline-int-divide
14593 Do not generate inline code for divides of integer values.
14595 @item -minline-sqrt-min-latency
14596 @opindex minline-sqrt-min-latency
14597 Generate code for inline square roots
14598 using the minimum latency algorithm.
14600 @item -minline-sqrt-max-throughput
14601 @opindex minline-sqrt-max-throughput
14602 Generate code for inline square roots
14603 using the maximum throughput algorithm.
14605 @item -mno-inline-sqrt
14606 @opindex mno-inline-sqrt
14607 Do not generate inline code for @code{sqrt}.
14609 @item -mfused-madd
14610 @itemx -mno-fused-madd
14611 @opindex mfused-madd
14612 @opindex mno-fused-madd
14613 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14614 instructions.  The default is to use these instructions.
14616 @item -mno-dwarf2-asm
14617 @itemx -mdwarf2-asm
14618 @opindex mno-dwarf2-asm
14619 @opindex mdwarf2-asm
14620 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14621 info.  This may be useful when not using the GNU assembler.
14623 @item -mearly-stop-bits
14624 @itemx -mno-early-stop-bits
14625 @opindex mearly-stop-bits
14626 @opindex mno-early-stop-bits
14627 Allow stop bits to be placed earlier than immediately preceding the
14628 instruction that triggered the stop bit.  This can improve instruction
14629 scheduling, but does not always do so.
14631 @item -mfixed-range=@var{register-range}
14632 @opindex mfixed-range
14633 Generate code treating the given register range as fixed registers.
14634 A fixed register is one that the register allocator cannot use.  This is
14635 useful when compiling kernel code.  A register range is specified as
14636 two registers separated by a dash.  Multiple register ranges can be
14637 specified separated by a comma.
14639 @item -mtls-size=@var{tls-size}
14640 @opindex mtls-size
14641 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
14644 @item -mtune=@var{cpu-type}
14645 @opindex mtune
14646 Tune the instruction scheduling for a particular CPU, Valid values are
14647 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
14648 and @samp{mckinley}.
14650 @item -milp32
14651 @itemx -mlp64
14652 @opindex milp32
14653 @opindex mlp64
14654 Generate code for a 32-bit or 64-bit environment.
14655 The 32-bit environment sets int, long and pointer to 32 bits.
14656 The 64-bit environment sets int to 32 bits and long and pointer
14657 to 64 bits.  These are HP-UX specific flags.
14659 @item -mno-sched-br-data-spec
14660 @itemx -msched-br-data-spec
14661 @opindex mno-sched-br-data-spec
14662 @opindex msched-br-data-spec
14663 (Dis/En)able data speculative scheduling before reload.
14664 This results in generation of @code{ld.a} instructions and
14665 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14666 The default is 'disable'.
14668 @item -msched-ar-data-spec
14669 @itemx -mno-sched-ar-data-spec
14670 @opindex msched-ar-data-spec
14671 @opindex mno-sched-ar-data-spec
14672 (En/Dis)able data speculative scheduling after reload.
14673 This results in generation of @code{ld.a} instructions and
14674 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14675 The default is 'enable'.
14677 @item -mno-sched-control-spec
14678 @itemx -msched-control-spec
14679 @opindex mno-sched-control-spec
14680 @opindex msched-control-spec
14681 (Dis/En)able control speculative scheduling.  This feature is
14682 available only during region scheduling (i.e.@: before reload).
14683 This results in generation of the @code{ld.s} instructions and
14684 the corresponding check instructions @code{chk.s}.
14685 The default is 'disable'.
14687 @item -msched-br-in-data-spec
14688 @itemx -mno-sched-br-in-data-spec
14689 @opindex msched-br-in-data-spec
14690 @opindex mno-sched-br-in-data-spec
14691 (En/Dis)able speculative scheduling of the instructions that
14692 are dependent on the data speculative loads before reload.
14693 This is effective only with @option{-msched-br-data-spec} enabled.
14694 The default is 'enable'.
14696 @item -msched-ar-in-data-spec
14697 @itemx -mno-sched-ar-in-data-spec
14698 @opindex msched-ar-in-data-spec
14699 @opindex mno-sched-ar-in-data-spec
14700 (En/Dis)able speculative scheduling of the instructions that
14701 are dependent on the data speculative loads after reload.
14702 This is effective only with @option{-msched-ar-data-spec} enabled.
14703 The default is 'enable'.
14705 @item -msched-in-control-spec
14706 @itemx -mno-sched-in-control-spec
14707 @opindex msched-in-control-spec
14708 @opindex mno-sched-in-control-spec
14709 (En/Dis)able speculative scheduling of the instructions that
14710 are dependent on the control speculative loads.
14711 This is effective only with @option{-msched-control-spec} enabled.
14712 The default is 'enable'.
14714 @item -mno-sched-prefer-non-data-spec-insns
14715 @itemx -msched-prefer-non-data-spec-insns
14716 @opindex mno-sched-prefer-non-data-spec-insns
14717 @opindex msched-prefer-non-data-spec-insns
14718 If enabled, data-speculative instructions are chosen for schedule
14719 only if there are no other choices at the moment.  This makes
14720 the use of the data speculation much more conservative.
14721 The default is 'disable'.
14723 @item -mno-sched-prefer-non-control-spec-insns
14724 @itemx -msched-prefer-non-control-spec-insns
14725 @opindex mno-sched-prefer-non-control-spec-insns
14726 @opindex msched-prefer-non-control-spec-insns
14727 If enabled, control-speculative instructions are chosen for schedule
14728 only if there are no other choices at the moment.  This makes
14729 the use of the control speculation much more conservative.
14730 The default is 'disable'.
14732 @item -mno-sched-count-spec-in-critical-path
14733 @itemx -msched-count-spec-in-critical-path
14734 @opindex mno-sched-count-spec-in-critical-path
14735 @opindex msched-count-spec-in-critical-path
14736 If enabled, speculative dependencies are considered during
14737 computation of the instructions priorities.  This makes the use of the
14738 speculation a bit more conservative.
14739 The default is 'disable'.
14741 @item -msched-spec-ldc
14742 @opindex msched-spec-ldc
14743 Use a simple data speculation check.  This option is on by default.
14745 @item -msched-control-spec-ldc
14746 @opindex msched-spec-ldc
14747 Use a simple check for control speculation.  This option is on by default.
14749 @item -msched-stop-bits-after-every-cycle
14750 @opindex msched-stop-bits-after-every-cycle
14751 Place a stop bit after every cycle when scheduling.  This option is on
14752 by default.
14754 @item -msched-fp-mem-deps-zero-cost
14755 @opindex msched-fp-mem-deps-zero-cost
14756 Assume that floating-point stores and loads are not likely to cause a conflict
14757 when placed into the same instruction group.  This option is disabled by
14758 default.
14760 @item -msel-sched-dont-check-control-spec
14761 @opindex msel-sched-dont-check-control-spec
14762 Generate checks for control speculation in selective scheduling.
14763 This flag is disabled by default.
14765 @item -msched-max-memory-insns=@var{max-insns}
14766 @opindex msched-max-memory-insns
14767 Limit on the number of memory insns per instruction group, giving lower
14768 priority to subsequent memory insns attempting to schedule in the same
14769 instruction group. Frequently useful to prevent cache bank conflicts.
14770 The default value is 1.
14772 @item -msched-max-memory-insns-hard-limit
14773 @opindex msched-max-memory-insns-hard-limit
14774 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
14775 disallowing more than that number in an instruction group.
14776 Otherwise, the limit is ``soft'', meaning that non-memory operations
14777 are preferred when the limit is reached, but memory operations may still
14778 be scheduled.
14780 @end table
14782 @node LM32 Options
14783 @subsection LM32 Options
14784 @cindex LM32 options
14786 These @option{-m} options are defined for the LatticeMico32 architecture:
14788 @table @gcctabopt
14789 @item -mbarrel-shift-enabled
14790 @opindex mbarrel-shift-enabled
14791 Enable barrel-shift instructions.
14793 @item -mdivide-enabled
14794 @opindex mdivide-enabled
14795 Enable divide and modulus instructions.
14797 @item -mmultiply-enabled
14798 @opindex multiply-enabled
14799 Enable multiply instructions.
14801 @item -msign-extend-enabled
14802 @opindex msign-extend-enabled
14803 Enable sign extend instructions.
14805 @item -muser-enabled
14806 @opindex muser-enabled
14807 Enable user-defined instructions.
14809 @end table
14811 @node M32C Options
14812 @subsection M32C Options
14813 @cindex M32C options
14815 @table @gcctabopt
14816 @item -mcpu=@var{name}
14817 @opindex mcpu=
14818 Select the CPU for which code is generated.  @var{name} may be one of
14819 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
14820 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
14821 the M32C/80 series.
14823 @item -msim
14824 @opindex msim
14825 Specifies that the program will be run on the simulator.  This causes
14826 an alternate runtime library to be linked in which supports, for
14827 example, file I/O@.  You must not use this option when generating
14828 programs that will run on real hardware; you must provide your own
14829 runtime library for whatever I/O functions are needed.
14831 @item -memregs=@var{number}
14832 @opindex memregs=
14833 Specifies the number of memory-based pseudo-registers GCC uses
14834 during code generation.  These pseudo-registers are used like real
14835 registers, so there is a tradeoff between GCC's ability to fit the
14836 code into available registers, and the performance penalty of using
14837 memory instead of registers.  Note that all modules in a program must
14838 be compiled with the same value for this option.  Because of that, you
14839 must not use this option with GCC's default runtime libraries.
14841 @end table
14843 @node M32R/D Options
14844 @subsection M32R/D Options
14845 @cindex M32R/D options
14847 These @option{-m} options are defined for Renesas M32R/D architectures:
14849 @table @gcctabopt
14850 @item -m32r2
14851 @opindex m32r2
14852 Generate code for the M32R/2@.
14854 @item -m32rx
14855 @opindex m32rx
14856 Generate code for the M32R/X@.
14858 @item -m32r
14859 @opindex m32r
14860 Generate code for the M32R@.  This is the default.
14862 @item -mmodel=small
14863 @opindex mmodel=small
14864 Assume all objects live in the lower 16MB of memory (so that their addresses
14865 can be loaded with the @code{ld24} instruction), and assume all subroutines
14866 are reachable with the @code{bl} instruction.
14867 This is the default.
14869 The addressability of a particular object can be set with the
14870 @code{model} attribute.
14872 @item -mmodel=medium
14873 @opindex mmodel=medium
14874 Assume objects may be anywhere in the 32-bit address space (the compiler
14875 generates @code{seth/add3} instructions to load their addresses), and
14876 assume all subroutines are reachable with the @code{bl} instruction.
14878 @item -mmodel=large
14879 @opindex mmodel=large
14880 Assume objects may be anywhere in the 32-bit address space (the compiler
14881 generates @code{seth/add3} instructions to load their addresses), and
14882 assume subroutines may not be reachable with the @code{bl} instruction
14883 (the compiler generates the much slower @code{seth/add3/jl}
14884 instruction sequence).
14886 @item -msdata=none
14887 @opindex msdata=none
14888 Disable use of the small data area.  Variables are put into
14889 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
14890 @code{section} attribute has been specified).
14891 This is the default.
14893 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
14894 Objects may be explicitly put in the small data area with the
14895 @code{section} attribute using one of these sections.
14897 @item -msdata=sdata
14898 @opindex msdata=sdata
14899 Put small global and static data in the small data area, but do not
14900 generate special code to reference them.
14902 @item -msdata=use
14903 @opindex msdata=use
14904 Put small global and static data in the small data area, and generate
14905 special instructions to reference them.
14907 @item -G @var{num}
14908 @opindex G
14909 @cindex smaller data references
14910 Put global and static objects less than or equal to @var{num} bytes
14911 into the small data or BSS sections instead of the normal data or BSS
14912 sections.  The default value of @var{num} is 8.
14913 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
14914 for this option to have any effect.
14916 All modules should be compiled with the same @option{-G @var{num}} value.
14917 Compiling with different values of @var{num} may or may not work; if it
14918 doesn't the linker gives an error message---incorrect code is not
14919 generated.
14921 @item -mdebug
14922 @opindex mdebug
14923 Makes the M32R-specific code in the compiler display some statistics
14924 that might help in debugging programs.
14926 @item -malign-loops
14927 @opindex malign-loops
14928 Align all loops to a 32-byte boundary.
14930 @item -mno-align-loops
14931 @opindex mno-align-loops
14932 Do not enforce a 32-byte alignment for loops.  This is the default.
14934 @item -missue-rate=@var{number}
14935 @opindex missue-rate=@var{number}
14936 Issue @var{number} instructions per cycle.  @var{number} can only be 1
14937 or 2.
14939 @item -mbranch-cost=@var{number}
14940 @opindex mbranch-cost=@var{number}
14941 @var{number} can only be 1 or 2.  If it is 1 then branches are
14942 preferred over conditional code, if it is 2, then the opposite applies.
14944 @item -mflush-trap=@var{number}
14945 @opindex mflush-trap=@var{number}
14946 Specifies the trap number to use to flush the cache.  The default is
14947 12.  Valid numbers are between 0 and 15 inclusive.
14949 @item -mno-flush-trap
14950 @opindex mno-flush-trap
14951 Specifies that the cache cannot be flushed by using a trap.
14953 @item -mflush-func=@var{name}
14954 @opindex mflush-func=@var{name}
14955 Specifies the name of the operating system function to call to flush
14956 the cache.  The default is @emph{_flush_cache}, but a function call
14957 is only used if a trap is not available.
14959 @item -mno-flush-func
14960 @opindex mno-flush-func
14961 Indicates that there is no OS function for flushing the cache.
14963 @end table
14965 @node M680x0 Options
14966 @subsection M680x0 Options
14967 @cindex M680x0 options
14969 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
14970 The default settings depend on which architecture was selected when
14971 the compiler was configured; the defaults for the most common choices
14972 are given below.
14974 @table @gcctabopt
14975 @item -march=@var{arch}
14976 @opindex march
14977 Generate code for a specific M680x0 or ColdFire instruction set
14978 architecture.  Permissible values of @var{arch} for M680x0
14979 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
14980 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
14981 architectures are selected according to Freescale's ISA classification
14982 and the permissible values are: @samp{isaa}, @samp{isaaplus},
14983 @samp{isab} and @samp{isac}.
14985 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
14986 code for a ColdFire target.  The @var{arch} in this macro is one of the
14987 @option{-march} arguments given above.
14989 When used together, @option{-march} and @option{-mtune} select code
14990 that runs on a family of similar processors but that is optimized
14991 for a particular microarchitecture.
14993 @item -mcpu=@var{cpu}
14994 @opindex mcpu
14995 Generate code for a specific M680x0 or ColdFire processor.
14996 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
14997 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
14998 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
14999 below, which also classifies the CPUs into families:
15001 @multitable @columnfractions 0.20 0.80
15002 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
15003 @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}
15004 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
15005 @item @samp{5206e} @tab @samp{5206e}
15006 @item @samp{5208} @tab @samp{5207} @samp{5208}
15007 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
15008 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
15009 @item @samp{5216} @tab @samp{5214} @samp{5216}
15010 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
15011 @item @samp{5225} @tab @samp{5224} @samp{5225}
15012 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
15013 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
15014 @item @samp{5249} @tab @samp{5249}
15015 @item @samp{5250} @tab @samp{5250}
15016 @item @samp{5271} @tab @samp{5270} @samp{5271}
15017 @item @samp{5272} @tab @samp{5272}
15018 @item @samp{5275} @tab @samp{5274} @samp{5275}
15019 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
15020 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
15021 @item @samp{5307} @tab @samp{5307}
15022 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
15023 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
15024 @item @samp{5407} @tab @samp{5407}
15025 @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}
15026 @end multitable
15028 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
15029 @var{arch} is compatible with @var{cpu}.  Other combinations of
15030 @option{-mcpu} and @option{-march} are rejected.
15032 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
15033 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
15034 where the value of @var{family} is given by the table above.
15036 @item -mtune=@var{tune}
15037 @opindex mtune
15038 Tune the code for a particular microarchitecture within the
15039 constraints set by @option{-march} and @option{-mcpu}.
15040 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
15041 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
15042 and @samp{cpu32}.  The ColdFire microarchitectures
15043 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
15045 You can also use @option{-mtune=68020-40} for code that needs
15046 to run relatively well on 68020, 68030 and 68040 targets.
15047 @option{-mtune=68020-60} is similar but includes 68060 targets
15048 as well.  These two options select the same tuning decisions as
15049 @option{-m68020-40} and @option{-m68020-60} respectively.
15051 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
15052 when tuning for 680x0 architecture @var{arch}.  It also defines
15053 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
15054 option is used.  If GCC is tuning for a range of architectures,
15055 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
15056 it defines the macros for every architecture in the range.
15058 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
15059 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
15060 of the arguments given above.
15062 @item -m68000
15063 @itemx -mc68000
15064 @opindex m68000
15065 @opindex mc68000
15066 Generate output for a 68000.  This is the default
15067 when the compiler is configured for 68000-based systems.
15068 It is equivalent to @option{-march=68000}.
15070 Use this option for microcontrollers with a 68000 or EC000 core,
15071 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
15073 @item -m68010
15074 @opindex m68010
15075 Generate output for a 68010.  This is the default
15076 when the compiler is configured for 68010-based systems.
15077 It is equivalent to @option{-march=68010}.
15079 @item -m68020
15080 @itemx -mc68020
15081 @opindex m68020
15082 @opindex mc68020
15083 Generate output for a 68020.  This is the default
15084 when the compiler is configured for 68020-based systems.
15085 It is equivalent to @option{-march=68020}.
15087 @item -m68030
15088 @opindex m68030
15089 Generate output for a 68030.  This is the default when the compiler is
15090 configured for 68030-based systems.  It is equivalent to
15091 @option{-march=68030}.
15093 @item -m68040
15094 @opindex m68040
15095 Generate output for a 68040.  This is the default when the compiler is
15096 configured for 68040-based systems.  It is equivalent to
15097 @option{-march=68040}.
15099 This option inhibits the use of 68881/68882 instructions that have to be
15100 emulated by software on the 68040.  Use this option if your 68040 does not
15101 have code to emulate those instructions.
15103 @item -m68060
15104 @opindex m68060
15105 Generate output for a 68060.  This is the default when the compiler is
15106 configured for 68060-based systems.  It is equivalent to
15107 @option{-march=68060}.
15109 This option inhibits the use of 68020 and 68881/68882 instructions that
15110 have to be emulated by software on the 68060.  Use this option if your 68060
15111 does not have code to emulate those instructions.
15113 @item -mcpu32
15114 @opindex mcpu32
15115 Generate output for a CPU32.  This is the default
15116 when the compiler is configured for CPU32-based systems.
15117 It is equivalent to @option{-march=cpu32}.
15119 Use this option for microcontrollers with a
15120 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
15121 68336, 68340, 68341, 68349 and 68360.
15123 @item -m5200
15124 @opindex m5200
15125 Generate output for a 520X ColdFire CPU@.  This is the default
15126 when the compiler is configured for 520X-based systems.
15127 It is equivalent to @option{-mcpu=5206}, and is now deprecated
15128 in favor of that option.
15130 Use this option for microcontroller with a 5200 core, including
15131 the MCF5202, MCF5203, MCF5204 and MCF5206.
15133 @item -m5206e
15134 @opindex m5206e
15135 Generate output for a 5206e ColdFire CPU@.  The option is now
15136 deprecated in favor of the equivalent @option{-mcpu=5206e}.
15138 @item -m528x
15139 @opindex m528x
15140 Generate output for a member of the ColdFire 528X family.
15141 The option is now deprecated in favor of the equivalent
15142 @option{-mcpu=528x}.
15144 @item -m5307
15145 @opindex m5307
15146 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
15147 in favor of the equivalent @option{-mcpu=5307}.
15149 @item -m5407
15150 @opindex m5407
15151 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
15152 in favor of the equivalent @option{-mcpu=5407}.
15154 @item -mcfv4e
15155 @opindex mcfv4e
15156 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
15157 This includes use of hardware floating-point instructions.
15158 The option is equivalent to @option{-mcpu=547x}, and is now
15159 deprecated in favor of that option.
15161 @item -m68020-40
15162 @opindex m68020-40
15163 Generate output for a 68040, without using any of the new instructions.
15164 This results in code that can run relatively efficiently on either a
15165 68020/68881 or a 68030 or a 68040.  The generated code does use the
15166 68881 instructions that are emulated on the 68040.
15168 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
15170 @item -m68020-60
15171 @opindex m68020-60
15172 Generate output for a 68060, without using any of the new instructions.
15173 This results in code that can run relatively efficiently on either a
15174 68020/68881 or a 68030 or a 68040.  The generated code does use the
15175 68881 instructions that are emulated on the 68060.
15177 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
15179 @item -mhard-float
15180 @itemx -m68881
15181 @opindex mhard-float
15182 @opindex m68881
15183 Generate floating-point instructions.  This is the default for 68020
15184 and above, and for ColdFire devices that have an FPU@.  It defines the
15185 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
15186 on ColdFire targets.
15188 @item -msoft-float
15189 @opindex msoft-float
15190 Do not generate floating-point instructions; use library calls instead.
15191 This is the default for 68000, 68010, and 68832 targets.  It is also
15192 the default for ColdFire devices that have no FPU.
15194 @item -mdiv
15195 @itemx -mno-div
15196 @opindex mdiv
15197 @opindex mno-div
15198 Generate (do not generate) ColdFire hardware divide and remainder
15199 instructions.  If @option{-march} is used without @option{-mcpu},
15200 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
15201 architectures.  Otherwise, the default is taken from the target CPU
15202 (either the default CPU, or the one specified by @option{-mcpu}).  For
15203 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
15204 @option{-mcpu=5206e}.
15206 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
15208 @item -mshort
15209 @opindex mshort
15210 Consider type @code{int} to be 16 bits wide, like @code{short int}.
15211 Additionally, parameters passed on the stack are also aligned to a
15212 16-bit boundary even on targets whose API mandates promotion to 32-bit.
15214 @item -mno-short
15215 @opindex mno-short
15216 Do not consider type @code{int} to be 16 bits wide.  This is the default.
15218 @item -mnobitfield
15219 @itemx -mno-bitfield
15220 @opindex mnobitfield
15221 @opindex mno-bitfield
15222 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
15223 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
15225 @item -mbitfield
15226 @opindex mbitfield
15227 Do use the bit-field instructions.  The @option{-m68020} option implies
15228 @option{-mbitfield}.  This is the default if you use a configuration
15229 designed for a 68020.
15231 @item -mrtd
15232 @opindex mrtd
15233 Use a different function-calling convention, in which functions
15234 that take a fixed number of arguments return with the @code{rtd}
15235 instruction, which pops their arguments while returning.  This
15236 saves one instruction in the caller since there is no need to pop
15237 the arguments there.
15239 This calling convention is incompatible with the one normally
15240 used on Unix, so you cannot use it if you need to call libraries
15241 compiled with the Unix compiler.
15243 Also, you must provide function prototypes for all functions that
15244 take variable numbers of arguments (including @code{printf});
15245 otherwise incorrect code is generated for calls to those
15246 functions.
15248 In addition, seriously incorrect code results if you call a
15249 function with too many arguments.  (Normally, extra arguments are
15250 harmlessly ignored.)
15252 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
15253 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
15255 @item -mno-rtd
15256 @opindex mno-rtd
15257 Do not use the calling conventions selected by @option{-mrtd}.
15258 This is the default.
15260 @item -malign-int
15261 @itemx -mno-align-int
15262 @opindex malign-int
15263 @opindex mno-align-int
15264 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
15265 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
15266 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
15267 Aligning variables on 32-bit boundaries produces code that runs somewhat
15268 faster on processors with 32-bit busses at the expense of more memory.
15270 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
15271 aligns structures containing the above types differently than
15272 most published application binary interface specifications for the m68k.
15274 @item -mpcrel
15275 @opindex mpcrel
15276 Use the pc-relative addressing mode of the 68000 directly, instead of
15277 using a global offset table.  At present, this option implies @option{-fpic},
15278 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
15279 not presently supported with @option{-mpcrel}, though this could be supported for
15280 68020 and higher processors.
15282 @item -mno-strict-align
15283 @itemx -mstrict-align
15284 @opindex mno-strict-align
15285 @opindex mstrict-align
15286 Do not (do) assume that unaligned memory references are handled by
15287 the system.
15289 @item -msep-data
15290 Generate code that allows the data segment to be located in a different
15291 area of memory from the text segment.  This allows for execute-in-place in
15292 an environment without virtual memory management.  This option implies
15293 @option{-fPIC}.
15295 @item -mno-sep-data
15296 Generate code that assumes that the data segment follows the text segment.
15297 This is the default.
15299 @item -mid-shared-library
15300 Generate code that supports shared libraries via the library ID method.
15301 This allows for execute-in-place and shared libraries in an environment
15302 without virtual memory management.  This option implies @option{-fPIC}.
15304 @item -mno-id-shared-library
15305 Generate code that doesn't assume ID-based shared libraries are being used.
15306 This is the default.
15308 @item -mshared-library-id=n
15309 Specifies the identification number of the ID-based shared library being
15310 compiled.  Specifying a value of 0 generates more compact code; specifying
15311 other values forces the allocation of that number to the current
15312 library, but is no more space- or time-efficient than omitting this option.
15314 @item -mxgot
15315 @itemx -mno-xgot
15316 @opindex mxgot
15317 @opindex mno-xgot
15318 When generating position-independent code for ColdFire, generate code
15319 that works if the GOT has more than 8192 entries.  This code is
15320 larger and slower than code generated without this option.  On M680x0
15321 processors, this option is not needed; @option{-fPIC} suffices.
15323 GCC normally uses a single instruction to load values from the GOT@.
15324 While this is relatively efficient, it only works if the GOT
15325 is smaller than about 64k.  Anything larger causes the linker
15326 to report an error such as:
15328 @cindex relocation truncated to fit (ColdFire)
15329 @smallexample
15330 relocation truncated to fit: R_68K_GOT16O foobar
15331 @end smallexample
15333 If this happens, you should recompile your code with @option{-mxgot}.
15334 It should then work with very large GOTs.  However, code generated with
15335 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
15336 the value of a global symbol.
15338 Note that some linkers, including newer versions of the GNU linker,
15339 can create multiple GOTs and sort GOT entries.  If you have such a linker,
15340 you should only need to use @option{-mxgot} when compiling a single
15341 object file that accesses more than 8192 GOT entries.  Very few do.
15343 These options have no effect unless GCC is generating
15344 position-independent code.
15346 @end table
15348 @node MCore Options
15349 @subsection MCore Options
15350 @cindex MCore options
15352 These are the @samp{-m} options defined for the Motorola M*Core
15353 processors.
15355 @table @gcctabopt
15357 @item -mhardlit
15358 @itemx -mno-hardlit
15359 @opindex mhardlit
15360 @opindex mno-hardlit
15361 Inline constants into the code stream if it can be done in two
15362 instructions or less.
15364 @item -mdiv
15365 @itemx -mno-div
15366 @opindex mdiv
15367 @opindex mno-div
15368 Use the divide instruction.  (Enabled by default).
15370 @item -mrelax-immediate
15371 @itemx -mno-relax-immediate
15372 @opindex mrelax-immediate
15373 @opindex mno-relax-immediate
15374 Allow arbitrary-sized immediates in bit operations.
15376 @item -mwide-bitfields
15377 @itemx -mno-wide-bitfields
15378 @opindex mwide-bitfields
15379 @opindex mno-wide-bitfields
15380 Always treat bit-fields as @code{int}-sized.
15382 @item -m4byte-functions
15383 @itemx -mno-4byte-functions
15384 @opindex m4byte-functions
15385 @opindex mno-4byte-functions
15386 Force all functions to be aligned to a 4-byte boundary.
15388 @item -mcallgraph-data
15389 @itemx -mno-callgraph-data
15390 @opindex mcallgraph-data
15391 @opindex mno-callgraph-data
15392 Emit callgraph information.
15394 @item -mslow-bytes
15395 @itemx -mno-slow-bytes
15396 @opindex mslow-bytes
15397 @opindex mno-slow-bytes
15398 Prefer word access when reading byte quantities.
15400 @item -mlittle-endian
15401 @itemx -mbig-endian
15402 @opindex mlittle-endian
15403 @opindex mbig-endian
15404 Generate code for a little-endian target.
15406 @item -m210
15407 @itemx -m340
15408 @opindex m210
15409 @opindex m340
15410 Generate code for the 210 processor.
15412 @item -mno-lsim
15413 @opindex mno-lsim
15414 Assume that runtime support has been provided and so omit the
15415 simulator library (@file{libsim.a)} from the linker command line.
15417 @item -mstack-increment=@var{size}
15418 @opindex mstack-increment
15419 Set the maximum amount for a single stack increment operation.  Large
15420 values can increase the speed of programs that contain functions
15421 that need a large amount of stack space, but they can also trigger a
15422 segmentation fault if the stack is extended too much.  The default
15423 value is 0x1000.
15425 @end table
15427 @node MeP Options
15428 @subsection MeP Options
15429 @cindex MeP options
15431 @table @gcctabopt
15433 @item -mabsdiff
15434 @opindex mabsdiff
15435 Enables the @code{abs} instruction, which is the absolute difference
15436 between two registers.
15438 @item -mall-opts
15439 @opindex mall-opts
15440 Enables all the optional instructions---average, multiply, divide, bit
15441 operations, leading zero, absolute difference, min/max, clip, and
15442 saturation.
15445 @item -maverage
15446 @opindex maverage
15447 Enables the @code{ave} instruction, which computes the average of two
15448 registers.
15450 @item -mbased=@var{n}
15451 @opindex mbased=
15452 Variables of size @var{n} bytes or smaller are placed in the
15453 @code{.based} section by default.  Based variables use the @code{$tp}
15454 register as a base register, and there is a 128-byte limit to the
15455 @code{.based} section.
15457 @item -mbitops
15458 @opindex mbitops
15459 Enables the bit operation instructions---bit test (@code{btstm}), set
15460 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15461 test-and-set (@code{tas}).
15463 @item -mc=@var{name}
15464 @opindex mc=
15465 Selects which section constant data is placed in.  @var{name} may
15466 be @code{tiny}, @code{near}, or @code{far}.
15468 @item -mclip
15469 @opindex mclip
15470 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
15471 useful unless you also provide @code{-mminmax}.
15473 @item -mconfig=@var{name}
15474 @opindex mconfig=
15475 Selects one of the built-in core configurations.  Each MeP chip has
15476 one or more modules in it; each module has a core CPU and a variety of
15477 coprocessors, optional instructions, and peripherals.  The
15478 @code{MeP-Integrator} tool, not part of GCC, provides these
15479 configurations through this option; using this option is the same as
15480 using all the corresponding command-line options.  The default
15481 configuration is @code{default}.
15483 @item -mcop
15484 @opindex mcop
15485 Enables the coprocessor instructions.  By default, this is a 32-bit
15486 coprocessor.  Note that the coprocessor is normally enabled via the
15487 @code{-mconfig=} option.
15489 @item -mcop32
15490 @opindex mcop32
15491 Enables the 32-bit coprocessor's instructions.
15493 @item -mcop64
15494 @opindex mcop64
15495 Enables the 64-bit coprocessor's instructions.
15497 @item -mivc2
15498 @opindex mivc2
15499 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
15501 @item -mdc
15502 @opindex mdc
15503 Causes constant variables to be placed in the @code{.near} section.
15505 @item -mdiv
15506 @opindex mdiv
15507 Enables the @code{div} and @code{divu} instructions.
15509 @item -meb
15510 @opindex meb
15511 Generate big-endian code.
15513 @item -mel
15514 @opindex mel
15515 Generate little-endian code.
15517 @item -mio-volatile
15518 @opindex mio-volatile
15519 Tells the compiler that any variable marked with the @code{io}
15520 attribute is to be considered volatile.
15522 @item -ml
15523 @opindex ml
15524 Causes variables to be assigned to the @code{.far} section by default.
15526 @item -mleadz
15527 @opindex mleadz
15528 Enables the @code{leadz} (leading zero) instruction.
15530 @item -mm
15531 @opindex mm
15532 Causes variables to be assigned to the @code{.near} section by default.
15534 @item -mminmax
15535 @opindex mminmax
15536 Enables the @code{min} and @code{max} instructions.
15538 @item -mmult
15539 @opindex mmult
15540 Enables the multiplication and multiply-accumulate instructions.
15542 @item -mno-opts
15543 @opindex mno-opts
15544 Disables all the optional instructions enabled by @code{-mall-opts}.
15546 @item -mrepeat
15547 @opindex mrepeat
15548 Enables the @code{repeat} and @code{erepeat} instructions, used for
15549 low-overhead looping.
15551 @item -ms
15552 @opindex ms
15553 Causes all variables to default to the @code{.tiny} section.  Note
15554 that there is a 65536-byte limit to this section.  Accesses to these
15555 variables use the @code{%gp} base register.
15557 @item -msatur
15558 @opindex msatur
15559 Enables the saturation instructions.  Note that the compiler does not
15560 currently generate these itself, but this option is included for
15561 compatibility with other tools, like @code{as}.
15563 @item -msdram
15564 @opindex msdram
15565 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15567 @item -msim
15568 @opindex msim
15569 Link the simulator runtime libraries.
15571 @item -msimnovec
15572 @opindex msimnovec
15573 Link the simulator runtime libraries, excluding built-in support
15574 for reset and exception vectors and tables.
15576 @item -mtf
15577 @opindex mtf
15578 Causes all functions to default to the @code{.far} section.  Without
15579 this option, functions default to the @code{.near} section.
15581 @item -mtiny=@var{n}
15582 @opindex mtiny=
15583 Variables that are @var{n} bytes or smaller are allocated to the
15584 @code{.tiny} section.  These variables use the @code{$gp} base
15585 register.  The default for this option is 4, but note that there's a
15586 65536-byte limit to the @code{.tiny} section.
15588 @end table
15590 @node MicroBlaze Options
15591 @subsection MicroBlaze Options
15592 @cindex MicroBlaze Options
15594 @table @gcctabopt
15596 @item -msoft-float
15597 @opindex msoft-float
15598 Use software emulation for floating point (default).
15600 @item -mhard-float
15601 @opindex mhard-float
15602 Use hardware floating-point instructions.
15604 @item -mmemcpy
15605 @opindex mmemcpy
15606 Do not optimize block moves, use @code{memcpy}.
15608 @item -mno-clearbss
15609 @opindex mno-clearbss
15610 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
15612 @item -mcpu=@var{cpu-type}
15613 @opindex mcpu=
15614 Use features of, and schedule code for, the given CPU.
15615 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15616 where @var{X} is a major version, @var{YY} is the minor version, and
15617 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
15618 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15620 @item -mxl-soft-mul
15621 @opindex mxl-soft-mul
15622 Use software multiply emulation (default).
15624 @item -mxl-soft-div
15625 @opindex mxl-soft-div
15626 Use software emulation for divides (default).
15628 @item -mxl-barrel-shift
15629 @opindex mxl-barrel-shift
15630 Use the hardware barrel shifter.
15632 @item -mxl-pattern-compare
15633 @opindex mxl-pattern-compare
15634 Use pattern compare instructions.
15636 @item -msmall-divides
15637 @opindex msmall-divides
15638 Use table lookup optimization for small signed integer divisions.
15640 @item -mxl-stack-check
15641 @opindex mxl-stack-check
15642 This option is deprecated.  Use @option{-fstack-check} instead.
15644 @item -mxl-gp-opt
15645 @opindex mxl-gp-opt
15646 Use GP-relative @code{.sdata}/@code{.sbss} sections.
15648 @item -mxl-multiply-high
15649 @opindex mxl-multiply-high
15650 Use multiply high instructions for high part of 32x32 multiply.
15652 @item -mxl-float-convert
15653 @opindex mxl-float-convert
15654 Use hardware floating-point conversion instructions.
15656 @item -mxl-float-sqrt
15657 @opindex mxl-float-sqrt
15658 Use hardware floating-point square root instruction.
15660 @item -mxl-mode-@var{app-model}
15661 Select application model @var{app-model}.  Valid models are
15662 @table @samp
15663 @item executable
15664 normal executable (default), uses startup code @file{crt0.o}.
15666 @item xmdstub
15667 for use with Xilinx Microprocessor Debugger (XMD) based
15668 software intrusive debug agent called xmdstub. This uses startup file
15669 @file{crt1.o} and sets the start address of the program to 0x800.
15671 @item bootstrap
15672 for applications that are loaded using a bootloader.
15673 This model uses startup file @file{crt2.o} which does not contain a processor
15674 reset vector handler. This is suitable for transferring control on a
15675 processor reset to the bootloader rather than the application.
15677 @item novectors
15678 for applications that do not require any of the
15679 MicroBlaze vectors. This option may be useful for applications running
15680 within a monitoring application. This model uses @file{crt3.o} as a startup file.
15681 @end table
15683 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
15684 @option{-mxl-mode-@var{app-model}}.
15686 @end table
15688 @node MIPS Options
15689 @subsection MIPS Options
15690 @cindex MIPS options
15692 @table @gcctabopt
15694 @item -EB
15695 @opindex EB
15696 Generate big-endian code.
15698 @item -EL
15699 @opindex EL
15700 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
15701 configurations.
15703 @item -march=@var{arch}
15704 @opindex march
15705 Generate code that runs on @var{arch}, which can be the name of a
15706 generic MIPS ISA, or the name of a particular processor.
15707 The ISA names are:
15708 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
15709 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
15710 The processor names are:
15711 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
15712 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
15713 @samp{5kc}, @samp{5kf},
15714 @samp{20kc},
15715 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
15716 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
15717 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
15718 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
15719 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
15720 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
15721 @samp{m4k},
15722 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
15723 @samp{orion},
15724 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
15725 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
15726 @samp{rm7000}, @samp{rm9000},
15727 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
15728 @samp{sb1},
15729 @samp{sr71000},
15730 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
15731 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
15732 @samp{xlr} and @samp{xlp}.
15733 The special value @samp{from-abi} selects the
15734 most compatible architecture for the selected ABI (that is,
15735 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
15737 The native Linux/GNU toolchain also supports the value @samp{native},
15738 which selects the best architecture option for the host processor.
15739 @option{-march=native} has no effect if GCC does not recognize
15740 the processor.
15742 In processor names, a final @samp{000} can be abbreviated as @samp{k}
15743 (for example, @option{-march=r2k}).  Prefixes are optional, and
15744 @samp{vr} may be written @samp{r}.
15746 Names of the form @samp{@var{n}f2_1} refer to processors with
15747 FPUs clocked at half the rate of the core, names of the form
15748 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
15749 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
15750 processors with FPUs clocked a ratio of 3:2 with respect to the core.
15751 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
15752 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
15753 accepted as synonyms for @samp{@var{n}f1_1}.
15755 GCC defines two macros based on the value of this option.  The first
15756 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
15757 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
15758 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
15759 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
15760 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
15762 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
15763 above.  In other words, it has the full prefix and does not
15764 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
15765 the macro names the resolved architecture (either @samp{"mips1"} or
15766 @samp{"mips3"}).  It names the default architecture when no
15767 @option{-march} option is given.
15769 @item -mtune=@var{arch}
15770 @opindex mtune
15771 Optimize for @var{arch}.  Among other things, this option controls
15772 the way instructions are scheduled, and the perceived cost of arithmetic
15773 operations.  The list of @var{arch} values is the same as for
15774 @option{-march}.
15776 When this option is not used, GCC optimizes for the processor
15777 specified by @option{-march}.  By using @option{-march} and
15778 @option{-mtune} together, it is possible to generate code that
15779 runs on a family of processors, but optimize the code for one
15780 particular member of that family.
15782 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
15783 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
15784 @option{-march} ones described above.
15786 @item -mips1
15787 @opindex mips1
15788 Equivalent to @option{-march=mips1}.
15790 @item -mips2
15791 @opindex mips2
15792 Equivalent to @option{-march=mips2}.
15794 @item -mips3
15795 @opindex mips3
15796 Equivalent to @option{-march=mips3}.
15798 @item -mips4
15799 @opindex mips4
15800 Equivalent to @option{-march=mips4}.
15802 @item -mips32
15803 @opindex mips32
15804 Equivalent to @option{-march=mips32}.
15806 @item -mips32r2
15807 @opindex mips32r2
15808 Equivalent to @option{-march=mips32r2}.
15810 @item -mips64
15811 @opindex mips64
15812 Equivalent to @option{-march=mips64}.
15814 @item -mips64r2
15815 @opindex mips64r2
15816 Equivalent to @option{-march=mips64r2}.
15818 @item -mips16
15819 @itemx -mno-mips16
15820 @opindex mips16
15821 @opindex mno-mips16
15822 Generate (do not generate) MIPS16 code.  If GCC is targeting a
15823 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
15825 MIPS16 code generation can also be controlled on a per-function basis
15826 by means of @code{mips16} and @code{nomips16} attributes.
15827 @xref{Function Attributes}, for more information.
15829 @item -mflip-mips16
15830 @opindex mflip-mips16
15831 Generate MIPS16 code on alternating functions.  This option is provided
15832 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
15833 not intended for ordinary use in compiling user code.
15835 @item -minterlink-mips16
15836 @itemx -mno-interlink-mips16
15837 @opindex minterlink-mips16
15838 @opindex mno-interlink-mips16
15839 Require (do not require) that non-MIPS16 code be link-compatible with
15840 MIPS16 code.
15842 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
15843 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
15844 therefore disables direct jumps unless GCC knows that the target of the
15845 jump is not MIPS16.
15847 @item -mabi=32
15848 @itemx -mabi=o64
15849 @itemx -mabi=n32
15850 @itemx -mabi=64
15851 @itemx -mabi=eabi
15852 @opindex mabi=32
15853 @opindex mabi=o64
15854 @opindex mabi=n32
15855 @opindex mabi=64
15856 @opindex mabi=eabi
15857 Generate code for the given ABI@.
15859 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
15860 generates 64-bit code when you select a 64-bit architecture, but you
15861 can use @option{-mgp32} to get 32-bit code instead.
15863 For information about the O64 ABI, see
15864 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
15866 GCC supports a variant of the o32 ABI in which floating-point registers
15867 are 64 rather than 32 bits wide.  You can select this combination with
15868 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
15869 and @code{mfhc1} instructions and is therefore only supported for
15870 MIPS32R2 processors.
15872 The register assignments for arguments and return values remain the
15873 same, but each scalar value is passed in a single 64-bit register
15874 rather than a pair of 32-bit registers.  For example, scalar
15875 floating-point values are returned in @samp{$f0} only, not a
15876 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
15877 remains the same, but all 64 bits are saved.
15879 @item -mabicalls
15880 @itemx -mno-abicalls
15881 @opindex mabicalls
15882 @opindex mno-abicalls
15883 Generate (do not generate) code that is suitable for SVR4-style
15884 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
15885 systems.
15887 @item -mshared
15888 @itemx -mno-shared
15889 Generate (do not generate) code that is fully position-independent,
15890 and that can therefore be linked into shared libraries.  This option
15891 only affects @option{-mabicalls}.
15893 All @option{-mabicalls} code has traditionally been position-independent,
15894 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
15895 as an extension, the GNU toolchain allows executables to use absolute
15896 accesses for locally-binding symbols.  It can also use shorter GP
15897 initialization sequences and generate direct calls to locally-defined
15898 functions.  This mode is selected by @option{-mno-shared}.
15900 @option{-mno-shared} depends on binutils 2.16 or higher and generates
15901 objects that can only be linked by the GNU linker.  However, the option
15902 does not affect the ABI of the final executable; it only affects the ABI
15903 of relocatable objects.  Using @option{-mno-shared} generally makes
15904 executables both smaller and quicker.
15906 @option{-mshared} is the default.
15908 @item -mplt
15909 @itemx -mno-plt
15910 @opindex mplt
15911 @opindex mno-plt
15912 Assume (do not assume) that the static and dynamic linkers
15913 support PLTs and copy relocations.  This option only affects
15914 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
15915 has no effect without @option{-msym32}.
15917 You can make @option{-mplt} the default by configuring
15918 GCC with @option{--with-mips-plt}.  The default is
15919 @option{-mno-plt} otherwise.
15921 @item -mxgot
15922 @itemx -mno-xgot
15923 @opindex mxgot
15924 @opindex mno-xgot
15925 Lift (do not lift) the usual restrictions on the size of the global
15926 offset table.
15928 GCC normally uses a single instruction to load values from the GOT@.
15929 While this is relatively efficient, it only works if the GOT
15930 is smaller than about 64k.  Anything larger causes the linker
15931 to report an error such as:
15933 @cindex relocation truncated to fit (MIPS)
15934 @smallexample
15935 relocation truncated to fit: R_MIPS_GOT16 foobar
15936 @end smallexample
15938 If this happens, you should recompile your code with @option{-mxgot}.
15939 This works with very large GOTs, although the code is also
15940 less efficient, since it takes three instructions to fetch the
15941 value of a global symbol.
15943 Note that some linkers can create multiple GOTs.  If you have such a
15944 linker, you should only need to use @option{-mxgot} when a single object
15945 file accesses more than 64k's worth of GOT entries.  Very few do.
15947 These options have no effect unless GCC is generating position
15948 independent code.
15950 @item -mgp32
15951 @opindex mgp32
15952 Assume that general-purpose registers are 32 bits wide.
15954 @item -mgp64
15955 @opindex mgp64
15956 Assume that general-purpose registers are 64 bits wide.
15958 @item -mfp32
15959 @opindex mfp32
15960 Assume that floating-point registers are 32 bits wide.
15962 @item -mfp64
15963 @opindex mfp64
15964 Assume that floating-point registers are 64 bits wide.
15966 @item -mhard-float
15967 @opindex mhard-float
15968 Use floating-point coprocessor instructions.
15970 @item -msoft-float
15971 @opindex msoft-float
15972 Do not use floating-point coprocessor instructions.  Implement
15973 floating-point calculations using library calls instead.
15975 @item -mno-float
15976 @opindex mno-float
15977 Equivalent to @option{-msoft-float}, but additionally asserts that the
15978 program being compiled does not perform any floating-point operations.
15979 This option is presently supported only by some bare-metal MIPS
15980 configurations, where it may select a special set of libraries
15981 that lack all floating-point support (including, for example, the
15982 floating-point @code{printf} formats).  
15983 If code compiled with @code{-mno-float} accidentally contains
15984 floating-point operations, it is likely to suffer a link-time
15985 or run-time failure.
15987 @item -msingle-float
15988 @opindex msingle-float
15989 Assume that the floating-point coprocessor only supports single-precision
15990 operations.
15992 @item -mdouble-float
15993 @opindex mdouble-float
15994 Assume that the floating-point coprocessor supports double-precision
15995 operations.  This is the default.
15997 @item -mllsc
15998 @itemx -mno-llsc
15999 @opindex mllsc
16000 @opindex mno-llsc
16001 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
16002 implement atomic memory built-in functions.  When neither option is
16003 specified, GCC uses the instructions if the target architecture
16004 supports them.
16006 @option{-mllsc} is useful if the runtime environment can emulate the
16007 instructions and @option{-mno-llsc} can be useful when compiling for
16008 nonstandard ISAs.  You can make either option the default by
16009 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
16010 respectively.  @option{--with-llsc} is the default for some
16011 configurations; see the installation documentation for details.
16013 @item -mdsp
16014 @itemx -mno-dsp
16015 @opindex mdsp
16016 @opindex mno-dsp
16017 Use (do not use) revision 1 of the MIPS DSP ASE@.
16018 @xref{MIPS DSP Built-in Functions}.  This option defines the
16019 preprocessor macro @samp{__mips_dsp}.  It also defines
16020 @samp{__mips_dsp_rev} to 1.
16022 @item -mdspr2
16023 @itemx -mno-dspr2
16024 @opindex mdspr2
16025 @opindex mno-dspr2
16026 Use (do not use) revision 2 of the MIPS DSP ASE@.
16027 @xref{MIPS DSP Built-in Functions}.  This option defines the
16028 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
16029 It also defines @samp{__mips_dsp_rev} to 2.
16031 @item -msmartmips
16032 @itemx -mno-smartmips
16033 @opindex msmartmips
16034 @opindex mno-smartmips
16035 Use (do not use) the MIPS SmartMIPS ASE.
16037 @item -mpaired-single
16038 @itemx -mno-paired-single
16039 @opindex mpaired-single
16040 @opindex mno-paired-single
16041 Use (do not use) paired-single floating-point instructions.
16042 @xref{MIPS Paired-Single Support}.  This option requires
16043 hardware floating-point support to be enabled.
16045 @item -mdmx
16046 @itemx -mno-mdmx
16047 @opindex mdmx
16048 @opindex mno-mdmx
16049 Use (do not use) MIPS Digital Media Extension instructions.
16050 This option can only be used when generating 64-bit code and requires
16051 hardware floating-point support to be enabled.
16053 @item -mips3d
16054 @itemx -mno-mips3d
16055 @opindex mips3d
16056 @opindex mno-mips3d
16057 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
16058 The option @option{-mips3d} implies @option{-mpaired-single}.
16060 @item -mmt
16061 @itemx -mno-mt
16062 @opindex mmt
16063 @opindex mno-mt
16064 Use (do not use) MT Multithreading instructions.
16066 @item -mmcu
16067 @itemx -mno-mcu
16068 @opindex mmcu
16069 @opindex mno-mcu
16070 Use (do not use) the MIPS MCU ASE instructions.
16072 @item -mlong64
16073 @opindex mlong64
16074 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
16075 an explanation of the default and the way that the pointer size is
16076 determined.
16078 @item -mlong32
16079 @opindex mlong32
16080 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
16082 The default size of @code{int}s, @code{long}s and pointers depends on
16083 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
16084 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
16085 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
16086 or the same size as integer registers, whichever is smaller.
16088 @item -msym32
16089 @itemx -mno-sym32
16090 @opindex msym32
16091 @opindex mno-sym32
16092 Assume (do not assume) that all symbols have 32-bit values, regardless
16093 of the selected ABI@.  This option is useful in combination with
16094 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
16095 to generate shorter and faster references to symbolic addresses.
16097 @item -G @var{num}
16098 @opindex G
16099 Put definitions of externally-visible data in a small data section
16100 if that data is no bigger than @var{num} bytes.  GCC can then generate
16101 more efficient accesses to the data; see @option{-mgpopt} for details.
16103 The default @option{-G} option depends on the configuration.
16105 @item -mlocal-sdata
16106 @itemx -mno-local-sdata
16107 @opindex mlocal-sdata
16108 @opindex mno-local-sdata
16109 Extend (do not extend) the @option{-G} behavior to local data too,
16110 such as to static variables in C@.  @option{-mlocal-sdata} is the
16111 default for all configurations.
16113 If the linker complains that an application is using too much small data,
16114 you might want to try rebuilding the less performance-critical parts with
16115 @option{-mno-local-sdata}.  You might also want to build large
16116 libraries with @option{-mno-local-sdata}, so that the libraries leave
16117 more room for the main program.
16119 @item -mextern-sdata
16120 @itemx -mno-extern-sdata
16121 @opindex mextern-sdata
16122 @opindex mno-extern-sdata
16123 Assume (do not assume) that externally-defined data is in
16124 a small data section if the size of that data is within the @option{-G} limit.
16125 @option{-mextern-sdata} is the default for all configurations.
16127 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
16128 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
16129 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
16130 is placed in a small data section.  If @var{Var} is defined by another
16131 module, you must either compile that module with a high-enough
16132 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
16133 definition.  If @var{Var} is common, you must link the application
16134 with a high-enough @option{-G} setting.
16136 The easiest way of satisfying these restrictions is to compile
16137 and link every module with the same @option{-G} option.  However,
16138 you may wish to build a library that supports several different
16139 small data limits.  You can do this by compiling the library with
16140 the highest supported @option{-G} setting and additionally using
16141 @option{-mno-extern-sdata} to stop the library from making assumptions
16142 about externally-defined data.
16144 @item -mgpopt
16145 @itemx -mno-gpopt
16146 @opindex mgpopt
16147 @opindex mno-gpopt
16148 Use (do not use) GP-relative accesses for symbols that are known to be
16149 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
16150 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
16151 configurations.
16153 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
16154 might not hold the value of @code{_gp}.  For example, if the code is
16155 part of a library that might be used in a boot monitor, programs that
16156 call boot monitor routines pass an unknown value in @code{$gp}.
16157 (In such situations, the boot monitor itself is usually compiled
16158 with @option{-G0}.)
16160 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
16161 @option{-mno-extern-sdata}.
16163 @item -membedded-data
16164 @itemx -mno-embedded-data
16165 @opindex membedded-data
16166 @opindex mno-embedded-data
16167 Allocate variables to the read-only data section first if possible, then
16168 next in the small data section if possible, otherwise in data.  This gives
16169 slightly slower code than the default, but reduces the amount of RAM required
16170 when executing, and thus may be preferred for some embedded systems.
16172 @item -muninit-const-in-rodata
16173 @itemx -mno-uninit-const-in-rodata
16174 @opindex muninit-const-in-rodata
16175 @opindex mno-uninit-const-in-rodata
16176 Put uninitialized @code{const} variables in the read-only data section.
16177 This option is only meaningful in conjunction with @option{-membedded-data}.
16179 @item -mcode-readable=@var{setting}
16180 @opindex mcode-readable
16181 Specify whether GCC may generate code that reads from executable sections.
16182 There are three possible settings:
16184 @table @gcctabopt
16185 @item -mcode-readable=yes
16186 Instructions may freely access executable sections.  This is the
16187 default setting.
16189 @item -mcode-readable=pcrel
16190 MIPS16 PC-relative load instructions can access executable sections,
16191 but other instructions must not do so.  This option is useful on 4KSc
16192 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
16193 It is also useful on processors that can be configured to have a dual
16194 instruction/data SRAM interface and that, like the M4K, automatically
16195 redirect PC-relative loads to the instruction RAM.
16197 @item -mcode-readable=no
16198 Instructions must not access executable sections.  This option can be
16199 useful on targets that are configured to have a dual instruction/data
16200 SRAM interface but that (unlike the M4K) do not automatically redirect
16201 PC-relative loads to the instruction RAM.
16202 @end table
16204 @item -msplit-addresses
16205 @itemx -mno-split-addresses
16206 @opindex msplit-addresses
16207 @opindex mno-split-addresses
16208 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
16209 relocation operators.  This option has been superseded by
16210 @option{-mexplicit-relocs} but is retained for backwards compatibility.
16212 @item -mexplicit-relocs
16213 @itemx -mno-explicit-relocs
16214 @opindex mexplicit-relocs
16215 @opindex mno-explicit-relocs
16216 Use (do not use) assembler relocation operators when dealing with symbolic
16217 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
16218 is to use assembler macros instead.
16220 @option{-mexplicit-relocs} is the default if GCC was configured
16221 to use an assembler that supports relocation operators.
16223 @item -mcheck-zero-division
16224 @itemx -mno-check-zero-division
16225 @opindex mcheck-zero-division
16226 @opindex mno-check-zero-division
16227 Trap (do not trap) on integer division by zero.
16229 The default is @option{-mcheck-zero-division}.
16231 @item -mdivide-traps
16232 @itemx -mdivide-breaks
16233 @opindex mdivide-traps
16234 @opindex mdivide-breaks
16235 MIPS systems check for division by zero by generating either a
16236 conditional trap or a break instruction.  Using traps results in
16237 smaller code, but is only supported on MIPS II and later.  Also, some
16238 versions of the Linux kernel have a bug that prevents trap from
16239 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
16240 allow conditional traps on architectures that support them and
16241 @option{-mdivide-breaks} to force the use of breaks.
16243 The default is usually @option{-mdivide-traps}, but this can be
16244 overridden at configure time using @option{--with-divide=breaks}.
16245 Divide-by-zero checks can be completely disabled using
16246 @option{-mno-check-zero-division}.
16248 @item -mmemcpy
16249 @itemx -mno-memcpy
16250 @opindex mmemcpy
16251 @opindex mno-memcpy
16252 Force (do not force) the use of @code{memcpy()} for non-trivial block
16253 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
16254 most constant-sized copies.
16256 @item -mlong-calls
16257 @itemx -mno-long-calls
16258 @opindex mlong-calls
16259 @opindex mno-long-calls
16260 Disable (do not disable) use of the @code{jal} instruction.  Calling
16261 functions using @code{jal} is more efficient but requires the caller
16262 and callee to be in the same 256 megabyte segment.
16264 This option has no effect on abicalls code.  The default is
16265 @option{-mno-long-calls}.
16267 @item -mmad
16268 @itemx -mno-mad
16269 @opindex mmad
16270 @opindex mno-mad
16271 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
16272 instructions, as provided by the R4650 ISA@.
16274 @item -mfused-madd
16275 @itemx -mno-fused-madd
16276 @opindex mfused-madd
16277 @opindex mno-fused-madd
16278 Enable (disable) use of the floating-point multiply-accumulate
16279 instructions, when they are available.  The default is
16280 @option{-mfused-madd}.
16282 When multiply-accumulate instructions are used, the intermediate
16283 product is calculated to infinite precision and is not subject to
16284 the FCSR Flush to Zero bit.  This may be undesirable in some
16285 circumstances.
16287 @item -nocpp
16288 @opindex nocpp
16289 Tell the MIPS assembler to not run its preprocessor over user
16290 assembler files (with a @samp{.s} suffix) when assembling them.
16292 @item -mfix-24k
16293 @item -mno-fix-24k
16294 @opindex mfix-24k
16295 @opindex mno-fix-24k
16296 Work around the 24K E48 (lost data on stores during refill) errata.
16297 The workarounds are implemented by the assembler rather than by GCC@.
16299 @item -mfix-r4000
16300 @itemx -mno-fix-r4000
16301 @opindex mfix-r4000
16302 @opindex mno-fix-r4000
16303 Work around certain R4000 CPU errata:
16304 @itemize @minus
16305 @item
16306 A double-word or a variable shift may give an incorrect result if executed
16307 immediately after starting an integer division.
16308 @item
16309 A double-word or a variable shift may give an incorrect result if executed
16310 while an integer multiplication is in progress.
16311 @item
16312 An integer division may give an incorrect result if started in a delay slot
16313 of a taken branch or a jump.
16314 @end itemize
16316 @item -mfix-r4400
16317 @itemx -mno-fix-r4400
16318 @opindex mfix-r4400
16319 @opindex mno-fix-r4400
16320 Work around certain R4400 CPU errata:
16321 @itemize @minus
16322 @item
16323 A double-word or a variable shift may give an incorrect result if executed
16324 immediately after starting an integer division.
16325 @end itemize
16327 @item -mfix-r10000
16328 @itemx -mno-fix-r10000
16329 @opindex mfix-r10000
16330 @opindex mno-fix-r10000
16331 Work around certain R10000 errata:
16332 @itemize @minus
16333 @item
16334 @code{ll}/@code{sc} sequences may not behave atomically on revisions
16335 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
16336 @end itemize
16338 This option can only be used if the target architecture supports
16339 branch-likely instructions.  @option{-mfix-r10000} is the default when
16340 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
16341 otherwise.
16343 @item -mfix-vr4120
16344 @itemx -mno-fix-vr4120
16345 @opindex mfix-vr4120
16346 Work around certain VR4120 errata:
16347 @itemize @minus
16348 @item
16349 @code{dmultu} does not always produce the correct result.
16350 @item
16351 @code{div} and @code{ddiv} do not always produce the correct result if one
16352 of the operands is negative.
16353 @end itemize
16354 The workarounds for the division errata rely on special functions in
16355 @file{libgcc.a}.  At present, these functions are only provided by
16356 the @code{mips64vr*-elf} configurations.
16358 Other VR4120 errata require a NOP to be inserted between certain pairs of
16359 instructions.  These errata are handled by the assembler, not by GCC itself.
16361 @item -mfix-vr4130
16362 @opindex mfix-vr4130
16363 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
16364 workarounds are implemented by the assembler rather than by GCC,
16365 although GCC avoids using @code{mflo} and @code{mfhi} if the
16366 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
16367 instructions are available instead.
16369 @item -mfix-sb1
16370 @itemx -mno-fix-sb1
16371 @opindex mfix-sb1
16372 Work around certain SB-1 CPU core errata.
16373 (This flag currently works around the SB-1 revision 2
16374 ``F1'' and ``F2'' floating-point errata.)
16376 @item -mr10k-cache-barrier=@var{setting}
16377 @opindex mr10k-cache-barrier
16378 Specify whether GCC should insert cache barriers to avoid the
16379 side-effects of speculation on R10K processors.
16381 In common with many processors, the R10K tries to predict the outcome
16382 of a conditional branch and speculatively executes instructions from
16383 the ``taken'' branch.  It later aborts these instructions if the
16384 predicted outcome is wrong.  However, on the R10K, even aborted
16385 instructions can have side effects.
16387 This problem only affects kernel stores and, depending on the system,
16388 kernel loads.  As an example, a speculatively-executed store may load
16389 the target memory into cache and mark the cache line as dirty, even if
16390 the store itself is later aborted.  If a DMA operation writes to the
16391 same area of memory before the ``dirty'' line is flushed, the cached
16392 data overwrites the DMA-ed data.  See the R10K processor manual
16393 for a full description, including other potential problems.
16395 One workaround is to insert cache barrier instructions before every memory
16396 access that might be speculatively executed and that might have side
16397 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
16398 controls GCC's implementation of this workaround.  It assumes that
16399 aborted accesses to any byte in the following regions does not have
16400 side effects:
16402 @enumerate
16403 @item
16404 the memory occupied by the current function's stack frame;
16406 @item
16407 the memory occupied by an incoming stack argument;
16409 @item
16410 the memory occupied by an object with a link-time-constant address.
16411 @end enumerate
16413 It is the kernel's responsibility to ensure that speculative
16414 accesses to these regions are indeed safe.
16416 If the input program contains a function declaration such as:
16418 @smallexample
16419 void foo (void);
16420 @end smallexample
16422 then the implementation of @code{foo} must allow @code{j foo} and
16423 @code{jal foo} to be executed speculatively.  GCC honors this
16424 restriction for functions it compiles itself.  It expects non-GCC
16425 functions (such as hand-written assembly code) to do the same.
16427 The option has three forms:
16429 @table @gcctabopt
16430 @item -mr10k-cache-barrier=load-store
16431 Insert a cache barrier before a load or store that might be
16432 speculatively executed and that might have side effects even
16433 if aborted.
16435 @item -mr10k-cache-barrier=store
16436 Insert a cache barrier before a store that might be speculatively
16437 executed and that might have side effects even if aborted.
16439 @item -mr10k-cache-barrier=none
16440 Disable the insertion of cache barriers.  This is the default setting.
16441 @end table
16443 @item -mflush-func=@var{func}
16444 @itemx -mno-flush-func
16445 @opindex mflush-func
16446 Specifies the function to call to flush the I and D caches, or to not
16447 call any such function.  If called, the function must take the same
16448 arguments as the common @code{_flush_func()}, that is, the address of the
16449 memory range for which the cache is being flushed, the size of the
16450 memory range, and the number 3 (to flush both caches).  The default
16451 depends on the target GCC was configured for, but commonly is either
16452 @samp{_flush_func} or @samp{__cpu_flush}.
16454 @item mbranch-cost=@var{num}
16455 @opindex mbranch-cost
16456 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16457 This cost is only a heuristic and is not guaranteed to produce
16458 consistent results across releases.  A zero cost redundantly selects
16459 the default, which is based on the @option{-mtune} setting.
16461 @item -mbranch-likely
16462 @itemx -mno-branch-likely
16463 @opindex mbranch-likely
16464 @opindex mno-branch-likely
16465 Enable or disable use of Branch Likely instructions, regardless of the
16466 default for the selected architecture.  By default, Branch Likely
16467 instructions may be generated if they are supported by the selected
16468 architecture.  An exception is for the MIPS32 and MIPS64 architectures
16469 and processors that implement those architectures; for those, Branch
16470 Likely instructions are not be generated by default because the MIPS32
16471 and MIPS64 architectures specifically deprecate their use.
16473 @item -mfp-exceptions
16474 @itemx -mno-fp-exceptions
16475 @opindex mfp-exceptions
16476 Specifies whether FP exceptions are enabled.  This affects how
16477 FP instructions are scheduled for some processors.
16478 The default is that FP exceptions are
16479 enabled.
16481 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16482 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
16483 FP pipe.
16485 @item -mvr4130-align
16486 @itemx -mno-vr4130-align
16487 @opindex mvr4130-align
16488 The VR4130 pipeline is two-way superscalar, but can only issue two
16489 instructions together if the first one is 8-byte aligned.  When this
16490 option is enabled, GCC aligns pairs of instructions that it
16491 thinks should execute in parallel.
16493 This option only has an effect when optimizing for the VR4130.
16494 It normally makes code faster, but at the expense of making it bigger.
16495 It is enabled by default at optimization level @option{-O3}.
16497 @item -msynci
16498 @itemx -mno-synci
16499 @opindex msynci
16500 Enable (disable) generation of @code{synci} instructions on
16501 architectures that support it.  The @code{synci} instructions (if
16502 enabled) are generated when @code{__builtin___clear_cache()} is
16503 compiled.
16505 This option defaults to @code{-mno-synci}, but the default can be
16506 overridden by configuring with @code{--with-synci}.
16508 When compiling code for single processor systems, it is generally safe
16509 to use @code{synci}.  However, on many multi-core (SMP) systems, it
16510 does not invalidate the instruction caches on all cores and may lead
16511 to undefined behavior.
16513 @item -mrelax-pic-calls
16514 @itemx -mno-relax-pic-calls
16515 @opindex mrelax-pic-calls
16516 Try to turn PIC calls that are normally dispatched via register
16517 @code{$25} into direct calls.  This is only possible if the linker can
16518 resolve the destination at link-time and if the destination is within
16519 range for a direct call.
16521 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16522 an assembler and a linker that support the @code{.reloc} assembly
16523 directive and @code{-mexplicit-relocs} is in effect.  With
16524 @code{-mno-explicit-relocs}, this optimization can be performed by the
16525 assembler and the linker alone without help from the compiler.
16527 @item -mmcount-ra-address
16528 @itemx -mno-mcount-ra-address
16529 @opindex mmcount-ra-address
16530 @opindex mno-mcount-ra-address
16531 Emit (do not emit) code that allows @code{_mcount} to modify the
16532 calling function's return address.  When enabled, this option extends
16533 the usual @code{_mcount} interface with a new @var{ra-address}
16534 parameter, which has type @code{intptr_t *} and is passed in register
16535 @code{$12}.  @code{_mcount} can then modify the return address by
16536 doing both of the following:
16537 @itemize
16538 @item
16539 Returning the new address in register @code{$31}.
16540 @item
16541 Storing the new address in @code{*@var{ra-address}},
16542 if @var{ra-address} is nonnull.
16543 @end itemize
16545 The default is @option{-mno-mcount-ra-address}.
16547 @end table
16549 @node MMIX Options
16550 @subsection MMIX Options
16551 @cindex MMIX Options
16553 These options are defined for the MMIX:
16555 @table @gcctabopt
16556 @item -mlibfuncs
16557 @itemx -mno-libfuncs
16558 @opindex mlibfuncs
16559 @opindex mno-libfuncs
16560 Specify that intrinsic library functions are being compiled, passing all
16561 values in registers, no matter the size.
16563 @item -mepsilon
16564 @itemx -mno-epsilon
16565 @opindex mepsilon
16566 @opindex mno-epsilon
16567 Generate floating-point comparison instructions that compare with respect
16568 to the @code{rE} epsilon register.
16570 @item -mabi=mmixware
16571 @itemx -mabi=gnu
16572 @opindex mabi=mmixware
16573 @opindex mabi=gnu
16574 Generate code that passes function parameters and return values that (in
16575 the called function) are seen as registers @code{$0} and up, as opposed to
16576 the GNU ABI which uses global registers @code{$231} and up.
16578 @item -mzero-extend
16579 @itemx -mno-zero-extend
16580 @opindex mzero-extend
16581 @opindex mno-zero-extend
16582 When reading data from memory in sizes shorter than 64 bits, use (do not
16583 use) zero-extending load instructions by default, rather than
16584 sign-extending ones.
16586 @item -mknuthdiv
16587 @itemx -mno-knuthdiv
16588 @opindex mknuthdiv
16589 @opindex mno-knuthdiv
16590 Make the result of a division yielding a remainder have the same sign as
16591 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
16592 remainder follows the sign of the dividend.  Both methods are
16593 arithmetically valid, the latter being almost exclusively used.
16595 @item -mtoplevel-symbols
16596 @itemx -mno-toplevel-symbols
16597 @opindex mtoplevel-symbols
16598 @opindex mno-toplevel-symbols
16599 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
16600 code can be used with the @code{PREFIX} assembly directive.
16602 @item -melf
16603 @opindex melf
16604 Generate an executable in the ELF format, rather than the default
16605 @samp{mmo} format used by the @command{mmix} simulator.
16607 @item -mbranch-predict
16608 @itemx -mno-branch-predict
16609 @opindex mbranch-predict
16610 @opindex mno-branch-predict
16611 Use (do not use) the probable-branch instructions, when static branch
16612 prediction indicates a probable branch.
16614 @item -mbase-addresses
16615 @itemx -mno-base-addresses
16616 @opindex mbase-addresses
16617 @opindex mno-base-addresses
16618 Generate (do not generate) code that uses @emph{base addresses}.  Using a
16619 base address automatically generates a request (handled by the assembler
16620 and the linker) for a constant to be set up in a global register.  The
16621 register is used for one or more base address requests within the range 0
16622 to 255 from the value held in the register.  The generally leads to short
16623 and fast code, but the number of different data items that can be
16624 addressed is limited.  This means that a program that uses lots of static
16625 data may require @option{-mno-base-addresses}.
16627 @item -msingle-exit
16628 @itemx -mno-single-exit
16629 @opindex msingle-exit
16630 @opindex mno-single-exit
16631 Force (do not force) generated code to have a single exit point in each
16632 function.
16633 @end table
16635 @node MN10300 Options
16636 @subsection MN10300 Options
16637 @cindex MN10300 options
16639 These @option{-m} options are defined for Matsushita MN10300 architectures:
16641 @table @gcctabopt
16642 @item -mmult-bug
16643 @opindex mmult-bug
16644 Generate code to avoid bugs in the multiply instructions for the MN10300
16645 processors.  This is the default.
16647 @item -mno-mult-bug
16648 @opindex mno-mult-bug
16649 Do not generate code to avoid bugs in the multiply instructions for the
16650 MN10300 processors.
16652 @item -mam33
16653 @opindex mam33
16654 Generate code using features specific to the AM33 processor.
16656 @item -mno-am33
16657 @opindex mno-am33
16658 Do not generate code using features specific to the AM33 processor.  This
16659 is the default.
16661 @item -mam33-2
16662 @opindex mam33-2
16663 Generate code using features specific to the AM33/2.0 processor.
16665 @item -mam34
16666 @opindex mam34
16667 Generate code using features specific to the AM34 processor.
16669 @item -mtune=@var{cpu-type}
16670 @opindex mtune
16671 Use the timing characteristics of the indicated CPU type when
16672 scheduling instructions.  This does not change the targeted processor
16673 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
16674 @samp{am33-2} or @samp{am34}.
16676 @item -mreturn-pointer-on-d0
16677 @opindex mreturn-pointer-on-d0
16678 When generating a function that returns a pointer, return the pointer
16679 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
16680 only in @code{a0}, and attempts to call such functions without a prototype
16681 result in errors.  Note that this option is on by default; use
16682 @option{-mno-return-pointer-on-d0} to disable it.
16684 @item -mno-crt0
16685 @opindex mno-crt0
16686 Do not link in the C run-time initialization object file.
16688 @item -mrelax
16689 @opindex mrelax
16690 Indicate to the linker that it should perform a relaxation optimization pass
16691 to shorten branches, calls and absolute memory addresses.  This option only
16692 has an effect when used on the command line for the final link step.
16694 This option makes symbolic debugging impossible.
16696 @item -mliw
16697 @opindex mliw
16698 Allow the compiler to generate @emph{Long Instruction Word}
16699 instructions if the target is the @samp{AM33} or later.  This is the
16700 default.  This option defines the preprocessor macro @samp{__LIW__}.
16702 @item -mnoliw
16703 @opindex mnoliw
16704 Do not allow the compiler to generate @emph{Long Instruction Word}
16705 instructions.  This option defines the preprocessor macro
16706 @samp{__NO_LIW__}.
16708 @item -msetlb
16709 @opindex msetlb
16710 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
16711 instructions if the target is the @samp{AM33} or later.  This is the
16712 default.  This option defines the preprocessor macro @samp{__SETLB__}.
16714 @item -mnosetlb
16715 @opindex mnosetlb
16716 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
16717 instructions.  This option defines the preprocessor macro
16718 @samp{__NO_SETLB__}.
16720 @end table
16722 @node Moxie Options
16723 @subsection Moxie Options
16724 @cindex Moxie Options
16726 @table @gcctabopt
16728 @item -meb
16729 @opindex meb
16730 Generate big-endian code.  This is the default for @samp{moxie-*-*}
16731 configurations.
16733 @item -mel
16734 @opindex mel
16735 Generate little-endian code.
16737 @item -mno-crt0
16738 @opindex mno-crt0
16739 Do not link in the C run-time initialization object file.
16741 @end table
16743 @node PDP-11 Options
16744 @subsection PDP-11 Options
16745 @cindex PDP-11 Options
16747 These options are defined for the PDP-11:
16749 @table @gcctabopt
16750 @item -mfpu
16751 @opindex mfpu
16752 Use hardware FPP floating point.  This is the default.  (FIS floating
16753 point on the PDP-11/40 is not supported.)
16755 @item -msoft-float
16756 @opindex msoft-float
16757 Do not use hardware floating point.
16759 @item -mac0
16760 @opindex mac0
16761 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
16763 @item -mno-ac0
16764 @opindex mno-ac0
16765 Return floating-point results in memory.  This is the default.
16767 @item -m40
16768 @opindex m40
16769 Generate code for a PDP-11/40.
16771 @item -m45
16772 @opindex m45
16773 Generate code for a PDP-11/45.  This is the default.
16775 @item -m10
16776 @opindex m10
16777 Generate code for a PDP-11/10.
16779 @item -mbcopy-builtin
16780 @opindex mbcopy-builtin
16781 Use inline @code{movmemhi} patterns for copying memory.  This is the
16782 default.
16784 @item -mbcopy
16785 @opindex mbcopy
16786 Do not use inline @code{movmemhi} patterns for copying memory.
16788 @item -mint16
16789 @itemx -mno-int32
16790 @opindex mint16
16791 @opindex mno-int32
16792 Use 16-bit @code{int}.  This is the default.
16794 @item -mint32
16795 @itemx -mno-int16
16796 @opindex mint32
16797 @opindex mno-int16
16798 Use 32-bit @code{int}.
16800 @item -mfloat64
16801 @itemx -mno-float32
16802 @opindex mfloat64
16803 @opindex mno-float32
16804 Use 64-bit @code{float}.  This is the default.
16806 @item -mfloat32
16807 @itemx -mno-float64
16808 @opindex mfloat32
16809 @opindex mno-float64
16810 Use 32-bit @code{float}.
16812 @item -mabshi
16813 @opindex mabshi
16814 Use @code{abshi2} pattern.  This is the default.
16816 @item -mno-abshi
16817 @opindex mno-abshi
16818 Do not use @code{abshi2} pattern.
16820 @item -mbranch-expensive
16821 @opindex mbranch-expensive
16822 Pretend that branches are expensive.  This is for experimenting with
16823 code generation only.
16825 @item -mbranch-cheap
16826 @opindex mbranch-cheap
16827 Do not pretend that branches are expensive.  This is the default.
16829 @item -munix-asm
16830 @opindex munix-asm
16831 Use Unix assembler syntax.  This is the default when configured for
16832 @samp{pdp11-*-bsd}.
16834 @item -mdec-asm
16835 @opindex mdec-asm
16836 Use DEC assembler syntax.  This is the default when configured for any
16837 PDP-11 target other than @samp{pdp11-*-bsd}.
16838 @end table
16840 @node picoChip Options
16841 @subsection picoChip Options
16842 @cindex picoChip options
16844 These @samp{-m} options are defined for picoChip implementations:
16846 @table @gcctabopt
16848 @item -mae=@var{ae_type}
16849 @opindex mcpu
16850 Set the instruction set, register set, and instruction scheduling
16851 parameters for array element type @var{ae_type}.  Supported values
16852 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
16854 @option{-mae=ANY} selects a completely generic AE type.  Code
16855 generated with this option runs on any of the other AE types.  The
16856 code is not as efficient as it would be if compiled for a specific
16857 AE type, and some types of operation (e.g., multiplication) do not
16858 work properly on all types of AE.
16860 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
16861 for compiled code, and is the default.
16863 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
16864 option may suffer from poor performance of byte (char) manipulation,
16865 since the DSP AE does not provide hardware support for byte load/stores.
16867 @item -msymbol-as-address
16868 Enable the compiler to directly use a symbol name as an address in a
16869 load/store instruction, without first loading it into a
16870 register.  Typically, the use of this option generates larger
16871 programs, which run faster than when the option isn't used.  However, the
16872 results vary from program to program, so it is left as a user option,
16873 rather than being permanently enabled.
16875 @item -mno-inefficient-warnings
16876 Disables warnings about the generation of inefficient code.  These
16877 warnings can be generated, for example, when compiling code that
16878 performs byte-level memory operations on the MAC AE type.  The MAC AE has
16879 no hardware support for byte-level memory operations, so all byte
16880 load/stores must be synthesized from word load/store operations.  This is
16881 inefficient and a warning is generated to indicate
16882 that you should rewrite the code to avoid byte operations, or to target
16883 an AE type that has the necessary hardware support.  This option disables
16884 these warnings.
16886 @end table
16888 @node PowerPC Options
16889 @subsection PowerPC Options
16890 @cindex PowerPC options
16892 These are listed under @xref{RS/6000 and PowerPC Options}.
16894 @node RL78 Options
16895 @subsection RL78 Options
16896 @cindex RL78 Options
16898 @table @gcctabopt
16900 @item -msim
16901 @opindex msim
16902 Links in additional target libraries to support operation within a
16903 simulator.
16905 @item -mmul=none
16906 @itemx -mmul=g13
16907 @itemx -mmul=rl78
16908 @opindex mmul
16909 Specifies the type of hardware multiplication support to be used.  The
16910 default is @code{none}, which uses software multiplication functions.
16911 The @code{g13} option is for the hardware multiply/divide peripheral
16912 only on the RL78/G13 targets.  The @code{rl78} option is for the
16913 standard hardware multiplication defined in the RL78 software manual.
16915 @end table
16917 @node RS/6000 and PowerPC Options
16918 @subsection IBM RS/6000 and PowerPC Options
16919 @cindex RS/6000 and PowerPC Options
16920 @cindex IBM RS/6000 and PowerPC Options
16922 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
16923 @table @gcctabopt
16924 @item -mpowerpc-gpopt
16925 @itemx -mno-powerpc-gpopt
16926 @itemx -mpowerpc-gfxopt
16927 @itemx -mno-powerpc-gfxopt
16928 @need 800
16929 @itemx -mpowerpc64
16930 @itemx -mno-powerpc64
16931 @itemx -mmfcrf
16932 @itemx -mno-mfcrf
16933 @itemx -mpopcntb
16934 @itemx -mno-popcntb
16935 @itemx -mpopcntd
16936 @itemx -mno-popcntd
16937 @itemx -mfprnd
16938 @itemx -mno-fprnd
16939 @need 800
16940 @itemx -mcmpb
16941 @itemx -mno-cmpb
16942 @itemx -mmfpgpr
16943 @itemx -mno-mfpgpr
16944 @itemx -mhard-dfp
16945 @itemx -mno-hard-dfp
16946 @opindex mpowerpc-gpopt
16947 @opindex mno-powerpc-gpopt
16948 @opindex mpowerpc-gfxopt
16949 @opindex mno-powerpc-gfxopt
16950 @opindex mpowerpc64
16951 @opindex mno-powerpc64
16952 @opindex mmfcrf
16953 @opindex mno-mfcrf
16954 @opindex mpopcntb
16955 @opindex mno-popcntb
16956 @opindex mpopcntd
16957 @opindex mno-popcntd
16958 @opindex mfprnd
16959 @opindex mno-fprnd
16960 @opindex mcmpb
16961 @opindex mno-cmpb
16962 @opindex mmfpgpr
16963 @opindex mno-mfpgpr
16964 @opindex mhard-dfp
16965 @opindex mno-hard-dfp
16966 You use these options to specify which instructions are available on the
16967 processor you are using.  The default value of these options is
16968 determined when configuring GCC@.  Specifying the
16969 @option{-mcpu=@var{cpu_type}} overrides the specification of these
16970 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
16971 rather than the options listed above.
16973 Specifying @option{-mpowerpc-gpopt} allows
16974 GCC to use the optional PowerPC architecture instructions in the
16975 General Purpose group, including floating-point square root.  Specifying
16976 @option{-mpowerpc-gfxopt} allows GCC to
16977 use the optional PowerPC architecture instructions in the Graphics
16978 group, including floating-point select.
16980 The @option{-mmfcrf} option allows GCC to generate the move from
16981 condition register field instruction implemented on the POWER4
16982 processor and other processors that support the PowerPC V2.01
16983 architecture.
16984 The @option{-mpopcntb} option allows GCC to generate the popcount and
16985 double-precision FP reciprocal estimate instruction implemented on the
16986 POWER5 processor and other processors that support the PowerPC V2.02
16987 architecture.
16988 The @option{-mpopcntd} option allows GCC to generate the popcount
16989 instruction implemented on the POWER7 processor and other processors
16990 that support the PowerPC V2.06 architecture.
16991 The @option{-mfprnd} option allows GCC to generate the FP round to
16992 integer instructions implemented on the POWER5+ processor and other
16993 processors that support the PowerPC V2.03 architecture.
16994 The @option{-mcmpb} option allows GCC to generate the compare bytes
16995 instruction implemented on the POWER6 processor and other processors
16996 that support the PowerPC V2.05 architecture.
16997 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
16998 general-purpose register instructions implemented on the POWER6X
16999 processor and other processors that support the extended PowerPC V2.05
17000 architecture.
17001 The @option{-mhard-dfp} option allows GCC to generate the decimal
17002 floating-point instructions implemented on some POWER processors.
17004 The @option{-mpowerpc64} option allows GCC to generate the additional
17005 64-bit instructions that are found in the full PowerPC64 architecture
17006 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
17007 @option{-mno-powerpc64}.
17009 @item -mcpu=@var{cpu_type}
17010 @opindex mcpu
17011 Set architecture type, register usage, and
17012 instruction scheduling parameters for machine type @var{cpu_type}.
17013 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
17014 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
17015 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
17016 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
17017 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
17018 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
17019 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
17020 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
17021 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
17022 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{powerpc},
17023 @samp{powerpc64}, and @samp{rs64}.
17025 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
17026 PowerPC and 64-bit PowerPC architecture machine
17027 types, with an appropriate, generic processor model assumed for
17028 scheduling purposes.
17030 The other options specify a specific processor.  Code generated under
17031 those options runs best on that processor, and may not run at all on
17032 others.
17034 The @option{-mcpu} options automatically enable or disable the
17035 following options:
17037 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
17038 -mpopcntb -mpopcntd  -mpowerpc64 @gol
17039 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
17040 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
17042 The particular options set for any particular CPU varies between
17043 compiler versions, depending on what setting seems to produce optimal
17044 code for that CPU; it doesn't necessarily reflect the actual hardware's
17045 capabilities.  If you wish to set an individual option to a particular
17046 value, you may specify it after the @option{-mcpu} option, like
17047 @option{-mcpu=970 -mno-altivec}.
17049 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
17050 not enabled or disabled by the @option{-mcpu} option at present because
17051 AIX does not have full support for these options.  You may still
17052 enable or disable them individually if you're sure it'll work in your
17053 environment.
17055 @item -mtune=@var{cpu_type}
17056 @opindex mtune
17057 Set the instruction scheduling parameters for machine type
17058 @var{cpu_type}, but do not set the architecture type or register usage,
17059 as @option{-mcpu=@var{cpu_type}} does.  The same
17060 values for @var{cpu_type} are used for @option{-mtune} as for
17061 @option{-mcpu}.  If both are specified, the code generated uses the
17062 architecture and registers set by @option{-mcpu}, but the
17063 scheduling parameters set by @option{-mtune}.
17065 @item -mcmodel=small
17066 @opindex mcmodel=small
17067 Generate PowerPC64 code for the small model: The TOC is limited to
17068 64k.
17070 @item -mcmodel=medium
17071 @opindex mcmodel=medium
17072 Generate PowerPC64 code for the medium model: The TOC and other static
17073 data may be up to a total of 4G in size.
17075 @item -mcmodel=large
17076 @opindex mcmodel=large
17077 Generate PowerPC64 code for the large model: The TOC may be up to 4G
17078 in size.  Other data and code is only limited by the 64-bit address
17079 space.
17081 @item -maltivec
17082 @itemx -mno-altivec
17083 @opindex maltivec
17084 @opindex mno-altivec
17085 Generate code that uses (does not use) AltiVec instructions, and also
17086 enable the use of built-in functions that allow more direct access to
17087 the AltiVec instruction set.  You may also need to set
17088 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
17089 enhancements.
17091 @item -mvrsave
17092 @itemx -mno-vrsave
17093 @opindex mvrsave
17094 @opindex mno-vrsave
17095 Generate VRSAVE instructions when generating AltiVec code.
17097 @item -mgen-cell-microcode
17098 @opindex mgen-cell-microcode
17099 Generate Cell microcode instructions.
17101 @item -mwarn-cell-microcode
17102 @opindex mwarn-cell-microcode
17103 Warn when a Cell microcode instruction is emitted.  An example
17104 of a Cell microcode instruction is a variable shift.
17106 @item -msecure-plt
17107 @opindex msecure-plt
17108 Generate code that allows @command{ld} and @command{ld.so}
17109 to build executables and shared
17110 libraries with non-executable @code{.plt} and @code{.got} sections.
17111 This is a PowerPC
17112 32-bit SYSV ABI option.
17114 @item -mbss-plt
17115 @opindex mbss-plt
17116 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
17117 fills in, and
17118 requires @code{.plt} and @code{.got}
17119 sections that are both writable and executable.
17120 This is a PowerPC 32-bit SYSV ABI option.
17122 @item -misel
17123 @itemx -mno-isel
17124 @opindex misel
17125 @opindex mno-isel
17126 This switch enables or disables the generation of ISEL instructions.
17128 @item -misel=@var{yes/no}
17129 This switch has been deprecated.  Use @option{-misel} and
17130 @option{-mno-isel} instead.
17132 @item -mspe
17133 @itemx -mno-spe
17134 @opindex mspe
17135 @opindex mno-spe
17136 This switch enables or disables the generation of SPE simd
17137 instructions.
17139 @item -mpaired
17140 @itemx -mno-paired
17141 @opindex mpaired
17142 @opindex mno-paired
17143 This switch enables or disables the generation of PAIRED simd
17144 instructions.
17146 @item -mspe=@var{yes/no}
17147 This option has been deprecated.  Use @option{-mspe} and
17148 @option{-mno-spe} instead.
17150 @item -mvsx
17151 @itemx -mno-vsx
17152 @opindex mvsx
17153 @opindex mno-vsx
17154 Generate code that uses (does not use) vector/scalar (VSX)
17155 instructions, and also enable the use of built-in functions that allow
17156 more direct access to the VSX instruction set.
17158 @item -mfloat-gprs=@var{yes/single/double/no}
17159 @itemx -mfloat-gprs
17160 @opindex mfloat-gprs
17161 This switch enables or disables the generation of floating-point
17162 operations on the general-purpose registers for architectures that
17163 support it.
17165 The argument @var{yes} or @var{single} enables the use of
17166 single-precision floating-point operations.
17168 The argument @var{double} enables the use of single and
17169 double-precision floating-point operations.
17171 The argument @var{no} disables floating-point operations on the
17172 general-purpose registers.
17174 This option is currently only available on the MPC854x.
17176 @item -m32
17177 @itemx -m64
17178 @opindex m32
17179 @opindex m64
17180 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
17181 targets (including GNU/Linux).  The 32-bit environment sets int, long
17182 and pointer to 32 bits and generates code that runs on any PowerPC
17183 variant.  The 64-bit environment sets int to 32 bits and long and
17184 pointer to 64 bits, and generates code for PowerPC64, as for
17185 @option{-mpowerpc64}.
17187 @item -mfull-toc
17188 @itemx -mno-fp-in-toc
17189 @itemx -mno-sum-in-toc
17190 @itemx -mminimal-toc
17191 @opindex mfull-toc
17192 @opindex mno-fp-in-toc
17193 @opindex mno-sum-in-toc
17194 @opindex mminimal-toc
17195 Modify generation of the TOC (Table Of Contents), which is created for
17196 every executable file.  The @option{-mfull-toc} option is selected by
17197 default.  In that case, GCC allocates at least one TOC entry for
17198 each unique non-automatic variable reference in your program.  GCC
17199 also places floating-point constants in the TOC@.  However, only
17200 16,384 entries are available in the TOC@.
17202 If you receive a linker error message that saying you have overflowed
17203 the available TOC space, you can reduce the amount of TOC space used
17204 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
17205 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
17206 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
17207 generate code to calculate the sum of an address and a constant at
17208 run time instead of putting that sum into the TOC@.  You may specify one
17209 or both of these options.  Each causes GCC to produce very slightly
17210 slower and larger code at the expense of conserving TOC space.
17212 If you still run out of space in the TOC even when you specify both of
17213 these options, specify @option{-mminimal-toc} instead.  This option causes
17214 GCC to make only one TOC entry for every file.  When you specify this
17215 option, GCC produces code that is slower and larger but which
17216 uses extremely little TOC space.  You may wish to use this option
17217 only on files that contain less frequently-executed code.
17219 @item -maix64
17220 @itemx -maix32
17221 @opindex maix64
17222 @opindex maix32
17223 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
17224 @code{long} type, and the infrastructure needed to support them.
17225 Specifying @option{-maix64} implies @option{-mpowerpc64},
17226 while @option{-maix32} disables the 64-bit ABI and
17227 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
17229 @item -mxl-compat
17230 @itemx -mno-xl-compat
17231 @opindex mxl-compat
17232 @opindex mno-xl-compat
17233 Produce code that conforms more closely to IBM XL compiler semantics
17234 when using AIX-compatible ABI@.  Pass floating-point arguments to
17235 prototyped functions beyond the register save area (RSA) on the stack
17236 in addition to argument FPRs.  Do not assume that most significant
17237 double in 128-bit long double value is properly rounded when comparing
17238 values and converting to double.  Use XL symbol names for long double
17239 support routines.
17241 The AIX calling convention was extended but not initially documented to
17242 handle an obscure K&R C case of calling a function that takes the
17243 address of its arguments with fewer arguments than declared.  IBM XL
17244 compilers access floating-point arguments that do not fit in the
17245 RSA from the stack when a subroutine is compiled without
17246 optimization.  Because always storing floating-point arguments on the
17247 stack is inefficient and rarely needed, this option is not enabled by
17248 default and only is necessary when calling subroutines compiled by IBM
17249 XL compilers without optimization.
17251 @item -mpe
17252 @opindex mpe
17253 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
17254 application written to use message passing with special startup code to
17255 enable the application to run.  The system must have PE installed in the
17256 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
17257 must be overridden with the @option{-specs=} option to specify the
17258 appropriate directory location.  The Parallel Environment does not
17259 support threads, so the @option{-mpe} option and the @option{-pthread}
17260 option are incompatible.
17262 @item -malign-natural
17263 @itemx -malign-power
17264 @opindex malign-natural
17265 @opindex malign-power
17266 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
17267 @option{-malign-natural} overrides the ABI-defined alignment of larger
17268 types, such as floating-point doubles, on their natural size-based boundary.
17269 The option @option{-malign-power} instructs GCC to follow the ABI-specified
17270 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
17272 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
17273 is not supported.
17275 @item -msoft-float
17276 @itemx -mhard-float
17277 @opindex msoft-float
17278 @opindex mhard-float
17279 Generate code that does not use (uses) the floating-point register set.
17280 Software floating-point emulation is provided if you use the
17281 @option{-msoft-float} option, and pass the option to GCC when linking.
17283 @item -msingle-float
17284 @itemx -mdouble-float
17285 @opindex msingle-float
17286 @opindex mdouble-float
17287 Generate code for single- or double-precision floating-point operations.
17288 @option{-mdouble-float} implies @option{-msingle-float}.
17290 @item -msimple-fpu
17291 @opindex msimple-fpu
17292 Do not generate @code{sqrt} and @code{div} instructions for hardware
17293 floating-point unit.
17295 @item -mfpu=@var{name}
17296 @opindex mfpu
17297 Specify type of floating-point unit.  Valid values for @var{name} are
17298 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
17299 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
17300 @samp{sp_full} (equivalent to @option{-msingle-float}),
17301 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
17303 @item -mxilinx-fpu
17304 @opindex mxilinx-fpu
17305 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
17307 @item -mmultiple
17308 @itemx -mno-multiple
17309 @opindex mmultiple
17310 @opindex mno-multiple
17311 Generate code that uses (does not use) the load multiple word
17312 instructions and the store multiple word instructions.  These
17313 instructions are generated by default on POWER systems, and not
17314 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
17315 PowerPC systems, since those instructions do not work when the
17316 processor is in little-endian mode.  The exceptions are PPC740 and
17317 PPC750 which permit these instructions in little-endian mode.
17319 @item -mstring
17320 @itemx -mno-string
17321 @opindex mstring
17322 @opindex mno-string
17323 Generate code that uses (does not use) the load string instructions
17324 and the store string word instructions to save multiple registers and
17325 do small block moves.  These instructions are generated by default on
17326 POWER systems, and not generated on PowerPC systems.  Do not use
17327 @option{-mstring} on little-endian PowerPC systems, since those
17328 instructions do not work when the processor is in little-endian mode.
17329 The exceptions are PPC740 and PPC750 which permit these instructions
17330 in little-endian mode.
17332 @item -mupdate
17333 @itemx -mno-update
17334 @opindex mupdate
17335 @opindex mno-update
17336 Generate code that uses (does not use) the load or store instructions
17337 that update the base register to the address of the calculated memory
17338 location.  These instructions are generated by default.  If you use
17339 @option{-mno-update}, there is a small window between the time that the
17340 stack pointer is updated and the address of the previous frame is
17341 stored, which means code that walks the stack frame across interrupts or
17342 signals may get corrupted data.
17344 @item -mavoid-indexed-addresses
17345 @itemx -mno-avoid-indexed-addresses
17346 @opindex mavoid-indexed-addresses
17347 @opindex mno-avoid-indexed-addresses
17348 Generate code that tries to avoid (not avoid) the use of indexed load
17349 or store instructions. These instructions can incur a performance
17350 penalty on Power6 processors in certain situations, such as when
17351 stepping through large arrays that cross a 16M boundary.  This option
17352 is enabled by default when targeting Power6 and disabled otherwise.
17354 @item -mfused-madd
17355 @itemx -mno-fused-madd
17356 @opindex mfused-madd
17357 @opindex mno-fused-madd
17358 Generate code that uses (does not use) the floating-point multiply and
17359 accumulate instructions.  These instructions are generated by default
17360 if hardware floating point is used.  The machine-dependent
17361 @option{-mfused-madd} option is now mapped to the machine-independent
17362 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
17363 mapped to @option{-ffp-contract=off}.
17365 @item -mmulhw
17366 @itemx -mno-mulhw
17367 @opindex mmulhw
17368 @opindex mno-mulhw
17369 Generate code that uses (does not use) the half-word multiply and
17370 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
17371 These instructions are generated by default when targeting those
17372 processors.
17374 @item -mdlmzb
17375 @itemx -mno-dlmzb
17376 @opindex mdlmzb
17377 @opindex mno-dlmzb
17378 Generate code that uses (does not use) the string-search @samp{dlmzb}
17379 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
17380 generated by default when targeting those processors.
17382 @item -mno-bit-align
17383 @itemx -mbit-align
17384 @opindex mno-bit-align
17385 @opindex mbit-align
17386 On System V.4 and embedded PowerPC systems do not (do) force structures
17387 and unions that contain bit-fields to be aligned to the base type of the
17388 bit-field.
17390 For example, by default a structure containing nothing but 8
17391 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
17392 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
17393 the structure is aligned to a 1-byte boundary and is 1 byte in
17394 size.
17396 @item -mno-strict-align
17397 @itemx -mstrict-align
17398 @opindex mno-strict-align
17399 @opindex mstrict-align
17400 On System V.4 and embedded PowerPC systems do not (do) assume that
17401 unaligned memory references are handled by the system.
17403 @item -mrelocatable
17404 @itemx -mno-relocatable
17405 @opindex mrelocatable
17406 @opindex mno-relocatable
17407 Generate code that allows (does not allow) a static executable to be
17408 relocated to a different address at run time.  A simple embedded
17409 PowerPC system loader should relocate the entire contents of
17410 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
17411 a table of 32-bit addresses generated by this option.  For this to
17412 work, all objects linked together must be compiled with
17413 @option{-mrelocatable} or @option{-mrelocatable-lib}.
17414 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
17416 @item -mrelocatable-lib
17417 @itemx -mno-relocatable-lib
17418 @opindex mrelocatable-lib
17419 @opindex mno-relocatable-lib
17420 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
17421 @code{.fixup} section to allow static executables to be relocated at
17422 run time, but @option{-mrelocatable-lib} does not use the smaller stack
17423 alignment of @option{-mrelocatable}.  Objects compiled with
17424 @option{-mrelocatable-lib} may be linked with objects compiled with
17425 any combination of the @option{-mrelocatable} options.
17427 @item -mno-toc
17428 @itemx -mtoc
17429 @opindex mno-toc
17430 @opindex mtoc
17431 On System V.4 and embedded PowerPC systems do not (do) assume that
17432 register 2 contains a pointer to a global area pointing to the addresses
17433 used in the program.
17435 @item -mlittle
17436 @itemx -mlittle-endian
17437 @opindex mlittle
17438 @opindex mlittle-endian
17439 On System V.4 and embedded PowerPC systems compile code for the
17440 processor in little-endian mode.  The @option{-mlittle-endian} option is
17441 the same as @option{-mlittle}.
17443 @item -mbig
17444 @itemx -mbig-endian
17445 @opindex mbig
17446 @opindex mbig-endian
17447 On System V.4 and embedded PowerPC systems compile code for the
17448 processor in big-endian mode.  The @option{-mbig-endian} option is
17449 the same as @option{-mbig}.
17451 @item -mdynamic-no-pic
17452 @opindex mdynamic-no-pic
17453 On Darwin and Mac OS X systems, compile code so that it is not
17454 relocatable, but that its external references are relocatable.  The
17455 resulting code is suitable for applications, but not shared
17456 libraries.
17458 @item -msingle-pic-base
17459 @opindex msingle-pic-base
17460 Treat the register used for PIC addressing as read-only, rather than
17461 loading it in the prologue for each function.  The runtime system is
17462 responsible for initializing this register with an appropriate value
17463 before execution begins.
17465 @item -mprioritize-restricted-insns=@var{priority}
17466 @opindex mprioritize-restricted-insns
17467 This option controls the priority that is assigned to
17468 dispatch-slot restricted instructions during the second scheduling
17469 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
17470 or @samp{2} to assign no, highest, or second-highest (respectively) 
17471 priority to dispatch-slot restricted
17472 instructions.
17474 @item -msched-costly-dep=@var{dependence_type}
17475 @opindex msched-costly-dep
17476 This option controls which dependences are considered costly
17477 by the target during instruction scheduling.  The argument
17478 @var{dependence_type} takes one of the following values:
17480 @table @asis
17481 @item @samp{no}
17482 No dependence is costly.
17484 @item @samp{all}
17485 All dependences are costly.
17487 @item @samp{true_store_to_load}
17488 A true dependence from store to load is costly.
17490 @item @samp{store_to_load}
17491 Any dependence from store to load is costly.
17493 @item @var{number}
17494 Any dependence for which the latency is greater than or equal to 
17495 @var{number} is costly.
17496 @end table
17498 @item -minsert-sched-nops=@var{scheme}
17499 @opindex minsert-sched-nops
17500 This option controls which NOP insertion scheme is used during
17501 the second scheduling pass.  The argument @var{scheme} takes one of the
17502 following values:
17504 @table @asis
17505 @item @samp{no}
17506 Don't insert NOPs.
17508 @item @samp{pad}
17509 Pad with NOPs any dispatch group that has vacant issue slots,
17510 according to the scheduler's grouping.
17512 @item @samp{regroup_exact}
17513 Insert NOPs to force costly dependent insns into
17514 separate groups.  Insert exactly as many NOPs as needed to force an insn
17515 to a new group, according to the estimated processor grouping.
17517 @item @var{number}
17518 Insert NOPs to force costly dependent insns into
17519 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
17520 @end table
17522 @item -mcall-sysv
17523 @opindex mcall-sysv
17524 On System V.4 and embedded PowerPC systems compile code using calling
17525 conventions that adhere to the March 1995 draft of the System V
17526 Application Binary Interface, PowerPC processor supplement.  This is the
17527 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
17529 @item -mcall-sysv-eabi
17530 @itemx -mcall-eabi
17531 @opindex mcall-sysv-eabi
17532 @opindex mcall-eabi
17533 Specify both @option{-mcall-sysv} and @option{-meabi} options.
17535 @item -mcall-sysv-noeabi
17536 @opindex mcall-sysv-noeabi
17537 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
17539 @item -mcall-aixdesc
17540 @opindex m
17541 On System V.4 and embedded PowerPC systems compile code for the AIX
17542 operating system.
17544 @item -mcall-linux
17545 @opindex mcall-linux
17546 On System V.4 and embedded PowerPC systems compile code for the
17547 Linux-based GNU system.
17549 @item -mcall-freebsd
17550 @opindex mcall-freebsd
17551 On System V.4 and embedded PowerPC systems compile code for the
17552 FreeBSD operating system.
17554 @item -mcall-netbsd
17555 @opindex mcall-netbsd
17556 On System V.4 and embedded PowerPC systems compile code for the
17557 NetBSD operating system.
17559 @item -mcall-openbsd
17560 @opindex mcall-netbsd
17561 On System V.4 and embedded PowerPC systems compile code for the
17562 OpenBSD operating system.
17564 @item -maix-struct-return
17565 @opindex maix-struct-return
17566 Return all structures in memory (as specified by the AIX ABI)@.
17568 @item -msvr4-struct-return
17569 @opindex msvr4-struct-return
17570 Return structures smaller than 8 bytes in registers (as specified by the
17571 SVR4 ABI)@.
17573 @item -mabi=@var{abi-type}
17574 @opindex mabi
17575 Extend the current ABI with a particular extension, or remove such extension.
17576 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
17577 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
17579 @item -mabi=spe
17580 @opindex mabi=spe
17581 Extend the current ABI with SPE ABI extensions.  This does not change
17582 the default ABI, instead it adds the SPE ABI extensions to the current
17583 ABI@.
17585 @item -mabi=no-spe
17586 @opindex mabi=no-spe
17587 Disable Book-E SPE ABI extensions for the current ABI@.
17589 @item -mabi=ibmlongdouble
17590 @opindex mabi=ibmlongdouble
17591 Change the current ABI to use IBM extended-precision long double.
17592 This is a PowerPC 32-bit SYSV ABI option.
17594 @item -mabi=ieeelongdouble
17595 @opindex mabi=ieeelongdouble
17596 Change the current ABI to use IEEE extended-precision long double.
17597 This is a PowerPC 32-bit Linux ABI option.
17599 @item -mprototype
17600 @itemx -mno-prototype
17601 @opindex mprototype
17602 @opindex mno-prototype
17603 On System V.4 and embedded PowerPC systems assume that all calls to
17604 variable argument functions are properly prototyped.  Otherwise, the
17605 compiler must insert an instruction before every non-prototyped call to
17606 set or clear bit 6 of the condition code register (@var{CR}) to
17607 indicate whether floating-point values are passed in the floating-point
17608 registers in case the function takes variable arguments.  With
17609 @option{-mprototype}, only calls to prototyped variable argument functions
17610 set or clear the bit.
17612 @item -msim
17613 @opindex msim
17614 On embedded PowerPC systems, assume that the startup module is called
17615 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
17616 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
17617 configurations.
17619 @item -mmvme
17620 @opindex mmvme
17621 On embedded PowerPC systems, assume that the startup module is called
17622 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
17623 @file{libc.a}.
17625 @item -mads
17626 @opindex mads
17627 On embedded PowerPC systems, assume that the startup module is called
17628 @file{crt0.o} and the standard C libraries are @file{libads.a} and
17629 @file{libc.a}.
17631 @item -myellowknife
17632 @opindex myellowknife
17633 On embedded PowerPC systems, assume that the startup module is called
17634 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
17635 @file{libc.a}.
17637 @item -mvxworks
17638 @opindex mvxworks
17639 On System V.4 and embedded PowerPC systems, specify that you are
17640 compiling for a VxWorks system.
17642 @item -memb
17643 @opindex memb
17644 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
17645 header to indicate that @samp{eabi} extended relocations are used.
17647 @item -meabi
17648 @itemx -mno-eabi
17649 @opindex meabi
17650 @opindex mno-eabi
17651 On System V.4 and embedded PowerPC systems do (do not) adhere to the
17652 Embedded Applications Binary Interface (EABI), which is a set of
17653 modifications to the System V.4 specifications.  Selecting @option{-meabi}
17654 means that the stack is aligned to an 8-byte boundary, a function
17655 @code{__eabi} is called from @code{main} to set up the EABI
17656 environment, and the @option{-msdata} option can use both @code{r2} and
17657 @code{r13} to point to two separate small data areas.  Selecting
17658 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
17659 no EABI initialization function is called from @code{main}, and the
17660 @option{-msdata} option only uses @code{r13} to point to a single
17661 small data area.  The @option{-meabi} option is on by default if you
17662 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
17664 @item -msdata=eabi
17665 @opindex msdata=eabi
17666 On System V.4 and embedded PowerPC systems, put small initialized
17667 @code{const} global and static data in the @samp{.sdata2} section, which
17668 is pointed to by register @code{r2}.  Put small initialized
17669 non-@code{const} global and static data in the @samp{.sdata} section,
17670 which is pointed to by register @code{r13}.  Put small uninitialized
17671 global and static data in the @samp{.sbss} section, which is adjacent to
17672 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
17673 incompatible with the @option{-mrelocatable} option.  The
17674 @option{-msdata=eabi} option also sets the @option{-memb} option.
17676 @item -msdata=sysv
17677 @opindex msdata=sysv
17678 On System V.4 and embedded PowerPC systems, put small global and static
17679 data in the @samp{.sdata} section, which is pointed to by register
17680 @code{r13}.  Put small uninitialized global and static data in the
17681 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
17682 The @option{-msdata=sysv} option is incompatible with the
17683 @option{-mrelocatable} option.
17685 @item -msdata=default
17686 @itemx -msdata
17687 @opindex msdata=default
17688 @opindex msdata
17689 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
17690 compile code the same as @option{-msdata=eabi}, otherwise compile code the
17691 same as @option{-msdata=sysv}.
17693 @item -msdata=data
17694 @opindex msdata=data
17695 On System V.4 and embedded PowerPC systems, put small global
17696 data in the @samp{.sdata} section.  Put small uninitialized global
17697 data in the @samp{.sbss} section.  Do not use register @code{r13}
17698 to address small data however.  This is the default behavior unless
17699 other @option{-msdata} options are used.
17701 @item -msdata=none
17702 @itemx -mno-sdata
17703 @opindex msdata=none
17704 @opindex mno-sdata
17705 On embedded PowerPC systems, put all initialized global and static data
17706 in the @samp{.data} section, and all uninitialized data in the
17707 @samp{.bss} section.
17709 @item -mblock-move-inline-limit=@var{num}
17710 @opindex mblock-move-inline-limit
17711 Inline all block moves (such as calls to @code{memcpy} or structure
17712 copies) less than or equal to @var{num} bytes.  The minimum value for
17713 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
17714 targets.  The default value is target-specific.
17716 @item -G @var{num}
17717 @opindex G
17718 @cindex smaller data references (PowerPC)
17719 @cindex .sdata/.sdata2 references (PowerPC)
17720 On embedded PowerPC systems, put global and static items less than or
17721 equal to @var{num} bytes into the small data or BSS sections instead of
17722 the normal data or BSS section.  By default, @var{num} is 8.  The
17723 @option{-G @var{num}} switch is also passed to the linker.
17724 All modules should be compiled with the same @option{-G @var{num}} value.
17726 @item -mregnames
17727 @itemx -mno-regnames
17728 @opindex mregnames
17729 @opindex mno-regnames
17730 On System V.4 and embedded PowerPC systems do (do not) emit register
17731 names in the assembly language output using symbolic forms.
17733 @item -mlongcall
17734 @itemx -mno-longcall
17735 @opindex mlongcall
17736 @opindex mno-longcall
17737 By default assume that all calls are far away so that a longer and more
17738 expensive calling sequence is required.  This is required for calls
17739 farther than 32 megabytes (33,554,432 bytes) from the current location.
17740 A short call is generated if the compiler knows
17741 the call cannot be that far away.  This setting can be overridden by
17742 the @code{shortcall} function attribute, or by @code{#pragma
17743 longcall(0)}.
17745 Some linkers are capable of detecting out-of-range calls and generating
17746 glue code on the fly.  On these systems, long calls are unnecessary and
17747 generate slower code.  As of this writing, the AIX linker can do this,
17748 as can the GNU linker for PowerPC/64.  It is planned to add this feature
17749 to the GNU linker for 32-bit PowerPC systems as well.
17751 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
17752 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
17753 addresses represent the callee and the branch island.  The
17754 Darwin/PPC linker prefers the first address and generates a @code{bl
17755 callee} if the PPC @code{bl} instruction reaches the callee directly;
17756 otherwise, the linker generates @code{bl L42} to call the branch
17757 island.  The branch island is appended to the body of the
17758 calling function; it computes the full 32-bit address of the callee
17759 and jumps to it.
17761 On Mach-O (Darwin) systems, this option directs the compiler emit to
17762 the glue for every direct call, and the Darwin linker decides whether
17763 to use or discard it.
17765 In the future, GCC may ignore all longcall specifications
17766 when the linker is known to generate glue.
17768 @item -mtls-markers
17769 @itemx -mno-tls-markers
17770 @opindex mtls-markers
17771 @opindex mno-tls-markers
17772 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
17773 specifying the function argument.  The relocation allows the linker to
17774 reliably associate function call with argument setup instructions for
17775 TLS optimization, which in turn allows GCC to better schedule the
17776 sequence.
17778 @item -pthread
17779 @opindex pthread
17780 Adds support for multithreading with the @dfn{pthreads} library.
17781 This option sets flags for both the preprocessor and linker.
17783 @item -mrecip
17784 @itemx -mno-recip
17785 @opindex mrecip
17786 This option enables use of the reciprocal estimate and
17787 reciprocal square root estimate instructions with additional
17788 Newton-Raphson steps to increase precision instead of doing a divide or
17789 square root and divide for floating-point arguments.  You should use
17790 the @option{-ffast-math} option when using @option{-mrecip} (or at
17791 least @option{-funsafe-math-optimizations},
17792 @option{-finite-math-only}, @option{-freciprocal-math} and
17793 @option{-fno-trapping-math}).  Note that while the throughput of the
17794 sequence is generally higher than the throughput of the non-reciprocal
17795 instruction, the precision of the sequence can be decreased by up to 2
17796 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
17797 roots.
17799 @item -mrecip=@var{opt}
17800 @opindex mrecip=opt
17801 This option controls which reciprocal estimate instructions
17802 may be used.  @var{opt} is a comma-separated list of options, which may
17803 be preceded by a @code{!} to invert the option:
17804 @code{all}: enable all estimate instructions,
17805 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
17806 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
17807 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
17808 @code{divf}: enable the single-precision reciprocal approximation instructions;
17809 @code{divd}: enable the double-precision reciprocal approximation instructions;
17810 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
17811 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
17812 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
17814 So, for example, @option{-mrecip=all,!rsqrtd} enables
17815 all of the reciprocal estimate instructions, except for the
17816 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
17817 which handle the double-precision reciprocal square root calculations.
17819 @item -mrecip-precision
17820 @itemx -mno-recip-precision
17821 @opindex mrecip-precision
17822 Assume (do not assume) that the reciprocal estimate instructions
17823 provide higher-precision estimates than is mandated by the PowerPC
17824 ABI.  Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
17825 automatically selects @option{-mrecip-precision}.  The double-precision 
17826 square root estimate instructions are not generated by
17827 default on low-precision machines, since they do not provide an
17828 estimate that converges after three steps.
17830 @item -mveclibabi=@var{type}
17831 @opindex mveclibabi
17832 Specifies the ABI type to use for vectorizing intrinsics using an
17833 external library.  The only type supported at present is @code{mass},
17834 which specifies to use IBM's Mathematical Acceleration Subsystem
17835 (MASS) libraries for vectorizing intrinsics using external libraries.
17836 GCC currently emits calls to @code{acosd2}, @code{acosf4},
17837 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
17838 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
17839 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
17840 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
17841 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
17842 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
17843 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
17844 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
17845 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
17846 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
17847 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
17848 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
17849 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
17850 for power7.  Both @option{-ftree-vectorize} and
17851 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
17852 libraries must be specified at link time.
17854 @item -mfriz
17855 @itemx -mno-friz
17856 @opindex mfriz
17857 Generate (do not generate) the @code{friz} instruction when the
17858 @option{-funsafe-math-optimizations} option is used to optimize
17859 rounding of floating-point values to 64-bit integer and back to floating
17860 point.  The @code{friz} instruction does not return the same value if
17861 the floating-point number is too large to fit in an integer.
17863 @item -mpointers-to-nested-functions
17864 @itemx -mno-pointers-to-nested-functions
17865 @opindex mpointers-to-nested-functions
17866 Generate (do not generate) code to load up the static chain register
17867 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
17868 systems where a function pointer points to a 3-word descriptor giving
17869 the function address, TOC value to be loaded in register @var{r2}, and
17870 static chain value to be loaded in register @var{r11}.  The
17871 @option{-mpointers-to-nested-functions} is on by default.  You cannot
17872 call through pointers to nested functions or pointers
17873 to functions compiled in other languages that use the static chain if
17874 you use the @option{-mno-pointers-to-nested-functions}.
17876 @item -msave-toc-indirect
17877 @itemx -mno-save-toc-indirect
17878 @opindex msave-toc-indirect
17879 Generate (do not generate) code to save the TOC value in the reserved
17880 stack location in the function prologue if the function calls through
17881 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
17882 saved in the prologue, it is saved just before the call through the
17883 pointer.  The @option{-mno-save-toc-indirect} option is the default.
17884 @end table
17886 @node RX Options
17887 @subsection RX Options
17888 @cindex RX Options
17890 These command-line options are defined for RX targets:
17892 @table @gcctabopt
17893 @item -m64bit-doubles
17894 @itemx -m32bit-doubles
17895 @opindex m64bit-doubles
17896 @opindex m32bit-doubles
17897 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
17898 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
17899 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
17900 works on 32-bit values, which is why the default is
17901 @option{-m32bit-doubles}.
17903 @item -fpu
17904 @itemx -nofpu
17905 @opindex fpu
17906 @opindex nofpu
17907 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
17908 floating-point hardware.  The default is enabled for the @var{RX600}
17909 series and disabled for the @var{RX200} series.
17911 Floating-point instructions are only generated for 32-bit floating-point 
17912 values, however, so the FPU hardware is not used for doubles if the
17913 @option{-m64bit-doubles} option is used.
17915 @emph{Note} If the @option{-fpu} option is enabled then
17916 @option{-funsafe-math-optimizations} is also enabled automatically.
17917 This is because the RX FPU instructions are themselves unsafe.
17919 @item -mcpu=@var{name}
17920 @opindex -mcpu
17921 Selects the type of RX CPU to be targeted.  Currently three types are
17922 supported, the generic @var{RX600} and @var{RX200} series hardware and
17923 the specific @var{RX610} CPU.  The default is @var{RX600}.
17925 The only difference between @var{RX600} and @var{RX610} is that the
17926 @var{RX610} does not support the @code{MVTIPL} instruction.
17928 The @var{RX200} series does not have a hardware floating-point unit
17929 and so @option{-nofpu} is enabled by default when this type is
17930 selected.
17932 @item -mbig-endian-data
17933 @itemx -mlittle-endian-data
17934 @opindex mbig-endian-data
17935 @opindex mlittle-endian-data
17936 Store data (but not code) in the big-endian format.  The default is
17937 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
17938 format.
17940 @item -msmall-data-limit=@var{N}
17941 @opindex msmall-data-limit
17942 Specifies the maximum size in bytes of global and static variables
17943 which can be placed into the small data area.  Using the small data
17944 area can lead to smaller and faster code, but the size of area is
17945 limited and it is up to the programmer to ensure that the area does
17946 not overflow.  Also when the small data area is used one of the RX's
17947 registers (usually @code{r13}) is reserved for use pointing to this
17948 area, so it is no longer available for use by the compiler.  This
17949 could result in slower and/or larger code if variables are pushed onto
17950 the stack instead of being held in this register.
17952 Note, common variables (variables that have not been initialized) and
17953 constants are not placed into the small data area as they are assigned
17954 to other sections in the output executable.
17956 The default value is zero, which disables this feature.  Note, this
17957 feature is not enabled by default with higher optimization levels
17958 (@option{-O2} etc) because of the potentially detrimental effects of
17959 reserving a register.  It is up to the programmer to experiment and
17960 discover whether this feature is of benefit to their program.  See the
17961 description of the @option{-mpid} option for a description of how the
17962 actual register to hold the small data area pointer is chosen.
17964 @item -msim
17965 @itemx -mno-sim
17966 @opindex msim
17967 @opindex mno-sim
17968 Use the simulator runtime.  The default is to use the libgloss
17969 board-specific runtime.
17971 @item -mas100-syntax
17972 @itemx -mno-as100-syntax
17973 @opindex mas100-syntax
17974 @opindex mno-as100-syntax
17975 When generating assembler output use a syntax that is compatible with
17976 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
17977 assembler, but it has some restrictions so it is not generated by default.
17979 @item -mmax-constant-size=@var{N}
17980 @opindex mmax-constant-size
17981 Specifies the maximum size, in bytes, of a constant that can be used as
17982 an operand in a RX instruction.  Although the RX instruction set does
17983 allow constants of up to 4 bytes in length to be used in instructions,
17984 a longer value equates to a longer instruction.  Thus in some
17985 circumstances it can be beneficial to restrict the size of constants
17986 that are used in instructions.  Constants that are too big are instead
17987 placed into a constant pool and referenced via register indirection.
17989 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
17990 or 4 means that constants of any size are allowed.
17992 @item -mrelax
17993 @opindex mrelax
17994 Enable linker relaxation.  Linker relaxation is a process whereby the
17995 linker attempts to reduce the size of a program by finding shorter
17996 versions of various instructions.  Disabled by default.
17998 @item -mint-register=@var{N}
17999 @opindex mint-register
18000 Specify the number of registers to reserve for fast interrupt handler
18001 functions.  The value @var{N} can be between 0 and 4.  A value of 1
18002 means that register @code{r13} is reserved for the exclusive use
18003 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
18004 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
18005 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
18006 A value of 0, the default, does not reserve any registers.
18008 @item -msave-acc-in-interrupts
18009 @opindex msave-acc-in-interrupts
18010 Specifies that interrupt handler functions should preserve the
18011 accumulator register.  This is only necessary if normal code might use
18012 the accumulator register, for example because it performs 64-bit
18013 multiplications.  The default is to ignore the accumulator as this
18014 makes the interrupt handlers faster.
18016 @item -mpid
18017 @itemx -mno-pid
18018 @opindex mpid
18019 @opindex mno-pid
18020 Enables the generation of position independent data.  When enabled any
18021 access to constant data is done via an offset from a base address
18022 held in a register.  This allows the location of constant data to be
18023 determined at run time without requiring the executable to be
18024 relocated, which is a benefit to embedded applications with tight
18025 memory constraints.  Data that can be modified is not affected by this
18026 option.
18028 Note, using this feature reserves a register, usually @code{r13}, for
18029 the constant data base address.  This can result in slower and/or
18030 larger code, especially in complicated functions.
18032 The actual register chosen to hold the constant data base address
18033 depends upon whether the @option{-msmall-data-limit} and/or the
18034 @option{-mint-register} command-line options are enabled.  Starting
18035 with register @code{r13} and proceeding downwards, registers are
18036 allocated first to satisfy the requirements of @option{-mint-register},
18037 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
18038 is possible for the small data area register to be @code{r8} if both
18039 @option{-mint-register=4} and @option{-mpid} are specified on the
18040 command line.
18042 By default this feature is not enabled.  The default can be restored
18043 via the @option{-mno-pid} command-line option.
18045 @item -mno-warn-multiple-fast-interrupts
18046 @itemx -mwarn-multiple-fast-interrupts
18047 @opindex mno-warn-multiple-fast-interrupts
18048 @opindex mwarn-multiple-fast-interrupts
18049 Prevents GCC from issuing a warning message if it finds more than one
18050 fast interrupt handler when it is compiling a file.  The default is to
18051 issue a warning for each extra fast interrupt handler found, as the RX
18052 only supports one such interrupt.
18054 @end table
18056 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
18057 has special significance to the RX port when used with the
18058 @code{interrupt} function attribute.  This attribute indicates a
18059 function intended to process fast interrupts.  GCC ensures
18060 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
18061 and/or @code{r13} and only provided that the normal use of the
18062 corresponding registers have been restricted via the
18063 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
18064 options.
18066 @node S/390 and zSeries Options
18067 @subsection S/390 and zSeries Options
18068 @cindex S/390 and zSeries Options
18070 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
18072 @table @gcctabopt
18073 @item -mhard-float
18074 @itemx -msoft-float
18075 @opindex mhard-float
18076 @opindex msoft-float
18077 Use (do not use) the hardware floating-point instructions and registers
18078 for floating-point operations.  When @option{-msoft-float} is specified,
18079 functions in @file{libgcc.a} are used to perform floating-point
18080 operations.  When @option{-mhard-float} is specified, the compiler
18081 generates IEEE floating-point instructions.  This is the default.
18083 @item -mhard-dfp
18084 @itemx -mno-hard-dfp
18085 @opindex mhard-dfp
18086 @opindex mno-hard-dfp
18087 Use (do not use) the hardware decimal-floating-point instructions for
18088 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
18089 specified, functions in @file{libgcc.a} are used to perform
18090 decimal-floating-point operations.  When @option{-mhard-dfp} is
18091 specified, the compiler generates decimal-floating-point hardware
18092 instructions.  This is the default for @option{-march=z9-ec} or higher.
18094 @item -mlong-double-64
18095 @itemx -mlong-double-128
18096 @opindex mlong-double-64
18097 @opindex mlong-double-128
18098 These switches control the size of @code{long double} type. A size
18099 of 64 bits makes the @code{long double} type equivalent to the @code{double}
18100 type. This is the default.
18102 @item -mbackchain
18103 @itemx -mno-backchain
18104 @opindex mbackchain
18105 @opindex mno-backchain
18106 Store (do not store) the address of the caller's frame as backchain pointer
18107 into the callee's stack frame.
18108 A backchain may be needed to allow debugging using tools that do not understand
18109 DWARF 2 call frame information.
18110 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
18111 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
18112 the backchain is placed into the topmost word of the 96/160 byte register
18113 save area.
18115 In general, code compiled with @option{-mbackchain} is call-compatible with
18116 code compiled with @option{-mmo-backchain}; however, use of the backchain
18117 for debugging purposes usually requires that the whole binary is built with
18118 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
18119 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
18120 to build a linux kernel use @option{-msoft-float}.
18122 The default is to not maintain the backchain.
18124 @item -mpacked-stack
18125 @itemx -mno-packed-stack
18126 @opindex mpacked-stack
18127 @opindex mno-packed-stack
18128 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
18129 specified, the compiler uses the all fields of the 96/160 byte register save
18130 area only for their default purpose; unused fields still take up stack space.
18131 When @option{-mpacked-stack} is specified, register save slots are densely
18132 packed at the top of the register save area; unused space is reused for other
18133 purposes, allowing for more efficient use of the available stack space.
18134 However, when @option{-mbackchain} is also in effect, the topmost word of
18135 the save area is always used to store the backchain, and the return address
18136 register is always saved two words below the backchain.
18138 As long as the stack frame backchain is not used, code generated with
18139 @option{-mpacked-stack} is call-compatible with code generated with
18140 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
18141 S/390 or zSeries generated code that uses the stack frame backchain at run
18142 time, not just for debugging purposes.  Such code is not call-compatible
18143 with code compiled with @option{-mpacked-stack}.  Also, note that the
18144 combination of @option{-mbackchain},
18145 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
18146 to build a linux kernel use @option{-msoft-float}.
18148 The default is to not use the packed stack layout.
18150 @item -msmall-exec
18151 @itemx -mno-small-exec
18152 @opindex msmall-exec
18153 @opindex mno-small-exec
18154 Generate (or do not generate) code using the @code{bras} instruction
18155 to do subroutine calls.
18156 This only works reliably if the total executable size does not
18157 exceed 64k.  The default is to use the @code{basr} instruction instead,
18158 which does not have this limitation.
18160 @item -m64
18161 @itemx -m31
18162 @opindex m64
18163 @opindex m31
18164 When @option{-m31} is specified, generate code compliant to the
18165 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
18166 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
18167 particular to generate 64-bit instructions.  For the @samp{s390}
18168 targets, the default is @option{-m31}, while the @samp{s390x}
18169 targets default to @option{-m64}.
18171 @item -mzarch
18172 @itemx -mesa
18173 @opindex mzarch
18174 @opindex mesa
18175 When @option{-mzarch} is specified, generate code using the
18176 instructions available on z/Architecture.
18177 When @option{-mesa} is specified, generate code using the
18178 instructions available on ESA/390.  Note that @option{-mesa} is
18179 not possible with @option{-m64}.
18180 When generating code compliant to the GNU/Linux for S/390 ABI,
18181 the default is @option{-mesa}.  When generating code compliant
18182 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
18184 @item -mmvcle
18185 @itemx -mno-mvcle
18186 @opindex mmvcle
18187 @opindex mno-mvcle
18188 Generate (or do not generate) code using the @code{mvcle} instruction
18189 to perform block moves.  When @option{-mno-mvcle} is specified,
18190 use a @code{mvc} loop instead.  This is the default unless optimizing for
18191 size.
18193 @item -mdebug
18194 @itemx -mno-debug
18195 @opindex mdebug
18196 @opindex mno-debug
18197 Print (or do not print) additional debug information when compiling.
18198 The default is to not print debug information.
18200 @item -march=@var{cpu-type}
18201 @opindex march
18202 Generate code that runs on @var{cpu-type}, which is the name of a system
18203 representing a certain processor type.  Possible values for
18204 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
18205 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
18206 When generating code using the instructions available on z/Architecture,
18207 the default is @option{-march=z900}.  Otherwise, the default is
18208 @option{-march=g5}.
18210 @item -mtune=@var{cpu-type}
18211 @opindex mtune
18212 Tune to @var{cpu-type} everything applicable about the generated code,
18213 except for the ABI and the set of available instructions.
18214 The list of @var{cpu-type} values is the same as for @option{-march}.
18215 The default is the value used for @option{-march}.
18217 @item -mtpf-trace
18218 @itemx -mno-tpf-trace
18219 @opindex mtpf-trace
18220 @opindex mno-tpf-trace
18221 Generate code that adds (does not add) in TPF OS specific branches to trace
18222 routines in the operating system.  This option is off by default, even
18223 when compiling for the TPF OS@.
18225 @item -mfused-madd
18226 @itemx -mno-fused-madd
18227 @opindex mfused-madd
18228 @opindex mno-fused-madd
18229 Generate code that uses (does not use) the floating-point multiply and
18230 accumulate instructions.  These instructions are generated by default if
18231 hardware floating point is used.
18233 @item -mwarn-framesize=@var{framesize}
18234 @opindex mwarn-framesize
18235 Emit a warning if the current function exceeds the given frame size.  Because
18236 this is a compile-time check it doesn't need to be a real problem when the program
18237 runs.  It is intended to identify functions that most probably cause
18238 a stack overflow.  It is useful to be used in an environment with limited stack
18239 size e.g.@: the linux kernel.
18241 @item -mwarn-dynamicstack
18242 @opindex mwarn-dynamicstack
18243 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
18244 arrays.  This is generally a bad idea with a limited stack size.
18246 @item -mstack-guard=@var{stack-guard}
18247 @itemx -mstack-size=@var{stack-size}
18248 @opindex mstack-guard
18249 @opindex mstack-size
18250 If these options are provided the S/390 back end emits additional instructions in
18251 the function prologue that trigger a trap if the stack size is @var{stack-guard}
18252 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
18253 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
18254 the frame size of the compiled function is chosen.
18255 These options are intended to be used to help debugging stack overflow problems.
18256 The additionally emitted code causes only little overhead and hence can also be
18257 used in production-like systems without greater performance degradation.  The given
18258 values have to be exact powers of 2 and @var{stack-size} has to be greater than
18259 @var{stack-guard} without exceeding 64k.
18260 In order to be efficient the extra code makes the assumption that the stack starts
18261 at an address aligned to the value given by @var{stack-size}.
18262 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
18263 @end table
18265 @node Score Options
18266 @subsection Score Options
18267 @cindex Score Options
18269 These options are defined for Score implementations:
18271 @table @gcctabopt
18272 @item -meb
18273 @opindex meb
18274 Compile code for big-endian mode.  This is the default.
18276 @item -mel
18277 @opindex mel
18278 Compile code for little-endian mode.
18280 @item -mnhwloop
18281 @opindex mnhwloop
18282 Disable generation of @code{bcnz} instructions.
18284 @item -muls
18285 @opindex muls
18286 Enable generation of unaligned load and store instructions.
18288 @item -mmac
18289 @opindex mmac
18290 Enable the use of multiply-accumulate instructions. Disabled by default.
18292 @item -mscore5
18293 @opindex mscore5
18294 Specify the SCORE5 as the target architecture.
18296 @item -mscore5u
18297 @opindex mscore5u
18298 Specify the SCORE5U of the target architecture.
18300 @item -mscore7
18301 @opindex mscore7
18302 Specify the SCORE7 as the target architecture. This is the default.
18304 @item -mscore7d
18305 @opindex mscore7d
18306 Specify the SCORE7D as the target architecture.
18307 @end table
18309 @node SH Options
18310 @subsection SH Options
18312 These @samp{-m} options are defined for the SH implementations:
18314 @table @gcctabopt
18315 @item -m1
18316 @opindex m1
18317 Generate code for the SH1.
18319 @item -m2
18320 @opindex m2
18321 Generate code for the SH2.
18323 @item -m2e
18324 Generate code for the SH2e.
18326 @item -m2a-nofpu
18327 @opindex m2a-nofpu
18328 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
18329 that the floating-point unit is not used.
18331 @item -m2a-single-only
18332 @opindex m2a-single-only
18333 Generate code for the SH2a-FPU, in such a way that no double-precision
18334 floating-point operations are used.
18336 @item -m2a-single
18337 @opindex m2a-single
18338 Generate code for the SH2a-FPU assuming the floating-point unit is in
18339 single-precision mode by default.
18341 @item -m2a
18342 @opindex m2a
18343 Generate code for the SH2a-FPU assuming the floating-point unit is in
18344 double-precision mode by default.
18346 @item -m3
18347 @opindex m3
18348 Generate code for the SH3.
18350 @item -m3e
18351 @opindex m3e
18352 Generate code for the SH3e.
18354 @item -m4-nofpu
18355 @opindex m4-nofpu
18356 Generate code for the SH4 without a floating-point unit.
18358 @item -m4-single-only
18359 @opindex m4-single-only
18360 Generate code for the SH4 with a floating-point unit that only
18361 supports single-precision arithmetic.
18363 @item -m4-single
18364 @opindex m4-single
18365 Generate code for the SH4 assuming the floating-point unit is in
18366 single-precision mode by default.
18368 @item -m4
18369 @opindex m4
18370 Generate code for the SH4.
18372 @item -m4a-nofpu
18373 @opindex m4a-nofpu
18374 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
18375 floating-point unit is not used.
18377 @item -m4a-single-only
18378 @opindex m4a-single-only
18379 Generate code for the SH4a, in such a way that no double-precision
18380 floating-point operations are used.
18382 @item -m4a-single
18383 @opindex m4a-single
18384 Generate code for the SH4a assuming the floating-point unit is in
18385 single-precision mode by default.
18387 @item -m4a
18388 @opindex m4a
18389 Generate code for the SH4a.
18391 @item -m4al
18392 @opindex m4al
18393 Same as @option{-m4a-nofpu}, except that it implicitly passes
18394 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
18395 instructions at the moment.
18397 @item -mb
18398 @opindex mb
18399 Compile code for the processor in big-endian mode.
18401 @item -ml
18402 @opindex ml
18403 Compile code for the processor in little-endian mode.
18405 @item -mdalign
18406 @opindex mdalign
18407 Align doubles at 64-bit boundaries.  Note that this changes the calling
18408 conventions, and thus some functions from the standard C library do
18409 not work unless you recompile it first with @option{-mdalign}.
18411 @item -mrelax
18412 @opindex mrelax
18413 Shorten some address references at link time, when possible; uses the
18414 linker option @option{-relax}.
18416 @item -mbigtable
18417 @opindex mbigtable
18418 Use 32-bit offsets in @code{switch} tables.  The default is to use
18419 16-bit offsets.
18421 @item -mbitops
18422 @opindex mbitops
18423 Enable the use of bit manipulation instructions on SH2A.
18425 @item -mfmovd
18426 @opindex mfmovd
18427 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
18428 alignment constraints.
18430 @item -mhitachi
18431 @opindex mhitachi
18432 Comply with the calling conventions defined by Renesas.
18434 @item -mrenesas
18435 @opindex mhitachi
18436 Comply with the calling conventions defined by Renesas.
18438 @item -mno-renesas
18439 @opindex mhitachi
18440 Comply with the calling conventions defined for GCC before the Renesas
18441 conventions were available.  This option is the default for all
18442 targets of the SH toolchain.
18444 @item -mnomacsave
18445 @opindex mnomacsave
18446 Mark the @code{MAC} register as call-clobbered, even if
18447 @option{-mhitachi} is given.
18449 @item -mieee
18450 @item -mno-ieee
18451 @opindex mieee
18452 @opindex mnoieee
18453 Control the IEEE compliance of floating-point comparisons, which affects the
18454 handling of cases where the result of a comparison is unordered.  By default
18455 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
18456 enabled @option{-mno-ieee} is implicitly set, which results in faster
18457 floating-point greater-equal and less-equal comparisons.  The implcit settings
18458 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
18460 @item -minline-ic_invalidate
18461 @opindex minline-ic_invalidate
18462 Inline code to invalidate instruction cache entries after setting up
18463 nested function trampolines.
18464 This option has no effect if @option{-musermode} is in effect and the selected
18465 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
18466 instruction.
18467 If the selected code generation option does not allow the use of the @code{icbi}
18468 instruction, and @option{-musermode} is not in effect, the inlined code
18469 manipulates the instruction cache address array directly with an associative
18470 write.  This not only requires privileged mode at run time, but it also
18471 fails if the cache line had been mapped via the TLB and has become unmapped.
18473 @item -misize
18474 @opindex misize
18475 Dump instruction size and location in the assembly code.
18477 @item -mpadstruct
18478 @opindex mpadstruct
18479 This option is deprecated.  It pads structures to multiple of 4 bytes,
18480 which is incompatible with the SH ABI@.
18482 @item -matomic-model=@var{model}
18483 @opindex matomic-model=@var{model}
18484 Sets the model of atomic operations and additional parameters as a comma
18485 separated list.  For details on the atomic built-in functions see
18486 @ref{__atomic Builtins}.  The following models and parameters are supported:
18488 @table @samp
18490 @item none
18491 Disable compiler generated atomic sequences and emit library calls for atomic
18492 operations.  This is the default if the target is not @code{sh-*-linux*}.
18494 @item soft-gusa
18495 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18496 built-in functions.  The generated atomic sequences require additional support
18497 from the interrupt/exception handling code of the system and are only suitable
18498 for SH3* and SH4* single-core systems.  This option is enabled by default when
18499 the target is @code{sh-*-linux*} and SH3* or SH4*.  When the target is SH4A,
18500 this option will also partially utilize the hardware atomic instructions
18501 @code{movli.l} and @code{movco.l} to create more efficient code, unless
18502 @samp{strict} is specified.  
18504 @item soft-tcb
18505 Generate software atomic sequences that use a variable in the thread control
18506 block.  This is a variation of the gUSA sequences which can also be used on
18507 SH1* and SH2* targets.  The generated atomic sequences require additional
18508 support from the interrupt/exception handling code of the system and are only
18509 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
18510 parameter has to be specified as well.
18512 @item soft-imask
18513 Generate software atomic sequences that temporarily disable interrupts by
18514 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
18515 in privileged mode and is only suitable for single-core systems.  Additional
18516 support from the interrupt/exception handling code of the system is not
18517 required.  This model is enabled by default when the target is
18518 @code{sh-*-linux*} and SH1* or SH2*.
18520 @item hard-llcs
18521 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
18522 instructions only.  This is only available on SH4A and is suitable for
18523 multi-core systems.  Since the hardware instructions support only 32 bit atomic
18524 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
18525 Code compiled with this option will also be compatible with other software
18526 atomic model interrupt/exception handling systems if executed on an SH4A
18527 system.  Additional support from the interrupt/exception handling code of the
18528 system is not required for this model.
18530 @item gbr-offset=
18531 This parameter specifies the offset in bytes of the variable in the thread
18532 control block structure that should be used by the generated atomic sequences
18533 when the @samp{soft-tcb} model has been selected.  For other models this
18534 parameter is ignored.  The specified value must be an integer multiple of four
18535 and in the range 0-1020.
18537 @item strict
18538 This parameter prevents mixed usage of multiple atomic models, even though they
18539 would be compatible, and will make the compiler generate atomic sequences of the
18540 specified model only.
18542 @end table
18544 @item -mtas
18545 @opindex mtas
18546 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
18547 Notice that depending on the particular hardware and software configuration
18548 this can degrade overall performance due to the operand cache line flushes
18549 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
18550 processors the @code{tas.b} instruction must be used with caution since it
18551 can result in data corruption for certain cache configurations.
18553 @item -mspace
18554 @opindex mspace
18555 Optimize for space instead of speed.  Implied by @option{-Os}.
18557 @item -mprefergot
18558 @opindex mprefergot
18559 When generating position-independent code, emit function calls using
18560 the Global Offset Table instead of the Procedure Linkage Table.
18562 @item -musermode
18563 @opindex musermode
18564 Don't generate privileged mode only code.  This option
18565 implies @option{-mno-inline-ic_invalidate}
18566 if the inlined code would not work in user mode.
18567 This is the default when the target is @code{sh-*-linux*}.
18569 @item -multcost=@var{number}
18570 @opindex multcost=@var{number}
18571 Set the cost to assume for a multiply insn.
18573 @item -mdiv=@var{strategy}
18574 @opindex mdiv=@var{strategy}
18575 Set the division strategy to use for SHmedia code.  @var{strategy} must be
18576 one of: 
18578 @table @samp
18580 @item fp 
18581 Performs the operation in floating point.  This has a very high latency,
18582 but needs only a few instructions, so it might be a good choice if
18583 your code has enough easily-exploitable ILP to allow the compiler to
18584 schedule the floating-point instructions together with other instructions.
18585 Division by zero causes a floating-point exception.
18587 @item inv
18588 Uses integer operations to calculate the inverse of the divisor,
18589 and then multiplies the dividend with the inverse.  This strategy allows
18590 CSE and hoisting of the inverse calculation.  Division by zero calculates
18591 an unspecified result, but does not trap.
18593 @item inv:minlat
18594 A variant of @samp{inv} where, if no CSE or hoisting opportunities
18595 have been found, or if the entire operation has been hoisted to the same
18596 place, the last stages of the inverse calculation are intertwined with the
18597 final multiply to reduce the overall latency, at the expense of using a few
18598 more instructions, and thus offering fewer scheduling opportunities with
18599 other code.
18601 @item call
18602 Calls a library function that usually implements the @samp{inv:minlat}
18603 strategy.
18604 This gives high code density for @code{m5-*media-nofpu} compilations.
18606 @item call2
18607 Uses a different entry point of the same library function, where it
18608 assumes that a pointer to a lookup table has already been set up, which
18609 exposes the pointer load to CSE and code hoisting optimizations.
18611 @item inv:call
18612 @itemx inv:call2
18613 @itemx inv:fp
18614 Use the @samp{inv} algorithm for initial
18615 code generation, but if the code stays unoptimized, revert to the @samp{call},
18616 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
18617 potentially-trapping side effect of division by zero is carried by a
18618 separate instruction, so it is possible that all the integer instructions
18619 are hoisted out, but the marker for the side effect stays where it is.
18620 A recombination to floating-point operations or a call is not possible
18621 in that case.
18623 @item inv20u
18624 @itemx inv20l
18625 Variants of the @samp{inv:minlat} strategy.  In the case
18626 that the inverse calculation is not separated from the multiply, they speed
18627 up division where the dividend fits into 20 bits (plus sign where applicable)
18628 by inserting a test to skip a number of operations in this case; this test
18629 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
18630 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
18632 @end table
18634 @item -maccumulate-outgoing-args
18635 @opindex maccumulate-outgoing-args
18636 Reserve space once for outgoing arguments in the function prologue rather
18637 than around each call.  Generally beneficial for performance and size.  Also
18638 needed for unwinding to avoid changing the stack frame around conditional code.
18640 @item -mdivsi3_libfunc=@var{name}
18641 @opindex mdivsi3_libfunc=@var{name}
18642 Set the name of the library function used for 32-bit signed division to
18643 @var{name}.
18644 This only affects the name used in the @samp{call} and @samp{inv:call}
18645 division strategies, and the compiler still expects the same
18646 sets of input/output/clobbered registers as if this option were not present.
18648 @item -mfixed-range=@var{register-range}
18649 @opindex mfixed-range
18650 Generate code treating the given register range as fixed registers.
18651 A fixed register is one that the register allocator can not use.  This is
18652 useful when compiling kernel code.  A register range is specified as
18653 two registers separated by a dash.  Multiple register ranges can be
18654 specified separated by a comma.
18656 @item -mindexed-addressing
18657 @opindex mindexed-addressing
18658 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
18659 This is only safe if the hardware and/or OS implement 32-bit wrap-around
18660 semantics for the indexed addressing mode.  The architecture allows the
18661 implementation of processors with 64-bit MMU, which the OS could use to
18662 get 32-bit addressing, but since no current hardware implementation supports
18663 this or any other way to make the indexed addressing mode safe to use in
18664 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
18666 @item -mgettrcost=@var{number}
18667 @opindex mgettrcost=@var{number}
18668 Set the cost assumed for the @code{gettr} instruction to @var{number}.
18669 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
18671 @item -mpt-fixed
18672 @opindex mpt-fixed
18673 Assume @code{pt*} instructions won't trap.  This generally generates
18674 better-scheduled code, but is unsafe on current hardware.
18675 The current architecture
18676 definition says that @code{ptabs} and @code{ptrel} trap when the target 
18677 anded with 3 is 3.
18678 This has the unintentional effect of making it unsafe to schedule these
18679 instructions before a branch, or hoist them out of a loop.  For example,
18680 @code{__do_global_ctors}, a part of @file{libgcc}
18681 that runs constructors at program
18682 startup, calls functions in a list which is delimited by @minus{}1.  With the
18683 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
18684 That means that all the constructors run a bit more quickly, but when
18685 the loop comes to the end of the list, the program crashes because @code{ptabs}
18686 loads @minus{}1 into a target register.  
18688 Since this option is unsafe for any
18689 hardware implementing the current architecture specification, the default
18690 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
18691 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
18692 this deters register allocation from using target registers for storing
18693 ordinary integers.
18695 @item -minvalid-symbols
18696 @opindex minvalid-symbols
18697 Assume symbols might be invalid.  Ordinary function symbols generated by
18698 the compiler are always valid to load with
18699 @code{movi}/@code{shori}/@code{ptabs} or
18700 @code{movi}/@code{shori}/@code{ptrel},
18701 but with assembler and/or linker tricks it is possible
18702 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
18703 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
18704 It prevents cross-basic-block CSE, hoisting and most scheduling
18705 of symbol loads.  The default is @option{-mno-invalid-symbols}.
18707 @item -mbranch-cost=@var{num}
18708 @opindex mbranch-cost=@var{num}
18709 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
18710 make the compiler try to generate more branch-free code if possible.  
18711 If not specified the value is selected depending on the processor type that
18712 is being compiled for.
18714 @item -mzdcbranch
18715 @itemx -mno-zdcbranch
18716 @opindex mzdcbranch
18717 @opindex mno-zdcbranch
18718 Assume (do not assume) that zero displacement conditional branch instructions
18719 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
18720 compiler will try to prefer zero displacement branch code sequences.  This is
18721 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
18722 disabled by specifying @option{-mno-zdcbranch}.
18724 @item -mcbranchdi
18725 @opindex mcbranchdi
18726 Enable the @code{cbranchdi4} instruction pattern.
18728 @item -mcmpeqdi
18729 @opindex mcmpeqdi
18730 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
18731 is in effect.
18733 @item -mfused-madd
18734 @itemx -mno-fused-madd
18735 @opindex mfused-madd
18736 @opindex mno-fused-madd
18737 Generate code that uses (does not use) the floating-point multiply and
18738 accumulate instructions.  These instructions are generated by default
18739 if hardware floating point is used.  The machine-dependent
18740 @option{-mfused-madd} option is now mapped to the machine-independent
18741 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
18742 mapped to @option{-ffp-contract=off}.
18744 @item -mfsca
18745 @itemx -mno-fsca
18746 @opindex mfsca
18747 @opindex mno-fsca
18748 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
18749 and cosine approximations.  The option @code{-mfsca} must be used in
18750 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
18751 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
18752 approximations even if @code{-funsafe-math-optimizations} is in effect.
18754 @item -mfsrra
18755 @itemx -mno-fsrra
18756 @opindex mfsrra
18757 @opindex mno-fsrra
18758 Allow or disallow the compiler to emit the @code{fsrra} instruction for
18759 reciprocal square root approximations.  The option @code{-mfsrra} must be used
18760 in combination with @code{-funsafe-math-optimizations} and
18761 @code{-ffinite-math-only}.  It is enabled by default when generating code for
18762 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
18763 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
18764 in effect.
18766 @item -mpretend-cmove
18767 @opindex mpretend-cmove
18768 Prefer zero-displacement conditional branches for conditional move instruction
18769 patterns.  This can result in faster code on the SH4 processor.
18771 @end table
18773 @node Solaris 2 Options
18774 @subsection Solaris 2 Options
18775 @cindex Solaris 2 options
18777 These @samp{-m} options are supported on Solaris 2:
18779 @table @gcctabopt
18780 @item -mimpure-text
18781 @opindex mimpure-text
18782 @option{-mimpure-text}, used in addition to @option{-shared}, tells
18783 the compiler to not pass @option{-z text} to the linker when linking a
18784 shared object.  Using this option, you can link position-dependent
18785 code into a shared object.
18787 @option{-mimpure-text} suppresses the ``relocations remain against
18788 allocatable but non-writable sections'' linker error message.
18789 However, the necessary relocations trigger copy-on-write, and the
18790 shared object is not actually shared across processes.  Instead of
18791 using @option{-mimpure-text}, you should compile all source code with
18792 @option{-fpic} or @option{-fPIC}.
18794 @end table
18796 These switches are supported in addition to the above on Solaris 2:
18798 @table @gcctabopt
18799 @item -pthreads
18800 @opindex pthreads
18801 Add support for multithreading using the POSIX threads library.  This
18802 option sets flags for both the preprocessor and linker.  This option does
18803 not affect the thread safety of object code produced  by the compiler or
18804 that of libraries supplied with it.
18806 @item -pthread
18807 @opindex pthread
18808 This is a synonym for @option{-pthreads}.
18809 @end table
18811 @node SPARC Options
18812 @subsection SPARC Options
18813 @cindex SPARC options
18815 These @samp{-m} options are supported on the SPARC:
18817 @table @gcctabopt
18818 @item -mno-app-regs
18819 @itemx -mapp-regs
18820 @opindex mno-app-regs
18821 @opindex mapp-regs
18822 Specify @option{-mapp-regs} to generate output using the global registers
18823 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
18824 is the default.
18826 To be fully SVR4 ABI-compliant at the cost of some performance loss,
18827 specify @option{-mno-app-regs}.  You should compile libraries and system
18828 software with this option.
18830 @item -mflat
18831 @itemx -mno-flat
18832 @opindex mflat
18833 @opindex mno-flat
18834 With @option{-mflat}, the compiler does not generate save/restore instructions
18835 and uses a ``flat'' or single register window model.  This model is compatible
18836 with the regular register window model.  The local registers and the input
18837 registers (0--5) are still treated as ``call-saved'' registers and are
18838 saved on the stack as needed.
18840 With @option{-mno-flat} (the default), the compiler generates save/restore
18841 instructions (except for leaf functions).  This is the normal operating mode.
18843 @item -mfpu
18844 @itemx -mhard-float
18845 @opindex mfpu
18846 @opindex mhard-float
18847 Generate output containing floating-point instructions.  This is the
18848 default.
18850 @item -mno-fpu
18851 @itemx -msoft-float
18852 @opindex mno-fpu
18853 @opindex msoft-float
18854 Generate output containing library calls for floating point.
18855 @strong{Warning:} the requisite libraries are not available for all SPARC
18856 targets.  Normally the facilities of the machine's usual C compiler are
18857 used, but this cannot be done directly in cross-compilation.  You must make
18858 your own arrangements to provide suitable library functions for
18859 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
18860 @samp{sparclite-*-*} do provide software floating-point support.
18862 @option{-msoft-float} changes the calling convention in the output file;
18863 therefore, it is only useful if you compile @emph{all} of a program with
18864 this option.  In particular, you need to compile @file{libgcc.a}, the
18865 library that comes with GCC, with @option{-msoft-float} in order for
18866 this to work.
18868 @item -mhard-quad-float
18869 @opindex mhard-quad-float
18870 Generate output containing quad-word (long double) floating-point
18871 instructions.
18873 @item -msoft-quad-float
18874 @opindex msoft-quad-float
18875 Generate output containing library calls for quad-word (long double)
18876 floating-point instructions.  The functions called are those specified
18877 in the SPARC ABI@.  This is the default.
18879 As of this writing, there are no SPARC implementations that have hardware
18880 support for the quad-word floating-point instructions.  They all invoke
18881 a trap handler for one of these instructions, and then the trap handler
18882 emulates the effect of the instruction.  Because of the trap handler overhead,
18883 this is much slower than calling the ABI library routines.  Thus the
18884 @option{-msoft-quad-float} option is the default.
18886 @item -mno-unaligned-doubles
18887 @itemx -munaligned-doubles
18888 @opindex mno-unaligned-doubles
18889 @opindex munaligned-doubles
18890 Assume that doubles have 8-byte alignment.  This is the default.
18892 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
18893 alignment only if they are contained in another type, or if they have an
18894 absolute address.  Otherwise, it assumes they have 4-byte alignment.
18895 Specifying this option avoids some rare compatibility problems with code
18896 generated by other compilers.  It is not the default because it results
18897 in a performance loss, especially for floating-point code.
18899 @item -mno-faster-structs
18900 @itemx -mfaster-structs
18901 @opindex mno-faster-structs
18902 @opindex mfaster-structs
18903 With @option{-mfaster-structs}, the compiler assumes that structures
18904 should have 8-byte alignment.  This enables the use of pairs of
18905 @code{ldd} and @code{std} instructions for copies in structure
18906 assignment, in place of twice as many @code{ld} and @code{st} pairs.
18907 However, the use of this changed alignment directly violates the SPARC
18908 ABI@.  Thus, it's intended only for use on targets where the developer
18909 acknowledges that their resulting code is not directly in line with
18910 the rules of the ABI@.
18912 @item -mcpu=@var{cpu_type}
18913 @opindex mcpu
18914 Set the instruction set, register set, and instruction scheduling parameters
18915 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
18916 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
18917 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
18918 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
18919 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
18920 and @samp{niagara4}.
18922 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
18923 which selects the best architecture option for the host processor.
18924 @option{-mcpu=native} has no effect if GCC does not recognize
18925 the processor.
18927 Default instruction scheduling parameters are used for values that select
18928 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
18929 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
18931 Here is a list of each supported architecture and their supported
18932 implementations.
18934 @table @asis
18935 @item v7
18936 cypress
18938 @item v8
18939 supersparc, hypersparc, leon
18941 @item sparclite
18942 f930, f934, sparclite86x
18944 @item sparclet
18945 tsc701
18947 @item v9
18948 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
18949 @end table
18951 By default (unless configured otherwise), GCC generates code for the V7
18952 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
18953 additionally optimizes it for the Cypress CY7C602 chip, as used in the
18954 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
18955 SPARCStation 1, 2, IPX etc.
18957 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
18958 architecture.  The only difference from V7 code is that the compiler emits
18959 the integer multiply and integer divide instructions which exist in SPARC-V8
18960 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
18961 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
18962 2000 series.
18964 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
18965 the SPARC architecture.  This adds the integer multiply, integer divide step
18966 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
18967 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
18968 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
18969 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
18970 MB86934 chip, which is the more recent SPARClite with FPU@.
18972 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
18973 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
18974 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
18975 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
18976 optimizes it for the TEMIC SPARClet chip.
18978 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
18979 architecture.  This adds 64-bit integer and floating-point move instructions,
18980 3 additional floating-point condition code registers and conditional move
18981 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
18982 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
18983 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
18984 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
18985 @option{-mcpu=niagara}, the compiler additionally optimizes it for
18986 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
18987 additionally optimizes it for Sun UltraSPARC T2 chips. With
18988 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
18989 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
18990 additionally optimizes it for Sun UltraSPARC T4 chips.
18992 @item -mtune=@var{cpu_type}
18993 @opindex mtune
18994 Set the instruction scheduling parameters for machine type
18995 @var{cpu_type}, but do not set the instruction set or register set that the
18996 option @option{-mcpu=@var{cpu_type}} does.
18998 The same values for @option{-mcpu=@var{cpu_type}} can be used for
18999 @option{-mtune=@var{cpu_type}}, but the only useful values are those
19000 that select a particular CPU implementation.  Those are @samp{cypress},
19001 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
19002 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
19003 @samp{niagara}, @samp{niagara2}, @samp{niagara3} and @samp{niagara4}.  With
19004 native Solaris and GNU/Linux toolchains, @samp{native} can also be used.
19006 @item -mv8plus
19007 @itemx -mno-v8plus
19008 @opindex mv8plus
19009 @opindex mno-v8plus
19010 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
19011 difference from the V8 ABI is that the global and out registers are
19012 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
19013 mode for all SPARC-V9 processors.
19015 @item -mvis
19016 @itemx -mno-vis
19017 @opindex mvis
19018 @opindex mno-vis
19019 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
19020 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
19022 @item -mvis2
19023 @itemx -mno-vis2
19024 @opindex mvis2
19025 @opindex mno-vis2
19026 With @option{-mvis2}, GCC generates code that takes advantage of
19027 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
19028 default is @option{-mvis2} when targeting a cpu that supports such
19029 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
19030 also sets @option{-mvis}.
19032 @item -mvis3
19033 @itemx -mno-vis3
19034 @opindex mvis3
19035 @opindex mno-vis3
19036 With @option{-mvis3}, GCC generates code that takes advantage of
19037 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
19038 default is @option{-mvis3} when targeting a cpu that supports such
19039 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
19040 also sets @option{-mvis2} and @option{-mvis}.
19042 @item -mpopc
19043 @itemx -mno-popc
19044 @opindex mpopc
19045 @opindex mno-popc
19046 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
19047 population count instruction.  The default is @option{-mpopc}
19048 when targeting a cpu that supports such instructions, such as Niagara-2 and
19049 later.
19051 @item -mfmaf
19052 @itemx -mno-fmaf
19053 @opindex mfmaf
19054 @opindex mno-fmaf
19055 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
19056 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
19057 when targeting a cpu that supports such instructions, such as Niagara-3 and
19058 later.
19060 @item -mfix-at697f
19061 @opindex mfix-at697f
19062 Enable the documented workaround for the single erratum of the Atmel AT697F
19063 processor (which corresponds to erratum #13 of the AT697E processor).
19064 @end table
19066 These @samp{-m} options are supported in addition to the above
19067 on SPARC-V9 processors in 64-bit environments:
19069 @table @gcctabopt
19070 @item -mlittle-endian
19071 @opindex mlittle-endian
19072 Generate code for a processor running in little-endian mode.  It is only
19073 available for a few configurations and most notably not on Solaris and Linux.
19075 @item -m32
19076 @itemx -m64
19077 @opindex m32
19078 @opindex m64
19079 Generate code for a 32-bit or 64-bit environment.
19080 The 32-bit environment sets int, long and pointer to 32 bits.
19081 The 64-bit environment sets int to 32 bits and long and pointer
19082 to 64 bits.
19084 @item -mcmodel=@var{which}
19085 @opindex mcmodel
19086 Set the code model to one of
19088 @table @samp
19089 @item medlow
19090 The Medium/Low code model: 64-bit addresses, programs
19091 must be linked in the low 32 bits of memory.  Programs can be statically
19092 or dynamically linked.
19094 @item medmid
19095 The Medium/Middle code model: 64-bit addresses, programs
19096 must be linked in the low 44 bits of memory, the text and data segments must
19097 be less than 2GB in size and the data segment must be located within 2GB of
19098 the text segment.
19100 @item medany
19101 The Medium/Anywhere code model: 64-bit addresses, programs
19102 may be linked anywhere in memory, the text and data segments must be less
19103 than 2GB in size and the data segment must be located within 2GB of the
19104 text segment.
19106 @item embmedany
19107 The Medium/Anywhere code model for embedded systems:
19108 64-bit addresses, the text and data segments must be less than 2GB in
19109 size, both starting anywhere in memory (determined at link time).  The
19110 global register %g4 points to the base of the data segment.  Programs
19111 are statically linked and PIC is not supported.
19112 @end table
19114 @item -mmemory-model=@var{mem-model}
19115 @opindex mmemory-model
19116 Set the memory model in force on the processor to one of
19118 @table @samp
19119 @item default
19120 The default memory model for the processor and operating system.
19122 @item rmo
19123 Relaxed Memory Order
19125 @item pso
19126 Partial Store Order
19128 @item tso
19129 Total Store Order
19131 @item sc
19132 Sequential Consistency
19133 @end table
19135 These memory models are formally defined in Appendix D of the Sparc V9
19136 architecture manual, as set in the processor's @code{PSTATE.MM} field.
19138 @item -mstack-bias
19139 @itemx -mno-stack-bias
19140 @opindex mstack-bias
19141 @opindex mno-stack-bias
19142 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
19143 frame pointer if present, are offset by @minus{}2047 which must be added back
19144 when making stack frame references.  This is the default in 64-bit mode.
19145 Otherwise, assume no such offset is present.
19146 @end table
19148 @node SPU Options
19149 @subsection SPU Options
19150 @cindex SPU options
19152 These @samp{-m} options are supported on the SPU:
19154 @table @gcctabopt
19155 @item -mwarn-reloc
19156 @itemx -merror-reloc
19157 @opindex mwarn-reloc
19158 @opindex merror-reloc
19160 The loader for SPU does not handle dynamic relocations.  By default, GCC
19161 gives an error when it generates code that requires a dynamic
19162 relocation.  @option{-mno-error-reloc} disables the error,
19163 @option{-mwarn-reloc} generates a warning instead.
19165 @item -msafe-dma
19166 @itemx -munsafe-dma
19167 @opindex msafe-dma
19168 @opindex munsafe-dma
19170 Instructions that initiate or test completion of DMA must not be
19171 reordered with respect to loads and stores of the memory that is being
19172 accessed.
19173 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
19174 memory accesses, but that can lead to inefficient code in places where the
19175 memory is known to not change.  Rather than mark the memory as volatile,
19176 you can use @option{-msafe-dma} to tell the compiler to treat
19177 the DMA instructions as potentially affecting all memory.  
19179 @item -mbranch-hints
19180 @opindex mbranch-hints
19182 By default, GCC generates a branch hint instruction to avoid
19183 pipeline stalls for always-taken or probably-taken branches.  A hint
19184 is not generated closer than 8 instructions away from its branch.
19185 There is little reason to disable them, except for debugging purposes,
19186 or to make an object a little bit smaller.
19188 @item -msmall-mem
19189 @itemx -mlarge-mem
19190 @opindex msmall-mem
19191 @opindex mlarge-mem
19193 By default, GCC generates code assuming that addresses are never larger
19194 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
19195 a full 32-bit address.
19197 @item -mstdmain
19198 @opindex mstdmain
19200 By default, GCC links against startup code that assumes the SPU-style
19201 main function interface (which has an unconventional parameter list).
19202 With @option{-mstdmain}, GCC links your program against startup
19203 code that assumes a C99-style interface to @code{main}, including a
19204 local copy of @code{argv} strings.
19206 @item -mfixed-range=@var{register-range}
19207 @opindex mfixed-range
19208 Generate code treating the given register range as fixed registers.
19209 A fixed register is one that the register allocator cannot use.  This is
19210 useful when compiling kernel code.  A register range is specified as
19211 two registers separated by a dash.  Multiple register ranges can be
19212 specified separated by a comma.
19214 @item -mea32
19215 @itemx -mea64
19216 @opindex mea32
19217 @opindex mea64
19218 Compile code assuming that pointers to the PPU address space accessed
19219 via the @code{__ea} named address space qualifier are either 32 or 64
19220 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
19221 all object code in an executable must be compiled with the same setting.
19223 @item -maddress-space-conversion
19224 @itemx -mno-address-space-conversion
19225 @opindex maddress-space-conversion
19226 @opindex mno-address-space-conversion
19227 Allow/disallow treating the @code{__ea} address space as superset
19228 of the generic address space.  This enables explicit type casts
19229 between @code{__ea} and generic pointer as well as implicit
19230 conversions of generic pointers to @code{__ea} pointers.  The
19231 default is to allow address space pointer conversions.
19233 @item -mcache-size=@var{cache-size}
19234 @opindex mcache-size
19235 This option controls the version of libgcc that the compiler links to an
19236 executable and selects a software-managed cache for accessing variables
19237 in the @code{__ea} address space with a particular cache size.  Possible
19238 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
19239 and @samp{128}.  The default cache size is 64KB.
19241 @item -matomic-updates
19242 @itemx -mno-atomic-updates
19243 @opindex matomic-updates
19244 @opindex mno-atomic-updates
19245 This option controls the version of libgcc that the compiler links to an
19246 executable and selects whether atomic updates to the software-managed
19247 cache of PPU-side variables are used.  If you use atomic updates, changes
19248 to a PPU variable from SPU code using the @code{__ea} named address space
19249 qualifier do not interfere with changes to other PPU variables residing
19250 in the same cache line from PPU code.  If you do not use atomic updates,
19251 such interference may occur; however, writing back cache lines is
19252 more efficient.  The default behavior is to use atomic updates.
19254 @item -mdual-nops
19255 @itemx -mdual-nops=@var{n}
19256 @opindex mdual-nops
19257 By default, GCC inserts nops to increase dual issue when it expects
19258 it to increase performance.  @var{n} can be a value from 0 to 10.  A
19259 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
19260 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
19262 @item -mhint-max-nops=@var{n}
19263 @opindex mhint-max-nops
19264 Maximum number of nops to insert for a branch hint.  A branch hint must
19265 be at least 8 instructions away from the branch it is affecting.  GCC
19266 inserts up to @var{n} nops to enforce this, otherwise it does not
19267 generate the branch hint.
19269 @item -mhint-max-distance=@var{n}
19270 @opindex mhint-max-distance
19271 The encoding of the branch hint instruction limits the hint to be within
19272 256 instructions of the branch it is affecting.  By default, GCC makes
19273 sure it is within 125.
19275 @item -msafe-hints
19276 @opindex msafe-hints
19277 Work around a hardware bug that causes the SPU to stall indefinitely.
19278 By default, GCC inserts the @code{hbrp} instruction to make sure
19279 this stall won't happen.
19281 @end table
19283 @node System V Options
19284 @subsection Options for System V
19286 These additional options are available on System V Release 4 for
19287 compatibility with other compilers on those systems:
19289 @table @gcctabopt
19290 @item -G
19291 @opindex G
19292 Create a shared object.
19293 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
19295 @item -Qy
19296 @opindex Qy
19297 Identify the versions of each tool used by the compiler, in a
19298 @code{.ident} assembler directive in the output.
19300 @item -Qn
19301 @opindex Qn
19302 Refrain from adding @code{.ident} directives to the output file (this is
19303 the default).
19305 @item -YP,@var{dirs}
19306 @opindex YP
19307 Search the directories @var{dirs}, and no others, for libraries
19308 specified with @option{-l}.
19310 @item -Ym,@var{dir}
19311 @opindex Ym
19312 Look in the directory @var{dir} to find the M4 preprocessor.
19313 The assembler uses this option.
19314 @c This is supposed to go with a -Yd for predefined M4 macro files, but
19315 @c the generic assembler that comes with Solaris takes just -Ym.
19316 @end table
19318 @node TILE-Gx Options
19319 @subsection TILE-Gx Options
19320 @cindex TILE-Gx options
19322 These @samp{-m} options are supported on the TILE-Gx:
19324 @table @gcctabopt
19325 @item -mcmodel=small
19326 @opindex mcmodel=small
19327 Generate code for the small model.  The distance for direct calls is
19328 limited to 500M in either direction.  PC-relative addresses are 32
19329 bits.  Absolute addresses support the full address range.
19331 @item -mcmodel=large
19332 @opindex mcmodel=large
19333 Generate code for the large model.  There is no limitation on call
19334 distance, pc-relative addresses, or absolute addresses.
19336 @item -mcpu=@var{name}
19337 @opindex mcpu
19338 Selects the type of CPU to be targeted.  Currently the only supported
19339 type is @samp{tilegx}.
19341 @item -m32
19342 @itemx -m64
19343 @opindex m32
19344 @opindex m64
19345 Generate code for a 32-bit or 64-bit environment.  The 32-bit
19346 environment sets int, long, and pointer to 32 bits.  The 64-bit
19347 environment sets int to 32 bits and long and pointer to 64 bits.
19348 @end table
19350 @node TILEPro Options
19351 @subsection TILEPro Options
19352 @cindex TILEPro options
19354 These @samp{-m} options are supported on the TILEPro:
19356 @table @gcctabopt
19357 @item -mcpu=@var{name}
19358 @opindex mcpu
19359 Selects the type of CPU to be targeted.  Currently the only supported
19360 type is @samp{tilepro}.
19362 @item -m32
19363 @opindex m32
19364 Generate code for a 32-bit environment, which sets int, long, and
19365 pointer to 32 bits.  This is the only supported behavior so the flag
19366 is essentially ignored.
19367 @end table
19369 @node V850 Options
19370 @subsection V850 Options
19371 @cindex V850 Options
19373 These @samp{-m} options are defined for V850 implementations:
19375 @table @gcctabopt
19376 @item -mlong-calls
19377 @itemx -mno-long-calls
19378 @opindex mlong-calls
19379 @opindex mno-long-calls
19380 Treat all calls as being far away (near).  If calls are assumed to be
19381 far away, the compiler always loads the function's address into a
19382 register, and calls indirect through the pointer.
19384 @item -mno-ep
19385 @itemx -mep
19386 @opindex mno-ep
19387 @opindex mep
19388 Do not optimize (do optimize) basic blocks that use the same index
19389 pointer 4 or more times to copy pointer into the @code{ep} register, and
19390 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
19391 option is on by default if you optimize.
19393 @item -mno-prolog-function
19394 @itemx -mprolog-function
19395 @opindex mno-prolog-function
19396 @opindex mprolog-function
19397 Do not use (do use) external functions to save and restore registers
19398 at the prologue and epilogue of a function.  The external functions
19399 are slower, but use less code space if more than one function saves
19400 the same number of registers.  The @option{-mprolog-function} option
19401 is on by default if you optimize.
19403 @item -mspace
19404 @opindex mspace
19405 Try to make the code as small as possible.  At present, this just turns
19406 on the @option{-mep} and @option{-mprolog-function} options.
19408 @item -mtda=@var{n}
19409 @opindex mtda
19410 Put static or global variables whose size is @var{n} bytes or less into
19411 the tiny data area that register @code{ep} points to.  The tiny data
19412 area can hold up to 256 bytes in total (128 bytes for byte references).
19414 @item -msda=@var{n}
19415 @opindex msda
19416 Put static or global variables whose size is @var{n} bytes or less into
19417 the small data area that register @code{gp} points to.  The small data
19418 area can hold up to 64 kilobytes.
19420 @item -mzda=@var{n}
19421 @opindex mzda
19422 Put static or global variables whose size is @var{n} bytes or less into
19423 the first 32 kilobytes of memory.
19425 @item -mv850
19426 @opindex mv850
19427 Specify that the target processor is the V850.
19429 @item -mbig-switch
19430 @opindex mbig-switch
19431 Generate code suitable for big switch tables.  Use this option only if
19432 the assembler/linker complain about out of range branches within a switch
19433 table.
19435 @item -mapp-regs
19436 @opindex mapp-regs
19437 This option causes r2 and r5 to be used in the code generated by
19438 the compiler.  This setting is the default.
19440 @item -mno-app-regs
19441 @opindex mno-app-regs
19442 This option causes r2 and r5 to be treated as fixed registers.
19444 @item -mv850e2v3
19445 @opindex mv850e2v3
19446 Specify that the target processor is the V850E2V3.  The preprocessor
19447 constant @samp{__v850e2v3__} is defined if
19448 this option is used.
19450 @item -mv850e2
19451 @opindex mv850e2
19452 Specify that the target processor is the V850E2.  The preprocessor
19453 constant @samp{__v850e2__} is defined if this option is used.
19455 @item -mv850e1
19456 @opindex mv850e1
19457 Specify that the target processor is the V850E1.  The preprocessor
19458 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
19459 this option is used.
19461 @item -mv850es
19462 @opindex mv850es
19463 Specify that the target processor is the V850ES.  This is an alias for
19464 the @option{-mv850e1} option.
19466 @item -mv850e
19467 @opindex mv850e
19468 Specify that the target processor is the V850E@.  The preprocessor
19469 constant @samp{__v850e__} is defined if this option is used.
19471 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
19472 nor @option{-mv850e2} nor @option{-mv850e2v3}
19473 are defined then a default target processor is chosen and the
19474 relevant @samp{__v850*__} preprocessor constant is defined.
19476 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
19477 defined, regardless of which processor variant is the target.
19479 @item -mdisable-callt
19480 @opindex mdisable-callt
19481 This option suppresses generation of the @code{CALLT} instruction for the
19482 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
19483 @option{-mno-disable-callt} which allows the @code{CALLT} instruction to be used.
19485 @end table
19487 @node VAX Options
19488 @subsection VAX Options
19489 @cindex VAX options
19491 These @samp{-m} options are defined for the VAX:
19493 @table @gcctabopt
19494 @item -munix
19495 @opindex munix
19496 Do not output certain jump instructions (@code{aobleq} and so on)
19497 that the Unix assembler for the VAX cannot handle across long
19498 ranges.
19500 @item -mgnu
19501 @opindex mgnu
19502 Do output those jump instructions, on the assumption that the
19503 GNU assembler is being used.
19505 @item -mg
19506 @opindex mg
19507 Output code for G-format floating-point numbers instead of D-format.
19508 @end table
19510 @node VMS Options
19511 @subsection VMS Options
19513 These @samp{-m} options are defined for the VMS implementations:
19515 @table @gcctabopt
19516 @item -mvms-return-codes
19517 @opindex mvms-return-codes
19518 Return VMS condition codes from @code{main}. The default is to return POSIX-style
19519 condition (e.g.@ error) codes.
19521 @item -mdebug-main=@var{prefix}
19522 @opindex mdebug-main=@var{prefix}
19523 Flag the first routine whose name starts with @var{prefix} as the main
19524 routine for the debugger.
19526 @item -mmalloc64
19527 @opindex mmalloc64
19528 Default to 64-bit memory allocation routines.
19530 @item -mpointer-size=@var{size}
19531 @opindex -mpointer-size=@var{size}
19532 Set the default size of pointers. Possible options for @var{size} are
19533 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
19534 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
19535 The later option disables @code{pragma pointer_size}.
19536 @end table
19538 @node VxWorks Options
19539 @subsection VxWorks Options
19540 @cindex VxWorks Options
19542 The options in this section are defined for all VxWorks targets.
19543 Options specific to the target hardware are listed with the other
19544 options for that target.
19546 @table @gcctabopt
19547 @item -mrtp
19548 @opindex mrtp
19549 GCC can generate code for both VxWorks kernels and real time processes
19550 (RTPs).  This option switches from the former to the latter.  It also
19551 defines the preprocessor macro @code{__RTP__}.
19553 @item -non-static
19554 @opindex non-static
19555 Link an RTP executable against shared libraries rather than static
19556 libraries.  The options @option{-static} and @option{-shared} can
19557 also be used for RTPs (@pxref{Link Options}); @option{-static}
19558 is the default.
19560 @item -Bstatic
19561 @itemx -Bdynamic
19562 @opindex Bstatic
19563 @opindex Bdynamic
19564 These options are passed down to the linker.  They are defined for
19565 compatibility with Diab.
19567 @item -Xbind-lazy
19568 @opindex Xbind-lazy
19569 Enable lazy binding of function calls.  This option is equivalent to
19570 @option{-Wl,-z,now} and is defined for compatibility with Diab.
19572 @item -Xbind-now
19573 @opindex Xbind-now
19574 Disable lazy binding of function calls.  This option is the default and
19575 is defined for compatibility with Diab.
19576 @end table
19578 @node x86-64 Options
19579 @subsection x86-64 Options
19580 @cindex x86-64 options
19582 These are listed under @xref{i386 and x86-64 Options}.
19584 @node Xstormy16 Options
19585 @subsection Xstormy16 Options
19586 @cindex Xstormy16 Options
19588 These options are defined for Xstormy16:
19590 @table @gcctabopt
19591 @item -msim
19592 @opindex msim
19593 Choose startup files and linker script suitable for the simulator.
19594 @end table
19596 @node Xtensa Options
19597 @subsection Xtensa Options
19598 @cindex Xtensa Options
19600 These options are supported for Xtensa targets:
19602 @table @gcctabopt
19603 @item -mconst16
19604 @itemx -mno-const16
19605 @opindex mconst16
19606 @opindex mno-const16
19607 Enable or disable use of @code{CONST16} instructions for loading
19608 constant values.  The @code{CONST16} instruction is currently not a
19609 standard option from Tensilica.  When enabled, @code{CONST16}
19610 instructions are always used in place of the standard @code{L32R}
19611 instructions.  The use of @code{CONST16} is enabled by default only if
19612 the @code{L32R} instruction is not available.
19614 @item -mfused-madd
19615 @itemx -mno-fused-madd
19616 @opindex mfused-madd
19617 @opindex mno-fused-madd
19618 Enable or disable use of fused multiply/add and multiply/subtract
19619 instructions in the floating-point option.  This has no effect if the
19620 floating-point option is not also enabled.  Disabling fused multiply/add
19621 and multiply/subtract instructions forces the compiler to use separate
19622 instructions for the multiply and add/subtract operations.  This may be
19623 desirable in some cases where strict IEEE 754-compliant results are
19624 required: the fused multiply add/subtract instructions do not round the
19625 intermediate result, thereby producing results with @emph{more} bits of
19626 precision than specified by the IEEE standard.  Disabling fused multiply
19627 add/subtract instructions also ensures that the program output is not
19628 sensitive to the compiler's ability to combine multiply and add/subtract
19629 operations.
19631 @item -mserialize-volatile
19632 @itemx -mno-serialize-volatile
19633 @opindex mserialize-volatile
19634 @opindex mno-serialize-volatile
19635 When this option is enabled, GCC inserts @code{MEMW} instructions before
19636 @code{volatile} memory references to guarantee sequential consistency.
19637 The default is @option{-mserialize-volatile}.  Use
19638 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
19640 @item -mforce-no-pic
19641 @opindex mforce-no-pic
19642 For targets, like GNU/Linux, where all user-mode Xtensa code must be
19643 position-independent code (PIC), this option disables PIC for compiling
19644 kernel code.
19646 @item -mtext-section-literals
19647 @itemx -mno-text-section-literals
19648 @opindex mtext-section-literals
19649 @opindex mno-text-section-literals
19650 Control the treatment of literal pools.  The default is
19651 @option{-mno-text-section-literals}, which places literals in a separate
19652 section in the output file.  This allows the literal pool to be placed
19653 in a data RAM/ROM, and it also allows the linker to combine literal
19654 pools from separate object files to remove redundant literals and
19655 improve code size.  With @option{-mtext-section-literals}, the literals
19656 are interspersed in the text section in order to keep them as close as
19657 possible to their references.  This may be necessary for large assembly
19658 files.
19660 @item -mtarget-align
19661 @itemx -mno-target-align
19662 @opindex mtarget-align
19663 @opindex mno-target-align
19664 When this option is enabled, GCC instructs the assembler to
19665 automatically align instructions to reduce branch penalties at the
19666 expense of some code density.  The assembler attempts to widen density
19667 instructions to align branch targets and the instructions following call
19668 instructions.  If there are not enough preceding safe density
19669 instructions to align a target, no widening is performed.  The
19670 default is @option{-mtarget-align}.  These options do not affect the
19671 treatment of auto-aligned instructions like @code{LOOP}, which the
19672 assembler always aligns, either by widening density instructions or
19673 by inserting NOP instructions.
19675 @item -mlongcalls
19676 @itemx -mno-longcalls
19677 @opindex mlongcalls
19678 @opindex mno-longcalls
19679 When this option is enabled, GCC instructs the assembler to translate
19680 direct calls to indirect calls unless it can determine that the target
19681 of a direct call is in the range allowed by the call instruction.  This
19682 translation typically occurs for calls to functions in other source
19683 files.  Specifically, the assembler translates a direct @code{CALL}
19684 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
19685 The default is @option{-mno-longcalls}.  This option should be used in
19686 programs where the call target can potentially be out of range.  This
19687 option is implemented in the assembler, not the compiler, so the
19688 assembly code generated by GCC still shows direct call
19689 instructions---look at the disassembled object code to see the actual
19690 instructions.  Note that the assembler uses an indirect call for
19691 every cross-file call, not just those that really are out of range.
19692 @end table
19694 @node zSeries Options
19695 @subsection zSeries Options
19696 @cindex zSeries options
19698 These are listed under @xref{S/390 and zSeries Options}.
19700 @node Code Gen Options
19701 @section Options for Code Generation Conventions
19702 @cindex code generation conventions
19703 @cindex options, code generation
19704 @cindex run-time options
19706 These machine-independent options control the interface conventions
19707 used in code generation.
19709 Most of them have both positive and negative forms; the negative form
19710 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
19711 one of the forms is listed---the one that is not the default.  You
19712 can figure out the other form by either removing @samp{no-} or adding
19715 @table @gcctabopt
19716 @item -fbounds-check
19717 @opindex fbounds-check
19718 For front ends that support it, generate additional code to check that
19719 indices used to access arrays are within the declared range.  This is
19720 currently only supported by the Java and Fortran front ends, where
19721 this option defaults to true and false respectively.
19723 @item -fstack-reuse=@var{reuse-level}
19724 @opindex fstack_reuse
19725 This option controls stack space reuse for user declared local/auto variables
19726 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
19727 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
19728 local variables and temporaries, @samp{named_vars} enables the reuse only for
19729 user defined local variables with names, and @samp{none} disables stack reuse
19730 completely. The default value is @samp{all}. The option is needed when the
19731 program extends the lifetime of a scoped local variable or a compiler generated
19732 temporary beyond the end point defined by the language.  When a lifetime of
19733 a variable ends, and if the variable lives in memory, the optimizing compiler
19734 has the freedom to reuse its stack space with other temporaries or scoped
19735 local variables whose live range does not overlap with it. Legacy code extending
19736 local lifetime will likely to break with the stack reuse optimization.
19738 For example,
19740 @smallexample
19741    int *p;
19742    @{
19743      int local1;
19745      p = &local1;
19746      local1 = 10;
19747      ....
19748    @}
19749    @{
19750       int local2;
19751       local2 = 20;
19752       ...
19753    @}
19755    if (*p == 10)  // out of scope use of local1
19756      @{
19758      @}
19759 @end smallexample
19761 Another example:
19762 @smallexample
19764    struct A
19765    @{
19766        A(int k) : i(k), j(k) @{ @}
19767        int i;
19768        int j;
19769    @};
19771    A *ap;
19773    void foo(const A& ar)
19774    @{
19775       ap = &ar;
19776    @}
19778    void bar()
19779    @{
19780       foo(A(10)); // temp object's lifetime ends when foo returns
19782       @{
19783         A a(20);
19784         ....
19785       @}
19786       ap->i+= 10;  // ap references out of scope temp whose space
19787                    // is reused with a. What is the value of ap->i?
19788    @}
19790 @end smallexample
19792 The lifetime of a compiler generated temporary is well defined by the C++
19793 standard. When a lifetime of a temporary ends, and if the temporary lives
19794 in memory, the optimizing compiler has the freedom to reuse its stack
19795 space with other temporaries or scoped local variables whose live range
19796 does not overlap with it. However some of the legacy code relies on
19797 the behavior of older compilers in which temporaries' stack space is
19798 not reused, the aggressive stack reuse can lead to runtime errors. This
19799 option is used to control the temporary stack reuse optimization.
19801 @item -ftrapv
19802 @opindex ftrapv
19803 This option generates traps for signed overflow on addition, subtraction,
19804 multiplication operations.
19806 @item -fwrapv
19807 @opindex fwrapv
19808 This option instructs the compiler to assume that signed arithmetic
19809 overflow of addition, subtraction and multiplication wraps around
19810 using twos-complement representation.  This flag enables some optimizations
19811 and disables others.  This option is enabled by default for the Java
19812 front end, as required by the Java language specification.
19814 @item -fexceptions
19815 @opindex fexceptions
19816 Enable exception handling.  Generates extra code needed to propagate
19817 exceptions.  For some targets, this implies GCC generates frame
19818 unwind information for all functions, which can produce significant data
19819 size overhead, although it does not affect execution.  If you do not
19820 specify this option, GCC enables it by default for languages like
19821 C++ that normally require exception handling, and disables it for
19822 languages like C that do not normally require it.  However, you may need
19823 to enable this option when compiling C code that needs to interoperate
19824 properly with exception handlers written in C++.  You may also wish to
19825 disable this option if you are compiling older C++ programs that don't
19826 use exception handling.
19828 @item -fnon-call-exceptions
19829 @opindex fnon-call-exceptions
19830 Generate code that allows trapping instructions to throw exceptions.
19831 Note that this requires platform-specific runtime support that does
19832 not exist everywhere.  Moreover, it only allows @emph{trapping}
19833 instructions to throw exceptions, i.e.@: memory references or floating-point
19834 instructions.  It does not allow exceptions to be thrown from
19835 arbitrary signal handlers such as @code{SIGALRM}.
19837 @item -fdelete-dead-exceptions
19838 @opindex fdelete-dead-exceptions
19839 Consider that instructions that may throw exceptions but don't otherwise
19840 contribute to the execution of the program can be optimized away.
19841 This option is enabled by default for the Ada front end, as permitted by
19842 the Ada language specification.
19843 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
19845 @item -funwind-tables
19846 @opindex funwind-tables
19847 Similar to @option{-fexceptions}, except that it just generates any needed
19848 static data, but does not affect the generated code in any other way.
19849 You normally do not need to enable this option; instead, a language processor
19850 that needs this handling enables it on your behalf.
19852 @item -fasynchronous-unwind-tables
19853 @opindex fasynchronous-unwind-tables
19854 Generate unwind table in DWARF 2 format, if supported by target machine.  The
19855 table is exact at each instruction boundary, so it can be used for stack
19856 unwinding from asynchronous events (such as debugger or garbage collector).
19858 @item -fpcc-struct-return
19859 @opindex fpcc-struct-return
19860 Return ``short'' @code{struct} and @code{union} values in memory like
19861 longer ones, rather than in registers.  This convention is less
19862 efficient, but it has the advantage of allowing intercallability between
19863 GCC-compiled files and files compiled with other compilers, particularly
19864 the Portable C Compiler (pcc).
19866 The precise convention for returning structures in memory depends
19867 on the target configuration macros.
19869 Short structures and unions are those whose size and alignment match
19870 that of some integer type.
19872 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
19873 switch is not binary compatible with code compiled with the
19874 @option{-freg-struct-return} switch.
19875 Use it to conform to a non-default application binary interface.
19877 @item -freg-struct-return
19878 @opindex freg-struct-return
19879 Return @code{struct} and @code{union} values in registers when possible.
19880 This is more efficient for small structures than
19881 @option{-fpcc-struct-return}.
19883 If you specify neither @option{-fpcc-struct-return} nor
19884 @option{-freg-struct-return}, GCC defaults to whichever convention is
19885 standard for the target.  If there is no standard convention, GCC
19886 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
19887 the principal compiler.  In those cases, we can choose the standard, and
19888 we chose the more efficient register return alternative.
19890 @strong{Warning:} code compiled with the @option{-freg-struct-return}
19891 switch is not binary compatible with code compiled with the
19892 @option{-fpcc-struct-return} switch.
19893 Use it to conform to a non-default application binary interface.
19895 @item -fshort-enums
19896 @opindex fshort-enums
19897 Allocate to an @code{enum} type only as many bytes as it needs for the
19898 declared range of possible values.  Specifically, the @code{enum} type
19899 is equivalent to the smallest integer type that has enough room.
19901 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
19902 code that is not binary compatible with code generated without that switch.
19903 Use it to conform to a non-default application binary interface.
19905 @item -fshort-double
19906 @opindex fshort-double
19907 Use the same size for @code{double} as for @code{float}.
19909 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
19910 code that is not binary compatible with code generated without that switch.
19911 Use it to conform to a non-default application binary interface.
19913 @item -fshort-wchar
19914 @opindex fshort-wchar
19915 Override the underlying type for @samp{wchar_t} to be @samp{short
19916 unsigned int} instead of the default for the target.  This option is
19917 useful for building programs to run under WINE@.
19919 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
19920 code that is not binary compatible with code generated without that switch.
19921 Use it to conform to a non-default application binary interface.
19923 @item -fno-common
19924 @opindex fno-common
19925 In C code, controls the placement of uninitialized global variables.
19926 Unix C compilers have traditionally permitted multiple definitions of
19927 such variables in different compilation units by placing the variables
19928 in a common block.
19929 This is the behavior specified by @option{-fcommon}, and is the default
19930 for GCC on most targets.
19931 On the other hand, this behavior is not required by ISO C, and on some
19932 targets may carry a speed or code size penalty on variable references.
19933 The @option{-fno-common} option specifies that the compiler should place
19934 uninitialized global variables in the data section of the object file,
19935 rather than generating them as common blocks.
19936 This has the effect that if the same variable is declared
19937 (without @code{extern}) in two different compilations,
19938 you get a multiple-definition error when you link them.
19939 In this case, you must compile with @option{-fcommon} instead.
19940 Compiling with @option{-fno-common} is useful on targets for which
19941 it provides better performance, or if you wish to verify that the
19942 program will work on other systems that always treat uninitialized
19943 variable declarations this way.
19945 @item -fno-ident
19946 @opindex fno-ident
19947 Ignore the @samp{#ident} directive.
19949 @item -finhibit-size-directive
19950 @opindex finhibit-size-directive
19951 Don't output a @code{.size} assembler directive, or anything else that
19952 would cause trouble if the function is split in the middle, and the
19953 two halves are placed at locations far apart in memory.  This option is
19954 used when compiling @file{crtstuff.c}; you should not need to use it
19955 for anything else.
19957 @item -fverbose-asm
19958 @opindex fverbose-asm
19959 Put extra commentary information in the generated assembly code to
19960 make it more readable.  This option is generally only of use to those
19961 who actually need to read the generated assembly code (perhaps while
19962 debugging the compiler itself).
19964 @option{-fno-verbose-asm}, the default, causes the
19965 extra information to be omitted and is useful when comparing two assembler
19966 files.
19968 @item -frecord-gcc-switches
19969 @opindex frecord-gcc-switches
19970 This switch causes the command line used to invoke the
19971 compiler to be recorded into the object file that is being created.
19972 This switch is only implemented on some targets and the exact format
19973 of the recording is target and binary file format dependent, but it
19974 usually takes the form of a section containing ASCII text.  This
19975 switch is related to the @option{-fverbose-asm} switch, but that
19976 switch only records information in the assembler output file as
19977 comments, so it never reaches the object file.
19978 See also @option{-grecord-gcc-switches} for another
19979 way of storing compiler options into the object file.
19981 @item -fpic
19982 @opindex fpic
19983 @cindex global offset table
19984 @cindex PIC
19985 Generate position-independent code (PIC) suitable for use in a shared
19986 library, if supported for the target machine.  Such code accesses all
19987 constant addresses through a global offset table (GOT)@.  The dynamic
19988 loader resolves the GOT entries when the program starts (the dynamic
19989 loader is not part of GCC; it is part of the operating system).  If
19990 the GOT size for the linked executable exceeds a machine-specific
19991 maximum size, you get an error message from the linker indicating that
19992 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
19993 instead.  (These maximums are 8k on the SPARC and 32k
19994 on the m68k and RS/6000.  The 386 has no such limit.)
19996 Position-independent code requires special support, and therefore works
19997 only on certain machines.  For the 386, GCC supports PIC for System V
19998 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
19999 position-independent.
20001 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20002 are defined to 1.
20004 @item -fPIC
20005 @opindex fPIC
20006 If supported for the target machine, emit position-independent code,
20007 suitable for dynamic linking and avoiding any limit on the size of the
20008 global offset table.  This option makes a difference on the m68k,
20009 PowerPC and SPARC@.
20011 Position-independent code requires special support, and therefore works
20012 only on certain machines.
20014 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
20015 are defined to 2.
20017 @item -fpie
20018 @itemx -fPIE
20019 @opindex fpie
20020 @opindex fPIE
20021 These options are similar to @option{-fpic} and @option{-fPIC}, but
20022 generated position independent code can be only linked into executables.
20023 Usually these options are used when @option{-pie} GCC option is
20024 used during linking.
20026 @option{-fpie} and @option{-fPIE} both define the macros
20027 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
20028 for @option{-fpie} and 2 for @option{-fPIE}.
20030 @item -fno-jump-tables
20031 @opindex fno-jump-tables
20032 Do not use jump tables for switch statements even where it would be
20033 more efficient than other code generation strategies.  This option is
20034 of use in conjunction with @option{-fpic} or @option{-fPIC} for
20035 building code that forms part of a dynamic linker and cannot
20036 reference the address of a jump table.  On some targets, jump tables
20037 do not require a GOT and this option is not needed.
20039 @item -ffixed-@var{reg}
20040 @opindex ffixed
20041 Treat the register named @var{reg} as a fixed register; generated code
20042 should never refer to it (except perhaps as a stack pointer, frame
20043 pointer or in some other fixed role).
20045 @var{reg} must be the name of a register.  The register names accepted
20046 are machine-specific and are defined in the @code{REGISTER_NAMES}
20047 macro in the machine description macro file.
20049 This flag does not have a negative form, because it specifies a
20050 three-way choice.
20052 @item -fcall-used-@var{reg}
20053 @opindex fcall-used
20054 Treat the register named @var{reg} as an allocable register that is
20055 clobbered by function calls.  It may be allocated for temporaries or
20056 variables that do not live across a call.  Functions compiled this way
20057 do not save and restore the register @var{reg}.
20059 It is an error to use this flag with the frame pointer or stack pointer.
20060 Use of this flag for other registers that have fixed pervasive roles in
20061 the machine's execution model produces disastrous results.
20063 This flag does not have a negative form, because it specifies a
20064 three-way choice.
20066 @item -fcall-saved-@var{reg}
20067 @opindex fcall-saved
20068 Treat the register named @var{reg} as an allocable register saved by
20069 functions.  It may be allocated even for temporaries or variables that
20070 live across a call.  Functions compiled this way save and restore
20071 the register @var{reg} if they use it.
20073 It is an error to use this flag with the frame pointer or stack pointer.
20074 Use of this flag for other registers that have fixed pervasive roles in
20075 the machine's execution model produces disastrous results.
20077 A different sort of disaster results from the use of this flag for
20078 a register in which function values may be returned.
20080 This flag does not have a negative form, because it specifies a
20081 three-way choice.
20083 @item -fpack-struct[=@var{n}]
20084 @opindex fpack-struct
20085 Without a value specified, pack all structure members together without
20086 holes.  When a value is specified (which must be a small power of two), pack
20087 structure members according to this value, representing the maximum
20088 alignment (that is, objects with default alignment requirements larger than
20089 this are output potentially unaligned at the next fitting location.
20091 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
20092 code that is not binary compatible with code generated without that switch.
20093 Additionally, it makes the code suboptimal.
20094 Use it to conform to a non-default application binary interface.
20096 @item -finstrument-functions
20097 @opindex finstrument-functions
20098 Generate instrumentation calls for entry and exit to functions.  Just
20099 after function entry and just before function exit, the following
20100 profiling functions are called with the address of the current
20101 function and its call site.  (On some platforms,
20102 @code{__builtin_return_address} does not work beyond the current
20103 function, so the call site information may not be available to the
20104 profiling functions otherwise.)
20106 @smallexample
20107 void __cyg_profile_func_enter (void *this_fn,
20108                                void *call_site);
20109 void __cyg_profile_func_exit  (void *this_fn,
20110                                void *call_site);
20111 @end smallexample
20113 The first argument is the address of the start of the current function,
20114 which may be looked up exactly in the symbol table.
20116 This instrumentation is also done for functions expanded inline in other
20117 functions.  The profiling calls indicate where, conceptually, the
20118 inline function is entered and exited.  This means that addressable
20119 versions of such functions must be available.  If all your uses of a
20120 function are expanded inline, this may mean an additional expansion of
20121 code size.  If you use @samp{extern inline} in your C code, an
20122 addressable version of such functions must be provided.  (This is
20123 normally the case anyway, but if you get lucky and the optimizer always
20124 expands the functions inline, you might have gotten away without
20125 providing static copies.)
20127 A function may be given the attribute @code{no_instrument_function}, in
20128 which case this instrumentation is not done.  This can be used, for
20129 example, for the profiling functions listed above, high-priority
20130 interrupt routines, and any functions from which the profiling functions
20131 cannot safely be called (perhaps signal handlers, if the profiling
20132 routines generate output or allocate memory).
20134 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
20135 @opindex finstrument-functions-exclude-file-list
20137 Set the list of functions that are excluded from instrumentation (see
20138 the description of @code{-finstrument-functions}).  If the file that
20139 contains a function definition matches with one of @var{file}, then
20140 that function is not instrumented.  The match is done on substrings:
20141 if the @var{file} parameter is a substring of the file name, it is
20142 considered to be a match.
20144 For example:
20146 @smallexample
20147 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
20148 @end smallexample
20150 @noindent
20151 excludes any inline function defined in files whose pathnames
20152 contain @code{/bits/stl} or @code{include/sys}.
20154 If, for some reason, you want to include letter @code{','} in one of
20155 @var{sym}, write @code{'\,'}. For example,
20156 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
20157 (note the single quote surrounding the option).
20159 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
20160 @opindex finstrument-functions-exclude-function-list
20162 This is similar to @code{-finstrument-functions-exclude-file-list},
20163 but this option sets the list of function names to be excluded from
20164 instrumentation.  The function name to be matched is its user-visible
20165 name, such as @code{vector<int> blah(const vector<int> &)}, not the
20166 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
20167 match is done on substrings: if the @var{sym} parameter is a substring
20168 of the function name, it is considered to be a match.  For C99 and C++
20169 extended identifiers, the function name must be given in UTF-8, not
20170 using universal character names.
20172 @item -fstack-check
20173 @opindex fstack-check
20174 Generate code to verify that you do not go beyond the boundary of the
20175 stack.  You should specify this flag if you are running in an
20176 environment with multiple threads, but you only rarely need to specify it in
20177 a single-threaded environment since stack overflow is automatically
20178 detected on nearly all systems if there is only one stack.
20180 Note that this switch does not actually cause checking to be done; the
20181 operating system or the language runtime must do that.  The switch causes
20182 generation of code to ensure that they see the stack being extended.
20184 You can additionally specify a string parameter: @code{no} means no
20185 checking, @code{generic} means force the use of old-style checking,
20186 @code{specific} means use the best checking method and is equivalent
20187 to bare @option{-fstack-check}.
20189 Old-style checking is a generic mechanism that requires no specific
20190 target support in the compiler but comes with the following drawbacks:
20192 @enumerate
20193 @item
20194 Modified allocation strategy for large objects: they are always
20195 allocated dynamically if their size exceeds a fixed threshold.
20197 @item
20198 Fixed limit on the size of the static frame of functions: when it is
20199 topped by a particular function, stack checking is not reliable and
20200 a warning is issued by the compiler.
20202 @item
20203 Inefficiency: because of both the modified allocation strategy and the
20204 generic implementation, code performance is hampered.
20205 @end enumerate
20207 Note that old-style stack checking is also the fallback method for
20208 @code{specific} if no target support has been added in the compiler.
20210 @item -fstack-limit-register=@var{reg}
20211 @itemx -fstack-limit-symbol=@var{sym}
20212 @itemx -fno-stack-limit
20213 @opindex fstack-limit-register
20214 @opindex fstack-limit-symbol
20215 @opindex fno-stack-limit
20216 Generate code to ensure that the stack does not grow beyond a certain value,
20217 either the value of a register or the address of a symbol.  If a larger
20218 stack is required, a signal is raised at run time.  For most targets,
20219 the signal is raised before the stack overruns the boundary, so
20220 it is possible to catch the signal without taking special precautions.
20222 For instance, if the stack starts at absolute address @samp{0x80000000}
20223 and grows downwards, you can use the flags
20224 @option{-fstack-limit-symbol=__stack_limit} and
20225 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
20226 of 128KB@.  Note that this may only work with the GNU linker.
20228 @item -fsplit-stack
20229 @opindex fsplit-stack
20230 Generate code to automatically split the stack before it overflows.
20231 The resulting program has a discontiguous stack which can only
20232 overflow if the program is unable to allocate any more memory.  This
20233 is most useful when running threaded programs, as it is no longer
20234 necessary to calculate a good stack size to use for each thread.  This
20235 is currently only implemented for the i386 and x86_64 back ends running
20236 GNU/Linux.
20238 When code compiled with @option{-fsplit-stack} calls code compiled
20239 without @option{-fsplit-stack}, there may not be much stack space
20240 available for the latter code to run.  If compiling all code,
20241 including library code, with @option{-fsplit-stack} is not an option,
20242 then the linker can fix up these calls so that the code compiled
20243 without @option{-fsplit-stack} always has a large stack.  Support for
20244 this is implemented in the gold linker in GNU binutils release 2.21
20245 and later.
20247 @item -fleading-underscore
20248 @opindex fleading-underscore
20249 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
20250 change the way C symbols are represented in the object file.  One use
20251 is to help link with legacy assembly code.
20253 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
20254 generate code that is not binary compatible with code generated without that
20255 switch.  Use it to conform to a non-default application binary interface.
20256 Not all targets provide complete support for this switch.
20258 @item -ftls-model=@var{model}
20259 @opindex ftls-model
20260 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
20261 The @var{model} argument should be one of @code{global-dynamic},
20262 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
20264 The default without @option{-fpic} is @code{initial-exec}; with
20265 @option{-fpic} the default is @code{global-dynamic}.
20267 @item -fvisibility=@var{default|internal|hidden|protected}
20268 @opindex fvisibility
20269 Set the default ELF image symbol visibility to the specified option---all
20270 symbols are marked with this unless overridden within the code.
20271 Using this feature can very substantially improve linking and
20272 load times of shared object libraries, produce more optimized
20273 code, provide near-perfect API export and prevent symbol clashes.
20274 It is @strong{strongly} recommended that you use this in any shared objects
20275 you distribute.
20277 Despite the nomenclature, @code{default} always means public; i.e.,
20278 available to be linked against from outside the shared object.
20279 @code{protected} and @code{internal} are pretty useless in real-world
20280 usage so the only other commonly used option is @code{hidden}.
20281 The default if @option{-fvisibility} isn't specified is
20282 @code{default}, i.e., make every
20283 symbol public---this causes the same behavior as previous versions of
20284 GCC@.
20286 A good explanation of the benefits offered by ensuring ELF
20287 symbols have the correct visibility is given by ``How To Write
20288 Shared Libraries'' by Ulrich Drepper (which can be found at
20289 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
20290 solution made possible by this option to marking things hidden when
20291 the default is public is to make the default hidden and mark things
20292 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
20293 and @code{__attribute__ ((visibility("default")))} instead of
20294 @code{__declspec(dllexport)} you get almost identical semantics with
20295 identical syntax.  This is a great boon to those working with
20296 cross-platform projects.
20298 For those adding visibility support to existing code, you may find
20299 @samp{#pragma GCC visibility} of use.  This works by you enclosing
20300 the declarations you wish to set visibility for with (for example)
20301 @samp{#pragma GCC visibility push(hidden)} and
20302 @samp{#pragma GCC visibility pop}.
20303 Bear in mind that symbol visibility should be viewed @strong{as
20304 part of the API interface contract} and thus all new code should
20305 always specify visibility when it is not the default; i.e., declarations
20306 only for use within the local DSO should @strong{always} be marked explicitly
20307 as hidden as so to avoid PLT indirection overheads---making this
20308 abundantly clear also aids readability and self-documentation of the code.
20309 Note that due to ISO C++ specification requirements, @code{operator new} and
20310 @code{operator delete} must always be of default visibility.
20312 Be aware that headers from outside your project, in particular system
20313 headers and headers from any other library you use, may not be
20314 expecting to be compiled with visibility other than the default.  You
20315 may need to explicitly say @samp{#pragma GCC visibility push(default)}
20316 before including any such headers.
20318 @samp{extern} declarations are not affected by @option{-fvisibility}, so
20319 a lot of code can be recompiled with @option{-fvisibility=hidden} with
20320 no modifications.  However, this means that calls to @code{extern}
20321 functions with no explicit visibility use the PLT, so it is more
20322 effective to use @code{__attribute ((visibility))} and/or
20323 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
20324 declarations should be treated as hidden.
20326 Note that @option{-fvisibility} does affect C++ vague linkage
20327 entities. This means that, for instance, an exception class that is
20328 be thrown between DSOs must be explicitly marked with default
20329 visibility so that the @samp{type_info} nodes are unified between
20330 the DSOs.
20332 An overview of these techniques, their benefits and how to use them
20333 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
20335 @item -fstrict-volatile-bitfields
20336 @opindex fstrict-volatile-bitfields
20337 This option should be used if accesses to volatile bit-fields (or other
20338 structure fields, although the compiler usually honors those types
20339 anyway) should use a single access of the width of the
20340 field's type, aligned to a natural alignment if possible.  For
20341 example, targets with memory-mapped peripheral registers might require
20342 all such accesses to be 16 bits wide; with this flag you can
20343 declare all peripheral bit-fields as @code{unsigned short} (assuming short
20344 is 16 bits on these targets) to force GCC to use 16-bit accesses
20345 instead of, perhaps, a more efficient 32-bit access.
20347 If this option is disabled, the compiler uses the most efficient
20348 instruction.  In the previous example, that might be a 32-bit load
20349 instruction, even though that accesses bytes that do not contain
20350 any portion of the bit-field, or memory-mapped registers unrelated to
20351 the one being updated.
20353 If the target requires strict alignment, and honoring the field
20354 type would require violating this alignment, a warning is issued.
20355 If the field has @code{packed} attribute, the access is done without
20356 honoring the field type.  If the field doesn't have @code{packed}
20357 attribute, the access is done honoring the field type.  In both cases,
20358 GCC assumes that the user knows something about the target hardware
20359 that it is unaware of.
20361 The default value of this option is determined by the application binary
20362 interface for the target processor.
20364 @item -fsync-libcalls
20365 @opindex fsync-libcalls
20366 This option controls whether any out-of-line instance of the @code{__sync}
20367 family of functions may be used to implement the C++11 @code{__atomic}
20368 family of functions.
20370 The default value of this option is enabled, thus the only useful form
20371 of the option is @option{-fno-sync-libcalls}.  This option is used in
20372 the implementation of the @file{libatomic} runtime library.
20374 @end table
20376 @c man end
20378 @node Environment Variables
20379 @section Environment Variables Affecting GCC
20380 @cindex environment variables
20382 @c man begin ENVIRONMENT
20383 This section describes several environment variables that affect how GCC
20384 operates.  Some of them work by specifying directories or prefixes to use
20385 when searching for various kinds of files.  Some are used to specify other
20386 aspects of the compilation environment.
20388 Note that you can also specify places to search using options such as
20389 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
20390 take precedence over places specified using environment variables, which
20391 in turn take precedence over those specified by the configuration of GCC@.
20392 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
20393 GNU Compiler Collection (GCC) Internals}.
20395 @table @env
20396 @item LANG
20397 @itemx LC_CTYPE
20398 @c @itemx LC_COLLATE
20399 @itemx LC_MESSAGES
20400 @c @itemx LC_MONETARY
20401 @c @itemx LC_NUMERIC
20402 @c @itemx LC_TIME
20403 @itemx LC_ALL
20404 @findex LANG
20405 @findex LC_CTYPE
20406 @c @findex LC_COLLATE
20407 @findex LC_MESSAGES
20408 @c @findex LC_MONETARY
20409 @c @findex LC_NUMERIC
20410 @c @findex LC_TIME
20411 @findex LC_ALL
20412 @cindex locale
20413 These environment variables control the way that GCC uses
20414 localization information which allows GCC to work with different
20415 national conventions.  GCC inspects the locale categories
20416 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
20417 so.  These locale categories can be set to any value supported by your
20418 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
20419 Kingdom encoded in UTF-8.
20421 The @env{LC_CTYPE} environment variable specifies character
20422 classification.  GCC uses it to determine the character boundaries in
20423 a string; this is needed for some multibyte encodings that contain quote
20424 and escape characters that are otherwise interpreted as a string
20425 end or escape.
20427 The @env{LC_MESSAGES} environment variable specifies the language to
20428 use in diagnostic messages.
20430 If the @env{LC_ALL} environment variable is set, it overrides the value
20431 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
20432 and @env{LC_MESSAGES} default to the value of the @env{LANG}
20433 environment variable.  If none of these variables are set, GCC
20434 defaults to traditional C English behavior.
20436 @item TMPDIR
20437 @findex TMPDIR
20438 If @env{TMPDIR} is set, it specifies the directory to use for temporary
20439 files.  GCC uses temporary files to hold the output of one stage of
20440 compilation which is to be used as input to the next stage: for example,
20441 the output of the preprocessor, which is the input to the compiler
20442 proper.
20444 @item GCC_COMPARE_DEBUG
20445 @findex GCC_COMPARE_DEBUG
20446 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
20447 @option{-fcompare-debug} to the compiler driver.  See the documentation
20448 of this option for more details.
20450 @item GCC_EXEC_PREFIX
20451 @findex GCC_EXEC_PREFIX
20452 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
20453 names of the subprograms executed by the compiler.  No slash is added
20454 when this prefix is combined with the name of a subprogram, but you can
20455 specify a prefix that ends with a slash if you wish.
20457 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
20458 an appropriate prefix to use based on the pathname it is invoked with.
20460 If GCC cannot find the subprogram using the specified prefix, it
20461 tries looking in the usual places for the subprogram.
20463 The default value of @env{GCC_EXEC_PREFIX} is
20464 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
20465 the installed compiler. In many cases @var{prefix} is the value
20466 of @code{prefix} when you ran the @file{configure} script.
20468 Other prefixes specified with @option{-B} take precedence over this prefix.
20470 This prefix is also used for finding files such as @file{crt0.o} that are
20471 used for linking.
20473 In addition, the prefix is used in an unusual way in finding the
20474 directories to search for header files.  For each of the standard
20475 directories whose name normally begins with @samp{/usr/local/lib/gcc}
20476 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
20477 replacing that beginning with the specified prefix to produce an
20478 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
20479 @file{foo/bar} just before it searches the standard directory 
20480 @file{/usr/local/lib/bar}.
20481 If a standard directory begins with the configured
20482 @var{prefix} then the value of @var{prefix} is replaced by
20483 @env{GCC_EXEC_PREFIX} when looking for header files.
20485 @item COMPILER_PATH
20486 @findex COMPILER_PATH
20487 The value of @env{COMPILER_PATH} is a colon-separated list of
20488 directories, much like @env{PATH}.  GCC tries the directories thus
20489 specified when searching for subprograms, if it can't find the
20490 subprograms using @env{GCC_EXEC_PREFIX}.
20492 @item LIBRARY_PATH
20493 @findex LIBRARY_PATH
20494 The value of @env{LIBRARY_PATH} is a colon-separated list of
20495 directories, much like @env{PATH}.  When configured as a native compiler,
20496 GCC tries the directories thus specified when searching for special
20497 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
20498 using GCC also uses these directories when searching for ordinary
20499 libraries for the @option{-l} option (but directories specified with
20500 @option{-L} come first).
20502 @item LANG
20503 @findex LANG
20504 @cindex locale definition
20505 This variable is used to pass locale information to the compiler.  One way in
20506 which this information is used is to determine the character set to be used
20507 when character literals, string literals and comments are parsed in C and C++.
20508 When the compiler is configured to allow multibyte characters,
20509 the following values for @env{LANG} are recognized:
20511 @table @samp
20512 @item C-JIS
20513 Recognize JIS characters.
20514 @item C-SJIS
20515 Recognize SJIS characters.
20516 @item C-EUCJP
20517 Recognize EUCJP characters.
20518 @end table
20520 If @env{LANG} is not defined, or if it has some other value, then the
20521 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
20522 recognize and translate multibyte characters.
20523 @end table
20525 @noindent
20526 Some additional environment variables affect the behavior of the
20527 preprocessor.
20529 @include cppenv.texi
20531 @c man end
20533 @node Precompiled Headers
20534 @section Using Precompiled Headers
20535 @cindex precompiled headers
20536 @cindex speed of compilation
20538 Often large projects have many header files that are included in every
20539 source file.  The time the compiler takes to process these header files
20540 over and over again can account for nearly all of the time required to
20541 build the project.  To make builds faster, GCC allows you to
20542 @dfn{precompile} a header file.
20544 To create a precompiled header file, simply compile it as you would any
20545 other file, if necessary using the @option{-x} option to make the driver
20546 treat it as a C or C++ header file.  You may want to use a
20547 tool like @command{make} to keep the precompiled header up-to-date when
20548 the headers it contains change.
20550 A precompiled header file is searched for when @code{#include} is
20551 seen in the compilation.  As it searches for the included file
20552 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
20553 compiler looks for a precompiled header in each directory just before it
20554 looks for the include file in that directory.  The name searched for is
20555 the name specified in the @code{#include} with @samp{.gch} appended.  If
20556 the precompiled header file can't be used, it is ignored.
20558 For instance, if you have @code{#include "all.h"}, and you have
20559 @file{all.h.gch} in the same directory as @file{all.h}, then the
20560 precompiled header file is used if possible, and the original
20561 header is used otherwise.
20563 Alternatively, you might decide to put the precompiled header file in a
20564 directory and use @option{-I} to ensure that directory is searched
20565 before (or instead of) the directory containing the original header.
20566 Then, if you want to check that the precompiled header file is always
20567 used, you can put a file of the same name as the original header in this
20568 directory containing an @code{#error} command.
20570 This also works with @option{-include}.  So yet another way to use
20571 precompiled headers, good for projects not designed with precompiled
20572 header files in mind, is to simply take most of the header files used by
20573 a project, include them from another header file, precompile that header
20574 file, and @option{-include} the precompiled header.  If the header files
20575 have guards against multiple inclusion, they are skipped because
20576 they've already been included (in the precompiled header).
20578 If you need to precompile the same header file for different
20579 languages, targets, or compiler options, you can instead make a
20580 @emph{directory} named like @file{all.h.gch}, and put each precompiled
20581 header in the directory, perhaps using @option{-o}.  It doesn't matter
20582 what you call the files in the directory; every precompiled header in
20583 the directory is considered.  The first precompiled header
20584 encountered in the directory that is valid for this compilation is
20585 used; they're searched in no particular order.
20587 There are many other possibilities, limited only by your imagination,
20588 good sense, and the constraints of your build system.
20590 A precompiled header file can be used only when these conditions apply:
20592 @itemize
20593 @item
20594 Only one precompiled header can be used in a particular compilation.
20596 @item
20597 A precompiled header can't be used once the first C token is seen.  You
20598 can have preprocessor directives before a precompiled header; you cannot
20599 include a precompiled header from inside another header.
20601 @item
20602 The precompiled header file must be produced for the same language as
20603 the current compilation.  You can't use a C precompiled header for a C++
20604 compilation.
20606 @item
20607 The precompiled header file must have been produced by the same compiler
20608 binary as the current compilation is using.
20610 @item
20611 Any macros defined before the precompiled header is included must
20612 either be defined in the same way as when the precompiled header was
20613 generated, or must not affect the precompiled header, which usually
20614 means that they don't appear in the precompiled header at all.
20616 The @option{-D} option is one way to define a macro before a
20617 precompiled header is included; using a @code{#define} can also do it.
20618 There are also some options that define macros implicitly, like
20619 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
20620 defined this way.
20622 @item If debugging information is output when using the precompiled
20623 header, using @option{-g} or similar, the same kind of debugging information
20624 must have been output when building the precompiled header.  However,
20625 a precompiled header built using @option{-g} can be used in a compilation
20626 when no debugging information is being output.
20628 @item The same @option{-m} options must generally be used when building
20629 and using the precompiled header.  @xref{Submodel Options},
20630 for any cases where this rule is relaxed.
20632 @item Each of the following options must be the same when building and using
20633 the precompiled header:
20635 @gccoptlist{-fexceptions}
20637 @item
20638 Some other command-line options starting with @option{-f},
20639 @option{-p}, or @option{-O} must be defined in the same way as when
20640 the precompiled header was generated.  At present, it's not clear
20641 which options are safe to change and which are not; the safest choice
20642 is to use exactly the same options when generating and using the
20643 precompiled header.  The following are known to be safe:
20645 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
20646 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
20647 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
20648 -pedantic-errors}
20650 @end itemize
20652 For all of these except the last, the compiler automatically
20653 ignores the precompiled header if the conditions aren't met.  If you
20654 find an option combination that doesn't work and doesn't cause the
20655 precompiled header to be ignored, please consider filing a bug report,
20656 see @ref{Bugs}.
20658 If you do use differing options when generating and using the
20659 precompiled header, the actual behavior is a mixture of the
20660 behavior for the options.  For instance, if you use @option{-g} to
20661 generate the precompiled header but not when using it, you may or may
20662 not get debugging information for routines in the precompiled header.