2012-03-19 Sandra Loosemore <sandra@codesourcery.com>
[official-gcc.git] / gcc / doc / invoke.texi
blobc744cb961929f9b528f98eb6f4f7fdb6e7c35e9b
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{-pedantic}]
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} would be @option{-fno-foo}.  This manual documents
117 only one of these two forms, whichever one is not the default.
119 @c man end
121 @xref{Option Index}, for an index to GCC's options.
123 @menu
124 * Option Summary::      Brief list of all options, without explanations.
125 * Overall Options::     Controlling the kind of output:
126                         an executable, object files, assembler files,
127                         or preprocessed source.
128 * Invoking G++::        Compiling C++ programs.
129 * C Dialect Options::   Controlling the variant of C language compiled.
130 * C++ Dialect Options:: Variations on C++.
131 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
132                         and Objective-C++.
133 * Language Independent Options:: Controlling how diagnostics should be
134                         formatted.
135 * Warning Options::     How picky should the compiler be?
136 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
137 * Optimize Options::    How much optimization?
138 * Preprocessor Options:: Controlling header files and macro definitions.
139                          Also, getting dependency information for Make.
140 * Assembler Options::   Passing options to the assembler.
141 * Link Options::        Specifying libraries and so on.
142 * Directory Options::   Where to find header files and libraries.
143                         Where to find the compiler executable files.
144 * Spec Files::          How to pass switches to sub-processes.
145 * Target Options::      Running a cross-compiler, or an old version of GCC.
146 * Submodel Options::    Specifying minor hardware or convention variations,
147                         such as 68010 vs 68020.
148 * Code Gen Options::    Specifying conventions for function calls, data layout
149                         and register usage.
150 * Environment Variables:: Env vars that affect GCC.
151 * Precompiled Headers:: Compiling a header once, and using it many times.
152 @end menu
154 @c man begin OPTIONS
156 @node Option Summary
157 @section Option Summary
159 Here is a summary of all the options, grouped by type.  Explanations are
160 in the following sections.
162 @table @emph
163 @item Overall Options
164 @xref{Overall Options,,Options Controlling the Kind of Output}.
165 @gccoptlist{-c  -S  -E  -o @var{file}  -no-canonical-prefixes  @gol
166 -pipe  -pass-exit-codes  @gol
167 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
168 --version -wrapper @@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}  @gol
169 -fdump-ada-spec@r{[}-slim@r{]} -fdump-go-spec=@var{file}}
171 @item C Language Options
172 @xref{C Dialect Options,,Options Controlling C Dialect}.
173 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
174 -aux-info @var{filename} -fallow-parameterless-variadic-functions @gol
175 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
176 -fhosted  -ffreestanding -fopenmp -fms-extensions -fplan9-extensions @gol
177 -trigraphs  -traditional  -traditional-cpp @gol
178 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
179 -fsigned-bitfields  -fsigned-char @gol
180 -funsigned-bitfields  -funsigned-char}
182 @item C++ Language Options
183 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
184 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
185 -fconserve-space  -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 -Wnarrowing -Wnoexcept @gol
202 -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}
235 @item Warning Options
236 @xref{Warning Options,,Options to Request or Suppress Warnings}.
237 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -pedantic @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-format-attribute  -Wmissing-include-dirs @gol
259 -Wno-mudflap @gol
260 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
261 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
262 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
263 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
264 -Wredundant-decls @gol
265 -Wreturn-type  -Wsequence-point  -Wshadow @gol
266 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
267 -Wstack-usage=@var{len} -Wstrict-aliasing -Wstrict-aliasing=n @gol
268 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
269 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]} @gol
270 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
271 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
272 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
273 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
274 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
275 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
276 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
277 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
278 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
280 @item C and Objective-C-only Warning Options
281 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
282 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
283 -Wold-style-declaration  -Wold-style-definition @gol
284 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
285 -Wdeclaration-after-statement -Wpointer-sign}
287 @item Debugging Options
288 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
289 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
290 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
291 -fdisable-ipa-@var{pass_name} @gol
292 -fdisable-rtl-@var{pass_name} @gol
293 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
294 -fdisable-tree-@var{pass_name} @gol
295 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
296 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
297 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
298 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
299 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
300 -fdump-passes @gol
301 -fdump-statistics @gol
302 -fdump-tree-all @gol
303 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
304 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
305 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
306 -fdump-tree-ch @gol
307 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
308 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-nrv -fdump-tree-vect @gol
317 -fdump-tree-sink @gol
318 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
319 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
322 -ftree-vectorizer-verbose=@var{n} @gol
323 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
324 -fdump-final-insns=@var{file} @gol
325 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
326 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
327 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
328 -fenable-@var{kind}-@var{pass} @gol
329 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
330 -fdebug-types-section @gol
331 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
332 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
333 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
334 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
335 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
336 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
337 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
338 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
339 -gvms  -gxcoff  -gxcoff+ @gol
340 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
341 -fdebug-prefix-map=@var{old}=@var{new} @gol
342 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
343 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
344 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
345 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
346 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
347 -print-sysroot -print-sysroot-headers-suffix @gol
348 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
350 @item Optimization Options
351 @xref{Optimize Options,,Options that Control Optimization}.
352 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
353 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
354 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
355 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
356 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
357 -fcompare-elim -fcprop-registers -fcrossjumping @gol
358 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
359 -fcx-limited-range @gol
360 -fdata-sections -fdce -fdelayed-branch @gol
361 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
362 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
363 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
364 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
365 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
366 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
367 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
368 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg @gol
369 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
370 -fira-algorithm=@var{algorithm} @gol
371 -fira-region=@var{region} @gol
372 -fira-loop-pressure -fno-ira-share-save-slots @gol
373 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
374 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
375 -floop-block -floop-interchange -floop-strip-mine @gol
376 -floop-parallelize-all -flto -flto-compression-level @gol
377 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
378 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
379 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
380 -fno-default-inline @gol
381 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
382 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
383 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
384 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
385 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
386 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
387 -fprefetch-loop-arrays @gol
388 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
389 -fprofile-generate=@var{path} @gol
390 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
391 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
392 -freorder-blocks-and-partition -freorder-functions @gol
393 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
394 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
395 -fsched-spec-load -fsched-spec-load-dangerous @gol
396 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
397 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
398 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
399 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
400 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
401 -fselective-scheduling -fselective-scheduling2 @gol
402 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
403 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
404 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
405 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
406 -fthread-jumps -ftracer -ftree-bit-ccp @gol
407 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
408 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
409 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
410 -ftree-loop-if-convert-stores -ftree-loop-im @gol
411 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
412 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
413 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
414 -ftree-sink -ftree-sra -ftree-switch-conversion -ftree-tail-merge @gol
415 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
416 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
417 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
418 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
419 -fwhole-program -fwpa -fuse-linker-plugin @gol
420 --param @var{name}=@var{value}
421 -O  -O0  -O1  -O2  -O3  -Os -Ofast}
423 @item Preprocessor Options
424 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
425 @gccoptlist{-A@var{question}=@var{answer} @gol
426 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
427 -C  -dD  -dI  -dM  -dN @gol
428 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
429 -idirafter @var{dir} @gol
430 -include @var{file}  -imacros @var{file} @gol
431 -iprefix @var{file}  -iwithprefix @var{dir} @gol
432 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
433 -imultilib @var{dir} -isysroot @var{dir} @gol
434 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
435 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
436 -remap -trigraphs  -undef  -U@var{macro}  @gol
437 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
439 @item Assembler Option
440 @xref{Assembler Options,,Passing Options to the Assembler}.
441 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
443 @item Linker Options
444 @xref{Link Options,,Options for Linking}.
445 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
446 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
447 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
448 -shared-libgcc  -symbolic @gol
449 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
450 -u @var{symbol}}
452 @item Directory Options
453 @xref{Directory Options,,Options for Directory Search}.
454 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
455 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
456 --sysroot=@var{dir}}
458 @item Machine Dependent Options
459 @xref{Submodel Options,,Hardware Models and Configurations}.
460 @c This list is ordered alphanumerically by subsection name.
461 @c Try and put the significant identifier (CPU or system) first,
462 @c so users have a clue at guessing where the ones they want will be.
464 @emph{Adapteva Epiphany Options}
465 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
466 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
467 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
468 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
469 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
470 -msplit-vecmove-early -m1reg-@var{reg}}
472 @emph{ARM Options}
473 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
474 -mabi=@var{name} @gol
475 -mapcs-stack-check  -mno-apcs-stack-check @gol
476 -mapcs-float  -mno-apcs-float @gol
477 -mapcs-reentrant  -mno-apcs-reentrant @gol
478 -msched-prolog  -mno-sched-prolog @gol
479 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
480 -mfloat-abi=@var{name}  -mfpe @gol
481 -mfp16-format=@var{name}
482 -mthumb-interwork  -mno-thumb-interwork @gol
483 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
484 -mstructure-size-boundary=@var{n} @gol
485 -mabort-on-noreturn @gol
486 -mlong-calls  -mno-long-calls @gol
487 -msingle-pic-base  -mno-single-pic-base @gol
488 -mpic-register=@var{reg} @gol
489 -mnop-fun-dllimport @gol
490 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
491 -mpoke-function-name @gol
492 -mthumb  -marm @gol
493 -mtpcs-frame  -mtpcs-leaf-frame @gol
494 -mcaller-super-interworking  -mcallee-super-interworking @gol
495 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
496 -mword-relocations @gol
497 -mfix-cortex-m3-ldrd}
499 @emph{AVR Options}
500 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
501 -mcall-prologues -mint8 -mno-interrupts -mrelax -mshort-calls @gol
502 -mstrict-X -mtiny-stack}
504 @emph{Blackfin Options}
505 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
506 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
507 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
508 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
509 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
510 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
511 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
512 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
513 -micplb}
515 @emph{C6X Options}
516 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
517 -msim -msdata=@var{sdata-type}}
519 @emph{CRIS Options}
520 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
521 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
522 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
523 -mstack-align  -mdata-align  -mconst-align @gol
524 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
525 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
526 -mmul-bug-workaround  -mno-mul-bug-workaround}
528 @emph{CR16 Options}
529 @gccoptlist{-mmac @gol
530 -mcr16cplus -mcr16c @gol
531 -msim -mint32 -mbit-ops
532 -mdata-model=@var{model}}
534 @emph{Darwin Options}
535 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
536 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
537 -client_name  -compatibility_version  -current_version @gol
538 -dead_strip @gol
539 -dependency-file  -dylib_file  -dylinker_install_name @gol
540 -dynamic  -dynamiclib  -exported_symbols_list @gol
541 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
542 -force_flat_namespace  -headerpad_max_install_names @gol
543 -iframework @gol
544 -image_base  -init  -install_name  -keep_private_externs @gol
545 -multi_module  -multiply_defined  -multiply_defined_unused @gol
546 -noall_load   -no_dead_strip_inits_and_terms @gol
547 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
548 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
549 -private_bundle  -read_only_relocs  -sectalign @gol
550 -sectobjectsymbols  -whyload  -seg1addr @gol
551 -sectcreate  -sectobjectsymbols  -sectorder @gol
552 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
553 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
554 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
555 -single_module  -static  -sub_library  -sub_umbrella @gol
556 -twolevel_namespace  -umbrella  -undefined @gol
557 -unexported_symbols_list  -weak_reference_mismatches @gol
558 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
559 -mkernel -mone-byte-bool}
561 @emph{DEC Alpha Options}
562 @gccoptlist{-mno-fp-regs  -msoft-float @gol
563 -mieee  -mieee-with-inexact  -mieee-conformant @gol
564 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
565 -mtrap-precision=@var{mode}  -mbuild-constants @gol
566 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
567 -mbwx  -mmax  -mfix  -mcix @gol
568 -mfloat-vax  -mfloat-ieee @gol
569 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
570 -msmall-text  -mlarge-text @gol
571 -mmemory-latency=@var{time}}
573 @emph{FR30 Options}
574 @gccoptlist{-msmall-model -mno-lsim}
576 @emph{FRV Options}
577 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
578 -mhard-float  -msoft-float @gol
579 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
580 -mdouble  -mno-double @gol
581 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
582 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
583 -mlinked-fp  -mlong-calls  -malign-labels @gol
584 -mlibrary-pic  -macc-4  -macc-8 @gol
585 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
586 -moptimize-membar -mno-optimize-membar @gol
587 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
588 -mvliw-branch  -mno-vliw-branch @gol
589 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
590 -mno-nested-cond-exec  -mtomcat-stats @gol
591 -mTLS -mtls @gol
592 -mcpu=@var{cpu}}
594 @emph{GNU/Linux Options}
595 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
596 -tno-android-cc -tno-android-ld}
598 @emph{H8/300 Options}
599 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
601 @emph{HPPA Options}
602 @gccoptlist{-march=@var{architecture-type} @gol
603 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
604 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
605 -mfixed-range=@var{register-range} @gol
606 -mjump-in-delay -mlinker-opt -mlong-calls @gol
607 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
608 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
609 -mno-jump-in-delay  -mno-long-load-store @gol
610 -mno-portable-runtime  -mno-soft-float @gol
611 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
612 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
613 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
614 -munix=@var{unix-std}  -nolibdld  -static  -threads}
616 @emph{i386 and x86-64 Options}
617 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
618 -mfpmath=@var{unit} @gol
619 -masm=@var{dialect}  -mno-fancy-math-387 @gol
620 -mno-fp-ret-in-387  -msoft-float @gol
621 -mno-wide-multiply  -mrtd  -malign-double @gol
622 -mpreferred-stack-boundary=@var{num} @gol
623 -mincoming-stack-boundary=@var{num} @gol
624 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
625 -mrecip -mrecip=@var{opt} @gol
626 -mvzeroupper @gol
627 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
628 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
629 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
630 -mbmi2 -mrtm -mlwp -mthreads @gol
631 -mno-align-stringops  -minline-all-stringops @gol
632 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
633 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
634 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
635 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
636 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
637 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
638 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
639 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
640 -msse2avx -mfentry -m8bit-idiv @gol
641 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
643 @emph{i386 and x86-64 Windows Options}
644 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
645 -mnop-fun-dllimport -mthread @gol
646 -municode -mwin32 -mwindows -fno-set-stack-executable}
648 @emph{IA-64 Options}
649 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
650 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
651 -mconstant-gp  -mauto-pic  -mfused-madd @gol
652 -minline-float-divide-min-latency @gol
653 -minline-float-divide-max-throughput @gol
654 -mno-inline-float-divide @gol
655 -minline-int-divide-min-latency @gol
656 -minline-int-divide-max-throughput  @gol
657 -mno-inline-int-divide @gol
658 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
659 -mno-inline-sqrt @gol
660 -mdwarf2-asm -mearly-stop-bits @gol
661 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
662 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
663 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
664 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
665 -msched-spec-ldc -msched-spec-control-ldc @gol
666 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
667 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
668 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
669 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
671 @emph{LM32 Options}
672 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
673 -msign-extend-enabled -muser-enabled}
675 @emph{M32R/D Options}
676 @gccoptlist{-m32r2 -m32rx -m32r @gol
677 -mdebug @gol
678 -malign-loops -mno-align-loops @gol
679 -missue-rate=@var{number} @gol
680 -mbranch-cost=@var{number} @gol
681 -mmodel=@var{code-size-model-type} @gol
682 -msdata=@var{sdata-type} @gol
683 -mno-flush-func -mflush-func=@var{name} @gol
684 -mno-flush-trap -mflush-trap=@var{number} @gol
685 -G @var{num}}
687 @emph{M32C Options}
688 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
690 @emph{M680x0 Options}
691 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
692 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
693 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
694 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
695 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
696 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
697 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
698 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
699 -mxgot -mno-xgot}
701 @emph{MCore Options}
702 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
703 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
704 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
705 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
706 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
708 @emph{MeP Options}
709 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
710 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
711 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
712 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
713 -mtiny=@var{n}}
715 @emph{MicroBlaze Options}
716 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
717 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
718 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
719 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
720 -mxl-mode-@var{app-model}}
722 @emph{MIPS Options}
723 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
724 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
725 -mips64  -mips64r2 @gol
726 -mips16  -mno-mips16  -mflip-mips16 @gol
727 -minterlink-mips16  -mno-interlink-mips16 @gol
728 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
729 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
730 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
731 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
732 -mfpu=@var{fpu-type} @gol
733 -msmartmips  -mno-smartmips @gol
734 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
735 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
736 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
737 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
738 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
739 -membedded-data  -mno-embedded-data @gol
740 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
741 -mcode-readable=@var{setting} @gol
742 -msplit-addresses  -mno-split-addresses @gol
743 -mexplicit-relocs  -mno-explicit-relocs @gol
744 -mcheck-zero-division  -mno-check-zero-division @gol
745 -mdivide-traps  -mdivide-breaks @gol
746 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
747 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
748 -mfix-24k -mno-fix-24k @gol
749 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
750 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
751 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
752 -mflush-func=@var{func}  -mno-flush-func @gol
753 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
754 -mfp-exceptions -mno-fp-exceptions @gol
755 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
756 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
758 @emph{MMIX Options}
759 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
760 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
761 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
762 -mno-base-addresses  -msingle-exit  -mno-single-exit}
764 @emph{MN10300 Options}
765 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
766 -mno-am33 -mam33 -mam33-2 -mam34 @gol
767 -mtune=@var{cpu-type} @gol
768 -mreturn-pointer-on-d0 @gol
769 -mno-crt0  -mrelax -mliw -msetlb}
771 @emph{PDP-11 Options}
772 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
773 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
774 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
775 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
776 -mbranch-expensive  -mbranch-cheap @gol
777 -munix-asm  -mdec-asm}
779 @emph{picoChip Options}
780 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
781 -msymbol-as-address -mno-inefficient-warnings}
783 @emph{PowerPC Options}
784 See RS/6000 and PowerPC Options.
786 @emph{RL78 Options}
787 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
789 @emph{RS/6000 and PowerPC Options}
790 @gccoptlist{-mcpu=@var{cpu-type} @gol
791 -mtune=@var{cpu-type} @gol
792 -mcmodel=@var{code-model} @gol
793 -mpower  -mno-power  -mpower2  -mno-power2 @gol
794 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
795 -maltivec  -mno-altivec @gol
796 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
797 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
798 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
799 -mfprnd  -mno-fprnd @gol
800 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
801 -mnew-mnemonics  -mold-mnemonics @gol
802 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
803 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
804 -malign-power  -malign-natural @gol
805 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
806 -msingle-float -mdouble-float -msimple-fpu @gol
807 -mstring  -mno-string  -mupdate  -mno-update @gol
808 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
809 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
810 -mstrict-align  -mno-strict-align  -mrelocatable @gol
811 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
812 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
813 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
814 -mprioritize-restricted-insns=@var{priority} @gol
815 -msched-costly-dep=@var{dependence_type} @gol
816 -minsert-sched-nops=@var{scheme} @gol
817 -mcall-sysv  -mcall-netbsd @gol
818 -maix-struct-return  -msvr4-struct-return @gol
819 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
820 -mblock-move-inline-limit=@var{num} @gol
821 -misel -mno-isel @gol
822 -misel=yes  -misel=no @gol
823 -mspe -mno-spe @gol
824 -mspe=yes  -mspe=no @gol
825 -mpaired @gol
826 -mgen-cell-microcode -mwarn-cell-microcode @gol
827 -mvrsave -mno-vrsave @gol
828 -mmulhw -mno-mulhw @gol
829 -mdlmzb -mno-dlmzb @gol
830 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
831 -mprototype  -mno-prototype @gol
832 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
833 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
834 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
835 -mno-recip-precision @gol
836 -mveclibabi=@var{type} -mfriz -mno-friz @gol
837 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
838 -msave-toc-indirect -mno-save-toc-indirect}
840 @emph{RX Options}
841 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
842 -mcpu=@gol
843 -mbig-endian-data -mlittle-endian-data @gol
844 -msmall-data @gol
845 -msim  -mno-sim@gol
846 -mas100-syntax -mno-as100-syntax@gol
847 -mrelax@gol
848 -mmax-constant-size=@gol
849 -mint-register=@gol
850 -mpid@gol
851 -msave-acc-in-interrupts}
853 @emph{S/390 and zSeries Options}
854 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
855 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
856 -mlong-double-64 -mlong-double-128 @gol
857 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
858 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
859 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
860 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
861 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
863 @emph{Score Options}
864 @gccoptlist{-meb -mel @gol
865 -mnhwloop @gol
866 -muls @gol
867 -mmac @gol
868 -mscore5 -mscore5u -mscore7 -mscore7d}
870 @emph{SH Options}
871 @gccoptlist{-m1  -m2  -m2e @gol
872 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
873 -m3  -m3e @gol
874 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
875 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
876 -m5-64media  -m5-64media-nofpu @gol
877 -m5-32media  -m5-32media-nofpu @gol
878 -m5-compact  -m5-compact-nofpu @gol
879 -mb  -ml  -mdalign  -mrelax @gol
880 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
881 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
882 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
883 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
884 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
885 -maccumulate-outgoing-args -minvalid-symbols -msoft-atomic @gol
886 -mbranch-cost=@var{num} -mcbranchdi -mcmpeqdi -mfused-madd -mpretend-cmove @gol
887 -menable-tas}
889 @emph{Solaris 2 Options}
890 @gccoptlist{-mimpure-text  -mno-impure-text @gol
891 -pthreads -pthread}
893 @emph{SPARC Options}
894 @gccoptlist{-mcpu=@var{cpu-type} @gol
895 -mtune=@var{cpu-type} @gol
896 -mcmodel=@var{code-model} @gol
897 -mmemory-model=@var{mem-model} @gol
898 -m32  -m64  -mapp-regs  -mno-app-regs @gol
899 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
900 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
901 -mhard-quad-float  -msoft-quad-float @gol
902 -mlittle-endian @gol
903 -mstack-bias  -mno-stack-bias @gol
904 -munaligned-doubles  -mno-unaligned-doubles @gol
905 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
906 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
907 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
908 -mfix-at697f}
910 @emph{SPU Options}
911 @gccoptlist{-mwarn-reloc -merror-reloc @gol
912 -msafe-dma -munsafe-dma @gol
913 -mbranch-hints @gol
914 -msmall-mem -mlarge-mem -mstdmain @gol
915 -mfixed-range=@var{register-range} @gol
916 -mea32 -mea64 @gol
917 -maddress-space-conversion -mno-address-space-conversion @gol
918 -mcache-size=@var{cache-size} @gol
919 -matomic-updates -mno-atomic-updates}
921 @emph{System V Options}
922 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
924 @emph{TILE-Gx Options}
925 @gccoptlist{-mcpu=CPU -m32 -m64}
927 @emph{TILEPro Options}
928 @gccoptlist{-mcpu=CPU -m32}
930 @emph{V850 Options}
931 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
932 -mprolog-function  -mno-prolog-function  -mspace @gol
933 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
934 -mapp-regs  -mno-app-regs @gol
935 -mdisable-callt  -mno-disable-callt @gol
936 -mv850e2v3 @gol
937 -mv850e2 @gol
938 -mv850e1 -mv850es @gol
939 -mv850e @gol
940 -mv850  -mbig-switch}
942 @emph{VAX Options}
943 @gccoptlist{-mg  -mgnu  -munix}
945 @emph{VMS Options}
946 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
947 -mpointer-size=@var{size}}
949 @emph{VxWorks Options}
950 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
951 -Xbind-lazy  -Xbind-now}
953 @emph{x86-64 Options}
954 See i386 and x86-64 Options.
956 @emph{Xstormy16 Options}
957 @gccoptlist{-msim}
959 @emph{Xtensa Options}
960 @gccoptlist{-mconst16 -mno-const16 @gol
961 -mfused-madd  -mno-fused-madd @gol
962 -mforce-no-pic @gol
963 -mserialize-volatile  -mno-serialize-volatile @gol
964 -mtext-section-literals  -mno-text-section-literals @gol
965 -mtarget-align  -mno-target-align @gol
966 -mlongcalls  -mno-longcalls}
968 @emph{zSeries Options}
969 See S/390 and zSeries Options.
971 @item Code Generation Options
972 @xref{Code Gen Options,,Options for Code Generation Conventions}.
973 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
974 -ffixed-@var{reg}  -fexceptions @gol
975 -fnon-call-exceptions  -funwind-tables @gol
976 -fasynchronous-unwind-tables @gol
977 -finhibit-size-directive  -finstrument-functions @gol
978 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
979 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
980 -fno-common  -fno-ident @gol
981 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
982 -fno-jump-tables @gol
983 -frecord-gcc-switches @gol
984 -freg-struct-return  -fshort-enums @gol
985 -fshort-double  -fshort-wchar @gol
986 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
987 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
988 -fno-stack-limit -fsplit-stack @gol
989 -fleading-underscore  -ftls-model=@var{model} @gol
990 -ftrapv  -fwrapv  -fbounds-check @gol
991 -fvisibility -fstrict-volatile-bitfields}
992 @end table
994 @menu
995 * Overall Options::     Controlling the kind of output:
996                         an executable, object files, assembler files,
997                         or preprocessed source.
998 * C Dialect Options::   Controlling the variant of C language compiled.
999 * C++ Dialect Options:: Variations on C++.
1000 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1001                         and Objective-C++.
1002 * Language Independent Options:: Controlling how diagnostics should be
1003                         formatted.
1004 * Warning Options::     How picky should the compiler be?
1005 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
1006 * Optimize Options::    How much optimization?
1007 * Preprocessor Options:: Controlling header files and macro definitions.
1008                          Also, getting dependency information for Make.
1009 * Assembler Options::   Passing options to the assembler.
1010 * Link Options::        Specifying libraries and so on.
1011 * Directory Options::   Where to find header files and libraries.
1012                         Where to find the compiler executable files.
1013 * Spec Files::          How to pass switches to sub-processes.
1014 * Target Options::      Running a cross-compiler, or an old version of GCC.
1015 @end menu
1017 @node Overall Options
1018 @section Options Controlling the Kind of Output
1020 Compilation can involve up to four stages: preprocessing, compilation
1021 proper, assembly and linking, always in that order.  GCC is capable of
1022 preprocessing and compiling several files either into several
1023 assembler input files, or into one assembler input file; then each
1024 assembler input file produces an object file, and linking combines all
1025 the object files (those newly compiled, and those specified as input)
1026 into an executable file.
1028 @cindex file name suffix
1029 For any given input file, the file name suffix determines what kind of
1030 compilation is done:
1032 @table @gcctabopt
1033 @item @var{file}.c
1034 C source code that must be preprocessed.
1036 @item @var{file}.i
1037 C source code that should not be preprocessed.
1039 @item @var{file}.ii
1040 C++ source code that should not be preprocessed.
1042 @item @var{file}.m
1043 Objective-C source code.  Note that you must link with the @file{libobjc}
1044 library to make an Objective-C program work.
1046 @item @var{file}.mi
1047 Objective-C source code that should not be preprocessed.
1049 @item @var{file}.mm
1050 @itemx @var{file}.M
1051 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1052 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1053 to a literal capital M@.
1055 @item @var{file}.mii
1056 Objective-C++ source code that should not be preprocessed.
1058 @item @var{file}.h
1059 C, C++, Objective-C or Objective-C++ header file to be turned into a
1060 precompiled header (default), or C, C++ header file to be turned into an
1061 Ada spec (via the @option{-fdump-ada-spec} switch).
1063 @item @var{file}.cc
1064 @itemx @var{file}.cp
1065 @itemx @var{file}.cxx
1066 @itemx @var{file}.cpp
1067 @itemx @var{file}.CPP
1068 @itemx @var{file}.c++
1069 @itemx @var{file}.C
1070 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1071 the last two letters must both be literally @samp{x}.  Likewise,
1072 @samp{.C} refers to a literal capital C@.
1074 @item @var{file}.mm
1075 @itemx @var{file}.M
1076 Objective-C++ source code that must be preprocessed.
1078 @item @var{file}.mii
1079 Objective-C++ source code that should not be preprocessed.
1081 @item @var{file}.hh
1082 @itemx @var{file}.H
1083 @itemx @var{file}.hp
1084 @itemx @var{file}.hxx
1085 @itemx @var{file}.hpp
1086 @itemx @var{file}.HPP
1087 @itemx @var{file}.h++
1088 @itemx @var{file}.tcc
1089 C++ header file to be turned into a precompiled header or Ada spec.
1091 @item @var{file}.f
1092 @itemx @var{file}.for
1093 @itemx @var{file}.ftn
1094 Fixed form Fortran source code that should not be preprocessed.
1096 @item @var{file}.F
1097 @itemx @var{file}.FOR
1098 @itemx @var{file}.fpp
1099 @itemx @var{file}.FPP
1100 @itemx @var{file}.FTN
1101 Fixed form Fortran source code that must be preprocessed (with the traditional
1102 preprocessor).
1104 @item @var{file}.f90
1105 @itemx @var{file}.f95
1106 @itemx @var{file}.f03
1107 @itemx @var{file}.f08
1108 Free form Fortran source code that should not be preprocessed.
1110 @item @var{file}.F90
1111 @itemx @var{file}.F95
1112 @itemx @var{file}.F03
1113 @itemx @var{file}.F08
1114 Free form Fortran source code that must be preprocessed (with the
1115 traditional preprocessor).
1117 @item @var{file}.go
1118 Go source code.
1120 @c FIXME: Descriptions of Java file types.
1121 @c @var{file}.java
1122 @c @var{file}.class
1123 @c @var{file}.zip
1124 @c @var{file}.jar
1126 @item @var{file}.ads
1127 Ada source code file that contains a library unit declaration (a
1128 declaration of a package, subprogram, or generic, or a generic
1129 instantiation), or a library unit renaming declaration (a package,
1130 generic, or subprogram renaming declaration).  Such files are also
1131 called @dfn{specs}.
1133 @item @var{file}.adb
1134 Ada source code file containing a library unit body (a subprogram or
1135 package body).  Such files are also called @dfn{bodies}.
1137 @c GCC also knows about some suffixes for languages not yet included:
1138 @c Pascal:
1139 @c @var{file}.p
1140 @c @var{file}.pas
1141 @c Ratfor:
1142 @c @var{file}.r
1144 @item @var{file}.s
1145 Assembler code.
1147 @item @var{file}.S
1148 @itemx @var{file}.sx
1149 Assembler code that must be preprocessed.
1151 @item @var{other}
1152 An object file to be fed straight into linking.
1153 Any file name with no recognized suffix is treated this way.
1154 @end table
1156 @opindex x
1157 You can specify the input language explicitly with the @option{-x} option:
1159 @table @gcctabopt
1160 @item -x @var{language}
1161 Specify explicitly the @var{language} for the following input files
1162 (rather than letting the compiler choose a default based on the file
1163 name suffix).  This option applies to all following input files until
1164 the next @option{-x} option.  Possible values for @var{language} are:
1165 @smallexample
1166 c  c-header  cpp-output
1167 c++  c++-header  c++-cpp-output
1168 objective-c  objective-c-header  objective-c-cpp-output
1169 objective-c++ objective-c++-header objective-c++-cpp-output
1170 assembler  assembler-with-cpp
1172 f77  f77-cpp-input f95  f95-cpp-input
1174 java
1175 @end smallexample
1177 @item -x none
1178 Turn off any specification of a language, so that subsequent files are
1179 handled according to their file name suffixes (as they are if @option{-x}
1180 has not been used at all).
1182 @item -pass-exit-codes
1183 @opindex pass-exit-codes
1184 Normally the @command{gcc} program will exit with the code of 1 if any
1185 phase of the compiler returns a non-success return code.  If you specify
1186 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1187 numerically highest error produced by any phase that returned an error
1188 indication.  The C, C++, and Fortran frontends return 4, if an internal
1189 compiler error is encountered.
1190 @end table
1192 If you only want some of the stages of compilation, you can use
1193 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1194 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1195 @command{gcc} is to stop.  Note that some combinations (for example,
1196 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1198 @table @gcctabopt
1199 @item -c
1200 @opindex c
1201 Compile or assemble the source files, but do not link.  The linking
1202 stage simply is not done.  The ultimate output is in the form of an
1203 object file for each source file.
1205 By default, the object file name for a source file is made by replacing
1206 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1208 Unrecognized input files, not requiring compilation or assembly, are
1209 ignored.
1211 @item -S
1212 @opindex S
1213 Stop after the stage of compilation proper; do not assemble.  The output
1214 is in the form of an assembler code file for each non-assembler input
1215 file specified.
1217 By default, the assembler file name for a source file is made by
1218 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1220 Input files that don't require compilation are ignored.
1222 @item -E
1223 @opindex E
1224 Stop after the preprocessing stage; do not run the compiler proper.  The
1225 output is in the form of preprocessed source code, which is sent to the
1226 standard output.
1228 Input files that don't require preprocessing are ignored.
1230 @cindex output file option
1231 @item -o @var{file}
1232 @opindex o
1233 Place output in file @var{file}.  This applies regardless to whatever
1234 sort of output is being produced, whether it be an executable file,
1235 an object file, an assembler file or preprocessed C code.
1237 If @option{-o} is not specified, the default is to put an executable
1238 file in @file{a.out}, the object file for
1239 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1240 assembler file in @file{@var{source}.s}, a precompiled header file in
1241 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1242 standard output.
1244 @item -v
1245 @opindex v
1246 Print (on standard error output) the commands executed to run the stages
1247 of compilation.  Also print the version number of the compiler driver
1248 program and of the preprocessor and the compiler proper.
1250 @item -###
1251 @opindex ###
1252 Like @option{-v} except the commands are not executed and arguments
1253 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1254 This is useful for shell scripts to capture the driver-generated command lines.
1256 @item -pipe
1257 @opindex pipe
1258 Use pipes rather than temporary files for communication between the
1259 various stages of compilation.  This fails to work on some systems where
1260 the assembler is unable to read from a pipe; but the GNU assembler has
1261 no trouble.
1263 @item --help
1264 @opindex help
1265 Print (on the standard output) a description of the command-line options
1266 understood by @command{gcc}.  If the @option{-v} option is also specified
1267 then @option{--help} will also be passed on to the various processes
1268 invoked by @command{gcc}, so that they can display the command-line options
1269 they accept.  If the @option{-Wextra} option has also been specified
1270 (prior to the @option{--help} option), then command-line options that
1271 have no documentation associated with them will also be displayed.
1273 @item --target-help
1274 @opindex target-help
1275 Print (on the standard output) a description of target-specific command-line
1276 options for each tool.  For some targets extra target-specific
1277 information may also be printed.
1279 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1280 Print (on the standard output) a description of the command-line
1281 options understood by the compiler that fit into all specified classes
1282 and qualifiers.  These are the supported classes:
1284 @table @asis
1285 @item @samp{optimizers}
1286 This will display all of the optimization options supported by the
1287 compiler.
1289 @item @samp{warnings}
1290 This will display all of the options controlling warning messages
1291 produced by the compiler.
1293 @item @samp{target}
1294 This will display target-specific options.  Unlike the
1295 @option{--target-help} option however, target-specific options of the
1296 linker and assembler will not be displayed.  This is because those
1297 tools do not currently support the extended @option{--help=} syntax.
1299 @item @samp{params}
1300 This will display the values recognized by the @option{--param}
1301 option.
1303 @item @var{language}
1304 This will display the options supported for @var{language}, where
1305 @var{language} is the name of one of the languages supported in this
1306 version of GCC@.
1308 @item @samp{common}
1309 This will display the options that are common to all languages.
1310 @end table
1312 These are the supported qualifiers:
1314 @table @asis
1315 @item @samp{undocumented}
1316 Display only those options that are undocumented.
1318 @item @samp{joined}
1319 Display options taking an argument that appears after an equal
1320 sign in the same continuous piece of text, such as:
1321 @samp{--help=target}.
1323 @item @samp{separate}
1324 Display options taking an argument that appears as a separate word
1325 following the original option, such as: @samp{-o output-file}.
1326 @end table
1328 Thus for example to display all the undocumented target-specific
1329 switches supported by the compiler the following can be used:
1331 @smallexample
1332 --help=target,undocumented
1333 @end smallexample
1335 The sense of a qualifier can be inverted by prefixing it with the
1336 @samp{^} character, so for example to display all binary warning
1337 options (i.e., ones that are either on or off and that do not take an
1338 argument) that have a description, use:
1340 @smallexample
1341 --help=warnings,^joined,^undocumented
1342 @end smallexample
1344 The argument to @option{--help=} should not consist solely of inverted
1345 qualifiers.
1347 Combining several classes is possible, although this usually
1348 restricts the output by so much that there is nothing to display.  One
1349 case where it does work however is when one of the classes is
1350 @var{target}.  So for example to display all the target-specific
1351 optimization options the following can be used:
1353 @smallexample
1354 --help=target,optimizers
1355 @end smallexample
1357 The @option{--help=} option can be repeated on the command line.  Each
1358 successive use will display its requested class of options, skipping
1359 those that have already been displayed.
1361 If the @option{-Q} option appears on the command line before the
1362 @option{--help=} option, then the descriptive text displayed by
1363 @option{--help=} is changed.  Instead of describing the displayed
1364 options, an indication is given as to whether the option is enabled,
1365 disabled or set to a specific value (assuming that the compiler
1366 knows this at the point where the @option{--help=} option is used).
1368 Here is a truncated example from the ARM port of @command{gcc}:
1370 @smallexample
1371   % gcc -Q -mabi=2 --help=target -c
1372   The following options are target specific:
1373   -mabi=                                2
1374   -mabort-on-noreturn                   [disabled]
1375   -mapcs                                [disabled]
1376 @end smallexample
1378 The output is sensitive to the effects of previous command-line
1379 options, so for example it is possible to find out which optimizations
1380 are enabled at @option{-O2} by using:
1382 @smallexample
1383 -Q -O2 --help=optimizers
1384 @end smallexample
1386 Alternatively you can discover which binary optimizations are enabled
1387 by @option{-O3} by using:
1389 @smallexample
1390 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1391 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1392 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1393 @end smallexample
1395 @item -no-canonical-prefixes
1396 @opindex no-canonical-prefixes
1397 Do not expand any symbolic links, resolve references to @samp{/../}
1398 or @samp{/./}, or make the path absolute when generating a relative
1399 prefix.
1401 @item --version
1402 @opindex version
1403 Display the version number and copyrights of the invoked GCC@.
1405 @item -wrapper
1406 @opindex wrapper
1407 Invoke all subcommands under a wrapper program.  The name of the
1408 wrapper program and its parameters are passed as a comma separated
1409 list.
1411 @smallexample
1412 gcc -c t.c -wrapper gdb,--args
1413 @end smallexample
1415 This will invoke all subprograms of @command{gcc} under
1416 @samp{gdb --args}, thus the invocation of @command{cc1} will be
1417 @samp{gdb --args cc1 @dots{}}.
1419 @item -fplugin=@var{name}.so
1420 Load the plugin code in file @var{name}.so, assumed to be a
1421 shared object to be dlopen'd by the compiler.  The base name of
1422 the shared object file is used to identify the plugin for the
1423 purposes of argument parsing (See
1424 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1425 Each plugin should define the callback functions specified in the
1426 Plugins API.
1428 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1429 Define an argument called @var{key} with a value of @var{value}
1430 for the plugin called @var{name}.
1432 @item -fdump-ada-spec@r{[}-slim@r{]}
1433 For C and C++ source and include files, generate corresponding Ada
1434 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1435 GNAT User's Guide}, which provides detailed documentation on this feature.
1437 @item -fdump-go-spec=@var{file}
1438 For input files in any language, generate corresponding Go
1439 declarations in @var{file}.  This generates Go @code{const},
1440 @code{type}, @code{var}, and @code{func} declarations which may be a
1441 useful way to start writing a Go interface to code written in some
1442 other language.
1444 @include @value{srcdir}/../libiberty/at-file.texi
1445 @end table
1447 @node Invoking G++
1448 @section Compiling C++ Programs
1450 @cindex suffixes for C++ source
1451 @cindex C++ source file suffixes
1452 C++ source files conventionally use one of the suffixes @samp{.C},
1453 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1454 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1455 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1456 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1457 files with these names and compiles them as C++ programs even if you
1458 call the compiler the same way as for compiling C programs (usually
1459 with the name @command{gcc}).
1461 @findex g++
1462 @findex c++
1463 However, the use of @command{gcc} does not add the C++ library.
1464 @command{g++} is a program that calls GCC and treats @samp{.c},
1465 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1466 files unless @option{-x} is used, and automatically specifies linking
1467 against the C++ library.  This program is also useful when
1468 precompiling a C header file with a @samp{.h} extension for use in C++
1469 compilations.  On many systems, @command{g++} is also installed with
1470 the name @command{c++}.
1472 @cindex invoking @command{g++}
1473 When you compile C++ programs, you may specify many of the same
1474 command-line options that you use for compiling programs in any
1475 language; or command-line options meaningful for C and related
1476 languages; or options that are meaningful only for C++ programs.
1477 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1478 explanations of options for languages related to C@.
1479 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1480 explanations of options that are meaningful only for C++ programs.
1482 @node C Dialect Options
1483 @section Options Controlling C Dialect
1484 @cindex dialect options
1485 @cindex language dialect options
1486 @cindex options, dialect
1488 The following options control the dialect of C (or languages derived
1489 from C, such as C++, Objective-C and Objective-C++) that the compiler
1490 accepts:
1492 @table @gcctabopt
1493 @cindex ANSI support
1494 @cindex ISO support
1495 @item -ansi
1496 @opindex ansi
1497 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1498 equivalent to @samp{-std=c++98}.
1500 This turns off certain features of GCC that are incompatible with ISO
1501 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1502 such as the @code{asm} and @code{typeof} keywords, and
1503 predefined macros such as @code{unix} and @code{vax} that identify the
1504 type of system you are using.  It also enables the undesirable and
1505 rarely used ISO trigraph feature.  For the C compiler,
1506 it disables recognition of C++ style @samp{//} comments as well as
1507 the @code{inline} keyword.
1509 The alternate keywords @code{__asm__}, @code{__extension__},
1510 @code{__inline__} and @code{__typeof__} continue to work despite
1511 @option{-ansi}.  You would not want to use them in an ISO C program, of
1512 course, but it is useful to put them in header files that might be included
1513 in compilations done with @option{-ansi}.  Alternate predefined macros
1514 such as @code{__unix__} and @code{__vax__} are also available, with or
1515 without @option{-ansi}.
1517 The @option{-ansi} option does not cause non-ISO programs to be
1518 rejected gratuitously.  For that, @option{-pedantic} is required in
1519 addition to @option{-ansi}.  @xref{Warning Options}.
1521 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1522 option is used.  Some header files may notice this macro and refrain
1523 from declaring certain functions or defining certain macros that the
1524 ISO standard doesn't call for; this is to avoid interfering with any
1525 programs that might use these names for other things.
1527 Functions that would normally be built in but do not have semantics
1528 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1529 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1530 built-in functions provided by GCC}, for details of the functions
1531 affected.
1533 @item -std=
1534 @opindex std
1535 Determine the language standard. @xref{Standards,,Language Standards
1536 Supported by GCC}, for details of these standard versions.  This option
1537 is currently only supported when compiling C or C++.
1539 The compiler can accept several base standards, such as @samp{c90} or
1540 @samp{c++98}, and GNU dialects of those standards, such as
1541 @samp{gnu90} or @samp{gnu++98}.  By specifying a base standard, the
1542 compiler will accept all programs following that standard and those
1543 using GNU extensions that do not contradict it.  For example,
1544 @samp{-std=c90} turns off certain features of GCC that are
1545 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1546 keywords, but not other GNU extensions that do not have a meaning in
1547 ISO C90, such as omitting the middle term of a @code{?:}
1548 expression. On the other hand, by specifying a GNU dialect of a
1549 standard, all features the compiler support are enabled, even when
1550 those features change the meaning of the base standard and some
1551 strict-conforming programs may be rejected.  The particular standard
1552 is used by @option{-pedantic} to identify which features are GNU
1553 extensions given that version of the standard. For example
1554 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1555 comments, while @samp{-std=gnu99 -pedantic} would not.
1557 A value for this option must be provided; possible values are
1559 @table @samp
1560 @item c90
1561 @itemx c89
1562 @itemx iso9899:1990
1563 Support all ISO C90 programs (certain GNU extensions that conflict
1564 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1566 @item iso9899:199409
1567 ISO C90 as modified in amendment 1.
1569 @item c99
1570 @itemx c9x
1571 @itemx iso9899:1999
1572 @itemx iso9899:199x
1573 ISO C99.  Note that this standard is not yet fully supported; see
1574 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1575 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1577 @item c11
1578 @itemx c1x
1579 @itemx iso9899:2011
1580 ISO C11, the 2011 revision of the ISO C standard.
1581 Support is incomplete and experimental.  The name @samp{c1x} is
1582 deprecated.
1584 @item gnu90
1585 @itemx gnu89
1586 GNU dialect of ISO C90 (including some C99 features). This
1587 is the default for C code.
1589 @item gnu99
1590 @itemx gnu9x
1591 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1592 this will become the default.  The name @samp{gnu9x} is deprecated.
1594 @item gnu11
1595 @item gnu1x
1596 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1597 name @samp{gnu1x} is deprecated.
1599 @item c++98
1600 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1601 C++ code.
1603 @item gnu++98
1604 GNU dialect of @option{-std=c++98}.  This is the default for
1605 C++ code.
1607 @item c++11
1608 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1609 experimental, and may change in incompatible ways in future releases.
1611 @item gnu++11
1612 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1613 experimental, and may change in incompatible ways in future releases.
1614 @end table
1616 @item -fgnu89-inline
1617 @opindex fgnu89-inline
1618 The option @option{-fgnu89-inline} tells GCC to use the traditional
1619 GNU semantics for @code{inline} functions when in C99 mode.
1620 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1621 is accepted and ignored by GCC versions 4.1.3 up to but not including
1622 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1623 C99 mode.  Using this option is roughly equivalent to adding the
1624 @code{gnu_inline} function attribute to all inline functions
1625 (@pxref{Function Attributes}).
1627 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1628 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1629 specifies the default behavior).  This option was first supported in
1630 GCC 4.3.  This option is not supported in @option{-std=c90} or
1631 @option{-std=gnu90} mode.
1633 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1634 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1635 in effect for @code{inline} functions.  @xref{Common Predefined
1636 Macros,,,cpp,The C Preprocessor}.
1638 @item -aux-info @var{filename}
1639 @opindex aux-info
1640 Output to the given filename prototyped declarations for all functions
1641 declared and/or defined in a translation unit, including those in header
1642 files.  This option is silently ignored in any language other than C@.
1644 Besides declarations, the file indicates, in comments, the origin of
1645 each declaration (source file and line), whether the declaration was
1646 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1647 @samp{O} for old, respectively, in the first character after the line
1648 number and the colon), and whether it came from a declaration or a
1649 definition (@samp{C} or @samp{F}, respectively, in the following
1650 character).  In the case of function definitions, a K&R-style list of
1651 arguments followed by their declarations is also provided, inside
1652 comments, after the declaration.
1654 @item -fallow-parameterless-variadic-functions
1655 Accept variadic functions without named parameters.
1657 Although it is possible to define such a function, this is not very
1658 useful as it is not possible to read the arguments.  This is only
1659 supported for C as this construct is allowed by C++.
1661 @item -fno-asm
1662 @opindex fno-asm
1663 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1664 keyword, so that code can use these words as identifiers.  You can use
1665 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1666 instead.  @option{-ansi} implies @option{-fno-asm}.
1668 In C++, this switch only affects the @code{typeof} keyword, since
1669 @code{asm} and @code{inline} are standard keywords.  You may want to
1670 use the @option{-fno-gnu-keywords} flag instead, which has the same
1671 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1672 switch only affects the @code{asm} and @code{typeof} keywords, since
1673 @code{inline} is a standard keyword in ISO C99.
1675 @item -fno-builtin
1676 @itemx -fno-builtin-@var{function}
1677 @opindex fno-builtin
1678 @cindex built-in functions
1679 Don't recognize built-in functions that do not begin with
1680 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1681 functions provided by GCC}, for details of the functions affected,
1682 including those which are not built-in functions when @option{-ansi} or
1683 @option{-std} options for strict ISO C conformance are used because they
1684 do not have an ISO standard meaning.
1686 GCC normally generates special code to handle certain built-in functions
1687 more efficiently; for instance, calls to @code{alloca} may become single
1688 instructions which adjust the stack directly, and calls to @code{memcpy}
1689 may become inline copy loops.  The resulting code is often both smaller
1690 and faster, but since the function calls no longer appear as such, you
1691 cannot set a breakpoint on those calls, nor can you change the behavior
1692 of the functions by linking with a different library.  In addition,
1693 when a function is recognized as a built-in function, GCC may use
1694 information about that function to warn about problems with calls to
1695 that function, or to generate more efficient code, even if the
1696 resulting code still contains calls to that function.  For example,
1697 warnings are given with @option{-Wformat} for bad calls to
1698 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1699 known not to modify global memory.
1701 With the @option{-fno-builtin-@var{function}} option
1702 only the built-in function @var{function} is
1703 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1704 function is named that is not built-in in this version of GCC, this
1705 option is ignored.  There is no corresponding
1706 @option{-fbuiltin-@var{function}} option; if you wish to enable
1707 built-in functions selectively when using @option{-fno-builtin} or
1708 @option{-ffreestanding}, you may define macros such as:
1710 @smallexample
1711 #define abs(n)          __builtin_abs ((n))
1712 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1713 @end smallexample
1715 @item -fhosted
1716 @opindex fhosted
1717 @cindex hosted environment
1719 Assert that compilation takes place in a hosted environment.  This implies
1720 @option{-fbuiltin}.  A hosted environment is one in which the
1721 entire standard library is available, and in which @code{main} has a return
1722 type of @code{int}.  Examples are nearly everything except a kernel.
1723 This is equivalent to @option{-fno-freestanding}.
1725 @item -ffreestanding
1726 @opindex ffreestanding
1727 @cindex hosted environment
1729 Assert that compilation takes place in a freestanding environment.  This
1730 implies @option{-fno-builtin}.  A freestanding environment
1731 is one in which the standard library may not exist, and program startup may
1732 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1733 This is equivalent to @option{-fno-hosted}.
1735 @xref{Standards,,Language Standards Supported by GCC}, for details of
1736 freestanding and hosted environments.
1738 @item -fopenmp
1739 @opindex fopenmp
1740 @cindex OpenMP parallel
1741 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1742 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1743 compiler generates parallel code according to the OpenMP Application
1744 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1745 implies @option{-pthread}, and thus is only supported on targets that
1746 have support for @option{-pthread}.
1748 @item -fgnu-tm
1749 @opindex fgnu-tm
1750 When the option @option{-fgnu-tm} is specified, the compiler will
1751 generate code for the Linux variant of Intel's current Transactional
1752 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1753 an experimental feature whose interface may change in future versions
1754 of GCC, as the official specification changes.  Please note that not
1755 all architectures are supported for this feature.
1757 For more information on GCC's support for transactional memory,
1758 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1759 Transactional Memory Library}.
1761 Note that the transactional memory feature is not supported with
1762 non-call exceptions (@option{-fnon-call-exceptions}).
1764 @item -fms-extensions
1765 @opindex fms-extensions
1766 Accept some non-standard constructs used in Microsoft header files.
1768 In C++ code, this allows member names in structures to be similar
1769 to previous types declarations.
1771 @smallexample
1772 typedef int UOW;
1773 struct ABC @{
1774   UOW UOW;
1776 @end smallexample
1778 Some cases of unnamed fields in structures and unions are only
1779 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1780 fields within structs/unions}, for details.
1782 @item -fplan9-extensions
1783 Accept some non-standard constructs used in Plan 9 code.
1785 This enables @option{-fms-extensions}, permits passing pointers to
1786 structures with anonymous fields to functions that expect pointers to
1787 elements of the type of the field, and permits referring to anonymous
1788 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1789 struct/union fields within structs/unions}, for details.  This is only
1790 supported for C, not C++.
1792 @item -trigraphs
1793 @opindex trigraphs
1794 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1795 options for strict ISO C conformance) implies @option{-trigraphs}.
1797 @cindex traditional C language
1798 @cindex C language, traditional
1799 @item -traditional
1800 @itemx -traditional-cpp
1801 @opindex traditional-cpp
1802 @opindex traditional
1803 Formerly, these options caused GCC to attempt to emulate a pre-standard
1804 C compiler.  They are now only supported with the @option{-E} switch.
1805 The preprocessor continues to support a pre-standard mode.  See the GNU
1806 CPP manual for details.
1808 @item -fcond-mismatch
1809 @opindex fcond-mismatch
1810 Allow conditional expressions with mismatched types in the second and
1811 third arguments.  The value of such an expression is void.  This option
1812 is not supported for C++.
1814 @item -flax-vector-conversions
1815 @opindex flax-vector-conversions
1816 Allow implicit conversions between vectors with differing numbers of
1817 elements and/or incompatible element types.  This option should not be
1818 used for new code.
1820 @item -funsigned-char
1821 @opindex funsigned-char
1822 Let the type @code{char} be unsigned, like @code{unsigned char}.
1824 Each kind of machine has a default for what @code{char} should
1825 be.  It is either like @code{unsigned char} by default or like
1826 @code{signed char} by default.
1828 Ideally, a portable program should always use @code{signed char} or
1829 @code{unsigned char} when it depends on the signedness of an object.
1830 But many programs have been written to use plain @code{char} and
1831 expect it to be signed, or expect it to be unsigned, depending on the
1832 machines they were written for.  This option, and its inverse, let you
1833 make such a program work with the opposite default.
1835 The type @code{char} is always a distinct type from each of
1836 @code{signed char} or @code{unsigned char}, even though its behavior
1837 is always just like one of those two.
1839 @item -fsigned-char
1840 @opindex fsigned-char
1841 Let the type @code{char} be signed, like @code{signed char}.
1843 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1844 the negative form of @option{-funsigned-char}.  Likewise, the option
1845 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1847 @item -fsigned-bitfields
1848 @itemx -funsigned-bitfields
1849 @itemx -fno-signed-bitfields
1850 @itemx -fno-unsigned-bitfields
1851 @opindex fsigned-bitfields
1852 @opindex funsigned-bitfields
1853 @opindex fno-signed-bitfields
1854 @opindex fno-unsigned-bitfields
1855 These options control whether a bit-field is signed or unsigned, when the
1856 declaration does not use either @code{signed} or @code{unsigned}.  By
1857 default, such a bit-field is signed, because this is consistent: the
1858 basic integer types such as @code{int} are signed types.
1859 @end table
1861 @node C++ Dialect Options
1862 @section Options Controlling C++ Dialect
1864 @cindex compiler options, C++
1865 @cindex C++ options, command-line
1866 @cindex options, C++
1867 This section describes the command-line options that are only meaningful
1868 for C++ programs; but you can also use most of the GNU compiler options
1869 regardless of what language your program is in.  For example, you
1870 might compile a file @code{firstClass.C} like this:
1872 @smallexample
1873 g++ -g -frepo -O -c firstClass.C
1874 @end smallexample
1876 @noindent
1877 In this example, only @option{-frepo} is an option meant
1878 only for C++ programs; you can use the other options with any
1879 language supported by GCC@.
1881 Here is a list of options that are @emph{only} for compiling C++ programs:
1883 @table @gcctabopt
1885 @item -fabi-version=@var{n}
1886 @opindex fabi-version
1887 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1888 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1889 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1890 the version that conforms most closely to the C++ ABI specification.
1891 Therefore, the ABI obtained using version 0 will change as ABI bugs
1892 are fixed.
1894 The default is version 2.
1896 Version 3 corrects an error in mangling a constant address as a
1897 template argument.
1899 Version 4, which first appeared in G++ 4.5, implements a standard
1900 mangling for vector types.
1902 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1903 attribute const/volatile on function pointer types, decltype of a
1904 plain decl, and use of a function parameter in the declaration of
1905 another parameter.
1907 Version 6, which first appeared in G++ 4.7, corrects the promotion
1908 behavior of C++11 scoped enums and the mangling of template argument
1909 packs, const/static_cast, prefix ++ and --, and a class scope function
1910 used as a template argument.
1912 See also @option{-Wabi}.
1914 @item -fno-access-control
1915 @opindex fno-access-control
1916 Turn off all access checking.  This switch is mainly useful for working
1917 around bugs in the access control code.
1919 @item -fcheck-new
1920 @opindex fcheck-new
1921 Check that the pointer returned by @code{operator new} is non-null
1922 before attempting to modify the storage allocated.  This check is
1923 normally unnecessary because the C++ standard specifies that
1924 @code{operator new} will only return @code{0} if it is declared
1925 @samp{throw()}, in which case the compiler will always check the
1926 return value even without this option.  In all other cases, when
1927 @code{operator new} has a non-empty exception specification, memory
1928 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1929 @samp{new (nothrow)}.
1931 @item -fconserve-space
1932 @opindex fconserve-space
1933 Put uninitialized or run-time-initialized global variables into the
1934 common segment, as C does.  This saves space in the executable at the
1935 cost of not diagnosing duplicate definitions.  If you compile with this
1936 flag and your program mysteriously crashes after @code{main()} has
1937 completed, you may have an object that is being destroyed twice because
1938 two definitions were merged.
1940 This option is no longer useful on most targets, now that support has
1941 been added for putting variables into BSS without making them common.
1943 @item -fconstexpr-depth=@var{n}
1944 @opindex fconstexpr-depth
1945 Set the maximum nested evaluation depth for C++11 constexpr functions
1946 to @var{n}.  A limit is needed to detect endless recursion during
1947 constant expression evaluation.  The minimum specified by the standard
1948 is 512.
1950 @item -fdeduce-init-list
1951 @opindex fdeduce-init-list
1952 Enable deduction of a template type parameter as
1953 std::initializer_list from a brace-enclosed initializer list, i.e.
1955 @smallexample
1956 template <class T> auto forward(T t) -> decltype (realfn (t))
1958   return realfn (t);
1961 void f()
1963   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1965 @end smallexample
1967 This deduction was implemented as a possible extension to the
1968 originally proposed semantics for the C++11 standard, but was not part
1969 of the final standard, so it is disabled by default.  This option is
1970 deprecated, and may be removed in a future version of G++.
1972 @item -ffriend-injection
1973 @opindex ffriend-injection
1974 Inject friend functions into the enclosing namespace, so that they are
1975 visible outside the scope of the class in which they are declared.
1976 Friend functions were documented to work this way in the old Annotated
1977 C++ Reference Manual, and versions of G++ before 4.1 always worked
1978 that way.  However, in ISO C++ a friend function that is not declared
1979 in an enclosing scope can only be found using argument dependent
1980 lookup.  This option causes friends to be injected as they were in
1981 earlier releases.
1983 This option is for compatibility, and may be removed in a future
1984 release of G++.
1986 @item -fno-elide-constructors
1987 @opindex fno-elide-constructors
1988 The C++ standard allows an implementation to omit creating a temporary
1989 that is only used to initialize another object of the same type.
1990 Specifying this option disables that optimization, and forces G++ to
1991 call the copy constructor in all cases.
1993 @item -fno-enforce-eh-specs
1994 @opindex fno-enforce-eh-specs
1995 Don't generate code to check for violation of exception specifications
1996 at run time.  This option violates the C++ standard, but may be useful
1997 for reducing code size in production builds, much like defining
1998 @samp{NDEBUG}.  This does not give user code permission to throw
1999 exceptions in violation of the exception specifications; the compiler
2000 will still optimize based on the specifications, so throwing an
2001 unexpected exception will result in undefined behavior.
2003 @item -ffor-scope
2004 @itemx -fno-for-scope
2005 @opindex ffor-scope
2006 @opindex fno-for-scope
2007 If @option{-ffor-scope} is specified, the scope of variables declared in
2008 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2009 as specified by the C++ standard.
2010 If @option{-fno-for-scope} is specified, the scope of variables declared in
2011 a @i{for-init-statement} extends to the end of the enclosing scope,
2012 as was the case in old versions of G++, and other (traditional)
2013 implementations of C++.
2015 The default if neither flag is given to follow the standard,
2016 but to allow and give a warning for old-style code that would
2017 otherwise be invalid, or have different behavior.
2019 @item -fno-gnu-keywords
2020 @opindex fno-gnu-keywords
2021 Do not recognize @code{typeof} as a keyword, so that code can use this
2022 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2023 @option{-ansi} implies @option{-fno-gnu-keywords}.
2025 @item -fno-implicit-templates
2026 @opindex fno-implicit-templates
2027 Never emit code for non-inline templates that are instantiated
2028 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2029 @xref{Template Instantiation}, for more information.
2031 @item -fno-implicit-inline-templates
2032 @opindex fno-implicit-inline-templates
2033 Don't emit code for implicit instantiations of inline templates, either.
2034 The default is to handle inlines differently so that compiles with and
2035 without optimization will need the same set of explicit instantiations.
2037 @item -fno-implement-inlines
2038 @opindex fno-implement-inlines
2039 To save space, do not emit out-of-line copies of inline functions
2040 controlled by @samp{#pragma implementation}.  This will cause linker
2041 errors if these functions are not inlined everywhere they are called.
2043 @item -fms-extensions
2044 @opindex fms-extensions
2045 Disable pedantic warnings about constructs used in MFC, such as implicit
2046 int and getting a pointer to member function via non-standard syntax.
2048 @item -fno-nonansi-builtins
2049 @opindex fno-nonansi-builtins
2050 Disable built-in declarations of functions that are not mandated by
2051 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2052 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2054 @item -fnothrow-opt
2055 @opindex fnothrow-opt
2056 Treat a @code{throw()} exception specification as though it were a
2057 @code{noexcept} specification to reduce or eliminate the text size
2058 overhead relative to a function with no exception specification.  If
2059 the function has local variables of types with non-trivial
2060 destructors, the exception specification will actually make the
2061 function smaller because the EH cleanups for those variables can be
2062 optimized away.  The semantic effect is that an exception thrown out of
2063 a function with such an exception specification will result in a call
2064 to @code{terminate} rather than @code{unexpected}.
2066 @item -fno-operator-names
2067 @opindex fno-operator-names
2068 Do not treat the operator name keywords @code{and}, @code{bitand},
2069 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2070 synonyms as keywords.
2072 @item -fno-optional-diags
2073 @opindex fno-optional-diags
2074 Disable diagnostics that the standard says a compiler does not need to
2075 issue.  Currently, the only such diagnostic issued by G++ is the one for
2076 a name having multiple meanings within a class.
2078 @item -fpermissive
2079 @opindex fpermissive
2080 Downgrade some diagnostics about nonconformant code from errors to
2081 warnings.  Thus, using @option{-fpermissive} will allow some
2082 nonconforming code to compile.
2084 @item -fno-pretty-templates
2085 @opindex fno-pretty-templates
2086 When an error message refers to a specialization of a function
2087 template, the compiler will normally print the signature of the
2088 template followed by the template arguments and any typedefs or
2089 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2090 rather than @code{void f(int)}) so that it's clear which template is
2091 involved.  When an error message refers to a specialization of a class
2092 template, the compiler will omit any template arguments that match
2093 the default template arguments for that template.  If either of these
2094 behaviors make it harder to understand the error message rather than
2095 easier, using @option{-fno-pretty-templates} will disable them.
2097 @item -frepo
2098 @opindex frepo
2099 Enable automatic template instantiation at link time.  This option also
2100 implies @option{-fno-implicit-templates}.  @xref{Template
2101 Instantiation}, for more information.
2103 @item -fno-rtti
2104 @opindex fno-rtti
2105 Disable generation of information about every class with virtual
2106 functions for use by the C++ run-time type identification features
2107 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2108 of the language, you can save some space by using this flag.  Note that
2109 exception handling uses the same information, but it will generate it as
2110 needed. The @samp{dynamic_cast} operator can still be used for casts that
2111 do not require run-time type information, i.e.@: casts to @code{void *} or to
2112 unambiguous base classes.
2114 @item -fstats
2115 @opindex fstats
2116 Emit statistics about front-end processing at the end of the compilation.
2117 This information is generally only useful to the G++ development team.
2119 @item -fstrict-enums
2120 @opindex fstrict-enums
2121 Allow the compiler to optimize using the assumption that a value of
2122 enumerated type can only be one of the values of the enumeration (as
2123 defined in the C++ standard; basically, a value that can be
2124 represented in the minimum number of bits needed to represent all the
2125 enumerators).  This assumption may not be valid if the program uses a
2126 cast to convert an arbitrary integer value to the enumerated type.
2128 @item -ftemplate-backtrace-limit=@var{n}
2129 @opindex ftemplate-backtrace-limit
2130 Set the maximum number of template instantiation notes for a single
2131 warning or error to @var{n}.  The default value is 10.
2133 @item -ftemplate-depth=@var{n}
2134 @opindex ftemplate-depth
2135 Set the maximum instantiation depth for template classes to @var{n}.
2136 A limit on the template instantiation depth is needed to detect
2137 endless recursions during template class instantiation.  ANSI/ISO C++
2138 conforming programs must not rely on a maximum depth greater than 17
2139 (changed to 1024 in C++11).  The default value is 900, as the compiler
2140 can run out of stack space before hitting 1024 in some situations.
2142 @item -fno-threadsafe-statics
2143 @opindex fno-threadsafe-statics
2144 Do not emit the extra code to use the routines specified in the C++
2145 ABI for thread-safe initialization of local statics.  You can use this
2146 option to reduce code size slightly in code that doesn't need to be
2147 thread-safe.
2149 @item -fuse-cxa-atexit
2150 @opindex fuse-cxa-atexit
2151 Register destructors for objects with static storage duration with the
2152 @code{__cxa_atexit} function rather than the @code{atexit} function.
2153 This option is required for fully standards-compliant handling of static
2154 destructors, but will only work if your C library supports
2155 @code{__cxa_atexit}.
2157 @item -fno-use-cxa-get-exception-ptr
2158 @opindex fno-use-cxa-get-exception-ptr
2159 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2160 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2161 if the runtime routine is not available.
2163 @item -fvisibility-inlines-hidden
2164 @opindex fvisibility-inlines-hidden
2165 This switch declares that the user does not attempt to compare
2166 pointers to inline functions or methods where the addresses of the two functions
2167 were taken in different shared objects.
2169 The effect of this is that GCC may, effectively, mark inline methods with
2170 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2171 appear in the export table of a DSO and do not require a PLT indirection
2172 when used within the DSO@.  Enabling this option can have a dramatic effect
2173 on load and link times of a DSO as it massively reduces the size of the
2174 dynamic export table when the library makes heavy use of templates.
2176 The behavior of this switch is not quite the same as marking the
2177 methods as hidden directly, because it does not affect static variables
2178 local to the function or cause the compiler to deduce that
2179 the function is defined in only one shared object.
2181 You may mark a method as having a visibility explicitly to negate the
2182 effect of the switch for that method.  For example, if you do want to
2183 compare pointers to a particular inline method, you might mark it as
2184 having default visibility.  Marking the enclosing class with explicit
2185 visibility will have no effect.
2187 Explicitly instantiated inline methods are unaffected by this option
2188 as their linkage might otherwise cross a shared library boundary.
2189 @xref{Template Instantiation}.
2191 @item -fvisibility-ms-compat
2192 @opindex fvisibility-ms-compat
2193 This flag attempts to use visibility settings to make GCC's C++
2194 linkage model compatible with that of Microsoft Visual Studio.
2196 The flag makes these changes to GCC's linkage model:
2198 @enumerate
2199 @item
2200 It sets the default visibility to @code{hidden}, like
2201 @option{-fvisibility=hidden}.
2203 @item
2204 Types, but not their members, are not hidden by default.
2206 @item
2207 The One Definition Rule is relaxed for types without explicit
2208 visibility specifications that are defined in more than one different
2209 shared object: those declarations are permitted if they would have
2210 been permitted when this option was not used.
2211 @end enumerate
2213 In new code it is better to use @option{-fvisibility=hidden} and
2214 export those classes that are intended to be externally visible.
2215 Unfortunately it is possible for code to rely, perhaps accidentally,
2216 on the Visual Studio behavior.
2218 Among the consequences of these changes are that static data members
2219 of the same type with the same name but defined in different shared
2220 objects will be different, so changing one will not change the other;
2221 and that pointers to function members defined in different shared
2222 objects may not compare equal.  When this flag is given, it is a
2223 violation of the ODR to define types with the same name differently.
2225 @item -fno-weak
2226 @opindex fno-weak
2227 Do not use weak symbol support, even if it is provided by the linker.
2228 By default, G++ will use weak symbols if they are available.  This
2229 option exists only for testing, and should not be used by end-users;
2230 it will result in inferior code and has no benefits.  This option may
2231 be removed in a future release of G++.
2233 @item -nostdinc++
2234 @opindex nostdinc++
2235 Do not search for header files in the standard directories specific to
2236 C++, but do still search the other standard directories.  (This option
2237 is used when building the C++ library.)
2238 @end table
2240 In addition, these optimization, warning, and code generation options
2241 have meanings only for C++ programs:
2243 @table @gcctabopt
2244 @item -fno-default-inline
2245 @opindex fno-default-inline
2246 Do not assume @samp{inline} for functions defined inside a class scope.
2247 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2248 functions will have linkage like inline functions; they just won't be
2249 inlined by default.
2251 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2252 @opindex Wabi
2253 @opindex Wno-abi
2254 Warn when G++ generates code that is probably not compatible with the
2255 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2256 all such cases, there are probably some cases that are not warned about,
2257 even though G++ is generating incompatible code.  There may also be
2258 cases where warnings are emitted even though the code that is generated
2259 will be compatible.
2261 You should rewrite your code to avoid these warnings if you are
2262 concerned about the fact that code generated by G++ may not be binary
2263 compatible with code generated by other compilers.
2265 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2267 @itemize @bullet
2269 @item
2270 A template with a non-type template parameter of reference type is
2271 mangled incorrectly:
2272 @smallexample
2273 extern int N;
2274 template <int &> struct S @{@};
2275 void n (S<N>) @{2@}
2276 @end smallexample
2278 This is fixed in @option{-fabi-version=3}.
2280 @item
2281 SIMD vector types declared using @code{__attribute ((vector_size))} are
2282 mangled in a non-standard way that does not allow for overloading of
2283 functions taking vectors of different sizes.
2285 The mangling is changed in @option{-fabi-version=4}.
2286 @end itemize
2288 The known incompatibilities in @option{-fabi-version=1} include:
2290 @itemize @bullet
2292 @item
2293 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2294 pack data into the same byte as a base class.  For example:
2296 @smallexample
2297 struct A @{ virtual void f(); int f1 : 1; @};
2298 struct B : public A @{ int f2 : 1; @};
2299 @end smallexample
2301 @noindent
2302 In this case, G++ will place @code{B::f2} into the same byte
2303 as@code{A::f1}; other compilers will not.  You can avoid this problem
2304 by explicitly padding @code{A} so that its size is a multiple of the
2305 byte size on your platform; that will cause G++ and other compilers to
2306 layout @code{B} identically.
2308 @item
2309 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2310 tail padding when laying out virtual bases.  For example:
2312 @smallexample
2313 struct A @{ virtual void f(); char c1; @};
2314 struct B @{ B(); char c2; @};
2315 struct C : public A, public virtual B @{@};
2316 @end smallexample
2318 @noindent
2319 In this case, G++ will not place @code{B} into the tail-padding for
2320 @code{A}; other compilers will.  You can avoid this problem by
2321 explicitly padding @code{A} so that its size is a multiple of its
2322 alignment (ignoring virtual base classes); that will cause G++ and other
2323 compilers to layout @code{C} identically.
2325 @item
2326 Incorrect handling of bit-fields with declared widths greater than that
2327 of their underlying types, when the bit-fields appear in a union.  For
2328 example:
2330 @smallexample
2331 union U @{ int i : 4096; @};
2332 @end smallexample
2334 @noindent
2335 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2336 union too small by the number of bits in an @code{int}.
2338 @item
2339 Empty classes can be placed at incorrect offsets.  For example:
2341 @smallexample
2342 struct A @{@};
2344 struct B @{
2345   A a;
2346   virtual void f ();
2349 struct C : public B, public A @{@};
2350 @end smallexample
2352 @noindent
2353 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2354 it should be placed at offset zero.  G++ mistakenly believes that the
2355 @code{A} data member of @code{B} is already at offset zero.
2357 @item
2358 Names of template functions whose types involve @code{typename} or
2359 template template parameters can be mangled incorrectly.
2361 @smallexample
2362 template <typename Q>
2363 void f(typename Q::X) @{@}
2365 template <template <typename> class Q>
2366 void f(typename Q<int>::X) @{@}
2367 @end smallexample
2369 @noindent
2370 Instantiations of these templates may be mangled incorrectly.
2372 @end itemize
2374 It also warns about psABI-related changes.  The known psABI changes at this
2375 point include:
2377 @itemize @bullet
2379 @item
2380 For SysV/x86-64, unions with @code{long double} members are 
2381 passed in memory as specified in psABI.  For example:
2383 @smallexample
2384 union U @{
2385   long double ld;
2386   int i;
2388 @end smallexample
2390 @noindent
2391 @code{union U} is always passed in memory.
2393 @end itemize
2395 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2396 @opindex Wctor-dtor-privacy
2397 @opindex Wno-ctor-dtor-privacy
2398 Warn when a class seems unusable because all the constructors or
2399 destructors in that class are private, and it has neither friends nor
2400 public static member functions.
2402 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2403 @opindex Wdelete-non-virtual-dtor
2404 @opindex Wno-delete-non-virtual-dtor
2405 Warn when @samp{delete} is used to destroy an instance of a class that
2406 has virtual functions and non-virtual destructor. It is unsafe to delete
2407 an instance of a derived class through a pointer to a base class if the
2408 base class does not have a virtual destructor.  This warning is enabled
2409 by @option{-Wall}.
2411 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2412 @opindex Wnarrowing
2413 @opindex Wno-narrowing
2414 Warn when a narrowing conversion prohibited by C++11 occurs within
2415 @samp{@{ @}}, e.g.
2417 @smallexample
2418 int i = @{ 2.2 @}; // error: narrowing from double to int
2419 @end smallexample
2421 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2423 With -std=c++11, @option{-Wno-narrowing} suppresses the diagnostic
2424 required by the standard.  Note that this does not affect the meaning
2425 of well-formed code; narrowing conversions are still considered
2426 ill-formed in SFINAE context.
2428 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2429 @opindex Wnoexcept
2430 @opindex Wno-noexcept
2431 Warn when a noexcept-expression evaluates to false because of a call
2432 to a function that does not have a non-throwing exception
2433 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2434 the compiler to never throw an exception.
2436 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2437 @opindex Wnon-virtual-dtor
2438 @opindex Wno-non-virtual-dtor
2439 Warn when a class has virtual functions and accessible non-virtual
2440 destructor, in which case it would be possible but unsafe to delete
2441 an instance of a derived class through a pointer to the base class.
2442 This warning is also enabled if @option{-Weffc++} is specified.
2444 @item -Wreorder @r{(C++ and Objective-C++ only)}
2445 @opindex Wreorder
2446 @opindex Wno-reorder
2447 @cindex reordering, warning
2448 @cindex warning for reordering of member initializers
2449 Warn when the order of member initializers given in the code does not
2450 match the order in which they must be executed.  For instance:
2452 @smallexample
2453 struct A @{
2454   int i;
2455   int j;
2456   A(): j (0), i (1) @{ @}
2458 @end smallexample
2460 The compiler will rearrange the member initializers for @samp{i}
2461 and @samp{j} to match the declaration order of the members, emitting
2462 a warning to that effect.  This warning is enabled by @option{-Wall}.
2463 @end table
2465 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2467 @table @gcctabopt
2468 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2469 @opindex Weffc++
2470 @opindex Wno-effc++
2471 Warn about violations of the following style guidelines from Scott Meyers'
2472 @cite{Effective C++, Second Edition} book:
2474 @itemize @bullet
2475 @item
2476 Item 11:  Define a copy constructor and an assignment operator for classes
2477 with dynamically allocated memory.
2479 @item
2480 Item 12:  Prefer initialization to assignment in constructors.
2482 @item
2483 Item 14:  Make destructors virtual in base classes.
2485 @item
2486 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2488 @item
2489 Item 23:  Don't try to return a reference when you must return an object.
2491 @end itemize
2493 Also warn about violations of the following style guidelines from
2494 Scott Meyers' @cite{More Effective C++} book:
2496 @itemize @bullet
2497 @item
2498 Item 6:  Distinguish between prefix and postfix forms of increment and
2499 decrement operators.
2501 @item
2502 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2504 @end itemize
2506 When selecting this option, be aware that the standard library
2507 headers do not obey all of these guidelines; use @samp{grep -v}
2508 to filter out those warnings.
2510 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2511 @opindex Wstrict-null-sentinel
2512 @opindex Wno-strict-null-sentinel
2513 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2514 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2515 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2516 it is guaranteed to be of the same size as a pointer.  But this use is
2517 not portable across different compilers.
2519 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2520 @opindex Wno-non-template-friend
2521 @opindex Wnon-template-friend
2522 Disable warnings when non-templatized friend functions are declared
2523 within a template.  Since the advent of explicit template specification
2524 support in G++, if the name of the friend is an unqualified-id (i.e.,
2525 @samp{friend foo(int)}), the C++ language specification demands that the
2526 friend declare or define an ordinary, nontemplate function.  (Section
2527 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2528 could be interpreted as a particular specialization of a templatized
2529 function.  Because this non-conforming behavior is no longer the default
2530 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2531 check existing code for potential trouble spots and is on by default.
2532 This new compiler behavior can be turned off with
2533 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2534 but disables the helpful warning.
2536 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2537 @opindex Wold-style-cast
2538 @opindex Wno-old-style-cast
2539 Warn if an old-style (C-style) cast to a non-void type is used within
2540 a C++ program.  The new-style casts (@samp{dynamic_cast},
2541 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2542 less vulnerable to unintended effects and much easier to search for.
2544 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2545 @opindex Woverloaded-virtual
2546 @opindex Wno-overloaded-virtual
2547 @cindex overloaded virtual function, warning
2548 @cindex warning for overloaded virtual function
2549 Warn when a function declaration hides virtual functions from a
2550 base class.  For example, in:
2552 @smallexample
2553 struct A @{
2554   virtual void f();
2557 struct B: public A @{
2558   void f(int);
2560 @end smallexample
2562 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2563 like:
2565 @smallexample
2566 B* b;
2567 b->f();
2568 @end smallexample
2570 will fail to compile.
2572 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2573 @opindex Wno-pmf-conversions
2574 @opindex Wpmf-conversions
2575 Disable the diagnostic for converting a bound pointer to member function
2576 to a plain pointer.
2578 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2579 @opindex Wsign-promo
2580 @opindex Wno-sign-promo
2581 Warn when overload resolution chooses a promotion from unsigned or
2582 enumerated type to a signed type, over a conversion to an unsigned type of
2583 the same size.  Previous versions of G++ would try to preserve
2584 unsignedness, but the standard mandates the current behavior.
2586 @smallexample
2587 struct A @{
2588   operator int ();
2589   A& operator = (int);
2592 main ()
2594   A a,b;
2595   a = b;
2597 @end smallexample
2599 In this example, G++ will synthesize a default @samp{A& operator =
2600 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2601 @end table
2603 @node Objective-C and Objective-C++ Dialect Options
2604 @section Options Controlling Objective-C and Objective-C++ Dialects
2606 @cindex compiler options, Objective-C and Objective-C++
2607 @cindex Objective-C and Objective-C++ options, command-line
2608 @cindex options, Objective-C and Objective-C++
2609 (NOTE: This manual does not describe the Objective-C and Objective-C++
2610 languages themselves.  @xref{Standards,,Language Standards
2611 Supported by GCC}, for references.)
2613 This section describes the command-line options that are only meaningful
2614 for Objective-C and Objective-C++ programs, but you can also use most of
2615 the language-independent GNU compiler options.
2616 For example, you might compile a file @code{some_class.m} like this:
2618 @smallexample
2619 gcc -g -fgnu-runtime -O -c some_class.m
2620 @end smallexample
2622 @noindent
2623 In this example, @option{-fgnu-runtime} is an option meant only for
2624 Objective-C and Objective-C++ programs; you can use the other options with
2625 any language supported by GCC@.
2627 Note that since Objective-C is an extension of the C language, Objective-C
2628 compilations may also use options specific to the C front-end (e.g.,
2629 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2630 C++-specific options (e.g., @option{-Wabi}).
2632 Here is a list of options that are @emph{only} for compiling Objective-C
2633 and Objective-C++ programs:
2635 @table @gcctabopt
2636 @item -fconstant-string-class=@var{class-name}
2637 @opindex fconstant-string-class
2638 Use @var{class-name} as the name of the class to instantiate for each
2639 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2640 class name is @code{NXConstantString} if the GNU runtime is being used, and
2641 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2642 @option{-fconstant-cfstrings} option, if also present, will override the
2643 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2644 to be laid out as constant CoreFoundation strings.
2646 @item -fgnu-runtime
2647 @opindex fgnu-runtime
2648 Generate object code compatible with the standard GNU Objective-C
2649 runtime.  This is the default for most types of systems.
2651 @item -fnext-runtime
2652 @opindex fnext-runtime
2653 Generate output compatible with the NeXT runtime.  This is the default
2654 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2655 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2656 used.
2658 @item -fno-nil-receivers
2659 @opindex fno-nil-receivers
2660 Assume that all Objective-C message dispatches (@code{[receiver
2661 message:arg]}) in this translation unit ensure that the receiver is
2662 not @code{nil}.  This allows for more efficient entry points in the
2663 runtime to be used.  This option is only available in conjunction with
2664 the NeXT runtime and ABI version 0 or 1.
2666 @item -fobjc-abi-version=@var{n}
2667 @opindex fobjc-abi-version
2668 Use version @var{n} of the Objective-C ABI for the selected runtime.
2669 This option is currently supported only for the NeXT runtime.  In that
2670 case, Version 0 is the traditional (32-bit) ABI without support for
2671 properties and other Objective-C 2.0 additions.  Version 1 is the
2672 traditional (32-bit) ABI with support for properties and other
2673 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2674 nothing is specified, the default is Version 0 on 32-bit target
2675 machines, and Version 2 on 64-bit target machines.
2677 @item -fobjc-call-cxx-cdtors
2678 @opindex fobjc-call-cxx-cdtors
2679 For each Objective-C class, check if any of its instance variables is a
2680 C++ object with a non-trivial default constructor.  If so, synthesize a
2681 special @code{- (id) .cxx_construct} instance method which will run
2682 non-trivial default constructors on any such instance variables, in order,
2683 and then return @code{self}.  Similarly, check if any instance variable
2684 is a C++ object with a non-trivial destructor, and if so, synthesize a
2685 special @code{- (void) .cxx_destruct} method which will run
2686 all such default destructors, in reverse order.
2688 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2689 methods thusly generated will only operate on instance variables
2690 declared in the current Objective-C class, and not those inherited
2691 from superclasses.  It is the responsibility of the Objective-C
2692 runtime to invoke all such methods in an object's inheritance
2693 hierarchy.  The @code{- (id) .cxx_construct} methods will be invoked
2694 by the runtime immediately after a new object instance is allocated;
2695 the @code{- (void) .cxx_destruct} methods will be invoked immediately
2696 before the runtime deallocates an object instance.
2698 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2699 support for invoking the @code{- (id) .cxx_construct} and
2700 @code{- (void) .cxx_destruct} methods.
2702 @item -fobjc-direct-dispatch
2703 @opindex fobjc-direct-dispatch
2704 Allow fast jumps to the message dispatcher.  On Darwin this is
2705 accomplished via the comm page.
2707 @item -fobjc-exceptions
2708 @opindex fobjc-exceptions
2709 Enable syntactic support for structured exception handling in
2710 Objective-C, similar to what is offered by C++ and Java.  This option
2711 is required to use the Objective-C keywords @code{@@try},
2712 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2713 @code{@@synchronized}.  This option is available with both the GNU
2714 runtime and the NeXT runtime (but not available in conjunction with
2715 the NeXT runtime on Mac OS X 10.2 and earlier).
2717 @item -fobjc-gc
2718 @opindex fobjc-gc
2719 Enable garbage collection (GC) in Objective-C and Objective-C++
2720 programs.  This option is only available with the NeXT runtime; the
2721 GNU runtime has a different garbage collection implementation that
2722 does not require special compiler flags.
2724 @item -fobjc-nilcheck
2725 @opindex fobjc-nilcheck
2726 For the NeXT runtime with version 2 of the ABI, check for a nil
2727 receiver in method invocations before doing the actual method call.
2728 This is the default and can be disabled using
2729 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2730 checked for nil in this way no matter what this flag is set to.
2731 Currently this flag does nothing when the GNU runtime, or an older
2732 version of the NeXT runtime ABI, is used.
2734 @item -fobjc-std=objc1
2735 @opindex fobjc-std
2736 Conform to the language syntax of Objective-C 1.0, the language
2737 recognized by GCC 4.0.  This only affects the Objective-C additions to
2738 the C/C++ language; it does not affect conformance to C/C++ standards,
2739 which is controlled by the separate C/C++ dialect option flags.  When
2740 this option is used with the Objective-C or Objective-C++ compiler,
2741 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2742 This is useful if you need to make sure that your Objective-C code can
2743 be compiled with older versions of GCC@.
2745 @item -freplace-objc-classes
2746 @opindex freplace-objc-classes
2747 Emit a special marker instructing @command{ld(1)} not to statically link in
2748 the resulting object file, and allow @command{dyld(1)} to load it in at
2749 run time instead.  This is used in conjunction with the Fix-and-Continue
2750 debugging mode, where the object file in question may be recompiled and
2751 dynamically reloaded in the course of program execution, without the need
2752 to restart the program itself.  Currently, Fix-and-Continue functionality
2753 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2754 and later.
2756 @item -fzero-link
2757 @opindex fzero-link
2758 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2759 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2760 compile time) with static class references that get initialized at load time,
2761 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2762 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2763 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2764 for individual class implementations to be modified during program execution.
2765 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2766 regardless of command-line options.
2768 @item -gen-decls
2769 @opindex gen-decls
2770 Dump interface declarations for all classes seen in the source file to a
2771 file named @file{@var{sourcename}.decl}.
2773 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2774 @opindex Wassign-intercept
2775 @opindex Wno-assign-intercept
2776 Warn whenever an Objective-C assignment is being intercepted by the
2777 garbage collector.
2779 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2780 @opindex Wno-protocol
2781 @opindex Wprotocol
2782 If a class is declared to implement a protocol, a warning is issued for
2783 every method in the protocol that is not implemented by the class.  The
2784 default behavior is to issue a warning for every method not explicitly
2785 implemented in the class, even if a method implementation is inherited
2786 from the superclass.  If you use the @option{-Wno-protocol} option, then
2787 methods inherited from the superclass are considered to be implemented,
2788 and no warning is issued for them.
2790 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2791 @opindex Wselector
2792 @opindex Wno-selector
2793 Warn if multiple methods of different types for the same selector are
2794 found during compilation.  The check is performed on the list of methods
2795 in the final stage of compilation.  Additionally, a check is performed
2796 for each selector appearing in a @code{@@selector(@dots{})}
2797 expression, and a corresponding method for that selector has been found
2798 during compilation.  Because these checks scan the method table only at
2799 the end of compilation, these warnings are not produced if the final
2800 stage of compilation is not reached, for example because an error is
2801 found during compilation, or because the @option{-fsyntax-only} option is
2802 being used.
2804 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2805 @opindex Wstrict-selector-match
2806 @opindex Wno-strict-selector-match
2807 Warn if multiple methods with differing argument and/or return types are
2808 found for a given selector when attempting to send a message using this
2809 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2810 is off (which is the default behavior), the compiler will omit such warnings
2811 if any differences found are confined to types that share the same size
2812 and alignment.
2814 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2815 @opindex Wundeclared-selector
2816 @opindex Wno-undeclared-selector
2817 Warn if a @code{@@selector(@dots{})} expression referring to an
2818 undeclared selector is found.  A selector is considered undeclared if no
2819 method with that name has been declared before the
2820 @code{@@selector(@dots{})} expression, either explicitly in an
2821 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2822 an @code{@@implementation} section.  This option always performs its
2823 checks as soon as a @code{@@selector(@dots{})} expression is found,
2824 while @option{-Wselector} only performs its checks in the final stage of
2825 compilation.  This also enforces the coding style convention
2826 that methods and selectors must be declared before being used.
2828 @item -print-objc-runtime-info
2829 @opindex print-objc-runtime-info
2830 Generate C header describing the largest structure that is passed by
2831 value, if any.
2833 @end table
2835 @node Language Independent Options
2836 @section Options to Control Diagnostic Messages Formatting
2837 @cindex options to control diagnostics formatting
2838 @cindex diagnostic messages
2839 @cindex message formatting
2841 Traditionally, diagnostic messages have been formatted irrespective of
2842 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2843 below can be used to control the diagnostic messages formatting
2844 algorithm, e.g.@: how many characters per line, how often source location
2845 information should be reported.  Right now, only the C++ front end can
2846 honor these options.  However it is expected, in the near future, that
2847 the remaining front ends would be able to digest them correctly.
2849 @table @gcctabopt
2850 @item -fmessage-length=@var{n}
2851 @opindex fmessage-length
2852 Try to format error messages so that they fit on lines of about @var{n}
2853 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2854 the front ends supported by GCC@.  If @var{n} is zero, then no
2855 line-wrapping will be done; each error message will appear on a single
2856 line.
2858 @opindex fdiagnostics-show-location
2859 @item -fdiagnostics-show-location=once
2860 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2861 reporter to emit @emph{once} source location information; that is, in
2862 case the message is too long to fit on a single physical line and has to
2863 be wrapped, the source location won't be emitted (as prefix) again,
2864 over and over, in subsequent continuation lines.  This is the default
2865 behavior.
2867 @item -fdiagnostics-show-location=every-line
2868 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2869 messages reporter to emit the same source location information (as
2870 prefix) for physical lines that result from the process of breaking
2871 a message which is too long to fit on a single line.
2873 @item -fno-diagnostics-show-option
2874 @opindex fno-diagnostics-show-option
2875 @opindex fdiagnostics-show-option
2876 By default, each diagnostic emitted includes text indicating the
2877 command-line option that directly controls the diagnostic (if such an
2878 option is known to the diagnostic machinery).  Specifying the
2879 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2881 @end table
2883 @node Warning Options
2884 @section Options to Request or Suppress Warnings
2885 @cindex options to control warnings
2886 @cindex warning messages
2887 @cindex messages, warning
2888 @cindex suppressing warnings
2890 Warnings are diagnostic messages that report constructions that
2891 are not inherently erroneous but that are risky or suggest there
2892 may have been an error.
2894 The following language-independent options do not enable specific
2895 warnings but control the kinds of diagnostics produced by GCC@.
2897 @table @gcctabopt
2898 @cindex syntax checking
2899 @item -fsyntax-only
2900 @opindex fsyntax-only
2901 Check the code for syntax errors, but don't do anything beyond that.
2903 @item -fmax-errors=@var{n}
2904 @opindex fmax-errors
2905 Limits the maximum number of error messages to @var{n}, at which point
2906 GCC bails out rather than attempting to continue processing the source
2907 code.  If @var{n} is 0 (the default), there is no limit on the number
2908 of error messages produced.  If @option{-Wfatal-errors} is also
2909 specified, then @option{-Wfatal-errors} takes precedence over this
2910 option.
2912 @item -w
2913 @opindex w
2914 Inhibit all warning messages.
2916 @item -Werror
2917 @opindex Werror
2918 @opindex Wno-error
2919 Make all warnings into errors.
2921 @item -Werror=
2922 @opindex Werror=
2923 @opindex Wno-error=
2924 Make the specified warning into an error.  The specifier for a warning
2925 is appended, for example @option{-Werror=switch} turns the warnings
2926 controlled by @option{-Wswitch} into errors.  This switch takes a
2927 negative form, to be used to negate @option{-Werror} for specific
2928 warnings, for example @option{-Wno-error=switch} makes
2929 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2930 is in effect.
2932 The warning message for each controllable warning includes the
2933 option that controls the warning.  That option can then be used with
2934 @option{-Werror=} and @option{-Wno-error=} as described above.
2935 (Printing of the option in the warning message can be disabled using the
2936 @option{-fno-diagnostics-show-option} flag.)
2938 Note that specifying @option{-Werror=}@var{foo} automatically implies
2939 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2940 imply anything.
2942 @item -Wfatal-errors
2943 @opindex Wfatal-errors
2944 @opindex Wno-fatal-errors
2945 This option causes the compiler to abort compilation on the first error
2946 occurred rather than trying to keep going and printing further error
2947 messages.
2949 @end table
2951 You can request many specific warnings with options beginning
2952 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2953 implicit declarations.  Each of these specific warning options also
2954 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2955 example, @option{-Wno-implicit}.  This manual lists only one of the
2956 two forms, whichever is not the default.  For further,
2957 language-specific options also refer to @ref{C++ Dialect Options} and
2958 @ref{Objective-C and Objective-C++ Dialect Options}.
2960 When an unrecognized warning option is requested (e.g.,
2961 @option{-Wunknown-warning}), GCC will emit a diagnostic stating
2962 that the option is not recognized.  However, if the @option{-Wno-} form
2963 is used, the behavior is slightly different: No diagnostic will be
2964 produced for @option{-Wno-unknown-warning} unless other diagnostics
2965 are being produced.  This allows the use of new @option{-Wno-} options
2966 with old compilers, but if something goes wrong, the compiler will
2967 warn that an unrecognized option was used.
2969 @table @gcctabopt
2970 @item -pedantic
2971 @opindex pedantic
2972 Issue all the warnings demanded by strict ISO C and ISO C++;
2973 reject all programs that use forbidden extensions, and some other
2974 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2975 version of the ISO C standard specified by any @option{-std} option used.
2977 Valid ISO C and ISO C++ programs should compile properly with or without
2978 this option (though a rare few will require @option{-ansi} or a
2979 @option{-std} option specifying the required version of ISO C)@.  However,
2980 without this option, certain GNU extensions and traditional C and C++
2981 features are supported as well.  With this option, they are rejected.
2983 @option{-pedantic} does not cause warning messages for use of the
2984 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2985 warnings are also disabled in the expression that follows
2986 @code{__extension__}.  However, only system header files should use
2987 these escape routes; application programs should avoid them.
2988 @xref{Alternate Keywords}.
2990 Some users try to use @option{-pedantic} to check programs for strict ISO
2991 C conformance.  They soon find that it does not do quite what they want:
2992 it finds some non-ISO practices, but not all---only those for which
2993 ISO C @emph{requires} a diagnostic, and some others for which
2994 diagnostics have been added.
2996 A feature to report any failure to conform to ISO C might be useful in
2997 some instances, but would require considerable additional work and would
2998 be quite different from @option{-pedantic}.  We don't have plans to
2999 support such a feature in the near future.
3001 Where the standard specified with @option{-std} represents a GNU
3002 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3003 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3004 extended dialect is based.  Warnings from @option{-pedantic} are given
3005 where they are required by the base standard.  (It would not make sense
3006 for such warnings to be given only for features not in the specified GNU
3007 C dialect, since by definition the GNU dialects of C include all
3008 features the compiler supports with the given option, and there would be
3009 nothing to warn about.)
3011 @item -pedantic-errors
3012 @opindex pedantic-errors
3013 Like @option{-pedantic}, except that errors are produced rather than
3014 warnings.
3016 @item -Wall
3017 @opindex Wall
3018 @opindex Wno-all
3019 This enables all the warnings about constructions that some users
3020 consider questionable, and that are easy to avoid (or modify to
3021 prevent the warning), even in conjunction with macros.  This also
3022 enables some language-specific warnings described in @ref{C++ Dialect
3023 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3025 @option{-Wall} turns on the following warning flags:
3027 @gccoptlist{-Waddress   @gol
3028 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3029 -Wc++11-compat  @gol
3030 -Wchar-subscripts  @gol
3031 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
3032 -Wimplicit-int @r{(C and Objective-C only)} @gol
3033 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3034 -Wcomment  @gol
3035 -Wformat   @gol
3036 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3037 -Wmaybe-uninitialized @gol
3038 -Wmissing-braces  @gol
3039 -Wnonnull  @gol
3040 -Wparentheses  @gol
3041 -Wpointer-sign  @gol
3042 -Wreorder   @gol
3043 -Wreturn-type  @gol
3044 -Wsequence-point  @gol
3045 -Wsign-compare @r{(only in C++)}  @gol
3046 -Wstrict-aliasing  @gol
3047 -Wstrict-overflow=1  @gol
3048 -Wswitch  @gol
3049 -Wtrigraphs  @gol
3050 -Wuninitialized  @gol
3051 -Wunknown-pragmas  @gol
3052 -Wunused-function  @gol
3053 -Wunused-label     @gol
3054 -Wunused-value     @gol
3055 -Wunused-variable  @gol
3056 -Wvolatile-register-var @gol
3059 Note that some warning flags are not implied by @option{-Wall}.  Some of
3060 them warn about constructions that users generally do not consider
3061 questionable, but which occasionally you might wish to check for;
3062 others warn about constructions that are necessary or hard to avoid in
3063 some cases, and there is no simple way to modify the code to suppress
3064 the warning. Some of them are enabled by @option{-Wextra} but many of
3065 them must be enabled individually.
3067 @item -Wextra
3068 @opindex W
3069 @opindex Wextra
3070 @opindex Wno-extra
3071 This enables some extra warning flags that are not enabled by
3072 @option{-Wall}. (This option used to be called @option{-W}.  The older
3073 name is still supported, but the newer name is more descriptive.)
3075 @gccoptlist{-Wclobbered  @gol
3076 -Wempty-body  @gol
3077 -Wignored-qualifiers @gol
3078 -Wmissing-field-initializers  @gol
3079 -Wmissing-parameter-type @r{(C only)}  @gol
3080 -Wold-style-declaration @r{(C only)}  @gol
3081 -Woverride-init  @gol
3082 -Wsign-compare  @gol
3083 -Wtype-limits  @gol
3084 -Wuninitialized  @gol
3085 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3086 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3089 The option @option{-Wextra} also prints warning messages for the
3090 following cases:
3092 @itemize @bullet
3094 @item
3095 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3096 @samp{>}, or @samp{>=}.
3098 @item
3099 (C++ only) An enumerator and a non-enumerator both appear in a
3100 conditional expression.
3102 @item
3103 (C++ only) Ambiguous virtual bases.
3105 @item
3106 (C++ only) Subscripting an array that has been declared @samp{register}.
3108 @item
3109 (C++ only) Taking the address of a variable that has been declared
3110 @samp{register}.
3112 @item
3113 (C++ only) A base class is not initialized in a derived class' copy
3114 constructor.
3116 @end itemize
3118 @item -Wchar-subscripts
3119 @opindex Wchar-subscripts
3120 @opindex Wno-char-subscripts
3121 Warn if an array subscript has type @code{char}.  This is a common cause
3122 of error, as programmers often forget that this type is signed on some
3123 machines.
3124 This warning is enabled by @option{-Wall}.
3126 @item -Wcomment
3127 @opindex Wcomment
3128 @opindex Wno-comment
3129 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3130 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3131 This warning is enabled by @option{-Wall}.
3133 @item -Wno-coverage-mismatch
3134 @opindex Wno-coverage-mismatch
3135 Warn if feedback profiles do not match when using the
3136 @option{-fprofile-use} option.
3137 If a source file was changed between @option{-fprofile-gen} and
3138 @option{-fprofile-use}, the files with the profile feedback can fail
3139 to match the source file and GCC cannot use the profile feedback
3140 information.  By default, this warning is enabled and is treated as an
3141 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3142 warning or @option{-Wno-error=coverage-mismatch} can be used to
3143 disable the error.  Disabling the error for this warning can result in
3144 poorly optimized code and is useful only in the
3145 case of very minor changes such as bug fixes to an existing code-base.
3146 Completely disabling the warning is not recommended.
3148 @item -Wno-cpp
3149 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3151 Suppress warning messages emitted by @code{#warning} directives.
3153 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3154 @opindex Wdouble-promotion
3155 @opindex Wno-double-promotion
3156 Give a warning when a value of type @code{float} is implicitly
3157 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3158 floating-point unit implement @code{float} in hardware, but emulate
3159 @code{double} in software.  On such a machine, doing computations
3160 using @code{double} values is much more expensive because of the
3161 overhead required for software emulation.
3163 It is easy to accidentally do computations with @code{double} because
3164 floating-point literals are implicitly of type @code{double}.  For
3165 example, in:
3166 @smallexample
3167 @group
3168 float area(float radius)
3170    return 3.14159 * radius * radius;
3172 @end group
3173 @end smallexample
3174 the compiler will perform the entire computation with @code{double}
3175 because the floating-point literal is a @code{double}.
3177 @item -Wformat
3178 @opindex Wformat
3179 @opindex Wno-format
3180 @opindex ffreestanding
3181 @opindex fno-builtin
3182 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3183 the arguments supplied have types appropriate to the format string
3184 specified, and that the conversions specified in the format string make
3185 sense.  This includes standard functions, and others specified by format
3186 attributes (@pxref{Function Attributes}), in the @code{printf},
3187 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3188 not in the C standard) families (or other target-specific families).
3189 Which functions are checked without format attributes having been
3190 specified depends on the standard version selected, and such checks of
3191 functions without the attribute specified are disabled by
3192 @option{-ffreestanding} or @option{-fno-builtin}.
3194 The formats are checked against the format features supported by GNU
3195 libc version 2.2.  These include all ISO C90 and C99 features, as well
3196 as features from the Single Unix Specification and some BSD and GNU
3197 extensions.  Other library implementations may not support all these
3198 features; GCC does not support warning about features that go beyond a
3199 particular library's limitations.  However, if @option{-pedantic} is used
3200 with @option{-Wformat}, warnings will be given about format features not
3201 in the selected standard version (but not for @code{strfmon} formats,
3202 since those are not in any version of the C standard).  @xref{C Dialect
3203 Options,,Options Controlling C Dialect}.
3205 Since @option{-Wformat} also checks for null format arguments for
3206 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3208 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3209 aspects of format checking, the options @option{-Wformat-y2k},
3210 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3211 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3212 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3214 @item -Wformat-y2k
3215 @opindex Wformat-y2k
3216 @opindex Wno-format-y2k
3217 If @option{-Wformat} is specified, also warn about @code{strftime}
3218 formats that may yield only a two-digit year.
3220 @item -Wno-format-contains-nul
3221 @opindex Wno-format-contains-nul
3222 @opindex Wformat-contains-nul
3223 If @option{-Wformat} is specified, do not warn about format strings that
3224 contain NUL bytes.
3226 @item -Wno-format-extra-args
3227 @opindex Wno-format-extra-args
3228 @opindex Wformat-extra-args
3229 If @option{-Wformat} is specified, do not warn about excess arguments to a
3230 @code{printf} or @code{scanf} format function.  The C standard specifies
3231 that such arguments are ignored.
3233 Where the unused arguments lie between used arguments that are
3234 specified with @samp{$} operand number specifications, normally
3235 warnings are still given, since the implementation could not know what
3236 type to pass to @code{va_arg} to skip the unused arguments.  However,
3237 in the case of @code{scanf} formats, this option will suppress the
3238 warning if the unused arguments are all pointers, since the Single
3239 Unix Specification says that such unused arguments are allowed.
3241 @item -Wno-format-zero-length
3242 @opindex Wno-format-zero-length
3243 @opindex Wformat-zero-length
3244 If @option{-Wformat} is specified, do not warn about zero-length formats.
3245 The C standard specifies that zero-length formats are allowed.
3247 @item -Wformat-nonliteral
3248 @opindex Wformat-nonliteral
3249 @opindex Wno-format-nonliteral
3250 If @option{-Wformat} is specified, also warn if the format string is not a
3251 string literal and so cannot be checked, unless the format function
3252 takes its format arguments as a @code{va_list}.
3254 @item -Wformat-security
3255 @opindex Wformat-security
3256 @opindex Wno-format-security
3257 If @option{-Wformat} is specified, also warn about uses of format
3258 functions that represent possible security problems.  At present, this
3259 warns about calls to @code{printf} and @code{scanf} functions where the
3260 format string is not a string literal and there are no format arguments,
3261 as in @code{printf (foo);}.  This may be a security hole if the format
3262 string came from untrusted input and contains @samp{%n}.  (This is
3263 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3264 in future warnings may be added to @option{-Wformat-security} that are not
3265 included in @option{-Wformat-nonliteral}.)
3267 @item -Wformat=2
3268 @opindex Wformat=2
3269 @opindex Wno-format=2
3270 Enable @option{-Wformat} plus format checks not included in
3271 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3272 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3274 @item -Wnonnull
3275 @opindex Wnonnull
3276 @opindex Wno-nonnull
3277 Warn about passing a null pointer for arguments marked as
3278 requiring a non-null value by the @code{nonnull} function attribute.
3280 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3281 can be disabled with the @option{-Wno-nonnull} option.
3283 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3284 @opindex Winit-self
3285 @opindex Wno-init-self
3286 Warn about uninitialized variables that are initialized with themselves.
3287 Note this option can only be used with the @option{-Wuninitialized} option.
3289 For example, GCC will warn about @code{i} being uninitialized in the
3290 following snippet only when @option{-Winit-self} has been specified:
3291 @smallexample
3292 @group
3293 int f()
3295   int i = i;
3296   return i;
3298 @end group
3299 @end smallexample
3301 @item -Wimplicit-int @r{(C and Objective-C only)}
3302 @opindex Wimplicit-int
3303 @opindex Wno-implicit-int
3304 Warn when a declaration does not specify a type.
3305 This warning is enabled by @option{-Wall}.
3307 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3308 @opindex Wimplicit-function-declaration
3309 @opindex Wno-implicit-function-declaration
3310 Give a warning whenever a function is used before being declared. In
3311 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3312 enabled by default and it is made into an error by
3313 @option{-pedantic-errors}. This warning is also enabled by
3314 @option{-Wall}.
3316 @item -Wimplicit @r{(C and Objective-C only)}
3317 @opindex Wimplicit
3318 @opindex Wno-implicit
3319 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3320 This warning is enabled by @option{-Wall}.
3322 @item -Wignored-qualifiers @r{(C and C++ only)}
3323 @opindex Wignored-qualifiers
3324 @opindex Wno-ignored-qualifiers
3325 Warn if the return type of a function has a type qualifier
3326 such as @code{const}.  For ISO C such a type qualifier has no effect,
3327 since the value returned by a function is not an lvalue.
3328 For C++, the warning is only emitted for scalar types or @code{void}.
3329 ISO C prohibits qualified @code{void} return types on function
3330 definitions, so such return types always receive a warning
3331 even without this option.
3333 This warning is also enabled by @option{-Wextra}.
3335 @item -Wmain
3336 @opindex Wmain
3337 @opindex Wno-main
3338 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3339 a function with external linkage, returning int, taking either zero
3340 arguments, two, or three arguments of appropriate types.  This warning
3341 is enabled by default in C++ and is enabled by either @option{-Wall}
3342 or @option{-pedantic}.
3344 @item -Wmissing-braces
3345 @opindex Wmissing-braces
3346 @opindex Wno-missing-braces
3347 Warn if an aggregate or union initializer is not fully bracketed.  In
3348 the following example, the initializer for @samp{a} is not fully
3349 bracketed, but that for @samp{b} is fully bracketed.
3351 @smallexample
3352 int a[2][2] = @{ 0, 1, 2, 3 @};
3353 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3354 @end smallexample
3356 This warning is enabled by @option{-Wall}.
3358 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3359 @opindex Wmissing-include-dirs
3360 @opindex Wno-missing-include-dirs
3361 Warn if a user-supplied include directory does not exist.
3363 @item -Wparentheses
3364 @opindex Wparentheses
3365 @opindex Wno-parentheses
3366 Warn if parentheses are omitted in certain contexts, such
3367 as when there is an assignment in a context where a truth value
3368 is expected, or when operators are nested whose precedence people
3369 often get confused about.
3371 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3372 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3373 interpretation from that of ordinary mathematical notation.
3375 Also warn about constructions where there may be confusion to which
3376 @code{if} statement an @code{else} branch belongs.  Here is an example of
3377 such a case:
3379 @smallexample
3380 @group
3382   if (a)
3383     if (b)
3384       foo ();
3385   else
3386     bar ();
3388 @end group
3389 @end smallexample
3391 In C/C++, every @code{else} branch belongs to the innermost possible
3392 @code{if} statement, which in this example is @code{if (b)}.  This is
3393 often not what the programmer expected, as illustrated in the above
3394 example by indentation the programmer chose.  When there is the
3395 potential for this confusion, GCC will issue a warning when this flag
3396 is specified.  To eliminate the warning, add explicit braces around
3397 the innermost @code{if} statement so there is no way the @code{else}
3398 could belong to the enclosing @code{if}.  The resulting code would
3399 look like this:
3401 @smallexample
3402 @group
3404   if (a)
3405     @{
3406       if (b)
3407         foo ();
3408       else
3409         bar ();
3410     @}
3412 @end group
3413 @end smallexample
3415 Also warn for dangerous uses of the
3416 ?: with omitted middle operand GNU extension. When the condition
3417 in the ?: operator is a boolean expression the omitted value will
3418 be always 1. Often the user expects it to be a value computed
3419 inside the conditional expression instead.
3421 This warning is enabled by @option{-Wall}.
3423 @item -Wsequence-point
3424 @opindex Wsequence-point
3425 @opindex Wno-sequence-point
3426 Warn about code that may have undefined semantics because of violations
3427 of sequence point rules in the C and C++ standards.
3429 The C and C++ standards defines the order in which expressions in a C/C++
3430 program are evaluated in terms of @dfn{sequence points}, which represent
3431 a partial ordering between the execution of parts of the program: those
3432 executed before the sequence point, and those executed after it.  These
3433 occur after the evaluation of a full expression (one which is not part
3434 of a larger expression), after the evaluation of the first operand of a
3435 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3436 function is called (but after the evaluation of its arguments and the
3437 expression denoting the called function), and in certain other places.
3438 Other than as expressed by the sequence point rules, the order of
3439 evaluation of subexpressions of an expression is not specified.  All
3440 these rules describe only a partial order rather than a total order,
3441 since, for example, if two functions are called within one expression
3442 with no sequence point between them, the order in which the functions
3443 are called is not specified.  However, the standards committee have
3444 ruled that function calls do not overlap.
3446 It is not specified when between sequence points modifications to the
3447 values of objects take effect.  Programs whose behavior depends on this
3448 have undefined behavior; the C and C++ standards specify that ``Between
3449 the previous and next sequence point an object shall have its stored
3450 value modified at most once by the evaluation of an expression.
3451 Furthermore, the prior value shall be read only to determine the value
3452 to be stored.''.  If a program breaks these rules, the results on any
3453 particular implementation are entirely unpredictable.
3455 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3456 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3457 diagnosed by this option, and it may give an occasional false positive
3458 result, but in general it has been found fairly effective at detecting
3459 this sort of problem in programs.
3461 The standard is worded confusingly, therefore there is some debate
3462 over the precise meaning of the sequence point rules in subtle cases.
3463 Links to discussions of the problem, including proposed formal
3464 definitions, may be found on the GCC readings page, at
3465 @uref{http://gcc.gnu.org/@/readings.html}.
3467 This warning is enabled by @option{-Wall} for C and C++.
3469 @item -Wreturn-type
3470 @opindex Wreturn-type
3471 @opindex Wno-return-type
3472 Warn whenever a function is defined with a return-type that defaults
3473 to @code{int}.  Also warn about any @code{return} statement with no
3474 return-value in a function whose return-type is not @code{void}
3475 (falling off the end of the function body is considered returning
3476 without a value), and about a @code{return} statement with an
3477 expression in a function whose return-type is @code{void}.
3479 For C++, a function without return type always produces a diagnostic
3480 message, even when @option{-Wno-return-type} is specified.  The only
3481 exceptions are @samp{main} and functions defined in system headers.
3483 This warning is enabled by @option{-Wall}.
3485 @item -Wswitch
3486 @opindex Wswitch
3487 @opindex Wno-switch
3488 Warn whenever a @code{switch} statement has an index of enumerated type
3489 and lacks a @code{case} for one or more of the named codes of that
3490 enumeration.  (The presence of a @code{default} label prevents this
3491 warning.)  @code{case} labels outside the enumeration range also
3492 provoke warnings when this option is used (even if there is a
3493 @code{default} label).
3494 This warning is enabled by @option{-Wall}.
3496 @item -Wswitch-default
3497 @opindex Wswitch-default
3498 @opindex Wno-switch-default
3499 Warn whenever a @code{switch} statement does not have a @code{default}
3500 case.
3502 @item -Wswitch-enum
3503 @opindex Wswitch-enum
3504 @opindex Wno-switch-enum
3505 Warn whenever a @code{switch} statement has an index of enumerated type
3506 and lacks a @code{case} for one or more of the named codes of that
3507 enumeration.  @code{case} labels outside the enumeration range also
3508 provoke warnings when this option is used.  The only difference
3509 between @option{-Wswitch} and this option is that this option gives a
3510 warning about an omitted enumeration code even if there is a
3511 @code{default} label.
3513 @item -Wsync-nand @r{(C and C++ only)}
3514 @opindex Wsync-nand
3515 @opindex Wno-sync-nand
3516 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3517 built-in functions are used.  These functions changed semantics in GCC 4.4.
3519 @item -Wtrigraphs
3520 @opindex Wtrigraphs
3521 @opindex Wno-trigraphs
3522 Warn if any trigraphs are encountered that might change the meaning of
3523 the program (trigraphs within comments are not warned about).
3524 This warning is enabled by @option{-Wall}.
3526 @item -Wunused-but-set-parameter
3527 @opindex Wunused-but-set-parameter
3528 @opindex Wno-unused-but-set-parameter
3529 Warn whenever a function parameter is assigned to, but otherwise unused
3530 (aside from its declaration).
3532 To suppress this warning use the @samp{unused} attribute
3533 (@pxref{Variable Attributes}).
3535 This warning is also enabled by @option{-Wunused} together with
3536 @option{-Wextra}.
3538 @item -Wunused-but-set-variable
3539 @opindex Wunused-but-set-variable
3540 @opindex Wno-unused-but-set-variable
3541 Warn whenever a local variable is assigned to, but otherwise unused
3542 (aside from its declaration).
3543 This warning is enabled by @option{-Wall}.
3545 To suppress this warning use the @samp{unused} attribute
3546 (@pxref{Variable Attributes}).
3548 This warning is also enabled by @option{-Wunused}, which is enabled
3549 by @option{-Wall}.
3551 @item -Wunused-function
3552 @opindex Wunused-function
3553 @opindex Wno-unused-function
3554 Warn whenever a static function is declared but not defined or a
3555 non-inline static function is unused.
3556 This warning is enabled by @option{-Wall}.
3558 @item -Wunused-label
3559 @opindex Wunused-label
3560 @opindex Wno-unused-label
3561 Warn whenever a label is declared but not used.
3562 This warning is enabled by @option{-Wall}.
3564 To suppress this warning use the @samp{unused} attribute
3565 (@pxref{Variable Attributes}).
3567 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3568 @opindex Wunused-local-typedefs
3569 Warn when a typedef locally defined in a function is not used.
3571 @item -Wunused-parameter
3572 @opindex Wunused-parameter
3573 @opindex Wno-unused-parameter
3574 Warn whenever a function parameter is unused aside from its declaration.
3576 To suppress this warning use the @samp{unused} attribute
3577 (@pxref{Variable Attributes}).
3579 @item -Wno-unused-result
3580 @opindex Wunused-result
3581 @opindex Wno-unused-result
3582 Do not warn if a caller of a function marked with attribute
3583 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3584 its return value. The default is @option{-Wunused-result}.
3586 @item -Wunused-variable
3587 @opindex Wunused-variable
3588 @opindex Wno-unused-variable
3589 Warn whenever a local variable or non-constant static variable is unused
3590 aside from its declaration.
3591 This warning is enabled by @option{-Wall}.
3593 To suppress this warning use the @samp{unused} attribute
3594 (@pxref{Variable Attributes}).
3596 @item -Wunused-value
3597 @opindex Wunused-value
3598 @opindex Wno-unused-value
3599 Warn whenever a statement computes a result that is explicitly not
3600 used. To suppress this warning cast the unused expression to
3601 @samp{void}. This includes an expression-statement or the left-hand
3602 side of a comma expression that contains no side effects. For example,
3603 an expression such as @samp{x[i,j]} will cause a warning, while
3604 @samp{x[(void)i,j]} will not.
3606 This warning is enabled by @option{-Wall}.
3608 @item -Wunused
3609 @opindex Wunused
3610 @opindex Wno-unused
3611 All the above @option{-Wunused} options combined.
3613 In order to get a warning about an unused function parameter, you must
3614 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3615 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3617 @item -Wuninitialized
3618 @opindex Wuninitialized
3619 @opindex Wno-uninitialized
3620 Warn if an automatic variable is used without first being initialized
3621 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3622 warn if a non-static reference or non-static @samp{const} member
3623 appears in a class without constructors.
3625 If you want to warn about code that uses the uninitialized value of the
3626 variable in its own initializer, use the @option{-Winit-self} option.
3628 These warnings occur for individual uninitialized or clobbered
3629 elements of structure, union or array variables as well as for
3630 variables that are uninitialized or clobbered as a whole.  They do
3631 not occur for variables or elements declared @code{volatile}.  Because
3632 these warnings depend on optimization, the exact variables or elements
3633 for which there are warnings will depend on the precise optimization
3634 options and version of GCC used.
3636 Note that there may be no warning about a variable that is used only
3637 to compute a value that itself is never used, because such
3638 computations may be deleted by data flow analysis before the warnings
3639 are printed.
3641 @item -Wmaybe-uninitialized
3642 @opindex Wmaybe-uninitialized
3643 @opindex Wno-maybe-uninitialized
3644 For an automatic variable, if there exists a path from the function
3645 entry to a use of the variable that is initialized, but there exist
3646 some other paths the variable is not initialized, the compiler will
3647 emit a warning if it can not prove the uninitialized paths do not
3648 happen at run time. These warnings are made optional because GCC is
3649 not smart enough to see all the reasons why the code might be correct
3650 despite appearing to have an error.  Here is one example of how
3651 this can happen:
3653 @smallexample
3654 @group
3656   int x;
3657   switch (y)
3658     @{
3659     case 1: x = 1;
3660       break;
3661     case 2: x = 4;
3662       break;
3663     case 3: x = 5;
3664     @}
3665   foo (x);
3667 @end group
3668 @end smallexample
3670 @noindent
3671 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3672 always initialized, but GCC doesn't know this. To suppress the
3673 warning, the user needs to provide a default case with assert(0) or
3674 similar code.
3676 @cindex @code{longjmp} warnings
3677 This option also warns when a non-volatile automatic variable might be
3678 changed by a call to @code{longjmp}.  These warnings as well are possible
3679 only in optimizing compilation.
3681 The compiler sees only the calls to @code{setjmp}.  It cannot know
3682 where @code{longjmp} will be called; in fact, a signal handler could
3683 call it at any point in the code.  As a result, you may get a warning
3684 even when there is in fact no problem because @code{longjmp} cannot
3685 in fact be called at the place that would cause a problem.
3687 Some spurious warnings can be avoided if you declare all the functions
3688 you use that never return as @code{noreturn}.  @xref{Function
3689 Attributes}.
3691 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3693 @item -Wunknown-pragmas
3694 @opindex Wunknown-pragmas
3695 @opindex Wno-unknown-pragmas
3696 @cindex warning for unknown pragmas
3697 @cindex unknown pragmas, warning
3698 @cindex pragmas, warning of unknown
3699 Warn when a @code{#pragma} directive is encountered that is not understood by 
3700 GCC@.  If this command-line option is used, warnings will even be issued
3701 for unknown pragmas in system header files.  This is not the case if
3702 the warnings were only enabled by the @option{-Wall} command-line option.
3704 @item -Wno-pragmas
3705 @opindex Wno-pragmas
3706 @opindex Wpragmas
3707 Do not warn about misuses of pragmas, such as incorrect parameters,
3708 invalid syntax, or conflicts between pragmas.  See also
3709 @samp{-Wunknown-pragmas}.
3711 @item -Wstrict-aliasing
3712 @opindex Wstrict-aliasing
3713 @opindex Wno-strict-aliasing
3714 This option is only active when @option{-fstrict-aliasing} is active.
3715 It warns about code that might break the strict aliasing rules that the
3716 compiler is using for optimization.  The warning does not catch all
3717 cases, but does attempt to catch the more common pitfalls.  It is
3718 included in @option{-Wall}.
3719 It is equivalent to @option{-Wstrict-aliasing=3}
3721 @item -Wstrict-aliasing=n
3722 @opindex Wstrict-aliasing=n
3723 @opindex Wno-strict-aliasing=n
3724 This option is only active when @option{-fstrict-aliasing} is active.
3725 It warns about code that might break the strict aliasing rules that the
3726 compiler is using for optimization.
3727 Higher levels correspond to higher accuracy (fewer false positives).
3728 Higher levels also correspond to more effort, similar to the way -O works.
3729 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3730 with n=3.
3732 Level 1: Most aggressive, quick, least accurate.
3733 Possibly useful when higher levels
3734 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3735 false negatives.  However, it has many false positives.
3736 Warns for all pointer conversions between possibly incompatible types,
3737 even if never dereferenced.  Runs in the front end only.
3739 Level 2: Aggressive, quick, not too precise.
3740 May still have many false positives (not as many as level 1 though),
3741 and few false negatives (but possibly more than level 1).
3742 Unlike level 1, it only warns when an address is taken.  Warns about
3743 incomplete types.  Runs in the front end only.
3745 Level 3 (default for @option{-Wstrict-aliasing}):
3746 Should have very few false positives and few false
3747 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3748 Takes care of the common pun+dereference pattern in the front end:
3749 @code{*(int*)&some_float}.
3750 If optimization is enabled, it also runs in the back end, where it deals
3751 with multiple statement cases using flow-sensitive points-to information.
3752 Only warns when the converted pointer is dereferenced.
3753 Does not warn about incomplete types.
3755 @item -Wstrict-overflow
3756 @itemx -Wstrict-overflow=@var{n}
3757 @opindex Wstrict-overflow
3758 @opindex Wno-strict-overflow
3759 This option is only active when @option{-fstrict-overflow} is active.
3760 It warns about cases where the compiler optimizes based on the
3761 assumption that signed overflow does not occur.  Note that it does not
3762 warn about all cases where the code might overflow: it only warns
3763 about cases where the compiler implements some optimization.  Thus
3764 this warning depends on the optimization level.
3766 An optimization that assumes that signed overflow does not occur is
3767 perfectly safe if the values of the variables involved are such that
3768 overflow never does, in fact, occur.  Therefore this warning can
3769 easily give a false positive: a warning about code that is not
3770 actually a problem.  To help focus on important issues, several
3771 warning levels are defined.  No warnings are issued for the use of
3772 undefined signed overflow when estimating how many iterations a loop
3773 will require, in particular when determining whether a loop will be
3774 executed at all.
3776 @table @gcctabopt
3777 @item -Wstrict-overflow=1
3778 Warn about cases that are both questionable and easy to avoid.  For
3779 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3780 compiler will simplify this to @code{1}.  This level of
3781 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3782 are not, and must be explicitly requested.
3784 @item -Wstrict-overflow=2
3785 Also warn about other cases where a comparison is simplified to a
3786 constant.  For example: @code{abs (x) >= 0}.  This can only be
3787 simplified when @option{-fstrict-overflow} is in effect, because
3788 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3789 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3790 @option{-Wstrict-overflow=2}.
3792 @item -Wstrict-overflow=3
3793 Also warn about other cases where a comparison is simplified.  For
3794 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3796 @item -Wstrict-overflow=4
3797 Also warn about other simplifications not covered by the above cases.
3798 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3800 @item -Wstrict-overflow=5
3801 Also warn about cases where the compiler reduces the magnitude of a
3802 constant involved in a comparison.  For example: @code{x + 2 > y} will
3803 be simplified to @code{x + 1 >= y}.  This is reported only at the
3804 highest warning level because this simplification applies to many
3805 comparisons, so this warning level will give a very large number of
3806 false positives.
3807 @end table
3809 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{]}
3810 @opindex Wsuggest-attribute=
3811 @opindex Wno-suggest-attribute=
3812 Warn for cases where adding an attribute may be beneficial. The
3813 attributes currently supported are listed below.
3815 @table @gcctabopt
3816 @item -Wsuggest-attribute=pure
3817 @itemx -Wsuggest-attribute=const
3818 @itemx -Wsuggest-attribute=noreturn
3819 @opindex Wsuggest-attribute=pure
3820 @opindex Wno-suggest-attribute=pure
3821 @opindex Wsuggest-attribute=const
3822 @opindex Wno-suggest-attribute=const
3823 @opindex Wsuggest-attribute=noreturn
3824 @opindex Wno-suggest-attribute=noreturn
3826 Warn about functions that might be candidates for attributes
3827 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3828 functions visible in other compilation units or (in the case of @code{pure} and
3829 @code{const}) if it cannot prove that the function returns normally. A function
3830 returns normally if it doesn't contain an infinite loop nor returns abnormally
3831 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3832 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3833 higher.  Higher optimization levels improve the accuracy of the analysis.
3834 @end table
3836 @item -Warray-bounds
3837 @opindex Wno-array-bounds
3838 @opindex Warray-bounds
3839 This option is only active when @option{-ftree-vrp} is active
3840 (default for @option{-O2} and above). It warns about subscripts to arrays
3841 that are always out of bounds. This warning is enabled by @option{-Wall}.
3843 @item -Wno-div-by-zero
3844 @opindex Wno-div-by-zero
3845 @opindex Wdiv-by-zero
3846 Do not warn about compile-time integer division by zero.  Floating-point
3847 division by zero is not warned about, as it can be a legitimate way of
3848 obtaining infinities and NaNs.
3850 @item -Wsystem-headers
3851 @opindex Wsystem-headers
3852 @opindex Wno-system-headers
3853 @cindex warnings from system headers
3854 @cindex system headers, warnings from
3855 Print warning messages for constructs found in system header files.
3856 Warnings from system headers are normally suppressed, on the assumption
3857 that they usually do not indicate real problems and would only make the
3858 compiler output harder to read.  Using this command-line option tells
3859 GCC to emit warnings from system headers as if they occurred in user
3860 code.  However, note that using @option{-Wall} in conjunction with this
3861 option will @emph{not} warn about unknown pragmas in system
3862 headers---for that, @option{-Wunknown-pragmas} must also be used.
3864 @item -Wtrampolines
3865 @opindex Wtrampolines
3866 @opindex Wno-trampolines
3867  Warn about trampolines generated for pointers to nested functions.
3869  A trampoline is a small piece of data or code that is created at run
3870  time on the stack when the address of a nested function is taken, and
3871  is used to call the nested function indirectly.  For some targets, it
3872  is made up of data only and thus requires no special treatment.  But,
3873  for most targets, it is made up of code and thus requires the stack
3874  to be made executable in order for the program to work properly.
3876 @item -Wfloat-equal
3877 @opindex Wfloat-equal
3878 @opindex Wno-float-equal
3879 Warn if floating-point values are used in equality comparisons.
3881 The idea behind this is that sometimes it is convenient (for the
3882 programmer) to consider floating-point values as approximations to
3883 infinitely precise real numbers.  If you are doing this, then you need
3884 to compute (by analyzing the code, or in some other way) the maximum or
3885 likely maximum error that the computation introduces, and allow for it
3886 when performing comparisons (and when producing output, but that's a
3887 different problem).  In particular, instead of testing for equality, you
3888 would check to see whether the two values have ranges that overlap; and
3889 this is done with the relational operators, so equality comparisons are
3890 probably mistaken.
3892 @item -Wtraditional @r{(C and Objective-C only)}
3893 @opindex Wtraditional
3894 @opindex Wno-traditional
3895 Warn about certain constructs that behave differently in traditional and
3896 ISO C@.  Also warn about ISO C constructs that have no traditional C
3897 equivalent, and/or problematic constructs that should be avoided.
3899 @itemize @bullet
3900 @item
3901 Macro parameters that appear within string literals in the macro body.
3902 In traditional C macro replacement takes place within string literals,
3903 but does not in ISO C@.
3905 @item
3906 In traditional C, some preprocessor directives did not exist.
3907 Traditional preprocessors would only consider a line to be a directive
3908 if the @samp{#} appeared in column 1 on the line.  Therefore
3909 @option{-Wtraditional} warns about directives that traditional C
3910 understands but would ignore because the @samp{#} does not appear as the
3911 first character on the line.  It also suggests you hide directives like
3912 @samp{#pragma} not understood by traditional C by indenting them.  Some
3913 traditional implementations would not recognize @samp{#elif}, so it
3914 suggests avoiding it altogether.
3916 @item
3917 A function-like macro that appears without arguments.
3919 @item
3920 The unary plus operator.
3922 @item
3923 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
3924 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3925 constants.)  Note, these suffixes appear in macros defined in the system
3926 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3927 Use of these macros in user code might normally lead to spurious
3928 warnings, however GCC's integrated preprocessor has enough context to
3929 avoid warning in these cases.
3931 @item
3932 A function declared external in one block and then used after the end of
3933 the block.
3935 @item
3936 A @code{switch} statement has an operand of type @code{long}.
3938 @item
3939 A non-@code{static} function declaration follows a @code{static} one.
3940 This construct is not accepted by some traditional C compilers.
3942 @item
3943 The ISO type of an integer constant has a different width or
3944 signedness from its traditional type.  This warning is only issued if
3945 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3946 typically represent bit patterns, are not warned about.
3948 @item
3949 Usage of ISO string concatenation is detected.
3951 @item
3952 Initialization of automatic aggregates.
3954 @item
3955 Identifier conflicts with labels.  Traditional C lacks a separate
3956 namespace for labels.
3958 @item
3959 Initialization of unions.  If the initializer is zero, the warning is
3960 omitted.  This is done under the assumption that the zero initializer in
3961 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3962 initializer warnings and relies on default initialization to zero in the
3963 traditional C case.
3965 @item
3966 Conversions by prototypes between fixed/floating-point values and vice
3967 versa.  The absence of these prototypes when compiling with traditional
3968 C would cause serious problems.  This is a subset of the possible
3969 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3971 @item
3972 Use of ISO C style function definitions.  This warning intentionally is
3973 @emph{not} issued for prototype declarations or variadic functions
3974 because these ISO C features will appear in your code when using
3975 libiberty's traditional C compatibility macros, @code{PARAMS} and
3976 @code{VPARAMS}.  This warning is also bypassed for nested functions
3977 because that feature is already a GCC extension and thus not relevant to
3978 traditional C compatibility.
3979 @end itemize
3981 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3982 @opindex Wtraditional-conversion
3983 @opindex Wno-traditional-conversion
3984 Warn if a prototype causes a type conversion that is different from what
3985 would happen to the same argument in the absence of a prototype.  This
3986 includes conversions of fixed point to floating and vice versa, and
3987 conversions changing the width or signedness of a fixed-point argument
3988 except when the same as the default promotion.
3990 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3991 @opindex Wdeclaration-after-statement
3992 @opindex Wno-declaration-after-statement
3993 Warn when a declaration is found after a statement in a block.  This
3994 construct, known from C++, was introduced with ISO C99 and is by default
3995 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3996 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3998 @item -Wundef
3999 @opindex Wundef
4000 @opindex Wno-undef
4001 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4003 @item -Wno-endif-labels
4004 @opindex Wno-endif-labels
4005 @opindex Wendif-labels
4006 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4008 @item -Wshadow
4009 @opindex Wshadow
4010 @opindex Wno-shadow
4011 Warn whenever a local variable or type declaration shadows another variable,
4012 parameter, type, or class member (in C++), or whenever a built-in function
4013 is shadowed. Note that in C++, the compiler will not warn if a local variable
4014 shadows a struct/class/enum, but will warn if it shadows an explicit typedef.
4016 @item -Wlarger-than=@var{len}
4017 @opindex Wlarger-than=@var{len}
4018 @opindex Wlarger-than-@var{len}
4019 Warn whenever an object of larger than @var{len} bytes is defined.
4021 @item -Wframe-larger-than=@var{len}
4022 @opindex Wframe-larger-than
4023 Warn if the size of a function frame is larger than @var{len} bytes.
4024 The computation done to determine the stack frame size is approximate
4025 and not conservative.
4026 The actual requirements may be somewhat greater than @var{len}
4027 even if you do not get a warning.  In addition, any space allocated
4028 via @code{alloca}, variable-length arrays, or related constructs
4029 is not included by the compiler when determining
4030 whether or not to issue a warning.
4032 @item -Wno-free-nonheap-object
4033 @opindex Wno-free-nonheap-object
4034 @opindex Wfree-nonheap-object
4035 Do not warn when attempting to free an object that was not allocated
4036 on the heap.
4038 @item -Wstack-usage=@var{len}
4039 @opindex Wstack-usage
4040 Warn if the stack usage of a function might be larger than @var{len} bytes.
4041 The computation done to determine the stack usage is conservative.
4042 Any space allocated via @code{alloca}, variable-length arrays, or related
4043 constructs is included by the compiler when determining whether or not to
4044 issue a warning.
4046 The message is in keeping with the output of @option{-fstack-usage}.
4048 @itemize
4049 @item
4050 If the stack usage is fully static but exceeds the specified amount, it's:
4052 @smallexample
4053   warning: stack usage is 1120 bytes
4054 @end smallexample
4055 @item
4056 If the stack usage is (partly) dynamic but bounded, it's:
4058 @smallexample
4059   warning: stack usage might be 1648 bytes
4060 @end smallexample
4061 @item
4062 If the stack usage is (partly) dynamic and not bounded, it's:
4064 @smallexample
4065   warning: stack usage might be unbounded
4066 @end smallexample
4067 @end itemize
4069 @item -Wunsafe-loop-optimizations
4070 @opindex Wunsafe-loop-optimizations
4071 @opindex Wno-unsafe-loop-optimizations
4072 Warn if the loop cannot be optimized because the compiler could not
4073 assume anything on the bounds of the loop indices.  With
4074 @option{-funsafe-loop-optimizations} warn if the compiler made
4075 such assumptions.
4077 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4078 @opindex Wno-pedantic-ms-format
4079 @opindex Wpedantic-ms-format
4080 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
4081 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
4082 depending on the MS runtime, when you are using the options @option{-Wformat}
4083 and @option{-pedantic} without gnu-extensions.
4085 @item -Wpointer-arith
4086 @opindex Wpointer-arith
4087 @opindex Wno-pointer-arith
4088 Warn about anything that depends on the ``size of'' a function type or
4089 of @code{void}.  GNU C assigns these types a size of 1, for
4090 convenience in calculations with @code{void *} pointers and pointers
4091 to functions.  In C++, warn also when an arithmetic operation involves
4092 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
4094 @item -Wtype-limits
4095 @opindex Wtype-limits
4096 @opindex Wno-type-limits
4097 Warn if a comparison is always true or always false due to the limited
4098 range of the data type, but do not warn for constant expressions.  For
4099 example, warn if an unsigned variable is compared against zero with
4100 @samp{<} or @samp{>=}.  This warning is also enabled by
4101 @option{-Wextra}.
4103 @item -Wbad-function-cast @r{(C and Objective-C only)}
4104 @opindex Wbad-function-cast
4105 @opindex Wno-bad-function-cast
4106 Warn whenever a function call is cast to a non-matching type.
4107 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4109 @item -Wc++-compat @r{(C and Objective-C only)}
4110 Warn about ISO C constructs that are outside of the common subset of
4111 ISO C and ISO C++, e.g.@: request for implicit conversion from
4112 @code{void *} to a pointer to non-@code{void} type.
4114 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4115 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4116 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4117 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4118 enabled by @option{-Wall}.
4120 @item -Wcast-qual
4121 @opindex Wcast-qual
4122 @opindex Wno-cast-qual
4123 Warn whenever a pointer is cast so as to remove a type qualifier from
4124 the target type.  For example, warn if a @code{const char *} is cast
4125 to an ordinary @code{char *}.
4127 Also warn when making a cast that introduces a type qualifier in an
4128 unsafe way.  For example, casting @code{char **} to @code{const char **}
4129 is unsafe, as in this example:
4131 @smallexample
4132   /* p is char ** value.  */
4133   const char **q = (const char **) p;
4134   /* Assignment of readonly string to const char * is OK.  */
4135   *q = "string";
4136   /* Now char** pointer points to read-only memory.  */
4137   **p = 'b';
4138 @end smallexample
4140 @item -Wcast-align
4141 @opindex Wcast-align
4142 @opindex Wno-cast-align
4143 Warn whenever a pointer is cast such that the required alignment of the
4144 target is increased.  For example, warn if a @code{char *} is cast to
4145 an @code{int *} on machines where integers can only be accessed at
4146 two- or four-byte boundaries.
4148 @item -Wwrite-strings
4149 @opindex Wwrite-strings
4150 @opindex Wno-write-strings
4151 When compiling C, give string constants the type @code{const
4152 char[@var{length}]} so that copying the address of one into a
4153 non-@code{const} @code{char *} pointer will get a warning.  These
4154 warnings will help you find at compile time code that can try to write
4155 into a string constant, but only if you have been very careful about
4156 using @code{const} in declarations and prototypes.  Otherwise, it will
4157 just be a nuisance. This is why we did not make @option{-Wall} request
4158 these warnings.
4160 When compiling C++, warn about the deprecated conversion from string
4161 literals to @code{char *}.  This warning is enabled by default for C++
4162 programs.
4164 @item -Wclobbered
4165 @opindex Wclobbered
4166 @opindex Wno-clobbered
4167 Warn for variables that might be changed by @samp{longjmp} or
4168 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4170 @item -Wconversion
4171 @opindex Wconversion
4172 @opindex Wno-conversion
4173 Warn for implicit conversions that may alter a value. This includes
4174 conversions between real and integer, like @code{abs (x)} when
4175 @code{x} is @code{double}; conversions between signed and unsigned,
4176 like @code{unsigned ui = -1}; and conversions to smaller types, like
4177 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4178 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4179 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4180 conversions between signed and unsigned integers can be disabled by
4181 using @option{-Wno-sign-conversion}.
4183 For C++, also warn for confusing overload resolution for user-defined
4184 conversions; and conversions that will never use a type conversion
4185 operator: conversions to @code{void}, the same type, a base class or a
4186 reference to them. Warnings about conversions between signed and
4187 unsigned integers are disabled by default in C++ unless
4188 @option{-Wsign-conversion} is explicitly enabled.
4190 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4191 @opindex Wconversion-null
4192 @opindex Wno-conversion-null
4193 Do not warn for conversions between @code{NULL} and non-pointer
4194 types. @option{-Wconversion-null} is enabled by default.
4196 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4197 @opindex Wzero-as-null-pointer-constant
4198 @opindex Wno-zero-as-null-pointer-constant
4199 Warn when a literal '0' is used as null pointer constant.  This can
4200 be useful to facilitate the conversion to @code{nullptr} in C++11.
4202 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4203 @opindex Wuseless-cast
4204 @opindex Wno-useless-cast
4205 Warn when an expression is casted to its own type.
4207 @item -Wempty-body
4208 @opindex Wempty-body
4209 @opindex Wno-empty-body
4210 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4211 while} statement.  This warning is also enabled by @option{-Wextra}.
4213 @item -Wenum-compare
4214 @opindex Wenum-compare
4215 @opindex Wno-enum-compare
4216 Warn about a comparison between values of different enumerated types. In C++
4217 this warning is enabled by default.  In C this warning is enabled by
4218 @option{-Wall}.
4220 @item -Wjump-misses-init @r{(C, Objective-C only)}
4221 @opindex Wjump-misses-init
4222 @opindex Wno-jump-misses-init
4223 Warn if a @code{goto} statement or a @code{switch} statement jumps
4224 forward across the initialization of a variable, or jumps backward to a
4225 label after the variable has been initialized.  This only warns about
4226 variables that are initialized when they are declared.  This warning is
4227 only supported for C and Objective-C; in C++ this sort of branch is an
4228 error in any case.
4230 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4231 can be disabled with the @option{-Wno-jump-misses-init} option.
4233 @item -Wsign-compare
4234 @opindex Wsign-compare
4235 @opindex Wno-sign-compare
4236 @cindex warning for comparison of signed and unsigned values
4237 @cindex comparison of signed and unsigned values, warning
4238 @cindex signed and unsigned values, comparison warning
4239 Warn when a comparison between signed and unsigned values could produce
4240 an incorrect result when the signed value is converted to unsigned.
4241 This warning is also enabled by @option{-Wextra}; to get the other warnings
4242 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
4244 @item -Wsign-conversion
4245 @opindex Wsign-conversion
4246 @opindex Wno-sign-conversion
4247 Warn for implicit conversions that may change the sign of an integer
4248 value, like assigning a signed integer expression to an unsigned
4249 integer variable. An explicit cast silences the warning. In C, this
4250 option is enabled also by @option{-Wconversion}.
4252 @item -Waddress
4253 @opindex Waddress
4254 @opindex Wno-address
4255 Warn about suspicious uses of memory addresses. These include using
4256 the address of a function in a conditional expression, such as
4257 @code{void func(void); if (func)}, and comparisons against the memory
4258 address of a string literal, such as @code{if (x == "abc")}.  Such
4259 uses typically indicate a programmer error: the address of a function
4260 always evaluates to true, so their use in a conditional usually
4261 indicate that the programmer forgot the parentheses in a function
4262 call; and comparisons against string literals result in unspecified
4263 behavior and are not portable in C, so they usually indicate that the
4264 programmer intended to use @code{strcmp}.  This warning is enabled by
4265 @option{-Wall}.
4267 @item -Wlogical-op
4268 @opindex Wlogical-op
4269 @opindex Wno-logical-op
4270 Warn about suspicious uses of logical operators in expressions.
4271 This includes using logical operators in contexts where a
4272 bit-wise operator is likely to be expected.
4274 @item -Waggregate-return
4275 @opindex Waggregate-return
4276 @opindex Wno-aggregate-return
4277 Warn if any functions that return structures or unions are defined or
4278 called.  (In languages where you can return an array, this also elicits
4279 a warning.)
4281 @item -Wno-attributes
4282 @opindex Wno-attributes
4283 @opindex Wattributes
4284 Do not warn if an unexpected @code{__attribute__} is used, such as
4285 unrecognized attributes, function attributes applied to variables,
4286 etc.  This will not stop errors for incorrect use of supported
4287 attributes.
4289 @item -Wno-builtin-macro-redefined
4290 @opindex Wno-builtin-macro-redefined
4291 @opindex Wbuiltin-macro-redefined
4292 Do not warn if certain built-in macros are redefined.  This suppresses
4293 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4294 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4296 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4297 @opindex Wstrict-prototypes
4298 @opindex Wno-strict-prototypes
4299 Warn if a function is declared or defined without specifying the
4300 argument types.  (An old-style function definition is permitted without
4301 a warning if preceded by a declaration that specifies the argument
4302 types.)
4304 @item -Wold-style-declaration @r{(C and Objective-C only)}
4305 @opindex Wold-style-declaration
4306 @opindex Wno-old-style-declaration
4307 Warn for obsolescent usages, according to the C Standard, in a
4308 declaration. For example, warn if storage-class specifiers like
4309 @code{static} are not the first things in a declaration.  This warning
4310 is also enabled by @option{-Wextra}.
4312 @item -Wold-style-definition @r{(C and Objective-C only)}
4313 @opindex Wold-style-definition
4314 @opindex Wno-old-style-definition
4315 Warn if an old-style function definition is used.  A warning is given
4316 even if there is a previous prototype.
4318 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4319 @opindex Wmissing-parameter-type
4320 @opindex Wno-missing-parameter-type
4321 A function parameter is declared without a type specifier in K&R-style
4322 functions:
4324 @smallexample
4325 void foo(bar) @{ @}
4326 @end smallexample
4328 This warning is also enabled by @option{-Wextra}.
4330 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4331 @opindex Wmissing-prototypes
4332 @opindex Wno-missing-prototypes
4333 Warn if a global function is defined without a previous prototype
4334 declaration.  This warning is issued even if the definition itself
4335 provides a prototype.  The aim is to detect global functions that 
4336 are not declared in header files.
4338 @item -Wmissing-declarations
4339 @opindex Wmissing-declarations
4340 @opindex Wno-missing-declarations
4341 Warn if a global function is defined without a previous declaration.
4342 Do so even if the definition itself provides a prototype.
4343 Use this option to detect global functions that are not declared in
4344 header files.  In C++, no warnings are issued for function templates,
4345 or for inline functions, or for functions in anonymous namespaces.
4347 @item -Wmissing-field-initializers
4348 @opindex Wmissing-field-initializers
4349 @opindex Wno-missing-field-initializers
4350 @opindex W
4351 @opindex Wextra
4352 @opindex Wno-extra
4353 Warn if a structure's initializer has some fields missing.  For
4354 example, the following code would cause such a warning, because
4355 @code{x.h} is implicitly zero:
4357 @smallexample
4358 struct s @{ int f, g, h; @};
4359 struct s x = @{ 3, 4 @};
4360 @end smallexample
4362 This option does not warn about designated initializers, so the following
4363 modification would not trigger a warning:
4365 @smallexample
4366 struct s @{ int f, g, h; @};
4367 struct s x = @{ .f = 3, .g = 4 @};
4368 @end smallexample
4370 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4371 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4373 @item -Wmissing-format-attribute
4374 @opindex Wmissing-format-attribute
4375 @opindex Wno-missing-format-attribute
4376 @opindex Wformat
4377 @opindex Wno-format
4378 Warn about function pointers that might be candidates for @code{format}
4379 attributes.  Note these are only possible candidates, not absolute ones.
4380 GCC will guess that function pointers with @code{format} attributes that
4381 are used in assignment, initialization, parameter passing or return
4382 statements should have a corresponding @code{format} attribute in the
4383 resulting type.  I.e.@: the left-hand side of the assignment or
4384 initialization, the type of the parameter variable, or the return type
4385 of the containing function respectively should also have a @code{format}
4386 attribute to avoid the warning.
4388 GCC will also warn about function definitions that might be
4389 candidates for @code{format} attributes.  Again, these are only
4390 possible candidates.  GCC will guess that @code{format} attributes
4391 might be appropriate for any function that calls a function like
4392 @code{vprintf} or @code{vscanf}, but this might not always be the
4393 case, and some functions for which @code{format} attributes are
4394 appropriate may not be detected.
4396 @item -Wno-multichar
4397 @opindex Wno-multichar
4398 @opindex Wmultichar
4399 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4400 Usually they indicate a typo in the user's code, as they have
4401 implementation-defined values, and should not be used in portable code.
4403 @item -Wnormalized=<none|id|nfc|nfkc>
4404 @opindex Wnormalized=
4405 @cindex NFC
4406 @cindex NFKC
4407 @cindex character set, input normalization
4408 In ISO C and ISO C++, two identifiers are different if they are
4409 different sequences of characters.  However, sometimes when characters
4410 outside the basic ASCII character set are used, you can have two
4411 different character sequences that look the same.  To avoid confusion,
4412 the ISO 10646 standard sets out some @dfn{normalization rules} which
4413 when applied ensure that two sequences that look the same are turned into
4414 the same sequence.  GCC can warn you if you are using identifiers that
4415 have not been normalized; this option controls that warning.
4417 There are four levels of warning supported by GCC@.  The default is
4418 @option{-Wnormalized=nfc}, which warns about any identifier that is
4419 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4420 recommended form for most uses.
4422 Unfortunately, there are some characters allowed in identifiers by
4423 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4424 identifiers.  That is, there's no way to use these symbols in portable
4425 ISO C or C++ and have all your identifiers in NFC@.
4426 @option{-Wnormalized=id} suppresses the warning for these characters.
4427 It is hoped that future versions of the standards involved will correct
4428 this, which is why this option is not the default.
4430 You can switch the warning off for all characters by writing
4431 @option{-Wnormalized=none}.  You would only want to do this if you
4432 were using some other normalization scheme (like ``D''), because
4433 otherwise you can easily create bugs that are literally impossible to see.
4435 Some characters in ISO 10646 have distinct meanings but look identical
4436 in some fonts or display methodologies, especially once formatting has
4437 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4438 LETTER N'', will display just like a regular @code{n} that has been
4439 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4440 normalization scheme to convert all these into a standard form as
4441 well, and GCC will warn if your code is not in NFKC if you use
4442 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4443 about every identifier that contains the letter O because it might be
4444 confused with the digit 0, and so is not the default, but may be
4445 useful as a local coding convention if the programming environment is
4446 unable to be fixed to display these characters distinctly.
4448 @item -Wno-deprecated
4449 @opindex Wno-deprecated
4450 @opindex Wdeprecated
4451 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4453 @item -Wno-deprecated-declarations
4454 @opindex Wno-deprecated-declarations
4455 @opindex Wdeprecated-declarations
4456 Do not warn about uses of functions (@pxref{Function Attributes}),
4457 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4458 Attributes}) marked as deprecated by using the @code{deprecated}
4459 attribute.
4461 @item -Wno-overflow
4462 @opindex Wno-overflow
4463 @opindex Woverflow
4464 Do not warn about compile-time overflow in constant expressions.
4466 @item -Woverride-init @r{(C and Objective-C only)}
4467 @opindex Woverride-init
4468 @opindex Wno-override-init
4469 @opindex W
4470 @opindex Wextra
4471 @opindex Wno-extra
4472 Warn if an initialized field without side effects is overridden when
4473 using designated initializers (@pxref{Designated Inits, , Designated
4474 Initializers}).
4476 This warning is included in @option{-Wextra}.  To get other
4477 @option{-Wextra} warnings without this one, use @samp{-Wextra
4478 -Wno-override-init}.
4480 @item -Wpacked
4481 @opindex Wpacked
4482 @opindex Wno-packed
4483 Warn if a structure is given the packed attribute, but the packed
4484 attribute has no effect on the layout or size of the structure.
4485 Such structures may be mis-aligned for little benefit.  For
4486 instance, in this code, the variable @code{f.x} in @code{struct bar}
4487 will be misaligned even though @code{struct bar} does not itself
4488 have the packed attribute:
4490 @smallexample
4491 @group
4492 struct foo @{
4493   int x;
4494   char a, b, c, d;
4495 @} __attribute__((packed));
4496 struct bar @{
4497   char z;
4498   struct foo f;
4500 @end group
4501 @end smallexample
4503 @item -Wpacked-bitfield-compat
4504 @opindex Wpacked-bitfield-compat
4505 @opindex Wno-packed-bitfield-compat
4506 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4507 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4508 the change can lead to differences in the structure layout.  GCC
4509 informs you when the offset of such a field has changed in GCC 4.4.
4510 For example there is no longer a 4-bit padding between field @code{a}
4511 and @code{b} in this structure:
4513 @smallexample
4514 struct foo
4516   char a:4;
4517   char b:8;
4518 @} __attribute__ ((packed));
4519 @end smallexample
4521 This warning is enabled by default.  Use
4522 @option{-Wno-packed-bitfield-compat} to disable this warning.
4524 @item -Wpadded
4525 @opindex Wpadded
4526 @opindex Wno-padded
4527 Warn if padding is included in a structure, either to align an element
4528 of the structure or to align the whole structure.  Sometimes when this
4529 happens it is possible to rearrange the fields of the structure to
4530 reduce the padding and so make the structure smaller.
4532 @item -Wredundant-decls
4533 @opindex Wredundant-decls
4534 @opindex Wno-redundant-decls
4535 Warn if anything is declared more than once in the same scope, even in
4536 cases where multiple declaration is valid and changes nothing.
4538 @item -Wnested-externs @r{(C and Objective-C only)}
4539 @opindex Wnested-externs
4540 @opindex Wno-nested-externs
4541 Warn if an @code{extern} declaration is encountered within a function.
4543 @item -Winline
4544 @opindex Winline
4545 @opindex Wno-inline
4546 Warn if a function can not be inlined and it was declared as inline.
4547 Even with this option, the compiler will not warn about failures to
4548 inline functions declared in system headers.
4550 The compiler uses a variety of heuristics to determine whether or not
4551 to inline a function.  For example, the compiler takes into account
4552 the size of the function being inlined and the amount of inlining
4553 that has already been done in the current function.  Therefore,
4554 seemingly insignificant changes in the source program can cause the
4555 warnings produced by @option{-Winline} to appear or disappear.
4557 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4558 @opindex Wno-invalid-offsetof
4559 @opindex Winvalid-offsetof
4560 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4561 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4562 to a non-POD type is undefined.  In existing C++ implementations,
4563 however, @samp{offsetof} typically gives meaningful results even when
4564 applied to certain kinds of non-POD types. (Such as a simple
4565 @samp{struct} that fails to be a POD type only by virtue of having a
4566 constructor.)  This flag is for users who are aware that they are
4567 writing nonportable code and who have deliberately chosen to ignore the
4568 warning about it.
4570 The restrictions on @samp{offsetof} may be relaxed in a future version
4571 of the C++ standard.
4573 @item -Wno-int-to-pointer-cast
4574 @opindex Wno-int-to-pointer-cast
4575 @opindex Wint-to-pointer-cast
4576 Suppress warnings from casts to pointer type of an integer of a
4577 different size. In C++, casting to a pointer type of smaller size is
4578 an error. @option{Wint-to-pointer-cast} is enabled by default.
4581 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4582 @opindex Wno-pointer-to-int-cast
4583 @opindex Wpointer-to-int-cast
4584 Suppress warnings from casts from a pointer to an integer type of a
4585 different size.
4587 @item -Winvalid-pch
4588 @opindex Winvalid-pch
4589 @opindex Wno-invalid-pch
4590 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4591 the search path but can't be used.
4593 @item -Wlong-long
4594 @opindex Wlong-long
4595 @opindex Wno-long-long
4596 Warn if @samp{long long} type is used.  This is enabled by either
4597 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4598 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4600 @item -Wvariadic-macros
4601 @opindex Wvariadic-macros
4602 @opindex Wno-variadic-macros
4603 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4604 alternate syntax when in pedantic ISO C99 mode.  This is default.
4605 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4607 @item -Wvector-operation-performance
4608 @opindex Wvector-operation-performance
4609 @opindex Wno-vector-operation-performance
4610 Warn if vector operation is not implemented via SIMD capabilities of the
4611 architecture.  Mainly useful for the performance tuning.
4612 Vector operation can be implemented @code{piecewise}, which means that the
4613 scalar operation is performed on every vector element; 
4614 @code{in parallel}, which means that the vector operation is implemented
4615 using scalars of wider type, which normally is more performance efficient;
4616 and @code{as a single scalar}, which means that vector fits into a
4617 scalar type.
4619 @item -Wvla
4620 @opindex Wvla
4621 @opindex Wno-vla
4622 Warn if variable length array is used in the code.
4623 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4624 the variable length array.
4626 @item -Wvolatile-register-var
4627 @opindex Wvolatile-register-var
4628 @opindex Wno-volatile-register-var
4629 Warn if a register variable is declared volatile.  The volatile
4630 modifier does not inhibit all optimizations that may eliminate reads
4631 and/or writes to register variables.  This warning is enabled by
4632 @option{-Wall}.
4634 @item -Wdisabled-optimization
4635 @opindex Wdisabled-optimization
4636 @opindex Wno-disabled-optimization
4637 Warn if a requested optimization pass is disabled.  This warning does
4638 not generally indicate that there is anything wrong with your code; it
4639 merely indicates that GCC's optimizers were unable to handle the code
4640 effectively.  Often, the problem is that your code is too big or too
4641 complex; GCC will refuse to optimize programs when the optimization
4642 itself is likely to take inordinate amounts of time.
4644 @item -Wpointer-sign @r{(C and Objective-C only)}
4645 @opindex Wpointer-sign
4646 @opindex Wno-pointer-sign
4647 Warn for pointer argument passing or assignment with different signedness.
4648 This option is only supported for C and Objective-C@.  It is implied by
4649 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4650 @option{-Wno-pointer-sign}.
4652 @item -Wstack-protector
4653 @opindex Wstack-protector
4654 @opindex Wno-stack-protector
4655 This option is only active when @option{-fstack-protector} is active.  It
4656 warns about functions that will not be protected against stack smashing.
4658 @item -Wno-mudflap
4659 @opindex Wno-mudflap
4660 Suppress warnings about constructs that cannot be instrumented by
4661 @option{-fmudflap}.
4663 @item -Woverlength-strings
4664 @opindex Woverlength-strings
4665 @opindex Wno-overlength-strings
4666 Warn about string constants that are longer than the ``minimum
4667 maximum'' length specified in the C standard.  Modern compilers
4668 generally allow string constants that are much longer than the
4669 standard's minimum limit, but very portable programs should avoid
4670 using longer strings.
4672 The limit applies @emph{after} string constant concatenation, and does
4673 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4674 C99, it was raised to 4095.  C++98 does not specify a normative
4675 minimum maximum, so we do not diagnose overlength strings in C++@.
4677 This option is implied by @option{-pedantic}, and can be disabled with
4678 @option{-Wno-overlength-strings}.
4680 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4681 @opindex Wunsuffixed-float-constants
4683 GCC will issue a warning for any floating constant that does not have
4684 a suffix.  When used together with @option{-Wsystem-headers} it will
4685 warn about such constants in system header files.  This can be useful
4686 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4687 from the decimal floating-point extension to C99.
4688 @end table
4690 @node Debugging Options
4691 @section Options for Debugging Your Program or GCC
4692 @cindex options, debugging
4693 @cindex debugging information options
4695 GCC has various special options that are used for debugging
4696 either your program or GCC:
4698 @table @gcctabopt
4699 @item -g
4700 @opindex g
4701 Produce debugging information in the operating system's native format
4702 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4703 information.
4705 On most systems that use stabs format, @option{-g} enables use of extra
4706 debugging information that only GDB can use; this extra information
4707 makes debugging work better in GDB but will probably make other debuggers
4708 crash or
4709 refuse to read the program.  If you want to control for certain whether
4710 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4711 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4713 GCC allows you to use @option{-g} with
4714 @option{-O}.  The shortcuts taken by optimized code may occasionally
4715 produce surprising results: some variables you declared may not exist
4716 at all; flow of control may briefly move where you did not expect it;
4717 some statements may not be executed because they compute constant
4718 results or their values were already at hand; some statements may
4719 execute in different places because they were moved out of loops.
4721 Nevertheless it proves possible to debug optimized output.  This makes
4722 it reasonable to use the optimizer for programs that might have bugs.
4724 The following options are useful when GCC is generated with the
4725 capability for more than one debugging format.
4727 @item -ggdb
4728 @opindex ggdb
4729 Produce debugging information for use by GDB@.  This means to use the
4730 most expressive format available (DWARF 2, stabs, or the native format
4731 if neither of those are supported), including GDB extensions if at all
4732 possible.
4734 @item -gstabs
4735 @opindex gstabs
4736 Produce debugging information in stabs format (if that is supported),
4737 without GDB extensions.  This is the format used by DBX on most BSD
4738 systems.  On MIPS, Alpha and System V Release 4 systems this option
4739 produces stabs debugging output that is not understood by DBX or SDB@.
4740 On System V Release 4 systems this option requires the GNU assembler.
4742 @item -feliminate-unused-debug-symbols
4743 @opindex feliminate-unused-debug-symbols
4744 Produce debugging information in stabs format (if that is supported),
4745 for only symbols that are actually used.
4747 @item -femit-class-debug-always
4748 Instead of emitting debugging information for a C++ class in only one
4749 object file, emit it in all object files using the class.  This option
4750 should be used only with debuggers that are unable to handle the way GCC
4751 normally emits debugging information for classes because using this
4752 option will increase the size of debugging information by as much as a
4753 factor of two.
4755 @item -fno-debug-types-section
4756 @opindex fno-debug-types-section
4757 @opindex fdebug-types-section
4758 By default when using DWARF Version 4 or higher type DIEs will be put into
4759 their own .debug_types section instead of making them part of the
4760 .debug_info section.  It is more efficient to put them in a separate
4761 comdat sections since the linker will then be able to remove duplicates.
4762 But not all DWARF consumers support .debug_types sections yet.
4764 @item -gstabs+
4765 @opindex gstabs+
4766 Produce debugging information in stabs format (if that is supported),
4767 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4768 use of these extensions is likely to make other debuggers crash or
4769 refuse to read the program.
4771 @item -gcoff
4772 @opindex gcoff
4773 Produce debugging information in COFF format (if that is supported).
4774 This is the format used by SDB on most System V systems prior to
4775 System V Release 4.
4777 @item -gxcoff
4778 @opindex gxcoff
4779 Produce debugging information in XCOFF format (if that is supported).
4780 This is the format used by the DBX debugger on IBM RS/6000 systems.
4782 @item -gxcoff+
4783 @opindex gxcoff+
4784 Produce debugging information in XCOFF format (if that is supported),
4785 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4786 use of these extensions is likely to make other debuggers crash or
4787 refuse to read the program, and may cause assemblers other than the GNU
4788 assembler (GAS) to fail with an error.
4790 @item -gdwarf-@var{version}
4791 @opindex gdwarf-@var{version}
4792 Produce debugging information in DWARF format (if that is supported).
4793 The value of @var{version} may be either 2, 3 or 4; the default version is 2.
4795 Note that with DWARF Version 2 some ports require, and will always
4796 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4798 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4799 for maximum benefit.
4801 @item -grecord-gcc-switches
4802 @opindex grecord-gcc-switches
4803 This switch causes the command-line options used to invoke the
4804 compiler that may affect code generation to be appended to the
4805 DW_AT_producer attribute in DWARF debugging information.  The options
4806 are concatenated with spaces separating them from each other and from
4807 the compiler version.  See also @option{-frecord-gcc-switches} for another
4808 way of storing compiler options into the object file.
4810 @item -gno-record-gcc-switches
4811 @opindex gno-record-gcc-switches
4812 Disallow appending command-line options to the DW_AT_producer attribute
4813 in DWARF debugging information.  This is the default.
4815 @item -gstrict-dwarf
4816 @opindex gstrict-dwarf
4817 Disallow using extensions of later DWARF standard version than selected
4818 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4819 DWARF extensions from later standard versions is allowed.
4821 @item -gno-strict-dwarf
4822 @opindex gno-strict-dwarf
4823 Allow using extensions of later DWARF standard version than selected with
4824 @option{-gdwarf-@var{version}}.
4826 @item -gvms
4827 @opindex gvms
4828 Produce debugging information in Alpha/VMS debug format (if that is
4829 supported).  This is the format used by DEBUG on Alpha/VMS systems.
4831 @item -g@var{level}
4832 @itemx -ggdb@var{level}
4833 @itemx -gstabs@var{level}
4834 @itemx -gcoff@var{level}
4835 @itemx -gxcoff@var{level}
4836 @itemx -gvms@var{level}
4837 Request debugging information and also use @var{level} to specify how
4838 much information.  The default level is 2.
4840 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4841 @option{-g}.
4843 Level 1 produces minimal information, enough for making backtraces in
4844 parts of the program that you don't plan to debug.  This includes
4845 descriptions of functions and external variables, but no information
4846 about local variables and no line numbers.
4848 Level 3 includes extra information, such as all the macro definitions
4849 present in the program.  Some debuggers support macro expansion when
4850 you use @option{-g3}.
4852 @option{-gdwarf-2} does not accept a concatenated debug level, because
4853 GCC used to support an option @option{-gdwarf} that meant to generate
4854 debug information in version 1 of the DWARF format (which is very
4855 different from version 2), and it would have been too confusing.  That
4856 debug format is long obsolete, but the option cannot be changed now.
4857 Instead use an additional @option{-g@var{level}} option to change the
4858 debug level for DWARF.
4860 @item -gtoggle
4861 @opindex gtoggle
4862 Turn off generation of debug info, if leaving out this option would have
4863 generated it, or turn it on at level 2 otherwise.  The position of this
4864 argument in the command line does not matter, it takes effect after all
4865 other options are processed, and it does so only once, no matter how
4866 many times it is given.  This is mainly intended to be used with
4867 @option{-fcompare-debug}.
4869 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4870 @opindex fdump-final-insns
4871 Dump the final internal representation (RTL) to @var{file}.  If the
4872 optional argument is omitted (or if @var{file} is @code{.}), the name
4873 of the dump file will be determined by appending @code{.gkd} to the
4874 compilation output file name.
4876 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4877 @opindex fcompare-debug
4878 @opindex fno-compare-debug
4879 If no error occurs during compilation, run the compiler a second time,
4880 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4881 passed to the second compilation.  Dump the final internal
4882 representation in both compilations, and print an error if they differ.
4884 If the equal sign is omitted, the default @option{-gtoggle} is used.
4886 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4887 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4888 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4889 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4890 is used.
4892 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4893 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4894 of the final representation and the second compilation, preventing even
4895 @env{GCC_COMPARE_DEBUG} from taking effect.
4897 To verify full coverage during @option{-fcompare-debug} testing, set
4898 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4899 which GCC will reject as an invalid option in any actual compilation
4900 (rather than preprocessing, assembly or linking).  To get just a
4901 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4902 not overridden} will do.
4904 @item -fcompare-debug-second
4905 @opindex fcompare-debug-second
4906 This option is implicitly passed to the compiler for the second
4907 compilation requested by @option{-fcompare-debug}, along with options to
4908 silence warnings, and omitting other options that would cause
4909 side-effect compiler outputs to files or to the standard output.  Dump
4910 files and preserved temporary files are renamed so as to contain the
4911 @code{.gk} additional extension during the second compilation, to avoid
4912 overwriting those generated by the first.
4914 When this option is passed to the compiler driver, it causes the
4915 @emph{first} compilation to be skipped, which makes it useful for little
4916 other than debugging the compiler proper.
4918 @item -feliminate-dwarf2-dups
4919 @opindex feliminate-dwarf2-dups
4920 Compress DWARF 2 debugging information by eliminating duplicated
4921 information about each symbol.  This option only makes sense when
4922 generating DWARF 2 debugging information with @option{-gdwarf-2}.
4924 @item -femit-struct-debug-baseonly
4925 Emit debug information for struct-like types
4926 only when the base name of the compilation source file
4927 matches the base name of file in which the struct was defined.
4929 This option substantially reduces the size of debugging information,
4930 but at significant potential loss in type information to the debugger.
4931 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4932 See @option{-femit-struct-debug-detailed} for more detailed control.
4934 This option works only with DWARF 2.
4936 @item -femit-struct-debug-reduced
4937 Emit debug information for struct-like types
4938 only when the base name of the compilation source file
4939 matches the base name of file in which the type was defined,
4940 unless the struct is a template or defined in a system header.
4942 This option significantly reduces the size of debugging information,
4943 with some potential loss in type information to the debugger.
4944 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4945 See @option{-femit-struct-debug-detailed} for more detailed control.
4947 This option works only with DWARF 2.
4949 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4950 Specify the struct-like types
4951 for which the compiler will generate debug information.
4952 The intent is to reduce duplicate struct debug information
4953 between different object files within the same program.
4955 This option is a detailed version of
4956 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4957 which will serve for most needs.
4959 A specification has the syntax@*
4960 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4962 The optional first word limits the specification to
4963 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4964 A struct type is used directly when it is the type of a variable, member.
4965 Indirect uses arise through pointers to structs.
4966 That is, when use of an incomplete struct would be legal, the use is indirect.
4967 An example is
4968 @samp{struct one direct; struct two * indirect;}.
4970 The optional second word limits the specification to
4971 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4972 Generic structs are a bit complicated to explain.
4973 For C++, these are non-explicit specializations of template classes,
4974 or non-template classes within the above.
4975 Other programming languages have generics,
4976 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4978 The third word specifies the source files for those
4979 structs for which the compiler will emit debug information.
4980 The values @samp{none} and @samp{any} have the normal meaning.
4981 The value @samp{base} means that
4982 the base of name of the file in which the type declaration appears
4983 must match the base of the name of the main compilation file.
4984 In practice, this means that
4985 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4986 but types declared in other header will not.
4987 The value @samp{sys} means those types satisfying @samp{base}
4988 or declared in system or compiler headers.
4990 You may need to experiment to determine the best settings for your application.
4992 The default is @samp{-femit-struct-debug-detailed=all}.
4994 This option works only with DWARF 2.
4996 @item -fno-merge-debug-strings
4997 @opindex fmerge-debug-strings
4998 @opindex fno-merge-debug-strings
4999 Direct the linker to not merge together strings in the debugging
5000 information that are identical in different object files.  Merging is
5001 not supported by all assemblers or linkers.  Merging decreases the size
5002 of the debug information in the output file at the cost of increasing
5003 link processing time.  Merging is enabled by default.
5005 @item -fdebug-prefix-map=@var{old}=@var{new}
5006 @opindex fdebug-prefix-map
5007 When compiling files in directory @file{@var{old}}, record debugging
5008 information describing them as in @file{@var{new}} instead.
5010 @item -fno-dwarf2-cfi-asm
5011 @opindex fdwarf2-cfi-asm
5012 @opindex fno-dwarf2-cfi-asm
5013 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5014 instead of using GAS @code{.cfi_*} directives.
5016 @cindex @command{prof}
5017 @item -p
5018 @opindex p
5019 Generate extra code to write profile information suitable for the
5020 analysis program @command{prof}.  You must use this option when compiling
5021 the source files you want data about, and you must also use it when
5022 linking.
5024 @cindex @command{gprof}
5025 @item -pg
5026 @opindex pg
5027 Generate extra code to write profile information suitable for the
5028 analysis program @command{gprof}.  You must use this option when compiling
5029 the source files you want data about, and you must also use it when
5030 linking.
5032 @item -Q
5033 @opindex Q
5034 Makes the compiler print out each function name as it is compiled, and
5035 print some statistics about each pass when it finishes.
5037 @item -ftime-report
5038 @opindex ftime-report
5039 Makes the compiler print some statistics about the time consumed by each
5040 pass when it finishes.
5042 @item -fmem-report
5043 @opindex fmem-report
5044 Makes the compiler print some statistics about permanent memory
5045 allocation when it finishes.
5047 @item -fpre-ipa-mem-report
5048 @opindex fpre-ipa-mem-report
5049 @item -fpost-ipa-mem-report
5050 @opindex fpost-ipa-mem-report
5051 Makes the compiler print some statistics about permanent memory
5052 allocation before or after interprocedural optimization.
5054 @item -fstack-usage
5055 @opindex fstack-usage
5056 Makes the compiler output stack usage information for the program, on a
5057 per-function basis.  The filename for the dump is made by appending
5058 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5059 the output file, if explicitly specified and it is not an executable,
5060 otherwise it is the basename of the source file.  An entry is made up
5061 of three fields:
5063 @itemize
5064 @item
5065 The name of the function.
5066 @item
5067 A number of bytes.
5068 @item
5069 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5070 @end itemize
5072 The qualifier @code{static} means that the function manipulates the stack
5073 statically: a fixed number of bytes are allocated for the frame on function
5074 entry and released on function exit; no stack adjustments are otherwise made
5075 in the function.  The second field is this fixed number of bytes.
5077 The qualifier @code{dynamic} means that the function manipulates the stack
5078 dynamically: in addition to the static allocation described above, stack
5079 adjustments are made in the body of the function, for example to push/pop
5080 arguments around function calls.  If the qualifier @code{bounded} is also
5081 present, the amount of these adjustments is bounded at compile time and
5082 the second field is an upper bound of the total amount of stack used by
5083 the function.  If it is not present, the amount of these adjustments is
5084 not bounded at compile time and the second field only represents the
5085 bounded part.
5087 @item -fprofile-arcs
5088 @opindex fprofile-arcs
5089 Add code so that program flow @dfn{arcs} are instrumented.  During
5090 execution the program records how many times each branch and call is
5091 executed and how many times it is taken or returns.  When the compiled
5092 program exits it saves this data to a file called
5093 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5094 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5095 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5096 @var{auxname} is generated from the name of the output file, if
5097 explicitly specified and it is not the final executable, otherwise it is
5098 the basename of the source file.  In both cases any suffix is removed
5099 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5100 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5101 @xref{Cross-profiling}.
5103 @cindex @command{gcov}
5104 @item --coverage
5105 @opindex coverage
5107 This option is used to compile and link code instrumented for coverage
5108 analysis.  The option is a synonym for @option{-fprofile-arcs}
5109 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5110 linking).  See the documentation for those options for more details.
5112 @itemize
5114 @item
5115 Compile the source files with @option{-fprofile-arcs} plus optimization
5116 and code generation options.  For test coverage analysis, use the
5117 additional @option{-ftest-coverage} option.  You do not need to profile
5118 every source file in a program.
5120 @item
5121 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5122 (the latter implies the former).
5124 @item
5125 Run the program on a representative workload to generate the arc profile
5126 information.  This may be repeated any number of times.  You can run
5127 concurrent instances of your program, and provided that the file system
5128 supports locking, the data files will be correctly updated.  Also
5129 @code{fork} calls are detected and correctly handled (double counting
5130 will not happen).
5132 @item
5133 For profile-directed optimizations, compile the source files again with
5134 the same optimization and code generation options plus
5135 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5136 Control Optimization}).
5138 @item
5139 For test coverage analysis, use @command{gcov} to produce human readable
5140 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5141 @command{gcov} documentation for further information.
5143 @end itemize
5145 With @option{-fprofile-arcs}, for each function of your program GCC
5146 creates a program flow graph, then finds a spanning tree for the graph.
5147 Only arcs that are not on the spanning tree have to be instrumented: the
5148 compiler adds code to count the number of times that these arcs are
5149 executed.  When an arc is the only exit or only entrance to a block, the
5150 instrumentation code can be added to the block; otherwise, a new basic
5151 block must be created to hold the instrumentation code.
5153 @need 2000
5154 @item -ftest-coverage
5155 @opindex ftest-coverage
5156 Produce a notes file that the @command{gcov} code-coverage utility
5157 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5158 show program coverage.  Each source file's note file is called
5159 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5160 above for a description of @var{auxname} and instructions on how to
5161 generate test coverage data.  Coverage data will match the source files
5162 more closely, if you do not optimize.
5164 @item -fdbg-cnt-list
5165 @opindex fdbg-cnt-list
5166 Print the name and the counter upper bound for all debug counters.
5169 @item -fdbg-cnt=@var{counter-value-list}
5170 @opindex fdbg-cnt
5171 Set the internal debug counter upper bound.  @var{counter-value-list}
5172 is a comma-separated list of @var{name}:@var{value} pairs
5173 which sets the upper bound of each debug counter @var{name} to @var{value}.
5174 All debug counters have the initial upper bound of @var{UINT_MAX},
5175 thus dbg_cnt() returns true always unless the upper bound is set by this option.
5176 e.g. With -fdbg-cnt=dce:10,tail_call:0
5177 dbg_cnt(dce) will return true only for first 10 invocations
5179 @itemx -fenable-@var{kind}-@var{pass}
5180 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5181 @opindex fdisable-
5182 @opindex fenable-
5184 This is a set of debugging options that are used to explicitly disable/enable
5185 optimization passes. For compiler users, regular options for enabling/disabling
5186 passes should be used instead.
5188 @itemize
5190 @item -fdisable-ipa-@var{pass}
5191 Disable ipa pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5192 statically invoked in the compiler multiple times, the pass name should be
5193 appended with a sequential number starting from 1.
5195 @item -fdisable-rtl-@var{pass}
5196 @item -fdisable-rtl-@var{pass}=@var{range-list}
5197 Disable rtl pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5198 statically invoked in the compiler multiple times, the pass name should be
5199 appended with a sequential number starting from 1.  @var{range-list} is a comma
5200 seperated list of function ranges or assembler names.  Each range is a number
5201 pair seperated by a colon.  The range is inclusive in both ends.  If the range
5202 is trivial, the number pair can be simplified as a single number.  If the
5203 function's cgraph node's @var{uid} is falling within one of the specified ranges,
5204 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5205 function header of a dump file, and the pass names can be dumped by using
5206 option @option{-fdump-passes}.
5208 @item -fdisable-tree-@var{pass}
5209 @item -fdisable-tree-@var{pass}=@var{range-list}
5210 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5211 option arguments.
5213 @item -fenable-ipa-@var{pass}
5214 Enable ipa pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5215 statically invoked in the compiler multiple times, the pass name should be
5216 appended with a sequential number starting from 1.
5218 @item -fenable-rtl-@var{pass}
5219 @item -fenable-rtl-@var{pass}=@var{range-list}
5220 Enable rtl pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5221 description and examples.
5223 @item -fenable-tree-@var{pass}
5224 @item -fenable-tree-@var{pass}=@var{range-list}
5225 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5226 of option arguments.
5228 @smallexample
5230 # disable ccp1 for all functions
5231    -fdisable-tree-ccp1
5232 # disable complete unroll for function whose cgraph node uid is 1
5233    -fenable-tree-cunroll=1
5234 # disable gcse2 for functions at the following ranges [1,1],
5235 # [300,400], and [400,1000]
5236 # disable gcse2 for functions foo and foo2
5237    -fdisable-rtl-gcse2=foo,foo2
5238 # disable early inlining
5239    -fdisable-tree-einline
5240 # disable ipa inlining
5241    -fdisable-ipa-inline
5242 # enable tree full unroll
5243    -fenable-tree-unroll
5245 @end smallexample
5247 @end itemize
5249 @item -d@var{letters}
5250 @itemx -fdump-rtl-@var{pass}
5251 @opindex d
5252 Says to make debugging dumps during compilation at times specified by
5253 @var{letters}.  This is used for debugging the RTL-based passes of the
5254 compiler.  The file names for most of the dumps are made by appending
5255 a pass number and a word to the @var{dumpname}, and the files are
5256 created in the directory of the output file.  Note that the pass
5257 number is computed statically as passes get registered into the pass
5258 manager.  Thus the numbering is not related to the dynamic order of
5259 execution of passes.  In particular, a pass installed by a plugin
5260 could have a number over 200 even if it executed quite early.
5261 @var{dumpname} is generated from the name of the output file, if
5262 explicitly specified and it is not an executable, otherwise it is the
5263 basename of the source file. These switches may have different effects
5264 when @option{-E} is used for preprocessing.
5266 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5267 @option{-d} option @var{letters}.  Here are the possible
5268 letters for use in @var{pass} and @var{letters}, and their meanings:
5270 @table @gcctabopt
5272 @item -fdump-rtl-alignments
5273 @opindex fdump-rtl-alignments
5274 Dump after branch alignments have been computed.
5276 @item -fdump-rtl-asmcons
5277 @opindex fdump-rtl-asmcons
5278 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5280 @item -fdump-rtl-auto_inc_dec
5281 @opindex fdump-rtl-auto_inc_dec
5282 Dump after auto-inc-dec discovery.  This pass is only run on
5283 architectures that have auto inc or auto dec instructions.
5285 @item -fdump-rtl-barriers
5286 @opindex fdump-rtl-barriers
5287 Dump after cleaning up the barrier instructions.
5289 @item -fdump-rtl-bbpart
5290 @opindex fdump-rtl-bbpart
5291 Dump after partitioning hot and cold basic blocks.
5293 @item -fdump-rtl-bbro
5294 @opindex fdump-rtl-bbro
5295 Dump after block reordering.
5297 @item -fdump-rtl-btl1
5298 @itemx -fdump-rtl-btl2
5299 @opindex fdump-rtl-btl2
5300 @opindex fdump-rtl-btl2
5301 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5302 after the two branch
5303 target load optimization passes.
5305 @item -fdump-rtl-bypass
5306 @opindex fdump-rtl-bypass
5307 Dump after jump bypassing and control flow optimizations.
5309 @item -fdump-rtl-combine
5310 @opindex fdump-rtl-combine
5311 Dump after the RTL instruction combination pass.
5313 @item -fdump-rtl-compgotos
5314 @opindex fdump-rtl-compgotos
5315 Dump after duplicating the computed gotos.
5317 @item -fdump-rtl-ce1
5318 @itemx -fdump-rtl-ce2
5319 @itemx -fdump-rtl-ce3
5320 @opindex fdump-rtl-ce1
5321 @opindex fdump-rtl-ce2
5322 @opindex fdump-rtl-ce3
5323 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5324 @option{-fdump-rtl-ce3} enable dumping after the three
5325 if conversion passes.
5327 @itemx -fdump-rtl-cprop_hardreg
5328 @opindex fdump-rtl-cprop_hardreg
5329 Dump after hard register copy propagation.
5331 @itemx -fdump-rtl-csa
5332 @opindex fdump-rtl-csa
5333 Dump after combining stack adjustments.
5335 @item -fdump-rtl-cse1
5336 @itemx -fdump-rtl-cse2
5337 @opindex fdump-rtl-cse1
5338 @opindex fdump-rtl-cse2
5339 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5340 the two common sub-expression elimination passes.
5342 @itemx -fdump-rtl-dce
5343 @opindex fdump-rtl-dce
5344 Dump after the standalone dead code elimination passes.
5346 @itemx -fdump-rtl-dbr
5347 @opindex fdump-rtl-dbr
5348 Dump after delayed branch scheduling.
5350 @item -fdump-rtl-dce1
5351 @itemx -fdump-rtl-dce2
5352 @opindex fdump-rtl-dce1
5353 @opindex fdump-rtl-dce2
5354 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5355 the two dead store elimination passes.
5357 @item -fdump-rtl-eh
5358 @opindex fdump-rtl-eh
5359 Dump after finalization of EH handling code.
5361 @item -fdump-rtl-eh_ranges
5362 @opindex fdump-rtl-eh_ranges
5363 Dump after conversion of EH handling range regions.
5365 @item -fdump-rtl-expand
5366 @opindex fdump-rtl-expand
5367 Dump after RTL generation.
5369 @item -fdump-rtl-fwprop1
5370 @itemx -fdump-rtl-fwprop2
5371 @opindex fdump-rtl-fwprop1
5372 @opindex fdump-rtl-fwprop2
5373 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5374 dumping after the two forward propagation passes.
5376 @item -fdump-rtl-gcse1
5377 @itemx -fdump-rtl-gcse2
5378 @opindex fdump-rtl-gcse1
5379 @opindex fdump-rtl-gcse2
5380 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5381 after global common subexpression elimination.
5383 @item -fdump-rtl-init-regs
5384 @opindex fdump-rtl-init-regs
5385 Dump after the initialization of the registers.
5387 @item -fdump-rtl-initvals
5388 @opindex fdump-rtl-initvals
5389 Dump after the computation of the initial value sets.
5391 @itemx -fdump-rtl-into_cfglayout
5392 @opindex fdump-rtl-into_cfglayout
5393 Dump after converting to cfglayout mode.
5395 @item -fdump-rtl-ira
5396 @opindex fdump-rtl-ira
5397 Dump after iterated register allocation.
5399 @item -fdump-rtl-jump
5400 @opindex fdump-rtl-jump
5401 Dump after the second jump optimization.
5403 @item -fdump-rtl-loop2
5404 @opindex fdump-rtl-loop2
5405 @option{-fdump-rtl-loop2} enables dumping after the rtl
5406 loop optimization passes.
5408 @item -fdump-rtl-mach
5409 @opindex fdump-rtl-mach
5410 Dump after performing the machine dependent reorganization pass, if that
5411 pass exists.
5413 @item -fdump-rtl-mode_sw
5414 @opindex fdump-rtl-mode_sw
5415 Dump after removing redundant mode switches.
5417 @item -fdump-rtl-rnreg
5418 @opindex fdump-rtl-rnreg
5419 Dump after register renumbering.
5421 @itemx -fdump-rtl-outof_cfglayout
5422 @opindex fdump-rtl-outof_cfglayout
5423 Dump after converting from cfglayout mode.
5425 @item -fdump-rtl-peephole2
5426 @opindex fdump-rtl-peephole2
5427 Dump after the peephole pass.
5429 @item -fdump-rtl-postreload
5430 @opindex fdump-rtl-postreload
5431 Dump after post-reload optimizations.
5433 @itemx -fdump-rtl-pro_and_epilogue
5434 @opindex fdump-rtl-pro_and_epilogue
5435 Dump after generating the function prologues and epilogues.
5437 @item -fdump-rtl-regmove
5438 @opindex fdump-rtl-regmove
5439 Dump after the register move pass.
5441 @item -fdump-rtl-sched1
5442 @itemx -fdump-rtl-sched2
5443 @opindex fdump-rtl-sched1
5444 @opindex fdump-rtl-sched2
5445 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5446 after the basic block scheduling passes.
5448 @item -fdump-rtl-see
5449 @opindex fdump-rtl-see
5450 Dump after sign extension elimination.
5452 @item -fdump-rtl-seqabstr
5453 @opindex fdump-rtl-seqabstr
5454 Dump after common sequence discovery.
5456 @item -fdump-rtl-shorten
5457 @opindex fdump-rtl-shorten
5458 Dump after shortening branches.
5460 @item -fdump-rtl-sibling
5461 @opindex fdump-rtl-sibling
5462 Dump after sibling call optimizations.
5464 @item -fdump-rtl-split1
5465 @itemx -fdump-rtl-split2
5466 @itemx -fdump-rtl-split3
5467 @itemx -fdump-rtl-split4
5468 @itemx -fdump-rtl-split5
5469 @opindex fdump-rtl-split1
5470 @opindex fdump-rtl-split2
5471 @opindex fdump-rtl-split3
5472 @opindex fdump-rtl-split4
5473 @opindex fdump-rtl-split5
5474 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5475 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5476 @option{-fdump-rtl-split5} enable dumping after five rounds of
5477 instruction splitting.
5479 @item -fdump-rtl-sms
5480 @opindex fdump-rtl-sms
5481 Dump after modulo scheduling.  This pass is only run on some
5482 architectures.
5484 @item -fdump-rtl-stack
5485 @opindex fdump-rtl-stack
5486 Dump after conversion from GCC's ``flat register file'' registers to the
5487 x87's stack-like registers.  This pass is only run on x86 variants.
5489 @item -fdump-rtl-subreg1
5490 @itemx -fdump-rtl-subreg2
5491 @opindex fdump-rtl-subreg1
5492 @opindex fdump-rtl-subreg2
5493 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5494 the two subreg expansion passes.
5496 @item -fdump-rtl-unshare
5497 @opindex fdump-rtl-unshare
5498 Dump after all rtl has been unshared.
5500 @item -fdump-rtl-vartrack
5501 @opindex fdump-rtl-vartrack
5502 Dump after variable tracking.
5504 @item -fdump-rtl-vregs
5505 @opindex fdump-rtl-vregs
5506 Dump after converting virtual registers to hard registers.
5508 @item -fdump-rtl-web
5509 @opindex fdump-rtl-web
5510 Dump after live range splitting.
5512 @item -fdump-rtl-regclass
5513 @itemx -fdump-rtl-subregs_of_mode_init
5514 @itemx -fdump-rtl-subregs_of_mode_finish
5515 @itemx -fdump-rtl-dfinit
5516 @itemx -fdump-rtl-dfinish
5517 @opindex fdump-rtl-regclass
5518 @opindex fdump-rtl-subregs_of_mode_init
5519 @opindex fdump-rtl-subregs_of_mode_finish
5520 @opindex fdump-rtl-dfinit
5521 @opindex fdump-rtl-dfinish
5522 These dumps are defined but always produce empty files.
5524 @item -fdump-rtl-all
5525 @opindex fdump-rtl-all
5526 Produce all the dumps listed above.
5528 @item -dA
5529 @opindex dA
5530 Annotate the assembler output with miscellaneous debugging information.
5532 @item -dD
5533 @opindex dD
5534 Dump all macro definitions, at the end of preprocessing, in addition to
5535 normal output.
5537 @item -dH
5538 @opindex dH
5539 Produce a core dump whenever an error occurs.
5541 @item -dm
5542 @opindex dm
5543 Print statistics on memory usage, at the end of the run, to
5544 standard error.
5546 @item -dp
5547 @opindex dp
5548 Annotate the assembler output with a comment indicating which
5549 pattern and alternative was used.  The length of each instruction is
5550 also printed.
5552 @item -dP
5553 @opindex dP
5554 Dump the RTL in the assembler output as a comment before each instruction.
5555 Also turns on @option{-dp} annotation.
5557 @item -dv
5558 @opindex dv
5559 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5560 dump a representation of the control flow graph suitable for viewing with VCG
5561 to @file{@var{file}.@var{pass}.vcg}.
5563 @item -dx
5564 @opindex dx
5565 Just generate RTL for a function instead of compiling it.  Usually used
5566 with @option{-fdump-rtl-expand}.
5567 @end table
5569 @item -fdump-noaddr
5570 @opindex fdump-noaddr
5571 When doing debugging dumps, suppress address output.  This makes it more
5572 feasible to use diff on debugging dumps for compiler invocations with
5573 different compiler binaries and/or different
5574 text / bss / data / heap / stack / dso start locations.
5576 @item -fdump-unnumbered
5577 @opindex fdump-unnumbered
5578 When doing debugging dumps, suppress instruction numbers and address output.
5579 This makes it more feasible to use diff on debugging dumps for compiler
5580 invocations with different options, in particular with and without
5581 @option{-g}.
5583 @item -fdump-unnumbered-links
5584 @opindex fdump-unnumbered-links
5585 When doing debugging dumps (see @option{-d} option above), suppress
5586 instruction numbers for the links to the previous and next instructions
5587 in a sequence.
5589 @item -fdump-translation-unit @r{(C++ only)}
5590 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5591 @opindex fdump-translation-unit
5592 Dump a representation of the tree structure for the entire translation
5593 unit to a file.  The file name is made by appending @file{.tu} to the
5594 source file name, and the file is created in the same directory as the
5595 output file.  If the @samp{-@var{options}} form is used, @var{options}
5596 controls the details of the dump as described for the
5597 @option{-fdump-tree} options.
5599 @item -fdump-class-hierarchy @r{(C++ only)}
5600 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5601 @opindex fdump-class-hierarchy
5602 Dump a representation of each class's hierarchy and virtual function
5603 table layout to a file.  The file name is made by appending
5604 @file{.class} to the source file name, and the file is created in the
5605 same directory as the output file.  If the @samp{-@var{options}} form
5606 is used, @var{options} controls the details of the dump as described
5607 for the @option{-fdump-tree} options.
5609 @item -fdump-ipa-@var{switch}
5610 @opindex fdump-ipa
5611 Control the dumping at various stages of inter-procedural analysis
5612 language tree to a file.  The file name is generated by appending a
5613 switch specific suffix to the source file name, and the file is created
5614 in the same directory as the output file.  The following dumps are
5615 possible:
5617 @table @samp
5618 @item all
5619 Enables all inter-procedural analysis dumps.
5621 @item cgraph
5622 Dumps information about call-graph optimization, unused function removal,
5623 and inlining decisions.
5625 @item inline
5626 Dump after function inlining.
5628 @end table
5630 @item -fdump-passes
5631 @opindex fdump-passes
5632 Dump the list of optimization passes that are turned on and off by
5633 the current command-line options.
5635 @item -fdump-statistics-@var{option}
5636 @opindex fdump-statistics
5637 Enable and control dumping of pass statistics in a separate file.  The
5638 file name is generated by appending a suffix ending in
5639 @samp{.statistics} to the source file name, and the file is created in
5640 the same directory as the output file.  If the @samp{-@var{option}}
5641 form is used, @samp{-stats} will cause counters to be summed over the
5642 whole compilation unit while @samp{-details} will dump every event as
5643 the passes generate them.  The default with no option is to sum
5644 counters for each function compiled.
5646 @item -fdump-tree-@var{switch}
5647 @itemx -fdump-tree-@var{switch}-@var{options}
5648 @opindex fdump-tree
5649 Control the dumping at various stages of processing the intermediate
5650 language tree to a file.  The file name is generated by appending a
5651 switch specific suffix to the source file name, and the file is
5652 created in the same directory as the output file.  If the
5653 @samp{-@var{options}} form is used, @var{options} is a list of
5654 @samp{-} separated options which control the details of the dump.  Not
5655 all options are applicable to all dumps; those that are not
5656 meaningful will be ignored.  The following options are available
5658 @table @samp
5659 @item address
5660 Print the address of each node.  Usually this is not meaningful as it
5661 changes according to the environment and source file.  Its primary use
5662 is for tying up a dump file with a debug environment.
5663 @item asmname
5664 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5665 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5666 use working backward from mangled names in the assembly file.
5667 @item slim
5668 Inhibit dumping of members of a scope or body of a function merely
5669 because that scope has been reached.  Only dump such items when they
5670 are directly reachable by some other path.  When dumping pretty-printed
5671 trees, this option inhibits dumping the bodies of control structures.
5672 @item raw
5673 Print a raw representation of the tree.  By default, trees are
5674 pretty-printed into a C-like representation.
5675 @item details
5676 Enable more detailed dumps (not honored by every dump option).
5677 @item stats
5678 Enable dumping various statistics about the pass (not honored by every dump
5679 option).
5680 @item blocks
5681 Enable showing basic block boundaries (disabled in raw dumps).
5682 @item vops
5683 Enable showing virtual operands for every statement.
5684 @item lineno
5685 Enable showing line numbers for statements.
5686 @item uid
5687 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5688 @item verbose
5689 Enable showing the tree dump for each statement.
5690 @item eh
5691 Enable showing the EH region number holding each statement.
5692 @item scev
5693 Enable showing scalar evolution analysis details.
5694 @item all
5695 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5696 and @option{lineno}.
5697 @end table
5699 The following tree dumps are possible:
5700 @table @samp
5702 @item original
5703 @opindex fdump-tree-original
5704 Dump before any tree based optimization, to @file{@var{file}.original}.
5706 @item optimized
5707 @opindex fdump-tree-optimized
5708 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5710 @item gimple
5711 @opindex fdump-tree-gimple
5712 Dump each function before and after the gimplification pass to a file.  The
5713 file name is made by appending @file{.gimple} to the source file name.
5715 @item cfg
5716 @opindex fdump-tree-cfg
5717 Dump the control flow graph of each function to a file.  The file name is
5718 made by appending @file{.cfg} to the source file name.
5720 @item vcg
5721 @opindex fdump-tree-vcg
5722 Dump the control flow graph of each function to a file in VCG format.  The
5723 file name is made by appending @file{.vcg} to the source file name.  Note
5724 that if the file contains more than one function, the generated file cannot
5725 be used directly by VCG@.  You will need to cut and paste each function's
5726 graph into its own separate file first.
5728 @item ch
5729 @opindex fdump-tree-ch
5730 Dump each function after copying loop headers.  The file name is made by
5731 appending @file{.ch} to the source file name.
5733 @item ssa
5734 @opindex fdump-tree-ssa
5735 Dump SSA related information to a file.  The file name is made by appending
5736 @file{.ssa} to the source file name.
5738 @item alias
5739 @opindex fdump-tree-alias
5740 Dump aliasing information for each function.  The file name is made by
5741 appending @file{.alias} to the source file name.
5743 @item ccp
5744 @opindex fdump-tree-ccp
5745 Dump each function after CCP@.  The file name is made by appending
5746 @file{.ccp} to the source file name.
5748 @item storeccp
5749 @opindex fdump-tree-storeccp
5750 Dump each function after STORE-CCP@.  The file name is made by appending
5751 @file{.storeccp} to the source file name.
5753 @item pre
5754 @opindex fdump-tree-pre
5755 Dump trees after partial redundancy elimination.  The file name is made
5756 by appending @file{.pre} to the source file name.
5758 @item fre
5759 @opindex fdump-tree-fre
5760 Dump trees after full redundancy elimination.  The file name is made
5761 by appending @file{.fre} to the source file name.
5763 @item copyprop
5764 @opindex fdump-tree-copyprop
5765 Dump trees after copy propagation.  The file name is made
5766 by appending @file{.copyprop} to the source file name.
5768 @item store_copyprop
5769 @opindex fdump-tree-store_copyprop
5770 Dump trees after store copy-propagation.  The file name is made
5771 by appending @file{.store_copyprop} to the source file name.
5773 @item dce
5774 @opindex fdump-tree-dce
5775 Dump each function after dead code elimination.  The file name is made by
5776 appending @file{.dce} to the source file name.
5778 @item mudflap
5779 @opindex fdump-tree-mudflap
5780 Dump each function after adding mudflap instrumentation.  The file name is
5781 made by appending @file{.mudflap} to the source file name.
5783 @item sra
5784 @opindex fdump-tree-sra
5785 Dump each function after performing scalar replacement of aggregates.  The
5786 file name is made by appending @file{.sra} to the source file name.
5788 @item sink
5789 @opindex fdump-tree-sink
5790 Dump each function after performing code sinking.  The file name is made
5791 by appending @file{.sink} to the source file name.
5793 @item dom
5794 @opindex fdump-tree-dom
5795 Dump each function after applying dominator tree optimizations.  The file
5796 name is made by appending @file{.dom} to the source file name.
5798 @item dse
5799 @opindex fdump-tree-dse
5800 Dump each function after applying dead store elimination.  The file
5801 name is made by appending @file{.dse} to the source file name.
5803 @item phiopt
5804 @opindex fdump-tree-phiopt
5805 Dump each function after optimizing PHI nodes into straightline code.  The file
5806 name is made by appending @file{.phiopt} to the source file name.
5808 @item forwprop
5809 @opindex fdump-tree-forwprop
5810 Dump each function after forward propagating single use variables.  The file
5811 name is made by appending @file{.forwprop} to the source file name.
5813 @item copyrename
5814 @opindex fdump-tree-copyrename
5815 Dump each function after applying the copy rename optimization.  The file
5816 name is made by appending @file{.copyrename} to the source file name.
5818 @item nrv
5819 @opindex fdump-tree-nrv
5820 Dump each function after applying the named return value optimization on
5821 generic trees.  The file name is made by appending @file{.nrv} to the source
5822 file name.
5824 @item vect
5825 @opindex fdump-tree-vect
5826 Dump each function after applying vectorization of loops.  The file name is
5827 made by appending @file{.vect} to the source file name.
5829 @item slp
5830 @opindex fdump-tree-slp
5831 Dump each function after applying vectorization of basic blocks.  The file name
5832 is made by appending @file{.slp} to the source file name.
5834 @item vrp
5835 @opindex fdump-tree-vrp
5836 Dump each function after Value Range Propagation (VRP).  The file name
5837 is made by appending @file{.vrp} to the source file name.
5839 @item all
5840 @opindex fdump-tree-all
5841 Enable all the available tree dumps with the flags provided in this option.
5842 @end table
5844 @item -ftree-vectorizer-verbose=@var{n}
5845 @opindex ftree-vectorizer-verbose
5846 This option controls the amount of debugging output the vectorizer prints.
5847 This information is written to standard error, unless
5848 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5849 in which case it is output to the usual dump listing file, @file{.vect}.
5850 For @var{n}=0 no diagnostic information is reported.
5851 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5852 and the total number of loops that got vectorized.
5853 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5854 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5855 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5856 level that @option{-fdump-tree-vect-stats} uses.
5857 Higher verbosity levels mean either more information dumped for each
5858 reported loop, or same amount of information reported for more loops:
5859 if @var{n}=3, vectorizer cost model information is reported.
5860 If @var{n}=4, alignment related information is added to the reports.
5861 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5862 memory access-patterns) is added to the reports.
5863 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5864 that did not pass the first analysis phase (i.e., may not be countable, or
5865 may have complicated control-flow).
5866 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5867 If @var{n}=8, SLP related information is added to the reports.
5868 For @var{n}=9, all the information the vectorizer generates during its
5869 analysis and transformation is reported.  This is the same verbosity level
5870 that @option{-fdump-tree-vect-details} uses.
5872 @item -frandom-seed=@var{string}
5873 @opindex frandom-seed
5874 This option provides a seed that GCC uses when it would otherwise use
5875 random numbers.  It is used to generate certain symbol names
5876 that have to be different in every compiled file.  It is also used to
5877 place unique stamps in coverage data files and the object files that
5878 produce them.  You can use the @option{-frandom-seed} option to produce
5879 reproducibly identical object files.
5881 The @var{string} should be different for every file you compile.
5883 @item -fsched-verbose=@var{n}
5884 @opindex fsched-verbose
5885 On targets that use instruction scheduling, this option controls the
5886 amount of debugging output the scheduler prints.  This information is
5887 written to standard error, unless @option{-fdump-rtl-sched1} or
5888 @option{-fdump-rtl-sched2} is specified, in which case it is output
5889 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5890 respectively.  However for @var{n} greater than nine, the output is
5891 always printed to standard error.
5893 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5894 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5895 For @var{n} greater than one, it also output basic block probabilities,
5896 detailed ready list information and unit/insn info.  For @var{n} greater
5897 than two, it includes RTL at abort point, control-flow and regions info.
5898 And for @var{n} over four, @option{-fsched-verbose} also includes
5899 dependence info.
5901 @item -save-temps
5902 @itemx -save-temps=cwd
5903 @opindex save-temps
5904 Store the usual ``temporary'' intermediate files permanently; place them
5905 in the current directory and name them based on the source file.  Thus,
5906 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5907 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5908 preprocessed @file{foo.i} output file even though the compiler now
5909 normally uses an integrated preprocessor.
5911 When used in combination with the @option{-x} command-line option,
5912 @option{-save-temps} is sensible enough to avoid over writing an
5913 input source file with the same extension as an intermediate file.
5914 The corresponding intermediate file may be obtained by renaming the
5915 source file before using @option{-save-temps}.
5917 If you invoke GCC in parallel, compiling several different source
5918 files that share a common base name in different subdirectories or the
5919 same source file compiled for multiple output destinations, it is
5920 likely that the different parallel compilers will interfere with each
5921 other, and overwrite the temporary files.  For instance:
5923 @smallexample
5924 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5925 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5926 @end smallexample
5928 may result in @file{foo.i} and @file{foo.o} being written to
5929 simultaneously by both compilers.
5931 @item -save-temps=obj
5932 @opindex save-temps=obj
5933 Store the usual ``temporary'' intermediate files permanently.  If the
5934 @option{-o} option is used, the temporary files are based on the
5935 object file.  If the @option{-o} option is not used, the
5936 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5938 For example:
5940 @smallexample
5941 gcc -save-temps=obj -c foo.c
5942 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5943 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5944 @end smallexample
5946 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5947 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5948 @file{dir2/yfoobar.o}.
5950 @item -time@r{[}=@var{file}@r{]}
5951 @opindex time
5952 Report the CPU time taken by each subprocess in the compilation
5953 sequence.  For C source files, this is the compiler proper and assembler
5954 (plus the linker if linking is done).
5956 Without the specification of an output file, the output looks like this:
5958 @smallexample
5959 # cc1 0.12 0.01
5960 # as 0.00 0.01
5961 @end smallexample
5963 The first number on each line is the ``user time'', that is time spent
5964 executing the program itself.  The second number is ``system time'',
5965 time spent executing operating system routines on behalf of the program.
5966 Both numbers are in seconds.
5968 With the specification of an output file, the output is appended to the
5969 named file, and it looks like this:
5971 @smallexample
5972 0.12 0.01 cc1 @var{options}
5973 0.00 0.01 as @var{options}
5974 @end smallexample
5976 The ``user time'' and the ``system time'' are moved before the program
5977 name, and the options passed to the program are displayed, so that one
5978 can later tell what file was being compiled, and with which options.
5980 @item -fvar-tracking
5981 @opindex fvar-tracking
5982 Run variable tracking pass.  It computes where variables are stored at each
5983 position in code.  Better debugging information is then generated
5984 (if the debugging information format supports this information).
5986 It is enabled by default when compiling with optimization (@option{-Os},
5987 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5988 the debug info format supports it.
5990 @item -fvar-tracking-assignments
5991 @opindex fvar-tracking-assignments
5992 @opindex fno-var-tracking-assignments
5993 Annotate assignments to user variables early in the compilation and
5994 attempt to carry the annotations over throughout the compilation all the
5995 way to the end, in an attempt to improve debug information while
5996 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5998 It can be enabled even if var-tracking is disabled, in which case
5999 annotations will be created and maintained, but discarded at the end.
6001 @item -fvar-tracking-assignments-toggle
6002 @opindex fvar-tracking-assignments-toggle
6003 @opindex fno-var-tracking-assignments-toggle
6004 Toggle @option{-fvar-tracking-assignments}, in the same way that
6005 @option{-gtoggle} toggles @option{-g}.
6007 @item -print-file-name=@var{library}
6008 @opindex print-file-name
6009 Print the full absolute name of the library file @var{library} that
6010 would be used when linking---and don't do anything else.  With this
6011 option, GCC does not compile or link anything; it just prints the
6012 file name.
6014 @item -print-multi-directory
6015 @opindex print-multi-directory
6016 Print the directory name corresponding to the multilib selected by any
6017 other switches present in the command line.  This directory is supposed
6018 to exist in @env{GCC_EXEC_PREFIX}.
6020 @item -print-multi-lib
6021 @opindex print-multi-lib
6022 Print the mapping from multilib directory names to compiler switches
6023 that enable them.  The directory name is separated from the switches by
6024 @samp{;}, and each switch starts with an @samp{@@} instead of the
6025 @samp{-}, without spaces between multiple switches.  This is supposed to
6026 ease shell-processing.
6028 @item -print-multi-os-directory
6029 @opindex print-multi-os-directory
6030 Print the path to OS libraries for the selected
6031 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6032 present in the @file{lib} subdirectory and no multilibs are used, this is
6033 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6034 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6035 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6036 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6038 @item -print-prog-name=@var{program}
6039 @opindex print-prog-name
6040 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6042 @item -print-libgcc-file-name
6043 @opindex print-libgcc-file-name
6044 Same as @option{-print-file-name=libgcc.a}.
6046 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6047 but you do want to link with @file{libgcc.a}.  You can do
6049 @smallexample
6050 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6051 @end smallexample
6053 @item -print-search-dirs
6054 @opindex print-search-dirs
6055 Print the name of the configured installation directory and a list of
6056 program and library directories @command{gcc} will search---and don't do anything else.
6058 This is useful when @command{gcc} prints the error message
6059 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6060 To resolve this you either need to put @file{cpp0} and the other compiler
6061 components where @command{gcc} expects to find them, or you can set the environment
6062 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6063 Don't forget the trailing @samp{/}.
6064 @xref{Environment Variables}.
6066 @item -print-sysroot
6067 @opindex print-sysroot
6068 Print the target sysroot directory that will be used during
6069 compilation.  This is the target sysroot specified either at configure
6070 time or using the @option{--sysroot} option, possibly with an extra
6071 suffix that depends on compilation options.  If no target sysroot is
6072 specified, the option prints nothing.
6074 @item -print-sysroot-headers-suffix
6075 @opindex print-sysroot-headers-suffix
6076 Print the suffix added to the target sysroot when searching for
6077 headers, or give an error if the compiler is not configured with such
6078 a suffix---and don't do anything else.
6080 @item -dumpmachine
6081 @opindex dumpmachine
6082 Print the compiler's target machine (for example,
6083 @samp{i686-pc-linux-gnu})---and don't do anything else.
6085 @item -dumpversion
6086 @opindex dumpversion
6087 Print the compiler version (for example, @samp{3.0})---and don't do
6088 anything else.
6090 @item -dumpspecs
6091 @opindex dumpspecs
6092 Print the compiler's built-in specs---and don't do anything else.  (This
6093 is used when GCC itself is being built.)  @xref{Spec Files}.
6095 @item -feliminate-unused-debug-types
6096 @opindex feliminate-unused-debug-types
6097 Normally, when producing DWARF 2 output, GCC will emit debugging
6098 information for all types declared in a compilation
6099 unit, regardless of whether or not they are actually used
6100 in that compilation unit.  Sometimes this is useful, such as
6101 if, in the debugger, you want to cast a value to a type that is
6102 not actually used in your program (but is declared).  More often,
6103 however, this results in a significant amount of wasted space.
6104 With this option, GCC will avoid producing debug symbol output
6105 for types that are nowhere used in the source file being compiled.
6106 @end table
6108 @node Optimize Options
6109 @section Options That Control Optimization
6110 @cindex optimize options
6111 @cindex options, optimization
6113 These options control various sorts of optimizations.
6115 Without any optimization option, the compiler's goal is to reduce the
6116 cost of compilation and to make debugging produce the expected
6117 results.  Statements are independent: if you stop the program with a
6118 breakpoint between statements, you can then assign a new value to any
6119 variable or change the program counter to any other statement in the
6120 function and get exactly the results you would expect from the source
6121 code.
6123 Turning on optimization flags makes the compiler attempt to improve
6124 the performance and/or code size at the expense of compilation time
6125 and possibly the ability to debug the program.
6127 The compiler performs optimization based on the knowledge it has of the
6128 program.  Compiling multiple files at once to a single output file mode allows
6129 the compiler to use information gained from all of the files when compiling
6130 each of them.
6132 Not all optimizations are controlled directly by a flag.  Only
6133 optimizations that have a flag are listed in this section.
6135 Most optimizations are only enabled if an @option{-O} level is set on
6136 the command line.  Otherwise they are disabled, even if individual
6137 optimization flags are specified.
6139 Depending on the target and how GCC was configured, a slightly different
6140 set of optimizations may be enabled at each @option{-O} level than
6141 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
6142 to find out the exact set of optimizations that are enabled at each level.
6143 @xref{Overall Options}, for examples.
6145 @table @gcctabopt
6146 @item -O
6147 @itemx -O1
6148 @opindex O
6149 @opindex O1
6150 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6151 more memory for a large function.
6153 With @option{-O}, the compiler tries to reduce code size and execution
6154 time, without performing any optimizations that take a great deal of
6155 compilation time.
6157 @option{-O} turns on the following optimization flags:
6158 @gccoptlist{
6159 -fauto-inc-dec @gol
6160 -fcompare-elim @gol
6161 -fcprop-registers @gol
6162 -fdce @gol
6163 -fdefer-pop @gol
6164 -fdelayed-branch @gol
6165 -fdse @gol
6166 -fguess-branch-probability @gol
6167 -fif-conversion2 @gol
6168 -fif-conversion @gol
6169 -fipa-pure-const @gol
6170 -fipa-profile @gol
6171 -fipa-reference @gol
6172 -fmerge-constants
6173 -fsplit-wide-types @gol
6174 -ftree-bit-ccp @gol
6175 -ftree-builtin-call-dce @gol
6176 -ftree-ccp @gol
6177 -ftree-ch @gol
6178 -ftree-copyrename @gol
6179 -ftree-dce @gol
6180 -ftree-dominator-opts @gol
6181 -ftree-dse @gol
6182 -ftree-forwprop @gol
6183 -ftree-fre @gol
6184 -ftree-phiprop @gol
6185 -ftree-sra @gol
6186 -ftree-pta @gol
6187 -ftree-ter @gol
6188 -funit-at-a-time}
6190 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6191 where doing so does not interfere with debugging.
6193 @item -O2
6194 @opindex O2
6195 Optimize even more.  GCC performs nearly all supported optimizations
6196 that do not involve a space-speed tradeoff.
6197 As compared to @option{-O}, this option increases both compilation time
6198 and the performance of the generated code.
6200 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6201 also turns on the following optimization flags:
6202 @gccoptlist{-fthread-jumps @gol
6203 -falign-functions  -falign-jumps @gol
6204 -falign-loops  -falign-labels @gol
6205 -fcaller-saves @gol
6206 -fcrossjumping @gol
6207 -fcse-follow-jumps  -fcse-skip-blocks @gol
6208 -fdelete-null-pointer-checks @gol
6209 -fdevirtualize @gol
6210 -fexpensive-optimizations @gol
6211 -fgcse  -fgcse-lm  @gol
6212 -finline-small-functions @gol
6213 -findirect-inlining @gol
6214 -fipa-sra @gol
6215 -foptimize-sibling-calls @gol
6216 -fpartial-inlining @gol
6217 -fpeephole2 @gol
6218 -fregmove @gol
6219 -freorder-blocks  -freorder-functions @gol
6220 -frerun-cse-after-loop  @gol
6221 -fsched-interblock  -fsched-spec @gol
6222 -fschedule-insns  -fschedule-insns2 @gol
6223 -fstrict-aliasing -fstrict-overflow @gol
6224 -ftree-switch-conversion -ftree-tail-merge @gol
6225 -ftree-pre @gol
6226 -ftree-vrp}
6228 Please note the warning under @option{-fgcse} about
6229 invoking @option{-O2} on programs that use computed gotos.
6231 @item -O3
6232 @opindex O3
6233 Optimize yet more.  @option{-O3} turns on all optimizations specified
6234 by @option{-O2} and also turns on the @option{-finline-functions},
6235 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6236 @option{-fgcse-after-reload}, @option{-ftree-vectorize} and
6237 @option{-fipa-cp-clone} options.
6239 @item -O0
6240 @opindex O0
6241 Reduce compilation time and make debugging produce the expected
6242 results.  This is the default.
6244 @item -Os
6245 @opindex Os
6246 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6247 do not typically increase code size.  It also performs further
6248 optimizations designed to reduce code size.
6250 @option{-Os} disables the following optimization flags:
6251 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6252 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6253 -fprefetch-loop-arrays  -ftree-vect-loop-version}
6255 @item -Ofast
6256 @opindex Ofast
6257 Disregard strict standards compliance.  @option{-Ofast} enables all
6258 @option{-O3} optimizations.  It also enables optimizations that are not
6259 valid for all standard compliant programs.
6260 It turns on @option{-ffast-math} and the Fortran-specific
6261 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6263 If you use multiple @option{-O} options, with or without level numbers,
6264 the last such option is the one that is effective.
6265 @end table
6267 Options of the form @option{-f@var{flag}} specify machine-independent
6268 flags.  Most flags have both positive and negative forms; the negative
6269 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
6270 below, only one of the forms is listed---the one you typically will
6271 use.  You can figure out the other form by either removing @samp{no-}
6272 or adding it.
6274 The following options control specific optimizations.  They are either
6275 activated by @option{-O} options or are related to ones that are.  You
6276 can use the following flags in the rare cases when ``fine-tuning'' of
6277 optimizations to be performed is desired.
6279 @table @gcctabopt
6280 @item -fno-default-inline
6281 @opindex fno-default-inline
6282 Do not make member functions inline by default merely because they are
6283 defined inside the class scope (C++ only).  Otherwise, when you specify
6284 @w{@option{-O}}, member functions defined inside class scope are compiled
6285 inline by default; i.e., you don't need to add @samp{inline} in front of
6286 the member function name.
6288 @item -fno-defer-pop
6289 @opindex fno-defer-pop
6290 Always pop the arguments to each function call as soon as that function
6291 returns.  For machines that must pop arguments after a function call,
6292 the compiler normally lets arguments accumulate on the stack for several
6293 function calls and pops them all at once.
6295 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6297 @item -fforward-propagate
6298 @opindex fforward-propagate
6299 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6300 instructions and checks if the result can be simplified.  If loop unrolling
6301 is active, two passes are performed and the second is scheduled after
6302 loop unrolling.
6304 This option is enabled by default at optimization levels @option{-O},
6305 @option{-O2}, @option{-O3}, @option{-Os}.
6307 @item -ffp-contract=@var{style}
6308 @opindex ffp-contract
6309 @option{-ffp-contract=off} disables floating-point expression contraction.
6310 @option{-ffp-contract=fast} enables floating-point expression contraction
6311 such as forming of fused multiply-add operations if the target has
6312 native support for them.
6313 @option{-ffp-contract=on} enables floating-point expression contraction
6314 if allowed by the language standard.  This is currently not implemented
6315 and treated equal to @option{-ffp-contract=off}.
6317 The default is @option{-ffp-contract=fast}.
6319 @item -fomit-frame-pointer
6320 @opindex fomit-frame-pointer
6321 Don't keep the frame pointer in a register for functions that
6322 don't need one.  This avoids the instructions to save, set up and
6323 restore frame pointers; it also makes an extra register available
6324 in many functions.  @strong{It also makes debugging impossible on
6325 some machines.}
6327 On some machines, such as the VAX, this flag has no effect, because
6328 the standard calling sequence automatically handles the frame pointer
6329 and nothing is saved by pretending it doesn't exist.  The
6330 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6331 whether a target machine supports this flag.  @xref{Registers,,Register
6332 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6334 Starting with GCC version 4.6, the default setting (when not optimizing for
6335 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6336 @option{-fomit-frame-pointer}.  The default can be reverted to
6337 @option{-fno-omit-frame-pointer} by configuring GCC with the
6338 @option{--enable-frame-pointer} configure option.
6340 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6342 @item -foptimize-sibling-calls
6343 @opindex foptimize-sibling-calls
6344 Optimize sibling and tail recursive calls.
6346 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6348 @item -fno-inline
6349 @opindex fno-inline
6350 Do not expand any functions inline apart from those marked with
6351 the @code{always_inline} attribute.  This is the default when not
6352 optimizing.
6354 Single functions can be exempted from inlining by marking them
6355 with the @code{noinline} attribute.
6357 @item -finline-small-functions
6358 @opindex finline-small-functions
6359 Integrate functions into their callers when their body is smaller than expected
6360 function call code (so overall size of program gets smaller).  The compiler
6361 heuristically decides which functions are simple enough to be worth integrating
6362 in this way.  This inlining applies to all functions, even those not declared
6363 inline.
6365 Enabled at level @option{-O2}.
6367 @item -findirect-inlining
6368 @opindex findirect-inlining
6369 Inline also indirect calls that are discovered to be known at compile
6370 time thanks to previous inlining.  This option has any effect only
6371 when inlining itself is turned on by the @option{-finline-functions}
6372 or @option{-finline-small-functions} options.
6374 Enabled at level @option{-O2}.
6376 @item -finline-functions
6377 @opindex finline-functions
6378 Consider all functions for inlining, even if they are not declared inline.
6379 The compiler heuristically decides which functions are worth integrating
6380 in this way.
6382 If all calls to a given function are integrated, and the function is
6383 declared @code{static}, then the function is normally not output as
6384 assembler code in its own right.
6386 Enabled at level @option{-O3}.
6388 @item -finline-functions-called-once
6389 @opindex finline-functions-called-once
6390 Consider all @code{static} functions called once for inlining into their
6391 caller even if they are not marked @code{inline}.  If a call to a given
6392 function is integrated, then the function is not output as assembler code
6393 in its own right.
6395 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6397 @item -fearly-inlining
6398 @opindex fearly-inlining
6399 Inline functions marked by @code{always_inline} and functions whose body seems
6400 smaller than the function call overhead early before doing
6401 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6402 makes profiling significantly cheaper and usually inlining faster on programs
6403 having large chains of nested wrapper functions.
6405 Enabled by default.
6407 @item -fipa-sra
6408 @opindex fipa-sra
6409 Perform interprocedural scalar replacement of aggregates, removal of
6410 unused parameters and replacement of parameters passed by reference
6411 by parameters passed by value.
6413 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6415 @item -finline-limit=@var{n}
6416 @opindex finline-limit
6417 By default, GCC limits the size of functions that can be inlined.  This flag
6418 allows coarse control of this limit.  @var{n} is the size of functions that
6419 can be inlined in number of pseudo instructions.
6421 Inlining is actually controlled by a number of parameters, which may be
6422 specified individually by using @option{--param @var{name}=@var{value}}.
6423 The @option{-finline-limit=@var{n}} option sets some of these parameters
6424 as follows:
6426 @table @gcctabopt
6427 @item max-inline-insns-single
6428 is set to @var{n}/2.
6429 @item max-inline-insns-auto
6430 is set to @var{n}/2.
6431 @end table
6433 See below for a documentation of the individual
6434 parameters controlling inlining and for the defaults of these parameters.
6436 @emph{Note:} there may be no value to @option{-finline-limit} that results
6437 in default behavior.
6439 @emph{Note:} pseudo instruction represents, in this particular context, an
6440 abstract measurement of function's size.  In no way does it represent a count
6441 of assembly instructions and as such its exact meaning might change from one
6442 release to an another.
6444 @item -fno-keep-inline-dllexport
6445 @opindex -fno-keep-inline-dllexport
6446 This is a more fine-grained version of @option{-fkeep-inline-functions},
6447 which applies only to functions that are declared using the @code{dllexport}
6448 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6449 Functions}.)
6451 @item -fkeep-inline-functions
6452 @opindex fkeep-inline-functions
6453 In C, emit @code{static} functions that are declared @code{inline}
6454 into the object file, even if the function has been inlined into all
6455 of its callers.  This switch does not affect functions using the
6456 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6457 inline functions into the object file.
6459 @item -fkeep-static-consts
6460 @opindex fkeep-static-consts
6461 Emit variables declared @code{static const} when optimization isn't turned
6462 on, even if the variables aren't referenced.
6464 GCC enables this option by default.  If you want to force the compiler to
6465 check if the variable was referenced, regardless of whether or not
6466 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6468 @item -fmerge-constants
6469 @opindex fmerge-constants
6470 Attempt to merge identical constants (string constants and floating-point
6471 constants) across compilation units.
6473 This option is the default for optimized compilation if the assembler and
6474 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6475 behavior.
6477 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6479 @item -fmerge-all-constants
6480 @opindex fmerge-all-constants
6481 Attempt to merge identical constants and identical variables.
6483 This option implies @option{-fmerge-constants}.  In addition to
6484 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6485 arrays or initialized constant variables with integral or floating-point
6486 types.  Languages like C or C++ require each variable, including multiple
6487 instances of the same variable in recursive calls, to have distinct locations,
6488 so using this option will result in non-conforming
6489 behavior.
6491 @item -fmodulo-sched
6492 @opindex fmodulo-sched
6493 Perform swing modulo scheduling immediately before the first scheduling
6494 pass.  This pass looks at innermost loops and reorders their
6495 instructions by overlapping different iterations.
6497 @item -fmodulo-sched-allow-regmoves
6498 @opindex fmodulo-sched-allow-regmoves
6499 Perform more aggressive SMS based modulo scheduling with register moves
6500 allowed.  By setting this flag certain anti-dependences edges will be
6501 deleted which will trigger the generation of reg-moves based on the
6502 life-range analysis.  This option is effective only with
6503 @option{-fmodulo-sched} enabled.
6505 @item -fno-branch-count-reg
6506 @opindex fno-branch-count-reg
6507 Do not use ``decrement and branch'' instructions on a count register,
6508 but instead generate a sequence of instructions that decrement a
6509 register, compare it against zero, then branch based upon the result.
6510 This option is only meaningful on architectures that support such
6511 instructions, which include x86, PowerPC, IA-64 and S/390.
6513 The default is @option{-fbranch-count-reg}.
6515 @item -fno-function-cse
6516 @opindex fno-function-cse
6517 Do not put function addresses in registers; make each instruction that
6518 calls a constant function contain the function's address explicitly.
6520 This option results in less efficient code, but some strange hacks
6521 that alter the assembler output may be confused by the optimizations
6522 performed when this option is not used.
6524 The default is @option{-ffunction-cse}
6526 @item -fno-zero-initialized-in-bss
6527 @opindex fno-zero-initialized-in-bss
6528 If the target supports a BSS section, GCC by default puts variables that
6529 are initialized to zero into BSS@.  This can save space in the resulting
6530 code.
6532 This option turns off this behavior because some programs explicitly
6533 rely on variables going to the data section.  E.g., so that the
6534 resulting executable can find the beginning of that section and/or make
6535 assumptions based on that.
6537 The default is @option{-fzero-initialized-in-bss}.
6539 @item -fmudflap -fmudflapth -fmudflapir
6540 @opindex fmudflap
6541 @opindex fmudflapth
6542 @opindex fmudflapir
6543 @cindex bounds checking
6544 @cindex mudflap
6545 For front-ends that support it (C and C++), instrument all risky
6546 pointer/array dereferencing operations, some standard library
6547 string/heap functions, and some other associated constructs with
6548 range/validity tests.  Modules so instrumented should be immune to
6549 buffer overflows, invalid heap use, and some other classes of C/C++
6550 programming errors.  The instrumentation relies on a separate runtime
6551 library (@file{libmudflap}), which will be linked into a program if
6552 @option{-fmudflap} is given at link time.  Run-time behavior of the
6553 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6554 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6555 for its options.
6557 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6558 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6559 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6560 instrumentation should ignore pointer reads.  This produces less
6561 instrumentation (and therefore faster execution) and still provides
6562 some protection against outright memory corrupting writes, but allows
6563 erroneously read data to propagate within a program.
6565 @item -fthread-jumps
6566 @opindex fthread-jumps
6567 Perform optimizations where we check to see if a jump branches to a
6568 location where another comparison subsumed by the first is found.  If
6569 so, the first branch is redirected to either the destination of the
6570 second branch or a point immediately following it, depending on whether
6571 the condition is known to be true or false.
6573 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6575 @item -fsplit-wide-types
6576 @opindex fsplit-wide-types
6577 When using a type that occupies multiple registers, such as @code{long
6578 long} on a 32-bit system, split the registers apart and allocate them
6579 independently.  This normally generates better code for those types,
6580 but may make debugging more difficult.
6582 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6583 @option{-Os}.
6585 @item -fcse-follow-jumps
6586 @opindex fcse-follow-jumps
6587 In common subexpression elimination (CSE), scan through jump instructions
6588 when the target of the jump is not reached by any other path.  For
6589 example, when CSE encounters an @code{if} statement with an
6590 @code{else} clause, CSE will follow the jump when the condition
6591 tested is false.
6593 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6595 @item -fcse-skip-blocks
6596 @opindex fcse-skip-blocks
6597 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6598 follow jumps that conditionally skip over blocks.  When CSE
6599 encounters a simple @code{if} statement with no else clause,
6600 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6601 body of the @code{if}.
6603 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6605 @item -frerun-cse-after-loop
6606 @opindex frerun-cse-after-loop
6607 Re-run common subexpression elimination after loop optimizations has been
6608 performed.
6610 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6612 @item -fgcse
6613 @opindex fgcse
6614 Perform a global common subexpression elimination pass.
6615 This pass also performs global constant and copy propagation.
6617 @emph{Note:} When compiling a program using computed gotos, a GCC
6618 extension, you may get better run-time performance if you disable
6619 the global common subexpression elimination pass by adding
6620 @option{-fno-gcse} to the command line.
6622 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6624 @item -fgcse-lm
6625 @opindex fgcse-lm
6626 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6627 attempt to move loads that are only killed by stores into themselves.  This
6628 allows a loop containing a load/store sequence to be changed to a load outside
6629 the loop, and a copy/store within the loop.
6631 Enabled by default when gcse is enabled.
6633 @item -fgcse-sm
6634 @opindex fgcse-sm
6635 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6636 global common subexpression elimination.  This pass will attempt to move
6637 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6638 loops containing a load/store sequence can be changed to a load before
6639 the loop and a store after the loop.
6641 Not enabled at any optimization level.
6643 @item -fgcse-las
6644 @opindex fgcse-las
6645 When @option{-fgcse-las} is enabled, the global common subexpression
6646 elimination pass eliminates redundant loads that come after stores to the
6647 same memory location (both partial and full redundancies).
6649 Not enabled at any optimization level.
6651 @item -fgcse-after-reload
6652 @opindex fgcse-after-reload
6653 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6654 pass is performed after reload.  The purpose of this pass is to cleanup
6655 redundant spilling.
6657 @item -funsafe-loop-optimizations
6658 @opindex funsafe-loop-optimizations
6659 If given, the loop optimizer will assume that loop indices do not
6660 overflow, and that the loops with nontrivial exit condition are not
6661 infinite.  This enables a wider range of loop optimizations even if
6662 the loop optimizer itself cannot prove that these assumptions are valid.
6663 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6664 if it finds this kind of loop.
6666 @item -fcrossjumping
6667 @opindex fcrossjumping
6668 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6669 resulting code may or may not perform better than without cross-jumping.
6671 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6673 @item -fauto-inc-dec
6674 @opindex fauto-inc-dec
6675 Combine increments or decrements of addresses with memory accesses.
6676 This pass is always skipped on architectures that do not have
6677 instructions to support this.  Enabled by default at @option{-O} and
6678 higher on architectures that support this.
6680 @item -fdce
6681 @opindex fdce
6682 Perform dead code elimination (DCE) on RTL@.
6683 Enabled by default at @option{-O} and higher.
6685 @item -fdse
6686 @opindex fdse
6687 Perform dead store elimination (DSE) on RTL@.
6688 Enabled by default at @option{-O} and higher.
6690 @item -fif-conversion
6691 @opindex fif-conversion
6692 Attempt to transform conditional jumps into branch-less equivalents.  This
6693 include use of conditional moves, min, max, set flags and abs instructions, and
6694 some tricks doable by standard arithmetics.  The use of conditional execution
6695 on chips where it is available is controlled by @code{if-conversion2}.
6697 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6699 @item -fif-conversion2
6700 @opindex fif-conversion2
6701 Use conditional execution (where available) to transform conditional jumps into
6702 branch-less equivalents.
6704 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6706 @item -fdelete-null-pointer-checks
6707 @opindex fdelete-null-pointer-checks
6708 Assume that programs cannot safely dereference null pointers, and that
6709 no code or data element resides there.  This enables simple constant
6710 folding optimizations at all optimization levels.  In addition, other
6711 optimization passes in GCC use this flag to control global dataflow
6712 analyses that eliminate useless checks for null pointers; these assume
6713 that if a pointer is checked after it has already been dereferenced,
6714 it cannot be null.
6716 Note however that in some environments this assumption is not true.
6717 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6718 for programs that depend on that behavior.
6720 Some targets, especially embedded ones, disable this option at all levels.
6721 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6722 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6723 are enabled independently at different optimization levels.
6725 @item -fdevirtualize
6726 @opindex fdevirtualize
6727 Attempt to convert calls to virtual functions to direct calls.  This
6728 is done both within a procedure and interprocedurally as part of
6729 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
6730 propagation (@option{-fipa-cp}).
6731 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6733 @item -fexpensive-optimizations
6734 @opindex fexpensive-optimizations
6735 Perform a number of minor optimizations that are relatively expensive.
6737 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6739 @item -free
6740 @opindex free
6741 Attempt to remove redundant extension instructions.  This is especially
6742 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
6743 registers after writing to their lower 32-bit half.
6745 Enabled for x86 at levels @option{-O2}, @option{-O3}.
6747 @item -foptimize-register-move
6748 @itemx -fregmove
6749 @opindex foptimize-register-move
6750 @opindex fregmove
6751 Attempt to reassign register numbers in move instructions and as
6752 operands of other simple instructions in order to maximize the amount of
6753 register tying.  This is especially helpful on machines with two-operand
6754 instructions.
6756 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6757 optimization.
6759 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6761 @item -fira-algorithm=@var{algorithm}
6762 Use the specified coloring algorithm for the integrated register
6763 allocator.  The @var{algorithm} argument can be @samp{priority}, which
6764 specifies Chow's priority coloring, or @samp{CB}, which specifies
6765 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
6766 for all architectures, but for those targets that do support it, it is
6767 the default because it generates better code.
6769 @item -fira-region=@var{region}
6770 Use specified regions for the integrated register allocator.  The
6771 @var{region} argument should be one of the following:
6773 @table @samp
6775 @item all
6776 Use all loops as register allocation regions.
6777 This can give the best results for machines with a small and/or
6778 irregular register set.
6780 @item mixed
6781 Use all loops except for loops with small register pressure 
6782 as the regions.  This value usually gives
6783 the best results in most cases and for most architectures,
6784 and is enabled by default when compiling with optimization for speed
6785 (@option{-O}, @option{-O2}, @dots{}).
6787 @item one
6788 Use all functions as a single region.  
6789 This typically results in the smallest code size, and is enabled by default for
6790 @option{-Os} or @option{-O0}.
6792 @end table
6794 @item -fira-loop-pressure
6795 @opindex fira-loop-pressure
6796 Use IRA to evaluate register pressure in loops for decisions to move
6797 loop invariants.  This option usually results in generation
6798 of faster and smaller code on machines with large register files (>= 32
6799 registers), but it can slow the compiler down.
6801 This option is enabled at level @option{-O3} for some targets.
6803 @item -fno-ira-share-save-slots
6804 @opindex fno-ira-share-save-slots
6805 Disable sharing of stack slots used for saving call-used hard
6806 registers living through a call.  Each hard register gets a
6807 separate stack slot, and as a result function stack frames are
6808 larger.
6810 @item -fno-ira-share-spill-slots
6811 @opindex fno-ira-share-spill-slots
6812 Disable sharing of stack slots allocated for pseudo-registers.  Each
6813 pseudo-register that does not get a hard register gets a separate
6814 stack slot, and as a result function stack frames are larger.
6816 @item -fira-verbose=@var{n}
6817 @opindex fira-verbose
6818 Control the verbosity of the dump file for the integrated register allocator.
6819 The default value is 5.  If the value @var{n} is greater or equal to 10,
6820 the dump output is sent to stderr using the same format as @var{n} minus 10.
6822 @item -fdelayed-branch
6823 @opindex fdelayed-branch
6824 If supported for the target machine, attempt to reorder instructions
6825 to exploit instruction slots available after delayed branch
6826 instructions.
6828 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6830 @item -fschedule-insns
6831 @opindex fschedule-insns
6832 If supported for the target machine, attempt to reorder instructions to
6833 eliminate execution stalls due to required data being unavailable.  This
6834 helps machines that have slow floating point or memory load instructions
6835 by allowing other instructions to be issued until the result of the load
6836 or floating-point instruction is required.
6838 Enabled at levels @option{-O2}, @option{-O3}.
6840 @item -fschedule-insns2
6841 @opindex fschedule-insns2
6842 Similar to @option{-fschedule-insns}, but requests an additional pass of
6843 instruction scheduling after register allocation has been done.  This is
6844 especially useful on machines with a relatively small number of
6845 registers and where memory load instructions take more than one cycle.
6847 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6849 @item -fno-sched-interblock
6850 @opindex fno-sched-interblock
6851 Don't schedule instructions across basic blocks.  This is normally
6852 enabled by default when scheduling before register allocation, i.e.@:
6853 with @option{-fschedule-insns} or at @option{-O2} or higher.
6855 @item -fno-sched-spec
6856 @opindex fno-sched-spec
6857 Don't allow speculative motion of non-load instructions.  This is normally
6858 enabled by default when scheduling before register allocation, i.e.@:
6859 with @option{-fschedule-insns} or at @option{-O2} or higher.
6861 @item -fsched-pressure
6862 @opindex fsched-pressure
6863 Enable register pressure sensitive insn scheduling before the register
6864 allocation.  This only makes sense when scheduling before register
6865 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6866 @option{-O2} or higher.  Usage of this option can improve the
6867 generated code and decrease its size by preventing register pressure
6868 increase above the number of available hard registers and as a
6869 consequence register spills in the register allocation.
6871 @item -fsched-spec-load
6872 @opindex fsched-spec-load
6873 Allow speculative motion of some load instructions.  This only makes
6874 sense when scheduling before register allocation, i.e.@: with
6875 @option{-fschedule-insns} or at @option{-O2} or higher.
6877 @item -fsched-spec-load-dangerous
6878 @opindex fsched-spec-load-dangerous
6879 Allow speculative motion of more load instructions.  This only makes
6880 sense when scheduling before register allocation, i.e.@: with
6881 @option{-fschedule-insns} or at @option{-O2} or higher.
6883 @item -fsched-stalled-insns
6884 @itemx -fsched-stalled-insns=@var{n}
6885 @opindex fsched-stalled-insns
6886 Define how many insns (if any) can be moved prematurely from the queue
6887 of stalled insns into the ready list, during the second scheduling pass.
6888 @option{-fno-sched-stalled-insns} means that no insns will be moved
6889 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6890 on how many queued insns can be moved prematurely.
6891 @option{-fsched-stalled-insns} without a value is equivalent to
6892 @option{-fsched-stalled-insns=1}.
6894 @item -fsched-stalled-insns-dep
6895 @itemx -fsched-stalled-insns-dep=@var{n}
6896 @opindex fsched-stalled-insns-dep
6897 Define how many insn groups (cycles) will be examined for a dependency
6898 on a stalled insn that is candidate for premature removal from the queue
6899 of stalled insns.  This has an effect only during the second scheduling pass,
6900 and only if @option{-fsched-stalled-insns} is used.
6901 @option{-fno-sched-stalled-insns-dep} is equivalent to
6902 @option{-fsched-stalled-insns-dep=0}.
6903 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6904 @option{-fsched-stalled-insns-dep=1}.
6906 @item -fsched2-use-superblocks
6907 @opindex fsched2-use-superblocks
6908 When scheduling after register allocation, do use superblock scheduling
6909 algorithm.  Superblock scheduling allows motion across basic block boundaries
6910 resulting on faster schedules.  This option is experimental, as not all machine
6911 descriptions used by GCC model the CPU closely enough to avoid unreliable
6912 results from the algorithm.
6914 This only makes sense when scheduling after register allocation, i.e.@: with
6915 @option{-fschedule-insns2} or at @option{-O2} or higher.
6917 @item -fsched-group-heuristic
6918 @opindex fsched-group-heuristic
6919 Enable the group heuristic in the scheduler.  This heuristic favors
6920 the instruction that belongs to a schedule group.  This is enabled
6921 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
6922 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6924 @item -fsched-critical-path-heuristic
6925 @opindex fsched-critical-path-heuristic
6926 Enable the critical-path heuristic in the scheduler.  This heuristic favors
6927 instructions on the critical path.  This is enabled by default when
6928 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
6929 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6931 @item -fsched-spec-insn-heuristic
6932 @opindex fsched-spec-insn-heuristic
6933 Enable the speculative instruction heuristic in the scheduler.  This
6934 heuristic favors speculative instructions with greater dependency weakness.
6935 This is enabled by default when scheduling is enabled, i.e.@:
6936 with @option{-fschedule-insns} or @option{-fschedule-insns2}
6937 or at @option{-O2} or higher.
6939 @item -fsched-rank-heuristic
6940 @opindex fsched-rank-heuristic
6941 Enable the rank heuristic in the scheduler.  This heuristic favors
6942 the instruction belonging to a basic block with greater size or frequency.
6943 This is enabled by default when scheduling is enabled, i.e.@:
6944 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6945 at @option{-O2} or higher.
6947 @item -fsched-last-insn-heuristic
6948 @opindex fsched-last-insn-heuristic
6949 Enable the last-instruction heuristic in the scheduler.  This heuristic
6950 favors the instruction that is less dependent on the last instruction
6951 scheduled.  This is enabled by default when scheduling is enabled,
6952 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6953 at @option{-O2} or higher.
6955 @item -fsched-dep-count-heuristic
6956 @opindex fsched-dep-count-heuristic
6957 Enable the dependent-count heuristic in the scheduler.  This heuristic
6958 favors the instruction that has more instructions depending on it.
6959 This is enabled by default when scheduling is enabled, i.e.@:
6960 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
6961 at @option{-O2} or higher.
6963 @item -freschedule-modulo-scheduled-loops
6964 @opindex freschedule-modulo-scheduled-loops
6965 The modulo scheduling comes before the traditional scheduling, if a loop
6966 was modulo scheduled we may want to prevent the later scheduling passes
6967 from changing its schedule, we use this option to control that.
6969 @item -fselective-scheduling
6970 @opindex fselective-scheduling
6971 Schedule instructions using selective scheduling algorithm.  Selective
6972 scheduling runs instead of the first scheduler pass.
6974 @item -fselective-scheduling2
6975 @opindex fselective-scheduling2
6976 Schedule instructions using selective scheduling algorithm.  Selective
6977 scheduling runs instead of the second scheduler pass.
6979 @item -fsel-sched-pipelining
6980 @opindex fsel-sched-pipelining
6981 Enable software pipelining of innermost loops during selective scheduling.
6982 This option has no effect until one of @option{-fselective-scheduling} or
6983 @option{-fselective-scheduling2} is turned on.
6985 @item -fsel-sched-pipelining-outer-loops
6986 @opindex fsel-sched-pipelining-outer-loops
6987 When pipelining loops during selective scheduling, also pipeline outer loops.
6988 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6990 @item -fshrink-wrap
6991 @opindex fshrink-wrap
6992 Emit function prologues only before parts of the function that need it,
6993 rather than at the top of the function.  This flag is enabled by default at
6994 @option{-O} and higher.
6996 @item -fcaller-saves
6997 @opindex fcaller-saves
6998 Enable values to be allocated in registers that will be clobbered by
6999 function calls, by emitting extra instructions to save and restore the
7000 registers around such calls.  Such allocation is done only when it
7001 seems to result in better code than would otherwise be produced.
7003 This option is always enabled by default on certain machines, usually
7004 those which have no call-preserved registers to use instead.
7006 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7008 @item -fcombine-stack-adjustments
7009 @opindex fcombine-stack-adjustments
7010 Tracks stack adjustments (pushes and pops) and stack memory references
7011 and then tries to find ways to combine them.
7013 Enabled by default at @option{-O1} and higher.
7015 @item -fconserve-stack
7016 @opindex fconserve-stack
7017 Attempt to minimize stack usage.  The compiler will attempt to use less
7018 stack space, even if that makes the program slower.  This option
7019 implies setting the @option{large-stack-frame} parameter to 100
7020 and the @option{large-stack-frame-growth} parameter to 400.
7022 @item -ftree-reassoc
7023 @opindex ftree-reassoc
7024 Perform reassociation on trees.  This flag is enabled by default
7025 at @option{-O} and higher.
7027 @item -ftree-pre
7028 @opindex ftree-pre
7029 Perform partial redundancy elimination (PRE) on trees.  This flag is
7030 enabled by default at @option{-O2} and @option{-O3}.
7032 @item -ftree-forwprop
7033 @opindex ftree-forwprop
7034 Perform forward propagation on trees.  This flag is enabled by default
7035 at @option{-O} and higher.
7037 @item -ftree-fre
7038 @opindex ftree-fre
7039 Perform full redundancy elimination (FRE) on trees.  The difference
7040 between FRE and PRE is that FRE only considers expressions
7041 that are computed on all paths leading to the redundant computation.
7042 This analysis is faster than PRE, though it exposes fewer redundancies.
7043 This flag is enabled by default at @option{-O} and higher.
7045 @item -ftree-phiprop
7046 @opindex ftree-phiprop
7047 Perform hoisting of loads from conditional pointers on trees.  This
7048 pass is enabled by default at @option{-O} and higher.
7050 @item -ftree-copy-prop
7051 @opindex ftree-copy-prop
7052 Perform copy propagation on trees.  This pass eliminates unnecessary
7053 copy operations.  This flag is enabled by default at @option{-O} and
7054 higher.
7056 @item -fipa-pure-const
7057 @opindex fipa-pure-const
7058 Discover which functions are pure or constant.
7059 Enabled by default at @option{-O} and higher.
7061 @item -fipa-reference
7062 @opindex fipa-reference
7063 Discover which static variables do not escape cannot escape the
7064 compilation unit.
7065 Enabled by default at @option{-O} and higher.
7067 @item -fipa-pta
7068 @opindex fipa-pta
7069 Perform interprocedural pointer analysis and interprocedural modification
7070 and reference analysis.  This option can cause excessive memory and
7071 compile-time usage on large compilation units.  It is not enabled by
7072 default at any optimization level.
7074 @item -fipa-profile
7075 @opindex fipa-profile
7076 Perform interprocedural profile propagation.  The functions called only from
7077 cold functions are marked as cold. Also functions executed once (such as
7078 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7079 functions and loop less parts of functions executed once are then optimized for
7080 size.
7081 Enabled by default at @option{-O} and higher.
7083 @item -fipa-cp
7084 @opindex fipa-cp
7085 Perform interprocedural constant propagation.
7086 This optimization analyzes the program to determine when values passed
7087 to functions are constants and then optimizes accordingly.
7088 This optimization can substantially increase performance
7089 if the application has constants passed to functions.
7090 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7092 @item -fipa-cp-clone
7093 @opindex fipa-cp-clone
7094 Perform function cloning to make interprocedural constant propagation stronger.
7095 When enabled, interprocedural constant propagation will perform function cloning
7096 when externally visible function can be called with constant arguments.
7097 Because this optimization can create multiple copies of functions,
7098 it may significantly increase code size
7099 (see @option{--param ipcp-unit-growth=@var{value}}).
7100 This flag is enabled by default at @option{-O3}.
7102 @item -fipa-matrix-reorg
7103 @opindex fipa-matrix-reorg
7104 Perform matrix flattening and transposing.
7105 Matrix flattening tries to replace an @math{m}-dimensional matrix
7106 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
7107 This reduces the level of indirection needed for accessing the elements
7108 of the matrix. The second optimization is matrix transposing, which
7109 attempts to change the order of the matrix's dimensions in order to
7110 improve cache locality.
7111 Both optimizations need the @option{-fwhole-program} flag.
7112 Transposing is enabled only if profiling information is available.
7114 @item -ftree-sink
7115 @opindex ftree-sink
7116 Perform forward store motion  on trees.  This flag is
7117 enabled by default at @option{-O} and higher.
7119 @item -ftree-bit-ccp
7120 @opindex ftree-bit-ccp
7121 Perform sparse conditional bit constant propagation on trees and propagate
7122 pointer alignment information.
7123 This pass only operates on local scalar variables and is enabled by default
7124 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7126 @item -ftree-ccp
7127 @opindex ftree-ccp
7128 Perform sparse conditional constant propagation (CCP) on trees.  This
7129 pass only operates on local scalar variables and is enabled by default
7130 at @option{-O} and higher.
7132 @item -ftree-switch-conversion
7133 Perform conversion of simple initializations in a switch to
7134 initializations from a scalar array.  This flag is enabled by default
7135 at @option{-O2} and higher.
7137 @item -ftree-tail-merge
7138 Look for identical code sequences.  When found, replace one with a jump to the
7139 other.  This optimization is known as tail merging or cross jumping.  This flag
7140 is enabled by default at @option{-O2} and higher.  The compilation time
7141 in this pass can
7142 be limited using @option{max-tail-merge-comparisons} parameter and
7143 @option{max-tail-merge-iterations} parameter.
7145 @item -ftree-dce
7146 @opindex ftree-dce
7147 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7148 default at @option{-O} and higher.
7150 @item -ftree-builtin-call-dce
7151 @opindex ftree-builtin-call-dce
7152 Perform conditional dead code elimination (DCE) for calls to builtin functions
7153 that may set @code{errno} but are otherwise side-effect free.  This flag is
7154 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7155 specified.
7157 @item -ftree-dominator-opts
7158 @opindex ftree-dominator-opts
7159 Perform a variety of simple scalar cleanups (constant/copy
7160 propagation, redundancy elimination, range propagation and expression
7161 simplification) based on a dominator tree traversal.  This also
7162 performs jump threading (to reduce jumps to jumps). This flag is
7163 enabled by default at @option{-O} and higher.
7165 @item -ftree-dse
7166 @opindex ftree-dse
7167 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7168 a memory location that is later overwritten by another store without
7169 any intervening loads.  In this case the earlier store can be deleted.  This
7170 flag is enabled by default at @option{-O} and higher.
7172 @item -ftree-ch
7173 @opindex ftree-ch
7174 Perform loop header copying on trees.  This is beneficial since it increases
7175 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7176 is enabled by default at @option{-O} and higher.  It is not enabled
7177 for @option{-Os}, since it usually increases code size.
7179 @item -ftree-loop-optimize
7180 @opindex ftree-loop-optimize
7181 Perform loop optimizations on trees.  This flag is enabled by default
7182 at @option{-O} and higher.
7184 @item -ftree-loop-linear
7185 @opindex ftree-loop-linear
7186 Perform loop interchange transformations on tree.  Same as
7187 @option{-floop-interchange}.  To use this code transformation, GCC has
7188 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7189 enable the Graphite loop transformation infrastructure.
7191 @item -floop-interchange
7192 @opindex floop-interchange
7193 Perform loop interchange transformations on loops.  Interchanging two
7194 nested loops switches the inner and outer loops.  For example, given a
7195 loop like:
7196 @smallexample
7197 DO J = 1, M
7198   DO I = 1, N
7199     A(J, I) = A(J, I) * C
7200   ENDDO
7201 ENDDO
7202 @end smallexample
7203 loop interchange will transform the loop as if the user had written:
7204 @smallexample
7205 DO I = 1, N
7206   DO J = 1, M
7207     A(J, I) = A(J, I) * C
7208   ENDDO
7209 ENDDO
7210 @end smallexample
7211 which can be beneficial when @code{N} is larger than the caches,
7212 because in Fortran, the elements of an array are stored in memory
7213 contiguously by column, and the original loop iterates over rows,
7214 potentially creating at each access a cache miss.  This optimization
7215 applies to all the languages supported by GCC and is not limited to
7216 Fortran.  To use this code transformation, GCC has to be configured
7217 with @option{--with-ppl} and @option{--with-cloog} to enable the
7218 Graphite loop transformation infrastructure.
7220 @item -floop-strip-mine
7221 @opindex floop-strip-mine
7222 Perform loop strip mining transformations on loops.  Strip mining
7223 splits a loop into two nested loops.  The outer loop has strides
7224 equal to the strip size and the inner loop has strides of the
7225 original loop within a strip.  The strip length can be changed
7226 using the @option{loop-block-tile-size} parameter.  For example,
7227 given a loop like:
7228 @smallexample
7229 DO I = 1, N
7230   A(I) = A(I) + C
7231 ENDDO
7232 @end smallexample
7233 loop strip mining will transform the loop as if the user had written:
7234 @smallexample
7235 DO II = 1, N, 51
7236   DO I = II, min (II + 50, N)
7237     A(I) = A(I) + C
7238   ENDDO
7239 ENDDO
7240 @end smallexample
7241 This optimization applies to all the languages supported by GCC and is
7242 not limited to Fortran.  To use this code transformation, GCC has to
7243 be configured with @option{--with-ppl} and @option{--with-cloog} to
7244 enable the Graphite loop transformation infrastructure.
7246 @item -floop-block
7247 @opindex floop-block
7248 Perform loop blocking transformations on loops.  Blocking strip mines
7249 each loop in the loop nest such that the memory accesses of the
7250 element loops fit inside caches.  The strip length can be changed
7251 using the @option{loop-block-tile-size} parameter.  For example, given
7252 a loop like:
7253 @smallexample
7254 DO I = 1, N
7255   DO J = 1, M
7256     A(J, I) = B(I) + C(J)
7257   ENDDO
7258 ENDDO
7259 @end smallexample
7260 loop blocking will transform the loop as if the user had written:
7261 @smallexample
7262 DO II = 1, N, 51
7263   DO JJ = 1, M, 51
7264     DO I = II, min (II + 50, N)
7265       DO J = JJ, min (JJ + 50, M)
7266         A(J, I) = B(I) + C(J)
7267       ENDDO
7268     ENDDO
7269   ENDDO
7270 ENDDO
7271 @end smallexample
7272 which can be beneficial when @code{M} is larger than the caches,
7273 because the innermost loop will iterate over a smaller amount of data
7274 which can be kept in the caches.  This optimization applies to all the
7275 languages supported by GCC and is not limited to Fortran.  To use this
7276 code transformation, GCC has to be configured with @option{--with-ppl}
7277 and @option{--with-cloog} to enable the Graphite loop transformation
7278 infrastructure.
7280 @item -fgraphite-identity
7281 @opindex fgraphite-identity
7282 Enable the identity transformation for graphite.  For every SCoP we generate
7283 the polyhedral representation and transform it back to gimple.  Using
7284 @option{-fgraphite-identity} we can check the costs or benefits of the
7285 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7286 are also performed by the code generator CLooG, like index splitting and
7287 dead code elimination in loops.
7289 @item -floop-parallelize-all
7290 @opindex floop-parallelize-all
7291 Use the Graphite data dependence analysis to identify loops that can
7292 be parallelized.  Parallelize all the loops that can be analyzed to
7293 not contain loop carried dependences without checking that it is
7294 profitable to parallelize the loops.
7296 @item -fcheck-data-deps
7297 @opindex fcheck-data-deps
7298 Compare the results of several data dependence analyzers.  This option
7299 is used for debugging the data dependence analyzers.
7301 @item -ftree-loop-if-convert
7302 Attempt to transform conditional jumps in the innermost loops to
7303 branch-less equivalents.  The intent is to remove control-flow from
7304 the innermost loops in order to improve the ability of the
7305 vectorization pass to handle these loops.  This is enabled by default
7306 if vectorization is enabled.
7308 @item -ftree-loop-if-convert-stores
7309 Attempt to also if-convert conditional jumps containing memory writes.
7310 This transformation can be unsafe for multi-threaded programs as it
7311 transforms conditional memory writes into unconditional memory writes.
7312 For example,
7313 @smallexample
7314 for (i = 0; i < N; i++)
7315   if (cond)
7316     A[i] = expr;
7317 @end smallexample
7318 would be transformed to
7319 @smallexample
7320 for (i = 0; i < N; i++)
7321   A[i] = cond ? expr : A[i];
7322 @end smallexample
7323 potentially producing data races.
7325 @item -ftree-loop-distribution
7326 Perform loop distribution.  This flag can improve cache performance on
7327 big loop bodies and allow further loop optimizations, like
7328 parallelization or vectorization, to take place.  For example, the loop
7329 @smallexample
7330 DO I = 1, N
7331   A(I) = B(I) + C
7332   D(I) = E(I) * F
7333 ENDDO
7334 @end smallexample
7335 is transformed to
7336 @smallexample
7337 DO I = 1, N
7338    A(I) = B(I) + C
7339 ENDDO
7340 DO I = 1, N
7341    D(I) = E(I) * F
7342 ENDDO
7343 @end smallexample
7345 @item -ftree-loop-distribute-patterns
7346 Perform loop distribution of patterns that can be code generated with
7347 calls to a library.  This flag is enabled by default at @option{-O3}.
7349 This pass distributes the initialization loops and generates a call to
7350 memset zero.  For example, the loop
7351 @smallexample
7352 DO I = 1, N
7353   A(I) = 0
7354   B(I) = A(I) + I
7355 ENDDO
7356 @end smallexample
7357 is transformed to
7358 @smallexample
7359 DO I = 1, N
7360    A(I) = 0
7361 ENDDO
7362 DO I = 1, N
7363    B(I) = A(I) + I
7364 ENDDO
7365 @end smallexample
7366 and the initialization loop is transformed into a call to memset zero.
7368 @item -ftree-loop-im
7369 @opindex ftree-loop-im
7370 Perform loop invariant motion on trees.  This pass moves only invariants that
7371 would be hard to handle at RTL level (function calls, operations that expand to
7372 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7373 operands of conditions that are invariant out of the loop, so that we can use
7374 just trivial invariantness analysis in loop unswitching.  The pass also includes
7375 store motion.
7377 @item -ftree-loop-ivcanon
7378 @opindex ftree-loop-ivcanon
7379 Create a canonical counter for number of iterations in loops for which
7380 determining number of iterations requires complicated analysis.  Later
7381 optimizations then may determine the number easily.  Useful especially
7382 in connection with unrolling.
7384 @item -fivopts
7385 @opindex fivopts
7386 Perform induction variable optimizations (strength reduction, induction
7387 variable merging and induction variable elimination) on trees.
7389 @item -ftree-parallelize-loops=n
7390 @opindex ftree-parallelize-loops
7391 Parallelize loops, i.e., split their iteration space to run in n threads.
7392 This is only possible for loops whose iterations are independent
7393 and can be arbitrarily reordered.  The optimization is only
7394 profitable on multiprocessor machines, for loops that are CPU-intensive,
7395 rather than constrained e.g.@: by memory bandwidth.  This option
7396 implies @option{-pthread}, and thus is only supported on targets
7397 that have support for @option{-pthread}.
7399 @item -ftree-pta
7400 @opindex ftree-pta
7401 Perform function-local points-to analysis on trees.  This flag is
7402 enabled by default at @option{-O} and higher.
7404 @item -ftree-sra
7405 @opindex ftree-sra
7406 Perform scalar replacement of aggregates.  This pass replaces structure
7407 references with scalars to prevent committing structures to memory too
7408 early.  This flag is enabled by default at @option{-O} and higher.
7410 @item -ftree-copyrename
7411 @opindex ftree-copyrename
7412 Perform copy renaming on trees.  This pass attempts to rename compiler
7413 temporaries to other variables at copy locations, usually resulting in
7414 variable names which more closely resemble the original variables.  This flag
7415 is enabled by default at @option{-O} and higher.
7417 @item -ftree-ter
7418 @opindex ftree-ter
7419 Perform temporary expression replacement during the SSA->normal phase.  Single
7420 use/single def temporaries are replaced at their use location with their
7421 defining expression.  This results in non-GIMPLE code, but gives the expanders
7422 much more complex trees to work on resulting in better RTL generation.  This is
7423 enabled by default at @option{-O} and higher.
7425 @item -ftree-vectorize
7426 @opindex ftree-vectorize
7427 Perform loop vectorization on trees. This flag is enabled by default at
7428 @option{-O3}.
7430 @item -ftree-slp-vectorize
7431 @opindex ftree-slp-vectorize
7432 Perform basic block vectorization on trees. This flag is enabled by default at
7433 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7435 @item -ftree-vect-loop-version
7436 @opindex ftree-vect-loop-version
7437 Perform loop versioning when doing loop vectorization on trees.  When a loop
7438 appears to be vectorizable except that data alignment or data dependence cannot
7439 be determined at compile time, then vectorized and non-vectorized versions of
7440 the loop are generated along with run-time checks for alignment or dependence
7441 to control which version is executed.  This option is enabled by default
7442 except at level @option{-Os} where it is disabled.
7444 @item -fvect-cost-model
7445 @opindex fvect-cost-model
7446 Enable cost model for vectorization.
7448 @item -ftree-vrp
7449 @opindex ftree-vrp
7450 Perform Value Range Propagation on trees.  This is similar to the
7451 constant propagation pass, but instead of values, ranges of values are
7452 propagated.  This allows the optimizers to remove unnecessary range
7453 checks like array bound checks and null pointer checks.  This is
7454 enabled by default at @option{-O2} and higher.  Null pointer check
7455 elimination is only done if @option{-fdelete-null-pointer-checks} is
7456 enabled.
7458 @item -ftracer
7459 @opindex ftracer
7460 Perform tail duplication to enlarge superblock size.  This transformation
7461 simplifies the control flow of the function allowing other optimizations to do
7462 better job.
7464 @item -funroll-loops
7465 @opindex funroll-loops
7466 Unroll loops whose number of iterations can be determined at compile
7467 time or upon entry to the loop.  @option{-funroll-loops} implies
7468 @option{-frerun-cse-after-loop}.  This option makes code larger,
7469 and may or may not make it run faster.
7471 @item -funroll-all-loops
7472 @opindex funroll-all-loops
7473 Unroll all loops, even if their number of iterations is uncertain when
7474 the loop is entered.  This usually makes programs run more slowly.
7475 @option{-funroll-all-loops} implies the same options as
7476 @option{-funroll-loops},
7478 @item -fsplit-ivs-in-unroller
7479 @opindex fsplit-ivs-in-unroller
7480 Enables expressing of values of induction variables in later iterations
7481 of the unrolled loop using the value in the first iteration.  This breaks
7482 long dependency chains, thus improving efficiency of the scheduling passes.
7484 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7485 same effect.  However in cases the loop body is more complicated than
7486 a single basic block, this is not reliable.  It also does not work at all
7487 on some of the architectures due to restrictions in the CSE pass.
7489 This optimization is enabled by default.
7491 @item -fvariable-expansion-in-unroller
7492 @opindex fvariable-expansion-in-unroller
7493 With this option, the compiler will create multiple copies of some
7494 local variables when unrolling a loop which can result in superior code.
7496 @item -fpartial-inlining
7497 @opindex fpartial-inlining
7498 Inline parts of functions.  This option has any effect only
7499 when inlining itself is turned on by the @option{-finline-functions}
7500 or @option{-finline-small-functions} options.
7502 Enabled at level @option{-O2}.
7504 @item -fpredictive-commoning
7505 @opindex fpredictive-commoning
7506 Perform predictive commoning optimization, i.e., reusing computations
7507 (especially memory loads and stores) performed in previous
7508 iterations of loops.
7510 This option is enabled at level @option{-O3}.
7512 @item -fprefetch-loop-arrays
7513 @opindex fprefetch-loop-arrays
7514 If supported by the target machine, generate instructions to prefetch
7515 memory to improve the performance of loops that access large arrays.
7517 This option may generate better or worse code; results are highly
7518 dependent on the structure of loops within the source code.
7520 Disabled at level @option{-Os}.
7522 @item -fno-peephole
7523 @itemx -fno-peephole2
7524 @opindex fno-peephole
7525 @opindex fno-peephole2
7526 Disable any machine-specific peephole optimizations.  The difference
7527 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7528 are implemented in the compiler; some targets use one, some use the
7529 other, a few use both.
7531 @option{-fpeephole} is enabled by default.
7532 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7534 @item -fno-guess-branch-probability
7535 @opindex fno-guess-branch-probability
7536 Do not guess branch probabilities using heuristics.
7538 GCC will use heuristics to guess branch probabilities if they are
7539 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7540 heuristics are based on the control flow graph.  If some branch probabilities
7541 are specified by @samp{__builtin_expect}, then the heuristics will be
7542 used to guess branch probabilities for the rest of the control flow graph,
7543 taking the @samp{__builtin_expect} info into account.  The interactions
7544 between the heuristics and @samp{__builtin_expect} can be complex, and in
7545 some cases, it may be useful to disable the heuristics so that the effects
7546 of @samp{__builtin_expect} are easier to understand.
7548 The default is @option{-fguess-branch-probability} at levels
7549 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7551 @item -freorder-blocks
7552 @opindex freorder-blocks
7553 Reorder basic blocks in the compiled function in order to reduce number of
7554 taken branches and improve code locality.
7556 Enabled at levels @option{-O2}, @option{-O3}.
7558 @item -freorder-blocks-and-partition
7559 @opindex freorder-blocks-and-partition
7560 In addition to reordering basic blocks in the compiled function, in order
7561 to reduce number of taken branches, partitions hot and cold basic blocks
7562 into separate sections of the assembly and .o files, to improve
7563 paging and cache locality performance.
7565 This optimization is automatically turned off in the presence of
7566 exception handling, for linkonce sections, for functions with a user-defined
7567 section attribute and on any architecture that does not support named
7568 sections.
7570 @item -freorder-functions
7571 @opindex freorder-functions
7572 Reorder functions in the object file in order to
7573 improve code locality.  This is implemented by using special
7574 subsections @code{.text.hot} for most frequently executed functions and
7575 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7576 the linker so object file format must support named sections and linker must
7577 place them in a reasonable way.
7579 Also profile feedback must be available in to make this option effective.  See
7580 @option{-fprofile-arcs} for details.
7582 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7584 @item -fstrict-aliasing
7585 @opindex fstrict-aliasing
7586 Allow the compiler to assume the strictest aliasing rules applicable to
7587 the language being compiled.  For C (and C++), this activates
7588 optimizations based on the type of expressions.  In particular, an
7589 object of one type is assumed never to reside at the same address as an
7590 object of a different type, unless the types are almost the same.  For
7591 example, an @code{unsigned int} can alias an @code{int}, but not a
7592 @code{void*} or a @code{double}.  A character type may alias any other
7593 type.
7595 @anchor{Type-punning}Pay special attention to code like this:
7596 @smallexample
7597 union a_union @{
7598   int i;
7599   double d;
7602 int f() @{
7603   union a_union t;
7604   t.d = 3.0;
7605   return t.i;
7607 @end smallexample
7608 The practice of reading from a different union member than the one most
7609 recently written to (called ``type-punning'') is common.  Even with
7610 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7611 is accessed through the union type.  So, the code above will work as
7612 expected.  @xref{Structures unions enumerations and bit-fields
7613 implementation}.  However, this code might not:
7614 @smallexample
7615 int f() @{
7616   union a_union t;
7617   int* ip;
7618   t.d = 3.0;
7619   ip = &t.i;
7620   return *ip;
7622 @end smallexample
7624 Similarly, access by taking the address, casting the resulting pointer
7625 and dereferencing the result has undefined behavior, even if the cast
7626 uses a union type, e.g.:
7627 @smallexample
7628 int f() @{
7629   double d = 3.0;
7630   return ((union a_union *) &d)->i;
7632 @end smallexample
7634 The @option{-fstrict-aliasing} option is enabled at levels
7635 @option{-O2}, @option{-O3}, @option{-Os}.
7637 @item -fstrict-overflow
7638 @opindex fstrict-overflow
7639 Allow the compiler to assume strict signed overflow rules, depending
7640 on the language being compiled.  For C (and C++) this means that
7641 overflow when doing arithmetic with signed numbers is undefined, which
7642 means that the compiler may assume that it will not happen.  This
7643 permits various optimizations.  For example, the compiler will assume
7644 that an expression like @code{i + 10 > i} will always be true for
7645 signed @code{i}.  This assumption is only valid if signed overflow is
7646 undefined, as the expression is false if @code{i + 10} overflows when
7647 using twos complement arithmetic.  When this option is in effect any
7648 attempt to determine whether an operation on signed numbers will
7649 overflow must be written carefully to not actually involve overflow.
7651 This option also allows the compiler to assume strict pointer
7652 semantics: given a pointer to an object, if adding an offset to that
7653 pointer does not produce a pointer to the same object, the addition is
7654 undefined.  This permits the compiler to conclude that @code{p + u >
7655 p} is always true for a pointer @code{p} and unsigned integer
7656 @code{u}.  This assumption is only valid because pointer wraparound is
7657 undefined, as the expression is false if @code{p + u} overflows using
7658 twos complement arithmetic.
7660 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7661 that integer signed overflow is fully defined: it wraps.  When
7662 @option{-fwrapv} is used, there is no difference between
7663 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7664 integers.  With @option{-fwrapv} certain types of overflow are
7665 permitted.  For example, if the compiler gets an overflow when doing
7666 arithmetic on constants, the overflowed value can still be used with
7667 @option{-fwrapv}, but not otherwise.
7669 The @option{-fstrict-overflow} option is enabled at levels
7670 @option{-O2}, @option{-O3}, @option{-Os}.
7672 @item -falign-functions
7673 @itemx -falign-functions=@var{n}
7674 @opindex falign-functions
7675 Align the start of functions to the next power-of-two greater than
7676 @var{n}, skipping up to @var{n} bytes.  For instance,
7677 @option{-falign-functions=32} aligns functions to the next 32-byte
7678 boundary, but @option{-falign-functions=24} would align to the next
7679 32-byte boundary only if this can be done by skipping 23 bytes or less.
7681 @option{-fno-align-functions} and @option{-falign-functions=1} are
7682 equivalent and mean that functions will not be aligned.
7684 Some assemblers only support this flag when @var{n} is a power of two;
7685 in that case, it is rounded up.
7687 If @var{n} is not specified or is zero, use a machine-dependent default.
7689 Enabled at levels @option{-O2}, @option{-O3}.
7691 @item -falign-labels
7692 @itemx -falign-labels=@var{n}
7693 @opindex falign-labels
7694 Align all branch targets to a power-of-two boundary, skipping up to
7695 @var{n} bytes like @option{-falign-functions}.  This option can easily
7696 make code slower, because it must insert dummy operations for when the
7697 branch target is reached in the usual flow of the code.
7699 @option{-fno-align-labels} and @option{-falign-labels=1} are
7700 equivalent and mean that labels will not be aligned.
7702 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7703 are greater than this value, then their values are used instead.
7705 If @var{n} is not specified or is zero, use a machine-dependent default
7706 which is very likely to be @samp{1}, meaning no alignment.
7708 Enabled at levels @option{-O2}, @option{-O3}.
7710 @item -falign-loops
7711 @itemx -falign-loops=@var{n}
7712 @opindex falign-loops
7713 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7714 like @option{-falign-functions}.  The hope is that the loop will be
7715 executed many times, which will make up for any execution of the dummy
7716 operations.
7718 @option{-fno-align-loops} and @option{-falign-loops=1} are
7719 equivalent and mean that loops will not be aligned.
7721 If @var{n} is not specified or is zero, use a machine-dependent default.
7723 Enabled at levels @option{-O2}, @option{-O3}.
7725 @item -falign-jumps
7726 @itemx -falign-jumps=@var{n}
7727 @opindex falign-jumps
7728 Align branch targets to a power-of-two boundary, for branch targets
7729 where the targets can only be reached by jumping, skipping up to @var{n}
7730 bytes like @option{-falign-functions}.  In this case, no dummy operations
7731 need be executed.
7733 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7734 equivalent and mean that loops will not be aligned.
7736 If @var{n} is not specified or is zero, use a machine-dependent default.
7738 Enabled at levels @option{-O2}, @option{-O3}.
7740 @item -funit-at-a-time
7741 @opindex funit-at-a-time
7742 This option is left for compatibility reasons. @option{-funit-at-a-time}
7743 has no effect, while @option{-fno-unit-at-a-time} implies
7744 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7746 Enabled by default.
7748 @item -fno-toplevel-reorder
7749 @opindex fno-toplevel-reorder
7750 Do not reorder top-level functions, variables, and @code{asm}
7751 statements.  Output them in the same order that they appear in the
7752 input file.  When this option is used, unreferenced static variables
7753 will not be removed.  This option is intended to support existing code
7754 that relies on a particular ordering.  For new code, it is better to
7755 use attributes.
7757 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
7758 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
7759 targets.
7761 @item -fweb
7762 @opindex fweb
7763 Constructs webs as commonly used for register allocation purposes and assign
7764 each web individual pseudo register.  This allows the register allocation pass
7765 to operate on pseudos directly, but also strengthens several other optimization
7766 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7767 however, make debugging impossible, since variables will no longer stay in a
7768 ``home register''.
7770 Enabled by default with @option{-funroll-loops}.
7772 @item -fwhole-program
7773 @opindex fwhole-program
7774 Assume that the current compilation unit represents the whole program being
7775 compiled.  All public functions and variables with the exception of @code{main}
7776 and those merged by attribute @code{externally_visible} become static functions
7777 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.
7778 While this option is equivalent to proper use of the @code{static} keyword for
7779 programs consisting of a single file, in combination with option
7780 @option{-flto} this flag can be used to
7781 compile many smaller scale programs since the functions and variables become
7782 local for the whole combined compilation unit, not for the single source file
7783 itself.
7785 This option implies @option{-fwhole-file} for Fortran programs.
7787 @item -flto[=@var{n}]
7788 @opindex flto
7789 This option runs the standard link-time optimizer.  When invoked
7790 with source code, it generates GIMPLE (one of GCC's internal
7791 representations) and writes it to special ELF sections in the object
7792 file.  When the object files are linked together, all the function
7793 bodies are read from these ELF sections and instantiated as if they
7794 had been part of the same translation unit.
7796 To use the link-time optimizer, @option{-flto} needs to be specified at
7797 compile time and during the final link.  For example:
7799 @smallexample
7800 gcc -c -O2 -flto foo.c
7801 gcc -c -O2 -flto bar.c
7802 gcc -o myprog -flto -O2 foo.o bar.o
7803 @end smallexample
7805 The first two invocations to GCC save a bytecode representation
7806 of GIMPLE into special ELF sections inside @file{foo.o} and
7807 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
7808 @file{foo.o} and @file{bar.o}, merges the two files into a single
7809 internal image, and compiles the result as usual.  Since both
7810 @file{foo.o} and @file{bar.o} are merged into a single image, this
7811 causes all the interprocedural analyses and optimizations in GCC to
7812 work across the two files as if they were a single one.  This means,
7813 for example, that the inliner is able to inline functions in
7814 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7816 Another (simpler) way to enable link-time optimization is:
7818 @smallexample
7819 gcc -o myprog -flto -O2 foo.c bar.c
7820 @end smallexample
7822 The above generates bytecode for @file{foo.c} and @file{bar.c},
7823 merges them together into a single GIMPLE representation and optimizes
7824 them as usual to produce @file{myprog}.
7826 The only important thing to keep in mind is that to enable link-time
7827 optimizations the @option{-flto} flag needs to be passed to both the
7828 compile and the link commands.
7830 To make whole program optimization effective, it is necessary to make
7831 certain whole program assumptions.  The compiler needs to know
7832 what functions and variables can be accessed by libraries and runtime
7833 outside of the link-time optimized unit.  When supported by the linker,
7834 the linker plugin (see @option{-fuse-linker-plugin}) passes information
7835 to the compiler about used and externally visible symbols.  When
7836 the linker plugin is not available, @option{-fwhole-program} should be
7837 used to allow the compiler to make these assumptions, which leads
7838 to more aggressive optimization decisions.
7840 Note that when a file is compiled with @option{-flto}, the generated
7841 object file is larger than a regular object file because it 
7842 contains GIMPLE bytecodes and the usual final code.  This means that
7843 object files with LTO information can be linked as normal object
7844 files; if @option{-flto} is not passed to the linker, no
7845 interprocedural optimizations are applied.
7847 Additionally, the optimization flags used to compile individual files
7848 are not necessarily related to those used at link time.  For instance,
7850 @smallexample
7851 gcc -c -O0 -flto foo.c
7852 gcc -c -O0 -flto bar.c
7853 gcc -o myprog -flto -O3 foo.o bar.o
7854 @end smallexample
7856 This produces individual object files with unoptimized assembler
7857 code, but the resulting binary @file{myprog} is optimized at
7858 @option{-O3}.  If, instead, the final binary is generated without
7859 @option{-flto}, then @file{myprog} is not optimized.
7861 When producing the final binary with @option{-flto}, GCC only
7862 applies link-time optimizations to those files that contain bytecode.
7863 Therefore, you can mix and match object files and libraries with
7864 GIMPLE bytecodes and final object code.  GCC automatically selects
7865 which files to optimize in LTO mode and which files to link without
7866 further processing.
7868 There are some code generation flags preserved by GCC when
7869 generating bytecodes, as they need to be used during the final link
7870 stage.  Currently, the following options are saved into the GIMPLE
7871 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7872 @option{-m} target flags.
7874 At link time, these options are read in and reapplied.  Note that the
7875 current implementation makes no attempt to recognize conflicting
7876 values for these options.  If different files have conflicting option
7877 values (e.g., one file is compiled with @option{-fPIC} and another
7878 isn't), the compiler simply uses the last value read from the
7879 bytecode files.  It is recommended, then, that you compile all the files
7880 participating in the same link with the same options.
7882 If LTO encounters objects with C linkage declared with incompatible
7883 types in separate translation units to be linked together (undefined
7884 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7885 issued.  The behavior is still undefined at run time.
7887 Another feature of LTO is that it is possible to apply interprocedural
7888 optimizations on files written in different languages.  This requires
7889 support in the language front end.  Currently, the C, C++ and
7890 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7891 something like this should work:
7893 @smallexample
7894 gcc -c -flto foo.c
7895 g++ -c -flto bar.cc
7896 gfortran -c -flto baz.f90
7897 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7898 @end smallexample
7900 Notice that the final link is done with @command{g++} to get the C++
7901 runtime libraries and @option{-lgfortran} is added to get the Fortran
7902 runtime libraries.  In general, when mixing languages in LTO mode, you
7903 should use the same link command options as when mixing languages in a
7904 regular (non-LTO) compilation; all you need to add is @option{-flto} to
7905 all the compile and link commands.
7907 If object files containing GIMPLE bytecode are stored in a library archive, say
7908 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
7909 are using a linker with plugin support.  To enable this feature, use
7910 the flag @option{-fuse-linker-plugin} at link time:
7912 @smallexample
7913 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7914 @end smallexample
7916 With the linker plugin enabled, the linker extracts the needed
7917 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
7918 to make them part of the aggregated GIMPLE image to be optimized.
7920 If you are not using a linker with plugin support and/or do not
7921 enable the linker plugin, then the objects inside @file{libfoo.a}
7922 are extracted and linked as usual, but they do not participate
7923 in the LTO optimization process.
7925 Link-time optimizations do not require the presence of the whole program to
7926 operate.  If the program does not require any symbols to be exported, it is
7927 possible to combine @option{-flto} and @option{-fwhole-program} to allow
7928 the interprocedural optimizers to use more aggressive assumptions which may
7929 lead to improved optimization opportunities.
7930 Use of @option{-fwhole-program} is not needed when linker plugin is
7931 active (see @option{-fuse-linker-plugin}).
7933 The current implementation of LTO makes no
7934 attempt to generate bytecode that is portable between different
7935 types of hosts.  The bytecode files are versioned and there is a
7936 strict version check, so bytecode files generated in one version of
7937 GCC will not work with an older/newer version of GCC@.
7939 Link-time optimization does not work well with generation of debugging
7940 information.  Combining @option{-flto} with
7941 @option{-g} is currently experimental and expected to produce wrong
7942 results.
7944 If you specify the optional @var{n}, the optimization and code
7945 generation done at link time is executed in parallel using @var{n}
7946 parallel jobs by utilizing an installed @command{make} program.  The
7947 environment variable @env{MAKE} may be used to override the program
7948 used.  The default value for @var{n} is 1.
7950 You can also specify @option{-flto=jobserver} to use GNU make's
7951 job server mode to determine the number of parallel jobs. This
7952 is useful when the Makefile calling GCC is already executing in parallel.
7953 You must prepend a @samp{+} to the command recipe in the parent Makefile
7954 for this to work.  This option likely only works if @env{MAKE} is
7955 GNU make.
7957 This option is disabled by default
7959 @item -flto-partition=@var{alg}
7960 @opindex flto-partition
7961 Specify the partitioning algorithm used by the link-time optimizer.
7962 The value is either @code{1to1} to specify a partitioning mirroring
7963 the original source files or @code{balanced} to specify partitioning
7964 into equally sized chunks (whenever possible).  Specifying @code{none}
7965 as an algorithm disables partitioning and streaming completely. The
7966 default value is @code{balanced}.
7968 @item -flto-compression-level=@var{n}
7969 This option specifies the level of compression used for intermediate
7970 language written to LTO object files, and is only meaningful in
7971 conjunction with LTO mode (@option{-flto}).  Valid
7972 values are 0 (no compression) to 9 (maximum compression).  Values
7973 outside this range are clamped to either 0 or 9.  If the option is not
7974 given, a default balanced compression setting is used.
7976 @item -flto-report
7977 Prints a report with internal details on the workings of the link-time
7978 optimizer.  The contents of this report vary from version to version.
7979 It is meant to be useful to GCC developers when processing object
7980 files in LTO mode (via @option{-flto}).
7982 Disabled by default.
7984 @item -fuse-linker-plugin
7985 Enables the use of a linker plugin during link-time optimization.  This
7986 option relies on plugin support in the linker, which is available in gold
7987 or in GNU ld 2.21 or newer.
7989 This option enables the extraction of object files with GIMPLE bytecode out
7990 of library archives. This improves the quality of optimization by exposing
7991 more code to the link-time optimizer.  This information specifies what
7992 symbols can be accessed externally (by non-LTO object or during dynamic
7993 linking).  Resulting code quality improvements on binaries (and shared
7994 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
7995 See @option{-flto} for a description of the effect of this flag and how to
7996 use it.
7998 This option is enabled by default when LTO support in GCC is enabled
7999 and GCC was configured for use with
8000 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8002 @item -ffat-lto-objects
8003 @opindex ffat-lto-objects
8004 Fat LTO objects are object files that contain both the intermediate language
8005 and the object code. This makes them usable for both LTO linking and normal
8006 linking. This option is effective only when compiling with @option{-flto}
8007 and is ignored at link time.
8009 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8010 requires the complete toolchain to be aware of LTO. It requires a linker with
8011 linker plugin support for basic functionality.  Additionally,
8012 @command{nm}, @command{ar} and @command{ranlib}
8013 need to support linker plugins to allow a full-featured build environment
8014 (capable of building static libraries etc).
8016 The default is @option{-ffat-lto-objects} but this default is intended to
8017 change in future releases when linker plugin enabled environments become more
8018 common.
8020 @item -fcompare-elim
8021 @opindex fcompare-elim
8022 After register allocation and post-register allocation instruction splitting,
8023 identify arithmetic instructions that compute processor flags similar to a
8024 comparison operation based on that arithmetic.  If possible, eliminate the
8025 explicit comparison operation.
8027 This pass only applies to certain targets that cannot explicitly represent
8028 the comparison operation before register allocation is complete.
8030 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8032 @item -fcprop-registers
8033 @opindex fcprop-registers
8034 After register allocation and post-register allocation instruction splitting,
8035 we perform a copy-propagation pass to try to reduce scheduling dependencies
8036 and occasionally eliminate the copy.
8038 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8040 @item -fprofile-correction
8041 @opindex fprofile-correction
8042 Profiles collected using an instrumented binary for multi-threaded programs may
8043 be inconsistent due to missed counter updates. When this option is specified,
8044 GCC will use heuristics to correct or smooth out such inconsistencies. By
8045 default, GCC will emit an error message when an inconsistent profile is detected.
8047 @item -fprofile-dir=@var{path}
8048 @opindex fprofile-dir
8050 Set the directory to search for the profile data files in to @var{path}.
8051 This option affects only the profile data generated by
8052 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8053 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8054 and its related options.  Both absolute and relative paths can be used.
8055 By default, GCC will use the current directory as @var{path}, thus the
8056 profile data file will appear in the same directory as the object file.
8058 @item -fprofile-generate
8059 @itemx -fprofile-generate=@var{path}
8060 @opindex fprofile-generate
8062 Enable options usually used for instrumenting application to produce
8063 profile useful for later recompilation with profile feedback based
8064 optimization.  You must use @option{-fprofile-generate} both when
8065 compiling and when linking your program.
8067 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8069 If @var{path} is specified, GCC will look at the @var{path} to find
8070 the profile feedback data files. See @option{-fprofile-dir}.
8072 @item -fprofile-use
8073 @itemx -fprofile-use=@var{path}
8074 @opindex fprofile-use
8075 Enable profile feedback directed optimizations, and optimizations
8076 generally profitable only with profile feedback available.
8078 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8079 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
8081 By default, GCC emits an error message if the feedback profiles do not
8082 match the source code.  This error can be turned into a warning by using
8083 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8084 code.
8086 If @var{path} is specified, GCC will look at the @var{path} to find
8087 the profile feedback data files. See @option{-fprofile-dir}.
8088 @end table
8090 The following options control compiler behavior regarding floating-point 
8091 arithmetic.  These options trade off between speed and
8092 correctness.  All must be specifically enabled.
8094 @table @gcctabopt
8095 @item -ffloat-store
8096 @opindex ffloat-store
8097 Do not store floating-point variables in registers, and inhibit other
8098 options that might change whether a floating-point value is taken from a
8099 register or memory.
8101 @cindex floating-point precision
8102 This option prevents undesirable excess precision on machines such as
8103 the 68000 where the floating registers (of the 68881) keep more
8104 precision than a @code{double} is supposed to have.  Similarly for the
8105 x86 architecture.  For most programs, the excess precision does only
8106 good, but a few programs rely on the precise definition of IEEE floating
8107 point.  Use @option{-ffloat-store} for such programs, after modifying
8108 them to store all pertinent intermediate computations into variables.
8110 @item -fexcess-precision=@var{style}
8111 @opindex fexcess-precision
8112 This option allows further control over excess precision on machines
8113 where floating-point registers have more precision than the IEEE
8114 @code{float} and @code{double} types and the processor does not
8115 support operations rounding to those types.  By default,
8116 @option{-fexcess-precision=fast} is in effect; this means that
8117 operations are carried out in the precision of the registers and that
8118 it is unpredictable when rounding to the types specified in the source
8119 code takes place.  When compiling C, if
8120 @option{-fexcess-precision=standard} is specified then excess
8121 precision will follow the rules specified in ISO C99; in particular,
8122 both casts and assignments cause values to be rounded to their
8123 semantic types (whereas @option{-ffloat-store} only affects
8124 assignments).  This option is enabled by default for C if a strict
8125 conformance option such as @option{-std=c99} is used.
8127 @opindex mfpmath
8128 @option{-fexcess-precision=standard} is not implemented for languages
8129 other than C, and has no effect if
8130 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8131 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8132 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8133 semantics apply without excess precision, and in the latter, rounding
8134 is unpredictable.
8136 @item -ffast-math
8137 @opindex ffast-math
8138 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8139 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8140 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8142 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8144 This option is not turned on by any @option{-O} option besides
8145 @option{-Ofast} since it can result in incorrect output for programs
8146 that depend on an exact implementation of IEEE or ISO rules/specifications
8147 for math functions. It may, however, yield faster code for programs
8148 that do not require the guarantees of these specifications.
8150 @item -fno-math-errno
8151 @opindex fno-math-errno
8152 Do not set ERRNO after calling math functions that are executed
8153 with a single instruction, e.g., sqrt.  A program that relies on
8154 IEEE exceptions for math error handling may want to use this flag
8155 for speed while maintaining IEEE arithmetic compatibility.
8157 This option is not turned on by any @option{-O} option since
8158 it can result in incorrect output for programs that depend on
8159 an exact implementation of IEEE or ISO rules/specifications for
8160 math functions. It may, however, yield faster code for programs
8161 that do not require the guarantees of these specifications.
8163 The default is @option{-fmath-errno}.
8165 On Darwin systems, the math library never sets @code{errno}.  There is
8166 therefore no reason for the compiler to consider the possibility that
8167 it might, and @option{-fno-math-errno} is the default.
8169 @item -funsafe-math-optimizations
8170 @opindex funsafe-math-optimizations
8172 Allow optimizations for floating-point arithmetic that (a) assume
8173 that arguments and results are valid and (b) may violate IEEE or
8174 ANSI standards.  When used at link-time, it may include libraries
8175 or startup files that change the default FPU control word or other
8176 similar optimizations.
8178 This option is not turned on by any @option{-O} option since
8179 it can result in incorrect output for programs that depend on
8180 an exact implementation of IEEE or ISO rules/specifications for
8181 math functions. It may, however, yield faster code for programs
8182 that do not require the guarantees of these specifications.
8183 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8184 @option{-fassociative-math} and @option{-freciprocal-math}.
8186 The default is @option{-fno-unsafe-math-optimizations}.
8188 @item -fassociative-math
8189 @opindex fassociative-math
8191 Allow re-association of operands in series of floating-point operations.
8192 This violates the ISO C and C++ language standard by possibly changing
8193 computation result.  NOTE: re-ordering may change the sign of zero as
8194 well as ignore NaNs and inhibit or create underflow or overflow (and
8195 thus cannot be used on code that relies on rounding behavior like
8196 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8197 and thus may not be used when ordered comparisons are required.
8198 This option requires that both @option{-fno-signed-zeros} and
8199 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8200 much sense with @option{-frounding-math}. For Fortran the option
8201 is automatically enabled when both @option{-fno-signed-zeros} and
8202 @option{-fno-trapping-math} are in effect.
8204 The default is @option{-fno-associative-math}.
8206 @item -freciprocal-math
8207 @opindex freciprocal-math
8209 Allow the reciprocal of a value to be used instead of dividing by
8210 the value if this enables optimizations.  For example @code{x / y}
8211 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8212 is subject to common subexpression elimination.  Note that this loses
8213 precision and increases the number of flops operating on the value.
8215 The default is @option{-fno-reciprocal-math}.
8217 @item -ffinite-math-only
8218 @opindex ffinite-math-only
8219 Allow optimizations for floating-point arithmetic that assume
8220 that arguments and results are not NaNs or +-Infs.
8222 This option is not turned on by any @option{-O} option since
8223 it can result in incorrect output for programs that depend on
8224 an exact implementation of IEEE or ISO rules/specifications for
8225 math functions. It may, however, yield faster code for programs
8226 that do not require the guarantees of these specifications.
8228 The default is @option{-fno-finite-math-only}.
8230 @item -fno-signed-zeros
8231 @opindex fno-signed-zeros
8232 Allow optimizations for floating-point arithmetic that ignore the
8233 signedness of zero.  IEEE arithmetic specifies the behavior of
8234 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8235 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8236 This option implies that the sign of a zero result isn't significant.
8238 The default is @option{-fsigned-zeros}.
8240 @item -fno-trapping-math
8241 @opindex fno-trapping-math
8242 Compile code assuming that floating-point operations cannot generate
8243 user-visible traps.  These traps include division by zero, overflow,
8244 underflow, inexact result and invalid operation.  This option requires
8245 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8246 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8248 This option should never be turned on by any @option{-O} option since
8249 it can result in incorrect output for programs that depend on
8250 an exact implementation of IEEE or ISO rules/specifications for
8251 math functions.
8253 The default is @option{-ftrapping-math}.
8255 @item -frounding-math
8256 @opindex frounding-math
8257 Disable transformations and optimizations that assume default floating-point
8258 rounding behavior.  This is round-to-zero for all floating point
8259 to integer conversions, and round-to-nearest for all other arithmetic
8260 truncations.  This option should be specified for programs that change
8261 the FP rounding mode dynamically, or that may be executed with a
8262 non-default rounding mode.  This option disables constant folding of
8263 floating-point expressions at compile time (which may be affected by
8264 rounding mode) and arithmetic transformations that are unsafe in the
8265 presence of sign-dependent rounding modes.
8267 The default is @option{-fno-rounding-math}.
8269 This option is experimental and does not currently guarantee to
8270 disable all GCC optimizations that are affected by rounding mode.
8271 Future versions of GCC may provide finer control of this setting
8272 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8273 will be used to specify the default state for @code{FENV_ACCESS}.
8275 @item -fsignaling-nans
8276 @opindex fsignaling-nans
8277 Compile code assuming that IEEE signaling NaNs may generate user-visible
8278 traps during floating-point operations.  Setting this option disables
8279 optimizations that may change the number of exceptions visible with
8280 signaling NaNs.  This option implies @option{-ftrapping-math}.
8282 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8283 be defined.
8285 The default is @option{-fno-signaling-nans}.
8287 This option is experimental and does not currently guarantee to
8288 disable all GCC optimizations that affect signaling NaN behavior.
8290 @item -fsingle-precision-constant
8291 @opindex fsingle-precision-constant
8292 Treat floating-point constants as single precision instead of
8293 implicitly converting them to double-precision constants.
8295 @item -fcx-limited-range
8296 @opindex fcx-limited-range
8297 When enabled, this option states that a range reduction step is not
8298 needed when performing complex division.  Also, there is no checking
8299 whether the result of a complex multiplication or division is @code{NaN
8300 + I*NaN}, with an attempt to rescue the situation in that case.  The
8301 default is @option{-fno-cx-limited-range}, but is enabled by
8302 @option{-ffast-math}.
8304 This option controls the default setting of the ISO C99
8305 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8306 all languages.
8308 @item -fcx-fortran-rules
8309 @opindex fcx-fortran-rules
8310 Complex multiplication and division follow Fortran rules.  Range
8311 reduction is done as part of complex division, but there is no checking
8312 whether the result of a complex multiplication or division is @code{NaN
8313 + I*NaN}, with an attempt to rescue the situation in that case.
8315 The default is @option{-fno-cx-fortran-rules}.
8317 @end table
8319 The following options control optimizations that may improve
8320 performance, but are not enabled by any @option{-O} options.  This
8321 section includes experimental options that may produce broken code.
8323 @table @gcctabopt
8324 @item -fbranch-probabilities
8325 @opindex fbranch-probabilities
8326 After running a program compiled with @option{-fprofile-arcs}
8327 (@pxref{Debugging Options,, Options for Debugging Your Program or
8328 @command{gcc}}), you can compile it a second time using
8329 @option{-fbranch-probabilities}, to improve optimizations based on
8330 the number of times each branch was taken.  When the program
8331 compiled with @option{-fprofile-arcs} exits it saves arc execution
8332 counts to a file called @file{@var{sourcename}.gcda} for each source
8333 file.  The information in this data file is very dependent on the
8334 structure of the generated code, so you must use the same source code
8335 and the same optimization options for both compilations.
8337 With @option{-fbranch-probabilities}, GCC puts a
8338 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8339 These can be used to improve optimization.  Currently, they are only
8340 used in one place: in @file{reorg.c}, instead of guessing which path a
8341 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8342 exactly determine which path is taken more often.
8344 @item -fprofile-values
8345 @opindex fprofile-values
8346 If combined with @option{-fprofile-arcs}, it adds code so that some
8347 data about values of expressions in the program is gathered.
8349 With @option{-fbranch-probabilities}, it reads back the data gathered
8350 from profiling values of expressions for usage in optimizations.
8352 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8354 @item -fvpt
8355 @opindex fvpt
8356 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
8357 a code to gather information about values of expressions.
8359 With @option{-fbranch-probabilities}, it reads back the data gathered
8360 and actually performs the optimizations based on them.
8361 Currently the optimizations include specialization of division operation
8362 using the knowledge about the value of the denominator.
8364 @item -frename-registers
8365 @opindex frename-registers
8366 Attempt to avoid false dependencies in scheduled code by making use
8367 of registers left over after register allocation.  This optimization
8368 will most benefit processors with lots of registers.  Depending on the
8369 debug information format adopted by the target, however, it can
8370 make debugging impossible, since variables will no longer stay in
8371 a ``home register''.
8373 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8375 @item -ftracer
8376 @opindex ftracer
8377 Perform tail duplication to enlarge superblock size.  This transformation
8378 simplifies the control flow of the function allowing other optimizations to do
8379 better job.
8381 Enabled with @option{-fprofile-use}.
8383 @item -funroll-loops
8384 @opindex funroll-loops
8385 Unroll loops whose number of iterations can be determined at compile time or
8386 upon entry to the loop.  @option{-funroll-loops} implies
8387 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8388 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8389 small constant number of iterations).  This option makes code larger, and may
8390 or may not make it run faster.
8392 Enabled with @option{-fprofile-use}.
8394 @item -funroll-all-loops
8395 @opindex funroll-all-loops
8396 Unroll all loops, even if their number of iterations is uncertain when
8397 the loop is entered.  This usually makes programs run more slowly.
8398 @option{-funroll-all-loops} implies the same options as
8399 @option{-funroll-loops}.
8401 @item -fpeel-loops
8402 @opindex fpeel-loops
8403 Peels loops for which there is enough information that they do not
8404 roll much (from profile feedback).  It also turns on complete loop peeling
8405 (i.e.@: complete removal of loops with small constant number of iterations).
8407 Enabled with @option{-fprofile-use}.
8409 @item -fmove-loop-invariants
8410 @opindex fmove-loop-invariants
8411 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8412 at level @option{-O1}
8414 @item -funswitch-loops
8415 @opindex funswitch-loops
8416 Move branches with loop invariant conditions out of the loop, with duplicates
8417 of the loop on both branches (modified according to result of the condition).
8419 @item -ffunction-sections
8420 @itemx -fdata-sections
8421 @opindex ffunction-sections
8422 @opindex fdata-sections
8423 Place each function or data item into its own section in the output
8424 file if the target supports arbitrary sections.  The name of the
8425 function or the name of the data item determines the section's name
8426 in the output file.
8428 Use these options on systems where the linker can perform optimizations
8429 to improve locality of reference in the instruction space.  Most systems
8430 using the ELF object format and SPARC processors running Solaris 2 have
8431 linkers with such optimizations.  AIX may have these optimizations in
8432 the future.
8434 Only use these options when there are significant benefits from doing
8435 so.  When you specify these options, the assembler and linker will
8436 create larger object and executable files and will also be slower.
8437 You will not be able to use @code{gprof} on all systems if you
8438 specify this option and you may have problems with debugging if
8439 you specify both this option and @option{-g}.
8441 @item -fbranch-target-load-optimize
8442 @opindex fbranch-target-load-optimize
8443 Perform branch target register load optimization before prologue / epilogue
8444 threading.
8445 The use of target registers can typically be exposed only during reload,
8446 thus hoisting loads out of loops and doing inter-block scheduling needs
8447 a separate optimization pass.
8449 @item -fbranch-target-load-optimize2
8450 @opindex fbranch-target-load-optimize2
8451 Perform branch target register load optimization after prologue / epilogue
8452 threading.
8454 @item -fbtr-bb-exclusive
8455 @opindex fbtr-bb-exclusive
8456 When performing branch target register load optimization, don't reuse
8457 branch target registers in within any basic block.
8459 @item -fstack-protector
8460 @opindex fstack-protector
8461 Emit extra code to check for buffer overflows, such as stack smashing
8462 attacks.  This is done by adding a guard variable to functions with
8463 vulnerable objects.  This includes functions that call alloca, and
8464 functions with buffers larger than 8 bytes.  The guards are initialized
8465 when a function is entered and then checked when the function exits.
8466 If a guard check fails, an error message is printed and the program exits.
8468 @item -fstack-protector-all
8469 @opindex fstack-protector-all
8470 Like @option{-fstack-protector} except that all functions are protected.
8472 @item -fsection-anchors
8473 @opindex fsection-anchors
8474 Try to reduce the number of symbolic address calculations by using
8475 shared ``anchor'' symbols to address nearby objects.  This transformation
8476 can help to reduce the number of GOT entries and GOT accesses on some
8477 targets.
8479 For example, the implementation of the following function @code{foo}:
8481 @smallexample
8482 static int a, b, c;
8483 int foo (void) @{ return a + b + c; @}
8484 @end smallexample
8486 would usually calculate the addresses of all three variables, but if you
8487 compile it with @option{-fsection-anchors}, it will access the variables
8488 from a common anchor point instead.  The effect is similar to the
8489 following pseudocode (which isn't valid C):
8491 @smallexample
8492 int foo (void)
8494   register int *xr = &x;
8495   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8497 @end smallexample
8499 Not all targets support this option.
8501 @item --param @var{name}=@var{value}
8502 @opindex param
8503 In some places, GCC uses various constants to control the amount of
8504 optimization that is done.  For example, GCC will not inline functions
8505 that contain more than a certain number of instructions.  You can
8506 control some of these constants on the command line using the
8507 @option{--param} option.
8509 The names of specific parameters, and the meaning of the values, are
8510 tied to the internals of the compiler, and are subject to change
8511 without notice in future releases.
8513 In each case, the @var{value} is an integer.  The allowable choices for
8514 @var{name} are given in the following table:
8516 @table @gcctabopt
8517 @item predictable-branch-outcome
8518 When branch is predicted to be taken with probability lower than this threshold
8519 (in percent), then it is considered well predictable. The default is 10.
8521 @item max-crossjump-edges
8522 The maximum number of incoming edges to consider for crossjumping.
8523 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8524 the number of edges incoming to each block.  Increasing values mean
8525 more aggressive optimization, making the compilation time increase with
8526 probably small improvement in executable size.
8528 @item min-crossjump-insns
8529 The minimum number of instructions that must be matched at the end
8530 of two blocks before crossjumping will be performed on them.  This
8531 value is ignored in the case where all instructions in the block being
8532 crossjumped from are matched.  The default value is 5.
8534 @item max-grow-copy-bb-insns
8535 The maximum code size expansion factor when copying basic blocks
8536 instead of jumping.  The expansion is relative to a jump instruction.
8537 The default value is 8.
8539 @item max-goto-duplication-insns
8540 The maximum number of instructions to duplicate to a block that jumps
8541 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8542 passes, GCC factors computed gotos early in the compilation process,
8543 and unfactors them as late as possible.  Only computed jumps at the
8544 end of a basic blocks with no more than max-goto-duplication-insns are
8545 unfactored.  The default value is 8.
8547 @item max-delay-slot-insn-search
8548 The maximum number of instructions to consider when looking for an
8549 instruction to fill a delay slot.  If more than this arbitrary number of
8550 instructions is searched, the time savings from filling the delay slot
8551 will be minimal so stop searching.  Increasing values mean more
8552 aggressive optimization, making the compilation time increase with probably
8553 small improvement in execution time.
8555 @item max-delay-slot-live-search
8556 When trying to fill delay slots, the maximum number of instructions to
8557 consider when searching for a block with valid live register
8558 information.  Increasing this arbitrarily chosen value means more
8559 aggressive optimization, increasing the compilation time.  This parameter
8560 should be removed when the delay slot code is rewritten to maintain the
8561 control-flow graph.
8563 @item max-gcse-memory
8564 The approximate maximum amount of memory that will be allocated in
8565 order to perform the global common subexpression elimination
8566 optimization.  If more memory than specified is required, the
8567 optimization will not be done.
8569 @item max-gcse-insertion-ratio
8570 If the ratio of expression insertions to deletions is larger than this value
8571 for any expression, then RTL PRE will insert or remove the expression and thus
8572 leave partially redundant computations in the instruction stream.  The default value is 20.
8574 @item max-pending-list-length
8575 The maximum number of pending dependencies scheduling will allow
8576 before flushing the current state and starting over.  Large functions
8577 with few branches or calls can create excessively large lists which
8578 needlessly consume memory and resources.
8580 @item max-modulo-backtrack-attempts
8581 The maximum number of backtrack attempts the scheduler should make
8582 when modulo scheduling a loop.  Larger values can exponentially increase
8583 compilation time.
8585 @item max-inline-insns-single
8586 Several parameters control the tree inliner used in GCC@.
8587 This number sets the maximum number of instructions (counted in GCC's
8588 internal representation) in a single function that the tree inliner
8589 will consider for inlining.  This only affects functions declared
8590 inline and methods implemented in a class declaration (C++).
8591 The default value is 400.
8593 @item max-inline-insns-auto
8594 When you use @option{-finline-functions} (included in @option{-O3}),
8595 a lot of functions that would otherwise not be considered for inlining
8596 by the compiler will be investigated.  To those functions, a different
8597 (more restrictive) limit compared to functions declared inline can
8598 be applied.
8599 The default value is 40.
8601 @item large-function-insns
8602 The limit specifying really large functions.  For functions larger than this
8603 limit after inlining, inlining is constrained by
8604 @option{--param large-function-growth}.  This parameter is useful primarily
8605 to avoid extreme compilation time caused by non-linear algorithms used by the
8606 back end.
8607 The default value is 2700.
8609 @item large-function-growth
8610 Specifies maximal growth of large function caused by inlining in percents.
8611 The default value is 100 which limits large function growth to 2.0 times
8612 the original size.
8614 @item large-unit-insns
8615 The limit specifying large translation unit.  Growth caused by inlining of
8616 units larger than this limit is limited by @option{--param inline-unit-growth}.
8617 For small units this might be too tight (consider unit consisting of function A
8618 that is inline and B that just calls A three time.  If B is small relative to
8619 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8620 large units consisting of small inlineable functions however the overall unit
8621 growth limit is needed to avoid exponential explosion of code size.  Thus for
8622 smaller units, the size is increased to @option{--param large-unit-insns}
8623 before applying @option{--param inline-unit-growth}.  The default is 10000
8625 @item inline-unit-growth
8626 Specifies maximal overall growth of the compilation unit caused by inlining.
8627 The default value is 30 which limits unit growth to 1.3 times the original
8628 size.
8630 @item ipcp-unit-growth
8631 Specifies maximal overall growth of the compilation unit caused by
8632 interprocedural constant propagation.  The default value is 10 which limits
8633 unit growth to 1.1 times the original size.
8635 @item large-stack-frame
8636 The limit specifying large stack frames.  While inlining the algorithm is trying
8637 to not grow past this limit too much.  Default value is 256 bytes.
8639 @item large-stack-frame-growth
8640 Specifies maximal growth of large stack frames caused by inlining in percents.
8641 The default value is 1000 which limits large stack frame growth to 11 times
8642 the original size.
8644 @item max-inline-insns-recursive
8645 @itemx max-inline-insns-recursive-auto
8646 Specifies maximum number of instructions out-of-line copy of self recursive inline
8647 function can grow into by performing recursive inlining.
8649 For functions declared inline @option{--param max-inline-insns-recursive} is
8650 taken into account.  For function not declared inline, recursive inlining
8651 happens only when @option{-finline-functions} (included in @option{-O3}) is
8652 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8653 default value is 450.
8655 @item max-inline-recursive-depth
8656 @itemx max-inline-recursive-depth-auto
8657 Specifies maximum recursion depth used by the recursive inlining.
8659 For functions declared inline @option{--param max-inline-recursive-depth} is
8660 taken into account.  For function not declared inline, recursive inlining
8661 happens only when @option{-finline-functions} (included in @option{-O3}) is
8662 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8663 default value is 8.
8665 @item min-inline-recursive-probability
8666 Recursive inlining is profitable only for function having deep recursion
8667 in average and can hurt for function having little recursion depth by
8668 increasing the prologue size or complexity of function body to other
8669 optimizers.
8671 When profile feedback is available (see @option{-fprofile-generate}) the actual
8672 recursion depth can be guessed from probability that function will recurse via
8673 given call expression.  This parameter limits inlining only to call expression
8674 whose probability exceeds given threshold (in percents).  The default value is
8677 @item early-inlining-insns
8678 Specify growth that early inliner can make.  In effect it increases amount of
8679 inlining for code having large abstraction penalty.  The default value is 10.
8681 @item max-early-inliner-iterations
8682 @itemx max-early-inliner-iterations
8683 Limit of iterations of early inliner.  This basically bounds number of nested
8684 indirect calls early inliner can resolve.  Deeper chains are still handled by
8685 late inlining.
8687 @item comdat-sharing-probability
8688 @itemx comdat-sharing-probability
8689 Probability (in percent) that C++ inline function with comdat visibility
8690 will be shared across multiple compilation units.  The default value is 20.
8692 @item min-vect-loop-bound
8693 The minimum number of iterations under which a loop will not get vectorized
8694 when @option{-ftree-vectorize} is used.  The number of iterations after
8695 vectorization needs to be greater than the value specified by this option
8696 to allow vectorization.  The default value is 0.
8698 @item gcse-cost-distance-ratio
8699 Scaling factor in calculation of maximum distance an expression
8700 can be moved by GCSE optimizations.  This is currently supported only in the
8701 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
8702 will be with simple expressions, i.e., the expressions that have cost
8703 less than @option{gcse-unrestricted-cost}.  Specifying 0 will disable
8704 hoisting of simple expressions.  The default value is 10.
8706 @item gcse-unrestricted-cost
8707 Cost, roughly measured as the cost of a single typical machine
8708 instruction, at which GCSE optimizations will not constrain
8709 the distance an expression can travel.  This is currently
8710 supported only in the code hoisting pass.  The lesser the cost,
8711 the more aggressive code hoisting will be.  Specifying 0 will
8712 allow all expressions to travel unrestricted distances.
8713 The default value is 3.
8715 @item max-hoist-depth
8716 The depth of search in the dominator tree for expressions to hoist.
8717 This is used to avoid quadratic behavior in hoisting algorithm.
8718 The value of 0 will avoid limiting the search, but may slow down compilation
8719 of huge functions.  The default value is 30.
8721 @item max-tail-merge-comparisons
8722 The maximum amount of similar bbs to compare a bb with.  This is used to
8723 avoid quadratic behavior in tree tail merging.  The default value is 10.
8725 @item max-tail-merge-iterations
8726 The maximum amount of iterations of the pass over the function.  This is used to
8727 limit compilation time in tree tail merging.  The default value is 2.
8729 @item max-unrolled-insns
8730 The maximum number of instructions that a loop should have if that loop
8731 is unrolled, and if the loop is unrolled, it determines how many times
8732 the loop code is unrolled.
8734 @item max-average-unrolled-insns
8735 The maximum number of instructions biased by probabilities of their execution
8736 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8737 it determines how many times the loop code is unrolled.
8739 @item max-unroll-times
8740 The maximum number of unrollings of a single loop.
8742 @item max-peeled-insns
8743 The maximum number of instructions that a loop should have if that loop
8744 is peeled, and if the loop is peeled, it determines how many times
8745 the loop code is peeled.
8747 @item max-peel-times
8748 The maximum number of peelings of a single loop.
8750 @item max-completely-peeled-insns
8751 The maximum number of insns of a completely peeled loop.
8753 @item max-completely-peel-times
8754 The maximum number of iterations of a loop to be suitable for complete peeling.
8756 @item max-completely-peel-loop-nest-depth
8757 The maximum depth of a loop nest suitable for complete peeling.
8759 @item max-unswitch-insns
8760 The maximum number of insns of an unswitched loop.
8762 @item max-unswitch-level
8763 The maximum number of branches unswitched in a single loop.
8765 @item lim-expensive
8766 The minimum cost of an expensive expression in the loop invariant motion.
8768 @item iv-consider-all-candidates-bound
8769 Bound on number of candidates for induction variables below that
8770 all candidates are considered for each use in induction variable
8771 optimizations.  Only the most relevant candidates are considered
8772 if there are more candidates, to avoid quadratic time complexity.
8774 @item iv-max-considered-uses
8775 The induction variable optimizations give up on loops that contain more
8776 induction variable uses.
8778 @item iv-always-prune-cand-set-bound
8779 If number of candidates in the set is smaller than this value,
8780 we always try to remove unnecessary ivs from the set during its
8781 optimization when a new iv is added to the set.
8783 @item scev-max-expr-size
8784 Bound on size of expressions used in the scalar evolutions analyzer.
8785 Large expressions slow the analyzer.
8787 @item scev-max-expr-complexity
8788 Bound on the complexity of the expressions in the scalar evolutions analyzer.
8789 Complex expressions slow the analyzer.
8791 @item omega-max-vars
8792 The maximum number of variables in an Omega constraint system.
8793 The default value is 128.
8795 @item omega-max-geqs
8796 The maximum number of inequalities in an Omega constraint system.
8797 The default value is 256.
8799 @item omega-max-eqs
8800 The maximum number of equalities in an Omega constraint system.
8801 The default value is 128.
8803 @item omega-max-wild-cards
8804 The maximum number of wildcard variables that the Omega solver will
8805 be able to insert.  The default value is 18.
8807 @item omega-hash-table-size
8808 The size of the hash table in the Omega solver.  The default value is
8809 550.
8811 @item omega-max-keys
8812 The maximal number of keys used by the Omega solver.  The default
8813 value is 500.
8815 @item omega-eliminate-redundant-constraints
8816 When set to 1, use expensive methods to eliminate all redundant
8817 constraints.  The default value is 0.
8819 @item vect-max-version-for-alignment-checks
8820 The maximum number of run-time checks that can be performed when
8821 doing loop versioning for alignment in the vectorizer.  See option
8822 ftree-vect-loop-version for more information.
8824 @item vect-max-version-for-alias-checks
8825 The maximum number of run-time checks that can be performed when
8826 doing loop versioning for alias in the vectorizer.  See option
8827 ftree-vect-loop-version for more information.
8829 @item max-iterations-to-track
8831 The maximum number of iterations of a loop the brute force algorithm
8832 for analysis of # of iterations of the loop tries to evaluate.
8834 @item hot-bb-count-fraction
8835 Select fraction of the maximal count of repetitions of basic block in program
8836 given basic block needs to have to be considered hot.
8838 @item hot-bb-frequency-fraction
8839 Select fraction of the entry block frequency of executions of basic block in
8840 function given basic block needs to have to be considered hot.
8842 @item max-predicted-iterations
8843 The maximum number of loop iterations we predict statically.  This is useful
8844 in cases where function contain single loop with known bound and other loop
8845 with unknown.  We predict the known number of iterations correctly, while
8846 the unknown number of iterations average to roughly 10.  This means that the
8847 loop without bounds would appear artificially cold relative to the other one.
8849 @item align-threshold
8851 Select fraction of the maximal frequency of executions of basic block in
8852 function given basic block will get aligned.
8854 @item align-loop-iterations
8856 A loop expected to iterate at lest the selected number of iterations will get
8857 aligned.
8859 @item tracer-dynamic-coverage
8860 @itemx tracer-dynamic-coverage-feedback
8862 This value is used to limit superblock formation once the given percentage of
8863 executed instructions is covered.  This limits unnecessary code size
8864 expansion.
8866 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8867 feedback is available.  The real profiles (as opposed to statically estimated
8868 ones) are much less balanced allowing the threshold to be larger value.
8870 @item tracer-max-code-growth
8871 Stop tail duplication once code growth has reached given percentage.  This is
8872 rather hokey argument, as most of the duplicates will be eliminated later in
8873 cross jumping, so it may be set to much higher values than is the desired code
8874 growth.
8876 @item tracer-min-branch-ratio
8878 Stop reverse growth when the reverse probability of best edge is less than this
8879 threshold (in percent).
8881 @item tracer-min-branch-ratio
8882 @itemx tracer-min-branch-ratio-feedback
8884 Stop forward growth if the best edge do have probability lower than this
8885 threshold.
8887 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8888 compilation for profile feedback and one for compilation without.  The value
8889 for compilation with profile feedback needs to be more conservative (higher) in
8890 order to make tracer effective.
8892 @item max-cse-path-length
8894 Maximum number of basic blocks on path that cse considers.  The default is 10.
8896 @item max-cse-insns
8897 The maximum instructions CSE process before flushing. The default is 1000.
8899 @item ggc-min-expand
8901 GCC uses a garbage collector to manage its own memory allocation.  This
8902 parameter specifies the minimum percentage by which the garbage
8903 collector's heap should be allowed to expand between collections.
8904 Tuning this may improve compilation speed; it has no effect on code
8905 generation.
8907 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8908 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8909 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8910 GCC is not able to calculate RAM on a particular platform, the lower
8911 bound of 30% is used.  Setting this parameter and
8912 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8913 every opportunity.  This is extremely slow, but can be useful for
8914 debugging.
8916 @item ggc-min-heapsize
8918 Minimum size of the garbage collector's heap before it begins bothering
8919 to collect garbage.  The first collection occurs after the heap expands
8920 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8921 tuning this may improve compilation speed, and has no effect on code
8922 generation.
8924 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
8925 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8926 with a lower bound of 4096 (four megabytes) and an upper bound of
8927 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8928 particular platform, the lower bound is used.  Setting this parameter
8929 very large effectively disables garbage collection.  Setting this
8930 parameter and @option{ggc-min-expand} to zero causes a full collection
8931 to occur at every opportunity.
8933 @item max-reload-search-insns
8934 The maximum number of instruction reload should look backward for equivalent
8935 register.  Increasing values mean more aggressive optimization, making the
8936 compilation time increase with probably slightly better performance.
8937 The default value is 100.
8939 @item max-cselib-memory-locations
8940 The maximum number of memory locations cselib should take into account.
8941 Increasing values mean more aggressive optimization, making the compilation time
8942 increase with probably slightly better performance.  The default value is 500.
8944 @item reorder-blocks-duplicate
8945 @itemx reorder-blocks-duplicate-feedback
8947 Used by basic block reordering pass to decide whether to use unconditional
8948 branch or duplicate the code on its destination.  Code is duplicated when its
8949 estimated size is smaller than this value multiplied by the estimated size of
8950 unconditional jump in the hot spots of the program.
8952 The @option{reorder-block-duplicate-feedback} is used only when profile
8953 feedback is available and may be set to higher values than
8954 @option{reorder-block-duplicate} since information about the hot spots is more
8955 accurate.
8957 @item max-sched-ready-insns
8958 The maximum number of instructions ready to be issued the scheduler should
8959 consider at any given time during the first scheduling pass.  Increasing
8960 values mean more thorough searches, making the compilation time increase
8961 with probably little benefit.  The default value is 100.
8963 @item max-sched-region-blocks
8964 The maximum number of blocks in a region to be considered for
8965 interblock scheduling.  The default value is 10.
8967 @item max-pipeline-region-blocks
8968 The maximum number of blocks in a region to be considered for
8969 pipelining in the selective scheduler.  The default value is 15.
8971 @item max-sched-region-insns
8972 The maximum number of insns in a region to be considered for
8973 interblock scheduling.  The default value is 100.
8975 @item max-pipeline-region-insns
8976 The maximum number of insns in a region to be considered for
8977 pipelining in the selective scheduler.  The default value is 200.
8979 @item min-spec-prob
8980 The minimum probability (in percents) of reaching a source block
8981 for interblock speculative scheduling.  The default value is 40.
8983 @item max-sched-extend-regions-iters
8984 The maximum number of iterations through CFG to extend regions.
8985 0 - disable region extension,
8986 N - do at most N iterations.
8987 The default value is 0.
8989 @item max-sched-insn-conflict-delay
8990 The maximum conflict delay for an insn to be considered for speculative motion.
8991 The default value is 3.
8993 @item sched-spec-prob-cutoff
8994 The minimal probability of speculation success (in percents), so that
8995 speculative insn will be scheduled.
8996 The default value is 40.
8998 @item sched-mem-true-dep-cost
8999 Minimal distance (in CPU cycles) between store and load targeting same
9000 memory locations.  The default value is 1.
9002 @item selsched-max-lookahead
9003 The maximum size of the lookahead window of selective scheduling.  It is a
9004 depth of search for available instructions.
9005 The default value is 50.
9007 @item selsched-max-sched-times
9008 The maximum number of times that an instruction will be scheduled during
9009 selective scheduling.  This is the limit on the number of iterations
9010 through which the instruction may be pipelined.  The default value is 2.
9012 @item selsched-max-insns-to-rename
9013 The maximum number of best instructions in the ready list that are considered
9014 for renaming in the selective scheduler.  The default value is 2.
9016 @item sms-min-sc
9017 The minimum value of stage count that swing modulo scheduler will
9018 generate.  The default value is 2.
9020 @item max-last-value-rtl
9021 The maximum size measured as number of RTLs that can be recorded in an expression
9022 in combiner for a pseudo register as last known value of that register.  The default
9023 is 10000.
9025 @item integer-share-limit
9026 Small integer constants can use a shared data structure, reducing the
9027 compiler's memory usage and increasing its speed.  This sets the maximum
9028 value of a shared integer constant.  The default value is 256.
9030 @item min-virtual-mappings
9031 Specifies the minimum number of virtual mappings in the incremental
9032 SSA updater that should be registered to trigger the virtual mappings
9033 heuristic defined by virtual-mappings-ratio.  The default value is
9034 100.
9036 @item virtual-mappings-ratio
9037 If the number of virtual mappings is virtual-mappings-ratio bigger
9038 than the number of virtual symbols to be updated, then the incremental
9039 SSA updater switches to a full update for those symbols.  The default
9040 ratio is 3.
9042 @item ssp-buffer-size
9043 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
9044 protection when @option{-fstack-protection} is used.
9046 @item max-jump-thread-duplication-stmts
9047 Maximum number of statements allowed in a block that needs to be
9048 duplicated when threading jumps.
9050 @item max-fields-for-field-sensitive
9051 Maximum number of fields in a structure we will treat in
9052 a field sensitive manner during pointer analysis.  The default is zero
9053 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
9055 @item prefetch-latency
9056 Estimate on average number of instructions that are executed before
9057 prefetch finishes.  The distance we prefetch ahead is proportional
9058 to this constant.  Increasing this number may also lead to less
9059 streams being prefetched (see @option{simultaneous-prefetches}).
9061 @item simultaneous-prefetches
9062 Maximum number of prefetches that can run at the same time.
9064 @item l1-cache-line-size
9065 The size of cache line in L1 cache, in bytes.
9067 @item l1-cache-size
9068 The size of L1 cache, in kilobytes.
9070 @item l2-cache-size
9071 The size of L2 cache, in kilobytes.
9073 @item min-insn-to-prefetch-ratio
9074 The minimum ratio between the number of instructions and the
9075 number of prefetches to enable prefetching in a loop.
9077 @item prefetch-min-insn-to-mem-ratio
9078 The minimum ratio between the number of instructions and the
9079 number of memory references to enable prefetching in a loop.
9081 @item use-canonical-types
9082 Whether the compiler should use the ``canonical'' type system.  By
9083 default, this should always be 1, which uses a more efficient internal
9084 mechanism for comparing types in C++ and Objective-C++.  However, if
9085 bugs in the canonical type system are causing compilation failures,
9086 set this value to 0 to disable canonical types.
9088 @item switch-conversion-max-branch-ratio
9089 Switch initialization conversion will refuse to create arrays that are
9090 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9091 branches in the switch.
9093 @item max-partial-antic-length
9094 Maximum length of the partial antic set computed during the tree
9095 partial redundancy elimination optimization (@option{-ftree-pre}) when
9096 optimizing at @option{-O3} and above.  For some sorts of source code
9097 the enhanced partial redundancy elimination optimization can run away,
9098 consuming all of the memory available on the host machine.  This
9099 parameter sets a limit on the length of the sets that are computed,
9100 which prevents the runaway behavior.  Setting a value of 0 for
9101 this parameter will allow an unlimited set length.
9103 @item sccvn-max-scc-size
9104 Maximum size of a strongly connected component (SCC) during SCCVN
9105 processing.  If this limit is hit, SCCVN processing for the whole
9106 function will not be done and optimizations depending on it will
9107 be disabled.  The default maximum SCC size is 10000.
9109 @item ira-max-loops-num
9110 IRA uses regional register allocation by default.  If a function
9111 contains more loops than the number given by this parameter, only at most
9112 the given number of the most frequently-executed loops form regions
9113 for regional register allocation.  The default value of the
9114 parameter is 100.
9116 @item ira-max-conflict-table-size 
9117 Although IRA uses a sophisticated algorithm to compress the conflict
9118 table, the table can still require excessive amounts of memory for
9119 huge functions.  If the conflict table for a function could be more
9120 than the size in MB given by this parameter, the register allocator
9121 instead uses a faster, simpler, and lower-quality
9122 algorithm that does not require building a pseudo-register conflict table.  
9123 The default value of the parameter is 2000.
9125 @item ira-loop-reserved-regs
9126 IRA can be used to evaluate more accurate register pressure in loops
9127 for decisions to move loop invariants (see @option{-O3}).  The number
9128 of available registers reserved for some other purposes is given
9129 by this parameter.  The default value of the parameter is 2, which is
9130 the minimal number of registers needed by typical instructions.
9131 This value is the best found from numerous experiments.
9133 @item loop-invariant-max-bbs-in-loop
9134 Loop invariant motion can be very expensive, both in compilation time and
9135 in amount of needed compile-time memory, with very large loops.  Loops
9136 with more basic blocks than this parameter won't have loop invariant
9137 motion optimization performed on them.  The default value of the
9138 parameter is 1000 for -O1 and 10000 for -O2 and above.
9140 @item loop-max-datarefs-for-datadeps
9141 Building data dapendencies is expensive for very large loops.  This
9142 parameter limits the number of data references in loops that are
9143 considered for data dependence analysis.  These large loops will not
9144 be handled then by the optimizations using loop data dependencies.
9145 The default value is 1000.
9147 @item max-vartrack-size
9148 Sets a maximum number of hash table slots to use during variable
9149 tracking dataflow analysis of any function.  If this limit is exceeded
9150 with variable tracking at assignments enabled, analysis for that
9151 function is retried without it, after removing all debug insns from
9152 the function.  If the limit is exceeded even without debug insns, var
9153 tracking analysis is completely disabled for the function.  Setting
9154 the parameter to zero makes it unlimited.
9156 @item max-vartrack-expr-depth
9157 Sets a maximum number of recursion levels when attempting to map
9158 variable names or debug temporaries to value expressions.  This trades
9159 compilation time for more complete debug information.  If this is set too
9160 low, value expressions that are available and could be represented in
9161 debug information may end up not being used; setting this higher may
9162 enable the compiler to find more complex debug expressions, but compile
9163 time and memory use may grow.  The default is 12.
9165 @item min-nondebug-insn-uid
9166 Use uids starting at this parameter for nondebug insns.  The range below
9167 the parameter is reserved exclusively for debug insns created by
9168 @option{-fvar-tracking-assignments}, but debug insns may get
9169 (non-overlapping) uids above it if the reserved range is exhausted.
9171 @item ipa-sra-ptr-growth-factor
9172 IPA-SRA will replace a pointer to an aggregate with one or more new
9173 parameters only when their cumulative size is less or equal to
9174 @option{ipa-sra-ptr-growth-factor} times the size of the original
9175 pointer parameter.
9177 @item tm-max-aggregate-size
9178 When making copies of thread-local variables in a transaction, this
9179 parameter specifies the size in bytes after which variables will be
9180 saved with the logging functions as opposed to save/restore code
9181 sequence pairs.  This option only applies when using
9182 @option{-fgnu-tm}.
9184 @item graphite-max-nb-scop-params
9185 To avoid exponential effects in the Graphite loop transforms, the
9186 number of parameters in a Static Control Part (SCoP) is bounded.  The
9187 default value is 10 parameters.  A variable whose value is unknown at
9188 compilation time and defined outside a SCoP is a parameter of the SCoP.
9190 @item graphite-max-bbs-per-function
9191 To avoid exponential effects in the detection of SCoPs, the size of
9192 the functions analyzed by Graphite is bounded.  The default value is
9193 100 basic blocks.
9195 @item loop-block-tile-size
9196 Loop blocking or strip mining transforms, enabled with
9197 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9198 loop in the loop nest by a given number of iterations.  The strip
9199 length can be changed using the @option{loop-block-tile-size}
9200 parameter.  The default value is 51 iterations.
9202 @item ipa-cp-value-list-size
9203 IPA-CP attempts to track all possible values and types passed to a function's
9204 parameter in order to propagate them and perform devirtualization.
9205 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9206 stores per one formal parameter of a function.
9208 @item lto-partitions
9209 Specify desired number of partitions produced during WHOPR compilation.
9210 The number of partitions should exceed the number of CPUs used for compilation.
9211 The default value is 32.
9213 @item lto-minpartition
9214 Size of minimal partition for WHOPR (in estimated instructions).
9215 This prevents expenses of splitting very small programs into too many
9216 partitions.
9218 @item cxx-max-namespaces-for-diagnostic-help
9219 The maximum number of namespaces to consult for suggestions when C++
9220 name lookup fails for an identifier.  The default is 1000.
9222 @item sink-frequency-threshold
9223 The maximum relative execution frequency (in percents) of the target block
9224 relative to a statement's original block to allow statement sinking of a
9225 statement.  Larger numbers result in more aggressive statement sinking.
9226 The default value is 75.  A small positive adjustment is applied for
9227 statements with memory operands as those are even more profitable so sink.
9229 @item max-stores-to-sink
9230 The maximum number of conditional stores paires that can be sunk.  Set to 0
9231 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9232 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9234 @item allow-load-data-races
9235 Allow optimizers to introduce new data races on loads.
9236 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9237 unless implicitly set by the @option{-fmemory-model=} option.
9239 @item allow-store-data-races
9240 Allow optimizers to introduce new data races on stores.
9241 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9242 unless implicitly set by the @option{-fmemory-model=} option.
9244 @item allow-packed-load-data-races
9245 Allow optimizers to introduce new data races on packed data loads.
9246 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9247 unless implicitly set by the @option{-fmemory-model=} option.
9249 @item allow-packed-store-data-races
9250 Allow optimizers to introduce new data races on packed data stores.
9251 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9252 unless implicitly set by the @option{-fmemory-model=} option.
9254 @item case-values-threshold
9255 The smallest number of different values for which it is best to use a
9256 jump-table instead of a tree of conditional branches.  If the value is
9257 0, use the default for the machine.  The default is 0.
9259 @item tree-reassoc-width
9260 Set the maximum number of instructions executed in parallel in
9261 reassociated tree. This parameter overrides target dependent
9262 heuristics used by default if has non zero value.
9264 @end table
9265 @end table
9267 @node Preprocessor Options
9268 @section Options Controlling the Preprocessor
9269 @cindex preprocessor options
9270 @cindex options, preprocessor
9272 These options control the C preprocessor, which is run on each C source
9273 file before actual compilation.
9275 If you use the @option{-E} option, nothing is done except preprocessing.
9276 Some of these options make sense only together with @option{-E} because
9277 they cause the preprocessor output to be unsuitable for actual
9278 compilation.
9280 @table @gcctabopt
9281 @item -Wp,@var{option}
9282 @opindex Wp
9283 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9284 and pass @var{option} directly through to the preprocessor.  If
9285 @var{option} contains commas, it is split into multiple options at the
9286 commas.  However, many options are modified, translated or interpreted
9287 by the compiler driver before being passed to the preprocessor, and
9288 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9289 interface is undocumented and subject to change, so whenever possible
9290 you should avoid using @option{-Wp} and let the driver handle the
9291 options instead.
9293 @item -Xpreprocessor @var{option}
9294 @opindex Xpreprocessor
9295 Pass @var{option} as an option to the preprocessor.  You can use this to
9296 supply system-specific preprocessor options that GCC does not know how to
9297 recognize.
9299 If you want to pass an option that takes an argument, you must use
9300 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9302 @item -no-integrated-cpp
9303 @opindex no-integrated-cpp
9304 Perform preprocessing as a separate pass before compilation.
9305 By default, GCC performs preprocessing as an integrated part of
9306 input tokenization and parsing.
9307 If this option is provided, the appropriate language front end
9308 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9309 and Objective-C, respectively) is instead invoked twice,
9310 once for preprocessing only and once for actual compilation
9311 of the preprocessed input.
9312 This option may be useful in conjunction with the @option{-B} or
9313 @option{-wrapper} options to specify an alternate preprocessor or
9314 perform additional processing of the program source between
9315 normal preprocessing and compilation.
9316 @end table
9318 @include cppopts.texi
9320 @node Assembler Options
9321 @section Passing Options to the Assembler
9323 @c prevent bad page break with this line
9324 You can pass options to the assembler.
9326 @table @gcctabopt
9327 @item -Wa,@var{option}
9328 @opindex Wa
9329 Pass @var{option} as an option to the assembler.  If @var{option}
9330 contains commas, it is split into multiple options at the commas.
9332 @item -Xassembler @var{option}
9333 @opindex Xassembler
9334 Pass @var{option} as an option to the assembler.  You can use this to
9335 supply system-specific assembler options that GCC does not know how to
9336 recognize.
9338 If you want to pass an option that takes an argument, you must use
9339 @option{-Xassembler} twice, once for the option and once for the argument.
9341 @end table
9343 @node Link Options
9344 @section Options for Linking
9345 @cindex link options
9346 @cindex options, linking
9348 These options come into play when the compiler links object files into
9349 an executable output file.  They are meaningless if the compiler is
9350 not doing a link step.
9352 @table @gcctabopt
9353 @cindex file names
9354 @item @var{object-file-name}
9355 A file name that does not end in a special recognized suffix is
9356 considered to name an object file or library.  (Object files are
9357 distinguished from libraries by the linker according to the file
9358 contents.)  If linking is done, these object files are used as input
9359 to the linker.
9361 @item -c
9362 @itemx -S
9363 @itemx -E
9364 @opindex c
9365 @opindex S
9366 @opindex E
9367 If any of these options is used, then the linker is not run, and
9368 object file names should not be used as arguments.  @xref{Overall
9369 Options}.
9371 @cindex Libraries
9372 @item -l@var{library}
9373 @itemx -l @var{library}
9374 @opindex l
9375 Search the library named @var{library} when linking.  (The second
9376 alternative with the library as a separate argument is only for
9377 POSIX compliance and is not recommended.)
9379 It makes a difference where in the command you write this option; the
9380 linker searches and processes libraries and object files in the order they
9381 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9382 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9383 to functions in @samp{z}, those functions may not be loaded.
9385 The linker searches a standard list of directories for the library,
9386 which is actually a file named @file{lib@var{library}.a}.  The linker
9387 then uses this file as if it had been specified precisely by name.
9389 The directories searched include several standard system directories
9390 plus any that you specify with @option{-L}.
9392 Normally the files found this way are library files---archive files
9393 whose members are object files.  The linker handles an archive file by
9394 scanning through it for members which define symbols that have so far
9395 been referenced but not defined.  But if the file that is found is an
9396 ordinary object file, it is linked in the usual fashion.  The only
9397 difference between using an @option{-l} option and specifying a file name
9398 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9399 and searches several directories.
9401 @item -lobjc
9402 @opindex lobjc
9403 You need this special case of the @option{-l} option in order to
9404 link an Objective-C or Objective-C++ program.
9406 @item -nostartfiles
9407 @opindex nostartfiles
9408 Do not use the standard system startup files when linking.
9409 The standard system libraries are used normally, unless @option{-nostdlib}
9410 or @option{-nodefaultlibs} is used.
9412 @item -nodefaultlibs
9413 @opindex nodefaultlibs
9414 Do not use the standard system libraries when linking.
9415 Only the libraries you specify will be passed to the linker, options
9416 specifying linkage of the system libraries, such as @code{-static-libgcc}
9417 or @code{-shared-libgcc}, will be ignored.
9418 The standard startup files are used normally, unless @option{-nostartfiles}
9419 is used.  The compiler may generate calls to @code{memcmp},
9420 @code{memset}, @code{memcpy} and @code{memmove}.
9421 These entries are usually resolved by entries in
9422 libc.  These entry points should be supplied through some other
9423 mechanism when this option is specified.
9425 @item -nostdlib
9426 @opindex nostdlib
9427 Do not use the standard system startup files or libraries when linking.
9428 No startup files and only the libraries you specify will be passed to
9429 the linker, options specifying linkage of the system libraries, such as
9430 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
9431 The compiler may generate calls to @code{memcmp}, @code{memset},
9432 @code{memcpy} and @code{memmove}.
9433 These entries are usually resolved by entries in
9434 libc.  These entry points should be supplied through some other
9435 mechanism when this option is specified.
9437 @cindex @option{-lgcc}, use with @option{-nostdlib}
9438 @cindex @option{-nostdlib} and unresolved references
9439 @cindex unresolved references and @option{-nostdlib}
9440 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9441 @cindex @option{-nodefaultlibs} and unresolved references
9442 @cindex unresolved references and @option{-nodefaultlibs}
9443 One of the standard libraries bypassed by @option{-nostdlib} and
9444 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9445 which GCC uses to overcome shortcomings of particular machines, or special
9446 needs for some languages.
9447 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9448 Collection (GCC) Internals},
9449 for more discussion of @file{libgcc.a}.)
9450 In most cases, you need @file{libgcc.a} even when you want to avoid
9451 other standard libraries.  In other words, when you specify @option{-nostdlib}
9452 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9453 This ensures that you have no unresolved references to internal GCC
9454 library subroutines.  (For example, @samp{__main}, used to ensure C++
9455 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
9456 GNU Compiler Collection (GCC) Internals}.)
9458 @item -pie
9459 @opindex pie
9460 Produce a position independent executable on targets that support it.
9461 For predictable results, you must also specify the same set of options
9462 that were used to generate code (@option{-fpie}, @option{-fPIE},
9463 or model suboptions) when you specify this option.
9465 @item -rdynamic
9466 @opindex rdynamic
9467 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9468 that support it. This instructs the linker to add all symbols, not
9469 only used ones, to the dynamic symbol table. This option is needed
9470 for some uses of @code{dlopen} or to allow obtaining backtraces
9471 from within a program.
9473 @item -s
9474 @opindex s
9475 Remove all symbol table and relocation information from the executable.
9477 @item -static
9478 @opindex static
9479 On systems that support dynamic linking, this prevents linking with the shared
9480 libraries.  On other systems, this option has no effect.
9482 @item -shared
9483 @opindex shared
9484 Produce a shared object which can then be linked with other objects to
9485 form an executable.  Not all systems support this option.  For predictable
9486 results, you must also specify the same set of options that were used to
9487 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
9488 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
9489 needs to build supplementary stub code for constructors to work.  On
9490 multi-libbed systems, @samp{gcc -shared} must select the correct support
9491 libraries to link against.  Failing to supply the correct flags may lead
9492 to subtle defects.  Supplying them in cases where they are not necessary
9493 is innocuous.}
9495 @item -shared-libgcc
9496 @itemx -static-libgcc
9497 @opindex shared-libgcc
9498 @opindex static-libgcc
9499 On systems that provide @file{libgcc} as a shared library, these options
9500 force the use of either the shared or static version respectively.
9501 If no shared version of @file{libgcc} was built when the compiler was
9502 configured, these options have no effect.
9504 There are several situations in which an application should use the
9505 shared @file{libgcc} instead of the static version.  The most common
9506 of these is when the application wishes to throw and catch exceptions
9507 across different shared libraries.  In that case, each of the libraries
9508 as well as the application itself should use the shared @file{libgcc}.
9510 Therefore, the G++ and GCJ drivers automatically add
9511 @option{-shared-libgcc} whenever you build a shared library or a main
9512 executable, because C++ and Java programs typically use exceptions, so
9513 this is the right thing to do.
9515 If, instead, you use the GCC driver to create shared libraries, you may
9516 find that they will not always be linked with the shared @file{libgcc}.
9517 If GCC finds, at its configuration time, that you have a non-GNU linker
9518 or a GNU linker that does not support option @option{--eh-frame-hdr},
9519 it will link the shared version of @file{libgcc} into shared libraries
9520 by default.  Otherwise, it will take advantage of the linker and optimize
9521 away the linking with the shared version of @file{libgcc}, linking with
9522 the static version of libgcc by default.  This allows exceptions to
9523 propagate through such shared libraries, without incurring relocation
9524 costs at library load time.
9526 However, if a library or main executable is supposed to throw or catch
9527 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9528 for the languages used in the program, or using the option
9529 @option{-shared-libgcc}, such that it is linked with the shared
9530 @file{libgcc}.
9532 @item -static-libstdc++
9533 When the @command{g++} program is used to link a C++ program, it will
9534 normally automatically link against @option{libstdc++}.  If
9535 @file{libstdc++} is available as a shared library, and the
9536 @option{-static} option is not used, then this will link against the
9537 shared version of @file{libstdc++}.  That is normally fine.  However, it
9538 is sometimes useful to freeze the version of @file{libstdc++} used by
9539 the program without going all the way to a fully static link.  The
9540 @option{-static-libstdc++} option directs the @command{g++} driver to
9541 link @file{libstdc++} statically, without necessarily linking other
9542 libraries statically.
9544 @item -symbolic
9545 @opindex symbolic
9546 Bind references to global symbols when building a shared object.  Warn
9547 about any unresolved references (unless overridden by the link editor
9548 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
9549 this option.
9551 @item -T @var{script}
9552 @opindex T
9553 @cindex linker script
9554 Use @var{script} as the linker script.  This option is supported by most
9555 systems using the GNU linker.  On some targets, such as bare-board
9556 targets without an operating system, the @option{-T} option may be required
9557 when linking to avoid references to undefined symbols.
9559 @item -Xlinker @var{option}
9560 @opindex Xlinker
9561 Pass @var{option} as an option to the linker.  You can use this to
9562 supply system-specific linker options that GCC does not recognize.
9564 If you want to pass an option that takes a separate argument, you must use
9565 @option{-Xlinker} twice, once for the option and once for the argument.
9566 For example, to pass @option{-assert definitions}, you must write
9567 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9568 @option{-Xlinker "-assert definitions"}, because this passes the entire
9569 string as a single argument, which is not what the linker expects.
9571 When using the GNU linker, it is usually more convenient to pass
9572 arguments to linker options using the @option{@var{option}=@var{value}}
9573 syntax than as separate arguments.  For example, you can specify
9574 @samp{-Xlinker -Map=output.map} rather than
9575 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9576 this syntax for command-line options.
9578 @item -Wl,@var{option}
9579 @opindex Wl
9580 Pass @var{option} as an option to the linker.  If @var{option} contains
9581 commas, it is split into multiple options at the commas.  You can use this
9582 syntax to pass an argument to the option.
9583 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
9584 linker.  When using the GNU linker, you can also get the same effect with
9585 @samp{-Wl,-Map=output.map}.
9587 @item -u @var{symbol}
9588 @opindex u
9589 Pretend the symbol @var{symbol} is undefined, to force linking of
9590 library modules to define it.  You can use @option{-u} multiple times with
9591 different symbols to force loading of additional library modules.
9592 @end table
9594 @node Directory Options
9595 @section Options for Directory Search
9596 @cindex directory options
9597 @cindex options, directory search
9598 @cindex search path
9600 These options specify directories to search for header files, for
9601 libraries and for parts of the compiler:
9603 @table @gcctabopt
9604 @item -I@var{dir}
9605 @opindex I
9606 Add the directory @var{dir} to the head of the list of directories to be
9607 searched for header files.  This can be used to override a system header
9608 file, substituting your own version, since these directories are
9609 searched before the system header file directories.  However, you should
9610 not use this option to add directories that contain vendor-supplied
9611 system header files (use @option{-isystem} for that).  If you use more than
9612 one @option{-I} option, the directories are scanned in left-to-right
9613 order; the standard system directories come after.
9615 If a standard system include directory, or a directory specified with
9616 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9617 option will be ignored.  The directory will still be searched but as a
9618 system directory at its normal position in the system include chain.
9619 This is to ensure that GCC's procedure to fix buggy system headers and
9620 the ordering for the include_next directive are not inadvertently changed.
9621 If you really need to change the search order for system directories,
9622 use the @option{-nostdinc} and/or @option{-isystem} options.
9624 @item -iplugindir=@var{dir}
9625 Set the directory to search for plugins that are passed
9626 by @option{-fplugin=@var{name}} instead of
9627 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
9628 to be used by the user, but only passed by the driver.
9630 @item -iquote@var{dir}
9631 @opindex iquote
9632 Add the directory @var{dir} to the head of the list of directories to
9633 be searched for header files only for the case of @samp{#include
9634 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9635 otherwise just like @option{-I}.
9637 @item -L@var{dir}
9638 @opindex L
9639 Add directory @var{dir} to the list of directories to be searched
9640 for @option{-l}.
9642 @item -B@var{prefix}
9643 @opindex B
9644 This option specifies where to find the executables, libraries,
9645 include files, and data files of the compiler itself.
9647 The compiler driver program runs one or more of the subprograms
9648 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
9649 @var{prefix} as a prefix for each program it tries to run, both with and
9650 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9652 For each subprogram to be run, the compiler driver first tries the
9653 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9654 was not specified, the driver tries two standard prefixes, 
9655 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9656 those results in a file name that is found, the unmodified program
9657 name is searched for using the directories specified in your
9658 @env{PATH} environment variable.
9660 The compiler will check to see if the path provided by the @option{-B}
9661 refers to a directory, and if necessary it will add a directory
9662 separator character at the end of the path.
9664 @option{-B} prefixes that effectively specify directory names also apply
9665 to libraries in the linker, because the compiler translates these
9666 options into @option{-L} options for the linker.  They also apply to
9667 includes files in the preprocessor, because the compiler translates these
9668 options into @option{-isystem} options for the preprocessor.  In this case,
9669 the compiler appends @samp{include} to the prefix.
9671 The runtime support file @file{libgcc.a} can also be searched for using
9672 the @option{-B} prefix, if needed.  If it is not found there, the two
9673 standard prefixes above are tried, and that is all.  The file is left
9674 out of the link if it is not found by those means.
9676 Another way to specify a prefix much like the @option{-B} prefix is to use
9677 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9678 Variables}.
9680 As a special kludge, if the path provided by @option{-B} is
9681 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9682 9, then it will be replaced by @file{[dir/]include}.  This is to help
9683 with boot-strapping the compiler.
9685 @item -specs=@var{file}
9686 @opindex specs
9687 Process @var{file} after the compiler reads in the standard @file{specs}
9688 file, in order to override the defaults which the @command{gcc} driver
9689 program uses when determining what switches to pass to @command{cc1},
9690 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
9691 @option{-specs=@var{file}} can be specified on the command line, and they
9692 are processed in order, from left to right.
9694 @item --sysroot=@var{dir}
9695 @opindex sysroot
9696 Use @var{dir} as the logical root directory for headers and libraries.
9697 For example, if the compiler would normally search for headers in
9698 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
9699 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9701 If you use both this option and the @option{-isysroot} option, then
9702 the @option{--sysroot} option will apply to libraries, but the
9703 @option{-isysroot} option will apply to header files.
9705 The GNU linker (beginning with version 2.16) has the necessary support
9706 for this option.  If your linker does not support this option, the
9707 header file aspect of @option{--sysroot} will still work, but the
9708 library aspect will not.
9710 @item -I-
9711 @opindex I-
9712 This option has been deprecated.  Please use @option{-iquote} instead for
9713 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9714 Any directories you specify with @option{-I} options before the @option{-I-}
9715 option are searched only for the case of @samp{#include "@var{file}"};
9716 they are not searched for @samp{#include <@var{file}>}.
9718 If additional directories are specified with @option{-I} options after
9719 the @option{-I-}, these directories are searched for all @samp{#include}
9720 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9721 this way.)
9723 In addition, the @option{-I-} option inhibits the use of the current
9724 directory (where the current input file came from) as the first search
9725 directory for @samp{#include "@var{file}"}.  There is no way to
9726 override this effect of @option{-I-}.  With @option{-I.} you can specify
9727 searching the directory that was current when the compiler was
9728 invoked.  That is not exactly the same as what the preprocessor does
9729 by default, but it is often satisfactory.
9731 @option{-I-} does not inhibit the use of the standard system directories
9732 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9733 independent.
9734 @end table
9736 @c man end
9738 @node Spec Files
9739 @section Specifying subprocesses and the switches to pass to them
9740 @cindex Spec Files
9742 @command{gcc} is a driver program.  It performs its job by invoking a
9743 sequence of other programs to do the work of compiling, assembling and
9744 linking.  GCC interprets its command-line parameters and uses these to
9745 deduce which programs it should invoke, and which command-line options
9746 it ought to place on their command lines.  This behavior is controlled
9747 by @dfn{spec strings}.  In most cases there is one spec string for each
9748 program that GCC can invoke, but a few programs have multiple spec
9749 strings to control their behavior.  The spec strings built into GCC can
9750 be overridden by using the @option{-specs=} command-line switch to specify
9751 a spec file.
9753 @dfn{Spec files} are plaintext files that are used to construct spec
9754 strings.  They consist of a sequence of directives separated by blank
9755 lines.  The type of directive is determined by the first non-whitespace
9756 character on the line, which can be one of the following:
9758 @table @code
9759 @item %@var{command}
9760 Issues a @var{command} to the spec file processor.  The commands that can
9761 appear here are:
9763 @table @code
9764 @item %include <@var{file}>
9765 @cindex @code{%include}
9766 Search for @var{file} and insert its text at the current point in the
9767 specs file.
9769 @item %include_noerr <@var{file}>
9770 @cindex @code{%include_noerr}
9771 Just like @samp{%include}, but do not generate an error message if the include
9772 file cannot be found.
9774 @item %rename @var{old_name} @var{new_name}
9775 @cindex @code{%rename}
9776 Rename the spec string @var{old_name} to @var{new_name}.
9778 @end table
9780 @item *[@var{spec_name}]:
9781 This tells the compiler to create, override or delete the named spec
9782 string.  All lines after this directive up to the next directive or
9783 blank line are considered to be the text for the spec string.  If this
9784 results in an empty string then the spec will be deleted.  (Or, if the
9785 spec did not exist, then nothing will happen.)  Otherwise, if the spec
9786 does not currently exist a new spec will be created.  If the spec does
9787 exist then its contents will be overridden by the text of this
9788 directive, unless the first character of that text is the @samp{+}
9789 character, in which case the text will be appended to the spec.
9791 @item [@var{suffix}]:
9792 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9793 and up to the next directive or blank line are considered to make up the
9794 spec string for the indicated suffix.  When the compiler encounters an
9795 input file with the named suffix, it will processes the spec string in
9796 order to work out how to compile that file.  For example:
9798 @smallexample
9799 .ZZ:
9800 z-compile -input %i
9801 @end smallexample
9803 This says that any input file whose name ends in @samp{.ZZ} should be
9804 passed to the program @samp{z-compile}, which should be invoked with the
9805 command-line switch @option{-input} and with the result of performing the
9806 @samp{%i} substitution.  (See below.)
9808 As an alternative to providing a spec string, the text that follows a
9809 suffix directive can be one of the following:
9811 @table @code
9812 @item @@@var{language}
9813 This says that the suffix is an alias for a known @var{language}.  This is
9814 similar to using the @option{-x} command-line switch to GCC to specify a
9815 language explicitly.  For example:
9817 @smallexample
9818 .ZZ:
9819 @@c++
9820 @end smallexample
9822 Says that .ZZ files are, in fact, C++ source files.
9824 @item #@var{name}
9825 This causes an error messages saying:
9827 @smallexample
9828 @var{name} compiler not installed on this system.
9829 @end smallexample
9830 @end table
9832 GCC already has an extensive list of suffixes built into it.
9833 This directive will add an entry to the end of the list of suffixes, but
9834 since the list is searched from the end backwards, it is effectively
9835 possible to override earlier entries using this technique.
9837 @end table
9839 GCC has the following spec strings built into it.  Spec files can
9840 override these strings or create their own.  Note that individual
9841 targets can also add their own spec strings to this list.
9843 @smallexample
9844 asm          Options to pass to the assembler
9845 asm_final    Options to pass to the assembler post-processor
9846 cpp          Options to pass to the C preprocessor
9847 cc1          Options to pass to the C compiler
9848 cc1plus      Options to pass to the C++ compiler
9849 endfile      Object files to include at the end of the link
9850 link         Options to pass to the linker
9851 lib          Libraries to include on the command line to the linker
9852 libgcc       Decides which GCC support library to pass to the linker
9853 linker       Sets the name of the linker
9854 predefines   Defines to be passed to the C preprocessor
9855 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9856              by default
9857 startfile    Object files to include at the start of the link
9858 @end smallexample
9860 Here is a small example of a spec file:
9862 @smallexample
9863 %rename lib                 old_lib
9865 *lib:
9866 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9867 @end smallexample
9869 This example renames the spec called @samp{lib} to @samp{old_lib} and
9870 then overrides the previous definition of @samp{lib} with a new one.
9871 The new definition adds in some extra command-line options before
9872 including the text of the old definition.
9874 @dfn{Spec strings} are a list of command-line options to be passed to their
9875 corresponding program.  In addition, the spec strings can contain
9876 @samp{%}-prefixed sequences to substitute variable text or to
9877 conditionally insert text into the command line.  Using these constructs
9878 it is possible to generate quite complex command lines.
9880 Here is a table of all defined @samp{%}-sequences for spec
9881 strings.  Note that spaces are not generated automatically around the
9882 results of expanding these sequences.  Therefore you can concatenate them
9883 together or combine them with constant text in a single argument.
9885 @table @code
9886 @item %%
9887 Substitute one @samp{%} into the program name or argument.
9889 @item %i
9890 Substitute the name of the input file being processed.
9892 @item %b
9893 Substitute the basename of the input file being processed.
9894 This is the substring up to (and not including) the last period
9895 and not including the directory.
9897 @item %B
9898 This is the same as @samp{%b}, but include the file suffix (text after
9899 the last period).
9901 @item %d
9902 Marks the argument containing or following the @samp{%d} as a
9903 temporary file name, so that that file will be deleted if GCC exits
9904 successfully.  Unlike @samp{%g}, this contributes no text to the
9905 argument.
9907 @item %g@var{suffix}
9908 Substitute a file name that has suffix @var{suffix} and is chosen
9909 once per compilation, and mark the argument in the same way as
9910 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9911 name is now chosen in a way that is hard to predict even when previously
9912 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9913 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9914 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9915 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9916 was simply substituted with a file name chosen once per compilation,
9917 without regard to any appended suffix (which was therefore treated
9918 just like ordinary text), making such attacks more likely to succeed.
9920 @item %u@var{suffix}
9921 Like @samp{%g}, but generates a new temporary file name even if
9922 @samp{%u@var{suffix}} was already seen.
9924 @item %U@var{suffix}
9925 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9926 new one if there is no such last file name.  In the absence of any
9927 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9928 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9929 would involve the generation of two distinct file names, one
9930 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9931 simply substituted with a file name chosen for the previous @samp{%u},
9932 without regard to any appended suffix.
9934 @item %j@var{suffix}
9935 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9936 writable, and if save-temps is off; otherwise, substitute the name
9937 of a temporary file, just like @samp{%u}.  This temporary file is not
9938 meant for communication between processes, but rather as a junk
9939 disposal mechanism.
9941 @item %|@var{suffix}
9942 @itemx %m@var{suffix}
9943 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9944 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9945 all.  These are the two most common ways to instruct a program that it
9946 should read from standard input or write to standard output.  If you
9947 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9948 construct: see for example @file{f/lang-specs.h}.
9950 @item %.@var{SUFFIX}
9951 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9952 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9953 terminated by the next space or %.
9955 @item %w
9956 Marks the argument containing or following the @samp{%w} as the
9957 designated output file of this compilation.  This puts the argument
9958 into the sequence of arguments that @samp{%o} will substitute later.
9960 @item %o
9961 Substitutes the names of all the output files, with spaces
9962 automatically placed around them.  You should write spaces
9963 around the @samp{%o} as well or the results are undefined.
9964 @samp{%o} is for use in the specs for running the linker.
9965 Input files whose names have no recognized suffix are not compiled
9966 at all, but they are included among the output files, so they will
9967 be linked.
9969 @item %O
9970 Substitutes the suffix for object files.  Note that this is
9971 handled specially when it immediately follows @samp{%g, %u, or %U},
9972 because of the need for those to form complete file names.  The
9973 handling is such that @samp{%O} is treated exactly as if it had already
9974 been substituted, except that @samp{%g, %u, and %U} do not currently
9975 support additional @var{suffix} characters following @samp{%O} as they would
9976 following, for example, @samp{.o}.
9978 @item %p
9979 Substitutes the standard macro predefinitions for the
9980 current target machine.  Use this when running @code{cpp}.
9982 @item %P
9983 Like @samp{%p}, but puts @samp{__} before and after the name of each
9984 predefined macro, except for macros that start with @samp{__} or with
9985 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9988 @item %I
9989 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9990 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9991 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9992 and @option{-imultilib} as necessary.
9994 @item %s
9995 Current argument is the name of a library or startup file of some sort.
9996 Search for that file in a standard list of directories and substitute
9997 the full name found.  The current working directory is included in the
9998 list of directories scanned.
10000 @item %T
10001 Current argument is the name of a linker script.  Search for that file
10002 in the current list of directories to scan for libraries. If the file
10003 is located insert a @option{--script} option into the command line
10004 followed by the full path name found.  If the file is not found then
10005 generate an error message.  Note: the current working directory is not
10006 searched.
10008 @item %e@var{str}
10009 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10010 Use this when inconsistent options are detected.
10012 @item %(@var{name})
10013 Substitute the contents of spec string @var{name} at this point.
10015 @item %x@{@var{option}@}
10016 Accumulate an option for @samp{%X}.
10018 @item %X
10019 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10020 spec string.
10022 @item %Y
10023 Output the accumulated assembler options specified by @option{-Wa}.
10025 @item %Z
10026 Output the accumulated preprocessor options specified by @option{-Wp}.
10028 @item %a
10029 Process the @code{asm} spec.  This is used to compute the
10030 switches to be passed to the assembler.
10032 @item %A
10033 Process the @code{asm_final} spec.  This is a spec string for
10034 passing switches to an assembler post-processor, if such a program is
10035 needed.
10037 @item %l
10038 Process the @code{link} spec.  This is the spec for computing the
10039 command line passed to the linker.  Typically it will make use of the
10040 @samp{%L %G %S %D and %E} sequences.
10042 @item %D
10043 Dump out a @option{-L} option for each directory that GCC believes might
10044 contain startup files.  If the target supports multilibs then the
10045 current multilib directory will be prepended to each of these paths.
10047 @item %L
10048 Process the @code{lib} spec.  This is a spec string for deciding which
10049 libraries should be included on the command line to the linker.
10051 @item %G
10052 Process the @code{libgcc} spec.  This is a spec string for deciding
10053 which GCC support library should be included on the command line to the linker.
10055 @item %S
10056 Process the @code{startfile} spec.  This is a spec for deciding which
10057 object files should be the first ones passed to the linker.  Typically
10058 this might be a file named @file{crt0.o}.
10060 @item %E
10061 Process the @code{endfile} spec.  This is a spec string that specifies
10062 the last object files that will be passed to the linker.
10064 @item %C
10065 Process the @code{cpp} spec.  This is used to construct the arguments
10066 to be passed to the C preprocessor.
10068 @item %1
10069 Process the @code{cc1} spec.  This is used to construct the options to be
10070 passed to the actual C compiler (@samp{cc1}).
10072 @item %2
10073 Process the @code{cc1plus} spec.  This is used to construct the options to be
10074 passed to the actual C++ compiler (@samp{cc1plus}).
10076 @item %*
10077 Substitute the variable part of a matched option.  See below.
10078 Note that each comma in the substituted string is replaced by
10079 a single space.
10081 @item %<@code{S}
10082 Remove all occurrences of @code{-S} from the command line.  Note---this
10083 command is position dependent.  @samp{%} commands in the spec string
10084 before this one will see @code{-S}, @samp{%} commands in the spec string
10085 after this one will not.
10087 @item %:@var{function}(@var{args})
10088 Call the named function @var{function}, passing it @var{args}.
10089 @var{args} is first processed as a nested spec string, then split
10090 into an argument vector in the usual fashion.  The function returns
10091 a string which is processed as if it had appeared literally as part
10092 of the current spec.
10094 The following built-in spec functions are provided:
10096 @table @code
10097 @item @code{getenv}
10098 The @code{getenv} spec function takes two arguments: an environment
10099 variable name and a string.  If the environment variable is not
10100 defined, a fatal error is issued.  Otherwise, the return value is the
10101 value of the environment variable concatenated with the string.  For
10102 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10104 @smallexample
10105 %:getenv(TOPDIR /include)
10106 @end smallexample
10108 expands to @file{/path/to/top/include}.
10110 @item @code{if-exists}
10111 The @code{if-exists} spec function takes one argument, an absolute
10112 pathname to a file.  If the file exists, @code{if-exists} returns the
10113 pathname.  Here is a small example of its usage:
10115 @smallexample
10116 *startfile:
10117 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10118 @end smallexample
10120 @item @code{if-exists-else}
10121 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10122 spec function, except that it takes two arguments.  The first argument is
10123 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10124 returns the pathname.  If it does not exist, it returns the second argument.
10125 This way, @code{if-exists-else} can be used to select one file or another,
10126 based on the existence of the first.  Here is a small example of its usage:
10128 @smallexample
10129 *startfile:
10130 crt0%O%s %:if-exists(crti%O%s) \
10131 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10132 @end smallexample
10134 @item @code{replace-outfile}
10135 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10136 first argument in the outfiles array and replaces it with the second argument.  Here
10137 is a small example of its usage:
10139 @smallexample
10140 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10141 @end smallexample
10143 @item @code{remove-outfile}
10144 The @code{remove-outfile} spec function takes one argument.  It looks for the
10145 first argument in the outfiles array and removes it.  Here is a small example
10146 its usage:
10148 @smallexample
10149 %:remove-outfile(-lm)
10150 @end smallexample
10152 @item @code{pass-through-libs}
10153 The @code{pass-through-libs} spec function takes any number of arguments.  It
10154 finds any @option{-l} options and any non-options ending in ".a" (which it
10155 assumes are the names of linker input library archive files) and returns a
10156 result containing all the found arguments each prepended by
10157 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10158 intended to be passed to the LTO linker plugin.
10160 @smallexample
10161 %:pass-through-libs(%G %L %G)
10162 @end smallexample
10164 @item @code{print-asm-header}
10165 The @code{print-asm-header} function takes no arguments and simply
10166 prints a banner like:
10168 @smallexample
10169 Assembler options
10170 =================
10172 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10173 @end smallexample
10175 It is used to separate compiler options from assembler options
10176 in the @option{--target-help} output.
10177 @end table
10179 @item %@{@code{S}@}
10180 Substitutes the @code{-S} switch, if that switch was given to GCC@.
10181 If that switch was not specified, this substitutes nothing.  Note that
10182 the leading dash is omitted when specifying this option, and it is
10183 automatically inserted if the substitution is performed.  Thus the spec
10184 string @samp{%@{foo@}} would match the command-line option @option{-foo}
10185 and would output the command-line option @option{-foo}.
10187 @item %W@{@code{S}@}
10188 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10189 deleted on failure.
10191 @item %@{@code{S}*@}
10192 Substitutes all the switches specified to GCC whose names start
10193 with @code{-S}, but which also take an argument.  This is used for
10194 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10195 GCC considers @option{-o foo} as being
10196 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
10197 text, including the space.  Thus two arguments would be generated.
10199 @item %@{@code{S}*&@code{T}*@}
10200 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10201 (the order of @code{S} and @code{T} in the spec is not significant).
10202 There can be any number of ampersand-separated variables; for each the
10203 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10205 @item %@{@code{S}:@code{X}@}
10206 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
10208 @item %@{!@code{S}:@code{X}@}
10209 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
10211 @item %@{@code{S}*:@code{X}@}
10212 Substitutes @code{X} if one or more switches whose names start with
10213 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10214 once, no matter how many such switches appeared.  However, if @code{%*}
10215 appears somewhere in @code{X}, then @code{X} will be substituted once
10216 for each matching switch, with the @code{%*} replaced by the part of
10217 that switch that matched the @code{*}.
10219 @item %@{.@code{S}:@code{X}@}
10220 Substitutes @code{X}, if processing a file with suffix @code{S}.
10222 @item %@{!.@code{S}:@code{X}@}
10223 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10225 @item %@{,@code{S}:@code{X}@}
10226 Substitutes @code{X}, if processing a file for language @code{S}.
10228 @item %@{!,@code{S}:@code{X}@}
10229 Substitutes @code{X}, if not processing a file for language @code{S}.
10231 @item %@{@code{S}|@code{P}:@code{X}@}
10232 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
10233 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10234 @code{*} sequences as well, although they have a stronger binding than
10235 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10236 alternatives must be starred, and only the first matching alternative
10237 is substituted.
10239 For example, a spec string like this:
10241 @smallexample
10242 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10243 @end smallexample
10245 will output the following command-line options from the following input
10246 command-line options:
10248 @smallexample
10249 fred.c        -foo -baz
10250 jim.d         -bar -boggle
10251 -d fred.c     -foo -baz -boggle
10252 -d jim.d      -bar -baz -boggle
10253 @end smallexample
10255 @item %@{S:X; T:Y; :D@}
10257 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
10258 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10259 be as many clauses as you need.  This may be combined with @code{.},
10260 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10263 @end table
10265 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10266 construct may contain other nested @samp{%} constructs or spaces, or
10267 even newlines.  They are processed as usual, as described above.
10268 Trailing white space in @code{X} is ignored.  White space may also
10269 appear anywhere on the left side of the colon in these constructs,
10270 except between @code{.} or @code{*} and the corresponding word.
10272 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10273 handled specifically in these constructs.  If another value of
10274 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10275 @option{-W} switch is found later in the command line, the earlier
10276 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10277 just one letter, which passes all matching options.
10279 The character @samp{|} at the beginning of the predicate text is used to
10280 indicate that a command should be piped to the following command, but
10281 only if @option{-pipe} is specified.
10283 It is built into GCC which switches take arguments and which do not.
10284 (You might think it would be useful to generalize this to allow each
10285 compiler's spec to say which switches take arguments.  But this cannot
10286 be done in a consistent fashion.  GCC cannot even decide which input
10287 files have been specified without knowing which switches take arguments,
10288 and it must know which input files to compile in order to tell which
10289 compilers to run).
10291 GCC also knows implicitly that arguments starting in @option{-l} are to be
10292 treated as compiler output files, and passed to the linker in their
10293 proper position among the other output files.
10295 @c man begin OPTIONS
10297 @node Target Options
10298 @section Specifying Target Machine and Compiler Version
10299 @cindex target options
10300 @cindex cross compiling
10301 @cindex specifying machine version
10302 @cindex specifying compiler version and target machine
10303 @cindex compiler version, specifying
10304 @cindex target machine, specifying
10306 The usual way to run GCC is to run the executable called @command{gcc}, or
10307 @command{@var{machine}-gcc} when cross-compiling, or
10308 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10309 one that was installed last.
10311 @node Submodel Options
10312 @section Hardware Models and Configurations
10313 @cindex submodel options
10314 @cindex specifying hardware config
10315 @cindex hardware models and configurations, specifying
10316 @cindex machine dependent options
10318 Each target machine types can have its own
10319 special options, starting with @samp{-m}, to choose among various
10320 hardware models or configurations---for example, 68010 vs 68020,
10321 floating coprocessor or none.  A single installed version of the
10322 compiler can compile for any model or configuration, according to the
10323 options specified.
10325 Some configurations of the compiler also support additional special
10326 options, usually for compatibility with other compilers on the same
10327 platform.
10329 @c This list is ordered alphanumerically by subsection name.
10330 @c It should be the same order and spelling as these options are listed
10331 @c in Machine Dependent Options
10333 @menu
10334 * Adapteva Epiphany Options::
10335 * ARM Options::
10336 * AVR Options::
10337 * Blackfin Options::
10338 * C6X Options::
10339 * CRIS Options::
10340 * CR16 Options::
10341 * Darwin Options::
10342 * DEC Alpha Options::
10343 * FR30 Options::
10344 * FRV Options::
10345 * GNU/Linux Options::
10346 * H8/300 Options::
10347 * HPPA Options::
10348 * i386 and x86-64 Options::
10349 * i386 and x86-64 Windows Options::
10350 * IA-64 Options::
10351 * LM32 Options::
10352 * M32C Options::
10353 * M32R/D Options::
10354 * M680x0 Options::
10355 * MCore Options::
10356 * MeP Options::
10357 * MicroBlaze Options::
10358 * MIPS Options::
10359 * MMIX Options::
10360 * MN10300 Options::
10361 * PDP-11 Options::
10362 * picoChip Options::
10363 * PowerPC Options::
10364 * RL78 Options::
10365 * RS/6000 and PowerPC Options::
10366 * RX Options::
10367 * S/390 and zSeries Options::
10368 * Score Options::
10369 * SH Options::
10370 * Solaris 2 Options::
10371 * SPARC Options::
10372 * SPU Options::
10373 * System V Options::
10374 * TILE-Gx Options::
10375 * TILEPro Options::
10376 * V850 Options::
10377 * VAX Options::
10378 * VMS Options::
10379 * VxWorks Options::
10380 * x86-64 Options::
10381 * Xstormy16 Options::
10382 * Xtensa Options::
10383 * zSeries Options::
10384 @end menu
10386 @node Adapteva Epiphany Options
10387 @subsection Adapteva Epiphany Options
10389 These @samp{-m} options are defined for Adapteva Epiphany:
10391 @table @gcctabopt
10392 @item -mhalf-reg-file
10393 @opindex mhalf-reg-file
10394 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
10395 That allows code to run on hardware variants that lack these registers.
10397 @item -mprefer-short-insn-regs
10398 @opindex mprefer-short-insn-regs
10399 Preferrentially allocate registers that allow short instruction generation.
10400 This can result in increasesd instruction count, so if this reduces or
10401 increases code size might vary from case to case.
10403 @item -mbranch-cost=@var{num}
10404 @opindex mbranch-cost
10405 Set the cost of branches to roughly @var{num} ``simple'' instructions.
10406 This cost is only a heuristic and is not guaranteed to produce
10407 consistent results across releases.
10409 @item -mcmove
10410 @opindex mcmove
10411 Enable the generation of conditional moves.
10413 @item -mnops=@var{num}
10414 @opindex mnops
10415 Emit @var{num} nops before every other generated instruction.
10417 @item -mno-soft-cmpsf
10418 @opindex mno-soft-cmpsf
10419 For single-precision floating-point comparisons, emit an fsub instruction
10420 and test the flags.  This is faster than a software comparison, but can
10421 get incorrect results in the presence of NaNs, or when two different small
10422 numbers are compared such that their difference is calculated as zero.
10423 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
10424 software comparisons.
10426 @item -mstack-offset=@var{num}
10427 @opindex mstack-offset
10428 Set the offset between the top of the stack and the stack pointer.
10429 E.g., a value of 8 means that the eight bytes in the range sp+0@dots{}sp+7
10430 can be used by leaf functions without stack allocation.
10431 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
10432 Note also that this option changes the ABI, compiling a program with a
10433 different stack offset than the libraries have been compiled with
10434 will generally not work.
10435 This option can be useful if you want to evaluate if a different stack
10436 offset would give you better code, but to actually use a different stack
10437 offset to build working programs, it is recommended to configure the
10438 toolchain with the appropriate @samp{--with-stack-offset=@var{num}} option.
10440 @item -mno-round-nearest
10441 @opindex mno-round-nearest
10442 Make the scheduler assume that the rounding mode has been set to
10443 truncating.  The default is @option{-mround-nearest}.
10445 @item -mlong-calls
10446 @opindex mlong-calls
10447 If not otherwise specified by an attribute, assume all calls might be beyond
10448 the offset range of the b / bl instructions, and therefore load the
10449 function address into a register before performing a (otherwise direct) call.
10450 This is the default.
10452 @item -mshort-calls
10453 @opindex short-calls
10454 If not otherwise specified by an attribute, assume all direct calls are
10455 in the range of the b / bl instructions, so use these instructions
10456 for direct calls.  The default is @option{-mlong-calls}.
10458 @item -msmall16
10459 @opindex msmall16
10460 Assume addresses can be loaded as 16-bit unsigned values.  This does not
10461 apply to function addresses for which @option{-mlong-calls} semantics
10462 are in effect.
10464 @item -mfp-mode=@var{mode}
10465 @opindex mfp-mode
10466 Set the prevailing mode of the floating-point unit.
10467 This determines the floating-point mode that is provided and expected
10468 at function call and return time.  Making this mode match the mode you
10469 predominantly need at function start can make your programs smaller and
10470 faster by avoiding unnecessary mode switches.
10472 @var{mode} can be set to one the following values:
10474 @table @samp
10475 @item caller
10476 Any mode at function entry is valid, and retained or restored when
10477 the function returns, and when it calls other functions.
10478 This mode is useful for compiling libraries or other compilation units
10479 you might want to incorporate into different programs with different
10480 prevailing FPU modes, and the convenience of being able to use a single
10481 object file outweighs the size and speed overhead for any extra
10482 mode switching that might be needed, compared with what would be needed
10483 with a more specific choice of prevailing FPU mode.
10485 @item truncate
10486 This is the mode used for floating-point calculations with
10487 truncating (i.e.@: round towards zero) rounding mode.  That includes
10488 conversion from floating point to integer.
10490 @item round-nearest
10491 This is the mode used for floating-point calculations with
10492 round-to-nearest-or-even rounding mode.
10494 @item int
10495 This is the mode used to perform integer calculations in the FPU, e.g.@:
10496 integer multiply, or integer multiply-and-accumulate.
10497 @end table
10499 The default is @option{-mfp-mode=caller}
10501 @item -mnosplit-lohi
10502 @opindex mnosplit-lohi
10503 @item -mno-postinc
10504 @opindex mno-postinc
10505 @item -mno-postmodify
10506 @opindex mno-postmodify
10507 Code generation tweaks that disable, respectively, splitting of 32-bit
10508 loads, generation of post-increment addresses, and generation of
10509 post-modify addresses.  The defaults are @option{msplit-lohi},
10510 @option{-mpost-inc}, and @option{-mpost-modify}.
10512 @item -mnovect-double
10513 @opindex mno-vect-double
10514 Change the preferred SIMD mode to SImode.  The default is
10515 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
10517 @item -max-vect-align=@var{num}
10518 @opindex max-vect-align
10519 The maximum alignment for SIMD vector mode types.
10520 @var{num} may be 4 or 8.  The default is 8.
10521 Note that this is an ABI change, even though many library function
10522 interfaces will be unaffected, if they don't use SIMD vector modes
10523 in places where they affect size and/or alignment of relevant types.
10525 @item -msplit-vecmove-early
10526 @opindex msplit-vecmove-early
10527 Split vector moves into single word moves before reload.  In theory this
10528 could give better register allocation, but so far the reverse seems to be
10529 generally the case.
10531 @item -m1reg-@var{reg}
10532 @opindex m1reg-
10533 Specify a register to hold the constant @minus{}1, which makes loading small negative
10534 constants and certain bitmasks faster.
10535 Allowable values for reg are r43 and r63, which specify to use that register
10536 as a fixed register, and none, which means that no register is used for this
10537 purpose.  The default is @option{-m1reg-none}.
10539 @end table
10541 @node ARM Options
10542 @subsection ARM Options
10543 @cindex ARM options
10545 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
10546 architectures:
10548 @table @gcctabopt
10549 @item -mabi=@var{name}
10550 @opindex mabi
10551 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
10552 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
10554 @item -mapcs-frame
10555 @opindex mapcs-frame
10556 Generate a stack frame that is compliant with the ARM Procedure Call
10557 Standard for all functions, even if this is not strictly necessary for
10558 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
10559 with this option will cause the stack frames not to be generated for
10560 leaf functions.  The default is @option{-mno-apcs-frame}.
10562 @item -mapcs
10563 @opindex mapcs
10564 This is a synonym for @option{-mapcs-frame}.
10566 @ignore
10567 @c not currently implemented
10568 @item -mapcs-stack-check
10569 @opindex mapcs-stack-check
10570 Generate code to check the amount of stack space available upon entry to
10571 every function (that actually uses some stack space).  If there is
10572 insufficient space available then either the function
10573 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
10574 called, depending upon the amount of stack space required.  The runtime
10575 system is required to provide these functions.  The default is
10576 @option{-mno-apcs-stack-check}, since this produces smaller code.
10578 @c not currently implemented
10579 @item -mapcs-float
10580 @opindex mapcs-float
10581 Pass floating-point arguments using the floating-point registers.  This is
10582 one of the variants of the APCS@.  This option is recommended if the
10583 target hardware has a floating-point unit or if a lot of floating-point
10584 arithmetic is going to be performed by the code.  The default is
10585 @option{-mno-apcs-float}, since integer only code is slightly increased in
10586 size if @option{-mapcs-float} is used.
10588 @c not currently implemented
10589 @item -mapcs-reentrant
10590 @opindex mapcs-reentrant
10591 Generate reentrant, position independent code.  The default is
10592 @option{-mno-apcs-reentrant}.
10593 @end ignore
10595 @item -mthumb-interwork
10596 @opindex mthumb-interwork
10597 Generate code that supports calling between the ARM and Thumb
10598 instruction sets.  Without this option, on pre-v5 architectures, the
10599 two instruction sets cannot be reliably used inside one program.  The
10600 default is @option{-mno-thumb-interwork}, since slightly larger code
10601 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
10602 configurations this option is meaningless.
10604 @item -mno-sched-prolog
10605 @opindex mno-sched-prolog
10606 Prevent the reordering of instructions in the function prologue, or the
10607 merging of those instruction with the instructions in the function's
10608 body.  This means that all functions will start with a recognizable set
10609 of instructions (or in fact one of a choice from a small set of
10610 different function prologues), and this information can be used to
10611 locate the start if functions inside an executable piece of code.  The
10612 default is @option{-msched-prolog}.
10614 @item -mfloat-abi=@var{name}
10615 @opindex mfloat-abi
10616 Specifies which floating-point ABI to use.  Permissible values
10617 are: @samp{soft}, @samp{softfp} and @samp{hard}.
10619 Specifying @samp{soft} causes GCC to generate output containing
10620 library calls for floating-point operations.
10621 @samp{softfp} allows the generation of code using hardware floating-point
10622 instructions, but still uses the soft-float calling conventions.
10623 @samp{hard} allows generation of floating-point instructions
10624 and uses FPU-specific calling conventions.
10626 The default depends on the specific target configuration.  Note that
10627 the hard-float and soft-float ABIs are not link-compatible; you must
10628 compile your entire program with the same ABI, and link with a
10629 compatible set of libraries.
10631 @item -mlittle-endian
10632 @opindex mlittle-endian
10633 Generate code for a processor running in little-endian mode.  This is
10634 the default for all standard configurations.
10636 @item -mbig-endian
10637 @opindex mbig-endian
10638 Generate code for a processor running in big-endian mode; the default is
10639 to compile code for a little-endian processor.
10641 @item -mwords-little-endian
10642 @opindex mwords-little-endian
10643 This option only applies when generating code for big-endian processors.
10644 Generate code for a little-endian word order but a big-endian byte
10645 order.  That is, a byte order of the form @samp{32107654}.  Note: this
10646 option should only be used if you require compatibility with code for
10647 big-endian ARM processors generated by versions of the compiler prior to
10648 2.8.  This option is now deprecated.
10650 @item -mcpu=@var{name}
10651 @opindex mcpu
10652 This specifies the name of the target ARM processor.  GCC uses this name
10653 to determine what kind of instructions it can emit when generating
10654 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
10655 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10656 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10657 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10658 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10659 @samp{arm720},
10660 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10661 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10662 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10663 @samp{strongarm1110},
10664 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10665 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10666 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10667 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10668 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10669 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10670 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10671 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
10672 @samp{cortex-a15}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
10673 @samp{cortex-m4}, @samp{cortex-m3},
10674 @samp{cortex-m1},
10675 @samp{cortex-m0},
10676 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
10677 @samp{fa526}, @samp{fa626},
10678 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
10681 @option{-mcpu=generic-@var{arch}} is also permissible, and is
10682 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
10683 See @option{-mtune} for more information.
10685 @option{-mcpu=native} causes the compiler to auto-detect the CPU
10686 of the build computer.  At present, this feature is only supported on
10687 Linux, and not all architectures are recognized.  If the auto-detect is
10688 unsuccessful the option has no effect.
10690 @item -mtune=@var{name}
10691 @opindex mtune
10692 This option is very similar to the @option{-mcpu=} option, except that
10693 instead of specifying the actual target processor type, and hence
10694 restricting which instructions can be used, it specifies that GCC should
10695 tune the performance of the code as if the target were of the type
10696 specified in this option, but still choosing the instructions that it
10697 will generate based on the CPU specified by a @option{-mcpu=} option.
10698 For some ARM implementations better performance can be obtained by using
10699 this option.
10701 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
10702 performance for a blend of processors within architecture @var{arch}.
10703 The aim is to generate code that run well on the current most popular
10704 processors, balancing between optimizations that benefit some CPUs in the
10705 range, and avoiding performance pitfalls of other CPUs.  The effects of
10706 this option may change in future GCC versions as CPU models come and go.
10708 @option{-mtune=native} causes the compiler to auto-detect the CPU
10709 of the build computer.  At present, this feature is only supported on
10710 Linux, and not all architectures are recognized.  If the auto-detect is
10711 unsuccessful the option has no effect.
10713 @item -march=@var{name}
10714 @opindex march
10715 This specifies the name of the target ARM architecture.  GCC uses this
10716 name to determine what kind of instructions it can emit when generating
10717 assembly code.  This option can be used in conjunction with or instead
10718 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
10719 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10720 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10721 @samp{armv6}, @samp{armv6j},
10722 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10723 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10724 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10726 @option{-march=native} causes the compiler to auto-detect the architecture
10727 of the build computer.  At present, this feature is only supported on
10728 Linux, and not all architectures are recognized.  If the auto-detect is
10729 unsuccessful the option has no effect.
10731 @item -mfpu=@var{name}
10732 @itemx -mfpe=@var{number}
10733 @itemx -mfp=@var{number}
10734 @opindex mfpu
10735 @opindex mfpe
10736 @opindex mfp
10737 This specifies what floating-point hardware (or hardware emulation) is
10738 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
10739 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
10740 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
10741 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
10742 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10743 @option{-mfp} and @option{-mfpe} are synonyms for
10744 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
10745 of GCC@.
10747 If @option{-msoft-float} is specified this specifies the format of
10748 floating-point values.
10750 If the selected floating-point hardware includes the NEON extension
10751 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10752 operations will not be used by GCC's auto-vectorization pass unless
10753 @option{-funsafe-math-optimizations} is also specified.  This is
10754 because NEON hardware does not fully implement the IEEE 754 standard for
10755 floating-point arithmetic (in particular denormal values are treated as
10756 zero), so the use of NEON instructions may lead to a loss of precision.
10758 @item -mfp16-format=@var{name}
10759 @opindex mfp16-format
10760 Specify the format of the @code{__fp16} half-precision floating-point type.
10761 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10762 the default is @samp{none}, in which case the @code{__fp16} type is not
10763 defined.  @xref{Half-Precision}, for more information.
10765 @item -mstructure-size-boundary=@var{n}
10766 @opindex mstructure-size-boundary
10767 The size of all structures and unions will be rounded up to a multiple
10768 of the number of bits set by this option.  Permissible values are 8, 32
10769 and 64.  The default value varies for different toolchains.  For the COFF
10770 targeted toolchain the default value is 8.  A value of 64 is only allowed
10771 if the underlying ABI supports it.
10773 Specifying the larger number can produce faster, more efficient code, but
10774 can also increase the size of the program.  Different values are potentially
10775 incompatible.  Code compiled with one value cannot necessarily expect to
10776 work with code or libraries compiled with another value, if they exchange
10777 information using structures or unions.
10779 @item -mabort-on-noreturn
10780 @opindex mabort-on-noreturn
10781 Generate a call to the function @code{abort} at the end of a
10782 @code{noreturn} function.  It will be executed if the function tries to
10783 return.
10785 @item -mlong-calls
10786 @itemx -mno-long-calls
10787 @opindex mlong-calls
10788 @opindex mno-long-calls
10789 Tells the compiler to perform function calls by first loading the
10790 address of the function into a register and then performing a subroutine
10791 call on this register.  This switch is needed if the target function
10792 will lie outside of the 64 megabyte addressing range of the offset based
10793 version of subroutine call instruction.
10795 Even if this switch is enabled, not all function calls will be turned
10796 into long calls.  The heuristic is that static functions, functions
10797 that have the @samp{short-call} attribute, functions that are inside
10798 the scope of a @samp{#pragma no_long_calls} directive and functions whose
10799 definitions have already been compiled within the current compilation
10800 unit, will not be turned into long calls.  The exception to this rule is
10801 that weak function definitions, functions with the @samp{long-call}
10802 attribute or the @samp{section} attribute, and functions that are within
10803 the scope of a @samp{#pragma long_calls} directive, will always be
10804 turned into long calls.
10806 This feature is not enabled by default.  Specifying
10807 @option{-mno-long-calls} will restore the default behavior, as will
10808 placing the function calls within the scope of a @samp{#pragma
10809 long_calls_off} directive.  Note these switches have no effect on how
10810 the compiler generates code to handle function calls via function
10811 pointers.
10813 @item -msingle-pic-base
10814 @opindex msingle-pic-base
10815 Treat the register used for PIC addressing as read-only, rather than
10816 loading it in the prologue for each function.  The runtime system is
10817 responsible for initializing this register with an appropriate value
10818 before execution begins.
10820 @item -mpic-register=@var{reg}
10821 @opindex mpic-register
10822 Specify the register to be used for PIC addressing.  The default is R10
10823 unless stack-checking is enabled, when R9 is used.
10825 @item -mcirrus-fix-invalid-insns
10826 @opindex mcirrus-fix-invalid-insns
10827 @opindex mno-cirrus-fix-invalid-insns
10828 Insert NOPs into the instruction stream to in order to work around
10829 problems with invalid Maverick instruction combinations.  This option
10830 is only valid if the @option{-mcpu=ep9312} option has been used to
10831 enable generation of instructions for the Cirrus Maverick floating-point
10832 co-processor.  This option is not enabled by default, since the
10833 problem is only present in older Maverick implementations.  The default
10834 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10835 switch.
10837 @item -mpoke-function-name
10838 @opindex mpoke-function-name
10839 Write the name of each function into the text section, directly
10840 preceding the function prologue.  The generated code is similar to this:
10842 @smallexample
10843      t0
10844          .ascii "arm_poke_function_name", 0
10845          .align
10846      t1
10847          .word 0xff000000 + (t1 - t0)
10848      arm_poke_function_name
10849          mov     ip, sp
10850          stmfd   sp!, @{fp, ip, lr, pc@}
10851          sub     fp, ip, #4
10852 @end smallexample
10854 When performing a stack backtrace, code can inspect the value of
10855 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10856 location @code{pc - 12} and the top 8 bits are set, then we know that
10857 there is a function name embedded immediately preceding this location
10858 and has length @code{((pc[-3]) & 0xff000000)}.
10860 @item -mthumb
10861 @itemx -marm
10862 @opindex marm
10863 @opindex mthumb
10865 Select between generating code that executes in ARM and Thumb
10866 states.  The default for most configurations is to generate code
10867 that executes in ARM state, but the default can be changed by
10868 configuring GCC with the @option{--with-mode=}@var{state}
10869 configure option.
10871 @item -mtpcs-frame
10872 @opindex mtpcs-frame
10873 Generate a stack frame that is compliant with the Thumb Procedure Call
10874 Standard for all non-leaf functions.  (A leaf function is one that does
10875 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10877 @item -mtpcs-leaf-frame
10878 @opindex mtpcs-leaf-frame
10879 Generate a stack frame that is compliant with the Thumb Procedure Call
10880 Standard for all leaf functions.  (A leaf function is one that does
10881 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10883 @item -mcallee-super-interworking
10884 @opindex mcallee-super-interworking
10885 Gives all externally visible functions in the file being compiled an ARM
10886 instruction set header which switches to Thumb mode before executing the
10887 rest of the function.  This allows these functions to be called from
10888 non-interworking code.  This option is not valid in AAPCS configurations
10889 because interworking is enabled by default.
10891 @item -mcaller-super-interworking
10892 @opindex mcaller-super-interworking
10893 Allows calls via function pointers (including virtual functions) to
10894 execute correctly regardless of whether the target code has been
10895 compiled for interworking or not.  There is a small overhead in the cost
10896 of executing a function pointer if this option is enabled.  This option
10897 is not valid in AAPCS configurations because interworking is enabled
10898 by default.
10900 @item -mtp=@var{name}
10901 @opindex mtp
10902 Specify the access model for the thread local storage pointer.  The valid
10903 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
10904 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
10905 (supported in the arm6k architecture), and @option{auto}, which uses the
10906 best available method for the selected processor.  The default setting is
10907 @option{auto}.
10909 @item -mtls-dialect=@var{dialect}
10910 @opindex mtls-dialect
10911 Specify the dialect to use for accessing thread local storage.  Two
10912 dialects are supported --- @option{gnu} and @option{gnu2}.  The
10913 @option{gnu} dialect selects the original GNU scheme for supporting
10914 local and global dynamic TLS models.  The @option{gnu2} dialect
10915 selects the GNU descriptor scheme, which provides better performance
10916 for shared libraries.  The GNU descriptor scheme is compatible with
10917 the original scheme, but does require new assembler, linker and
10918 library support.  Initial and local exec TLS models are unaffected by
10919 this option and always use the original scheme.
10921 @item -mword-relocations
10922 @opindex mword-relocations
10923 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
10924 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
10925 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
10926 is specified.
10928 @item -mfix-cortex-m3-ldrd
10929 @opindex mfix-cortex-m3-ldrd
10930 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
10931 with overlapping destination and base registers are used.  This option avoids
10932 generating these instructions.  This option is enabled by default when
10933 @option{-mcpu=cortex-m3} is specified.
10935 @end table
10937 @node AVR Options
10938 @subsection AVR Options
10939 @cindex AVR Options
10941 These options are defined for AVR implementations:
10943 @table @gcctabopt
10944 @item -mmcu=@var{mcu}
10945 @opindex mmcu
10946 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
10948 For a complete list of @var{mcu} values that are supported by @command{avr-gcc},
10949 see the compiler output when called with the @code{--help=target}
10950 command line option.
10951 The default for this option is@tie{}@code{avr2}.
10953 GCC supports the following AVR devices and ISAs:
10955 @table @code
10957 @item avr1
10958 This ISA is implemented by the minimal AVR core and supported
10959 for assembler only.
10960 @*@var{mcu}@tie{}= @code{at90s1200},
10961 @code{attiny10}, @code{attiny11}, @code{attiny12}, @code{attiny15},
10962 @code{attiny28}.
10964 @item avr2
10965 ``Classic'' devices with up to 8@tie{}KiB of program memory.
10966 @*@var{mcu}@tie{}= @code{at90s2313}, @code{attiny26}, @code{at90c8534},
10967 @dots{}
10969 @item avr25
10970 ``Classic'' devices with up to 8@tie{}KiB of program memory and with
10971 the @code{MOVW} instruction.
10972 @*@var{mcu}@tie{}= @code{attiny2313}, @code{attiny261}, @code{attiny24},
10973 @dots{}
10975 @item avr3
10976 ``Classic'' devices with 16@tie{}KiB up to 64@tie{}KiB of program memory.
10977 @*@var{mcu}@tie{}= @code{at43usb355}, @code{at76c711}.
10979 @item avr31
10980 ``Classic'' devices with 128@tie{}KiB of program memory.
10981 @*@var{mcu}@tie{}= @code{atmega103}, @code{at43usb320}.
10983 @item avr35
10984 ``Classic'' devices with 16@tie{}KiB up to 64@tie{}KiB of program
10985 memory and with the @code{MOVW} instruction.
10986 @*@var{mcu}@tie{}= @code{at90usb162}, @code{atmega8u2},
10987 @code{attiny167}, @dots{}
10989 @item avr4
10990 ``Enhanced'' devices with up to 8@tie{}KiB of program memory.
10991 @*@var{mcu}@tie{}= @code{atmega8}, @code{atmega88}, @code{at90pwm81},
10992 @dots{}
10994 @item avr5
10995 ``Enhanced'' devices with 16@tie{}KiB up to 64@tie{}KiB of program memory.
10996 @*@var{mcu}@tie{}= @code{atmega16}, @code{atmega6490}, @code{at90can64},
10997 @dots{}
10999 @item avr51
11000 ``Enhanced'' devices with 128@tie{}KiB of program memory.
11001 @*@var{mcu}@tie{}= @code{atmega128}, @code{at90can128}, @code{at90usb1287},
11002 @dots{}
11004 @item avr6
11005 ``Enhanced'' devices with 3-byte PC, i.e.@: with at least 256@tie{}KiB
11006 of program memory.
11007 @*@var{mcu}@tie{}= @code{atmega2560}, @code{atmega2561}.
11009 @item avrxmega2
11010 ``XMEGA'' devices with more than 8@tie{}KiB and up to 64@tie{}KiB
11011 of program memory.
11012 @*@var{mcu}@tie{}= @code{atxmega16a4}, @code{atxmega16d4},
11013 @dots{}
11015 @item avrxmega4
11016 ``XMEGA'' devices with more than 64@tie{}KiB and up to 128@tie{}KiB
11017 of program memory.
11018 @*@var{mcu}@tie{}= @code{atxmega64a3}, @code{atxmega64d3}.
11020 @item avrxmega5
11021 ``XMEGA'' devices with more than 64@tie{}KiB and up to 128@tie{}KiB
11022 of program memory and more than 64@tie{}KiB of RAM.
11023 @*@var{mcu}@tie{}= @code{atxmega64a1}, @code{atxmega64a1u}.
11025 @item avrxmega6
11026 ``XMEGA'' devices with more than 128@tie{}KiB of program memory.
11027 @*@var{mcu}@tie{}= @code{atxmega128a3}, @code{atxmega192d3},
11028 @dots{}
11030 @item avrxmega7
11031 ``XMEGA'' devices with more than 128@tie{}KiB of program memory and
11032 more than 64@tie{}KiB of RAM.
11033 @*@var{mcu}@tie{}= @code{atxmega128a1}, @code{atxmega128a1u}.
11035 @end table
11038 @item -maccumulate-args
11039 @opindex maccumulate-args
11040 Accumulate outgoing function arguments and acquire/release the needed
11041 stack space for outgoing function arguments once in function
11042 prologue/epilogue.  Without this option, outgoing arguments are pushed
11043 before calling a function and popped afterwards.
11045 Popping the arguments after the function call can be expensive on
11046 AVR so that accumulating the stack space might lead to smaller
11047 executables because arguments need not to be removed from the
11048 stack after such a function call.
11050 This option can lead to reduced code size for functions that perform
11051 several calls to functions that get their arguments on the stack like
11052 calls to printf-like functions.
11054 @item -mbranch-cost=@var{cost}
11055 @opindex mbranch-cost
11056 Set the branch costs for conditional branch instructions to
11057 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
11058 integers. The default branch cost is 0.
11060 @item -mcall-prologues
11061 @opindex mcall-prologues
11062 Functions prologues/epilogues expanded as call to appropriate
11063 subroutines.  Code size will be smaller.
11065 @item -mint8
11066 @opindex mint8
11067 Assume int to be 8-bit integer.  This affects the sizes of all types: a
11068 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
11069 and long long will be 4 bytes.  Please note that this option does not
11070 comply to the C standards, but it will provide you with smaller code
11071 size.
11073 @item -mno-interrupts
11074 @opindex mno-interrupts
11075 Generated code is not compatible with hardware interrupts.
11076 Code size will be smaller.
11078 @item -mrelax
11079 @opindex mrelax
11080 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11081 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11082 Setting @code{-mrelax} just adds the @code{--relax} option to the
11083 linker command line when the linker is called.
11085 Jump relaxing is performed by the linker because jump offsets are not
11086 known before code is located. Therefore, the assembler code generated by the
11087 compiler will be the same, but the instructions in the executable may
11088 differ from instructions in the assembler code.
11090 @item -mshort-calls
11091 @opindex mshort-calls
11092 Use @code{RCALL}/@code{RJMP} instructions even on devices with
11093 16@tie{}KiB or more of program memory, i.e.@: on devices that
11094 have the @code{CALL} and @code{JMP} instructions.
11095 See also the @code{-mrelax} command line option.
11097 @item -mstrict-X
11098 @opindex mstrict-X
11099 Use address register @code{X} in a way proposed by the hardware.  This means
11100 that @code{X} will only be used in indirect, post-increment or
11101 pre-decrement addressing.
11103 Without this option, the @code{X} register may be used in the same way
11104 as @code{Y} or @code{Z} which then is emulated by additional
11105 instructions.  
11106 For example, loading a value with @code{X+const} addressing with a
11107 small non-negative @code{const < 64} to a register @var{Rn} will be
11108 performed as
11110 @example
11111 adiw r26, const   ; X += const
11112 ld   @var{Rn}, X        ; @var{Rn} = *X
11113 sbiw r26, const   ; X -= const
11114 @end example
11116 @item -mtiny-stack
11117 @opindex mtiny-stack
11118 Only use the lower 8@tie{}bits of the stack pointer and assume that the high
11119 byte of SP is always zero.
11120 @end table
11122 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11123 @cindex @code{EIND}
11124 Pointers in the implementation are 16@tie{}bits wide.
11125 The address of a function or label is represented as word address so
11126 that indirect jumps and calls can target any code address in the
11127 range of 64@tie{}Ki words.
11129 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11130 bytes of program memory space, there is a special function register called
11131 @code{EIND} that serves as most significant part of the target address
11132 when @code{EICALL} or @code{EIJMP} instructions are used.
11134 Indirect jumps and calls on these devices are handled as follows by
11135 the compiler and are subject to some limitations:
11137 @itemize @bullet
11139 @item
11140 The compiler never sets @code{EIND}.
11142 @item
11143 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11144 instructions or might read @code{EIND} directly in order to emulate an
11145 indirect call/jump by means of a @code{RET} instruction.
11147 @item
11148 The compiler assumes that @code{EIND} never changes during the startup
11149 code or during the application. In particular, @code{EIND} is not
11150 saved/restored in function or interrupt service routine
11151 prologue/epilogue.
11153 @item
11154 For indirect calls to functions and computed goto, the linker will
11155 generate @emph{stubs}. Stubs are jump pads sometimes also called
11156 @emph{trampolines}. Thus, the indirect call/jump will jump to such a stub.
11157 The stub contains a direct jump to the desired address.
11159 @item
11160 The default linker script is arranged for code with @code{EIND = 0}.
11161 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11162 linker script has to be used in order to place the sections whose
11163 name start with @code{.trampolines} into the segment where @code{EIND}
11164 points to.
11166 @item
11167 The startup code from libgcc never sets @code{EIND}.
11168 Notice that startup code is a blend of code from libgcc and AVR-Libc.
11169 For the impact of AVR-Libc on @code{EIND}, see the
11170 @w{@uref{http://nongnu.org/avr-libc/user-manual,AVR-Libc user manual}}.
11172 @item
11173 It is legitimate for user-specific startup code to set up @code{EIND}
11174 early, for example by means of initialization code located in
11175 section @code{.init3}. Such code runs prior to general startup code
11176 that initializes RAM and calls constructors, but after the bit
11177 of startup code from AVR-Libc that sets @code{EIND} to the segment
11178 where the vector table is located.
11179 @example
11180 #include <avr/io.h>
11182 static void
11183 __attribute__ ((section (".init3"), naked, used, no_instrument_function))
11184 init3_set_eind (void)
11186     __asm volatile ("ldi r24, pm_hh8(__trampolines_start)" "\n\t"
11187                     "out %i0, r24" :: "n" (&EIND) : "r24", "memory");
11189 @end example
11191 @noindent
11192 The @code{__trampolines_start} symbol is defined in the linker script.
11194 @item
11195 Stubs will be generated automatically by the linker if
11196 the following two conditions are met:
11197 @itemize @minus
11199 @item The address of a label is taken by means of the @code{gs} modifier
11200 (short for @emph{generate stubs}) like so:
11201 @example
11202 LDI r24, lo8(gs(@var{func}))
11203 LDI r25, hi8(gs(@var{func}))
11204 @end example
11205 @item The final location of that label is in a code segment
11206 @emph{outside} the segment where the stubs are located.
11207 @end itemize
11209 @item
11210 The compiler will emit such @code{gs} modifiers for code labels in the
11211 following situations:
11212 @itemize @minus
11213 @item Taking address of a function or code label.
11214 @item Computed goto.
11215 @item If prologue-save function is used, see @option{-mcall-prologues}
11216 command-line option.
11217 @item Switch/case dispatch tables. If you do not want such dispatch
11218 tables you can specify the @option{-fno-jump-tables} command-line option.
11219 @item C and C++ constructors/destructors called during startup/shutdown.
11220 @item If the tools hit a @code{gs()} modifier explained above.
11221 @end itemize
11223 @item
11224 Jumping to non-symbolic addresses like so is @emph{not} supported:
11226 @example
11227 int main (void)
11229     /* Call function at word address 0x2 */
11230     return ((int(*)(void)) 0x2)();
11232 @end example
11234 Instead, a stub has to be set up, i.e.@: the function has to be called
11235 through a symbol (@code{func_4} in the example):
11237 @example
11238 int main (void)
11240     extern int func_4 (void);
11242     /* Call function at byte address 0x4 */
11243     return func_4();
11245 @end example
11247 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11248 Alternatively, @code{func_4} can be defined in the linker script.
11249 @end itemize
11251 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11252 @cindex @code{RAMPD}
11253 @cindex @code{RAMPX}
11254 @cindex @code{RAMPY}
11255 @cindex @code{RAMPZ}
11256 Some AVR devices support memories larger than the 64@tie{}KiB range
11257 that can be accessed with 16-bit pointers.  To access memory locations
11258 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11259 register is used as high part of the address:
11260 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11261 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11262 register, respectively, to get a wide address. Similarly,
11263 @code{RAMPD} is used together with direct addressing.
11265 @itemize
11266 @item
11267 The startup code initializes the @code{RAMP} special function
11268 registers with zero.
11270 @item
11271 If a @ref{AVR Named Address Spaces,named address space} other than
11272 generic or @code{__flash} is used, then @code{RAMPZ} will be set
11273 as needed before the operation.
11275 @item
11276 If the device supports RAM larger than 64@tie{KiB} and the compiler
11277 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11278 will be reset to zero after the operation.
11280 @item
11281 If the device comes with a specific @code{RAMP} register, the ISR
11282 prologue/epilogue will save/restore that SFR and initialize it with
11283 zero in case the ISR code might (implicitly) use it.
11285 @item
11286 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
11287 If you use inline assembler to read from locations outside the
11288 16-bit address range and change one of the @code{RAMP} registers,
11289 you must reset it to zero after the access.
11291 @end itemize
11293 @subsubsection AVR Built-in Macros
11295 GCC defines several built-in macros so that the user code can test
11296 for the presence or absence of features.  Almost any of the following
11297 built-in macros are deduced from device capabilities and thus
11298 triggered by the @code{-mmcu=} command-line option.
11300 For even more AVR-specific built-in macros see
11301 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
11303 @table @code
11305 @item __AVR_@var{Device}__
11306 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
11307 the device's name. For example, @code{-mmcu=atmega8} will define the
11308 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
11309 @code{__AVR_ATtiny261A__}, etc.
11311 The built-in macros' names follow
11312 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
11313 the device name as from the AVR user manual. The difference between
11314 @var{Device} in the built-in macro and @var{device} in
11315 @code{-mmcu=@var{device}} is that the latter is always lowercase.
11317 @item __AVR_HAVE_ELPM__
11318 The device has the the @code{ELPM} instruction.
11320 @item __AVR_HAVE_ELPMX__
11321 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
11322 R@var{n},Z+} instructions.
11324 @item __AVR_HAVE_MOVW__
11325 The device has the @code{MOVW} instruction to perform 16-bit
11326 register-register moves.
11328 @item __AVR_HAVE_LPMX__
11329 The device has the @code{LPM R@var{n},Z} and @code{LPM
11330 R@var{n},Z+} instructions.
11332 @item __AVR_HAVE_MUL__
11333 The device has a hardware multiplier. 
11335 @item __AVR_HAVE_JMP_CALL__
11336 The device has the @code{JMP} and @code{CALL} instructions.
11337 This is the case for devices with at least 16@tie{}KiB of program
11338 memory and if @code{-mshort-calls} is not set.
11340 @item __AVR_HAVE_EIJMP_EICALL__
11341 @item __AVR_3_BYTE_PC__
11342 The device has the @code{EIJMP} and @code{EICALL} instructions.
11343 This is the case for devices with more than 128@tie{}KiB of program memory.
11344 This also means that the program counter
11345 (PC) is 3@tie{}bytes wide.
11347 @item __AVR_2_BYTE_PC__
11348 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
11349 with up to 128@tie{}KiB of program memory.
11351 @item __AVR_HAVE_8BIT_SP__
11352 @item __AVR_HAVE_16BIT_SP__
11353 The stack pointer (SP) is respectively 8 or 16 bits wide.
11354 The definition of these macros is affected by @code{-mtiny-stack}.
11356 @item __AVR_HAVE_RAMPD__
11357 @item __AVR_HAVE_RAMPX__
11358 @item __AVR_HAVE_RAMPY__
11359 @item __AVR_HAVE_RAMPZ__
11360 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
11361 @code{RAMPZ} special function register, respectively.
11363 @item __NO_INTERRUPTS__
11364 This macro reflects the @code{-mno-interrupts} command line option.
11366 @item __AVR_ERRATA_SKIP__
11367 @item __AVR_ERRATA_SKIP_JMP_CALL__
11368 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
11369 instructions because of a hardware erratum.  Skip instructions are
11370 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
11371 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
11372 set.
11374 @item __AVR_SFR_OFFSET__=@var{offset}
11375 Instructions that can address I/O special function registers directly
11376 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
11377 address as if addressed by an instruction to access RAM like @code{LD}
11378 or @code{STS}. This offset depends on the device architecture and has
11379 to be subtracted from the RAM address in order to get the
11380 respective I/O@tie{}address.
11382 @end table
11384 @node Blackfin Options
11385 @subsection Blackfin Options
11386 @cindex Blackfin Options
11388 @table @gcctabopt
11389 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11390 @opindex mcpu=
11391 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
11392 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11393 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11394 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11395 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11396 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11397 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11398 @samp{bf561}, @samp{bf592}.
11399 The optional @var{sirevision} specifies the silicon revision of the target
11400 Blackfin processor.  Any workarounds available for the targeted silicon revision
11401 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
11402 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
11403 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
11404 hexadecimal digits representing the major and minor numbers in the silicon
11405 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
11406 is not defined.  If @var{sirevision} is @samp{any}, the
11407 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
11408 If this optional @var{sirevision} is not used, GCC assumes the latest known
11409 silicon revision of the targeted Blackfin processor.
11411 Support for @samp{bf561} is incomplete.  For @samp{bf561},
11412 Only the processor macro is defined.
11413 Without this option, @samp{bf532} is used as the processor by default.
11414 The corresponding predefined processor macros for @var{cpu} is to
11415 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
11416 provided by libgloss to be linked in if @option{-msim} is not given.
11418 @item -msim
11419 @opindex msim
11420 Specifies that the program will be run on the simulator.  This causes
11421 the simulator BSP provided by libgloss to be linked in.  This option
11422 has effect only for @samp{bfin-elf} toolchain.
11423 Certain other options, such as @option{-mid-shared-library} and
11424 @option{-mfdpic}, imply @option{-msim}.
11426 @item -momit-leaf-frame-pointer
11427 @opindex momit-leaf-frame-pointer
11428 Don't keep the frame pointer in a register for leaf functions.  This
11429 avoids the instructions to save, set up and restore frame pointers and
11430 makes an extra register available in leaf functions.  The option
11431 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
11432 which might make debugging harder.
11434 @item -mspecld-anomaly
11435 @opindex mspecld-anomaly
11436 When enabled, the compiler will ensure that the generated code does not
11437 contain speculative loads after jump instructions. If this option is used,
11438 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
11440 @item -mno-specld-anomaly
11441 @opindex mno-specld-anomaly
11442 Don't generate extra code to prevent speculative loads from occurring.
11444 @item -mcsync-anomaly
11445 @opindex mcsync-anomaly
11446 When enabled, the compiler will ensure that the generated code does not
11447 contain CSYNC or SSYNC instructions too soon after conditional branches.
11448 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
11450 @item -mno-csync-anomaly
11451 @opindex mno-csync-anomaly
11452 Don't generate extra code to prevent CSYNC or SSYNC instructions from
11453 occurring too soon after a conditional branch.
11455 @item -mlow-64k
11456 @opindex mlow-64k
11457 When enabled, the compiler is free to take advantage of the knowledge that
11458 the entire program fits into the low 64k of memory.
11460 @item -mno-low-64k
11461 @opindex mno-low-64k
11462 Assume that the program is arbitrarily large.  This is the default.
11464 @item -mstack-check-l1
11465 @opindex mstack-check-l1
11466 Do stack checking using information placed into L1 scratchpad memory by the
11467 uClinux kernel.
11469 @item -mid-shared-library
11470 @opindex mid-shared-library
11471 Generate code that supports shared libraries via the library ID method.
11472 This allows for execute in place and shared libraries in an environment
11473 without virtual memory management.  This option implies @option{-fPIC}.
11474 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11476 @item -mno-id-shared-library
11477 @opindex mno-id-shared-library
11478 Generate code that doesn't assume ID based shared libraries are being used.
11479 This is the default.
11481 @item -mleaf-id-shared-library
11482 @opindex mleaf-id-shared-library
11483 Generate code that supports shared libraries via the library ID method,
11484 but assumes that this library or executable won't link against any other
11485 ID shared libraries.  That allows the compiler to use faster code for jumps
11486 and calls.
11488 @item -mno-leaf-id-shared-library
11489 @opindex mno-leaf-id-shared-library
11490 Do not assume that the code being compiled won't link against any ID shared
11491 libraries.  Slower code will be generated for jump and call insns.
11493 @item -mshared-library-id=n
11494 @opindex mshared-library-id
11495 Specified the identification number of the ID based shared library being
11496 compiled.  Specifying a value of 0 will generate more compact code, specifying
11497 other values will force the allocation of that number to the current
11498 library but is no more space or time efficient than omitting this option.
11500 @item -msep-data
11501 @opindex msep-data
11502 Generate code that allows the data segment to be located in a different
11503 area of memory from the text segment.  This allows for execute in place in
11504 an environment without virtual memory management by eliminating relocations
11505 against the text section.
11507 @item -mno-sep-data
11508 @opindex mno-sep-data
11509 Generate code that assumes that the data segment follows the text segment.
11510 This is the default.
11512 @item -mlong-calls
11513 @itemx -mno-long-calls
11514 @opindex mlong-calls
11515 @opindex mno-long-calls
11516 Tells the compiler to perform function calls by first loading the
11517 address of the function into a register and then performing a subroutine
11518 call on this register.  This switch is needed if the target function
11519 lies outside of the 24-bit addressing range of the offset-based
11520 version of subroutine call instruction.
11522 This feature is not enabled by default.  Specifying
11523 @option{-mno-long-calls} will restore the default behavior.  Note these
11524 switches have no effect on how the compiler generates code to handle
11525 function calls via function pointers.
11527 @item -mfast-fp
11528 @opindex mfast-fp
11529 Link with the fast floating-point library. This library relaxes some of
11530 the IEEE floating-point standard's rules for checking inputs against
11531 Not-a-Number (NAN), in the interest of performance.
11533 @item -minline-plt
11534 @opindex minline-plt
11535 Enable inlining of PLT entries in function calls to functions that are
11536 not known to bind locally.  It has no effect without @option{-mfdpic}.
11538 @item -mmulticore
11539 @opindex mmulticore
11540 Build standalone application for multicore Blackfin processor. Proper
11541 start files and link scripts will be used to support multicore.
11542 This option defines @code{__BFIN_MULTICORE}. It can only be used with
11543 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
11544 @option{-mcorea} or @option{-mcoreb}. If it's used without
11545 @option{-mcorea} or @option{-mcoreb}, single application/dual core
11546 programming model is used. In this model, the main function of Core B
11547 should be named as coreb_main. If it's used with @option{-mcorea} or
11548 @option{-mcoreb}, one application per core programming model is used.
11549 If this option is not used, single core application programming
11550 model is used.
11552 @item -mcorea
11553 @opindex mcorea
11554 Build standalone application for Core A of BF561 when using
11555 one application per core programming model. Proper start files
11556 and link scripts will be used to support Core A. This option
11557 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
11559 @item -mcoreb
11560 @opindex mcoreb
11561 Build standalone application for Core B of BF561 when using
11562 one application per core programming model. Proper start files
11563 and link scripts will be used to support Core B. This option
11564 defines @code{__BFIN_COREB}. When this option is used, coreb_main
11565 should be used instead of main. It must be used with
11566 @option{-mmulticore}.
11568 @item -msdram
11569 @opindex msdram
11570 Build standalone application for SDRAM. Proper start files and
11571 link scripts will be used to put the application into SDRAM.
11572 Loader should initialize SDRAM before loading the application
11573 into SDRAM. This option defines @code{__BFIN_SDRAM}.
11575 @item -micplb
11576 @opindex micplb
11577 Assume that ICPLBs are enabled at run time.  This has an effect on certain
11578 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
11579 are enabled; for standalone applications the default is off.
11580 @end table
11582 @node C6X Options
11583 @subsection C6X Options
11584 @cindex C6X Options
11586 @table @gcctabopt
11587 @item -march=@var{name}
11588 @opindex march
11589 This specifies the name of the target architecture.  GCC uses this
11590 name to determine what kind of instructions it can emit when generating
11591 assembly code.  Permissible names are: @samp{c62x},
11592 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
11594 @item -mbig-endian
11595 @opindex mbig-endian
11596 Generate code for a big-endian target.
11598 @item -mlittle-endian
11599 @opindex mlittle-endian
11600 Generate code for a little-endian target.  This is the default.
11602 @item -msim
11603 @opindex msim
11604 Choose startup files and linker script suitable for the simulator.
11606 @item -msdata=default
11607 @opindex msdata=default
11608 Put small global and static data in the @samp{.neardata} section,
11609 which is pointed to by register @code{B14}.  Put small uninitialized
11610 global and static data in the @samp{.bss} section, which is adjacent
11611 to the @samp{.neardata} section.  Put small read-only data into the
11612 @samp{.rodata} section.  The corresponding sections used for large
11613 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
11615 @item -msdata=all
11616 @opindex msdata=all
11617 Put all data, not just small objets, into the sections reserved for
11618 small data, and use addressing relative to the @code{B14} register to
11619 access them.
11621 @item -msdata=none
11622 @opindex msdata=none
11623 Make no use of the sections reserved for small data, and use absolute
11624 addresses to access all data.  Put all initialized global and static
11625 data in the @samp{.fardata} section, and all uninitialized data in the
11626 @samp{.far} section.  Put all constant data into the @samp{.const}
11627 section.
11628 @end table
11630 @node CRIS Options
11631 @subsection CRIS Options
11632 @cindex CRIS Options
11634 These options are defined specifically for the CRIS ports.
11636 @table @gcctabopt
11637 @item -march=@var{architecture-type}
11638 @itemx -mcpu=@var{architecture-type}
11639 @opindex march
11640 @opindex mcpu
11641 Generate code for the specified architecture.  The choices for
11642 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
11643 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
11644 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
11645 @samp{v10}.
11647 @item -mtune=@var{architecture-type}
11648 @opindex mtune
11649 Tune to @var{architecture-type} everything applicable about the generated
11650 code, except for the ABI and the set of available instructions.  The
11651 choices for @var{architecture-type} are the same as for
11652 @option{-march=@var{architecture-type}}.
11654 @item -mmax-stack-frame=@var{n}
11655 @opindex mmax-stack-frame
11656 Warn when the stack frame of a function exceeds @var{n} bytes.
11658 @item -metrax4
11659 @itemx -metrax100
11660 @opindex metrax4
11661 @opindex metrax100
11662 The options @option{-metrax4} and @option{-metrax100} are synonyms for
11663 @option{-march=v3} and @option{-march=v8} respectively.
11665 @item -mmul-bug-workaround
11666 @itemx -mno-mul-bug-workaround
11667 @opindex mmul-bug-workaround
11668 @opindex mno-mul-bug-workaround
11669 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
11670 models where it applies.  This option is active by default.
11672 @item -mpdebug
11673 @opindex mpdebug
11674 Enable CRIS-specific verbose debug-related information in the assembly
11675 code.  This option also has the effect to turn off the @samp{#NO_APP}
11676 formatted-code indicator to the assembler at the beginning of the
11677 assembly file.
11679 @item -mcc-init
11680 @opindex mcc-init
11681 Do not use condition-code results from previous instruction; always emit
11682 compare and test instructions before use of condition codes.
11684 @item -mno-side-effects
11685 @opindex mno-side-effects
11686 Do not emit instructions with side-effects in addressing modes other than
11687 post-increment.
11689 @item -mstack-align
11690 @itemx -mno-stack-align
11691 @itemx -mdata-align
11692 @itemx -mno-data-align
11693 @itemx -mconst-align
11694 @itemx -mno-const-align
11695 @opindex mstack-align
11696 @opindex mno-stack-align
11697 @opindex mdata-align
11698 @opindex mno-data-align
11699 @opindex mconst-align
11700 @opindex mno-const-align
11701 These options (no-options) arranges (eliminate arrangements) for the
11702 stack-frame, individual data and constants to be aligned for the maximum
11703 single data access size for the chosen CPU model.  The default is to
11704 arrange for 32-bit alignment.  ABI details such as structure layout are
11705 not affected by these options.
11707 @item -m32-bit
11708 @itemx -m16-bit
11709 @itemx -m8-bit
11710 @opindex m32-bit
11711 @opindex m16-bit
11712 @opindex m8-bit
11713 Similar to the stack- data- and const-align options above, these options
11714 arrange for stack-frame, writable data and constants to all be 32-bit,
11715 16-bit or 8-bit aligned.  The default is 32-bit alignment.
11717 @item -mno-prologue-epilogue
11718 @itemx -mprologue-epilogue
11719 @opindex mno-prologue-epilogue
11720 @opindex mprologue-epilogue
11721 With @option{-mno-prologue-epilogue}, the normal function prologue and
11722 epilogue which set up the stack frame are omitted and no return
11723 instructions or return sequences are generated in the code.  Use this
11724 option only together with visual inspection of the compiled code: no
11725 warnings or errors are generated when call-saved registers must be saved,
11726 or storage for local variable needs to be allocated.
11728 @item -mno-gotplt
11729 @itemx -mgotplt
11730 @opindex mno-gotplt
11731 @opindex mgotplt
11732 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
11733 instruction sequences that load addresses for functions from the PLT part
11734 of the GOT rather than (traditional on other architectures) calls to the
11735 PLT@.  The default is @option{-mgotplt}.
11737 @item -melf
11738 @opindex melf
11739 Legacy no-op option only recognized with the cris-axis-elf and
11740 cris-axis-linux-gnu targets.
11742 @item -mlinux
11743 @opindex mlinux
11744 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
11746 @item -sim
11747 @opindex sim
11748 This option, recognized for the cris-axis-elf arranges
11749 to link with input-output functions from a simulator library.  Code,
11750 initialized data and zero-initialized data are allocated consecutively.
11752 @item -sim2
11753 @opindex sim2
11754 Like @option{-sim}, but pass linker options to locate initialized data at
11755 0x40000000 and zero-initialized data at 0x80000000.
11756 @end table
11758 @node CR16 Options
11759 @subsection CR16 Options
11760 @cindex CR16 Options
11762 These options are defined specifically for the CR16 ports.
11764 @table @gcctabopt
11766 @item -mmac
11767 @opindex mmac
11768 Enable the use of multiply-accumulate instructions. Disabled by default.
11770 @item -mcr16cplus
11771 @itemx -mcr16c
11772 @opindex mcr16cplus
11773 @opindex mcr16c
11774 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
11775 is default.
11777 @item -msim
11778 @opindex msim
11779 Links the library libsim.a which is in compatible with simulator. Applicable
11780 to ELF compiler only.
11782 @item -mint32
11783 @opindex mint32
11784 Choose integer type as 32-bit wide.
11786 @item -mbit-ops
11787 @opindex mbit-ops
11788 Generates sbit/cbit instructions for bit manipulations.
11790 @item -mdata-model=@var{model}
11791 @opindex mdata-model
11792 Choose a data model. The choices for @var{model} are @samp{near},
11793 @samp{far} or @samp{medium}. @samp{medium} is default.
11794 However, @samp{far} is not valid when -mcr16c option is chosen as
11795 CR16C architecture does not support far data model.
11796 @end table
11798 @node Darwin Options
11799 @subsection Darwin Options
11800 @cindex Darwin options
11802 These options are defined for all architectures running the Darwin operating
11803 system.
11805 FSF GCC on Darwin does not create ``fat'' object files; it will create
11806 an object file for the single architecture that it was built to
11807 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
11808 @option{-arch} options are used; it does so by running the compiler or
11809 linker multiple times and joining the results together with
11810 @file{lipo}.
11812 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
11813 @samp{i686}) is determined by the flags that specify the ISA
11814 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
11815 @option{-force_cpusubtype_ALL} option can be used to override this.
11817 The Darwin tools vary in their behavior when presented with an ISA
11818 mismatch.  The assembler, @file{as}, will only permit instructions to
11819 be used that are valid for the subtype of the file it is generating,
11820 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
11821 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
11822 and print an error if asked to create a shared library with a less
11823 restrictive subtype than its input files (for instance, trying to put
11824 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
11825 for executables, @command{ld}, will quietly give the executable the most
11826 restrictive subtype of any of its input files.
11828 @table @gcctabopt
11829 @item -F@var{dir}
11830 @opindex F
11831 Add the framework directory @var{dir} to the head of the list of
11832 directories to be searched for header files.  These directories are
11833 interleaved with those specified by @option{-I} options and are
11834 scanned in a left-to-right order.
11836 A framework directory is a directory with frameworks in it.  A
11837 framework is a directory with a @samp{"Headers"} and/or
11838 @samp{"PrivateHeaders"} directory contained directly in it that ends
11839 in @samp{".framework"}.  The name of a framework is the name of this
11840 directory excluding the @samp{".framework"}.  Headers associated with
11841 the framework are found in one of those two directories, with
11842 @samp{"Headers"} being searched first.  A subframework is a framework
11843 directory that is in a framework's @samp{"Frameworks"} directory.
11844 Includes of subframework headers can only appear in a header of a
11845 framework that contains the subframework, or in a sibling subframework
11846 header.  Two subframeworks are siblings if they occur in the same
11847 framework.  A subframework should not have the same name as a
11848 framework, a warning will be issued if this is violated.  Currently a
11849 subframework cannot have subframeworks, in the future, the mechanism
11850 may be extended to support this.  The standard frameworks can be found
11851 in @samp{"/System/Library/Frameworks"} and
11852 @samp{"/Library/Frameworks"}.  An example include looks like
11853 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
11854 the name of the framework and header.h is found in the
11855 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
11857 @item -iframework@var{dir}
11858 @opindex iframework
11859 Like @option{-F} except the directory is a treated as a system
11860 directory.  The main difference between this @option{-iframework} and
11861 @option{-F} is that with @option{-iframework} the compiler does not
11862 warn about constructs contained within header files found via
11863 @var{dir}.  This option is valid only for the C family of languages.
11865 @item -gused
11866 @opindex gused
11867 Emit debugging information for symbols that are used.  For stabs
11868 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
11869 This is by default ON@.
11871 @item -gfull
11872 @opindex gfull
11873 Emit debugging information for all symbols and types.
11875 @item -mmacosx-version-min=@var{version}
11876 The earliest version of MacOS X that this executable will run on
11877 is @var{version}.  Typical values of @var{version} include @code{10.1},
11878 @code{10.2}, and @code{10.3.9}.
11880 If the compiler was built to use the system's headers by default,
11881 then the default for this option is the system version on which the
11882 compiler is running, otherwise the default is to make choices that
11883 are compatible with as many systems and code bases as possible.
11885 @item -mkernel
11886 @opindex mkernel
11887 Enable kernel development mode.  The @option{-mkernel} option sets
11888 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
11889 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
11890 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
11891 applicable.  This mode also sets @option{-mno-altivec},
11892 @option{-msoft-float}, @option{-fno-builtin} and
11893 @option{-mlong-branch} for PowerPC targets.
11895 @item -mone-byte-bool
11896 @opindex mone-byte-bool
11897 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
11898 By default @samp{sizeof(bool)} is @samp{4} when compiling for
11899 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
11900 option has no effect on x86.
11902 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
11903 to generate code that is not binary compatible with code generated
11904 without that switch.  Using this switch may require recompiling all
11905 other modules in a program, including system libraries.  Use this
11906 switch to conform to a non-default data model.
11908 @item -mfix-and-continue
11909 @itemx -ffix-and-continue
11910 @itemx -findirect-data
11911 @opindex mfix-and-continue
11912 @opindex ffix-and-continue
11913 @opindex findirect-data
11914 Generate code suitable for fast turn around development.  Needed to
11915 enable GDB to dynamically load @code{.o} files into already running
11916 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
11917 are provided for backwards compatibility.
11919 @item -all_load
11920 @opindex all_load
11921 Loads all members of static archive libraries.
11922 See man ld(1) for more information.
11924 @item -arch_errors_fatal
11925 @opindex arch_errors_fatal
11926 Cause the errors having to do with files that have the wrong architecture
11927 to be fatal.
11929 @item -bind_at_load
11930 @opindex bind_at_load
11931 Causes the output file to be marked such that the dynamic linker will
11932 bind all undefined references when the file is loaded or launched.
11934 @item -bundle
11935 @opindex bundle
11936 Produce a Mach-o bundle format file.
11937 See man ld(1) for more information.
11939 @item -bundle_loader @var{executable}
11940 @opindex bundle_loader
11941 This option specifies the @var{executable} that will be loading the build
11942 output file being linked.  See man ld(1) for more information.
11944 @item -dynamiclib
11945 @opindex dynamiclib
11946 When passed this option, GCC will produce a dynamic library instead of
11947 an executable when linking, using the Darwin @file{libtool} command.
11949 @item -force_cpusubtype_ALL
11950 @opindex force_cpusubtype_ALL
11951 This causes GCC's output file to have the @var{ALL} subtype, instead of
11952 one controlled by the @option{-mcpu} or @option{-march} option.
11954 @item -allowable_client  @var{client_name}
11955 @itemx -client_name
11956 @itemx -compatibility_version
11957 @itemx -current_version
11958 @itemx -dead_strip
11959 @itemx -dependency-file
11960 @itemx -dylib_file
11961 @itemx -dylinker_install_name
11962 @itemx -dynamic
11963 @itemx -exported_symbols_list
11964 @itemx -filelist
11965 @need 800
11966 @itemx -flat_namespace
11967 @itemx -force_flat_namespace
11968 @itemx -headerpad_max_install_names
11969 @itemx -image_base
11970 @itemx -init
11971 @itemx -install_name
11972 @itemx -keep_private_externs
11973 @itemx -multi_module
11974 @itemx -multiply_defined
11975 @itemx -multiply_defined_unused
11976 @need 800
11977 @itemx -noall_load
11978 @itemx -no_dead_strip_inits_and_terms
11979 @itemx -nofixprebinding
11980 @itemx -nomultidefs
11981 @itemx -noprebind
11982 @itemx -noseglinkedit
11983 @itemx -pagezero_size
11984 @itemx -prebind
11985 @itemx -prebind_all_twolevel_modules
11986 @itemx -private_bundle
11987 @need 800
11988 @itemx -read_only_relocs
11989 @itemx -sectalign
11990 @itemx -sectobjectsymbols
11991 @itemx -whyload
11992 @itemx -seg1addr
11993 @itemx -sectcreate
11994 @itemx -sectobjectsymbols
11995 @itemx -sectorder
11996 @itemx -segaddr
11997 @itemx -segs_read_only_addr
11998 @need 800
11999 @itemx -segs_read_write_addr
12000 @itemx -seg_addr_table
12001 @itemx -seg_addr_table_filename
12002 @itemx -seglinkedit
12003 @itemx -segprot
12004 @itemx -segs_read_only_addr
12005 @itemx -segs_read_write_addr
12006 @itemx -single_module
12007 @itemx -static
12008 @itemx -sub_library
12009 @need 800
12010 @itemx -sub_umbrella
12011 @itemx -twolevel_namespace
12012 @itemx -umbrella
12013 @itemx -undefined
12014 @itemx -unexported_symbols_list
12015 @itemx -weak_reference_mismatches
12016 @itemx -whatsloaded
12017 @opindex allowable_client
12018 @opindex client_name
12019 @opindex compatibility_version
12020 @opindex current_version
12021 @opindex dead_strip
12022 @opindex dependency-file
12023 @opindex dylib_file
12024 @opindex dylinker_install_name
12025 @opindex dynamic
12026 @opindex exported_symbols_list
12027 @opindex filelist
12028 @opindex flat_namespace
12029 @opindex force_flat_namespace
12030 @opindex headerpad_max_install_names
12031 @opindex image_base
12032 @opindex init
12033 @opindex install_name
12034 @opindex keep_private_externs
12035 @opindex multi_module
12036 @opindex multiply_defined
12037 @opindex multiply_defined_unused
12038 @opindex noall_load
12039 @opindex no_dead_strip_inits_and_terms
12040 @opindex nofixprebinding
12041 @opindex nomultidefs
12042 @opindex noprebind
12043 @opindex noseglinkedit
12044 @opindex pagezero_size
12045 @opindex prebind
12046 @opindex prebind_all_twolevel_modules
12047 @opindex private_bundle
12048 @opindex read_only_relocs
12049 @opindex sectalign
12050 @opindex sectobjectsymbols
12051 @opindex whyload
12052 @opindex seg1addr
12053 @opindex sectcreate
12054 @opindex sectobjectsymbols
12055 @opindex sectorder
12056 @opindex segaddr
12057 @opindex segs_read_only_addr
12058 @opindex segs_read_write_addr
12059 @opindex seg_addr_table
12060 @opindex seg_addr_table_filename
12061 @opindex seglinkedit
12062 @opindex segprot
12063 @opindex segs_read_only_addr
12064 @opindex segs_read_write_addr
12065 @opindex single_module
12066 @opindex static
12067 @opindex sub_library
12068 @opindex sub_umbrella
12069 @opindex twolevel_namespace
12070 @opindex umbrella
12071 @opindex undefined
12072 @opindex unexported_symbols_list
12073 @opindex weak_reference_mismatches
12074 @opindex whatsloaded
12075 These options are passed to the Darwin linker.  The Darwin linker man page
12076 describes them in detail.
12077 @end table
12079 @node DEC Alpha Options
12080 @subsection DEC Alpha Options
12082 These @samp{-m} options are defined for the DEC Alpha implementations:
12084 @table @gcctabopt
12085 @item -mno-soft-float
12086 @itemx -msoft-float
12087 @opindex mno-soft-float
12088 @opindex msoft-float
12089 Use (do not use) the hardware floating-point instructions for
12090 floating-point operations.  When @option{-msoft-float} is specified,
12091 functions in @file{libgcc.a} will be used to perform floating-point
12092 operations.  Unless they are replaced by routines that emulate the
12093 floating-point operations, or compiled in such a way as to call such
12094 emulations routines, these routines will issue floating-point
12095 operations.   If you are compiling for an Alpha without floating-point
12096 operations, you must ensure that the library is built so as not to call
12097 them.
12099 Note that Alpha implementations without floating-point operations are
12100 required to have floating-point registers.
12102 @item -mfp-reg
12103 @itemx -mno-fp-regs
12104 @opindex mfp-reg
12105 @opindex mno-fp-regs
12106 Generate code that uses (does not use) the floating-point register set.
12107 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
12108 register set is not used, floating-point operands are passed in integer
12109 registers as if they were integers and floating-point results are passed
12110 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
12111 so any function with a floating-point argument or return value called by code
12112 compiled with @option{-mno-fp-regs} must also be compiled with that
12113 option.
12115 A typical use of this option is building a kernel that does not use,
12116 and hence need not save and restore, any floating-point registers.
12118 @item -mieee
12119 @opindex mieee
12120 The Alpha architecture implements floating-point hardware optimized for
12121 maximum performance.  It is mostly compliant with the IEEE floating-point
12122 standard.  However, for full compliance, software assistance is
12123 required.  This option generates code fully IEEE-compliant code
12124 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12125 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12126 defined during compilation.  The resulting code is less efficient but is
12127 able to correctly support denormalized numbers and exceptional IEEE
12128 values such as not-a-number and plus/minus infinity.  Other Alpha
12129 compilers call this option @option{-ieee_with_no_inexact}.
12131 @item -mieee-with-inexact
12132 @opindex mieee-with-inexact
12133 This is like @option{-mieee} except the generated code also maintains
12134 the IEEE @var{inexact-flag}.  Turning on this option causes the
12135 generated code to implement fully-compliant IEEE math.  In addition to
12136 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12137 macro.  On some Alpha implementations the resulting code may execute
12138 significantly slower than the code generated by default.  Since there is
12139 very little code that depends on the @var{inexact-flag}, you should
12140 normally not specify this option.  Other Alpha compilers call this
12141 option @option{-ieee_with_inexact}.
12143 @item -mfp-trap-mode=@var{trap-mode}
12144 @opindex mfp-trap-mode
12145 This option controls what floating-point related traps are enabled.
12146 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12147 The trap mode can be set to one of four values:
12149 @table @samp
12150 @item n
12151 This is the default (normal) setting.  The only traps that are enabled
12152 are the ones that cannot be disabled in software (e.g., division by zero
12153 trap).
12155 @item u
12156 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12157 as well.
12159 @item su
12160 Like @samp{u}, but the instructions are marked to be safe for software
12161 completion (see Alpha architecture manual for details).
12163 @item sui
12164 Like @samp{su}, but inexact traps are enabled as well.
12165 @end table
12167 @item -mfp-rounding-mode=@var{rounding-mode}
12168 @opindex mfp-rounding-mode
12169 Selects the IEEE rounding mode.  Other Alpha compilers call this option
12170 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
12173 @table @samp
12174 @item n
12175 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
12176 the nearest machine number or towards the even machine number in case
12177 of a tie.
12179 @item m
12180 Round towards minus infinity.
12182 @item c
12183 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
12185 @item d
12186 Dynamic rounding mode.  A field in the floating-point control register
12187 (@var{fpcr}, see Alpha architecture reference manual) controls the
12188 rounding mode in effect.  The C library initializes this register for
12189 rounding towards plus infinity.  Thus, unless your program modifies the
12190 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12191 @end table
12193 @item -mtrap-precision=@var{trap-precision}
12194 @opindex mtrap-precision
12195 In the Alpha architecture, floating-point traps are imprecise.  This
12196 means without software assistance it is impossible to recover from a
12197 floating trap and program execution normally needs to be terminated.
12198 GCC can generate code that can assist operating system trap handlers
12199 in determining the exact location that caused a floating-point trap.
12200 Depending on the requirements of an application, different levels of
12201 precisions can be selected:
12203 @table @samp
12204 @item p
12205 Program precision.  This option is the default and means a trap handler
12206 can only identify which program caused a floating-point exception.
12208 @item f
12209 Function precision.  The trap handler can determine the function that
12210 caused a floating-point exception.
12212 @item i
12213 Instruction precision.  The trap handler can determine the exact
12214 instruction that caused a floating-point exception.
12215 @end table
12217 Other Alpha compilers provide the equivalent options called
12218 @option{-scope_safe} and @option{-resumption_safe}.
12220 @item -mieee-conformant
12221 @opindex mieee-conformant
12222 This option marks the generated code as IEEE conformant.  You must not
12223 use this option unless you also specify @option{-mtrap-precision=i} and either
12224 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
12225 is to emit the line @samp{.eflag 48} in the function prologue of the
12226 generated assembly file.
12228 @item -mbuild-constants
12229 @opindex mbuild-constants
12230 Normally GCC examines a 32- or 64-bit integer constant to
12231 see if it can construct it from smaller constants in two or three
12232 instructions.  If it cannot, it will output the constant as a literal and
12233 generate code to load it from the data segment at run time.
12235 Use this option to require GCC to construct @emph{all} integer constants
12236 using code, even if it takes more instructions (the maximum is six).
12238 You would typically use this option to build a shared library dynamic
12239 loader.  Itself a shared library, it must relocate itself in memory
12240 before it can find the variables and constants in its own data segment.
12242 @item -mbwx
12243 @itemx -mno-bwx
12244 @itemx -mcix
12245 @itemx -mno-cix
12246 @itemx -mfix
12247 @itemx -mno-fix
12248 @itemx -mmax
12249 @itemx -mno-max
12250 @opindex mbwx
12251 @opindex mno-bwx
12252 @opindex mcix
12253 @opindex mno-cix
12254 @opindex mfix
12255 @opindex mno-fix
12256 @opindex mmax
12257 @opindex mno-max
12258 Indicate whether GCC should generate code to use the optional BWX,
12259 CIX, FIX and MAX instruction sets.  The default is to use the instruction
12260 sets supported by the CPU type specified via @option{-mcpu=} option or that
12261 of the CPU on which GCC was built if none was specified.
12263 @item -mfloat-vax
12264 @itemx -mfloat-ieee
12265 @opindex mfloat-vax
12266 @opindex mfloat-ieee
12267 Generate code that uses (does not use) VAX F and G floating-point
12268 arithmetic instead of IEEE single and double precision.
12270 @item -mexplicit-relocs
12271 @itemx -mno-explicit-relocs
12272 @opindex mexplicit-relocs
12273 @opindex mno-explicit-relocs
12274 Older Alpha assemblers provided no way to generate symbol relocations
12275 except via assembler macros.  Use of these macros does not allow
12276 optimal instruction scheduling.  GNU binutils as of version 2.12
12277 supports a new syntax that allows the compiler to explicitly mark
12278 which relocations should apply to which instructions.  This option
12279 is mostly useful for debugging, as GCC detects the capabilities of
12280 the assembler when it is built and sets the default accordingly.
12282 @item -msmall-data
12283 @itemx -mlarge-data
12284 @opindex msmall-data
12285 @opindex mlarge-data
12286 When @option{-mexplicit-relocs} is in effect, static data is
12287 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
12288 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
12289 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
12290 16-bit relocations off of the @code{$gp} register.  This limits the
12291 size of the small data area to 64KB, but allows the variables to be
12292 directly accessed via a single instruction.
12294 The default is @option{-mlarge-data}.  With this option the data area
12295 is limited to just below 2GB@.  Programs that require more than 2GB of
12296 data must use @code{malloc} or @code{mmap} to allocate the data in the
12297 heap instead of in the program's data segment.
12299 When generating code for shared libraries, @option{-fpic} implies
12300 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
12302 @item -msmall-text
12303 @itemx -mlarge-text
12304 @opindex msmall-text
12305 @opindex mlarge-text
12306 When @option{-msmall-text} is used, the compiler assumes that the
12307 code of the entire program (or shared library) fits in 4MB, and is
12308 thus reachable with a branch instruction.  When @option{-msmall-data}
12309 is used, the compiler can assume that all local symbols share the
12310 same @code{$gp} value, and thus reduce the number of instructions
12311 required for a function call from 4 to 1.
12313 The default is @option{-mlarge-text}.
12315 @item -mcpu=@var{cpu_type}
12316 @opindex mcpu
12317 Set the instruction set and instruction scheduling parameters for
12318 machine type @var{cpu_type}.  You can specify either the @samp{EV}
12319 style name or the corresponding chip number.  GCC supports scheduling
12320 parameters for the EV4, EV5 and EV6 family of processors and will
12321 choose the default values for the instruction set from the processor
12322 you specify.  If you do not specify a processor type, GCC will default
12323 to the processor on which the compiler was built.
12325 Supported values for @var{cpu_type} are
12327 @table @samp
12328 @item ev4
12329 @itemx ev45
12330 @itemx 21064
12331 Schedules as an EV4 and has no instruction set extensions.
12333 @item ev5
12334 @itemx 21164
12335 Schedules as an EV5 and has no instruction set extensions.
12337 @item ev56
12338 @itemx 21164a
12339 Schedules as an EV5 and supports the BWX extension.
12341 @item pca56
12342 @itemx 21164pc
12343 @itemx 21164PC
12344 Schedules as an EV5 and supports the BWX and MAX extensions.
12346 @item ev6
12347 @itemx 21264
12348 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12350 @item ev67
12351 @itemx 21264a
12352 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12353 @end table
12355 Native toolchains also support the value @samp{native},
12356 which selects the best architecture option for the host processor.
12357 @option{-mcpu=native} has no effect if GCC does not recognize
12358 the processor.
12360 @item -mtune=@var{cpu_type}
12361 @opindex mtune
12362 Set only the instruction scheduling parameters for machine type
12363 @var{cpu_type}.  The instruction set is not changed.
12365 Native toolchains also support the value @samp{native},
12366 which selects the best architecture option for the host processor.
12367 @option{-mtune=native} has no effect if GCC does not recognize
12368 the processor.
12370 @item -mmemory-latency=@var{time}
12371 @opindex mmemory-latency
12372 Sets the latency the scheduler should assume for typical memory
12373 references as seen by the application.  This number is highly
12374 dependent on the memory access patterns used by the application
12375 and the size of the external cache on the machine.
12377 Valid options for @var{time} are
12379 @table @samp
12380 @item @var{number}
12381 A decimal number representing clock cycles.
12383 @item L1
12384 @itemx L2
12385 @itemx L3
12386 @itemx main
12387 The compiler contains estimates of the number of clock cycles for
12388 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12389 (also called Dcache, Scache, and Bcache), as well as to main memory.
12390 Note that L3 is only valid for EV5.
12392 @end table
12393 @end table
12395 @node FR30 Options
12396 @subsection FR30 Options
12397 @cindex FR30 Options
12399 These options are defined specifically for the FR30 port.
12401 @table @gcctabopt
12403 @item -msmall-model
12404 @opindex msmall-model
12405 Use the small address space model.  This can produce smaller code, but
12406 it does assume that all symbolic values and addresses will fit into a
12407 20-bit range.
12409 @item -mno-lsim
12410 @opindex mno-lsim
12411 Assume that runtime support has been provided and so there is no need
12412 to include the simulator library (@file{libsim.a}) on the linker
12413 command line.
12415 @end table
12417 @node FRV Options
12418 @subsection FRV Options
12419 @cindex FRV Options
12421 @table @gcctabopt
12422 @item -mgpr-32
12423 @opindex mgpr-32
12425 Only use the first 32 general-purpose registers.
12427 @item -mgpr-64
12428 @opindex mgpr-64
12430 Use all 64 general-purpose registers.
12432 @item -mfpr-32
12433 @opindex mfpr-32
12435 Use only the first 32 floating-point registers.
12437 @item -mfpr-64
12438 @opindex mfpr-64
12440 Use all 64 floating-point registers.
12442 @item -mhard-float
12443 @opindex mhard-float
12445 Use hardware instructions for floating-point operations.
12447 @item -msoft-float
12448 @opindex msoft-float
12450 Use library routines for floating-point operations.
12452 @item -malloc-cc
12453 @opindex malloc-cc
12455 Dynamically allocate condition code registers.
12457 @item -mfixed-cc
12458 @opindex mfixed-cc
12460 Do not try to dynamically allocate condition code registers, only
12461 use @code{icc0} and @code{fcc0}.
12463 @item -mdword
12464 @opindex mdword
12466 Change ABI to use double word insns.
12468 @item -mno-dword
12469 @opindex mno-dword
12471 Do not use double word instructions.
12473 @item -mdouble
12474 @opindex mdouble
12476 Use floating-point double instructions.
12478 @item -mno-double
12479 @opindex mno-double
12481 Do not use floating-point double instructions.
12483 @item -mmedia
12484 @opindex mmedia
12486 Use media instructions.
12488 @item -mno-media
12489 @opindex mno-media
12491 Do not use media instructions.
12493 @item -mmuladd
12494 @opindex mmuladd
12496 Use multiply and add/subtract instructions.
12498 @item -mno-muladd
12499 @opindex mno-muladd
12501 Do not use multiply and add/subtract instructions.
12503 @item -mfdpic
12504 @opindex mfdpic
12506 Select the FDPIC ABI, which uses function descriptors to represent
12507 pointers to functions.  Without any PIC/PIE-related options, it
12508 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
12509 assumes GOT entries and small data are within a 12-bit range from the
12510 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
12511 are computed with 32 bits.
12512 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12514 @item -minline-plt
12515 @opindex minline-plt
12517 Enable inlining of PLT entries in function calls to functions that are
12518 not known to bind locally.  It has no effect without @option{-mfdpic}.
12519 It's enabled by default if optimizing for speed and compiling for
12520 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
12521 optimization option such as @option{-O3} or above is present in the
12522 command line.
12524 @item -mTLS
12525 @opindex mTLS
12527 Assume a large TLS segment when generating thread-local code.
12529 @item -mtls
12530 @opindex mtls
12532 Do not assume a large TLS segment when generating thread-local code.
12534 @item -mgprel-ro
12535 @opindex mgprel-ro
12537 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
12538 that is known to be in read-only sections.  It's enabled by default,
12539 except for @option{-fpic} or @option{-fpie}: even though it may help
12540 make the global offset table smaller, it trades 1 instruction for 4.
12541 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
12542 one of which may be shared by multiple symbols, and it avoids the need
12543 for a GOT entry for the referenced symbol, so it's more likely to be a
12544 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
12546 @item -multilib-library-pic
12547 @opindex multilib-library-pic
12549 Link with the (library, not FD) pic libraries.  It's implied by
12550 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
12551 @option{-fpic} without @option{-mfdpic}.  You should never have to use
12552 it explicitly.
12554 @item -mlinked-fp
12555 @opindex mlinked-fp
12557 Follow the EABI requirement of always creating a frame pointer whenever
12558 a stack frame is allocated.  This option is enabled by default and can
12559 be disabled with @option{-mno-linked-fp}.
12561 @item -mlong-calls
12562 @opindex mlong-calls
12564 Use indirect addressing to call functions outside the current
12565 compilation unit.  This allows the functions to be placed anywhere
12566 within the 32-bit address space.
12568 @item -malign-labels
12569 @opindex malign-labels
12571 Try to align labels to an 8-byte boundary by inserting nops into the
12572 previous packet.  This option only has an effect when VLIW packing
12573 is enabled.  It doesn't create new packets; it merely adds nops to
12574 existing ones.
12576 @item -mlibrary-pic
12577 @opindex mlibrary-pic
12579 Generate position-independent EABI code.
12581 @item -macc-4
12582 @opindex macc-4
12584 Use only the first four media accumulator registers.
12586 @item -macc-8
12587 @opindex macc-8
12589 Use all eight media accumulator registers.
12591 @item -mpack
12592 @opindex mpack
12594 Pack VLIW instructions.
12596 @item -mno-pack
12597 @opindex mno-pack
12599 Do not pack VLIW instructions.
12601 @item -mno-eflags
12602 @opindex mno-eflags
12604 Do not mark ABI switches in e_flags.
12606 @item -mcond-move
12607 @opindex mcond-move
12609 Enable the use of conditional-move instructions (default).
12611 This switch is mainly for debugging the compiler and will likely be removed
12612 in a future version.
12614 @item -mno-cond-move
12615 @opindex mno-cond-move
12617 Disable the use of conditional-move instructions.
12619 This switch is mainly for debugging the compiler and will likely be removed
12620 in a future version.
12622 @item -mscc
12623 @opindex mscc
12625 Enable the use of conditional set instructions (default).
12627 This switch is mainly for debugging the compiler and will likely be removed
12628 in a future version.
12630 @item -mno-scc
12631 @opindex mno-scc
12633 Disable the use of conditional set instructions.
12635 This switch is mainly for debugging the compiler and will likely be removed
12636 in a future version.
12638 @item -mcond-exec
12639 @opindex mcond-exec
12641 Enable the use of conditional execution (default).
12643 This switch is mainly for debugging the compiler and will likely be removed
12644 in a future version.
12646 @item -mno-cond-exec
12647 @opindex mno-cond-exec
12649 Disable the use of conditional execution.
12651 This switch is mainly for debugging the compiler and will likely be removed
12652 in a future version.
12654 @item -mvliw-branch
12655 @opindex mvliw-branch
12657 Run a pass to pack branches into VLIW instructions (default).
12659 This switch is mainly for debugging the compiler and will likely be removed
12660 in a future version.
12662 @item -mno-vliw-branch
12663 @opindex mno-vliw-branch
12665 Do not run a pass to pack branches into VLIW instructions.
12667 This switch is mainly for debugging the compiler and will likely be removed
12668 in a future version.
12670 @item -mmulti-cond-exec
12671 @opindex mmulti-cond-exec
12673 Enable optimization of @code{&&} and @code{||} in conditional execution
12674 (default).
12676 This switch is mainly for debugging the compiler and will likely be removed
12677 in a future version.
12679 @item -mno-multi-cond-exec
12680 @opindex mno-multi-cond-exec
12682 Disable optimization of @code{&&} and @code{||} in conditional execution.
12684 This switch is mainly for debugging the compiler and will likely be removed
12685 in a future version.
12687 @item -mnested-cond-exec
12688 @opindex mnested-cond-exec
12690 Enable nested conditional execution optimizations (default).
12692 This switch is mainly for debugging the compiler and will likely be removed
12693 in a future version.
12695 @item -mno-nested-cond-exec
12696 @opindex mno-nested-cond-exec
12698 Disable nested conditional execution optimizations.
12700 This switch is mainly for debugging the compiler and will likely be removed
12701 in a future version.
12703 @item -moptimize-membar
12704 @opindex moptimize-membar
12706 This switch removes redundant @code{membar} instructions from the
12707 compiler generated code.  It is enabled by default.
12709 @item -mno-optimize-membar
12710 @opindex mno-optimize-membar
12712 This switch disables the automatic removal of redundant @code{membar}
12713 instructions from the generated code.
12715 @item -mtomcat-stats
12716 @opindex mtomcat-stats
12718 Cause gas to print out tomcat statistics.
12720 @item -mcpu=@var{cpu}
12721 @opindex mcpu
12723 Select the processor type for which to generate code.  Possible values are
12724 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
12725 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
12727 @end table
12729 @node GNU/Linux Options
12730 @subsection GNU/Linux Options
12732 These @samp{-m} options are defined for GNU/Linux targets:
12734 @table @gcctabopt
12735 @item -mglibc
12736 @opindex mglibc
12737 Use the GNU C library.  This is the default except
12738 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
12740 @item -muclibc
12741 @opindex muclibc
12742 Use uClibc C library.  This is the default on
12743 @samp{*-*-linux-*uclibc*} targets.
12745 @item -mbionic
12746 @opindex mbionic
12747 Use Bionic C library.  This is the default on
12748 @samp{*-*-linux-*android*} targets.
12750 @item -mandroid
12751 @opindex mandroid
12752 Compile code compatible with Android platform.  This is the default on
12753 @samp{*-*-linux-*android*} targets.
12755 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
12756 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
12757 this option makes the GCC driver pass Android-specific options to the linker.
12758 Finally, this option causes the preprocessor macro @code{__ANDROID__}
12759 to be defined.
12761 @item -tno-android-cc
12762 @opindex tno-android-cc
12763 Disable compilation effects of @option{-mandroid}, i.e., do not enable
12764 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
12765 @option{-fno-rtti} by default.
12767 @item -tno-android-ld
12768 @opindex tno-android-ld
12769 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
12770 linking options to the linker.
12772 @end table
12774 @node H8/300 Options
12775 @subsection H8/300 Options
12777 These @samp{-m} options are defined for the H8/300 implementations:
12779 @table @gcctabopt
12780 @item -mrelax
12781 @opindex mrelax
12782 Shorten some address references at link time, when possible; uses the
12783 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
12784 ld, Using ld}, for a fuller description.
12786 @item -mh
12787 @opindex mh
12788 Generate code for the H8/300H@.
12790 @item -ms
12791 @opindex ms
12792 Generate code for the H8S@.
12794 @item -mn
12795 @opindex mn
12796 Generate code for the H8S and H8/300H in the normal mode.  This switch
12797 must be used either with @option{-mh} or @option{-ms}.
12799 @item -ms2600
12800 @opindex ms2600
12801 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
12803 @item -mint32
12804 @opindex mint32
12805 Make @code{int} data 32 bits by default.
12807 @item -malign-300
12808 @opindex malign-300
12809 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
12810 The default for the H8/300H and H8S is to align longs and floats on
12811 4-byte boundaries.
12812 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
12813 This option has no effect on the H8/300.
12814 @end table
12816 @node HPPA Options
12817 @subsection HPPA Options
12818 @cindex HPPA Options
12820 These @samp{-m} options are defined for the HPPA family of computers:
12822 @table @gcctabopt
12823 @item -march=@var{architecture-type}
12824 @opindex march
12825 Generate code for the specified architecture.  The choices for
12826 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
12827 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
12828 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
12829 architecture option for your machine.  Code compiled for lower numbered
12830 architectures will run on higher numbered architectures, but not the
12831 other way around.
12833 @item -mpa-risc-1-0
12834 @itemx -mpa-risc-1-1
12835 @itemx -mpa-risc-2-0
12836 @opindex mpa-risc-1-0
12837 @opindex mpa-risc-1-1
12838 @opindex mpa-risc-2-0
12839 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
12841 @item -mbig-switch
12842 @opindex mbig-switch
12843 Generate code suitable for big switch tables.  Use this option only if
12844 the assembler/linker complain about out of range branches within a switch
12845 table.
12847 @item -mjump-in-delay
12848 @opindex mjump-in-delay
12849 Fill delay slots of function calls with unconditional jump instructions
12850 by modifying the return pointer for the function call to be the target
12851 of the conditional jump.
12853 @item -mdisable-fpregs
12854 @opindex mdisable-fpregs
12855 Prevent floating-point registers from being used in any manner.  This is
12856 necessary for compiling kernels that perform lazy context switching of
12857 floating-point registers.  If you use this option and attempt to perform
12858 floating-point operations, the compiler aborts.
12860 @item -mdisable-indexing
12861 @opindex mdisable-indexing
12862 Prevent the compiler from using indexing address modes.  This avoids some
12863 rather obscure problems when compiling MIG generated code under MACH@.
12865 @item -mno-space-regs
12866 @opindex mno-space-regs
12867 Generate code that assumes the target has no space registers.  This allows
12868 GCC to generate faster indirect calls and use unscaled index address modes.
12870 Such code is suitable for level 0 PA systems and kernels.
12872 @item -mfast-indirect-calls
12873 @opindex mfast-indirect-calls
12874 Generate code that assumes calls never cross space boundaries.  This
12875 allows GCC to emit code that performs faster indirect calls.
12877 This option will not work in the presence of shared libraries or nested
12878 functions.
12880 @item -mfixed-range=@var{register-range}
12881 @opindex mfixed-range
12882 Generate code treating the given register range as fixed registers.
12883 A fixed register is one that the register allocator can not use.  This is
12884 useful when compiling kernel code.  A register range is specified as
12885 two registers separated by a dash.  Multiple register ranges can be
12886 specified separated by a comma.
12888 @item -mlong-load-store
12889 @opindex mlong-load-store
12890 Generate 3-instruction load and store sequences as sometimes required by
12891 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
12892 the HP compilers.
12894 @item -mportable-runtime
12895 @opindex mportable-runtime
12896 Use the portable calling conventions proposed by HP for ELF systems.
12898 @item -mgas
12899 @opindex mgas
12900 Enable the use of assembler directives only GAS understands.
12902 @item -mschedule=@var{cpu-type}
12903 @opindex mschedule
12904 Schedule code according to the constraints for the machine type
12905 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
12906 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
12907 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
12908 proper scheduling option for your machine.  The default scheduling is
12909 @samp{8000}.
12911 @item -mlinker-opt
12912 @opindex mlinker-opt
12913 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
12914 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
12915 linkers in which they give bogus error messages when linking some programs.
12917 @item -msoft-float
12918 @opindex msoft-float
12919 Generate output containing library calls for floating point.
12920 @strong{Warning:} the requisite libraries are not available for all HPPA
12921 targets.  Normally the facilities of the machine's usual C compiler are
12922 used, but this cannot be done directly in cross-compilation.  You must make
12923 your own arrangements to provide suitable library functions for
12924 cross-compilation.
12926 @option{-msoft-float} changes the calling convention in the output file;
12927 therefore, it is only useful if you compile @emph{all} of a program with
12928 this option.  In particular, you need to compile @file{libgcc.a}, the
12929 library that comes with GCC, with @option{-msoft-float} in order for
12930 this to work.
12932 @item -msio
12933 @opindex msio
12934 Generate the predefine, @code{_SIO}, for server IO@.  The default is
12935 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
12936 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
12937 options are available under HP-UX and HI-UX@.
12939 @item -mgnu-ld
12940 @opindex mgnu-ld
12941 Use options specific to GNU @command{ld}.
12942 This passes @option{-shared} to @command{ld} when
12943 building a shared library.  It is the default when GCC is configured,
12944 explicitly or implicitly, with the GNU linker.  This option does not
12945 affect which @command{ld} is called; it only changes what parameters
12946 are passed to that @command{ld}.
12947 The @command{ld} that is called is determined by the
12948 @option{--with-ld} configure option, GCC's program search path, and
12949 finally by the user's @env{PATH}.  The linker used by GCC can be printed
12950 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
12951 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
12953 @item -mhp-ld
12954 @opindex mhp-ld
12955 Use options specific to HP @command{ld}.
12956 This passes @option{-b} to @command{ld} when building
12957 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
12958 links.  It is the default when GCC is configured, explicitly or
12959 implicitly, with the HP linker.  This option does not affect
12960 which @command{ld} is called; it only changes what parameters are passed to that
12961 @command{ld}.
12962 The @command{ld} that is called is determined by the @option{--with-ld}
12963 configure option, GCC's program search path, and finally by the user's
12964 @env{PATH}.  The linker used by GCC can be printed using @samp{which
12965 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
12966 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
12968 @item -mlong-calls
12969 @opindex mno-long-calls
12970 Generate code that uses long call sequences.  This ensures that a call
12971 is always able to reach linker generated stubs.  The default is to generate
12972 long calls only when the distance from the call site to the beginning
12973 of the function or translation unit, as the case may be, exceeds a
12974 predefined limit set by the branch type being used.  The limits for
12975 normal calls are 7,600,000 and 240,000 bytes, respectively for the
12976 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
12977 240,000 bytes.
12979 Distances are measured from the beginning of functions when using the
12980 @option{-ffunction-sections} option, or when using the @option{-mgas}
12981 and @option{-mno-portable-runtime} options together under HP-UX with
12982 the SOM linker.
12984 It is normally not desirable to use this option as it will degrade
12985 performance.  However, it may be useful in large applications,
12986 particularly when partial linking is used to build the application.
12988 The types of long calls used depends on the capabilities of the
12989 assembler and linker, and the type of code being generated.  The
12990 impact on systems that support long absolute calls, and long pic
12991 symbol-difference or pc-relative calls should be relatively small.
12992 However, an indirect call is used on 32-bit ELF systems in pic code
12993 and it is quite long.
12995 @item -munix=@var{unix-std}
12996 @opindex march
12997 Generate compiler predefines and select a startfile for the specified
12998 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
12999 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
13000 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
13001 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
13002 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13003 and later.
13005 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13006 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13007 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13008 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13009 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13010 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13012 It is @emph{important} to note that this option changes the interfaces
13013 for various library routines.  It also affects the operational behavior
13014 of the C library.  Thus, @emph{extreme} care is needed in using this
13015 option.
13017 Library code that is intended to operate with more than one UNIX
13018 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13019 as appropriate.  Most GNU software doesn't provide this capability.
13021 @item -nolibdld
13022 @opindex nolibdld
13023 Suppress the generation of link options to search libdld.sl when the
13024 @option{-static} option is specified on HP-UX 10 and later.
13026 @item -static
13027 @opindex static
13028 The HP-UX implementation of setlocale in libc has a dependency on
13029 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
13030 when the @option{-static} option is specified, special link options
13031 are needed to resolve this dependency.
13033 On HP-UX 10 and later, the GCC driver adds the necessary options to
13034 link with libdld.sl when the @option{-static} option is specified.
13035 This causes the resulting binary to be dynamic.  On the 64-bit port,
13036 the linkers generate dynamic binaries by default in any case.  The
13037 @option{-nolibdld} option can be used to prevent the GCC driver from
13038 adding these link options.
13040 @item -threads
13041 @opindex threads
13042 Add support for multithreading with the @dfn{dce thread} library
13043 under HP-UX@.  This option sets flags for both the preprocessor and
13044 linker.
13045 @end table
13047 @node i386 and x86-64 Options
13048 @subsection Intel 386 and AMD x86-64 Options
13049 @cindex i386 Options
13050 @cindex x86-64 Options
13051 @cindex Intel 386 Options
13052 @cindex AMD x86-64 Options
13054 These @samp{-m} options are defined for the i386 and x86-64 family of
13055 computers:
13057 @table @gcctabopt
13059 @item -march=@var{cpu-type}
13060 @opindex march
13061 Generate instructions for the machine type @var{cpu-type}.  In contrast to
13062 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
13063 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13064 to generate code that may not run at all on processors other than the one
13065 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
13066 @option{-mtune=@var{cpu-type}}.
13068 The choices for @var{cpu-type} are:
13070 @table @samp
13071 @item native
13072 This selects the CPU to generate code for at compilation time by determining
13073 the processor type of the compiling machine.  Using @option{-march=native}
13074 enables all instruction subsets supported by the local machine (hence
13075 the result might not run on different machines).  Using @option{-mtune=native}
13076 produces code optimized for the local machine under the constraints
13077 of the selected instruction set.  
13079 @item i386
13080 Original Intel i386 CPU@.
13082 @item i486
13083 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
13085 @item i586
13086 @itemx pentium
13087 Intel Pentium CPU with no MMX support.
13089 @item pentium-mmx
13090 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13092 @item pentiumpro
13093 Intel Pentium Pro CPU@.
13095 @item i686
13096 When used with @option{-march}, the Pentium Pro
13097 instruction set is used, so the code runs on all i686 family chips.
13098 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13100 @item pentium2
13101 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13102 support.
13104 @item pentium3
13105 @itemx pentium3m
13106 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13107 set support.
13109 @item pentium-m
13110 Intel Pentium M; low-power version of Intel Pentium III CPU
13111 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
13113 @item pentium4
13114 @itemx pentium4m
13115 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13117 @item prescott
13118 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13119 set support.
13121 @item nocona
13122 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13123 SSE2 and SSE3 instruction set support.
13125 @item core2
13126 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13127 instruction set support.
13129 @item corei7
13130 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13131 and SSE4.2 instruction set support.
13133 @item corei7-avx
13134 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13135 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13137 @item core-avx-i
13138 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13139 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13140 set support.
13142 @item atom
13143 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13144 instruction set support.
13146 @item k6
13147 AMD K6 CPU with MMX instruction set support.
13149 @item k6-2
13150 @itemx k6-3
13151 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13153 @item athlon
13154 @itemx athlon-tbird
13155 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13156 support.
13158 @item athlon-4
13159 @itemx athlon-xp
13160 @itemx athlon-mp
13161 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13162 instruction set support.
13164 @item k8
13165 @itemx opteron
13166 @itemx athlon64
13167 @itemx athlon-fx
13168 Processors based on the AMD K8 core with x86-64 instruction set support,
13169 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13170 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13171 instruction set extensions.)
13173 @item k8-sse3
13174 @itemx opteron-sse3
13175 @itemx athlon64-sse3
13176 Improved versions of AMD K8 cores with SSE3 instruction set support.
13178 @item amdfam10
13179 @itemx barcelona
13180 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
13181 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13182 instruction set extensions.)
13184 @item bdver1
13185 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
13186 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13187 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13188 @item bdver2
13189 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13190 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13191 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13192 extensions.)
13194 @item btver1
13195 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
13196 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13197 instruction set extensions.)
13199 @item winchip-c6
13200 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13201 set support.
13203 @item winchip2
13204 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13205 instruction set support.
13207 @item c3
13208 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
13209 implemented for this chip.)
13211 @item c3-2
13212 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13213 (No scheduling is
13214 implemented for this chip.)
13216 @item geode
13217 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
13218 @end table
13220 @item -mtune=@var{cpu-type}
13221 @opindex mtune
13222 Tune to @var{cpu-type} everything applicable about the generated code, except
13223 for the ABI and the set of available instructions.  
13224 While picking a specific @var{cpu-type} schedules things appropriately
13225 for that particular chip, the compiler does not generate any code that
13226 cannot run on the default machine type unless you use a
13227 @option{-march=@var{cpu-type}} option.
13228 For example, if GCC is configured for i686-pc-linux-gnu
13229 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
13230 but still runs on i686 machines.
13232 The choices for @var{cpu-type} are the same as for @option{-march}.
13233 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
13235 @table @samp
13236 @item generic
13237 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
13238 If you know the CPU on which your code will run, then you should use
13239 the corresponding @option{-mtune} or @option{-march} option instead of
13240 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
13241 of your application will have, then you should use this option.
13243 As new processors are deployed in the marketplace, the behavior of this
13244 option will change.  Therefore, if you upgrade to a newer version of
13245 GCC, code generation controlled by this option will change to reflect
13246 the processors
13247 that are most common at the time that version of GCC is released.
13249 There is no @option{-march=generic} option because @option{-march}
13250 indicates the instruction set the compiler can use, and there is no
13251 generic instruction set applicable to all processors.  In contrast,
13252 @option{-mtune} indicates the processor (or, in this case, collection of
13253 processors) for which the code is optimized.
13254 @end table
13256 @item -mcpu=@var{cpu-type}
13257 @opindex mcpu
13258 A deprecated synonym for @option{-mtune}.
13260 @item -mfpmath=@var{unit}
13261 @opindex mfpmath
13262 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
13263 for @var{unit} are:
13265 @table @samp
13266 @item 387
13267 Use the standard 387 floating-point coprocessor present on the majority of chips and
13268 emulated otherwise.  Code compiled with this option runs almost everywhere.
13269 The temporary results are computed in 80-bit precision instead of the precision
13270 specified by the type, resulting in slightly different results compared to most
13271 of other chips.  See @option{-ffloat-store} for more detailed description.
13273 This is the default choice for i386 compiler.
13275 @item sse
13276 Use scalar floating-point instructions present in the SSE instruction set.
13277 This instruction set is supported by Pentium III and newer chips,
13278 and in the AMD line
13279 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
13280 instruction set supports only single-precision arithmetic, thus the double and
13281 extended-precision arithmetic are still done using 387.  A later version, present
13282 only in Pentium 4 and AMD x86-64 chips, supports double-precision
13283 arithmetic too.
13285 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
13286 or @option{-msse2} switches to enable SSE extensions and make this option
13287 effective.  For the x86-64 compiler, these extensions are enabled by default.
13289 The resulting code should be considerably faster in the majority of cases and avoid
13290 the numerical instability problems of 387 code, but may break some existing
13291 code that expects temporaries to be 80 bits.
13293 This is the default choice for the x86-64 compiler.
13295 @item sse,387
13296 @itemx sse+387
13297 @itemx both
13298 Attempt to utilize both instruction sets at once.  This effectively doubles the
13299 amount of available registers, and on chips with separate execution units for
13300 387 and SSE the execution resources too.  Use this option with care, as it is
13301 still experimental, because the GCC register allocator does not model separate
13302 functional units well, resulting in unstable performance.
13303 @end table
13305 @item -masm=@var{dialect}
13306 @opindex masm=@var{dialect}
13307 Output assembly instructions using selected @var{dialect}.  Supported
13308 choices are @samp{intel} or @samp{att} (the default).  Darwin does
13309 not support @samp{intel}.
13311 @item -mieee-fp
13312 @itemx -mno-ieee-fp
13313 @opindex mieee-fp
13314 @opindex mno-ieee-fp
13315 Control whether or not the compiler uses IEEE floating-point
13316 comparisons.  These correctly handle the case where the result of a
13317 comparison is unordered.
13319 @item -msoft-float
13320 @opindex msoft-float
13321 Generate output containing library calls for floating point.
13323 @strong{Warning:} the requisite libraries are not part of GCC@.
13324 Normally the facilities of the machine's usual C compiler are used, but
13325 this can't be done directly in cross-compilation.  You must make your
13326 own arrangements to provide suitable library functions for
13327 cross-compilation.
13329 On machines where a function returns floating-point results in the 80387
13330 register stack, some floating-point opcodes may be emitted even if
13331 @option{-msoft-float} is used.
13333 @item -mno-fp-ret-in-387
13334 @opindex mno-fp-ret-in-387
13335 Do not use the FPU registers for return values of functions.
13337 The usual calling convention has functions return values of types
13338 @code{float} and @code{double} in an FPU register, even if there
13339 is no FPU@.  The idea is that the operating system should emulate
13340 an FPU@.
13342 The option @option{-mno-fp-ret-in-387} causes such values to be returned
13343 in ordinary CPU registers instead.
13345 @item -mno-fancy-math-387
13346 @opindex mno-fancy-math-387
13347 Some 387 emulators do not support the @code{sin}, @code{cos} and
13348 @code{sqrt} instructions for the 387.  Specify this option to avoid
13349 generating those instructions.  This option is the default on FreeBSD,
13350 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
13351 indicates that the target CPU always has an FPU and so the
13352 instruction does not need emulation.  These
13353 instructions are not generated unless you also use the
13354 @option{-funsafe-math-optimizations} switch.
13356 @item -malign-double
13357 @itemx -mno-align-double
13358 @opindex malign-double
13359 @opindex mno-align-double
13360 Control whether GCC aligns @code{double}, @code{long double}, and
13361 @code{long long} variables on a two-word boundary or a one-word
13362 boundary.  Aligning @code{double} variables on a two-word boundary
13363 produces code that runs somewhat faster on a Pentium at the
13364 expense of more memory.
13366 On x86-64, @option{-malign-double} is enabled by default.
13368 @strong{Warning:} if you use the @option{-malign-double} switch,
13369 structures containing the above types are aligned differently than
13370 the published application binary interface specifications for the 386
13371 and are not binary compatible with structures in code compiled
13372 without that switch.
13374 @item -m96bit-long-double
13375 @itemx -m128bit-long-double
13376 @opindex m96bit-long-double
13377 @opindex m128bit-long-double
13378 These switches control the size of @code{long double} type.  The i386
13379 application binary interface specifies the size to be 96 bits,
13380 so @option{-m96bit-long-double} is the default in 32-bit mode.
13382 Modern architectures (Pentium and newer) prefer @code{long double}
13383 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
13384 conforming to the ABI, this is not possible.  So specifying
13385 @option{-m128bit-long-double} aligns @code{long double}
13386 to a 16-byte boundary by padding the @code{long double} with an additional
13387 32-bit zero.
13389 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
13390 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
13392 Notice that neither of these options enable any extra precision over the x87
13393 standard of 80 bits for a @code{long double}.
13395 @strong{Warning:} if you override the default value for your target ABI, this
13396 changes the size of 
13397 structures and arrays containing @code{long double} variables,
13398 as well as modifying the function calling convention for functions taking
13399 @code{long double}.  Hence they are not binary-compatible
13400 with code compiled without that switch.
13402 @item -mlarge-data-threshold=@var{threshold}
13403 @opindex mlarge-data-threshold
13404 When @option{-mcmodel=medium} is specified, data objects larger than
13405 @var{threshold} are placed in the large data section.  This value must be the
13406 same across all objects linked into the binary, and defaults to 65535.
13408 @item -mrtd
13409 @opindex mrtd
13410 Use a different function-calling convention, in which functions that
13411 take a fixed number of arguments return with the @code{ret @var{num}}
13412 instruction, which pops their arguments while returning.  This saves one
13413 instruction in the caller since there is no need to pop the arguments
13414 there.
13416 You can specify that an individual function is called with this calling
13417 sequence with the function attribute @samp{stdcall}.  You can also
13418 override the @option{-mrtd} option by using the function attribute
13419 @samp{cdecl}.  @xref{Function Attributes}.
13421 @strong{Warning:} this calling convention is incompatible with the one
13422 normally used on Unix, so you cannot use it if you need to call
13423 libraries compiled with the Unix compiler.
13425 Also, you must provide function prototypes for all functions that
13426 take variable numbers of arguments (including @code{printf});
13427 otherwise incorrect code is generated for calls to those
13428 functions.
13430 In addition, seriously incorrect code results if you call a
13431 function with too many arguments.  (Normally, extra arguments are
13432 harmlessly ignored.)
13434 @item -mregparm=@var{num}
13435 @opindex mregparm
13436 Control how many registers are used to pass integer arguments.  By
13437 default, no registers are used to pass arguments, and at most 3
13438 registers can be used.  You can control this behavior for a specific
13439 function by using the function attribute @samp{regparm}.
13440 @xref{Function Attributes}.
13442 @strong{Warning:} if you use this switch, and
13443 @var{num} is nonzero, then you must build all modules with the same
13444 value, including any libraries.  This includes the system libraries and
13445 startup modules.
13447 @item -msseregparm
13448 @opindex msseregparm
13449 Use SSE register passing conventions for float and double arguments
13450 and return values.  You can control this behavior for a specific
13451 function by using the function attribute @samp{sseregparm}.
13452 @xref{Function Attributes}.
13454 @strong{Warning:} if you use this switch then you must build all
13455 modules with the same value, including any libraries.  This includes
13456 the system libraries and startup modules.
13458 @item -mvect8-ret-in-mem
13459 @opindex mvect8-ret-in-mem
13460 Return 8-byte vectors in memory instead of MMX registers.  This is the
13461 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
13462 Studio compilers until version 12.  Later compiler versions (starting
13463 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
13464 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
13465 you need to remain compatible with existing code produced by those
13466 previous compiler versions or older versions of GCC@.
13468 @item -mpc32
13469 @itemx -mpc64
13470 @itemx -mpc80
13471 @opindex mpc32
13472 @opindex mpc64
13473 @opindex mpc80
13475 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
13476 is specified, the significands of results of floating-point operations are
13477 rounded to 24 bits (single precision); @option{-mpc64} rounds the
13478 significands of results of floating-point operations to 53 bits (double
13479 precision) and @option{-mpc80} rounds the significands of results of
13480 floating-point operations to 64 bits (extended double precision), which is
13481 the default.  When this option is used, floating-point operations in higher
13482 precisions are not available to the programmer without setting the FPU
13483 control word explicitly.
13485 Setting the rounding of floating-point operations to less than the default
13486 80 bits can speed some programs by 2% or more.  Note that some mathematical
13487 libraries assume that extended-precision (80-bit) floating-point operations
13488 are enabled by default; routines in such libraries could suffer significant
13489 loss of accuracy, typically through so-called ``catastrophic cancellation'',
13490 when this option is used to set the precision to less than extended precision.
13492 @item -mstackrealign
13493 @opindex mstackrealign
13494 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
13495 option generates an alternate prologue and epilogue that realigns the
13496 run-time stack if necessary.  This supports mixing legacy codes that keep
13497 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
13498 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
13499 applicable to individual functions.
13501 @item -mpreferred-stack-boundary=@var{num}
13502 @opindex mpreferred-stack-boundary
13503 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
13504 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
13505 the default is 4 (16 bytes or 128 bits).
13507 @item -mincoming-stack-boundary=@var{num}
13508 @opindex mincoming-stack-boundary
13509 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
13510 boundary.  If @option{-mincoming-stack-boundary} is not specified,
13511 the one specified by @option{-mpreferred-stack-boundary} is used.
13513 On Pentium and Pentium Pro, @code{double} and @code{long double} values
13514 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
13515 suffer significant run time performance penalties.  On Pentium III, the
13516 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
13517 properly if it is not 16-byte aligned.
13519 To ensure proper alignment of this values on the stack, the stack boundary
13520 must be as aligned as that required by any value stored on the stack.
13521 Further, every function must be generated such that it keeps the stack
13522 aligned.  Thus calling a function compiled with a higher preferred
13523 stack boundary from a function compiled with a lower preferred stack
13524 boundary most likely misaligns the stack.  It is recommended that
13525 libraries that use callbacks always use the default setting.
13527 This extra alignment does consume extra stack space, and generally
13528 increases code size.  Code that is sensitive to stack space usage, such
13529 as embedded systems and operating system kernels, may want to reduce the
13530 preferred alignment to @option{-mpreferred-stack-boundary=2}.
13532 @item -mmmx
13533 @itemx -mno-mmx
13534 @itemx -msse
13535 @itemx -mno-sse
13536 @itemx -msse2
13537 @itemx -mno-sse2
13538 @itemx -msse3
13539 @itemx -mno-sse3
13540 @itemx -mssse3
13541 @itemx -mno-ssse3
13542 @itemx -msse4.1
13543 @need 800
13544 @itemx -mno-sse4.1
13545 @itemx -msse4.2
13546 @itemx -mno-sse4.2
13547 @itemx -msse4
13548 @itemx -mno-sse4
13549 @itemx -mavx
13550 @itemx -mno-avx
13551 @itemx -mavx2
13552 @itemx -mno-avx2
13553 @itemx -maes
13554 @itemx -mno-aes
13555 @itemx -mpclmul
13556 @need 800
13557 @itemx -mno-pclmul
13558 @itemx -mfsgsbase
13559 @itemx -mno-fsgsbase
13560 @itemx -mrdrnd
13561 @itemx -mno-rdrnd
13562 @itemx -mf16c
13563 @itemx -mno-f16c
13564 @itemx -mfma
13565 @itemx -mno-fma
13566 @itemx -msse4a
13567 @itemx -mno-sse4a
13568 @itemx -mfma4
13569 @need 800
13570 @itemx -mno-fma4
13571 @itemx -mxop
13572 @itemx -mno-xop
13573 @itemx -mlwp
13574 @itemx -mno-lwp
13575 @itemx -m3dnow
13576 @itemx -mno-3dnow
13577 @itemx -mpopcnt
13578 @itemx -mno-popcnt
13579 @itemx -mabm
13580 @itemx -mno-abm
13581 @itemx -mbmi
13582 @itemx -mbmi2
13583 @itemx -mno-bmi
13584 @itemx -mno-bmi2
13585 @itemx -mlzcnt
13586 @itemx -mno-lzcnt
13587 @itemx -mrtm
13588 @itemx -mtbm
13589 @itemx -mno-tbm
13590 @opindex mmmx
13591 @opindex mno-mmx
13592 @opindex msse
13593 @opindex mno-sse
13594 @opindex m3dnow
13595 @opindex mno-3dnow
13596 These switches enable or disable the use of instructions in the MMX, SSE,
13597 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
13598 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
13599 extended instruction sets.
13600 These extensions are also available as built-in functions: see
13601 @ref{X86 Built-in Functions}, for details of the functions enabled and
13602 disabled by these switches.
13604 To generate SSE/SSE2 instructions automatically from floating-point
13605 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
13607 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
13608 generates new AVX instructions or AVX equivalence for all SSEx instructions
13609 when needed.
13611 These options enable GCC to use these extended instructions in
13612 generated code, even without @option{-mfpmath=sse}.  Applications that
13613 perform run-time CPU detection must compile separate files for each
13614 supported architecture, using the appropriate flags.  In particular,
13615 the file containing the CPU detection code should be compiled without
13616 these options.
13618 @item -mcld
13619 @opindex mcld
13620 This option instructs GCC to emit a @code{cld} instruction in the prologue
13621 of functions that use string instructions.  String instructions depend on
13622 the DF flag to select between autoincrement or autodecrement mode.  While the
13623 ABI specifies the DF flag to be cleared on function entry, some operating
13624 systems violate this specification by not clearing the DF flag in their
13625 exception dispatchers.  The exception handler can be invoked with the DF flag
13626 set, which leads to wrong direction mode when string instructions are used.
13627 This option can be enabled by default on 32-bit x86 targets by configuring
13628 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
13629 instructions can be suppressed with the @option{-mno-cld} compiler option
13630 in this case.
13632 @item -mvzeroupper
13633 @opindex mvzeroupper
13634 This option instructs GCC to emit a @code{vzeroupper} instruction
13635 before a transfer of control flow out of the function to minimize
13636 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
13637 intrinsics.
13639 @item -mcx16
13640 @opindex mcx16
13641 This option enables GCC to generate @code{CMPXCHG16B} instructions.
13642 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
13643 (or oword) data types.  
13644 This is useful for high-resolution counters that can be updated
13645 by multiple processors (or cores).  This instruction is generated as part of
13646 atomic built-in functions: see @ref{__sync Builtins} or
13647 @ref{__atomic Builtins} for details.
13649 @item -msahf
13650 @opindex msahf
13651 This option enables generation of @code{SAHF} instructions in 64-bit code.
13652 Early Intel Pentium 4 CPUs with Intel 64 support,
13653 prior to the introduction of Pentium 4 G1 step in December 2005,
13654 lacked the @code{LAHF} and @code{SAHF} instructions
13655 which were supported by AMD64.
13656 These are load and store instructions, respectively, for certain status flags.
13657 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
13658 @code{drem}, and @code{remainder} built-in functions;
13659 see @ref{Other Builtins} for details.
13661 @item -mmovbe
13662 @opindex mmovbe
13663 This option enables use of the @code{movbe} instruction to implement
13664 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
13666 @item -mcrc32
13667 @opindex mcrc32
13668 This option enables built-in functions @code{__builtin_ia32_crc32qi},
13669 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
13670 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
13672 @item -mrecip
13673 @opindex mrecip
13674 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
13675 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
13676 with an additional Newton-Raphson step
13677 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
13678 (and their vectorized
13679 variants) for single-precision floating-point arguments.  These instructions
13680 are generated only when @option{-funsafe-math-optimizations} is enabled
13681 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
13682 Note that while the throughput of the sequence is higher than the throughput
13683 of the non-reciprocal instruction, the precision of the sequence can be
13684 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
13686 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
13687 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
13688 combination), and doesn't need @option{-mrecip}.
13690 Also note that GCC emits the above sequence with additional Newton-Raphson step
13691 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
13692 already with @option{-ffast-math} (or the above option combination), and
13693 doesn't need @option{-mrecip}.
13695 @item -mrecip=@var{opt}
13696 @opindex mrecip=opt
13697 This option controls which reciprocal estimate instructions
13698 may be used.  @var{opt} is a comma-separated list of options, which may
13699 be preceded by a @samp{!} to invert the option:
13701 @table @samp
13702 @item all
13703 Enable all estimate instructions.
13705 @item default
13706 Enable the default instructions, equivalent to @option{-mrecip}.
13708 @item none
13709 Disable all estimate instructions, equivalent to @option{-mno-recip}.
13711 @item div
13712 Enable the approximation for scalar division.
13714 @item vec-div
13715 Enable the approximation for vectorized division.
13717 @item sqrt
13718 Enable the approximation for scalar square root.
13720 @item vec-sqrt
13721 Enable the approximation for vectorized square root.
13722 @end table
13724 So, for example, @option{-mrecip=all,!sqrt} enables
13725 all of the reciprocal approximations, except for square root.
13727 @item -mveclibabi=@var{type}
13728 @opindex mveclibabi
13729 Specifies the ABI type to use for vectorizing intrinsics using an
13730 external library.  Supported values for @var{type} are @samp{svml} 
13731 for the Intel short
13732 vector math library and @samp{acml} for the AMD math core library.
13733 To use this option, both @option{-ftree-vectorize} and
13734 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
13735 ABI-compatible library must be specified at link time.
13737 GCC currently emits calls to @code{vmldExp2},
13738 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
13739 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
13740 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
13741 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
13742 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
13743 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
13744 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
13745 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
13746 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
13747 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
13748 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
13749 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
13750 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
13751 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
13752 when @option{-mveclibabi=acml} is used.  
13754 @item -mabi=@var{name}
13755 @opindex mabi
13756 Generate code for the specified calling convention.  Permissible values
13757 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
13758 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
13759 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
13760 You can control this behavior for a specific function by
13761 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
13762 @xref{Function Attributes}.
13764 @item -mtls-dialect=@var{type}
13765 @opindex mtls-dialect
13766 Generate code to access thread-local storage using the @samp{gnu} or
13767 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
13768 @samp{gnu2} is more efficient, but it may add compile- and run-time
13769 requirements that cannot be satisfied on all systems.
13771 @item -mpush-args
13772 @itemx -mno-push-args
13773 @opindex mpush-args
13774 @opindex mno-push-args
13775 Use PUSH operations to store outgoing parameters.  This method is shorter
13776 and usually equally fast as method using SUB/MOV operations and is enabled
13777 by default.  In some cases disabling it may improve performance because of
13778 improved scheduling and reduced dependencies.
13780 @item -maccumulate-outgoing-args
13781 @opindex maccumulate-outgoing-args
13782 If enabled, the maximum amount of space required for outgoing arguments is
13783 computed in the function prologue.  This is faster on most modern CPUs
13784 because of reduced dependencies, improved scheduling and reduced stack usage
13785 when the preferred stack boundary is not equal to 2.  The drawback is a notable
13786 increase in code size.  This switch implies @option{-mno-push-args}.
13788 @item -mthreads
13789 @opindex mthreads
13790 Support thread-safe exception handling on MinGW.  Programs that rely
13791 on thread-safe exception handling must compile and link all code with the
13792 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
13793 @code{-D_MT}; when linking, it links in a special thread helper library
13794 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
13796 @item -mno-align-stringops
13797 @opindex mno-align-stringops
13798 Do not align the destination of inlined string operations.  This switch reduces
13799 code size and improves performance in case the destination is already aligned,
13800 but GCC doesn't know about it.
13802 @item -minline-all-stringops
13803 @opindex minline-all-stringops
13804 By default GCC inlines string operations only when the destination is 
13805 known to be aligned to least a 4-byte boundary.  
13806 This enables more inlining and increases code
13807 size, but may improve performance of code that depends on fast
13808 @code{memcpy}, @code{strlen},
13809 and @code{memset} for short lengths.
13811 @item -minline-stringops-dynamically
13812 @opindex minline-stringops-dynamically
13813 For string operations of unknown size, use run-time checks with
13814 inline code for small blocks and a library call for large blocks.
13816 @item -mstringop-strategy=@var{alg}
13817 @opindex mstringop-strategy=@var{alg}
13818 Override the internal decision heuristic for the particular algorithm to use
13819 for inlining string operations.  The allowed values for @var{alg} are:
13821 @table @samp
13822 @item rep_byte
13823 @itemx rep_4byte
13824 @itemx rep_8byte
13825 Expand using i386 @code{rep} prefix of the specified size.
13827 @item byte_loop
13828 @itemx loop
13829 @itemx unrolled_loop
13830 Expand into an inline loop.
13832 @item libcall
13833 Always use a library call.
13834 @end table
13836 @item -momit-leaf-frame-pointer
13837 @opindex momit-leaf-frame-pointer
13838 Don't keep the frame pointer in a register for leaf functions.  This
13839 avoids the instructions to save, set up, and restore frame pointers and
13840 makes an extra register available in leaf functions.  The option
13841 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
13842 which might make debugging harder.
13844 @item -mtls-direct-seg-refs
13845 @itemx -mno-tls-direct-seg-refs
13846 @opindex mtls-direct-seg-refs
13847 Controls whether TLS variables may be accessed with offsets from the
13848 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
13849 or whether the thread base pointer must be added.  Whether or not this
13850 is valid depends on the operating system, and whether it maps the
13851 segment to cover the entire TLS area.
13853 For systems that use the GNU C Library, the default is on.
13855 @item -msse2avx
13856 @itemx -mno-sse2avx
13857 @opindex msse2avx
13858 Specify that the assembler should encode SSE instructions with VEX
13859 prefix.  The option @option{-mavx} turns this on by default.
13861 @item -mfentry
13862 @itemx -mno-fentry
13863 @opindex mfentry
13864 If profiling is active (@option{-pg}), put the profiling
13865 counter call before the prologue.
13866 Note: On x86 architectures the attribute @code{ms_hook_prologue}
13867 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
13869 @item -m8bit-idiv
13870 @itemx -mno-8bit-idiv
13871 @opindex 8bit-idiv
13872 On some processors, like Intel Atom, 8-bit unsigned integer divide is
13873 much faster than 32-bit/64-bit integer divide.  This option generates a
13874 run-time check.  If both dividend and divisor are within range of 0
13875 to 255, 8-bit unsigned integer divide is used instead of
13876 32-bit/64-bit integer divide.
13878 @item -mavx256-split-unaligned-load
13879 @itemx -mavx256-split-unaligned-store
13880 @opindex avx256-split-unaligned-load
13881 @opindex avx256-split-unaligned-store
13882 Split 32-byte AVX unaligned load and store.
13884 @end table
13886 These @samp{-m} switches are supported in addition to the above
13887 on x86-64 processors in 64-bit environments.
13889 @table @gcctabopt
13890 @item -m32
13891 @itemx -m64
13892 @itemx -mx32
13893 @opindex m32
13894 @opindex m64
13895 @opindex mx32
13896 Generate code for a 32-bit or 64-bit environment.
13897 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
13898 to 32 bits, and
13899 generates code that runs on any i386 system.
13901 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
13902 types to 64 bits, and generates code for the x86-64 architecture.
13903 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
13904 and @option{-mdynamic-no-pic} options.
13906 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
13907 to 32 bits, and
13908 generates code for the x86-64 architecture.
13910 @item -mno-red-zone
13911 @opindex mno-red-zone
13912 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
13913 by the x86-64 ABI; it is a 128-byte area beyond the location of the
13914 stack pointer that is not modified by signal or interrupt handlers
13915 and therefore can be used for temporary data without adjusting the stack
13916 pointer.  The flag @option{-mno-red-zone} disables this red zone.
13918 @item -mcmodel=small
13919 @opindex mcmodel=small
13920 Generate code for the small code model: the program and its symbols must
13921 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
13922 Programs can be statically or dynamically linked.  This is the default
13923 code model.
13925 @item -mcmodel=kernel
13926 @opindex mcmodel=kernel
13927 Generate code for the kernel code model.  The kernel runs in the
13928 negative 2 GB of the address space.
13929 This model has to be used for Linux kernel code.
13931 @item -mcmodel=medium
13932 @opindex mcmodel=medium
13933 Generate code for the medium model: the program is linked in the lower 2
13934 GB of the address space.  Small symbols are also placed there.  Symbols
13935 with sizes larger than @option{-mlarge-data-threshold} are put into
13936 large data or BSS sections and can be located above 2GB.  Programs can
13937 be statically or dynamically linked.
13939 @item -mcmodel=large
13940 @opindex mcmodel=large
13941 Generate code for the large model.  This model makes no assumptions
13942 about addresses and sizes of sections.
13944 @item -maddress-mode=long
13945 @opindex maddress-mode=long
13946 Generate code for long address mode.  This is only supported for 64-bit
13947 and x32 environments.  It is the default address mode for 64-bit
13948 environments.
13950 @item -maddress-mode=short
13951 @opindex maddress-mode=short
13952 Generate code for short address mode.  This is only supported for 32-bit
13953 and x32 environments.  It is the default address mode for 32-bit and
13954 x32 environments.
13955 @end table
13957 @node i386 and x86-64 Windows Options
13958 @subsection i386 and x86-64 Windows Options
13959 @cindex i386 and x86-64 Windows Options
13961 These additional options are available for Microsoft Windows targets:
13963 @table @gcctabopt
13964 @item -mconsole
13965 @opindex mconsole
13966 This option
13967 specifies that a console application is to be generated, by
13968 instructing the linker to set the PE header subsystem type
13969 required for console applications.
13970 This option is available for Cygwin and MinGW targets and is
13971 enabled by default on those targets.
13973 @item -mdll
13974 @opindex mdll
13975 This option is available for Cygwin and MinGW targets.  It
13976 specifies that a DLL---a dynamic link library---is to be
13977 generated, enabling the selection of the required runtime
13978 startup object and entry point.
13980 @item -mnop-fun-dllimport
13981 @opindex mnop-fun-dllimport
13982 This option is available for Cygwin and MinGW targets.  It
13983 specifies that the @code{dllimport} attribute should be ignored.
13985 @item -mthread
13986 @opindex mthread
13987 This option is available for MinGW targets. It specifies
13988 that MinGW-specific thread support is to be used.
13990 @item -municode
13991 @opindex municode
13992 This option is available for MinGW-w64 targets.  It causes
13993 the @code{UNICODE} preprocessor macro to be predefined, and
13994 chooses Unicode-capable runtime startup code.
13996 @item -mwin32
13997 @opindex mwin32
13998 This option is available for Cygwin and MinGW targets.  It
13999 specifies that the typical Microsoft Windows predefined macros are to
14000 be set in the pre-processor, but does not influence the choice
14001 of runtime library/startup code.
14003 @item -mwindows
14004 @opindex mwindows
14005 This option is available for Cygwin and MinGW targets.  It
14006 specifies that a GUI application is to be generated by
14007 instructing the linker to set the PE header subsystem type
14008 appropriately.
14010 @item -fno-set-stack-executable
14011 @opindex fno-set-stack-executable
14012 This option is available for MinGW targets. It specifies that
14013 the executable flag for the stack used by nested functions isn't
14014 set. This is necessary for binaries running in kernel mode of
14015 Microsoft Windows, as there the User32 API, which is used to set executable
14016 privileges, isn't available.
14018 @item -fwritable-relocated-rdata
14019 @opindex fno-writable-relocated-rdata
14020 This option is available for MinGW and Cygwin targets.  It specifies
14021 that relocated-data in read-only section is put into .data
14022 section.  This is a necessary for older runtimes not supporting
14023 modification of .rdata sections for pseudo-relocation.
14025 @item -mpe-aligned-commons
14026 @opindex mpe-aligned-commons
14027 This option is available for Cygwin and MinGW targets.  It
14028 specifies that the GNU extension to the PE file format that
14029 permits the correct alignment of COMMON variables should be
14030 used when generating code.  It is enabled by default if
14031 GCC detects that the target assembler found during configuration
14032 supports the feature.
14033 @end table
14035 See also under @ref{i386 and x86-64 Options} for standard options.
14037 @node IA-64 Options
14038 @subsection IA-64 Options
14039 @cindex IA-64 Options
14041 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14043 @table @gcctabopt
14044 @item -mbig-endian
14045 @opindex mbig-endian
14046 Generate code for a big-endian target.  This is the default for HP-UX@.
14048 @item -mlittle-endian
14049 @opindex mlittle-endian
14050 Generate code for a little-endian target.  This is the default for AIX5
14051 and GNU/Linux.
14053 @item -mgnu-as
14054 @itemx -mno-gnu-as
14055 @opindex mgnu-as
14056 @opindex mno-gnu-as
14057 Generate (or don't) code for the GNU assembler.  This is the default.
14058 @c Also, this is the default if the configure option @option{--with-gnu-as}
14059 @c is used.
14061 @item -mgnu-ld
14062 @itemx -mno-gnu-ld
14063 @opindex mgnu-ld
14064 @opindex mno-gnu-ld
14065 Generate (or don't) code for the GNU linker.  This is the default.
14066 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14067 @c is used.
14069 @item -mno-pic
14070 @opindex mno-pic
14071 Generate code that does not use a global pointer register.  The result
14072 is not position independent code, and violates the IA-64 ABI@.
14074 @item -mvolatile-asm-stop
14075 @itemx -mno-volatile-asm-stop
14076 @opindex mvolatile-asm-stop
14077 @opindex mno-volatile-asm-stop
14078 Generate (or don't) a stop bit immediately before and after volatile asm
14079 statements.
14081 @item -mregister-names
14082 @itemx -mno-register-names
14083 @opindex mregister-names
14084 @opindex mno-register-names
14085 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14086 the stacked registers.  This may make assembler output more readable.
14088 @item -mno-sdata
14089 @itemx -msdata
14090 @opindex mno-sdata
14091 @opindex msdata
14092 Disable (or enable) optimizations that use the small data section.  This may
14093 be useful for working around optimizer bugs.
14095 @item -mconstant-gp
14096 @opindex mconstant-gp
14097 Generate code that uses a single constant global pointer value.  This is
14098 useful when compiling kernel code.
14100 @item -mauto-pic
14101 @opindex mauto-pic
14102 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
14103 This is useful when compiling firmware code.
14105 @item -minline-float-divide-min-latency
14106 @opindex minline-float-divide-min-latency
14107 Generate code for inline divides of floating-point values
14108 using the minimum latency algorithm.
14110 @item -minline-float-divide-max-throughput
14111 @opindex minline-float-divide-max-throughput
14112 Generate code for inline divides of floating-point values
14113 using the maximum throughput algorithm.
14115 @item -mno-inline-float-divide
14116 @opindex mno-inline-float-divide
14117 Do not generate inline code for divides of floating-point values.
14119 @item -minline-int-divide-min-latency
14120 @opindex minline-int-divide-min-latency
14121 Generate code for inline divides of integer values
14122 using the minimum latency algorithm.
14124 @item -minline-int-divide-max-throughput
14125 @opindex minline-int-divide-max-throughput
14126 Generate code for inline divides of integer values
14127 using the maximum throughput algorithm.
14129 @item -mno-inline-int-divide
14130 @opindex mno-inline-int-divide
14131 Do not generate inline code for divides of integer values.
14133 @item -minline-sqrt-min-latency
14134 @opindex minline-sqrt-min-latency
14135 Generate code for inline square roots
14136 using the minimum latency algorithm.
14138 @item -minline-sqrt-max-throughput
14139 @opindex minline-sqrt-max-throughput
14140 Generate code for inline square roots
14141 using the maximum throughput algorithm.
14143 @item -mno-inline-sqrt
14144 @opindex mno-inline-sqrt
14145 Do not generate inline code for @code{sqrt}.
14147 @item -mfused-madd
14148 @itemx -mno-fused-madd
14149 @opindex mfused-madd
14150 @opindex mno-fused-madd
14151 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14152 instructions.  The default is to use these instructions.
14154 @item -mno-dwarf2-asm
14155 @itemx -mdwarf2-asm
14156 @opindex mno-dwarf2-asm
14157 @opindex mdwarf2-asm
14158 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14159 info.  This may be useful when not using the GNU assembler.
14161 @item -mearly-stop-bits
14162 @itemx -mno-early-stop-bits
14163 @opindex mearly-stop-bits
14164 @opindex mno-early-stop-bits
14165 Allow stop bits to be placed earlier than immediately preceding the
14166 instruction that triggered the stop bit.  This can improve instruction
14167 scheduling, but does not always do so.
14169 @item -mfixed-range=@var{register-range}
14170 @opindex mfixed-range
14171 Generate code treating the given register range as fixed registers.
14172 A fixed register is one that the register allocator cannot use.  This is
14173 useful when compiling kernel code.  A register range is specified as
14174 two registers separated by a dash.  Multiple register ranges can be
14175 specified separated by a comma.
14177 @item -mtls-size=@var{tls-size}
14178 @opindex mtls-size
14179 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
14182 @item -mtune=@var{cpu-type}
14183 @opindex mtune
14184 Tune the instruction scheduling for a particular CPU, Valid values are
14185 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
14186 and @samp{mckinley}.
14188 @item -milp32
14189 @itemx -mlp64
14190 @opindex milp32
14191 @opindex mlp64
14192 Generate code for a 32-bit or 64-bit environment.
14193 The 32-bit environment sets int, long and pointer to 32 bits.
14194 The 64-bit environment sets int to 32 bits and long and pointer
14195 to 64 bits.  These are HP-UX specific flags.
14197 @item -mno-sched-br-data-spec
14198 @itemx -msched-br-data-spec
14199 @opindex mno-sched-br-data-spec
14200 @opindex msched-br-data-spec
14201 (Dis/En)able data speculative scheduling before reload.
14202 This results in generation of @code{ld.a} instructions and
14203 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14204 The default is 'disable'.
14206 @item -msched-ar-data-spec
14207 @itemx -mno-sched-ar-data-spec
14208 @opindex msched-ar-data-spec
14209 @opindex mno-sched-ar-data-spec
14210 (En/Dis)able data speculative scheduling after reload.
14211 This results in generation of @code{ld.a} instructions and
14212 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14213 The default is 'enable'.
14215 @item -mno-sched-control-spec
14216 @itemx -msched-control-spec
14217 @opindex mno-sched-control-spec
14218 @opindex msched-control-spec
14219 (Dis/En)able control speculative scheduling.  This feature is
14220 available only during region scheduling (i.e.@: before reload).
14221 This results in generation of the @code{ld.s} instructions and
14222 the corresponding check instructions @code{chk.s}.
14223 The default is 'disable'.
14225 @item -msched-br-in-data-spec
14226 @itemx -mno-sched-br-in-data-spec
14227 @opindex msched-br-in-data-spec
14228 @opindex mno-sched-br-in-data-spec
14229 (En/Dis)able speculative scheduling of the instructions that
14230 are dependent on the data speculative loads before reload.
14231 This is effective only with @option{-msched-br-data-spec} enabled.
14232 The default is 'enable'.
14234 @item -msched-ar-in-data-spec
14235 @itemx -mno-sched-ar-in-data-spec
14236 @opindex msched-ar-in-data-spec
14237 @opindex mno-sched-ar-in-data-spec
14238 (En/Dis)able speculative scheduling of the instructions that
14239 are dependent on the data speculative loads after reload.
14240 This is effective only with @option{-msched-ar-data-spec} enabled.
14241 The default is 'enable'.
14243 @item -msched-in-control-spec
14244 @itemx -mno-sched-in-control-spec
14245 @opindex msched-in-control-spec
14246 @opindex mno-sched-in-control-spec
14247 (En/Dis)able speculative scheduling of the instructions that
14248 are dependent on the control speculative loads.
14249 This is effective only with @option{-msched-control-spec} enabled.
14250 The default is 'enable'.
14252 @item -mno-sched-prefer-non-data-spec-insns
14253 @itemx -msched-prefer-non-data-spec-insns
14254 @opindex mno-sched-prefer-non-data-spec-insns
14255 @opindex msched-prefer-non-data-spec-insns
14256 If enabled, data-speculative instructions are chosen for schedule
14257 only if there are no other choices at the moment.  This makes
14258 the use of the data speculation much more conservative.
14259 The default is 'disable'.
14261 @item -mno-sched-prefer-non-control-spec-insns
14262 @itemx -msched-prefer-non-control-spec-insns
14263 @opindex mno-sched-prefer-non-control-spec-insns
14264 @opindex msched-prefer-non-control-spec-insns
14265 If enabled, control-speculative instructions are chosen for schedule
14266 only if there are no other choices at the moment.  This makes
14267 the use of the control speculation much more conservative.
14268 The default is 'disable'.
14270 @item -mno-sched-count-spec-in-critical-path
14271 @itemx -msched-count-spec-in-critical-path
14272 @opindex mno-sched-count-spec-in-critical-path
14273 @opindex msched-count-spec-in-critical-path
14274 If enabled, speculative dependencies are considered during
14275 computation of the instructions priorities.  This makes the use of the
14276 speculation a bit more conservative.
14277 The default is 'disable'.
14279 @item -msched-spec-ldc
14280 @opindex msched-spec-ldc
14281 Use a simple data speculation check.  This option is on by default.
14283 @item -msched-control-spec-ldc
14284 @opindex msched-spec-ldc
14285 Use a simple check for control speculation.  This option is on by default.
14287 @item -msched-stop-bits-after-every-cycle
14288 @opindex msched-stop-bits-after-every-cycle
14289 Place a stop bit after every cycle when scheduling.  This option is on
14290 by default.
14292 @item -msched-fp-mem-deps-zero-cost
14293 @opindex msched-fp-mem-deps-zero-cost
14294 Assume that floating-point stores and loads are not likely to cause a conflict
14295 when placed into the same instruction group.  This option is disabled by
14296 default.
14298 @item -msel-sched-dont-check-control-spec
14299 @opindex msel-sched-dont-check-control-spec
14300 Generate checks for control speculation in selective scheduling.
14301 This flag is disabled by default.
14303 @item -msched-max-memory-insns=@var{max-insns}
14304 @opindex msched-max-memory-insns
14305 Limit on the number of memory insns per instruction group, giving lower
14306 priority to subsequent memory insns attempting to schedule in the same
14307 instruction group. Frequently useful to prevent cache bank conflicts.
14308 The default value is 1.
14310 @item -msched-max-memory-insns-hard-limit
14311 @opindex msched-max-memory-insns-hard-limit
14312 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
14313 disallowing more than that number in an instruction group.
14314 Otherwise, the limit is ``soft'', meaning that non-memory operations
14315 are preferred when the limit is reached, but memory operations may still
14316 be scheduled.
14318 @end table
14320 @node LM32 Options
14321 @subsection LM32 Options
14322 @cindex LM32 options
14324 These @option{-m} options are defined for the Lattice Mico32 architecture:
14326 @table @gcctabopt
14327 @item -mbarrel-shift-enabled
14328 @opindex mbarrel-shift-enabled
14329 Enable barrel-shift instructions.
14331 @item -mdivide-enabled
14332 @opindex mdivide-enabled
14333 Enable divide and modulus instructions.
14335 @item -mmultiply-enabled
14336 @opindex multiply-enabled
14337 Enable multiply instructions.
14339 @item -msign-extend-enabled
14340 @opindex msign-extend-enabled
14341 Enable sign extend instructions.
14343 @item -muser-enabled
14344 @opindex muser-enabled
14345 Enable user-defined instructions.
14347 @end table
14349 @node M32C Options
14350 @subsection M32C Options
14351 @cindex M32C options
14353 @table @gcctabopt
14354 @item -mcpu=@var{name}
14355 @opindex mcpu=
14356 Select the CPU for which code is generated.  @var{name} may be one of
14357 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
14358 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
14359 the M32C/80 series.
14361 @item -msim
14362 @opindex msim
14363 Specifies that the program will be run on the simulator.  This causes
14364 an alternate runtime library to be linked in which supports, for
14365 example, file I/O@.  You must not use this option when generating
14366 programs that will run on real hardware; you must provide your own
14367 runtime library for whatever I/O functions are needed.
14369 @item -memregs=@var{number}
14370 @opindex memregs=
14371 Specifies the number of memory-based pseudo-registers GCC will use
14372 during code generation.  These pseudo-registers will be used like real
14373 registers, so there is a tradeoff between GCC's ability to fit the
14374 code into available registers, and the performance penalty of using
14375 memory instead of registers.  Note that all modules in a program must
14376 be compiled with the same value for this option.  Because of that, you
14377 must not use this option with the default runtime libraries gcc
14378 builds.
14380 @end table
14382 @node M32R/D Options
14383 @subsection M32R/D Options
14384 @cindex M32R/D options
14386 These @option{-m} options are defined for Renesas M32R/D architectures:
14388 @table @gcctabopt
14389 @item -m32r2
14390 @opindex m32r2
14391 Generate code for the M32R/2@.
14393 @item -m32rx
14394 @opindex m32rx
14395 Generate code for the M32R/X@.
14397 @item -m32r
14398 @opindex m32r
14399 Generate code for the M32R@.  This is the default.
14401 @item -mmodel=small
14402 @opindex mmodel=small
14403 Assume all objects live in the lower 16MB of memory (so that their addresses
14404 can be loaded with the @code{ld24} instruction), and assume all subroutines
14405 are reachable with the @code{bl} instruction.
14406 This is the default.
14408 The addressability of a particular object can be set with the
14409 @code{model} attribute.
14411 @item -mmodel=medium
14412 @opindex mmodel=medium
14413 Assume objects may be anywhere in the 32-bit address space (the compiler
14414 will generate @code{seth/add3} instructions to load their addresses), and
14415 assume all subroutines are reachable with the @code{bl} instruction.
14417 @item -mmodel=large
14418 @opindex mmodel=large
14419 Assume objects may be anywhere in the 32-bit address space (the compiler
14420 will generate @code{seth/add3} instructions to load their addresses), and
14421 assume subroutines may not be reachable with the @code{bl} instruction
14422 (the compiler will generate the much slower @code{seth/add3/jl}
14423 instruction sequence).
14425 @item -msdata=none
14426 @opindex msdata=none
14427 Disable use of the small data area.  Variables will be put into
14428 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
14429 @code{section} attribute has been specified).
14430 This is the default.
14432 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
14433 Objects may be explicitly put in the small data area with the
14434 @code{section} attribute using one of these sections.
14436 @item -msdata=sdata
14437 @opindex msdata=sdata
14438 Put small global and static data in the small data area, but do not
14439 generate special code to reference them.
14441 @item -msdata=use
14442 @opindex msdata=use
14443 Put small global and static data in the small data area, and generate
14444 special instructions to reference them.
14446 @item -G @var{num}
14447 @opindex G
14448 @cindex smaller data references
14449 Put global and static objects less than or equal to @var{num} bytes
14450 into the small data or bss sections instead of the normal data or bss
14451 sections.  The default value of @var{num} is 8.
14452 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
14453 for this option to have any effect.
14455 All modules should be compiled with the same @option{-G @var{num}} value.
14456 Compiling with different values of @var{num} may or may not work; if it
14457 doesn't the linker will give an error message---incorrect code will not be
14458 generated.
14460 @item -mdebug
14461 @opindex mdebug
14462 Makes the M32R specific code in the compiler display some statistics
14463 that might help in debugging programs.
14465 @item -malign-loops
14466 @opindex malign-loops
14467 Align all loops to a 32-byte boundary.
14469 @item -mno-align-loops
14470 @opindex mno-align-loops
14471 Do not enforce a 32-byte alignment for loops.  This is the default.
14473 @item -missue-rate=@var{number}
14474 @opindex missue-rate=@var{number}
14475 Issue @var{number} instructions per cycle.  @var{number} can only be 1
14476 or 2.
14478 @item -mbranch-cost=@var{number}
14479 @opindex mbranch-cost=@var{number}
14480 @var{number} can only be 1 or 2.  If it is 1 then branches will be
14481 preferred over conditional code, if it is 2, then the opposite will
14482 apply.
14484 @item -mflush-trap=@var{number}
14485 @opindex mflush-trap=@var{number}
14486 Specifies the trap number to use to flush the cache.  The default is
14487 12.  Valid numbers are between 0 and 15 inclusive.
14489 @item -mno-flush-trap
14490 @opindex mno-flush-trap
14491 Specifies that the cache cannot be flushed by using a trap.
14493 @item -mflush-func=@var{name}
14494 @opindex mflush-func=@var{name}
14495 Specifies the name of the operating system function to call to flush
14496 the cache.  The default is @emph{_flush_cache}, but a function call
14497 will only be used if a trap is not available.
14499 @item -mno-flush-func
14500 @opindex mno-flush-func
14501 Indicates that there is no OS function for flushing the cache.
14503 @end table
14505 @node M680x0 Options
14506 @subsection M680x0 Options
14507 @cindex M680x0 options
14509 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
14510 The default settings depend on which architecture was selected when
14511 the compiler was configured; the defaults for the most common choices
14512 are given below.
14514 @table @gcctabopt
14515 @item -march=@var{arch}
14516 @opindex march
14517 Generate code for a specific M680x0 or ColdFire instruction set
14518 architecture.  Permissible values of @var{arch} for M680x0
14519 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
14520 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
14521 architectures are selected according to Freescale's ISA classification
14522 and the permissible values are: @samp{isaa}, @samp{isaaplus},
14523 @samp{isab} and @samp{isac}.
14525 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
14526 code for a ColdFire target.  The @var{arch} in this macro is one of the
14527 @option{-march} arguments given above.
14529 When used together, @option{-march} and @option{-mtune} select code
14530 that runs on a family of similar processors but that is optimized
14531 for a particular microarchitecture.
14533 @item -mcpu=@var{cpu}
14534 @opindex mcpu
14535 Generate code for a specific M680x0 or ColdFire processor.
14536 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
14537 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
14538 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
14539 below, which also classifies the CPUs into families:
14541 @multitable @columnfractions 0.20 0.80
14542 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
14543 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
14544 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
14545 @item @samp{5206e} @tab @samp{5206e}
14546 @item @samp{5208} @tab @samp{5207} @samp{5208}
14547 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
14548 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
14549 @item @samp{5216} @tab @samp{5214} @samp{5216}
14550 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
14551 @item @samp{5225} @tab @samp{5224} @samp{5225}
14552 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
14553 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
14554 @item @samp{5249} @tab @samp{5249}
14555 @item @samp{5250} @tab @samp{5250}
14556 @item @samp{5271} @tab @samp{5270} @samp{5271}
14557 @item @samp{5272} @tab @samp{5272}
14558 @item @samp{5275} @tab @samp{5274} @samp{5275}
14559 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
14560 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
14561 @item @samp{5307} @tab @samp{5307}
14562 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
14563 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
14564 @item @samp{5407} @tab @samp{5407}
14565 @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}
14566 @end multitable
14568 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
14569 @var{arch} is compatible with @var{cpu}.  Other combinations of
14570 @option{-mcpu} and @option{-march} are rejected.
14572 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
14573 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
14574 where the value of @var{family} is given by the table above.
14576 @item -mtune=@var{tune}
14577 @opindex mtune
14578 Tune the code for a particular microarchitecture, within the
14579 constraints set by @option{-march} and @option{-mcpu}.
14580 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
14581 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
14582 and @samp{cpu32}.  The ColdFire microarchitectures
14583 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
14585 You can also use @option{-mtune=68020-40} for code that needs
14586 to run relatively well on 68020, 68030 and 68040 targets.
14587 @option{-mtune=68020-60} is similar but includes 68060 targets
14588 as well.  These two options select the same tuning decisions as
14589 @option{-m68020-40} and @option{-m68020-60} respectively.
14591 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
14592 when tuning for 680x0 architecture @var{arch}.  It also defines
14593 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
14594 option is used.  If GCC is tuning for a range of architectures,
14595 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
14596 it defines the macros for every architecture in the range.
14598 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
14599 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
14600 of the arguments given above.
14602 @item -m68000
14603 @itemx -mc68000
14604 @opindex m68000
14605 @opindex mc68000
14606 Generate output for a 68000.  This is the default
14607 when the compiler is configured for 68000-based systems.
14608 It is equivalent to @option{-march=68000}.
14610 Use this option for microcontrollers with a 68000 or EC000 core,
14611 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
14613 @item -m68010
14614 @opindex m68010
14615 Generate output for a 68010.  This is the default
14616 when the compiler is configured for 68010-based systems.
14617 It is equivalent to @option{-march=68010}.
14619 @item -m68020
14620 @itemx -mc68020
14621 @opindex m68020
14622 @opindex mc68020
14623 Generate output for a 68020.  This is the default
14624 when the compiler is configured for 68020-based systems.
14625 It is equivalent to @option{-march=68020}.
14627 @item -m68030
14628 @opindex m68030
14629 Generate output for a 68030.  This is the default when the compiler is
14630 configured for 68030-based systems.  It is equivalent to
14631 @option{-march=68030}.
14633 @item -m68040
14634 @opindex m68040
14635 Generate output for a 68040.  This is the default when the compiler is
14636 configured for 68040-based systems.  It is equivalent to
14637 @option{-march=68040}.
14639 This option inhibits the use of 68881/68882 instructions that have to be
14640 emulated by software on the 68040.  Use this option if your 68040 does not
14641 have code to emulate those instructions.
14643 @item -m68060
14644 @opindex m68060
14645 Generate output for a 68060.  This is the default when the compiler is
14646 configured for 68060-based systems.  It is equivalent to
14647 @option{-march=68060}.
14649 This option inhibits the use of 68020 and 68881/68882 instructions that
14650 have to be emulated by software on the 68060.  Use this option if your 68060
14651 does not have code to emulate those instructions.
14653 @item -mcpu32
14654 @opindex mcpu32
14655 Generate output for a CPU32.  This is the default
14656 when the compiler is configured for CPU32-based systems.
14657 It is equivalent to @option{-march=cpu32}.
14659 Use this option for microcontrollers with a
14660 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
14661 68336, 68340, 68341, 68349 and 68360.
14663 @item -m5200
14664 @opindex m5200
14665 Generate output for a 520X ColdFire CPU@.  This is the default
14666 when the compiler is configured for 520X-based systems.
14667 It is equivalent to @option{-mcpu=5206}, and is now deprecated
14668 in favor of that option.
14670 Use this option for microcontroller with a 5200 core, including
14671 the MCF5202, MCF5203, MCF5204 and MCF5206.
14673 @item -m5206e
14674 @opindex m5206e
14675 Generate output for a 5206e ColdFire CPU@.  The option is now
14676 deprecated in favor of the equivalent @option{-mcpu=5206e}.
14678 @item -m528x
14679 @opindex m528x
14680 Generate output for a member of the ColdFire 528X family.
14681 The option is now deprecated in favor of the equivalent
14682 @option{-mcpu=528x}.
14684 @item -m5307
14685 @opindex m5307
14686 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
14687 in favor of the equivalent @option{-mcpu=5307}.
14689 @item -m5407
14690 @opindex m5407
14691 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
14692 in favor of the equivalent @option{-mcpu=5407}.
14694 @item -mcfv4e
14695 @opindex mcfv4e
14696 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
14697 This includes use of hardware floating-point instructions.
14698 The option is equivalent to @option{-mcpu=547x}, and is now
14699 deprecated in favor of that option.
14701 @item -m68020-40
14702 @opindex m68020-40
14703 Generate output for a 68040, without using any of the new instructions.
14704 This results in code that can run relatively efficiently on either a
14705 68020/68881 or a 68030 or a 68040.  The generated code does use the
14706 68881 instructions that are emulated on the 68040.
14708 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
14710 @item -m68020-60
14711 @opindex m68020-60
14712 Generate output for a 68060, without using any of the new instructions.
14713 This results in code that can run relatively efficiently on either a
14714 68020/68881 or a 68030 or a 68040.  The generated code does use the
14715 68881 instructions that are emulated on the 68060.
14717 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
14719 @item -mhard-float
14720 @itemx -m68881
14721 @opindex mhard-float
14722 @opindex m68881
14723 Generate floating-point instructions.  This is the default for 68020
14724 and above, and for ColdFire devices that have an FPU@.  It defines the
14725 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
14726 on ColdFire targets.
14728 @item -msoft-float
14729 @opindex msoft-float
14730 Do not generate floating-point instructions; use library calls instead.
14731 This is the default for 68000, 68010, and 68832 targets.  It is also
14732 the default for ColdFire devices that have no FPU.
14734 @item -mdiv
14735 @itemx -mno-div
14736 @opindex mdiv
14737 @opindex mno-div
14738 Generate (do not generate) ColdFire hardware divide and remainder
14739 instructions.  If @option{-march} is used without @option{-mcpu},
14740 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
14741 architectures.  Otherwise, the default is taken from the target CPU
14742 (either the default CPU, or the one specified by @option{-mcpu}).  For
14743 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
14744 @option{-mcpu=5206e}.
14746 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
14748 @item -mshort
14749 @opindex mshort
14750 Consider type @code{int} to be 16 bits wide, like @code{short int}.
14751 Additionally, parameters passed on the stack are also aligned to a
14752 16-bit boundary even on targets whose API mandates promotion to 32-bit.
14754 @item -mno-short
14755 @opindex mno-short
14756 Do not consider type @code{int} to be 16 bits wide.  This is the default.
14758 @item -mnobitfield
14759 @itemx -mno-bitfield
14760 @opindex mnobitfield
14761 @opindex mno-bitfield
14762 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
14763 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
14765 @item -mbitfield
14766 @opindex mbitfield
14767 Do use the bit-field instructions.  The @option{-m68020} option implies
14768 @option{-mbitfield}.  This is the default if you use a configuration
14769 designed for a 68020.
14771 @item -mrtd
14772 @opindex mrtd
14773 Use a different function-calling convention, in which functions
14774 that take a fixed number of arguments return with the @code{rtd}
14775 instruction, which pops their arguments while returning.  This
14776 saves one instruction in the caller since there is no need to pop
14777 the arguments there.
14779 This calling convention is incompatible with the one normally
14780 used on Unix, so you cannot use it if you need to call libraries
14781 compiled with the Unix compiler.
14783 Also, you must provide function prototypes for all functions that
14784 take variable numbers of arguments (including @code{printf});
14785 otherwise incorrect code will be generated for calls to those
14786 functions.
14788 In addition, seriously incorrect code will result if you call a
14789 function with too many arguments.  (Normally, extra arguments are
14790 harmlessly ignored.)
14792 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
14793 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
14795 @item -mno-rtd
14796 @opindex mno-rtd
14797 Do not use the calling conventions selected by @option{-mrtd}.
14798 This is the default.
14800 @item -malign-int
14801 @itemx -mno-align-int
14802 @opindex malign-int
14803 @opindex mno-align-int
14804 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
14805 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
14806 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
14807 Aligning variables on 32-bit boundaries produces code that runs somewhat
14808 faster on processors with 32-bit busses at the expense of more memory.
14810 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
14811 align structures containing the above types  differently than
14812 most published application binary interface specifications for the m68k.
14814 @item -mpcrel
14815 @opindex mpcrel
14816 Use the pc-relative addressing mode of the 68000 directly, instead of
14817 using a global offset table.  At present, this option implies @option{-fpic},
14818 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
14819 not presently supported with @option{-mpcrel}, though this could be supported for
14820 68020 and higher processors.
14822 @item -mno-strict-align
14823 @itemx -mstrict-align
14824 @opindex mno-strict-align
14825 @opindex mstrict-align
14826 Do not (do) assume that unaligned memory references will be handled by
14827 the system.
14829 @item -msep-data
14830 Generate code that allows the data segment to be located in a different
14831 area of memory from the text segment.  This allows for execute in place in
14832 an environment without virtual memory management.  This option implies
14833 @option{-fPIC}.
14835 @item -mno-sep-data
14836 Generate code that assumes that the data segment follows the text segment.
14837 This is the default.
14839 @item -mid-shared-library
14840 Generate code that supports shared libraries via the library ID method.
14841 This allows for execute in place and shared libraries in an environment
14842 without virtual memory management.  This option implies @option{-fPIC}.
14844 @item -mno-id-shared-library
14845 Generate code that doesn't assume ID based shared libraries are being used.
14846 This is the default.
14848 @item -mshared-library-id=n
14849 Specified the identification number of the ID based shared library being
14850 compiled.  Specifying a value of 0 will generate more compact code, specifying
14851 other values will force the allocation of that number to the current
14852 library but is no more space or time efficient than omitting this option.
14854 @item -mxgot
14855 @itemx -mno-xgot
14856 @opindex mxgot
14857 @opindex mno-xgot
14858 When generating position-independent code for ColdFire, generate code
14859 that works if the GOT has more than 8192 entries.  This code is
14860 larger and slower than code generated without this option.  On M680x0
14861 processors, this option is not needed; @option{-fPIC} suffices.
14863 GCC normally uses a single instruction to load values from the GOT@.
14864 While this is relatively efficient, it only works if the GOT
14865 is smaller than about 64k.  Anything larger causes the linker
14866 to report an error such as:
14868 @cindex relocation truncated to fit (ColdFire)
14869 @smallexample
14870 relocation truncated to fit: R_68K_GOT16O foobar
14871 @end smallexample
14873 If this happens, you should recompile your code with @option{-mxgot}.
14874 It should then work with very large GOTs.  However, code generated with
14875 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
14876 the value of a global symbol.
14878 Note that some linkers, including newer versions of the GNU linker,
14879 can create multiple GOTs and sort GOT entries.  If you have such a linker,
14880 you should only need to use @option{-mxgot} when compiling a single
14881 object file that accesses more than 8192 GOT entries.  Very few do.
14883 These options have no effect unless GCC is generating
14884 position-independent code.
14886 @end table
14888 @node MCore Options
14889 @subsection MCore Options
14890 @cindex MCore options
14892 These are the @samp{-m} options defined for the Motorola M*Core
14893 processors.
14895 @table @gcctabopt
14897 @item -mhardlit
14898 @itemx -mno-hardlit
14899 @opindex mhardlit
14900 @opindex mno-hardlit
14901 Inline constants into the code stream if it can be done in two
14902 instructions or less.
14904 @item -mdiv
14905 @itemx -mno-div
14906 @opindex mdiv
14907 @opindex mno-div
14908 Use the divide instruction.  (Enabled by default).
14910 @item -mrelax-immediate
14911 @itemx -mno-relax-immediate
14912 @opindex mrelax-immediate
14913 @opindex mno-relax-immediate
14914 Allow arbitrary sized immediates in bit operations.
14916 @item -mwide-bitfields
14917 @itemx -mno-wide-bitfields
14918 @opindex mwide-bitfields
14919 @opindex mno-wide-bitfields
14920 Always treat bit-fields as int-sized.
14922 @item -m4byte-functions
14923 @itemx -mno-4byte-functions
14924 @opindex m4byte-functions
14925 @opindex mno-4byte-functions
14926 Force all functions to be aligned to a 4-byte boundary.
14928 @item -mcallgraph-data
14929 @itemx -mno-callgraph-data
14930 @opindex mcallgraph-data
14931 @opindex mno-callgraph-data
14932 Emit callgraph information.
14934 @item -mslow-bytes
14935 @itemx -mno-slow-bytes
14936 @opindex mslow-bytes
14937 @opindex mno-slow-bytes
14938 Prefer word access when reading byte quantities.
14940 @item -mlittle-endian
14941 @itemx -mbig-endian
14942 @opindex mlittle-endian
14943 @opindex mbig-endian
14944 Generate code for a little-endian target.
14946 @item -m210
14947 @itemx -m340
14948 @opindex m210
14949 @opindex m340
14950 Generate code for the 210 processor.
14952 @item -mno-lsim
14953 @opindex mno-lsim
14954 Assume that runtime support has been provided and so omit the
14955 simulator library (@file{libsim.a)} from the linker command line.
14957 @item -mstack-increment=@var{size}
14958 @opindex mstack-increment
14959 Set the maximum amount for a single stack increment operation.  Large
14960 values can increase the speed of programs that contain functions
14961 that need a large amount of stack space, but they can also trigger a
14962 segmentation fault if the stack is extended too much.  The default
14963 value is 0x1000.
14965 @end table
14967 @node MeP Options
14968 @subsection MeP Options
14969 @cindex MeP options
14971 @table @gcctabopt
14973 @item -mabsdiff
14974 @opindex mabsdiff
14975 Enables the @code{abs} instruction, which is the absolute difference
14976 between two registers.
14978 @item -mall-opts
14979 @opindex mall-opts
14980 Enables all the optional instructions - average, multiply, divide, bit
14981 operations, leading zero, absolute difference, min/max, clip, and
14982 saturation.
14985 @item -maverage
14986 @opindex maverage
14987 Enables the @code{ave} instruction, which computes the average of two
14988 registers.
14990 @item -mbased=@var{n}
14991 @opindex mbased=
14992 Variables of size @var{n} bytes or smaller will be placed in the
14993 @code{.based} section by default.  Based variables use the @code{$tp}
14994 register as a base register, and there is a 128-byte limit to the
14995 @code{.based} section.
14997 @item -mbitops
14998 @opindex mbitops
14999 Enables the bit operation instructions - bit test (@code{btstm}), set
15000 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15001 test-and-set (@code{tas}).
15003 @item -mc=@var{name}
15004 @opindex mc=
15005 Selects which section constant data will be placed in.  @var{name} may
15006 be @code{tiny}, @code{near}, or @code{far}.
15008 @item -mclip
15009 @opindex mclip
15010 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
15011 useful unless you also provide @code{-mminmax}.
15013 @item -mconfig=@var{name}
15014 @opindex mconfig=
15015 Selects one of the build-in core configurations.  Each MeP chip has
15016 one or more modules in it; each module has a core CPU and a variety of
15017 coprocessors, optional instructions, and peripherals.  The
15018 @code{MeP-Integrator} tool, not part of GCC, provides these
15019 configurations through this option; using this option is the same as
15020 using all the corresponding command-line options.  The default
15021 configuration is @code{default}.
15023 @item -mcop
15024 @opindex mcop
15025 Enables the coprocessor instructions.  By default, this is a 32-bit
15026 coprocessor.  Note that the coprocessor is normally enabled via the
15027 @code{-mconfig=} option.
15029 @item -mcop32
15030 @opindex mcop32
15031 Enables the 32-bit coprocessor's instructions.
15033 @item -mcop64
15034 @opindex mcop64
15035 Enables the 64-bit coprocessor's instructions.
15037 @item -mivc2
15038 @opindex mivc2
15039 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
15041 @item -mdc
15042 @opindex mdc
15043 Causes constant variables to be placed in the @code{.near} section.
15045 @item -mdiv
15046 @opindex mdiv
15047 Enables the @code{div} and @code{divu} instructions.
15049 @item -meb
15050 @opindex meb
15051 Generate big-endian code.
15053 @item -mel
15054 @opindex mel
15055 Generate little-endian code.
15057 @item -mio-volatile
15058 @opindex mio-volatile
15059 Tells the compiler that any variable marked with the @code{io}
15060 attribute is to be considered volatile.
15062 @item -ml
15063 @opindex ml
15064 Causes variables to be assigned to the @code{.far} section by default.
15066 @item -mleadz
15067 @opindex mleadz
15068 Enables the @code{leadz} (leading zero) instruction.
15070 @item -mm
15071 @opindex mm
15072 Causes variables to be assigned to the @code{.near} section by default.
15074 @item -mminmax
15075 @opindex mminmax
15076 Enables the @code{min} and @code{max} instructions.
15078 @item -mmult
15079 @opindex mmult
15080 Enables the multiplication and multiply-accumulate instructions.
15082 @item -mno-opts
15083 @opindex mno-opts
15084 Disables all the optional instructions enabled by @code{-mall-opts}.
15086 @item -mrepeat
15087 @opindex mrepeat
15088 Enables the @code{repeat} and @code{erepeat} instructions, used for
15089 low-overhead looping.
15091 @item -ms
15092 @opindex ms
15093 Causes all variables to default to the @code{.tiny} section.  Note
15094 that there is a 65536-byte limit to this section.  Accesses to these
15095 variables use the @code{%gp} base register.
15097 @item -msatur
15098 @opindex msatur
15099 Enables the saturation instructions.  Note that the compiler does not
15100 currently generate these itself, but this option is included for
15101 compatibility with other tools, like @code{as}.
15103 @item -msdram
15104 @opindex msdram
15105 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15107 @item -msim
15108 @opindex msim
15109 Link the simulator runtime libraries.
15111 @item -msimnovec
15112 @opindex msimnovec
15113 Link the simulator runtime libraries, excluding built-in support
15114 for reset and exception vectors and tables.
15116 @item -mtf
15117 @opindex mtf
15118 Causes all functions to default to the @code{.far} section.  Without
15119 this option, functions default to the @code{.near} section.
15121 @item -mtiny=@var{n}
15122 @opindex mtiny=
15123 Variables that are @var{n} bytes or smaller will be allocated to the
15124 @code{.tiny} section.  These variables use the @code{$gp} base
15125 register.  The default for this option is 4, but note that there's a
15126 65536-byte limit to the @code{.tiny} section.
15128 @end table
15130 @node MicroBlaze Options
15131 @subsection MicroBlaze Options
15132 @cindex MicroBlaze Options
15134 @table @gcctabopt
15136 @item -msoft-float
15137 @opindex msoft-float
15138 Use software emulation for floating point (default).
15140 @item -mhard-float
15141 @opindex mhard-float
15142 Use hardware floating-point instructions.
15144 @item -mmemcpy
15145 @opindex mmemcpy
15146 Do not optimize block moves, use @code{memcpy}.
15148 @item -mno-clearbss
15149 @opindex mno-clearbss
15150 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
15152 @item -mcpu=@var{cpu-type}
15153 @opindex mcpu=
15154 Use features of and schedule code for given CPU.
15155 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15156 where @var{X} is a major version, @var{YY} is the minor version, and
15157 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
15158 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15160 @item -mxl-soft-mul
15161 @opindex mxl-soft-mul
15162 Use software multiply emulation (default).
15164 @item -mxl-soft-div
15165 @opindex mxl-soft-div
15166 Use software emulation for divides (default).
15168 @item -mxl-barrel-shift
15169 @opindex mxl-barrel-shift
15170 Use the hardware barrel shifter.
15172 @item -mxl-pattern-compare
15173 @opindex mxl-pattern-compare
15174 Use pattern compare instructions.
15176 @item -msmall-divides
15177 @opindex msmall-divides
15178 Use table lookup optimization for small signed integer divisions.
15180 @item -mxl-stack-check
15181 @opindex mxl-stack-check
15182 This option is deprecated.  Use -fstack-check instead.
15184 @item -mxl-gp-opt
15185 @opindex mxl-gp-opt
15186 Use GP relative sdata/sbss sections.
15188 @item -mxl-multiply-high
15189 @opindex mxl-multiply-high
15190 Use multiply high instructions for high part of 32x32 multiply.
15192 @item -mxl-float-convert
15193 @opindex mxl-float-convert
15194 Use hardware floating-point conversion instructions.
15196 @item -mxl-float-sqrt
15197 @opindex mxl-float-sqrt
15198 Use hardware floating-point square root instruction.
15200 @item -mxl-mode-@var{app-model}
15201 Select application model @var{app-model}.  Valid models are
15202 @table @samp
15203 @item executable
15204 normal executable (default), uses startup code @file{crt0.o}.
15206 @item xmdstub
15207 for use with Xilinx Microprocessor Debugger (XMD) based
15208 software intrusive debug agent called xmdstub. This uses startup file
15209 @file{crt1.o} and sets the start address of the program to be 0x800.
15211 @item bootstrap
15212 for applications that are loaded using a bootloader.
15213 This model uses startup file @file{crt2.o} which does not contain a processor
15214 reset vector handler. This is suitable for transferring control on a
15215 processor reset to the bootloader rather than the application.
15217 @item novectors
15218 for applications that do not require any of the
15219 MicroBlaze vectors. This option may be useful for applications running
15220 within a monitoring application. This model uses @file{crt3.o} as a startup file.
15221 @end table
15223 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
15224 @option{-mxl-mode-@var{app-model}}.
15226 @end table
15228 @node MIPS Options
15229 @subsection MIPS Options
15230 @cindex MIPS options
15232 @table @gcctabopt
15234 @item -EB
15235 @opindex EB
15236 Generate big-endian code.
15238 @item -EL
15239 @opindex EL
15240 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
15241 configurations.
15243 @item -march=@var{arch}
15244 @opindex march
15245 Generate code that will run on @var{arch}, which can be the name of a
15246 generic MIPS ISA, or the name of a particular processor.
15247 The ISA names are:
15248 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
15249 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
15250 The processor names are:
15251 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
15252 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
15253 @samp{5kc}, @samp{5kf},
15254 @samp{20kc},
15255 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
15256 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
15257 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
15258 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
15259 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
15260 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
15261 @samp{m4k},
15262 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
15263 @samp{orion},
15264 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
15265 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
15266 @samp{rm7000}, @samp{rm9000},
15267 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
15268 @samp{sb1},
15269 @samp{sr71000},
15270 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
15271 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
15272 and @samp{xlr}.
15273 The special value @samp{from-abi} selects the
15274 most compatible architecture for the selected ABI (that is,
15275 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
15277 The native Linux/GNU toolchain also supports the value @samp{native},
15278 which selects the best architecture option for the host processor.
15279 @option{-march=native} has no effect if GCC does not recognize
15280 the processor.
15282 In processor names, a final @samp{000} can be abbreviated as @samp{k}
15283 (for example, @samp{-march=r2k}).  Prefixes are optional, and
15284 @samp{vr} may be written @samp{r}.
15286 Names of the form @samp{@var{n}f2_1} refer to processors with
15287 FPUs clocked at half the rate of the core, names of the form
15288 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
15289 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
15290 processors with FPUs clocked a ratio of 3:2 with respect to the core.
15291 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
15292 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
15293 accepted as synonyms for @samp{@var{n}f1_1}.
15295 GCC defines two macros based on the value of this option.  The first
15296 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
15297 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
15298 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
15299 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
15300 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
15302 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
15303 above.  In other words, it will have the full prefix and will not
15304 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
15305 the macro names the resolved architecture (either @samp{"mips1"} or
15306 @samp{"mips3"}).  It names the default architecture when no
15307 @option{-march} option is given.
15309 @item -mtune=@var{arch}
15310 @opindex mtune
15311 Optimize for @var{arch}.  Among other things, this option controls
15312 the way instructions are scheduled, and the perceived cost of arithmetic
15313 operations.  The list of @var{arch} values is the same as for
15314 @option{-march}.
15316 When this option is not used, GCC will optimize for the processor
15317 specified by @option{-march}.  By using @option{-march} and
15318 @option{-mtune} together, it is possible to generate code that will
15319 run on a family of processors, but optimize the code for one
15320 particular member of that family.
15322 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
15323 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
15324 @samp{-march} ones described above.
15326 @item -mips1
15327 @opindex mips1
15328 Equivalent to @samp{-march=mips1}.
15330 @item -mips2
15331 @opindex mips2
15332 Equivalent to @samp{-march=mips2}.
15334 @item -mips3
15335 @opindex mips3
15336 Equivalent to @samp{-march=mips3}.
15338 @item -mips4
15339 @opindex mips4
15340 Equivalent to @samp{-march=mips4}.
15342 @item -mips32
15343 @opindex mips32
15344 Equivalent to @samp{-march=mips32}.
15346 @item -mips32r2
15347 @opindex mips32r2
15348 Equivalent to @samp{-march=mips32r2}.
15350 @item -mips64
15351 @opindex mips64
15352 Equivalent to @samp{-march=mips64}.
15354 @item -mips64r2
15355 @opindex mips64r2
15356 Equivalent to @samp{-march=mips64r2}.
15358 @item -mips16
15359 @itemx -mno-mips16
15360 @opindex mips16
15361 @opindex mno-mips16
15362 Generate (do not generate) MIPS16 code.  If GCC is targetting a
15363 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
15365 MIPS16 code generation can also be controlled on a per-function basis
15366 by means of @code{mips16} and @code{nomips16} attributes.
15367 @xref{Function Attributes}, for more information.
15369 @item -mflip-mips16
15370 @opindex mflip-mips16
15371 Generate MIPS16 code on alternating functions.  This option is provided
15372 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
15373 not intended for ordinary use in compiling user code.
15375 @item -minterlink-mips16
15376 @itemx -mno-interlink-mips16
15377 @opindex minterlink-mips16
15378 @opindex mno-interlink-mips16
15379 Require (do not require) that non-MIPS16 code be link-compatible with
15380 MIPS16 code.
15382 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
15383 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
15384 therefore disables direct jumps unless GCC knows that the target of the
15385 jump is not MIPS16.
15387 @item -mabi=32
15388 @itemx -mabi=o64
15389 @itemx -mabi=n32
15390 @itemx -mabi=64
15391 @itemx -mabi=eabi
15392 @opindex mabi=32
15393 @opindex mabi=o64
15394 @opindex mabi=n32
15395 @opindex mabi=64
15396 @opindex mabi=eabi
15397 Generate code for the given ABI@.
15399 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
15400 generates 64-bit code when you select a 64-bit architecture, but you
15401 can use @option{-mgp32} to get 32-bit code instead.
15403 For information about the O64 ABI, see
15404 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
15406 GCC supports a variant of the o32 ABI in which floating-point registers
15407 are 64 rather than 32 bits wide.  You can select this combination with
15408 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
15409 and @samp{mfhc1} instructions and is therefore only supported for
15410 MIPS32R2 processors.
15412 The register assignments for arguments and return values remain the
15413 same, but each scalar value is passed in a single 64-bit register
15414 rather than a pair of 32-bit registers.  For example, scalar
15415 floating-point values are returned in @samp{$f0} only, not a
15416 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
15417 remains the same, but all 64 bits are saved.
15419 @item -mabicalls
15420 @itemx -mno-abicalls
15421 @opindex mabicalls
15422 @opindex mno-abicalls
15423 Generate (do not generate) code that is suitable for SVR4-style
15424 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
15425 systems.
15427 @item -mshared
15428 @itemx -mno-shared
15429 Generate (do not generate) code that is fully position-independent,
15430 and that can therefore be linked into shared libraries.  This option
15431 only affects @option{-mabicalls}.
15433 All @option{-mabicalls} code has traditionally been position-independent,
15434 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
15435 as an extension, the GNU toolchain allows executables to use absolute
15436 accesses for locally-binding symbols.  It can also use shorter GP
15437 initialization sequences and generate direct calls to locally-defined
15438 functions.  This mode is selected by @option{-mno-shared}.
15440 @option{-mno-shared} depends on binutils 2.16 or higher and generates
15441 objects that can only be linked by the GNU linker.  However, the option
15442 does not affect the ABI of the final executable; it only affects the ABI
15443 of relocatable objects.  Using @option{-mno-shared} will generally make
15444 executables both smaller and quicker.
15446 @option{-mshared} is the default.
15448 @item -mplt
15449 @itemx -mno-plt
15450 @opindex mplt
15451 @opindex mno-plt
15452 Assume (do not assume) that the static and dynamic linkers
15453 support PLTs and copy relocations.  This option only affects
15454 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
15455 has no effect without @samp{-msym32}.
15457 You can make @option{-mplt} the default by configuring
15458 GCC with @option{--with-mips-plt}.  The default is
15459 @option{-mno-plt} otherwise.
15461 @item -mxgot
15462 @itemx -mno-xgot
15463 @opindex mxgot
15464 @opindex mno-xgot
15465 Lift (do not lift) the usual restrictions on the size of the global
15466 offset table.
15468 GCC normally uses a single instruction to load values from the GOT@.
15469 While this is relatively efficient, it will only work if the GOT
15470 is smaller than about 64k.  Anything larger will cause the linker
15471 to report an error such as:
15473 @cindex relocation truncated to fit (MIPS)
15474 @smallexample
15475 relocation truncated to fit: R_MIPS_GOT16 foobar
15476 @end smallexample
15478 If this happens, you should recompile your code with @option{-mxgot}.
15479 It should then work with very large GOTs, although it will also be
15480 less efficient, since it will take three instructions to fetch the
15481 value of a global symbol.
15483 Note that some linkers can create multiple GOTs.  If you have such a
15484 linker, you should only need to use @option{-mxgot} when a single object
15485 file accesses more than 64k's worth of GOT entries.  Very few do.
15487 These options have no effect unless GCC is generating position
15488 independent code.
15490 @item -mgp32
15491 @opindex mgp32
15492 Assume that general-purpose registers are 32 bits wide.
15494 @item -mgp64
15495 @opindex mgp64
15496 Assume that general-purpose registers are 64 bits wide.
15498 @item -mfp32
15499 @opindex mfp32
15500 Assume that floating-point registers are 32 bits wide.
15502 @item -mfp64
15503 @opindex mfp64
15504 Assume that floating-point registers are 64 bits wide.
15506 @item -mhard-float
15507 @opindex mhard-float
15508 Use floating-point coprocessor instructions.
15510 @item -msoft-float
15511 @opindex msoft-float
15512 Do not use floating-point coprocessor instructions.  Implement
15513 floating-point calculations using library calls instead.
15515 @item -msingle-float
15516 @opindex msingle-float
15517 Assume that the floating-point coprocessor only supports single-precision
15518 operations.
15520 @item -mdouble-float
15521 @opindex mdouble-float
15522 Assume that the floating-point coprocessor supports double-precision
15523 operations.  This is the default.
15525 @item -mllsc
15526 @itemx -mno-llsc
15527 @opindex mllsc
15528 @opindex mno-llsc
15529 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
15530 implement atomic memory built-in functions.  When neither option is
15531 specified, GCC will use the instructions if the target architecture
15532 supports them.
15534 @option{-mllsc} is useful if the runtime environment can emulate the
15535 instructions and @option{-mno-llsc} can be useful when compiling for
15536 nonstandard ISAs.  You can make either option the default by
15537 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
15538 respectively.  @option{--with-llsc} is the default for some
15539 configurations; see the installation documentation for details.
15541 @item -mdsp
15542 @itemx -mno-dsp
15543 @opindex mdsp
15544 @opindex mno-dsp
15545 Use (do not use) revision 1 of the MIPS DSP ASE@.
15546 @xref{MIPS DSP Built-in Functions}.  This option defines the
15547 preprocessor macro @samp{__mips_dsp}.  It also defines
15548 @samp{__mips_dsp_rev} to 1.
15550 @item -mdspr2
15551 @itemx -mno-dspr2
15552 @opindex mdspr2
15553 @opindex mno-dspr2
15554 Use (do not use) revision 2 of the MIPS DSP ASE@.
15555 @xref{MIPS DSP Built-in Functions}.  This option defines the
15556 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
15557 It also defines @samp{__mips_dsp_rev} to 2.
15559 @item -msmartmips
15560 @itemx -mno-smartmips
15561 @opindex msmartmips
15562 @opindex mno-smartmips
15563 Use (do not use) the MIPS SmartMIPS ASE.
15565 @item -mpaired-single
15566 @itemx -mno-paired-single
15567 @opindex mpaired-single
15568 @opindex mno-paired-single
15569 Use (do not use) paired-single floating-point instructions.
15570 @xref{MIPS Paired-Single Support}.  This option requires
15571 hardware floating-point support to be enabled.
15573 @item -mdmx
15574 @itemx -mno-mdmx
15575 @opindex mdmx
15576 @opindex mno-mdmx
15577 Use (do not use) MIPS Digital Media Extension instructions.
15578 This option can only be used when generating 64-bit code and requires
15579 hardware floating-point support to be enabled.
15581 @item -mips3d
15582 @itemx -mno-mips3d
15583 @opindex mips3d
15584 @opindex mno-mips3d
15585 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
15586 The option @option{-mips3d} implies @option{-mpaired-single}.
15588 @item -mmt
15589 @itemx -mno-mt
15590 @opindex mmt
15591 @opindex mno-mt
15592 Use (do not use) MT Multithreading instructions.
15594 @item -mlong64
15595 @opindex mlong64
15596 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
15597 an explanation of the default and the way that the pointer size is
15598 determined.
15600 @item -mlong32
15601 @opindex mlong32
15602 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
15604 The default size of @code{int}s, @code{long}s and pointers depends on
15605 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
15606 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
15607 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
15608 or the same size as integer registers, whichever is smaller.
15610 @item -msym32
15611 @itemx -mno-sym32
15612 @opindex msym32
15613 @opindex mno-sym32
15614 Assume (do not assume) that all symbols have 32-bit values, regardless
15615 of the selected ABI@.  This option is useful in combination with
15616 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
15617 to generate shorter and faster references to symbolic addresses.
15619 @item -G @var{num}
15620 @opindex G
15621 Put definitions of externally-visible data in a small data section
15622 if that data is no bigger than @var{num} bytes.  GCC can then access
15623 the data more efficiently; see @option{-mgpopt} for details.
15625 The default @option{-G} option depends on the configuration.
15627 @item -mlocal-sdata
15628 @itemx -mno-local-sdata
15629 @opindex mlocal-sdata
15630 @opindex mno-local-sdata
15631 Extend (do not extend) the @option{-G} behavior to local data too,
15632 such as to static variables in C@.  @option{-mlocal-sdata} is the
15633 default for all configurations.
15635 If the linker complains that an application is using too much small data,
15636 you might want to try rebuilding the less performance-critical parts with
15637 @option{-mno-local-sdata}.  You might also want to build large
15638 libraries with @option{-mno-local-sdata}, so that the libraries leave
15639 more room for the main program.
15641 @item -mextern-sdata
15642 @itemx -mno-extern-sdata
15643 @opindex mextern-sdata
15644 @opindex mno-extern-sdata
15645 Assume (do not assume) that externally-defined data will be in
15646 a small data section if that data is within the @option{-G} limit.
15647 @option{-mextern-sdata} is the default for all configurations.
15649 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
15650 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
15651 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
15652 is placed in a small data section.  If @var{Var} is defined by another
15653 module, you must either compile that module with a high-enough
15654 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
15655 definition.  If @var{Var} is common, you must link the application
15656 with a high-enough @option{-G} setting.
15658 The easiest way of satisfying these restrictions is to compile
15659 and link every module with the same @option{-G} option.  However,
15660 you may wish to build a library that supports several different
15661 small data limits.  You can do this by compiling the library with
15662 the highest supported @option{-G} setting and additionally using
15663 @option{-mno-extern-sdata} to stop the library from making assumptions
15664 about externally-defined data.
15666 @item -mgpopt
15667 @itemx -mno-gpopt
15668 @opindex mgpopt
15669 @opindex mno-gpopt
15670 Use (do not use) GP-relative accesses for symbols that are known to be
15671 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
15672 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
15673 configurations.
15675 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
15676 might not hold the value of @code{_gp}.  For example, if the code is
15677 part of a library that might be used in a boot monitor, programs that
15678 call boot monitor routines will pass an unknown value in @code{$gp}.
15679 (In such situations, the boot monitor itself would usually be compiled
15680 with @option{-G0}.)
15682 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
15683 @option{-mno-extern-sdata}.
15685 @item -membedded-data
15686 @itemx -mno-embedded-data
15687 @opindex membedded-data
15688 @opindex mno-embedded-data
15689 Allocate variables to the read-only data section first if possible, then
15690 next in the small data section if possible, otherwise in data.  This gives
15691 slightly slower code than the default, but reduces the amount of RAM required
15692 when executing, and thus may be preferred for some embedded systems.
15694 @item -muninit-const-in-rodata
15695 @itemx -mno-uninit-const-in-rodata
15696 @opindex muninit-const-in-rodata
15697 @opindex mno-uninit-const-in-rodata
15698 Put uninitialized @code{const} variables in the read-only data section.
15699 This option is only meaningful in conjunction with @option{-membedded-data}.
15701 @item -mcode-readable=@var{setting}
15702 @opindex mcode-readable
15703 Specify whether GCC may generate code that reads from executable sections.
15704 There are three possible settings:
15706 @table @gcctabopt
15707 @item -mcode-readable=yes
15708 Instructions may freely access executable sections.  This is the
15709 default setting.
15711 @item -mcode-readable=pcrel
15712 MIPS16 PC-relative load instructions can access executable sections,
15713 but other instructions must not do so.  This option is useful on 4KSc
15714 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
15715 It is also useful on processors that can be configured to have a dual
15716 instruction/data SRAM interface and that, like the M4K, automatically
15717 redirect PC-relative loads to the instruction RAM.
15719 @item -mcode-readable=no
15720 Instructions must not access executable sections.  This option can be
15721 useful on targets that are configured to have a dual instruction/data
15722 SRAM interface but that (unlike the M4K) do not automatically redirect
15723 PC-relative loads to the instruction RAM.
15724 @end table
15726 @item -msplit-addresses
15727 @itemx -mno-split-addresses
15728 @opindex msplit-addresses
15729 @opindex mno-split-addresses
15730 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
15731 relocation operators.  This option has been superseded by
15732 @option{-mexplicit-relocs} but is retained for backwards compatibility.
15734 @item -mexplicit-relocs
15735 @itemx -mno-explicit-relocs
15736 @opindex mexplicit-relocs
15737 @opindex mno-explicit-relocs
15738 Use (do not use) assembler relocation operators when dealing with symbolic
15739 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
15740 is to use assembler macros instead.
15742 @option{-mexplicit-relocs} is the default if GCC was configured
15743 to use an assembler that supports relocation operators.
15745 @item -mcheck-zero-division
15746 @itemx -mno-check-zero-division
15747 @opindex mcheck-zero-division
15748 @opindex mno-check-zero-division
15749 Trap (do not trap) on integer division by zero.
15751 The default is @option{-mcheck-zero-division}.
15753 @item -mdivide-traps
15754 @itemx -mdivide-breaks
15755 @opindex mdivide-traps
15756 @opindex mdivide-breaks
15757 MIPS systems check for division by zero by generating either a
15758 conditional trap or a break instruction.  Using traps results in
15759 smaller code, but is only supported on MIPS II and later.  Also, some
15760 versions of the Linux kernel have a bug that prevents trap from
15761 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
15762 allow conditional traps on architectures that support them and
15763 @option{-mdivide-breaks} to force the use of breaks.
15765 The default is usually @option{-mdivide-traps}, but this can be
15766 overridden at configure time using @option{--with-divide=breaks}.
15767 Divide-by-zero checks can be completely disabled using
15768 @option{-mno-check-zero-division}.
15770 @item -mmemcpy
15771 @itemx -mno-memcpy
15772 @opindex mmemcpy
15773 @opindex mno-memcpy
15774 Force (do not force) the use of @code{memcpy()} for non-trivial block
15775 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
15776 most constant-sized copies.
15778 @item -mlong-calls
15779 @itemx -mno-long-calls
15780 @opindex mlong-calls
15781 @opindex mno-long-calls
15782 Disable (do not disable) use of the @code{jal} instruction.  Calling
15783 functions using @code{jal} is more efficient but requires the caller
15784 and callee to be in the same 256 megabyte segment.
15786 This option has no effect on abicalls code.  The default is
15787 @option{-mno-long-calls}.
15789 @item -mmad
15790 @itemx -mno-mad
15791 @opindex mmad
15792 @opindex mno-mad
15793 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
15794 instructions, as provided by the R4650 ISA@.
15796 @item -mfused-madd
15797 @itemx -mno-fused-madd
15798 @opindex mfused-madd
15799 @opindex mno-fused-madd
15800 Enable (disable) use of the floating-point multiply-accumulate
15801 instructions, when they are available.  The default is
15802 @option{-mfused-madd}.
15804 When multiply-accumulate instructions are used, the intermediate
15805 product is calculated to infinite precision and is not subject to
15806 the FCSR Flush to Zero bit.  This may be undesirable in some
15807 circumstances.
15809 @item -nocpp
15810 @opindex nocpp
15811 Tell the MIPS assembler to not run its preprocessor over user
15812 assembler files (with a @samp{.s} suffix) when assembling them.
15814 @item -mfix-24k
15815 @item -mno-fix-24k
15816 @opindex mfix-24k
15817 @opindex mno-fix-24k
15818 Work around the 24K E48 (lost data on stores during refill) errata.
15819 The workarounds are implemented by the assembler rather than by GCC@.
15821 @item -mfix-r4000
15822 @itemx -mno-fix-r4000
15823 @opindex mfix-r4000
15824 @opindex mno-fix-r4000
15825 Work around certain R4000 CPU errata:
15826 @itemize @minus
15827 @item
15828 A double-word or a variable shift may give an incorrect result if executed
15829 immediately after starting an integer division.
15830 @item
15831 A double-word or a variable shift may give an incorrect result if executed
15832 while an integer multiplication is in progress.
15833 @item
15834 An integer division may give an incorrect result if started in a delay slot
15835 of a taken branch or a jump.
15836 @end itemize
15838 @item -mfix-r4400
15839 @itemx -mno-fix-r4400
15840 @opindex mfix-r4400
15841 @opindex mno-fix-r4400
15842 Work around certain R4400 CPU errata:
15843 @itemize @minus
15844 @item
15845 A double-word or a variable shift may give an incorrect result if executed
15846 immediately after starting an integer division.
15847 @end itemize
15849 @item -mfix-r10000
15850 @itemx -mno-fix-r10000
15851 @opindex mfix-r10000
15852 @opindex mno-fix-r10000
15853 Work around certain R10000 errata:
15854 @itemize @minus
15855 @item
15856 @code{ll}/@code{sc} sequences may not behave atomically on revisions
15857 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
15858 @end itemize
15860 This option can only be used if the target architecture supports
15861 branch-likely instructions.  @option{-mfix-r10000} is the default when
15862 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
15863 otherwise.
15865 @item -mfix-vr4120
15866 @itemx -mno-fix-vr4120
15867 @opindex mfix-vr4120
15868 Work around certain VR4120 errata:
15869 @itemize @minus
15870 @item
15871 @code{dmultu} does not always produce the correct result.
15872 @item
15873 @code{div} and @code{ddiv} do not always produce the correct result if one
15874 of the operands is negative.
15875 @end itemize
15876 The workarounds for the division errata rely on special functions in
15877 @file{libgcc.a}.  At present, these functions are only provided by
15878 the @code{mips64vr*-elf} configurations.
15880 Other VR4120 errata require a nop to be inserted between certain pairs of
15881 instructions.  These errata are handled by the assembler, not by GCC itself.
15883 @item -mfix-vr4130
15884 @opindex mfix-vr4130
15885 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
15886 workarounds are implemented by the assembler rather than by GCC,
15887 although GCC will avoid using @code{mflo} and @code{mfhi} if the
15888 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
15889 instructions are available instead.
15891 @item -mfix-sb1
15892 @itemx -mno-fix-sb1
15893 @opindex mfix-sb1
15894 Work around certain SB-1 CPU core errata.
15895 (This flag currently works around the SB-1 revision 2
15896 ``F1'' and ``F2'' floating-point errata.)
15898 @item -mr10k-cache-barrier=@var{setting}
15899 @opindex mr10k-cache-barrier
15900 Specify whether GCC should insert cache barriers to avoid the
15901 side-effects of speculation on R10K processors.
15903 In common with many processors, the R10K tries to predict the outcome
15904 of a conditional branch and speculatively executes instructions from
15905 the ``taken'' branch.  It later aborts these instructions if the
15906 predicted outcome was wrong.  However, on the R10K, even aborted
15907 instructions can have side effects.
15909 This problem only affects kernel stores and, depending on the system,
15910 kernel loads.  As an example, a speculatively-executed store may load
15911 the target memory into cache and mark the cache line as dirty, even if
15912 the store itself is later aborted.  If a DMA operation writes to the
15913 same area of memory before the ``dirty'' line is flushed, the cached
15914 data will overwrite the DMA-ed data.  See the R10K processor manual
15915 for a full description, including other potential problems.
15917 One workaround is to insert cache barrier instructions before every memory
15918 access that might be speculatively executed and that might have side
15919 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
15920 controls GCC's implementation of this workaround.  It assumes that
15921 aborted accesses to any byte in the following regions will not have
15922 side effects:
15924 @enumerate
15925 @item
15926 the memory occupied by the current function's stack frame;
15928 @item
15929 the memory occupied by an incoming stack argument;
15931 @item
15932 the memory occupied by an object with a link-time-constant address.
15933 @end enumerate
15935 It is the kernel's responsibility to ensure that speculative
15936 accesses to these regions are indeed safe.
15938 If the input program contains a function declaration such as:
15940 @smallexample
15941 void foo (void);
15942 @end smallexample
15944 then the implementation of @code{foo} must allow @code{j foo} and
15945 @code{jal foo} to be executed speculatively.  GCC honors this
15946 restriction for functions it compiles itself.  It expects non-GCC
15947 functions (such as hand-written assembly code) to do the same.
15949 The option has three forms:
15951 @table @gcctabopt
15952 @item -mr10k-cache-barrier=load-store
15953 Insert a cache barrier before a load or store that might be
15954 speculatively executed and that might have side effects even
15955 if aborted.
15957 @item -mr10k-cache-barrier=store
15958 Insert a cache barrier before a store that might be speculatively
15959 executed and that might have side effects even if aborted.
15961 @item -mr10k-cache-barrier=none
15962 Disable the insertion of cache barriers.  This is the default setting.
15963 @end table
15965 @item -mflush-func=@var{func}
15966 @itemx -mno-flush-func
15967 @opindex mflush-func
15968 Specifies the function to call to flush the I and D caches, or to not
15969 call any such function.  If called, the function must take the same
15970 arguments as the common @code{_flush_func()}, that is, the address of the
15971 memory range for which the cache is being flushed, the size of the
15972 memory range, and the number 3 (to flush both caches).  The default
15973 depends on the target GCC was configured for, but commonly is either
15974 @samp{_flush_func} or @samp{__cpu_flush}.
15976 @item mbranch-cost=@var{num}
15977 @opindex mbranch-cost
15978 Set the cost of branches to roughly @var{num} ``simple'' instructions.
15979 This cost is only a heuristic and is not guaranteed to produce
15980 consistent results across releases.  A zero cost redundantly selects
15981 the default, which is based on the @option{-mtune} setting.
15983 @item -mbranch-likely
15984 @itemx -mno-branch-likely
15985 @opindex mbranch-likely
15986 @opindex mno-branch-likely
15987 Enable or disable use of Branch Likely instructions, regardless of the
15988 default for the selected architecture.  By default, Branch Likely
15989 instructions may be generated if they are supported by the selected
15990 architecture.  An exception is for the MIPS32 and MIPS64 architectures
15991 and processors that implement those architectures; for those, Branch
15992 Likely instructions will not be generated by default because the MIPS32
15993 and MIPS64 architectures specifically deprecate their use.
15995 @item -mfp-exceptions
15996 @itemx -mno-fp-exceptions
15997 @opindex mfp-exceptions
15998 Specifies whether FP exceptions are enabled.  This affects how we schedule
15999 FP instructions for some processors.  The default is that FP exceptions are
16000 enabled.
16002 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16003 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
16004 FP pipe.
16006 @item -mvr4130-align
16007 @itemx -mno-vr4130-align
16008 @opindex mvr4130-align
16009 The VR4130 pipeline is two-way superscalar, but can only issue two
16010 instructions together if the first one is 8-byte aligned.  When this
16011 option is enabled, GCC will align pairs of instructions that it
16012 thinks should execute in parallel.
16014 This option only has an effect when optimizing for the VR4130.
16015 It normally makes code faster, but at the expense of making it bigger.
16016 It is enabled by default at optimization level @option{-O3}.
16018 @item -msynci
16019 @itemx -mno-synci
16020 @opindex msynci
16021 Enable (disable) generation of @code{synci} instructions on
16022 architectures that support it.  The @code{synci} instructions (if
16023 enabled) will be generated when @code{__builtin___clear_cache()} is
16024 compiled.
16026 This option defaults to @code{-mno-synci}, but the default can be
16027 overridden by configuring with @code{--with-synci}.
16029 When compiling code for single processor systems, it is generally safe
16030 to use @code{synci}.  However, on many multi-core (SMP) systems, it
16031 will not invalidate the instruction caches on all cores and may lead
16032 to undefined behavior.
16034 @item -mrelax-pic-calls
16035 @itemx -mno-relax-pic-calls
16036 @opindex mrelax-pic-calls
16037 Try to turn PIC calls that are normally dispatched via register
16038 @code{$25} into direct calls.  This is only possible if the linker can
16039 resolve the destination at link-time and if the destination is within
16040 range for a direct call.
16042 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16043 an assembler and a linker that supports the @code{.reloc} assembly
16044 directive and @code{-mexplicit-relocs} is in effect.  With
16045 @code{-mno-explicit-relocs}, this optimization can be performed by the
16046 assembler and the linker alone without help from the compiler.
16048 @item -mmcount-ra-address
16049 @itemx -mno-mcount-ra-address
16050 @opindex mmcount-ra-address
16051 @opindex mno-mcount-ra-address
16052 Emit (do not emit) code that allows @code{_mcount} to modify the
16053 calling function's return address.  When enabled, this option extends
16054 the usual @code{_mcount} interface with a new @var{ra-address}
16055 parameter, which has type @code{intptr_t *} and is passed in register
16056 @code{$12}.  @code{_mcount} can then modify the return address by
16057 doing both of the following:
16058 @itemize
16059 @item
16060 Returning the new address in register @code{$31}.
16061 @item
16062 Storing the new address in @code{*@var{ra-address}},
16063 if @var{ra-address} is nonnull.
16064 @end itemize
16066 The default is @option{-mno-mcount-ra-address}.
16068 @end table
16070 @node MMIX Options
16071 @subsection MMIX Options
16072 @cindex MMIX Options
16074 These options are defined for the MMIX:
16076 @table @gcctabopt
16077 @item -mlibfuncs
16078 @itemx -mno-libfuncs
16079 @opindex mlibfuncs
16080 @opindex mno-libfuncs
16081 Specify that intrinsic library functions are being compiled, passing all
16082 values in registers, no matter the size.
16084 @item -mepsilon
16085 @itemx -mno-epsilon
16086 @opindex mepsilon
16087 @opindex mno-epsilon
16088 Generate floating-point comparison instructions that compare with respect
16089 to the @code{rE} epsilon register.
16091 @item -mabi=mmixware
16092 @itemx -mabi=gnu
16093 @opindex mabi=mmixware
16094 @opindex mabi=gnu
16095 Generate code that passes function parameters and return values that (in
16096 the called function) are seen as registers @code{$0} and up, as opposed to
16097 the GNU ABI which uses global registers @code{$231} and up.
16099 @item -mzero-extend
16100 @itemx -mno-zero-extend
16101 @opindex mzero-extend
16102 @opindex mno-zero-extend
16103 When reading data from memory in sizes shorter than 64 bits, use (do not
16104 use) zero-extending load instructions by default, rather than
16105 sign-extending ones.
16107 @item -mknuthdiv
16108 @itemx -mno-knuthdiv
16109 @opindex mknuthdiv
16110 @opindex mno-knuthdiv
16111 Make the result of a division yielding a remainder have the same sign as
16112 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
16113 remainder follows the sign of the dividend.  Both methods are
16114 arithmetically valid, the latter being almost exclusively used.
16116 @item -mtoplevel-symbols
16117 @itemx -mno-toplevel-symbols
16118 @opindex mtoplevel-symbols
16119 @opindex mno-toplevel-symbols
16120 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
16121 code can be used with the @code{PREFIX} assembly directive.
16123 @item -melf
16124 @opindex melf
16125 Generate an executable in the ELF format, rather than the default
16126 @samp{mmo} format used by the @command{mmix} simulator.
16128 @item -mbranch-predict
16129 @itemx -mno-branch-predict
16130 @opindex mbranch-predict
16131 @opindex mno-branch-predict
16132 Use (do not use) the probable-branch instructions, when static branch
16133 prediction indicates a probable branch.
16135 @item -mbase-addresses
16136 @itemx -mno-base-addresses
16137 @opindex mbase-addresses
16138 @opindex mno-base-addresses
16139 Generate (do not generate) code that uses @emph{base addresses}.  Using a
16140 base address automatically generates a request (handled by the assembler
16141 and the linker) for a constant to be set up in a global register.  The
16142 register is used for one or more base address requests within the range 0
16143 to 255 from the value held in the register.  The generally leads to short
16144 and fast code, but the number of different data items that can be
16145 addressed is limited.  This means that a program that uses lots of static
16146 data may require @option{-mno-base-addresses}.
16148 @item -msingle-exit
16149 @itemx -mno-single-exit
16150 @opindex msingle-exit
16151 @opindex mno-single-exit
16152 Force (do not force) generated code to have a single exit point in each
16153 function.
16154 @end table
16156 @node MN10300 Options
16157 @subsection MN10300 Options
16158 @cindex MN10300 options
16160 These @option{-m} options are defined for Matsushita MN10300 architectures:
16162 @table @gcctabopt
16163 @item -mmult-bug
16164 @opindex mmult-bug
16165 Generate code to avoid bugs in the multiply instructions for the MN10300
16166 processors.  This is the default.
16168 @item -mno-mult-bug
16169 @opindex mno-mult-bug
16170 Do not generate code to avoid bugs in the multiply instructions for the
16171 MN10300 processors.
16173 @item -mam33
16174 @opindex mam33
16175 Generate code using features specific to the AM33 processor.
16177 @item -mno-am33
16178 @opindex mno-am33
16179 Do not generate code using features specific to the AM33 processor.  This
16180 is the default.
16182 @item -mam33-2
16183 @opindex mam33-2
16184 Generate code using features specific to the AM33/2.0 processor.
16186 @item -mam34
16187 @opindex mam34
16188 Generate code using features specific to the AM34 processor.
16190 @item -mtune=@var{cpu-type}
16191 @opindex mtune
16192 Use the timing characteristics of the indicated CPU type when
16193 scheduling instructions.  This does not change the targeted processor
16194 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
16195 @samp{am33-2} or @samp{am34}.
16197 @item -mreturn-pointer-on-d0
16198 @opindex mreturn-pointer-on-d0
16199 When generating a function that returns a pointer, return the pointer
16200 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
16201 only in a0, and attempts to call such functions without a prototype
16202 would result in errors.  Note that this option is on by default; use
16203 @option{-mno-return-pointer-on-d0} to disable it.
16205 @item -mno-crt0
16206 @opindex mno-crt0
16207 Do not link in the C run-time initialization object file.
16209 @item -mrelax
16210 @opindex mrelax
16211 Indicate to the linker that it should perform a relaxation optimization pass
16212 to shorten branches, calls and absolute memory addresses.  This option only
16213 has an effect when used on the command line for the final link step.
16215 This option makes symbolic debugging impossible.
16217 @item -mliw
16218 @opindex mliw
16219 Allow the compiler to generate @emph{Long Instruction Word}
16220 instructions if the target is the @samp{AM33} or later.  This is the
16221 default.  This option defines the preprocessor macro @samp{__LIW__}.
16223 @item -mnoliw
16224 @opindex mnoliw
16225 Do not allow the compiler to generate @emph{Long Instruction Word}
16226 instructions.  This option defines the preprocessor macro
16227 @samp{__NO_LIW__}.
16229 @item -msetlb
16230 @opindex msetlb
16231 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
16232 instructions if the target is the @samp{AM33} or later.  This is the
16233 default.  This option defines the preprocessor macro @samp{__SETLB__}.
16235 @item -mnosetlb
16236 @opindex mnosetlb
16237 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
16238 instructions.  This option defines the preprocessor macro
16239 @samp{__NO_SETLB__}.
16241 @end table
16243 @node PDP-11 Options
16244 @subsection PDP-11 Options
16245 @cindex PDP-11 Options
16247 These options are defined for the PDP-11:
16249 @table @gcctabopt
16250 @item -mfpu
16251 @opindex mfpu
16252 Use hardware FPP floating point.  This is the default.  (FIS floating
16253 point on the PDP-11/40 is not supported.)
16255 @item -msoft-float
16256 @opindex msoft-float
16257 Do not use hardware floating point.
16259 @item -mac0
16260 @opindex mac0
16261 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
16263 @item -mno-ac0
16264 @opindex mno-ac0
16265 Return floating-point results in memory.  This is the default.
16267 @item -m40
16268 @opindex m40
16269 Generate code for a PDP-11/40.
16271 @item -m45
16272 @opindex m45
16273 Generate code for a PDP-11/45.  This is the default.
16275 @item -m10
16276 @opindex m10
16277 Generate code for a PDP-11/10.
16279 @item -mbcopy-builtin
16280 @opindex mbcopy-builtin
16281 Use inline @code{movmemhi} patterns for copying memory.  This is the
16282 default.
16284 @item -mbcopy
16285 @opindex mbcopy
16286 Do not use inline @code{movmemhi} patterns for copying memory.
16288 @item -mint16
16289 @itemx -mno-int32
16290 @opindex mint16
16291 @opindex mno-int32
16292 Use 16-bit @code{int}.  This is the default.
16294 @item -mint32
16295 @itemx -mno-int16
16296 @opindex mint32
16297 @opindex mno-int16
16298 Use 32-bit @code{int}.
16300 @item -mfloat64
16301 @itemx -mno-float32
16302 @opindex mfloat64
16303 @opindex mno-float32
16304 Use 64-bit @code{float}.  This is the default.
16306 @item -mfloat32
16307 @itemx -mno-float64
16308 @opindex mfloat32
16309 @opindex mno-float64
16310 Use 32-bit @code{float}.
16312 @item -mabshi
16313 @opindex mabshi
16314 Use @code{abshi2} pattern.  This is the default.
16316 @item -mno-abshi
16317 @opindex mno-abshi
16318 Do not use @code{abshi2} pattern.
16320 @item -mbranch-expensive
16321 @opindex mbranch-expensive
16322 Pretend that branches are expensive.  This is for experimenting with
16323 code generation only.
16325 @item -mbranch-cheap
16326 @opindex mbranch-cheap
16327 Do not pretend that branches are expensive.  This is the default.
16329 @item -munix-asm
16330 @opindex munix-asm
16331 Use Unix assembler syntax.  This is the default when configured for
16332 @samp{pdp11-*-bsd}.
16334 @item -mdec-asm
16335 @opindex mdec-asm
16336 Use DEC assembler syntax.  This is the default when configured for any
16337 PDP-11 target other than @samp{pdp11-*-bsd}.
16338 @end table
16340 @node picoChip Options
16341 @subsection picoChip Options
16342 @cindex picoChip options
16344 These @samp{-m} options are defined for picoChip implementations:
16346 @table @gcctabopt
16348 @item -mae=@var{ae_type}
16349 @opindex mcpu
16350 Set the instruction set, register set, and instruction scheduling
16351 parameters for array element type @var{ae_type}.  Supported values
16352 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
16354 @option{-mae=ANY} selects a completely generic AE type.  Code
16355 generated with this option will run on any of the other AE types.  The
16356 code will not be as efficient as it would be if compiled for a specific
16357 AE type, and some types of operation (e.g., multiplication) will not
16358 work properly on all types of AE.
16360 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
16361 for compiled code, and is the default.
16363 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
16364 option may suffer from poor performance of byte (char) manipulation,
16365 since the DSP AE does not provide hardware support for byte load/stores.
16367 @item -msymbol-as-address
16368 Enable the compiler to directly use a symbol name as an address in a
16369 load/store instruction, without first loading it into a
16370 register.  Typically, the use of this option will generate larger
16371 programs, which run faster than when the option isn't used.  However, the
16372 results vary from program to program, so it is left as a user option,
16373 rather than being permanently enabled.
16375 @item -mno-inefficient-warnings
16376 Disables warnings about the generation of inefficient code.  These
16377 warnings can be generated, for example, when compiling code that
16378 performs byte-level memory operations on the MAC AE type.  The MAC AE has
16379 no hardware support for byte-level memory operations, so all byte
16380 load/stores must be synthesized from word load/store operations.  This is
16381 inefficient and a warning will be generated indicating to the programmer
16382 that they should rewrite the code to avoid byte operations, or to target
16383 an AE type that has the necessary hardware support.  This option enables
16384 the warning to be turned off.
16386 @end table
16388 @node PowerPC Options
16389 @subsection PowerPC Options
16390 @cindex PowerPC options
16392 These are listed under @xref{RS/6000 and PowerPC Options}.
16394 @node RL78 Options
16395 @subsection RL78 Options
16396 @cindex RL78 Options
16398 @table @gcctabopt
16400 @item -msim
16401 @opindex msim
16402 Links in additional target libraries to support operation within a
16403 simulator.
16405 @item -mmul=none
16406 @itemx -mmul=g13
16407 @itemx -mmul=rl78
16408 @opindex mmul
16409 Specifies the type of hardware multiplication support to be used.  The
16410 default is @code{none}, which uses software multiplication functions.
16411 The @code{g13} option is for the hardware multiply/divide peripheral
16412 only on the RL78/G13 targets.  The @code{rl78} option is for the
16413 standard hardware multiplication defined in the RL78 software manual.
16415 @end table
16417 @node RS/6000 and PowerPC Options
16418 @subsection IBM RS/6000 and PowerPC Options
16419 @cindex RS/6000 and PowerPC Options
16420 @cindex IBM RS/6000 and PowerPC Options
16422 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
16423 @table @gcctabopt
16424 @item -mpower
16425 @itemx -mno-power
16426 @itemx -mpower2
16427 @itemx -mno-power2
16428 @itemx -mpowerpc
16429 @itemx -mno-powerpc
16430 @itemx -mpowerpc-gpopt
16431 @itemx -mno-powerpc-gpopt
16432 @itemx -mpowerpc-gfxopt
16433 @itemx -mno-powerpc-gfxopt
16434 @need 800
16435 @itemx -mpowerpc64
16436 @itemx -mno-powerpc64
16437 @itemx -mmfcrf
16438 @itemx -mno-mfcrf
16439 @itemx -mpopcntb
16440 @itemx -mno-popcntb
16441 @itemx -mpopcntd
16442 @itemx -mno-popcntd
16443 @itemx -mfprnd
16444 @itemx -mno-fprnd
16445 @need 800
16446 @itemx -mcmpb
16447 @itemx -mno-cmpb
16448 @itemx -mmfpgpr
16449 @itemx -mno-mfpgpr
16450 @itemx -mhard-dfp
16451 @itemx -mno-hard-dfp
16452 @opindex mpower
16453 @opindex mno-power
16454 @opindex mpower2
16455 @opindex mno-power2
16456 @opindex mpowerpc
16457 @opindex mno-powerpc
16458 @opindex mpowerpc-gpopt
16459 @opindex mno-powerpc-gpopt
16460 @opindex mpowerpc-gfxopt
16461 @opindex mno-powerpc-gfxopt
16462 @opindex mpowerpc64
16463 @opindex mno-powerpc64
16464 @opindex mmfcrf
16465 @opindex mno-mfcrf
16466 @opindex mpopcntb
16467 @opindex mno-popcntb
16468 @opindex mpopcntd
16469 @opindex mno-popcntd
16470 @opindex mfprnd
16471 @opindex mno-fprnd
16472 @opindex mcmpb
16473 @opindex mno-cmpb
16474 @opindex mmfpgpr
16475 @opindex mno-mfpgpr
16476 @opindex mhard-dfp
16477 @opindex mno-hard-dfp
16478 GCC supports two related instruction set architectures for the
16479 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
16480 instructions supported by the @samp{rios} chip set used in the original
16481 RS/6000 systems and the @dfn{PowerPC} instruction set is the
16482 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
16483 the IBM 4xx, 6xx, and follow-on microprocessors.
16485 Neither architecture is a subset of the other.  However there is a
16486 large common subset of instructions supported by both.  An MQ
16487 register is included in processors supporting the POWER architecture.
16489 You use these options to specify which instructions are available on the
16490 processor you are using.  The default value of these options is
16491 determined when configuring GCC@.  Specifying the
16492 @option{-mcpu=@var{cpu_type}} overrides the specification of these
16493 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
16494 rather than the options listed above.
16496 The @option{-mpower} option allows GCC to generate instructions that
16497 are found only in the POWER architecture and to use the MQ register.
16498 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
16499 to generate instructions that are present in the POWER2 architecture but
16500 not the original POWER architecture.
16502 The @option{-mpowerpc} option allows GCC to generate instructions that
16503 are found only in the 32-bit subset of the PowerPC architecture.
16504 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
16505 GCC to use the optional PowerPC architecture instructions in the
16506 General Purpose group, including floating-point square root.  Specifying
16507 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
16508 use the optional PowerPC architecture instructions in the Graphics
16509 group, including floating-point select.
16511 The @option{-mmfcrf} option allows GCC to generate the move from
16512 condition register field instruction implemented on the POWER4
16513 processor and other processors that support the PowerPC V2.01
16514 architecture.
16515 The @option{-mpopcntb} option allows GCC to generate the popcount and
16516 double-precision FP reciprocal estimate instruction implemented on the
16517 POWER5 processor and other processors that support the PowerPC V2.02
16518 architecture.
16519 The @option{-mpopcntd} option allows GCC to generate the popcount
16520 instruction implemented on the POWER7 processor and other processors
16521 that support the PowerPC V2.06 architecture.
16522 The @option{-mfprnd} option allows GCC to generate the FP round to
16523 integer instructions implemented on the POWER5+ processor and other
16524 processors that support the PowerPC V2.03 architecture.
16525 The @option{-mcmpb} option allows GCC to generate the compare bytes
16526 instruction implemented on the POWER6 processor and other processors
16527 that support the PowerPC V2.05 architecture.
16528 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
16529 general-purpose register instructions implemented on the POWER6X
16530 processor and other processors that support the extended PowerPC V2.05
16531 architecture.
16532 The @option{-mhard-dfp} option allows GCC to generate the decimal
16533 floating-point instructions implemented on some POWER processors.
16535 The @option{-mpowerpc64} option allows GCC to generate the additional
16536 64-bit instructions that are found in the full PowerPC64 architecture
16537 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
16538 @option{-mno-powerpc64}.
16540 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
16541 will use only the instructions in the common subset of both
16542 architectures plus some special AIX common-mode calls, and will not use
16543 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
16544 permits GCC to use any instruction from either architecture and to
16545 allow use of the MQ register; specify this for the Motorola MPC601.
16547 @item -mnew-mnemonics
16548 @itemx -mold-mnemonics
16549 @opindex mnew-mnemonics
16550 @opindex mold-mnemonics
16551 Select which mnemonics to use in the generated assembler code.  With
16552 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
16553 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
16554 assembler mnemonics defined for the POWER architecture.  Instructions
16555 defined in only one architecture have only one mnemonic; GCC uses that
16556 mnemonic irrespective of which of these options is specified.
16558 GCC defaults to the mnemonics appropriate for the architecture in
16559 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
16560 value of these option.  Unless you are building a cross-compiler, you
16561 should normally not specify either @option{-mnew-mnemonics} or
16562 @option{-mold-mnemonics}, but should instead accept the default.
16564 @item -mcpu=@var{cpu_type}
16565 @opindex mcpu
16566 Set architecture type, register usage, choice of mnemonics, and
16567 instruction scheduling parameters for machine type @var{cpu_type}.
16568 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
16569 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
16570 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
16571 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
16572 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
16573 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
16574 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
16575 @samp{G4}, @samp{G5}, @samp{titan}, @samp{power}, @samp{power2}, @samp{power3},
16576 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
16577 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
16578 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
16580 @option{-mcpu=common} selects a completely generic processor.  Code
16581 generated under this option will run on any POWER or PowerPC processor.
16582 GCC will use only the instructions in the common subset of both
16583 architectures, and will not use the MQ register.  GCC assumes a generic
16584 processor model for scheduling purposes.
16586 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
16587 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
16588 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
16589 types, with an appropriate, generic processor model assumed for
16590 scheduling purposes.
16592 The other options specify a specific processor.  Code generated under
16593 those options will run best on that processor, and may not run at all on
16594 others.
16596 The @option{-mcpu} options automatically enable or disable the
16597 following options:
16599 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
16600 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
16601 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
16602 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
16604 The particular options set for any particular CPU will vary between
16605 compiler versions, depending on what setting seems to produce optimal
16606 code for that CPU; it doesn't necessarily reflect the actual hardware's
16607 capabilities.  If you wish to set an individual option to a particular
16608 value, you may specify it after the @option{-mcpu} option, like
16609 @samp{-mcpu=970 -mno-altivec}.
16611 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
16612 not enabled or disabled by the @option{-mcpu} option at present because
16613 AIX does not have full support for these options.  You may still
16614 enable or disable them individually if you're sure it'll work in your
16615 environment.
16617 @item -mtune=@var{cpu_type}
16618 @opindex mtune
16619 Set the instruction scheduling parameters for machine type
16620 @var{cpu_type}, but do not set the architecture type, register usage, or
16621 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
16622 values for @var{cpu_type} are used for @option{-mtune} as for
16623 @option{-mcpu}.  If both are specified, the code generated will use the
16624 architecture, registers, and mnemonics set by @option{-mcpu}, but the
16625 scheduling parameters set by @option{-mtune}.
16627 @item -mcmodel=small
16628 @opindex mcmodel=small
16629 Generate PowerPC64 code for the small model: The TOC is limited to
16630 64k.
16632 @item -mcmodel=medium
16633 @opindex mcmodel=medium
16634 Generate PowerPC64 code for the medium model: The TOC and other static
16635 data may be up to a total of 4G in size.
16637 @item -mcmodel=large
16638 @opindex mcmodel=large
16639 Generate PowerPC64 code for the large model: The TOC may be up to 4G
16640 in size.  Other data and code is only limited by the 64-bit address
16641 space.
16643 @item -maltivec
16644 @itemx -mno-altivec
16645 @opindex maltivec
16646 @opindex mno-altivec
16647 Generate code that uses (does not use) AltiVec instructions, and also
16648 enable the use of built-in functions that allow more direct access to
16649 the AltiVec instruction set.  You may also need to set
16650 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
16651 enhancements.
16653 @item -mvrsave
16654 @itemx -mno-vrsave
16655 @opindex mvrsave
16656 @opindex mno-vrsave
16657 Generate VRSAVE instructions when generating AltiVec code.
16659 @item -mgen-cell-microcode
16660 @opindex mgen-cell-microcode
16661 Generate Cell microcode instructions
16663 @item -mwarn-cell-microcode
16664 @opindex mwarn-cell-microcode
16665 Warning when a Cell microcode instruction is going to emitted.  An example
16666 of a Cell microcode instruction is a variable shift.
16668 @item -msecure-plt
16669 @opindex msecure-plt
16670 Generate code that allows @command{ld} and @command{ld.so}
16671 to build executables and shared
16672 libraries with non-executable @code{.plt} and @code{.got} sections.
16673 This is a PowerPC
16674 32-bit SYSV ABI option.
16676 @item -mbss-plt
16677 @opindex mbss-plt
16678 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
16679 fills in, and
16680 requires @code{.plt} and @code{.got}
16681 sections that are both writable and executable.
16682 This is a PowerPC 32-bit SYSV ABI option.
16684 @item -misel
16685 @itemx -mno-isel
16686 @opindex misel
16687 @opindex mno-isel
16688 This switch enables or disables the generation of ISEL instructions.
16690 @item -misel=@var{yes/no}
16691 This switch has been deprecated.  Use @option{-misel} and
16692 @option{-mno-isel} instead.
16694 @item -mspe
16695 @itemx -mno-spe
16696 @opindex mspe
16697 @opindex mno-spe
16698 This switch enables or disables the generation of SPE simd
16699 instructions.
16701 @item -mpaired
16702 @itemx -mno-paired
16703 @opindex mpaired
16704 @opindex mno-paired
16705 This switch enables or disables the generation of PAIRED simd
16706 instructions.
16708 @item -mspe=@var{yes/no}
16709 This option has been deprecated.  Use @option{-mspe} and
16710 @option{-mno-spe} instead.
16712 @item -mvsx
16713 @itemx -mno-vsx
16714 @opindex mvsx
16715 @opindex mno-vsx
16716 Generate code that uses (does not use) vector/scalar (VSX)
16717 instructions, and also enable the use of built-in functions that allow
16718 more direct access to the VSX instruction set.
16720 @item -mfloat-gprs=@var{yes/single/double/no}
16721 @itemx -mfloat-gprs
16722 @opindex mfloat-gprs
16723 This switch enables or disables the generation of floating-point
16724 operations on the general-purpose registers for architectures that
16725 support it.
16727 The argument @var{yes} or @var{single} enables the use of
16728 single-precision floating-point operations.
16730 The argument @var{double} enables the use of single and
16731 double-precision floating-point operations.
16733 The argument @var{no} disables floating-point operations on the
16734 general-purpose registers.
16736 This option is currently only available on the MPC854x.
16738 @item -m32
16739 @itemx -m64
16740 @opindex m32
16741 @opindex m64
16742 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
16743 targets (including GNU/Linux).  The 32-bit environment sets int, long
16744 and pointer to 32 bits and generates code that runs on any PowerPC
16745 variant.  The 64-bit environment sets int to 32 bits and long and
16746 pointer to 64 bits, and generates code for PowerPC64, as for
16747 @option{-mpowerpc64}.
16749 @item -mfull-toc
16750 @itemx -mno-fp-in-toc
16751 @itemx -mno-sum-in-toc
16752 @itemx -mminimal-toc
16753 @opindex mfull-toc
16754 @opindex mno-fp-in-toc
16755 @opindex mno-sum-in-toc
16756 @opindex mminimal-toc
16757 Modify generation of the TOC (Table Of Contents), which is created for
16758 every executable file.  The @option{-mfull-toc} option is selected by
16759 default.  In that case, GCC will allocate at least one TOC entry for
16760 each unique non-automatic variable reference in your program.  GCC
16761 will also place floating-point constants in the TOC@.  However, only
16762 16,384 entries are available in the TOC@.
16764 If you receive a linker error message that saying you have overflowed
16765 the available TOC space, you can reduce the amount of TOC space used
16766 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
16767 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
16768 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
16769 generate code to calculate the sum of an address and a constant at
16770 run time instead of putting that sum into the TOC@.  You may specify one
16771 or both of these options.  Each causes GCC to produce very slightly
16772 slower and larger code at the expense of conserving TOC space.
16774 If you still run out of space in the TOC even when you specify both of
16775 these options, specify @option{-mminimal-toc} instead.  This option causes
16776 GCC to make only one TOC entry for every file.  When you specify this
16777 option, GCC will produce code that is slower and larger but which
16778 uses extremely little TOC space.  You may wish to use this option
16779 only on files that contain less frequently executed code.
16781 @item -maix64
16782 @itemx -maix32
16783 @opindex maix64
16784 @opindex maix32
16785 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
16786 @code{long} type, and the infrastructure needed to support them.
16787 Specifying @option{-maix64} implies @option{-mpowerpc64} and
16788 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
16789 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
16791 @item -mxl-compat
16792 @itemx -mno-xl-compat
16793 @opindex mxl-compat
16794 @opindex mno-xl-compat
16795 Produce code that conforms more closely to IBM XL compiler semantics
16796 when using AIX-compatible ABI@.  Pass floating-point arguments to
16797 prototyped functions beyond the register save area (RSA) on the stack
16798 in addition to argument FPRs.  Do not assume that most significant
16799 double in 128-bit long double value is properly rounded when comparing
16800 values and converting to double.  Use XL symbol names for long double
16801 support routines.
16803 The AIX calling convention was extended but not initially documented to
16804 handle an obscure K&R C case of calling a function that takes the
16805 address of its arguments with fewer arguments than declared.  IBM XL
16806 compilers access floating-point arguments that do not fit in the
16807 RSA from the stack when a subroutine is compiled without
16808 optimization.  Because always storing floating-point arguments on the
16809 stack is inefficient and rarely needed, this option is not enabled by
16810 default and only is necessary when calling subroutines compiled by IBM
16811 XL compilers without optimization.
16813 @item -mpe
16814 @opindex mpe
16815 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
16816 application written to use message passing with special startup code to
16817 enable the application to run.  The system must have PE installed in the
16818 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
16819 must be overridden with the @option{-specs=} option to specify the
16820 appropriate directory location.  The Parallel Environment does not
16821 support threads, so the @option{-mpe} option and the @option{-pthread}
16822 option are incompatible.
16824 @item -malign-natural
16825 @itemx -malign-power
16826 @opindex malign-natural
16827 @opindex malign-power
16828 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
16829 @option{-malign-natural} overrides the ABI-defined alignment of larger
16830 types, such as floating-point doubles, on their natural size-based boundary.
16831 The option @option{-malign-power} instructs GCC to follow the ABI-specified
16832 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
16834 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
16835 is not supported.
16837 @item -msoft-float
16838 @itemx -mhard-float
16839 @opindex msoft-float
16840 @opindex mhard-float
16841 Generate code that does not use (uses) the floating-point register set.
16842 Software floating-point emulation is provided if you use the
16843 @option{-msoft-float} option, and pass the option to GCC when linking.
16845 @item -msingle-float
16846 @itemx -mdouble-float
16847 @opindex msingle-float
16848 @opindex mdouble-float
16849 Generate code for single- or double-precision floating-point operations.
16850 @option{-mdouble-float} implies @option{-msingle-float}.
16852 @item -msimple-fpu
16853 @opindex msimple-fpu
16854 Do not generate sqrt and div instructions for hardware floating-point unit.
16856 @item -mfpu
16857 @opindex mfpu
16858 Specify type of floating-point unit.  Valid values are @var{sp_lite}
16859 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
16860 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
16861 and @var{dp_full} (equivalent to -mdouble-float).
16863 @item -mxilinx-fpu
16864 @opindex mxilinx-fpu
16865 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
16867 @item -mmultiple
16868 @itemx -mno-multiple
16869 @opindex mmultiple
16870 @opindex mno-multiple
16871 Generate code that uses (does not use) the load multiple word
16872 instructions and the store multiple word instructions.  These
16873 instructions are generated by default on POWER systems, and not
16874 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
16875 PowerPC systems, since those instructions do not work when the
16876 processor is in little-endian mode.  The exceptions are PPC740 and
16877 PPC750 which permit these instructions in little-endian mode.
16879 @item -mstring
16880 @itemx -mno-string
16881 @opindex mstring
16882 @opindex mno-string
16883 Generate code that uses (does not use) the load string instructions
16884 and the store string word instructions to save multiple registers and
16885 do small block moves.  These instructions are generated by default on
16886 POWER systems, and not generated on PowerPC systems.  Do not use
16887 @option{-mstring} on little-endian PowerPC systems, since those
16888 instructions do not work when the processor is in little-endian mode.
16889 The exceptions are PPC740 and PPC750 which permit these instructions
16890 in little-endian mode.
16892 @item -mupdate
16893 @itemx -mno-update
16894 @opindex mupdate
16895 @opindex mno-update
16896 Generate code that uses (does not use) the load or store instructions
16897 that update the base register to the address of the calculated memory
16898 location.  These instructions are generated by default.  If you use
16899 @option{-mno-update}, there is a small window between the time that the
16900 stack pointer is updated and the address of the previous frame is
16901 stored, which means code that walks the stack frame across interrupts or
16902 signals may get corrupted data.
16904 @item -mavoid-indexed-addresses
16905 @itemx -mno-avoid-indexed-addresses
16906 @opindex mavoid-indexed-addresses
16907 @opindex mno-avoid-indexed-addresses
16908 Generate code that tries to avoid (not avoid) the use of indexed load
16909 or store instructions. These instructions can incur a performance
16910 penalty on Power6 processors in certain situations, such as when
16911 stepping through large arrays that cross a 16M boundary.  This option
16912 is enabled by default when targetting Power6 and disabled otherwise.
16914 @item -mfused-madd
16915 @itemx -mno-fused-madd
16916 @opindex mfused-madd
16917 @opindex mno-fused-madd
16918 Generate code that uses (does not use) the floating-point multiply and
16919 accumulate instructions.  These instructions are generated by default
16920 if hardware floating point is used.  The machine-dependent
16921 @option{-mfused-madd} option is now mapped to the machine-independent
16922 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
16923 mapped to @option{-ffp-contract=off}.
16925 @item -mmulhw
16926 @itemx -mno-mulhw
16927 @opindex mmulhw
16928 @opindex mno-mulhw
16929 Generate code that uses (does not use) the half-word multiply and
16930 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
16931 These instructions are generated by default when targetting those
16932 processors.
16934 @item -mdlmzb
16935 @itemx -mno-dlmzb
16936 @opindex mdlmzb
16937 @opindex mno-dlmzb
16938 Generate code that uses (does not use) the string-search @samp{dlmzb}
16939 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
16940 generated by default when targetting those processors.
16942 @item -mno-bit-align
16943 @itemx -mbit-align
16944 @opindex mno-bit-align
16945 @opindex mbit-align
16946 On System V.4 and embedded PowerPC systems do not (do) force structures
16947 and unions that contain bit-fields to be aligned to the base type of the
16948 bit-field.
16950 For example, by default a structure containing nothing but 8
16951 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
16952 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
16953 the structure is aligned to a 1-byte boundary and is 1 byte in
16954 size.
16956 @item -mno-strict-align
16957 @itemx -mstrict-align
16958 @opindex mno-strict-align
16959 @opindex mstrict-align
16960 On System V.4 and embedded PowerPC systems do not (do) assume that
16961 unaligned memory references will be handled by the system.
16963 @item -mrelocatable
16964 @itemx -mno-relocatable
16965 @opindex mrelocatable
16966 @opindex mno-relocatable
16967 Generate code that allows (does not allow) a static executable to be
16968 relocated to a different address at run time.  A simple embedded
16969 PowerPC system loader should relocate the entire contents of
16970 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
16971 a table of 32-bit addresses generated by this option.  For this to
16972 work, all objects linked together must be compiled with
16973 @option{-mrelocatable} or @option{-mrelocatable-lib}.
16974 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
16976 @item -mrelocatable-lib
16977 @itemx -mno-relocatable-lib
16978 @opindex mrelocatable-lib
16979 @opindex mno-relocatable-lib
16980 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
16981 @code{.fixup} section to allow static executables to be relocated at
16982 run time, but @option{-mrelocatable-lib} does not use the smaller stack
16983 alignment of @option{-mrelocatable}.  Objects compiled with
16984 @option{-mrelocatable-lib} may be linked with objects compiled with
16985 any combination of the @option{-mrelocatable} options.
16987 @item -mno-toc
16988 @itemx -mtoc
16989 @opindex mno-toc
16990 @opindex mtoc
16991 On System V.4 and embedded PowerPC systems do not (do) assume that
16992 register 2 contains a pointer to a global area pointing to the addresses
16993 used in the program.
16995 @item -mlittle
16996 @itemx -mlittle-endian
16997 @opindex mlittle
16998 @opindex mlittle-endian
16999 On System V.4 and embedded PowerPC systems compile code for the
17000 processor in little-endian mode.  The @option{-mlittle-endian} option is
17001 the same as @option{-mlittle}.
17003 @item -mbig
17004 @itemx -mbig-endian
17005 @opindex mbig
17006 @opindex mbig-endian
17007 On System V.4 and embedded PowerPC systems compile code for the
17008 processor in big-endian mode.  The @option{-mbig-endian} option is
17009 the same as @option{-mbig}.
17011 @item -mdynamic-no-pic
17012 @opindex mdynamic-no-pic
17013 On Darwin and Mac OS X systems, compile code so that it is not
17014 relocatable, but that its external references are relocatable.  The
17015 resulting code is suitable for applications, but not shared
17016 libraries.
17018 @item -msingle-pic-base
17019 @opindex msingle-pic-base
17020 Treat the register used for PIC addressing as read-only, rather than
17021 loading it in the prologue for each function.  The runtime system is
17022 responsible for initializing this register with an appropriate value
17023 before execution begins.
17025 @item -mprioritize-restricted-insns=@var{priority}
17026 @opindex mprioritize-restricted-insns
17027 This option controls the priority that is assigned to
17028 dispatch-slot restricted instructions during the second scheduling
17029 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
17030 @var{no/highest/second-highest} priority to dispatch slot restricted
17031 instructions.
17033 @item -msched-costly-dep=@var{dependence_type}
17034 @opindex msched-costly-dep
17035 This option controls which dependences are considered costly
17036 by the target during instruction scheduling.  The argument
17037 @var{dependence_type} takes one of the following values:
17038 @var{no}: no dependence is costly,
17039 @var{all}: all dependences are costly,
17040 @var{true_store_to_load}: a true dependence from store to load is costly,
17041 @var{store_to_load}: any dependence from store to load is costly,
17042 @var{number}: any dependence for which latency >= @var{number} is costly.
17044 @item -minsert-sched-nops=@var{scheme}
17045 @opindex minsert-sched-nops
17046 This option controls which nop insertion scheme will be used during
17047 the second scheduling pass.  The argument @var{scheme} takes one of the
17048 following values:
17049 @var{no}: Don't insert nops.
17050 @var{pad}: Pad with nops any dispatch group that has vacant issue slots,
17051 according to the scheduler's grouping.
17052 @var{regroup_exact}: Insert nops to force costly dependent insns into
17053 separate groups.  Insert exactly as many nops as needed to force an insn
17054 to a new group, according to the estimated processor grouping.
17055 @var{number}: Insert nops to force costly dependent insns into
17056 separate groups.  Insert @var{number} nops to force an insn to a new group.
17058 @item -mcall-sysv
17059 @opindex mcall-sysv
17060 On System V.4 and embedded PowerPC systems compile code using calling
17061 conventions that adheres to the March 1995 draft of the System V
17062 Application Binary Interface, PowerPC processor supplement.  This is the
17063 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
17065 @item -mcall-sysv-eabi
17066 @itemx -mcall-eabi
17067 @opindex mcall-sysv-eabi
17068 @opindex mcall-eabi
17069 Specify both @option{-mcall-sysv} and @option{-meabi} options.
17071 @item -mcall-sysv-noeabi
17072 @opindex mcall-sysv-noeabi
17073 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
17075 @item -mcall-aixdesc
17076 @opindex m
17077 On System V.4 and embedded PowerPC systems compile code for the AIX
17078 operating system.
17080 @item -mcall-linux
17081 @opindex mcall-linux
17082 On System V.4 and embedded PowerPC systems compile code for the
17083 Linux-based GNU system.
17085 @item -mcall-freebsd
17086 @opindex mcall-freebsd
17087 On System V.4 and embedded PowerPC systems compile code for the
17088 FreeBSD operating system.
17090 @item -mcall-netbsd
17091 @opindex mcall-netbsd
17092 On System V.4 and embedded PowerPC systems compile code for the
17093 NetBSD operating system.
17095 @item -mcall-openbsd
17096 @opindex mcall-netbsd
17097 On System V.4 and embedded PowerPC systems compile code for the
17098 OpenBSD operating system.
17100 @item -maix-struct-return
17101 @opindex maix-struct-return
17102 Return all structures in memory (as specified by the AIX ABI)@.
17104 @item -msvr4-struct-return
17105 @opindex msvr4-struct-return
17106 Return structures smaller than 8 bytes in registers (as specified by the
17107 SVR4 ABI)@.
17109 @item -mabi=@var{abi-type}
17110 @opindex mabi
17111 Extend the current ABI with a particular extension, or remove such extension.
17112 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
17113 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
17115 @item -mabi=spe
17116 @opindex mabi=spe
17117 Extend the current ABI with SPE ABI extensions.  This does not change
17118 the default ABI, instead it adds the SPE ABI extensions to the current
17119 ABI@.
17121 @item -mabi=no-spe
17122 @opindex mabi=no-spe
17123 Disable Booke SPE ABI extensions for the current ABI@.
17125 @item -mabi=ibmlongdouble
17126 @opindex mabi=ibmlongdouble
17127 Change the current ABI to use IBM extended-precision long double.
17128 This is a PowerPC 32-bit SYSV ABI option.
17130 @item -mabi=ieeelongdouble
17131 @opindex mabi=ieeelongdouble
17132 Change the current ABI to use IEEE extended-precision long double.
17133 This is a PowerPC 32-bit Linux ABI option.
17135 @item -mprototype
17136 @itemx -mno-prototype
17137 @opindex mprototype
17138 @opindex mno-prototype
17139 On System V.4 and embedded PowerPC systems assume that all calls to
17140 variable argument functions are properly prototyped.  Otherwise, the
17141 compiler must insert an instruction before every non prototyped call to
17142 set or clear bit 6 of the condition code register (@var{CR}) to
17143 indicate whether floating-point values were passed in the floating-point
17144 registers in case the function takes variable arguments.  With
17145 @option{-mprototype}, only calls to prototyped variable argument functions
17146 will set or clear the bit.
17148 @item -msim
17149 @opindex msim
17150 On embedded PowerPC systems, assume that the startup module is called
17151 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
17152 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
17153 configurations.
17155 @item -mmvme
17156 @opindex mmvme
17157 On embedded PowerPC systems, assume that the startup module is called
17158 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
17159 @file{libc.a}.
17161 @item -mads
17162 @opindex mads
17163 On embedded PowerPC systems, assume that the startup module is called
17164 @file{crt0.o} and the standard C libraries are @file{libads.a} and
17165 @file{libc.a}.
17167 @item -myellowknife
17168 @opindex myellowknife
17169 On embedded PowerPC systems, assume that the startup module is called
17170 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
17171 @file{libc.a}.
17173 @item -mvxworks
17174 @opindex mvxworks
17175 On System V.4 and embedded PowerPC systems, specify that you are
17176 compiling for a VxWorks system.
17178 @item -memb
17179 @opindex memb
17180 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
17181 header to indicate that @samp{eabi} extended relocations are used.
17183 @item -meabi
17184 @itemx -mno-eabi
17185 @opindex meabi
17186 @opindex mno-eabi
17187 On System V.4 and embedded PowerPC systems do (do not) adhere to the
17188 Embedded Applications Binary Interface (eabi) which is a set of
17189 modifications to the System V.4 specifications.  Selecting @option{-meabi}
17190 means that the stack is aligned to an 8-byte boundary, a function
17191 @code{__eabi} is called to from @code{main} to set up the eabi
17192 environment, and the @option{-msdata} option can use both @code{r2} and
17193 @code{r13} to point to two separate small data areas.  Selecting
17194 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
17195 do not call an initialization function from @code{main}, and the
17196 @option{-msdata} option will only use @code{r13} to point to a single
17197 small data area.  The @option{-meabi} option is on by default if you
17198 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
17200 @item -msdata=eabi
17201 @opindex msdata=eabi
17202 On System V.4 and embedded PowerPC systems, put small initialized
17203 @code{const} global and static data in the @samp{.sdata2} section, which
17204 is pointed to by register @code{r2}.  Put small initialized
17205 non-@code{const} global and static data in the @samp{.sdata} section,
17206 which is pointed to by register @code{r13}.  Put small uninitialized
17207 global and static data in the @samp{.sbss} section, which is adjacent to
17208 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
17209 incompatible with the @option{-mrelocatable} option.  The
17210 @option{-msdata=eabi} option also sets the @option{-memb} option.
17212 @item -msdata=sysv
17213 @opindex msdata=sysv
17214 On System V.4 and embedded PowerPC systems, put small global and static
17215 data in the @samp{.sdata} section, which is pointed to by register
17216 @code{r13}.  Put small uninitialized global and static data in the
17217 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
17218 The @option{-msdata=sysv} option is incompatible with the
17219 @option{-mrelocatable} option.
17221 @item -msdata=default
17222 @itemx -msdata
17223 @opindex msdata=default
17224 @opindex msdata
17225 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
17226 compile code the same as @option{-msdata=eabi}, otherwise compile code the
17227 same as @option{-msdata=sysv}.
17229 @item -msdata=data
17230 @opindex msdata=data
17231 On System V.4 and embedded PowerPC systems, put small global
17232 data in the @samp{.sdata} section.  Put small uninitialized global
17233 data in the @samp{.sbss} section.  Do not use register @code{r13}
17234 to address small data however.  This is the default behavior unless
17235 other @option{-msdata} options are used.
17237 @item -msdata=none
17238 @itemx -mno-sdata
17239 @opindex msdata=none
17240 @opindex mno-sdata
17241 On embedded PowerPC systems, put all initialized global and static data
17242 in the @samp{.data} section, and all uninitialized data in the
17243 @samp{.bss} section.
17245 @item -mblock-move-inline-limit=@var{num}
17246 @opindex mblock-move-inline-limit
17247 Inline all block moves (such as calls to @code{memcpy} or structure
17248 copies) less than or equal to @var{num} bytes.  The minimum value for
17249 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
17250 targets.  The default value is target-specific.
17252 @item -G @var{num}
17253 @opindex G
17254 @cindex smaller data references (PowerPC)
17255 @cindex .sdata/.sdata2 references (PowerPC)
17256 On embedded PowerPC systems, put global and static items less than or
17257 equal to @var{num} bytes into the small data or bss sections instead of
17258 the normal data or bss section.  By default, @var{num} is 8.  The
17259 @option{-G @var{num}} switch is also passed to the linker.
17260 All modules should be compiled with the same @option{-G @var{num}} value.
17262 @item -mregnames
17263 @itemx -mno-regnames
17264 @opindex mregnames
17265 @opindex mno-regnames
17266 On System V.4 and embedded PowerPC systems do (do not) emit register
17267 names in the assembly language output using symbolic forms.
17269 @item -mlongcall
17270 @itemx -mno-longcall
17271 @opindex mlongcall
17272 @opindex mno-longcall
17273 By default assume that all calls are far away so that a longer more
17274 expensive calling sequence is required.  This is required for calls
17275 further than 32 megabytes (33,554,432 bytes) from the current location.
17276 A short call will be generated if the compiler knows
17277 the call cannot be that far away.  This setting can be overridden by
17278 the @code{shortcall} function attribute, or by @code{#pragma
17279 longcall(0)}.
17281 Some linkers are capable of detecting out-of-range calls and generating
17282 glue code on the fly.  On these systems, long calls are unnecessary and
17283 generate slower code.  As of this writing, the AIX linker can do this,
17284 as can the GNU linker for PowerPC/64.  It is planned to add this feature
17285 to the GNU linker for 32-bit PowerPC systems as well.
17287 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
17288 callee, L42'', plus a ``branch island'' (glue code).  The two target
17289 addresses represent the callee and the ``branch island''.  The
17290 Darwin/PPC linker will prefer the first address and generate a ``bl
17291 callee'' if the PPC ``bl'' instruction will reach the callee directly;
17292 otherwise, the linker will generate ``bl L42'' to call the ``branch
17293 island''.  The ``branch island'' is appended to the body of the
17294 calling function; it computes the full 32-bit address of the callee
17295 and jumps to it.
17297 On Mach-O (Darwin) systems, this option directs the compiler emit to
17298 the glue for every direct call, and the Darwin linker decides whether
17299 to use or discard it.
17301 In the future, we may cause GCC to ignore all longcall specifications
17302 when the linker is known to generate glue.
17304 @item -mtls-markers
17305 @itemx -mno-tls-markers
17306 @opindex mtls-markers
17307 @opindex mno-tls-markers
17308 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
17309 specifying the function argument.  The relocation allows the linker to
17310 reliably associate function call with argument setup instructions for
17311 TLS optimization, which in turn allows GCC to better schedule the
17312 sequence.
17314 @item -pthread
17315 @opindex pthread
17316 Adds support for multithreading with the @dfn{pthreads} library.
17317 This option sets flags for both the preprocessor and linker.
17319 @item -mrecip
17320 @itemx -mno-recip
17321 @opindex mrecip
17322 This option will enable GCC to use the reciprocal estimate and
17323 reciprocal square root estimate instructions with additional
17324 Newton-Raphson steps to increase precision instead of doing a divide or
17325 square root and divide for floating-point arguments.  You should use
17326 the @option{-ffast-math} option when using @option{-mrecip} (or at
17327 least @option{-funsafe-math-optimizations},
17328 @option{-finite-math-only}, @option{-freciprocal-math} and
17329 @option{-fno-trapping-math}).  Note that while the throughput of the
17330 sequence is generally higher than the throughput of the non-reciprocal
17331 instruction, the precision of the sequence can be decreased by up to 2
17332 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
17333 roots.
17335 @item -mrecip=@var{opt}
17336 @opindex mrecip=opt
17337 This option allows to control which reciprocal estimate instructions
17338 may be used.  @var{opt} is a comma separated list of options, which may
17339 be preceded by a @code{!} to invert the option:
17340 @code{all}: enable all estimate instructions,
17341 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
17342 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
17343 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
17344 @code{divf}: enable the single-precision reciprocal approximation instructions;
17345 @code{divd}: enable the double-precision reciprocal approximation instructions;
17346 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
17347 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
17348 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
17350 So for example, @option{-mrecip=all,!rsqrtd} would enable the
17351 all of the reciprocal estimate instructions, except for the
17352 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
17353 which handle the double-precision reciprocal square root calculations.
17355 @item -mrecip-precision
17356 @itemx -mno-recip-precision
17357 @opindex mrecip-precision
17358 Assume (do not assume) that the reciprocal estimate instructions
17359 provide higher-precision estimates than is mandated by the PowerPC
17360 ABI.  Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
17361 automatically selects @option{-mrecip-precision}.  The double-precision 
17362 square root estimate instructions are not generated by
17363 default on low-precision machines, since they do not provide an
17364 estimate that converges after three steps.
17366 @item -mveclibabi=@var{type}
17367 @opindex mveclibabi
17368 Specifies the ABI type to use for vectorizing intrinsics using an
17369 external library.  The only type supported at present is @code{mass},
17370 which specifies to use IBM's Mathematical Acceleration Subsystem
17371 (MASS) libraries for vectorizing intrinsics using external libraries.
17372 GCC will currently emit calls to @code{acosd2}, @code{acosf4},
17373 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
17374 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
17375 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
17376 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
17377 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
17378 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
17379 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
17380 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
17381 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
17382 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
17383 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
17384 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
17385 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
17386 for power7.  Both @option{-ftree-vectorize} and
17387 @option{-funsafe-math-optimizations} have to be enabled.  The MASS
17388 libraries will have to be specified at link time.
17390 @item -mfriz
17391 @itemx -mno-friz
17392 @opindex mfriz
17393 Generate (do not generate) the @code{friz} instruction when the
17394 @option{-funsafe-math-optimizations} option is used to optimize
17395 rounding of floating-point values to 64-bit integer and back to floating
17396 point.  The @code{friz} instruction does not return the same value if
17397 the floating-point number is too large to fit in an integer.
17399 @item -mpointers-to-nested-functions
17400 @itemx -mno-pointers-to-nested-functions
17401 @opindex mpointers-to-nested-functions
17402 Generate (do not generate) code to load up the static chain register
17403 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
17404 systems where a function pointer points to a 3-word descriptor giving
17405 the function address, TOC value to be loaded in register @var{r2}, and
17406 static chain value to be loaded in register @var{r11}.  The
17407 @option{-mpointers-to-nested-functions} is on by default.  You will
17408 not be able to call through pointers to nested functions or pointers
17409 to functions compiled in other languages that use the static chain if
17410 you use the @option{-mno-pointers-to-nested-functions}.
17412 @item -msave-toc-indirect
17413 @itemx -mno-save-toc-indirect
17414 @opindex msave-toc-indirect
17415 Generate (do not generate) code to save the TOC value in the reserved
17416 stack location in the function prologue if the function calls through
17417 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
17418 saved in the prologue, it is saved just before the call through the
17419 pointer.  The @option{-mno-save-toc-indirect} option is the default.
17420 @end table
17422 @node RX Options
17423 @subsection RX Options
17424 @cindex RX Options
17426 These command-line options are defined for RX targets:
17428 @table @gcctabopt
17429 @item -m64bit-doubles
17430 @itemx -m32bit-doubles
17431 @opindex m64bit-doubles
17432 @opindex m32bit-doubles
17433 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
17434 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
17435 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
17436 works on 32-bit values, which is why the default is
17437 @option{-m32bit-doubles}.
17439 @item -fpu
17440 @itemx -nofpu
17441 @opindex fpu
17442 @opindex nofpu
17443 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
17444 floating-point hardware.  The default is enabled for the @var{RX600}
17445 series and disabled for the @var{RX200} series.
17447 Floating-point instructions will only be generated for 32-bit floating-point 
17448 values however, so if the @option{-m64bit-doubles} option is in
17449 use then the FPU hardware will not be used for doubles.
17451 @emph{Note} If the @option{-fpu} option is enabled then
17452 @option{-funsafe-math-optimizations} is also enabled automatically.
17453 This is because the RX FPU instructions are themselves unsafe.
17455 @item -mcpu=@var{name}
17456 @opindex -mcpu
17457 Selects the type of RX CPU to be targeted.  Currently three types are
17458 supported, the generic @var{RX600} and @var{RX200} series hardware and
17459 the specific @var{RX610} CPU.  The default is @var{RX600}.
17461 The only difference between @var{RX600} and @var{RX610} is that the
17462 @var{RX610} does not support the @code{MVTIPL} instruction.
17464 The @var{RX200} series does not have a hardware floating-point unit
17465 and so @option{-nofpu} is enabled by default when this type is
17466 selected.
17468 @item -mbig-endian-data
17469 @itemx -mlittle-endian-data
17470 @opindex mbig-endian-data
17471 @opindex mlittle-endian-data
17472 Store data (but not code) in the big-endian format.  The default is
17473 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
17474 format.
17476 @item -msmall-data-limit=@var{N}
17477 @opindex msmall-data-limit
17478 Specifies the maximum size in bytes of global and static variables
17479 which can be placed into the small data area.  Using the small data
17480 area can lead to smaller and faster code, but the size of area is
17481 limited and it is up to the programmer to ensure that the area does
17482 not overflow.  Also when the small data area is used one of the RX's
17483 registers (usually @code{r13}) is reserved for use pointing to this
17484 area, so it is no longer available for use by the compiler.  This
17485 could result in slower and/or larger code if variables which once
17486 could have been held in the reserved register are now pushed onto the
17487 stack.
17489 Note, common variables (variables that have not been initialized) and
17490 constants are not placed into the small data area as they are assigned
17491 to other sections in the output executable.
17493 The default value is zero, which disables this feature.  Note, this
17494 feature is not enabled by default with higher optimization levels
17495 (@option{-O2} etc) because of the potentially detrimental effects of
17496 reserving a register.  It is up to the programmer to experiment and
17497 discover whether this feature is of benefit to their program.  See the
17498 description of the @option{-mpid} option for a description of how the
17499 actual register to hold the small data area pointer is chosen.
17501 @item -msim
17502 @itemx -mno-sim
17503 @opindex msim
17504 @opindex mno-sim
17505 Use the simulator runtime.  The default is to use the libgloss board
17506 specific runtime.
17508 @item -mas100-syntax
17509 @itemx -mno-as100-syntax
17510 @opindex mas100-syntax
17511 @opindex mno-as100-syntax
17512 When generating assembler output use a syntax that is compatible with
17513 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
17514 assembler but it has some restrictions so generating it is not the
17515 default option.
17517 @item -mmax-constant-size=@var{N}
17518 @opindex mmax-constant-size
17519 Specifies the maximum size, in bytes, of a constant that can be used as
17520 an operand in a RX instruction.  Although the RX instruction set does
17521 allow constants of up to 4 bytes in length to be used in instructions,
17522 a longer value equates to a longer instruction.  Thus in some
17523 circumstances it can be beneficial to restrict the size of constants
17524 that are used in instructions.  Constants that are too big are instead
17525 placed into a constant pool and referenced via register indirection.
17527 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
17528 or 4 means that constants of any size are allowed.
17530 @item -mrelax
17531 @opindex mrelax
17532 Enable linker relaxation.  Linker relaxation is a process whereby the
17533 linker will attempt to reduce the size of a program by finding shorter
17534 versions of various instructions.  Disabled by default.
17536 @item -mint-register=@var{N}
17537 @opindex mint-register
17538 Specify the number of registers to reserve for fast interrupt handler
17539 functions.  The value @var{N} can be between 0 and 4.  A value of 1
17540 means that register @code{r13} will be reserved for the exclusive use
17541 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
17542 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
17543 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
17544 A value of 0, the default, does not reserve any registers.
17546 @item -msave-acc-in-interrupts
17547 @opindex msave-acc-in-interrupts
17548 Specifies that interrupt handler functions should preserve the
17549 accumulator register.  This is only necessary if normal code might use
17550 the accumulator register, for example because it performs 64-bit
17551 multiplications.  The default is to ignore the accumulator as this
17552 makes the interrupt handlers faster.
17554 @item -mpid
17555 @itemx -mno-pid
17556 @opindex mpid
17557 @opindex mno-pid
17558 Enables the generation of position independent data.  When enabled any
17559 access to constant data will done via an offset from a base address
17560 held in a register.  This allows the location of constant data to be
17561 determined at run time without requiring the executable to be
17562 relocated, which is a benefit to embedded applications with tight
17563 memory constraints.  Data that can be modified is not affected by this
17564 option.
17566 Note, using this feature reserves a register, usually @code{r13}, for
17567 the constant data base address.  This can result in slower and/or
17568 larger code, especially in complicated functions.
17570 The actual register chosen to hold the constant data base address
17571 depends upon whether the @option{-msmall-data-limit} and/or the
17572 @option{-mint-register} command-line options are enabled.  Starting
17573 with register @code{r13} and proceeding downwards, registers are
17574 allocated first to satisfy the requirements of @option{-mint-register},
17575 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
17576 is possible for the small data area register to be @code{r8} if both
17577 @option{-mint-register=4} and @option{-mpid} are specified on the
17578 command line.
17580 By default this feature is not enabled.  The default can be restored
17581 via the @option{-mno-pid} command-line option.
17583 @end table
17585 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
17586 has special significance to the RX port when used with the
17587 @code{interrupt} function attribute.  This attribute indicates a
17588 function intended to process fast interrupts.  GCC will will ensure
17589 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
17590 and/or @code{r13} and only provided that the normal use of the
17591 corresponding registers have been restricted via the
17592 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
17593 options.
17595 @node S/390 and zSeries Options
17596 @subsection S/390 and zSeries Options
17597 @cindex S/390 and zSeries Options
17599 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
17601 @table @gcctabopt
17602 @item -mhard-float
17603 @itemx -msoft-float
17604 @opindex mhard-float
17605 @opindex msoft-float
17606 Use (do not use) the hardware floating-point instructions and registers
17607 for floating-point operations.  When @option{-msoft-float} is specified,
17608 functions in @file{libgcc.a} will be used to perform floating-point
17609 operations.  When @option{-mhard-float} is specified, the compiler
17610 generates IEEE floating-point instructions.  This is the default.
17612 @item -mhard-dfp
17613 @itemx -mno-hard-dfp
17614 @opindex mhard-dfp
17615 @opindex mno-hard-dfp
17616 Use (do not use) the hardware decimal-floating-point instructions for
17617 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
17618 specified, functions in @file{libgcc.a} will be used to perform
17619 decimal-floating-point operations.  When @option{-mhard-dfp} is
17620 specified, the compiler generates decimal-floating-point hardware
17621 instructions.  This is the default for @option{-march=z9-ec} or higher.
17623 @item -mlong-double-64
17624 @itemx -mlong-double-128
17625 @opindex mlong-double-64
17626 @opindex mlong-double-128
17627 These switches control the size of @code{long double} type. A size
17628 of 64 bits makes the @code{long double} type equivalent to the @code{double}
17629 type. This is the default.
17631 @item -mbackchain
17632 @itemx -mno-backchain
17633 @opindex mbackchain
17634 @opindex mno-backchain
17635 Store (do not store) the address of the caller's frame as backchain pointer
17636 into the callee's stack frame.
17637 A backchain may be needed to allow debugging using tools that do not understand
17638 DWARF 2 call frame information.
17639 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
17640 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
17641 the backchain is placed into the topmost word of the 96/160 byte register
17642 save area.
17644 In general, code compiled with @option{-mbackchain} is call-compatible with
17645 code compiled with @option{-mmo-backchain}; however, use of the backchain
17646 for debugging purposes usually requires that the whole binary is built with
17647 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
17648 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17649 to build a linux kernel use @option{-msoft-float}.
17651 The default is to not maintain the backchain.
17653 @item -mpacked-stack
17654 @itemx -mno-packed-stack
17655 @opindex mpacked-stack
17656 @opindex mno-packed-stack
17657 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
17658 specified, the compiler uses the all fields of the 96/160 byte register save
17659 area only for their default purpose; unused fields still take up stack space.
17660 When @option{-mpacked-stack} is specified, register save slots are densely
17661 packed at the top of the register save area; unused space is reused for other
17662 purposes, allowing for more efficient use of the available stack space.
17663 However, when @option{-mbackchain} is also in effect, the topmost word of
17664 the save area is always used to store the backchain, and the return address
17665 register is always saved two words below the backchain.
17667 As long as the stack frame backchain is not used, code generated with
17668 @option{-mpacked-stack} is call-compatible with code generated with
17669 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
17670 S/390 or zSeries generated code that uses the stack frame backchain at run
17671 time, not just for debugging purposes.  Such code is not call-compatible
17672 with code compiled with @option{-mpacked-stack}.  Also, note that the
17673 combination of @option{-mbackchain},
17674 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17675 to build a linux kernel use @option{-msoft-float}.
17677 The default is to not use the packed stack layout.
17679 @item -msmall-exec
17680 @itemx -mno-small-exec
17681 @opindex msmall-exec
17682 @opindex mno-small-exec
17683 Generate (or do not generate) code using the @code{bras} instruction
17684 to do subroutine calls.
17685 This only works reliably if the total executable size does not
17686 exceed 64k.  The default is to use the @code{basr} instruction instead,
17687 which does not have this limitation.
17689 @item -m64
17690 @itemx -m31
17691 @opindex m64
17692 @opindex m31
17693 When @option{-m31} is specified, generate code compliant to the
17694 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
17695 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
17696 particular to generate 64-bit instructions.  For the @samp{s390}
17697 targets, the default is @option{-m31}, while the @samp{s390x}
17698 targets default to @option{-m64}.
17700 @item -mzarch
17701 @itemx -mesa
17702 @opindex mzarch
17703 @opindex mesa
17704 When @option{-mzarch} is specified, generate code using the
17705 instructions available on z/Architecture.
17706 When @option{-mesa} is specified, generate code using the
17707 instructions available on ESA/390.  Note that @option{-mesa} is
17708 not possible with @option{-m64}.
17709 When generating code compliant to the GNU/Linux for S/390 ABI,
17710 the default is @option{-mesa}.  When generating code compliant
17711 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
17713 @item -mmvcle
17714 @itemx -mno-mvcle
17715 @opindex mmvcle
17716 @opindex mno-mvcle
17717 Generate (or do not generate) code using the @code{mvcle} instruction
17718 to perform block moves.  When @option{-mno-mvcle} is specified,
17719 use a @code{mvc} loop instead.  This is the default unless optimizing for
17720 size.
17722 @item -mdebug
17723 @itemx -mno-debug
17724 @opindex mdebug
17725 @opindex mno-debug
17726 Print (or do not print) additional debug information when compiling.
17727 The default is to not print debug information.
17729 @item -march=@var{cpu-type}
17730 @opindex march
17731 Generate code that will run on @var{cpu-type}, which is the name of a system
17732 representing a certain processor type.  Possible values for
17733 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
17734 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
17735 When generating code using the instructions available on z/Architecture,
17736 the default is @option{-march=z900}.  Otherwise, the default is
17737 @option{-march=g5}.
17739 @item -mtune=@var{cpu-type}
17740 @opindex mtune
17741 Tune to @var{cpu-type} everything applicable about the generated code,
17742 except for the ABI and the set of available instructions.
17743 The list of @var{cpu-type} values is the same as for @option{-march}.
17744 The default is the value used for @option{-march}.
17746 @item -mtpf-trace
17747 @itemx -mno-tpf-trace
17748 @opindex mtpf-trace
17749 @opindex mno-tpf-trace
17750 Generate code that adds (does not add) in TPF OS specific branches to trace
17751 routines in the operating system.  This option is off by default, even
17752 when compiling for the TPF OS@.
17754 @item -mfused-madd
17755 @itemx -mno-fused-madd
17756 @opindex mfused-madd
17757 @opindex mno-fused-madd
17758 Generate code that uses (does not use) the floating-point multiply and
17759 accumulate instructions.  These instructions are generated by default if
17760 hardware floating point is used.
17762 @item -mwarn-framesize=@var{framesize}
17763 @opindex mwarn-framesize
17764 Emit a warning if the current function exceeds the given frame size.  Because
17765 this is a compile-time check it doesn't need to be a real problem when the program
17766 runs.  It is intended to identify functions that most probably cause
17767 a stack overflow.  It is useful to be used in an environment with limited stack
17768 size e.g.@: the linux kernel.
17770 @item -mwarn-dynamicstack
17771 @opindex mwarn-dynamicstack
17772 Emit a warning if the function calls alloca or uses dynamically
17773 sized arrays.  This is generally a bad idea with a limited stack size.
17775 @item -mstack-guard=@var{stack-guard}
17776 @itemx -mstack-size=@var{stack-size}
17777 @opindex mstack-guard
17778 @opindex mstack-size
17779 If these options are provided the s390 back end emits additional instructions in
17780 the function prologue which trigger a trap if the stack size is @var{stack-guard}
17781 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
17782 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
17783 the frame size of the compiled function is chosen.
17784 These options are intended to be used to help debugging stack overflow problems.
17785 The additionally emitted code causes only little overhead and hence can also be
17786 used in production like systems without greater performance degradation.  The given
17787 values have to be exact powers of 2 and @var{stack-size} has to be greater than
17788 @var{stack-guard} without exceeding 64k.
17789 In order to be efficient the extra code makes the assumption that the stack starts
17790 at an address aligned to the value given by @var{stack-size}.
17791 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
17792 @end table
17794 @node Score Options
17795 @subsection Score Options
17796 @cindex Score Options
17798 These options are defined for Score implementations:
17800 @table @gcctabopt
17801 @item -meb
17802 @opindex meb
17803 Compile code for big-endian mode.  This is the default.
17805 @item -mel
17806 @opindex mel
17807 Compile code for little-endian mode.
17809 @item -mnhwloop
17810 @opindex mnhwloop
17811 Disable generate bcnz instruction.
17813 @item -muls
17814 @opindex muls
17815 Enable generate unaligned load and store instruction.
17817 @item -mmac
17818 @opindex mmac
17819 Enable the use of multiply-accumulate instructions. Disabled by default.
17821 @item -mscore5
17822 @opindex mscore5
17823 Specify the SCORE5 as the target architecture.
17825 @item -mscore5u
17826 @opindex mscore5u
17827 Specify the SCORE5U of the target architecture.
17829 @item -mscore7
17830 @opindex mscore7
17831 Specify the SCORE7 as the target architecture. This is the default.
17833 @item -mscore7d
17834 @opindex mscore7d
17835 Specify the SCORE7D as the target architecture.
17836 @end table
17838 @node SH Options
17839 @subsection SH Options
17841 These @samp{-m} options are defined for the SH implementations:
17843 @table @gcctabopt
17844 @item -m1
17845 @opindex m1
17846 Generate code for the SH1.
17848 @item -m2
17849 @opindex m2
17850 Generate code for the SH2.
17852 @item -m2e
17853 Generate code for the SH2e.
17855 @item -m2a-nofpu
17856 @opindex m2a-nofpu
17857 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
17858 that the floating-point unit is not used.
17860 @item -m2a-single-only
17861 @opindex m2a-single-only
17862 Generate code for the SH2a-FPU, in such a way that no double-precision
17863 floating-point operations are used.
17865 @item -m2a-single
17866 @opindex m2a-single
17867 Generate code for the SH2a-FPU assuming the floating-point unit is in
17868 single-precision mode by default.
17870 @item -m2a
17871 @opindex m2a
17872 Generate code for the SH2a-FPU assuming the floating-point unit is in
17873 double-precision mode by default.
17875 @item -m3
17876 @opindex m3
17877 Generate code for the SH3.
17879 @item -m3e
17880 @opindex m3e
17881 Generate code for the SH3e.
17883 @item -m4-nofpu
17884 @opindex m4-nofpu
17885 Generate code for the SH4 without a floating-point unit.
17887 @item -m4-single-only
17888 @opindex m4-single-only
17889 Generate code for the SH4 with a floating-point unit that only
17890 supports single-precision arithmetic.
17892 @item -m4-single
17893 @opindex m4-single
17894 Generate code for the SH4 assuming the floating-point unit is in
17895 single-precision mode by default.
17897 @item -m4
17898 @opindex m4
17899 Generate code for the SH4.
17901 @item -m4a-nofpu
17902 @opindex m4a-nofpu
17903 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
17904 floating-point unit is not used.
17906 @item -m4a-single-only
17907 @opindex m4a-single-only
17908 Generate code for the SH4a, in such a way that no double-precision
17909 floating-point operations are used.
17911 @item -m4a-single
17912 @opindex m4a-single
17913 Generate code for the SH4a assuming the floating-point unit is in
17914 single-precision mode by default.
17916 @item -m4a
17917 @opindex m4a
17918 Generate code for the SH4a.
17920 @item -m4al
17921 @opindex m4al
17922 Same as @option{-m4a-nofpu}, except that it implicitly passes
17923 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
17924 instructions at the moment.
17926 @item -mb
17927 @opindex mb
17928 Compile code for the processor in big-endian mode.
17930 @item -ml
17931 @opindex ml
17932 Compile code for the processor in little-endian mode.
17934 @item -mdalign
17935 @opindex mdalign
17936 Align doubles at 64-bit boundaries.  Note that this changes the calling
17937 conventions, and thus some functions from the standard C library will
17938 not work unless you recompile it first with @option{-mdalign}.
17940 @item -mrelax
17941 @opindex mrelax
17942 Shorten some address references at link time, when possible; uses the
17943 linker option @option{-relax}.
17945 @item -mbigtable
17946 @opindex mbigtable
17947 Use 32-bit offsets in @code{switch} tables.  The default is to use
17948 16-bit offsets.
17950 @item -mbitops
17951 @opindex mbitops
17952 Enable the use of bit manipulation instructions on SH2A.
17954 @item -mfmovd
17955 @opindex mfmovd
17956 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
17957 alignment constraints.
17959 @item -mhitachi
17960 @opindex mhitachi
17961 Comply with the calling conventions defined by Renesas.
17963 @item -mrenesas
17964 @opindex mhitachi
17965 Comply with the calling conventions defined by Renesas.
17967 @item -mno-renesas
17968 @opindex mhitachi
17969 Comply with the calling conventions defined for GCC before the Renesas
17970 conventions were available.  This option is the default for all
17971 targets of the SH toolchain.
17973 @item -mnomacsave
17974 @opindex mnomacsave
17975 Mark the @code{MAC} register as call-clobbered, even if
17976 @option{-mhitachi} is given.
17978 @item -mieee
17979 @opindex mieee
17980 Increase IEEE compliance of floating-point code.
17981 At the moment, this is equivalent to @option{-fno-finite-math-only}.
17982 When generating 16-bit SH opcodes, getting IEEE-conforming results for
17983 comparisons of NANs / infinities incurs extra overhead in every
17984 floating-point comparison, therefore the default is set to
17985 @option{-ffinite-math-only}.
17987 @item -minline-ic_invalidate
17988 @opindex minline-ic_invalidate
17989 Inline code to invalidate instruction cache entries after setting up
17990 nested function trampolines.
17991 This option has no effect if -musermode is in effect and the selected
17992 code generation option (e.g. -m4) does not allow the use of the icbi
17993 instruction.
17994 If the selected code generation option does not allow the use of the icbi
17995 instruction, and -musermode is not in effect, the inlined code will
17996 manipulate the instruction cache address array directly with an associative
17997 write.  This not only requires privileged mode, but it will also
17998 fail if the cache line had been mapped via the TLB and has become unmapped.
18000 @item -misize
18001 @opindex misize
18002 Dump instruction size and location in the assembly code.
18004 @item -mpadstruct
18005 @opindex mpadstruct
18006 This option is deprecated.  It pads structures to multiple of 4 bytes,
18007 which is incompatible with the SH ABI@.
18009 @item -msoft-atomic
18010 @opindex msoft-atomic
18011 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18012 built-in functions.  The generated atomic sequences require support from the 
18013 interrupt / exception handling code of the system and are only suitable for
18014 single-core systems.  They will not perform correctly on multi-core systems.
18015 This option is enabled by default when the target is @code{sh-*-linux*}.
18016 For details on the atomic built-in functions see @ref{__atomic Builtins}.
18018 @item -menable-tas
18019 @opindex menable-tas
18020 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
18021 Notice that depending on the particular hardware and software configuration
18022 this can degrade overall performance due to the operand cache line flushes
18023 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
18024 processors the @code{tas.b} instruction must be used with caution since it
18025 can result in data corruption for certain cache configurations.
18027 @item -mspace
18028 @opindex mspace
18029 Optimize for space instead of speed.  Implied by @option{-Os}.
18031 @item -mprefergot
18032 @opindex mprefergot
18033 When generating position-independent code, emit function calls using
18034 the Global Offset Table instead of the Procedure Linkage Table.
18036 @item -musermode
18037 @opindex musermode
18038 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
18039 if the inlined code would not work in user mode.
18040 This is the default when the target is @code{sh-*-linux*}.
18042 @item -multcost=@var{number}
18043 @opindex multcost=@var{number}
18044 Set the cost to assume for a multiply insn.
18046 @item -mdiv=@var{strategy}
18047 @opindex mdiv=@var{strategy}
18048 Set the division strategy to use for SHmedia code.  @var{strategy} must be
18049 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
18050 inv:call2, inv:fp .
18051 "fp" performs the operation in floating point.  This has a very high latency,
18052 but needs only a few instructions, so it might be a good choice if
18053 your code has enough easily-exploitable ILP to allow the compiler to
18054 schedule the floating-point instructions together with other instructions.
18055 Division by zero causes a floating-point exception.
18056 "inv" uses integer operations to calculate the inverse of the divisor,
18057 and then multiplies the dividend with the inverse.  This strategy allows
18058 cse and hoisting of the inverse calculation.  Division by zero calculates
18059 an unspecified result, but does not trap.
18060 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
18061 have been found, or if the entire operation has been hoisted to the same
18062 place, the last stages of the inverse calculation are intertwined with the
18063 final multiply to reduce the overall latency, at the expense of using a few
18064 more instructions, and thus offering fewer scheduling opportunities with
18065 other code.
18066 "call" calls a library function that usually implements the inv:minlat
18067 strategy.
18068 This gives high code density for m5-*media-nofpu compilations.
18069 "call2" uses a different entry point of the same library function, where it
18070 assumes that a pointer to a lookup table has already been set up, which
18071 exposes the pointer load to cse / code hoisting optimizations.
18072 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
18073 code generation, but if the code stays unoptimized, revert to the "call",
18074 "call2", or "fp" strategies, respectively.  Note that the
18075 potentially-trapping side effect of division by zero is carried by a
18076 separate instruction, so it is possible that all the integer instructions
18077 are hoisted out, but the marker for the side effect stays where it is.
18078 A recombination to fp operations or a call is not possible in that case.
18079 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
18080 that the inverse calculation was nor separated from the multiply, they speed
18081 up division where the dividend fits into 20 bits (plus sign where applicable),
18082 by inserting a test to skip a number of operations in this case; this test
18083 slows down the case of larger dividends.  inv20u assumes the case of a such
18084 a small dividend to be unlikely, and inv20l assumes it to be likely.
18086 @item -maccumulate-outgoing-args
18087 @opindex maccumulate-outgoing-args
18088 Reserve space once for outgoing arguments in the function prologue rather
18089 than around each call.  Generally beneficial for performance and size.  Also
18090 needed for unwinding to avoid changing the stack frame around conditional code.
18092 @item -mdivsi3_libfunc=@var{name}
18093 @opindex mdivsi3_libfunc=@var{name}
18094 Set the name of the library function used for 32-bit signed division to
18095 @var{name}.  This only affect the name used in the call and inv:call
18096 division strategies, and the compiler will still expect the same
18097 sets of input/output/clobbered registers as if this option was not present.
18099 @item -mfixed-range=@var{register-range}
18100 @opindex mfixed-range
18101 Generate code treating the given register range as fixed registers.
18102 A fixed register is one that the register allocator can not use.  This is
18103 useful when compiling kernel code.  A register range is specified as
18104 two registers separated by a dash.  Multiple register ranges can be
18105 specified separated by a comma.
18107 @item -mindexed-addressing
18108 @opindex mindexed-addressing
18109 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
18110 This is only safe if the hardware and/or OS implement 32-bit wrap-around
18111 semantics for the indexed addressing mode.  The architecture allows the
18112 implementation of processors with 64-bit MMU, which the OS could use to
18113 get 32-bit addressing, but since no current hardware implementation supports
18114 this or any other way to make the indexed addressing mode safe to use in
18115 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
18117 @item -mgettrcost=@var{number}
18118 @opindex mgettrcost=@var{number}
18119 Set the cost assumed for the gettr instruction to @var{number}.
18120 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
18122 @item -mpt-fixed
18123 @opindex mpt-fixed
18124 Assume pt* instructions won't trap.  This will generally generate better
18125 scheduled code, but is unsafe on current hardware.  The current architecture
18126 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
18127 This has the unintentional effect of making it unsafe to schedule ptabs /
18128 ptrel before a branch, or hoist it out of a loop.  For example,
18129 __do_global_ctors, a part of libgcc that runs constructors at program
18130 startup, calls functions in a list which is delimited by @minus{}1.  With the
18131 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
18132 That means that all the constructors will be run a bit quicker, but when
18133 the loop comes to the end of the list, the program crashes because ptabs
18134 loads @minus{}1 into a target register.  Since this option is unsafe for any
18135 hardware implementing the current architecture specification, the default
18136 is -mno-pt-fixed.  Unless the user specifies a specific cost with
18137 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
18138 this deters register allocation using target registers for storing
18139 ordinary integers.
18141 @item -minvalid-symbols
18142 @opindex minvalid-symbols
18143 Assume symbols might be invalid.  Ordinary function symbols generated by
18144 the compiler will always be valid to load with movi/shori/ptabs or
18145 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
18146 to generate symbols that will cause ptabs / ptrel to trap.
18147 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
18148 It will then prevent cross-basic-block cse, hoisting and most scheduling
18149 of symbol loads.  The default is @option{-mno-invalid-symbols}.
18151 @item -mbranch-cost=@var{num}
18152 @opindex mbranch-cost=@var{num}
18153 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
18154 will make the compiler try to generate more branch-free code if possible.  
18155 If not specified the value is selected depending on the processor type that
18156 is being compiled for.
18158 @item -mcbranchdi
18159 @opindex mcbranchdi
18160 Enable the @code{cbranchdi4} instruction pattern.
18162 @item -mcmpeqdi
18163 @opindex mcmpeqdi
18164 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
18165 is in effect.
18167 @item -mfused-madd
18168 @opindex mfused-madd
18169 Allow the usage of the @code{fmac} instruction (floating-point
18170 multiply-accumulate) if the processor type supports it.  Enabling this
18171 option might generate code that produces different numeric floating-point
18172 results compared to strict IEEE 754 arithmetic.
18174 @item -mpretend-cmove
18175 @opindex mpretend-cmove
18176 Prefer zero-displacement conditional branches for conditional move instruction
18177 patterns.  This can result in faster code on the SH4 processor.
18179 @end table
18181 @node Solaris 2 Options
18182 @subsection Solaris 2 Options
18183 @cindex Solaris 2 options
18185 These @samp{-m} options are supported on Solaris 2:
18187 @table @gcctabopt
18188 @item -mimpure-text
18189 @opindex mimpure-text
18190 @option{-mimpure-text}, used in addition to @option{-shared}, tells
18191 the compiler to not pass @option{-z text} to the linker when linking a
18192 shared object.  Using this option, you can link position-dependent
18193 code into a shared object.
18195 @option{-mimpure-text} suppresses the ``relocations remain against
18196 allocatable but non-writable sections'' linker error message.
18197 However, the necessary relocations will trigger copy-on-write, and the
18198 shared object is not actually shared across processes.  Instead of
18199 using @option{-mimpure-text}, you should compile all source code with
18200 @option{-fpic} or @option{-fPIC}.
18202 @end table
18204 These switches are supported in addition to the above on Solaris 2:
18206 @table @gcctabopt
18207 @item -pthreads
18208 @opindex pthreads
18209 Add support for multithreading using the POSIX threads library.  This
18210 option sets flags for both the preprocessor and linker.  This option does
18211 not affect the thread safety of object code produced  by the compiler or
18212 that of libraries supplied with it.
18214 @item -pthread
18215 @opindex pthread
18216 This is a synonym for @option{-pthreads}.
18217 @end table
18219 @node SPARC Options
18220 @subsection SPARC Options
18221 @cindex SPARC options
18223 These @samp{-m} options are supported on the SPARC:
18225 @table @gcctabopt
18226 @item -mno-app-regs
18227 @itemx -mapp-regs
18228 @opindex mno-app-regs
18229 @opindex mapp-regs
18230 Specify @option{-mapp-regs} to generate output using the global registers
18231 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
18232 is the default.
18234 To be fully SVR4 ABI compliant at the cost of some performance loss,
18235 specify @option{-mno-app-regs}.  You should compile libraries and system
18236 software with this option.
18238 @item -mflat
18239 @itemx -mno-flat
18240 @opindex mflat
18241 @opindex mno-flat
18242 With @option{-mflat}, the compiler does not generate save/restore instructions
18243 and uses a ``flat'' or single register window model.  This model is compatible
18244 with the regular register window model.  The local registers and the input
18245 registers (0--5) are still treated as ``call-saved'' registers and will be
18246 saved on the stack as needed.
18248 With @option{-mno-flat} (the default), the compiler generates save/restore
18249 instructions (except for leaf functions).  This is the normal operating mode.
18251 @item -mfpu
18252 @itemx -mhard-float
18253 @opindex mfpu
18254 @opindex mhard-float
18255 Generate output containing floating-point instructions.  This is the
18256 default.
18258 @item -mno-fpu
18259 @itemx -msoft-float
18260 @opindex mno-fpu
18261 @opindex msoft-float
18262 Generate output containing library calls for floating point.
18263 @strong{Warning:} the requisite libraries are not available for all SPARC
18264 targets.  Normally the facilities of the machine's usual C compiler are
18265 used, but this cannot be done directly in cross-compilation.  You must make
18266 your own arrangements to provide suitable library functions for
18267 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
18268 @samp{sparclite-*-*} do provide software floating-point support.
18270 @option{-msoft-float} changes the calling convention in the output file;
18271 therefore, it is only useful if you compile @emph{all} of a program with
18272 this option.  In particular, you need to compile @file{libgcc.a}, the
18273 library that comes with GCC, with @option{-msoft-float} in order for
18274 this to work.
18276 @item -mhard-quad-float
18277 @opindex mhard-quad-float
18278 Generate output containing quad-word (long double) floating-point
18279 instructions.
18281 @item -msoft-quad-float
18282 @opindex msoft-quad-float
18283 Generate output containing library calls for quad-word (long double)
18284 floating-point instructions.  The functions called are those specified
18285 in the SPARC ABI@.  This is the default.
18287 As of this writing, there are no SPARC implementations that have hardware
18288 support for the quad-word floating-point instructions.  They all invoke
18289 a trap handler for one of these instructions, and then the trap handler
18290 emulates the effect of the instruction.  Because of the trap handler overhead,
18291 this is much slower than calling the ABI library routines.  Thus the
18292 @option{-msoft-quad-float} option is the default.
18294 @item -mno-unaligned-doubles
18295 @itemx -munaligned-doubles
18296 @opindex mno-unaligned-doubles
18297 @opindex munaligned-doubles
18298 Assume that doubles have 8-byte alignment.  This is the default.
18300 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
18301 alignment only if they are contained in another type, or if they have an
18302 absolute address.  Otherwise, it assumes they have 4-byte alignment.
18303 Specifying this option avoids some rare compatibility problems with code
18304 generated by other compilers.  It is not the default because it results
18305 in a performance loss, especially for floating-point code.
18307 @item -mno-faster-structs
18308 @itemx -mfaster-structs
18309 @opindex mno-faster-structs
18310 @opindex mfaster-structs
18311 With @option{-mfaster-structs}, the compiler assumes that structures
18312 should have 8-byte alignment.  This enables the use of pairs of
18313 @code{ldd} and @code{std} instructions for copies in structure
18314 assignment, in place of twice as many @code{ld} and @code{st} pairs.
18315 However, the use of this changed alignment directly violates the SPARC
18316 ABI@.  Thus, it's intended only for use on targets where the developer
18317 acknowledges that their resulting code will not be directly in line with
18318 the rules of the ABI@.
18320 @item -mcpu=@var{cpu_type}
18321 @opindex mcpu
18322 Set the instruction set, register set, and instruction scheduling parameters
18323 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
18324 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
18325 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
18326 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
18327 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
18328 and @samp{niagara4}.
18330 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
18331 which selects the best architecture option for the host processor.
18332 @option{-mcpu=native} has no effect if GCC does not recognize
18333 the processor.
18335 Default instruction scheduling parameters are used for values that select
18336 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
18337 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
18339 Here is a list of each supported architecture and their supported
18340 implementations.
18342 @table @asis
18343 @item v7
18344 cypress
18346 @item v8
18347 supersparc, hypersparc, leon
18349 @item sparclite
18350 f930, f934, sparclite86x
18352 @item sparclet
18353 tsc701
18355 @item v9
18356 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
18357 @end table
18359 By default (unless configured otherwise), GCC generates code for the V7
18360 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
18361 additionally optimizes it for the Cypress CY7C602 chip, as used in the
18362 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
18363 SPARCStation 1, 2, IPX etc.
18365 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
18366 architecture.  The only difference from V7 code is that the compiler emits
18367 the integer multiply and integer divide instructions which exist in SPARC-V8
18368 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
18369 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
18370 2000 series.
18372 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
18373 the SPARC architecture.  This adds the integer multiply, integer divide step
18374 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
18375 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
18376 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
18377 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
18378 MB86934 chip, which is the more recent SPARClite with FPU@.
18380 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
18381 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
18382 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
18383 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
18384 optimizes it for the TEMIC SPARClet chip.
18386 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
18387 architecture.  This adds 64-bit integer and floating-point move instructions,
18388 3 additional floating-point condition code registers and conditional move
18389 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
18390 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
18391 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
18392 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
18393 @option{-mcpu=niagara}, the compiler additionally optimizes it for
18394 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
18395 additionally optimizes it for Sun UltraSPARC T2 chips. With
18396 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
18397 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
18398 additionally optimizes it for Sun UltraSPARC T4 chips.
18400 @item -mtune=@var{cpu_type}
18401 @opindex mtune
18402 Set the instruction scheduling parameters for machine type
18403 @var{cpu_type}, but do not set the instruction set or register set that the
18404 option @option{-mcpu=@var{cpu_type}} would.
18406 The same values for @option{-mcpu=@var{cpu_type}} can be used for
18407 @option{-mtune=@var{cpu_type}}, but the only useful values are those
18408 that select a particular CPU implementation.  Those are @samp{cypress},
18409 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
18410 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
18411 @samp{niagara}, @samp{niagara2}, @samp{niagara3} and @samp{niagara4}.  With
18412 native Solaris and GNU/Linux toolchains, @samp{native} can also be used.
18414 @item -mv8plus
18415 @itemx -mno-v8plus
18416 @opindex mv8plus
18417 @opindex mno-v8plus
18418 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
18419 difference from the V8 ABI is that the global and out registers are
18420 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
18421 mode for all SPARC-V9 processors.
18423 @item -mvis
18424 @itemx -mno-vis
18425 @opindex mvis
18426 @opindex mno-vis
18427 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
18428 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
18430 @item -mvis2
18431 @itemx -mno-vis2
18432 @opindex mvis2
18433 @opindex mno-vis2
18434 With @option{-mvis2}, GCC generates code that takes advantage of
18435 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
18436 default is @option{-mvis2} when targetting a cpu that supports such
18437 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
18438 also sets @option{-mvis}.
18440 @item -mvis3
18441 @itemx -mno-vis3
18442 @opindex mvis3
18443 @opindex mno-vis3
18444 With @option{-mvis3}, GCC generates code that takes advantage of
18445 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
18446 default is @option{-mvis3} when targetting a cpu that supports such
18447 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
18448 also sets @option{-mvis2} and @option{-mvis}.
18450 @item -mpopc
18451 @itemx -mno-popc
18452 @opindex mpopc
18453 @opindex mno-popc
18454 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
18455 population count instruction.  The default is @option{-mpopc}
18456 when targetting a cpu that supports such instructions, such as Niagara-2 and
18457 later.
18459 @item -mfmaf
18460 @itemx -mno-fmaf
18461 @opindex mfmaf
18462 @opindex mno-fmaf
18463 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
18464 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
18465 when targetting a cpu that supports such instructions, such as Niagara-3 and
18466 later.
18468 @item -mfix-at697f
18469 @opindex mfix-at697f
18470 Enable the documented workaround for the single erratum of the Atmel AT697F
18471 processor (which corresponds to erratum #13 of the AT697E processor).
18472 @end table
18474 These @samp{-m} options are supported in addition to the above
18475 on SPARC-V9 processors in 64-bit environments:
18477 @table @gcctabopt
18478 @item -mlittle-endian
18479 @opindex mlittle-endian
18480 Generate code for a processor running in little-endian mode.  It is only
18481 available for a few configurations and most notably not on Solaris and Linux.
18483 @item -m32
18484 @itemx -m64
18485 @opindex m32
18486 @opindex m64
18487 Generate code for a 32-bit or 64-bit environment.
18488 The 32-bit environment sets int, long and pointer to 32 bits.
18489 The 64-bit environment sets int to 32 bits and long and pointer
18490 to 64 bits.
18492 @item -mcmodel=@var{which}
18493 @opindex mcmodel
18494 Set the code model to one of
18496 @table @samp
18497 @item medlow
18498 The Medium/Low code model: 64-bit addresses, programs
18499 must be linked in the low 32 bits of memory.  Programs can be statically
18500 or dynamically linked.
18502 @item medmid
18503 The Medium/Middle code model: 64-bit addresses, programs
18504 must be linked in the low 44 bits of memory, the text and data segments must
18505 be less than 2GB in size and the data segment must be located within 2GB of
18506 the text segment.
18508 @item medany
18509 The Medium/Anywhere code model: 64-bit addresses, programs
18510 may be linked anywhere in memory, the text and data segments must be less
18511 than 2GB in size and the data segment must be located within 2GB of the
18512 text segment.
18514 @item embmedany
18515 The Medium/Anywhere code model for embedded systems:
18516 64-bit addresses, the text and data segments must be less than 2GB in
18517 size, both starting anywhere in memory (determined at link time).  The
18518 global register %g4 points to the base of the data segment.  Programs
18519 are statically linked and PIC is not supported.
18520 @end table
18522 @item -mmemory-model=@var{mem-model}
18523 @opindex mmemory-model
18524 Set the memory model in force on the processor to one of
18526 @table @samp
18527 @item default
18528 The default memory model for the processor and operating system.
18530 @item rmo
18531 Relaxed Memory Order
18533 @item pso
18534 Partial Store Order
18536 @item tso
18537 Total Store Order
18539 @item sc
18540 Sequential Consistency
18541 @end table
18543 These memory models are formally defined in Appendix D of the Sparc V9
18544 architecture manual, as set in the processor's @code{PSTATE.MM} field.
18546 @item -mstack-bias
18547 @itemx -mno-stack-bias
18548 @opindex mstack-bias
18549 @opindex mno-stack-bias
18550 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
18551 frame pointer if present, are offset by @minus{}2047 which must be added back
18552 when making stack frame references.  This is the default in 64-bit mode.
18553 Otherwise, assume no such offset is present.
18554 @end table
18556 @node SPU Options
18557 @subsection SPU Options
18558 @cindex SPU options
18560 These @samp{-m} options are supported on the SPU:
18562 @table @gcctabopt
18563 @item -mwarn-reloc
18564 @itemx -merror-reloc
18565 @opindex mwarn-reloc
18566 @opindex merror-reloc
18568 The loader for SPU does not handle dynamic relocations.  By default, GCC
18569 will give an error when it generates code that requires a dynamic
18570 relocation.  @option{-mno-error-reloc} disables the error,
18571 @option{-mwarn-reloc} will generate a warning instead.
18573 @item -msafe-dma
18574 @itemx -munsafe-dma
18575 @opindex msafe-dma
18576 @opindex munsafe-dma
18578 Instructions that initiate or test completion of DMA must not be
18579 reordered with respect to loads and stores of the memory that is being
18580 accessed.  Users typically address this problem using the volatile
18581 keyword, but that can lead to inefficient code in places where the
18582 memory is known to not change.  Rather than mark the memory as volatile
18583 we treat the DMA instructions as potentially effecting all memory.  With
18584 @option{-munsafe-dma} users must use the volatile keyword to protect
18585 memory accesses.
18587 @item -mbranch-hints
18588 @opindex mbranch-hints
18590 By default, GCC will generate a branch hint instruction to avoid
18591 pipeline stalls for always taken or probably taken branches.  A hint
18592 will not be generated closer than 8 instructions away from its branch.
18593 There is little reason to disable them, except for debugging purposes,
18594 or to make an object a little bit smaller.
18596 @item -msmall-mem
18597 @itemx -mlarge-mem
18598 @opindex msmall-mem
18599 @opindex mlarge-mem
18601 By default, GCC generates code assuming that addresses are never larger
18602 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
18603 a full 32-bit address.
18605 @item -mstdmain
18606 @opindex mstdmain
18608 By default, GCC links against startup code that assumes the SPU-style
18609 main function interface (which has an unconventional parameter list).
18610 With @option{-mstdmain}, GCC will link your program against startup
18611 code that assumes a C99-style interface to @code{main}, including a
18612 local copy of @code{argv} strings.
18614 @item -mfixed-range=@var{register-range}
18615 @opindex mfixed-range
18616 Generate code treating the given register range as fixed registers.
18617 A fixed register is one that the register allocator can not use.  This is
18618 useful when compiling kernel code.  A register range is specified as
18619 two registers separated by a dash.  Multiple register ranges can be
18620 specified separated by a comma.
18622 @item -mea32
18623 @itemx -mea64
18624 @opindex mea32
18625 @opindex mea64
18626 Compile code assuming that pointers to the PPU address space accessed
18627 via the @code{__ea} named address space qualifier are either 32 or 64
18628 bits wide.  The default is 32 bits.  As this is an ABI changing option,
18629 all object code in an executable must be compiled with the same setting.
18631 @item -maddress-space-conversion
18632 @itemx -mno-address-space-conversion
18633 @opindex maddress-space-conversion
18634 @opindex mno-address-space-conversion
18635 Allow/disallow treating the @code{__ea} address space as superset
18636 of the generic address space.  This enables explicit type casts
18637 between @code{__ea} and generic pointer as well as implicit
18638 conversions of generic pointers to @code{__ea} pointers.  The
18639 default is to allow address space pointer conversions.
18641 @item -mcache-size=@var{cache-size}
18642 @opindex mcache-size
18643 This option controls the version of libgcc that the compiler links to an
18644 executable and selects a software-managed cache for accessing variables
18645 in the @code{__ea} address space with a particular cache size.  Possible
18646 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
18647 and @samp{128}.  The default cache size is 64KB.
18649 @item -matomic-updates
18650 @itemx -mno-atomic-updates
18651 @opindex matomic-updates
18652 @opindex mno-atomic-updates
18653 This option controls the version of libgcc that the compiler links to an
18654 executable and selects whether atomic updates to the software-managed
18655 cache of PPU-side variables are used.  If you use atomic updates, changes
18656 to a PPU variable from SPU code using the @code{__ea} named address space
18657 qualifier will not interfere with changes to other PPU variables residing
18658 in the same cache line from PPU code.  If you do not use atomic updates,
18659 such interference may occur; however, writing back cache lines will be
18660 more efficient.  The default behavior is to use atomic updates.
18662 @item -mdual-nops
18663 @itemx -mdual-nops=@var{n}
18664 @opindex mdual-nops
18665 By default, GCC will insert nops to increase dual issue when it expects
18666 it to increase performance.  @var{n} can be a value from 0 to 10.  A
18667 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
18668 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
18670 @item -mhint-max-nops=@var{n}
18671 @opindex mhint-max-nops
18672 Maximum number of nops to insert for a branch hint.  A branch hint must
18673 be at least 8 instructions away from the branch it is effecting.  GCC
18674 will insert up to @var{n} nops to enforce this, otherwise it will not
18675 generate the branch hint.
18677 @item -mhint-max-distance=@var{n}
18678 @opindex mhint-max-distance
18679 The encoding of the branch hint instruction limits the hint to be within
18680 256 instructions of the branch it is effecting.  By default, GCC makes
18681 sure it is within 125.
18683 @item -msafe-hints
18684 @opindex msafe-hints
18685 Work around a hardware bug that causes the SPU to stall indefinitely.
18686 By default, GCC will insert the @code{hbrp} instruction to make sure
18687 this stall won't happen.
18689 @end table
18691 @node System V Options
18692 @subsection Options for System V
18694 These additional options are available on System V Release 4 for
18695 compatibility with other compilers on those systems:
18697 @table @gcctabopt
18698 @item -G
18699 @opindex G
18700 Create a shared object.
18701 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
18703 @item -Qy
18704 @opindex Qy
18705 Identify the versions of each tool used by the compiler, in a
18706 @code{.ident} assembler directive in the output.
18708 @item -Qn
18709 @opindex Qn
18710 Refrain from adding @code{.ident} directives to the output file (this is
18711 the default).
18713 @item -YP,@var{dirs}
18714 @opindex YP
18715 Search the directories @var{dirs}, and no others, for libraries
18716 specified with @option{-l}.
18718 @item -Ym,@var{dir}
18719 @opindex Ym
18720 Look in the directory @var{dir} to find the M4 preprocessor.
18721 The assembler uses this option.
18722 @c This is supposed to go with a -Yd for predefined M4 macro files, but
18723 @c the generic assembler that comes with Solaris takes just -Ym.
18724 @end table
18726 @node TILE-Gx Options
18727 @subsection TILE-Gx Options
18728 @cindex TILE-Gx options
18730 These @samp{-m} options are supported on the TILE-Gx:
18732 @table @gcctabopt
18733 @item -mcpu=@var{name}
18734 @opindex mcpu
18735 Selects the type of CPU to be targeted.  Currently the only supported
18736 type is @samp{tilegx}.
18738 @item -m32
18739 @itemx -m64
18740 @opindex m32
18741 @opindex m64
18742 Generate code for a 32-bit or 64-bit environment.  The 32-bit
18743 environment sets int, long, and pointer to 32 bits.  The 64-bit
18744 environment sets int to 32 bits and long and pointer to 64 bits.
18745 @end table
18747 @node TILEPro Options
18748 @subsection TILEPro Options
18749 @cindex TILEPro options
18751 These @samp{-m} options are supported on the TILEPro:
18753 @table @gcctabopt
18754 @item -mcpu=@var{name}
18755 @opindex mcpu
18756 Selects the type of CPU to be targeted.  Currently the only supported
18757 type is @samp{tilepro}.
18759 @item -m32
18760 @opindex m32
18761 Generate code for a 32-bit environment, which sets int, long, and
18762 pointer to 32 bits.  This is the only supported behavior so the flag
18763 is essentially ignored.
18764 @end table
18766 @node V850 Options
18767 @subsection V850 Options
18768 @cindex V850 Options
18770 These @samp{-m} options are defined for V850 implementations:
18772 @table @gcctabopt
18773 @item -mlong-calls
18774 @itemx -mno-long-calls
18775 @opindex mlong-calls
18776 @opindex mno-long-calls
18777 Treat all calls as being far away (near).  If calls are assumed to be
18778 far away, the compiler will always load the functions address up into a
18779 register, and call indirect through the pointer.
18781 @item -mno-ep
18782 @itemx -mep
18783 @opindex mno-ep
18784 @opindex mep
18785 Do not optimize (do optimize) basic blocks that use the same index
18786 pointer 4 or more times to copy pointer into the @code{ep} register, and
18787 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
18788 option is on by default if you optimize.
18790 @item -mno-prolog-function
18791 @itemx -mprolog-function
18792 @opindex mno-prolog-function
18793 @opindex mprolog-function
18794 Do not use (do use) external functions to save and restore registers
18795 at the prologue and epilogue of a function.  The external functions
18796 are slower, but use less code space if more than one function saves
18797 the same number of registers.  The @option{-mprolog-function} option
18798 is on by default if you optimize.
18800 @item -mspace
18801 @opindex mspace
18802 Try to make the code as small as possible.  At present, this just turns
18803 on the @option{-mep} and @option{-mprolog-function} options.
18805 @item -mtda=@var{n}
18806 @opindex mtda
18807 Put static or global variables whose size is @var{n} bytes or less into
18808 the tiny data area that register @code{ep} points to.  The tiny data
18809 area can hold up to 256 bytes in total (128 bytes for byte references).
18811 @item -msda=@var{n}
18812 @opindex msda
18813 Put static or global variables whose size is @var{n} bytes or less into
18814 the small data area that register @code{gp} points to.  The small data
18815 area can hold up to 64 kilobytes.
18817 @item -mzda=@var{n}
18818 @opindex mzda
18819 Put static or global variables whose size is @var{n} bytes or less into
18820 the first 32 kilobytes of memory.
18822 @item -mv850
18823 @opindex mv850
18824 Specify that the target processor is the V850.
18826 @item -mbig-switch
18827 @opindex mbig-switch
18828 Generate code suitable for big switch tables.  Use this option only if
18829 the assembler/linker complain about out of range branches within a switch
18830 table.
18832 @item -mapp-regs
18833 @opindex mapp-regs
18834 This option will cause r2 and r5 to be used in the code generated by
18835 the compiler.  This setting is the default.
18837 @item -mno-app-regs
18838 @opindex mno-app-regs
18839 This option will cause r2 and r5 to be treated as fixed registers.
18841 @item -mv850e2v3
18842 @opindex mv850e2v3
18843 Specify that the target processor is the V850E2V3.  The preprocessor
18844 constants @samp{__v850e2v3__} will be defined if
18845 this option is used.
18847 @item -mv850e2
18848 @opindex mv850e2
18849 Specify that the target processor is the V850E2.  The preprocessor
18850 constants @samp{__v850e2__} will be defined if this option is used.
18852 @item -mv850e1
18853 @opindex mv850e1
18854 Specify that the target processor is the V850E1.  The preprocessor
18855 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
18856 this option is used.
18858 @item -mv850es
18859 @opindex mv850es
18860 Specify that the target processor is the V850ES.  This is an alias for
18861 the @option{-mv850e1} option.
18863 @item -mv850e
18864 @opindex mv850e
18865 Specify that the target processor is the V850E@.  The preprocessor
18866 constant @samp{__v850e__} will be defined if this option is used.
18868 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
18869 nor @option{-mv850e2} nor @option{-mv850e2v3}
18870 are defined then a default target processor will be chosen and the
18871 relevant @samp{__v850*__} preprocessor constant will be defined.
18873 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
18874 defined, regardless of which processor variant is the target.
18876 @item -mdisable-callt
18877 @opindex mdisable-callt
18878 This option will suppress generation of the CALLT instruction for the
18879 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
18880 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
18882 @end table
18884 @node VAX Options
18885 @subsection VAX Options
18886 @cindex VAX options
18888 These @samp{-m} options are defined for the VAX:
18890 @table @gcctabopt
18891 @item -munix
18892 @opindex munix
18893 Do not output certain jump instructions (@code{aobleq} and so on)
18894 that the Unix assembler for the VAX cannot handle across long
18895 ranges.
18897 @item -mgnu
18898 @opindex mgnu
18899 Do output those jump instructions, on the assumption that you
18900 will assemble with the GNU assembler.
18902 @item -mg
18903 @opindex mg
18904 Output code for G-format floating-point numbers instead of D-format.
18905 @end table
18907 @node VMS Options
18908 @subsection VMS Options
18910 These @samp{-m} options are defined for the VMS implementations:
18912 @table @gcctabopt
18913 @item -mvms-return-codes
18914 @opindex mvms-return-codes
18915 Return VMS condition codes from @code{main}. The default is to return POSIX-style
18916 condition (e.g.@ error) codes.
18918 @item -mdebug-main=@var{prefix}
18919 @opindex mdebug-main=@var{prefix}
18920 Flag the first routine whose name starts with @var{prefix} as the main
18921 routine for the debugger.
18923 @item -mmalloc64
18924 @opindex mmalloc64
18925 Default to 64-bit memory allocation routines.
18927 @item -mpointer-size=@var{size}
18928 @opindex -mpointer-size=@var{size}
18929 Set the default size of pointers. Possible options for @var{size} are
18930 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
18931 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
18932 The later option disables @code{pragma pointer_size}.
18933 @end table
18935 @node VxWorks Options
18936 @subsection VxWorks Options
18937 @cindex VxWorks Options
18939 The options in this section are defined for all VxWorks targets.
18940 Options specific to the target hardware are listed with the other
18941 options for that target.
18943 @table @gcctabopt
18944 @item -mrtp
18945 @opindex mrtp
18946 GCC can generate code for both VxWorks kernels and real time processes
18947 (RTPs).  This option switches from the former to the latter.  It also
18948 defines the preprocessor macro @code{__RTP__}.
18950 @item -non-static
18951 @opindex non-static
18952 Link an RTP executable against shared libraries rather than static
18953 libraries.  The options @option{-static} and @option{-shared} can
18954 also be used for RTPs (@pxref{Link Options}); @option{-static}
18955 is the default.
18957 @item -Bstatic
18958 @itemx -Bdynamic
18959 @opindex Bstatic
18960 @opindex Bdynamic
18961 These options are passed down to the linker.  They are defined for
18962 compatibility with Diab.
18964 @item -Xbind-lazy
18965 @opindex Xbind-lazy
18966 Enable lazy binding of function calls.  This option is equivalent to
18967 @option{-Wl,-z,now} and is defined for compatibility with Diab.
18969 @item -Xbind-now
18970 @opindex Xbind-now
18971 Disable lazy binding of function calls.  This option is the default and
18972 is defined for compatibility with Diab.
18973 @end table
18975 @node x86-64 Options
18976 @subsection x86-64 Options
18977 @cindex x86-64 options
18979 These are listed under @xref{i386 and x86-64 Options}.
18981 @node Xstormy16 Options
18982 @subsection Xstormy16 Options
18983 @cindex Xstormy16 Options
18985 These options are defined for Xstormy16:
18987 @table @gcctabopt
18988 @item -msim
18989 @opindex msim
18990 Choose startup files and linker script suitable for the simulator.
18991 @end table
18993 @node Xtensa Options
18994 @subsection Xtensa Options
18995 @cindex Xtensa Options
18997 These options are supported for Xtensa targets:
18999 @table @gcctabopt
19000 @item -mconst16
19001 @itemx -mno-const16
19002 @opindex mconst16
19003 @opindex mno-const16
19004 Enable or disable use of @code{CONST16} instructions for loading
19005 constant values.  The @code{CONST16} instruction is currently not a
19006 standard option from Tensilica.  When enabled, @code{CONST16}
19007 instructions are always used in place of the standard @code{L32R}
19008 instructions.  The use of @code{CONST16} is enabled by default only if
19009 the @code{L32R} instruction is not available.
19011 @item -mfused-madd
19012 @itemx -mno-fused-madd
19013 @opindex mfused-madd
19014 @opindex mno-fused-madd
19015 Enable or disable use of fused multiply/add and multiply/subtract
19016 instructions in the floating-point option.  This has no effect if the
19017 floating-point option is not also enabled.  Disabling fused multiply/add
19018 and multiply/subtract instructions forces the compiler to use separate
19019 instructions for the multiply and add/subtract operations.  This may be
19020 desirable in some cases where strict IEEE 754-compliant results are
19021 required: the fused multiply add/subtract instructions do not round the
19022 intermediate result, thereby producing results with @emph{more} bits of
19023 precision than specified by the IEEE standard.  Disabling fused multiply
19024 add/subtract instructions also ensures that the program output is not
19025 sensitive to the compiler's ability to combine multiply and add/subtract
19026 operations.
19028 @item -mserialize-volatile
19029 @itemx -mno-serialize-volatile
19030 @opindex mserialize-volatile
19031 @opindex mno-serialize-volatile
19032 When this option is enabled, GCC inserts @code{MEMW} instructions before
19033 @code{volatile} memory references to guarantee sequential consistency.
19034 The default is @option{-mserialize-volatile}.  Use
19035 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
19037 @item -mforce-no-pic
19038 @opindex mforce-no-pic
19039 For targets, like GNU/Linux, where all user-mode Xtensa code must be
19040 position-independent code (PIC), this option disables PIC for compiling
19041 kernel code.
19043 @item -mtext-section-literals
19044 @itemx -mno-text-section-literals
19045 @opindex mtext-section-literals
19046 @opindex mno-text-section-literals
19047 Control the treatment of literal pools.  The default is
19048 @option{-mno-text-section-literals}, which places literals in a separate
19049 section in the output file.  This allows the literal pool to be placed
19050 in a data RAM/ROM, and it also allows the linker to combine literal
19051 pools from separate object files to remove redundant literals and
19052 improve code size.  With @option{-mtext-section-literals}, the literals
19053 are interspersed in the text section in order to keep them as close as
19054 possible to their references.  This may be necessary for large assembly
19055 files.
19057 @item -mtarget-align
19058 @itemx -mno-target-align
19059 @opindex mtarget-align
19060 @opindex mno-target-align
19061 When this option is enabled, GCC instructs the assembler to
19062 automatically align instructions to reduce branch penalties at the
19063 expense of some code density.  The assembler attempts to widen density
19064 instructions to align branch targets and the instructions following call
19065 instructions.  If there are not enough preceding safe density
19066 instructions to align a target, no widening will be performed.  The
19067 default is @option{-mtarget-align}.  These options do not affect the
19068 treatment of auto-aligned instructions like @code{LOOP}, which the
19069 assembler will always align, either by widening density instructions or
19070 by inserting no-op instructions.
19072 @item -mlongcalls
19073 @itemx -mno-longcalls
19074 @opindex mlongcalls
19075 @opindex mno-longcalls
19076 When this option is enabled, GCC instructs the assembler to translate
19077 direct calls to indirect calls unless it can determine that the target
19078 of a direct call is in the range allowed by the call instruction.  This
19079 translation typically occurs for calls to functions in other source
19080 files.  Specifically, the assembler translates a direct @code{CALL}
19081 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
19082 The default is @option{-mno-longcalls}.  This option should be used in
19083 programs where the call target can potentially be out of range.  This
19084 option is implemented in the assembler, not the compiler, so the
19085 assembly code generated by GCC will still show direct call
19086 instructions---look at the disassembled object code to see the actual
19087 instructions.  Note that the assembler will use an indirect call for
19088 every cross-file call, not just those that really will be out of range.
19089 @end table
19091 @node zSeries Options
19092 @subsection zSeries Options
19093 @cindex zSeries options
19095 These are listed under @xref{S/390 and zSeries Options}.
19097 @node Code Gen Options
19098 @section Options for Code Generation Conventions
19099 @cindex code generation conventions
19100 @cindex options, code generation
19101 @cindex run-time options
19103 These machine-independent options control the interface conventions
19104 used in code generation.
19106 Most of them have both positive and negative forms; the negative form
19107 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
19108 one of the forms is listed---the one that is not the default.  You
19109 can figure out the other form by either removing @samp{no-} or adding
19112 @table @gcctabopt
19113 @item -fbounds-check
19114 @opindex fbounds-check
19115 For front ends that support it, generate additional code to check that
19116 indices used to access arrays are within the declared range.  This is
19117 currently only supported by the Java and Fortran front ends, where
19118 this option defaults to true and false respectively.
19120 @item -ftrapv
19121 @opindex ftrapv
19122 This option generates traps for signed overflow on addition, subtraction,
19123 multiplication operations.
19125 @item -fwrapv
19126 @opindex fwrapv
19127 This option instructs the compiler to assume that signed arithmetic
19128 overflow of addition, subtraction and multiplication wraps around
19129 using twos-complement representation.  This flag enables some optimizations
19130 and disables others.  This option is enabled by default for the Java
19131 front end, as required by the Java language specification.
19133 @item -fexceptions
19134 @opindex fexceptions
19135 Enable exception handling.  Generates extra code needed to propagate
19136 exceptions.  For some targets, this implies GCC will generate frame
19137 unwind information for all functions, which can produce significant data
19138 size overhead, although it does not affect execution.  If you do not
19139 specify this option, GCC will enable it by default for languages like
19140 C++ that normally require exception handling, and disable it for
19141 languages like C that do not normally require it.  However, you may need
19142 to enable this option when compiling C code that needs to interoperate
19143 properly with exception handlers written in C++.  You may also wish to
19144 disable this option if you are compiling older C++ programs that don't
19145 use exception handling.
19147 @item -fnon-call-exceptions
19148 @opindex fnon-call-exceptions
19149 Generate code that allows trapping instructions to throw exceptions.
19150 Note that this requires platform-specific runtime support that does
19151 not exist everywhere.  Moreover, it only allows @emph{trapping}
19152 instructions to throw exceptions, i.e.@: memory references or floating-point
19153 instructions.  It does not allow exceptions to be thrown from
19154 arbitrary signal handlers such as @code{SIGALRM}.
19156 @item -funwind-tables
19157 @opindex funwind-tables
19158 Similar to @option{-fexceptions}, except that it will just generate any needed
19159 static data, but will not affect the generated code in any other way.
19160 You will normally not enable this option; instead, a language processor
19161 that needs this handling would enable it on your behalf.
19163 @item -fasynchronous-unwind-tables
19164 @opindex fasynchronous-unwind-tables
19165 Generate unwind table in DWARF 2 format, if supported by target machine.  The
19166 table is exact at each instruction boundary, so it can be used for stack
19167 unwinding from asynchronous events (such as debugger or garbage collector).
19169 @item -fpcc-struct-return
19170 @opindex fpcc-struct-return
19171 Return ``short'' @code{struct} and @code{union} values in memory like
19172 longer ones, rather than in registers.  This convention is less
19173 efficient, but it has the advantage of allowing intercallability between
19174 GCC-compiled files and files compiled with other compilers, particularly
19175 the Portable C Compiler (pcc).
19177 The precise convention for returning structures in memory depends
19178 on the target configuration macros.
19180 Short structures and unions are those whose size and alignment match
19181 that of some integer type.
19183 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
19184 switch is not binary compatible with code compiled with the
19185 @option{-freg-struct-return} switch.
19186 Use it to conform to a non-default application binary interface.
19188 @item -freg-struct-return
19189 @opindex freg-struct-return
19190 Return @code{struct} and @code{union} values in registers when possible.
19191 This is more efficient for small structures than
19192 @option{-fpcc-struct-return}.
19194 If you specify neither @option{-fpcc-struct-return} nor
19195 @option{-freg-struct-return}, GCC defaults to whichever convention is
19196 standard for the target.  If there is no standard convention, GCC
19197 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
19198 the principal compiler.  In those cases, we can choose the standard, and
19199 we chose the more efficient register return alternative.
19201 @strong{Warning:} code compiled with the @option{-freg-struct-return}
19202 switch is not binary compatible with code compiled with the
19203 @option{-fpcc-struct-return} switch.
19204 Use it to conform to a non-default application binary interface.
19206 @item -fshort-enums
19207 @opindex fshort-enums
19208 Allocate to an @code{enum} type only as many bytes as it needs for the
19209 declared range of possible values.  Specifically, the @code{enum} type
19210 will be equivalent to the smallest integer type that has enough room.
19212 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
19213 code that is not binary compatible with code generated without that switch.
19214 Use it to conform to a non-default application binary interface.
19216 @item -fshort-double
19217 @opindex fshort-double
19218 Use the same size for @code{double} as for @code{float}.
19220 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
19221 code that is not binary compatible with code generated without that switch.
19222 Use it to conform to a non-default application binary interface.
19224 @item -fshort-wchar
19225 @opindex fshort-wchar
19226 Override the underlying type for @samp{wchar_t} to be @samp{short
19227 unsigned int} instead of the default for the target.  This option is
19228 useful for building programs to run under WINE@.
19230 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
19231 code that is not binary compatible with code generated without that switch.
19232 Use it to conform to a non-default application binary interface.
19234 @item -fno-common
19235 @opindex fno-common
19236 In C code, controls the placement of uninitialized global variables.
19237 Unix C compilers have traditionally permitted multiple definitions of
19238 such variables in different compilation units by placing the variables
19239 in a common block.
19240 This is the behavior specified by @option{-fcommon}, and is the default
19241 for GCC on most targets.
19242 On the other hand, this behavior is not required by ISO C, and on some
19243 targets may carry a speed or code size penalty on variable references.
19244 The @option{-fno-common} option specifies that the compiler should place
19245 uninitialized global variables in the data section of the object file,
19246 rather than generating them as common blocks.
19247 This has the effect that if the same variable is declared
19248 (without @code{extern}) in two different compilations,
19249 you will get a multiple-definition error when you link them.
19250 In this case, you must compile with @option{-fcommon} instead.
19251 Compiling with @option{-fno-common} is useful on targets for which
19252 it provides better performance, or if you wish to verify that the
19253 program will work on other systems that always treat uninitialized
19254 variable declarations this way.
19256 @item -fno-ident
19257 @opindex fno-ident
19258 Ignore the @samp{#ident} directive.
19260 @item -finhibit-size-directive
19261 @opindex finhibit-size-directive
19262 Don't output a @code{.size} assembler directive, or anything else that
19263 would cause trouble if the function is split in the middle, and the
19264 two halves are placed at locations far apart in memory.  This option is
19265 used when compiling @file{crtstuff.c}; you should not need to use it
19266 for anything else.
19268 @item -fverbose-asm
19269 @opindex fverbose-asm
19270 Put extra commentary information in the generated assembly code to
19271 make it more readable.  This option is generally only of use to those
19272 who actually need to read the generated assembly code (perhaps while
19273 debugging the compiler itself).
19275 @option{-fno-verbose-asm}, the default, causes the
19276 extra information to be omitted and is useful when comparing two assembler
19277 files.
19279 @item -frecord-gcc-switches
19280 @opindex frecord-gcc-switches
19281 This switch causes the command line that was used to invoke the
19282 compiler to be recorded into the object file that is being created.
19283 This switch is only implemented on some targets and the exact format
19284 of the recording is target and binary file format dependent, but it
19285 usually takes the form of a section containing ASCII text.  This
19286 switch is related to the @option{-fverbose-asm} switch, but that
19287 switch only records information in the assembler output file as
19288 comments, so it never reaches the object file.
19289 See also @option{-grecord-gcc-switches} for another
19290 way of storing compiler options into the object file.
19292 @item -fpic
19293 @opindex fpic
19294 @cindex global offset table
19295 @cindex PIC
19296 Generate position-independent code (PIC) suitable for use in a shared
19297 library, if supported for the target machine.  Such code accesses all
19298 constant addresses through a global offset table (GOT)@.  The dynamic
19299 loader resolves the GOT entries when the program starts (the dynamic
19300 loader is not part of GCC; it is part of the operating system).  If
19301 the GOT size for the linked executable exceeds a machine-specific
19302 maximum size, you get an error message from the linker indicating that
19303 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
19304 instead.  (These maximums are 8k on the SPARC and 32k
19305 on the m68k and RS/6000.  The 386 has no such limit.)
19307 Position-independent code requires special support, and therefore works
19308 only on certain machines.  For the 386, GCC supports PIC for System V
19309 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
19310 position-independent.
19312 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19313 are defined to 1.
19315 @item -fPIC
19316 @opindex fPIC
19317 If supported for the target machine, emit position-independent code,
19318 suitable for dynamic linking and avoiding any limit on the size of the
19319 global offset table.  This option makes a difference on the m68k,
19320 PowerPC and SPARC@.
19322 Position-independent code requires special support, and therefore works
19323 only on certain machines.
19325 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19326 are defined to 2.
19328 @item -fpie
19329 @itemx -fPIE
19330 @opindex fpie
19331 @opindex fPIE
19332 These options are similar to @option{-fpic} and @option{-fPIC}, but
19333 generated position independent code can be only linked into executables.
19334 Usually these options are used when @option{-pie} GCC option will be
19335 used during linking.
19337 @option{-fpie} and @option{-fPIE} both define the macros
19338 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
19339 for @option{-fpie} and 2 for @option{-fPIE}.
19341 @item -fno-jump-tables
19342 @opindex fno-jump-tables
19343 Do not use jump tables for switch statements even where it would be
19344 more efficient than other code generation strategies.  This option is
19345 of use in conjunction with @option{-fpic} or @option{-fPIC} for
19346 building code that forms part of a dynamic linker and cannot
19347 reference the address of a jump table.  On some targets, jump tables
19348 do not require a GOT and this option is not needed.
19350 @item -ffixed-@var{reg}
19351 @opindex ffixed
19352 Treat the register named @var{reg} as a fixed register; generated code
19353 should never refer to it (except perhaps as a stack pointer, frame
19354 pointer or in some other fixed role).
19356 @var{reg} must be the name of a register.  The register names accepted
19357 are machine-specific and are defined in the @code{REGISTER_NAMES}
19358 macro in the machine description macro file.
19360 This flag does not have a negative form, because it specifies a
19361 three-way choice.
19363 @item -fcall-used-@var{reg}
19364 @opindex fcall-used
19365 Treat the register named @var{reg} as an allocable register that is
19366 clobbered by function calls.  It may be allocated for temporaries or
19367 variables that do not live across a call.  Functions compiled this way
19368 will not save and restore the register @var{reg}.
19370 It is an error to used this flag with the frame pointer or stack pointer.
19371 Use of this flag for other registers that have fixed pervasive roles in
19372 the machine's execution model will produce disastrous results.
19374 This flag does not have a negative form, because it specifies a
19375 three-way choice.
19377 @item -fcall-saved-@var{reg}
19378 @opindex fcall-saved
19379 Treat the register named @var{reg} as an allocable register saved by
19380 functions.  It may be allocated even for temporaries or variables that
19381 live across a call.  Functions compiled this way will save and restore
19382 the register @var{reg} if they use it.
19384 It is an error to used this flag with the frame pointer or stack pointer.
19385 Use of this flag for other registers that have fixed pervasive roles in
19386 the machine's execution model will produce disastrous results.
19388 A different sort of disaster will result from the use of this flag for
19389 a register in which function values may be returned.
19391 This flag does not have a negative form, because it specifies a
19392 three-way choice.
19394 @item -fpack-struct[=@var{n}]
19395 @opindex fpack-struct
19396 Without a value specified, pack all structure members together without
19397 holes.  When a value is specified (which must be a small power of two), pack
19398 structure members according to this value, representing the maximum
19399 alignment (that is, objects with default alignment requirements larger than
19400 this will be output potentially unaligned at the next fitting location.
19402 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
19403 code that is not binary compatible with code generated without that switch.
19404 Additionally, it makes the code suboptimal.
19405 Use it to conform to a non-default application binary interface.
19407 @item -finstrument-functions
19408 @opindex finstrument-functions
19409 Generate instrumentation calls for entry and exit to functions.  Just
19410 after function entry and just before function exit, the following
19411 profiling functions will be called with the address of the current
19412 function and its call site.  (On some platforms,
19413 @code{__builtin_return_address} does not work beyond the current
19414 function, so the call site information may not be available to the
19415 profiling functions otherwise.)
19417 @smallexample
19418 void __cyg_profile_func_enter (void *this_fn,
19419                                void *call_site);
19420 void __cyg_profile_func_exit  (void *this_fn,
19421                                void *call_site);
19422 @end smallexample
19424 The first argument is the address of the start of the current function,
19425 which may be looked up exactly in the symbol table.
19427 This instrumentation is also done for functions expanded inline in other
19428 functions.  The profiling calls will indicate where, conceptually, the
19429 inline function is entered and exited.  This means that addressable
19430 versions of such functions must be available.  If all your uses of a
19431 function are expanded inline, this may mean an additional expansion of
19432 code size.  If you use @samp{extern inline} in your C code, an
19433 addressable version of such functions must be provided.  (This is
19434 normally the case anyways, but if you get lucky and the optimizer always
19435 expands the functions inline, you might have gotten away without
19436 providing static copies.)
19438 A function may be given the attribute @code{no_instrument_function}, in
19439 which case this instrumentation will not be done.  This can be used, for
19440 example, for the profiling functions listed above, high-priority
19441 interrupt routines, and any functions from which the profiling functions
19442 cannot safely be called (perhaps signal handlers, if the profiling
19443 routines generate output or allocate memory).
19445 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
19446 @opindex finstrument-functions-exclude-file-list
19448 Set the list of functions that are excluded from instrumentation (see
19449 the description of @code{-finstrument-functions}).  If the file that
19450 contains a function definition matches with one of @var{file}, then
19451 that function is not instrumented.  The match is done on substrings:
19452 if the @var{file} parameter is a substring of the file name, it is
19453 considered to be a match.
19455 For example:
19457 @smallexample
19458 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
19459 @end smallexample
19461 @noindent
19462 will exclude any inline function defined in files whose pathnames
19463 contain @code{/bits/stl} or @code{include/sys}.
19465 If, for some reason, you want to include letter @code{','} in one of
19466 @var{sym}, write @code{'\,'}. For example,
19467 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
19468 (note the single quote surrounding the option).
19470 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
19471 @opindex finstrument-functions-exclude-function-list
19473 This is similar to @code{-finstrument-functions-exclude-file-list},
19474 but this option sets the list of function names to be excluded from
19475 instrumentation.  The function name to be matched is its user-visible
19476 name, such as @code{vector<int> blah(const vector<int> &)}, not the
19477 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
19478 match is done on substrings: if the @var{sym} parameter is a substring
19479 of the function name, it is considered to be a match.  For C99 and C++
19480 extended identifiers, the function name must be given in UTF-8, not
19481 using universal character names.
19483 @item -fstack-check
19484 @opindex fstack-check
19485 Generate code to verify that you do not go beyond the boundary of the
19486 stack.  You should specify this flag if you are running in an
19487 environment with multiple threads, but only rarely need to specify it in
19488 a single-threaded environment since stack overflow is automatically
19489 detected on nearly all systems if there is only one stack.
19491 Note that this switch does not actually cause checking to be done; the
19492 operating system or the language runtime must do that.  The switch causes
19493 generation of code to ensure that they see the stack being extended.
19495 You can additionally specify a string parameter: @code{no} means no
19496 checking, @code{generic} means force the use of old-style checking,
19497 @code{specific} means use the best checking method and is equivalent
19498 to bare @option{-fstack-check}.
19500 Old-style checking is a generic mechanism that requires no specific
19501 target support in the compiler but comes with the following drawbacks:
19503 @enumerate
19504 @item
19505 Modified allocation strategy for large objects: they will always be
19506 allocated dynamically if their size exceeds a fixed threshold.
19508 @item
19509 Fixed limit on the size of the static frame of functions: when it is
19510 topped by a particular function, stack checking is not reliable and
19511 a warning is issued by the compiler.
19513 @item
19514 Inefficiency: because of both the modified allocation strategy and the
19515 generic implementation, the performances of the code are hampered.
19516 @end enumerate
19518 Note that old-style stack checking is also the fallback method for
19519 @code{specific} if no target support has been added in the compiler.
19521 @item -fstack-limit-register=@var{reg}
19522 @itemx -fstack-limit-symbol=@var{sym}
19523 @itemx -fno-stack-limit
19524 @opindex fstack-limit-register
19525 @opindex fstack-limit-symbol
19526 @opindex fno-stack-limit
19527 Generate code to ensure that the stack does not grow beyond a certain value,
19528 either the value of a register or the address of a symbol.  If the stack
19529 would grow beyond the value, a signal is raised.  For most targets,
19530 the signal is raised before the stack overruns the boundary, so
19531 it is possible to catch the signal without taking special precautions.
19533 For instance, if the stack starts at absolute address @samp{0x80000000}
19534 and grows downwards, you can use the flags
19535 @option{-fstack-limit-symbol=__stack_limit} and
19536 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
19537 of 128KB@.  Note that this may only work with the GNU linker.
19539 @item -fsplit-stack
19540 @opindex fsplit-stack
19541 Generate code to automatically split the stack before it overflows.
19542 The resulting program has a discontiguous stack which can only
19543 overflow if the program is unable to allocate any more memory.  This
19544 is most useful when running threaded programs, as it is no longer
19545 necessary to calculate a good stack size to use for each thread.  This
19546 is currently only implemented for the i386 and x86_64 back ends running
19547 GNU/Linux.
19549 When code compiled with @option{-fsplit-stack} calls code compiled
19550 without @option{-fsplit-stack}, there may not be much stack space
19551 available for the latter code to run.  If compiling all code,
19552 including library code, with @option{-fsplit-stack} is not an option,
19553 then the linker can fix up these calls so that the code compiled
19554 without @option{-fsplit-stack} always has a large stack.  Support for
19555 this is implemented in the gold linker in GNU binutils release 2.21
19556 and later.
19558 @item -fleading-underscore
19559 @opindex fleading-underscore
19560 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
19561 change the way C symbols are represented in the object file.  One use
19562 is to help link with legacy assembly code.
19564 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
19565 generate code that is not binary compatible with code generated without that
19566 switch.  Use it to conform to a non-default application binary interface.
19567 Not all targets provide complete support for this switch.
19569 @item -ftls-model=@var{model}
19570 @opindex ftls-model
19571 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
19572 The @var{model} argument should be one of @code{global-dynamic},
19573 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
19575 The default without @option{-fpic} is @code{initial-exec}; with
19576 @option{-fpic} the default is @code{global-dynamic}.
19578 @item -fvisibility=@var{default|internal|hidden|protected}
19579 @opindex fvisibility
19580 Set the default ELF image symbol visibility to the specified option---all
19581 symbols will be marked with this unless overridden within the code.
19582 Using this feature can very substantially improve linking and
19583 load times of shared object libraries, produce more optimized
19584 code, provide near-perfect API export and prevent symbol clashes.
19585 It is @strong{strongly} recommended that you use this in any shared objects
19586 you distribute.
19588 Despite the nomenclature, @code{default} always means public; i.e.,
19589 available to be linked against from outside the shared object.
19590 @code{protected} and @code{internal} are pretty useless in real-world
19591 usage so the only other commonly used option will be @code{hidden}.
19592 The default if @option{-fvisibility} isn't specified is
19593 @code{default}, i.e., make every
19594 symbol public---this causes the same behavior as previous versions of
19595 GCC@.
19597 A good explanation of the benefits offered by ensuring ELF
19598 symbols have the correct visibility is given by ``How To Write
19599 Shared Libraries'' by Ulrich Drepper (which can be found at
19600 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
19601 solution made possible by this option to marking things hidden when
19602 the default is public is to make the default hidden and mark things
19603 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
19604 and @code{__attribute__ ((visibility("default")))} instead of
19605 @code{__declspec(dllexport)} you get almost identical semantics with
19606 identical syntax.  This is a great boon to those working with
19607 cross-platform projects.
19609 For those adding visibility support to existing code, you may find
19610 @samp{#pragma GCC visibility} of use.  This works by you enclosing
19611 the declarations you wish to set visibility for with (for example)
19612 @samp{#pragma GCC visibility push(hidden)} and
19613 @samp{#pragma GCC visibility pop}.
19614 Bear in mind that symbol visibility should be viewed @strong{as
19615 part of the API interface contract} and thus all new code should
19616 always specify visibility when it is not the default; i.e., declarations
19617 only for use within the local DSO should @strong{always} be marked explicitly
19618 as hidden as so to avoid PLT indirection overheads---making this
19619 abundantly clear also aids readability and self-documentation of the code.
19620 Note that due to ISO C++ specification requirements, operator new and
19621 operator delete must always be of default visibility.
19623 Be aware that headers from outside your project, in particular system
19624 headers and headers from any other library you use, may not be
19625 expecting to be compiled with visibility other than the default.  You
19626 may need to explicitly say @samp{#pragma GCC visibility push(default)}
19627 before including any such headers.
19629 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
19630 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
19631 no modifications.  However, this means that calls to @samp{extern}
19632 functions with no explicit visibility will use the PLT, so it is more
19633 effective to use @samp{__attribute ((visibility))} and/or
19634 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
19635 declarations should be treated as hidden.
19637 Note that @samp{-fvisibility} does affect C++ vague linkage
19638 entities. This means that, for instance, an exception class that will
19639 be thrown between DSOs must be explicitly marked with default
19640 visibility so that the @samp{type_info} nodes will be unified between
19641 the DSOs.
19643 An overview of these techniques, their benefits and how to use them
19644 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
19646 @item -fstrict-volatile-bitfields
19647 @opindex fstrict-volatile-bitfields
19648 This option should be used if accesses to volatile bit-fields (or other
19649 structure fields, although the compiler usually honors those types
19650 anyway) should use a single access of the width of the
19651 field's type, aligned to a natural alignment if possible.  For
19652 example, targets with memory-mapped peripheral registers might require
19653 all such accesses to be 16 bits wide; with this flag the user could
19654 declare all peripheral bit-fields as ``unsigned short'' (assuming short
19655 is 16 bits on these targets) to force GCC to use 16-bit accesses
19656 instead of, perhaps, a more efficient 32-bit access.
19658 If this option is disabled, the compiler will use the most efficient
19659 instruction.  In the previous example, that might be a 32-bit load
19660 instruction, even though that will access bytes that do not contain
19661 any portion of the bit-field, or memory-mapped registers unrelated to
19662 the one being updated.
19664 If the target requires strict alignment, and honoring the field
19665 type would require violating this alignment, a warning is issued.
19666 If the field has @code{packed} attribute, the access is done without
19667 honoring the field type.  If the field doesn't have @code{packed}
19668 attribute, the access is done honoring the field type.  In both cases,
19669 GCC assumes that the user knows something about the target hardware
19670 that it is unaware of.
19672 The default value of this option is determined by the application binary
19673 interface for the target processor.
19675 @end table
19677 @c man end
19679 @node Environment Variables
19680 @section Environment Variables Affecting GCC
19681 @cindex environment variables
19683 @c man begin ENVIRONMENT
19684 This section describes several environment variables that affect how GCC
19685 operates.  Some of them work by specifying directories or prefixes to use
19686 when searching for various kinds of files.  Some are used to specify other
19687 aspects of the compilation environment.
19689 Note that you can also specify places to search using options such as
19690 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
19691 take precedence over places specified using environment variables, which
19692 in turn take precedence over those specified by the configuration of GCC@.
19693 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
19694 GNU Compiler Collection (GCC) Internals}.
19696 @table @env
19697 @item LANG
19698 @itemx LC_CTYPE
19699 @c @itemx LC_COLLATE
19700 @itemx LC_MESSAGES
19701 @c @itemx LC_MONETARY
19702 @c @itemx LC_NUMERIC
19703 @c @itemx LC_TIME
19704 @itemx LC_ALL
19705 @findex LANG
19706 @findex LC_CTYPE
19707 @c @findex LC_COLLATE
19708 @findex LC_MESSAGES
19709 @c @findex LC_MONETARY
19710 @c @findex LC_NUMERIC
19711 @c @findex LC_TIME
19712 @findex LC_ALL
19713 @cindex locale
19714 These environment variables control the way that GCC uses
19715 localization information which allows GCC to work with different
19716 national conventions.  GCC inspects the locale categories
19717 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
19718 so.  These locale categories can be set to any value supported by your
19719 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
19720 Kingdom encoded in UTF-8.
19722 The @env{LC_CTYPE} environment variable specifies character
19723 classification.  GCC uses it to determine the character boundaries in
19724 a string; this is needed for some multibyte encodings that contain quote
19725 and escape characters that would otherwise be interpreted as a string
19726 end or escape.
19728 The @env{LC_MESSAGES} environment variable specifies the language to
19729 use in diagnostic messages.
19731 If the @env{LC_ALL} environment variable is set, it overrides the value
19732 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
19733 and @env{LC_MESSAGES} default to the value of the @env{LANG}
19734 environment variable.  If none of these variables are set, GCC
19735 defaults to traditional C English behavior.
19737 @item TMPDIR
19738 @findex TMPDIR
19739 If @env{TMPDIR} is set, it specifies the directory to use for temporary
19740 files.  GCC uses temporary files to hold the output of one stage of
19741 compilation which is to be used as input to the next stage: for example,
19742 the output of the preprocessor, which is the input to the compiler
19743 proper.
19745 @item GCC_COMPARE_DEBUG
19746 @findex GCC_COMPARE_DEBUG
19747 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
19748 @option{-fcompare-debug} to the compiler driver.  See the documentation
19749 of this option for more details.
19751 @item GCC_EXEC_PREFIX
19752 @findex GCC_EXEC_PREFIX
19753 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
19754 names of the subprograms executed by the compiler.  No slash is added
19755 when this prefix is combined with the name of a subprogram, but you can
19756 specify a prefix that ends with a slash if you wish.
19758 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
19759 an appropriate prefix to use based on the pathname it was invoked with.
19761 If GCC cannot find the subprogram using the specified prefix, it
19762 tries looking in the usual places for the subprogram.
19764 The default value of @env{GCC_EXEC_PREFIX} is
19765 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
19766 the installed compiler. In many cases @var{prefix} is the value
19767 of @code{prefix} when you ran the @file{configure} script.
19769 Other prefixes specified with @option{-B} take precedence over this prefix.
19771 This prefix is also used for finding files such as @file{crt0.o} that are
19772 used for linking.
19774 In addition, the prefix is used in an unusual way in finding the
19775 directories to search for header files.  For each of the standard
19776 directories whose name normally begins with @samp{/usr/local/lib/gcc}
19777 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
19778 replacing that beginning with the specified prefix to produce an
19779 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
19780 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
19781 These alternate directories are searched first; the standard directories
19782 come next. If a standard directory begins with the configured
19783 @var{prefix} then the value of @var{prefix} is replaced by
19784 @env{GCC_EXEC_PREFIX} when looking for header files.
19786 @item COMPILER_PATH
19787 @findex COMPILER_PATH
19788 The value of @env{COMPILER_PATH} is a colon-separated list of
19789 directories, much like @env{PATH}.  GCC tries the directories thus
19790 specified when searching for subprograms, if it can't find the
19791 subprograms using @env{GCC_EXEC_PREFIX}.
19793 @item LIBRARY_PATH
19794 @findex LIBRARY_PATH
19795 The value of @env{LIBRARY_PATH} is a colon-separated list of
19796 directories, much like @env{PATH}.  When configured as a native compiler,
19797 GCC tries the directories thus specified when searching for special
19798 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
19799 using GCC also uses these directories when searching for ordinary
19800 libraries for the @option{-l} option (but directories specified with
19801 @option{-L} come first).
19803 @item LANG
19804 @findex LANG
19805 @cindex locale definition
19806 This variable is used to pass locale information to the compiler.  One way in
19807 which this information is used is to determine the character set to be used
19808 when character literals, string literals and comments are parsed in C and C++.
19809 When the compiler is configured to allow multibyte characters,
19810 the following values for @env{LANG} are recognized:
19812 @table @samp
19813 @item C-JIS
19814 Recognize JIS characters.
19815 @item C-SJIS
19816 Recognize SJIS characters.
19817 @item C-EUCJP
19818 Recognize EUCJP characters.
19819 @end table
19821 If @env{LANG} is not defined, or if it has some other value, then the
19822 compiler will use mblen and mbtowc as defined by the default locale to
19823 recognize and translate multibyte characters.
19824 @end table
19826 @noindent
19827 Some additional environments variables affect the behavior of the
19828 preprocessor.
19830 @include cppenv.texi
19832 @c man end
19834 @node Precompiled Headers
19835 @section Using Precompiled Headers
19836 @cindex precompiled headers
19837 @cindex speed of compilation
19839 Often large projects have many header files that are included in every
19840 source file.  The time the compiler takes to process these header files
19841 over and over again can account for nearly all of the time required to
19842 build the project.  To make builds faster, GCC allows users to
19843 `precompile' a header file; then, if builds can use the precompiled
19844 header file they will be much faster.
19846 To create a precompiled header file, simply compile it as you would any
19847 other file, if necessary using the @option{-x} option to make the driver
19848 treat it as a C or C++ header file.  You will probably want to use a
19849 tool like @command{make} to keep the precompiled header up-to-date when
19850 the headers it contains change.
19852 A precompiled header file will be searched for when @code{#include} is
19853 seen in the compilation.  As it searches for the included file
19854 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
19855 compiler looks for a precompiled header in each directory just before it
19856 looks for the include file in that directory.  The name searched for is
19857 the name specified in the @code{#include} with @samp{.gch} appended.  If
19858 the precompiled header file can't be used, it is ignored.
19860 For instance, if you have @code{#include "all.h"}, and you have
19861 @file{all.h.gch} in the same directory as @file{all.h}, then the
19862 precompiled header file will be used if possible, and the original
19863 header will be used otherwise.
19865 Alternatively, you might decide to put the precompiled header file in a
19866 directory and use @option{-I} to ensure that directory is searched
19867 before (or instead of) the directory containing the original header.
19868 Then, if you want to check that the precompiled header file is always
19869 used, you can put a file of the same name as the original header in this
19870 directory containing an @code{#error} command.
19872 This also works with @option{-include}.  So yet another way to use
19873 precompiled headers, good for projects not designed with precompiled
19874 header files in mind, is to simply take most of the header files used by
19875 a project, include them from another header file, precompile that header
19876 file, and @option{-include} the precompiled header.  If the header files
19877 have guards against multiple inclusion, they will be skipped because
19878 they've already been included (in the precompiled header).
19880 If you need to precompile the same header file for different
19881 languages, targets, or compiler options, you can instead make a
19882 @emph{directory} named like @file{all.h.gch}, and put each precompiled
19883 header in the directory, perhaps using @option{-o}.  It doesn't matter
19884 what you call the files in the directory, every precompiled header in
19885 the directory will be considered.  The first precompiled header
19886 encountered in the directory that is valid for this compilation will
19887 be used; they're searched in no particular order.
19889 There are many other possibilities, limited only by your imagination,
19890 good sense, and the constraints of your build system.
19892 A precompiled header file can be used only when these conditions apply:
19894 @itemize
19895 @item
19896 Only one precompiled header can be used in a particular compilation.
19898 @item
19899 A precompiled header can't be used once the first C token is seen.  You
19900 can have preprocessor directives before a precompiled header; you cannot
19901 include a precompiled header from inside another header.
19903 @item
19904 The precompiled header file must be produced for the same language as
19905 the current compilation.  You can't use a C precompiled header for a C++
19906 compilation.
19908 @item
19909 The precompiled header file must have been produced by the same compiler
19910 binary as the current compilation is using.
19912 @item
19913 Any macros defined before the precompiled header is included must
19914 either be defined in the same way as when the precompiled header was
19915 generated, or must not affect the precompiled header, which usually
19916 means that they don't appear in the precompiled header at all.
19918 The @option{-D} option is one way to define a macro before a
19919 precompiled header is included; using a @code{#define} can also do it.
19920 There are also some options that define macros implicitly, like
19921 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
19922 defined this way.
19924 @item If debugging information is output when using the precompiled
19925 header, using @option{-g} or similar, the same kind of debugging information
19926 must have been output when building the precompiled header.  However,
19927 a precompiled header built using @option{-g} can be used in a compilation
19928 when no debugging information is being output.
19930 @item The same @option{-m} options must generally be used when building
19931 and using the precompiled header.  @xref{Submodel Options},
19932 for any cases where this rule is relaxed.
19934 @item Each of the following options must be the same when building and using
19935 the precompiled header:
19937 @gccoptlist{-fexceptions}
19939 @item
19940 Some other command-line options starting with @option{-f},
19941 @option{-p}, or @option{-O} must be defined in the same way as when
19942 the precompiled header was generated.  At present, it's not clear
19943 which options are safe to change and which are not; the safest choice
19944 is to use exactly the same options when generating and using the
19945 precompiled header.  The following are known to be safe:
19947 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
19948 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
19949 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
19950 -pedantic-errors}
19952 @end itemize
19954 For all of these except the last, the compiler will automatically
19955 ignore the precompiled header if the conditions aren't met.  If you
19956 find an option combination that doesn't work and doesn't cause the
19957 precompiled header to be ignored, please consider filing a bug report,
19958 see @ref{Bugs}.
19960 If you do use differing options when generating and using the
19961 precompiled header, the actual behavior will be a mixture of the
19962 behavior for the options.  For instance, if you use @option{-g} to
19963 generate the precompiled header but not when using it, you may or may
19964 not get debugging information for routines in the precompiled header.