re PR middle-end/33190 (tm.texi describes some non-existing hooks)
[platform/upstream/gcc.git] / gcc / doc / invoke.texi
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.
6
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
11
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.
17
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.
25
26 (a) The FSF's Front-Cover Text is:
27
28      A GNU Manual
29
30 (b) The FSF's Back-Cover Text is:
31
32      You have freedom to copy and modify this GNU Manual, like GNU
33      software.  Copies published by the Free Software Foundation raise
34      funds for GNU development.
35 @c man end
36 @c Set file name and title for the man page.
37 @setfilename gcc
38 @settitle GNU project C and C++ compiler
39 @c man begin SYNOPSIS
40 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
41     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
42     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
43     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
44     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
45     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
46     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
47
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
67
68 @node Invoking GCC
69 @chapter GCC Command Options
70 @cindex GCC command options
71 @cindex command options
72 @cindex options, GCC command
73
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.
80
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.
85
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.
92
93 @cindex C++ compilation options
94 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
95 options for compiling C++ programs.
96
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}}.
103
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.
111
112 Many options have long names starting with @samp{-f} or with
113 @samp{-W}---for example,
114 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
115 these have both positive and negative forms; the negative form of
116 @option{-ffoo} is @option{-fno-foo}.  This manual documents
117 only one of these two forms, whichever one is not the default.
118
119 @c man end
120
121 @xref{Option Index}, for an index to GCC's options.
122
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
153
154 @c man begin OPTIONS
155
156 @node Option Summary
157 @section Option Summary
158
159 Here is a summary of all the options, grouped by type.  Explanations are
160 in the following sections.
161
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}}
170
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}
181
182 @item C++ Language Options
183 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
184 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
185 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
186 -fno-elide-constructors @gol
187 -fno-enforce-eh-specs @gol
188 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
189 -fno-implicit-templates @gol
190 -fno-implicit-inline-templates @gol
191 -fno-implement-inlines  -fms-extensions @gol
192 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
193 -fno-optional-diags  -fpermissive @gol
194 -fno-pretty-templates @gol
195 -frepo  -fno-rtti  -fstats  -ftemplate-backtrace-limit=@var{n} @gol
196 -ftemplate-depth=@var{n} @gol
197 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
198 -fno-default-inline  -fvisibility-inlines-hidden @gol
199 -fvisibility-ms-compat @gol
200 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
202 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
203 -Weffc++  -Wstrict-null-sentinel @gol
204 -Wno-non-template-friend  -Wold-style-cast @gol
205 -Woverloaded-virtual  -Wno-pmf-conversions @gol
206 -Wsign-promo}
207
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}
228
229 @item Language Independent Options
230 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
231 @gccoptlist{-fmessage-length=@var{n}  @gol
232 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
233 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
234
235 @item Warning Options
236 @xref{Warning Options,,Options to Request or Suppress Warnings}.
237 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
238 -pedantic-errors @gol
239 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
240 -Wno-attributes -Wno-builtin-macro-redefined @gol
241 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
242 -Wchar-subscripts -Wclobbered  -Wcomment @gol
243 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wno-deprecated  @gol
244 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
245 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
246 -Wno-endif-labels -Werror  -Werror=* @gol
247 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
248 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
249 -Wformat-security  -Wformat-y2k @gol
250 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
251 -Wignored-qualifiers @gol
252 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
253 -Winit-self  -Winline -Wmaybe-uninitialized @gol
254 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
255 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
256 -Wlogical-op -Wlong-long @gol
257 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
258 -Wmissing-include-dirs @gol
259 -Wno-mudflap @gol
260 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
261 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
262 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
263 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
264 -Wredundant-decls @gol
265 -Wreturn-type  -Wsequence-point  -Wshadow @gol
266 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
267 -Wstack-usage=@var{len} -Wstrict-aliasing -Wstrict-aliasing=n @gol
268 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
269 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
270 -Wmissing-format-attribute @gol
271 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
272 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
273 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
274 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
275 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
276 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
277 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
278 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
279 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
280
281 @item C and Objective-C-only Warning Options
282 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
283 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
284 -Wold-style-declaration  -Wold-style-definition @gol
285 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
286 -Wdeclaration-after-statement -Wpointer-sign}
287
288 @item Debugging Options
289 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
290 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
291 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
292 -fdisable-ipa-@var{pass_name} @gol
293 -fdisable-rtl-@var{pass_name} @gol
294 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
295 -fdisable-tree-@var{pass_name} @gol
296 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
297 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
298 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
299 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
300 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
301 -fdump-passes @gol
302 -fdump-statistics @gol
303 -fdump-tree-all @gol
304 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
305 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
306 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
307 -fdump-tree-ch @gol
308 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
309 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
310 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
313 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-nrv -fdump-tree-vect @gol
318 -fdump-tree-sink @gol
319 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
320 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
323 -ftree-vectorizer-verbose=@var{n} @gol
324 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
325 -fdump-final-insns=@var{file} @gol
326 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
327 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
328 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
329 -fenable-@var{kind}-@var{pass} @gol
330 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
331 -fdebug-types-section @gol
332 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
333 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
334 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
335 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
336 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
337 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
338 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
339 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
340 -gvms  -gxcoff  -gxcoff+ @gol
341 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
342 -fdebug-prefix-map=@var{old}=@var{new} @gol
343 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
344 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
345 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
346 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
347 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
348 -print-sysroot -print-sysroot-headers-suffix @gol
349 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
350
351 @item Optimization Options
352 @xref{Optimize Options,,Options that Control Optimization}.
353 @gccoptlist{-falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
354 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
355 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
356 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
357 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
358 -fcompare-elim -fcprop-registers -fcrossjumping @gol
359 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
360 -fcx-limited-range @gol
361 -fdata-sections -fdce -fdelayed-branch @gol
362 -fdelete-null-pointer-checks -fdevirtualize -fdse @gol
363 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
364 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
365 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
366 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
367 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
368 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
369 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg @gol
370 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
371 -fira-algorithm=@var{algorithm} @gol
372 -fira-region=@var{region} @gol
373 -fira-loop-pressure -fno-ira-share-save-slots @gol
374 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
375 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
376 -floop-block -floop-interchange -floop-strip-mine @gol
377 -floop-parallelize-all -flto -flto-compression-level @gol
378 -flto-partition=@var{alg} -flto-report -fmerge-all-constants @gol
379 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
380 -fmove-loop-invariants fmudflap -fmudflapir -fmudflapth -fno-branch-count-reg @gol
381 -fno-default-inline @gol
382 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
383 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
384 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
385 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
386 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
387 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
388 -fprefetch-loop-arrays @gol
389 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
390 -fprofile-generate=@var{path} @gol
391 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
392 -freciprocal-math -free -fregmove -frename-registers -freorder-blocks @gol
393 -freorder-blocks-and-partition -freorder-functions @gol
394 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
395 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
396 -fsched-spec-load -fsched-spec-load-dangerous @gol
397 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
398 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
399 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
400 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
401 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
402 -fselective-scheduling -fselective-scheduling2 @gol
403 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
404 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
405 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
406 -fstack-protector-all -fstrict-aliasing -fstrict-overflow @gol
407 -fthread-jumps -ftracer -ftree-bit-ccp @gol
408 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
409 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
410 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
411 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
412 -ftree-loop-if-convert-stores -ftree-loop-im @gol
413 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
414 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
415 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
416 -ftree-reassoc @gol
417 -ftree-sink -ftree-sra -ftree-switch-conversion -ftree-tail-merge @gol
418 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
419 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
420 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
421 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
422 -fwhole-program -fwpa -fuse-linker-plugin @gol
423 --param @var{name}=@var{value}
424 -O  -O0  -O1  -O2  -O3  -Os -Ofast}
425
426 @item Preprocessor Options
427 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
428 @gccoptlist{-A@var{question}=@var{answer} @gol
429 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
430 -C  -dD  -dI  -dM  -dN @gol
431 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
432 -idirafter @var{dir} @gol
433 -include @var{file}  -imacros @var{file} @gol
434 -iprefix @var{file}  -iwithprefix @var{dir} @gol
435 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
436 -imultilib @var{dir} -isysroot @var{dir} @gol
437 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
438 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
439 -remap -trigraphs  -undef  -U@var{macro}  @gol
440 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
441
442 @item Assembler Option
443 @xref{Assembler Options,,Passing Options to the Assembler}.
444 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
445
446 @item Linker Options
447 @xref{Link Options,,Options for Linking}.
448 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
449 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
450 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
451 -shared-libgcc  -symbolic @gol
452 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
453 -u @var{symbol}}
454
455 @item Directory Options
456 @xref{Directory Options,,Options for Directory Search}.
457 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
458 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
459 --sysroot=@var{dir}}
460
461 @item Machine Dependent Options
462 @xref{Submodel Options,,Hardware Models and Configurations}.
463 @c This list is ordered alphanumerically by subsection name.
464 @c Try and put the significant identifier (CPU or system) first,
465 @c so users have a clue at guessing where the ones they want will be.
466
467 @emph{Adapteva Epiphany Options}
468 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
469 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
470 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
471 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
472 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
473 -msplit-vecmove-early -m1reg-@var{reg}}
474
475 @emph{ARM Options}
476 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
477 -mabi=@var{name} @gol
478 -mapcs-stack-check  -mno-apcs-stack-check @gol
479 -mapcs-float  -mno-apcs-float @gol
480 -mapcs-reentrant  -mno-apcs-reentrant @gol
481 -msched-prolog  -mno-sched-prolog @gol
482 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
483 -mfloat-abi=@var{name} @gol
484 -mfp16-format=@var{name}
485 -mthumb-interwork  -mno-thumb-interwork @gol
486 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
487 -mstructure-size-boundary=@var{n} @gol
488 -mabort-on-noreturn @gol
489 -mlong-calls  -mno-long-calls @gol
490 -msingle-pic-base  -mno-single-pic-base @gol
491 -mpic-register=@var{reg} @gol
492 -mnop-fun-dllimport @gol
493 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
494 -mpoke-function-name @gol
495 -mthumb  -marm @gol
496 -mtpcs-frame  -mtpcs-leaf-frame @gol
497 -mcaller-super-interworking  -mcallee-super-interworking @gol
498 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
499 -mword-relocations @gol
500 -mfix-cortex-m3-ldrd}
501
502 @emph{AVR Options}
503 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
504 -mcall-prologues -mint8 -mno-interrupts -mrelax -mshort-calls @gol
505 -mstrict-X -mtiny-stack}
506
507 @emph{Blackfin Options}
508 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
509 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
510 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
511 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
512 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
513 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
514 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
515 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
516 -micplb}
517
518 @emph{C6X Options}
519 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
520 -msim -msdata=@var{sdata-type}}
521
522 @emph{CRIS Options}
523 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
524 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
525 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
526 -mstack-align  -mdata-align  -mconst-align @gol
527 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
528 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
529 -mmul-bug-workaround  -mno-mul-bug-workaround}
530
531 @emph{CR16 Options}
532 @gccoptlist{-mmac @gol
533 -mcr16cplus -mcr16c @gol
534 -msim -mint32 -mbit-ops
535 -mdata-model=@var{model}}
536
537 @emph{Darwin Options}
538 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
539 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
540 -client_name  -compatibility_version  -current_version @gol
541 -dead_strip @gol
542 -dependency-file  -dylib_file  -dylinker_install_name @gol
543 -dynamic  -dynamiclib  -exported_symbols_list @gol
544 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
545 -force_flat_namespace  -headerpad_max_install_names @gol
546 -iframework @gol
547 -image_base  -init  -install_name  -keep_private_externs @gol
548 -multi_module  -multiply_defined  -multiply_defined_unused @gol
549 -noall_load   -no_dead_strip_inits_and_terms @gol
550 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
551 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
552 -private_bundle  -read_only_relocs  -sectalign @gol
553 -sectobjectsymbols  -whyload  -seg1addr @gol
554 -sectcreate  -sectobjectsymbols  -sectorder @gol
555 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
556 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
557 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
558 -single_module  -static  -sub_library  -sub_umbrella @gol
559 -twolevel_namespace  -umbrella  -undefined @gol
560 -unexported_symbols_list  -weak_reference_mismatches @gol
561 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
562 -mkernel -mone-byte-bool}
563
564 @emph{DEC Alpha Options}
565 @gccoptlist{-mno-fp-regs  -msoft-float @gol
566 -mieee  -mieee-with-inexact  -mieee-conformant @gol
567 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
568 -mtrap-precision=@var{mode}  -mbuild-constants @gol
569 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
570 -mbwx  -mmax  -mfix  -mcix @gol
571 -mfloat-vax  -mfloat-ieee @gol
572 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
573 -msmall-text  -mlarge-text @gol
574 -mmemory-latency=@var{time}}
575
576 @emph{FR30 Options}
577 @gccoptlist{-msmall-model -mno-lsim}
578
579 @emph{FRV Options}
580 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
581 -mhard-float  -msoft-float @gol
582 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
583 -mdouble  -mno-double @gol
584 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
585 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
586 -mlinked-fp  -mlong-calls  -malign-labels @gol
587 -mlibrary-pic  -macc-4  -macc-8 @gol
588 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
589 -moptimize-membar -mno-optimize-membar @gol
590 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
591 -mvliw-branch  -mno-vliw-branch @gol
592 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
593 -mno-nested-cond-exec  -mtomcat-stats @gol
594 -mTLS -mtls @gol
595 -mcpu=@var{cpu}}
596
597 @emph{GNU/Linux Options}
598 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
599 -tno-android-cc -tno-android-ld}
600
601 @emph{H8/300 Options}
602 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
603
604 @emph{HPPA Options}
605 @gccoptlist{-march=@var{architecture-type} @gol
606 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
607 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
608 -mfixed-range=@var{register-range} @gol
609 -mjump-in-delay -mlinker-opt -mlong-calls @gol
610 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
611 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
612 -mno-jump-in-delay  -mno-long-load-store @gol
613 -mno-portable-runtime  -mno-soft-float @gol
614 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
615 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
616 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
617 -munix=@var{unix-std}  -nolibdld  -static  -threads}
618
619 @emph{i386 and x86-64 Options}
620 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
621 -mfpmath=@var{unit} @gol
622 -masm=@var{dialect}  -mno-fancy-math-387 @gol
623 -mno-fp-ret-in-387  -msoft-float @gol
624 -mno-wide-multiply  -mrtd  -malign-double @gol
625 -mpreferred-stack-boundary=@var{num} @gol
626 -mincoming-stack-boundary=@var{num} @gol
627 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
628 -mrecip -mrecip=@var{opt} @gol
629 -mvzeroupper @gol
630 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
631 -mavx2 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
632 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
633 -mbmi2 -mrtm -mlwp -mthreads @gol
634 -mno-align-stringops  -minline-all-stringops @gol
635 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
636 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
637 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
638 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
639 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
640 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
641 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
642 -m32 -m64 -mx32 -mlarge-data-threshold=@var{num} @gol
643 -msse2avx -mfentry -m8bit-idiv @gol
644 -mavx256-split-unaligned-load -mavx256-split-unaligned-store}
645
646 @emph{i386 and x86-64 Windows Options}
647 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
648 -mnop-fun-dllimport -mthread @gol
649 -municode -mwin32 -mwindows -fno-set-stack-executable}
650
651 @emph{IA-64 Options}
652 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
653 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
654 -mconstant-gp  -mauto-pic  -mfused-madd @gol
655 -minline-float-divide-min-latency @gol
656 -minline-float-divide-max-throughput @gol
657 -mno-inline-float-divide @gol
658 -minline-int-divide-min-latency @gol
659 -minline-int-divide-max-throughput  @gol
660 -mno-inline-int-divide @gol
661 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
662 -mno-inline-sqrt @gol
663 -mdwarf2-asm -mearly-stop-bits @gol
664 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
665 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
666 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
667 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
668 -msched-spec-ldc -msched-spec-control-ldc @gol
669 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
670 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
671 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
672 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
673
674 @emph{LM32 Options}
675 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
676 -msign-extend-enabled -muser-enabled}
677
678 @emph{M32R/D Options}
679 @gccoptlist{-m32r2 -m32rx -m32r @gol
680 -mdebug @gol
681 -malign-loops -mno-align-loops @gol
682 -missue-rate=@var{number} @gol
683 -mbranch-cost=@var{number} @gol
684 -mmodel=@var{code-size-model-type} @gol
685 -msdata=@var{sdata-type} @gol
686 -mno-flush-func -mflush-func=@var{name} @gol
687 -mno-flush-trap -mflush-trap=@var{number} @gol
688 -G @var{num}}
689
690 @emph{M32C Options}
691 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
692
693 @emph{M680x0 Options}
694 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
695 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
696 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
697 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
698 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
699 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
700 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
701 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
702 -mxgot -mno-xgot}
703
704 @emph{MCore Options}
705 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
706 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
707 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
708 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
709 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
710
711 @emph{MeP Options}
712 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
713 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
714 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
715 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
716 -mtiny=@var{n}}
717
718 @emph{MicroBlaze Options}
719 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
720 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
721 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
722 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
723 -mxl-mode-@var{app-model}}
724
725 @emph{MIPS Options}
726 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
727 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
728 -mips64  -mips64r2 @gol
729 -mips16  -mno-mips16  -mflip-mips16 @gol
730 -minterlink-mips16  -mno-interlink-mips16 @gol
731 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
732 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
733 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
734 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
735 -mfpu=@var{fpu-type} @gol
736 -msmartmips  -mno-smartmips @gol
737 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
738 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
739 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
740 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
741 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
742 -membedded-data  -mno-embedded-data @gol
743 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
744 -mcode-readable=@var{setting} @gol
745 -msplit-addresses  -mno-split-addresses @gol
746 -mexplicit-relocs  -mno-explicit-relocs @gol
747 -mcheck-zero-division  -mno-check-zero-division @gol
748 -mdivide-traps  -mdivide-breaks @gol
749 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
750 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
751 -mfix-24k -mno-fix-24k @gol
752 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
753 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
754 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
755 -mflush-func=@var{func}  -mno-flush-func @gol
756 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
757 -mfp-exceptions -mno-fp-exceptions @gol
758 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
759 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
760
761 @emph{MMIX Options}
762 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
763 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
764 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
765 -mno-base-addresses  -msingle-exit  -mno-single-exit}
766
767 @emph{MN10300 Options}
768 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
769 -mno-am33 -mam33 -mam33-2 -mam34 @gol
770 -mtune=@var{cpu-type} @gol
771 -mreturn-pointer-on-d0 @gol
772 -mno-crt0  -mrelax -mliw -msetlb}
773
774 @emph{PDP-11 Options}
775 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
776 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
777 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
778 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
779 -mbranch-expensive  -mbranch-cheap @gol
780 -munix-asm  -mdec-asm}
781
782 @emph{picoChip Options}
783 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
784 -msymbol-as-address -mno-inefficient-warnings}
785
786 @emph{PowerPC Options}
787 See RS/6000 and PowerPC Options.
788
789 @emph{RL78 Options}
790 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
791
792 @emph{RS/6000 and PowerPC Options}
793 @gccoptlist{-mcpu=@var{cpu-type} @gol
794 -mtune=@var{cpu-type} @gol
795 -mcmodel=@var{code-model} @gol
796 -mpower  -mno-power  -mpower2  -mno-power2 @gol
797 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
798 -maltivec  -mno-altivec @gol
799 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
800 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
801 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
802 -mfprnd  -mno-fprnd @gol
803 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
804 -mnew-mnemonics  -mold-mnemonics @gol
805 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
806 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
807 -malign-power  -malign-natural @gol
808 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
809 -msingle-float -mdouble-float -msimple-fpu @gol
810 -mstring  -mno-string  -mupdate  -mno-update @gol
811 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
812 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
813 -mstrict-align  -mno-strict-align  -mrelocatable @gol
814 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
815 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
816 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
817 -mprioritize-restricted-insns=@var{priority} @gol
818 -msched-costly-dep=@var{dependence_type} @gol
819 -minsert-sched-nops=@var{scheme} @gol
820 -mcall-sysv  -mcall-netbsd @gol
821 -maix-struct-return  -msvr4-struct-return @gol
822 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
823 -mblock-move-inline-limit=@var{num} @gol
824 -misel -mno-isel @gol
825 -misel=yes  -misel=no @gol
826 -mspe -mno-spe @gol
827 -mspe=yes  -mspe=no @gol
828 -mpaired @gol
829 -mgen-cell-microcode -mwarn-cell-microcode @gol
830 -mvrsave -mno-vrsave @gol
831 -mmulhw -mno-mulhw @gol
832 -mdlmzb -mno-dlmzb @gol
833 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
834 -mprototype  -mno-prototype @gol
835 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
836 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
837 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
838 -mno-recip-precision @gol
839 -mveclibabi=@var{type} -mfriz -mno-friz @gol
840 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
841 -msave-toc-indirect -mno-save-toc-indirect}
842
843 @emph{RX Options}
844 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
845 -mcpu=@gol
846 -mbig-endian-data -mlittle-endian-data @gol
847 -msmall-data @gol
848 -msim  -mno-sim@gol
849 -mas100-syntax -mno-as100-syntax@gol
850 -mrelax@gol
851 -mmax-constant-size=@gol
852 -mint-register=@gol
853 -mpid@gol
854 -msave-acc-in-interrupts}
855
856 @emph{S/390 and zSeries Options}
857 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
858 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
859 -mlong-double-64 -mlong-double-128 @gol
860 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
861 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
862 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
863 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
864 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
865
866 @emph{Score Options}
867 @gccoptlist{-meb -mel @gol
868 -mnhwloop @gol
869 -muls @gol
870 -mmac @gol
871 -mscore5 -mscore5u -mscore7 -mscore7d}
872
873 @emph{SH Options}
874 @gccoptlist{-m1  -m2  -m2e @gol
875 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
876 -m3  -m3e @gol
877 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
878 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
879 -m5-64media  -m5-64media-nofpu @gol
880 -m5-32media  -m5-32media-nofpu @gol
881 -m5-compact  -m5-compact-nofpu @gol
882 -mb  -ml  -mdalign  -mrelax @gol
883 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
884 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
885 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
886 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
887 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
888 -maccumulate-outgoing-args -minvalid-symbols -msoft-atomic -mhard-atomic @gol
889 -mbranch-cost=@var{num} -mcbranchdi -mcmpeqdi -mfused-madd -mno-fused-madd @gol
890 -mfsca -mno-fsca -mfsrra -mno-fsrra -mpretend-cmove -menable-tas}
891
892 @emph{Solaris 2 Options}
893 @gccoptlist{-mimpure-text  -mno-impure-text @gol
894 -pthreads -pthread}
895
896 @emph{SPARC Options}
897 @gccoptlist{-mcpu=@var{cpu-type} @gol
898 -mtune=@var{cpu-type} @gol
899 -mcmodel=@var{code-model} @gol
900 -mmemory-model=@var{mem-model} @gol
901 -m32  -m64  -mapp-regs  -mno-app-regs @gol
902 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
903 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
904 -mhard-quad-float  -msoft-quad-float @gol
905 -mlittle-endian @gol
906 -mstack-bias  -mno-stack-bias @gol
907 -munaligned-doubles  -mno-unaligned-doubles @gol
908 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
909 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
910 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
911 -mfix-at697f}
912
913 @emph{SPU Options}
914 @gccoptlist{-mwarn-reloc -merror-reloc @gol
915 -msafe-dma -munsafe-dma @gol
916 -mbranch-hints @gol
917 -msmall-mem -mlarge-mem -mstdmain @gol
918 -mfixed-range=@var{register-range} @gol
919 -mea32 -mea64 @gol
920 -maddress-space-conversion -mno-address-space-conversion @gol
921 -mcache-size=@var{cache-size} @gol
922 -matomic-updates -mno-atomic-updates}
923
924 @emph{System V Options}
925 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
926
927 @emph{TILE-Gx Options}
928 @gccoptlist{-mcpu=CPU -m32 -m64}
929
930 @emph{TILEPro Options}
931 @gccoptlist{-mcpu=CPU -m32}
932
933 @emph{V850 Options}
934 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
935 -mprolog-function  -mno-prolog-function  -mspace @gol
936 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
937 -mapp-regs  -mno-app-regs @gol
938 -mdisable-callt  -mno-disable-callt @gol
939 -mv850e2v3 @gol
940 -mv850e2 @gol
941 -mv850e1 -mv850es @gol
942 -mv850e @gol
943 -mv850  -mbig-switch}
944
945 @emph{VAX Options}
946 @gccoptlist{-mg  -mgnu  -munix}
947
948 @emph{VMS Options}
949 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
950 -mpointer-size=@var{size}}
951
952 @emph{VxWorks Options}
953 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
954 -Xbind-lazy  -Xbind-now}
955
956 @emph{x86-64 Options}
957 See i386 and x86-64 Options.
958
959 @emph{Xstormy16 Options}
960 @gccoptlist{-msim}
961
962 @emph{Xtensa Options}
963 @gccoptlist{-mconst16 -mno-const16 @gol
964 -mfused-madd  -mno-fused-madd @gol
965 -mforce-no-pic @gol
966 -mserialize-volatile  -mno-serialize-volatile @gol
967 -mtext-section-literals  -mno-text-section-literals @gol
968 -mtarget-align  -mno-target-align @gol
969 -mlongcalls  -mno-longcalls}
970
971 @emph{zSeries Options}
972 See S/390 and zSeries Options.
973
974 @item Code Generation Options
975 @xref{Code Gen Options,,Options for Code Generation Conventions}.
976 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
977 -ffixed-@var{reg}  -fexceptions @gol
978 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
979 -fasynchronous-unwind-tables @gol
980 -finhibit-size-directive  -finstrument-functions @gol
981 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
982 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
983 -fno-common  -fno-ident @gol
984 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
985 -fno-jump-tables @gol
986 -frecord-gcc-switches @gol
987 -freg-struct-return  -fshort-enums @gol
988 -fshort-double  -fshort-wchar @gol
989 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
990 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
991 -fno-stack-limit -fsplit-stack @gol
992 -fleading-underscore  -ftls-model=@var{model} @gol
993 -ftrapv  -fwrapv  -fbounds-check @gol
994 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
995 @end table
996
997 @menu
998 * Overall Options::     Controlling the kind of output:
999                         an executable, object files, assembler files,
1000                         or preprocessed source.
1001 * C Dialect Options::   Controlling the variant of C language compiled.
1002 * C++ Dialect Options:: Variations on C++.
1003 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
1004                         and Objective-C++.
1005 * Language Independent Options:: Controlling how diagnostics should be
1006                         formatted.
1007 * Warning Options::     How picky should the compiler be?
1008 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
1009 * Optimize Options::    How much optimization?
1010 * Preprocessor Options:: Controlling header files and macro definitions.
1011                          Also, getting dependency information for Make.
1012 * Assembler Options::   Passing options to the assembler.
1013 * Link Options::        Specifying libraries and so on.
1014 * Directory Options::   Where to find header files and libraries.
1015                         Where to find the compiler executable files.
1016 * Spec Files::          How to pass switches to sub-processes.
1017 * Target Options::      Running a cross-compiler, or an old version of GCC.
1018 @end menu
1019
1020 @node Overall Options
1021 @section Options Controlling the Kind of Output
1022
1023 Compilation can involve up to four stages: preprocessing, compilation
1024 proper, assembly and linking, always in that order.  GCC is capable of
1025 preprocessing and compiling several files either into several
1026 assembler input files, or into one assembler input file; then each
1027 assembler input file produces an object file, and linking combines all
1028 the object files (those newly compiled, and those specified as input)
1029 into an executable file.
1030
1031 @cindex file name suffix
1032 For any given input file, the file name suffix determines what kind of
1033 compilation is done:
1034
1035 @table @gcctabopt
1036 @item @var{file}.c
1037 C source code that must be preprocessed.
1038
1039 @item @var{file}.i
1040 C source code that should not be preprocessed.
1041
1042 @item @var{file}.ii
1043 C++ source code that should not be preprocessed.
1044
1045 @item @var{file}.m
1046 Objective-C source code.  Note that you must link with the @file{libobjc}
1047 library to make an Objective-C program work.
1048
1049 @item @var{file}.mi
1050 Objective-C source code that should not be preprocessed.
1051
1052 @item @var{file}.mm
1053 @itemx @var{file}.M
1054 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1055 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1056 to a literal capital M@.
1057
1058 @item @var{file}.mii
1059 Objective-C++ source code that should not be preprocessed.
1060
1061 @item @var{file}.h
1062 C, C++, Objective-C or Objective-C++ header file to be turned into a
1063 precompiled header (default), or C, C++ header file to be turned into an
1064 Ada spec (via the @option{-fdump-ada-spec} switch).
1065
1066 @item @var{file}.cc
1067 @itemx @var{file}.cp
1068 @itemx @var{file}.cxx
1069 @itemx @var{file}.cpp
1070 @itemx @var{file}.CPP
1071 @itemx @var{file}.c++
1072 @itemx @var{file}.C
1073 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1074 the last two letters must both be literally @samp{x}.  Likewise,
1075 @samp{.C} refers to a literal capital C@.
1076
1077 @item @var{file}.mm
1078 @itemx @var{file}.M
1079 Objective-C++ source code that must be preprocessed.
1080
1081 @item @var{file}.mii
1082 Objective-C++ source code that should not be preprocessed.
1083
1084 @item @var{file}.hh
1085 @itemx @var{file}.H
1086 @itemx @var{file}.hp
1087 @itemx @var{file}.hxx
1088 @itemx @var{file}.hpp
1089 @itemx @var{file}.HPP
1090 @itemx @var{file}.h++
1091 @itemx @var{file}.tcc
1092 C++ header file to be turned into a precompiled header or Ada spec.
1093
1094 @item @var{file}.f
1095 @itemx @var{file}.for
1096 @itemx @var{file}.ftn
1097 Fixed form Fortran source code that should not be preprocessed.
1098
1099 @item @var{file}.F
1100 @itemx @var{file}.FOR
1101 @itemx @var{file}.fpp
1102 @itemx @var{file}.FPP
1103 @itemx @var{file}.FTN
1104 Fixed form Fortran source code that must be preprocessed (with the traditional
1105 preprocessor).
1106
1107 @item @var{file}.f90
1108 @itemx @var{file}.f95
1109 @itemx @var{file}.f03
1110 @itemx @var{file}.f08
1111 Free form Fortran source code that should not be preprocessed.
1112
1113 @item @var{file}.F90
1114 @itemx @var{file}.F95
1115 @itemx @var{file}.F03
1116 @itemx @var{file}.F08
1117 Free form Fortran source code that must be preprocessed (with the
1118 traditional preprocessor).
1119
1120 @item @var{file}.go
1121 Go source code.
1122
1123 @c FIXME: Descriptions of Java file types.
1124 @c @var{file}.java
1125 @c @var{file}.class
1126 @c @var{file}.zip
1127 @c @var{file}.jar
1128
1129 @item @var{file}.ads
1130 Ada source code file that contains a library unit declaration (a
1131 declaration of a package, subprogram, or generic, or a generic
1132 instantiation), or a library unit renaming declaration (a package,
1133 generic, or subprogram renaming declaration).  Such files are also
1134 called @dfn{specs}.
1135
1136 @item @var{file}.adb
1137 Ada source code file containing a library unit body (a subprogram or
1138 package body).  Such files are also called @dfn{bodies}.
1139
1140 @c GCC also knows about some suffixes for languages not yet included:
1141 @c Pascal:
1142 @c @var{file}.p
1143 @c @var{file}.pas
1144 @c Ratfor:
1145 @c @var{file}.r
1146
1147 @item @var{file}.s
1148 Assembler code.
1149
1150 @item @var{file}.S
1151 @itemx @var{file}.sx
1152 Assembler code that must be preprocessed.
1153
1154 @item @var{other}
1155 An object file to be fed straight into linking.
1156 Any file name with no recognized suffix is treated this way.
1157 @end table
1158
1159 @opindex x
1160 You can specify the input language explicitly with the @option{-x} option:
1161
1162 @table @gcctabopt
1163 @item -x @var{language}
1164 Specify explicitly the @var{language} for the following input files
1165 (rather than letting the compiler choose a default based on the file
1166 name suffix).  This option applies to all following input files until
1167 the next @option{-x} option.  Possible values for @var{language} are:
1168 @smallexample
1169 c  c-header  cpp-output
1170 c++  c++-header  c++-cpp-output
1171 objective-c  objective-c-header  objective-c-cpp-output
1172 objective-c++ objective-c++-header objective-c++-cpp-output
1173 assembler  assembler-with-cpp
1174 ada
1175 f77  f77-cpp-input f95  f95-cpp-input
1176 go
1177 java
1178 @end smallexample
1179
1180 @item -x none
1181 Turn off any specification of a language, so that subsequent files are
1182 handled according to their file name suffixes (as they are if @option{-x}
1183 has not been used at all).
1184
1185 @item -pass-exit-codes
1186 @opindex pass-exit-codes
1187 Normally the @command{gcc} program exits with the code of 1 if any
1188 phase of the compiler returns a non-success return code.  If you specify
1189 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1190 the numerically highest error produced by any phase returning an error
1191 indication.  The C, C++, and Fortran front ends return 4 if an internal
1192 compiler error is encountered.
1193 @end table
1194
1195 If you only want some of the stages of compilation, you can use
1196 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1197 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1198 @command{gcc} is to stop.  Note that some combinations (for example,
1199 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1200
1201 @table @gcctabopt
1202 @item -c
1203 @opindex c
1204 Compile or assemble the source files, but do not link.  The linking
1205 stage simply is not done.  The ultimate output is in the form of an
1206 object file for each source file.
1207
1208 By default, the object file name for a source file is made by replacing
1209 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1210
1211 Unrecognized input files, not requiring compilation or assembly, are
1212 ignored.
1213
1214 @item -S
1215 @opindex S
1216 Stop after the stage of compilation proper; do not assemble.  The output
1217 is in the form of an assembler code file for each non-assembler input
1218 file specified.
1219
1220 By default, the assembler file name for a source file is made by
1221 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1222
1223 Input files that don't require compilation are ignored.
1224
1225 @item -E
1226 @opindex E
1227 Stop after the preprocessing stage; do not run the compiler proper.  The
1228 output is in the form of preprocessed source code, which is sent to the
1229 standard output.
1230
1231 Input files that don't require preprocessing are ignored.
1232
1233 @cindex output file option
1234 @item -o @var{file}
1235 @opindex o
1236 Place output in file @var{file}.  This applies regardless to whatever
1237 sort of output is being produced, whether it be an executable file,
1238 an object file, an assembler file or preprocessed C code.
1239
1240 If @option{-o} is not specified, the default is to put an executable
1241 file in @file{a.out}, the object file for
1242 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1243 assembler file in @file{@var{source}.s}, a precompiled header file in
1244 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1245 standard output.
1246
1247 @item -v
1248 @opindex v
1249 Print (on standard error output) the commands executed to run the stages
1250 of compilation.  Also print the version number of the compiler driver
1251 program and of the preprocessor and the compiler proper.
1252
1253 @item -###
1254 @opindex ###
1255 Like @option{-v} except the commands are not executed and arguments
1256 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1257 This is useful for shell scripts to capture the driver-generated command lines.
1258
1259 @item -pipe
1260 @opindex pipe
1261 Use pipes rather than temporary files for communication between the
1262 various stages of compilation.  This fails to work on some systems where
1263 the assembler is unable to read from a pipe; but the GNU assembler has
1264 no trouble.
1265
1266 @item --help
1267 @opindex help
1268 Print (on the standard output) a description of the command-line options
1269 understood by @command{gcc}.  If the @option{-v} option is also specified
1270 then @option{--help} is also passed on to the various processes
1271 invoked by @command{gcc}, so that they can display the command-line options
1272 they accept.  If the @option{-Wextra} option has also been specified
1273 (prior to the @option{--help} option), then command-line options that
1274 have no documentation associated with them are also displayed.
1275
1276 @item --target-help
1277 @opindex target-help
1278 Print (on the standard output) a description of target-specific command-line
1279 options for each tool.  For some targets extra target-specific
1280 information may also be printed.
1281
1282 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1283 Print (on the standard output) a description of the command-line
1284 options understood by the compiler that fit into all specified classes
1285 and qualifiers.  These are the supported classes:
1286
1287 @table @asis
1288 @item @samp{optimizers}
1289 Display all of the optimization options supported by the
1290 compiler.
1291
1292 @item @samp{warnings}
1293 Display all of the options controlling warning messages
1294 produced by the compiler.
1295
1296 @item @samp{target}
1297 Display target-specific options.  Unlike the
1298 @option{--target-help} option however, target-specific options of the
1299 linker and assembler are not displayed.  This is because those
1300 tools do not currently support the extended @option{--help=} syntax.
1301
1302 @item @samp{params}
1303 Display the values recognized by the @option{--param}
1304 option.
1305
1306 @item @var{language}
1307 Display the options supported for @var{language}, where
1308 @var{language} is the name of one of the languages supported in this
1309 version of GCC@.
1310
1311 @item @samp{common}
1312 Display the options that are common to all languages.
1313 @end table
1314
1315 These are the supported qualifiers:
1316
1317 @table @asis
1318 @item @samp{undocumented}
1319 Display only those options that are undocumented.
1320
1321 @item @samp{joined}
1322 Display options taking an argument that appears after an equal
1323 sign in the same continuous piece of text, such as:
1324 @samp{--help=target}.
1325
1326 @item @samp{separate}
1327 Display options taking an argument that appears as a separate word
1328 following the original option, such as: @samp{-o output-file}.
1329 @end table
1330
1331 Thus for example to display all the undocumented target-specific
1332 switches supported by the compiler the following can be used:
1333
1334 @smallexample
1335 --help=target,undocumented
1336 @end smallexample
1337
1338 The sense of a qualifier can be inverted by prefixing it with the
1339 @samp{^} character, so for example to display all binary warning
1340 options (i.e., ones that are either on or off and that do not take an
1341 argument) that have a description, use:
1342
1343 @smallexample
1344 --help=warnings,^joined,^undocumented
1345 @end smallexample
1346
1347 The argument to @option{--help=} should not consist solely of inverted
1348 qualifiers.
1349
1350 Combining several classes is possible, although this usually
1351 restricts the output by so much that there is nothing to display.  One
1352 case where it does work however is when one of the classes is
1353 @var{target}.  So for example to display all the target-specific
1354 optimization options the following can be used:
1355
1356 @smallexample
1357 --help=target,optimizers
1358 @end smallexample
1359
1360 The @option{--help=} option can be repeated on the command line.  Each
1361 successive use displays its requested class of options, skipping
1362 those that have already been displayed.
1363
1364 If the @option{-Q} option appears on the command line before the
1365 @option{--help=} option, then the descriptive text displayed by
1366 @option{--help=} is changed.  Instead of describing the displayed
1367 options, an indication is given as to whether the option is enabled,
1368 disabled or set to a specific value (assuming that the compiler
1369 knows this at the point where the @option{--help=} option is used).
1370
1371 Here is a truncated example from the ARM port of @command{gcc}:
1372
1373 @smallexample
1374   % gcc -Q -mabi=2 --help=target -c
1375   The following options are target specific:
1376   -mabi=                                2
1377   -mabort-on-noreturn                   [disabled]
1378   -mapcs                                [disabled]
1379 @end smallexample
1380
1381 The output is sensitive to the effects of previous command-line
1382 options, so for example it is possible to find out which optimizations
1383 are enabled at @option{-O2} by using:
1384
1385 @smallexample
1386 -Q -O2 --help=optimizers
1387 @end smallexample
1388
1389 Alternatively you can discover which binary optimizations are enabled
1390 by @option{-O3} by using:
1391
1392 @smallexample
1393 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1394 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1395 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1396 @end smallexample
1397
1398 @item -no-canonical-prefixes
1399 @opindex no-canonical-prefixes
1400 Do not expand any symbolic links, resolve references to @samp{/../}
1401 or @samp{/./}, or make the path absolute when generating a relative
1402 prefix.
1403
1404 @item --version
1405 @opindex version
1406 Display the version number and copyrights of the invoked GCC@.
1407
1408 @item -wrapper
1409 @opindex wrapper
1410 Invoke all subcommands under a wrapper program.  The name of the
1411 wrapper program and its parameters are passed as a comma separated
1412 list.
1413
1414 @smallexample
1415 gcc -c t.c -wrapper gdb,--args
1416 @end smallexample
1417
1418 @noindent
1419 This invokes all subprograms of @command{gcc} under
1420 @samp{gdb --args}, thus the invocation of @command{cc1} is
1421 @samp{gdb --args cc1 @dots{}}.
1422
1423 @item -fplugin=@var{name}.so
1424 Load the plugin code in file @var{name}.so, assumed to be a
1425 shared object to be dlopen'd by the compiler.  The base name of
1426 the shared object file is used to identify the plugin for the
1427 purposes of argument parsing (See
1428 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1429 Each plugin should define the callback functions specified in the
1430 Plugins API.
1431
1432 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1433 Define an argument called @var{key} with a value of @var{value}
1434 for the plugin called @var{name}.
1435
1436 @item -fdump-ada-spec@r{[}-slim@r{]}
1437 For C and C++ source and include files, generate corresponding Ada
1438 specs. @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1439 GNAT User's Guide}, which provides detailed documentation on this feature.
1440
1441 @item -fdump-go-spec=@var{file}
1442 For input files in any language, generate corresponding Go
1443 declarations in @var{file}.  This generates Go @code{const},
1444 @code{type}, @code{var}, and @code{func} declarations which may be a
1445 useful way to start writing a Go interface to code written in some
1446 other language.
1447
1448 @include @value{srcdir}/../libiberty/at-file.texi
1449 @end table
1450
1451 @node Invoking G++
1452 @section Compiling C++ Programs
1453
1454 @cindex suffixes for C++ source
1455 @cindex C++ source file suffixes
1456 C++ source files conventionally use one of the suffixes @samp{.C},
1457 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1458 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1459 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1460 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1461 files with these names and compiles them as C++ programs even if you
1462 call the compiler the same way as for compiling C programs (usually
1463 with the name @command{gcc}).
1464
1465 @findex g++
1466 @findex c++
1467 However, the use of @command{gcc} does not add the C++ library.
1468 @command{g++} is a program that calls GCC and treats @samp{.c},
1469 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1470 files unless @option{-x} is used, and automatically specifies linking
1471 against the C++ library.  This program is also useful when
1472 precompiling a C header file with a @samp{.h} extension for use in C++
1473 compilations.  On many systems, @command{g++} is also installed with
1474 the name @command{c++}.
1475
1476 @cindex invoking @command{g++}
1477 When you compile C++ programs, you may specify many of the same
1478 command-line options that you use for compiling programs in any
1479 language; or command-line options meaningful for C and related
1480 languages; or options that are meaningful only for C++ programs.
1481 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1482 explanations of options for languages related to C@.
1483 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1484 explanations of options that are meaningful only for C++ programs.
1485
1486 @node C Dialect Options
1487 @section Options Controlling C Dialect
1488 @cindex dialect options
1489 @cindex language dialect options
1490 @cindex options, dialect
1491
1492 The following options control the dialect of C (or languages derived
1493 from C, such as C++, Objective-C and Objective-C++) that the compiler
1494 accepts:
1495
1496 @table @gcctabopt
1497 @cindex ANSI support
1498 @cindex ISO support
1499 @item -ansi
1500 @opindex ansi
1501 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1502 equivalent to @option{-std=c++98}.
1503
1504 This turns off certain features of GCC that are incompatible with ISO
1505 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1506 such as the @code{asm} and @code{typeof} keywords, and
1507 predefined macros such as @code{unix} and @code{vax} that identify the
1508 type of system you are using.  It also enables the undesirable and
1509 rarely used ISO trigraph feature.  For the C compiler,
1510 it disables recognition of C++ style @samp{//} comments as well as
1511 the @code{inline} keyword.
1512
1513 The alternate keywords @code{__asm__}, @code{__extension__},
1514 @code{__inline__} and @code{__typeof__} continue to work despite
1515 @option{-ansi}.  You would not want to use them in an ISO C program, of
1516 course, but it is useful to put them in header files that might be included
1517 in compilations done with @option{-ansi}.  Alternate predefined macros
1518 such as @code{__unix__} and @code{__vax__} are also available, with or
1519 without @option{-ansi}.
1520
1521 The @option{-ansi} option does not cause non-ISO programs to be
1522 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1523 addition to @option{-ansi}.  @xref{Warning Options}.
1524
1525 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1526 option is used.  Some header files may notice this macro and refrain
1527 from declaring certain functions or defining certain macros that the
1528 ISO standard doesn't call for; this is to avoid interfering with any
1529 programs that might use these names for other things.
1530
1531 Functions that are normally built in but do not have semantics
1532 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1533 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1534 built-in functions provided by GCC}, for details of the functions
1535 affected.
1536
1537 @item -std=
1538 @opindex std
1539 Determine the language standard. @xref{Standards,,Language Standards
1540 Supported by GCC}, for details of these standard versions.  This option
1541 is currently only supported when compiling C or C++.
1542
1543 The compiler can accept several base standards, such as @samp{c90} or
1544 @samp{c++98}, and GNU dialects of those standards, such as
1545 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1546 compiler accepts all programs following that standard plus those
1547 using GNU extensions that do not contradict it.  For example,
1548 @option{-std=c90} turns off certain features of GCC that are
1549 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1550 keywords, but not other GNU extensions that do not have a meaning in
1551 ISO C90, such as omitting the middle term of a @code{?:}
1552 expression. On the other hand, by specifying a GNU dialect of a
1553 standard, all features the compiler support are enabled, even when
1554 those features change the meaning of the base standard and some
1555 strict-conforming programs may be rejected.  The particular standard
1556 is used by @option{-Wpedantic} to identify which features are GNU
1557 extensions given that version of the standard. For example
1558 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1559 comments, while @option{-std=gnu99 -Wpedantic} does not.
1560
1561 A value for this option must be provided; possible values are
1562
1563 @table @samp
1564 @item c90
1565 @itemx c89
1566 @itemx iso9899:1990
1567 Support all ISO C90 programs (certain GNU extensions that conflict
1568 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1569
1570 @item iso9899:199409
1571 ISO C90 as modified in amendment 1.
1572
1573 @item c99
1574 @itemx c9x
1575 @itemx iso9899:1999
1576 @itemx iso9899:199x
1577 ISO C99.  Note that this standard is not yet fully supported; see
1578 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1579 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1580
1581 @item c11
1582 @itemx c1x
1583 @itemx iso9899:2011
1584 ISO C11, the 2011 revision of the ISO C standard.
1585 Support is incomplete and experimental.  The name @samp{c1x} is
1586 deprecated.
1587
1588 @item gnu90
1589 @itemx gnu89
1590 GNU dialect of ISO C90 (including some C99 features). This
1591 is the default for C code.
1592
1593 @item gnu99
1594 @itemx gnu9x
1595 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1596 this will become the default.  The name @samp{gnu9x} is deprecated.
1597
1598 @item gnu11
1599 @item gnu1x
1600 GNU dialect of ISO C11.  Support is incomplete and experimental.  The
1601 name @samp{gnu1x} is deprecated.
1602
1603 @item c++98
1604 @itemx c++03
1605 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1606 additional defect reports. Same as @option{-ansi} for C++ code.
1607
1608 @item gnu++98
1609 @itemx gnu++03
1610 GNU dialect of @option{-std=c++98}.  This is the default for
1611 C++ code.
1612
1613 @item c++11
1614 @itemx c++0x
1615 The 2011 ISO C++ standard plus amendments.  Support for C++11 is still
1616 experimental, and may change in incompatible ways in future releases.
1617 The name @samp{c++0x} is deprecated.
1618
1619 @item gnu++11
1620 @itemx gnu++0x
1621 GNU dialect of @option{-std=c++11}. Support for C++11 is still
1622 experimental, and may change in incompatible ways in future releases.
1623 The name @samp{gnu++0x} is deprecated.
1624
1625 @item c++1y
1626 The next revision of the ISO C++ standard, tentatively planned for
1627 2017.  Support is highly experimental, and will almost certainly
1628 change in incompatible ways in future releases.
1629
1630 @item gnu++1y
1631 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1632 and will almost certainly change in incompatible ways in future
1633 releases.
1634 @end table
1635
1636 @item -fgnu89-inline
1637 @opindex fgnu89-inline
1638 The option @option{-fgnu89-inline} tells GCC to use the traditional
1639 GNU semantics for @code{inline} functions when in C99 mode.
1640 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1641 is accepted and ignored by GCC versions 4.1.3 up to but not including
1642 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1643 C99 mode.  Using this option is roughly equivalent to adding the
1644 @code{gnu_inline} function attribute to all inline functions
1645 (@pxref{Function Attributes}).
1646
1647 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1648 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1649 specifies the default behavior).  This option was first supported in
1650 GCC 4.3.  This option is not supported in @option{-std=c90} or
1651 @option{-std=gnu90} mode.
1652
1653 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1654 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1655 in effect for @code{inline} functions.  @xref{Common Predefined
1656 Macros,,,cpp,The C Preprocessor}.
1657
1658 @item -aux-info @var{filename}
1659 @opindex aux-info
1660 Output to the given filename prototyped declarations for all functions
1661 declared and/or defined in a translation unit, including those in header
1662 files.  This option is silently ignored in any language other than C@.
1663
1664 Besides declarations, the file indicates, in comments, the origin of
1665 each declaration (source file and line), whether the declaration was
1666 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1667 @samp{O} for old, respectively, in the first character after the line
1668 number and the colon), and whether it came from a declaration or a
1669 definition (@samp{C} or @samp{F}, respectively, in the following
1670 character).  In the case of function definitions, a K&R-style list of
1671 arguments followed by their declarations is also provided, inside
1672 comments, after the declaration.
1673
1674 @item -fallow-parameterless-variadic-functions
1675 Accept variadic functions without named parameters.
1676
1677 Although it is possible to define such a function, this is not very
1678 useful as it is not possible to read the arguments.  This is only
1679 supported for C as this construct is allowed by C++.
1680
1681 @item -fno-asm
1682 @opindex fno-asm
1683 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1684 keyword, so that code can use these words as identifiers.  You can use
1685 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1686 instead.  @option{-ansi} implies @option{-fno-asm}.
1687
1688 In C++, this switch only affects the @code{typeof} keyword, since
1689 @code{asm} and @code{inline} are standard keywords.  You may want to
1690 use the @option{-fno-gnu-keywords} flag instead, which has the same
1691 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1692 switch only affects the @code{asm} and @code{typeof} keywords, since
1693 @code{inline} is a standard keyword in ISO C99.
1694
1695 @item -fno-builtin
1696 @itemx -fno-builtin-@var{function}
1697 @opindex fno-builtin
1698 @cindex built-in functions
1699 Don't recognize built-in functions that do not begin with
1700 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1701 functions provided by GCC}, for details of the functions affected,
1702 including those which are not built-in functions when @option{-ansi} or
1703 @option{-std} options for strict ISO C conformance are used because they
1704 do not have an ISO standard meaning.
1705
1706 GCC normally generates special code to handle certain built-in functions
1707 more efficiently; for instance, calls to @code{alloca} may become single
1708 instructions which adjust the stack directly, and calls to @code{memcpy}
1709 may become inline copy loops.  The resulting code is often both smaller
1710 and faster, but since the function calls no longer appear as such, you
1711 cannot set a breakpoint on those calls, nor can you change the behavior
1712 of the functions by linking with a different library.  In addition,
1713 when a function is recognized as a built-in function, GCC may use
1714 information about that function to warn about problems with calls to
1715 that function, or to generate more efficient code, even if the
1716 resulting code still contains calls to that function.  For example,
1717 warnings are given with @option{-Wformat} for bad calls to
1718 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1719 known not to modify global memory.
1720
1721 With the @option{-fno-builtin-@var{function}} option
1722 only the built-in function @var{function} is
1723 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1724 function is named that is not built-in in this version of GCC, this
1725 option is ignored.  There is no corresponding
1726 @option{-fbuiltin-@var{function}} option; if you wish to enable
1727 built-in functions selectively when using @option{-fno-builtin} or
1728 @option{-ffreestanding}, you may define macros such as:
1729
1730 @smallexample
1731 #define abs(n)          __builtin_abs ((n))
1732 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1733 @end smallexample
1734
1735 @item -fhosted
1736 @opindex fhosted
1737 @cindex hosted environment
1738
1739 Assert that compilation takes place in a hosted environment.  This implies
1740 @option{-fbuiltin}.  A hosted environment is one in which the
1741 entire standard library is available, and in which @code{main} has a return
1742 type of @code{int}.  Examples are nearly everything except a kernel.
1743 This is equivalent to @option{-fno-freestanding}.
1744
1745 @item -ffreestanding
1746 @opindex ffreestanding
1747 @cindex hosted environment
1748
1749 Assert that compilation takes place in a freestanding environment.  This
1750 implies @option{-fno-builtin}.  A freestanding environment
1751 is one in which the standard library may not exist, and program startup may
1752 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1753 This is equivalent to @option{-fno-hosted}.
1754
1755 @xref{Standards,,Language Standards Supported by GCC}, for details of
1756 freestanding and hosted environments.
1757
1758 @item -fopenmp
1759 @opindex fopenmp
1760 @cindex OpenMP parallel
1761 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1762 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1763 compiler generates parallel code according to the OpenMP Application
1764 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1765 implies @option{-pthread}, and thus is only supported on targets that
1766 have support for @option{-pthread}.
1767
1768 @item -fgnu-tm
1769 @opindex fgnu-tm
1770 When the option @option{-fgnu-tm} is specified, the compiler
1771 generates code for the Linux variant of Intel's current Transactional
1772 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1773 an experimental feature whose interface may change in future versions
1774 of GCC, as the official specification changes.  Please note that not
1775 all architectures are supported for this feature.
1776
1777 For more information on GCC's support for transactional memory,
1778 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1779 Transactional Memory Library}.
1780
1781 Note that the transactional memory feature is not supported with
1782 non-call exceptions (@option{-fnon-call-exceptions}).
1783
1784 @item -fms-extensions
1785 @opindex fms-extensions
1786 Accept some non-standard constructs used in Microsoft header files.
1787
1788 In C++ code, this allows member names in structures to be similar
1789 to previous types declarations.
1790
1791 @smallexample
1792 typedef int UOW;
1793 struct ABC @{
1794   UOW UOW;
1795 @};
1796 @end smallexample
1797
1798 Some cases of unnamed fields in structures and unions are only
1799 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1800 fields within structs/unions}, for details.
1801
1802 @item -fplan9-extensions
1803 Accept some non-standard constructs used in Plan 9 code.
1804
1805 This enables @option{-fms-extensions}, permits passing pointers to
1806 structures with anonymous fields to functions that expect pointers to
1807 elements of the type of the field, and permits referring to anonymous
1808 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1809 struct/union fields within structs/unions}, for details.  This is only
1810 supported for C, not C++.
1811
1812 @item -trigraphs
1813 @opindex trigraphs
1814 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1815 options for strict ISO C conformance) implies @option{-trigraphs}.
1816
1817 @cindex traditional C language
1818 @cindex C language, traditional
1819 @item -traditional
1820 @itemx -traditional-cpp
1821 @opindex traditional-cpp
1822 @opindex traditional
1823 Formerly, these options caused GCC to attempt to emulate a pre-standard
1824 C compiler.  They are now only supported with the @option{-E} switch.
1825 The preprocessor continues to support a pre-standard mode.  See the GNU
1826 CPP manual for details.
1827
1828 @item -fcond-mismatch
1829 @opindex fcond-mismatch
1830 Allow conditional expressions with mismatched types in the second and
1831 third arguments.  The value of such an expression is void.  This option
1832 is not supported for C++.
1833
1834 @item -flax-vector-conversions
1835 @opindex flax-vector-conversions
1836 Allow implicit conversions between vectors with differing numbers of
1837 elements and/or incompatible element types.  This option should not be
1838 used for new code.
1839
1840 @item -funsigned-char
1841 @opindex funsigned-char
1842 Let the type @code{char} be unsigned, like @code{unsigned char}.
1843
1844 Each kind of machine has a default for what @code{char} should
1845 be.  It is either like @code{unsigned char} by default or like
1846 @code{signed char} by default.
1847
1848 Ideally, a portable program should always use @code{signed char} or
1849 @code{unsigned char} when it depends on the signedness of an object.
1850 But many programs have been written to use plain @code{char} and
1851 expect it to be signed, or expect it to be unsigned, depending on the
1852 machines they were written for.  This option, and its inverse, let you
1853 make such a program work with the opposite default.
1854
1855 The type @code{char} is always a distinct type from each of
1856 @code{signed char} or @code{unsigned char}, even though its behavior
1857 is always just like one of those two.
1858
1859 @item -fsigned-char
1860 @opindex fsigned-char
1861 Let the type @code{char} be signed, like @code{signed char}.
1862
1863 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1864 the negative form of @option{-funsigned-char}.  Likewise, the option
1865 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1866
1867 @item -fsigned-bitfields
1868 @itemx -funsigned-bitfields
1869 @itemx -fno-signed-bitfields
1870 @itemx -fno-unsigned-bitfields
1871 @opindex fsigned-bitfields
1872 @opindex funsigned-bitfields
1873 @opindex fno-signed-bitfields
1874 @opindex fno-unsigned-bitfields
1875 These options control whether a bit-field is signed or unsigned, when the
1876 declaration does not use either @code{signed} or @code{unsigned}.  By
1877 default, such a bit-field is signed, because this is consistent: the
1878 basic integer types such as @code{int} are signed types.
1879 @end table
1880
1881 @node C++ Dialect Options
1882 @section Options Controlling C++ Dialect
1883
1884 @cindex compiler options, C++
1885 @cindex C++ options, command-line
1886 @cindex options, C++
1887 This section describes the command-line options that are only meaningful
1888 for C++ programs; but you can also use most of the GNU compiler options
1889 regardless of what language your program is in.  For example, you
1890 might compile a file @code{firstClass.C} like this:
1891
1892 @smallexample
1893 g++ -g -frepo -O -c firstClass.C
1894 @end smallexample
1895
1896 @noindent
1897 In this example, only @option{-frepo} is an option meant
1898 only for C++ programs; you can use the other options with any
1899 language supported by GCC@.
1900
1901 Here is a list of options that are @emph{only} for compiling C++ programs:
1902
1903 @table @gcctabopt
1904
1905 @item -fabi-version=@var{n}
1906 @opindex fabi-version
1907 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1908 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1909 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1910 the version that conforms most closely to the C++ ABI specification.
1911 Therefore, the ABI obtained using version 0 will change as ABI bugs
1912 are fixed.
1913
1914 The default is version 2.
1915
1916 Version 3 corrects an error in mangling a constant address as a
1917 template argument.
1918
1919 Version 4, which first appeared in G++ 4.5, implements a standard
1920 mangling for vector types.
1921
1922 Version 5, which first appeared in G++ 4.6, corrects the mangling of
1923 attribute const/volatile on function pointer types, decltype of a
1924 plain decl, and use of a function parameter in the declaration of
1925 another parameter.
1926
1927 Version 6, which first appeared in G++ 4.7, corrects the promotion
1928 behavior of C++11 scoped enums and the mangling of template argument
1929 packs, const/static_cast, prefix ++ and --, and a class scope function
1930 used as a template argument.
1931
1932 See also @option{-Wabi}.
1933
1934 @item -fno-access-control
1935 @opindex fno-access-control
1936 Turn off all access checking.  This switch is mainly useful for working
1937 around bugs in the access control code.
1938
1939 @item -fcheck-new
1940 @opindex fcheck-new
1941 Check that the pointer returned by @code{operator new} is non-null
1942 before attempting to modify the storage allocated.  This check is
1943 normally unnecessary because the C++ standard specifies that
1944 @code{operator new} only returns @code{0} if it is declared
1945 @samp{throw()}, in which case the compiler always checks the
1946 return value even without this option.  In all other cases, when
1947 @code{operator new} has a non-empty exception specification, memory
1948 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1949 @samp{new (nothrow)}.
1950
1951 @item -fconstexpr-depth=@var{n}
1952 @opindex fconstexpr-depth
1953 Set the maximum nested evaluation depth for C++11 constexpr functions
1954 to @var{n}.  A limit is needed to detect endless recursion during
1955 constant expression evaluation.  The minimum specified by the standard
1956 is 512.
1957
1958 @item -fdeduce-init-list
1959 @opindex fdeduce-init-list
1960 Enable deduction of a template type parameter as
1961 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
1962
1963 @smallexample
1964 template <class T> auto forward(T t) -> decltype (realfn (t))
1965 @{
1966   return realfn (t);
1967 @}
1968
1969 void f()
1970 @{
1971   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1972 @}
1973 @end smallexample
1974
1975 This deduction was implemented as a possible extension to the
1976 originally proposed semantics for the C++11 standard, but was not part
1977 of the final standard, so it is disabled by default.  This option is
1978 deprecated, and may be removed in a future version of G++.
1979
1980 @item -ffriend-injection
1981 @opindex ffriend-injection
1982 Inject friend functions into the enclosing namespace, so that they are
1983 visible outside the scope of the class in which they are declared.
1984 Friend functions were documented to work this way in the old Annotated
1985 C++ Reference Manual, and versions of G++ before 4.1 always worked
1986 that way.  However, in ISO C++ a friend function that is not declared
1987 in an enclosing scope can only be found using argument dependent
1988 lookup.  This option causes friends to be injected as they were in
1989 earlier releases.
1990
1991 This option is for compatibility, and may be removed in a future
1992 release of G++.
1993
1994 @item -fno-elide-constructors
1995 @opindex fno-elide-constructors
1996 The C++ standard allows an implementation to omit creating a temporary
1997 that is only used to initialize another object of the same type.
1998 Specifying this option disables that optimization, and forces G++ to
1999 call the copy constructor in all cases.
2000
2001 @item -fno-enforce-eh-specs
2002 @opindex fno-enforce-eh-specs
2003 Don't generate code to check for violation of exception specifications
2004 at run time.  This option violates the C++ standard, but may be useful
2005 for reducing code size in production builds, much like defining
2006 @samp{NDEBUG}.  This does not give user code permission to throw
2007 exceptions in violation of the exception specifications; the compiler
2008 still optimizes based on the specifications, so throwing an
2009 unexpected exception results in undefined behavior at run time.
2010
2011 @item -ffor-scope
2012 @itemx -fno-for-scope
2013 @opindex ffor-scope
2014 @opindex fno-for-scope
2015 If @option{-ffor-scope} is specified, the scope of variables declared in
2016 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2017 as specified by the C++ standard.
2018 If @option{-fno-for-scope} is specified, the scope of variables declared in
2019 a @i{for-init-statement} extends to the end of the enclosing scope,
2020 as was the case in old versions of G++, and other (traditional)
2021 implementations of C++.
2022
2023 The default if neither flag is given to follow the standard,
2024 but to allow and give a warning for old-style code that would
2025 otherwise be invalid, or have different behavior.
2026
2027 @item -fno-gnu-keywords
2028 @opindex fno-gnu-keywords
2029 Do not recognize @code{typeof} as a keyword, so that code can use this
2030 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2031 @option{-ansi} implies @option{-fno-gnu-keywords}.
2032
2033 @item -fno-implicit-templates
2034 @opindex fno-implicit-templates
2035 Never emit code for non-inline templates that are instantiated
2036 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2037 @xref{Template Instantiation}, for more information.
2038
2039 @item -fno-implicit-inline-templates
2040 @opindex fno-implicit-inline-templates
2041 Don't emit code for implicit instantiations of inline templates, either.
2042 The default is to handle inlines differently so that compiles with and
2043 without optimization need the same set of explicit instantiations.
2044
2045 @item -fno-implement-inlines
2046 @opindex fno-implement-inlines
2047 To save space, do not emit out-of-line copies of inline functions
2048 controlled by @samp{#pragma implementation}.  This causes linker
2049 errors if these functions are not inlined everywhere they are called.
2050
2051 @item -fms-extensions
2052 @opindex fms-extensions
2053 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2054 int and getting a pointer to member function via non-standard syntax.
2055
2056 @item -fno-nonansi-builtins
2057 @opindex fno-nonansi-builtins
2058 Disable built-in declarations of functions that are not mandated by
2059 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2060 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2061
2062 @item -fnothrow-opt
2063 @opindex fnothrow-opt
2064 Treat a @code{throw()} exception specification as if it were a
2065 @code{noexcept} specification to reduce or eliminate the text size
2066 overhead relative to a function with no exception specification.  If
2067 the function has local variables of types with non-trivial
2068 destructors, the exception specification actually makes the
2069 function smaller because the EH cleanups for those variables can be
2070 optimized away.  The semantic effect is that an exception thrown out of
2071 a function with such an exception specification results in a call
2072 to @code{terminate} rather than @code{unexpected}.
2073
2074 @item -fno-operator-names
2075 @opindex fno-operator-names
2076 Do not treat the operator name keywords @code{and}, @code{bitand},
2077 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2078 synonyms as keywords.
2079
2080 @item -fno-optional-diags
2081 @opindex fno-optional-diags
2082 Disable diagnostics that the standard says a compiler does not need to
2083 issue.  Currently, the only such diagnostic issued by G++ is the one for
2084 a name having multiple meanings within a class.
2085
2086 @item -fpermissive
2087 @opindex fpermissive
2088 Downgrade some diagnostics about nonconformant code from errors to
2089 warnings.  Thus, using @option{-fpermissive} allows some
2090 nonconforming code to compile.
2091
2092 @item -fno-pretty-templates
2093 @opindex fno-pretty-templates
2094 When an error message refers to a specialization of a function
2095 template, the compiler normally prints the signature of the
2096 template followed by the template arguments and any typedefs or
2097 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2098 rather than @code{void f(int)}) so that it's clear which template is
2099 involved.  When an error message refers to a specialization of a class
2100 template, the compiler omits any template arguments that match
2101 the default template arguments for that template.  If either of these
2102 behaviors make it harder to understand the error message rather than
2103 easier, you can use @option{-fno-pretty-templates} to disable them.
2104
2105 @item -frepo
2106 @opindex frepo
2107 Enable automatic template instantiation at link time.  This option also
2108 implies @option{-fno-implicit-templates}.  @xref{Template
2109 Instantiation}, for more information.
2110
2111 @item -fno-rtti
2112 @opindex fno-rtti
2113 Disable generation of information about every class with virtual
2114 functions for use by the C++ run-time type identification features
2115 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2116 of the language, you can save some space by using this flag.  Note that
2117 exception handling uses the same information, but G++ generates it as
2118 needed. The @samp{dynamic_cast} operator can still be used for casts that
2119 do not require run-time type information, i.e.@: casts to @code{void *} or to
2120 unambiguous base classes.
2121
2122 @item -fstats
2123 @opindex fstats
2124 Emit statistics about front-end processing at the end of the compilation.
2125 This information is generally only useful to the G++ development team.
2126
2127 @item -fstrict-enums
2128 @opindex fstrict-enums
2129 Allow the compiler to optimize using the assumption that a value of
2130 enumerated type can only be one of the values of the enumeration (as
2131 defined in the C++ standard; basically, a value that can be
2132 represented in the minimum number of bits needed to represent all the
2133 enumerators).  This assumption may not be valid if the program uses a
2134 cast to convert an arbitrary integer value to the enumerated type.
2135
2136 @item -ftemplate-backtrace-limit=@var{n}
2137 @opindex ftemplate-backtrace-limit
2138 Set the maximum number of template instantiation notes for a single
2139 warning or error to @var{n}.  The default value is 10.
2140
2141 @item -ftemplate-depth=@var{n}
2142 @opindex ftemplate-depth
2143 Set the maximum instantiation depth for template classes to @var{n}.
2144 A limit on the template instantiation depth is needed to detect
2145 endless recursions during template class instantiation.  ANSI/ISO C++
2146 conforming programs must not rely on a maximum depth greater than 17
2147 (changed to 1024 in C++11).  The default value is 900, as the compiler
2148 can run out of stack space before hitting 1024 in some situations.
2149
2150 @item -fno-threadsafe-statics
2151 @opindex fno-threadsafe-statics
2152 Do not emit the extra code to use the routines specified in the C++
2153 ABI for thread-safe initialization of local statics.  You can use this
2154 option to reduce code size slightly in code that doesn't need to be
2155 thread-safe.
2156
2157 @item -fuse-cxa-atexit
2158 @opindex fuse-cxa-atexit
2159 Register destructors for objects with static storage duration with the
2160 @code{__cxa_atexit} function rather than the @code{atexit} function.
2161 This option is required for fully standards-compliant handling of static
2162 destructors, but only works if your C library supports
2163 @code{__cxa_atexit}.
2164
2165 @item -fno-use-cxa-get-exception-ptr
2166 @opindex fno-use-cxa-get-exception-ptr
2167 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2168 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2169 if the runtime routine is not available.
2170
2171 @item -fvisibility-inlines-hidden
2172 @opindex fvisibility-inlines-hidden
2173 This switch declares that the user does not attempt to compare
2174 pointers to inline functions or methods where the addresses of the two functions
2175 are taken in different shared objects.
2176
2177 The effect of this is that GCC may, effectively, mark inline methods with
2178 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2179 appear in the export table of a DSO and do not require a PLT indirection
2180 when used within the DSO@.  Enabling this option can have a dramatic effect
2181 on load and link times of a DSO as it massively reduces the size of the
2182 dynamic export table when the library makes heavy use of templates.
2183
2184 The behavior of this switch is not quite the same as marking the
2185 methods as hidden directly, because it does not affect static variables
2186 local to the function or cause the compiler to deduce that
2187 the function is defined in only one shared object.
2188
2189 You may mark a method as having a visibility explicitly to negate the
2190 effect of the switch for that method.  For example, if you do want to
2191 compare pointers to a particular inline method, you might mark it as
2192 having default visibility.  Marking the enclosing class with explicit
2193 visibility has no effect.
2194
2195 Explicitly instantiated inline methods are unaffected by this option
2196 as their linkage might otherwise cross a shared library boundary.
2197 @xref{Template Instantiation}.
2198
2199 @item -fvisibility-ms-compat
2200 @opindex fvisibility-ms-compat
2201 This flag attempts to use visibility settings to make GCC's C++
2202 linkage model compatible with that of Microsoft Visual Studio.
2203
2204 The flag makes these changes to GCC's linkage model:
2205
2206 @enumerate
2207 @item
2208 It sets the default visibility to @code{hidden}, like
2209 @option{-fvisibility=hidden}.
2210
2211 @item
2212 Types, but not their members, are not hidden by default.
2213
2214 @item
2215 The One Definition Rule is relaxed for types without explicit
2216 visibility specifications that are defined in more than one
2217 shared object: those declarations are permitted if they are
2218 permitted when this option is not used.
2219 @end enumerate
2220
2221 In new code it is better to use @option{-fvisibility=hidden} and
2222 export those classes that are intended to be externally visible.
2223 Unfortunately it is possible for code to rely, perhaps accidentally,
2224 on the Visual Studio behavior.
2225
2226 Among the consequences of these changes are that static data members
2227 of the same type with the same name but defined in different shared
2228 objects are different, so changing one does not change the other;
2229 and that pointers to function members defined in different shared
2230 objects may not compare equal.  When this flag is given, it is a
2231 violation of the ODR to define types with the same name differently.
2232
2233 @item -fno-weak
2234 @opindex fno-weak
2235 Do not use weak symbol support, even if it is provided by the linker.
2236 By default, G++ uses weak symbols if they are available.  This
2237 option exists only for testing, and should not be used by end-users;
2238 it results in inferior code and has no benefits.  This option may
2239 be removed in a future release of G++.
2240
2241 @item -nostdinc++
2242 @opindex nostdinc++
2243 Do not search for header files in the standard directories specific to
2244 C++, but do still search the other standard directories.  (This option
2245 is used when building the C++ library.)
2246 @end table
2247
2248 In addition, these optimization, warning, and code generation options
2249 have meanings only for C++ programs:
2250
2251 @table @gcctabopt
2252 @item -fno-default-inline
2253 @opindex fno-default-inline
2254 Do not assume @samp{inline} for functions defined inside a class scope.
2255 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2256 functions have linkage like inline functions; they just aren't
2257 inlined by default.
2258
2259 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2260 @opindex Wabi
2261 @opindex Wno-abi
2262 Warn when G++ generates code that is probably not compatible with the
2263 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2264 all such cases, there are probably some cases that are not warned about,
2265 even though G++ is generating incompatible code.  There may also be
2266 cases where warnings are emitted even though the code that is generated
2267 is compatible.
2268
2269 You should rewrite your code to avoid these warnings if you are
2270 concerned about the fact that code generated by G++ may not be binary
2271 compatible with code generated by other compilers.
2272
2273 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2274
2275 @itemize @bullet
2276
2277 @item
2278 A template with a non-type template parameter of reference type is
2279 mangled incorrectly:
2280 @smallexample
2281 extern int N;
2282 template <int &> struct S @{@};
2283 void n (S<N>) @{2@}
2284 @end smallexample
2285
2286 This is fixed in @option{-fabi-version=3}.
2287
2288 @item
2289 SIMD vector types declared using @code{__attribute ((vector_size))} are
2290 mangled in a non-standard way that does not allow for overloading of
2291 functions taking vectors of different sizes.
2292
2293 The mangling is changed in @option{-fabi-version=4}.
2294 @end itemize
2295
2296 The known incompatibilities in @option{-fabi-version=1} include:
2297
2298 @itemize @bullet
2299
2300 @item
2301 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2302 pack data into the same byte as a base class.  For example:
2303
2304 @smallexample
2305 struct A @{ virtual void f(); int f1 : 1; @};
2306 struct B : public A @{ int f2 : 1; @};
2307 @end smallexample
2308
2309 @noindent
2310 In this case, G++ places @code{B::f2} into the same byte
2311 as@code{A::f1}; other compilers do not.  You can avoid this problem
2312 by explicitly padding @code{A} so that its size is a multiple of the
2313 byte size on your platform; that causes G++ and other compilers to
2314 lay out @code{B} identically.
2315
2316 @item
2317 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2318 tail padding when laying out virtual bases.  For example:
2319
2320 @smallexample
2321 struct A @{ virtual void f(); char c1; @};
2322 struct B @{ B(); char c2; @};
2323 struct C : public A, public virtual B @{@};
2324 @end smallexample
2325
2326 @noindent
2327 In this case, G++ does not place @code{B} into the tail-padding for
2328 @code{A}; other compilers do.  You can avoid this problem by
2329 explicitly padding @code{A} so that its size is a multiple of its
2330 alignment (ignoring virtual base classes); that causes G++ and other
2331 compilers to lay out @code{C} identically.
2332
2333 @item
2334 Incorrect handling of bit-fields with declared widths greater than that
2335 of their underlying types, when the bit-fields appear in a union.  For
2336 example:
2337
2338 @smallexample
2339 union U @{ int i : 4096; @};
2340 @end smallexample
2341
2342 @noindent
2343 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2344 union too small by the number of bits in an @code{int}.
2345
2346 @item
2347 Empty classes can be placed at incorrect offsets.  For example:
2348
2349 @smallexample
2350 struct A @{@};
2351
2352 struct B @{
2353   A a;
2354   virtual void f ();
2355 @};
2356
2357 struct C : public B, public A @{@};
2358 @end smallexample
2359
2360 @noindent
2361 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2362 it should be placed at offset zero.  G++ mistakenly believes that the
2363 @code{A} data member of @code{B} is already at offset zero.
2364
2365 @item
2366 Names of template functions whose types involve @code{typename} or
2367 template template parameters can be mangled incorrectly.
2368
2369 @smallexample
2370 template <typename Q>
2371 void f(typename Q::X) @{@}
2372
2373 template <template <typename> class Q>
2374 void f(typename Q<int>::X) @{@}
2375 @end smallexample
2376
2377 @noindent
2378 Instantiations of these templates may be mangled incorrectly.
2379
2380 @end itemize
2381
2382 It also warns about psABI-related changes.  The known psABI changes at this
2383 point include:
2384
2385 @itemize @bullet
2386
2387 @item
2388 For SysV/x86-64, unions with @code{long double} members are 
2389 passed in memory as specified in psABI.  For example:
2390
2391 @smallexample
2392 union U @{
2393   long double ld;
2394   int i;
2395 @};
2396 @end smallexample
2397
2398 @noindent
2399 @code{union U} is always passed in memory.
2400
2401 @end itemize
2402
2403 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2404 @opindex Wctor-dtor-privacy
2405 @opindex Wno-ctor-dtor-privacy
2406 Warn when a class seems unusable because all the constructors or
2407 destructors in that class are private, and it has neither friends nor
2408 public static member functions.
2409
2410 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2411 @opindex Wdelete-non-virtual-dtor
2412 @opindex Wno-delete-non-virtual-dtor
2413 Warn when @samp{delete} is used to destroy an instance of a class that
2414 has virtual functions and non-virtual destructor. It is unsafe to delete
2415 an instance of a derived class through a pointer to a base class if the
2416 base class does not have a virtual destructor.  This warning is enabled
2417 by @option{-Wall}.
2418
2419 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2420 @opindex Wliteral-suffix
2421 @opindex Wno-literal-suffix
2422 Warn when a string or character literal is followed by a ud-suffix which does
2423 not begin with an underscore.  As a conforming extension, GCC treats such
2424 suffixes as separate preprocessing tokens in order to maintain backwards
2425 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2426 For example:
2427
2428 @smallexample
2429 #define __STDC_FORMAT_MACROS
2430 #include <inttypes.h>
2431 #include <stdio.h>
2432
2433 int main() @{
2434   int64_t i64 = 123;
2435   printf("My int64: %"PRId64"\n", i64);
2436 @}
2437 @end smallexample
2438
2439 In this case, @code{PRId64} is treated as a separate preprocessing token.
2440
2441 This warning is enabled by default.
2442
2443 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2444 @opindex Wnarrowing
2445 @opindex Wno-narrowing
2446 Warn when a narrowing conversion prohibited by C++11 occurs within
2447 @samp{@{ @}}, e.g.
2448
2449 @smallexample
2450 int i = @{ 2.2 @}; // error: narrowing from double to int
2451 @end smallexample
2452
2453 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2454
2455 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2456 required by the standard.  Note that this does not affect the meaning
2457 of well-formed code; narrowing conversions are still considered
2458 ill-formed in SFINAE context.
2459
2460 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2461 @opindex Wnoexcept
2462 @opindex Wno-noexcept
2463 Warn when a noexcept-expression evaluates to false because of a call
2464 to a function that does not have a non-throwing exception
2465 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2466 the compiler to never throw an exception.
2467
2468 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2469 @opindex Wnon-virtual-dtor
2470 @opindex Wno-non-virtual-dtor
2471 Warn when a class has virtual functions and an accessible non-virtual
2472 destructor, in which case it is possible but unsafe to delete
2473 an instance of a derived class through a pointer to the base class.
2474 This warning is also enabled if @option{-Weffc++} is specified.
2475
2476 @item -Wreorder @r{(C++ and Objective-C++ only)}
2477 @opindex Wreorder
2478 @opindex Wno-reorder
2479 @cindex reordering, warning
2480 @cindex warning for reordering of member initializers
2481 Warn when the order of member initializers given in the code does not
2482 match the order in which they must be executed.  For instance:
2483
2484 @smallexample
2485 struct A @{
2486   int i;
2487   int j;
2488   A(): j (0), i (1) @{ @}
2489 @};
2490 @end smallexample
2491
2492 @noindent
2493 The compiler rearranges the member initializers for @samp{i}
2494 and @samp{j} to match the declaration order of the members, emitting
2495 a warning to that effect.  This warning is enabled by @option{-Wall}.
2496 @end table
2497
2498 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2499
2500 @table @gcctabopt
2501 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2502 @opindex Weffc++
2503 @opindex Wno-effc++
2504 Warn about violations of the following style guidelines from Scott Meyers'
2505 @cite{Effective C++, Second Edition} book:
2506
2507 @itemize @bullet
2508 @item
2509 Item 11:  Define a copy constructor and an assignment operator for classes
2510 with dynamically allocated memory.
2511
2512 @item
2513 Item 12:  Prefer initialization to assignment in constructors.
2514
2515 @item
2516 Item 14:  Make destructors virtual in base classes.
2517
2518 @item
2519 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2520
2521 @item
2522 Item 23:  Don't try to return a reference when you must return an object.
2523
2524 @end itemize
2525
2526 Also warn about violations of the following style guidelines from
2527 Scott Meyers' @cite{More Effective C++} book:
2528
2529 @itemize @bullet
2530 @item
2531 Item 6:  Distinguish between prefix and postfix forms of increment and
2532 decrement operators.
2533
2534 @item
2535 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2536
2537 @end itemize
2538
2539 When selecting this option, be aware that the standard library
2540 headers do not obey all of these guidelines; use @samp{grep -v}
2541 to filter out those warnings.
2542
2543 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2544 @opindex Wstrict-null-sentinel
2545 @opindex Wno-strict-null-sentinel
2546 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2547 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2548 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2549 it is guaranteed to be of the same size as a pointer.  But this use is
2550 not portable across different compilers.
2551
2552 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2553 @opindex Wno-non-template-friend
2554 @opindex Wnon-template-friend
2555 Disable warnings when non-templatized friend functions are declared
2556 within a template.  Since the advent of explicit template specification
2557 support in G++, if the name of the friend is an unqualified-id (i.e.,
2558 @samp{friend foo(int)}), the C++ language specification demands that the
2559 friend declare or define an ordinary, nontemplate function.  (Section
2560 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2561 could be interpreted as a particular specialization of a templatized
2562 function.  Because this non-conforming behavior is no longer the default
2563 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2564 check existing code for potential trouble spots and is on by default.
2565 This new compiler behavior can be turned off with
2566 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2567 but disables the helpful warning.
2568
2569 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2570 @opindex Wold-style-cast
2571 @opindex Wno-old-style-cast
2572 Warn if an old-style (C-style) cast to a non-void type is used within
2573 a C++ program.  The new-style casts (@samp{dynamic_cast},
2574 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2575 less vulnerable to unintended effects and much easier to search for.
2576
2577 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2578 @opindex Woverloaded-virtual
2579 @opindex Wno-overloaded-virtual
2580 @cindex overloaded virtual function, warning
2581 @cindex warning for overloaded virtual function
2582 Warn when a function declaration hides virtual functions from a
2583 base class.  For example, in:
2584
2585 @smallexample
2586 struct A @{
2587   virtual void f();
2588 @};
2589
2590 struct B: public A @{
2591   void f(int);
2592 @};
2593 @end smallexample
2594
2595 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2596 like:
2597
2598 @smallexample
2599 B* b;
2600 b->f();
2601 @end smallexample
2602
2603 @noindent
2604 fails to compile.
2605
2606 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2607 @opindex Wno-pmf-conversions
2608 @opindex Wpmf-conversions
2609 Disable the diagnostic for converting a bound pointer to member function
2610 to a plain pointer.
2611
2612 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2613 @opindex Wsign-promo
2614 @opindex Wno-sign-promo
2615 Warn when overload resolution chooses a promotion from unsigned or
2616 enumerated type to a signed type, over a conversion to an unsigned type of
2617 the same size.  Previous versions of G++ tried to preserve
2618 unsignedness, but the standard mandates the current behavior.
2619
2620 @smallexample
2621 struct A @{
2622   operator int ();
2623   A& operator = (int);
2624 @};
2625
2626 main ()
2627 @{
2628   A a,b;
2629   a = b;
2630 @}
2631 @end smallexample
2632
2633 @noindent
2634 In this example, G++ synthesizes a default @samp{A& operator =
2635 (const A&);}, while cfront uses the user-defined @samp{operator =}.
2636 @end table
2637
2638 @node Objective-C and Objective-C++ Dialect Options
2639 @section Options Controlling Objective-C and Objective-C++ Dialects
2640
2641 @cindex compiler options, Objective-C and Objective-C++
2642 @cindex Objective-C and Objective-C++ options, command-line
2643 @cindex options, Objective-C and Objective-C++
2644 (NOTE: This manual does not describe the Objective-C and Objective-C++
2645 languages themselves.  @xref{Standards,,Language Standards
2646 Supported by GCC}, for references.)
2647
2648 This section describes the command-line options that are only meaningful
2649 for Objective-C and Objective-C++ programs, but you can also use most of
2650 the language-independent GNU compiler options.
2651 For example, you might compile a file @code{some_class.m} like this:
2652
2653 @smallexample
2654 gcc -g -fgnu-runtime -O -c some_class.m
2655 @end smallexample
2656
2657 @noindent
2658 In this example, @option{-fgnu-runtime} is an option meant only for
2659 Objective-C and Objective-C++ programs; you can use the other options with
2660 any language supported by GCC@.
2661
2662 Note that since Objective-C is an extension of the C language, Objective-C
2663 compilations may also use options specific to the C front-end (e.g.,
2664 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2665 C++-specific options (e.g., @option{-Wabi}).
2666
2667 Here is a list of options that are @emph{only} for compiling Objective-C
2668 and Objective-C++ programs:
2669
2670 @table @gcctabopt
2671 @item -fconstant-string-class=@var{class-name}
2672 @opindex fconstant-string-class
2673 Use @var{class-name} as the name of the class to instantiate for each
2674 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2675 class name is @code{NXConstantString} if the GNU runtime is being used, and
2676 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2677 @option{-fconstant-cfstrings} option, if also present, overrides the
2678 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2679 to be laid out as constant CoreFoundation strings.
2680
2681 @item -fgnu-runtime
2682 @opindex fgnu-runtime
2683 Generate object code compatible with the standard GNU Objective-C
2684 runtime.  This is the default for most types of systems.
2685
2686 @item -fnext-runtime
2687 @opindex fnext-runtime
2688 Generate output compatible with the NeXT runtime.  This is the default
2689 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2690 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2691 used.
2692
2693 @item -fno-nil-receivers
2694 @opindex fno-nil-receivers
2695 Assume that all Objective-C message dispatches (@code{[receiver
2696 message:arg]}) in this translation unit ensure that the receiver is
2697 not @code{nil}.  This allows for more efficient entry points in the
2698 runtime to be used.  This option is only available in conjunction with
2699 the NeXT runtime and ABI version 0 or 1.
2700
2701 @item -fobjc-abi-version=@var{n}
2702 @opindex fobjc-abi-version
2703 Use version @var{n} of the Objective-C ABI for the selected runtime.
2704 This option is currently supported only for the NeXT runtime.  In that
2705 case, Version 0 is the traditional (32-bit) ABI without support for
2706 properties and other Objective-C 2.0 additions.  Version 1 is the
2707 traditional (32-bit) ABI with support for properties and other
2708 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2709 nothing is specified, the default is Version 0 on 32-bit target
2710 machines, and Version 2 on 64-bit target machines.
2711
2712 @item -fobjc-call-cxx-cdtors
2713 @opindex fobjc-call-cxx-cdtors
2714 For each Objective-C class, check if any of its instance variables is a
2715 C++ object with a non-trivial default constructor.  If so, synthesize a
2716 special @code{- (id) .cxx_construct} instance method which runs
2717 non-trivial default constructors on any such instance variables, in order,
2718 and then return @code{self}.  Similarly, check if any instance variable
2719 is a C++ object with a non-trivial destructor, and if so, synthesize a
2720 special @code{- (void) .cxx_destruct} method which runs
2721 all such default destructors, in reverse order.
2722
2723 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2724 methods thusly generated only operate on instance variables
2725 declared in the current Objective-C class, and not those inherited
2726 from superclasses.  It is the responsibility of the Objective-C
2727 runtime to invoke all such methods in an object's inheritance
2728 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2729 by the runtime immediately after a new object instance is allocated;
2730 the @code{- (void) .cxx_destruct} methods are invoked immediately
2731 before the runtime deallocates an object instance.
2732
2733 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2734 support for invoking the @code{- (id) .cxx_construct} and
2735 @code{- (void) .cxx_destruct} methods.
2736
2737 @item -fobjc-direct-dispatch
2738 @opindex fobjc-direct-dispatch
2739 Allow fast jumps to the message dispatcher.  On Darwin this is
2740 accomplished via the comm page.
2741
2742 @item -fobjc-exceptions
2743 @opindex fobjc-exceptions
2744 Enable syntactic support for structured exception handling in
2745 Objective-C, similar to what is offered by C++ and Java.  This option
2746 is required to use the Objective-C keywords @code{@@try},
2747 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2748 @code{@@synchronized}.  This option is available with both the GNU
2749 runtime and the NeXT runtime (but not available in conjunction with
2750 the NeXT runtime on Mac OS X 10.2 and earlier).
2751
2752 @item -fobjc-gc
2753 @opindex fobjc-gc
2754 Enable garbage collection (GC) in Objective-C and Objective-C++
2755 programs.  This option is only available with the NeXT runtime; the
2756 GNU runtime has a different garbage collection implementation that
2757 does not require special compiler flags.
2758
2759 @item -fobjc-nilcheck
2760 @opindex fobjc-nilcheck
2761 For the NeXT runtime with version 2 of the ABI, check for a nil
2762 receiver in method invocations before doing the actual method call.
2763 This is the default and can be disabled using
2764 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2765 checked for nil in this way no matter what this flag is set to.
2766 Currently this flag does nothing when the GNU runtime, or an older
2767 version of the NeXT runtime ABI, is used.
2768
2769 @item -fobjc-std=objc1
2770 @opindex fobjc-std
2771 Conform to the language syntax of Objective-C 1.0, the language
2772 recognized by GCC 4.0.  This only affects the Objective-C additions to
2773 the C/C++ language; it does not affect conformance to C/C++ standards,
2774 which is controlled by the separate C/C++ dialect option flags.  When
2775 this option is used with the Objective-C or Objective-C++ compiler,
2776 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2777 This is useful if you need to make sure that your Objective-C code can
2778 be compiled with older versions of GCC@.
2779
2780 @item -freplace-objc-classes
2781 @opindex freplace-objc-classes
2782 Emit a special marker instructing @command{ld(1)} not to statically link in
2783 the resulting object file, and allow @command{dyld(1)} to load it in at
2784 run time instead.  This is used in conjunction with the Fix-and-Continue
2785 debugging mode, where the object file in question may be recompiled and
2786 dynamically reloaded in the course of program execution, without the need
2787 to restart the program itself.  Currently, Fix-and-Continue functionality
2788 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2789 and later.
2790
2791 @item -fzero-link
2792 @opindex fzero-link
2793 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2794 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2795 compile time) with static class references that get initialized at load time,
2796 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2797 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2798 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2799 for individual class implementations to be modified during program execution.
2800 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2801 regardless of command-line options.
2802
2803 @item -gen-decls
2804 @opindex gen-decls
2805 Dump interface declarations for all classes seen in the source file to a
2806 file named @file{@var{sourcename}.decl}.
2807
2808 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2809 @opindex Wassign-intercept
2810 @opindex Wno-assign-intercept
2811 Warn whenever an Objective-C assignment is being intercepted by the
2812 garbage collector.
2813
2814 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2815 @opindex Wno-protocol
2816 @opindex Wprotocol
2817 If a class is declared to implement a protocol, a warning is issued for
2818 every method in the protocol that is not implemented by the class.  The
2819 default behavior is to issue a warning for every method not explicitly
2820 implemented in the class, even if a method implementation is inherited
2821 from the superclass.  If you use the @option{-Wno-protocol} option, then
2822 methods inherited from the superclass are considered to be implemented,
2823 and no warning is issued for them.
2824
2825 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2826 @opindex Wselector
2827 @opindex Wno-selector
2828 Warn if multiple methods of different types for the same selector are
2829 found during compilation.  The check is performed on the list of methods
2830 in the final stage of compilation.  Additionally, a check is performed
2831 for each selector appearing in a @code{@@selector(@dots{})}
2832 expression, and a corresponding method for that selector has been found
2833 during compilation.  Because these checks scan the method table only at
2834 the end of compilation, these warnings are not produced if the final
2835 stage of compilation is not reached, for example because an error is
2836 found during compilation, or because the @option{-fsyntax-only} option is
2837 being used.
2838
2839 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2840 @opindex Wstrict-selector-match
2841 @opindex Wno-strict-selector-match
2842 Warn if multiple methods with differing argument and/or return types are
2843 found for a given selector when attempting to send a message using this
2844 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2845 is off (which is the default behavior), the compiler omits such warnings
2846 if any differences found are confined to types that share the same size
2847 and alignment.
2848
2849 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2850 @opindex Wundeclared-selector
2851 @opindex Wno-undeclared-selector
2852 Warn if a @code{@@selector(@dots{})} expression referring to an
2853 undeclared selector is found.  A selector is considered undeclared if no
2854 method with that name has been declared before the
2855 @code{@@selector(@dots{})} expression, either explicitly in an
2856 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2857 an @code{@@implementation} section.  This option always performs its
2858 checks as soon as a @code{@@selector(@dots{})} expression is found,
2859 while @option{-Wselector} only performs its checks in the final stage of
2860 compilation.  This also enforces the coding style convention
2861 that methods and selectors must be declared before being used.
2862
2863 @item -print-objc-runtime-info
2864 @opindex print-objc-runtime-info
2865 Generate C header describing the largest structure that is passed by
2866 value, if any.
2867
2868 @end table
2869
2870 @node Language Independent Options
2871 @section Options to Control Diagnostic Messages Formatting
2872 @cindex options to control diagnostics formatting
2873 @cindex diagnostic messages
2874 @cindex message formatting
2875
2876 Traditionally, diagnostic messages have been formatted irrespective of
2877 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
2878 options described below
2879 to control the formatting algorithm for diagnostic messages, 
2880 e.g.@: how many characters per line, how often source location
2881 information should be reported.  Note that some language front ends may not
2882 honor these options.
2883
2884 @table @gcctabopt
2885 @item -fmessage-length=@var{n}
2886 @opindex fmessage-length
2887 Try to format error messages so that they fit on lines of about @var{n}
2888 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2889 the front ends supported by GCC@.  If @var{n} is zero, then no
2890 line-wrapping is done; each error message appears on a single
2891 line.
2892
2893 @item -fdiagnostics-show-location=once
2894 @opindex fdiagnostics-show-location
2895 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2896 reporter to emit @emph{once} source location information; that is, in
2897 case the message is too long to fit on a single physical line and has to
2898 be wrapped, the source location won't be emitted (as prefix) again,
2899 over and over, in subsequent continuation lines.  This is the default
2900 behavior.
2901
2902 @item -fdiagnostics-show-location=every-line
2903 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2904 messages reporter to emit the same source location information (as
2905 prefix) for physical lines that result from the process of breaking
2906 a message which is too long to fit on a single line.
2907
2908 @item -fno-diagnostics-show-option
2909 @opindex fno-diagnostics-show-option
2910 @opindex fdiagnostics-show-option
2911 By default, each diagnostic emitted includes text indicating the
2912 command-line option that directly controls the diagnostic (if such an
2913 option is known to the diagnostic machinery).  Specifying the
2914 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
2915
2916 @item -fno-diagnostics-show-caret
2917 @opindex fno-diagnostics-show-caret
2918 @opindex fdiagnostics-show-caret
2919 By default, each diagnostic emitted includes the original source line
2920 and a caret '^' indicating the column.  This option suppresses this
2921 information.
2922
2923 @end table
2924
2925 @node Warning Options
2926 @section Options to Request or Suppress Warnings
2927 @cindex options to control warnings
2928 @cindex warning messages
2929 @cindex messages, warning
2930 @cindex suppressing warnings
2931
2932 Warnings are diagnostic messages that report constructions that
2933 are not inherently erroneous but that are risky or suggest there
2934 may have been an error.
2935
2936 The following language-independent options do not enable specific
2937 warnings but control the kinds of diagnostics produced by GCC@.
2938
2939 @table @gcctabopt
2940 @cindex syntax checking
2941 @item -fsyntax-only
2942 @opindex fsyntax-only
2943 Check the code for syntax errors, but don't do anything beyond that.
2944
2945 @item -fmax-errors=@var{n}
2946 @opindex fmax-errors
2947 Limits the maximum number of error messages to @var{n}, at which point
2948 GCC bails out rather than attempting to continue processing the source
2949 code.  If @var{n} is 0 (the default), there is no limit on the number
2950 of error messages produced.  If @option{-Wfatal-errors} is also
2951 specified, then @option{-Wfatal-errors} takes precedence over this
2952 option.
2953
2954 @item -w
2955 @opindex w
2956 Inhibit all warning messages.
2957
2958 @item -Werror
2959 @opindex Werror
2960 @opindex Wno-error
2961 Make all warnings into errors.
2962
2963 @item -Werror=
2964 @opindex Werror=
2965 @opindex Wno-error=
2966 Make the specified warning into an error.  The specifier for a warning
2967 is appended, for example @option{-Werror=switch} turns the warnings
2968 controlled by @option{-Wswitch} into errors.  This switch takes a
2969 negative form, to be used to negate @option{-Werror} for specific
2970 warnings, for example @option{-Wno-error=switch} makes
2971 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2972 is in effect.
2973
2974 The warning message for each controllable warning includes the
2975 option that controls the warning.  That option can then be used with
2976 @option{-Werror=} and @option{-Wno-error=} as described above.
2977 (Printing of the option in the warning message can be disabled using the
2978 @option{-fno-diagnostics-show-option} flag.)
2979
2980 Note that specifying @option{-Werror=}@var{foo} automatically implies
2981 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2982 imply anything.
2983
2984 @item -Wfatal-errors
2985 @opindex Wfatal-errors
2986 @opindex Wno-fatal-errors
2987 This option causes the compiler to abort compilation on the first error
2988 occurred rather than trying to keep going and printing further error
2989 messages.
2990
2991 @end table
2992
2993 You can request many specific warnings with options beginning
2994 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2995 implicit declarations.  Each of these specific warning options also
2996 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2997 example, @option{-Wno-implicit}.  This manual lists only one of the
2998 two forms, whichever is not the default.  For further,
2999 language-specific options also refer to @ref{C++ Dialect Options} and
3000 @ref{Objective-C and Objective-C++ Dialect Options}.
3001
3002 When an unrecognized warning option is requested (e.g.,
3003 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3004 that the option is not recognized.  However, if the @option{-Wno-} form
3005 is used, the behavior is slightly different: no diagnostic is
3006 produced for @option{-Wno-unknown-warning} unless other diagnostics
3007 are being produced.  This allows the use of new @option{-Wno-} options
3008 with old compilers, but if something goes wrong, the compiler
3009 warns that an unrecognized option is present.
3010
3011 @table @gcctabopt
3012 @item -Wpedantic
3013 @itemx -pedantic
3014 @opindex pedantic
3015 @opindex Wpedantic
3016 Issue all the warnings demanded by strict ISO C and ISO C++;
3017 reject all programs that use forbidden extensions, and some other
3018 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3019 version of the ISO C standard specified by any @option{-std} option used.
3020
3021 Valid ISO C and ISO C++ programs should compile properly with or without
3022 this option (though a rare few require @option{-ansi} or a
3023 @option{-std} option specifying the required version of ISO C)@.  However,
3024 without this option, certain GNU extensions and traditional C and C++
3025 features are supported as well.  With this option, they are rejected.
3026
3027 @option{-Wpedantic} does not cause warning messages for use of the
3028 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3029 warnings are also disabled in the expression that follows
3030 @code{__extension__}.  However, only system header files should use
3031 these escape routes; application programs should avoid them.
3032 @xref{Alternate Keywords}.
3033
3034 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3035 C conformance.  They soon find that it does not do quite what they want:
3036 it finds some non-ISO practices, but not all---only those for which
3037 ISO C @emph{requires} a diagnostic, and some others for which
3038 diagnostics have been added.
3039
3040 A feature to report any failure to conform to ISO C might be useful in
3041 some instances, but would require considerable additional work and would
3042 be quite different from @option{-Wpedantic}.  We don't have plans to
3043 support such a feature in the near future.
3044
3045 Where the standard specified with @option{-std} represents a GNU
3046 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3047 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3048 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3049 where they are required by the base standard.  (It does not make sense
3050 for such warnings to be given only for features not in the specified GNU
3051 C dialect, since by definition the GNU dialects of C include all
3052 features the compiler supports with the given option, and there would be
3053 nothing to warn about.)
3054
3055 @item -pedantic-errors
3056 @opindex pedantic-errors
3057 Like @option{-Wpedantic}, except that errors are produced rather than
3058 warnings.
3059
3060 @item -Wall
3061 @opindex Wall
3062 @opindex Wno-all
3063 This enables all the warnings about constructions that some users
3064 consider questionable, and that are easy to avoid (or modify to
3065 prevent the warning), even in conjunction with macros.  This also
3066 enables some language-specific warnings described in @ref{C++ Dialect
3067 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3068
3069 @option{-Wall} turns on the following warning flags:
3070
3071 @gccoptlist{-Waddress   @gol
3072 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3073 -Wc++11-compat  @gol
3074 -Wchar-subscripts  @gol
3075 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
3076 -Wimplicit-int @r{(C and Objective-C only)} @gol
3077 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3078 -Wcomment  @gol
3079 -Wformat   @gol
3080 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3081 -Wmaybe-uninitialized @gol
3082 -Wmissing-braces @r{(only for C/ObjC)} @gol
3083 -Wnonnull  @gol
3084 -Wparentheses  @gol
3085 -Wpointer-sign  @gol
3086 -Wreorder   @gol
3087 -Wreturn-type  @gol
3088 -Wsequence-point  @gol
3089 -Wsign-compare @r{(only in C++)}  @gol
3090 -Wstrict-aliasing  @gol
3091 -Wstrict-overflow=1  @gol
3092 -Wswitch  @gol
3093 -Wtrigraphs  @gol
3094 -Wuninitialized  @gol
3095 -Wunknown-pragmas  @gol
3096 -Wunused-function  @gol
3097 -Wunused-label     @gol
3098 -Wunused-value     @gol
3099 -Wunused-variable  @gol
3100 -Wvolatile-register-var @gol
3101 }
3102
3103 Note that some warning flags are not implied by @option{-Wall}.  Some of
3104 them warn about constructions that users generally do not consider
3105 questionable, but which occasionally you might wish to check for;
3106 others warn about constructions that are necessary or hard to avoid in
3107 some cases, and there is no simple way to modify the code to suppress
3108 the warning. Some of them are enabled by @option{-Wextra} but many of
3109 them must be enabled individually.
3110
3111 @item -Wextra
3112 @opindex W
3113 @opindex Wextra
3114 @opindex Wno-extra
3115 This enables some extra warning flags that are not enabled by
3116 @option{-Wall}. (This option used to be called @option{-W}.  The older
3117 name is still supported, but the newer name is more descriptive.)
3118
3119 @gccoptlist{-Wclobbered  @gol
3120 -Wempty-body  @gol
3121 -Wignored-qualifiers @gol
3122 -Wmissing-field-initializers  @gol
3123 -Wmissing-parameter-type @r{(C only)}  @gol
3124 -Wold-style-declaration @r{(C only)}  @gol
3125 -Woverride-init  @gol
3126 -Wsign-compare  @gol
3127 -Wtype-limits  @gol
3128 -Wuninitialized  @gol
3129 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3130 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3131 }
3132
3133 The option @option{-Wextra} also prints warning messages for the
3134 following cases:
3135
3136 @itemize @bullet
3137
3138 @item
3139 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3140 @samp{>}, or @samp{>=}.
3141
3142 @item
3143 (C++ only) An enumerator and a non-enumerator both appear in a
3144 conditional expression.
3145
3146 @item
3147 (C++ only) Ambiguous virtual bases.
3148
3149 @item
3150 (C++ only) Subscripting an array that has been declared @samp{register}.
3151
3152 @item
3153 (C++ only) Taking the address of a variable that has been declared
3154 @samp{register}.
3155
3156 @item
3157 (C++ only) A base class is not initialized in a derived class' copy
3158 constructor.
3159
3160 @end itemize
3161
3162 @item -Wchar-subscripts
3163 @opindex Wchar-subscripts
3164 @opindex Wno-char-subscripts
3165 Warn if an array subscript has type @code{char}.  This is a common cause
3166 of error, as programmers often forget that this type is signed on some
3167 machines.
3168 This warning is enabled by @option{-Wall}.
3169
3170 @item -Wcomment
3171 @opindex Wcomment
3172 @opindex Wno-comment
3173 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3174 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3175 This warning is enabled by @option{-Wall}.
3176
3177 @item -Wno-coverage-mismatch
3178 @opindex Wno-coverage-mismatch
3179 Warn if feedback profiles do not match when using the
3180 @option{-fprofile-use} option.
3181 If a source file is changed between compiling with @option{-fprofile-gen} and
3182 with @option{-fprofile-use}, the files with the profile feedback can fail
3183 to match the source file and GCC cannot use the profile feedback
3184 information.  By default, this warning is enabled and is treated as an
3185 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3186 warning or @option{-Wno-error=coverage-mismatch} can be used to
3187 disable the error.  Disabling the error for this warning can result in
3188 poorly optimized code and is useful only in the
3189 case of very minor changes such as bug fixes to an existing code-base.
3190 Completely disabling the warning is not recommended.
3191
3192 @item -Wno-cpp
3193 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3194
3195 Suppress warning messages emitted by @code{#warning} directives.
3196
3197 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3198 @opindex Wdouble-promotion
3199 @opindex Wno-double-promotion
3200 Give a warning when a value of type @code{float} is implicitly
3201 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3202 floating-point unit implement @code{float} in hardware, but emulate
3203 @code{double} in software.  On such a machine, doing computations
3204 using @code{double} values is much more expensive because of the
3205 overhead required for software emulation.
3206
3207 It is easy to accidentally do computations with @code{double} because
3208 floating-point literals are implicitly of type @code{double}.  For
3209 example, in:
3210 @smallexample
3211 @group
3212 float area(float radius)
3213 @{
3214    return 3.14159 * radius * radius;
3215 @}
3216 @end group
3217 @end smallexample
3218 the compiler performs the entire computation with @code{double}
3219 because the floating-point literal is a @code{double}.
3220
3221 @item -Wformat
3222 @opindex Wformat
3223 @opindex Wno-format
3224 @opindex ffreestanding
3225 @opindex fno-builtin
3226 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3227 the arguments supplied have types appropriate to the format string
3228 specified, and that the conversions specified in the format string make
3229 sense.  This includes standard functions, and others specified by format
3230 attributes (@pxref{Function Attributes}), in the @code{printf},
3231 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3232 not in the C standard) families (or other target-specific families).
3233 Which functions are checked without format attributes having been
3234 specified depends on the standard version selected, and such checks of
3235 functions without the attribute specified are disabled by
3236 @option{-ffreestanding} or @option{-fno-builtin}.
3237
3238 The formats are checked against the format features supported by GNU
3239 libc version 2.2.  These include all ISO C90 and C99 features, as well
3240 as features from the Single Unix Specification and some BSD and GNU
3241 extensions.  Other library implementations may not support all these
3242 features; GCC does not support warning about features that go beyond a
3243 particular library's limitations.  However, if @option{-Wpedantic} is used
3244 with @option{-Wformat}, warnings are given about format features not
3245 in the selected standard version (but not for @code{strfmon} formats,
3246 since those are not in any version of the C standard).  @xref{C Dialect
3247 Options,,Options Controlling C Dialect}.
3248
3249 Since @option{-Wformat} also checks for null format arguments for
3250 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3251
3252 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3253 aspects of format checking, the options @option{-Wformat-y2k},
3254 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3255 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3256 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3257
3258 @item -Wformat-y2k
3259 @opindex Wformat-y2k
3260 @opindex Wno-format-y2k
3261 If @option{-Wformat} is specified, also warn about @code{strftime}
3262 formats that may yield only a two-digit year.
3263
3264 @item -Wno-format-contains-nul
3265 @opindex Wno-format-contains-nul
3266 @opindex Wformat-contains-nul
3267 If @option{-Wformat} is specified, do not warn about format strings that
3268 contain NUL bytes.
3269
3270 @item -Wno-format-extra-args
3271 @opindex Wno-format-extra-args
3272 @opindex Wformat-extra-args
3273 If @option{-Wformat} is specified, do not warn about excess arguments to a
3274 @code{printf} or @code{scanf} format function.  The C standard specifies
3275 that such arguments are ignored.
3276
3277 Where the unused arguments lie between used arguments that are
3278 specified with @samp{$} operand number specifications, normally
3279 warnings are still given, since the implementation could not know what
3280 type to pass to @code{va_arg} to skip the unused arguments.  However,
3281 in the case of @code{scanf} formats, this option suppresses the
3282 warning if the unused arguments are all pointers, since the Single
3283 Unix Specification says that such unused arguments are allowed.
3284
3285 @item -Wno-format-zero-length
3286 @opindex Wno-format-zero-length
3287 @opindex Wformat-zero-length
3288 If @option{-Wformat} is specified, do not warn about zero-length formats.
3289 The C standard specifies that zero-length formats are allowed.
3290
3291 @item -Wformat-nonliteral
3292 @opindex Wformat-nonliteral
3293 @opindex Wno-format-nonliteral
3294 If @option{-Wformat} is specified, also warn if the format string is not a
3295 string literal and so cannot be checked, unless the format function
3296 takes its format arguments as a @code{va_list}.
3297
3298 @item -Wformat-security
3299 @opindex Wformat-security
3300 @opindex Wno-format-security
3301 If @option{-Wformat} is specified, also warn about uses of format
3302 functions that represent possible security problems.  At present, this
3303 warns about calls to @code{printf} and @code{scanf} functions where the
3304 format string is not a string literal and there are no format arguments,
3305 as in @code{printf (foo);}.  This may be a security hole if the format
3306 string came from untrusted input and contains @samp{%n}.  (This is
3307 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3308 in future warnings may be added to @option{-Wformat-security} that are not
3309 included in @option{-Wformat-nonliteral}.)
3310
3311 @item -Wformat=2
3312 @opindex Wformat=2
3313 @opindex Wno-format=2
3314 Enable @option{-Wformat} plus format checks not included in
3315 @option{-Wformat}.  Currently equivalent to @option{-Wformat
3316 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3317
3318 @item -Wnonnull
3319 @opindex Wnonnull
3320 @opindex Wno-nonnull
3321 Warn about passing a null pointer for arguments marked as
3322 requiring a non-null value by the @code{nonnull} function attribute.
3323
3324 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3325 can be disabled with the @option{-Wno-nonnull} option.
3326
3327 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3328 @opindex Winit-self
3329 @opindex Wno-init-self
3330 Warn about uninitialized variables that are initialized with themselves.
3331 Note this option can only be used with the @option{-Wuninitialized} option.
3332
3333 For example, GCC warns about @code{i} being uninitialized in the
3334 following snippet only when @option{-Winit-self} has been specified:
3335 @smallexample
3336 @group
3337 int f()
3338 @{
3339   int i = i;
3340   return i;
3341 @}
3342 @end group
3343 @end smallexample
3344
3345 @item -Wimplicit-int @r{(C and Objective-C only)}
3346 @opindex Wimplicit-int
3347 @opindex Wno-implicit-int
3348 Warn when a declaration does not specify a type.
3349 This warning is enabled by @option{-Wall}.
3350
3351 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3352 @opindex Wimplicit-function-declaration
3353 @opindex Wno-implicit-function-declaration
3354 Give a warning whenever a function is used before being declared. In
3355 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3356 enabled by default and it is made into an error by
3357 @option{-pedantic-errors}. This warning is also enabled by
3358 @option{-Wall}.
3359
3360 @item -Wimplicit @r{(C and Objective-C only)}
3361 @opindex Wimplicit
3362 @opindex Wno-implicit
3363 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3364 This warning is enabled by @option{-Wall}.
3365
3366 @item -Wignored-qualifiers @r{(C and C++ only)}
3367 @opindex Wignored-qualifiers
3368 @opindex Wno-ignored-qualifiers
3369 Warn if the return type of a function has a type qualifier
3370 such as @code{const}.  For ISO C such a type qualifier has no effect,
3371 since the value returned by a function is not an lvalue.
3372 For C++, the warning is only emitted for scalar types or @code{void}.
3373 ISO C prohibits qualified @code{void} return types on function
3374 definitions, so such return types always receive a warning
3375 even without this option.
3376
3377 This warning is also enabled by @option{-Wextra}.
3378
3379 @item -Wmain
3380 @opindex Wmain
3381 @opindex Wno-main
3382 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3383 a function with external linkage, returning int, taking either zero
3384 arguments, two, or three arguments of appropriate types.  This warning
3385 is enabled by default in C++ and is enabled by either @option{-Wall}
3386 or @option{-Wpedantic}.
3387
3388 @item -Wmissing-braces
3389 @opindex Wmissing-braces
3390 @opindex Wno-missing-braces
3391 Warn if an aggregate or union initializer is not fully bracketed.  In
3392 the following example, the initializer for @samp{a} is not fully
3393 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3394 enabled by @option{-Wall} in C.
3395
3396 @smallexample
3397 int a[2][2] = @{ 0, 1, 2, 3 @};
3398 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3399 @end smallexample
3400
3401 This warning is enabled by @option{-Wall}.
3402
3403 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3404 @opindex Wmissing-include-dirs
3405 @opindex Wno-missing-include-dirs
3406 Warn if a user-supplied include directory does not exist.
3407
3408 @item -Wparentheses
3409 @opindex Wparentheses
3410 @opindex Wno-parentheses
3411 Warn if parentheses are omitted in certain contexts, such
3412 as when there is an assignment in a context where a truth value
3413 is expected, or when operators are nested whose precedence people
3414 often get confused about.
3415
3416 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3417 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3418 interpretation from that of ordinary mathematical notation.
3419
3420 Also warn about constructions where there may be confusion to which
3421 @code{if} statement an @code{else} branch belongs.  Here is an example of
3422 such a case:
3423
3424 @smallexample
3425 @group
3426 @{
3427   if (a)
3428     if (b)
3429       foo ();
3430   else
3431     bar ();
3432 @}
3433 @end group
3434 @end smallexample
3435
3436 In C/C++, every @code{else} branch belongs to the innermost possible
3437 @code{if} statement, which in this example is @code{if (b)}.  This is
3438 often not what the programmer expected, as illustrated in the above
3439 example by indentation the programmer chose.  When there is the
3440 potential for this confusion, GCC issues a warning when this flag
3441 is specified.  To eliminate the warning, add explicit braces around
3442 the innermost @code{if} statement so there is no way the @code{else}
3443 can belong to the enclosing @code{if}.  The resulting code
3444 looks like this:
3445
3446 @smallexample
3447 @group
3448 @{
3449   if (a)
3450     @{
3451       if (b)
3452         foo ();
3453       else
3454         bar ();
3455     @}
3456 @}
3457 @end group
3458 @end smallexample
3459
3460 Also warn for dangerous uses of the GNU extension to
3461 @code{?:} with omitted middle operand. When the condition
3462 in the @code{?}: operator is a boolean expression, the omitted value is
3463 always 1.  Often programmers expect it to be a value computed
3464 inside the conditional expression instead.
3465
3466 This warning is enabled by @option{-Wall}.
3467
3468 @item -Wsequence-point
3469 @opindex Wsequence-point
3470 @opindex Wno-sequence-point
3471 Warn about code that may have undefined semantics because of violations
3472 of sequence point rules in the C and C++ standards.
3473
3474 The C and C++ standards defines the order in which expressions in a C/C++
3475 program are evaluated in terms of @dfn{sequence points}, which represent
3476 a partial ordering between the execution of parts of the program: those
3477 executed before the sequence point, and those executed after it.  These
3478 occur after the evaluation of a full expression (one which is not part
3479 of a larger expression), after the evaluation of the first operand of a
3480 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3481 function is called (but after the evaluation of its arguments and the
3482 expression denoting the called function), and in certain other places.
3483 Other than as expressed by the sequence point rules, the order of
3484 evaluation of subexpressions of an expression is not specified.  All
3485 these rules describe only a partial order rather than a total order,
3486 since, for example, if two functions are called within one expression
3487 with no sequence point between them, the order in which the functions
3488 are called is not specified.  However, the standards committee have
3489 ruled that function calls do not overlap.
3490
3491 It is not specified when between sequence points modifications to the
3492 values of objects take effect.  Programs whose behavior depends on this
3493 have undefined behavior; the C and C++ standards specify that ``Between
3494 the previous and next sequence point an object shall have its stored
3495 value modified at most once by the evaluation of an expression.
3496 Furthermore, the prior value shall be read only to determine the value
3497 to be stored.''.  If a program breaks these rules, the results on any
3498 particular implementation are entirely unpredictable.
3499
3500 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3501 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3502 diagnosed by this option, and it may give an occasional false positive
3503 result, but in general it has been found fairly effective at detecting
3504 this sort of problem in programs.
3505
3506 The standard is worded confusingly, therefore there is some debate
3507 over the precise meaning of the sequence point rules in subtle cases.
3508 Links to discussions of the problem, including proposed formal
3509 definitions, may be found on the GCC readings page, at
3510 @uref{http://gcc.gnu.org/@/readings.html}.
3511
3512 This warning is enabled by @option{-Wall} for C and C++.
3513
3514 @item -Wreturn-type
3515 @opindex Wreturn-type
3516 @opindex Wno-return-type
3517 Warn whenever a function is defined with a return-type that defaults
3518 to @code{int}.  Also warn about any @code{return} statement with no
3519 return-value in a function whose return-type is not @code{void}
3520 (falling off the end of the function body is considered returning
3521 without a value), and about a @code{return} statement with an
3522 expression in a function whose return-type is @code{void}.
3523
3524 For C++, a function without return type always produces a diagnostic
3525 message, even when @option{-Wno-return-type} is specified.  The only
3526 exceptions are @samp{main} and functions defined in system headers.
3527
3528 This warning is enabled by @option{-Wall}.
3529
3530 @item -Wswitch
3531 @opindex Wswitch
3532 @opindex Wno-switch
3533 Warn whenever a @code{switch} statement has an index of enumerated type
3534 and lacks a @code{case} for one or more of the named codes of that
3535 enumeration.  (The presence of a @code{default} label prevents this
3536 warning.)  @code{case} labels outside the enumeration range also
3537 provoke warnings when this option is used (even if there is a
3538 @code{default} label).
3539 This warning is enabled by @option{-Wall}.
3540
3541 @item -Wswitch-default
3542 @opindex Wswitch-default
3543 @opindex Wno-switch-default
3544 Warn whenever a @code{switch} statement does not have a @code{default}
3545 case.
3546
3547 @item -Wswitch-enum
3548 @opindex Wswitch-enum
3549 @opindex Wno-switch-enum
3550 Warn whenever a @code{switch} statement has an index of enumerated type
3551 and lacks a @code{case} for one or more of the named codes of that
3552 enumeration.  @code{case} labels outside the enumeration range also
3553 provoke warnings when this option is used.  The only difference
3554 between @option{-Wswitch} and this option is that this option gives a
3555 warning about an omitted enumeration code even if there is a
3556 @code{default} label.
3557
3558 @item -Wsync-nand @r{(C and C++ only)}
3559 @opindex Wsync-nand
3560 @opindex Wno-sync-nand
3561 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3562 built-in functions are used.  These functions changed semantics in GCC 4.4.
3563
3564 @item -Wtrigraphs
3565 @opindex Wtrigraphs
3566 @opindex Wno-trigraphs
3567 Warn if any trigraphs are encountered that might change the meaning of
3568 the program (trigraphs within comments are not warned about).
3569 This warning is enabled by @option{-Wall}.
3570
3571 @item -Wunused-but-set-parameter
3572 @opindex Wunused-but-set-parameter
3573 @opindex Wno-unused-but-set-parameter
3574 Warn whenever a function parameter is assigned to, but otherwise unused
3575 (aside from its declaration).
3576
3577 To suppress this warning use the @samp{unused} attribute
3578 (@pxref{Variable Attributes}).
3579
3580 This warning is also enabled by @option{-Wunused} together with
3581 @option{-Wextra}.
3582
3583 @item -Wunused-but-set-variable
3584 @opindex Wunused-but-set-variable
3585 @opindex Wno-unused-but-set-variable
3586 Warn whenever a local variable is assigned to, but otherwise unused
3587 (aside from its declaration).
3588 This warning is enabled by @option{-Wall}.
3589
3590 To suppress this warning use the @samp{unused} attribute
3591 (@pxref{Variable Attributes}).
3592
3593 This warning is also enabled by @option{-Wunused}, which is enabled
3594 by @option{-Wall}.
3595
3596 @item -Wunused-function
3597 @opindex Wunused-function
3598 @opindex Wno-unused-function
3599 Warn whenever a static function is declared but not defined or a
3600 non-inline static function is unused.
3601 This warning is enabled by @option{-Wall}.
3602
3603 @item -Wunused-label
3604 @opindex Wunused-label
3605 @opindex Wno-unused-label
3606 Warn whenever a label is declared but not used.
3607 This warning is enabled by @option{-Wall}.
3608
3609 To suppress this warning use the @samp{unused} attribute
3610 (@pxref{Variable Attributes}).
3611
3612 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3613 @opindex Wunused-local-typedefs
3614 Warn when a typedef locally defined in a function is not used.
3615 This warning is enabled by @option{-Wall}.
3616
3617 @item -Wunused-parameter
3618 @opindex Wunused-parameter
3619 @opindex Wno-unused-parameter
3620 Warn whenever a function parameter is unused aside from its declaration.
3621
3622 To suppress this warning use the @samp{unused} attribute
3623 (@pxref{Variable Attributes}).
3624
3625 @item -Wno-unused-result
3626 @opindex Wunused-result
3627 @opindex Wno-unused-result
3628 Do not warn if a caller of a function marked with attribute
3629 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3630 its return value. The default is @option{-Wunused-result}.
3631
3632 @item -Wunused-variable
3633 @opindex Wunused-variable
3634 @opindex Wno-unused-variable
3635 Warn whenever a local variable or non-constant static variable is unused
3636 aside from its declaration.
3637 This warning is enabled by @option{-Wall}.
3638
3639 To suppress this warning use the @samp{unused} attribute
3640 (@pxref{Variable Attributes}).
3641
3642 @item -Wunused-value
3643 @opindex Wunused-value
3644 @opindex Wno-unused-value
3645 Warn whenever a statement computes a result that is explicitly not
3646 used. To suppress this warning cast the unused expression to
3647 @samp{void}. This includes an expression-statement or the left-hand
3648 side of a comma expression that contains no side effects. For example,
3649 an expression such as @samp{x[i,j]} causes a warning, while
3650 @samp{x[(void)i,j]} does not.
3651
3652 This warning is enabled by @option{-Wall}.
3653
3654 @item -Wunused
3655 @opindex Wunused
3656 @opindex Wno-unused
3657 All the above @option{-Wunused} options combined.
3658
3659 In order to get a warning about an unused function parameter, you must
3660 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3661 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3662
3663 @item -Wuninitialized
3664 @opindex Wuninitialized
3665 @opindex Wno-uninitialized
3666 Warn if an automatic variable is used without first being initialized
3667 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3668 warn if a non-static reference or non-static @samp{const} member
3669 appears in a class without constructors.
3670
3671 If you want to warn about code that uses the uninitialized value of the
3672 variable in its own initializer, use the @option{-Winit-self} option.
3673
3674 These warnings occur for individual uninitialized or clobbered
3675 elements of structure, union or array variables as well as for
3676 variables that are uninitialized or clobbered as a whole.  They do
3677 not occur for variables or elements declared @code{volatile}.  Because
3678 these warnings depend on optimization, the exact variables or elements
3679 for which there are warnings depends on the precise optimization
3680 options and version of GCC used.
3681
3682 Note that there may be no warning about a variable that is used only
3683 to compute a value that itself is never used, because such
3684 computations may be deleted by data flow analysis before the warnings
3685 are printed.
3686
3687 @item -Wmaybe-uninitialized
3688 @opindex Wmaybe-uninitialized
3689 @opindex Wno-maybe-uninitialized
3690 For an automatic variable, if there exists a path from the function
3691 entry to a use of the variable that is initialized, but there exist
3692 some other paths for which the variable is not initialized, the compiler
3693 emits a warning if it cannot prove the uninitialized paths are not
3694 executed at run time. These warnings are made optional because GCC is
3695 not smart enough to see all the reasons why the code might be correct
3696 in spite of appearing to have an error.  Here is one example of how
3697 this can happen:
3698
3699 @smallexample
3700 @group
3701 @{
3702   int x;
3703   switch (y)
3704     @{
3705     case 1: x = 1;
3706       break;
3707     case 2: x = 4;
3708       break;
3709     case 3: x = 5;
3710     @}
3711   foo (x);
3712 @}
3713 @end group
3714 @end smallexample
3715
3716 @noindent
3717 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3718 always initialized, but GCC doesn't know this. To suppress the
3719 warning, you need to provide a default case with assert(0) or
3720 similar code.
3721
3722 @cindex @code{longjmp} warnings
3723 This option also warns when a non-volatile automatic variable might be
3724 changed by a call to @code{longjmp}.  These warnings as well are possible
3725 only in optimizing compilation.
3726
3727 The compiler sees only the calls to @code{setjmp}.  It cannot know
3728 where @code{longjmp} will be called; in fact, a signal handler could
3729 call it at any point in the code.  As a result, you may get a warning
3730 even when there is in fact no problem because @code{longjmp} cannot
3731 in fact be called at the place that would cause a problem.
3732
3733 Some spurious warnings can be avoided if you declare all the functions
3734 you use that never return as @code{noreturn}.  @xref{Function
3735 Attributes}.
3736
3737 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3738
3739 @item -Wunknown-pragmas
3740 @opindex Wunknown-pragmas
3741 @opindex Wno-unknown-pragmas
3742 @cindex warning for unknown pragmas
3743 @cindex unknown pragmas, warning
3744 @cindex pragmas, warning of unknown
3745 Warn when a @code{#pragma} directive is encountered that is not understood by 
3746 GCC@.  If this command-line option is used, warnings are even issued
3747 for unknown pragmas in system header files.  This is not the case if
3748 the warnings are only enabled by the @option{-Wall} command-line option.
3749
3750 @item -Wno-pragmas
3751 @opindex Wno-pragmas
3752 @opindex Wpragmas
3753 Do not warn about misuses of pragmas, such as incorrect parameters,
3754 invalid syntax, or conflicts between pragmas.  See also
3755 @option{-Wunknown-pragmas}.
3756
3757 @item -Wstrict-aliasing
3758 @opindex Wstrict-aliasing
3759 @opindex Wno-strict-aliasing
3760 This option is only active when @option{-fstrict-aliasing} is active.
3761 It warns about code that might break the strict aliasing rules that the
3762 compiler is using for optimization.  The warning does not catch all
3763 cases, but does attempt to catch the more common pitfalls.  It is
3764 included in @option{-Wall}.
3765 It is equivalent to @option{-Wstrict-aliasing=3}
3766
3767 @item -Wstrict-aliasing=n
3768 @opindex Wstrict-aliasing=n
3769 @opindex Wno-strict-aliasing=n
3770 This option is only active when @option{-fstrict-aliasing} is active.
3771 It warns about code that might break the strict aliasing rules that the
3772 compiler is using for optimization.
3773 Higher levels correspond to higher accuracy (fewer false positives).
3774 Higher levels also correspond to more effort, similar to the way @option{-O} 
3775 works.
3776 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
3777
3778 Level 1: Most aggressive, quick, least accurate.
3779 Possibly useful when higher levels
3780 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
3781 false negatives.  However, it has many false positives.
3782 Warns for all pointer conversions between possibly incompatible types,
3783 even if never dereferenced.  Runs in the front end only.
3784
3785 Level 2: Aggressive, quick, not too precise.
3786 May still have many false positives (not as many as level 1 though),
3787 and few false negatives (but possibly more than level 1).
3788 Unlike level 1, it only warns when an address is taken.  Warns about
3789 incomplete types.  Runs in the front end only.
3790
3791 Level 3 (default for @option{-Wstrict-aliasing}):
3792 Should have very few false positives and few false
3793 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3794 Takes care of the common pun+dereference pattern in the front end:
3795 @code{*(int*)&some_float}.
3796 If optimization is enabled, it also runs in the back end, where it deals
3797 with multiple statement cases using flow-sensitive points-to information.
3798 Only warns when the converted pointer is dereferenced.
3799 Does not warn about incomplete types.
3800
3801 @item -Wstrict-overflow
3802 @itemx -Wstrict-overflow=@var{n}
3803 @opindex Wstrict-overflow
3804 @opindex Wno-strict-overflow
3805 This option is only active when @option{-fstrict-overflow} is active.
3806 It warns about cases where the compiler optimizes based on the
3807 assumption that signed overflow does not occur.  Note that it does not
3808 warn about all cases where the code might overflow: it only warns
3809 about cases where the compiler implements some optimization.  Thus
3810 this warning depends on the optimization level.
3811
3812 An optimization that assumes that signed overflow does not occur is
3813 perfectly safe if the values of the variables involved are such that
3814 overflow never does, in fact, occur.  Therefore this warning can
3815 easily give a false positive: a warning about code that is not
3816 actually a problem.  To help focus on important issues, several
3817 warning levels are defined.  No warnings are issued for the use of
3818 undefined signed overflow when estimating how many iterations a loop
3819 requires, in particular when determining whether a loop will be
3820 executed at all.
3821
3822 @table @gcctabopt
3823 @item -Wstrict-overflow=1
3824 Warn about cases that are both questionable and easy to avoid.  For
3825 example,  with @option{-fstrict-overflow}, the compiler simplifies
3826 @code{x + 1 > x} to @code{1}.  This level of
3827 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3828 are not, and must be explicitly requested.
3829
3830 @item -Wstrict-overflow=2
3831 Also warn about other cases where a comparison is simplified to a
3832 constant.  For example: @code{abs (x) >= 0}.  This can only be
3833 simplified when @option{-fstrict-overflow} is in effect, because
3834 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3835 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3836 @option{-Wstrict-overflow=2}.
3837
3838 @item -Wstrict-overflow=3
3839 Also warn about other cases where a comparison is simplified.  For
3840 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
3841
3842 @item -Wstrict-overflow=4
3843 Also warn about other simplifications not covered by the above cases.
3844 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
3845
3846 @item -Wstrict-overflow=5
3847 Also warn about cases where the compiler reduces the magnitude of a
3848 constant involved in a comparison.  For example: @code{x + 2 > y} is
3849 simplified to @code{x + 1 >= y}.  This is reported only at the
3850 highest warning level because this simplification applies to many
3851 comparisons, so this warning level gives a very large number of
3852 false positives.
3853 @end table
3854
3855 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
3856 @opindex Wsuggest-attribute=
3857 @opindex Wno-suggest-attribute=
3858 Warn for cases where adding an attribute may be beneficial. The
3859 attributes currently supported are listed below.
3860
3861 @table @gcctabopt
3862 @item -Wsuggest-attribute=pure
3863 @itemx -Wsuggest-attribute=const
3864 @itemx -Wsuggest-attribute=noreturn
3865 @opindex Wsuggest-attribute=pure
3866 @opindex Wno-suggest-attribute=pure
3867 @opindex Wsuggest-attribute=const
3868 @opindex Wno-suggest-attribute=const
3869 @opindex Wsuggest-attribute=noreturn
3870 @opindex Wno-suggest-attribute=noreturn
3871
3872 Warn about functions that might be candidates for attributes
3873 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
3874 functions visible in other compilation units or (in the case of @code{pure} and
3875 @code{const}) if it cannot prove that the function returns normally. A function
3876 returns normally if it doesn't contain an infinite loop nor returns abnormally
3877 by throwing, calling @code{abort()} or trapping.  This analysis requires option
3878 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
3879 higher.  Higher optimization levels improve the accuracy of the analysis.
3880
3881 @item -Wsuggest-attribute=format
3882 @itemx -Wmissing-format-attribute
3883 @opindex Wsuggest-attribute=format
3884 @opindex Wmissing-format-attribute
3885 @opindex Wno-suggest-attribute=format
3886 @opindex Wno-missing-format-attribute
3887 @opindex Wformat
3888 @opindex Wno-format
3889
3890 Warn about function pointers that might be candidates for @code{format}
3891 attributes.  Note these are only possible candidates, not absolute ones.
3892 GCC guesses that function pointers with @code{format} attributes that
3893 are used in assignment, initialization, parameter passing or return
3894 statements should have a corresponding @code{format} attribute in the
3895 resulting type.  I.e.@: the left-hand side of the assignment or
3896 initialization, the type of the parameter variable, or the return type
3897 of the containing function respectively should also have a @code{format}
3898 attribute to avoid the warning.
3899
3900 GCC also warns about function definitions that might be
3901 candidates for @code{format} attributes.  Again, these are only
3902 possible candidates.  GCC guesses that @code{format} attributes
3903 might be appropriate for any function that calls a function like
3904 @code{vprintf} or @code{vscanf}, but this might not always be the
3905 case, and some functions for which @code{format} attributes are
3906 appropriate may not be detected.
3907 @end table
3908
3909 @item -Warray-bounds
3910 @opindex Wno-array-bounds
3911 @opindex Warray-bounds
3912 This option is only active when @option{-ftree-vrp} is active
3913 (default for @option{-O2} and above). It warns about subscripts to arrays
3914 that are always out of bounds. This warning is enabled by @option{-Wall}.
3915
3916 @item -Wno-div-by-zero
3917 @opindex Wno-div-by-zero
3918 @opindex Wdiv-by-zero
3919 Do not warn about compile-time integer division by zero.  Floating-point
3920 division by zero is not warned about, as it can be a legitimate way of
3921 obtaining infinities and NaNs.
3922
3923 @item -Wsystem-headers
3924 @opindex Wsystem-headers
3925 @opindex Wno-system-headers
3926 @cindex warnings from system headers
3927 @cindex system headers, warnings from
3928 Print warning messages for constructs found in system header files.
3929 Warnings from system headers are normally suppressed, on the assumption
3930 that they usually do not indicate real problems and would only make the
3931 compiler output harder to read.  Using this command-line option tells
3932 GCC to emit warnings from system headers as if they occurred in user
3933 code.  However, note that using @option{-Wall} in conjunction with this
3934 option does @emph{not} warn about unknown pragmas in system
3935 headers---for that, @option{-Wunknown-pragmas} must also be used.
3936
3937 @item -Wtrampolines
3938 @opindex Wtrampolines
3939 @opindex Wno-trampolines
3940  Warn about trampolines generated for pointers to nested functions.
3941
3942  A trampoline is a small piece of data or code that is created at run
3943  time on the stack when the address of a nested function is taken, and
3944  is used to call the nested function indirectly.  For some targets, it
3945  is made up of data only and thus requires no special treatment.  But,
3946  for most targets, it is made up of code and thus requires the stack
3947  to be made executable in order for the program to work properly.
3948
3949 @item -Wfloat-equal
3950 @opindex Wfloat-equal
3951 @opindex Wno-float-equal
3952 Warn if floating-point values are used in equality comparisons.
3953
3954 The idea behind this is that sometimes it is convenient (for the
3955 programmer) to consider floating-point values as approximations to
3956 infinitely precise real numbers.  If you are doing this, then you need
3957 to compute (by analyzing the code, or in some other way) the maximum or
3958 likely maximum error that the computation introduces, and allow for it
3959 when performing comparisons (and when producing output, but that's a
3960 different problem).  In particular, instead of testing for equality, you
3961 should check to see whether the two values have ranges that overlap; and
3962 this is done with the relational operators, so equality comparisons are
3963 probably mistaken.
3964
3965 @item -Wtraditional @r{(C and Objective-C only)}
3966 @opindex Wtraditional
3967 @opindex Wno-traditional
3968 Warn about certain constructs that behave differently in traditional and
3969 ISO C@.  Also warn about ISO C constructs that have no traditional C
3970 equivalent, and/or problematic constructs that should be avoided.
3971
3972 @itemize @bullet
3973 @item
3974 Macro parameters that appear within string literals in the macro body.
3975 In traditional C macro replacement takes place within string literals,
3976 but does not in ISO C@.
3977
3978 @item
3979 In traditional C, some preprocessor directives did not exist.
3980 Traditional preprocessors only considered a line to be a directive
3981 if the @samp{#} appeared in column 1 on the line.  Therefore
3982 @option{-Wtraditional} warns about directives that traditional C
3983 understands but ignores because the @samp{#} does not appear as the
3984 first character on the line.  It also suggests you hide directives like
3985 @samp{#pragma} not understood by traditional C by indenting them.  Some
3986 traditional implementations do not recognize @samp{#elif}, so this option
3987 suggests avoiding it altogether.
3988
3989 @item
3990 A function-like macro that appears without arguments.
3991
3992 @item
3993 The unary plus operator.
3994
3995 @item
3996 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
3997 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3998 constants.)  Note, these suffixes appear in macros defined in the system
3999 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4000 Use of these macros in user code might normally lead to spurious
4001 warnings, however GCC's integrated preprocessor has enough context to
4002 avoid warning in these cases.
4003
4004 @item
4005 A function declared external in one block and then used after the end of
4006 the block.
4007
4008 @item
4009 A @code{switch} statement has an operand of type @code{long}.
4010
4011 @item
4012 A non-@code{static} function declaration follows a @code{static} one.
4013 This construct is not accepted by some traditional C compilers.
4014
4015 @item
4016 The ISO type of an integer constant has a different width or
4017 signedness from its traditional type.  This warning is only issued if
4018 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4019 typically represent bit patterns, are not warned about.
4020
4021 @item
4022 Usage of ISO string concatenation is detected.
4023
4024 @item
4025 Initialization of automatic aggregates.
4026
4027 @item
4028 Identifier conflicts with labels.  Traditional C lacks a separate
4029 namespace for labels.
4030
4031 @item
4032 Initialization of unions.  If the initializer is zero, the warning is
4033 omitted.  This is done under the assumption that the zero initializer in
4034 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4035 initializer warnings and relies on default initialization to zero in the
4036 traditional C case.
4037
4038 @item
4039 Conversions by prototypes between fixed/floating-point values and vice
4040 versa.  The absence of these prototypes when compiling with traditional
4041 C causes serious problems.  This is a subset of the possible
4042 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4043
4044 @item
4045 Use of ISO C style function definitions.  This warning intentionally is
4046 @emph{not} issued for prototype declarations or variadic functions
4047 because these ISO C features appear in your code when using
4048 libiberty's traditional C compatibility macros, @code{PARAMS} and
4049 @code{VPARAMS}.  This warning is also bypassed for nested functions
4050 because that feature is already a GCC extension and thus not relevant to
4051 traditional C compatibility.
4052 @end itemize
4053
4054 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4055 @opindex Wtraditional-conversion
4056 @opindex Wno-traditional-conversion
4057 Warn if a prototype causes a type conversion that is different from what
4058 would happen to the same argument in the absence of a prototype.  This
4059 includes conversions of fixed point to floating and vice versa, and
4060 conversions changing the width or signedness of a fixed-point argument
4061 except when the same as the default promotion.
4062
4063 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4064 @opindex Wdeclaration-after-statement
4065 @opindex Wno-declaration-after-statement
4066 Warn when a declaration is found after a statement in a block.  This
4067 construct, known from C++, was introduced with ISO C99 and is by default
4068 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4069 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4070
4071 @item -Wundef
4072 @opindex Wundef
4073 @opindex Wno-undef
4074 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4075
4076 @item -Wno-endif-labels
4077 @opindex Wno-endif-labels
4078 @opindex Wendif-labels
4079 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4080
4081 @item -Wshadow
4082 @opindex Wshadow
4083 @opindex Wno-shadow
4084 Warn whenever a local variable or type declaration shadows another variable,
4085 parameter, type, or class member (in C++), or whenever a built-in function
4086 is shadowed. Note that in C++, the compiler warns if a local variable
4087 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4088
4089 @item -Wlarger-than=@var{len}
4090 @opindex Wlarger-than=@var{len}
4091 @opindex Wlarger-than-@var{len}
4092 Warn whenever an object of larger than @var{len} bytes is defined.
4093
4094 @item -Wframe-larger-than=@var{len}
4095 @opindex Wframe-larger-than
4096 Warn if the size of a function frame is larger than @var{len} bytes.
4097 The computation done to determine the stack frame size is approximate
4098 and not conservative.
4099 The actual requirements may be somewhat greater than @var{len}
4100 even if you do not get a warning.  In addition, any space allocated
4101 via @code{alloca}, variable-length arrays, or related constructs
4102 is not included by the compiler when determining
4103 whether or not to issue a warning.
4104
4105 @item -Wno-free-nonheap-object
4106 @opindex Wno-free-nonheap-object
4107 @opindex Wfree-nonheap-object
4108 Do not warn when attempting to free an object that was not allocated
4109 on the heap.
4110
4111 @item -Wstack-usage=@var{len}
4112 @opindex Wstack-usage
4113 Warn if the stack usage of a function might be larger than @var{len} bytes.
4114 The computation done to determine the stack usage is conservative.
4115 Any space allocated via @code{alloca}, variable-length arrays, or related
4116 constructs is included by the compiler when determining whether or not to
4117 issue a warning.
4118
4119 The message is in keeping with the output of @option{-fstack-usage}.
4120
4121 @itemize
4122 @item
4123 If the stack usage is fully static but exceeds the specified amount, it's:
4124
4125 @smallexample
4126   warning: stack usage is 1120 bytes
4127 @end smallexample
4128 @item
4129 If the stack usage is (partly) dynamic but bounded, it's:
4130
4131 @smallexample
4132   warning: stack usage might be 1648 bytes
4133 @end smallexample
4134 @item
4135 If the stack usage is (partly) dynamic and not bounded, it's:
4136
4137 @smallexample
4138   warning: stack usage might be unbounded
4139 @end smallexample
4140 @end itemize
4141
4142 @item -Wunsafe-loop-optimizations
4143 @opindex Wunsafe-loop-optimizations
4144 @opindex Wno-unsafe-loop-optimizations
4145 Warn if the loop cannot be optimized because the compiler cannot
4146 assume anything on the bounds of the loop indices.  With
4147 @option{-funsafe-loop-optimizations} warn if the compiler makes
4148 such assumptions.
4149
4150 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4151 @opindex Wno-pedantic-ms-format
4152 @opindex Wpedantic-ms-format
4153 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
4154 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
4155 depending on the MS runtime, when you are using the options @option{-Wformat}
4156 and @option{-Wpedantic} without gnu-extensions.
4157
4158 @item -Wpointer-arith
4159 @opindex Wpointer-arith
4160 @opindex Wno-pointer-arith
4161 Warn about anything that depends on the ``size of'' a function type or
4162 of @code{void}.  GNU C assigns these types a size of 1, for
4163 convenience in calculations with @code{void *} pointers and pointers
4164 to functions.  In C++, warn also when an arithmetic operation involves
4165 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4166
4167 @item -Wtype-limits
4168 @opindex Wtype-limits
4169 @opindex Wno-type-limits
4170 Warn if a comparison is always true or always false due to the limited
4171 range of the data type, but do not warn for constant expressions.  For
4172 example, warn if an unsigned variable is compared against zero with
4173 @samp{<} or @samp{>=}.  This warning is also enabled by
4174 @option{-Wextra}.
4175
4176 @item -Wbad-function-cast @r{(C and Objective-C only)}
4177 @opindex Wbad-function-cast
4178 @opindex Wno-bad-function-cast
4179 Warn whenever a function call is cast to a non-matching type.
4180 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4181
4182 @item -Wc++-compat @r{(C and Objective-C only)}
4183 Warn about ISO C constructs that are outside of the common subset of
4184 ISO C and ISO C++, e.g.@: request for implicit conversion from
4185 @code{void *} to a pointer to non-@code{void} type.
4186
4187 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4188 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4189 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4190 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4191 enabled by @option{-Wall}.
4192
4193 @item -Wcast-qual
4194 @opindex Wcast-qual
4195 @opindex Wno-cast-qual
4196 Warn whenever a pointer is cast so as to remove a type qualifier from
4197 the target type.  For example, warn if a @code{const char *} is cast
4198 to an ordinary @code{char *}.
4199
4200 Also warn when making a cast that introduces a type qualifier in an
4201 unsafe way.  For example, casting @code{char **} to @code{const char **}
4202 is unsafe, as in this example:
4203
4204 @smallexample
4205   /* p is char ** value.  */
4206   const char **q = (const char **) p;
4207   /* Assignment of readonly string to const char * is OK.  */
4208   *q = "string";
4209   /* Now char** pointer points to read-only memory.  */
4210   **p = 'b';
4211 @end smallexample
4212
4213 @item -Wcast-align
4214 @opindex Wcast-align
4215 @opindex Wno-cast-align
4216 Warn whenever a pointer is cast such that the required alignment of the
4217 target is increased.  For example, warn if a @code{char *} is cast to
4218 an @code{int *} on machines where integers can only be accessed at
4219 two- or four-byte boundaries.
4220
4221 @item -Wwrite-strings
4222 @opindex Wwrite-strings
4223 @opindex Wno-write-strings
4224 When compiling C, give string constants the type @code{const
4225 char[@var{length}]} so that copying the address of one into a
4226 non-@code{const} @code{char *} pointer produces a warning.  These
4227 warnings help you find at compile time code that can try to write
4228 into a string constant, but only if you have been very careful about
4229 using @code{const} in declarations and prototypes.  Otherwise, it is
4230 just a nuisance. This is why we did not make @option{-Wall} request
4231 these warnings.
4232
4233 When compiling C++, warn about the deprecated conversion from string
4234 literals to @code{char *}.  This warning is enabled by default for C++
4235 programs.
4236
4237 @item -Wclobbered
4238 @opindex Wclobbered
4239 @opindex Wno-clobbered
4240 Warn for variables that might be changed by @samp{longjmp} or
4241 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4242
4243 @item -Wconversion
4244 @opindex Wconversion
4245 @opindex Wno-conversion
4246 Warn for implicit conversions that may alter a value. This includes
4247 conversions between real and integer, like @code{abs (x)} when
4248 @code{x} is @code{double}; conversions between signed and unsigned,
4249 like @code{unsigned ui = -1}; and conversions to smaller types, like
4250 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4251 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4252 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4253 conversions between signed and unsigned integers can be disabled by
4254 using @option{-Wno-sign-conversion}.
4255
4256 For C++, also warn for confusing overload resolution for user-defined
4257 conversions; and conversions that never use a type conversion
4258 operator: conversions to @code{void}, the same type, a base class or a
4259 reference to them. Warnings about conversions between signed and
4260 unsigned integers are disabled by default in C++ unless
4261 @option{-Wsign-conversion} is explicitly enabled.
4262
4263 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4264 @opindex Wconversion-null
4265 @opindex Wno-conversion-null
4266 Do not warn for conversions between @code{NULL} and non-pointer
4267 types. @option{-Wconversion-null} is enabled by default.
4268
4269 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4270 @opindex Wzero-as-null-pointer-constant
4271 @opindex Wno-zero-as-null-pointer-constant
4272 Warn when a literal '0' is used as null pointer constant.  This can
4273 be useful to facilitate the conversion to @code{nullptr} in C++11.
4274
4275 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4276 @opindex Wuseless-cast
4277 @opindex Wno-useless-cast
4278 Warn when an expression is casted to its own type.
4279
4280 @item -Wempty-body
4281 @opindex Wempty-body
4282 @opindex Wno-empty-body
4283 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4284 while} statement.  This warning is also enabled by @option{-Wextra}.
4285
4286 @item -Wenum-compare
4287 @opindex Wenum-compare
4288 @opindex Wno-enum-compare
4289 Warn about a comparison between values of different enumerated types.
4290 In C++ enumeral mismatches in conditional expressions are also
4291 diagnosed and the warning is enabled by default.  In C this warning is 
4292 enabled by @option{-Wall}.
4293
4294 @item -Wjump-misses-init @r{(C, Objective-C only)}
4295 @opindex Wjump-misses-init
4296 @opindex Wno-jump-misses-init
4297 Warn if a @code{goto} statement or a @code{switch} statement jumps
4298 forward across the initialization of a variable, or jumps backward to a
4299 label after the variable has been initialized.  This only warns about
4300 variables that are initialized when they are declared.  This warning is
4301 only supported for C and Objective-C; in C++ this sort of branch is an
4302 error in any case.
4303
4304 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4305 can be disabled with the @option{-Wno-jump-misses-init} option.
4306
4307 @item -Wsign-compare
4308 @opindex Wsign-compare
4309 @opindex Wno-sign-compare
4310 @cindex warning for comparison of signed and unsigned values
4311 @cindex comparison of signed and unsigned values, warning
4312 @cindex signed and unsigned values, comparison warning
4313 Warn when a comparison between signed and unsigned values could produce
4314 an incorrect result when the signed value is converted to unsigned.
4315 This warning is also enabled by @option{-Wextra}; to get the other warnings
4316 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4317
4318 @item -Wsign-conversion
4319 @opindex Wsign-conversion
4320 @opindex Wno-sign-conversion
4321 Warn for implicit conversions that may change the sign of an integer
4322 value, like assigning a signed integer expression to an unsigned
4323 integer variable. An explicit cast silences the warning. In C, this
4324 option is enabled also by @option{-Wconversion}.
4325
4326 @item -Waddress
4327 @opindex Waddress
4328 @opindex Wno-address
4329 Warn about suspicious uses of memory addresses. These include using
4330 the address of a function in a conditional expression, such as
4331 @code{void func(void); if (func)}, and comparisons against the memory
4332 address of a string literal, such as @code{if (x == "abc")}.  Such
4333 uses typically indicate a programmer error: the address of a function
4334 always evaluates to true, so their use in a conditional usually
4335 indicate that the programmer forgot the parentheses in a function
4336 call; and comparisons against string literals result in unspecified
4337 behavior and are not portable in C, so they usually indicate that the
4338 programmer intended to use @code{strcmp}.  This warning is enabled by
4339 @option{-Wall}.
4340
4341 @item -Wlogical-op
4342 @opindex Wlogical-op
4343 @opindex Wno-logical-op
4344 Warn about suspicious uses of logical operators in expressions.
4345 This includes using logical operators in contexts where a
4346 bit-wise operator is likely to be expected.
4347
4348 @item -Waggregate-return
4349 @opindex Waggregate-return
4350 @opindex Wno-aggregate-return
4351 Warn if any functions that return structures or unions are defined or
4352 called.  (In languages where you can return an array, this also elicits
4353 a warning.)
4354
4355 @item -Wno-attributes
4356 @opindex Wno-attributes
4357 @opindex Wattributes
4358 Do not warn if an unexpected @code{__attribute__} is used, such as
4359 unrecognized attributes, function attributes applied to variables,
4360 etc.  This does not stop errors for incorrect use of supported
4361 attributes.
4362
4363 @item -Wno-builtin-macro-redefined
4364 @opindex Wno-builtin-macro-redefined
4365 @opindex Wbuiltin-macro-redefined
4366 Do not warn if certain built-in macros are redefined.  This suppresses
4367 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4368 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4369
4370 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4371 @opindex Wstrict-prototypes
4372 @opindex Wno-strict-prototypes
4373 Warn if a function is declared or defined without specifying the
4374 argument types.  (An old-style function definition is permitted without
4375 a warning if preceded by a declaration that specifies the argument
4376 types.)
4377
4378 @item -Wold-style-declaration @r{(C and Objective-C only)}
4379 @opindex Wold-style-declaration
4380 @opindex Wno-old-style-declaration
4381 Warn for obsolescent usages, according to the C Standard, in a
4382 declaration. For example, warn if storage-class specifiers like
4383 @code{static} are not the first things in a declaration.  This warning
4384 is also enabled by @option{-Wextra}.
4385
4386 @item -Wold-style-definition @r{(C and Objective-C only)}
4387 @opindex Wold-style-definition
4388 @opindex Wno-old-style-definition
4389 Warn if an old-style function definition is used.  A warning is given
4390 even if there is a previous prototype.
4391
4392 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4393 @opindex Wmissing-parameter-type
4394 @opindex Wno-missing-parameter-type
4395 A function parameter is declared without a type specifier in K&R-style
4396 functions:
4397
4398 @smallexample
4399 void foo(bar) @{ @}
4400 @end smallexample
4401
4402 This warning is also enabled by @option{-Wextra}.
4403
4404 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4405 @opindex Wmissing-prototypes
4406 @opindex Wno-missing-prototypes
4407 Warn if a global function is defined without a previous prototype
4408 declaration.  This warning is issued even if the definition itself
4409 provides a prototype.  Use this option to detect global functions
4410 that do not have a matching prototype declaration in a header file.
4411 This option is not valid for C++ because all function declarations
4412 provide prototypes and a non-matching declaration will declare an
4413 overload rather than conflict with an earlier declaration.
4414 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4415
4416 @item -Wmissing-declarations
4417 @opindex Wmissing-declarations
4418 @opindex Wno-missing-declarations
4419 Warn if a global function is defined without a previous declaration.
4420 Do so even if the definition itself provides a prototype.
4421 Use this option to detect global functions that are not declared in
4422 header files.  In C, no warnings are issued for functions with previous
4423 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4424 missing prototypes.  In C++, no warnings are issued for function templates,
4425 or for inline functions, or for functions in anonymous namespaces.
4426
4427 @item -Wmissing-field-initializers
4428 @opindex Wmissing-field-initializers
4429 @opindex Wno-missing-field-initializers
4430 @opindex W
4431 @opindex Wextra
4432 @opindex Wno-extra
4433 Warn if a structure's initializer has some fields missing.  For
4434 example, the following code causes such a warning, because
4435 @code{x.h} is implicitly zero:
4436
4437 @smallexample
4438 struct s @{ int f, g, h; @};
4439 struct s x = @{ 3, 4 @};
4440 @end smallexample
4441
4442 This option does not warn about designated initializers, so the following
4443 modification does not trigger a warning:
4444
4445 @smallexample
4446 struct s @{ int f, g, h; @};
4447 struct s x = @{ .f = 3, .g = 4 @};
4448 @end smallexample
4449
4450 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4451 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4452
4453 @item -Wno-multichar
4454 @opindex Wno-multichar
4455 @opindex Wmultichar
4456 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4457 Usually they indicate a typo in the user's code, as they have
4458 implementation-defined values, and should not be used in portable code.
4459
4460 @item -Wnormalized=<none|id|nfc|nfkc>
4461 @opindex Wnormalized=
4462 @cindex NFC
4463 @cindex NFKC
4464 @cindex character set, input normalization
4465 In ISO C and ISO C++, two identifiers are different if they are
4466 different sequences of characters.  However, sometimes when characters
4467 outside the basic ASCII character set are used, you can have two
4468 different character sequences that look the same.  To avoid confusion,
4469 the ISO 10646 standard sets out some @dfn{normalization rules} which
4470 when applied ensure that two sequences that look the same are turned into
4471 the same sequence.  GCC can warn you if you are using identifiers that
4472 have not been normalized; this option controls that warning.
4473
4474 There are four levels of warning supported by GCC@.  The default is
4475 @option{-Wnormalized=nfc}, which warns about any identifier that is
4476 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4477 recommended form for most uses.
4478
4479 Unfortunately, there are some characters allowed in identifiers by
4480 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4481 identifiers.  That is, there's no way to use these symbols in portable
4482 ISO C or C++ and have all your identifiers in NFC@.
4483 @option{-Wnormalized=id} suppresses the warning for these characters.
4484 It is hoped that future versions of the standards involved will correct
4485 this, which is why this option is not the default.
4486
4487 You can switch the warning off for all characters by writing
4488 @option{-Wnormalized=none}.  You should only do this if you
4489 are using some other normalization scheme (like ``D''), because
4490 otherwise you can easily create bugs that are literally impossible to see.
4491
4492 Some characters in ISO 10646 have distinct meanings but look identical
4493 in some fonts or display methodologies, especially once formatting has
4494 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4495 LETTER N'', displays just like a regular @code{n} that has been
4496 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4497 normalization scheme to convert all these into a standard form as
4498 well, and GCC warns if your code is not in NFKC if you use
4499 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4500 about every identifier that contains the letter O because it might be
4501 confused with the digit 0, and so is not the default, but may be
4502 useful as a local coding convention if the programming environment 
4503 cannot be fixed to display these characters distinctly.
4504
4505 @item -Wno-deprecated
4506 @opindex Wno-deprecated
4507 @opindex Wdeprecated
4508 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4509
4510 @item -Wno-deprecated-declarations
4511 @opindex Wno-deprecated-declarations
4512 @opindex Wdeprecated-declarations
4513 Do not warn about uses of functions (@pxref{Function Attributes}),
4514 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4515 Attributes}) marked as deprecated by using the @code{deprecated}
4516 attribute.
4517
4518 @item -Wno-overflow
4519 @opindex Wno-overflow
4520 @opindex Woverflow
4521 Do not warn about compile-time overflow in constant expressions.
4522
4523 @item -Woverride-init @r{(C and Objective-C only)}
4524 @opindex Woverride-init
4525 @opindex Wno-override-init
4526 @opindex W
4527 @opindex Wextra
4528 @opindex Wno-extra
4529 Warn if an initialized field without side effects is overridden when
4530 using designated initializers (@pxref{Designated Inits, , Designated
4531 Initializers}).
4532
4533 This warning is included in @option{-Wextra}.  To get other
4534 @option{-Wextra} warnings without this one, use @option{-Wextra
4535 -Wno-override-init}.
4536
4537 @item -Wpacked
4538 @opindex Wpacked
4539 @opindex Wno-packed
4540 Warn if a structure is given the packed attribute, but the packed
4541 attribute has no effect on the layout or size of the structure.
4542 Such structures may be mis-aligned for little benefit.  For
4543 instance, in this code, the variable @code{f.x} in @code{struct bar}
4544 is misaligned even though @code{struct bar} does not itself
4545 have the packed attribute:
4546
4547 @smallexample
4548 @group
4549 struct foo @{
4550   int x;
4551   char a, b, c, d;
4552 @} __attribute__((packed));
4553 struct bar @{
4554   char z;
4555   struct foo f;
4556 @};
4557 @end group
4558 @end smallexample
4559
4560 @item -Wpacked-bitfield-compat
4561 @opindex Wpacked-bitfield-compat
4562 @opindex Wno-packed-bitfield-compat
4563 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4564 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4565 the change can lead to differences in the structure layout.  GCC
4566 informs you when the offset of such a field has changed in GCC 4.4.
4567 For example there is no longer a 4-bit padding between field @code{a}
4568 and @code{b} in this structure:
4569
4570 @smallexample
4571 struct foo
4572 @{
4573   char a:4;
4574   char b:8;
4575 @} __attribute__ ((packed));
4576 @end smallexample
4577
4578 This warning is enabled by default.  Use
4579 @option{-Wno-packed-bitfield-compat} to disable this warning.
4580
4581 @item -Wpadded
4582 @opindex Wpadded
4583 @opindex Wno-padded
4584 Warn if padding is included in a structure, either to align an element
4585 of the structure or to align the whole structure.  Sometimes when this
4586 happens it is possible to rearrange the fields of the structure to
4587 reduce the padding and so make the structure smaller.
4588
4589 @item -Wredundant-decls
4590 @opindex Wredundant-decls
4591 @opindex Wno-redundant-decls
4592 Warn if anything is declared more than once in the same scope, even in
4593 cases where multiple declaration is valid and changes nothing.
4594
4595 @item -Wnested-externs @r{(C and Objective-C only)}
4596 @opindex Wnested-externs
4597 @opindex Wno-nested-externs
4598 Warn if an @code{extern} declaration is encountered within a function.
4599
4600 @item -Winline
4601 @opindex Winline
4602 @opindex Wno-inline
4603 Warn if a function that is declared as inline cannot be inlined.
4604 Even with this option, the compiler does not warn about failures to
4605 inline functions declared in system headers.
4606
4607 The compiler uses a variety of heuristics to determine whether or not
4608 to inline a function.  For example, the compiler takes into account
4609 the size of the function being inlined and the amount of inlining
4610 that has already been done in the current function.  Therefore,
4611 seemingly insignificant changes in the source program can cause the
4612 warnings produced by @option{-Winline} to appear or disappear.
4613
4614 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4615 @opindex Wno-invalid-offsetof
4616 @opindex Winvalid-offsetof
4617 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4618 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4619 to a non-POD type is undefined.  In existing C++ implementations,
4620 however, @samp{offsetof} typically gives meaningful results even when
4621 applied to certain kinds of non-POD types. (Such as a simple
4622 @samp{struct} that fails to be a POD type only by virtue of having a
4623 constructor.)  This flag is for users who are aware that they are
4624 writing nonportable code and who have deliberately chosen to ignore the
4625 warning about it.
4626
4627 The restrictions on @samp{offsetof} may be relaxed in a future version
4628 of the C++ standard.
4629
4630 @item -Wno-int-to-pointer-cast
4631 @opindex Wno-int-to-pointer-cast
4632 @opindex Wint-to-pointer-cast
4633 Suppress warnings from casts to pointer type of an integer of a
4634 different size. In C++, casting to a pointer type of smaller size is
4635 an error. @option{Wint-to-pointer-cast} is enabled by default.
4636
4637
4638 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4639 @opindex Wno-pointer-to-int-cast
4640 @opindex Wpointer-to-int-cast
4641 Suppress warnings from casts from a pointer to an integer type of a
4642 different size.
4643
4644 @item -Winvalid-pch
4645 @opindex Winvalid-pch
4646 @opindex Wno-invalid-pch
4647 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4648 the search path but can't be used.
4649
4650 @item -Wlong-long
4651 @opindex Wlong-long
4652 @opindex Wno-long-long
4653 Warn if @samp{long long} type is used.  This is enabled by either
4654 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4655 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4656
4657 @item -Wvariadic-macros
4658 @opindex Wvariadic-macros
4659 @opindex Wno-variadic-macros
4660 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4661 alternate syntax when in pedantic ISO C99 mode.  This is default.
4662 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4663
4664 @item -Wvarargs
4665 @opindex Wvarargs
4666 @opindex Wno-varargs
4667 Warn upon questionable usage of the macros used to handle variable
4668 arguments like @samp{va_start}.  This is default.  To inhibit the
4669 warning messages, use @option{-Wno-varargs}.
4670
4671 @item -Wvector-operation-performance
4672 @opindex Wvector-operation-performance
4673 @opindex Wno-vector-operation-performance
4674 Warn if vector operation is not implemented via SIMD capabilities of the
4675 architecture.  Mainly useful for the performance tuning.
4676 Vector operation can be implemented @code{piecewise}, which means that the
4677 scalar operation is performed on every vector element; 
4678 @code{in parallel}, which means that the vector operation is implemented
4679 using scalars of wider type, which normally is more performance efficient;
4680 and @code{as a single scalar}, which means that vector fits into a
4681 scalar type.
4682
4683 @item -Wvla
4684 @opindex Wvla
4685 @opindex Wno-vla
4686 Warn if variable length array is used in the code.
4687 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
4688 the variable length array.
4689
4690 @item -Wvolatile-register-var
4691 @opindex Wvolatile-register-var
4692 @opindex Wno-volatile-register-var
4693 Warn if a register variable is declared volatile.  The volatile
4694 modifier does not inhibit all optimizations that may eliminate reads
4695 and/or writes to register variables.  This warning is enabled by
4696 @option{-Wall}.
4697
4698 @item -Wdisabled-optimization
4699 @opindex Wdisabled-optimization
4700 @opindex Wno-disabled-optimization
4701 Warn if a requested optimization pass is disabled.  This warning does
4702 not generally indicate that there is anything wrong with your code; it
4703 merely indicates that GCC's optimizers are unable to handle the code
4704 effectively.  Often, the problem is that your code is too big or too
4705 complex; GCC refuses to optimize programs when the optimization
4706 itself is likely to take inordinate amounts of time.
4707
4708 @item -Wpointer-sign @r{(C and Objective-C only)}
4709 @opindex Wpointer-sign
4710 @opindex Wno-pointer-sign
4711 Warn for pointer argument passing or assignment with different signedness.
4712 This option is only supported for C and Objective-C@.  It is implied by
4713 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
4714 @option{-Wno-pointer-sign}.
4715
4716 @item -Wstack-protector
4717 @opindex Wstack-protector
4718 @opindex Wno-stack-protector
4719 This option is only active when @option{-fstack-protector} is active.  It
4720 warns about functions that are not protected against stack smashing.
4721
4722 @item -Wno-mudflap
4723 @opindex Wno-mudflap
4724 Suppress warnings about constructs that cannot be instrumented by
4725 @option{-fmudflap}.
4726
4727 @item -Woverlength-strings
4728 @opindex Woverlength-strings
4729 @opindex Wno-overlength-strings
4730 Warn about string constants that are longer than the ``minimum
4731 maximum'' length specified in the C standard.  Modern compilers
4732 generally allow string constants that are much longer than the
4733 standard's minimum limit, but very portable programs should avoid
4734 using longer strings.
4735
4736 The limit applies @emph{after} string constant concatenation, and does
4737 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4738 C99, it was raised to 4095.  C++98 does not specify a normative
4739 minimum maximum, so we do not diagnose overlength strings in C++@.
4740
4741 This option is implied by @option{-Wpedantic}, and can be disabled with
4742 @option{-Wno-overlength-strings}.
4743
4744 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4745 @opindex Wunsuffixed-float-constants
4746
4747 Issue a warning for any floating constant that does not have
4748 a suffix.  When used together with @option{-Wsystem-headers} it
4749 warns about such constants in system header files.  This can be useful
4750 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4751 from the decimal floating-point extension to C99.
4752 @end table
4753
4754 @node Debugging Options
4755 @section Options for Debugging Your Program or GCC
4756 @cindex options, debugging
4757 @cindex debugging information options
4758
4759 GCC has various special options that are used for debugging
4760 either your program or GCC:
4761
4762 @table @gcctabopt
4763 @item -g
4764 @opindex g
4765 Produce debugging information in the operating system's native format
4766 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4767 information.
4768
4769 On most systems that use stabs format, @option{-g} enables use of extra
4770 debugging information that only GDB can use; this extra information
4771 makes debugging work better in GDB but probably makes other debuggers
4772 crash or
4773 refuse to read the program.  If you want to control for certain whether
4774 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4775 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4776
4777 GCC allows you to use @option{-g} with
4778 @option{-O}.  The shortcuts taken by optimized code may occasionally
4779 produce surprising results: some variables you declared may not exist
4780 at all; flow of control may briefly move where you did not expect it;
4781 some statements may not be executed because they compute constant
4782 results or their values are already at hand; some statements may
4783 execute in different places because they have been moved out of loops.
4784
4785 Nevertheless it proves possible to debug optimized output.  This makes
4786 it reasonable to use the optimizer for programs that might have bugs.
4787
4788 The following options are useful when GCC is generated with the
4789 capability for more than one debugging format.
4790
4791 @item -ggdb
4792 @opindex ggdb
4793 Produce debugging information for use by GDB@.  This means to use the
4794 most expressive format available (DWARF 2, stabs, or the native format
4795 if neither of those are supported), including GDB extensions if at all
4796 possible.
4797
4798 @item -gpubnames
4799 @opindex gpubnames
4800 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
4801
4802 @item -gstabs
4803 @opindex gstabs
4804 Produce debugging information in stabs format (if that is supported),
4805 without GDB extensions.  This is the format used by DBX on most BSD
4806 systems.  On MIPS, Alpha and System V Release 4 systems this option
4807 produces stabs debugging output that is not understood by DBX or SDB@.
4808 On System V Release 4 systems this option requires the GNU assembler.
4809
4810 @item -feliminate-unused-debug-symbols
4811 @opindex feliminate-unused-debug-symbols
4812 Produce debugging information in stabs format (if that is supported),
4813 for only symbols that are actually used.
4814
4815 @item -femit-class-debug-always
4816 Instead of emitting debugging information for a C++ class in only one
4817 object file, emit it in all object files using the class.  This option
4818 should be used only with debuggers that are unable to handle the way GCC
4819 normally emits debugging information for classes because using this
4820 option increases the size of debugging information by as much as a
4821 factor of two.
4822
4823 @item -fdebug-types-section
4824 @opindex fdebug-types-section
4825 @opindex fno-debug-types-section
4826 When using DWARF Version 4 or higher, type DIEs can be put into
4827 their own @code{.debug_types} section instead of making them part of the
4828 @code{.debug_info} section.  It is more efficient to put them in a separate
4829 comdat sections since the linker can then remove duplicates.
4830 But not all DWARF consumers support @code{.debug_types} sections yet
4831 and on some objects @code{.debug_types} produces larger instead of smaller
4832 debugging information.
4833
4834 @item -gstabs+
4835 @opindex gstabs+
4836 Produce debugging information in stabs format (if that is supported),
4837 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4838 use of these extensions is likely to make other debuggers crash or
4839 refuse to read the program.
4840
4841 @item -gcoff
4842 @opindex gcoff
4843 Produce debugging information in COFF format (if that is supported).
4844 This is the format used by SDB on most System V systems prior to
4845 System V Release 4.
4846
4847 @item -gxcoff
4848 @opindex gxcoff
4849 Produce debugging information in XCOFF format (if that is supported).
4850 This is the format used by the DBX debugger on IBM RS/6000 systems.
4851
4852 @item -gxcoff+
4853 @opindex gxcoff+
4854 Produce debugging information in XCOFF format (if that is supported),
4855 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4856 use of these extensions is likely to make other debuggers crash or
4857 refuse to read the program, and may cause assemblers other than the GNU
4858 assembler (GAS) to fail with an error.
4859
4860 @item -gdwarf-@var{version}
4861 @opindex gdwarf-@var{version}
4862 Produce debugging information in DWARF format (if that is supported).
4863 The value of @var{version} may be either 2, 3 or 4; the default version
4864 for most targets is 4.
4865
4866 Note that with DWARF Version 2, some ports require and always
4867 use some non-conflicting DWARF 3 extensions in the unwind tables.
4868
4869 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4870 for maximum benefit.
4871
4872 @item -grecord-gcc-switches
4873 @opindex grecord-gcc-switches
4874 This switch causes the command-line options used to invoke the
4875 compiler that may affect code generation to be appended to the
4876 DW_AT_producer attribute in DWARF debugging information.  The options
4877 are concatenated with spaces separating them from each other and from
4878 the compiler version.  See also @option{-frecord-gcc-switches} for another
4879 way of storing compiler options into the object file.  This is the default.
4880
4881 @item -gno-record-gcc-switches
4882 @opindex gno-record-gcc-switches
4883 Disallow appending command-line options to the DW_AT_producer attribute
4884 in DWARF debugging information.
4885
4886 @item -gstrict-dwarf
4887 @opindex gstrict-dwarf
4888 Disallow using extensions of later DWARF standard version than selected
4889 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4890 DWARF extensions from later standard versions is allowed.
4891
4892 @item -gno-strict-dwarf
4893 @opindex gno-strict-dwarf
4894 Allow using extensions of later DWARF standard version than selected with
4895 @option{-gdwarf-@var{version}}.
4896
4897 @item -gvms
4898 @opindex gvms
4899 Produce debugging information in Alpha/VMS debug format (if that is
4900 supported).  This is the format used by DEBUG on Alpha/VMS systems.
4901
4902 @item -g@var{level}
4903 @itemx -ggdb@var{level}
4904 @itemx -gstabs@var{level}
4905 @itemx -gcoff@var{level}
4906 @itemx -gxcoff@var{level}
4907 @itemx -gvms@var{level}
4908 Request debugging information and also use @var{level} to specify how
4909 much information.  The default level is 2.
4910
4911 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4912 @option{-g}.
4913
4914 Level 1 produces minimal information, enough for making backtraces in
4915 parts of the program that you don't plan to debug.  This includes
4916 descriptions of functions and external variables, but no information
4917 about local variables and no line numbers.
4918
4919 Level 3 includes extra information, such as all the macro definitions
4920 present in the program.  Some debuggers support macro expansion when
4921 you use @option{-g3}.
4922
4923 @option{-gdwarf-2} does not accept a concatenated debug level, because
4924 GCC used to support an option @option{-gdwarf} that meant to generate
4925 debug information in version 1 of the DWARF format (which is very
4926 different from version 2), and it would have been too confusing.  That
4927 debug format is long obsolete, but the option cannot be changed now.
4928 Instead use an additional @option{-g@var{level}} option to change the
4929 debug level for DWARF.
4930
4931 @item -gtoggle
4932 @opindex gtoggle
4933 Turn off generation of debug info, if leaving out this option
4934 generates it, or turn it on at level 2 otherwise.  The position of this
4935 argument in the command line does not matter; it takes effect after all
4936 other options are processed, and it does so only once, no matter how
4937 many times it is given.  This is mainly intended to be used with
4938 @option{-fcompare-debug}.
4939
4940 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4941 @opindex fdump-final-insns
4942 Dump the final internal representation (RTL) to @var{file}.  If the
4943 optional argument is omitted (or if @var{file} is @code{.}), the name
4944 of the dump file is determined by appending @code{.gkd} to the
4945 compilation output file name.
4946
4947 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4948 @opindex fcompare-debug
4949 @opindex fno-compare-debug
4950 If no error occurs during compilation, run the compiler a second time,
4951 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4952 passed to the second compilation.  Dump the final internal
4953 representation in both compilations, and print an error if they differ.
4954
4955 If the equal sign is omitted, the default @option{-gtoggle} is used.
4956
4957 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4958 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4959 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4960 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4961 is used.
4962
4963 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4964 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4965 of the final representation and the second compilation, preventing even
4966 @env{GCC_COMPARE_DEBUG} from taking effect.
4967
4968 To verify full coverage during @option{-fcompare-debug} testing, set
4969 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4970 which GCC rejects as an invalid option in any actual compilation
4971 (rather than preprocessing, assembly or linking).  To get just a
4972 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4973 not overridden} will do.
4974
4975 @item -fcompare-debug-second
4976 @opindex fcompare-debug-second
4977 This option is implicitly passed to the compiler for the second
4978 compilation requested by @option{-fcompare-debug}, along with options to
4979 silence warnings, and omitting other options that would cause
4980 side-effect compiler outputs to files or to the standard output.  Dump
4981 files and preserved temporary files are renamed so as to contain the
4982 @code{.gk} additional extension during the second compilation, to avoid
4983 overwriting those generated by the first.
4984
4985 When this option is passed to the compiler driver, it causes the
4986 @emph{first} compilation to be skipped, which makes it useful for little
4987 other than debugging the compiler proper.
4988
4989 @item -feliminate-dwarf2-dups
4990 @opindex feliminate-dwarf2-dups
4991 Compress DWARF 2 debugging information by eliminating duplicated
4992 information about each symbol.  This option only makes sense when
4993 generating DWARF 2 debugging information with @option{-gdwarf-2}.
4994
4995 @item -femit-struct-debug-baseonly
4996 Emit debug information for struct-like types
4997 only when the base name of the compilation source file
4998 matches the base name of file in which the struct is defined.
4999
5000 This option substantially reduces the size of debugging information,
5001 but at significant potential loss in type information to the debugger.
5002 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5003 See @option{-femit-struct-debug-detailed} for more detailed control.
5004
5005 This option works only with DWARF 2.
5006
5007 @item -femit-struct-debug-reduced
5008 Emit debug information for struct-like types
5009 only when the base name of the compilation source file
5010 matches the base name of file in which the type is defined,
5011 unless the struct is a template or defined in a system header.
5012
5013 This option significantly reduces the size of debugging information,
5014 with some potential loss in type information to the debugger.
5015 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5016 See @option{-femit-struct-debug-detailed} for more detailed control.
5017
5018 This option works only with DWARF 2.
5019
5020 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5021 Specify the struct-like types
5022 for which the compiler generates debug information.
5023 The intent is to reduce duplicate struct debug information
5024 between different object files within the same program.
5025
5026 This option is a detailed version of
5027 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5028 which serves for most needs.
5029
5030 A specification has the syntax@*
5031 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5032
5033 The optional first word limits the specification to
5034 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5035 A struct type is used directly when it is the type of a variable, member.
5036 Indirect uses arise through pointers to structs.
5037 That is, when use of an incomplete struct is valid, the use is indirect.
5038 An example is
5039 @samp{struct one direct; struct two * indirect;}.
5040
5041 The optional second word limits the specification to
5042 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5043 Generic structs are a bit complicated to explain.
5044 For C++, these are non-explicit specializations of template classes,
5045 or non-template classes within the above.
5046 Other programming languages have generics,
5047 but @option{-femit-struct-debug-detailed} does not yet implement them.
5048
5049 The third word specifies the source files for those
5050 structs for which the compiler should emit debug information.
5051 The values @samp{none} and @samp{any} have the normal meaning.
5052 The value @samp{base} means that
5053 the base of name of the file in which the type declaration appears
5054 must match the base of the name of the main compilation file.
5055 In practice, this means that when compiling @file{foo.c}, debug information
5056 is generated for types declared in that file and @file{foo.h},
5057 but not other header files.
5058 The value @samp{sys} means those types satisfying @samp{base}
5059 or declared in system or compiler headers.
5060
5061 You may need to experiment to determine the best settings for your application.
5062
5063 The default is @option{-femit-struct-debug-detailed=all}.
5064
5065 This option works only with DWARF 2.
5066
5067 @item -fno-merge-debug-strings
5068 @opindex fmerge-debug-strings
5069 @opindex fno-merge-debug-strings
5070 Direct the linker to not merge together strings in the debugging
5071 information that are identical in different object files.  Merging is
5072 not supported by all assemblers or linkers.  Merging decreases the size
5073 of the debug information in the output file at the cost of increasing
5074 link processing time.  Merging is enabled by default.
5075
5076 @item -fdebug-prefix-map=@var{old}=@var{new}
5077 @opindex fdebug-prefix-map
5078 When compiling files in directory @file{@var{old}}, record debugging
5079 information describing them as in @file{@var{new}} instead.
5080
5081 @item -fno-dwarf2-cfi-asm
5082 @opindex fdwarf2-cfi-asm
5083 @opindex fno-dwarf2-cfi-asm
5084 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5085 instead of using GAS @code{.cfi_*} directives.
5086
5087 @cindex @command{prof}
5088 @item -p
5089 @opindex p
5090 Generate extra code to write profile information suitable for the
5091 analysis program @command{prof}.  You must use this option when compiling
5092 the source files you want data about, and you must also use it when
5093 linking.
5094
5095 @cindex @command{gprof}
5096 @item -pg
5097 @opindex pg
5098 Generate extra code to write profile information suitable for the
5099 analysis program @command{gprof}.  You must use this option when compiling
5100 the source files you want data about, and you must also use it when
5101 linking.
5102
5103 @item -Q
5104 @opindex Q
5105 Makes the compiler print out each function name as it is compiled, and
5106 print some statistics about each pass when it finishes.
5107
5108 @item -ftime-report
5109 @opindex ftime-report
5110 Makes the compiler print some statistics about the time consumed by each
5111 pass when it finishes.
5112
5113 @item -fmem-report
5114 @opindex fmem-report
5115 Makes the compiler print some statistics about permanent memory
5116 allocation when it finishes.
5117
5118 @item -fpre-ipa-mem-report
5119 @opindex fpre-ipa-mem-report
5120 @item -fpost-ipa-mem-report
5121 @opindex fpost-ipa-mem-report
5122 Makes the compiler print some statistics about permanent memory
5123 allocation before or after interprocedural optimization.
5124
5125 @item -fstack-usage
5126 @opindex fstack-usage
5127 Makes the compiler output stack usage information for the program, on a
5128 per-function basis.  The filename for the dump is made by appending
5129 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5130 the output file, if explicitly specified and it is not an executable,
5131 otherwise it is the basename of the source file.  An entry is made up
5132 of three fields:
5133
5134 @itemize
5135 @item
5136 The name of the function.
5137 @item
5138 A number of bytes.
5139 @item
5140 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5141 @end itemize
5142
5143 The qualifier @code{static} means that the function manipulates the stack
5144 statically: a fixed number of bytes are allocated for the frame on function
5145 entry and released on function exit; no stack adjustments are otherwise made
5146 in the function.  The second field is this fixed number of bytes.
5147
5148 The qualifier @code{dynamic} means that the function manipulates the stack
5149 dynamically: in addition to the static allocation described above, stack
5150 adjustments are made in the body of the function, for example to push/pop
5151 arguments around function calls.  If the qualifier @code{bounded} is also
5152 present, the amount of these adjustments is bounded at compile time and
5153 the second field is an upper bound of the total amount of stack used by
5154 the function.  If it is not present, the amount of these adjustments is
5155 not bounded at compile time and the second field only represents the
5156 bounded part.
5157
5158 @item -fprofile-arcs
5159 @opindex fprofile-arcs
5160 Add code so that program flow @dfn{arcs} are instrumented.  During
5161 execution the program records how many times each branch and call is
5162 executed and how many times it is taken or returns.  When the compiled
5163 program exits it saves this data to a file called
5164 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5165 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5166 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5167 @var{auxname} is generated from the name of the output file, if
5168 explicitly specified and it is not the final executable, otherwise it is
5169 the basename of the source file.  In both cases any suffix is removed
5170 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5171 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5172 @xref{Cross-profiling}.
5173
5174 @cindex @command{gcov}
5175 @item --coverage
5176 @opindex coverage
5177
5178 This option is used to compile and link code instrumented for coverage
5179 analysis.  The option is a synonym for @option{-fprofile-arcs}
5180 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5181 linking).  See the documentation for those options for more details.
5182
5183 @itemize
5184
5185 @item
5186 Compile the source files with @option{-fprofile-arcs} plus optimization
5187 and code generation options.  For test coverage analysis, use the
5188 additional @option{-ftest-coverage} option.  You do not need to profile
5189 every source file in a program.
5190
5191 @item
5192 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5193 (the latter implies the former).
5194
5195 @item
5196 Run the program on a representative workload to generate the arc profile
5197 information.  This may be repeated any number of times.  You can run
5198 concurrent instances of your program, and provided that the file system
5199 supports locking, the data files will be correctly updated.  Also
5200 @code{fork} calls are detected and correctly handled (double counting
5201 will not happen).
5202
5203 @item
5204 For profile-directed optimizations, compile the source files again with
5205 the same optimization and code generation options plus
5206 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5207 Control Optimization}).
5208
5209 @item
5210 For test coverage analysis, use @command{gcov} to produce human readable
5211 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5212 @command{gcov} documentation for further information.
5213
5214 @end itemize
5215
5216 With @option{-fprofile-arcs}, for each function of your program GCC
5217 creates a program flow graph, then finds a spanning tree for the graph.
5218 Only arcs that are not on the spanning tree have to be instrumented: the
5219 compiler adds code to count the number of times that these arcs are
5220 executed.  When an arc is the only exit or only entrance to a block, the
5221 instrumentation code can be added to the block; otherwise, a new basic
5222 block must be created to hold the instrumentation code.
5223
5224 @need 2000
5225 @item -ftest-coverage
5226 @opindex ftest-coverage
5227 Produce a notes file that the @command{gcov} code-coverage utility
5228 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5229 show program coverage.  Each source file's note file is called
5230 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5231 above for a description of @var{auxname} and instructions on how to
5232 generate test coverage data.  Coverage data matches the source files
5233 more closely if you do not optimize.
5234
5235 @item -fdbg-cnt-list
5236 @opindex fdbg-cnt-list
5237 Print the name and the counter upper bound for all debug counters.
5238
5239
5240 @item -fdbg-cnt=@var{counter-value-list}
5241 @opindex fdbg-cnt
5242 Set the internal debug counter upper bound.  @var{counter-value-list}
5243 is a comma-separated list of @var{name}:@var{value} pairs
5244 which sets the upper bound of each debug counter @var{name} to @var{value}.
5245 All debug counters have the initial upper bound of @code{UINT_MAX};
5246 thus @code{dbg_cnt()} returns true always unless the upper bound
5247 is set by this option.
5248 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5249 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5250
5251 @itemx -fenable-@var{kind}-@var{pass}
5252 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5253 @opindex fdisable-
5254 @opindex fenable-
5255
5256 This is a set of options that are used to explicitly disable/enable
5257 optimization passes.  These options are intended for use for debugging GCC.
5258 Compiler users should use regular options for enabling/disabling
5259 passes instead.
5260
5261 @table @gcctabopt
5262
5263 @item -fdisable-ipa-@var{pass}
5264 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5265 statically invoked in the compiler multiple times, the pass name should be
5266 appended with a sequential number starting from 1.
5267
5268 @item -fdisable-rtl-@var{pass}
5269 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5270 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5271 statically invoked in the compiler multiple times, the pass name should be
5272 appended with a sequential number starting from 1.  @var{range-list} is a 
5273 comma-separated list of function ranges or assembler names.  Each range is a number
5274 pair separated by a colon.  The range is inclusive in both ends.  If the range
5275 is trivial, the number pair can be simplified as a single number.  If the
5276 function's cgraph node's @var{uid} falls within one of the specified ranges,
5277 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5278 function header of a dump file, and the pass names can be dumped by using
5279 option @option{-fdump-passes}.
5280
5281 @item -fdisable-tree-@var{pass}
5282 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5283 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5284 option arguments.
5285
5286 @item -fenable-ipa-@var{pass}
5287 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5288 statically invoked in the compiler multiple times, the pass name should be
5289 appended with a sequential number starting from 1.
5290
5291 @item -fenable-rtl-@var{pass}
5292 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5293 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5294 description and examples.
5295
5296 @item -fenable-tree-@var{pass}
5297 @itemx -fenable-tree-@var{pass}=@var{range-list}
5298 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5299 of option arguments.
5300
5301 @end table
5302
5303 Here are some examples showing uses of these options.
5304
5305 @smallexample
5306
5307 # disable ccp1 for all functions
5308    -fdisable-tree-ccp1
5309 # disable complete unroll for function whose cgraph node uid is 1
5310    -fenable-tree-cunroll=1
5311 # disable gcse2 for functions at the following ranges [1,1],
5312 # [300,400], and [400,1000]
5313 # disable gcse2 for functions foo and foo2
5314    -fdisable-rtl-gcse2=foo,foo2
5315 # disable early inlining
5316    -fdisable-tree-einline
5317 # disable ipa inlining
5318    -fdisable-ipa-inline
5319 # enable tree full unroll
5320    -fenable-tree-unroll
5321
5322 @end smallexample
5323
5324 @item -d@var{letters}
5325 @itemx -fdump-rtl-@var{pass}
5326 @opindex d
5327 Says to make debugging dumps during compilation at times specified by
5328 @var{letters}.  This is used for debugging the RTL-based passes of the
5329 compiler.  The file names for most of the dumps are made by appending
5330 a pass number and a word to the @var{dumpname}, and the files are
5331 created in the directory of the output file.  Note that the pass
5332 number is computed statically as passes get registered into the pass
5333 manager.  Thus the numbering is not related to the dynamic order of
5334 execution of passes.  In particular, a pass installed by a plugin
5335 could have a number over 200 even if it executed quite early.
5336 @var{dumpname} is generated from the name of the output file, if
5337 explicitly specified and it is not an executable, otherwise it is the
5338 basename of the source file. These switches may have different effects
5339 when @option{-E} is used for preprocessing.
5340
5341 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5342 @option{-d} option @var{letters}.  Here are the possible
5343 letters for use in @var{pass} and @var{letters}, and their meanings:
5344
5345 @table @gcctabopt
5346
5347 @item -fdump-rtl-alignments
5348 @opindex fdump-rtl-alignments
5349 Dump after branch alignments have been computed.
5350
5351 @item -fdump-rtl-asmcons
5352 @opindex fdump-rtl-asmcons
5353 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5354
5355 @item -fdump-rtl-auto_inc_dec
5356 @opindex fdump-rtl-auto_inc_dec
5357 Dump after auto-inc-dec discovery.  This pass is only run on
5358 architectures that have auto inc or auto dec instructions.
5359
5360 @item -fdump-rtl-barriers
5361 @opindex fdump-rtl-barriers
5362 Dump after cleaning up the barrier instructions.
5363
5364 @item -fdump-rtl-bbpart
5365 @opindex fdump-rtl-bbpart
5366 Dump after partitioning hot and cold basic blocks.
5367
5368 @item -fdump-rtl-bbro
5369 @opindex fdump-rtl-bbro
5370 Dump after block reordering.
5371
5372 @item -fdump-rtl-btl1
5373 @itemx -fdump-rtl-btl2
5374 @opindex fdump-rtl-btl2
5375 @opindex fdump-rtl-btl2
5376 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5377 after the two branch
5378 target load optimization passes.
5379
5380 @item -fdump-rtl-bypass
5381 @opindex fdump-rtl-bypass
5382 Dump after jump bypassing and control flow optimizations.
5383
5384 @item -fdump-rtl-combine
5385 @opindex fdump-rtl-combine
5386 Dump after the RTL instruction combination pass.
5387
5388 @item -fdump-rtl-compgotos
5389 @opindex fdump-rtl-compgotos
5390 Dump after duplicating the computed gotos.
5391
5392 @item -fdump-rtl-ce1
5393 @itemx -fdump-rtl-ce2
5394 @itemx -fdump-rtl-ce3
5395 @opindex fdump-rtl-ce1
5396 @opindex fdump-rtl-ce2
5397 @opindex fdump-rtl-ce3
5398 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5399 @option{-fdump-rtl-ce3} enable dumping after the three
5400 if conversion passes.
5401
5402 @itemx -fdump-rtl-cprop_hardreg
5403 @opindex fdump-rtl-cprop_hardreg
5404 Dump after hard register copy propagation.
5405
5406 @itemx -fdump-rtl-csa
5407 @opindex fdump-rtl-csa
5408 Dump after combining stack adjustments.
5409
5410 @item -fdump-rtl-cse1
5411 @itemx -fdump-rtl-cse2
5412 @opindex fdump-rtl-cse1
5413 @opindex fdump-rtl-cse2
5414 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5415 the two common sub-expression elimination passes.
5416
5417 @itemx -fdump-rtl-dce
5418 @opindex fdump-rtl-dce
5419 Dump after the standalone dead code elimination passes.
5420
5421 @itemx -fdump-rtl-dbr
5422 @opindex fdump-rtl-dbr
5423 Dump after delayed branch scheduling.
5424
5425 @item -fdump-rtl-dce1
5426 @itemx -fdump-rtl-dce2
5427 @opindex fdump-rtl-dce1
5428 @opindex fdump-rtl-dce2
5429 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5430 the two dead store elimination passes.
5431
5432 @item -fdump-rtl-eh
5433 @opindex fdump-rtl-eh
5434 Dump after finalization of EH handling code.
5435
5436 @item -fdump-rtl-eh_ranges
5437 @opindex fdump-rtl-eh_ranges
5438 Dump after conversion of EH handling range regions.
5439
5440 @item -fdump-rtl-expand
5441 @opindex fdump-rtl-expand
5442 Dump after RTL generation.
5443
5444 @item -fdump-rtl-fwprop1
5445 @itemx -fdump-rtl-fwprop2
5446 @opindex fdump-rtl-fwprop1
5447 @opindex fdump-rtl-fwprop2
5448 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5449 dumping after the two forward propagation passes.
5450
5451 @item -fdump-rtl-gcse1
5452 @itemx -fdump-rtl-gcse2
5453 @opindex fdump-rtl-gcse1
5454 @opindex fdump-rtl-gcse2
5455 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5456 after global common subexpression elimination.
5457
5458 @item -fdump-rtl-init-regs
5459 @opindex fdump-rtl-init-regs
5460 Dump after the initialization of the registers.
5461
5462 @item -fdump-rtl-initvals
5463 @opindex fdump-rtl-initvals
5464 Dump after the computation of the initial value sets.
5465
5466 @itemx -fdump-rtl-into_cfglayout
5467 @opindex fdump-rtl-into_cfglayout
5468 Dump after converting to cfglayout mode.
5469
5470 @item -fdump-rtl-ira
5471 @opindex fdump-rtl-ira
5472 Dump after iterated register allocation.
5473
5474 @item -fdump-rtl-jump
5475 @opindex fdump-rtl-jump
5476 Dump after the second jump optimization.
5477
5478 @item -fdump-rtl-loop2
5479 @opindex fdump-rtl-loop2
5480 @option{-fdump-rtl-loop2} enables dumping after the rtl
5481 loop optimization passes.
5482
5483 @item -fdump-rtl-mach
5484 @opindex fdump-rtl-mach
5485 Dump after performing the machine dependent reorganization pass, if that
5486 pass exists.
5487
5488 @item -fdump-rtl-mode_sw
5489 @opindex fdump-rtl-mode_sw
5490 Dump after removing redundant mode switches.
5491
5492 @item -fdump-rtl-rnreg
5493 @opindex fdump-rtl-rnreg
5494 Dump after register renumbering.
5495
5496 @itemx -fdump-rtl-outof_cfglayout
5497 @opindex fdump-rtl-outof_cfglayout
5498 Dump after converting from cfglayout mode.
5499
5500 @item -fdump-rtl-peephole2
5501 @opindex fdump-rtl-peephole2
5502 Dump after the peephole pass.
5503
5504 @item -fdump-rtl-postreload
5505 @opindex fdump-rtl-postreload
5506 Dump after post-reload optimizations.
5507
5508 @itemx -fdump-rtl-pro_and_epilogue
5509 @opindex fdump-rtl-pro_and_epilogue
5510 Dump after generating the function prologues and epilogues.
5511
5512 @item -fdump-rtl-regmove
5513 @opindex fdump-rtl-regmove
5514 Dump after the register move pass.
5515
5516 @item -fdump-rtl-sched1
5517 @itemx -fdump-rtl-sched2
5518 @opindex fdump-rtl-sched1
5519 @opindex fdump-rtl-sched2
5520 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5521 after the basic block scheduling passes.
5522
5523 @item -fdump-rtl-see
5524 @opindex fdump-rtl-see
5525 Dump after sign extension elimination.
5526
5527 @item -fdump-rtl-seqabstr
5528 @opindex fdump-rtl-seqabstr
5529 Dump after common sequence discovery.
5530
5531 @item -fdump-rtl-shorten
5532 @opindex fdump-rtl-shorten
5533 Dump after shortening branches.
5534
5535 @item -fdump-rtl-sibling
5536 @opindex fdump-rtl-sibling
5537 Dump after sibling call optimizations.
5538
5539 @item -fdump-rtl-split1
5540 @itemx -fdump-rtl-split2
5541 @itemx -fdump-rtl-split3
5542 @itemx -fdump-rtl-split4
5543 @itemx -fdump-rtl-split5
5544 @opindex fdump-rtl-split1
5545 @opindex fdump-rtl-split2
5546 @opindex fdump-rtl-split3
5547 @opindex fdump-rtl-split4
5548 @opindex fdump-rtl-split5
5549 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5550 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5551 @option{-fdump-rtl-split5} enable dumping after five rounds of
5552 instruction splitting.
5553
5554 @item -fdump-rtl-sms
5555 @opindex fdump-rtl-sms
5556 Dump after modulo scheduling.  This pass is only run on some
5557 architectures.
5558
5559 @item -fdump-rtl-stack
5560 @opindex fdump-rtl-stack
5561 Dump after conversion from GCC's ``flat register file'' registers to the
5562 x87's stack-like registers.  This pass is only run on x86 variants.
5563
5564 @item -fdump-rtl-subreg1
5565 @itemx -fdump-rtl-subreg2
5566 @opindex fdump-rtl-subreg1
5567 @opindex fdump-rtl-subreg2
5568 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5569 the two subreg expansion passes.
5570
5571 @item -fdump-rtl-unshare
5572 @opindex fdump-rtl-unshare
5573 Dump after all rtl has been unshared.
5574
5575 @item -fdump-rtl-vartrack
5576 @opindex fdump-rtl-vartrack
5577 Dump after variable tracking.
5578
5579 @item -fdump-rtl-vregs
5580 @opindex fdump-rtl-vregs
5581 Dump after converting virtual registers to hard registers.
5582
5583 @item -fdump-rtl-web
5584 @opindex fdump-rtl-web
5585 Dump after live range splitting.
5586
5587 @item -fdump-rtl-regclass
5588 @itemx -fdump-rtl-subregs_of_mode_init
5589 @itemx -fdump-rtl-subregs_of_mode_finish
5590 @itemx -fdump-rtl-dfinit
5591 @itemx -fdump-rtl-dfinish
5592 @opindex fdump-rtl-regclass
5593 @opindex fdump-rtl-subregs_of_mode_init
5594 @opindex fdump-rtl-subregs_of_mode_finish
5595 @opindex fdump-rtl-dfinit
5596 @opindex fdump-rtl-dfinish
5597 These dumps are defined but always produce empty files.
5598
5599 @item -fdump-rtl-all
5600 @opindex fdump-rtl-all
5601 Produce all the dumps listed above.
5602
5603 @item -dA
5604 @opindex dA
5605 Annotate the assembler output with miscellaneous debugging information.
5606
5607 @item -dD
5608 @opindex dD
5609 Dump all macro definitions, at the end of preprocessing, in addition to
5610 normal output.
5611
5612 @item -dH
5613 @opindex dH
5614 Produce a core dump whenever an error occurs.
5615
5616 @item -dm
5617 @opindex dm
5618 Print statistics on memory usage, at the end of the run, to
5619 standard error.
5620
5621 @item -dp
5622 @opindex dp
5623 Annotate the assembler output with a comment indicating which
5624 pattern and alternative is used.  The length of each instruction is
5625 also printed.
5626
5627 @item -dP
5628 @opindex dP
5629 Dump the RTL in the assembler output as a comment before each instruction.
5630 Also turns on @option{-dp} annotation.
5631
5632 @item -dv
5633 @opindex dv
5634 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5635 dump a representation of the control flow graph suitable for viewing with VCG
5636 to @file{@var{file}.@var{pass}.vcg}.
5637
5638 @item -dx
5639 @opindex dx
5640 Just generate RTL for a function instead of compiling it.  Usually used
5641 with @option{-fdump-rtl-expand}.
5642 @end table
5643
5644 @item -fdump-noaddr
5645 @opindex fdump-noaddr
5646 When doing debugging dumps, suppress address output.  This makes it more
5647 feasible to use diff on debugging dumps for compiler invocations with
5648 different compiler binaries and/or different
5649 text / bss / data / heap / stack / dso start locations.
5650
5651 @item -fdump-unnumbered
5652 @opindex fdump-unnumbered
5653 When doing debugging dumps, suppress instruction numbers and address output.
5654 This makes it more feasible to use diff on debugging dumps for compiler
5655 invocations with different options, in particular with and without
5656 @option{-g}.
5657
5658 @item -fdump-unnumbered-links
5659 @opindex fdump-unnumbered-links
5660 When doing debugging dumps (see @option{-d} option above), suppress
5661 instruction numbers for the links to the previous and next instructions
5662 in a sequence.
5663
5664 @item -fdump-translation-unit @r{(C++ only)}
5665 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5666 @opindex fdump-translation-unit
5667 Dump a representation of the tree structure for the entire translation
5668 unit to a file.  The file name is made by appending @file{.tu} to the
5669 source file name, and the file is created in the same directory as the
5670 output file.  If the @samp{-@var{options}} form is used, @var{options}
5671 controls the details of the dump as described for the
5672 @option{-fdump-tree} options.
5673
5674 @item -fdump-class-hierarchy @r{(C++ only)}
5675 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5676 @opindex fdump-class-hierarchy
5677 Dump a representation of each class's hierarchy and virtual function
5678 table layout to a file.  The file name is made by appending
5679 @file{.class} to the source file name, and the file is created in the
5680 same directory as the output file.  If the @samp{-@var{options}} form
5681 is used, @var{options} controls the details of the dump as described
5682 for the @option{-fdump-tree} options.
5683
5684 @item -fdump-ipa-@var{switch}
5685 @opindex fdump-ipa
5686 Control the dumping at various stages of inter-procedural analysis
5687 language tree to a file.  The file name is generated by appending a
5688 switch specific suffix to the source file name, and the file is created
5689 in the same directory as the output file.  The following dumps are
5690 possible:
5691
5692 @table @samp
5693 @item all
5694 Enables all inter-procedural analysis dumps.
5695
5696 @item cgraph
5697 Dumps information about call-graph optimization, unused function removal,
5698 and inlining decisions.
5699
5700 @item inline
5701 Dump after function inlining.
5702
5703 @end table
5704
5705 @item -fdump-passes
5706 @opindex fdump-passes
5707 Dump the list of optimization passes that are turned on and off by
5708 the current command-line options.
5709
5710 @item -fdump-statistics-@var{option}
5711 @opindex fdump-statistics
5712 Enable and control dumping of pass statistics in a separate file.  The
5713 file name is generated by appending a suffix ending in
5714 @samp{.statistics} to the source file name, and the file is created in
5715 the same directory as the output file.  If the @samp{-@var{option}}
5716 form is used, @samp{-stats} causes counters to be summed over the
5717 whole compilation unit while @samp{-details} dumps every event as
5718 the passes generate them.  The default with no option is to sum
5719 counters for each function compiled.
5720
5721 @item -fdump-tree-@var{switch}
5722 @itemx -fdump-tree-@var{switch}-@var{options}
5723 @opindex fdump-tree
5724 Control the dumping at various stages of processing the intermediate
5725 language tree to a file.  The file name is generated by appending a
5726 switch specific suffix to the source file name, and the file is
5727 created in the same directory as the output file.  If the
5728 @samp{-@var{options}} form is used, @var{options} is a list of
5729 @samp{-} separated options which control the details of the dump.  Not
5730 all options are applicable to all dumps; those that are not
5731 meaningful are ignored.  The following options are available
5732
5733 @table @samp
5734 @item address
5735 Print the address of each node.  Usually this is not meaningful as it
5736 changes according to the environment and source file.  Its primary use
5737 is for tying up a dump file with a debug environment.
5738 @item asmname
5739 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5740 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5741 use working backward from mangled names in the assembly file.
5742 @item slim
5743 Inhibit dumping of members of a scope or body of a function merely
5744 because that scope has been reached.  Only dump such items when they
5745 are directly reachable by some other path.  When dumping pretty-printed
5746 trees, this option inhibits dumping the bodies of control structures.
5747 @item raw
5748 Print a raw representation of the tree.  By default, trees are
5749 pretty-printed into a C-like representation.
5750 @item details
5751 Enable more detailed dumps (not honored by every dump option).
5752 @item stats
5753 Enable dumping various statistics about the pass (not honored by every dump
5754 option).
5755 @item blocks
5756 Enable showing basic block boundaries (disabled in raw dumps).
5757 @item vops
5758 Enable showing virtual operands for every statement.
5759 @item lineno
5760 Enable showing line numbers for statements.
5761 @item uid
5762 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5763 @item verbose
5764 Enable showing the tree dump for each statement.
5765 @item eh
5766 Enable showing the EH region number holding each statement.
5767 @item scev
5768 Enable showing scalar evolution analysis details.
5769 @item all
5770 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5771 and @option{lineno}.
5772 @end table
5773
5774 The following tree dumps are possible:
5775 @table @samp
5776
5777 @item original
5778 @opindex fdump-tree-original
5779 Dump before any tree based optimization, to @file{@var{file}.original}.
5780
5781 @item optimized
5782 @opindex fdump-tree-optimized
5783 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5784
5785 @item gimple
5786 @opindex fdump-tree-gimple
5787 Dump each function before and after the gimplification pass to a file.  The
5788 file name is made by appending @file{.gimple} to the source file name.
5789
5790 @item cfg
5791 @opindex fdump-tree-cfg
5792 Dump the control flow graph of each function to a file.  The file name is
5793 made by appending @file{.cfg} to the source file name.
5794
5795 @item vcg
5796 @opindex fdump-tree-vcg
5797 Dump the control flow graph of each function to a file in VCG format.  The
5798 file name is made by appending @file{.vcg} to the source file name.  Note
5799 that if the file contains more than one function, the generated file cannot
5800 be used directly by VCG@.  You must cut and paste each function's
5801 graph into its own separate file first.
5802
5803 @item ch
5804 @opindex fdump-tree-ch
5805 Dump each function after copying loop headers.  The file name is made by
5806 appending @file{.ch} to the source file name.
5807
5808 @item ssa
5809 @opindex fdump-tree-ssa
5810 Dump SSA related information to a file.  The file name is made by appending
5811 @file{.ssa} to the source file name.
5812
5813 @item alias
5814 @opindex fdump-tree-alias
5815 Dump aliasing information for each function.  The file name is made by
5816 appending @file{.alias} to the source file name.
5817
5818 @item ccp
5819 @opindex fdump-tree-ccp
5820 Dump each function after CCP@.  The file name is made by appending
5821 @file{.ccp} to the source file name.
5822
5823 @item storeccp
5824 @opindex fdump-tree-storeccp
5825 Dump each function after STORE-CCP@.  The file name is made by appending
5826 @file{.storeccp} to the source file name.
5827
5828 @item pre
5829 @opindex fdump-tree-pre
5830 Dump trees after partial redundancy elimination.  The file name is made
5831 by appending @file{.pre} to the source file name.
5832
5833 @item fre
5834 @opindex fdump-tree-fre
5835 Dump trees after full redundancy elimination.  The file name is made
5836 by appending @file{.fre} to the source file name.
5837
5838 @item copyprop
5839 @opindex fdump-tree-copyprop
5840 Dump trees after copy propagation.  The file name is made
5841 by appending @file{.copyprop} to the source file name.
5842
5843 @item store_copyprop
5844 @opindex fdump-tree-store_copyprop
5845 Dump trees after store copy-propagation.  The file name is made
5846 by appending @file{.store_copyprop} to the source file name.
5847
5848 @item dce
5849 @opindex fdump-tree-dce
5850 Dump each function after dead code elimination.  The file name is made by
5851 appending @file{.dce} to the source file name.
5852
5853 @item mudflap
5854 @opindex fdump-tree-mudflap
5855 Dump each function after adding mudflap instrumentation.  The file name is
5856 made by appending @file{.mudflap} to the source file name.
5857
5858 @item sra
5859 @opindex fdump-tree-sra
5860 Dump each function after performing scalar replacement of aggregates.  The
5861 file name is made by appending @file{.sra} to the source file name.
5862
5863 @item sink
5864 @opindex fdump-tree-sink
5865 Dump each function after performing code sinking.  The file name is made
5866 by appending @file{.sink} to the source file name.
5867
5868 @item dom
5869 @opindex fdump-tree-dom
5870 Dump each function after applying dominator tree optimizations.  The file
5871 name is made by appending @file{.dom} to the source file name.
5872
5873 @item dse
5874 @opindex fdump-tree-dse
5875 Dump each function after applying dead store elimination.  The file
5876 name is made by appending @file{.dse} to the source file name.
5877
5878 @item phiopt
5879 @opindex fdump-tree-phiopt
5880 Dump each function after optimizing PHI nodes into straightline code.  The file
5881 name is made by appending @file{.phiopt} to the source file name.
5882
5883 @item forwprop
5884 @opindex fdump-tree-forwprop
5885 Dump each function after forward propagating single use variables.  The file
5886 name is made by appending @file{.forwprop} to the source file name.
5887
5888 @item copyrename
5889 @opindex fdump-tree-copyrename
5890 Dump each function after applying the copy rename optimization.  The file
5891 name is made by appending @file{.copyrename} to the source file name.
5892
5893 @item nrv
5894 @opindex fdump-tree-nrv
5895 Dump each function after applying the named return value optimization on
5896 generic trees.  The file name is made by appending @file{.nrv} to the source
5897 file name.
5898
5899 @item vect
5900 @opindex fdump-tree-vect
5901 Dump each function after applying vectorization of loops.  The file name is
5902 made by appending @file{.vect} to the source file name.
5903
5904 @item slp
5905 @opindex fdump-tree-slp
5906 Dump each function after applying vectorization of basic blocks.  The file name
5907 is made by appending @file{.slp} to the source file name.
5908
5909 @item vrp
5910 @opindex fdump-tree-vrp
5911 Dump each function after Value Range Propagation (VRP).  The file name
5912 is made by appending @file{.vrp} to the source file name.
5913
5914 @item all
5915 @opindex fdump-tree-all
5916 Enable all the available tree dumps with the flags provided in this option.
5917 @end table
5918
5919 @item -ftree-vectorizer-verbose=@var{n}
5920 @opindex ftree-vectorizer-verbose
5921 This option controls the amount of debugging output the vectorizer prints.
5922 This information is written to standard error, unless
5923 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5924 in which case it is output to the usual dump listing file, @file{.vect}.
5925 For @var{n}=0 no diagnostic information is reported.
5926 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5927 and the total number of loops that got vectorized.
5928 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5929 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5930 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5931 level that @option{-fdump-tree-vect-stats} uses.
5932 Higher verbosity levels mean either more information dumped for each
5933 reported loop, or same amount of information reported for more loops:
5934 if @var{n}=3, vectorizer cost model information is reported.
5935 If @var{n}=4, alignment related information is added to the reports.
5936 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5937 memory access-patterns) is added to the reports.
5938 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5939 that did not pass the first analysis phase (i.e., may not be countable, or
5940 may have complicated control-flow).
5941 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5942 If @var{n}=8, SLP related information is added to the reports.
5943 For @var{n}=9, all the information the vectorizer generates during its
5944 analysis and transformation is reported.  This is the same verbosity level
5945 that @option{-fdump-tree-vect-details} uses.
5946
5947 @item -frandom-seed=@var{string}
5948 @opindex frandom-seed
5949 This option provides a seed that GCC uses in place of
5950 random numbers in generating certain symbol names
5951 that have to be different in every compiled file.  It is also used to
5952 place unique stamps in coverage data files and the object files that
5953 produce them.  You can use the @option{-frandom-seed} option to produce
5954 reproducibly identical object files.
5955
5956 The @var{string} should be different for every file you compile.
5957
5958 @item -fsched-verbose=@var{n}
5959 @opindex fsched-verbose
5960 On targets that use instruction scheduling, this option controls the
5961 amount of debugging output the scheduler prints.  This information is
5962 written to standard error, unless @option{-fdump-rtl-sched1} or
5963 @option{-fdump-rtl-sched2} is specified, in which case it is output
5964 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5965 respectively.  However for @var{n} greater than nine, the output is
5966 always printed to standard error.
5967
5968 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5969 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5970 For @var{n} greater than one, it also output basic block probabilities,
5971 detailed ready list information and unit/insn info.  For @var{n} greater
5972 than two, it includes RTL at abort point, control-flow and regions info.
5973 And for @var{n} over four, @option{-fsched-verbose} also includes
5974 dependence info.
5975
5976 @item -save-temps
5977 @itemx -save-temps=cwd
5978 @opindex save-temps
5979 Store the usual ``temporary'' intermediate files permanently; place them
5980 in the current directory and name them based on the source file.  Thus,
5981 compiling @file{foo.c} with @option{-c -save-temps} produces files
5982 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5983 preprocessed @file{foo.i} output file even though the compiler now
5984 normally uses an integrated preprocessor.
5985
5986 When used in combination with the @option{-x} command-line option,
5987 @option{-save-temps} is sensible enough to avoid over writing an
5988 input source file with the same extension as an intermediate file.
5989 The corresponding intermediate file may be obtained by renaming the
5990 source file before using @option{-save-temps}.
5991
5992 If you invoke GCC in parallel, compiling several different source
5993 files that share a common base name in different subdirectories or the
5994 same source file compiled for multiple output destinations, it is
5995 likely that the different parallel compilers will interfere with each
5996 other, and overwrite the temporary files.  For instance:
5997
5998 @smallexample
5999 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6000 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6001 @end smallexample
6002
6003 may result in @file{foo.i} and @file{foo.o} being written to
6004 simultaneously by both compilers.
6005
6006 @item -save-temps=obj
6007 @opindex save-temps=obj
6008 Store the usual ``temporary'' intermediate files permanently.  If the
6009 @option{-o} option is used, the temporary files are based on the
6010 object file.  If the @option{-o} option is not used, the
6011 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6012
6013 For example:
6014
6015 @smallexample
6016 gcc -save-temps=obj -c foo.c
6017 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6018 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6019 @end smallexample
6020
6021 @noindent
6022 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6023 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6024 @file{dir2/yfoobar.o}.
6025
6026 @item -time@r{[}=@var{file}@r{]}
6027 @opindex time
6028 Report the CPU time taken by each subprocess in the compilation
6029 sequence.  For C source files, this is the compiler proper and assembler
6030 (plus the linker if linking is done).
6031
6032 Without the specification of an output file, the output looks like this:
6033
6034 @smallexample
6035 # cc1 0.12 0.01
6036 # as 0.00 0.01
6037 @end smallexample
6038
6039 The first number on each line is the ``user time'', that is time spent
6040 executing the program itself.  The second number is ``system time'',
6041 time spent executing operating system routines on behalf of the program.
6042 Both numbers are in seconds.
6043
6044 With the specification of an output file, the output is appended to the
6045 named file, and it looks like this:
6046
6047 @smallexample
6048 0.12 0.01 cc1 @var{options}
6049 0.00 0.01 as @var{options}
6050 @end smallexample
6051
6052 The ``user time'' and the ``system time'' are moved before the program
6053 name, and the options passed to the program are displayed, so that one
6054 can later tell what file was being compiled, and with which options.
6055
6056 @item -fvar-tracking
6057 @opindex fvar-tracking
6058 Run variable tracking pass.  It computes where variables are stored at each
6059 position in code.  Better debugging information is then generated
6060 (if the debugging information format supports this information).
6061
6062 It is enabled by default when compiling with optimization (@option{-Os},
6063 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6064 the debug info format supports it.
6065
6066 @item -fvar-tracking-assignments
6067 @opindex fvar-tracking-assignments
6068 @opindex fno-var-tracking-assignments
6069 Annotate assignments to user variables early in the compilation and
6070 attempt to carry the annotations over throughout the compilation all the
6071 way to the end, in an attempt to improve debug information while
6072 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6073
6074 It can be enabled even if var-tracking is disabled, in which case
6075 annotations are created and maintained, but discarded at the end.
6076
6077 @item -fvar-tracking-assignments-toggle
6078 @opindex fvar-tracking-assignments-toggle
6079 @opindex fno-var-tracking-assignments-toggle
6080 Toggle @option{-fvar-tracking-assignments}, in the same way that
6081 @option{-gtoggle} toggles @option{-g}.
6082
6083 @item -print-file-name=@var{library}
6084 @opindex print-file-name
6085 Print the full absolute name of the library file @var{library} that
6086 would be used when linking---and don't do anything else.  With this
6087 option, GCC does not compile or link anything; it just prints the
6088 file name.
6089
6090 @item -print-multi-directory
6091 @opindex print-multi-directory
6092 Print the directory name corresponding to the multilib selected by any
6093 other switches present in the command line.  This directory is supposed
6094 to exist in @env{GCC_EXEC_PREFIX}.
6095
6096 @item -print-multi-lib
6097 @opindex print-multi-lib
6098 Print the mapping from multilib directory names to compiler switches
6099 that enable them.  The directory name is separated from the switches by
6100 @samp{;}, and each switch starts with an @samp{@@} instead of the
6101 @samp{-}, without spaces between multiple switches.  This is supposed to
6102 ease shell-processing.
6103
6104 @item -print-multi-os-directory
6105 @opindex print-multi-os-directory
6106 Print the path to OS libraries for the selected
6107 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6108 present in the @file{lib} subdirectory and no multilibs are used, this is
6109 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6110 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6111 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6112 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6113
6114 @item -print-prog-name=@var{program}
6115 @opindex print-prog-name
6116 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6117
6118 @item -print-libgcc-file-name
6119 @opindex print-libgcc-file-name
6120 Same as @option{-print-file-name=libgcc.a}.
6121
6122 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6123 but you do want to link with @file{libgcc.a}.  You can do
6124
6125 @smallexample
6126 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6127 @end smallexample
6128
6129 @item -print-search-dirs
6130 @opindex print-search-dirs
6131 Print the name of the configured installation directory and a list of
6132 program and library directories @command{gcc} searches---and don't do anything else.
6133
6134 This is useful when @command{gcc} prints the error message
6135 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6136 To resolve this you either need to put @file{cpp0} and the other compiler
6137 components where @command{gcc} expects to find them, or you can set the environment
6138 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6139 Don't forget the trailing @samp{/}.
6140 @xref{Environment Variables}.
6141
6142 @item -print-sysroot
6143 @opindex print-sysroot
6144 Print the target sysroot directory that is used during
6145 compilation.  This is the target sysroot specified either at configure
6146 time or using the @option{--sysroot} option, possibly with an extra
6147 suffix that depends on compilation options.  If no target sysroot is
6148 specified, the option prints nothing.
6149
6150 @item -print-sysroot-headers-suffix
6151 @opindex print-sysroot-headers-suffix
6152 Print the suffix added to the target sysroot when searching for
6153 headers, or give an error if the compiler is not configured with such
6154 a suffix---and don't do anything else.
6155
6156 @item -dumpmachine
6157 @opindex dumpmachine
6158 Print the compiler's target machine (for example,
6159 @samp{i686-pc-linux-gnu})---and don't do anything else.
6160
6161 @item -dumpversion
6162 @opindex dumpversion
6163 Print the compiler version (for example, @samp{3.0})---and don't do
6164 anything else.
6165
6166 @item -dumpspecs
6167 @opindex dumpspecs
6168 Print the compiler's built-in specs---and don't do anything else.  (This
6169 is used when GCC itself is being built.)  @xref{Spec Files}.
6170
6171 @item -feliminate-unused-debug-types
6172 @opindex feliminate-unused-debug-types
6173 Normally, when producing DWARF 2 output, GCC emits debugging
6174 information for all types declared in a compilation
6175 unit, regardless of whether or not they are actually used
6176 in that compilation unit.  Sometimes this is useful, such as
6177 if, in the debugger, you want to cast a value to a type that is
6178 not actually used in your program (but is declared).  More often,
6179 however, this results in a significant amount of wasted space.
6180 With this option, GCC avoids producing debug symbol output
6181 for types that are nowhere used in the source file being compiled.
6182 @end table
6183
6184 @node Optimize Options
6185 @section Options That Control Optimization
6186 @cindex optimize options
6187 @cindex options, optimization
6188
6189 These options control various sorts of optimizations.
6190
6191 Without any optimization option, the compiler's goal is to reduce the
6192 cost of compilation and to make debugging produce the expected
6193 results.  Statements are independent: if you stop the program with a
6194 breakpoint between statements, you can then assign a new value to any
6195 variable or change the program counter to any other statement in the
6196 function and get exactly the results you expect from the source
6197 code.
6198
6199 Turning on optimization flags makes the compiler attempt to improve
6200 the performance and/or code size at the expense of compilation time
6201 and possibly the ability to debug the program.
6202
6203 The compiler performs optimization based on the knowledge it has of the
6204 program.  Compiling multiple files at once to a single output file mode allows
6205 the compiler to use information gained from all of the files when compiling
6206 each of them.
6207
6208 Not all optimizations are controlled directly by a flag.  Only
6209 optimizations that have a flag are listed in this section.
6210
6211 Most optimizations are only enabled if an @option{-O} level is set on
6212 the command line.  Otherwise they are disabled, even if individual
6213 optimization flags are specified.
6214
6215 Depending on the target and how GCC was configured, a slightly different
6216 set of optimizations may be enabled at each @option{-O} level than
6217 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6218 to find out the exact set of optimizations that are enabled at each level.
6219 @xref{Overall Options}, for examples.
6220
6221 @table @gcctabopt
6222 @item -O
6223 @itemx -O1
6224 @opindex O
6225 @opindex O1
6226 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6227 more memory for a large function.
6228
6229 With @option{-O}, the compiler tries to reduce code size and execution
6230 time, without performing any optimizations that take a great deal of
6231 compilation time.
6232
6233 @option{-O} turns on the following optimization flags:
6234 @gccoptlist{
6235 -fauto-inc-dec @gol
6236 -fcompare-elim @gol
6237 -fcprop-registers @gol
6238 -fdce @gol
6239 -fdefer-pop @gol
6240 -fdelayed-branch @gol
6241 -fdse @gol
6242 -fguess-branch-probability @gol
6243 -fif-conversion2 @gol
6244 -fif-conversion @gol
6245 -fipa-pure-const @gol
6246 -fipa-profile @gol
6247 -fipa-reference @gol
6248 -fmerge-constants
6249 -fsplit-wide-types @gol
6250 -ftree-bit-ccp @gol
6251 -ftree-builtin-call-dce @gol
6252 -ftree-ccp @gol
6253 -ftree-ch @gol
6254 -ftree-copyrename @gol
6255 -ftree-dce @gol
6256 -ftree-dominator-opts @gol
6257 -ftree-dse @gol
6258 -ftree-forwprop @gol
6259 -ftree-fre @gol
6260 -ftree-phiprop @gol
6261 -ftree-sra @gol
6262 -ftree-pta @gol
6263 -ftree-ter @gol
6264 -funit-at-a-time}
6265
6266 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6267 where doing so does not interfere with debugging.
6268
6269 @item -O2
6270 @opindex O2
6271 Optimize even more.  GCC performs nearly all supported optimizations
6272 that do not involve a space-speed tradeoff.
6273 As compared to @option{-O}, this option increases both compilation time
6274 and the performance of the generated code.
6275
6276 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6277 also turns on the following optimization flags:
6278 @gccoptlist{-fthread-jumps @gol
6279 -falign-functions  -falign-jumps @gol
6280 -falign-loops  -falign-labels @gol
6281 -fcaller-saves @gol
6282 -fcrossjumping @gol
6283 -fcse-follow-jumps  -fcse-skip-blocks @gol
6284 -fdelete-null-pointer-checks @gol
6285 -fdevirtualize @gol
6286 -fexpensive-optimizations @gol
6287 -fgcse  -fgcse-lm  @gol
6288 -finline-small-functions @gol
6289 -findirect-inlining @gol
6290 -fipa-sra @gol
6291 -foptimize-sibling-calls @gol
6292 -fpartial-inlining @gol
6293 -fpeephole2 @gol
6294 -fregmove @gol
6295 -freorder-blocks  -freorder-functions @gol
6296 -frerun-cse-after-loop  @gol
6297 -fsched-interblock  -fsched-spec @gol
6298 -fschedule-insns  -fschedule-insns2 @gol
6299 -fstrict-aliasing -fstrict-overflow @gol
6300 -ftree-switch-conversion -ftree-tail-merge @gol
6301 -ftree-pre @gol
6302 -ftree-vrp}
6303
6304 Please note the warning under @option{-fgcse} about
6305 invoking @option{-O2} on programs that use computed gotos.
6306
6307 @item -O3
6308 @opindex O3
6309 Optimize yet more.  @option{-O3} turns on all optimizations specified
6310 by @option{-O2} and also turns on the @option{-finline-functions},
6311 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6312 @option{-fgcse-after-reload}, @option{-ftree-vectorize},
6313 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6314
6315 @item -O0
6316 @opindex O0
6317 Reduce compilation time and make debugging produce the expected
6318 results.  This is the default.
6319
6320 @item -Os
6321 @opindex Os
6322 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6323 do not typically increase code size.  It also performs further
6324 optimizations designed to reduce code size.
6325
6326 @option{-Os} disables the following optimization flags:
6327 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6328 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6329 -fprefetch-loop-arrays  -ftree-vect-loop-version}
6330
6331 @item -Ofast
6332 @opindex Ofast
6333 Disregard strict standards compliance.  @option{-Ofast} enables all
6334 @option{-O3} optimizations.  It also enables optimizations that are not
6335 valid for all standard compliant programs.
6336 It turns on @option{-ffast-math} and the Fortran-specific
6337 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6338
6339 If you use multiple @option{-O} options, with or without level numbers,
6340 the last such option is the one that is effective.
6341 @end table
6342
6343 Options of the form @option{-f@var{flag}} specify machine-independent
6344 flags.  Most flags have both positive and negative forms; the negative
6345 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6346 below, only one of the forms is listed---the one you typically 
6347 use.  You can figure out the other form by either removing @samp{no-}
6348 or adding it.
6349
6350 The following options control specific optimizations.  They are either
6351 activated by @option{-O} options or are related to ones that are.  You
6352 can use the following flags in the rare cases when ``fine-tuning'' of
6353 optimizations to be performed is desired.
6354
6355 @table @gcctabopt
6356 @item -fno-default-inline
6357 @opindex fno-default-inline
6358 Do not make member functions inline by default merely because they are
6359 defined inside the class scope (C++ only).  Otherwise, when you specify
6360 @w{@option{-O}}, member functions defined inside class scope are compiled
6361 inline by default; i.e., you don't need to add @samp{inline} in front of
6362 the member function name.
6363
6364 @item -fno-defer-pop
6365 @opindex fno-defer-pop
6366 Always pop the arguments to each function call as soon as that function
6367 returns.  For machines that must pop arguments after a function call,
6368 the compiler normally lets arguments accumulate on the stack for several
6369 function calls and pops them all at once.
6370
6371 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6372
6373 @item -fforward-propagate
6374 @opindex fforward-propagate
6375 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6376 instructions and checks if the result can be simplified.  If loop unrolling
6377 is active, two passes are performed and the second is scheduled after
6378 loop unrolling.
6379
6380 This option is enabled by default at optimization levels @option{-O},
6381 @option{-O2}, @option{-O3}, @option{-Os}.
6382
6383 @item -ffp-contract=@var{style}
6384 @opindex ffp-contract
6385 @option{-ffp-contract=off} disables floating-point expression contraction.
6386 @option{-ffp-contract=fast} enables floating-point expression contraction
6387 such as forming of fused multiply-add operations if the target has
6388 native support for them.
6389 @option{-ffp-contract=on} enables floating-point expression contraction
6390 if allowed by the language standard.  This is currently not implemented
6391 and treated equal to @option{-ffp-contract=off}.
6392
6393 The default is @option{-ffp-contract=fast}.
6394
6395 @item -fomit-frame-pointer
6396 @opindex fomit-frame-pointer
6397 Don't keep the frame pointer in a register for functions that
6398 don't need one.  This avoids the instructions to save, set up and
6399 restore frame pointers; it also makes an extra register available
6400 in many functions.  @strong{It also makes debugging impossible on
6401 some machines.}
6402
6403 On some machines, such as the VAX, this flag has no effect, because
6404 the standard calling sequence automatically handles the frame pointer
6405 and nothing is saved by pretending it doesn't exist.  The
6406 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
6407 whether a target machine supports this flag.  @xref{Registers,,Register
6408 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
6409
6410 Starting with GCC version 4.6, the default setting (when not optimizing for
6411 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
6412 @option{-fomit-frame-pointer}.  The default can be reverted to
6413 @option{-fno-omit-frame-pointer} by configuring GCC with the
6414 @option{--enable-frame-pointer} configure option.
6415
6416 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6417
6418 @item -foptimize-sibling-calls
6419 @opindex foptimize-sibling-calls
6420 Optimize sibling and tail recursive calls.
6421
6422 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6423
6424 @item -fno-inline
6425 @opindex fno-inline
6426 Do not expand any functions inline apart from those marked with
6427 the @code{always_inline} attribute.  This is the default when not
6428 optimizing.
6429
6430 Single functions can be exempted from inlining by marking them
6431 with the @code{noinline} attribute.
6432
6433 @item -finline-small-functions
6434 @opindex finline-small-functions
6435 Integrate functions into their callers when their body is smaller than expected
6436 function call code (so overall size of program gets smaller).  The compiler
6437 heuristically decides which functions are simple enough to be worth integrating
6438 in this way.  This inlining applies to all functions, even those not declared
6439 inline.
6440
6441 Enabled at level @option{-O2}.
6442
6443 @item -findirect-inlining
6444 @opindex findirect-inlining
6445 Inline also indirect calls that are discovered to be known at compile
6446 time thanks to previous inlining.  This option has any effect only
6447 when inlining itself is turned on by the @option{-finline-functions}
6448 or @option{-finline-small-functions} options.
6449
6450 Enabled at level @option{-O2}.
6451
6452 @item -finline-functions
6453 @opindex finline-functions
6454 Consider all functions for inlining, even if they are not declared inline.
6455 The compiler heuristically decides which functions are worth integrating
6456 in this way.
6457
6458 If all calls to a given function are integrated, and the function is
6459 declared @code{static}, then the function is normally not output as
6460 assembler code in its own right.
6461
6462 Enabled at level @option{-O3}.
6463
6464 @item -finline-functions-called-once
6465 @opindex finline-functions-called-once
6466 Consider all @code{static} functions called once for inlining into their
6467 caller even if they are not marked @code{inline}.  If a call to a given
6468 function is integrated, then the function is not output as assembler code
6469 in its own right.
6470
6471 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6472
6473 @item -fearly-inlining
6474 @opindex fearly-inlining
6475 Inline functions marked by @code{always_inline} and functions whose body seems
6476 smaller than the function call overhead early before doing
6477 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6478 makes profiling significantly cheaper and usually inlining faster on programs
6479 having large chains of nested wrapper functions.
6480
6481 Enabled by default.
6482
6483 @item -fipa-sra
6484 @opindex fipa-sra
6485 Perform interprocedural scalar replacement of aggregates, removal of
6486 unused parameters and replacement of parameters passed by reference
6487 by parameters passed by value.
6488
6489 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6490
6491 @item -finline-limit=@var{n}
6492 @opindex finline-limit
6493 By default, GCC limits the size of functions that can be inlined.  This flag
6494 allows coarse control of this limit.  @var{n} is the size of functions that
6495 can be inlined in number of pseudo instructions.
6496
6497 Inlining is actually controlled by a number of parameters, which may be
6498 specified individually by using @option{--param @var{name}=@var{value}}.
6499 The @option{-finline-limit=@var{n}} option sets some of these parameters
6500 as follows:
6501
6502 @table @gcctabopt
6503 @item max-inline-insns-single
6504 is set to @var{n}/2.
6505 @item max-inline-insns-auto
6506 is set to @var{n}/2.
6507 @end table
6508
6509 See below for a documentation of the individual
6510 parameters controlling inlining and for the defaults of these parameters.
6511
6512 @emph{Note:} there may be no value to @option{-finline-limit} that results
6513 in default behavior.
6514
6515 @emph{Note:} pseudo instruction represents, in this particular context, an
6516 abstract measurement of function's size.  In no way does it represent a count
6517 of assembly instructions and as such its exact meaning might change from one
6518 release to an another.
6519
6520 @item -fno-keep-inline-dllexport
6521 @opindex -fno-keep-inline-dllexport
6522 This is a more fine-grained version of @option{-fkeep-inline-functions},
6523 which applies only to functions that are declared using the @code{dllexport}
6524 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
6525 Functions}.)
6526
6527 @item -fkeep-inline-functions
6528 @opindex fkeep-inline-functions
6529 In C, emit @code{static} functions that are declared @code{inline}
6530 into the object file, even if the function has been inlined into all
6531 of its callers.  This switch does not affect functions using the
6532 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6533 inline functions into the object file.
6534
6535 @item -fkeep-static-consts
6536 @opindex fkeep-static-consts
6537 Emit variables declared @code{static const} when optimization isn't turned
6538 on, even if the variables aren't referenced.
6539
6540 GCC enables this option by default.  If you want to force the compiler to
6541 check if a variable is referenced, regardless of whether or not
6542 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6543
6544 @item -fmerge-constants
6545 @opindex fmerge-constants
6546 Attempt to merge identical constants (string constants and floating-point
6547 constants) across compilation units.
6548
6549 This option is the default for optimized compilation if the assembler and
6550 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6551 behavior.
6552
6553 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6554
6555 @item -fmerge-all-constants
6556 @opindex fmerge-all-constants
6557 Attempt to merge identical constants and identical variables.
6558
6559 This option implies @option{-fmerge-constants}.  In addition to
6560 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6561 arrays or initialized constant variables with integral or floating-point
6562 types.  Languages like C or C++ require each variable, including multiple
6563 instances of the same variable in recursive calls, to have distinct locations,
6564 so using this option results in non-conforming
6565 behavior.
6566
6567 @item -fmodulo-sched
6568 @opindex fmodulo-sched
6569 Perform swing modulo scheduling immediately before the first scheduling
6570 pass.  This pass looks at innermost loops and reorders their
6571 instructions by overlapping different iterations.
6572
6573 @item -fmodulo-sched-allow-regmoves
6574 @opindex fmodulo-sched-allow-regmoves
6575 Perform more aggressive SMS-based modulo scheduling with register moves
6576 allowed.  By setting this flag certain anti-dependences edges are
6577 deleted, which triggers the generation of reg-moves based on the
6578 life-range analysis.  This option is effective only with
6579 @option{-fmodulo-sched} enabled.
6580
6581 @item -fno-branch-count-reg
6582 @opindex fno-branch-count-reg
6583 Do not use ``decrement and branch'' instructions on a count register,
6584 but instead generate a sequence of instructions that decrement a
6585 register, compare it against zero, then branch based upon the result.
6586 This option is only meaningful on architectures that support such
6587 instructions, which include x86, PowerPC, IA-64 and S/390.
6588
6589 The default is @option{-fbranch-count-reg}.
6590
6591 @item -fno-function-cse
6592 @opindex fno-function-cse
6593 Do not put function addresses in registers; make each instruction that
6594 calls a constant function contain the function's address explicitly.
6595
6596 This option results in less efficient code, but some strange hacks
6597 that alter the assembler output may be confused by the optimizations
6598 performed when this option is not used.
6599
6600 The default is @option{-ffunction-cse}
6601
6602 @item -fno-zero-initialized-in-bss
6603 @opindex fno-zero-initialized-in-bss
6604 If the target supports a BSS section, GCC by default puts variables that
6605 are initialized to zero into BSS@.  This can save space in the resulting
6606 code.
6607
6608 This option turns off this behavior because some programs explicitly
6609 rely on variables going to the data section.  E.g., so that the
6610 resulting executable can find the beginning of that section and/or make
6611 assumptions based on that.
6612
6613 The default is @option{-fzero-initialized-in-bss}.
6614
6615 @item -fmudflap -fmudflapth -fmudflapir
6616 @opindex fmudflap
6617 @opindex fmudflapth
6618 @opindex fmudflapir
6619 @cindex bounds checking
6620 @cindex mudflap
6621 For front-ends that support it (C and C++), instrument all risky
6622 pointer/array dereferencing operations, some standard library
6623 string/heap functions, and some other associated constructs with
6624 range/validity tests.  Modules so instrumented should be immune to
6625 buffer overflows, invalid heap use, and some other classes of C/C++
6626 programming errors.  The instrumentation relies on a separate runtime
6627 library (@file{libmudflap}), which is linked into a program if
6628 @option{-fmudflap} is given at link time.  Run-time behavior of the
6629 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6630 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6631 for its options.
6632
6633 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6634 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6635 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6636 instrumentation should ignore pointer reads.  This produces less
6637 instrumentation (and therefore faster execution) and still provides
6638 some protection against outright memory corrupting writes, but allows
6639 erroneously read data to propagate within a program.
6640
6641 @item -fthread-jumps
6642 @opindex fthread-jumps
6643 Perform optimizations where we check to see if a jump branches to a
6644 location where another comparison subsumed by the first is found.  If
6645 so, the first branch is redirected to either the destination of the
6646 second branch or a point immediately following it, depending on whether
6647 the condition is known to be true or false.
6648
6649 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6650
6651 @item -fsplit-wide-types
6652 @opindex fsplit-wide-types
6653 When using a type that occupies multiple registers, such as @code{long
6654 long} on a 32-bit system, split the registers apart and allocate them
6655 independently.  This normally generates better code for those types,
6656 but may make debugging more difficult.
6657
6658 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6659 @option{-Os}.
6660
6661 @item -fcse-follow-jumps
6662 @opindex fcse-follow-jumps
6663 In common subexpression elimination (CSE), scan through jump instructions
6664 when the target of the jump is not reached by any other path.  For
6665 example, when CSE encounters an @code{if} statement with an
6666 @code{else} clause, CSE follows the jump when the condition
6667 tested is false.
6668
6669 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6670
6671 @item -fcse-skip-blocks
6672 @opindex fcse-skip-blocks
6673 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6674 follow jumps that conditionally skip over blocks.  When CSE
6675 encounters a simple @code{if} statement with no else clause,
6676 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6677 body of the @code{if}.
6678
6679 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6680
6681 @item -frerun-cse-after-loop
6682 @opindex frerun-cse-after-loop
6683 Re-run common subexpression elimination after loop optimizations are
6684 performed.
6685
6686 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6687
6688 @item -fgcse
6689 @opindex fgcse
6690 Perform a global common subexpression elimination pass.
6691 This pass also performs global constant and copy propagation.
6692
6693 @emph{Note:} When compiling a program using computed gotos, a GCC
6694 extension, you may get better run-time performance if you disable
6695 the global common subexpression elimination pass by adding
6696 @option{-fno-gcse} to the command line.
6697
6698 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6699
6700 @item -fgcse-lm
6701 @opindex fgcse-lm
6702 When @option{-fgcse-lm} is enabled, global common subexpression elimination
6703 attempts to move loads that are only killed by stores into themselves.  This
6704 allows a loop containing a load/store sequence to be changed to a load outside
6705 the loop, and a copy/store within the loop.
6706
6707 Enabled by default when @option{-fgcse} is enabled.
6708
6709 @item -fgcse-sm
6710 @opindex fgcse-sm
6711 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6712 global common subexpression elimination.  This pass attempts to move
6713 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6714 loops containing a load/store sequence can be changed to a load before
6715 the loop and a store after the loop.
6716
6717 Not enabled at any optimization level.
6718
6719 @item -fgcse-las
6720 @opindex fgcse-las
6721 When @option{-fgcse-las} is enabled, the global common subexpression
6722 elimination pass eliminates redundant loads that come after stores to the
6723 same memory location (both partial and full redundancies).
6724
6725 Not enabled at any optimization level.
6726
6727 @item -fgcse-after-reload
6728 @opindex fgcse-after-reload
6729 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6730 pass is performed after reload.  The purpose of this pass is to cleanup
6731 redundant spilling.
6732
6733 @item -funsafe-loop-optimizations
6734 @opindex funsafe-loop-optimizations
6735 If given, the loop optimizer assumes that loop indices do not
6736 overflow, and that the loops with nontrivial exit condition are not
6737 infinite.  This enables a wider range of loop optimizations even if
6738 the loop optimizer itself cannot prove that these assumptions are valid.
6739 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
6740 if it finds this kind of loop.
6741
6742 @item -fcrossjumping
6743 @opindex fcrossjumping
6744 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6745 resulting code may or may not perform better than without cross-jumping.
6746
6747 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6748
6749 @item -fauto-inc-dec
6750 @opindex fauto-inc-dec
6751 Combine increments or decrements of addresses with memory accesses.
6752 This pass is always skipped on architectures that do not have
6753 instructions to support this.  Enabled by default at @option{-O} and
6754 higher on architectures that support this.
6755
6756 @item -fdce
6757 @opindex fdce
6758 Perform dead code elimination (DCE) on RTL@.
6759 Enabled by default at @option{-O} and higher.
6760
6761 @item -fdse
6762 @opindex fdse
6763 Perform dead store elimination (DSE) on RTL@.
6764 Enabled by default at @option{-O} and higher.
6765
6766 @item -fif-conversion
6767 @opindex fif-conversion
6768 Attempt to transform conditional jumps into branch-less equivalents.  This
6769 include use of conditional moves, min, max, set flags and abs instructions, and
6770 some tricks doable by standard arithmetics.  The use of conditional execution
6771 on chips where it is available is controlled by @code{if-conversion2}.
6772
6773 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6774
6775 @item -fif-conversion2
6776 @opindex fif-conversion2
6777 Use conditional execution (where available) to transform conditional jumps into
6778 branch-less equivalents.
6779
6780 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6781
6782 @item -fdelete-null-pointer-checks
6783 @opindex fdelete-null-pointer-checks
6784 Assume that programs cannot safely dereference null pointers, and that
6785 no code or data element resides there.  This enables simple constant
6786 folding optimizations at all optimization levels.  In addition, other
6787 optimization passes in GCC use this flag to control global dataflow
6788 analyses that eliminate useless checks for null pointers; these assume
6789 that if a pointer is checked after it has already been dereferenced,
6790 it cannot be null.
6791
6792 Note however that in some environments this assumption is not true.
6793 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6794 for programs that depend on that behavior.
6795
6796 Some targets, especially embedded ones, disable this option at all levels.
6797 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6798 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6799 are enabled independently at different optimization levels.
6800
6801 @item -fdevirtualize
6802 @opindex fdevirtualize
6803 Attempt to convert calls to virtual functions to direct calls.  This
6804 is done both within a procedure and interprocedurally as part of
6805 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
6806 propagation (@option{-fipa-cp}).
6807 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6808
6809 @item -fexpensive-optimizations
6810 @opindex fexpensive-optimizations
6811 Perform a number of minor optimizations that are relatively expensive.
6812
6813 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6814
6815 @item -free
6816 @opindex free
6817 Attempt to remove redundant extension instructions.  This is especially
6818 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
6819 registers after writing to their lower 32-bit half.
6820
6821 Enabled for x86 at levels @option{-O2}, @option{-O3}.
6822
6823 @item -foptimize-register-move
6824 @itemx -fregmove
6825 @opindex foptimize-register-move
6826 @opindex fregmove
6827 Attempt to reassign register numbers in move instructions and as
6828 operands of other simple instructions in order to maximize the amount of
6829 register tying.  This is especially helpful on machines with two-operand
6830 instructions.
6831
6832 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6833 optimization.
6834
6835 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6836
6837 @item -fira-algorithm=@var{algorithm}
6838 Use the specified coloring algorithm for the integrated register
6839 allocator.  The @var{algorithm} argument can be @samp{priority}, which
6840 specifies Chow's priority coloring, or @samp{CB}, which specifies
6841 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
6842 for all architectures, but for those targets that do support it, it is
6843 the default because it generates better code.
6844
6845 @item -fira-region=@var{region}
6846 Use specified regions for the integrated register allocator.  The
6847 @var{region} argument should be one of the following:
6848
6849 @table @samp
6850
6851 @item all
6852 Use all loops as register allocation regions.
6853 This can give the best results for machines with a small and/or
6854 irregular register set.
6855
6856 @item mixed
6857 Use all loops except for loops with small register pressure 
6858 as the regions.  This value usually gives
6859 the best results in most cases and for most architectures,
6860 and is enabled by default when compiling with optimization for speed
6861 (@option{-O}, @option{-O2}, @dots{}).
6862
6863 @item one
6864 Use all functions as a single region.  
6865 This typically results in the smallest code size, and is enabled by default for
6866 @option{-Os} or @option{-O0}.
6867
6868 @end table
6869
6870 @item -fira-loop-pressure
6871 @opindex fira-loop-pressure
6872 Use IRA to evaluate register pressure in loops for decisions to move
6873 loop invariants.  This option usually results in generation
6874 of faster and smaller code on machines with large register files (>= 32
6875 registers), but it can slow the compiler down.
6876
6877 This option is enabled at level @option{-O3} for some targets.
6878
6879 @item -fno-ira-share-save-slots
6880 @opindex fno-ira-share-save-slots
6881 Disable sharing of stack slots used for saving call-used hard
6882 registers living through a call.  Each hard register gets a
6883 separate stack slot, and as a result function stack frames are
6884 larger.
6885
6886 @item -fno-ira-share-spill-slots
6887 @opindex fno-ira-share-spill-slots
6888 Disable sharing of stack slots allocated for pseudo-registers.  Each
6889 pseudo-register that does not get a hard register gets a separate
6890 stack slot, and as a result function stack frames are larger.
6891
6892 @item -fira-verbose=@var{n}
6893 @opindex fira-verbose
6894 Control the verbosity of the dump file for the integrated register allocator.
6895 The default value is 5.  If the value @var{n} is greater or equal to 10,
6896 the dump output is sent to stderr using the same format as @var{n} minus 10.
6897
6898 @item -fdelayed-branch
6899 @opindex fdelayed-branch
6900 If supported for the target machine, attempt to reorder instructions
6901 to exploit instruction slots available after delayed branch
6902 instructions.
6903
6904 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6905
6906 @item -fschedule-insns
6907 @opindex fschedule-insns
6908 If supported for the target machine, attempt to reorder instructions to
6909 eliminate execution stalls due to required data being unavailable.  This
6910 helps machines that have slow floating point or memory load instructions
6911 by allowing other instructions to be issued until the result of the load
6912 or floating-point instruction is required.
6913
6914 Enabled at levels @option{-O2}, @option{-O3}.
6915
6916 @item -fschedule-insns2
6917 @opindex fschedule-insns2
6918 Similar to @option{-fschedule-insns}, but requests an additional pass of
6919 instruction scheduling after register allocation has been done.  This is
6920 especially useful on machines with a relatively small number of
6921 registers and where memory load instructions take more than one cycle.
6922
6923 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6924
6925 @item -fno-sched-interblock
6926 @opindex fno-sched-interblock
6927 Don't schedule instructions across basic blocks.  This is normally
6928 enabled by default when scheduling before register allocation, i.e.@:
6929 with @option{-fschedule-insns} or at @option{-O2} or higher.
6930
6931 @item -fno-sched-spec
6932 @opindex fno-sched-spec
6933 Don't allow speculative motion of non-load instructions.  This is normally
6934 enabled by default when scheduling before register allocation, i.e.@:
6935 with @option{-fschedule-insns} or at @option{-O2} or higher.
6936
6937 @item -fsched-pressure
6938 @opindex fsched-pressure
6939 Enable register pressure sensitive insn scheduling before the register
6940 allocation.  This only makes sense when scheduling before register
6941 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6942 @option{-O2} or higher.  Usage of this option can improve the
6943 generated code and decrease its size by preventing register pressure
6944 increase above the number of available hard registers and as a
6945 consequence register spills in the register allocation.
6946
6947 @item -fsched-spec-load
6948 @opindex fsched-spec-load
6949 Allow speculative motion of some load instructions.  This only makes
6950 sense when scheduling before register allocation, i.e.@: with
6951 @option{-fschedule-insns} or at @option{-O2} or higher.
6952
6953 @item -fsched-spec-load-dangerous
6954 @opindex fsched-spec-load-dangerous
6955 Allow speculative motion of more load instructions.  This only makes
6956 sense when scheduling before register allocation, i.e.@: with
6957 @option{-fschedule-insns} or at @option{-O2} or higher.
6958
6959 @item -fsched-stalled-insns
6960 @itemx -fsched-stalled-insns=@var{n}
6961 @opindex fsched-stalled-insns
6962 Define how many insns (if any) can be moved prematurely from the queue
6963 of stalled insns into the ready list during the second scheduling pass.
6964 @option{-fno-sched-stalled-insns} means that no insns are moved
6965 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6966 on how many queued insns can be moved prematurely.
6967 @option{-fsched-stalled-insns} without a value is equivalent to
6968 @option{-fsched-stalled-insns=1}.
6969
6970 @item -fsched-stalled-insns-dep
6971 @itemx -fsched-stalled-insns-dep=@var{n}
6972 @opindex fsched-stalled-insns-dep
6973 Define how many insn groups (cycles) are examined for a dependency
6974 on a stalled insn that is a candidate for premature removal from the queue
6975 of stalled insns.  This has an effect only during the second scheduling pass,
6976 and only if @option{-fsched-stalled-insns} is used.
6977 @option{-fno-sched-stalled-insns-dep} is equivalent to
6978 @option{-fsched-stalled-insns-dep=0}.
6979 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6980 @option{-fsched-stalled-insns-dep=1}.
6981
6982 @item -fsched2-use-superblocks
6983 @opindex fsched2-use-superblocks
6984 When scheduling after register allocation, do use superblock scheduling
6985 algorithm.  Superblock scheduling allows motion across basic block boundaries
6986 resulting on faster schedules.  This option is experimental, as not all machine
6987 descriptions used by GCC model the CPU closely enough to avoid unreliable
6988 results from the algorithm.
6989
6990 This only makes sense when scheduling after register allocation, i.e.@: with
6991 @option{-fschedule-insns2} or at @option{-O2} or higher.
6992
6993 @item -fsched-group-heuristic
6994 @opindex fsched-group-heuristic
6995 Enable the group heuristic in the scheduler.  This heuristic favors
6996 the instruction that belongs to a schedule group.  This is enabled
6997 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
6998 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6999
7000 @item -fsched-critical-path-heuristic
7001 @opindex fsched-critical-path-heuristic
7002 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7003 instructions on the critical path.  This is enabled by default when
7004 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7005 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7006
7007 @item -fsched-spec-insn-heuristic
7008 @opindex fsched-spec-insn-heuristic
7009 Enable the speculative instruction heuristic in the scheduler.  This
7010 heuristic favors speculative instructions with greater dependency weakness.
7011 This is enabled by default when scheduling is enabled, i.e.@:
7012 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7013 or at @option{-O2} or higher.
7014
7015 @item -fsched-rank-heuristic
7016 @opindex fsched-rank-heuristic
7017 Enable the rank heuristic in the scheduler.  This heuristic favors
7018 the instruction belonging to a basic block with greater size or frequency.
7019 This is enabled by default when scheduling is enabled, i.e.@:
7020 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7021 at @option{-O2} or higher.
7022
7023 @item -fsched-last-insn-heuristic
7024 @opindex fsched-last-insn-heuristic
7025 Enable the last-instruction heuristic in the scheduler.  This heuristic
7026 favors the instruction that is less dependent on the last instruction
7027 scheduled.  This is enabled by default when scheduling is enabled,
7028 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7029 at @option{-O2} or higher.
7030
7031 @item -fsched-dep-count-heuristic
7032 @opindex fsched-dep-count-heuristic
7033 Enable the dependent-count heuristic in the scheduler.  This heuristic
7034 favors the instruction that has more instructions depending on it.
7035 This is enabled by default when scheduling is enabled, i.e.@:
7036 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7037 at @option{-O2} or higher.
7038
7039 @item -freschedule-modulo-scheduled-loops
7040 @opindex freschedule-modulo-scheduled-loops
7041 The modulo scheduling comes before the traditional scheduling.  If a loop
7042 is modulo scheduled you may want to prevent the later scheduling passes
7043 from changing its schedule; use this option to control that.
7044
7045 @item -fselective-scheduling
7046 @opindex fselective-scheduling
7047 Schedule instructions using selective scheduling algorithm.  Selective
7048 scheduling runs instead of the first scheduler pass.
7049
7050 @item -fselective-scheduling2
7051 @opindex fselective-scheduling2
7052 Schedule instructions using selective scheduling algorithm.  Selective
7053 scheduling runs instead of the second scheduler pass.
7054
7055 @item -fsel-sched-pipelining
7056 @opindex fsel-sched-pipelining
7057 Enable software pipelining of innermost loops during selective scheduling.
7058 This option has no effect until one of @option{-fselective-scheduling} or
7059 @option{-fselective-scheduling2} is turned on.
7060
7061 @item -fsel-sched-pipelining-outer-loops
7062 @opindex fsel-sched-pipelining-outer-loops
7063 When pipelining loops during selective scheduling, also pipeline outer loops.
7064 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
7065
7066 @item -fshrink-wrap
7067 @opindex fshrink-wrap
7068 Emit function prologues only before parts of the function that need it,
7069 rather than at the top of the function.  This flag is enabled by default at
7070 @option{-O} and higher.
7071
7072 @item -fcaller-saves
7073 @opindex fcaller-saves
7074 Enable allocation of values to registers that are clobbered by
7075 function calls, by emitting extra instructions to save and restore the
7076 registers around such calls.  Such allocation is done only when it
7077 seems to result in better code.
7078
7079 This option is always enabled by default on certain machines, usually
7080 those which have no call-preserved registers to use instead.
7081
7082 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7083
7084 @item -fcombine-stack-adjustments
7085 @opindex fcombine-stack-adjustments
7086 Tracks stack adjustments (pushes and pops) and stack memory references
7087 and then tries to find ways to combine them.
7088
7089 Enabled by default at @option{-O1} and higher.
7090
7091 @item -fconserve-stack
7092 @opindex fconserve-stack
7093 Attempt to minimize stack usage.  The compiler attempts to use less
7094 stack space, even if that makes the program slower.  This option
7095 implies setting the @option{large-stack-frame} parameter to 100
7096 and the @option{large-stack-frame-growth} parameter to 400.
7097
7098 @item -ftree-reassoc
7099 @opindex ftree-reassoc
7100 Perform reassociation on trees.  This flag is enabled by default
7101 at @option{-O} and higher.
7102
7103 @item -ftree-pre
7104 @opindex ftree-pre
7105 Perform partial redundancy elimination (PRE) on trees.  This flag is
7106 enabled by default at @option{-O2} and @option{-O3}.
7107
7108 @item -ftree-partial-pre
7109 @opindex ftree-partial-pre
7110 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7111 enabled by default at @option{-O3}.
7112
7113 @item -ftree-forwprop
7114 @opindex ftree-forwprop
7115 Perform forward propagation on trees.  This flag is enabled by default
7116 at @option{-O} and higher.
7117
7118 @item -ftree-fre
7119 @opindex ftree-fre
7120 Perform full redundancy elimination (FRE) on trees.  The difference
7121 between FRE and PRE is that FRE only considers expressions
7122 that are computed on all paths leading to the redundant computation.
7123 This analysis is faster than PRE, though it exposes fewer redundancies.
7124 This flag is enabled by default at @option{-O} and higher.
7125
7126 @item -ftree-phiprop
7127 @opindex ftree-phiprop
7128 Perform hoisting of loads from conditional pointers on trees.  This
7129 pass is enabled by default at @option{-O} and higher.
7130
7131 @item -ftree-copy-prop
7132 @opindex ftree-copy-prop
7133 Perform copy propagation on trees.  This pass eliminates unnecessary
7134 copy operations.  This flag is enabled by default at @option{-O} and
7135 higher.
7136
7137 @item -fipa-pure-const
7138 @opindex fipa-pure-const
7139 Discover which functions are pure or constant.
7140 Enabled by default at @option{-O} and higher.
7141
7142 @item -fipa-reference
7143 @opindex fipa-reference
7144 Discover which static variables do not escape cannot escape the
7145 compilation unit.
7146 Enabled by default at @option{-O} and higher.
7147
7148 @item -fipa-pta
7149 @opindex fipa-pta
7150 Perform interprocedural pointer analysis and interprocedural modification
7151 and reference analysis.  This option can cause excessive memory and
7152 compile-time usage on large compilation units.  It is not enabled by
7153 default at any optimization level.
7154
7155 @item -fipa-profile
7156 @opindex fipa-profile
7157 Perform interprocedural profile propagation.  The functions called only from
7158 cold functions are marked as cold. Also functions executed once (such as
7159 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7160 functions and loop less parts of functions executed once are then optimized for
7161 size.
7162 Enabled by default at @option{-O} and higher.
7163
7164 @item -fipa-cp
7165 @opindex fipa-cp
7166 Perform interprocedural constant propagation.
7167 This optimization analyzes the program to determine when values passed
7168 to functions are constants and then optimizes accordingly.
7169 This optimization can substantially increase performance
7170 if the application has constants passed to functions.
7171 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7172
7173 @item -fipa-cp-clone
7174 @opindex fipa-cp-clone
7175 Perform function cloning to make interprocedural constant propagation stronger.
7176 When enabled, interprocedural constant propagation performs function cloning
7177 when externally visible function can be called with constant arguments.
7178 Because this optimization can create multiple copies of functions,
7179 it may significantly increase code size
7180 (see @option{--param ipcp-unit-growth=@var{value}}).
7181 This flag is enabled by default at @option{-O3}.
7182
7183 @item -fipa-matrix-reorg
7184 @opindex fipa-matrix-reorg
7185 Perform matrix flattening and transposing.
7186 Matrix flattening tries to replace an @math{m}-dimensional matrix
7187 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
7188 This reduces the level of indirection needed for accessing the elements
7189 of the matrix. The second optimization is matrix transposing, which
7190 attempts to change the order of the matrix's dimensions in order to
7191 improve cache locality.
7192 Both optimizations need the @option{-fwhole-program} flag.
7193 Transposing is enabled only if profiling information is available.
7194
7195 @item -ftree-sink
7196 @opindex ftree-sink
7197 Perform forward store motion  on trees.  This flag is
7198 enabled by default at @option{-O} and higher.
7199
7200 @item -ftree-bit-ccp
7201 @opindex ftree-bit-ccp
7202 Perform sparse conditional bit constant propagation on trees and propagate
7203 pointer alignment information.
7204 This pass only operates on local scalar variables and is enabled by default
7205 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7206
7207 @item -ftree-ccp
7208 @opindex ftree-ccp
7209 Perform sparse conditional constant propagation (CCP) on trees.  This
7210 pass only operates on local scalar variables and is enabled by default
7211 at @option{-O} and higher.
7212
7213 @item -ftree-switch-conversion
7214 Perform conversion of simple initializations in a switch to
7215 initializations from a scalar array.  This flag is enabled by default
7216 at @option{-O2} and higher.
7217
7218 @item -ftree-tail-merge
7219 Look for identical code sequences.  When found, replace one with a jump to the
7220 other.  This optimization is known as tail merging or cross jumping.  This flag
7221 is enabled by default at @option{-O2} and higher.  The compilation time
7222 in this pass can
7223 be limited using @option{max-tail-merge-comparisons} parameter and
7224 @option{max-tail-merge-iterations} parameter.
7225
7226 @item -ftree-dce
7227 @opindex ftree-dce
7228 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7229 default at @option{-O} and higher.
7230
7231 @item -ftree-builtin-call-dce
7232 @opindex ftree-builtin-call-dce
7233 Perform conditional dead code elimination (DCE) for calls to builtin functions
7234 that may set @code{errno} but are otherwise side-effect free.  This flag is
7235 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7236 specified.
7237
7238 @item -ftree-dominator-opts
7239 @opindex ftree-dominator-opts
7240 Perform a variety of simple scalar cleanups (constant/copy
7241 propagation, redundancy elimination, range propagation and expression
7242 simplification) based on a dominator tree traversal.  This also
7243 performs jump threading (to reduce jumps to jumps). This flag is
7244 enabled by default at @option{-O} and higher.
7245
7246 @item -ftree-dse
7247 @opindex ftree-dse
7248 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7249 a memory location that is later overwritten by another store without
7250 any intervening loads.  In this case the earlier store can be deleted.  This
7251 flag is enabled by default at @option{-O} and higher.
7252
7253 @item -ftree-ch
7254 @opindex ftree-ch
7255 Perform loop header copying on trees.  This is beneficial since it increases
7256 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7257 is enabled by default at @option{-O} and higher.  It is not enabled
7258 for @option{-Os}, since it usually increases code size.
7259
7260 @item -ftree-loop-optimize
7261 @opindex ftree-loop-optimize
7262 Perform loop optimizations on trees.  This flag is enabled by default
7263 at @option{-O} and higher.
7264
7265 @item -ftree-loop-linear
7266 @opindex ftree-loop-linear
7267 Perform loop interchange transformations on tree.  Same as
7268 @option{-floop-interchange}.  To use this code transformation, GCC has
7269 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7270 enable the Graphite loop transformation infrastructure.
7271
7272 @item -floop-interchange
7273 @opindex floop-interchange
7274 Perform loop interchange transformations on loops.  Interchanging two
7275 nested loops switches the inner and outer loops.  For example, given a
7276 loop like:
7277 @smallexample
7278 DO J = 1, M
7279   DO I = 1, N
7280     A(J, I) = A(J, I) * C
7281   ENDDO
7282 ENDDO
7283 @end smallexample
7284 loop interchange transforms the loop as if it were written:
7285 @smallexample
7286 DO I = 1, N
7287   DO J = 1, M
7288     A(J, I) = A(J, I) * C
7289   ENDDO
7290 ENDDO
7291 @end smallexample
7292 which can be beneficial when @code{N} is larger than the caches,
7293 because in Fortran, the elements of an array are stored in memory
7294 contiguously by column, and the original loop iterates over rows,
7295 potentially creating at each access a cache miss.  This optimization
7296 applies to all the languages supported by GCC and is not limited to
7297 Fortran.  To use this code transformation, GCC has to be configured
7298 with @option{--with-ppl} and @option{--with-cloog} to enable the
7299 Graphite loop transformation infrastructure.
7300
7301 @item -floop-strip-mine
7302 @opindex floop-strip-mine
7303 Perform loop strip mining transformations on loops.  Strip mining
7304 splits a loop into two nested loops.  The outer loop has strides
7305 equal to the strip size and the inner loop has strides of the
7306 original loop within a strip.  The strip length can be changed
7307 using the @option{loop-block-tile-size} parameter.  For example,
7308 given a loop like:
7309 @smallexample
7310 DO I = 1, N
7311   A(I) = A(I) + C
7312 ENDDO
7313 @end smallexample
7314 loop strip mining transforms the loop as if it were written:
7315 @smallexample
7316 DO II = 1, N, 51
7317   DO I = II, min (II + 50, N)
7318     A(I) = A(I) + C
7319   ENDDO
7320 ENDDO
7321 @end smallexample
7322 This optimization applies to all the languages supported by GCC and is
7323 not limited to Fortran.  To use this code transformation, GCC has to
7324 be configured with @option{--with-ppl} and @option{--with-cloog} to
7325 enable the Graphite loop transformation infrastructure.
7326
7327 @item -floop-block
7328 @opindex floop-block
7329 Perform loop blocking transformations on loops.  Blocking strip mines
7330 each loop in the loop nest such that the memory accesses of the
7331 element loops fit inside caches.  The strip length can be changed
7332 using the @option{loop-block-tile-size} parameter.  For example, given
7333 a loop like:
7334 @smallexample
7335 DO I = 1, N
7336   DO J = 1, M
7337     A(J, I) = B(I) + C(J)
7338   ENDDO
7339 ENDDO
7340 @end smallexample
7341 loop blocking transforms the loop as if it were written:
7342 @smallexample
7343 DO II = 1, N, 51
7344   DO JJ = 1, M, 51
7345     DO I = II, min (II + 50, N)
7346       DO J = JJ, min (JJ + 50, M)
7347         A(J, I) = B(I) + C(J)
7348       ENDDO
7349     ENDDO
7350   ENDDO
7351 ENDDO
7352 @end smallexample
7353 which can be beneficial when @code{M} is larger than the caches,
7354 because the innermost loop iterates over a smaller amount of data
7355 which can be kept in the caches.  This optimization applies to all the
7356 languages supported by GCC and is not limited to Fortran.  To use this
7357 code transformation, GCC has to be configured with @option{--with-ppl}
7358 and @option{--with-cloog} to enable the Graphite loop transformation
7359 infrastructure.
7360
7361 @item -fgraphite-identity
7362 @opindex fgraphite-identity
7363 Enable the identity transformation for graphite.  For every SCoP we generate
7364 the polyhedral representation and transform it back to gimple.  Using
7365 @option{-fgraphite-identity} we can check the costs or benefits of the
7366 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7367 are also performed by the code generator CLooG, like index splitting and
7368 dead code elimination in loops.
7369
7370 @item -floop-parallelize-all
7371 @opindex floop-parallelize-all
7372 Use the Graphite data dependence analysis to identify loops that can
7373 be parallelized.  Parallelize all the loops that can be analyzed to
7374 not contain loop carried dependences without checking that it is
7375 profitable to parallelize the loops.
7376
7377 @item -fcheck-data-deps
7378 @opindex fcheck-data-deps
7379 Compare the results of several data dependence analyzers.  This option
7380 is used for debugging the data dependence analyzers.
7381
7382 @item -ftree-loop-if-convert
7383 Attempt to transform conditional jumps in the innermost loops to
7384 branch-less equivalents.  The intent is to remove control-flow from
7385 the innermost loops in order to improve the ability of the
7386 vectorization pass to handle these loops.  This is enabled by default
7387 if vectorization is enabled.
7388
7389 @item -ftree-loop-if-convert-stores
7390 Attempt to also if-convert conditional jumps containing memory writes.
7391 This transformation can be unsafe for multi-threaded programs as it
7392 transforms conditional memory writes into unconditional memory writes.
7393 For example,
7394 @smallexample
7395 for (i = 0; i < N; i++)
7396   if (cond)
7397     A[i] = expr;
7398 @end smallexample
7399 is transformed to
7400 @smallexample
7401 for (i = 0; i < N; i++)
7402   A[i] = cond ? expr : A[i];
7403 @end smallexample
7404 potentially producing data races.
7405
7406 @item -ftree-loop-distribution
7407 Perform loop distribution.  This flag can improve cache performance on
7408 big loop bodies and allow further loop optimizations, like
7409 parallelization or vectorization, to take place.  For example, the loop
7410 @smallexample
7411 DO I = 1, N
7412   A(I) = B(I) + C
7413   D(I) = E(I) * F
7414 ENDDO
7415 @end smallexample
7416 is transformed to
7417 @smallexample
7418 DO I = 1, N
7419    A(I) = B(I) + C
7420 ENDDO
7421 DO I = 1, N
7422    D(I) = E(I) * F
7423 ENDDO
7424 @end smallexample
7425
7426 @item -ftree-loop-distribute-patterns
7427 Perform loop distribution of patterns that can be code generated with
7428 calls to a library.  This flag is enabled by default at @option{-O3}.
7429
7430 This pass distributes the initialization loops and generates a call to
7431 memset zero.  For example, the loop
7432 @smallexample
7433 DO I = 1, N
7434   A(I) = 0
7435   B(I) = A(I) + I
7436 ENDDO
7437 @end smallexample
7438 is transformed to
7439 @smallexample
7440 DO I = 1, N
7441    A(I) = 0
7442 ENDDO
7443 DO I = 1, N
7444    B(I) = A(I) + I
7445 ENDDO
7446 @end smallexample
7447 and the initialization loop is transformed into a call to memset zero.
7448
7449 @item -ftree-loop-im
7450 @opindex ftree-loop-im
7451 Perform loop invariant motion on trees.  This pass moves only invariants that
7452 are hard to handle at RTL level (function calls, operations that expand to
7453 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
7454 operands of conditions that are invariant out of the loop, so that we can use
7455 just trivial invariantness analysis in loop unswitching.  The pass also includes
7456 store motion.
7457
7458 @item -ftree-loop-ivcanon
7459 @opindex ftree-loop-ivcanon
7460 Create a canonical counter for number of iterations in loops for which
7461 determining number of iterations requires complicated analysis.  Later
7462 optimizations then may determine the number easily.  Useful especially
7463 in connection with unrolling.
7464
7465 @item -fivopts
7466 @opindex fivopts
7467 Perform induction variable optimizations (strength reduction, induction
7468 variable merging and induction variable elimination) on trees.
7469
7470 @item -ftree-parallelize-loops=n
7471 @opindex ftree-parallelize-loops
7472 Parallelize loops, i.e., split their iteration space to run in n threads.
7473 This is only possible for loops whose iterations are independent
7474 and can be arbitrarily reordered.  The optimization is only
7475 profitable on multiprocessor machines, for loops that are CPU-intensive,
7476 rather than constrained e.g.@: by memory bandwidth.  This option
7477 implies @option{-pthread}, and thus is only supported on targets
7478 that have support for @option{-pthread}.
7479
7480 @item -ftree-pta
7481 @opindex ftree-pta
7482 Perform function-local points-to analysis on trees.  This flag is
7483 enabled by default at @option{-O} and higher.
7484
7485 @item -ftree-sra
7486 @opindex ftree-sra
7487 Perform scalar replacement of aggregates.  This pass replaces structure
7488 references with scalars to prevent committing structures to memory too
7489 early.  This flag is enabled by default at @option{-O} and higher.
7490
7491 @item -ftree-copyrename
7492 @opindex ftree-copyrename
7493 Perform copy renaming on trees.  This pass attempts to rename compiler
7494 temporaries to other variables at copy locations, usually resulting in
7495 variable names which more closely resemble the original variables.  This flag
7496 is enabled by default at @option{-O} and higher.
7497
7498 @item -ftree-coalesce-inlined-vars
7499 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7500 combine small user-defined variables too, but only if they were inlined
7501 from other functions.  It is a more limited form of
7502 @option{-ftree-coalesce-vars}.  This may harm debug information of such
7503 inlined variables, but it will keep variables of the inlined-into
7504 function apart from each other, such that they are more likely to
7505 contain the expected values in a debugging session.  This was the
7506 default in GCC versions older than 4.7.
7507
7508 @item -ftree-coalesce-vars
7509 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
7510 combine small user-defined variables too, instead of just compiler
7511 temporaries.  This may severely limit the ability to debug an optimized
7512 program compiled with @option{-fno-var-tracking-assignments}.  In the
7513 negated form, this flag prevents SSA coalescing of user variables,
7514 including inlined ones.  This option is enabled by default.
7515
7516 @item -ftree-ter
7517 @opindex ftree-ter
7518 Perform temporary expression replacement during the SSA->normal phase.  Single
7519 use/single def temporaries are replaced at their use location with their
7520 defining expression.  This results in non-GIMPLE code, but gives the expanders
7521 much more complex trees to work on resulting in better RTL generation.  This is
7522 enabled by default at @option{-O} and higher.
7523
7524 @item -ftree-vectorize
7525 @opindex ftree-vectorize
7526 Perform loop vectorization on trees. This flag is enabled by default at
7527 @option{-O3}.
7528
7529 @item -ftree-slp-vectorize
7530 @opindex ftree-slp-vectorize
7531 Perform basic block vectorization on trees. This flag is enabled by default at
7532 @option{-O3} and when @option{-ftree-vectorize} is enabled.
7533
7534 @item -ftree-vect-loop-version
7535 @opindex ftree-vect-loop-version
7536 Perform loop versioning when doing loop vectorization on trees.  When a loop
7537 appears to be vectorizable except that data alignment or data dependence cannot
7538 be determined at compile time, then vectorized and non-vectorized versions of
7539 the loop are generated along with run-time checks for alignment or dependence
7540 to control which version is executed.  This option is enabled by default
7541 except at level @option{-Os} where it is disabled.
7542
7543 @item -fvect-cost-model
7544 @opindex fvect-cost-model
7545 Enable cost model for vectorization.
7546
7547 @item -ftree-vrp
7548 @opindex ftree-vrp
7549 Perform Value Range Propagation on trees.  This is similar to the
7550 constant propagation pass, but instead of values, ranges of values are
7551 propagated.  This allows the optimizers to remove unnecessary range
7552 checks like array bound checks and null pointer checks.  This is
7553 enabled by default at @option{-O2} and higher.  Null pointer check
7554 elimination is only done if @option{-fdelete-null-pointer-checks} is
7555 enabled.
7556
7557 @item -ftracer
7558 @opindex ftracer
7559 Perform tail duplication to enlarge superblock size.  This transformation
7560 simplifies the control flow of the function allowing other optimizations to do
7561 better job.
7562
7563 @item -funroll-loops
7564 @opindex funroll-loops
7565 Unroll loops whose number of iterations can be determined at compile
7566 time or upon entry to the loop.  @option{-funroll-loops} implies
7567 @option{-frerun-cse-after-loop}.  This option makes code larger,
7568 and may or may not make it run faster.
7569
7570 @item -funroll-all-loops
7571 @opindex funroll-all-loops
7572 Unroll all loops, even if their number of iterations is uncertain when
7573 the loop is entered.  This usually makes programs run more slowly.
7574 @option{-funroll-all-loops} implies the same options as
7575 @option{-funroll-loops},
7576
7577 @item -fsplit-ivs-in-unroller
7578 @opindex fsplit-ivs-in-unroller
7579 Enables expressing of values of induction variables in later iterations
7580 of the unrolled loop using the value in the first iteration.  This breaks
7581 long dependency chains, thus improving efficiency of the scheduling passes.
7582
7583 Combination of @option{-fweb} and CSE is often sufficient to obtain the
7584 same effect.  However in cases the loop body is more complicated than
7585 a single basic block, this is not reliable.  It also does not work at all
7586 on some of the architectures due to restrictions in the CSE pass.
7587
7588 This optimization is enabled by default.
7589
7590 @item -fvariable-expansion-in-unroller
7591 @opindex fvariable-expansion-in-unroller
7592 With this option, the compiler creates multiple copies of some
7593 local variables when unrolling a loop, which can result in superior code.
7594
7595 @item -fpartial-inlining
7596 @opindex fpartial-inlining
7597 Inline parts of functions.  This option has any effect only
7598 when inlining itself is turned on by the @option{-finline-functions}
7599 or @option{-finline-small-functions} options.
7600
7601 Enabled at level @option{-O2}.
7602
7603 @item -fpredictive-commoning
7604 @opindex fpredictive-commoning
7605 Perform predictive commoning optimization, i.e., reusing computations
7606 (especially memory loads and stores) performed in previous
7607 iterations of loops.
7608
7609 This option is enabled at level @option{-O3}.
7610
7611 @item -fprefetch-loop-arrays
7612 @opindex fprefetch-loop-arrays
7613 If supported by the target machine, generate instructions to prefetch
7614 memory to improve the performance of loops that access large arrays.
7615
7616 This option may generate better or worse code; results are highly
7617 dependent on the structure of loops within the source code.
7618
7619 Disabled at level @option{-Os}.
7620
7621 @item -fno-peephole
7622 @itemx -fno-peephole2
7623 @opindex fno-peephole
7624 @opindex fno-peephole2
7625 Disable any machine-specific peephole optimizations.  The difference
7626 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7627 are implemented in the compiler; some targets use one, some use the
7628 other, a few use both.
7629
7630 @option{-fpeephole} is enabled by default.
7631 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7632
7633 @item -fno-guess-branch-probability
7634 @opindex fno-guess-branch-probability
7635 Do not guess branch probabilities using heuristics.
7636
7637 GCC uses heuristics to guess branch probabilities if they are
7638 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7639 heuristics are based on the control flow graph.  If some branch probabilities
7640 are specified by @samp{__builtin_expect}, then the heuristics are
7641 used to guess branch probabilities for the rest of the control flow graph,
7642 taking the @samp{__builtin_expect} info into account.  The interactions
7643 between the heuristics and @samp{__builtin_expect} can be complex, and in
7644 some cases, it may be useful to disable the heuristics so that the effects
7645 of @samp{__builtin_expect} are easier to understand.
7646
7647 The default is @option{-fguess-branch-probability} at levels
7648 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7649
7650 @item -freorder-blocks
7651 @opindex freorder-blocks
7652 Reorder basic blocks in the compiled function in order to reduce number of
7653 taken branches and improve code locality.
7654
7655 Enabled at levels @option{-O2}, @option{-O3}.
7656
7657 @item -freorder-blocks-and-partition
7658 @opindex freorder-blocks-and-partition
7659 In addition to reordering basic blocks in the compiled function, in order
7660 to reduce number of taken branches, partitions hot and cold basic blocks
7661 into separate sections of the assembly and .o files, to improve
7662 paging and cache locality performance.
7663
7664 This optimization is automatically turned off in the presence of
7665 exception handling, for linkonce sections, for functions with a user-defined
7666 section attribute and on any architecture that does not support named
7667 sections.
7668
7669 @item -freorder-functions
7670 @opindex freorder-functions
7671 Reorder functions in the object file in order to
7672 improve code locality.  This is implemented by using special
7673 subsections @code{.text.hot} for most frequently executed functions and
7674 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7675 the linker so object file format must support named sections and linker must
7676 place them in a reasonable way.
7677
7678 Also profile feedback must be available in to make this option effective.  See
7679 @option{-fprofile-arcs} for details.
7680
7681 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7682
7683 @item -fstrict-aliasing
7684 @opindex fstrict-aliasing
7685 Allow the compiler to assume the strictest aliasing rules applicable to
7686 the language being compiled.  For C (and C++), this activates
7687 optimizations based on the type of expressions.  In particular, an
7688 object of one type is assumed never to reside at the same address as an
7689 object of a different type, unless the types are almost the same.  For
7690 example, an @code{unsigned int} can alias an @code{int}, but not a
7691 @code{void*} or a @code{double}.  A character type may alias any other
7692 type.
7693
7694 @anchor{Type-punning}Pay special attention to code like this:
7695 @smallexample
7696 union a_union @{
7697   int i;
7698   double d;
7699 @};
7700
7701 int f() @{
7702   union a_union t;
7703   t.d = 3.0;
7704   return t.i;
7705 @}
7706 @end smallexample
7707 The practice of reading from a different union member than the one most
7708 recently written to (called ``type-punning'') is common.  Even with
7709 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7710 is accessed through the union type.  So, the code above works as
7711 expected.  @xref{Structures unions enumerations and bit-fields
7712 implementation}.  However, this code might not:
7713 @smallexample
7714 int f() @{
7715   union a_union t;
7716   int* ip;
7717   t.d = 3.0;
7718   ip = &t.i;
7719   return *ip;
7720 @}
7721 @end smallexample
7722
7723 Similarly, access by taking the address, casting the resulting pointer
7724 and dereferencing the result has undefined behavior, even if the cast
7725 uses a union type, e.g.:
7726 @smallexample
7727 int f() @{
7728   double d = 3.0;
7729   return ((union a_union *) &d)->i;
7730 @}
7731 @end smallexample
7732
7733 The @option{-fstrict-aliasing} option is enabled at levels
7734 @option{-O2}, @option{-O3}, @option{-Os}.
7735
7736 @item -fstrict-overflow
7737 @opindex fstrict-overflow
7738 Allow the compiler to assume strict signed overflow rules, depending
7739 on the language being compiled.  For C (and C++) this means that
7740 overflow when doing arithmetic with signed numbers is undefined, which
7741 means that the compiler may assume that it does not happen.  This
7742 permits various optimizations.  For example, the compiler assumes
7743 that an expression like @code{i + 10 > i} is always true for
7744 signed @code{i}.  This assumption is only valid if signed overflow is
7745 undefined, as the expression is false if @code{i + 10} overflows when
7746 using twos complement arithmetic.  When this option is in effect any
7747 attempt to determine whether an operation on signed numbers 
7748 overflows must be written carefully to not actually involve overflow.
7749
7750 This option also allows the compiler to assume strict pointer
7751 semantics: given a pointer to an object, if adding an offset to that
7752 pointer does not produce a pointer to the same object, the addition is
7753 undefined.  This permits the compiler to conclude that @code{p + u >
7754 p} is always true for a pointer @code{p} and unsigned integer
7755 @code{u}.  This assumption is only valid because pointer wraparound is
7756 undefined, as the expression is false if @code{p + u} overflows using
7757 twos complement arithmetic.
7758
7759 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7760 that integer signed overflow is fully defined: it wraps.  When
7761 @option{-fwrapv} is used, there is no difference between
7762 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7763 integers.  With @option{-fwrapv} certain types of overflow are
7764 permitted.  For example, if the compiler gets an overflow when doing
7765 arithmetic on constants, the overflowed value can still be used with
7766 @option{-fwrapv}, but not otherwise.
7767
7768 The @option{-fstrict-overflow} option is enabled at levels
7769 @option{-O2}, @option{-O3}, @option{-Os}.
7770
7771 @item -falign-functions
7772 @itemx -falign-functions=@var{n}
7773 @opindex falign-functions
7774 Align the start of functions to the next power-of-two greater than
7775 @var{n}, skipping up to @var{n} bytes.  For instance,
7776 @option{-falign-functions=32} aligns functions to the next 32-byte
7777 boundary, but @option{-falign-functions=24} aligns to the next
7778 32-byte boundary only if this can be done by skipping 23 bytes or less.
7779
7780 @option{-fno-align-functions} and @option{-falign-functions=1} are
7781 equivalent and mean that functions are not aligned.
7782
7783 Some assemblers only support this flag when @var{n} is a power of two;
7784 in that case, it is rounded up.
7785
7786 If @var{n} is not specified or is zero, use a machine-dependent default.
7787
7788 Enabled at levels @option{-O2}, @option{-O3}.
7789
7790 @item -falign-labels
7791 @itemx -falign-labels=@var{n}
7792 @opindex falign-labels
7793 Align all branch targets to a power-of-two boundary, skipping up to
7794 @var{n} bytes like @option{-falign-functions}.  This option can easily
7795 make code slower, because it must insert dummy operations for when the
7796 branch target is reached in the usual flow of the code.
7797
7798 @option{-fno-align-labels} and @option{-falign-labels=1} are
7799 equivalent and mean that labels are not aligned.
7800
7801 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7802 are greater than this value, then their values are used instead.
7803
7804 If @var{n} is not specified or is zero, use a machine-dependent default
7805 which is very likely to be @samp{1}, meaning no alignment.
7806
7807 Enabled at levels @option{-O2}, @option{-O3}.
7808
7809 @item -falign-loops
7810 @itemx -falign-loops=@var{n}
7811 @opindex falign-loops
7812 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7813 like @option{-falign-functions}.  If the loops are
7814 executed many times, this makes up for any execution of the dummy
7815 operations.
7816
7817 @option{-fno-align-loops} and @option{-falign-loops=1} are
7818 equivalent and mean that loops are not aligned.
7819
7820 If @var{n} is not specified or is zero, use a machine-dependent default.
7821
7822 Enabled at levels @option{-O2}, @option{-O3}.
7823
7824 @item -falign-jumps
7825 @itemx -falign-jumps=@var{n}
7826 @opindex falign-jumps
7827 Align branch targets to a power-of-two boundary, for branch targets
7828 where the targets can only be reached by jumping, skipping up to @var{n}
7829 bytes like @option{-falign-functions}.  In this case, no dummy operations
7830 need be executed.
7831
7832 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7833 equivalent and mean that loops are not aligned.
7834
7835 If @var{n} is not specified or is zero, use a machine-dependent default.
7836
7837 Enabled at levels @option{-O2}, @option{-O3}.
7838
7839 @item -funit-at-a-time
7840 @opindex funit-at-a-time
7841 This option is left for compatibility reasons. @option{-funit-at-a-time}
7842 has no effect, while @option{-fno-unit-at-a-time} implies
7843 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7844
7845 Enabled by default.
7846
7847 @item -fno-toplevel-reorder
7848 @opindex fno-toplevel-reorder
7849 Do not reorder top-level functions, variables, and @code{asm}
7850 statements.  Output them in the same order that they appear in the
7851 input file.  When this option is used, unreferenced static variables
7852 are not removed.  This option is intended to support existing code
7853 that relies on a particular ordering.  For new code, it is better to
7854 use attributes.
7855
7856 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
7857 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
7858 targets.
7859
7860 @item -fweb
7861 @opindex fweb
7862 Constructs webs as commonly used for register allocation purposes and assign
7863 each web individual pseudo register.  This allows the register allocation pass
7864 to operate on pseudos directly, but also strengthens several other optimization
7865 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7866 however, make debugging impossible, since variables no longer stay in a
7867 ``home register''.
7868
7869 Enabled by default with @option{-funroll-loops}.
7870
7871 @item -fwhole-program
7872 @opindex fwhole-program
7873 Assume that the current compilation unit represents the whole program being
7874 compiled.  All public functions and variables with the exception of @code{main}
7875 and those merged by attribute @code{externally_visible} become static functions
7876 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.
7877 While this option is equivalent to proper use of the @code{static} keyword for
7878 programs consisting of a single file, in combination with option
7879 @option{-flto} this flag can be used to
7880 compile many smaller scale programs since the functions and variables become
7881 local for the whole combined compilation unit, not for the single source file
7882 itself.
7883
7884 This option implies @option{-fwhole-file} for Fortran programs.
7885
7886 @item -flto[=@var{n}]
7887 @opindex flto
7888 This option runs the standard link-time optimizer.  When invoked
7889 with source code, it generates GIMPLE (one of GCC's internal
7890 representations) and writes it to special ELF sections in the object
7891 file.  When the object files are linked together, all the function
7892 bodies are read from these ELF sections and instantiated as if they
7893 had been part of the same translation unit.
7894
7895 To use the link-time optimizer, @option{-flto} needs to be specified at
7896 compile time and during the final link.  For example:
7897
7898 @smallexample
7899 gcc -c -O2 -flto foo.c
7900 gcc -c -O2 -flto bar.c
7901 gcc -o myprog -flto -O2 foo.o bar.o
7902 @end smallexample
7903
7904 The first two invocations to GCC save a bytecode representation
7905 of GIMPLE into special ELF sections inside @file{foo.o} and
7906 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
7907 @file{foo.o} and @file{bar.o}, merges the two files into a single
7908 internal image, and compiles the result as usual.  Since both
7909 @file{foo.o} and @file{bar.o} are merged into a single image, this
7910 causes all the interprocedural analyses and optimizations in GCC to
7911 work across the two files as if they were a single one.  This means,
7912 for example, that the inliner is able to inline functions in
7913 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7914
7915 Another (simpler) way to enable link-time optimization is:
7916
7917 @smallexample
7918 gcc -o myprog -flto -O2 foo.c bar.c
7919 @end smallexample
7920
7921 The above generates bytecode for @file{foo.c} and @file{bar.c},
7922 merges them together into a single GIMPLE representation and optimizes
7923 them as usual to produce @file{myprog}.
7924
7925 The only important thing to keep in mind is that to enable link-time
7926 optimizations the @option{-flto} flag needs to be passed to both the
7927 compile and the link commands.
7928
7929 To make whole program optimization effective, it is necessary to make
7930 certain whole program assumptions.  The compiler needs to know
7931 what functions and variables can be accessed by libraries and runtime
7932 outside of the link-time optimized unit.  When supported by the linker,
7933 the linker plugin (see @option{-fuse-linker-plugin}) passes information
7934 to the compiler about used and externally visible symbols.  When
7935 the linker plugin is not available, @option{-fwhole-program} should be
7936 used to allow the compiler to make these assumptions, which leads
7937 to more aggressive optimization decisions.
7938
7939 Note that when a file is compiled with @option{-flto}, the generated
7940 object file is larger than a regular object file because it 
7941 contains GIMPLE bytecodes and the usual final code.  This means that
7942 object files with LTO information can be linked as normal object
7943 files; if @option{-flto} is not passed to the linker, no
7944 interprocedural optimizations are applied.
7945
7946 Additionally, the optimization flags used to compile individual files
7947 are not necessarily related to those used at link time.  For instance,
7948
7949 @smallexample
7950 gcc -c -O0 -flto foo.c
7951 gcc -c -O0 -flto bar.c
7952 gcc -o myprog -flto -O3 foo.o bar.o
7953 @end smallexample
7954
7955 This produces individual object files with unoptimized assembler
7956 code, but the resulting binary @file{myprog} is optimized at
7957 @option{-O3}.  If, instead, the final binary is generated without
7958 @option{-flto}, then @file{myprog} is not optimized.
7959
7960 When producing the final binary with @option{-flto}, GCC only
7961 applies link-time optimizations to those files that contain bytecode.
7962 Therefore, you can mix and match object files and libraries with
7963 GIMPLE bytecodes and final object code.  GCC automatically selects
7964 which files to optimize in LTO mode and which files to link without
7965 further processing.
7966
7967 There are some code generation flags preserved by GCC when
7968 generating bytecodes, as they need to be used during the final link
7969 stage.  Currently, the following options are saved into the GIMPLE
7970 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7971 @option{-m} target flags.
7972
7973 At link time, these options are read in and reapplied.  Note that the
7974 current implementation makes no attempt to recognize conflicting
7975 values for these options.  If different files have conflicting option
7976 values (e.g., one file is compiled with @option{-fPIC} and another
7977 isn't), the compiler simply uses the last value read from the
7978 bytecode files.  It is recommended, then, that you compile all the files
7979 participating in the same link with the same options.
7980
7981 If LTO encounters objects with C linkage declared with incompatible
7982 types in separate translation units to be linked together (undefined
7983 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7984 issued.  The behavior is still undefined at run time.
7985
7986 Another feature of LTO is that it is possible to apply interprocedural
7987 optimizations on files written in different languages.  This requires
7988 support in the language front end.  Currently, the C, C++ and
7989 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7990 something like this should work:
7991
7992 @smallexample
7993 gcc -c -flto foo.c
7994 g++ -c -flto bar.cc
7995 gfortran -c -flto baz.f90
7996 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7997 @end smallexample
7998
7999 Notice that the final link is done with @command{g++} to get the C++
8000 runtime libraries and @option{-lgfortran} is added to get the Fortran
8001 runtime libraries.  In general, when mixing languages in LTO mode, you
8002 should use the same link command options as when mixing languages in a
8003 regular (non-LTO) compilation; all you need to add is @option{-flto} to
8004 all the compile and link commands.
8005
8006 If object files containing GIMPLE bytecode are stored in a library archive, say
8007 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8008 are using a linker with plugin support.  To enable this feature, use
8009 the flag @option{-fuse-linker-plugin} at link time:
8010
8011 @smallexample
8012 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8013 @end smallexample
8014
8015 With the linker plugin enabled, the linker extracts the needed
8016 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8017 to make them part of the aggregated GIMPLE image to be optimized.
8018
8019 If you are not using a linker with plugin support and/or do not
8020 enable the linker plugin, then the objects inside @file{libfoo.a}
8021 are extracted and linked as usual, but they do not participate
8022 in the LTO optimization process.
8023
8024 Link-time optimizations do not require the presence of the whole program to
8025 operate.  If the program does not require any symbols to be exported, it is
8026 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8027 the interprocedural optimizers to use more aggressive assumptions which may
8028 lead to improved optimization opportunities.
8029 Use of @option{-fwhole-program} is not needed when linker plugin is
8030 active (see @option{-fuse-linker-plugin}).
8031
8032 The current implementation of LTO makes no
8033 attempt to generate bytecode that is portable between different
8034 types of hosts.  The bytecode files are versioned and there is a
8035 strict version check, so bytecode files generated in one version of
8036 GCC will not work with an older/newer version of GCC@.
8037
8038 Link-time optimization does not work well with generation of debugging
8039 information.  Combining @option{-flto} with
8040 @option{-g} is currently experimental and expected to produce wrong
8041 results.
8042
8043 If you specify the optional @var{n}, the optimization and code
8044 generation done at link time is executed in parallel using @var{n}
8045 parallel jobs by utilizing an installed @command{make} program.  The
8046 environment variable @env{MAKE} may be used to override the program
8047 used.  The default value for @var{n} is 1.
8048
8049 You can also specify @option{-flto=jobserver} to use GNU make's
8050 job server mode to determine the number of parallel jobs. This
8051 is useful when the Makefile calling GCC is already executing in parallel.
8052 You must prepend a @samp{+} to the command recipe in the parent Makefile
8053 for this to work.  This option likely only works if @env{MAKE} is
8054 GNU make.
8055
8056 This option is disabled by default
8057
8058 @item -flto-partition=@var{alg}
8059 @opindex flto-partition
8060 Specify the partitioning algorithm used by the link-time optimizer.
8061 The value is either @code{1to1} to specify a partitioning mirroring
8062 the original source files or @code{balanced} to specify partitioning
8063 into equally sized chunks (whenever possible).  Specifying @code{none}
8064 as an algorithm disables partitioning and streaming completely. The
8065 default value is @code{balanced}.
8066
8067 @item -flto-compression-level=@var{n}
8068 This option specifies the level of compression used for intermediate
8069 language written to LTO object files, and is only meaningful in
8070 conjunction with LTO mode (@option{-flto}).  Valid
8071 values are 0 (no compression) to 9 (maximum compression).  Values
8072 outside this range are clamped to either 0 or 9.  If the option is not
8073 given, a default balanced compression setting is used.
8074
8075 @item -flto-report
8076 Prints a report with internal details on the workings of the link-time
8077 optimizer.  The contents of this report vary from version to version.
8078 It is meant to be useful to GCC developers when processing object
8079 files in LTO mode (via @option{-flto}).
8080
8081 Disabled by default.
8082
8083 @item -fuse-linker-plugin
8084 Enables the use of a linker plugin during link-time optimization.  This
8085 option relies on plugin support in the linker, which is available in gold
8086 or in GNU ld 2.21 or newer.
8087
8088 This option enables the extraction of object files with GIMPLE bytecode out
8089 of library archives. This improves the quality of optimization by exposing
8090 more code to the link-time optimizer.  This information specifies what
8091 symbols can be accessed externally (by non-LTO object or during dynamic
8092 linking).  Resulting code quality improvements on binaries (and shared
8093 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8094 See @option{-flto} for a description of the effect of this flag and how to
8095 use it.
8096
8097 This option is enabled by default when LTO support in GCC is enabled
8098 and GCC was configured for use with
8099 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8100
8101 @item -ffat-lto-objects
8102 @opindex ffat-lto-objects
8103 Fat LTO objects are object files that contain both the intermediate language
8104 and the object code. This makes them usable for both LTO linking and normal
8105 linking. This option is effective only when compiling with @option{-flto}
8106 and is ignored at link time.
8107
8108 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8109 requires the complete toolchain to be aware of LTO. It requires a linker with
8110 linker plugin support for basic functionality.  Additionally,
8111 @command{nm}, @command{ar} and @command{ranlib}
8112 need to support linker plugins to allow a full-featured build environment
8113 (capable of building static libraries etc).
8114
8115 The default is @option{-ffat-lto-objects} but this default is intended to
8116 change in future releases when linker plugin enabled environments become more
8117 common.
8118
8119 @item -fcompare-elim
8120 @opindex fcompare-elim
8121 After register allocation and post-register allocation instruction splitting,
8122 identify arithmetic instructions that compute processor flags similar to a
8123 comparison operation based on that arithmetic.  If possible, eliminate the
8124 explicit comparison operation.
8125
8126 This pass only applies to certain targets that cannot explicitly represent
8127 the comparison operation before register allocation is complete.
8128
8129 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8130
8131 @item -fcprop-registers
8132 @opindex fcprop-registers
8133 After register allocation and post-register allocation instruction splitting,
8134 we perform a copy-propagation pass to try to reduce scheduling dependencies
8135 and occasionally eliminate the copy.
8136
8137 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8138
8139 @item -fprofile-correction
8140 @opindex fprofile-correction
8141 Profiles collected using an instrumented binary for multi-threaded programs may
8142 be inconsistent due to missed counter updates. When this option is specified,
8143 GCC uses heuristics to correct or smooth out such inconsistencies. By
8144 default, GCC emits an error message when an inconsistent profile is detected.
8145
8146 @item -fprofile-dir=@var{path}
8147 @opindex fprofile-dir
8148
8149 Set the directory to search for the profile data files in to @var{path}.
8150 This option affects only the profile data generated by
8151 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8152 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8153 and its related options.  Both absolute and relative paths can be used.
8154 By default, GCC uses the current directory as @var{path}, thus the
8155 profile data file appears in the same directory as the object file.
8156
8157 @item -fprofile-generate
8158 @itemx -fprofile-generate=@var{path}
8159 @opindex fprofile-generate
8160
8161 Enable options usually used for instrumenting application to produce
8162 profile useful for later recompilation with profile feedback based
8163 optimization.  You must use @option{-fprofile-generate} both when
8164 compiling and when linking your program.
8165
8166 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8167
8168 If @var{path} is specified, GCC looks at the @var{path} to find
8169 the profile feedback data files. See @option{-fprofile-dir}.
8170
8171 @item -fprofile-use
8172 @itemx -fprofile-use=@var{path}
8173 @opindex fprofile-use
8174 Enable profile feedback directed optimizations, and optimizations
8175 generally profitable only with profile feedback available.
8176
8177 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8178 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
8179
8180 By default, GCC emits an error message if the feedback profiles do not
8181 match the source code.  This error can be turned into a warning by using
8182 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8183 code.
8184
8185 If @var{path} is specified, GCC looks at the @var{path} to find
8186 the profile feedback data files. See @option{-fprofile-dir}.
8187 @end table
8188
8189 The following options control compiler behavior regarding floating-point 
8190 arithmetic.  These options trade off between speed and
8191 correctness.  All must be specifically enabled.
8192
8193 @table @gcctabopt
8194 @item -ffloat-store
8195 @opindex ffloat-store
8196 Do not store floating-point variables in registers, and inhibit other
8197 options that might change whether a floating-point value is taken from a
8198 register or memory.
8199
8200 @cindex floating-point precision
8201 This option prevents undesirable excess precision on machines such as
8202 the 68000 where the floating registers (of the 68881) keep more
8203 precision than a @code{double} is supposed to have.  Similarly for the
8204 x86 architecture.  For most programs, the excess precision does only
8205 good, but a few programs rely on the precise definition of IEEE floating
8206 point.  Use @option{-ffloat-store} for such programs, after modifying
8207 them to store all pertinent intermediate computations into variables.
8208
8209 @item -fexcess-precision=@var{style}
8210 @opindex fexcess-precision
8211 This option allows further control over excess precision on machines
8212 where floating-point registers have more precision than the IEEE
8213 @code{float} and @code{double} types and the processor does not
8214 support operations rounding to those types.  By default,
8215 @option{-fexcess-precision=fast} is in effect; this means that
8216 operations are carried out in the precision of the registers and that
8217 it is unpredictable when rounding to the types specified in the source
8218 code takes place.  When compiling C, if
8219 @option{-fexcess-precision=standard} is specified then excess
8220 precision follows the rules specified in ISO C99; in particular,
8221 both casts and assignments cause values to be rounded to their
8222 semantic types (whereas @option{-ffloat-store} only affects
8223 assignments).  This option is enabled by default for C if a strict
8224 conformance option such as @option{-std=c99} is used.
8225
8226 @opindex mfpmath
8227 @option{-fexcess-precision=standard} is not implemented for languages
8228 other than C, and has no effect if
8229 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8230 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8231 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8232 semantics apply without excess precision, and in the latter, rounding
8233 is unpredictable.
8234
8235 @item -ffast-math
8236 @opindex ffast-math
8237 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8238 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8239 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8240
8241 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8242
8243 This option is not turned on by any @option{-O} option besides
8244 @option{-Ofast} since it can result in incorrect output for programs
8245 that depend on an exact implementation of IEEE or ISO rules/specifications
8246 for math functions. It may, however, yield faster code for programs
8247 that do not require the guarantees of these specifications.
8248
8249 @item -fno-math-errno
8250 @opindex fno-math-errno
8251 Do not set @code{errno} after calling math functions that are executed
8252 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8253 IEEE exceptions for math error handling may want to use this flag
8254 for speed while maintaining IEEE arithmetic compatibility.
8255
8256 This option is not turned on by any @option{-O} option since
8257 it can result in incorrect output for programs that depend on
8258 an exact implementation of IEEE or ISO rules/specifications for
8259 math functions. It may, however, yield faster code for programs
8260 that do not require the guarantees of these specifications.
8261
8262 The default is @option{-fmath-errno}.
8263
8264 On Darwin systems, the math library never sets @code{errno}.  There is
8265 therefore no reason for the compiler to consider the possibility that
8266 it might, and @option{-fno-math-errno} is the default.
8267
8268 @item -funsafe-math-optimizations
8269 @opindex funsafe-math-optimizations
8270
8271 Allow optimizations for floating-point arithmetic that (a) assume
8272 that arguments and results are valid and (b) may violate IEEE or
8273 ANSI standards.  When used at link-time, it may include libraries
8274 or startup files that change the default FPU control word or other
8275 similar optimizations.
8276
8277 This option is not turned on by any @option{-O} option since
8278 it can result in incorrect output for programs that depend on
8279 an exact implementation of IEEE or ISO rules/specifications for
8280 math functions. It may, however, yield faster code for programs
8281 that do not require the guarantees of these specifications.
8282 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8283 @option{-fassociative-math} and @option{-freciprocal-math}.
8284
8285 The default is @option{-fno-unsafe-math-optimizations}.
8286
8287 @item -fassociative-math
8288 @opindex fassociative-math
8289
8290 Allow re-association of operands in series of floating-point operations.
8291 This violates the ISO C and C++ language standard by possibly changing
8292 computation result.  NOTE: re-ordering may change the sign of zero as
8293 well as ignore NaNs and inhibit or create underflow or overflow (and
8294 thus cannot be used on code that relies on rounding behavior like
8295 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8296 and thus may not be used when ordered comparisons are required.
8297 This option requires that both @option{-fno-signed-zeros} and
8298 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8299 much sense with @option{-frounding-math}. For Fortran the option
8300 is automatically enabled when both @option{-fno-signed-zeros} and
8301 @option{-fno-trapping-math} are in effect.
8302
8303 The default is @option{-fno-associative-math}.
8304
8305 @item -freciprocal-math
8306 @opindex freciprocal-math
8307
8308 Allow the reciprocal of a value to be used instead of dividing by
8309 the value if this enables optimizations.  For example @code{x / y}
8310 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8311 is subject to common subexpression elimination.  Note that this loses
8312 precision and increases the number of flops operating on the value.
8313
8314 The default is @option{-fno-reciprocal-math}.
8315
8316 @item -ffinite-math-only
8317 @opindex ffinite-math-only
8318 Allow optimizations for floating-point arithmetic that assume
8319 that arguments and results are not NaNs or +-Infs.
8320
8321 This option is not turned on by any @option{-O} option since
8322 it can result in incorrect output for programs that depend on
8323 an exact implementation of IEEE or ISO rules/specifications for
8324 math functions. It may, however, yield faster code for programs
8325 that do not require the guarantees of these specifications.
8326
8327 The default is @option{-fno-finite-math-only}.
8328
8329 @item -fno-signed-zeros
8330 @opindex fno-signed-zeros
8331 Allow optimizations for floating-point arithmetic that ignore the
8332 signedness of zero.  IEEE arithmetic specifies the behavior of
8333 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
8334 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
8335 This option implies that the sign of a zero result isn't significant.
8336
8337 The default is @option{-fsigned-zeros}.
8338
8339 @item -fno-trapping-math
8340 @opindex fno-trapping-math
8341 Compile code assuming that floating-point operations cannot generate
8342 user-visible traps.  These traps include division by zero, overflow,
8343 underflow, inexact result and invalid operation.  This option requires
8344 that @option{-fno-signaling-nans} be in effect.  Setting this option may
8345 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
8346
8347 This option should never be turned on by any @option{-O} option since
8348 it can result in incorrect output for programs that depend on
8349 an exact implementation of IEEE or ISO rules/specifications for
8350 math functions.
8351
8352 The default is @option{-ftrapping-math}.
8353
8354 @item -frounding-math
8355 @opindex frounding-math
8356 Disable transformations and optimizations that assume default floating-point
8357 rounding behavior.  This is round-to-zero for all floating point
8358 to integer conversions, and round-to-nearest for all other arithmetic
8359 truncations.  This option should be specified for programs that change
8360 the FP rounding mode dynamically, or that may be executed with a
8361 non-default rounding mode.  This option disables constant folding of
8362 floating-point expressions at compile time (which may be affected by
8363 rounding mode) and arithmetic transformations that are unsafe in the
8364 presence of sign-dependent rounding modes.
8365
8366 The default is @option{-fno-rounding-math}.
8367
8368 This option is experimental and does not currently guarantee to
8369 disable all GCC optimizations that are affected by rounding mode.
8370 Future versions of GCC may provide finer control of this setting
8371 using C99's @code{FENV_ACCESS} pragma.  This command-line option
8372 will be used to specify the default state for @code{FENV_ACCESS}.
8373
8374 @item -fsignaling-nans
8375 @opindex fsignaling-nans
8376 Compile code assuming that IEEE signaling NaNs may generate user-visible
8377 traps during floating-point operations.  Setting this option disables
8378 optimizations that may change the number of exceptions visible with
8379 signaling NaNs.  This option implies @option{-ftrapping-math}.
8380
8381 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
8382 be defined.
8383
8384 The default is @option{-fno-signaling-nans}.
8385
8386 This option is experimental and does not currently guarantee to
8387 disable all GCC optimizations that affect signaling NaN behavior.
8388
8389 @item -fsingle-precision-constant
8390 @opindex fsingle-precision-constant
8391 Treat floating-point constants as single precision instead of
8392 implicitly converting them to double-precision constants.
8393
8394 @item -fcx-limited-range
8395 @opindex fcx-limited-range
8396 When enabled, this option states that a range reduction step is not
8397 needed when performing complex division.  Also, there is no checking
8398 whether the result of a complex multiplication or division is @code{NaN
8399 + I*NaN}, with an attempt to rescue the situation in that case.  The
8400 default is @option{-fno-cx-limited-range}, but is enabled by
8401 @option{-ffast-math}.
8402
8403 This option controls the default setting of the ISO C99
8404 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
8405 all languages.
8406
8407 @item -fcx-fortran-rules
8408 @opindex fcx-fortran-rules
8409 Complex multiplication and division follow Fortran rules.  Range
8410 reduction is done as part of complex division, but there is no checking
8411 whether the result of a complex multiplication or division is @code{NaN
8412 + I*NaN}, with an attempt to rescue the situation in that case.
8413
8414 The default is @option{-fno-cx-fortran-rules}.
8415
8416 @end table
8417
8418 The following options control optimizations that may improve
8419 performance, but are not enabled by any @option{-O} options.  This
8420 section includes experimental options that may produce broken code.
8421
8422 @table @gcctabopt
8423 @item -fbranch-probabilities
8424 @opindex fbranch-probabilities
8425 After running a program compiled with @option{-fprofile-arcs}
8426 (@pxref{Debugging Options,, Options for Debugging Your Program or
8427 @command{gcc}}), you can compile it a second time using
8428 @option{-fbranch-probabilities}, to improve optimizations based on
8429 the number of times each branch was taken.  When the program
8430 compiled with @option{-fprofile-arcs} exits it saves arc execution
8431 counts to a file called @file{@var{sourcename}.gcda} for each source
8432 file.  The information in this data file is very dependent on the
8433 structure of the generated code, so you must use the same source code
8434 and the same optimization options for both compilations.
8435
8436 With @option{-fbranch-probabilities}, GCC puts a
8437 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
8438 These can be used to improve optimization.  Currently, they are only
8439 used in one place: in @file{reorg.c}, instead of guessing which path a
8440 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
8441 exactly determine which path is taken more often.
8442
8443 @item -fprofile-values
8444 @opindex fprofile-values
8445 If combined with @option{-fprofile-arcs}, it adds code so that some
8446 data about values of expressions in the program is gathered.
8447
8448 With @option{-fbranch-probabilities}, it reads back the data gathered
8449 from profiling values of expressions for usage in optimizations.
8450
8451 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8452
8453 @item -fvpt
8454 @opindex fvpt
8455 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
8456 a code to gather information about values of expressions.
8457
8458 With @option{-fbranch-probabilities}, it reads back the data gathered
8459 and actually performs the optimizations based on them.
8460 Currently the optimizations include specialization of division operation
8461 using the knowledge about the value of the denominator.
8462
8463 @item -frename-registers
8464 @opindex frename-registers
8465 Attempt to avoid false dependencies in scheduled code by making use
8466 of registers left over after register allocation.  This optimization
8467 most benefits processors with lots of registers.  Depending on the
8468 debug information format adopted by the target, however, it can
8469 make debugging impossible, since variables no longer stay in
8470 a ``home register''.
8471
8472 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
8473
8474 @item -ftracer
8475 @opindex ftracer
8476 Perform tail duplication to enlarge superblock size.  This transformation
8477 simplifies the control flow of the function allowing other optimizations to do
8478 better job.
8479
8480 Enabled with @option{-fprofile-use}.
8481
8482 @item -funroll-loops
8483 @opindex funroll-loops
8484 Unroll loops whose number of iterations can be determined at compile time or
8485 upon entry to the loop.  @option{-funroll-loops} implies
8486 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
8487 It also turns on complete loop peeling (i.e.@: complete removal of loops with
8488 small constant number of iterations).  This option makes code larger, and may
8489 or may not make it run faster.
8490
8491 Enabled with @option{-fprofile-use}.
8492
8493 @item -funroll-all-loops
8494 @opindex funroll-all-loops
8495 Unroll all loops, even if their number of iterations is uncertain when
8496 the loop is entered.  This usually makes programs run more slowly.
8497 @option{-funroll-all-loops} implies the same options as
8498 @option{-funroll-loops}.
8499
8500 @item -fpeel-loops
8501 @opindex fpeel-loops
8502 Peels loops for which there is enough information that they do not
8503 roll much (from profile feedback).  It also turns on complete loop peeling
8504 (i.e.@: complete removal of loops with small constant number of iterations).
8505
8506 Enabled with @option{-fprofile-use}.
8507
8508 @item -fmove-loop-invariants
8509 @opindex fmove-loop-invariants
8510 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
8511 at level @option{-O1}
8512
8513 @item -funswitch-loops
8514 @opindex funswitch-loops
8515 Move branches with loop invariant conditions out of the loop, with duplicates
8516 of the loop on both branches (modified according to result of the condition).
8517
8518 @item -ffunction-sections
8519 @itemx -fdata-sections
8520 @opindex ffunction-sections
8521 @opindex fdata-sections
8522 Place each function or data item into its own section in the output
8523 file if the target supports arbitrary sections.  The name of the
8524 function or the name of the data item determines the section's name
8525 in the output file.
8526
8527 Use these options on systems where the linker can perform optimizations
8528 to improve locality of reference in the instruction space.  Most systems
8529 using the ELF object format and SPARC processors running Solaris 2 have
8530 linkers with such optimizations.  AIX may have these optimizations in
8531 the future.
8532
8533 Only use these options when there are significant benefits from doing
8534 so.  When you specify these options, the assembler and linker
8535 create larger object and executable files and are also slower.
8536 You cannot use @code{gprof} on all systems if you
8537 specify this option, and you may have problems with debugging if
8538 you specify both this option and @option{-g}.
8539
8540 @item -fbranch-target-load-optimize
8541 @opindex fbranch-target-load-optimize
8542 Perform branch target register load optimization before prologue / epilogue
8543 threading.
8544 The use of target registers can typically be exposed only during reload,
8545 thus hoisting loads out of loops and doing inter-block scheduling needs
8546 a separate optimization pass.
8547
8548 @item -fbranch-target-load-optimize2
8549 @opindex fbranch-target-load-optimize2
8550 Perform branch target register load optimization after prologue / epilogue
8551 threading.
8552
8553 @item -fbtr-bb-exclusive
8554 @opindex fbtr-bb-exclusive
8555 When performing branch target register load optimization, don't reuse
8556 branch target registers in within any basic block.
8557
8558 @item -fstack-protector
8559 @opindex fstack-protector
8560 Emit extra code to check for buffer overflows, such as stack smashing
8561 attacks.  This is done by adding a guard variable to functions with
8562 vulnerable objects.  This includes functions that call @code{alloca}, and
8563 functions with buffers larger than 8 bytes.  The guards are initialized
8564 when a function is entered and then checked when the function exits.
8565 If a guard check fails, an error message is printed and the program exits.
8566
8567 @item -fstack-protector-all
8568 @opindex fstack-protector-all
8569 Like @option{-fstack-protector} except that all functions are protected.
8570
8571 @item -fsection-anchors
8572 @opindex fsection-anchors
8573 Try to reduce the number of symbolic address calculations by using
8574 shared ``anchor'' symbols to address nearby objects.  This transformation
8575 can help to reduce the number of GOT entries and GOT accesses on some
8576 targets.
8577
8578 For example, the implementation of the following function @code{foo}:
8579
8580 @smallexample
8581 static int a, b, c;
8582 int foo (void) @{ return a + b + c; @}
8583 @end smallexample
8584
8585 @noindent
8586 usually calculates the addresses of all three variables, but if you
8587 compile it with @option{-fsection-anchors}, it accesses the variables
8588 from a common anchor point instead.  The effect is similar to the
8589 following pseudocode (which isn't valid C):
8590
8591 @smallexample
8592 int foo (void)
8593 @{
8594   register int *xr = &x;
8595   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
8596 @}
8597 @end smallexample
8598
8599 Not all targets support this option.
8600
8601 @item --param @var{name}=@var{value}
8602 @opindex param
8603 In some places, GCC uses various constants to control the amount of
8604 optimization that is done.  For example, GCC does not inline functions
8605 that contain more than a certain number of instructions.  You can
8606 control some of these constants on the command line using the
8607 @option{--param} option.
8608
8609 The names of specific parameters, and the meaning of the values, are
8610 tied to the internals of the compiler, and are subject to change
8611 without notice in future releases.
8612
8613 In each case, the @var{value} is an integer.  The allowable choices for
8614 @var{name} are given in the following table:
8615
8616 @table @gcctabopt
8617 @item predictable-branch-outcome
8618 When branch is predicted to be taken with probability lower than this threshold
8619 (in percent), then it is considered well predictable. The default is 10.
8620
8621 @item max-crossjump-edges
8622 The maximum number of incoming edges to consider for crossjumping.
8623 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8624 the number of edges incoming to each block.  Increasing values mean
8625 more aggressive optimization, making the compilation time increase with
8626 probably small improvement in executable size.
8627
8628 @item min-crossjump-insns
8629 The minimum number of instructions that must be matched at the end
8630 of two blocks before crossjumping is performed on them.  This
8631 value is ignored in the case where all instructions in the block being
8632 crossjumped from are matched.  The default value is 5.
8633
8634 @item max-grow-copy-bb-insns
8635 The maximum code size expansion factor when copying basic blocks
8636 instead of jumping.  The expansion is relative to a jump instruction.
8637 The default value is 8.
8638
8639 @item max-goto-duplication-insns
8640 The maximum number of instructions to duplicate to a block that jumps
8641 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8642 passes, GCC factors computed gotos early in the compilation process,
8643 and unfactors them as late as possible.  Only computed jumps at the
8644 end of a basic blocks with no more than max-goto-duplication-insns are
8645 unfactored.  The default value is 8.
8646
8647 @item max-delay-slot-insn-search
8648 The maximum number of instructions to consider when looking for an
8649 instruction to fill a delay slot.  If more than this arbitrary number of
8650 instructions are searched, the time savings from filling the delay slot
8651 are minimal, so stop searching.  Increasing values mean more
8652 aggressive optimization, making the compilation time increase with probably
8653 small improvement in execution time.
8654
8655 @item max-delay-slot-live-search
8656 When trying to fill delay slots, the maximum number of instructions to
8657 consider when searching for a block with valid live register
8658 information.  Increasing this arbitrarily chosen value means more
8659 aggressive optimization, increasing the compilation time.  This parameter
8660 should be removed when the delay slot code is rewritten to maintain the
8661 control-flow graph.
8662
8663 @item max-gcse-memory
8664 The approximate maximum amount of memory that can be allocated in
8665 order to perform the global common subexpression elimination
8666 optimization.  If more memory than specified is required, the
8667 optimization is not done.
8668
8669 @item max-gcse-insertion-ratio
8670 If the ratio of expression insertions to deletions is larger than this value
8671 for any expression, then RTL PRE inserts or removes the expression and thus
8672 leaves partially redundant computations in the instruction stream.  The default value is 20.
8673
8674 @item max-pending-list-length
8675 The maximum number of pending dependencies scheduling allows
8676 before flushing the current state and starting over.  Large functions
8677 with few branches or calls can create excessively large lists which
8678 needlessly consume memory and resources.
8679
8680 @item max-modulo-backtrack-attempts
8681 The maximum number of backtrack attempts the scheduler should make
8682 when modulo scheduling a loop.  Larger values can exponentially increase
8683 compilation time.
8684
8685 @item max-inline-insns-single
8686 Several parameters control the tree inliner used in GCC@.
8687 This number sets the maximum number of instructions (counted in GCC's
8688 internal representation) in a single function that the tree inliner
8689 considers for inlining.  This only affects functions declared
8690 inline and methods implemented in a class declaration (C++).
8691 The default value is 400.
8692
8693 @item max-inline-insns-auto
8694 When you use @option{-finline-functions} (included in @option{-O3}),
8695 a lot of functions that would otherwise not be considered for inlining
8696 by the compiler are investigated.  To those functions, a different
8697 (more restrictive) limit compared to functions declared inline can
8698 be applied.
8699 The default value is 40.
8700
8701 @item large-function-insns
8702 The limit specifying really large functions.  For functions larger than this
8703 limit after inlining, inlining is constrained by
8704 @option{--param large-function-growth}.  This parameter is useful primarily
8705 to avoid extreme compilation time caused by non-linear algorithms used by the
8706 back end.
8707 The default value is 2700.
8708
8709 @item large-function-growth
8710 Specifies maximal growth of large function caused by inlining in percents.
8711 The default value is 100 which limits large function growth to 2.0 times
8712 the original size.
8713
8714 @item large-unit-insns
8715 The limit specifying large translation unit.  Growth caused by inlining of
8716 units larger than this limit is limited by @option{--param inline-unit-growth}.
8717 For small units this might be too tight (consider unit consisting of function A
8718 that is inline and B that just calls A three time.  If B is small relative to
8719 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8720 large units consisting of small inlineable functions however the overall unit
8721 growth limit is needed to avoid exponential explosion of code size.  Thus for
8722 smaller units, the size is increased to @option{--param large-unit-insns}
8723 before applying @option{--param inline-unit-growth}.  The default is 10000
8724
8725 @item inline-unit-growth
8726 Specifies maximal overall growth of the compilation unit caused by inlining.
8727 The default value is 30 which limits unit growth to 1.3 times the original
8728 size.
8729
8730 @item ipcp-unit-growth
8731 Specifies maximal overall growth of the compilation unit caused by
8732 interprocedural constant propagation.  The default value is 10 which limits
8733 unit growth to 1.1 times the original size.
8734
8735 @item large-stack-frame
8736 The limit specifying large stack frames.  While inlining the algorithm is trying
8737 to not grow past this limit too much.  Default value is 256 bytes.
8738
8739 @item large-stack-frame-growth
8740 Specifies maximal growth of large stack frames caused by inlining in percents.
8741 The default value is 1000 which limits large stack frame growth to 11 times
8742 the original size.
8743
8744 @item max-inline-insns-recursive
8745 @itemx max-inline-insns-recursive-auto
8746 Specifies maximum number of instructions out-of-line copy of self recursive inline
8747 function can grow into by performing recursive inlining.
8748
8749 For functions declared inline @option{--param max-inline-insns-recursive} is
8750 taken into account.  For function not declared inline, recursive inlining
8751 happens only when @option{-finline-functions} (included in @option{-O3}) is
8752 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8753 default value is 450.
8754
8755 @item max-inline-recursive-depth
8756 @itemx max-inline-recursive-depth-auto
8757 Specifies maximum recursion depth used by the recursive inlining.
8758
8759 For functions declared inline @option{--param max-inline-recursive-depth} is
8760 taken into account.  For function not declared inline, recursive inlining
8761 happens only when @option{-finline-functions} (included in @option{-O3}) is
8762 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8763 default value is 8.
8764
8765 @item min-inline-recursive-probability
8766 Recursive inlining is profitable only for function having deep recursion
8767 in average and can hurt for function having little recursion depth by
8768 increasing the prologue size or complexity of function body to other
8769 optimizers.
8770
8771 When profile feedback is available (see @option{-fprofile-generate}) the actual
8772 recursion depth can be guessed from probability that function will recurse via
8773 given call expression.  This parameter limits inlining only to call expression
8774 whose probability exceeds given threshold (in percents).  The default value is
8775 10.
8776
8777 @item early-inlining-insns
8778 Specify growth that early inliner can make.  In effect it increases amount of
8779 inlining for code having large abstraction penalty.  The default value is 10.
8780
8781 @item max-early-inliner-iterations
8782 @itemx max-early-inliner-iterations
8783 Limit of iterations of early inliner.  This basically bounds number of nested
8784 indirect calls early inliner can resolve.  Deeper chains are still handled by
8785 late inlining.
8786
8787 @item comdat-sharing-probability
8788 @itemx comdat-sharing-probability
8789 Probability (in percent) that C++ inline function with comdat visibility
8790 are shared across multiple compilation units.  The default value is 20.
8791
8792 @item min-vect-loop-bound
8793 The minimum number of iterations under which a loop is not vectorized
8794 when @option{-ftree-vectorize} is used.  The number of iterations after
8795 vectorization needs to be greater than the value specified by this option
8796 to allow vectorization.  The default value is 0.
8797
8798 @item gcse-cost-distance-ratio
8799 Scaling factor in calculation of maximum distance an expression
8800 can be moved by GCSE optimizations.  This is currently supported only in the
8801 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
8802 is with simple expressions, i.e., the expressions that have cost
8803 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
8804 hoisting of simple expressions.  The default value is 10.
8805
8806 @item gcse-unrestricted-cost
8807 Cost, roughly measured as the cost of a single typical machine
8808 instruction, at which GCSE optimizations do not constrain
8809 the distance an expression can travel.  This is currently
8810 supported only in the code hoisting pass.  The lesser the cost,
8811 the more aggressive code hoisting is.  Specifying 0 
8812 allows all expressions to travel unrestricted distances.
8813 The default value is 3.
8814
8815 @item max-hoist-depth
8816 The depth of search in the dominator tree for expressions to hoist.
8817 This is used to avoid quadratic behavior in hoisting algorithm.
8818 The value of 0 does not limit on the search, but may slow down compilation
8819 of huge functions.  The default value is 30.
8820
8821 @item max-tail-merge-comparisons
8822 The maximum amount of similar bbs to compare a bb with.  This is used to
8823 avoid quadratic behavior in tree tail merging.  The default value is 10.
8824
8825 @item max-tail-merge-iterations
8826 The maximum amount of iterations of the pass over the function.  This is used to
8827 limit compilation time in tree tail merging.  The default value is 2.
8828
8829 @item max-unrolled-insns
8830 The maximum number of instructions that a loop should have if that loop
8831 is unrolled, and if the loop is unrolled, it determines how many times
8832 the loop code is unrolled.
8833
8834 @item max-average-unrolled-insns
8835 The maximum number of instructions biased by probabilities of their execution
8836 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8837 it determines how many times the loop code is unrolled.
8838
8839 @item max-unroll-times
8840 The maximum number of unrollings of a single loop.
8841
8842 @item max-peeled-insns
8843 The maximum number of instructions that a loop should have if that loop
8844 is peeled, and if the loop is peeled, it determines how many times
8845 the loop code is peeled.
8846
8847 @item max-peel-times
8848 The maximum number of peelings of a single loop.
8849
8850 @item max-completely-peeled-insns
8851 The maximum number of insns of a completely peeled loop.
8852
8853 @item max-completely-peel-times
8854 The maximum number of iterations of a loop to be suitable for complete peeling.
8855
8856 @item max-completely-peel-loop-nest-depth
8857 The maximum depth of a loop nest suitable for complete peeling.
8858
8859 @item max-unswitch-insns
8860 The maximum number of insns of an unswitched loop.
8861
8862 @item max-unswitch-level
8863 The maximum number of branches unswitched in a single loop.
8864
8865 @item lim-expensive
8866 The minimum cost of an expensive expression in the loop invariant motion.
8867
8868 @item iv-consider-all-candidates-bound
8869 Bound on number of candidates for induction variables below that
8870 all candidates are considered for each use in induction variable
8871 optimizations.  Only the most relevant candidates are considered
8872 if there are more candidates, to avoid quadratic time complexity.
8873
8874 @item iv-max-considered-uses
8875 The induction variable optimizations give up on loops that contain more
8876 induction variable uses.
8877
8878 @item iv-always-prune-cand-set-bound
8879 If number of candidates in the set is smaller than this value,
8880 we always try to remove unnecessary ivs from the set during its
8881 optimization when a new iv is added to the set.
8882
8883 @item scev-max-expr-size
8884 Bound on size of expressions used in the scalar evolutions analyzer.
8885 Large expressions slow the analyzer.
8886
8887 @item scev-max-expr-complexity
8888 Bound on the complexity of the expressions in the scalar evolutions analyzer.
8889 Complex expressions slow the analyzer.
8890
8891 @item omega-max-vars
8892 The maximum number of variables in an Omega constraint system.
8893 The default value is 128.
8894
8895 @item omega-max-geqs
8896 The maximum number of inequalities in an Omega constraint system.
8897 The default value is 256.
8898
8899 @item omega-max-eqs
8900 The maximum number of equalities in an Omega constraint system.
8901 The default value is 128.
8902
8903 @item omega-max-wild-cards
8904 The maximum number of wildcard variables that the Omega solver is
8905 able to insert.  The default value is 18.
8906
8907 @item omega-hash-table-size
8908 The size of the hash table in the Omega solver.  The default value is
8909 550.
8910
8911 @item omega-max-keys
8912 The maximal number of keys used by the Omega solver.  The default
8913 value is 500.
8914
8915 @item omega-eliminate-redundant-constraints
8916 When set to 1, use expensive methods to eliminate all redundant
8917 constraints.  The default value is 0.
8918
8919 @item vect-max-version-for-alignment-checks
8920 The maximum number of run-time checks that can be performed when
8921 doing loop versioning for alignment in the vectorizer.  See option
8922 @option{-ftree-vect-loop-version} for more information.
8923
8924 @item vect-max-version-for-alias-checks
8925 The maximum number of run-time checks that can be performed when
8926 doing loop versioning for alias in the vectorizer.  See option
8927 @option{-ftree-vect-loop-version} for more information.
8928
8929 @item max-iterations-to-track
8930
8931 The maximum number of iterations of a loop the brute force algorithm
8932 for analysis of # of iterations of the loop tries to evaluate.
8933
8934 @item hot-bb-count-fraction
8935 Select fraction of the maximal count of repetitions of basic block in program
8936 given basic block needs to have to be considered hot.
8937
8938 @item hot-bb-frequency-fraction
8939 Select fraction of the entry block frequency of executions of basic block in
8940 function given basic block needs to have to be considered hot.
8941
8942 @item max-predicted-iterations
8943 The maximum number of loop iterations we predict statically.  This is useful
8944 in cases where a function contains a single loop with known bound and
8945 another loop with unknown bound.
8946 The known number of iterations is predicted correctly, while
8947 the unknown number of iterations average to roughly 10.  This means that the
8948 loop without bounds appears artificially cold relative to the other one.
8949
8950 @item align-threshold
8951
8952 Select fraction of the maximal frequency of executions of a basic block in
8953 a function to align the basic block.
8954
8955 @item align-loop-iterations
8956
8957 A loop expected to iterate at least the selected number of iterations is
8958 aligned.
8959
8960 @item tracer-dynamic-coverage
8961 @itemx tracer-dynamic-coverage-feedback
8962
8963 This value is used to limit superblock formation once the given percentage of
8964 executed instructions is covered.  This limits unnecessary code size
8965 expansion.
8966
8967 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8968 feedback is available.  The real profiles (as opposed to statically estimated
8969 ones) are much less balanced allowing the threshold to be larger value.
8970
8971 @item tracer-max-code-growth
8972 Stop tail duplication once code growth has reached given percentage.  This is
8973 a rather artificial limit, as most of the duplicates are eliminated later in
8974 cross jumping, so it may be set to much higher values than is the desired code
8975 growth.
8976
8977 @item tracer-min-branch-ratio
8978
8979 Stop reverse growth when the reverse probability of best edge is less than this
8980 threshold (in percent).
8981
8982 @item tracer-min-branch-ratio
8983 @itemx tracer-min-branch-ratio-feedback
8984
8985 Stop forward growth if the best edge has probability lower than this
8986 threshold.
8987
8988 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8989 compilation for profile feedback and one for compilation without.  The value
8990 for compilation with profile feedback needs to be more conservative (higher) in
8991 order to make tracer effective.
8992
8993 @item max-cse-path-length
8994
8995 Maximum number of basic blocks on path that cse considers.  The default is 10.
8996
8997 @item max-cse-insns
8998 The maximum instructions CSE process before flushing. The default is 1000.
8999
9000 @item ggc-min-expand
9001
9002 GCC uses a garbage collector to manage its own memory allocation.  This
9003 parameter specifies the minimum percentage by which the garbage
9004 collector's heap should be allowed to expand between collections.
9005 Tuning this may improve compilation speed; it has no effect on code
9006 generation.
9007
9008 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9009 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9010 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9011 GCC is not able to calculate RAM on a particular platform, the lower
9012 bound of 30% is used.  Setting this parameter and
9013 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9014 every opportunity.  This is extremely slow, but can be useful for
9015 debugging.
9016
9017 @item ggc-min-heapsize
9018
9019 Minimum size of the garbage collector's heap before it begins bothering
9020 to collect garbage.  The first collection occurs after the heap expands
9021 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9022 tuning this may improve compilation speed, and has no effect on code
9023 generation.
9024
9025 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9026 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9027 with a lower bound of 4096 (four megabytes) and an upper bound of
9028 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9029 particular platform, the lower bound is used.  Setting this parameter
9030 very large effectively disables garbage collection.  Setting this
9031 parameter and @option{ggc-min-expand} to zero causes a full collection
9032 to occur at every opportunity.
9033
9034 @item max-reload-search-insns
9035 The maximum number of instruction reload should look backward for equivalent
9036 register.  Increasing values mean more aggressive optimization, making the
9037 compilation time increase with probably slightly better performance.
9038 The default value is 100.
9039
9040 @item max-cselib-memory-locations
9041 The maximum number of memory locations cselib should take into account.
9042 Increasing values mean more aggressive optimization, making the compilation time
9043 increase with probably slightly better performance.  The default value is 500.
9044
9045 @item reorder-blocks-duplicate
9046 @itemx reorder-blocks-duplicate-feedback
9047
9048 Used by basic block reordering pass to decide whether to use unconditional
9049 branch or duplicate the code on its destination.  Code is duplicated when its
9050 estimated size is smaller than this value multiplied by the estimated size of
9051 unconditional jump in the hot spots of the program.
9052
9053 The @option{reorder-block-duplicate-feedback} is used only when profile
9054 feedback is available and may be set to higher values than
9055 @option{reorder-block-duplicate} since information about the hot spots is more
9056 accurate.
9057
9058 @item max-sched-ready-insns
9059 The maximum number of instructions ready to be issued the scheduler should
9060 consider at any given time during the first scheduling pass.  Increasing
9061 values mean more thorough searches, making the compilation time increase
9062 with probably little benefit.  The default value is 100.
9063
9064 @item max-sched-region-blocks
9065 The maximum number of blocks in a region to be considered for
9066 interblock scheduling.  The default value is 10.
9067
9068 @item max-pipeline-region-blocks
9069 The maximum number of blocks in a region to be considered for
9070 pipelining in the selective scheduler.  The default value is 15.
9071
9072 @item max-sched-region-insns
9073 The maximum number of insns in a region to be considered for
9074 interblock scheduling.  The default value is 100.
9075
9076 @item max-pipeline-region-insns
9077 The maximum number of insns in a region to be considered for
9078 pipelining in the selective scheduler.  The default value is 200.
9079
9080 @item min-spec-prob
9081 The minimum probability (in percents) of reaching a source block
9082 for interblock speculative scheduling.  The default value is 40.
9083
9084 @item max-sched-extend-regions-iters
9085 The maximum number of iterations through CFG to extend regions.
9086 A value of 0 (the default) disables region extensions.
9087
9088 @item max-sched-insn-conflict-delay
9089 The maximum conflict delay for an insn to be considered for speculative motion.
9090 The default value is 3.
9091
9092 @item sched-spec-prob-cutoff
9093 The minimal probability of speculation success (in percents), so that
9094 speculative insns are scheduled.
9095 The default value is 40.
9096
9097 @item sched-mem-true-dep-cost
9098 Minimal distance (in CPU cycles) between store and load targeting same
9099 memory locations.  The default value is 1.
9100
9101 @item selsched-max-lookahead
9102 The maximum size of the lookahead window of selective scheduling.  It is a
9103 depth of search for available instructions.
9104 The default value is 50.
9105
9106 @item selsched-max-sched-times
9107 The maximum number of times that an instruction is scheduled during
9108 selective scheduling.  This is the limit on the number of iterations
9109 through which the instruction may be pipelined.  The default value is 2.
9110
9111 @item selsched-max-insns-to-rename
9112 The maximum number of best instructions in the ready list that are considered
9113 for renaming in the selective scheduler.  The default value is 2.
9114
9115 @item sms-min-sc
9116 The minimum value of stage count that swing modulo scheduler
9117 generates.  The default value is 2.
9118
9119 @item max-last-value-rtl
9120 The maximum size measured as number of RTLs that can be recorded in an expression
9121 in combiner for a pseudo register as last known value of that register.  The default
9122 is 10000.
9123
9124 @item integer-share-limit
9125 Small integer constants can use a shared data structure, reducing the
9126 compiler's memory usage and increasing its speed.  This sets the maximum
9127 value of a shared integer constant.  The default value is 256.
9128
9129 @item min-virtual-mappings
9130 Specifies the minimum number of virtual mappings in the incremental
9131 SSA updater that should be registered to trigger the virtual mappings
9132 heuristic defined by virtual-mappings-ratio.  The default value is
9133 100.
9134
9135 @item virtual-mappings-ratio
9136 If the number of virtual mappings is virtual-mappings-ratio bigger
9137 than the number of virtual symbols to be updated, then the incremental
9138 SSA updater switches to a full update for those symbols.  The default
9139 ratio is 3.
9140
9141 @item ssp-buffer-size
9142 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9143 protection when @option{-fstack-protection} is used.
9144
9145 @item max-jump-thread-duplication-stmts
9146 Maximum number of statements allowed in a block that needs to be
9147 duplicated when threading jumps.
9148
9149 @item max-fields-for-field-sensitive
9150 Maximum number of fields in a structure treated in
9151 a field sensitive manner during pointer analysis.  The default is zero
9152 for @option{-O0} and @option{-O1},
9153 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9154
9155 @item prefetch-latency
9156 Estimate on average number of instructions that are executed before
9157 prefetch finishes.  The distance we prefetch ahead is proportional
9158 to this constant.  Increasing this number may also lead to less
9159 streams being prefetched (see @option{simultaneous-prefetches}).
9160
9161 @item simultaneous-prefetches
9162 Maximum number of prefetches that can run at the same time.
9163
9164 @item l1-cache-line-size
9165 The size of cache line in L1 cache, in bytes.
9166
9167 @item l1-cache-size
9168 The size of L1 cache, in kilobytes.
9169
9170 @item l2-cache-size
9171 The size of L2 cache, in kilobytes.
9172
9173 @item min-insn-to-prefetch-ratio
9174 The minimum ratio between the number of instructions and the
9175 number of prefetches to enable prefetching in a loop.
9176
9177 @item prefetch-min-insn-to-mem-ratio
9178 The minimum ratio between the number of instructions and the
9179 number of memory references to enable prefetching in a loop.
9180
9181 @item use-canonical-types
9182 Whether the compiler should use the ``canonical'' type system.  By
9183 default, this should always be 1, which uses a more efficient internal
9184 mechanism for comparing types in C++ and Objective-C++.  However, if
9185 bugs in the canonical type system are causing compilation failures,
9186 set this value to 0 to disable canonical types.
9187
9188 @item switch-conversion-max-branch-ratio
9189 Switch initialization conversion refuses to create arrays that are
9190 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9191 branches in the switch.
9192
9193 @item max-partial-antic-length
9194 Maximum length of the partial antic set computed during the tree
9195 partial redundancy elimination optimization (@option{-ftree-pre}) when
9196 optimizing at @option{-O3} and above.  For some sorts of source code
9197 the enhanced partial redundancy elimination optimization can run away,
9198 consuming all of the memory available on the host machine.  This
9199 parameter sets a limit on the length of the sets that are computed,
9200 which prevents the runaway behavior.  Setting a value of 0 for
9201 this parameter allows an unlimited set length.
9202
9203 @item sccvn-max-scc-size
9204 Maximum size of a strongly connected component (SCC) during SCCVN
9205 processing.  If this limit is hit, SCCVN processing for the whole
9206 function is not done and optimizations depending on it are
9207 disabled.  The default maximum SCC size is 10000.
9208
9209 @item ira-max-loops-num
9210 IRA uses regional register allocation by default.  If a function
9211 contains more loops than the number given by this parameter, only at most
9212 the given number of the most frequently-executed loops form regions
9213 for regional register allocation.  The default value of the
9214 parameter is 100.
9215
9216 @item ira-max-conflict-table-size 
9217 Although IRA uses a sophisticated algorithm to compress the conflict
9218 table, the table can still require excessive amounts of memory for
9219 huge functions.  If the conflict table for a function could be more
9220 than the size in MB given by this parameter, the register allocator
9221 instead uses a faster, simpler, and lower-quality
9222 algorithm that does not require building a pseudo-register conflict table.  
9223 The default value of the parameter is 2000.
9224
9225 @item ira-loop-reserved-regs
9226 IRA can be used to evaluate more accurate register pressure in loops
9227 for decisions to move loop invariants (see @option{-O3}).  The number
9228 of available registers reserved for some other purposes is given
9229 by this parameter.  The default value of the parameter is 2, which is
9230 the minimal number of registers needed by typical instructions.
9231 This value is the best found from numerous experiments.
9232
9233 @item loop-invariant-max-bbs-in-loop
9234 Loop invariant motion can be very expensive, both in compilation time and
9235 in amount of needed compile-time memory, with very large loops.  Loops
9236 with more basic blocks than this parameter won't have loop invariant
9237 motion optimization performed on them.  The default value of the
9238 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9239
9240 @item loop-max-datarefs-for-datadeps
9241 Building data dapendencies is expensive for very large loops.  This
9242 parameter limits the number of data references in loops that are
9243 considered for data dependence analysis.  These large loops are no
9244 handled by the optimizations using loop data dependencies.
9245 The default value is 1000.
9246
9247 @item max-vartrack-size
9248 Sets a maximum number of hash table slots to use during variable
9249 tracking dataflow analysis of any function.  If this limit is exceeded
9250 with variable tracking at assignments enabled, analysis for that
9251 function is retried without it, after removing all debug insns from
9252 the function.  If the limit is exceeded even without debug insns, var
9253 tracking analysis is completely disabled for the function.  Setting
9254 the parameter to zero makes it unlimited.
9255
9256 @item max-vartrack-expr-depth
9257 Sets a maximum number of recursion levels when attempting to map
9258 variable names or debug temporaries to value expressions.  This trades
9259 compilation time for more complete debug information.  If this is set too
9260 low, value expressions that are available and could be represented in
9261 debug information may end up not being used; setting this higher may
9262 enable the compiler to find more complex debug expressions, but compile
9263 time and memory use may grow.  The default is 12.
9264
9265 @item min-nondebug-insn-uid
9266 Use uids starting at this parameter for nondebug insns.  The range below
9267 the parameter is reserved exclusively for debug insns created by
9268 @option{-fvar-tracking-assignments}, but debug insns may get
9269 (non-overlapping) uids above it if the reserved range is exhausted.
9270
9271 @item ipa-sra-ptr-growth-factor
9272 IPA-SRA replaces a pointer to an aggregate with one or more new
9273 parameters only when their cumulative size is less or equal to
9274 @option{ipa-sra-ptr-growth-factor} times the size of the original
9275 pointer parameter.
9276
9277 @item tm-max-aggregate-size
9278 When making copies of thread-local variables in a transaction, this
9279 parameter specifies the size in bytes after which variables are
9280 saved with the logging functions as opposed to save/restore code
9281 sequence pairs.  This option only applies when using
9282 @option{-fgnu-tm}.
9283
9284 @item graphite-max-nb-scop-params
9285 To avoid exponential effects in the Graphite loop transforms, the
9286 number of parameters in a Static Control Part (SCoP) is bounded.  The
9287 default value is 10 parameters.  A variable whose value is unknown at
9288 compilation time and defined outside a SCoP is a parameter of the SCoP.
9289
9290 @item graphite-max-bbs-per-function
9291 To avoid exponential effects in the detection of SCoPs, the size of
9292 the functions analyzed by Graphite is bounded.  The default value is
9293 100 basic blocks.
9294
9295 @item loop-block-tile-size
9296 Loop blocking or strip mining transforms, enabled with
9297 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
9298 loop in the loop nest by a given number of iterations.  The strip
9299 length can be changed using the @option{loop-block-tile-size}
9300 parameter.  The default value is 51 iterations.
9301
9302 @item ipa-cp-value-list-size
9303 IPA-CP attempts to track all possible values and types passed to a function's
9304 parameter in order to propagate them and perform devirtualization.
9305 @option{ipa-cp-value-list-size} is the maximum number of values and types it
9306 stores per one formal parameter of a function.
9307
9308 @item lto-partitions
9309 Specify desired number of partitions produced during WHOPR compilation.
9310 The number of partitions should exceed the number of CPUs used for compilation.
9311 The default value is 32.
9312
9313 @item lto-minpartition
9314 Size of minimal partition for WHOPR (in estimated instructions).
9315 This prevents expenses of splitting very small programs into too many
9316 partitions.
9317
9318 @item cxx-max-namespaces-for-diagnostic-help
9319 The maximum number of namespaces to consult for suggestions when C++
9320 name lookup fails for an identifier.  The default is 1000.
9321
9322 @item sink-frequency-threshold
9323 The maximum relative execution frequency (in percents) of the target block
9324 relative to a statement's original block to allow statement sinking of a
9325 statement.  Larger numbers result in more aggressive statement sinking.
9326 The default value is 75.  A small positive adjustment is applied for
9327 statements with memory operands as those are even more profitable so sink.
9328
9329 @item max-stores-to-sink
9330 The maximum number of conditional stores paires that can be sunk.  Set to 0
9331 if either vectorization (@option{-ftree-vectorize}) or if-conversion
9332 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
9333
9334 @item allow-load-data-races
9335 Allow optimizers to introduce new data races on loads.
9336 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9337 unless implicitly set by the @option{-fmemory-model=} option.
9338
9339 @item allow-store-data-races
9340 Allow optimizers to introduce new data races on stores.
9341 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9342 unless implicitly set by the @option{-fmemory-model=} option.
9343
9344 @item allow-packed-load-data-races
9345 Allow optimizers to introduce new data races on packed data loads.
9346 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9347 unless implicitly set by the @option{-fmemory-model=} option.
9348
9349 @item allow-packed-store-data-races
9350 Allow optimizers to introduce new data races on packed data stores.
9351 Set to 1 to allow, otherwise to 0.  This option is enabled by default
9352 unless implicitly set by the @option{-fmemory-model=} option.
9353
9354 @item case-values-threshold
9355 The smallest number of different values for which it is best to use a
9356 jump-table instead of a tree of conditional branches.  If the value is
9357 0, use the default for the machine.  The default is 0.
9358
9359 @item tree-reassoc-width
9360 Set the maximum number of instructions executed in parallel in
9361 reassociated tree. This parameter overrides target dependent
9362 heuristics used by default if has non zero value.
9363
9364 @item sched-pressure-algorithm
9365 Choose between the two available implementations of
9366 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
9367 and is the more likely to prevent instructions from being reordered.
9368 Algorithm 2 was designed to be a compromise between the relatively
9369 conservative approach taken by algorithm 1 and the rather aggressive
9370 approach taken by the default scheduler.  It relies more heavily on
9371 having a regular register file and accurate register pressure classes.
9372 See @file{haifa-sched.c} in the GCC sources for more details.
9373
9374 The default choice depends on the target.
9375 @end table
9376 @end table
9377
9378 @node Preprocessor Options
9379 @section Options Controlling the Preprocessor
9380 @cindex preprocessor options
9381 @cindex options, preprocessor
9382
9383 These options control the C preprocessor, which is run on each C source
9384 file before actual compilation.
9385
9386 If you use the @option{-E} option, nothing is done except preprocessing.
9387 Some of these options make sense only together with @option{-E} because
9388 they cause the preprocessor output to be unsuitable for actual
9389 compilation.
9390
9391 @table @gcctabopt
9392 @item -Wp,@var{option}
9393 @opindex Wp
9394 You can use @option{-Wp,@var{option}} to bypass the compiler driver
9395 and pass @var{option} directly through to the preprocessor.  If
9396 @var{option} contains commas, it is split into multiple options at the
9397 commas.  However, many options are modified, translated or interpreted
9398 by the compiler driver before being passed to the preprocessor, and
9399 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
9400 interface is undocumented and subject to change, so whenever possible
9401 you should avoid using @option{-Wp} and let the driver handle the
9402 options instead.
9403
9404 @item -Xpreprocessor @var{option}
9405 @opindex Xpreprocessor
9406 Pass @var{option} as an option to the preprocessor.  You can use this to
9407 supply system-specific preprocessor options that GCC does not know how to
9408 recognize.
9409
9410 If you want to pass an option that takes an argument, you must use
9411 @option{-Xpreprocessor} twice, once for the option and once for the argument.
9412
9413 @item -no-integrated-cpp
9414 @opindex no-integrated-cpp
9415 Perform preprocessing as a separate pass before compilation.
9416 By default, GCC performs preprocessing as an integrated part of
9417 input tokenization and parsing.
9418 If this option is provided, the appropriate language front end
9419 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
9420 and Objective-C, respectively) is instead invoked twice,
9421 once for preprocessing only and once for actual compilation
9422 of the preprocessed input.
9423 This option may be useful in conjunction with the @option{-B} or
9424 @option{-wrapper} options to specify an alternate preprocessor or
9425 perform additional processing of the program source between
9426 normal preprocessing and compilation.
9427 @end table
9428
9429 @include cppopts.texi
9430
9431 @node Assembler Options
9432 @section Passing Options to the Assembler
9433
9434 @c prevent bad page break with this line
9435 You can pass options to the assembler.
9436
9437 @table @gcctabopt
9438 @item -Wa,@var{option}
9439 @opindex Wa
9440 Pass @var{option} as an option to the assembler.  If @var{option}
9441 contains commas, it is split into multiple options at the commas.
9442
9443 @item -Xassembler @var{option}
9444 @opindex Xassembler
9445 Pass @var{option} as an option to the assembler.  You can use this to
9446 supply system-specific assembler options that GCC does not know how to
9447 recognize.
9448
9449 If you want to pass an option that takes an argument, you must use
9450 @option{-Xassembler} twice, once for the option and once for the argument.
9451
9452 @end table
9453
9454 @node Link Options
9455 @section Options for Linking
9456 @cindex link options
9457 @cindex options, linking
9458
9459 These options come into play when the compiler links object files into
9460 an executable output file.  They are meaningless if the compiler is
9461 not doing a link step.
9462
9463 @table @gcctabopt
9464 @cindex file names
9465 @item @var{object-file-name}
9466 A file name that does not end in a special recognized suffix is
9467 considered to name an object file or library.  (Object files are
9468 distinguished from libraries by the linker according to the file
9469 contents.)  If linking is done, these object files are used as input
9470 to the linker.
9471
9472 @item -c
9473 @itemx -S
9474 @itemx -E
9475 @opindex c
9476 @opindex S
9477 @opindex E
9478 If any of these options is used, then the linker is not run, and
9479 object file names should not be used as arguments.  @xref{Overall
9480 Options}.
9481
9482 @cindex Libraries
9483 @item -l@var{library}
9484 @itemx -l @var{library}
9485 @opindex l
9486 Search the library named @var{library} when linking.  (The second
9487 alternative with the library as a separate argument is only for
9488 POSIX compliance and is not recommended.)
9489
9490 It makes a difference where in the command you write this option; the
9491 linker searches and processes libraries and object files in the order they
9492 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
9493 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
9494 to functions in @samp{z}, those functions may not be loaded.
9495
9496 The linker searches a standard list of directories for the library,
9497 which is actually a file named @file{lib@var{library}.a}.  The linker
9498 then uses this file as if it had been specified precisely by name.
9499
9500 The directories searched include several standard system directories
9501 plus any that you specify with @option{-L}.
9502
9503 Normally the files found this way are library files---archive files
9504 whose members are object files.  The linker handles an archive file by
9505 scanning through it for members which define symbols that have so far
9506 been referenced but not defined.  But if the file that is found is an
9507 ordinary object file, it is linked in the usual fashion.  The only
9508 difference between using an @option{-l} option and specifying a file name
9509 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
9510 and searches several directories.
9511
9512 @item -lobjc
9513 @opindex lobjc
9514 You need this special case of the @option{-l} option in order to
9515 link an Objective-C or Objective-C++ program.
9516
9517 @item -nostartfiles
9518 @opindex nostartfiles
9519 Do not use the standard system startup files when linking.
9520 The standard system libraries are used normally, unless @option{-nostdlib}
9521 or @option{-nodefaultlibs} is used.
9522
9523 @item -nodefaultlibs
9524 @opindex nodefaultlibs
9525 Do not use the standard system libraries when linking.
9526 Only the libraries you specify are passed to the linker, and options
9527 specifying linkage of the system libraries, such as @code{-static-libgcc}
9528 or @code{-shared-libgcc}, are ignored.  
9529 The standard startup files are used normally, unless @option{-nostartfiles}
9530 is used.  The compiler may generate calls to @code{memcmp},
9531 @code{memset}, @code{memcpy} and @code{memmove}.
9532 These entries are usually resolved by entries in
9533 libc.  These entry points should be supplied through some other
9534 mechanism when this option is specified.
9535
9536 @item -nostdlib
9537 @opindex nostdlib
9538 Do not use the standard system startup files or libraries when linking.
9539 No startup files and only the libraries you specify are passed to
9540 the linker, and options specifying linkage of the system libraries, such as
9541 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
9542
9543 The compiler may generate calls to @code{memcmp}, @code{memset},
9544 @code{memcpy} and @code{memmove}.
9545 These entries are usually resolved by entries in
9546 libc.  These entry points should be supplied through some other
9547 mechanism when this option is specified.
9548
9549 @cindex @option{-lgcc}, use with @option{-nostdlib}
9550 @cindex @option{-nostdlib} and unresolved references
9551 @cindex unresolved references and @option{-nostdlib}
9552 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
9553 @cindex @option{-nodefaultlibs} and unresolved references
9554 @cindex unresolved references and @option{-nodefaultlibs}
9555 One of the standard libraries bypassed by @option{-nostdlib} and
9556 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
9557 which GCC uses to overcome shortcomings of particular machines, or special
9558 needs for some languages.
9559 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
9560 Collection (GCC) Internals},
9561 for more discussion of @file{libgcc.a}.)
9562 In most cases, you need @file{libgcc.a} even when you want to avoid
9563 other standard libraries.  In other words, when you specify @option{-nostdlib}
9564 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
9565 This ensures that you have no unresolved references to internal GCC
9566 library subroutines.
9567 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
9568 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
9569 GNU Compiler Collection (GCC) Internals}.)
9570
9571 @item -pie
9572 @opindex pie
9573 Produce a position independent executable on targets that support it.
9574 For predictable results, you must also specify the same set of options
9575 used for compilation (@option{-fpie}, @option{-fPIE},
9576 or model suboptions) when you specify this linker option.
9577
9578 @item -rdynamic
9579 @opindex rdynamic
9580 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
9581 that support it. This instructs the linker to add all symbols, not
9582 only used ones, to the dynamic symbol table. This option is needed
9583 for some uses of @code{dlopen} or to allow obtaining backtraces
9584 from within a program.
9585
9586 @item -s
9587 @opindex s
9588 Remove all symbol table and relocation information from the executable.
9589
9590 @item -static
9591 @opindex static
9592 On systems that support dynamic linking, this prevents linking with the shared
9593 libraries.  On other systems, this option has no effect.
9594
9595 @item -shared
9596 @opindex shared
9597 Produce a shared object which can then be linked with other objects to
9598 form an executable.  Not all systems support this option.  For predictable
9599 results, you must also specify the same set of options used for compilation
9600 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
9601 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
9602 needs to build supplementary stub code for constructors to work.  On
9603 multi-libbed systems, @samp{gcc -shared} must select the correct support
9604 libraries to link against.  Failing to supply the correct flags may lead
9605 to subtle defects.  Supplying them in cases where they are not necessary
9606 is innocuous.}
9607
9608 @item -shared-libgcc
9609 @itemx -static-libgcc
9610 @opindex shared-libgcc
9611 @opindex static-libgcc
9612 On systems that provide @file{libgcc} as a shared library, these options
9613 force the use of either the shared or static version respectively.
9614 If no shared version of @file{libgcc} was built when the compiler was
9615 configured, these options have no effect.
9616
9617 There are several situations in which an application should use the
9618 shared @file{libgcc} instead of the static version.  The most common
9619 of these is when the application wishes to throw and catch exceptions
9620 across different shared libraries.  In that case, each of the libraries
9621 as well as the application itself should use the shared @file{libgcc}.
9622
9623 Therefore, the G++ and GCJ drivers automatically add
9624 @option{-shared-libgcc} whenever you build a shared library or a main
9625 executable, because C++ and Java programs typically use exceptions, so
9626 this is the right thing to do.
9627
9628 If, instead, you use the GCC driver to create shared libraries, you may
9629 find that they are not always linked with the shared @file{libgcc}.
9630 If GCC finds, at its configuration time, that you have a non-GNU linker
9631 or a GNU linker that does not support option @option{--eh-frame-hdr},
9632 it links the shared version of @file{libgcc} into shared libraries
9633 by default.  Otherwise, it takes advantage of the linker and optimizes
9634 away the linking with the shared version of @file{libgcc}, linking with
9635 the static version of libgcc by default.  This allows exceptions to
9636 propagate through such shared libraries, without incurring relocation
9637 costs at library load time.
9638
9639 However, if a library or main executable is supposed to throw or catch
9640 exceptions, you must link it using the G++ or GCJ driver, as appropriate
9641 for the languages used in the program, or using the option
9642 @option{-shared-libgcc}, such that it is linked with the shared
9643 @file{libgcc}.
9644
9645 @item -static-libstdc++
9646 When the @command{g++} program is used to link a C++ program, it
9647 normally automatically links against @option{libstdc++}.  If
9648 @file{libstdc++} is available as a shared library, and the
9649 @option{-static} option is not used, then this links against the
9650 shared version of @file{libstdc++}.  That is normally fine.  However, it
9651 is sometimes useful to freeze the version of @file{libstdc++} used by
9652 the program without going all the way to a fully static link.  The
9653 @option{-static-libstdc++} option directs the @command{g++} driver to
9654 link @file{libstdc++} statically, without necessarily linking other
9655 libraries statically.
9656
9657 @item -symbolic
9658 @opindex symbolic
9659 Bind references to global symbols when building a shared object.  Warn
9660 about any unresolved references (unless overridden by the link editor
9661 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
9662 this option.
9663
9664 @item -T @var{script}
9665 @opindex T
9666 @cindex linker script
9667 Use @var{script} as the linker script.  This option is supported by most
9668 systems using the GNU linker.  On some targets, such as bare-board
9669 targets without an operating system, the @option{-T} option may be required
9670 when linking to avoid references to undefined symbols.
9671
9672 @item -Xlinker @var{option}
9673 @opindex Xlinker
9674 Pass @var{option} as an option to the linker.  You can use this to
9675 supply system-specific linker options that GCC does not recognize.
9676
9677 If you want to pass an option that takes a separate argument, you must use
9678 @option{-Xlinker} twice, once for the option and once for the argument.
9679 For example, to pass @option{-assert definitions}, you must write
9680 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
9681 @option{-Xlinker "-assert definitions"}, because this passes the entire
9682 string as a single argument, which is not what the linker expects.
9683
9684 When using the GNU linker, it is usually more convenient to pass
9685 arguments to linker options using the @option{@var{option}=@var{value}}
9686 syntax than as separate arguments.  For example, you can specify
9687 @option{-Xlinker -Map=output.map} rather than
9688 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
9689 this syntax for command-line options.
9690
9691 @item -Wl,@var{option}
9692 @opindex Wl
9693 Pass @var{option} as an option to the linker.  If @var{option} contains
9694 commas, it is split into multiple options at the commas.  You can use this
9695 syntax to pass an argument to the option.
9696 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
9697 linker.  When using the GNU linker, you can also get the same effect with
9698 @option{-Wl,-Map=output.map}.
9699
9700 @item -u @var{symbol}
9701 @opindex u
9702 Pretend the symbol @var{symbol} is undefined, to force linking of
9703 library modules to define it.  You can use @option{-u} multiple times with
9704 different symbols to force loading of additional library modules.
9705 @end table
9706
9707 @node Directory Options
9708 @section Options for Directory Search
9709 @cindex directory options
9710 @cindex options, directory search
9711 @cindex search path
9712
9713 These options specify directories to search for header files, for
9714 libraries and for parts of the compiler:
9715
9716 @table @gcctabopt
9717 @item -I@var{dir}
9718 @opindex I
9719 Add the directory @var{dir} to the head of the list of directories to be
9720 searched for header files.  This can be used to override a system header
9721 file, substituting your own version, since these directories are
9722 searched before the system header file directories.  However, you should
9723 not use this option to add directories that contain vendor-supplied
9724 system header files (use @option{-isystem} for that).  If you use more than
9725 one @option{-I} option, the directories are scanned in left-to-right
9726 order; the standard system directories come after.
9727
9728 If a standard system include directory, or a directory specified with
9729 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
9730 option is ignored.  The directory is still searched but as a
9731 system directory at its normal position in the system include chain.
9732 This is to ensure that GCC's procedure to fix buggy system headers and
9733 the ordering for the @code{include_next} directive are not inadvertently changed.
9734 If you really need to change the search order for system directories,
9735 use the @option{-nostdinc} and/or @option{-isystem} options.
9736
9737 @item -iplugindir=@var{dir}
9738 Set the directory to search for plugins that are passed
9739 by @option{-fplugin=@var{name}} instead of
9740 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
9741 to be used by the user, but only passed by the driver.
9742
9743 @item -iquote@var{dir}
9744 @opindex iquote
9745 Add the directory @var{dir} to the head of the list of directories to
9746 be searched for header files only for the case of @samp{#include
9747 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
9748 otherwise just like @option{-I}.
9749
9750 @item -L@var{dir}
9751 @opindex L
9752 Add directory @var{dir} to the list of directories to be searched
9753 for @option{-l}.
9754
9755 @item -B@var{prefix}
9756 @opindex B
9757 This option specifies where to find the executables, libraries,
9758 include files, and data files of the compiler itself.
9759
9760 The compiler driver program runs one or more of the subprograms
9761 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
9762 @var{prefix} as a prefix for each program it tries to run, both with and
9763 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9764
9765 For each subprogram to be run, the compiler driver first tries the
9766 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9767 is not specified, the driver tries two standard prefixes, 
9768 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9769 those results in a file name that is found, the unmodified program
9770 name is searched for using the directories specified in your
9771 @env{PATH} environment variable.
9772
9773 The compiler checks to see if the path provided by the @option{-B}
9774 refers to a directory, and if necessary it adds a directory
9775 separator character at the end of the path.
9776
9777 @option{-B} prefixes that effectively specify directory names also apply
9778 to libraries in the linker, because the compiler translates these
9779 options into @option{-L} options for the linker.  They also apply to
9780 includes files in the preprocessor, because the compiler translates these
9781 options into @option{-isystem} options for the preprocessor.  In this case,
9782 the compiler appends @samp{include} to the prefix.
9783
9784 The runtime support file @file{libgcc.a} can also be searched for using
9785 the @option{-B} prefix, if needed.  If it is not found there, the two
9786 standard prefixes above are tried, and that is all.  The file is left
9787 out of the link if it is not found by those means.
9788
9789 Another way to specify a prefix much like the @option{-B} prefix is to use
9790 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9791 Variables}.
9792
9793 As a special kludge, if the path provided by @option{-B} is
9794 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9795 9, then it is replaced by @file{[dir/]include}.  This is to help
9796 with boot-strapping the compiler.
9797
9798 @item -specs=@var{file}
9799 @opindex specs
9800 Process @var{file} after the compiler reads in the standard @file{specs}
9801 file, in order to override the defaults which the @command{gcc} driver
9802 program uses when determining what switches to pass to @command{cc1},
9803 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
9804 @option{-specs=@var{file}} can be specified on the command line, and they
9805 are processed in order, from left to right.
9806
9807 @item --sysroot=@var{dir}
9808 @opindex sysroot
9809 Use @var{dir} as the logical root directory for headers and libraries.
9810 For example, if the compiler normally searches for headers in
9811 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
9812 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9813
9814 If you use both this option and the @option{-isysroot} option, then
9815 the @option{--sysroot} option applies to libraries, but the
9816 @option{-isysroot} option applies to header files.
9817
9818 The GNU linker (beginning with version 2.16) has the necessary support
9819 for this option.  If your linker does not support this option, the
9820 header file aspect of @option{--sysroot} still works, but the
9821 library aspect does not.
9822
9823 @item -I-
9824 @opindex I-
9825 This option has been deprecated.  Please use @option{-iquote} instead for
9826 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9827 Any directories you specify with @option{-I} options before the @option{-I-}
9828 option are searched only for the case of @samp{#include "@var{file}"};
9829 they are not searched for @samp{#include <@var{file}>}.
9830
9831 If additional directories are specified with @option{-I} options after
9832 the @option{-I-}, these directories are searched for all @samp{#include}
9833 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9834 this way.)
9835
9836 In addition, the @option{-I-} option inhibits the use of the current
9837 directory (where the current input file came from) as the first search
9838 directory for @samp{#include "@var{file}"}.  There is no way to
9839 override this effect of @option{-I-}.  With @option{-I.} you can specify
9840 searching the directory that is current when the compiler is
9841 invoked.  That is not exactly the same as what the preprocessor does
9842 by default, but it is often satisfactory.
9843
9844 @option{-I-} does not inhibit the use of the standard system directories
9845 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9846 independent.
9847 @end table
9848
9849 @c man end
9850
9851 @node Spec Files
9852 @section Specifying subprocesses and the switches to pass to them
9853 @cindex Spec Files
9854
9855 @command{gcc} is a driver program.  It performs its job by invoking a
9856 sequence of other programs to do the work of compiling, assembling and
9857 linking.  GCC interprets its command-line parameters and uses these to
9858 deduce which programs it should invoke, and which command-line options
9859 it ought to place on their command lines.  This behavior is controlled
9860 by @dfn{spec strings}.  In most cases there is one spec string for each
9861 program that GCC can invoke, but a few programs have multiple spec
9862 strings to control their behavior.  The spec strings built into GCC can
9863 be overridden by using the @option{-specs=} command-line switch to specify
9864 a spec file.
9865
9866 @dfn{Spec files} are plaintext files that are used to construct spec
9867 strings.  They consist of a sequence of directives separated by blank
9868 lines.  The type of directive is determined by the first non-whitespace
9869 character on the line, which can be one of the following:
9870
9871 @table @code
9872 @item %@var{command}
9873 Issues a @var{command} to the spec file processor.  The commands that can
9874 appear here are:
9875
9876 @table @code
9877 @item %include <@var{file}>
9878 @cindex @code{%include}
9879 Search for @var{file} and insert its text at the current point in the
9880 specs file.
9881
9882 @item %include_noerr <@var{file}>
9883 @cindex @code{%include_noerr}
9884 Just like @samp{%include}, but do not generate an error message if the include
9885 file cannot be found.
9886
9887 @item %rename @var{old_name} @var{new_name}
9888 @cindex @code{%rename}
9889 Rename the spec string @var{old_name} to @var{new_name}.
9890
9891 @end table
9892
9893 @item *[@var{spec_name}]:
9894 This tells the compiler to create, override or delete the named spec
9895 string.  All lines after this directive up to the next directive or
9896 blank line are considered to be the text for the spec string.  If this
9897 results in an empty string then the spec is deleted.  (Or, if the
9898 spec did not exist, then nothing happens.)  Otherwise, if the spec
9899 does not currently exist a new spec is created.  If the spec does
9900 exist then its contents are overridden by the text of this
9901 directive, unless the first character of that text is the @samp{+}
9902 character, in which case the text is appended to the spec.
9903
9904 @item [@var{suffix}]:
9905 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9906 and up to the next directive or blank line are considered to make up the
9907 spec string for the indicated suffix.  When the compiler encounters an
9908 input file with the named suffix, it processes the spec string in
9909 order to work out how to compile that file.  For example:
9910
9911 @smallexample
9912 .ZZ:
9913 z-compile -input %i
9914 @end smallexample
9915
9916 This says that any input file whose name ends in @samp{.ZZ} should be
9917 passed to the program @samp{z-compile}, which should be invoked with the
9918 command-line switch @option{-input} and with the result of performing the
9919 @samp{%i} substitution.  (See below.)
9920
9921 As an alternative to providing a spec string, the text that follows a
9922 suffix directive can be one of the following:
9923
9924 @table @code
9925 @item @@@var{language}
9926 This says that the suffix is an alias for a known @var{language}.  This is
9927 similar to using the @option{-x} command-line switch to GCC to specify a
9928 language explicitly.  For example:
9929
9930 @smallexample
9931 .ZZ:
9932 @@c++
9933 @end smallexample
9934
9935 Says that .ZZ files are, in fact, C++ source files.
9936
9937 @item #@var{name}
9938 This causes an error messages saying:
9939
9940 @smallexample
9941 @var{name} compiler not installed on this system.
9942 @end smallexample
9943 @end table
9944
9945 GCC already has an extensive list of suffixes built into it.
9946 This directive adds an entry to the end of the list of suffixes, but
9947 since the list is searched from the end backwards, it is effectively
9948 possible to override earlier entries using this technique.
9949
9950 @end table
9951
9952 GCC has the following spec strings built into it.  Spec files can
9953 override these strings or create their own.  Note that individual
9954 targets can also add their own spec strings to this list.
9955
9956 @smallexample
9957 asm          Options to pass to the assembler
9958 asm_final    Options to pass to the assembler post-processor
9959 cpp          Options to pass to the C preprocessor
9960 cc1          Options to pass to the C compiler
9961 cc1plus      Options to pass to the C++ compiler
9962 endfile      Object files to include at the end of the link
9963 link         Options to pass to the linker
9964 lib          Libraries to include on the command line to the linker
9965 libgcc       Decides which GCC support library to pass to the linker
9966 linker       Sets the name of the linker
9967 predefines   Defines to be passed to the C preprocessor
9968 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9969              by default
9970 startfile    Object files to include at the start of the link
9971 @end smallexample
9972
9973 Here is a small example of a spec file:
9974
9975 @smallexample
9976 %rename lib                 old_lib
9977
9978 *lib:
9979 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9980 @end smallexample
9981
9982 This example renames the spec called @samp{lib} to @samp{old_lib} and
9983 then overrides the previous definition of @samp{lib} with a new one.
9984 The new definition adds in some extra command-line options before
9985 including the text of the old definition.
9986
9987 @dfn{Spec strings} are a list of command-line options to be passed to their
9988 corresponding program.  In addition, the spec strings can contain
9989 @samp{%}-prefixed sequences to substitute variable text or to
9990 conditionally insert text into the command line.  Using these constructs
9991 it is possible to generate quite complex command lines.
9992
9993 Here is a table of all defined @samp{%}-sequences for spec
9994 strings.  Note that spaces are not generated automatically around the
9995 results of expanding these sequences.  Therefore you can concatenate them
9996 together or combine them with constant text in a single argument.
9997
9998 @table @code
9999 @item %%
10000 Substitute one @samp{%} into the program name or argument.
10001
10002 @item %i
10003 Substitute the name of the input file being processed.
10004
10005 @item %b
10006 Substitute the basename of the input file being processed.
10007 This is the substring up to (and not including) the last period
10008 and not including the directory.
10009
10010 @item %B
10011 This is the same as @samp{%b}, but include the file suffix (text after
10012 the last period).
10013
10014 @item %d
10015 Marks the argument containing or following the @samp{%d} as a
10016 temporary file name, so that that file is deleted if GCC exits
10017 successfully.  Unlike @samp{%g}, this contributes no text to the
10018 argument.
10019
10020 @item %g@var{suffix}
10021 Substitute a file name that has suffix @var{suffix} and is chosen
10022 once per compilation, and mark the argument in the same way as
10023 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10024 name is now chosen in a way that is hard to predict even when previously
10025 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10026 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10027 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10028 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10029 was simply substituted with a file name chosen once per compilation,
10030 without regard to any appended suffix (which was therefore treated
10031 just like ordinary text), making such attacks more likely to succeed.
10032
10033 @item %u@var{suffix}
10034 Like @samp{%g}, but generates a new temporary file name
10035 each time it appears instead of once per compilation.
10036
10037 @item %U@var{suffix}
10038 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10039 new one if there is no such last file name.  In the absence of any
10040 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10041 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10042 involves the generation of two distinct file names, one
10043 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10044 simply substituted with a file name chosen for the previous @samp{%u},
10045 without regard to any appended suffix.
10046
10047 @item %j@var{suffix}
10048 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10049 writable, and if @option{-save-temps} is not used; 
10050 otherwise, substitute the name
10051 of a temporary file, just like @samp{%u}.  This temporary file is not
10052 meant for communication between processes, but rather as a junk
10053 disposal mechanism.
10054
10055 @item %|@var{suffix}
10056 @itemx %m@var{suffix}
10057 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10058 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10059 all.  These are the two most common ways to instruct a program that it
10060 should read from standard input or write to standard output.  If you
10061 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10062 construct: see for example @file{f/lang-specs.h}.
10063
10064 @item %.@var{SUFFIX}
10065 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10066 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10067 terminated by the next space or %.
10068
10069 @item %w
10070 Marks the argument containing or following the @samp{%w} as the
10071 designated output file of this compilation.  This puts the argument
10072 into the sequence of arguments that @samp{%o} substitutes.
10073
10074 @item %o
10075 Substitutes the names of all the output files, with spaces
10076 automatically placed around them.  You should write spaces
10077 around the @samp{%o} as well or the results are undefined.
10078 @samp{%o} is for use in the specs for running the linker.
10079 Input files whose names have no recognized suffix are not compiled
10080 at all, but they are included among the output files, so they are
10081 linked.
10082
10083 @item %O
10084 Substitutes the suffix for object files.  Note that this is
10085 handled specially when it immediately follows @samp{%g, %u, or %U},
10086 because of the need for those to form complete file names.  The
10087 handling is such that @samp{%O} is treated exactly as if it had already
10088 been substituted, except that @samp{%g, %u, and %U} do not currently
10089 support additional @var{suffix} characters following @samp{%O} as they do
10090 following, for example, @samp{.o}.
10091
10092 @item %p
10093 Substitutes the standard macro predefinitions for the
10094 current target machine.  Use this when running @code{cpp}.
10095
10096 @item %P
10097 Like @samp{%p}, but puts @samp{__} before and after the name of each
10098 predefined macro, except for macros that start with @samp{__} or with
10099 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10100 C@.
10101
10102 @item %I
10103 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10104 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10105 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10106 and @option{-imultilib} as necessary.
10107
10108 @item %s
10109 Current argument is the name of a library or startup file of some sort.
10110 Search for that file in a standard list of directories and substitute
10111 the full name found.  The current working directory is included in the
10112 list of directories scanned.
10113
10114 @item %T
10115 Current argument is the name of a linker script.  Search for that file
10116 in the current list of directories to scan for libraries. If the file
10117 is located insert a @option{--script} option into the command line
10118 followed by the full path name found.  If the file is not found then
10119 generate an error message.  Note: the current working directory is not
10120 searched.
10121
10122 @item %e@var{str}
10123 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10124 Use this when inconsistent options are detected.
10125
10126 @item %(@var{name})
10127 Substitute the contents of spec string @var{name} at this point.
10128
10129 @item %x@{@var{option}@}
10130 Accumulate an option for @samp{%X}.
10131
10132 @item %X
10133 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10134 spec string.
10135
10136 @item %Y
10137 Output the accumulated assembler options specified by @option{-Wa}.
10138
10139 @item %Z
10140 Output the accumulated preprocessor options specified by @option{-Wp}.
10141
10142 @item %a
10143 Process the @code{asm} spec.  This is used to compute the
10144 switches to be passed to the assembler.
10145
10146 @item %A
10147 Process the @code{asm_final} spec.  This is a spec string for
10148 passing switches to an assembler post-processor, if such a program is
10149 needed.
10150
10151 @item %l
10152 Process the @code{link} spec.  This is the spec for computing the
10153 command line passed to the linker.  Typically it makes use of the
10154 @samp{%L %G %S %D and %E} sequences.
10155
10156 @item %D
10157 Dump out a @option{-L} option for each directory that GCC believes might
10158 contain startup files.  If the target supports multilibs then the
10159 current multilib directory is prepended to each of these paths.
10160
10161 @item %L
10162 Process the @code{lib} spec.  This is a spec string for deciding which
10163 libraries are included on the command line to the linker.
10164
10165 @item %G
10166 Process the @code{libgcc} spec.  This is a spec string for deciding
10167 which GCC support library is included on the command line to the linker.
10168
10169 @item %S
10170 Process the @code{startfile} spec.  This is a spec for deciding which
10171 object files are the first ones passed to the linker.  Typically
10172 this might be a file named @file{crt0.o}.
10173
10174 @item %E
10175 Process the @code{endfile} spec.  This is a spec string that specifies
10176 the last object files that are passed to the linker.
10177
10178 @item %C
10179 Process the @code{cpp} spec.  This is used to construct the arguments
10180 to be passed to the C preprocessor.
10181
10182 @item %1
10183 Process the @code{cc1} spec.  This is used to construct the options to be
10184 passed to the actual C compiler (@samp{cc1}).
10185
10186 @item %2
10187 Process the @code{cc1plus} spec.  This is used to construct the options to be
10188 passed to the actual C++ compiler (@samp{cc1plus}).
10189
10190 @item %*
10191 Substitute the variable part of a matched option.  See below.
10192 Note that each comma in the substituted string is replaced by
10193 a single space.
10194
10195 @item %<@code{S}
10196 Remove all occurrences of @code{-S} from the command line.  Note---this
10197 command is position dependent.  @samp{%} commands in the spec string
10198 before this one see @code{-S}, @samp{%} commands in the spec string
10199 after this one do not.
10200
10201 @item %:@var{function}(@var{args})
10202 Call the named function @var{function}, passing it @var{args}.
10203 @var{args} is first processed as a nested spec string, then split
10204 into an argument vector in the usual fashion.  The function returns
10205 a string which is processed as if it had appeared literally as part
10206 of the current spec.
10207
10208 The following built-in spec functions are provided:
10209
10210 @table @code
10211 @item @code{getenv}
10212 The @code{getenv} spec function takes two arguments: an environment
10213 variable name and a string.  If the environment variable is not
10214 defined, a fatal error is issued.  Otherwise, the return value is the
10215 value of the environment variable concatenated with the string.  For
10216 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
10217
10218 @smallexample
10219 %:getenv(TOPDIR /include)
10220 @end smallexample
10221
10222 expands to @file{/path/to/top/include}.
10223
10224 @item @code{if-exists}
10225 The @code{if-exists} spec function takes one argument, an absolute
10226 pathname to a file.  If the file exists, @code{if-exists} returns the
10227 pathname.  Here is a small example of its usage:
10228
10229 @smallexample
10230 *startfile:
10231 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
10232 @end smallexample
10233
10234 @item @code{if-exists-else}
10235 The @code{if-exists-else} spec function is similar to the @code{if-exists}
10236 spec function, except that it takes two arguments.  The first argument is
10237 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
10238 returns the pathname.  If it does not exist, it returns the second argument.
10239 This way, @code{if-exists-else} can be used to select one file or another,
10240 based on the existence of the first.  Here is a small example of its usage:
10241
10242 @smallexample
10243 *startfile:
10244 crt0%O%s %:if-exists(crti%O%s) \
10245 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
10246 @end smallexample
10247
10248 @item @code{replace-outfile}
10249 The @code{replace-outfile} spec function takes two arguments.  It looks for the
10250 first argument in the outfiles array and replaces it with the second argument.  Here
10251 is a small example of its usage:
10252
10253 @smallexample
10254 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
10255 @end smallexample
10256
10257 @item @code{remove-outfile}
10258 The @code{remove-outfile} spec function takes one argument.  It looks for the
10259 first argument in the outfiles array and removes it.  Here is a small example
10260 its usage:
10261
10262 @smallexample
10263 %:remove-outfile(-lm)
10264 @end smallexample
10265
10266 @item @code{pass-through-libs}
10267 The @code{pass-through-libs} spec function takes any number of arguments.  It
10268 finds any @option{-l} options and any non-options ending in @file{.a} (which it
10269 assumes are the names of linker input library archive files) and returns a
10270 result containing all the found arguments each prepended by
10271 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
10272 intended to be passed to the LTO linker plugin.
10273
10274 @smallexample
10275 %:pass-through-libs(%G %L %G)
10276 @end smallexample
10277
10278 @item @code{print-asm-header}
10279 The @code{print-asm-header} function takes no arguments and simply
10280 prints a banner like:
10281
10282 @smallexample
10283 Assembler options
10284 =================
10285
10286 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
10287 @end smallexample
10288
10289 It is used to separate compiler options from assembler options
10290 in the @option{--target-help} output.
10291 @end table
10292
10293 @item %@{@code{S}@}
10294 Substitutes the @code{-S} switch, if that switch is given to GCC@.
10295 If that switch is not specified, this substitutes nothing.  Note that
10296 the leading dash is omitted when specifying this option, and it is
10297 automatically inserted if the substitution is performed.  Thus the spec
10298 string @samp{%@{foo@}} matches the command-line option @option{-foo}
10299 and outputs the command-line option @option{-foo}.
10300
10301 @item %W@{@code{S}@}
10302 Like %@{@code{S}@} but mark last argument supplied within as a file to be
10303 deleted on failure.
10304
10305 @item %@{@code{S}*@}
10306 Substitutes all the switches specified to GCC whose names start
10307 with @code{-S}, but which also take an argument.  This is used for
10308 switches like @option{-o}, @option{-D}, @option{-I}, etc.
10309 GCC considers @option{-o foo} as being
10310 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
10311 text, including the space.  Thus two arguments are generated.
10312
10313 @item %@{@code{S}*&@code{T}*@}
10314 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
10315 (the order of @code{S} and @code{T} in the spec is not significant).
10316 There can be any number of ampersand-separated variables; for each the
10317 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
10318
10319 @item %@{@code{S}:@code{X}@}
10320 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
10321
10322 @item %@{!@code{S}:@code{X}@}
10323 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
10324
10325 @item %@{@code{S}*:@code{X}@}
10326 Substitutes @code{X} if one or more switches whose names start with
10327 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
10328 once, no matter how many such switches appeared.  However, if @code{%*}
10329 appears somewhere in @code{X}, then @code{X} is substituted once
10330 for each matching switch, with the @code{%*} replaced by the part of
10331 that switch matching the @code{*}.
10332
10333 @item %@{.@code{S}:@code{X}@}
10334 Substitutes @code{X}, if processing a file with suffix @code{S}.
10335
10336 @item %@{!.@code{S}:@code{X}@}
10337 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
10338
10339 @item %@{,@code{S}:@code{X}@}
10340 Substitutes @code{X}, if processing a file for language @code{S}.
10341
10342 @item %@{!,@code{S}:@code{X}@}
10343 Substitutes @code{X}, if not processing a file for language @code{S}.
10344
10345 @item %@{@code{S}|@code{P}:@code{X}@}
10346 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
10347 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
10348 @code{*} sequences as well, although they have a stronger binding than
10349 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
10350 alternatives must be starred, and only the first matching alternative
10351 is substituted.
10352
10353 For example, a spec string like this:
10354
10355 @smallexample
10356 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
10357 @end smallexample
10358
10359 @noindent
10360 outputs the following command-line options from the following input
10361 command-line options:
10362
10363 @smallexample
10364 fred.c        -foo -baz
10365 jim.d         -bar -boggle
10366 -d fred.c     -foo -baz -boggle
10367 -d jim.d      -bar -baz -boggle
10368 @end smallexample
10369
10370 @item %@{S:X; T:Y; :D@}
10371
10372 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
10373 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
10374 be as many clauses as you need.  This may be combined with @code{.},
10375 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
10376
10377
10378 @end table
10379
10380 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
10381 construct may contain other nested @samp{%} constructs or spaces, or
10382 even newlines.  They are processed as usual, as described above.
10383 Trailing white space in @code{X} is ignored.  White space may also
10384 appear anywhere on the left side of the colon in these constructs,
10385 except between @code{.} or @code{*} and the corresponding word.
10386
10387 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
10388 handled specifically in these constructs.  If another value of
10389 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
10390 @option{-W} switch is found later in the command line, the earlier
10391 switch value is ignored, except with @{@code{S}*@} where @code{S} is
10392 just one letter, which passes all matching options.
10393
10394 The character @samp{|} at the beginning of the predicate text is used to
10395 indicate that a command should be piped to the following command, but
10396 only if @option{-pipe} is specified.
10397
10398 It is built into GCC which switches take arguments and which do not.
10399 (You might think it would be useful to generalize this to allow each
10400 compiler's spec to say which switches take arguments.  But this cannot
10401 be done in a consistent fashion.  GCC cannot even decide which input
10402 files have been specified without knowing which switches take arguments,
10403 and it must know which input files to compile in order to tell which
10404 compilers to run).
10405
10406 GCC also knows implicitly that arguments starting in @option{-l} are to be
10407 treated as compiler output files, and passed to the linker in their
10408 proper position among the other output files.
10409
10410 @c man begin OPTIONS
10411
10412 @node Target Options
10413 @section Specifying Target Machine and Compiler Version
10414 @cindex target options
10415 @cindex cross compiling
10416 @cindex specifying machine version
10417 @cindex specifying compiler version and target machine
10418 @cindex compiler version, specifying
10419 @cindex target machine, specifying
10420
10421 The usual way to run GCC is to run the executable called @command{gcc}, or
10422 @command{@var{machine}-gcc} when cross-compiling, or
10423 @command{@var{machine}-gcc-@var{version}} to run a version other than the
10424 one that was installed last.
10425
10426 @node Submodel Options
10427 @section Hardware Models and Configurations
10428 @cindex submodel options
10429 @cindex specifying hardware config
10430 @cindex hardware models and configurations, specifying
10431 @cindex machine dependent options
10432
10433 Each target machine types can have its own
10434 special options, starting with @samp{-m}, to choose among various
10435 hardware models or configurations---for example, 68010 vs 68020,
10436 floating coprocessor or none.  A single installed version of the
10437 compiler can compile for any model or configuration, according to the
10438 options specified.
10439
10440 Some configurations of the compiler also support additional special
10441 options, usually for compatibility with other compilers on the same
10442 platform.
10443
10444 @c This list is ordered alphanumerically by subsection name.
10445 @c It should be the same order and spelling as these options are listed
10446 @c in Machine Dependent Options
10447
10448 @menu
10449 * Adapteva Epiphany Options::
10450 * ARM Options::
10451 * AVR Options::
10452 * Blackfin Options::
10453 * C6X Options::
10454 * CRIS Options::
10455 * CR16 Options::
10456 * Darwin Options::
10457 * DEC Alpha Options::
10458 * FR30 Options::
10459 * FRV Options::
10460 * GNU/Linux Options::
10461 * H8/300 Options::
10462 * HPPA Options::
10463 * i386 and x86-64 Options::
10464 * i386 and x86-64 Windows Options::
10465 * IA-64 Options::
10466 * LM32 Options::
10467 * M32C Options::
10468 * M32R/D Options::
10469 * M680x0 Options::
10470 * MCore Options::
10471 * MeP Options::
10472 * MicroBlaze Options::
10473 * MIPS Options::
10474 * MMIX Options::
10475 * MN10300 Options::
10476 * PDP-11 Options::
10477 * picoChip Options::
10478 * PowerPC Options::
10479 * RL78 Options::
10480 * RS/6000 and PowerPC Options::
10481 * RX Options::
10482 * S/390 and zSeries Options::
10483 * Score Options::
10484 * SH Options::
10485 * Solaris 2 Options::
10486 * SPARC Options::
10487 * SPU Options::
10488 * System V Options::
10489 * TILE-Gx Options::
10490 * TILEPro Options::
10491 * V850 Options::
10492 * VAX Options::
10493 * VMS Options::
10494 * VxWorks Options::
10495 * x86-64 Options::
10496 * Xstormy16 Options::
10497 * Xtensa Options::
10498 * zSeries Options::
10499 @end menu
10500
10501 @node Adapteva Epiphany Options
10502 @subsection Adapteva Epiphany Options
10503
10504 These @samp{-m} options are defined for Adapteva Epiphany:
10505
10506 @table @gcctabopt
10507 @item -mhalf-reg-file
10508 @opindex mhalf-reg-file
10509 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
10510 That allows code to run on hardware variants that lack these registers.
10511
10512 @item -mprefer-short-insn-regs
10513 @opindex mprefer-short-insn-regs
10514 Preferrentially allocate registers that allow short instruction generation.
10515 This can result in increasesd instruction count, so if this reduces or
10516 increases code size might vary from case to case.
10517
10518 @item -mbranch-cost=@var{num}
10519 @opindex mbranch-cost
10520 Set the cost of branches to roughly @var{num} ``simple'' instructions.
10521 This cost is only a heuristic and is not guaranteed to produce
10522 consistent results across releases.
10523
10524 @item -mcmove
10525 @opindex mcmove
10526 Enable the generation of conditional moves.
10527
10528 @item -mnops=@var{num}
10529 @opindex mnops
10530 Emit @var{num} nops before every other generated instruction.
10531
10532 @item -mno-soft-cmpsf
10533 @opindex mno-soft-cmpsf
10534 For single-precision floating-point comparisons, emit an @code{fsub} instruction
10535 and test the flags.  This is faster than a software comparison, but can
10536 get incorrect results in the presence of NaNs, or when two different small
10537 numbers are compared such that their difference is calculated as zero.
10538 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
10539 software comparisons.
10540
10541 @item -mstack-offset=@var{num}
10542 @opindex mstack-offset
10543 Set the offset between the top of the stack and the stack pointer.
10544 E.g., a value of 8 means that the eight bytes in the range sp+0@dots{}sp+7
10545 can be used by leaf functions without stack allocation.
10546 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
10547 Note also that this option changes the ABI, compiling a program with a
10548 different stack offset than the libraries have been compiled with
10549 generally does not work.
10550 This option can be useful if you want to evaluate if a different stack
10551 offset would give you better code, but to actually use a different stack
10552 offset to build working programs, it is recommended to configure the
10553 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
10554
10555 @item -mno-round-nearest
10556 @opindex mno-round-nearest
10557 Make the scheduler assume that the rounding mode has been set to
10558 truncating.  The default is @option{-mround-nearest}.
10559
10560 @item -mlong-calls
10561 @opindex mlong-calls
10562 If not otherwise specified by an attribute, assume all calls might be beyond
10563 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
10564 function address into a register before performing a (otherwise direct) call.
10565 This is the default.
10566
10567 @item -mshort-calls
10568 @opindex short-calls
10569 If not otherwise specified by an attribute, assume all direct calls are
10570 in the range of the @code{b} / @code{bl} instructions, so use these instructions
10571 for direct calls.  The default is @option{-mlong-calls}.
10572
10573 @item -msmall16
10574 @opindex msmall16
10575 Assume addresses can be loaded as 16-bit unsigned values.  This does not
10576 apply to function addresses for which @option{-mlong-calls} semantics
10577 are in effect.
10578
10579 @item -mfp-mode=@var{mode}
10580 @opindex mfp-mode
10581 Set the prevailing mode of the floating-point unit.
10582 This determines the floating-point mode that is provided and expected
10583 at function call and return time.  Making this mode match the mode you
10584 predominantly need at function start can make your programs smaller and
10585 faster by avoiding unnecessary mode switches.
10586
10587 @var{mode} can be set to one the following values:
10588
10589 @table @samp
10590 @item caller
10591 Any mode at function entry is valid, and retained or restored when
10592 the function returns, and when it calls other functions.
10593 This mode is useful for compiling libraries or other compilation units
10594 you might want to incorporate into different programs with different
10595 prevailing FPU modes, and the convenience of being able to use a single
10596 object file outweighs the size and speed overhead for any extra
10597 mode switching that might be needed, compared with what would be needed
10598 with a more specific choice of prevailing FPU mode.
10599
10600 @item truncate
10601 This is the mode used for floating-point calculations with
10602 truncating (i.e.@: round towards zero) rounding mode.  That includes
10603 conversion from floating point to integer.
10604
10605 @item round-nearest
10606 This is the mode used for floating-point calculations with
10607 round-to-nearest-or-even rounding mode.
10608
10609 @item int
10610 This is the mode used to perform integer calculations in the FPU, e.g.@:
10611 integer multiply, or integer multiply-and-accumulate.
10612 @end table
10613
10614 The default is @option{-mfp-mode=caller}
10615
10616 @item -mnosplit-lohi
10617 @opindex mnosplit-lohi
10618 @item -mno-postinc
10619 @opindex mno-postinc
10620 @item -mno-postmodify
10621 @opindex mno-postmodify
10622 Code generation tweaks that disable, respectively, splitting of 32-bit
10623 loads, generation of post-increment addresses, and generation of
10624 post-modify addresses.  The defaults are @option{msplit-lohi},
10625 @option{-mpost-inc}, and @option{-mpost-modify}.
10626
10627 @item -mnovect-double
10628 @opindex mno-vect-double
10629 Change the preferred SIMD mode to SImode.  The default is
10630 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
10631
10632 @item -max-vect-align=@var{num}
10633 @opindex max-vect-align
10634 The maximum alignment for SIMD vector mode types.
10635 @var{num} may be 4 or 8.  The default is 8.
10636 Note that this is an ABI change, even though many library function
10637 interfaces are unaffected if they don't use SIMD vector modes
10638 in places that affect size and/or alignment of relevant types.
10639
10640 @item -msplit-vecmove-early
10641 @opindex msplit-vecmove-early
10642 Split vector moves into single word moves before reload.  In theory this
10643 can give better register allocation, but so far the reverse seems to be
10644 generally the case.
10645
10646 @item -m1reg-@var{reg}
10647 @opindex m1reg-
10648 Specify a register to hold the constant @minus{}1, which makes loading small negative
10649 constants and certain bitmasks faster.
10650 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
10651 which specify use of that register as a fixed register,
10652 and @samp{none}, which means that no register is used for this
10653 purpose.  The default is @option{-m1reg-none}.
10654
10655 @end table
10656
10657 @node ARM Options
10658 @subsection ARM Options
10659 @cindex ARM options
10660
10661 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
10662 architectures:
10663
10664 @table @gcctabopt
10665 @item -mabi=@var{name}
10666 @opindex mabi
10667 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
10668 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
10669
10670 @item -mapcs-frame
10671 @opindex mapcs-frame
10672 Generate a stack frame that is compliant with the ARM Procedure Call
10673 Standard for all functions, even if this is not strictly necessary for
10674 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
10675 with this option causes the stack frames not to be generated for
10676 leaf functions.  The default is @option{-mno-apcs-frame}.
10677
10678 @item -mapcs
10679 @opindex mapcs
10680 This is a synonym for @option{-mapcs-frame}.
10681
10682 @ignore
10683 @c not currently implemented
10684 @item -mapcs-stack-check
10685 @opindex mapcs-stack-check
10686 Generate code to check the amount of stack space available upon entry to
10687 every function (that actually uses some stack space).  If there is
10688 insufficient space available then either the function
10689 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
10690 called, depending upon the amount of stack space required.  The runtime
10691 system is required to provide these functions.  The default is
10692 @option{-mno-apcs-stack-check}, since this produces smaller code.
10693
10694 @c not currently implemented
10695 @item -mapcs-float
10696 @opindex mapcs-float
10697 Pass floating-point arguments using the floating-point registers.  This is
10698 one of the variants of the APCS@.  This option is recommended if the
10699 target hardware has a floating-point unit or if a lot of floating-point
10700 arithmetic is going to be performed by the code.  The default is
10701 @option{-mno-apcs-float}, since integer only code is slightly increased in
10702 size if @option{-mapcs-float} is used.
10703
10704 @c not currently implemented
10705 @item -mapcs-reentrant
10706 @opindex mapcs-reentrant
10707 Generate reentrant, position independent code.  The default is
10708 @option{-mno-apcs-reentrant}.
10709 @end ignore
10710
10711 @item -mthumb-interwork
10712 @opindex mthumb-interwork
10713 Generate code that supports calling between the ARM and Thumb
10714 instruction sets.  Without this option, on pre-v5 architectures, the
10715 two instruction sets cannot be reliably used inside one program.  The
10716 default is @option{-mno-thumb-interwork}, since slightly larger code
10717 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
10718 configurations this option is meaningless.
10719
10720 @item -mno-sched-prolog
10721 @opindex mno-sched-prolog
10722 Prevent the reordering of instructions in the function prologue, or the
10723 merging of those instruction with the instructions in the function's
10724 body.  This means that all functions start with a recognizable set
10725 of instructions (or in fact one of a choice from a small set of
10726 different function prologues), and this information can be used to
10727 locate the start of functions inside an executable piece of code.  The
10728 default is @option{-msched-prolog}.
10729
10730 @item -mfloat-abi=@var{name}
10731 @opindex mfloat-abi
10732 Specifies which floating-point ABI to use.  Permissible values
10733 are: @samp{soft}, @samp{softfp} and @samp{hard}.
10734
10735 Specifying @samp{soft} causes GCC to generate output containing
10736 library calls for floating-point operations.
10737 @samp{softfp} allows the generation of code using hardware floating-point
10738 instructions, but still uses the soft-float calling conventions.
10739 @samp{hard} allows generation of floating-point instructions
10740 and uses FPU-specific calling conventions.
10741
10742 The default depends on the specific target configuration.  Note that
10743 the hard-float and soft-float ABIs are not link-compatible; you must
10744 compile your entire program with the same ABI, and link with a
10745 compatible set of libraries.
10746
10747 @item -mlittle-endian
10748 @opindex mlittle-endian
10749 Generate code for a processor running in little-endian mode.  This is
10750 the default for all standard configurations.
10751
10752 @item -mbig-endian
10753 @opindex mbig-endian
10754 Generate code for a processor running in big-endian mode; the default is
10755 to compile code for a little-endian processor.
10756
10757 @item -mwords-little-endian
10758 @opindex mwords-little-endian
10759 This option only applies when generating code for big-endian processors.
10760 Generate code for a little-endian word order but a big-endian byte
10761 order.  That is, a byte order of the form @samp{32107654}.  Note: this
10762 option should only be used if you require compatibility with code for
10763 big-endian ARM processors generated by versions of the compiler prior to
10764 2.8.  This option is now deprecated.
10765
10766 @item -mcpu=@var{name}
10767 @opindex mcpu
10768 This specifies the name of the target ARM processor.  GCC uses this name
10769 to determine what kind of instructions it can emit when generating
10770 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
10771 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
10772 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
10773 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
10774 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
10775 @samp{arm720},
10776 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
10777 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
10778 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
10779 @samp{strongarm1110},
10780 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
10781 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
10782 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
10783 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
10784 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
10785 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
10786 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
10787 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9}, 
10788 @samp{cortex-a15}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5},
10789 @samp{cortex-m4}, @samp{cortex-m3},
10790 @samp{cortex-m1},
10791 @samp{cortex-m0},
10792 @samp{cortex-m0plus},
10793 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
10794 @samp{fa526}, @samp{fa626},
10795 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
10796
10797
10798 @option{-mcpu=generic-@var{arch}} is also permissible, and is
10799 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
10800 See @option{-mtune} for more information.
10801
10802 @option{-mcpu=native} causes the compiler to auto-detect the CPU
10803 of the build computer.  At present, this feature is only supported on
10804 Linux, and not all architectures are recognized.  If the auto-detect is
10805 unsuccessful the option has no effect.
10806
10807 @item -mtune=@var{name}
10808 @opindex mtune
10809 This option is very similar to the @option{-mcpu=} option, except that
10810 instead of specifying the actual target processor type, and hence
10811 restricting which instructions can be used, it specifies that GCC should
10812 tune the performance of the code as if the target were of the type
10813 specified in this option, but still choosing the instructions it
10814 generates based on the CPU specified by a @option{-mcpu=} option.
10815 For some ARM implementations better performance can be obtained by using
10816 this option.
10817
10818 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
10819 performance for a blend of processors within architecture @var{arch}.
10820 The aim is to generate code that run well on the current most popular
10821 processors, balancing between optimizations that benefit some CPUs in the
10822 range, and avoiding performance pitfalls of other CPUs.  The effects of
10823 this option may change in future GCC versions as CPU models come and go.
10824
10825 @option{-mtune=native} causes the compiler to auto-detect the CPU
10826 of the build computer.  At present, this feature is only supported on
10827 Linux, and not all architectures are recognized.  If the auto-detect is
10828 unsuccessful the option has no effect.
10829
10830 @item -march=@var{name}
10831 @opindex march
10832 This specifies the name of the target ARM architecture.  GCC uses this
10833 name to determine what kind of instructions it can emit when generating
10834 assembly code.  This option can be used in conjunction with or instead
10835 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
10836 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
10837 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
10838 @samp{armv6}, @samp{armv6j},
10839 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
10840 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
10841 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
10842
10843 @option{-march=native} causes the compiler to auto-detect the architecture
10844 of the build computer.  At present, this feature is only supported on
10845 Linux, and not all architectures are recognized.  If the auto-detect is
10846 unsuccessful the option has no effect.
10847
10848 @item -mfpu=@var{name}
10849 @opindex mfpu
10850 This specifies what floating-point hardware (or hardware emulation) is
10851 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
10852 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
10853 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
10854 @samp{vfpv4-d16}, @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
10855
10856 If @option{-msoft-float} is specified this specifies the format of
10857 floating-point values.
10858
10859 If the selected floating-point hardware includes the NEON extension
10860 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
10861 operations are not generated by GCC's auto-vectorization pass unless
10862 @option{-funsafe-math-optimizations} is also specified.  This is
10863 because NEON hardware does not fully implement the IEEE 754 standard for
10864 floating-point arithmetic (in particular denormal values are treated as
10865 zero), so the use of NEON instructions may lead to a loss of precision.
10866
10867 @item -mfp16-format=@var{name}
10868 @opindex mfp16-format
10869 Specify the format of the @code{__fp16} half-precision floating-point type.
10870 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
10871 the default is @samp{none}, in which case the @code{__fp16} type is not
10872 defined.  @xref{Half-Precision}, for more information.
10873
10874 @item -mstructure-size-boundary=@var{n}
10875 @opindex mstructure-size-boundary
10876 The sizes of all structures and unions are rounded up to a multiple
10877 of the number of bits set by this option.  Permissible values are 8, 32
10878 and 64.  The default value varies for different toolchains.  For the COFF
10879 targeted toolchain the default value is 8.  A value of 64 is only allowed
10880 if the underlying ABI supports it.
10881
10882 Specifying the larger number can produce faster, more efficient code, but
10883 can also increase the size of the program.  Different values are potentially
10884 incompatible.  Code compiled with one value cannot necessarily expect to
10885 work with code or libraries compiled with another value, if they exchange
10886 information using structures or unions.
10887
10888 @item -mabort-on-noreturn
10889 @opindex mabort-on-noreturn
10890 Generate a call to the function @code{abort} at the end of a
10891 @code{noreturn} function.  It is executed if the function tries to
10892 return.
10893
10894 @item -mlong-calls
10895 @itemx -mno-long-calls
10896 @opindex mlong-calls
10897 @opindex mno-long-calls
10898 Tells the compiler to perform function calls by first loading the
10899 address of the function into a register and then performing a subroutine
10900 call on this register.  This switch is needed if the target function
10901 lies outside of the 64-megabyte addressing range of the offset-based
10902 version of subroutine call instruction.
10903
10904 Even if this switch is enabled, not all function calls are turned
10905 into long calls.  The heuristic is that static functions, functions
10906 that have the @samp{short-call} attribute, functions that are inside
10907 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
10908 definitions have already been compiled within the current compilation
10909 unit are not turned into long calls.  The exceptions to this rule are
10910 that weak function definitions, functions with the @samp{long-call}
10911 attribute or the @samp{section} attribute, and functions that are within
10912 the scope of a @samp{#pragma long_calls} directive are always
10913 turned into long calls.
10914
10915 This feature is not enabled by default.  Specifying
10916 @option{-mno-long-calls} restores the default behavior, as does
10917 placing the function calls within the scope of a @samp{#pragma
10918 long_calls_off} directive.  Note these switches have no effect on how
10919 the compiler generates code to handle function calls via function
10920 pointers.
10921
10922 @item -msingle-pic-base
10923 @opindex msingle-pic-base
10924 Treat the register used for PIC addressing as read-only, rather than
10925 loading it in the prologue for each function.  The runtime system is
10926 responsible for initializing this register with an appropriate value
10927 before execution begins.
10928
10929 @item -mpic-register=@var{reg}
10930 @opindex mpic-register
10931 Specify the register to be used for PIC addressing.  The default is R10
10932 unless stack-checking is enabled, when R9 is used.
10933
10934 @item -mcirrus-fix-invalid-insns
10935 @opindex mcirrus-fix-invalid-insns
10936 @opindex mno-cirrus-fix-invalid-insns
10937 Insert NOPs into the instruction stream to in order to work around
10938 problems with invalid Maverick instruction combinations.  This option
10939 is only valid if the @option{-mcpu=ep9312} option has been used to
10940 enable generation of instructions for the Cirrus Maverick floating-point
10941 co-processor.  This option is not enabled by default, since the
10942 problem is only present in older Maverick implementations.  The default
10943 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10944 switch.
10945
10946 @item -mpoke-function-name
10947 @opindex mpoke-function-name
10948 Write the name of each function into the text section, directly
10949 preceding the function prologue.  The generated code is similar to this:
10950
10951 @smallexample
10952      t0
10953          .ascii "arm_poke_function_name", 0
10954          .align
10955      t1
10956          .word 0xff000000 + (t1 - t0)
10957      arm_poke_function_name
10958          mov     ip, sp
10959          stmfd   sp!, @{fp, ip, lr, pc@}
10960          sub     fp, ip, #4
10961 @end smallexample
10962
10963 When performing a stack backtrace, code can inspect the value of
10964 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10965 location @code{pc - 12} and the top 8 bits are set, then we know that
10966 there is a function name embedded immediately preceding this location
10967 and has length @code{((pc[-3]) & 0xff000000)}.
10968
10969 @item -mthumb
10970 @itemx -marm
10971 @opindex marm
10972 @opindex mthumb
10973
10974 Select between generating code that executes in ARM and Thumb
10975 states.  The default for most configurations is to generate code
10976 that executes in ARM state, but the default can be changed by
10977 configuring GCC with the @option{--with-mode=}@var{state}
10978 configure option.
10979
10980 @item -mtpcs-frame
10981 @opindex mtpcs-frame
10982 Generate a stack frame that is compliant with the Thumb Procedure Call
10983 Standard for all non-leaf functions.  (A leaf function is one that does
10984 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10985
10986 @item -mtpcs-leaf-frame
10987 @opindex mtpcs-leaf-frame
10988 Generate a stack frame that is compliant with the Thumb Procedure Call
10989 Standard for all leaf functions.  (A leaf function is one that does
10990 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10991
10992 @item -mcallee-super-interworking
10993 @opindex mcallee-super-interworking
10994 Gives all externally visible functions in the file being compiled an ARM
10995 instruction set header which switches to Thumb mode before executing the
10996 rest of the function.  This allows these functions to be called from
10997 non-interworking code.  This option is not valid in AAPCS configurations
10998 because interworking is enabled by default.
10999
11000 @item -mcaller-super-interworking
11001 @opindex mcaller-super-interworking
11002 Allows calls via function pointers (including virtual functions) to
11003 execute correctly regardless of whether the target code has been
11004 compiled for interworking or not.  There is a small overhead in the cost
11005 of executing a function pointer if this option is enabled.  This option
11006 is not valid in AAPCS configurations because interworking is enabled
11007 by default.
11008
11009 @item -mtp=@var{name}
11010 @opindex mtp
11011 Specify the access model for the thread local storage pointer.  The valid
11012 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
11013 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
11014 (supported in the arm6k architecture), and @option{auto}, which uses the
11015 best available method for the selected processor.  The default setting is
11016 @option{auto}.
11017
11018 @item -mtls-dialect=@var{dialect}
11019 @opindex mtls-dialect
11020 Specify the dialect to use for accessing thread local storage.  Two
11021 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
11022 @samp{gnu} dialect selects the original GNU scheme for supporting
11023 local and global dynamic TLS models.  The @samp{gnu2} dialect
11024 selects the GNU descriptor scheme, which provides better performance
11025 for shared libraries.  The GNU descriptor scheme is compatible with
11026 the original scheme, but does require new assembler, linker and
11027 library support.  Initial and local exec TLS models are unaffected by
11028 this option and always use the original scheme.
11029
11030 @item -mword-relocations
11031 @opindex mword-relocations
11032 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
11033 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
11034 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
11035 is specified.
11036
11037 @item -mfix-cortex-m3-ldrd
11038 @opindex mfix-cortex-m3-ldrd
11039 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
11040 with overlapping destination and base registers are used.  This option avoids
11041 generating these instructions.  This option is enabled by default when
11042 @option{-mcpu=cortex-m3} is specified.
11043
11044 @end table
11045
11046 @node AVR Options
11047 @subsection AVR Options
11048 @cindex AVR Options
11049
11050 These options are defined for AVR implementations:
11051
11052 @table @gcctabopt
11053 @item -mmcu=@var{mcu}
11054 @opindex mmcu
11055 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
11056
11057 For a complete list of @var{mcu} values that are supported by @command{avr-gcc},
11058 see the compiler output when called with the @option{--help=target}
11059 command line option.
11060 The default for this option is@tie{}@code{avr2}.
11061
11062 GCC supports the following AVR devices and ISAs:
11063
11064 @include avr-mmcu.texi
11065
11066 @item -maccumulate-args
11067 @opindex maccumulate-args
11068 Accumulate outgoing function arguments and acquire/release the needed
11069 stack space for outgoing function arguments once in function
11070 prologue/epilogue.  Without this option, outgoing arguments are pushed
11071 before calling a function and popped afterwards.
11072
11073 Popping the arguments after the function call can be expensive on
11074 AVR so that accumulating the stack space might lead to smaller
11075 executables because arguments need not to be removed from the
11076 stack after such a function call.
11077
11078 This option can lead to reduced code size for functions that perform
11079 several calls to functions that get their arguments on the stack like
11080 calls to printf-like functions.
11081
11082 @item -mbranch-cost=@var{cost}
11083 @opindex mbranch-cost
11084 Set the branch costs for conditional branch instructions to
11085 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
11086 integers. The default branch cost is 0.
11087
11088 @item -mcall-prologues
11089 @opindex mcall-prologues
11090 Functions prologues/epilogues are expanded as calls to appropriate
11091 subroutines.  Code size is smaller.
11092
11093 @item -mint8
11094 @opindex mint8
11095 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
11096 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
11097 and @code{long long} is 4 bytes.  Please note that this option does not
11098 conform to the C standards, but it results in smaller code
11099 size.
11100
11101 @item -mno-interrupts
11102 @opindex mno-interrupts
11103 Generated code is not compatible with hardware interrupts.
11104 Code size is smaller.
11105
11106 @item -mrelax
11107 @opindex mrelax
11108 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
11109 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
11110 Setting @code{-mrelax} just adds the @code{--relax} option to the
11111 linker command line when the linker is called.
11112
11113 Jump relaxing is performed by the linker because jump offsets are not
11114 known before code is located. Therefore, the assembler code generated by the
11115 compiler is the same, but the instructions in the executable may
11116 differ from instructions in the assembler code.
11117
11118 Relaxing must be turned on if linker stubs are needed, see the
11119 section on @code{EIND} and linker stubs below.
11120
11121 @item -mshort-calls
11122 @opindex mshort-calls
11123 Use @code{RCALL}/@code{RJMP} instructions even on devices with
11124 16@tie{}KiB or more of program memory, i.e.@: on devices that
11125 have the @code{CALL} and @code{JMP} instructions.
11126 See also the @code{-mrelax} command line option.
11127
11128 @item -msp8
11129 @opindex msp8
11130 Treat the stack pointer register as an 8-bit register,
11131 i.e.@: assume the high byte of the stack pointer is zero.
11132 In general, you don't need to set this option by hand.
11133
11134 This option is used internally by the compiler to select and
11135 build multilibs for architectures @code{avr2} and @code{avr25}.
11136 These architectures mix devices with and without @code{SPH}.
11137 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
11138 the compiler driver will add or remove this option from the compiler
11139 proper's command line, because the compiler then knows if the device
11140 or architecture has an 8-bit stack pointer and thus no @code{SPH}
11141 register or not.
11142
11143 @item -mstrict-X
11144 @opindex mstrict-X
11145 Use address register @code{X} in a way proposed by the hardware.  This means
11146 that @code{X} is only used in indirect, post-increment or
11147 pre-decrement addressing.
11148
11149 Without this option, the @code{X} register may be used in the same way
11150 as @code{Y} or @code{Z} which then is emulated by additional
11151 instructions.  
11152 For example, loading a value with @code{X+const} addressing with a
11153 small non-negative @code{const < 64} to a register @var{Rn} is
11154 performed as
11155
11156 @example
11157 adiw r26, const   ; X += const
11158 ld   @var{Rn}, X        ; @var{Rn} = *X
11159 sbiw r26, const   ; X -= const
11160 @end example
11161
11162 @item -mtiny-stack
11163 @opindex mtiny-stack
11164 Only change the lower 8@tie{}bits of the stack pointer.
11165 @end table
11166
11167 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
11168 @cindex @code{EIND}
11169 Pointers in the implementation are 16@tie{}bits wide.
11170 The address of a function or label is represented as word address so
11171 that indirect jumps and calls can target any code address in the
11172 range of 64@tie{}Ki words.
11173
11174 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
11175 bytes of program memory space, there is a special function register called
11176 @code{EIND} that serves as most significant part of the target address
11177 when @code{EICALL} or @code{EIJMP} instructions are used.
11178
11179 Indirect jumps and calls on these devices are handled as follows by
11180 the compiler and are subject to some limitations:
11181
11182 @itemize @bullet
11183
11184 @item
11185 The compiler never sets @code{EIND}.
11186
11187 @item
11188 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
11189 instructions or might read @code{EIND} directly in order to emulate an
11190 indirect call/jump by means of a @code{RET} instruction.
11191
11192 @item
11193 The compiler assumes that @code{EIND} never changes during the startup
11194 code or during the application. In particular, @code{EIND} is not
11195 saved/restored in function or interrupt service routine
11196 prologue/epilogue.
11197
11198 @item
11199 For indirect calls to functions and computed goto, the linker
11200 generates @emph{stubs}. Stubs are jump pads sometimes also called
11201 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
11202 The stub contains a direct jump to the desired address.
11203
11204 @item
11205 Linker relaxation must be turned on so that the linker will generate
11206 the stubs correctly an all situaltion. See the compiler option
11207 @code{-mrelax} and the linler option @code{--relax}.
11208 There are corner cases where the linker is supposed to generate stubs
11209 but aborts without relaxation and without a helpful error message.
11210
11211 @item
11212 The default linker script is arranged for code with @code{EIND = 0}.
11213 If code is supposed to work for a setup with @code{EIND != 0}, a custom
11214 linker script has to be used in order to place the sections whose
11215 name start with @code{.trampolines} into the segment where @code{EIND}
11216 points to.
11217
11218 @item
11219 The startup code from libgcc never sets @code{EIND}.
11220 Notice that startup code is a blend of code from libgcc and AVR-LibC.
11221 For the impact of AVR-LibC on @code{EIND}, see the
11222 @w{@uref{http://nongnu.org/avr-libc/user-manual,AVR-LibC user manual}}.
11223
11224 @item
11225 It is legitimate for user-specific startup code to set up @code{EIND}
11226 early, for example by means of initialization code located in
11227 section @code{.init3}. Such code runs prior to general startup code
11228 that initializes RAM and calls constructors, but after the bit
11229 of startup code from AVR-LibC that sets @code{EIND} to the segment
11230 where the vector table is located.
11231 @example
11232 #include <avr/io.h>
11233
11234 static void
11235 __attribute__((section(".init3"),naked,used,no_instrument_function))
11236 init3_set_eind (void)
11237 @{
11238   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
11239                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
11240 @}
11241 @end example
11242
11243 @noindent
11244 The @code{__trampolines_start} symbol is defined in the linker script.
11245
11246 @item
11247 Stubs are generated automatically by the linker if
11248 the following two conditions are met:
11249 @itemize @minus
11250
11251 @item The address of a label is taken by means of the @code{gs} modifier
11252 (short for @emph{generate stubs}) like so:
11253 @example
11254 LDI r24, lo8(gs(@var{func}))
11255 LDI r25, hi8(gs(@var{func}))
11256 @end example
11257 @item The final location of that label is in a code segment
11258 @emph{outside} the segment where the stubs are located.
11259 @end itemize
11260
11261 @item
11262 The compiler emits such @code{gs} modifiers for code labels in the
11263 following situations:
11264 @itemize @minus
11265 @item Taking address of a function or code label.
11266 @item Computed goto.
11267 @item If prologue-save function is used, see @option{-mcall-prologues}
11268 command-line option.
11269 @item Switch/case dispatch tables. If you do not want such dispatch
11270 tables you can specify the @option{-fno-jump-tables} command-line option.
11271 @item C and C++ constructors/destructors called during startup/shutdown.
11272 @item If the tools hit a @code{gs()} modifier explained above.
11273 @end itemize
11274
11275 @item
11276 Jumping to non-symbolic addresses like so is @emph{not} supported:
11277
11278 @example
11279 int main (void)
11280 @{
11281     /* Call function at word address 0x2 */
11282     return ((int(*)(void)) 0x2)();
11283 @}
11284 @end example
11285
11286 Instead, a stub has to be set up, i.e.@: the function has to be called
11287 through a symbol (@code{func_4} in the example):
11288
11289 @example
11290 int main (void)
11291 @{
11292     extern int func_4 (void);
11293
11294     /* Call function at byte address 0x4 */
11295     return func_4();
11296 @}
11297 @end example
11298
11299 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
11300 Alternatively, @code{func_4} can be defined in the linker script.
11301 @end itemize
11302
11303 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
11304 @cindex @code{RAMPD}
11305 @cindex @code{RAMPX}
11306 @cindex @code{RAMPY}
11307 @cindex @code{RAMPZ}
11308 Some AVR devices support memories larger than the 64@tie{}KiB range
11309 that can be accessed with 16-bit pointers.  To access memory locations
11310 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
11311 register is used as high part of the address:
11312 The @code{X}, @code{Y}, @code{Z} address register is concatenated
11313 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
11314 register, respectively, to get a wide address. Similarly,
11315 @code{RAMPD} is used together with direct addressing.
11316
11317 @itemize
11318 @item
11319 The startup code initializes the @code{RAMP} special function
11320 registers with zero.
11321
11322 @item
11323 If a @ref{AVR Named Address Spaces,named address space} other than
11324 generic or @code{__flash} is used, then @code{RAMPZ} is set
11325 as needed before the operation.
11326
11327 @item
11328 If the device supports RAM larger than 64@tie{KiB} and the compiler
11329 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
11330 is reset to zero after the operation.
11331
11332 @item
11333 If the device comes with a specific @code{RAMP} register, the ISR
11334 prologue/epilogue saves/restores that SFR and initializes it with
11335 zero in case the ISR code might (implicitly) use it.
11336
11337 @item
11338 RAM larger than 64@tie{KiB} is not supported by GCC for AVR targets.
11339 If you use inline assembler to read from locations outside the
11340 16-bit address range and change one of the @code{RAMP} registers,
11341 you must reset it to zero after the access.
11342
11343 @end itemize
11344
11345 @subsubsection AVR Built-in Macros
11346
11347 GCC defines several built-in macros so that the user code can test
11348 for the presence or absence of features.  Almost any of the following
11349 built-in macros are deduced from device capabilities and thus
11350 triggered by the @code{-mmcu=} command-line option.
11351
11352 For even more AVR-specific built-in macros see
11353 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
11354
11355 @table @code
11356
11357 @item __AVR_@var{Device}__
11358 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
11359 the device's name. For example, @code{-mmcu=atmega8} defines the
11360 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
11361 @code{__AVR_ATtiny261A__}, etc.
11362
11363 The built-in macros' names follow
11364 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
11365 the device name as from the AVR user manual. The difference between
11366 @var{Device} in the built-in macro and @var{device} in
11367 @code{-mmcu=@var{device}} is that the latter is always lowercase.
11368
11369 @item __AVR_HAVE_ELPM__
11370 The device has the the @code{ELPM} instruction.
11371
11372 @item __AVR_HAVE_ELPMX__
11373 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
11374 R@var{n},Z+} instructions.
11375
11376 @item __AVR_HAVE_MOVW__
11377 The device has the @code{MOVW} instruction to perform 16-bit
11378 register-register moves.
11379
11380 @item __AVR_HAVE_LPMX__
11381 The device has the @code{LPM R@var{n},Z} and
11382 @code{LPM R@var{n},Z+} instructions.
11383
11384 @item __AVR_HAVE_MUL__
11385 The device has a hardware multiplier. 
11386
11387 @item __AVR_HAVE_JMP_CALL__
11388 The device has the @code{JMP} and @code{CALL} instructions.
11389 This is the case for devices with at least 16@tie{}KiB of program
11390 memory and if @code{-mshort-calls} is not set.
11391
11392 @item __AVR_HAVE_EIJMP_EICALL__
11393 @item __AVR_3_BYTE_PC__
11394 The device has the @code{EIJMP} and @code{EICALL} instructions.
11395 This is the case for devices with more than 128@tie{}KiB of program memory.
11396 This also means that the program counter
11397 (PC) is 3@tie{}bytes wide.
11398
11399 @item __AVR_2_BYTE_PC__
11400 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
11401 with up to 128@tie{}KiB of program memory.
11402
11403 @item __AVR_HAVE_8BIT_SP__
11404 @item __AVR_HAVE_16BIT_SP__
11405 The stack pointer (SP) register is treated as 8-bit respectively
11406 16-bit register by the compiler.
11407 The definition of these macros is affected by @code{-mtiny-stack}.
11408
11409 @item __AVR_HAVE_SPH__
11410 @item __AVR_SP8__
11411 The device has the SPH (high part of stack pointer) special function
11412 register or has an 8-bit stack pointer, respectively.
11413 The definition of these macros is affected by @code{-mmcu=} and
11414 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
11415 by @code{-msp8}.
11416
11417 @item __AVR_HAVE_RAMPD__
11418 @item __AVR_HAVE_RAMPX__
11419 @item __AVR_HAVE_RAMPY__
11420 @item __AVR_HAVE_RAMPZ__
11421 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
11422 @code{RAMPZ} special function register, respectively.
11423
11424 @item __NO_INTERRUPTS__
11425 This macro reflects the @code{-mno-interrupts} command line option.
11426
11427 @item __AVR_ERRATA_SKIP__
11428 @item __AVR_ERRATA_SKIP_JMP_CALL__
11429 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
11430 instructions because of a hardware erratum.  Skip instructions are
11431 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
11432 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
11433 set.
11434
11435 @item __AVR_SFR_OFFSET__=@var{offset}
11436 Instructions that can address I/O special function registers directly
11437 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
11438 address as if addressed by an instruction to access RAM like @code{LD}
11439 or @code{STS}. This offset depends on the device architecture and has
11440 to be subtracted from the RAM address in order to get the
11441 respective I/O@tie{}address.
11442
11443 @end table
11444
11445 @node Blackfin Options
11446 @subsection Blackfin Options
11447 @cindex Blackfin Options
11448
11449 @table @gcctabopt
11450 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
11451 @opindex mcpu=
11452 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
11453 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
11454 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
11455 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
11456 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
11457 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
11458 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
11459 @samp{bf561}, @samp{bf592}.
11460 The optional @var{sirevision} specifies the silicon revision of the target
11461 Blackfin processor.  Any workarounds available for the targeted silicon revision
11462 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
11463 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
11464 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
11465 hexadecimal digits representing the major and minor numbers in the silicon
11466 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
11467 is not defined.  If @var{sirevision} is @samp{any}, the
11468 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
11469 If this optional @var{sirevision} is not used, GCC assumes the latest known
11470 silicon revision of the targeted Blackfin processor.
11471
11472 Support for @samp{bf561} is incomplete.  For @samp{bf561},
11473 Only the processor macro is defined.
11474 Without this option, @samp{bf532} is used as the processor by default.
11475 The corresponding predefined processor macros for @var{cpu} is to
11476 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
11477 provided by libgloss to be linked in if @option{-msim} is not given.
11478
11479 @item -msim
11480 @opindex msim
11481 Specifies that the program will be run on the simulator.  This causes
11482 the simulator BSP provided by libgloss to be linked in.  This option
11483 has effect only for @samp{bfin-elf} toolchain.
11484 Certain other options, such as @option{-mid-shared-library} and
11485 @option{-mfdpic}, imply @option{-msim}.
11486
11487 @item -momit-leaf-frame-pointer
11488 @opindex momit-leaf-frame-pointer
11489 Don't keep the frame pointer in a register for leaf functions.  This
11490 avoids the instructions to save, set up and restore frame pointers and
11491 makes an extra register available in leaf functions.  The option
11492 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
11493 which might make debugging harder.
11494
11495 @item -mspecld-anomaly
11496 @opindex mspecld-anomaly
11497 When enabled, the compiler ensures that the generated code does not
11498 contain speculative loads after jump instructions. If this option is used,
11499 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
11500
11501 @item -mno-specld-anomaly
11502 @opindex mno-specld-anomaly
11503 Don't generate extra code to prevent speculative loads from occurring.
11504
11505 @item -mcsync-anomaly
11506 @opindex mcsync-anomaly
11507 When enabled, the compiler ensures that the generated code does not
11508 contain CSYNC or SSYNC instructions too soon after conditional branches.
11509 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
11510
11511 @item -mno-csync-anomaly
11512 @opindex mno-csync-anomaly
11513 Don't generate extra code to prevent CSYNC or SSYNC instructions from
11514 occurring too soon after a conditional branch.
11515
11516 @item -mlow-64k
11517 @opindex mlow-64k
11518 When enabled, the compiler is free to take advantage of the knowledge that
11519 the entire program fits into the low 64k of memory.
11520
11521 @item -mno-low-64k
11522 @opindex mno-low-64k
11523 Assume that the program is arbitrarily large.  This is the default.
11524
11525 @item -mstack-check-l1
11526 @opindex mstack-check-l1
11527 Do stack checking using information placed into L1 scratchpad memory by the
11528 uClinux kernel.
11529
11530 @item -mid-shared-library
11531 @opindex mid-shared-library
11532 Generate code that supports shared libraries via the library ID method.
11533 This allows for execute in place and shared libraries in an environment
11534 without virtual memory management.  This option implies @option{-fPIC}.
11535 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11536
11537 @item -mno-id-shared-library
11538 @opindex mno-id-shared-library
11539 Generate code that doesn't assume ID based shared libraries are being used.
11540 This is the default.
11541
11542 @item -mleaf-id-shared-library
11543 @opindex mleaf-id-shared-library
11544 Generate code that supports shared libraries via the library ID method,
11545 but assumes that this library or executable won't link against any other
11546 ID shared libraries.  That allows the compiler to use faster code for jumps
11547 and calls.
11548
11549 @item -mno-leaf-id-shared-library
11550 @opindex mno-leaf-id-shared-library
11551 Do not assume that the code being compiled won't link against any ID shared
11552 libraries.  Slower code is generated for jump and call insns.
11553
11554 @item -mshared-library-id=n
11555 @opindex mshared-library-id
11556 Specifies the identification number of the ID-based shared library being
11557 compiled.  Specifying a value of 0 generates more compact code; specifying
11558 other values forces the allocation of that number to the current
11559 library but is no more space- or time-efficient than omitting this option.
11560
11561 @item -msep-data
11562 @opindex msep-data
11563 Generate code that allows the data segment to be located in a different
11564 area of memory from the text segment.  This allows for execute in place in
11565 an environment without virtual memory management by eliminating relocations
11566 against the text section.
11567
11568 @item -mno-sep-data
11569 @opindex mno-sep-data
11570 Generate code that assumes that the data segment follows the text segment.
11571 This is the default.
11572
11573 @item -mlong-calls
11574 @itemx -mno-long-calls
11575 @opindex mlong-calls
11576 @opindex mno-long-calls
11577 Tells the compiler to perform function calls by first loading the
11578 address of the function into a register and then performing a subroutine
11579 call on this register.  This switch is needed if the target function
11580 lies outside of the 24-bit addressing range of the offset-based
11581 version of subroutine call instruction.
11582
11583 This feature is not enabled by default.  Specifying
11584 @option{-mno-long-calls} restores the default behavior.  Note these
11585 switches have no effect on how the compiler generates code to handle
11586 function calls via function pointers.
11587
11588 @item -mfast-fp
11589 @opindex mfast-fp
11590 Link with the fast floating-point library. This library relaxes some of
11591 the IEEE floating-point standard's rules for checking inputs against
11592 Not-a-Number (NAN), in the interest of performance.
11593
11594 @item -minline-plt
11595 @opindex minline-plt
11596 Enable inlining of PLT entries in function calls to functions that are
11597 not known to bind locally.  It has no effect without @option{-mfdpic}.
11598
11599 @item -mmulticore
11600 @opindex mmulticore
11601 Build standalone application for multicore Blackfin processor. Proper
11602 start files and link scripts are used to support multicore.
11603 This option defines @code{__BFIN_MULTICORE}. It can only be used with
11604 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
11605 @option{-mcorea} or @option{-mcoreb}. If it's used without
11606 @option{-mcorea} or @option{-mcoreb}, single application/dual core
11607 programming model is used. In this model, the main function of Core B
11608 should be named as coreb_main. If it's used with @option{-mcorea} or
11609 @option{-mcoreb}, one application per core programming model is used.
11610 If this option is not used, single core application programming
11611 model is used.
11612
11613 @item -mcorea
11614 @opindex mcorea
11615 Build standalone application for Core A of BF561 when using
11616 one application per core programming model. Proper start files
11617 and link scripts are used to support Core A. This option
11618 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
11619
11620 @item -mcoreb
11621 @opindex mcoreb
11622 Build standalone application for Core B of BF561 when using
11623 one application per core programming model. Proper start files
11624 and link scripts are used to support Core B. This option
11625 defines @code{__BFIN_COREB}. When this option is used, coreb_main
11626 should be used instead of main. It must be used with
11627 @option{-mmulticore}.
11628
11629 @item -msdram
11630 @opindex msdram
11631 Build standalone application for SDRAM. Proper start files and
11632 link scripts are used to put the application into SDRAM.
11633 Loader should initialize SDRAM before loading the application
11634 into SDRAM. This option defines @code{__BFIN_SDRAM}.
11635
11636 @item -micplb
11637 @opindex micplb
11638 Assume that ICPLBs are enabled at run time.  This has an effect on certain
11639 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
11640 are enabled; for standalone applications the default is off.
11641 @end table
11642
11643 @node C6X Options
11644 @subsection C6X Options
11645 @cindex C6X Options
11646
11647 @table @gcctabopt
11648 @item -march=@var{name}
11649 @opindex march
11650 This specifies the name of the target architecture.  GCC uses this
11651 name to determine what kind of instructions it can emit when generating
11652 assembly code.  Permissible names are: @samp{c62x},
11653 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
11654
11655 @item -mbig-endian
11656 @opindex mbig-endian
11657 Generate code for a big-endian target.
11658
11659 @item -mlittle-endian
11660 @opindex mlittle-endian
11661 Generate code for a little-endian target.  This is the default.
11662
11663 @item -msim
11664 @opindex msim
11665 Choose startup files and linker script suitable for the simulator.
11666
11667 @item -msdata=default
11668 @opindex msdata=default
11669 Put small global and static data in the @samp{.neardata} section,
11670 which is pointed to by register @code{B14}.  Put small uninitialized
11671 global and static data in the @samp{.bss} section, which is adjacent
11672 to the @samp{.neardata} section.  Put small read-only data into the
11673 @samp{.rodata} section.  The corresponding sections used for large
11674 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
11675
11676 @item -msdata=all
11677 @opindex msdata=all
11678 Put all data, not just small objets, into the sections reserved for
11679 small data, and use addressing relative to the @code{B14} register to
11680 access them.
11681
11682 @item -msdata=none
11683 @opindex msdata=none
11684 Make no use of the sections reserved for small data, and use absolute
11685 addresses to access all data.  Put all initialized global and static
11686 data in the @samp{.fardata} section, and all uninitialized data in the
11687 @samp{.far} section.  Put all constant data into the @samp{.const}
11688 section.
11689 @end table
11690
11691 @node CRIS Options
11692 @subsection CRIS Options
11693 @cindex CRIS Options
11694
11695 These options are defined specifically for the CRIS ports.
11696
11697 @table @gcctabopt
11698 @item -march=@var{architecture-type}
11699 @itemx -mcpu=@var{architecture-type}
11700 @opindex march
11701 @opindex mcpu
11702 Generate code for the specified architecture.  The choices for
11703 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
11704 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
11705 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
11706 @samp{v10}.
11707
11708 @item -mtune=@var{architecture-type}
11709 @opindex mtune
11710 Tune to @var{architecture-type} everything applicable about the generated
11711 code, except for the ABI and the set of available instructions.  The
11712 choices for @var{architecture-type} are the same as for
11713 @option{-march=@var{architecture-type}}.
11714
11715 @item -mmax-stack-frame=@var{n}
11716 @opindex mmax-stack-frame
11717 Warn when the stack frame of a function exceeds @var{n} bytes.
11718
11719 @item -metrax4
11720 @itemx -metrax100
11721 @opindex metrax4
11722 @opindex metrax100
11723 The options @option{-metrax4} and @option{-metrax100} are synonyms for
11724 @option{-march=v3} and @option{-march=v8} respectively.
11725
11726 @item -mmul-bug-workaround
11727 @itemx -mno-mul-bug-workaround
11728 @opindex mmul-bug-workaround
11729 @opindex mno-mul-bug-workaround
11730 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
11731 models where it applies.  This option is active by default.
11732
11733 @item -mpdebug
11734 @opindex mpdebug
11735 Enable CRIS-specific verbose debug-related information in the assembly
11736 code.  This option also has the effect to turn off the @samp{#NO_APP}
11737 formatted-code indicator to the assembler at the beginning of the
11738 assembly file.
11739
11740 @item -mcc-init
11741 @opindex mcc-init
11742 Do not use condition-code results from previous instruction; always emit
11743 compare and test instructions before use of condition codes.
11744
11745 @item -mno-side-effects
11746 @opindex mno-side-effects
11747 Do not emit instructions with side-effects in addressing modes other than
11748 post-increment.
11749
11750 @item -mstack-align
11751 @itemx -mno-stack-align
11752 @itemx -mdata-align
11753 @itemx -mno-data-align
11754 @itemx -mconst-align
11755 @itemx -mno-const-align
11756 @opindex mstack-align
11757 @opindex mno-stack-align
11758 @opindex mdata-align
11759 @opindex mno-data-align
11760 @opindex mconst-align
11761 @opindex mno-const-align
11762 These options (no-options) arranges (eliminate arrangements) for the
11763 stack-frame, individual data and constants to be aligned for the maximum
11764 single data access size for the chosen CPU model.  The default is to
11765 arrange for 32-bit alignment.  ABI details such as structure layout are
11766 not affected by these options.
11767
11768 @item -m32-bit
11769 @itemx -m16-bit
11770 @itemx -m8-bit
11771 @opindex m32-bit
11772 @opindex m16-bit
11773 @opindex m8-bit
11774 Similar to the stack- data- and const-align options above, these options
11775 arrange for stack-frame, writable data and constants to all be 32-bit,
11776 16-bit or 8-bit aligned.  The default is 32-bit alignment.
11777
11778 @item -mno-prologue-epilogue
11779 @itemx -mprologue-epilogue
11780 @opindex mno-prologue-epilogue
11781 @opindex mprologue-epilogue
11782 With @option{-mno-prologue-epilogue}, the normal function prologue and
11783 epilogue which set up the stack frame are omitted and no return
11784 instructions or return sequences are generated in the code.  Use this
11785 option only together with visual inspection of the compiled code: no
11786 warnings or errors are generated when call-saved registers must be saved,
11787 or storage for local variable needs to be allocated.
11788
11789 @item -mno-gotplt
11790 @itemx -mgotplt
11791 @opindex mno-gotplt
11792 @opindex mgotplt
11793 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
11794 instruction sequences that load addresses for functions from the PLT part
11795 of the GOT rather than (traditional on other architectures) calls to the
11796 PLT@.  The default is @option{-mgotplt}.
11797
11798 @item -melf
11799 @opindex melf
11800 Legacy no-op option only recognized with the cris-axis-elf and
11801 cris-axis-linux-gnu targets.
11802
11803 @item -mlinux
11804 @opindex mlinux
11805 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
11806
11807 @item -sim
11808 @opindex sim
11809 This option, recognized for the cris-axis-elf arranges
11810 to link with input-output functions from a simulator library.  Code,
11811 initialized data and zero-initialized data are allocated consecutively.
11812
11813 @item -sim2
11814 @opindex sim2
11815 Like @option{-sim}, but pass linker options to locate initialized data at
11816 0x40000000 and zero-initialized data at 0x80000000.
11817 @end table
11818
11819 @node CR16 Options
11820 @subsection CR16 Options
11821 @cindex CR16 Options
11822
11823 These options are defined specifically for the CR16 ports.
11824
11825 @table @gcctabopt
11826
11827 @item -mmac
11828 @opindex mmac
11829 Enable the use of multiply-accumulate instructions. Disabled by default.
11830
11831 @item -mcr16cplus
11832 @itemx -mcr16c
11833 @opindex mcr16cplus
11834 @opindex mcr16c
11835 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
11836 is default.
11837
11838 @item -msim
11839 @opindex msim
11840 Links the library libsim.a which is in compatible with simulator. Applicable
11841 to ELF compiler only.
11842
11843 @item -mint32
11844 @opindex mint32
11845 Choose integer type as 32-bit wide.
11846
11847 @item -mbit-ops
11848 @opindex mbit-ops
11849 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
11850
11851 @item -mdata-model=@var{model}
11852 @opindex mdata-model
11853 Choose a data model. The choices for @var{model} are @samp{near},
11854 @samp{far} or @samp{medium}. @samp{medium} is default.
11855 However, @samp{far} is not valid with @option{-mcr16c}, as the
11856 CR16C architecture does not support the far data model.
11857 @end table
11858
11859 @node Darwin Options
11860 @subsection Darwin Options
11861 @cindex Darwin options
11862
11863 These options are defined for all architectures running the Darwin operating
11864 system.
11865
11866 FSF GCC on Darwin does not create ``fat'' object files; it creates
11867 an object file for the single architecture that GCC was built to
11868 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
11869 @option{-arch} options are used; it does so by running the compiler or
11870 linker multiple times and joining the results together with
11871 @file{lipo}.
11872
11873 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
11874 @samp{i686}) is determined by the flags that specify the ISA
11875 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
11876 @option{-force_cpusubtype_ALL} option can be used to override this.
11877
11878 The Darwin tools vary in their behavior when presented with an ISA
11879 mismatch.  The assembler, @file{as}, only permits instructions to
11880 be used that are valid for the subtype of the file it is generating,
11881 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
11882 The linker for shared libraries, @file{/usr/bin/libtool}, fails
11883 and prints an error if asked to create a shared library with a less
11884 restrictive subtype than its input files (for instance, trying to put
11885 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
11886 for executables, @command{ld}, quietly gives the executable the most
11887 restrictive subtype of any of its input files.
11888
11889 @table @gcctabopt
11890 @item -F@var{dir}
11891 @opindex F
11892 Add the framework directory @var{dir} to the head of the list of
11893 directories to be searched for header files.  These directories are
11894 interleaved with those specified by @option{-I} options and are
11895 scanned in a left-to-right order.
11896
11897 A framework directory is a directory with frameworks in it.  A
11898 framework is a directory with a @file{Headers} and/or
11899 @file{PrivateHeaders} directory contained directly in it that ends
11900 in @file{.framework}.  The name of a framework is the name of this
11901 directory excluding the @file{.framework}.  Headers associated with
11902 the framework are found in one of those two directories, with
11903 @file{Headers} being searched first.  A subframework is a framework
11904 directory that is in a framework's @file{Frameworks} directory.
11905 Includes of subframework headers can only appear in a header of a
11906 framework that contains the subframework, or in a sibling subframework
11907 header.  Two subframeworks are siblings if they occur in the same
11908 framework.  A subframework should not have the same name as a
11909 framework; a warning is issued if this is violated.  Currently a
11910 subframework cannot have subframeworks; in the future, the mechanism
11911 may be extended to support this.  The standard frameworks can be found
11912 in @file{/System/Library/Frameworks} and
11913 @file{/Library/Frameworks}.  An example include looks like
11914 @code{#include <Framework/header.h>}, where @file{Framework} denotes
11915 the name of the framework and @file{header.h} is found in the
11916 @file{PrivateHeaders} or @file{Headers} directory.
11917
11918 @item -iframework@var{dir}
11919 @opindex iframework
11920 Like @option{-F} except the directory is a treated as a system
11921 directory.  The main difference between this @option{-iframework} and
11922 @option{-F} is that with @option{-iframework} the compiler does not
11923 warn about constructs contained within header files found via
11924 @var{dir}.  This option is valid only for the C family of languages.
11925
11926 @item -gused
11927 @opindex gused
11928 Emit debugging information for symbols that are used.  For stabs
11929 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
11930 This is by default ON@.
11931
11932 @item -gfull
11933 @opindex gfull
11934 Emit debugging information for all symbols and types.
11935
11936 @item -mmacosx-version-min=@var{version}
11937 The earliest version of MacOS X that this executable will run on
11938 is @var{version}.  Typical values of @var{version} include @code{10.1},
11939 @code{10.2}, and @code{10.3.9}.
11940
11941 If the compiler was built to use the system's headers by default,
11942 then the default for this option is the system version on which the
11943 compiler is running, otherwise the default is to make choices that
11944 are compatible with as many systems and code bases as possible.
11945
11946 @item -mkernel
11947 @opindex mkernel
11948 Enable kernel development mode.  The @option{-mkernel} option sets
11949 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
11950 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
11951 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
11952 applicable.  This mode also sets @option{-mno-altivec},
11953 @option{-msoft-float}, @option{-fno-builtin} and
11954 @option{-mlong-branch} for PowerPC targets.
11955
11956 @item -mone-byte-bool
11957 @opindex mone-byte-bool
11958 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
11959 By default @samp{sizeof(bool)} is @samp{4} when compiling for
11960 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
11961 option has no effect on x86.
11962
11963 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
11964 to generate code that is not binary compatible with code generated
11965 without that switch.  Using this switch may require recompiling all
11966 other modules in a program, including system libraries.  Use this
11967 switch to conform to a non-default data model.
11968
11969 @item -mfix-and-continue
11970 @itemx -ffix-and-continue
11971 @itemx -findirect-data
11972 @opindex mfix-and-continue
11973 @opindex ffix-and-continue
11974 @opindex findirect-data
11975 Generate code suitable for fast turn around development.  Needed to
11976 enable GDB to dynamically load @code{.o} files into already running
11977 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
11978 are provided for backwards compatibility.
11979
11980 @item -all_load
11981 @opindex all_load
11982 Loads all members of static archive libraries.
11983 See man ld(1) for more information.
11984
11985 @item -arch_errors_fatal
11986 @opindex arch_errors_fatal
11987 Cause the errors having to do with files that have the wrong architecture
11988 to be fatal.
11989
11990 @item -bind_at_load
11991 @opindex bind_at_load
11992 Causes the output file to be marked such that the dynamic linker will
11993 bind all undefined references when the file is loaded or launched.
11994
11995 @item -bundle
11996 @opindex bundle
11997 Produce a Mach-o bundle format file.
11998 See man ld(1) for more information.
11999
12000 @item -bundle_loader @var{executable}
12001 @opindex bundle_loader
12002 This option specifies the @var{executable} that will load the build
12003 output file being linked.  See man ld(1) for more information.
12004
12005 @item -dynamiclib
12006 @opindex dynamiclib
12007 When passed this option, GCC produces a dynamic library instead of
12008 an executable when linking, using the Darwin @file{libtool} command.
12009
12010 @item -force_cpusubtype_ALL
12011 @opindex force_cpusubtype_ALL
12012 This causes GCC's output file to have the @var{ALL} subtype, instead of
12013 one controlled by the @option{-mcpu} or @option{-march} option.
12014
12015 @item -allowable_client  @var{client_name}
12016 @itemx -client_name
12017 @itemx -compatibility_version
12018 @itemx -current_version
12019 @itemx -dead_strip
12020 @itemx -dependency-file
12021 @itemx -dylib_file
12022 @itemx -dylinker_install_name
12023 @itemx -dynamic
12024 @itemx -exported_symbols_list
12025 @itemx -filelist
12026 @need 800
12027 @itemx -flat_namespace
12028 @itemx -force_flat_namespace
12029 @itemx -headerpad_max_install_names
12030 @itemx -image_base
12031 @itemx -init
12032 @itemx -install_name
12033 @itemx -keep_private_externs
12034 @itemx -multi_module
12035 @itemx -multiply_defined
12036 @itemx -multiply_defined_unused
12037 @need 800
12038 @itemx -noall_load
12039 @itemx -no_dead_strip_inits_and_terms
12040 @itemx -nofixprebinding
12041 @itemx -nomultidefs
12042 @itemx -noprebind
12043 @itemx -noseglinkedit
12044 @itemx -pagezero_size
12045 @itemx -prebind
12046 @itemx -prebind_all_twolevel_modules
12047 @itemx -private_bundle
12048 @need 800
12049 @itemx -read_only_relocs
12050 @itemx -sectalign
12051 @itemx -sectobjectsymbols
12052 @itemx -whyload
12053 @itemx -seg1addr
12054 @itemx -sectcreate
12055 @itemx -sectobjectsymbols
12056 @itemx -sectorder
12057 @itemx -segaddr
12058 @itemx -segs_read_only_addr
12059 @need 800
12060 @itemx -segs_read_write_addr
12061 @itemx -seg_addr_table
12062 @itemx -seg_addr_table_filename
12063 @itemx -seglinkedit
12064 @itemx -segprot
12065 @itemx -segs_read_only_addr
12066 @itemx -segs_read_write_addr
12067 @itemx -single_module
12068 @itemx -static
12069 @itemx -sub_library
12070 @need 800
12071 @itemx -sub_umbrella
12072 @itemx -twolevel_namespace
12073 @itemx -umbrella
12074 @itemx -undefined
12075 @itemx -unexported_symbols_list
12076 @itemx -weak_reference_mismatches
12077 @itemx -whatsloaded
12078 @opindex allowable_client
12079 @opindex client_name
12080 @opindex compatibility_version
12081 @opindex current_version
12082 @opindex dead_strip
12083 @opindex dependency-file
12084 @opindex dylib_file
12085 @opindex dylinker_install_name
12086 @opindex dynamic
12087 @opindex exported_symbols_list
12088 @opindex filelist
12089 @opindex flat_namespace
12090 @opindex force_flat_namespace
12091 @opindex headerpad_max_install_names
12092 @opindex image_base
12093 @opindex init
12094 @opindex install_name
12095 @opindex keep_private_externs
12096 @opindex multi_module
12097 @opindex multiply_defined
12098 @opindex multiply_defined_unused
12099 @opindex noall_load
12100 @opindex no_dead_strip_inits_and_terms
12101 @opindex nofixprebinding
12102 @opindex nomultidefs
12103 @opindex noprebind
12104 @opindex noseglinkedit
12105 @opindex pagezero_size
12106 @opindex prebind
12107 @opindex prebind_all_twolevel_modules
12108 @opindex private_bundle
12109 @opindex read_only_relocs
12110 @opindex sectalign
12111 @opindex sectobjectsymbols
12112 @opindex whyload
12113 @opindex seg1addr
12114 @opindex sectcreate
12115 @opindex sectobjectsymbols
12116 @opindex sectorder
12117 @opindex segaddr
12118 @opindex segs_read_only_addr
12119 @opindex segs_read_write_addr
12120 @opindex seg_addr_table
12121 @opindex seg_addr_table_filename
12122 @opindex seglinkedit
12123 @opindex segprot
12124 @opindex segs_read_only_addr
12125 @opindex segs_read_write_addr
12126 @opindex single_module
12127 @opindex static
12128 @opindex sub_library
12129 @opindex sub_umbrella
12130 @opindex twolevel_namespace
12131 @opindex umbrella
12132 @opindex undefined
12133 @opindex unexported_symbols_list
12134 @opindex weak_reference_mismatches
12135 @opindex whatsloaded
12136 These options are passed to the Darwin linker.  The Darwin linker man page
12137 describes them in detail.
12138 @end table
12139
12140 @node DEC Alpha Options
12141 @subsection DEC Alpha Options
12142
12143 These @samp{-m} options are defined for the DEC Alpha implementations:
12144
12145 @table @gcctabopt
12146 @item -mno-soft-float
12147 @itemx -msoft-float
12148 @opindex mno-soft-float
12149 @opindex msoft-float
12150 Use (do not use) the hardware floating-point instructions for
12151 floating-point operations.  When @option{-msoft-float} is specified,
12152 functions in @file{libgcc.a} are used to perform floating-point
12153 operations.  Unless they are replaced by routines that emulate the
12154 floating-point operations, or compiled in such a way as to call such
12155 emulations routines, these routines issue floating-point
12156 operations.   If you are compiling for an Alpha without floating-point
12157 operations, you must ensure that the library is built so as not to call
12158 them.
12159
12160 Note that Alpha implementations without floating-point operations are
12161 required to have floating-point registers.
12162
12163 @item -mfp-reg
12164 @itemx -mno-fp-regs
12165 @opindex mfp-reg
12166 @opindex mno-fp-regs
12167 Generate code that uses (does not use) the floating-point register set.
12168 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
12169 register set is not used, floating-point operands are passed in integer
12170 registers as if they were integers and floating-point results are passed
12171 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
12172 so any function with a floating-point argument or return value called by code
12173 compiled with @option{-mno-fp-regs} must also be compiled with that
12174 option.
12175
12176 A typical use of this option is building a kernel that does not use,
12177 and hence need not save and restore, any floating-point registers.
12178
12179 @item -mieee
12180 @opindex mieee
12181 The Alpha architecture implements floating-point hardware optimized for
12182 maximum performance.  It is mostly compliant with the IEEE floating-point
12183 standard.  However, for full compliance, software assistance is
12184 required.  This option generates code fully IEEE-compliant code
12185 @emph{except} that the @var{inexact-flag} is not maintained (see below).
12186 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
12187 defined during compilation.  The resulting code is less efficient but is
12188 able to correctly support denormalized numbers and exceptional IEEE
12189 values such as not-a-number and plus/minus infinity.  Other Alpha
12190 compilers call this option @option{-ieee_with_no_inexact}.
12191
12192 @item -mieee-with-inexact
12193 @opindex mieee-with-inexact
12194 This is like @option{-mieee} except the generated code also maintains
12195 the IEEE @var{inexact-flag}.  Turning on this option causes the
12196 generated code to implement fully-compliant IEEE math.  In addition to
12197 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
12198 macro.  On some Alpha implementations the resulting code may execute
12199 significantly slower than the code generated by default.  Since there is
12200 very little code that depends on the @var{inexact-flag}, you should
12201 normally not specify this option.  Other Alpha compilers call this
12202 option @option{-ieee_with_inexact}.
12203
12204 @item -mfp-trap-mode=@var{trap-mode}
12205 @opindex mfp-trap-mode
12206 This option controls what floating-point related traps are enabled.
12207 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
12208 The trap mode can be set to one of four values:
12209
12210 @table @samp
12211 @item n
12212 This is the default (normal) setting.  The only traps that are enabled
12213 are the ones that cannot be disabled in software (e.g., division by zero
12214 trap).
12215
12216 @item u
12217 In addition to the traps enabled by @samp{n}, underflow traps are enabled
12218 as well.
12219
12220 @item su
12221 Like @samp{u}, but the instructions are marked to be safe for software
12222 completion (see Alpha architecture manual for details).
12223
12224 @item sui
12225 Like @samp{su}, but inexact traps are enabled as well.
12226 @end table
12227
12228 @item -mfp-rounding-mode=@var{rounding-mode}
12229 @opindex mfp-rounding-mode
12230 Selects the IEEE rounding mode.  Other Alpha compilers call this option
12231 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
12232 of:
12233
12234 @table @samp
12235 @item n
12236 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
12237 the nearest machine number or towards the even machine number in case
12238 of a tie.
12239
12240 @item m
12241 Round towards minus infinity.
12242
12243 @item c
12244 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
12245
12246 @item d
12247 Dynamic rounding mode.  A field in the floating-point control register
12248 (@var{fpcr}, see Alpha architecture reference manual) controls the
12249 rounding mode in effect.  The C library initializes this register for
12250 rounding towards plus infinity.  Thus, unless your program modifies the
12251 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
12252 @end table
12253
12254 @item -mtrap-precision=@var{trap-precision}
12255 @opindex mtrap-precision
12256 In the Alpha architecture, floating-point traps are imprecise.  This
12257 means without software assistance it is impossible to recover from a
12258 floating trap and program execution normally needs to be terminated.
12259 GCC can generate code that can assist operating system trap handlers
12260 in determining the exact location that caused a floating-point trap.
12261 Depending on the requirements of an application, different levels of
12262 precisions can be selected:
12263
12264 @table @samp
12265 @item p
12266 Program precision.  This option is the default and means a trap handler
12267 can only identify which program caused a floating-point exception.
12268
12269 @item f
12270 Function precision.  The trap handler can determine the function that
12271 caused a floating-point exception.
12272
12273 @item i
12274 Instruction precision.  The trap handler can determine the exact
12275 instruction that caused a floating-point exception.
12276 @end table
12277
12278 Other Alpha compilers provide the equivalent options called
12279 @option{-scope_safe} and @option{-resumption_safe}.
12280
12281 @item -mieee-conformant
12282 @opindex mieee-conformant
12283 This option marks the generated code as IEEE conformant.  You must not
12284 use this option unless you also specify @option{-mtrap-precision=i} and either
12285 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
12286 is to emit the line @samp{.eflag 48} in the function prologue of the
12287 generated assembly file.
12288
12289 @item -mbuild-constants
12290 @opindex mbuild-constants
12291 Normally GCC examines a 32- or 64-bit integer constant to
12292 see if it can construct it from smaller constants in two or three
12293 instructions.  If it cannot, it outputs the constant as a literal and
12294 generates code to load it from the data segment at run time.
12295
12296 Use this option to require GCC to construct @emph{all} integer constants
12297 using code, even if it takes more instructions (the maximum is six).
12298
12299 You typically use this option to build a shared library dynamic
12300 loader.  Itself a shared library, it must relocate itself in memory
12301 before it can find the variables and constants in its own data segment.
12302
12303 @item -mbwx
12304 @itemx -mno-bwx
12305 @itemx -mcix
12306 @itemx -mno-cix
12307 @itemx -mfix
12308 @itemx -mno-fix
12309 @itemx -mmax
12310 @itemx -mno-max
12311 @opindex mbwx
12312 @opindex mno-bwx
12313 @opindex mcix
12314 @opindex mno-cix
12315 @opindex mfix
12316 @opindex mno-fix
12317 @opindex mmax
12318 @opindex mno-max
12319 Indicate whether GCC should generate code to use the optional BWX,
12320 CIX, FIX and MAX instruction sets.  The default is to use the instruction
12321 sets supported by the CPU type specified via @option{-mcpu=} option or that
12322 of the CPU on which GCC was built if none is specified.
12323
12324 @item -mfloat-vax
12325 @itemx -mfloat-ieee
12326 @opindex mfloat-vax
12327 @opindex mfloat-ieee
12328 Generate code that uses (does not use) VAX F and G floating-point
12329 arithmetic instead of IEEE single and double precision.
12330
12331 @item -mexplicit-relocs
12332 @itemx -mno-explicit-relocs
12333 @opindex mexplicit-relocs
12334 @opindex mno-explicit-relocs
12335 Older Alpha assemblers provided no way to generate symbol relocations
12336 except via assembler macros.  Use of these macros does not allow
12337 optimal instruction scheduling.  GNU binutils as of version 2.12
12338 supports a new syntax that allows the compiler to explicitly mark
12339 which relocations should apply to which instructions.  This option
12340 is mostly useful for debugging, as GCC detects the capabilities of
12341 the assembler when it is built and sets the default accordingly.
12342
12343 @item -msmall-data
12344 @itemx -mlarge-data
12345 @opindex msmall-data
12346 @opindex mlarge-data
12347 When @option{-mexplicit-relocs} is in effect, static data is
12348 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
12349 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
12350 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
12351 16-bit relocations off of the @code{$gp} register.  This limits the
12352 size of the small data area to 64KB, but allows the variables to be
12353 directly accessed via a single instruction.
12354
12355 The default is @option{-mlarge-data}.  With this option the data area
12356 is limited to just below 2GB@.  Programs that require more than 2GB of
12357 data must use @code{malloc} or @code{mmap} to allocate the data in the
12358 heap instead of in the program's data segment.
12359
12360 When generating code for shared libraries, @option{-fpic} implies
12361 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
12362
12363 @item -msmall-text
12364 @itemx -mlarge-text
12365 @opindex msmall-text
12366 @opindex mlarge-text
12367 When @option{-msmall-text} is used, the compiler assumes that the
12368 code of the entire program (or shared library) fits in 4MB, and is
12369 thus reachable with a branch instruction.  When @option{-msmall-data}
12370 is used, the compiler can assume that all local symbols share the
12371 same @code{$gp} value, and thus reduce the number of instructions
12372 required for a function call from 4 to 1.
12373
12374 The default is @option{-mlarge-text}.
12375
12376 @item -mcpu=@var{cpu_type}
12377 @opindex mcpu
12378 Set the instruction set and instruction scheduling parameters for
12379 machine type @var{cpu_type}.  You can specify either the @samp{EV}
12380 style name or the corresponding chip number.  GCC supports scheduling
12381 parameters for the EV4, EV5 and EV6 family of processors and
12382 chooses the default values for the instruction set from the processor
12383 you specify.  If you do not specify a processor type, GCC defaults
12384 to the processor on which the compiler was built.
12385
12386 Supported values for @var{cpu_type} are
12387
12388 @table @samp
12389 @item ev4
12390 @itemx ev45
12391 @itemx 21064
12392 Schedules as an EV4 and has no instruction set extensions.
12393
12394 @item ev5
12395 @itemx 21164
12396 Schedules as an EV5 and has no instruction set extensions.
12397
12398 @item ev56
12399 @itemx 21164a
12400 Schedules as an EV5 and supports the BWX extension.
12401
12402 @item pca56
12403 @itemx 21164pc
12404 @itemx 21164PC
12405 Schedules as an EV5 and supports the BWX and MAX extensions.
12406
12407 @item ev6
12408 @itemx 21264
12409 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
12410
12411 @item ev67
12412 @itemx 21264a
12413 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
12414 @end table
12415
12416 Native toolchains also support the value @samp{native},
12417 which selects the best architecture option for the host processor.
12418 @option{-mcpu=native} has no effect if GCC does not recognize
12419 the processor.
12420
12421 @item -mtune=@var{cpu_type}
12422 @opindex mtune
12423 Set only the instruction scheduling parameters for machine type
12424 @var{cpu_type}.  The instruction set is not changed.
12425
12426 Native toolchains also support the value @samp{native},
12427 which selects the best architecture option for the host processor.
12428 @option{-mtune=native} has no effect if GCC does not recognize
12429 the processor.
12430
12431 @item -mmemory-latency=@var{time}
12432 @opindex mmemory-latency
12433 Sets the latency the scheduler should assume for typical memory
12434 references as seen by the application.  This number is highly
12435 dependent on the memory access patterns used by the application
12436 and the size of the external cache on the machine.
12437
12438 Valid options for @var{time} are
12439
12440 @table @samp
12441 @item @var{number}
12442 A decimal number representing clock cycles.
12443
12444 @item L1
12445 @itemx L2
12446 @itemx L3
12447 @itemx main
12448 The compiler contains estimates of the number of clock cycles for
12449 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
12450 (also called Dcache, Scache, and Bcache), as well as to main memory.
12451 Note that L3 is only valid for EV5.
12452
12453 @end table
12454 @end table
12455
12456 @node FR30 Options
12457 @subsection FR30 Options
12458 @cindex FR30 Options
12459
12460 These options are defined specifically for the FR30 port.
12461
12462 @table @gcctabopt
12463
12464 @item -msmall-model
12465 @opindex msmall-model
12466 Use the small address space model.  This can produce smaller code, but
12467 it does assume that all symbolic values and addresses fit into a
12468 20-bit range.
12469
12470 @item -mno-lsim
12471 @opindex mno-lsim
12472 Assume that runtime support has been provided and so there is no need
12473 to include the simulator library (@file{libsim.a}) on the linker
12474 command line.
12475
12476 @end table
12477
12478 @node FRV Options
12479 @subsection FRV Options
12480 @cindex FRV Options
12481
12482 @table @gcctabopt
12483 @item -mgpr-32
12484 @opindex mgpr-32
12485
12486 Only use the first 32 general-purpose registers.
12487
12488 @item -mgpr-64
12489 @opindex mgpr-64
12490
12491 Use all 64 general-purpose registers.
12492
12493 @item -mfpr-32
12494 @opindex mfpr-32
12495
12496 Use only the first 32 floating-point registers.
12497
12498 @item -mfpr-64
12499 @opindex mfpr-64
12500
12501 Use all 64 floating-point registers.
12502
12503 @item -mhard-float
12504 @opindex mhard-float
12505
12506 Use hardware instructions for floating-point operations.
12507
12508 @item -msoft-float
12509 @opindex msoft-float
12510
12511 Use library routines for floating-point operations.
12512
12513 @item -malloc-cc
12514 @opindex malloc-cc
12515
12516 Dynamically allocate condition code registers.
12517
12518 @item -mfixed-cc
12519 @opindex mfixed-cc
12520
12521 Do not try to dynamically allocate condition code registers, only
12522 use @code{icc0} and @code{fcc0}.
12523
12524 @item -mdword
12525 @opindex mdword
12526
12527 Change ABI to use double word insns.
12528
12529 @item -mno-dword
12530 @opindex mno-dword
12531
12532 Do not use double word instructions.
12533
12534 @item -mdouble
12535 @opindex mdouble
12536
12537 Use floating-point double instructions.
12538
12539 @item -mno-double
12540 @opindex mno-double
12541
12542 Do not use floating-point double instructions.
12543
12544 @item -mmedia
12545 @opindex mmedia
12546
12547 Use media instructions.
12548
12549 @item -mno-media
12550 @opindex mno-media
12551
12552 Do not use media instructions.
12553
12554 @item -mmuladd
12555 @opindex mmuladd
12556
12557 Use multiply and add/subtract instructions.
12558
12559 @item -mno-muladd
12560 @opindex mno-muladd
12561
12562 Do not use multiply and add/subtract instructions.
12563
12564 @item -mfdpic
12565 @opindex mfdpic
12566
12567 Select the FDPIC ABI, which uses function descriptors to represent
12568 pointers to functions.  Without any PIC/PIE-related options, it
12569 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
12570 assumes GOT entries and small data are within a 12-bit range from the
12571 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
12572 are computed with 32 bits.
12573 With a @samp{bfin-elf} target, this option implies @option{-msim}.
12574
12575 @item -minline-plt
12576 @opindex minline-plt
12577
12578 Enable inlining of PLT entries in function calls to functions that are
12579 not known to bind locally.  It has no effect without @option{-mfdpic}.
12580 It's enabled by default if optimizing for speed and compiling for
12581 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
12582 optimization option such as @option{-O3} or above is present in the
12583 command line.
12584
12585 @item -mTLS
12586 @opindex mTLS
12587
12588 Assume a large TLS segment when generating thread-local code.
12589
12590 @item -mtls
12591 @opindex mtls
12592
12593 Do not assume a large TLS segment when generating thread-local code.
12594
12595 @item -mgprel-ro
12596 @opindex mgprel-ro
12597
12598 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
12599 that is known to be in read-only sections.  It's enabled by default,
12600 except for @option{-fpic} or @option{-fpie}: even though it may help
12601 make the global offset table smaller, it trades 1 instruction for 4.
12602 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
12603 one of which may be shared by multiple symbols, and it avoids the need
12604 for a GOT entry for the referenced symbol, so it's more likely to be a
12605 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
12606
12607 @item -multilib-library-pic
12608 @opindex multilib-library-pic
12609
12610 Link with the (library, not FD) pic libraries.  It's implied by
12611 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
12612 @option{-fpic} without @option{-mfdpic}.  You should never have to use
12613 it explicitly.
12614
12615 @item -mlinked-fp
12616 @opindex mlinked-fp
12617
12618 Follow the EABI requirement of always creating a frame pointer whenever
12619 a stack frame is allocated.  This option is enabled by default and can
12620 be disabled with @option{-mno-linked-fp}.
12621
12622 @item -mlong-calls
12623 @opindex mlong-calls
12624
12625 Use indirect addressing to call functions outside the current
12626 compilation unit.  This allows the functions to be placed anywhere
12627 within the 32-bit address space.
12628
12629 @item -malign-labels
12630 @opindex malign-labels
12631
12632 Try to align labels to an 8-byte boundary by inserting nops into the
12633 previous packet.  This option only has an effect when VLIW packing
12634 is enabled.  It doesn't create new packets; it merely adds nops to
12635 existing ones.
12636
12637 @item -mlibrary-pic
12638 @opindex mlibrary-pic
12639
12640 Generate position-independent EABI code.
12641
12642 @item -macc-4
12643 @opindex macc-4
12644
12645 Use only the first four media accumulator registers.
12646
12647 @item -macc-8
12648 @opindex macc-8
12649
12650 Use all eight media accumulator registers.
12651
12652 @item -mpack
12653 @opindex mpack
12654
12655 Pack VLIW instructions.
12656
12657 @item -mno-pack
12658 @opindex mno-pack
12659
12660 Do not pack VLIW instructions.
12661
12662 @item -mno-eflags
12663 @opindex mno-eflags
12664
12665 Do not mark ABI switches in e_flags.
12666
12667 @item -mcond-move
12668 @opindex mcond-move
12669
12670 Enable the use of conditional-move instructions (default).
12671
12672 This switch is mainly for debugging the compiler and will likely be removed
12673 in a future version.
12674
12675 @item -mno-cond-move
12676 @opindex mno-cond-move
12677
12678 Disable the use of conditional-move instructions.
12679
12680 This switch is mainly for debugging the compiler and will likely be removed
12681 in a future version.
12682
12683 @item -mscc
12684 @opindex mscc
12685
12686 Enable the use of conditional set instructions (default).
12687
12688 This switch is mainly for debugging the compiler and will likely be removed
12689 in a future version.
12690
12691 @item -mno-scc
12692 @opindex mno-scc
12693
12694 Disable the use of conditional set instructions.
12695
12696 This switch is mainly for debugging the compiler and will likely be removed
12697 in a future version.
12698
12699 @item -mcond-exec
12700 @opindex mcond-exec
12701
12702 Enable the use of conditional execution (default).
12703
12704 This switch is mainly for debugging the compiler and will likely be removed
12705 in a future version.
12706
12707 @item -mno-cond-exec
12708 @opindex mno-cond-exec
12709
12710 Disable the use of conditional execution.
12711
12712 This switch is mainly for debugging the compiler and will likely be removed
12713 in a future version.
12714
12715 @item -mvliw-branch
12716 @opindex mvliw-branch
12717
12718 Run a pass to pack branches into VLIW instructions (default).
12719
12720 This switch is mainly for debugging the compiler and will likely be removed
12721 in a future version.
12722
12723 @item -mno-vliw-branch
12724 @opindex mno-vliw-branch
12725
12726 Do not run a pass to pack branches into VLIW instructions.
12727
12728 This switch is mainly for debugging the compiler and will likely be removed
12729 in a future version.
12730
12731 @item -mmulti-cond-exec
12732 @opindex mmulti-cond-exec
12733
12734 Enable optimization of @code{&&} and @code{||} in conditional execution
12735 (default).
12736
12737 This switch is mainly for debugging the compiler and will likely be removed
12738 in a future version.
12739
12740 @item -mno-multi-cond-exec
12741 @opindex mno-multi-cond-exec
12742
12743 Disable optimization of @code{&&} and @code{||} in conditional execution.
12744
12745 This switch is mainly for debugging the compiler and will likely be removed
12746 in a future version.
12747
12748 @item -mnested-cond-exec
12749 @opindex mnested-cond-exec
12750
12751 Enable nested conditional execution optimizations (default).
12752
12753 This switch is mainly for debugging the compiler and will likely be removed
12754 in a future version.
12755
12756 @item -mno-nested-cond-exec
12757 @opindex mno-nested-cond-exec
12758
12759 Disable nested conditional execution optimizations.
12760
12761 This switch is mainly for debugging the compiler and will likely be removed
12762 in a future version.
12763
12764 @item -moptimize-membar
12765 @opindex moptimize-membar
12766
12767 This switch removes redundant @code{membar} instructions from the
12768 compiler generated code.  It is enabled by default.
12769
12770 @item -mno-optimize-membar
12771 @opindex mno-optimize-membar
12772
12773 This switch disables the automatic removal of redundant @code{membar}
12774 instructions from the generated code.
12775
12776 @item -mtomcat-stats
12777 @opindex mtomcat-stats
12778
12779 Cause gas to print out tomcat statistics.
12780
12781 @item -mcpu=@var{cpu}
12782 @opindex mcpu
12783
12784 Select the processor type for which to generate code.  Possible values are
12785 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
12786 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
12787
12788 @end table
12789
12790 @node GNU/Linux Options
12791 @subsection GNU/Linux Options
12792
12793 These @samp{-m} options are defined for GNU/Linux targets:
12794
12795 @table @gcctabopt
12796 @item -mglibc
12797 @opindex mglibc
12798 Use the GNU C library.  This is the default except
12799 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
12800
12801 @item -muclibc
12802 @opindex muclibc
12803 Use uClibc C library.  This is the default on
12804 @samp{*-*-linux-*uclibc*} targets.
12805
12806 @item -mbionic
12807 @opindex mbionic
12808 Use Bionic C library.  This is the default on
12809 @samp{*-*-linux-*android*} targets.
12810
12811 @item -mandroid
12812 @opindex mandroid
12813 Compile code compatible with Android platform.  This is the default on
12814 @samp{*-*-linux-*android*} targets.
12815
12816 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
12817 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
12818 this option makes the GCC driver pass Android-specific options to the linker.
12819 Finally, this option causes the preprocessor macro @code{__ANDROID__}
12820 to be defined.
12821
12822 @item -tno-android-cc
12823 @opindex tno-android-cc
12824 Disable compilation effects of @option{-mandroid}, i.e., do not enable
12825 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
12826 @option{-fno-rtti} by default.
12827
12828 @item -tno-android-ld
12829 @opindex tno-android-ld
12830 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
12831 linking options to the linker.
12832
12833 @end table
12834
12835 @node H8/300 Options
12836 @subsection H8/300 Options
12837
12838 These @samp{-m} options are defined for the H8/300 implementations:
12839
12840 @table @gcctabopt
12841 @item -mrelax
12842 @opindex mrelax
12843 Shorten some address references at link time, when possible; uses the
12844 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
12845 ld, Using ld}, for a fuller description.
12846
12847 @item -mh
12848 @opindex mh
12849 Generate code for the H8/300H@.
12850
12851 @item -ms
12852 @opindex ms
12853 Generate code for the H8S@.
12854
12855 @item -mn
12856 @opindex mn
12857 Generate code for the H8S and H8/300H in the normal mode.  This switch
12858 must be used either with @option{-mh} or @option{-ms}.
12859
12860 @item -ms2600
12861 @opindex ms2600
12862 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
12863
12864 @item -mexr
12865 @opindex mexr
12866 Extended registers are stored on stack before execution of function
12867 with monitor attribute. Default option is @option{-mexr}.
12868 This option is valid only for H8S targets.
12869
12870 @item -mno-exr
12871 @opindex mno-exr
12872 Extended registers are not stored on stack before execution of function 
12873 with monitor attribute. Default option is @option{-mno-exr}. 
12874 This option is valid only for H8S targets.
12875
12876 @item -mint32
12877 @opindex mint32
12878 Make @code{int} data 32 bits by default.
12879
12880 @item -malign-300
12881 @opindex malign-300
12882 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
12883 The default for the H8/300H and H8S is to align longs and floats on
12884 4-byte boundaries.
12885 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
12886 This option has no effect on the H8/300.
12887 @end table
12888
12889 @node HPPA Options
12890 @subsection HPPA Options
12891 @cindex HPPA Options
12892
12893 These @samp{-m} options are defined for the HPPA family of computers:
12894
12895 @table @gcctabopt
12896 @item -march=@var{architecture-type}
12897 @opindex march
12898 Generate code for the specified architecture.  The choices for
12899 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
12900 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
12901 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
12902 architecture option for your machine.  Code compiled for lower numbered
12903 architectures runs on higher numbered architectures, but not the
12904 other way around.
12905
12906 @item -mpa-risc-1-0
12907 @itemx -mpa-risc-1-1
12908 @itemx -mpa-risc-2-0
12909 @opindex mpa-risc-1-0
12910 @opindex mpa-risc-1-1
12911 @opindex mpa-risc-2-0
12912 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
12913
12914 @item -mbig-switch
12915 @opindex mbig-switch
12916 Generate code suitable for big switch tables.  Use this option only if
12917 the assembler/linker complain about out of range branches within a switch
12918 table.
12919
12920 @item -mjump-in-delay
12921 @opindex mjump-in-delay
12922 Fill delay slots of function calls with unconditional jump instructions
12923 by modifying the return pointer for the function call to be the target
12924 of the conditional jump.
12925
12926 @item -mdisable-fpregs
12927 @opindex mdisable-fpregs
12928 Prevent floating-point registers from being used in any manner.  This is
12929 necessary for compiling kernels that perform lazy context switching of
12930 floating-point registers.  If you use this option and attempt to perform
12931 floating-point operations, the compiler aborts.
12932
12933 @item -mdisable-indexing
12934 @opindex mdisable-indexing
12935 Prevent the compiler from using indexing address modes.  This avoids some
12936 rather obscure problems when compiling MIG generated code under MACH@.
12937
12938 @item -mno-space-regs
12939 @opindex mno-space-regs
12940 Generate code that assumes the target has no space registers.  This allows
12941 GCC to generate faster indirect calls and use unscaled index address modes.
12942
12943 Such code is suitable for level 0 PA systems and kernels.
12944
12945 @item -mfast-indirect-calls
12946 @opindex mfast-indirect-calls
12947 Generate code that assumes calls never cross space boundaries.  This
12948 allows GCC to emit code that performs faster indirect calls.
12949
12950 This option does not work in the presence of shared libraries or nested
12951 functions.
12952
12953 @item -mfixed-range=@var{register-range}
12954 @opindex mfixed-range
12955 Generate code treating the given register range as fixed registers.
12956 A fixed register is one that the register allocator can not use.  This is
12957 useful when compiling kernel code.  A register range is specified as
12958 two registers separated by a dash.  Multiple register ranges can be
12959 specified separated by a comma.
12960
12961 @item -mlong-load-store
12962 @opindex mlong-load-store
12963 Generate 3-instruction load and store sequences as sometimes required by
12964 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
12965 the HP compilers.
12966
12967 @item -mportable-runtime
12968 @opindex mportable-runtime
12969 Use the portable calling conventions proposed by HP for ELF systems.
12970
12971 @item -mgas
12972 @opindex mgas
12973 Enable the use of assembler directives only GAS understands.
12974
12975 @item -mschedule=@var{cpu-type}
12976 @opindex mschedule
12977 Schedule code according to the constraints for the machine type
12978 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
12979 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
12980 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
12981 proper scheduling option for your machine.  The default scheduling is
12982 @samp{8000}.
12983
12984 @item -mlinker-opt
12985 @opindex mlinker-opt
12986 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
12987 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
12988 linkers in which they give bogus error messages when linking some programs.
12989
12990 @item -msoft-float
12991 @opindex msoft-float
12992 Generate output containing library calls for floating point.
12993 @strong{Warning:} the requisite libraries are not available for all HPPA
12994 targets.  Normally the facilities of the machine's usual C compiler are
12995 used, but this cannot be done directly in cross-compilation.  You must make
12996 your own arrangements to provide suitable library functions for
12997 cross-compilation.
12998
12999 @option{-msoft-float} changes the calling convention in the output file;
13000 therefore, it is only useful if you compile @emph{all} of a program with
13001 this option.  In particular, you need to compile @file{libgcc.a}, the
13002 library that comes with GCC, with @option{-msoft-float} in order for
13003 this to work.
13004
13005 @item -msio
13006 @opindex msio
13007 Generate the predefine, @code{_SIO}, for server IO@.  The default is
13008 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
13009 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
13010 options are available under HP-UX and HI-UX@.
13011
13012 @item -mgnu-ld
13013 @opindex mgnu-ld
13014 Use options specific to GNU @command{ld}.
13015 This passes @option{-shared} to @command{ld} when
13016 building a shared library.  It is the default when GCC is configured,
13017 explicitly or implicitly, with the GNU linker.  This option does not
13018 affect which @command{ld} is called; it only changes what parameters
13019 are passed to that @command{ld}.
13020 The @command{ld} that is called is determined by the
13021 @option{--with-ld} configure option, GCC's program search path, and
13022 finally by the user's @env{PATH}.  The linker used by GCC can be printed
13023 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
13024 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13025
13026 @item -mhp-ld
13027 @opindex mhp-ld
13028 Use options specific to HP @command{ld}.
13029 This passes @option{-b} to @command{ld} when building
13030 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
13031 links.  It is the default when GCC is configured, explicitly or
13032 implicitly, with the HP linker.  This option does not affect
13033 which @command{ld} is called; it only changes what parameters are passed to that
13034 @command{ld}.
13035 The @command{ld} that is called is determined by the @option{--with-ld}
13036 configure option, GCC's program search path, and finally by the user's
13037 @env{PATH}.  The linker used by GCC can be printed using @samp{which
13038 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
13039 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
13040
13041 @item -mlong-calls
13042 @opindex mno-long-calls
13043 Generate code that uses long call sequences.  This ensures that a call
13044 is always able to reach linker generated stubs.  The default is to generate
13045 long calls only when the distance from the call site to the beginning
13046 of the function or translation unit, as the case may be, exceeds a
13047 predefined limit set by the branch type being used.  The limits for
13048 normal calls are 7,600,000 and 240,000 bytes, respectively for the
13049 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
13050 240,000 bytes.
13051
13052 Distances are measured from the beginning of functions when using the
13053 @option{-ffunction-sections} option, or when using the @option{-mgas}
13054 and @option{-mno-portable-runtime} options together under HP-UX with
13055 the SOM linker.
13056
13057 It is normally not desirable to use this option as it degrades
13058 performance.  However, it may be useful in large applications,
13059 particularly when partial linking is used to build the application.
13060
13061 The types of long calls used depends on the capabilities of the
13062 assembler and linker, and the type of code being generated.  The
13063 impact on systems that support long absolute calls, and long pic
13064 symbol-difference or pc-relative calls should be relatively small.
13065 However, an indirect call is used on 32-bit ELF systems in pic code
13066 and it is quite long.
13067
13068 @item -munix=@var{unix-std}
13069 @opindex march
13070 Generate compiler predefines and select a startfile for the specified
13071 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
13072 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
13073 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
13074 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
13075 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
13076 and later.
13077
13078 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
13079 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
13080 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
13081 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
13082 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
13083 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
13084
13085 It is @emph{important} to note that this option changes the interfaces
13086 for various library routines.  It also affects the operational behavior
13087 of the C library.  Thus, @emph{extreme} care is needed in using this
13088 option.
13089
13090 Library code that is intended to operate with more than one UNIX
13091 standard must test, set and restore the variable @var{__xpg4_extended_mask}
13092 as appropriate.  Most GNU software doesn't provide this capability.
13093
13094 @item -nolibdld
13095 @opindex nolibdld
13096 Suppress the generation of link options to search libdld.sl when the
13097 @option{-static} option is specified on HP-UX 10 and later.
13098
13099 @item -static
13100 @opindex static
13101 The HP-UX implementation of setlocale in libc has a dependency on
13102 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
13103 when the @option{-static} option is specified, special link options
13104 are needed to resolve this dependency.
13105
13106 On HP-UX 10 and later, the GCC driver adds the necessary options to
13107 link with libdld.sl when the @option{-static} option is specified.
13108 This causes the resulting binary to be dynamic.  On the 64-bit port,
13109 the linkers generate dynamic binaries by default in any case.  The
13110 @option{-nolibdld} option can be used to prevent the GCC driver from
13111 adding these link options.
13112
13113 @item -threads
13114 @opindex threads
13115 Add support for multithreading with the @dfn{dce thread} library
13116 under HP-UX@.  This option sets flags for both the preprocessor and
13117 linker.
13118 @end table
13119
13120 @node i386 and x86-64 Options
13121 @subsection Intel 386 and AMD x86-64 Options
13122 @cindex i386 Options
13123 @cindex x86-64 Options
13124 @cindex Intel 386 Options
13125 @cindex AMD x86-64 Options
13126
13127 These @samp{-m} options are defined for the i386 and x86-64 family of
13128 computers:
13129
13130 @table @gcctabopt
13131
13132 @item -march=@var{cpu-type}
13133 @opindex march
13134 Generate instructions for the machine type @var{cpu-type}.  In contrast to
13135 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
13136 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
13137 to generate code that may not run at all on processors other than the one
13138 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
13139 @option{-mtune=@var{cpu-type}}.
13140
13141 The choices for @var{cpu-type} are:
13142
13143 @table @samp
13144 @item native
13145 This selects the CPU to generate code for at compilation time by determining
13146 the processor type of the compiling machine.  Using @option{-march=native}
13147 enables all instruction subsets supported by the local machine (hence
13148 the result might not run on different machines).  Using @option{-mtune=native}
13149 produces code optimized for the local machine under the constraints
13150 of the selected instruction set.  
13151
13152 @item i386
13153 Original Intel i386 CPU@.
13154
13155 @item i486
13156 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
13157
13158 @item i586
13159 @itemx pentium
13160 Intel Pentium CPU with no MMX support.
13161
13162 @item pentium-mmx
13163 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
13164
13165 @item pentiumpro
13166 Intel Pentium Pro CPU@.
13167
13168 @item i686
13169 When used with @option{-march}, the Pentium Pro
13170 instruction set is used, so the code runs on all i686 family chips.
13171 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
13172
13173 @item pentium2
13174 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
13175 support.
13176
13177 @item pentium3
13178 @itemx pentium3m
13179 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
13180 set support.
13181
13182 @item pentium-m
13183 Intel Pentium M; low-power version of Intel Pentium III CPU
13184 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
13185
13186 @item pentium4
13187 @itemx pentium4m
13188 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
13189
13190 @item prescott
13191 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
13192 set support.
13193
13194 @item nocona
13195 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
13196 SSE2 and SSE3 instruction set support.
13197
13198 @item core2
13199 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13200 instruction set support.
13201
13202 @item corei7
13203 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1
13204 and SSE4.2 instruction set support.
13205
13206 @item corei7-avx
13207 Intel Core i7 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13208 SSE4.1, SSE4.2, AVX, AES and PCLMUL instruction set support.
13209
13210 @item core-avx-i
13211 Intel Core CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
13212 SSE4.1, SSE4.2, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C instruction
13213 set support.
13214
13215 @item atom
13216 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
13217 instruction set support.
13218
13219 @item k6
13220 AMD K6 CPU with MMX instruction set support.
13221
13222 @item k6-2
13223 @itemx k6-3
13224 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
13225
13226 @item athlon
13227 @itemx athlon-tbird
13228 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
13229 support.
13230
13231 @item athlon-4
13232 @itemx athlon-xp
13233 @itemx athlon-mp
13234 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
13235 instruction set support.
13236
13237 @item k8
13238 @itemx opteron
13239 @itemx athlon64
13240 @itemx athlon-fx
13241 Processors based on the AMD K8 core with x86-64 instruction set support,
13242 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
13243 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
13244 instruction set extensions.)
13245
13246 @item k8-sse3
13247 @itemx opteron-sse3
13248 @itemx athlon64-sse3
13249 Improved versions of AMD K8 cores with SSE3 instruction set support.
13250
13251 @item amdfam10
13252 @itemx barcelona
13253 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
13254 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
13255 instruction set extensions.)
13256
13257 @item bdver1
13258 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
13259 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
13260 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
13261 @item bdver2
13262 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
13263 supersets BMI, TBM, F16C, FMA, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE,
13264 SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
13265 extensions.)
13266
13267 @item btver1
13268 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
13269 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
13270 instruction set extensions.)
13271
13272 @item winchip-c6
13273 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
13274 set support.
13275
13276 @item winchip2
13277 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
13278 instruction set support.
13279
13280 @item c3
13281 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
13282 implemented for this chip.)
13283
13284 @item c3-2
13285 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
13286 (No scheduling is
13287 implemented for this chip.)
13288
13289 @item geode
13290 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
13291 @end table
13292
13293 @item -mtune=@var{cpu-type}
13294 @opindex mtune
13295 Tune to @var{cpu-type} everything applicable about the generated code, except
13296 for the ABI and the set of available instructions.  
13297 While picking a specific @var{cpu-type} schedules things appropriately
13298 for that particular chip, the compiler does not generate any code that
13299 cannot run on the default machine type unless you use a
13300 @option{-march=@var{cpu-type}} option.
13301 For example, if GCC is configured for i686-pc-linux-gnu
13302 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
13303 but still runs on i686 machines.
13304
13305 The choices for @var{cpu-type} are the same as for @option{-march}.
13306 In addition, @option{-mtune} supports an extra choice for @var{cpu-type}:
13307
13308 @table @samp
13309 @item generic
13310 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
13311 If you know the CPU on which your code will run, then you should use
13312 the corresponding @option{-mtune} or @option{-march} option instead of
13313 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
13314 of your application will have, then you should use this option.
13315
13316 As new processors are deployed in the marketplace, the behavior of this
13317 option will change.  Therefore, if you upgrade to a newer version of
13318 GCC, code generation controlled by this option will change to reflect
13319 the processors
13320 that are most common at the time that version of GCC is released.
13321
13322 There is no @option{-march=generic} option because @option{-march}
13323 indicates the instruction set the compiler can use, and there is no
13324 generic instruction set applicable to all processors.  In contrast,
13325 @option{-mtune} indicates the processor (or, in this case, collection of
13326 processors) for which the code is optimized.
13327 @end table
13328
13329 @item -mcpu=@var{cpu-type}
13330 @opindex mcpu
13331 A deprecated synonym for @option{-mtune}.
13332
13333 @item -mfpmath=@var{unit}
13334 @opindex mfpmath
13335 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
13336 for @var{unit} are:
13337
13338 @table @samp
13339 @item 387
13340 Use the standard 387 floating-point coprocessor present on the majority of chips and
13341 emulated otherwise.  Code compiled with this option runs almost everywhere.
13342 The temporary results are computed in 80-bit precision instead of the precision
13343 specified by the type, resulting in slightly different results compared to most
13344 of other chips.  See @option{-ffloat-store} for more detailed description.
13345
13346 This is the default choice for i386 compiler.
13347
13348 @item sse
13349 Use scalar floating-point instructions present in the SSE instruction set.
13350 This instruction set is supported by Pentium III and newer chips,
13351 and in the AMD line
13352 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
13353 instruction set supports only single-precision arithmetic, thus the double and
13354 extended-precision arithmetic are still done using 387.  A later version, present
13355 only in Pentium 4 and AMD x86-64 chips, supports double-precision
13356 arithmetic too.
13357
13358 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
13359 or @option{-msse2} switches to enable SSE extensions and make this option
13360 effective.  For the x86-64 compiler, these extensions are enabled by default.
13361
13362 The resulting code should be considerably faster in the majority of cases and avoid
13363 the numerical instability problems of 387 code, but may break some existing
13364 code that expects temporaries to be 80 bits.
13365
13366 This is the default choice for the x86-64 compiler.
13367
13368 @item sse,387
13369 @itemx sse+387
13370 @itemx both
13371 Attempt to utilize both instruction sets at once.  This effectively doubles the
13372 amount of available registers, and on chips with separate execution units for
13373 387 and SSE the execution resources too.  Use this option with care, as it is
13374 still experimental, because the GCC register allocator does not model separate
13375 functional units well, resulting in unstable performance.
13376 @end table
13377
13378 @item -masm=@var{dialect}
13379 @opindex masm=@var{dialect}
13380 Output assembly instructions using selected @var{dialect}.  Supported
13381 choices are @samp{intel} or @samp{att} (the default).  Darwin does
13382 not support @samp{intel}.
13383
13384 @item -mieee-fp
13385 @itemx -mno-ieee-fp
13386 @opindex mieee-fp
13387 @opindex mno-ieee-fp
13388 Control whether or not the compiler uses IEEE floating-point
13389 comparisons.  These correctly handle the case where the result of a
13390 comparison is unordered.
13391
13392 @item -msoft-float
13393 @opindex msoft-float
13394 Generate output containing library calls for floating point.
13395
13396 @strong{Warning:} the requisite libraries are not part of GCC@.
13397 Normally the facilities of the machine's usual C compiler are used, but
13398 this can't be done directly in cross-compilation.  You must make your
13399 own arrangements to provide suitable library functions for
13400 cross-compilation.
13401
13402 On machines where a function returns floating-point results in the 80387
13403 register stack, some floating-point opcodes may be emitted even if
13404 @option{-msoft-float} is used.
13405
13406 @item -mno-fp-ret-in-387
13407 @opindex mno-fp-ret-in-387
13408 Do not use the FPU registers for return values of functions.
13409
13410 The usual calling convention has functions return values of types
13411 @code{float} and @code{double} in an FPU register, even if there
13412 is no FPU@.  The idea is that the operating system should emulate
13413 an FPU@.
13414
13415 The option @option{-mno-fp-ret-in-387} causes such values to be returned
13416 in ordinary CPU registers instead.
13417
13418 @item -mno-fancy-math-387
13419 @opindex mno-fancy-math-387
13420 Some 387 emulators do not support the @code{sin}, @code{cos} and
13421 @code{sqrt} instructions for the 387.  Specify this option to avoid
13422 generating those instructions.  This option is the default on FreeBSD,
13423 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
13424 indicates that the target CPU always has an FPU and so the
13425 instruction does not need emulation.  These
13426 instructions are not generated unless you also use the
13427 @option{-funsafe-math-optimizations} switch.
13428
13429 @item -malign-double
13430 @itemx -mno-align-double
13431 @opindex malign-double
13432 @opindex mno-align-double
13433 Control whether GCC aligns @code{double}, @code{long double}, and
13434 @code{long long} variables on a two-word boundary or a one-word
13435 boundary.  Aligning @code{double} variables on a two-word boundary
13436 produces code that runs somewhat faster on a Pentium at the
13437 expense of more memory.
13438
13439 On x86-64, @option{-malign-double} is enabled by default.
13440
13441 @strong{Warning:} if you use the @option{-malign-double} switch,
13442 structures containing the above types are aligned differently than
13443 the published application binary interface specifications for the 386
13444 and are not binary compatible with structures in code compiled
13445 without that switch.
13446
13447 @item -m96bit-long-double
13448 @itemx -m128bit-long-double
13449 @opindex m96bit-long-double
13450 @opindex m128bit-long-double
13451 These switches control the size of @code{long double} type.  The i386
13452 application binary interface specifies the size to be 96 bits,
13453 so @option{-m96bit-long-double} is the default in 32-bit mode.
13454
13455 Modern architectures (Pentium and newer) prefer @code{long double}
13456 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
13457 conforming to the ABI, this is not possible.  So specifying
13458 @option{-m128bit-long-double} aligns @code{long double}
13459 to a 16-byte boundary by padding the @code{long double} with an additional
13460 32-bit zero.
13461
13462 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
13463 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
13464
13465 Notice that neither of these options enable any extra precision over the x87
13466 standard of 80 bits for a @code{long double}.
13467
13468 @strong{Warning:} if you override the default value for your target ABI, this
13469 changes the size of 
13470 structures and arrays containing @code{long double} variables,
13471 as well as modifying the function calling convention for functions taking
13472 @code{long double}.  Hence they are not binary-compatible
13473 with code compiled without that switch.
13474
13475 @item -mlarge-data-threshold=@var{threshold}
13476 @opindex mlarge-data-threshold
13477 When @option{-mcmodel=medium} is specified, data objects larger than
13478 @var{threshold} are placed in the large data section.  This value must be the
13479 same across all objects linked into the binary, and defaults to 65535.
13480
13481 @item -mrtd
13482 @opindex mrtd
13483 Use a different function-calling convention, in which functions that
13484 take a fixed number of arguments return with the @code{ret @var{num}}
13485 instruction, which pops their arguments while returning.  This saves one
13486 instruction in the caller since there is no need to pop the arguments
13487 there.
13488
13489 You can specify that an individual function is called with this calling
13490 sequence with the function attribute @samp{stdcall}.  You can also
13491 override the @option{-mrtd} option by using the function attribute
13492 @samp{cdecl}.  @xref{Function Attributes}.
13493
13494 @strong{Warning:} this calling convention is incompatible with the one
13495 normally used on Unix, so you cannot use it if you need to call
13496 libraries compiled with the Unix compiler.
13497
13498 Also, you must provide function prototypes for all functions that
13499 take variable numbers of arguments (including @code{printf});
13500 otherwise incorrect code is generated for calls to those
13501 functions.
13502
13503 In addition, seriously incorrect code results if you call a
13504 function with too many arguments.  (Normally, extra arguments are
13505 harmlessly ignored.)
13506
13507 @item -mregparm=@var{num}
13508 @opindex mregparm
13509 Control how many registers are used to pass integer arguments.  By
13510 default, no registers are used to pass arguments, and at most 3
13511 registers can be used.  You can control this behavior for a specific
13512 function by using the function attribute @samp{regparm}.
13513 @xref{Function Attributes}.
13514
13515 @strong{Warning:} if you use this switch, and
13516 @var{num} is nonzero, then you must build all modules with the same
13517 value, including any libraries.  This includes the system libraries and
13518 startup modules.
13519
13520 @item -msseregparm
13521 @opindex msseregparm
13522 Use SSE register passing conventions for float and double arguments
13523 and return values.  You can control this behavior for a specific
13524 function by using the function attribute @samp{sseregparm}.
13525 @xref{Function Attributes}.
13526
13527 @strong{Warning:} if you use this switch then you must build all
13528 modules with the same value, including any libraries.  This includes
13529 the system libraries and startup modules.
13530
13531 @item -mvect8-ret-in-mem
13532 @opindex mvect8-ret-in-mem
13533 Return 8-byte vectors in memory instead of MMX registers.  This is the
13534 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
13535 Studio compilers until version 12.  Later compiler versions (starting
13536 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
13537 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
13538 you need to remain compatible with existing code produced by those
13539 previous compiler versions or older versions of GCC@.
13540
13541 @item -mpc32
13542 @itemx -mpc64
13543 @itemx -mpc80
13544 @opindex mpc32
13545 @opindex mpc64
13546 @opindex mpc80
13547
13548 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
13549 is specified, the significands of results of floating-point operations are
13550 rounded to 24 bits (single precision); @option{-mpc64} rounds the
13551 significands of results of floating-point operations to 53 bits (double
13552 precision) and @option{-mpc80} rounds the significands of results of
13553 floating-point operations to 64 bits (extended double precision), which is
13554 the default.  When this option is used, floating-point operations in higher
13555 precisions are not available to the programmer without setting the FPU
13556 control word explicitly.
13557
13558 Setting the rounding of floating-point operations to less than the default
13559 80 bits can speed some programs by 2% or more.  Note that some mathematical
13560 libraries assume that extended-precision (80-bit) floating-point operations
13561 are enabled by default; routines in such libraries could suffer significant
13562 loss of accuracy, typically through so-called ``catastrophic cancellation'',
13563 when this option is used to set the precision to less than extended precision.
13564
13565 @item -mstackrealign
13566 @opindex mstackrealign
13567 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
13568 option generates an alternate prologue and epilogue that realigns the
13569 run-time stack if necessary.  This supports mixing legacy codes that keep
13570 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
13571 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
13572 applicable to individual functions.
13573
13574 @item -mpreferred-stack-boundary=@var{num}
13575 @opindex mpreferred-stack-boundary
13576 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
13577 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
13578 the default is 4 (16 bytes or 128 bits).
13579
13580 @strong{Warning:} When generating code for the x86-64 architecture with
13581 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
13582 used to keep the stack boundary aligned to 8 byte boundary.  Since
13583 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
13584 intended to be used in controlled environment where stack space is
13585 important limitation.  This option will lead to wrong code when functions
13586 compiled with 16 byte stack alignment (such as functions from a standard
13587 library) are called with misaligned stack.  In this case, SSE
13588 instructions may lead to misaligned memory access traps.  In addition,
13589 variable arguments will be handled incorrectly for 16 byte aligned
13590 objects (including x87 long double and __int128), leading to wrong
13591 results.  You must build all modules with
13592 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
13593 includes the system libraries and startup modules.
13594
13595 @item -mincoming-stack-boundary=@var{num}
13596 @opindex mincoming-stack-boundary
13597 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
13598 boundary.  If @option{-mincoming-stack-boundary} is not specified,
13599 the one specified by @option{-mpreferred-stack-boundary} is used.
13600
13601 On Pentium and Pentium Pro, @code{double} and @code{long double} values
13602 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
13603 suffer significant run time performance penalties.  On Pentium III, the
13604 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
13605 properly if it is not 16-byte aligned.
13606
13607 To ensure proper alignment of this values on the stack, the stack boundary
13608 must be as aligned as that required by any value stored on the stack.
13609 Further, every function must be generated such that it keeps the stack
13610 aligned.  Thus calling a function compiled with a higher preferred
13611 stack boundary from a function compiled with a lower preferred stack
13612 boundary most likely misaligns the stack.  It is recommended that
13613 libraries that use callbacks always use the default setting.
13614
13615 This extra alignment does consume extra stack space, and generally
13616 increases code size.  Code that is sensitive to stack space usage, such
13617 as embedded systems and operating system kernels, may want to reduce the
13618 preferred alignment to @option{-mpreferred-stack-boundary=2}.
13619
13620 @item -mmmx
13621 @itemx -mno-mmx
13622 @itemx -msse
13623 @itemx -mno-sse
13624 @itemx -msse2
13625 @itemx -mno-sse2
13626 @itemx -msse3
13627 @itemx -mno-sse3
13628 @itemx -mssse3
13629 @itemx -mno-ssse3
13630 @itemx -msse4.1
13631 @need 800
13632 @itemx -mno-sse4.1
13633 @itemx -msse4.2
13634 @itemx -mno-sse4.2
13635 @itemx -msse4
13636 @itemx -mno-sse4
13637 @itemx -mavx
13638 @itemx -mno-avx
13639 @itemx -mavx2
13640 @itemx -mno-avx2
13641 @itemx -maes
13642 @itemx -mno-aes
13643 @itemx -mpclmul
13644 @need 800
13645 @itemx -mno-pclmul
13646 @itemx -mfsgsbase
13647 @itemx -mno-fsgsbase
13648 @itemx -mrdrnd
13649 @itemx -mno-rdrnd
13650 @itemx -mf16c
13651 @itemx -mno-f16c
13652 @itemx -mfma
13653 @itemx -mno-fma
13654 @itemx -msse4a
13655 @itemx -mno-sse4a
13656 @itemx -mfma4
13657 @need 800
13658 @itemx -mno-fma4
13659 @itemx -mxop
13660 @itemx -mno-xop
13661 @itemx -mlwp
13662 @itemx -mno-lwp
13663 @itemx -m3dnow
13664 @itemx -mno-3dnow
13665 @itemx -mpopcnt
13666 @itemx -mno-popcnt
13667 @itemx -mabm
13668 @itemx -mno-abm
13669 @itemx -mbmi
13670 @itemx -mbmi2
13671 @itemx -mno-bmi
13672 @itemx -mno-bmi2
13673 @itemx -mlzcnt
13674 @itemx -mno-lzcnt
13675 @itemx -mrtm
13676 @itemx -mtbm
13677 @itemx -mno-tbm
13678 @opindex mmmx
13679 @opindex mno-mmx
13680 @opindex msse
13681 @opindex mno-sse
13682 @opindex m3dnow
13683 @opindex mno-3dnow
13684 These switches enable or disable the use of instructions in the MMX, SSE,
13685 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, F16C,
13686 FMA, SSE4A, FMA4, XOP, LWP, ABM, BMI, BMI2, LZCNT, RTM or 3DNow!@:
13687 extended instruction sets.
13688 These extensions are also available as built-in functions: see
13689 @ref{X86 Built-in Functions}, for details of the functions enabled and
13690 disabled by these switches.
13691
13692 To generate SSE/SSE2 instructions automatically from floating-point
13693 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
13694
13695 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
13696 generates new AVX instructions or AVX equivalence for all SSEx instructions
13697 when needed.
13698
13699 These options enable GCC to use these extended instructions in
13700 generated code, even without @option{-mfpmath=sse}.  Applications that
13701 perform run-time CPU detection must compile separate files for each
13702 supported architecture, using the appropriate flags.  In particular,
13703 the file containing the CPU detection code should be compiled without
13704 these options.
13705
13706 @item -mcld
13707 @opindex mcld
13708 This option instructs GCC to emit a @code{cld} instruction in the prologue
13709 of functions that use string instructions.  String instructions depend on
13710 the DF flag to select between autoincrement or autodecrement mode.  While the
13711 ABI specifies the DF flag to be cleared on function entry, some operating
13712 systems violate this specification by not clearing the DF flag in their
13713 exception dispatchers.  The exception handler can be invoked with the DF flag
13714 set, which leads to wrong direction mode when string instructions are used.
13715 This option can be enabled by default on 32-bit x86 targets by configuring
13716 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
13717 instructions can be suppressed with the @option{-mno-cld} compiler option
13718 in this case.
13719
13720 @item -mvzeroupper
13721 @opindex mvzeroupper
13722 This option instructs GCC to emit a @code{vzeroupper} instruction
13723 before a transfer of control flow out of the function to minimize
13724 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
13725 intrinsics.
13726
13727 @item -mcx16
13728 @opindex mcx16
13729 This option enables GCC to generate @code{CMPXCHG16B} instructions.
13730 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
13731 (or oword) data types.  
13732 This is useful for high-resolution counters that can be updated
13733 by multiple processors (or cores).  This instruction is generated as part of
13734 atomic built-in functions: see @ref{__sync Builtins} or
13735 @ref{__atomic Builtins} for details.
13736
13737 @item -msahf
13738 @opindex msahf
13739 This option enables generation of @code{SAHF} instructions in 64-bit code.
13740 Early Intel Pentium 4 CPUs with Intel 64 support,
13741 prior to the introduction of Pentium 4 G1 step in December 2005,
13742 lacked the @code{LAHF} and @code{SAHF} instructions
13743 which were supported by AMD64.
13744 These are load and store instructions, respectively, for certain status flags.
13745 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
13746 @code{drem}, and @code{remainder} built-in functions;
13747 see @ref{Other Builtins} for details.
13748
13749 @item -mmovbe
13750 @opindex mmovbe
13751 This option enables use of the @code{movbe} instruction to implement
13752 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
13753
13754 @item -mcrc32
13755 @opindex mcrc32
13756 This option enables built-in functions @code{__builtin_ia32_crc32qi},
13757 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
13758 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
13759
13760 @item -mrecip
13761 @opindex mrecip
13762 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
13763 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
13764 with an additional Newton-Raphson step
13765 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
13766 (and their vectorized
13767 variants) for single-precision floating-point arguments.  These instructions
13768 are generated only when @option{-funsafe-math-optimizations} is enabled
13769 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
13770 Note that while the throughput of the sequence is higher than the throughput
13771 of the non-reciprocal instruction, the precision of the sequence can be
13772 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
13773
13774 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
13775 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
13776 combination), and doesn't need @option{-mrecip}.
13777
13778 Also note that GCC emits the above sequence with additional Newton-Raphson step
13779 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
13780 already with @option{-ffast-math} (or the above option combination), and
13781 doesn't need @option{-mrecip}.
13782
13783 @item -mrecip=@var{opt}
13784 @opindex mrecip=opt
13785 This option controls which reciprocal estimate instructions
13786 may be used.  @var{opt} is a comma-separated list of options, which may
13787 be preceded by a @samp{!} to invert the option:
13788
13789 @table @samp
13790 @item all
13791 Enable all estimate instructions.
13792
13793 @item default
13794 Enable the default instructions, equivalent to @option{-mrecip}.
13795
13796 @item none
13797 Disable all estimate instructions, equivalent to @option{-mno-recip}.
13798
13799 @item div
13800 Enable the approximation for scalar division.
13801
13802 @item vec-div
13803 Enable the approximation for vectorized division.
13804
13805 @item sqrt
13806 Enable the approximation for scalar square root.
13807
13808 @item vec-sqrt
13809 Enable the approximation for vectorized square root.
13810 @end table
13811
13812 So, for example, @option{-mrecip=all,!sqrt} enables
13813 all of the reciprocal approximations, except for square root.
13814
13815 @item -mveclibabi=@var{type}
13816 @opindex mveclibabi
13817 Specifies the ABI type to use for vectorizing intrinsics using an
13818 external library.  Supported values for @var{type} are @samp{svml} 
13819 for the Intel short
13820 vector math library and @samp{acml} for the AMD math core library.
13821 To use this option, both @option{-ftree-vectorize} and
13822 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
13823 ABI-compatible library must be specified at link time.
13824
13825 GCC currently emits calls to @code{vmldExp2},
13826 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
13827 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
13828 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
13829 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
13830 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
13831 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
13832 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
13833 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
13834 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
13835 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
13836 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
13837 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
13838 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
13839 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
13840 when @option{-mveclibabi=acml} is used.  
13841
13842 @item -mabi=@var{name}
13843 @opindex mabi
13844 Generate code for the specified calling convention.  Permissible values
13845 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
13846 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
13847 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
13848 You can control this behavior for a specific function by
13849 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
13850 @xref{Function Attributes}.
13851
13852 @item -mtls-dialect=@var{type}
13853 @opindex mtls-dialect
13854 Generate code to access thread-local storage using the @samp{gnu} or
13855 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
13856 @samp{gnu2} is more efficient, but it may add compile- and run-time
13857 requirements that cannot be satisfied on all systems.
13858
13859 @item -mpush-args
13860 @itemx -mno-push-args
13861 @opindex mpush-args
13862 @opindex mno-push-args
13863 Use PUSH operations to store outgoing parameters.  This method is shorter
13864 and usually equally fast as method using SUB/MOV operations and is enabled
13865 by default.  In some cases disabling it may improve performance because of
13866 improved scheduling and reduced dependencies.
13867
13868 @item -maccumulate-outgoing-args
13869 @opindex maccumulate-outgoing-args
13870 If enabled, the maximum amount of space required for outgoing arguments is
13871 computed in the function prologue.  This is faster on most modern CPUs
13872 because of reduced dependencies, improved scheduling and reduced stack usage
13873 when the preferred stack boundary is not equal to 2.  The drawback is a notable
13874 increase in code size.  This switch implies @option{-mno-push-args}.
13875
13876 @item -mthreads
13877 @opindex mthreads
13878 Support thread-safe exception handling on MinGW.  Programs that rely
13879 on thread-safe exception handling must compile and link all code with the
13880 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
13881 @code{-D_MT}; when linking, it links in a special thread helper library
13882 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
13883
13884 @item -mno-align-stringops
13885 @opindex mno-align-stringops
13886 Do not align the destination of inlined string operations.  This switch reduces
13887 code size and improves performance in case the destination is already aligned,
13888 but GCC doesn't know about it.
13889
13890 @item -minline-all-stringops
13891 @opindex minline-all-stringops
13892 By default GCC inlines string operations only when the destination is 
13893 known to be aligned to least a 4-byte boundary.  
13894 This enables more inlining and increases code
13895 size, but may improve performance of code that depends on fast
13896 @code{memcpy}, @code{strlen},
13897 and @code{memset} for short lengths.
13898
13899 @item -minline-stringops-dynamically
13900 @opindex minline-stringops-dynamically
13901 For string operations of unknown size, use run-time checks with
13902 inline code for small blocks and a library call for large blocks.
13903
13904 @item -mstringop-strategy=@var{alg}
13905 @opindex mstringop-strategy=@var{alg}
13906 Override the internal decision heuristic for the particular algorithm to use
13907 for inlining string operations.  The allowed values for @var{alg} are:
13908
13909 @table @samp
13910 @item rep_byte
13911 @itemx rep_4byte
13912 @itemx rep_8byte
13913 Expand using i386 @code{rep} prefix of the specified size.
13914
13915 @item byte_loop
13916 @itemx loop
13917 @itemx unrolled_loop
13918 Expand into an inline loop.
13919
13920 @item libcall
13921 Always use a library call.
13922 @end table
13923
13924 @item -momit-leaf-frame-pointer
13925 @opindex momit-leaf-frame-pointer
13926 Don't keep the frame pointer in a register for leaf functions.  This
13927 avoids the instructions to save, set up, and restore frame pointers and
13928 makes an extra register available in leaf functions.  The option
13929 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
13930 which might make debugging harder.
13931
13932 @item -mtls-direct-seg-refs
13933 @itemx -mno-tls-direct-seg-refs
13934 @opindex mtls-direct-seg-refs
13935 Controls whether TLS variables may be accessed with offsets from the
13936 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
13937 or whether the thread base pointer must be added.  Whether or not this
13938 is valid depends on the operating system, and whether it maps the
13939 segment to cover the entire TLS area.
13940
13941 For systems that use the GNU C Library, the default is on.
13942
13943 @item -msse2avx
13944 @itemx -mno-sse2avx
13945 @opindex msse2avx
13946 Specify that the assembler should encode SSE instructions with VEX
13947 prefix.  The option @option{-mavx} turns this on by default.
13948
13949 @item -mfentry
13950 @itemx -mno-fentry
13951 @opindex mfentry
13952 If profiling is active (@option{-pg}), put the profiling
13953 counter call before the prologue.
13954 Note: On x86 architectures the attribute @code{ms_hook_prologue}
13955 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
13956
13957 @item -m8bit-idiv
13958 @itemx -mno-8bit-idiv
13959 @opindex 8bit-idiv
13960 On some processors, like Intel Atom, 8-bit unsigned integer divide is
13961 much faster than 32-bit/64-bit integer divide.  This option generates a
13962 run-time check.  If both dividend and divisor are within range of 0
13963 to 255, 8-bit unsigned integer divide is used instead of
13964 32-bit/64-bit integer divide.
13965
13966 @item -mavx256-split-unaligned-load
13967 @itemx -mavx256-split-unaligned-store
13968 @opindex avx256-split-unaligned-load
13969 @opindex avx256-split-unaligned-store
13970 Split 32-byte AVX unaligned load and store.
13971
13972 @end table
13973
13974 These @samp{-m} switches are supported in addition to the above
13975 on x86-64 processors in 64-bit environments.
13976
13977 @table @gcctabopt
13978 @item -m32
13979 @itemx -m64
13980 @itemx -mx32
13981 @opindex m32
13982 @opindex m64
13983 @opindex mx32
13984 Generate code for a 32-bit or 64-bit environment.
13985 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
13986 to 32 bits, and
13987 generates code that runs on any i386 system.
13988
13989 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
13990 types to 64 bits, and generates code for the x86-64 architecture.
13991 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
13992 and @option{-mdynamic-no-pic} options.
13993
13994 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
13995 to 32 bits, and
13996 generates code for the x86-64 architecture.
13997
13998 @item -mno-red-zone
13999 @opindex mno-red-zone
14000 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
14001 by the x86-64 ABI; it is a 128-byte area beyond the location of the
14002 stack pointer that is not modified by signal or interrupt handlers
14003 and therefore can be used for temporary data without adjusting the stack
14004 pointer.  The flag @option{-mno-red-zone} disables this red zone.
14005
14006 @item -mcmodel=small
14007 @opindex mcmodel=small
14008 Generate code for the small code model: the program and its symbols must
14009 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
14010 Programs can be statically or dynamically linked.  This is the default
14011 code model.
14012
14013 @item -mcmodel=kernel
14014 @opindex mcmodel=kernel
14015 Generate code for the kernel code model.  The kernel runs in the
14016 negative 2 GB of the address space.
14017 This model has to be used for Linux kernel code.
14018
14019 @item -mcmodel=medium
14020 @opindex mcmodel=medium
14021 Generate code for the medium model: the program is linked in the lower 2
14022 GB of the address space.  Small symbols are also placed there.  Symbols
14023 with sizes larger than @option{-mlarge-data-threshold} are put into
14024 large data or BSS sections and can be located above 2GB.  Programs can
14025 be statically or dynamically linked.
14026
14027 @item -mcmodel=large
14028 @opindex mcmodel=large
14029 Generate code for the large model.  This model makes no assumptions
14030 about addresses and sizes of sections.
14031
14032 @item -maddress-mode=long
14033 @opindex maddress-mode=long
14034 Generate code for long address mode.  This is only supported for 64-bit
14035 and x32 environments.  It is the default address mode for 64-bit
14036 environments.
14037
14038 @item -maddress-mode=short
14039 @opindex maddress-mode=short
14040 Generate code for short address mode.  This is only supported for 32-bit
14041 and x32 environments.  It is the default address mode for 32-bit and
14042 x32 environments.
14043 @end table
14044
14045 @node i386 and x86-64 Windows Options
14046 @subsection i386 and x86-64 Windows Options
14047 @cindex i386 and x86-64 Windows Options
14048
14049 These additional options are available for Microsoft Windows targets:
14050
14051 @table @gcctabopt
14052 @item -mconsole
14053 @opindex mconsole
14054 This option
14055 specifies that a console application is to be generated, by
14056 instructing the linker to set the PE header subsystem type
14057 required for console applications.
14058 This option is available for Cygwin and MinGW targets and is
14059 enabled by default on those targets.
14060
14061 @item -mdll
14062 @opindex mdll
14063 This option is available for Cygwin and MinGW targets.  It
14064 specifies that a DLL---a dynamic link library---is to be
14065 generated, enabling the selection of the required runtime
14066 startup object and entry point.
14067
14068 @item -mnop-fun-dllimport
14069 @opindex mnop-fun-dllimport
14070 This option is available for Cygwin and MinGW targets.  It
14071 specifies that the @code{dllimport} attribute should be ignored.
14072
14073 @item -mthread
14074 @opindex mthread
14075 This option is available for MinGW targets. It specifies
14076 that MinGW-specific thread support is to be used.
14077
14078 @item -municode
14079 @opindex municode
14080 This option is available for MinGW-w64 targets.  It causes
14081 the @code{UNICODE} preprocessor macro to be predefined, and
14082 chooses Unicode-capable runtime startup code.
14083
14084 @item -mwin32
14085 @opindex mwin32
14086 This option is available for Cygwin and MinGW targets.  It
14087 specifies that the typical Microsoft Windows predefined macros are to
14088 be set in the pre-processor, but does not influence the choice
14089 of runtime library/startup code.
14090
14091 @item -mwindows
14092 @opindex mwindows
14093 This option is available for Cygwin and MinGW targets.  It
14094 specifies that a GUI application is to be generated by
14095 instructing the linker to set the PE header subsystem type
14096 appropriately.
14097
14098 @item -fno-set-stack-executable
14099 @opindex fno-set-stack-executable
14100 This option is available for MinGW targets. It specifies that
14101 the executable flag for the stack used by nested functions isn't
14102 set. This is necessary for binaries running in kernel mode of
14103 Microsoft Windows, as there the User32 API, which is used to set executable
14104 privileges, isn't available.
14105
14106 @item -fwritable-relocated-rdata
14107 @opindex fno-writable-relocated-rdata
14108 This option is available for MinGW and Cygwin targets.  It specifies
14109 that relocated-data in read-only section is put into .data
14110 section.  This is a necessary for older runtimes not supporting
14111 modification of .rdata sections for pseudo-relocation.
14112
14113 @item -mpe-aligned-commons
14114 @opindex mpe-aligned-commons
14115 This option is available for Cygwin and MinGW targets.  It
14116 specifies that the GNU extension to the PE file format that
14117 permits the correct alignment of COMMON variables should be
14118 used when generating code.  It is enabled by default if
14119 GCC detects that the target assembler found during configuration
14120 supports the feature.
14121 @end table
14122
14123 See also under @ref{i386 and x86-64 Options} for standard options.
14124
14125 @node IA-64 Options
14126 @subsection IA-64 Options
14127 @cindex IA-64 Options
14128
14129 These are the @samp{-m} options defined for the Intel IA-64 architecture.
14130
14131 @table @gcctabopt
14132 @item -mbig-endian
14133 @opindex mbig-endian
14134 Generate code for a big-endian target.  This is the default for HP-UX@.
14135
14136 @item -mlittle-endian
14137 @opindex mlittle-endian
14138 Generate code for a little-endian target.  This is the default for AIX5
14139 and GNU/Linux.
14140
14141 @item -mgnu-as
14142 @itemx -mno-gnu-as
14143 @opindex mgnu-as
14144 @opindex mno-gnu-as
14145 Generate (or don't) code for the GNU assembler.  This is the default.
14146 @c Also, this is the default if the configure option @option{--with-gnu-as}
14147 @c is used.
14148
14149 @item -mgnu-ld
14150 @itemx -mno-gnu-ld
14151 @opindex mgnu-ld
14152 @opindex mno-gnu-ld
14153 Generate (or don't) code for the GNU linker.  This is the default.
14154 @c Also, this is the default if the configure option @option{--with-gnu-ld}
14155 @c is used.
14156
14157 @item -mno-pic
14158 @opindex mno-pic
14159 Generate code that does not use a global pointer register.  The result
14160 is not position independent code, and violates the IA-64 ABI@.
14161
14162 @item -mvolatile-asm-stop
14163 @itemx -mno-volatile-asm-stop
14164 @opindex mvolatile-asm-stop
14165 @opindex mno-volatile-asm-stop
14166 Generate (or don't) a stop bit immediately before and after volatile asm
14167 statements.
14168
14169 @item -mregister-names
14170 @itemx -mno-register-names
14171 @opindex mregister-names
14172 @opindex mno-register-names
14173 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
14174 the stacked registers.  This may make assembler output more readable.
14175
14176 @item -mno-sdata
14177 @itemx -msdata
14178 @opindex mno-sdata
14179 @opindex msdata
14180 Disable (or enable) optimizations that use the small data section.  This may
14181 be useful for working around optimizer bugs.
14182
14183 @item -mconstant-gp
14184 @opindex mconstant-gp
14185 Generate code that uses a single constant global pointer value.  This is
14186 useful when compiling kernel code.
14187
14188 @item -mauto-pic
14189 @opindex mauto-pic
14190 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
14191 This is useful when compiling firmware code.
14192
14193 @item -minline-float-divide-min-latency
14194 @opindex minline-float-divide-min-latency
14195 Generate code for inline divides of floating-point values
14196 using the minimum latency algorithm.
14197
14198 @item -minline-float-divide-max-throughput
14199 @opindex minline-float-divide-max-throughput
14200 Generate code for inline divides of floating-point values
14201 using the maximum throughput algorithm.
14202
14203 @item -mno-inline-float-divide
14204 @opindex mno-inline-float-divide
14205 Do not generate inline code for divides of floating-point values.
14206
14207 @item -minline-int-divide-min-latency
14208 @opindex minline-int-divide-min-latency
14209 Generate code for inline divides of integer values
14210 using the minimum latency algorithm.
14211
14212 @item -minline-int-divide-max-throughput
14213 @opindex minline-int-divide-max-throughput
14214 Generate code for inline divides of integer values
14215 using the maximum throughput algorithm.
14216
14217 @item -mno-inline-int-divide
14218 @opindex mno-inline-int-divide
14219 Do not generate inline code for divides of integer values.
14220
14221 @item -minline-sqrt-min-latency
14222 @opindex minline-sqrt-min-latency
14223 Generate code for inline square roots
14224 using the minimum latency algorithm.
14225
14226 @item -minline-sqrt-max-throughput
14227 @opindex minline-sqrt-max-throughput
14228 Generate code for inline square roots
14229 using the maximum throughput algorithm.
14230
14231 @item -mno-inline-sqrt
14232 @opindex mno-inline-sqrt
14233 Do not generate inline code for @code{sqrt}.
14234
14235 @item -mfused-madd
14236 @itemx -mno-fused-madd
14237 @opindex mfused-madd
14238 @opindex mno-fused-madd
14239 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
14240 instructions.  The default is to use these instructions.
14241
14242 @item -mno-dwarf2-asm
14243 @itemx -mdwarf2-asm
14244 @opindex mno-dwarf2-asm
14245 @opindex mdwarf2-asm
14246 Don't (or do) generate assembler code for the DWARF 2 line number debugging
14247 info.  This may be useful when not using the GNU assembler.
14248
14249 @item -mearly-stop-bits
14250 @itemx -mno-early-stop-bits
14251 @opindex mearly-stop-bits
14252 @opindex mno-early-stop-bits
14253 Allow stop bits to be placed earlier than immediately preceding the
14254 instruction that triggered the stop bit.  This can improve instruction
14255 scheduling, but does not always do so.
14256
14257 @item -mfixed-range=@var{register-range}
14258 @opindex mfixed-range
14259 Generate code treating the given register range as fixed registers.
14260 A fixed register is one that the register allocator cannot use.  This is
14261 useful when compiling kernel code.  A register range is specified as
14262 two registers separated by a dash.  Multiple register ranges can be
14263 specified separated by a comma.
14264
14265 @item -mtls-size=@var{tls-size}
14266 @opindex mtls-size
14267 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
14268 64.
14269
14270 @item -mtune=@var{cpu-type}
14271 @opindex mtune
14272 Tune the instruction scheduling for a particular CPU, Valid values are
14273 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
14274 and @samp{mckinley}.
14275
14276 @item -milp32
14277 @itemx -mlp64
14278 @opindex milp32
14279 @opindex mlp64
14280 Generate code for a 32-bit or 64-bit environment.
14281 The 32-bit environment sets int, long and pointer to 32 bits.
14282 The 64-bit environment sets int to 32 bits and long and pointer
14283 to 64 bits.  These are HP-UX specific flags.
14284
14285 @item -mno-sched-br-data-spec
14286 @itemx -msched-br-data-spec
14287 @opindex mno-sched-br-data-spec
14288 @opindex msched-br-data-spec
14289 (Dis/En)able data speculative scheduling before reload.
14290 This results in generation of @code{ld.a} instructions and
14291 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14292 The default is 'disable'.
14293
14294 @item -msched-ar-data-spec
14295 @itemx -mno-sched-ar-data-spec
14296 @opindex msched-ar-data-spec
14297 @opindex mno-sched-ar-data-spec
14298 (En/Dis)able data speculative scheduling after reload.
14299 This results in generation of @code{ld.a} instructions and
14300 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
14301 The default is 'enable'.
14302
14303 @item -mno-sched-control-spec
14304 @itemx -msched-control-spec
14305 @opindex mno-sched-control-spec
14306 @opindex msched-control-spec
14307 (Dis/En)able control speculative scheduling.  This feature is
14308 available only during region scheduling (i.e.@: before reload).
14309 This results in generation of the @code{ld.s} instructions and
14310 the corresponding check instructions @code{chk.s}.
14311 The default is 'disable'.
14312
14313 @item -msched-br-in-data-spec
14314 @itemx -mno-sched-br-in-data-spec
14315 @opindex msched-br-in-data-spec
14316 @opindex mno-sched-br-in-data-spec
14317 (En/Dis)able speculative scheduling of the instructions that
14318 are dependent on the data speculative loads before reload.
14319 This is effective only with @option{-msched-br-data-spec} enabled.
14320 The default is 'enable'.
14321
14322 @item -msched-ar-in-data-spec
14323 @itemx -mno-sched-ar-in-data-spec
14324 @opindex msched-ar-in-data-spec
14325 @opindex mno-sched-ar-in-data-spec
14326 (En/Dis)able speculative scheduling of the instructions that
14327 are dependent on the data speculative loads after reload.
14328 This is effective only with @option{-msched-ar-data-spec} enabled.
14329 The default is 'enable'.
14330
14331 @item -msched-in-control-spec
14332 @itemx -mno-sched-in-control-spec
14333 @opindex msched-in-control-spec
14334 @opindex mno-sched-in-control-spec
14335 (En/Dis)able speculative scheduling of the instructions that
14336 are dependent on the control speculative loads.
14337 This is effective only with @option{-msched-control-spec} enabled.
14338 The default is 'enable'.
14339
14340 @item -mno-sched-prefer-non-data-spec-insns
14341 @itemx -msched-prefer-non-data-spec-insns
14342 @opindex mno-sched-prefer-non-data-spec-insns
14343 @opindex msched-prefer-non-data-spec-insns
14344 If enabled, data-speculative instructions are chosen for schedule
14345 only if there are no other choices at the moment.  This makes
14346 the use of the data speculation much more conservative.
14347 The default is 'disable'.
14348
14349 @item -mno-sched-prefer-non-control-spec-insns
14350 @itemx -msched-prefer-non-control-spec-insns
14351 @opindex mno-sched-prefer-non-control-spec-insns
14352 @opindex msched-prefer-non-control-spec-insns
14353 If enabled, control-speculative instructions are chosen for schedule
14354 only if there are no other choices at the moment.  This makes
14355 the use of the control speculation much more conservative.
14356 The default is 'disable'.
14357
14358 @item -mno-sched-count-spec-in-critical-path
14359 @itemx -msched-count-spec-in-critical-path
14360 @opindex mno-sched-count-spec-in-critical-path
14361 @opindex msched-count-spec-in-critical-path
14362 If enabled, speculative dependencies are considered during
14363 computation of the instructions priorities.  This makes the use of the
14364 speculation a bit more conservative.
14365 The default is 'disable'.
14366
14367 @item -msched-spec-ldc
14368 @opindex msched-spec-ldc
14369 Use a simple data speculation check.  This option is on by default.
14370
14371 @item -msched-control-spec-ldc
14372 @opindex msched-spec-ldc
14373 Use a simple check for control speculation.  This option is on by default.
14374
14375 @item -msched-stop-bits-after-every-cycle
14376 @opindex msched-stop-bits-after-every-cycle
14377 Place a stop bit after every cycle when scheduling.  This option is on
14378 by default.
14379
14380 @item -msched-fp-mem-deps-zero-cost
14381 @opindex msched-fp-mem-deps-zero-cost
14382 Assume that floating-point stores and loads are not likely to cause a conflict
14383 when placed into the same instruction group.  This option is disabled by
14384 default.
14385
14386 @item -msel-sched-dont-check-control-spec
14387 @opindex msel-sched-dont-check-control-spec
14388 Generate checks for control speculation in selective scheduling.
14389 This flag is disabled by default.
14390
14391 @item -msched-max-memory-insns=@var{max-insns}
14392 @opindex msched-max-memory-insns
14393 Limit on the number of memory insns per instruction group, giving lower
14394 priority to subsequent memory insns attempting to schedule in the same
14395 instruction group. Frequently useful to prevent cache bank conflicts.
14396 The default value is 1.
14397
14398 @item -msched-max-memory-insns-hard-limit
14399 @opindex msched-max-memory-insns-hard-limit
14400 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
14401 disallowing more than that number in an instruction group.
14402 Otherwise, the limit is ``soft'', meaning that non-memory operations
14403 are preferred when the limit is reached, but memory operations may still
14404 be scheduled.
14405
14406 @end table
14407
14408 @node LM32 Options
14409 @subsection LM32 Options
14410 @cindex LM32 options
14411
14412 These @option{-m} options are defined for the Lattice Mico32 architecture:
14413
14414 @table @gcctabopt
14415 @item -mbarrel-shift-enabled
14416 @opindex mbarrel-shift-enabled
14417 Enable barrel-shift instructions.
14418
14419 @item -mdivide-enabled
14420 @opindex mdivide-enabled
14421 Enable divide and modulus instructions.
14422
14423 @item -mmultiply-enabled
14424 @opindex multiply-enabled
14425 Enable multiply instructions.
14426
14427 @item -msign-extend-enabled
14428 @opindex msign-extend-enabled
14429 Enable sign extend instructions.
14430
14431 @item -muser-enabled
14432 @opindex muser-enabled
14433 Enable user-defined instructions.
14434
14435 @end table
14436
14437 @node M32C Options
14438 @subsection M32C Options
14439 @cindex M32C options
14440
14441 @table @gcctabopt
14442 @item -mcpu=@var{name}
14443 @opindex mcpu=
14444 Select the CPU for which code is generated.  @var{name} may be one of
14445 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
14446 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
14447 the M32C/80 series.
14448
14449 @item -msim
14450 @opindex msim
14451 Specifies that the program will be run on the simulator.  This causes
14452 an alternate runtime library to be linked in which supports, for
14453 example, file I/O@.  You must not use this option when generating
14454 programs that will run on real hardware; you must provide your own
14455 runtime library for whatever I/O functions are needed.
14456
14457 @item -memregs=@var{number}
14458 @opindex memregs=
14459 Specifies the number of memory-based pseudo-registers GCC uses
14460 during code generation.  These pseudo-registers are used like real
14461 registers, so there is a tradeoff between GCC's ability to fit the
14462 code into available registers, and the performance penalty of using
14463 memory instead of registers.  Note that all modules in a program must
14464 be compiled with the same value for this option.  Because of that, you
14465 must not use this option with the default runtime libraries gcc
14466 builds.
14467
14468 @end table
14469
14470 @node M32R/D Options
14471 @subsection M32R/D Options
14472 @cindex M32R/D options
14473
14474 These @option{-m} options are defined for Renesas M32R/D architectures:
14475
14476 @table @gcctabopt
14477 @item -m32r2
14478 @opindex m32r2
14479 Generate code for the M32R/2@.
14480
14481 @item -m32rx
14482 @opindex m32rx
14483 Generate code for the M32R/X@.
14484
14485 @item -m32r
14486 @opindex m32r
14487 Generate code for the M32R@.  This is the default.
14488
14489 @item -mmodel=small
14490 @opindex mmodel=small
14491 Assume all objects live in the lower 16MB of memory (so that their addresses
14492 can be loaded with the @code{ld24} instruction), and assume all subroutines
14493 are reachable with the @code{bl} instruction.
14494 This is the default.
14495
14496 The addressability of a particular object can be set with the
14497 @code{model} attribute.
14498
14499 @item -mmodel=medium
14500 @opindex mmodel=medium
14501 Assume objects may be anywhere in the 32-bit address space (the compiler
14502 generates @code{seth/add3} instructions to load their addresses), and
14503 assume all subroutines are reachable with the @code{bl} instruction.
14504
14505 @item -mmodel=large
14506 @opindex mmodel=large
14507 Assume objects may be anywhere in the 32-bit address space (the compiler
14508 generates @code{seth/add3} instructions to load their addresses), and
14509 assume subroutines may not be reachable with the @code{bl} instruction
14510 (the compiler generates the much slower @code{seth/add3/jl}
14511 instruction sequence).
14512
14513 @item -msdata=none
14514 @opindex msdata=none
14515 Disable use of the small data area.  Variables are put into
14516 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
14517 @code{section} attribute has been specified).
14518 This is the default.
14519
14520 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
14521 Objects may be explicitly put in the small data area with the
14522 @code{section} attribute using one of these sections.
14523
14524 @item -msdata=sdata
14525 @opindex msdata=sdata
14526 Put small global and static data in the small data area, but do not
14527 generate special code to reference them.
14528
14529 @item -msdata=use
14530 @opindex msdata=use
14531 Put small global and static data in the small data area, and generate
14532 special instructions to reference them.
14533
14534 @item -G @var{num}
14535 @opindex G
14536 @cindex smaller data references
14537 Put global and static objects less than or equal to @var{num} bytes
14538 into the small data or bss sections instead of the normal data or bss
14539 sections.  The default value of @var{num} is 8.
14540 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
14541 for this option to have any effect.
14542
14543 All modules should be compiled with the same @option{-G @var{num}} value.
14544 Compiling with different values of @var{num} may or may not work; if it
14545 doesn't the linker gives an error message---incorrect code is not
14546 generated.
14547
14548 @item -mdebug
14549 @opindex mdebug
14550 Makes the M32R specific code in the compiler display some statistics
14551 that might help in debugging programs.
14552
14553 @item -malign-loops
14554 @opindex malign-loops
14555 Align all loops to a 32-byte boundary.
14556
14557 @item -mno-align-loops
14558 @opindex mno-align-loops
14559 Do not enforce a 32-byte alignment for loops.  This is the default.
14560
14561 @item -missue-rate=@var{number}
14562 @opindex missue-rate=@var{number}
14563 Issue @var{number} instructions per cycle.  @var{number} can only be 1
14564 or 2.
14565
14566 @item -mbranch-cost=@var{number}
14567 @opindex mbranch-cost=@var{number}
14568 @var{number} can only be 1 or 2.  If it is 1 then branches are
14569 preferred over conditional code, if it is 2, then the opposite applies.
14570
14571 @item -mflush-trap=@var{number}
14572 @opindex mflush-trap=@var{number}
14573 Specifies the trap number to use to flush the cache.  The default is
14574 12.  Valid numbers are between 0 and 15 inclusive.
14575
14576 @item -mno-flush-trap
14577 @opindex mno-flush-trap
14578 Specifies that the cache cannot be flushed by using a trap.
14579
14580 @item -mflush-func=@var{name}
14581 @opindex mflush-func=@var{name}
14582 Specifies the name of the operating system function to call to flush
14583 the cache.  The default is @emph{_flush_cache}, but a function call
14584 is only used if a trap is not available.
14585
14586 @item -mno-flush-func
14587 @opindex mno-flush-func
14588 Indicates that there is no OS function for flushing the cache.
14589
14590 @end table
14591
14592 @node M680x0 Options
14593 @subsection M680x0 Options
14594 @cindex M680x0 options
14595
14596 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
14597 The default settings depend on which architecture was selected when
14598 the compiler was configured; the defaults for the most common choices
14599 are given below.
14600
14601 @table @gcctabopt
14602 @item -march=@var{arch}
14603 @opindex march
14604 Generate code for a specific M680x0 or ColdFire instruction set
14605 architecture.  Permissible values of @var{arch} for M680x0
14606 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
14607 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
14608 architectures are selected according to Freescale's ISA classification
14609 and the permissible values are: @samp{isaa}, @samp{isaaplus},
14610 @samp{isab} and @samp{isac}.
14611
14612 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
14613 code for a ColdFire target.  The @var{arch} in this macro is one of the
14614 @option{-march} arguments given above.
14615
14616 When used together, @option{-march} and @option{-mtune} select code
14617 that runs on a family of similar processors but that is optimized
14618 for a particular microarchitecture.
14619
14620 @item -mcpu=@var{cpu}
14621 @opindex mcpu
14622 Generate code for a specific M680x0 or ColdFire processor.
14623 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
14624 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
14625 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
14626 below, which also classifies the CPUs into families:
14627
14628 @multitable @columnfractions 0.20 0.80
14629 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
14630 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51ag} @samp{51cn} @samp{51em} @samp{51je} @samp{51jf} @samp{51jg} @samp{51jm} @samp{51mm} @samp{51qe} @samp{51qm}
14631 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
14632 @item @samp{5206e} @tab @samp{5206e}
14633 @item @samp{5208} @tab @samp{5207} @samp{5208}
14634 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
14635 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
14636 @item @samp{5216} @tab @samp{5214} @samp{5216}
14637 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
14638 @item @samp{5225} @tab @samp{5224} @samp{5225}
14639 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
14640 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
14641 @item @samp{5249} @tab @samp{5249}
14642 @item @samp{5250} @tab @samp{5250}
14643 @item @samp{5271} @tab @samp{5270} @samp{5271}
14644 @item @samp{5272} @tab @samp{5272}
14645 @item @samp{5275} @tab @samp{5274} @samp{5275}
14646 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
14647 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
14648 @item @samp{5307} @tab @samp{5307}
14649 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
14650 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
14651 @item @samp{5407} @tab @samp{5407}
14652 @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}
14653 @end multitable
14654
14655 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
14656 @var{arch} is compatible with @var{cpu}.  Other combinations of
14657 @option{-mcpu} and @option{-march} are rejected.
14658
14659 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
14660 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
14661 where the value of @var{family} is given by the table above.
14662
14663 @item -mtune=@var{tune}
14664 @opindex mtune
14665 Tune the code for a particular microarchitecture, within the
14666 constraints set by @option{-march} and @option{-mcpu}.
14667 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
14668 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
14669 and @samp{cpu32}.  The ColdFire microarchitectures
14670 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
14671
14672 You can also use @option{-mtune=68020-40} for code that needs
14673 to run relatively well on 68020, 68030 and 68040 targets.
14674 @option{-mtune=68020-60} is similar but includes 68060 targets
14675 as well.  These two options select the same tuning decisions as
14676 @option{-m68020-40} and @option{-m68020-60} respectively.
14677
14678 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
14679 when tuning for 680x0 architecture @var{arch}.  It also defines
14680 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
14681 option is used.  If GCC is tuning for a range of architectures,
14682 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
14683 it defines the macros for every architecture in the range.
14684
14685 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
14686 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
14687 of the arguments given above.
14688
14689 @item -m68000
14690 @itemx -mc68000
14691 @opindex m68000
14692 @opindex mc68000
14693 Generate output for a 68000.  This is the default
14694 when the compiler is configured for 68000-based systems.
14695 It is equivalent to @option{-march=68000}.
14696
14697 Use this option for microcontrollers with a 68000 or EC000 core,
14698 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
14699
14700 @item -m68010
14701 @opindex m68010
14702 Generate output for a 68010.  This is the default
14703 when the compiler is configured for 68010-based systems.
14704 It is equivalent to @option{-march=68010}.
14705
14706 @item -m68020
14707 @itemx -mc68020
14708 @opindex m68020
14709 @opindex mc68020
14710 Generate output for a 68020.  This is the default
14711 when the compiler is configured for 68020-based systems.
14712 It is equivalent to @option{-march=68020}.
14713
14714 @item -m68030
14715 @opindex m68030
14716 Generate output for a 68030.  This is the default when the compiler is
14717 configured for 68030-based systems.  It is equivalent to
14718 @option{-march=68030}.
14719
14720 @item -m68040
14721 @opindex m68040
14722 Generate output for a 68040.  This is the default when the compiler is
14723 configured for 68040-based systems.  It is equivalent to
14724 @option{-march=68040}.
14725
14726 This option inhibits the use of 68881/68882 instructions that have to be
14727 emulated by software on the 68040.  Use this option if your 68040 does not
14728 have code to emulate those instructions.
14729
14730 @item -m68060
14731 @opindex m68060
14732 Generate output for a 68060.  This is the default when the compiler is
14733 configured for 68060-based systems.  It is equivalent to
14734 @option{-march=68060}.
14735
14736 This option inhibits the use of 68020 and 68881/68882 instructions that
14737 have to be emulated by software on the 68060.  Use this option if your 68060
14738 does not have code to emulate those instructions.
14739
14740 @item -mcpu32
14741 @opindex mcpu32
14742 Generate output for a CPU32.  This is the default
14743 when the compiler is configured for CPU32-based systems.
14744 It is equivalent to @option{-march=cpu32}.
14745
14746 Use this option for microcontrollers with a
14747 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
14748 68336, 68340, 68341, 68349 and 68360.
14749
14750 @item -m5200
14751 @opindex m5200
14752 Generate output for a 520X ColdFire CPU@.  This is the default
14753 when the compiler is configured for 520X-based systems.
14754 It is equivalent to @option{-mcpu=5206}, and is now deprecated
14755 in favor of that option.
14756
14757 Use this option for microcontroller with a 5200 core, including
14758 the MCF5202, MCF5203, MCF5204 and MCF5206.
14759
14760 @item -m5206e
14761 @opindex m5206e
14762 Generate output for a 5206e ColdFire CPU@.  The option is now
14763 deprecated in favor of the equivalent @option{-mcpu=5206e}.
14764
14765 @item -m528x
14766 @opindex m528x
14767 Generate output for a member of the ColdFire 528X family.
14768 The option is now deprecated in favor of the equivalent
14769 @option{-mcpu=528x}.
14770
14771 @item -m5307
14772 @opindex m5307
14773 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
14774 in favor of the equivalent @option{-mcpu=5307}.
14775
14776 @item -m5407
14777 @opindex m5407
14778 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
14779 in favor of the equivalent @option{-mcpu=5407}.
14780
14781 @item -mcfv4e
14782 @opindex mcfv4e
14783 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
14784 This includes use of hardware floating-point instructions.
14785 The option is equivalent to @option{-mcpu=547x}, and is now
14786 deprecated in favor of that option.
14787
14788 @item -m68020-40
14789 @opindex m68020-40
14790 Generate output for a 68040, without using any of the new instructions.
14791 This results in code that can run relatively efficiently on either a
14792 68020/68881 or a 68030 or a 68040.  The generated code does use the
14793 68881 instructions that are emulated on the 68040.
14794
14795 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
14796
14797 @item -m68020-60
14798 @opindex m68020-60
14799 Generate output for a 68060, without using any of the new instructions.
14800 This results in code that can run relatively efficiently on either a
14801 68020/68881 or a 68030 or a 68040.  The generated code does use the
14802 68881 instructions that are emulated on the 68060.
14803
14804 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
14805
14806 @item -mhard-float
14807 @itemx -m68881
14808 @opindex mhard-float
14809 @opindex m68881
14810 Generate floating-point instructions.  This is the default for 68020
14811 and above, and for ColdFire devices that have an FPU@.  It defines the
14812 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
14813 on ColdFire targets.
14814
14815 @item -msoft-float
14816 @opindex msoft-float
14817 Do not generate floating-point instructions; use library calls instead.
14818 This is the default for 68000, 68010, and 68832 targets.  It is also
14819 the default for ColdFire devices that have no FPU.
14820
14821 @item -mdiv
14822 @itemx -mno-div
14823 @opindex mdiv
14824 @opindex mno-div
14825 Generate (do not generate) ColdFire hardware divide and remainder
14826 instructions.  If @option{-march} is used without @option{-mcpu},
14827 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
14828 architectures.  Otherwise, the default is taken from the target CPU
14829 (either the default CPU, or the one specified by @option{-mcpu}).  For
14830 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
14831 @option{-mcpu=5206e}.
14832
14833 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
14834
14835 @item -mshort
14836 @opindex mshort
14837 Consider type @code{int} to be 16 bits wide, like @code{short int}.
14838 Additionally, parameters passed on the stack are also aligned to a
14839 16-bit boundary even on targets whose API mandates promotion to 32-bit.
14840
14841 @item -mno-short
14842 @opindex mno-short
14843 Do not consider type @code{int} to be 16 bits wide.  This is the default.
14844
14845 @item -mnobitfield
14846 @itemx -mno-bitfield
14847 @opindex mnobitfield
14848 @opindex mno-bitfield
14849 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
14850 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
14851
14852 @item -mbitfield
14853 @opindex mbitfield
14854 Do use the bit-field instructions.  The @option{-m68020} option implies
14855 @option{-mbitfield}.  This is the default if you use a configuration
14856 designed for a 68020.
14857
14858 @item -mrtd
14859 @opindex mrtd
14860 Use a different function-calling convention, in which functions
14861 that take a fixed number of arguments return with the @code{rtd}
14862 instruction, which pops their arguments while returning.  This
14863 saves one instruction in the caller since there is no need to pop
14864 the arguments there.
14865
14866 This calling convention is incompatible with the one normally
14867 used on Unix, so you cannot use it if you need to call libraries
14868 compiled with the Unix compiler.
14869
14870 Also, you must provide function prototypes for all functions that
14871 take variable numbers of arguments (including @code{printf});
14872 otherwise incorrect code is generated for calls to those
14873 functions.
14874
14875 In addition, seriously incorrect code results if you call a
14876 function with too many arguments.  (Normally, extra arguments are
14877 harmlessly ignored.)
14878
14879 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
14880 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
14881
14882 @item -mno-rtd
14883 @opindex mno-rtd
14884 Do not use the calling conventions selected by @option{-mrtd}.
14885 This is the default.
14886
14887 @item -malign-int
14888 @itemx -mno-align-int
14889 @opindex malign-int
14890 @opindex mno-align-int
14891 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
14892 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
14893 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
14894 Aligning variables on 32-bit boundaries produces code that runs somewhat
14895 faster on processors with 32-bit busses at the expense of more memory.
14896
14897 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
14898 aligns structures containing the above types differently than
14899 most published application binary interface specifications for the m68k.
14900
14901 @item -mpcrel
14902 @opindex mpcrel
14903 Use the pc-relative addressing mode of the 68000 directly, instead of
14904 using a global offset table.  At present, this option implies @option{-fpic},
14905 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
14906 not presently supported with @option{-mpcrel}, though this could be supported for
14907 68020 and higher processors.
14908
14909 @item -mno-strict-align
14910 @itemx -mstrict-align
14911 @opindex mno-strict-align
14912 @opindex mstrict-align
14913 Do not (do) assume that unaligned memory references are handled by
14914 the system.
14915
14916 @item -msep-data
14917 Generate code that allows the data segment to be located in a different
14918 area of memory from the text segment.  This allows for execute in place in
14919 an environment without virtual memory management.  This option implies
14920 @option{-fPIC}.
14921
14922 @item -mno-sep-data
14923 Generate code that assumes that the data segment follows the text segment.
14924 This is the default.
14925
14926 @item -mid-shared-library
14927 Generate code that supports shared libraries via the library ID method.
14928 This allows for execute in place and shared libraries in an environment
14929 without virtual memory management.  This option implies @option{-fPIC}.
14930
14931 @item -mno-id-shared-library
14932 Generate code that doesn't assume ID based shared libraries are being used.
14933 This is the default.
14934
14935 @item -mshared-library-id=n
14936 Specifies the identification number of the ID-based shared library being
14937 compiled.  Specifying a value of 0 generates more compact code; specifying
14938 other values forces the allocation of that number to the current
14939 library, but is no more space- or time-efficient than omitting this option.
14940
14941 @item -mxgot
14942 @itemx -mno-xgot
14943 @opindex mxgot
14944 @opindex mno-xgot
14945 When generating position-independent code for ColdFire, generate code
14946 that works if the GOT has more than 8192 entries.  This code is
14947 larger and slower than code generated without this option.  On M680x0
14948 processors, this option is not needed; @option{-fPIC} suffices.
14949
14950 GCC normally uses a single instruction to load values from the GOT@.
14951 While this is relatively efficient, it only works if the GOT
14952 is smaller than about 64k.  Anything larger causes the linker
14953 to report an error such as:
14954
14955 @cindex relocation truncated to fit (ColdFire)
14956 @smallexample
14957 relocation truncated to fit: R_68K_GOT16O foobar
14958 @end smallexample
14959
14960 If this happens, you should recompile your code with @option{-mxgot}.
14961 It should then work with very large GOTs.  However, code generated with
14962 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
14963 the value of a global symbol.
14964
14965 Note that some linkers, including newer versions of the GNU linker,
14966 can create multiple GOTs and sort GOT entries.  If you have such a linker,
14967 you should only need to use @option{-mxgot} when compiling a single
14968 object file that accesses more than 8192 GOT entries.  Very few do.
14969
14970 These options have no effect unless GCC is generating
14971 position-independent code.
14972
14973 @end table
14974
14975 @node MCore Options
14976 @subsection MCore Options
14977 @cindex MCore options
14978
14979 These are the @samp{-m} options defined for the Motorola M*Core
14980 processors.
14981
14982 @table @gcctabopt
14983
14984 @item -mhardlit
14985 @itemx -mno-hardlit
14986 @opindex mhardlit
14987 @opindex mno-hardlit
14988 Inline constants into the code stream if it can be done in two
14989 instructions or less.
14990
14991 @item -mdiv
14992 @itemx -mno-div
14993 @opindex mdiv
14994 @opindex mno-div
14995 Use the divide instruction.  (Enabled by default).
14996
14997 @item -mrelax-immediate
14998 @itemx -mno-relax-immediate
14999 @opindex mrelax-immediate
15000 @opindex mno-relax-immediate
15001 Allow arbitrary sized immediates in bit operations.
15002
15003 @item -mwide-bitfields
15004 @itemx -mno-wide-bitfields
15005 @opindex mwide-bitfields
15006 @opindex mno-wide-bitfields
15007 Always treat bit-fields as int-sized.
15008
15009 @item -m4byte-functions
15010 @itemx -mno-4byte-functions
15011 @opindex m4byte-functions
15012 @opindex mno-4byte-functions
15013 Force all functions to be aligned to a 4-byte boundary.
15014
15015 @item -mcallgraph-data
15016 @itemx -mno-callgraph-data
15017 @opindex mcallgraph-data
15018 @opindex mno-callgraph-data
15019 Emit callgraph information.
15020
15021 @item -mslow-bytes
15022 @itemx -mno-slow-bytes
15023 @opindex mslow-bytes
15024 @opindex mno-slow-bytes
15025 Prefer word access when reading byte quantities.
15026
15027 @item -mlittle-endian
15028 @itemx -mbig-endian
15029 @opindex mlittle-endian
15030 @opindex mbig-endian
15031 Generate code for a little-endian target.
15032
15033 @item -m210
15034 @itemx -m340
15035 @opindex m210
15036 @opindex m340
15037 Generate code for the 210 processor.
15038
15039 @item -mno-lsim
15040 @opindex mno-lsim
15041 Assume that runtime support has been provided and so omit the
15042 simulator library (@file{libsim.a)} from the linker command line.
15043
15044 @item -mstack-increment=@var{size}
15045 @opindex mstack-increment
15046 Set the maximum amount for a single stack increment operation.  Large
15047 values can increase the speed of programs that contain functions
15048 that need a large amount of stack space, but they can also trigger a
15049 segmentation fault if the stack is extended too much.  The default
15050 value is 0x1000.
15051
15052 @end table
15053
15054 @node MeP Options
15055 @subsection MeP Options
15056 @cindex MeP options
15057
15058 @table @gcctabopt
15059
15060 @item -mabsdiff
15061 @opindex mabsdiff
15062 Enables the @code{abs} instruction, which is the absolute difference
15063 between two registers.
15064
15065 @item -mall-opts
15066 @opindex mall-opts
15067 Enables all the optional instructions---average, multiply, divide, bit
15068 operations, leading zero, absolute difference, min/max, clip, and
15069 saturation.
15070
15071
15072 @item -maverage
15073 @opindex maverage
15074 Enables the @code{ave} instruction, which computes the average of two
15075 registers.
15076
15077 @item -mbased=@var{n}
15078 @opindex mbased=
15079 Variables of size @var{n} bytes or smaller are placed in the
15080 @code{.based} section by default.  Based variables use the @code{$tp}
15081 register as a base register, and there is a 128-byte limit to the
15082 @code{.based} section.
15083
15084 @item -mbitops
15085 @opindex mbitops
15086 Enables the bit operation instructions---bit test (@code{btstm}), set
15087 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
15088 test-and-set (@code{tas}).
15089
15090 @item -mc=@var{name}
15091 @opindex mc=
15092 Selects which section constant data is placed in.  @var{name} may
15093 be @code{tiny}, @code{near}, or @code{far}.
15094
15095 @item -mclip
15096 @opindex mclip
15097 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
15098 useful unless you also provide @code{-mminmax}.
15099
15100 @item -mconfig=@var{name}
15101 @opindex mconfig=
15102 Selects one of the build-in core configurations.  Each MeP chip has
15103 one or more modules in it; each module has a core CPU and a variety of
15104 coprocessors, optional instructions, and peripherals.  The
15105 @code{MeP-Integrator} tool, not part of GCC, provides these
15106 configurations through this option; using this option is the same as
15107 using all the corresponding command-line options.  The default
15108 configuration is @code{default}.
15109
15110 @item -mcop
15111 @opindex mcop
15112 Enables the coprocessor instructions.  By default, this is a 32-bit
15113 coprocessor.  Note that the coprocessor is normally enabled via the
15114 @code{-mconfig=} option.
15115
15116 @item -mcop32
15117 @opindex mcop32
15118 Enables the 32-bit coprocessor's instructions.
15119
15120 @item -mcop64
15121 @opindex mcop64
15122 Enables the 64-bit coprocessor's instructions.
15123
15124 @item -mivc2
15125 @opindex mivc2
15126 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
15127
15128 @item -mdc
15129 @opindex mdc
15130 Causes constant variables to be placed in the @code{.near} section.
15131
15132 @item -mdiv
15133 @opindex mdiv
15134 Enables the @code{div} and @code{divu} instructions.
15135
15136 @item -meb
15137 @opindex meb
15138 Generate big-endian code.
15139
15140 @item -mel
15141 @opindex mel
15142 Generate little-endian code.
15143
15144 @item -mio-volatile
15145 @opindex mio-volatile
15146 Tells the compiler that any variable marked with the @code{io}
15147 attribute is to be considered volatile.
15148
15149 @item -ml
15150 @opindex ml
15151 Causes variables to be assigned to the @code{.far} section by default.
15152
15153 @item -mleadz
15154 @opindex mleadz
15155 Enables the @code{leadz} (leading zero) instruction.
15156
15157 @item -mm
15158 @opindex mm
15159 Causes variables to be assigned to the @code{.near} section by default.
15160
15161 @item -mminmax
15162 @opindex mminmax
15163 Enables the @code{min} and @code{max} instructions.
15164
15165 @item -mmult
15166 @opindex mmult
15167 Enables the multiplication and multiply-accumulate instructions.
15168
15169 @item -mno-opts
15170 @opindex mno-opts
15171 Disables all the optional instructions enabled by @code{-mall-opts}.
15172
15173 @item -mrepeat
15174 @opindex mrepeat
15175 Enables the @code{repeat} and @code{erepeat} instructions, used for
15176 low-overhead looping.
15177
15178 @item -ms
15179 @opindex ms
15180 Causes all variables to default to the @code{.tiny} section.  Note
15181 that there is a 65536-byte limit to this section.  Accesses to these
15182 variables use the @code{%gp} base register.
15183
15184 @item -msatur
15185 @opindex msatur
15186 Enables the saturation instructions.  Note that the compiler does not
15187 currently generate these itself, but this option is included for
15188 compatibility with other tools, like @code{as}.
15189
15190 @item -msdram
15191 @opindex msdram
15192 Link the SDRAM-based runtime instead of the default ROM-based runtime.
15193
15194 @item -msim
15195 @opindex msim
15196 Link the simulator runtime libraries.
15197
15198 @item -msimnovec
15199 @opindex msimnovec
15200 Link the simulator runtime libraries, excluding built-in support
15201 for reset and exception vectors and tables.
15202
15203 @item -mtf
15204 @opindex mtf
15205 Causes all functions to default to the @code{.far} section.  Without
15206 this option, functions default to the @code{.near} section.
15207
15208 @item -mtiny=@var{n}
15209 @opindex mtiny=
15210 Variables that are @var{n} bytes or smaller are allocated to the
15211 @code{.tiny} section.  These variables use the @code{$gp} base
15212 register.  The default for this option is 4, but note that there's a
15213 65536-byte limit to the @code{.tiny} section.
15214
15215 @end table
15216
15217 @node MicroBlaze Options
15218 @subsection MicroBlaze Options
15219 @cindex MicroBlaze Options
15220
15221 @table @gcctabopt
15222
15223 @item -msoft-float
15224 @opindex msoft-float
15225 Use software emulation for floating point (default).
15226
15227 @item -mhard-float
15228 @opindex mhard-float
15229 Use hardware floating-point instructions.
15230
15231 @item -mmemcpy
15232 @opindex mmemcpy
15233 Do not optimize block moves, use @code{memcpy}.
15234
15235 @item -mno-clearbss
15236 @opindex mno-clearbss
15237 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
15238
15239 @item -mcpu=@var{cpu-type}
15240 @opindex mcpu=
15241 Use features of and schedule code for given CPU.
15242 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
15243 where @var{X} is a major version, @var{YY} is the minor version, and
15244 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
15245 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
15246
15247 @item -mxl-soft-mul
15248 @opindex mxl-soft-mul
15249 Use software multiply emulation (default).
15250
15251 @item -mxl-soft-div
15252 @opindex mxl-soft-div
15253 Use software emulation for divides (default).
15254
15255 @item -mxl-barrel-shift
15256 @opindex mxl-barrel-shift
15257 Use the hardware barrel shifter.
15258
15259 @item -mxl-pattern-compare
15260 @opindex mxl-pattern-compare
15261 Use pattern compare instructions.
15262
15263 @item -msmall-divides
15264 @opindex msmall-divides
15265 Use table lookup optimization for small signed integer divisions.
15266
15267 @item -mxl-stack-check
15268 @opindex mxl-stack-check
15269 This option is deprecated.  Use @option{-fstack-check} instead.
15270
15271 @item -mxl-gp-opt
15272 @opindex mxl-gp-opt
15273 Use GP-relative @code{.sdata}/@code{.sbss} sections.
15274
15275 @item -mxl-multiply-high
15276 @opindex mxl-multiply-high
15277 Use multiply high instructions for high part of 32x32 multiply.
15278
15279 @item -mxl-float-convert
15280 @opindex mxl-float-convert
15281 Use hardware floating-point conversion instructions.
15282
15283 @item -mxl-float-sqrt
15284 @opindex mxl-float-sqrt
15285 Use hardware floating-point square root instruction.
15286
15287 @item -mxl-mode-@var{app-model}
15288 Select application model @var{app-model}.  Valid models are
15289 @table @samp
15290 @item executable
15291 normal executable (default), uses startup code @file{crt0.o}.
15292
15293 @item xmdstub
15294 for use with Xilinx Microprocessor Debugger (XMD) based
15295 software intrusive debug agent called xmdstub. This uses startup file
15296 @file{crt1.o} and sets the start address of the program to be 0x800.
15297
15298 @item bootstrap
15299 for applications that are loaded using a bootloader.
15300 This model uses startup file @file{crt2.o} which does not contain a processor
15301 reset vector handler. This is suitable for transferring control on a
15302 processor reset to the bootloader rather than the application.
15303
15304 @item novectors
15305 for applications that do not require any of the
15306 MicroBlaze vectors. This option may be useful for applications running
15307 within a monitoring application. This model uses @file{crt3.o} as a startup file.
15308 @end table
15309
15310 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
15311 @option{-mxl-mode-@var{app-model}}.
15312
15313 @end table
15314
15315 @node MIPS Options
15316 @subsection MIPS Options
15317 @cindex MIPS options
15318
15319 @table @gcctabopt
15320
15321 @item -EB
15322 @opindex EB
15323 Generate big-endian code.
15324
15325 @item -EL
15326 @opindex EL
15327 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
15328 configurations.
15329
15330 @item -march=@var{arch}
15331 @opindex march
15332 Generate code that runs on @var{arch}, which can be the name of a
15333 generic MIPS ISA, or the name of a particular processor.
15334 The ISA names are:
15335 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
15336 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
15337 The processor names are:
15338 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
15339 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
15340 @samp{5kc}, @samp{5kf},
15341 @samp{20kc},
15342 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
15343 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
15344 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
15345 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
15346 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
15347 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
15348 @samp{m4k},
15349 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
15350 @samp{orion},
15351 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
15352 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
15353 @samp{rm7000}, @samp{rm9000},
15354 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
15355 @samp{sb1},
15356 @samp{sr71000},
15357 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
15358 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
15359 @samp{xlr} and @samp{xlp}.
15360 The special value @samp{from-abi} selects the
15361 most compatible architecture for the selected ABI (that is,
15362 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
15363
15364 The native Linux/GNU toolchain also supports the value @samp{native},
15365 which selects the best architecture option for the host processor.
15366 @option{-march=native} has no effect if GCC does not recognize
15367 the processor.
15368
15369 In processor names, a final @samp{000} can be abbreviated as @samp{k}
15370 (for example, @option{-march=r2k}).  Prefixes are optional, and
15371 @samp{vr} may be written @samp{r}.
15372
15373 Names of the form @samp{@var{n}f2_1} refer to processors with
15374 FPUs clocked at half the rate of the core, names of the form
15375 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
15376 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
15377 processors with FPUs clocked a ratio of 3:2 with respect to the core.
15378 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
15379 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
15380 accepted as synonyms for @samp{@var{n}f1_1}.
15381
15382 GCC defines two macros based on the value of this option.  The first
15383 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
15384 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
15385 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
15386 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
15387 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
15388
15389 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
15390 above.  In other words, it has the full prefix and does not
15391 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
15392 the macro names the resolved architecture (either @samp{"mips1"} or
15393 @samp{"mips3"}).  It names the default architecture when no
15394 @option{-march} option is given.
15395
15396 @item -mtune=@var{arch}
15397 @opindex mtune
15398 Optimize for @var{arch}.  Among other things, this option controls
15399 the way instructions are scheduled, and the perceived cost of arithmetic
15400 operations.  The list of @var{arch} values is the same as for
15401 @option{-march}.
15402
15403 When this option is not used, GCC optimizes for the processor
15404 specified by @option{-march}.  By using @option{-march} and
15405 @option{-mtune} together, it is possible to generate code that
15406 runs on a family of processors, but optimize the code for one
15407 particular member of that family.
15408
15409 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
15410 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
15411 @option{-march} ones described above.
15412
15413 @item -mips1
15414 @opindex mips1
15415 Equivalent to @option{-march=mips1}.
15416
15417 @item -mips2
15418 @opindex mips2
15419 Equivalent to @option{-march=mips2}.
15420
15421 @item -mips3
15422 @opindex mips3
15423 Equivalent to @option{-march=mips3}.
15424
15425 @item -mips4
15426 @opindex mips4
15427 Equivalent to @option{-march=mips4}.
15428
15429 @item -mips32
15430 @opindex mips32
15431 Equivalent to @option{-march=mips32}.
15432
15433 @item -mips32r2
15434 @opindex mips32r2
15435 Equivalent to @option{-march=mips32r2}.
15436
15437 @item -mips64
15438 @opindex mips64
15439 Equivalent to @option{-march=mips64}.
15440
15441 @item -mips64r2
15442 @opindex mips64r2
15443 Equivalent to @option{-march=mips64r2}.
15444
15445 @item -mips16
15446 @itemx -mno-mips16
15447 @opindex mips16
15448 @opindex mno-mips16
15449 Generate (do not generate) MIPS16 code.  If GCC is targeting a
15450 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
15451
15452 MIPS16 code generation can also be controlled on a per-function basis
15453 by means of @code{mips16} and @code{nomips16} attributes.
15454 @xref{Function Attributes}, for more information.
15455
15456 @item -mflip-mips16
15457 @opindex mflip-mips16
15458 Generate MIPS16 code on alternating functions.  This option is provided
15459 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
15460 not intended for ordinary use in compiling user code.
15461
15462 @item -minterlink-mips16
15463 @itemx -mno-interlink-mips16
15464 @opindex minterlink-mips16
15465 @opindex mno-interlink-mips16
15466 Require (do not require) that non-MIPS16 code be link-compatible with
15467 MIPS16 code.
15468
15469 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
15470 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
15471 therefore disables direct jumps unless GCC knows that the target of the
15472 jump is not MIPS16.
15473
15474 @item -mabi=32
15475 @itemx -mabi=o64
15476 @itemx -mabi=n32
15477 @itemx -mabi=64
15478 @itemx -mabi=eabi
15479 @opindex mabi=32
15480 @opindex mabi=o64
15481 @opindex mabi=n32
15482 @opindex mabi=64
15483 @opindex mabi=eabi
15484 Generate code for the given ABI@.
15485
15486 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
15487 generates 64-bit code when you select a 64-bit architecture, but you
15488 can use @option{-mgp32} to get 32-bit code instead.
15489
15490 For information about the O64 ABI, see
15491 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
15492
15493 GCC supports a variant of the o32 ABI in which floating-point registers
15494 are 64 rather than 32 bits wide.  You can select this combination with
15495 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
15496 and @code{mfhc1} instructions and is therefore only supported for
15497 MIPS32R2 processors.
15498
15499 The register assignments for arguments and return values remain the
15500 same, but each scalar value is passed in a single 64-bit register
15501 rather than a pair of 32-bit registers.  For example, scalar
15502 floating-point values are returned in @samp{$f0} only, not a
15503 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
15504 remains the same, but all 64 bits are saved.
15505
15506 @item -mabicalls
15507 @itemx -mno-abicalls
15508 @opindex mabicalls
15509 @opindex mno-abicalls
15510 Generate (do not generate) code that is suitable for SVR4-style
15511 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
15512 systems.
15513
15514 @item -mshared
15515 @itemx -mno-shared
15516 Generate (do not generate) code that is fully position-independent,
15517 and that can therefore be linked into shared libraries.  This option
15518 only affects @option{-mabicalls}.
15519
15520 All @option{-mabicalls} code has traditionally been position-independent,
15521 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
15522 as an extension, the GNU toolchain allows executables to use absolute
15523 accesses for locally-binding symbols.  It can also use shorter GP
15524 initialization sequences and generate direct calls to locally-defined
15525 functions.  This mode is selected by @option{-mno-shared}.
15526
15527 @option{-mno-shared} depends on binutils 2.16 or higher and generates
15528 objects that can only be linked by the GNU linker.  However, the option
15529 does not affect the ABI of the final executable; it only affects the ABI
15530 of relocatable objects.  Using @option{-mno-shared} generally makes
15531 executables both smaller and quicker.
15532
15533 @option{-mshared} is the default.
15534
15535 @item -mplt
15536 @itemx -mno-plt
15537 @opindex mplt
15538 @opindex mno-plt
15539 Assume (do not assume) that the static and dynamic linkers
15540 support PLTs and copy relocations.  This option only affects
15541 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
15542 has no effect without @option{-msym32}.
15543
15544 You can make @option{-mplt} the default by configuring
15545 GCC with @option{--with-mips-plt}.  The default is
15546 @option{-mno-plt} otherwise.
15547
15548 @item -mxgot
15549 @itemx -mno-xgot
15550 @opindex mxgot
15551 @opindex mno-xgot
15552 Lift (do not lift) the usual restrictions on the size of the global
15553 offset table.
15554
15555 GCC normally uses a single instruction to load values from the GOT@.
15556 While this is relatively efficient, it only works if the GOT
15557 is smaller than about 64k.  Anything larger causes the linker
15558 to report an error such as:
15559
15560 @cindex relocation truncated to fit (MIPS)
15561 @smallexample
15562 relocation truncated to fit: R_MIPS_GOT16 foobar
15563 @end smallexample
15564
15565 If this happens, you should recompile your code with @option{-mxgot}.
15566 This works with very large GOTs, although the code is also
15567 less efficient, since it takes three instructions to fetch the
15568 value of a global symbol.
15569
15570 Note that some linkers can create multiple GOTs.  If you have such a
15571 linker, you should only need to use @option{-mxgot} when a single object
15572 file accesses more than 64k's worth of GOT entries.  Very few do.
15573
15574 These options have no effect unless GCC is generating position
15575 independent code.
15576
15577 @item -mgp32
15578 @opindex mgp32
15579 Assume that general-purpose registers are 32 bits wide.
15580
15581 @item -mgp64
15582 @opindex mgp64
15583 Assume that general-purpose registers are 64 bits wide.
15584
15585 @item -mfp32
15586 @opindex mfp32
15587 Assume that floating-point registers are 32 bits wide.
15588
15589 @item -mfp64
15590 @opindex mfp64
15591 Assume that floating-point registers are 64 bits wide.
15592
15593 @item -mhard-float
15594 @opindex mhard-float
15595 Use floating-point coprocessor instructions.
15596
15597 @item -msoft-float
15598 @opindex msoft-float
15599 Do not use floating-point coprocessor instructions.  Implement
15600 floating-point calculations using library calls instead.
15601
15602 @item -msingle-float
15603 @opindex msingle-float
15604 Assume that the floating-point coprocessor only supports single-precision
15605 operations.
15606
15607 @item -mdouble-float
15608 @opindex mdouble-float
15609 Assume that the floating-point coprocessor supports double-precision
15610 operations.  This is the default.
15611
15612 @item -mllsc
15613 @itemx -mno-llsc
15614 @opindex mllsc
15615 @opindex mno-llsc
15616 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
15617 implement atomic memory built-in functions.  When neither option is
15618 specified, GCC uses the instructions if the target architecture
15619 supports them.
15620
15621 @option{-mllsc} is useful if the runtime environment can emulate the
15622 instructions and @option{-mno-llsc} can be useful when compiling for
15623 nonstandard ISAs.  You can make either option the default by
15624 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
15625 respectively.  @option{--with-llsc} is the default for some
15626 configurations; see the installation documentation for details.
15627
15628 @item -mdsp
15629 @itemx -mno-dsp
15630 @opindex mdsp
15631 @opindex mno-dsp
15632 Use (do not use) revision 1 of the MIPS DSP ASE@.
15633 @xref{MIPS DSP Built-in Functions}.  This option defines the
15634 preprocessor macro @samp{__mips_dsp}.  It also defines
15635 @samp{__mips_dsp_rev} to 1.
15636
15637 @item -mdspr2
15638 @itemx -mno-dspr2
15639 @opindex mdspr2
15640 @opindex mno-dspr2
15641 Use (do not use) revision 2 of the MIPS DSP ASE@.
15642 @xref{MIPS DSP Built-in Functions}.  This option defines the
15643 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
15644 It also defines @samp{__mips_dsp_rev} to 2.
15645
15646 @item -msmartmips
15647 @itemx -mno-smartmips
15648 @opindex msmartmips
15649 @opindex mno-smartmips
15650 Use (do not use) the MIPS SmartMIPS ASE.
15651
15652 @item -mpaired-single
15653 @itemx -mno-paired-single
15654 @opindex mpaired-single
15655 @opindex mno-paired-single
15656 Use (do not use) paired-single floating-point instructions.
15657 @xref{MIPS Paired-Single Support}.  This option requires
15658 hardware floating-point support to be enabled.
15659
15660 @item -mdmx
15661 @itemx -mno-mdmx
15662 @opindex mdmx
15663 @opindex mno-mdmx
15664 Use (do not use) MIPS Digital Media Extension instructions.
15665 This option can only be used when generating 64-bit code and requires
15666 hardware floating-point support to be enabled.
15667
15668 @item -mips3d
15669 @itemx -mno-mips3d
15670 @opindex mips3d
15671 @opindex mno-mips3d
15672 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
15673 The option @option{-mips3d} implies @option{-mpaired-single}.
15674
15675 @item -mmt
15676 @itemx -mno-mt
15677 @opindex mmt
15678 @opindex mno-mt
15679 Use (do not use) MT Multithreading instructions.
15680
15681 @item -mlong64
15682 @opindex mlong64
15683 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
15684 an explanation of the default and the way that the pointer size is
15685 determined.
15686
15687 @item -mlong32
15688 @opindex mlong32
15689 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
15690
15691 The default size of @code{int}s, @code{long}s and pointers depends on
15692 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
15693 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
15694 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
15695 or the same size as integer registers, whichever is smaller.
15696
15697 @item -msym32
15698 @itemx -mno-sym32
15699 @opindex msym32
15700 @opindex mno-sym32
15701 Assume (do not assume) that all symbols have 32-bit values, regardless
15702 of the selected ABI@.  This option is useful in combination with
15703 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
15704 to generate shorter and faster references to symbolic addresses.
15705
15706 @item -G @var{num}
15707 @opindex G
15708 Put definitions of externally-visible data in a small data section
15709 if that data is no bigger than @var{num} bytes.  GCC can then access
15710 the data more efficiently; see @option{-mgpopt} for details.
15711
15712 The default @option{-G} option depends on the configuration.
15713
15714 @item -mlocal-sdata
15715 @itemx -mno-local-sdata
15716 @opindex mlocal-sdata
15717 @opindex mno-local-sdata
15718 Extend (do not extend) the @option{-G} behavior to local data too,
15719 such as to static variables in C@.  @option{-mlocal-sdata} is the
15720 default for all configurations.
15721
15722 If the linker complains that an application is using too much small data,
15723 you might want to try rebuilding the less performance-critical parts with
15724 @option{-mno-local-sdata}.  You might also want to build large
15725 libraries with @option{-mno-local-sdata}, so that the libraries leave
15726 more room for the main program.
15727
15728 @item -mextern-sdata
15729 @itemx -mno-extern-sdata
15730 @opindex mextern-sdata
15731 @opindex mno-extern-sdata
15732 Assume (do not assume) that externally-defined data is in
15733 a small data section if the size of that data is within the @option{-G} limit.
15734 @option{-mextern-sdata} is the default for all configurations.
15735
15736 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
15737 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
15738 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
15739 is placed in a small data section.  If @var{Var} is defined by another
15740 module, you must either compile that module with a high-enough
15741 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
15742 definition.  If @var{Var} is common, you must link the application
15743 with a high-enough @option{-G} setting.
15744
15745 The easiest way of satisfying these restrictions is to compile
15746 and link every module with the same @option{-G} option.  However,
15747 you may wish to build a library that supports several different
15748 small data limits.  You can do this by compiling the library with
15749 the highest supported @option{-G} setting and additionally using
15750 @option{-mno-extern-sdata} to stop the library from making assumptions
15751 about externally-defined data.
15752
15753 @item -mgpopt
15754 @itemx -mno-gpopt
15755 @opindex mgpopt
15756 @opindex mno-gpopt
15757 Use (do not use) GP-relative accesses for symbols that are known to be
15758 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
15759 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
15760 configurations.
15761
15762 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
15763 might not hold the value of @code{_gp}.  For example, if the code is
15764 part of a library that might be used in a boot monitor, programs that
15765 call boot monitor routines pass an unknown value in @code{$gp}.
15766 (In such situations, the boot monitor itself is usually compiled
15767 with @option{-G0}.)
15768
15769 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
15770 @option{-mno-extern-sdata}.
15771
15772 @item -membedded-data
15773 @itemx -mno-embedded-data
15774 @opindex membedded-data
15775 @opindex mno-embedded-data
15776 Allocate variables to the read-only data section first if possible, then
15777 next in the small data section if possible, otherwise in data.  This gives
15778 slightly slower code than the default, but reduces the amount of RAM required
15779 when executing, and thus may be preferred for some embedded systems.
15780
15781 @item -muninit-const-in-rodata
15782 @itemx -mno-uninit-const-in-rodata
15783 @opindex muninit-const-in-rodata
15784 @opindex mno-uninit-const-in-rodata
15785 Put uninitialized @code{const} variables in the read-only data section.
15786 This option is only meaningful in conjunction with @option{-membedded-data}.
15787
15788 @item -mcode-readable=@var{setting}
15789 @opindex mcode-readable
15790 Specify whether GCC may generate code that reads from executable sections.
15791 There are three possible settings:
15792
15793 @table @gcctabopt
15794 @item -mcode-readable=yes
15795 Instructions may freely access executable sections.  This is the
15796 default setting.
15797
15798 @item -mcode-readable=pcrel
15799 MIPS16 PC-relative load instructions can access executable sections,
15800 but other instructions must not do so.  This option is useful on 4KSc
15801 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
15802 It is also useful on processors that can be configured to have a dual
15803 instruction/data SRAM interface and that, like the M4K, automatically
15804 redirect PC-relative loads to the instruction RAM.
15805
15806 @item -mcode-readable=no
15807 Instructions must not access executable sections.  This option can be
15808 useful on targets that are configured to have a dual instruction/data
15809 SRAM interface but that (unlike the M4K) do not automatically redirect
15810 PC-relative loads to the instruction RAM.
15811 @end table
15812
15813 @item -msplit-addresses
15814 @itemx -mno-split-addresses
15815 @opindex msplit-addresses
15816 @opindex mno-split-addresses
15817 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
15818 relocation operators.  This option has been superseded by
15819 @option{-mexplicit-relocs} but is retained for backwards compatibility.
15820
15821 @item -mexplicit-relocs
15822 @itemx -mno-explicit-relocs
15823 @opindex mexplicit-relocs
15824 @opindex mno-explicit-relocs
15825 Use (do not use) assembler relocation operators when dealing with symbolic
15826 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
15827 is to use assembler macros instead.
15828
15829 @option{-mexplicit-relocs} is the default if GCC was configured
15830 to use an assembler that supports relocation operators.
15831
15832 @item -mcheck-zero-division
15833 @itemx -mno-check-zero-division
15834 @opindex mcheck-zero-division
15835 @opindex mno-check-zero-division
15836 Trap (do not trap) on integer division by zero.
15837
15838 The default is @option{-mcheck-zero-division}.
15839
15840 @item -mdivide-traps
15841 @itemx -mdivide-breaks
15842 @opindex mdivide-traps
15843 @opindex mdivide-breaks
15844 MIPS systems check for division by zero by generating either a
15845 conditional trap or a break instruction.  Using traps results in
15846 smaller code, but is only supported on MIPS II and later.  Also, some
15847 versions of the Linux kernel have a bug that prevents trap from
15848 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
15849 allow conditional traps on architectures that support them and
15850 @option{-mdivide-breaks} to force the use of breaks.
15851
15852 The default is usually @option{-mdivide-traps}, but this can be
15853 overridden at configure time using @option{--with-divide=breaks}.
15854 Divide-by-zero checks can be completely disabled using
15855 @option{-mno-check-zero-division}.
15856
15857 @item -mmemcpy
15858 @itemx -mno-memcpy
15859 @opindex mmemcpy
15860 @opindex mno-memcpy
15861 Force (do not force) the use of @code{memcpy()} for non-trivial block
15862 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
15863 most constant-sized copies.
15864
15865 @item -mlong-calls
15866 @itemx -mno-long-calls
15867 @opindex mlong-calls
15868 @opindex mno-long-calls
15869 Disable (do not disable) use of the @code{jal} instruction.  Calling
15870 functions using @code{jal} is more efficient but requires the caller
15871 and callee to be in the same 256 megabyte segment.
15872
15873 This option has no effect on abicalls code.  The default is
15874 @option{-mno-long-calls}.
15875
15876 @item -mmad
15877 @itemx -mno-mad
15878 @opindex mmad
15879 @opindex mno-mad
15880 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
15881 instructions, as provided by the R4650 ISA@.
15882
15883 @item -mfused-madd
15884 @itemx -mno-fused-madd
15885 @opindex mfused-madd
15886 @opindex mno-fused-madd
15887 Enable (disable) use of the floating-point multiply-accumulate
15888 instructions, when they are available.  The default is
15889 @option{-mfused-madd}.
15890
15891 When multiply-accumulate instructions are used, the intermediate
15892 product is calculated to infinite precision and is not subject to
15893 the FCSR Flush to Zero bit.  This may be undesirable in some
15894 circumstances.
15895
15896 @item -nocpp
15897 @opindex nocpp
15898 Tell the MIPS assembler to not run its preprocessor over user
15899 assembler files (with a @samp{.s} suffix) when assembling them.
15900
15901 @item -mfix-24k
15902 @item -mno-fix-24k
15903 @opindex mfix-24k
15904 @opindex mno-fix-24k
15905 Work around the 24K E48 (lost data on stores during refill) errata.
15906 The workarounds are implemented by the assembler rather than by GCC@.
15907
15908 @item -mfix-r4000
15909 @itemx -mno-fix-r4000
15910 @opindex mfix-r4000
15911 @opindex mno-fix-r4000
15912 Work around certain R4000 CPU errata:
15913 @itemize @minus
15914 @item
15915 A double-word or a variable shift may give an incorrect result if executed
15916 immediately after starting an integer division.
15917 @item
15918 A double-word or a variable shift may give an incorrect result if executed
15919 while an integer multiplication is in progress.
15920 @item
15921 An integer division may give an incorrect result if started in a delay slot
15922 of a taken branch or a jump.
15923 @end itemize
15924
15925 @item -mfix-r4400
15926 @itemx -mno-fix-r4400
15927 @opindex mfix-r4400
15928 @opindex mno-fix-r4400
15929 Work around certain R4400 CPU errata:
15930 @itemize @minus
15931 @item
15932 A double-word or a variable shift may give an incorrect result if executed
15933 immediately after starting an integer division.
15934 @end itemize
15935
15936 @item -mfix-r10000
15937 @itemx -mno-fix-r10000
15938 @opindex mfix-r10000
15939 @opindex mno-fix-r10000
15940 Work around certain R10000 errata:
15941 @itemize @minus
15942 @item
15943 @code{ll}/@code{sc} sequences may not behave atomically on revisions
15944 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
15945 @end itemize
15946
15947 This option can only be used if the target architecture supports
15948 branch-likely instructions.  @option{-mfix-r10000} is the default when
15949 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
15950 otherwise.
15951
15952 @item -mfix-vr4120
15953 @itemx -mno-fix-vr4120
15954 @opindex mfix-vr4120
15955 Work around certain VR4120 errata:
15956 @itemize @minus
15957 @item
15958 @code{dmultu} does not always produce the correct result.
15959 @item
15960 @code{div} and @code{ddiv} do not always produce the correct result if one
15961 of the operands is negative.
15962 @end itemize
15963 The workarounds for the division errata rely on special functions in
15964 @file{libgcc.a}.  At present, these functions are only provided by
15965 the @code{mips64vr*-elf} configurations.
15966
15967 Other VR4120 errata require a nop to be inserted between certain pairs of
15968 instructions.  These errata are handled by the assembler, not by GCC itself.
15969
15970 @item -mfix-vr4130
15971 @opindex mfix-vr4130
15972 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
15973 workarounds are implemented by the assembler rather than by GCC,
15974 although GCC avoids using @code{mflo} and @code{mfhi} if the
15975 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
15976 instructions are available instead.
15977
15978 @item -mfix-sb1
15979 @itemx -mno-fix-sb1
15980 @opindex mfix-sb1
15981 Work around certain SB-1 CPU core errata.
15982 (This flag currently works around the SB-1 revision 2
15983 ``F1'' and ``F2'' floating-point errata.)
15984
15985 @item -mr10k-cache-barrier=@var{setting}
15986 @opindex mr10k-cache-barrier
15987 Specify whether GCC should insert cache barriers to avoid the
15988 side-effects of speculation on R10K processors.
15989
15990 In common with many processors, the R10K tries to predict the outcome
15991 of a conditional branch and speculatively executes instructions from
15992 the ``taken'' branch.  It later aborts these instructions if the
15993 predicted outcome is wrong.  However, on the R10K, even aborted
15994 instructions can have side effects.
15995
15996 This problem only affects kernel stores and, depending on the system,
15997 kernel loads.  As an example, a speculatively-executed store may load
15998 the target memory into cache and mark the cache line as dirty, even if
15999 the store itself is later aborted.  If a DMA operation writes to the
16000 same area of memory before the ``dirty'' line is flushed, the cached
16001 data overwrites the DMA-ed data.  See the R10K processor manual
16002 for a full description, including other potential problems.
16003
16004 One workaround is to insert cache barrier instructions before every memory
16005 access that might be speculatively executed and that might have side
16006 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
16007 controls GCC's implementation of this workaround.  It assumes that
16008 aborted accesses to any byte in the following regions does not have
16009 side effects:
16010
16011 @enumerate
16012 @item
16013 the memory occupied by the current function's stack frame;
16014
16015 @item
16016 the memory occupied by an incoming stack argument;
16017
16018 @item
16019 the memory occupied by an object with a link-time-constant address.
16020 @end enumerate
16021
16022 It is the kernel's responsibility to ensure that speculative
16023 accesses to these regions are indeed safe.
16024
16025 If the input program contains a function declaration such as:
16026
16027 @smallexample
16028 void foo (void);
16029 @end smallexample
16030
16031 then the implementation of @code{foo} must allow @code{j foo} and
16032 @code{jal foo} to be executed speculatively.  GCC honors this
16033 restriction for functions it compiles itself.  It expects non-GCC
16034 functions (such as hand-written assembly code) to do the same.
16035
16036 The option has three forms:
16037
16038 @table @gcctabopt
16039 @item -mr10k-cache-barrier=load-store
16040 Insert a cache barrier before a load or store that might be
16041 speculatively executed and that might have side effects even
16042 if aborted.
16043
16044 @item -mr10k-cache-barrier=store
16045 Insert a cache barrier before a store that might be speculatively
16046 executed and that might have side effects even if aborted.
16047
16048 @item -mr10k-cache-barrier=none
16049 Disable the insertion of cache barriers.  This is the default setting.
16050 @end table
16051
16052 @item -mflush-func=@var{func}
16053 @itemx -mno-flush-func
16054 @opindex mflush-func
16055 Specifies the function to call to flush the I and D caches, or to not
16056 call any such function.  If called, the function must take the same
16057 arguments as the common @code{_flush_func()}, that is, the address of the
16058 memory range for which the cache is being flushed, the size of the
16059 memory range, and the number 3 (to flush both caches).  The default
16060 depends on the target GCC was configured for, but commonly is either
16061 @samp{_flush_func} or @samp{__cpu_flush}.
16062
16063 @item mbranch-cost=@var{num}
16064 @opindex mbranch-cost
16065 Set the cost of branches to roughly @var{num} ``simple'' instructions.
16066 This cost is only a heuristic and is not guaranteed to produce
16067 consistent results across releases.  A zero cost redundantly selects
16068 the default, which is based on the @option{-mtune} setting.
16069
16070 @item -mbranch-likely
16071 @itemx -mno-branch-likely
16072 @opindex mbranch-likely
16073 @opindex mno-branch-likely
16074 Enable or disable use of Branch Likely instructions, regardless of the
16075 default for the selected architecture.  By default, Branch Likely
16076 instructions may be generated if they are supported by the selected
16077 architecture.  An exception is for the MIPS32 and MIPS64 architectures
16078 and processors that implement those architectures; for those, Branch
16079 Likely instructions are not be generated by default because the MIPS32
16080 and MIPS64 architectures specifically deprecate their use.
16081
16082 @item -mfp-exceptions
16083 @itemx -mno-fp-exceptions
16084 @opindex mfp-exceptions
16085 Specifies whether FP exceptions are enabled.  This affects how
16086 FP instructions are scheduled for some processors.
16087 The default is that FP exceptions are
16088 enabled.
16089
16090 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
16091 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
16092 FP pipe.
16093
16094 @item -mvr4130-align
16095 @itemx -mno-vr4130-align
16096 @opindex mvr4130-align
16097 The VR4130 pipeline is two-way superscalar, but can only issue two
16098 instructions together if the first one is 8-byte aligned.  When this
16099 option is enabled, GCC aligns pairs of instructions that it
16100 thinks should execute in parallel.
16101
16102 This option only has an effect when optimizing for the VR4130.
16103 It normally makes code faster, but at the expense of making it bigger.
16104 It is enabled by default at optimization level @option{-O3}.
16105
16106 @item -msynci
16107 @itemx -mno-synci
16108 @opindex msynci
16109 Enable (disable) generation of @code{synci} instructions on
16110 architectures that support it.  The @code{synci} instructions (if
16111 enabled) are generated when @code{__builtin___clear_cache()} is
16112 compiled.
16113
16114 This option defaults to @code{-mno-synci}, but the default can be
16115 overridden by configuring with @code{--with-synci}.
16116
16117 When compiling code for single processor systems, it is generally safe
16118 to use @code{synci}.  However, on many multi-core (SMP) systems, it
16119 does not invalidate the instruction caches on all cores and may lead
16120 to undefined behavior.
16121
16122 @item -mrelax-pic-calls
16123 @itemx -mno-relax-pic-calls
16124 @opindex mrelax-pic-calls
16125 Try to turn PIC calls that are normally dispatched via register
16126 @code{$25} into direct calls.  This is only possible if the linker can
16127 resolve the destination at link-time and if the destination is within
16128 range for a direct call.
16129
16130 @option{-mrelax-pic-calls} is the default if GCC was configured to use
16131 an assembler and a linker that supports the @code{.reloc} assembly
16132 directive and @code{-mexplicit-relocs} is in effect.  With
16133 @code{-mno-explicit-relocs}, this optimization can be performed by the
16134 assembler and the linker alone without help from the compiler.
16135
16136 @item -mmcount-ra-address
16137 @itemx -mno-mcount-ra-address
16138 @opindex mmcount-ra-address
16139 @opindex mno-mcount-ra-address
16140 Emit (do not emit) code that allows @code{_mcount} to modify the
16141 calling function's return address.  When enabled, this option extends
16142 the usual @code{_mcount} interface with a new @var{ra-address}
16143 parameter, which has type @code{intptr_t *} and is passed in register
16144 @code{$12}.  @code{_mcount} can then modify the return address by
16145 doing both of the following:
16146 @itemize
16147 @item
16148 Returning the new address in register @code{$31}.
16149 @item
16150 Storing the new address in @code{*@var{ra-address}},
16151 if @var{ra-address} is nonnull.
16152 @end itemize
16153
16154 The default is @option{-mno-mcount-ra-address}.
16155
16156 @end table
16157
16158 @node MMIX Options
16159 @subsection MMIX Options
16160 @cindex MMIX Options
16161
16162 These options are defined for the MMIX:
16163
16164 @table @gcctabopt
16165 @item -mlibfuncs
16166 @itemx -mno-libfuncs
16167 @opindex mlibfuncs
16168 @opindex mno-libfuncs
16169 Specify that intrinsic library functions are being compiled, passing all
16170 values in registers, no matter the size.
16171
16172 @item -mepsilon
16173 @itemx -mno-epsilon
16174 @opindex mepsilon
16175 @opindex mno-epsilon
16176 Generate floating-point comparison instructions that compare with respect
16177 to the @code{rE} epsilon register.
16178
16179 @item -mabi=mmixware
16180 @itemx -mabi=gnu
16181 @opindex mabi=mmixware
16182 @opindex mabi=gnu
16183 Generate code that passes function parameters and return values that (in
16184 the called function) are seen as registers @code{$0} and up, as opposed to
16185 the GNU ABI which uses global registers @code{$231} and up.
16186
16187 @item -mzero-extend
16188 @itemx -mno-zero-extend
16189 @opindex mzero-extend
16190 @opindex mno-zero-extend
16191 When reading data from memory in sizes shorter than 64 bits, use (do not
16192 use) zero-extending load instructions by default, rather than
16193 sign-extending ones.
16194
16195 @item -mknuthdiv
16196 @itemx -mno-knuthdiv
16197 @opindex mknuthdiv
16198 @opindex mno-knuthdiv
16199 Make the result of a division yielding a remainder have the same sign as
16200 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
16201 remainder follows the sign of the dividend.  Both methods are
16202 arithmetically valid, the latter being almost exclusively used.
16203
16204 @item -mtoplevel-symbols
16205 @itemx -mno-toplevel-symbols
16206 @opindex mtoplevel-symbols
16207 @opindex mno-toplevel-symbols
16208 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
16209 code can be used with the @code{PREFIX} assembly directive.
16210
16211 @item -melf
16212 @opindex melf
16213 Generate an executable in the ELF format, rather than the default
16214 @samp{mmo} format used by the @command{mmix} simulator.
16215
16216 @item -mbranch-predict
16217 @itemx -mno-branch-predict
16218 @opindex mbranch-predict
16219 @opindex mno-branch-predict
16220 Use (do not use) the probable-branch instructions, when static branch
16221 prediction indicates a probable branch.
16222
16223 @item -mbase-addresses
16224 @itemx -mno-base-addresses
16225 @opindex mbase-addresses
16226 @opindex mno-base-addresses
16227 Generate (do not generate) code that uses @emph{base addresses}.  Using a
16228 base address automatically generates a request (handled by the assembler
16229 and the linker) for a constant to be set up in a global register.  The
16230 register is used for one or more base address requests within the range 0
16231 to 255 from the value held in the register.  The generally leads to short
16232 and fast code, but the number of different data items that can be
16233 addressed is limited.  This means that a program that uses lots of static
16234 data may require @option{-mno-base-addresses}.
16235
16236 @item -msingle-exit
16237 @itemx -mno-single-exit
16238 @opindex msingle-exit
16239 @opindex mno-single-exit
16240 Force (do not force) generated code to have a single exit point in each
16241 function.
16242 @end table
16243
16244 @node MN10300 Options
16245 @subsection MN10300 Options
16246 @cindex MN10300 options
16247
16248 These @option{-m} options are defined for Matsushita MN10300 architectures:
16249
16250 @table @gcctabopt
16251 @item -mmult-bug
16252 @opindex mmult-bug
16253 Generate code to avoid bugs in the multiply instructions for the MN10300
16254 processors.  This is the default.
16255
16256 @item -mno-mult-bug
16257 @opindex mno-mult-bug
16258 Do not generate code to avoid bugs in the multiply instructions for the
16259 MN10300 processors.
16260
16261 @item -mam33
16262 @opindex mam33
16263 Generate code using features specific to the AM33 processor.
16264
16265 @item -mno-am33
16266 @opindex mno-am33
16267 Do not generate code using features specific to the AM33 processor.  This
16268 is the default.
16269
16270 @item -mam33-2
16271 @opindex mam33-2
16272 Generate code using features specific to the AM33/2.0 processor.
16273
16274 @item -mam34
16275 @opindex mam34
16276 Generate code using features specific to the AM34 processor.
16277
16278 @item -mtune=@var{cpu-type}
16279 @opindex mtune
16280 Use the timing characteristics of the indicated CPU type when
16281 scheduling instructions.  This does not change the targeted processor
16282 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
16283 @samp{am33-2} or @samp{am34}.
16284
16285 @item -mreturn-pointer-on-d0
16286 @opindex mreturn-pointer-on-d0
16287 When generating a function that returns a pointer, return the pointer
16288 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
16289 only in @code{a0}, and attempts to call such functions without a prototype
16290 result in errors.  Note that this option is on by default; use
16291 @option{-mno-return-pointer-on-d0} to disable it.
16292
16293 @item -mno-crt0
16294 @opindex mno-crt0
16295 Do not link in the C run-time initialization object file.
16296
16297 @item -mrelax
16298 @opindex mrelax
16299 Indicate to the linker that it should perform a relaxation optimization pass
16300 to shorten branches, calls and absolute memory addresses.  This option only
16301 has an effect when used on the command line for the final link step.
16302
16303 This option makes symbolic debugging impossible.
16304
16305 @item -mliw
16306 @opindex mliw
16307 Allow the compiler to generate @emph{Long Instruction Word}
16308 instructions if the target is the @samp{AM33} or later.  This is the
16309 default.  This option defines the preprocessor macro @samp{__LIW__}.
16310
16311 @item -mnoliw
16312 @opindex mnoliw
16313 Do not allow the compiler to generate @emph{Long Instruction Word}
16314 instructions.  This option defines the preprocessor macro
16315 @samp{__NO_LIW__}.
16316
16317 @item -msetlb
16318 @opindex msetlb
16319 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
16320 instructions if the target is the @samp{AM33} or later.  This is the
16321 default.  This option defines the preprocessor macro @samp{__SETLB__}.
16322
16323 @item -mnosetlb
16324 @opindex mnosetlb
16325 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
16326 instructions.  This option defines the preprocessor macro
16327 @samp{__NO_SETLB__}.
16328
16329 @end table
16330
16331 @node PDP-11 Options
16332 @subsection PDP-11 Options
16333 @cindex PDP-11 Options
16334
16335 These options are defined for the PDP-11:
16336
16337 @table @gcctabopt
16338 @item -mfpu
16339 @opindex mfpu
16340 Use hardware FPP floating point.  This is the default.  (FIS floating
16341 point on the PDP-11/40 is not supported.)
16342
16343 @item -msoft-float
16344 @opindex msoft-float
16345 Do not use hardware floating point.
16346
16347 @item -mac0
16348 @opindex mac0
16349 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
16350
16351 @item -mno-ac0
16352 @opindex mno-ac0
16353 Return floating-point results in memory.  This is the default.
16354
16355 @item -m40
16356 @opindex m40
16357 Generate code for a PDP-11/40.
16358
16359 @item -m45
16360 @opindex m45
16361 Generate code for a PDP-11/45.  This is the default.
16362
16363 @item -m10
16364 @opindex m10
16365 Generate code for a PDP-11/10.
16366
16367 @item -mbcopy-builtin
16368 @opindex mbcopy-builtin
16369 Use inline @code{movmemhi} patterns for copying memory.  This is the
16370 default.
16371
16372 @item -mbcopy
16373 @opindex mbcopy
16374 Do not use inline @code{movmemhi} patterns for copying memory.
16375
16376 @item -mint16
16377 @itemx -mno-int32
16378 @opindex mint16
16379 @opindex mno-int32
16380 Use 16-bit @code{int}.  This is the default.
16381
16382 @item -mint32
16383 @itemx -mno-int16
16384 @opindex mint32
16385 @opindex mno-int16
16386 Use 32-bit @code{int}.
16387
16388 @item -mfloat64
16389 @itemx -mno-float32
16390 @opindex mfloat64
16391 @opindex mno-float32
16392 Use 64-bit @code{float}.  This is the default.
16393
16394 @item -mfloat32
16395 @itemx -mno-float64
16396 @opindex mfloat32
16397 @opindex mno-float64
16398 Use 32-bit @code{float}.
16399
16400 @item -mabshi
16401 @opindex mabshi
16402 Use @code{abshi2} pattern.  This is the default.
16403
16404 @item -mno-abshi
16405 @opindex mno-abshi
16406 Do not use @code{abshi2} pattern.
16407
16408 @item -mbranch-expensive
16409 @opindex mbranch-expensive
16410 Pretend that branches are expensive.  This is for experimenting with
16411 code generation only.
16412
16413 @item -mbranch-cheap
16414 @opindex mbranch-cheap
16415 Do not pretend that branches are expensive.  This is the default.
16416
16417 @item -munix-asm
16418 @opindex munix-asm
16419 Use Unix assembler syntax.  This is the default when configured for
16420 @samp{pdp11-*-bsd}.
16421
16422 @item -mdec-asm
16423 @opindex mdec-asm
16424 Use DEC assembler syntax.  This is the default when configured for any
16425 PDP-11 target other than @samp{pdp11-*-bsd}.
16426 @end table
16427
16428 @node picoChip Options
16429 @subsection picoChip Options
16430 @cindex picoChip options
16431
16432 These @samp{-m} options are defined for picoChip implementations:
16433
16434 @table @gcctabopt
16435
16436 @item -mae=@var{ae_type}
16437 @opindex mcpu
16438 Set the instruction set, register set, and instruction scheduling
16439 parameters for array element type @var{ae_type}.  Supported values
16440 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
16441
16442 @option{-mae=ANY} selects a completely generic AE type.  Code
16443 generated with this option runs on any of the other AE types.  The
16444 code is not as efficient as it would be if compiled for a specific
16445 AE type, and some types of operation (e.g., multiplication) do not
16446 work properly on all types of AE.
16447
16448 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
16449 for compiled code, and is the default.
16450
16451 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
16452 option may suffer from poor performance of byte (char) manipulation,
16453 since the DSP AE does not provide hardware support for byte load/stores.
16454
16455 @item -msymbol-as-address
16456 Enable the compiler to directly use a symbol name as an address in a
16457 load/store instruction, without first loading it into a
16458 register.  Typically, the use of this option generates larger
16459 programs, which run faster than when the option isn't used.  However, the
16460 results vary from program to program, so it is left as a user option,
16461 rather than being permanently enabled.
16462
16463 @item -mno-inefficient-warnings
16464 Disables warnings about the generation of inefficient code.  These
16465 warnings can be generated, for example, when compiling code that
16466 performs byte-level memory operations on the MAC AE type.  The MAC AE has
16467 no hardware support for byte-level memory operations, so all byte
16468 load/stores must be synthesized from word load/store operations.  This is
16469 inefficient and a warning is generated to indicate
16470 that you should rewrite the code to avoid byte operations, or to target
16471 an AE type that has the necessary hardware support.  This option disables
16472 these warnings.
16473
16474 @end table
16475
16476 @node PowerPC Options
16477 @subsection PowerPC Options
16478 @cindex PowerPC options
16479
16480 These are listed under @xref{RS/6000 and PowerPC Options}.
16481
16482 @node RL78 Options
16483 @subsection RL78 Options
16484 @cindex RL78 Options
16485
16486 @table @gcctabopt
16487
16488 @item -msim
16489 @opindex msim
16490 Links in additional target libraries to support operation within a
16491 simulator.
16492
16493 @item -mmul=none
16494 @itemx -mmul=g13
16495 @itemx -mmul=rl78
16496 @opindex mmul
16497 Specifies the type of hardware multiplication support to be used.  The
16498 default is @code{none}, which uses software multiplication functions.
16499 The @code{g13} option is for the hardware multiply/divide peripheral
16500 only on the RL78/G13 targets.  The @code{rl78} option is for the
16501 standard hardware multiplication defined in the RL78 software manual.
16502
16503 @end table
16504
16505 @node RS/6000 and PowerPC Options
16506 @subsection IBM RS/6000 and PowerPC Options
16507 @cindex RS/6000 and PowerPC Options
16508 @cindex IBM RS/6000 and PowerPC Options
16509
16510 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
16511 @table @gcctabopt
16512 @item -mpower
16513 @itemx -mno-power
16514 @itemx -mpower2
16515 @itemx -mno-power2
16516 @itemx -mpowerpc
16517 @itemx -mno-powerpc
16518 @itemx -mpowerpc-gpopt
16519 @itemx -mno-powerpc-gpopt
16520 @itemx -mpowerpc-gfxopt
16521 @itemx -mno-powerpc-gfxopt
16522 @need 800
16523 @itemx -mpowerpc64
16524 @itemx -mno-powerpc64
16525 @itemx -mmfcrf
16526 @itemx -mno-mfcrf
16527 @itemx -mpopcntb
16528 @itemx -mno-popcntb
16529 @itemx -mpopcntd
16530 @itemx -mno-popcntd
16531 @itemx -mfprnd
16532 @itemx -mno-fprnd
16533 @need 800
16534 @itemx -mcmpb
16535 @itemx -mno-cmpb
16536 @itemx -mmfpgpr
16537 @itemx -mno-mfpgpr
16538 @itemx -mhard-dfp
16539 @itemx -mno-hard-dfp
16540 @opindex mpower
16541 @opindex mno-power
16542 @opindex mpower2
16543 @opindex mno-power2
16544 @opindex mpowerpc
16545 @opindex mno-powerpc
16546 @opindex mpowerpc-gpopt
16547 @opindex mno-powerpc-gpopt
16548 @opindex mpowerpc-gfxopt
16549 @opindex mno-powerpc-gfxopt
16550 @opindex mpowerpc64
16551 @opindex mno-powerpc64
16552 @opindex mmfcrf
16553 @opindex mno-mfcrf
16554 @opindex mpopcntb
16555 @opindex mno-popcntb
16556 @opindex mpopcntd
16557 @opindex mno-popcntd
16558 @opindex mfprnd
16559 @opindex mno-fprnd
16560 @opindex mcmpb
16561 @opindex mno-cmpb
16562 @opindex mmfpgpr
16563 @opindex mno-mfpgpr
16564 @opindex mhard-dfp
16565 @opindex mno-hard-dfp
16566 GCC supports two related instruction set architectures for the
16567 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
16568 instructions supported by the @samp{rios} chip set used in the original
16569 RS/6000 systems and the @dfn{PowerPC} instruction set is the
16570 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
16571 the IBM 4xx, 6xx, and follow-on microprocessors.
16572
16573 Neither architecture is a subset of the other.  However there is a
16574 large common subset of instructions supported by both.  An MQ
16575 register is included in processors supporting the POWER architecture.
16576
16577 You use these options to specify which instructions are available on the
16578 processor you are using.  The default value of these options is
16579 determined when configuring GCC@.  Specifying the
16580 @option{-mcpu=@var{cpu_type}} overrides the specification of these
16581 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
16582 rather than the options listed above.
16583
16584 The @option{-mpower} option allows GCC to generate instructions that
16585 are found only in the POWER architecture and to use the MQ register.
16586 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
16587 to generate instructions that are present in the POWER2 architecture but
16588 not the original POWER architecture.
16589
16590 The @option{-mpowerpc} option allows GCC to generate instructions that
16591 are found only in the 32-bit subset of the PowerPC architecture.
16592 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
16593 GCC to use the optional PowerPC architecture instructions in the
16594 General Purpose group, including floating-point square root.  Specifying
16595 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
16596 use the optional PowerPC architecture instructions in the Graphics
16597 group, including floating-point select.
16598
16599 The @option{-mmfcrf} option allows GCC to generate the move from
16600 condition register field instruction implemented on the POWER4
16601 processor and other processors that support the PowerPC V2.01
16602 architecture.
16603 The @option{-mpopcntb} option allows GCC to generate the popcount and
16604 double-precision FP reciprocal estimate instruction implemented on the
16605 POWER5 processor and other processors that support the PowerPC V2.02
16606 architecture.
16607 The @option{-mpopcntd} option allows GCC to generate the popcount
16608 instruction implemented on the POWER7 processor and other processors
16609 that support the PowerPC V2.06 architecture.
16610 The @option{-mfprnd} option allows GCC to generate the FP round to
16611 integer instructions implemented on the POWER5+ processor and other
16612 processors that support the PowerPC V2.03 architecture.
16613 The @option{-mcmpb} option allows GCC to generate the compare bytes
16614 instruction implemented on the POWER6 processor and other processors
16615 that support the PowerPC V2.05 architecture.
16616 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
16617 general-purpose register instructions implemented on the POWER6X
16618 processor and other processors that support the extended PowerPC V2.05
16619 architecture.
16620 The @option{-mhard-dfp} option allows GCC to generate the decimal
16621 floating-point instructions implemented on some POWER processors.
16622
16623 The @option{-mpowerpc64} option allows GCC to generate the additional
16624 64-bit instructions that are found in the full PowerPC64 architecture
16625 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
16626 @option{-mno-powerpc64}.
16627
16628 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
16629 uses only the instructions in the common subset of both
16630 architectures plus some special AIX common-mode calls, and does not use
16631 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
16632 permits GCC to use any instruction from either architecture and to
16633 allow use of the MQ register; specify this for the Motorola MPC601.
16634
16635 @item -mnew-mnemonics
16636 @itemx -mold-mnemonics
16637 @opindex mnew-mnemonics
16638 @opindex mold-mnemonics
16639 Select which mnemonics to use in the generated assembler code.  With
16640 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
16641 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
16642 assembler mnemonics defined for the POWER architecture.  Instructions
16643 defined in only one architecture have only one mnemonic; GCC uses that
16644 mnemonic irrespective of which of these options is specified.
16645
16646 GCC defaults to the mnemonics appropriate for the architecture in
16647 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
16648 value of these option.  Unless you are building a cross-compiler, you
16649 should normally not specify either @option{-mnew-mnemonics} or
16650 @option{-mold-mnemonics}, but should instead accept the default.
16651
16652 @item -mcpu=@var{cpu_type}
16653 @opindex mcpu
16654 Set architecture type, register usage, choice of mnemonics, and
16655 instruction scheduling parameters for machine type @var{cpu_type}.
16656 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
16657 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
16658 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
16659 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
16660 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
16661 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
16662 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
16663 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
16664 @samp{titan}, @samp{power}, @samp{power2}, @samp{power3},
16665 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
16666 @samp{power6x}, @samp{power7}, @samp{common}, @samp{powerpc},
16667 @samp{powerpc64}, @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc},
16668 and @samp{rs64}.
16669
16670 @option{-mcpu=common} selects a completely generic processor.  Code
16671 generated under this option runs on any POWER or PowerPC processor.
16672 GCC uses only the instructions in the common subset of both
16673 architectures, and does not use the MQ register.  GCC assumes a generic
16674 processor model for scheduling purposes.
16675
16676 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
16677 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
16678 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
16679 types, with an appropriate, generic processor model assumed for
16680 scheduling purposes.
16681
16682 The other options specify a specific processor.  Code generated under
16683 those options runs best on that processor, and may not run at all on
16684 others.
16685
16686 The @option{-mcpu} options automatically enable or disable the
16687 following options:
16688
16689 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
16690 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
16691 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
16692 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
16693
16694 The particular options set for any particular CPU varies between
16695 compiler versions, depending on what setting seems to produce optimal
16696 code for that CPU; it doesn't necessarily reflect the actual hardware's
16697 capabilities.  If you wish to set an individual option to a particular
16698 value, you may specify it after the @option{-mcpu} option, like
16699 @option{-mcpu=970 -mno-altivec}.
16700
16701 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
16702 not enabled or disabled by the @option{-mcpu} option at present because
16703 AIX does not have full support for these options.  You may still
16704 enable or disable them individually if you're sure it'll work in your
16705 environment.
16706
16707 @item -mtune=@var{cpu_type}
16708 @opindex mtune
16709 Set the instruction scheduling parameters for machine type
16710 @var{cpu_type}, but do not set the architecture type, register usage, or
16711 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} does.  The same
16712 values for @var{cpu_type} are used for @option{-mtune} as for
16713 @option{-mcpu}.  If both are specified, the code generated uses the
16714 architecture, registers, and mnemonics set by @option{-mcpu}, but the
16715 scheduling parameters set by @option{-mtune}.
16716
16717 @item -mcmodel=small
16718 @opindex mcmodel=small
16719 Generate PowerPC64 code for the small model: The TOC is limited to
16720 64k.
16721
16722 @item -mcmodel=medium
16723 @opindex mcmodel=medium
16724 Generate PowerPC64 code for the medium model: The TOC and other static
16725 data may be up to a total of 4G in size.
16726
16727 @item -mcmodel=large
16728 @opindex mcmodel=large
16729 Generate PowerPC64 code for the large model: The TOC may be up to 4G
16730 in size.  Other data and code is only limited by the 64-bit address
16731 space.
16732
16733 @item -maltivec
16734 @itemx -mno-altivec
16735 @opindex maltivec
16736 @opindex mno-altivec
16737 Generate code that uses (does not use) AltiVec instructions, and also
16738 enable the use of built-in functions that allow more direct access to
16739 the AltiVec instruction set.  You may also need to set
16740 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
16741 enhancements.
16742
16743 @item -mvrsave
16744 @itemx -mno-vrsave
16745 @opindex mvrsave
16746 @opindex mno-vrsave
16747 Generate VRSAVE instructions when generating AltiVec code.
16748
16749 @item -mgen-cell-microcode
16750 @opindex mgen-cell-microcode
16751 Generate Cell microcode instructions
16752
16753 @item -mwarn-cell-microcode
16754 @opindex mwarn-cell-microcode
16755 Warning when a Cell microcode instruction is going to emitted.  An example
16756 of a Cell microcode instruction is a variable shift.
16757
16758 @item -msecure-plt
16759 @opindex msecure-plt
16760 Generate code that allows @command{ld} and @command{ld.so}
16761 to build executables and shared
16762 libraries with non-executable @code{.plt} and @code{.got} sections.
16763 This is a PowerPC
16764 32-bit SYSV ABI option.
16765
16766 @item -mbss-plt
16767 @opindex mbss-plt
16768 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
16769 fills in, and
16770 requires @code{.plt} and @code{.got}
16771 sections that are both writable and executable.
16772 This is a PowerPC 32-bit SYSV ABI option.
16773
16774 @item -misel
16775 @itemx -mno-isel
16776 @opindex misel
16777 @opindex mno-isel
16778 This switch enables or disables the generation of ISEL instructions.
16779
16780 @item -misel=@var{yes/no}
16781 This switch has been deprecated.  Use @option{-misel} and
16782 @option{-mno-isel} instead.
16783
16784 @item -mspe
16785 @itemx -mno-spe
16786 @opindex mspe
16787 @opindex mno-spe
16788 This switch enables or disables the generation of SPE simd
16789 instructions.
16790
16791 @item -mpaired
16792 @itemx -mno-paired
16793 @opindex mpaired
16794 @opindex mno-paired
16795 This switch enables or disables the generation of PAIRED simd
16796 instructions.
16797
16798 @item -mspe=@var{yes/no}
16799 This option has been deprecated.  Use @option{-mspe} and
16800 @option{-mno-spe} instead.
16801
16802 @item -mvsx
16803 @itemx -mno-vsx
16804 @opindex mvsx
16805 @opindex mno-vsx
16806 Generate code that uses (does not use) vector/scalar (VSX)
16807 instructions, and also enable the use of built-in functions that allow
16808 more direct access to the VSX instruction set.
16809
16810 @item -mfloat-gprs=@var{yes/single/double/no}
16811 @itemx -mfloat-gprs
16812 @opindex mfloat-gprs
16813 This switch enables or disables the generation of floating-point
16814 operations on the general-purpose registers for architectures that
16815 support it.
16816
16817 The argument @var{yes} or @var{single} enables the use of
16818 single-precision floating-point operations.
16819
16820 The argument @var{double} enables the use of single and
16821 double-precision floating-point operations.
16822
16823 The argument @var{no} disables floating-point operations on the
16824 general-purpose registers.
16825
16826 This option is currently only available on the MPC854x.
16827
16828 @item -m32
16829 @itemx -m64
16830 @opindex m32
16831 @opindex m64
16832 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
16833 targets (including GNU/Linux).  The 32-bit environment sets int, long
16834 and pointer to 32 bits and generates code that runs on any PowerPC
16835 variant.  The 64-bit environment sets int to 32 bits and long and
16836 pointer to 64 bits, and generates code for PowerPC64, as for
16837 @option{-mpowerpc64}.
16838
16839 @item -mfull-toc
16840 @itemx -mno-fp-in-toc
16841 @itemx -mno-sum-in-toc
16842 @itemx -mminimal-toc
16843 @opindex mfull-toc
16844 @opindex mno-fp-in-toc
16845 @opindex mno-sum-in-toc
16846 @opindex mminimal-toc
16847 Modify generation of the TOC (Table Of Contents), which is created for
16848 every executable file.  The @option{-mfull-toc} option is selected by
16849 default.  In that case, GCC allocates at least one TOC entry for
16850 each unique non-automatic variable reference in your program.  GCC
16851 also places floating-point constants in the TOC@.  However, only
16852 16,384 entries are available in the TOC@.
16853
16854 If you receive a linker error message that saying you have overflowed
16855 the available TOC space, you can reduce the amount of TOC space used
16856 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
16857 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
16858 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
16859 generate code to calculate the sum of an address and a constant at
16860 run time instead of putting that sum into the TOC@.  You may specify one
16861 or both of these options.  Each causes GCC to produce very slightly
16862 slower and larger code at the expense of conserving TOC space.
16863
16864 If you still run out of space in the TOC even when you specify both of
16865 these options, specify @option{-mminimal-toc} instead.  This option causes
16866 GCC to make only one TOC entry for every file.  When you specify this
16867 option, GCC produces code that is slower and larger but which
16868 uses extremely little TOC space.  You may wish to use this option
16869 only on files that contain less frequently-executed code.
16870
16871 @item -maix64
16872 @itemx -maix32
16873 @opindex maix64
16874 @opindex maix32
16875 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
16876 @code{long} type, and the infrastructure needed to support them.
16877 Specifying @option{-maix64} implies @option{-mpowerpc64} and
16878 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
16879 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
16880
16881 @item -mxl-compat
16882 @itemx -mno-xl-compat
16883 @opindex mxl-compat
16884 @opindex mno-xl-compat
16885 Produce code that conforms more closely to IBM XL compiler semantics
16886 when using AIX-compatible ABI@.  Pass floating-point arguments to
16887 prototyped functions beyond the register save area (RSA) on the stack
16888 in addition to argument FPRs.  Do not assume that most significant
16889 double in 128-bit long double value is properly rounded when comparing
16890 values and converting to double.  Use XL symbol names for long double
16891 support routines.
16892
16893 The AIX calling convention was extended but not initially documented to
16894 handle an obscure K&R C case of calling a function that takes the
16895 address of its arguments with fewer arguments than declared.  IBM XL
16896 compilers access floating-point arguments that do not fit in the
16897 RSA from the stack when a subroutine is compiled without
16898 optimization.  Because always storing floating-point arguments on the
16899 stack is inefficient and rarely needed, this option is not enabled by
16900 default and only is necessary when calling subroutines compiled by IBM
16901 XL compilers without optimization.
16902
16903 @item -mpe
16904 @opindex mpe
16905 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
16906 application written to use message passing with special startup code to
16907 enable the application to run.  The system must have PE installed in the
16908 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
16909 must be overridden with the @option{-specs=} option to specify the
16910 appropriate directory location.  The Parallel Environment does not
16911 support threads, so the @option{-mpe} option and the @option{-pthread}
16912 option are incompatible.
16913
16914 @item -malign-natural
16915 @itemx -malign-power
16916 @opindex malign-natural
16917 @opindex malign-power
16918 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
16919 @option{-malign-natural} overrides the ABI-defined alignment of larger
16920 types, such as floating-point doubles, on their natural size-based boundary.
16921 The option @option{-malign-power} instructs GCC to follow the ABI-specified
16922 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
16923
16924 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
16925 is not supported.
16926
16927 @item -msoft-float
16928 @itemx -mhard-float
16929 @opindex msoft-float
16930 @opindex mhard-float
16931 Generate code that does not use (uses) the floating-point register set.
16932 Software floating-point emulation is provided if you use the
16933 @option{-msoft-float} option, and pass the option to GCC when linking.
16934
16935 @item -msingle-float
16936 @itemx -mdouble-float
16937 @opindex msingle-float
16938 @opindex mdouble-float
16939 Generate code for single- or double-precision floating-point operations.
16940 @option{-mdouble-float} implies @option{-msingle-float}.
16941
16942 @item -msimple-fpu
16943 @opindex msimple-fpu
16944 Do not generate @code{sqrt} and @code{div} instructions for hardware
16945 floating-point unit.
16946
16947 @item -mfpu=@var{name}
16948 @opindex mfpu
16949 Specify type of floating-point unit.  Valid values for @var{name} are
16950 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
16951 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
16952 @samp{sp_full} (equivalent to @option{-msingle-float}),
16953 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
16954
16955 @item -mxilinx-fpu
16956 @opindex mxilinx-fpu
16957 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
16958
16959 @item -mmultiple
16960 @itemx -mno-multiple
16961 @opindex mmultiple
16962 @opindex mno-multiple
16963 Generate code that uses (does not use) the load multiple word
16964 instructions and the store multiple word instructions.  These
16965 instructions are generated by default on POWER systems, and not
16966 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
16967 PowerPC systems, since those instructions do not work when the
16968 processor is in little-endian mode.  The exceptions are PPC740 and
16969 PPC750 which permit these instructions in little-endian mode.
16970
16971 @item -mstring
16972 @itemx -mno-string
16973 @opindex mstring
16974 @opindex mno-string
16975 Generate code that uses (does not use) the load string instructions
16976 and the store string word instructions to save multiple registers and
16977 do small block moves.  These instructions are generated by default on
16978 POWER systems, and not generated on PowerPC systems.  Do not use
16979 @option{-mstring} on little-endian PowerPC systems, since those
16980 instructions do not work when the processor is in little-endian mode.
16981 The exceptions are PPC740 and PPC750 which permit these instructions
16982 in little-endian mode.
16983
16984 @item -mupdate
16985 @itemx -mno-update
16986 @opindex mupdate
16987 @opindex mno-update
16988 Generate code that uses (does not use) the load or store instructions
16989 that update the base register to the address of the calculated memory
16990 location.  These instructions are generated by default.  If you use
16991 @option{-mno-update}, there is a small window between the time that the
16992 stack pointer is updated and the address of the previous frame is
16993 stored, which means code that walks the stack frame across interrupts or
16994 signals may get corrupted data.
16995
16996 @item -mavoid-indexed-addresses
16997 @itemx -mno-avoid-indexed-addresses
16998 @opindex mavoid-indexed-addresses
16999 @opindex mno-avoid-indexed-addresses
17000 Generate code that tries to avoid (not avoid) the use of indexed load
17001 or store instructions. These instructions can incur a performance
17002 penalty on Power6 processors in certain situations, such as when
17003 stepping through large arrays that cross a 16M boundary.  This option
17004 is enabled by default when targeting Power6 and disabled otherwise.
17005
17006 @item -mfused-madd
17007 @itemx -mno-fused-madd
17008 @opindex mfused-madd
17009 @opindex mno-fused-madd
17010 Generate code that uses (does not use) the floating-point multiply and
17011 accumulate instructions.  These instructions are generated by default
17012 if hardware floating point is used.  The machine-dependent
17013 @option{-mfused-madd} option is now mapped to the machine-independent
17014 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
17015 mapped to @option{-ffp-contract=off}.
17016
17017 @item -mmulhw
17018 @itemx -mno-mulhw
17019 @opindex mmulhw
17020 @opindex mno-mulhw
17021 Generate code that uses (does not use) the half-word multiply and
17022 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
17023 These instructions are generated by default when targeting those
17024 processors.
17025
17026 @item -mdlmzb
17027 @itemx -mno-dlmzb
17028 @opindex mdlmzb
17029 @opindex mno-dlmzb
17030 Generate code that uses (does not use) the string-search @samp{dlmzb}
17031 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
17032 generated by default when targeting those processors.
17033
17034 @item -mno-bit-align
17035 @itemx -mbit-align
17036 @opindex mno-bit-align
17037 @opindex mbit-align
17038 On System V.4 and embedded PowerPC systems do not (do) force structures
17039 and unions that contain bit-fields to be aligned to the base type of the
17040 bit-field.
17041
17042 For example, by default a structure containing nothing but 8
17043 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
17044 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
17045 the structure is aligned to a 1-byte boundary and is 1 byte in
17046 size.
17047
17048 @item -mno-strict-align
17049 @itemx -mstrict-align
17050 @opindex mno-strict-align
17051 @opindex mstrict-align
17052 On System V.4 and embedded PowerPC systems do not (do) assume that
17053 unaligned memory references are handled by the system.
17054
17055 @item -mrelocatable
17056 @itemx -mno-relocatable
17057 @opindex mrelocatable
17058 @opindex mno-relocatable
17059 Generate code that allows (does not allow) a static executable to be
17060 relocated to a different address at run time.  A simple embedded
17061 PowerPC system loader should relocate the entire contents of
17062 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
17063 a table of 32-bit addresses generated by this option.  For this to
17064 work, all objects linked together must be compiled with
17065 @option{-mrelocatable} or @option{-mrelocatable-lib}.
17066 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
17067
17068 @item -mrelocatable-lib
17069 @itemx -mno-relocatable-lib
17070 @opindex mrelocatable-lib
17071 @opindex mno-relocatable-lib
17072 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
17073 @code{.fixup} section to allow static executables to be relocated at
17074 run time, but @option{-mrelocatable-lib} does not use the smaller stack
17075 alignment of @option{-mrelocatable}.  Objects compiled with
17076 @option{-mrelocatable-lib} may be linked with objects compiled with
17077 any combination of the @option{-mrelocatable} options.
17078
17079 @item -mno-toc
17080 @itemx -mtoc
17081 @opindex mno-toc
17082 @opindex mtoc
17083 On System V.4 and embedded PowerPC systems do not (do) assume that
17084 register 2 contains a pointer to a global area pointing to the addresses
17085 used in the program.
17086
17087 @item -mlittle
17088 @itemx -mlittle-endian
17089 @opindex mlittle
17090 @opindex mlittle-endian
17091 On System V.4 and embedded PowerPC systems compile code for the
17092 processor in little-endian mode.  The @option{-mlittle-endian} option is
17093 the same as @option{-mlittle}.
17094
17095 @item -mbig
17096 @itemx -mbig-endian
17097 @opindex mbig
17098 @opindex mbig-endian
17099 On System V.4 and embedded PowerPC systems compile code for the
17100 processor in big-endian mode.  The @option{-mbig-endian} option is
17101 the same as @option{-mbig}.
17102
17103 @item -mdynamic-no-pic
17104 @opindex mdynamic-no-pic
17105 On Darwin and Mac OS X systems, compile code so that it is not
17106 relocatable, but that its external references are relocatable.  The
17107 resulting code is suitable for applications, but not shared
17108 libraries.
17109
17110 @item -msingle-pic-base
17111 @opindex msingle-pic-base
17112 Treat the register used for PIC addressing as read-only, rather than
17113 loading it in the prologue for each function.  The runtime system is
17114 responsible for initializing this register with an appropriate value
17115 before execution begins.
17116
17117 @item -mprioritize-restricted-insns=@var{priority}
17118 @opindex mprioritize-restricted-insns
17119 This option controls the priority that is assigned to
17120 dispatch-slot restricted instructions during the second scheduling
17121 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
17122 or @samp{2} to assign no, highest, or second-highest (respectively) 
17123 priority to dispatch-slot restricted
17124 instructions.
17125
17126 @item -msched-costly-dep=@var{dependence_type}
17127 @opindex msched-costly-dep
17128 This option controls which dependences are considered costly
17129 by the target during instruction scheduling.  The argument
17130 @var{dependence_type} takes one of the following values:
17131
17132 @table @asis
17133 @item @samp{no}
17134 No dependence is costly.
17135
17136 @item @samp{all}
17137 All dependences are costly.
17138
17139 @item @samp{true_store_to_load}
17140 A true dependence from store to load is costly.
17141
17142 @item @samp{store_to_load}
17143 Any dependence from store to load is costly.
17144
17145 @item @var{number}
17146 Any dependence for which the latency is greater than or equal to 
17147 @var{number} is costly.
17148 @end table
17149
17150 @item -minsert-sched-nops=@var{scheme}
17151 @opindex minsert-sched-nops
17152 This option controls which NOP insertion scheme is used during
17153 the second scheduling pass.  The argument @var{scheme} takes one of the
17154 following values:
17155
17156 @table @asis
17157 @item @samp{no}
17158 Don't insert NOPs.
17159
17160 @item @samp{pad}
17161 Pad with NOPs any dispatch group that has vacant issue slots,
17162 according to the scheduler's grouping.
17163
17164 @item @samp{regroup_exact}
17165 Insert NOPs to force costly dependent insns into
17166 separate groups.  Insert exactly as many NOPs as needed to force an insn
17167 to a new group, according to the estimated processor grouping.
17168
17169 @item @var{number}
17170 Insert NOPs to force costly dependent insns into
17171 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
17172 @end table
17173
17174 @item -mcall-sysv
17175 @opindex mcall-sysv
17176 On System V.4 and embedded PowerPC systems compile code using calling
17177 conventions that adheres to the March 1995 draft of the System V
17178 Application Binary Interface, PowerPC processor supplement.  This is the
17179 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
17180
17181 @item -mcall-sysv-eabi
17182 @itemx -mcall-eabi
17183 @opindex mcall-sysv-eabi
17184 @opindex mcall-eabi
17185 Specify both @option{-mcall-sysv} and @option{-meabi} options.
17186
17187 @item -mcall-sysv-noeabi
17188 @opindex mcall-sysv-noeabi
17189 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
17190
17191 @item -mcall-aixdesc
17192 @opindex m
17193 On System V.4 and embedded PowerPC systems compile code for the AIX
17194 operating system.
17195
17196 @item -mcall-linux
17197 @opindex mcall-linux
17198 On System V.4 and embedded PowerPC systems compile code for the
17199 Linux-based GNU system.
17200
17201 @item -mcall-freebsd
17202 @opindex mcall-freebsd
17203 On System V.4 and embedded PowerPC systems compile code for the
17204 FreeBSD operating system.
17205
17206 @item -mcall-netbsd
17207 @opindex mcall-netbsd
17208 On System V.4 and embedded PowerPC systems compile code for the
17209 NetBSD operating system.
17210
17211 @item -mcall-openbsd
17212 @opindex mcall-netbsd
17213 On System V.4 and embedded PowerPC systems compile code for the
17214 OpenBSD operating system.
17215
17216 @item -maix-struct-return
17217 @opindex maix-struct-return
17218 Return all structures in memory (as specified by the AIX ABI)@.
17219
17220 @item -msvr4-struct-return
17221 @opindex msvr4-struct-return
17222 Return structures smaller than 8 bytes in registers (as specified by the
17223 SVR4 ABI)@.
17224
17225 @item -mabi=@var{abi-type}
17226 @opindex mabi
17227 Extend the current ABI with a particular extension, or remove such extension.
17228 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
17229 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
17230
17231 @item -mabi=spe
17232 @opindex mabi=spe
17233 Extend the current ABI with SPE ABI extensions.  This does not change
17234 the default ABI, instead it adds the SPE ABI extensions to the current
17235 ABI@.
17236
17237 @item -mabi=no-spe
17238 @opindex mabi=no-spe
17239 Disable Booke SPE ABI extensions for the current ABI@.
17240
17241 @item -mabi=ibmlongdouble
17242 @opindex mabi=ibmlongdouble
17243 Change the current ABI to use IBM extended-precision long double.
17244 This is a PowerPC 32-bit SYSV ABI option.
17245
17246 @item -mabi=ieeelongdouble
17247 @opindex mabi=ieeelongdouble
17248 Change the current ABI to use IEEE extended-precision long double.
17249 This is a PowerPC 32-bit Linux ABI option.
17250
17251 @item -mprototype
17252 @itemx -mno-prototype
17253 @opindex mprototype
17254 @opindex mno-prototype
17255 On System V.4 and embedded PowerPC systems assume that all calls to
17256 variable argument functions are properly prototyped.  Otherwise, the
17257 compiler must insert an instruction before every non prototyped call to
17258 set or clear bit 6 of the condition code register (@var{CR}) to
17259 indicate whether floating-point values are passed in the floating-point
17260 registers in case the function takes variable arguments.  With
17261 @option{-mprototype}, only calls to prototyped variable argument functions
17262 set or clear the bit.
17263
17264 @item -msim
17265 @opindex msim
17266 On embedded PowerPC systems, assume that the startup module is called
17267 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
17268 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
17269 configurations.
17270
17271 @item -mmvme
17272 @opindex mmvme
17273 On embedded PowerPC systems, assume that the startup module is called
17274 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
17275 @file{libc.a}.
17276
17277 @item -mads
17278 @opindex mads
17279 On embedded PowerPC systems, assume that the startup module is called
17280 @file{crt0.o} and the standard C libraries are @file{libads.a} and
17281 @file{libc.a}.
17282
17283 @item -myellowknife
17284 @opindex myellowknife
17285 On embedded PowerPC systems, assume that the startup module is called
17286 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
17287 @file{libc.a}.
17288
17289 @item -mvxworks
17290 @opindex mvxworks
17291 On System V.4 and embedded PowerPC systems, specify that you are
17292 compiling for a VxWorks system.
17293
17294 @item -memb
17295 @opindex memb
17296 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
17297 header to indicate that @samp{eabi} extended relocations are used.
17298
17299 @item -meabi
17300 @itemx -mno-eabi
17301 @opindex meabi
17302 @opindex mno-eabi
17303 On System V.4 and embedded PowerPC systems do (do not) adhere to the
17304 Embedded Applications Binary Interface (eabi) which is a set of
17305 modifications to the System V.4 specifications.  Selecting @option{-meabi}
17306 means that the stack is aligned to an 8-byte boundary, a function
17307 @code{__eabi} is called to from @code{main} to set up the eabi
17308 environment, and the @option{-msdata} option can use both @code{r2} and
17309 @code{r13} to point to two separate small data areas.  Selecting
17310 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
17311 do not call an initialization function from @code{main}, and the
17312 @option{-msdata} option only uses @code{r13} to point to a single
17313 small data area.  The @option{-meabi} option is on by default if you
17314 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
17315
17316 @item -msdata=eabi
17317 @opindex msdata=eabi
17318 On System V.4 and embedded PowerPC systems, put small initialized
17319 @code{const} global and static data in the @samp{.sdata2} section, which
17320 is pointed to by register @code{r2}.  Put small initialized
17321 non-@code{const} global and static data in the @samp{.sdata} section,
17322 which is pointed to by register @code{r13}.  Put small uninitialized
17323 global and static data in the @samp{.sbss} section, which is adjacent to
17324 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
17325 incompatible with the @option{-mrelocatable} option.  The
17326 @option{-msdata=eabi} option also sets the @option{-memb} option.
17327
17328 @item -msdata=sysv
17329 @opindex msdata=sysv
17330 On System V.4 and embedded PowerPC systems, put small global and static
17331 data in the @samp{.sdata} section, which is pointed to by register
17332 @code{r13}.  Put small uninitialized global and static data in the
17333 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
17334 The @option{-msdata=sysv} option is incompatible with the
17335 @option{-mrelocatable} option.
17336
17337 @item -msdata=default
17338 @itemx -msdata
17339 @opindex msdata=default
17340 @opindex msdata
17341 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
17342 compile code the same as @option{-msdata=eabi}, otherwise compile code the
17343 same as @option{-msdata=sysv}.
17344
17345 @item -msdata=data
17346 @opindex msdata=data
17347 On System V.4 and embedded PowerPC systems, put small global
17348 data in the @samp{.sdata} section.  Put small uninitialized global
17349 data in the @samp{.sbss} section.  Do not use register @code{r13}
17350 to address small data however.  This is the default behavior unless
17351 other @option{-msdata} options are used.
17352
17353 @item -msdata=none
17354 @itemx -mno-sdata
17355 @opindex msdata=none
17356 @opindex mno-sdata
17357 On embedded PowerPC systems, put all initialized global and static data
17358 in the @samp{.data} section, and all uninitialized data in the
17359 @samp{.bss} section.
17360
17361 @item -mblock-move-inline-limit=@var{num}
17362 @opindex mblock-move-inline-limit
17363 Inline all block moves (such as calls to @code{memcpy} or structure
17364 copies) less than or equal to @var{num} bytes.  The minimum value for
17365 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
17366 targets.  The default value is target-specific.
17367
17368 @item -G @var{num}
17369 @opindex G
17370 @cindex smaller data references (PowerPC)
17371 @cindex .sdata/.sdata2 references (PowerPC)
17372 On embedded PowerPC systems, put global and static items less than or
17373 equal to @var{num} bytes into the small data or bss sections instead of
17374 the normal data or bss section.  By default, @var{num} is 8.  The
17375 @option{-G @var{num}} switch is also passed to the linker.
17376 All modules should be compiled with the same @option{-G @var{num}} value.
17377
17378 @item -mregnames
17379 @itemx -mno-regnames
17380 @opindex mregnames
17381 @opindex mno-regnames
17382 On System V.4 and embedded PowerPC systems do (do not) emit register
17383 names in the assembly language output using symbolic forms.
17384
17385 @item -mlongcall
17386 @itemx -mno-longcall
17387 @opindex mlongcall
17388 @opindex mno-longcall
17389 By default assume that all calls are far away so that a longer more
17390 expensive calling sequence is required.  This is required for calls
17391 further than 32 megabytes (33,554,432 bytes) from the current location.
17392 A short call is generated if the compiler knows
17393 the call cannot be that far away.  This setting can be overridden by
17394 the @code{shortcall} function attribute, or by @code{#pragma
17395 longcall(0)}.
17396
17397 Some linkers are capable of detecting out-of-range calls and generating
17398 glue code on the fly.  On these systems, long calls are unnecessary and
17399 generate slower code.  As of this writing, the AIX linker can do this,
17400 as can the GNU linker for PowerPC/64.  It is planned to add this feature
17401 to the GNU linker for 32-bit PowerPC systems as well.
17402
17403 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
17404 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
17405 addresses represent the callee and the branch island.  The
17406 Darwin/PPC linker prefers the first address and generates a @code{bl
17407 callee} if the PPC @code{bl} instruction reaches the callee directly;
17408 otherwise, the linker generates @code{bl L42} to call the branch
17409 island.  The branch island is appended to the body of the
17410 calling function; it computes the full 32-bit address of the callee
17411 and jumps to it.
17412
17413 On Mach-O (Darwin) systems, this option directs the compiler emit to
17414 the glue for every direct call, and the Darwin linker decides whether
17415 to use or discard it.
17416
17417 In the future, GCC may ignore all longcall specifications
17418 when the linker is known to generate glue.
17419
17420 @item -mtls-markers
17421 @itemx -mno-tls-markers
17422 @opindex mtls-markers
17423 @opindex mno-tls-markers
17424 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
17425 specifying the function argument.  The relocation allows the linker to
17426 reliably associate function call with argument setup instructions for
17427 TLS optimization, which in turn allows GCC to better schedule the
17428 sequence.
17429
17430 @item -pthread
17431 @opindex pthread
17432 Adds support for multithreading with the @dfn{pthreads} library.
17433 This option sets flags for both the preprocessor and linker.
17434
17435 @item -mrecip
17436 @itemx -mno-recip
17437 @opindex mrecip
17438 This option enables use of the reciprocal estimate and
17439 reciprocal square root estimate instructions with additional
17440 Newton-Raphson steps to increase precision instead of doing a divide or
17441 square root and divide for floating-point arguments.  You should use
17442 the @option{-ffast-math} option when using @option{-mrecip} (or at
17443 least @option{-funsafe-math-optimizations},
17444 @option{-finite-math-only}, @option{-freciprocal-math} and
17445 @option{-fno-trapping-math}).  Note that while the throughput of the
17446 sequence is generally higher than the throughput of the non-reciprocal
17447 instruction, the precision of the sequence can be decreased by up to 2
17448 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
17449 roots.
17450
17451 @item -mrecip=@var{opt}
17452 @opindex mrecip=opt
17453 This option allows to control which reciprocal estimate instructions
17454 may be used.  @var{opt} is a comma separated list of options, which may
17455 be preceded by a @code{!} to invert the option:
17456 @code{all}: enable all estimate instructions,
17457 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
17458 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
17459 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
17460 @code{divf}: enable the single-precision reciprocal approximation instructions;
17461 @code{divd}: enable the double-precision reciprocal approximation instructions;
17462 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
17463 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
17464 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
17465
17466 So, for example, @option{-mrecip=all,!rsqrtd} enables
17467 all of the reciprocal estimate instructions, except for the
17468 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
17469 which handle the double-precision reciprocal square root calculations.
17470
17471 @item -mrecip-precision
17472 @itemx -mno-recip-precision
17473 @opindex mrecip-precision
17474 Assume (do not assume) that the reciprocal estimate instructions
17475 provide higher-precision estimates than is mandated by the PowerPC
17476 ABI.  Selecting @option{-mcpu=power6} or @option{-mcpu=power7}
17477 automatically selects @option{-mrecip-precision}.  The double-precision 
17478 square root estimate instructions are not generated by
17479 default on low-precision machines, since they do not provide an
17480 estimate that converges after three steps.
17481
17482 @item -mveclibabi=@var{type}
17483 @opindex mveclibabi
17484 Specifies the ABI type to use for vectorizing intrinsics using an
17485 external library.  The only type supported at present is @code{mass},
17486 which specifies to use IBM's Mathematical Acceleration Subsystem
17487 (MASS) libraries for vectorizing intrinsics using external libraries.
17488 GCC currently emits calls to @code{acosd2}, @code{acosf4},
17489 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
17490 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
17491 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
17492 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
17493 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
17494 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
17495 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
17496 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
17497 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
17498 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
17499 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
17500 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
17501 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
17502 for power7.  Both @option{-ftree-vectorize} and
17503 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
17504 libraries must be specified at link time.
17505
17506 @item -mfriz
17507 @itemx -mno-friz
17508 @opindex mfriz
17509 Generate (do not generate) the @code{friz} instruction when the
17510 @option{-funsafe-math-optimizations} option is used to optimize
17511 rounding of floating-point values to 64-bit integer and back to floating
17512 point.  The @code{friz} instruction does not return the same value if
17513 the floating-point number is too large to fit in an integer.
17514
17515 @item -mpointers-to-nested-functions
17516 @itemx -mno-pointers-to-nested-functions
17517 @opindex mpointers-to-nested-functions
17518 Generate (do not generate) code to load up the static chain register
17519 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
17520 systems where a function pointer points to a 3-word descriptor giving
17521 the function address, TOC value to be loaded in register @var{r2}, and
17522 static chain value to be loaded in register @var{r11}.  The
17523 @option{-mpointers-to-nested-functions} is on by default.  You cannot
17524 call through pointers to nested functions or pointers
17525 to functions compiled in other languages that use the static chain if
17526 you use the @option{-mno-pointers-to-nested-functions}.
17527
17528 @item -msave-toc-indirect
17529 @itemx -mno-save-toc-indirect
17530 @opindex msave-toc-indirect
17531 Generate (do not generate) code to save the TOC value in the reserved
17532 stack location in the function prologue if the function calls through
17533 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
17534 saved in the prologue, it is saved just before the call through the
17535 pointer.  The @option{-mno-save-toc-indirect} option is the default.
17536 @end table
17537
17538 @node RX Options
17539 @subsection RX Options
17540 @cindex RX Options
17541
17542 These command-line options are defined for RX targets:
17543
17544 @table @gcctabopt
17545 @item -m64bit-doubles
17546 @itemx -m32bit-doubles
17547 @opindex m64bit-doubles
17548 @opindex m32bit-doubles
17549 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
17550 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
17551 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
17552 works on 32-bit values, which is why the default is
17553 @option{-m32bit-doubles}.
17554
17555 @item -fpu
17556 @itemx -nofpu
17557 @opindex fpu
17558 @opindex nofpu
17559 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
17560 floating-point hardware.  The default is enabled for the @var{RX600}
17561 series and disabled for the @var{RX200} series.
17562
17563 Floating-point instructions are only generated for 32-bit floating-point 
17564 values, however, so the FPU hardware is not used for doubles if the
17565 @option{-m64bit-doubles} option is used.
17566
17567 @emph{Note} If the @option{-fpu} option is enabled then
17568 @option{-funsafe-math-optimizations} is also enabled automatically.
17569 This is because the RX FPU instructions are themselves unsafe.
17570
17571 @item -mcpu=@var{name}
17572 @opindex -mcpu
17573 Selects the type of RX CPU to be targeted.  Currently three types are
17574 supported, the generic @var{RX600} and @var{RX200} series hardware and
17575 the specific @var{RX610} CPU.  The default is @var{RX600}.
17576
17577 The only difference between @var{RX600} and @var{RX610} is that the
17578 @var{RX610} does not support the @code{MVTIPL} instruction.
17579
17580 The @var{RX200} series does not have a hardware floating-point unit
17581 and so @option{-nofpu} is enabled by default when this type is
17582 selected.
17583
17584 @item -mbig-endian-data
17585 @itemx -mlittle-endian-data
17586 @opindex mbig-endian-data
17587 @opindex mlittle-endian-data
17588 Store data (but not code) in the big-endian format.  The default is
17589 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
17590 format.
17591
17592 @item -msmall-data-limit=@var{N}
17593 @opindex msmall-data-limit
17594 Specifies the maximum size in bytes of global and static variables
17595 which can be placed into the small data area.  Using the small data
17596 area can lead to smaller and faster code, but the size of area is
17597 limited and it is up to the programmer to ensure that the area does
17598 not overflow.  Also when the small data area is used one of the RX's
17599 registers (usually @code{r13}) is reserved for use pointing to this
17600 area, so it is no longer available for use by the compiler.  This
17601 could result in slower and/or larger code if variables are pushed onto
17602 the stack instead of being held in this register.
17603
17604 Note, common variables (variables that have not been initialized) and
17605 constants are not placed into the small data area as they are assigned
17606 to other sections in the output executable.
17607
17608 The default value is zero, which disables this feature.  Note, this
17609 feature is not enabled by default with higher optimization levels
17610 (@option{-O2} etc) because of the potentially detrimental effects of
17611 reserving a register.  It is up to the programmer to experiment and
17612 discover whether this feature is of benefit to their program.  See the
17613 description of the @option{-mpid} option for a description of how the
17614 actual register to hold the small data area pointer is chosen.
17615
17616 @item -msim
17617 @itemx -mno-sim
17618 @opindex msim
17619 @opindex mno-sim
17620 Use the simulator runtime.  The default is to use the libgloss board
17621 specific runtime.
17622
17623 @item -mas100-syntax
17624 @itemx -mno-as100-syntax
17625 @opindex mas100-syntax
17626 @opindex mno-as100-syntax
17627 When generating assembler output use a syntax that is compatible with
17628 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
17629 assembler but it has some restrictions so generating it is not the
17630 default option.
17631
17632 @item -mmax-constant-size=@var{N}
17633 @opindex mmax-constant-size
17634 Specifies the maximum size, in bytes, of a constant that can be used as
17635 an operand in a RX instruction.  Although the RX instruction set does
17636 allow constants of up to 4 bytes in length to be used in instructions,
17637 a longer value equates to a longer instruction.  Thus in some
17638 circumstances it can be beneficial to restrict the size of constants
17639 that are used in instructions.  Constants that are too big are instead
17640 placed into a constant pool and referenced via register indirection.
17641
17642 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
17643 or 4 means that constants of any size are allowed.
17644
17645 @item -mrelax
17646 @opindex mrelax
17647 Enable linker relaxation.  Linker relaxation is a process whereby the
17648 linker attempts to reduce the size of a program by finding shorter
17649 versions of various instructions.  Disabled by default.
17650
17651 @item -mint-register=@var{N}
17652 @opindex mint-register
17653 Specify the number of registers to reserve for fast interrupt handler
17654 functions.  The value @var{N} can be between 0 and 4.  A value of 1
17655 means that register @code{r13} is reserved for the exclusive use
17656 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
17657 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
17658 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
17659 A value of 0, the default, does not reserve any registers.
17660
17661 @item -msave-acc-in-interrupts
17662 @opindex msave-acc-in-interrupts
17663 Specifies that interrupt handler functions should preserve the
17664 accumulator register.  This is only necessary if normal code might use
17665 the accumulator register, for example because it performs 64-bit
17666 multiplications.  The default is to ignore the accumulator as this
17667 makes the interrupt handlers faster.
17668
17669 @item -mpid
17670 @itemx -mno-pid
17671 @opindex mpid
17672 @opindex mno-pid
17673 Enables the generation of position independent data.  When enabled any
17674 access to constant data is done via an offset from a base address
17675 held in a register.  This allows the location of constant data to be
17676 determined at run time without requiring the executable to be
17677 relocated, which is a benefit to embedded applications with tight
17678 memory constraints.  Data that can be modified is not affected by this
17679 option.
17680
17681 Note, using this feature reserves a register, usually @code{r13}, for
17682 the constant data base address.  This can result in slower and/or
17683 larger code, especially in complicated functions.
17684
17685 The actual register chosen to hold the constant data base address
17686 depends upon whether the @option{-msmall-data-limit} and/or the
17687 @option{-mint-register} command-line options are enabled.  Starting
17688 with register @code{r13} and proceeding downwards, registers are
17689 allocated first to satisfy the requirements of @option{-mint-register},
17690 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
17691 is possible for the small data area register to be @code{r8} if both
17692 @option{-mint-register=4} and @option{-mpid} are specified on the
17693 command line.
17694
17695 By default this feature is not enabled.  The default can be restored
17696 via the @option{-mno-pid} command-line option.
17697
17698 @end table
17699
17700 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
17701 has special significance to the RX port when used with the
17702 @code{interrupt} function attribute.  This attribute indicates a
17703 function intended to process fast interrupts.  GCC ensures
17704 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
17705 and/or @code{r13} and only provided that the normal use of the
17706 corresponding registers have been restricted via the
17707 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
17708 options.
17709
17710 @node S/390 and zSeries Options
17711 @subsection S/390 and zSeries Options
17712 @cindex S/390 and zSeries Options
17713
17714 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
17715
17716 @table @gcctabopt
17717 @item -mhard-float
17718 @itemx -msoft-float
17719 @opindex mhard-float
17720 @opindex msoft-float
17721 Use (do not use) the hardware floating-point instructions and registers
17722 for floating-point operations.  When @option{-msoft-float} is specified,
17723 functions in @file{libgcc.a} are used to perform floating-point
17724 operations.  When @option{-mhard-float} is specified, the compiler
17725 generates IEEE floating-point instructions.  This is the default.
17726
17727 @item -mhard-dfp
17728 @itemx -mno-hard-dfp
17729 @opindex mhard-dfp
17730 @opindex mno-hard-dfp
17731 Use (do not use) the hardware decimal-floating-point instructions for
17732 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
17733 specified, functions in @file{libgcc.a} are used to perform
17734 decimal-floating-point operations.  When @option{-mhard-dfp} is
17735 specified, the compiler generates decimal-floating-point hardware
17736 instructions.  This is the default for @option{-march=z9-ec} or higher.
17737
17738 @item -mlong-double-64
17739 @itemx -mlong-double-128
17740 @opindex mlong-double-64
17741 @opindex mlong-double-128
17742 These switches control the size of @code{long double} type. A size
17743 of 64 bits makes the @code{long double} type equivalent to the @code{double}
17744 type. This is the default.
17745
17746 @item -mbackchain
17747 @itemx -mno-backchain
17748 @opindex mbackchain
17749 @opindex mno-backchain
17750 Store (do not store) the address of the caller's frame as backchain pointer
17751 into the callee's stack frame.
17752 A backchain may be needed to allow debugging using tools that do not understand
17753 DWARF 2 call frame information.
17754 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
17755 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
17756 the backchain is placed into the topmost word of the 96/160 byte register
17757 save area.
17758
17759 In general, code compiled with @option{-mbackchain} is call-compatible with
17760 code compiled with @option{-mmo-backchain}; however, use of the backchain
17761 for debugging purposes usually requires that the whole binary is built with
17762 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
17763 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17764 to build a linux kernel use @option{-msoft-float}.
17765
17766 The default is to not maintain the backchain.
17767
17768 @item -mpacked-stack
17769 @itemx -mno-packed-stack
17770 @opindex mpacked-stack
17771 @opindex mno-packed-stack
17772 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
17773 specified, the compiler uses the all fields of the 96/160 byte register save
17774 area only for their default purpose; unused fields still take up stack space.
17775 When @option{-mpacked-stack} is specified, register save slots are densely
17776 packed at the top of the register save area; unused space is reused for other
17777 purposes, allowing for more efficient use of the available stack space.
17778 However, when @option{-mbackchain} is also in effect, the topmost word of
17779 the save area is always used to store the backchain, and the return address
17780 register is always saved two words below the backchain.
17781
17782 As long as the stack frame backchain is not used, code generated with
17783 @option{-mpacked-stack} is call-compatible with code generated with
17784 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
17785 S/390 or zSeries generated code that uses the stack frame backchain at run
17786 time, not just for debugging purposes.  Such code is not call-compatible
17787 with code compiled with @option{-mpacked-stack}.  Also, note that the
17788 combination of @option{-mbackchain},
17789 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
17790 to build a linux kernel use @option{-msoft-float}.
17791
17792 The default is to not use the packed stack layout.
17793
17794 @item -msmall-exec
17795 @itemx -mno-small-exec
17796 @opindex msmall-exec
17797 @opindex mno-small-exec
17798 Generate (or do not generate) code using the @code{bras} instruction
17799 to do subroutine calls.
17800 This only works reliably if the total executable size does not
17801 exceed 64k.  The default is to use the @code{basr} instruction instead,
17802 which does not have this limitation.
17803
17804 @item -m64
17805 @itemx -m31
17806 @opindex m64
17807 @opindex m31
17808 When @option{-m31} is specified, generate code compliant to the
17809 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
17810 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
17811 particular to generate 64-bit instructions.  For the @samp{s390}
17812 targets, the default is @option{-m31}, while the @samp{s390x}
17813 targets default to @option{-m64}.
17814
17815 @item -mzarch
17816 @itemx -mesa
17817 @opindex mzarch
17818 @opindex mesa
17819 When @option{-mzarch} is specified, generate code using the
17820 instructions available on z/Architecture.
17821 When @option{-mesa} is specified, generate code using the
17822 instructions available on ESA/390.  Note that @option{-mesa} is
17823 not possible with @option{-m64}.
17824 When generating code compliant to the GNU/Linux for S/390 ABI,
17825 the default is @option{-mesa}.  When generating code compliant
17826 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
17827
17828 @item -mmvcle
17829 @itemx -mno-mvcle
17830 @opindex mmvcle
17831 @opindex mno-mvcle
17832 Generate (or do not generate) code using the @code{mvcle} instruction
17833 to perform block moves.  When @option{-mno-mvcle} is specified,
17834 use a @code{mvc} loop instead.  This is the default unless optimizing for
17835 size.
17836
17837 @item -mdebug
17838 @itemx -mno-debug
17839 @opindex mdebug
17840 @opindex mno-debug
17841 Print (or do not print) additional debug information when compiling.
17842 The default is to not print debug information.
17843
17844 @item -march=@var{cpu-type}
17845 @opindex march
17846 Generate code that runs on @var{cpu-type}, which is the name of a system
17847 representing a certain processor type.  Possible values for
17848 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
17849 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
17850 When generating code using the instructions available on z/Architecture,
17851 the default is @option{-march=z900}.  Otherwise, the default is
17852 @option{-march=g5}.
17853
17854 @item -mtune=@var{cpu-type}
17855 @opindex mtune
17856 Tune to @var{cpu-type} everything applicable about the generated code,
17857 except for the ABI and the set of available instructions.
17858 The list of @var{cpu-type} values is the same as for @option{-march}.
17859 The default is the value used for @option{-march}.
17860
17861 @item -mtpf-trace
17862 @itemx -mno-tpf-trace
17863 @opindex mtpf-trace
17864 @opindex mno-tpf-trace
17865 Generate code that adds (does not add) in TPF OS specific branches to trace
17866 routines in the operating system.  This option is off by default, even
17867 when compiling for the TPF OS@.
17868
17869 @item -mfused-madd
17870 @itemx -mno-fused-madd
17871 @opindex mfused-madd
17872 @opindex mno-fused-madd
17873 Generate code that uses (does not use) the floating-point multiply and
17874 accumulate instructions.  These instructions are generated by default if
17875 hardware floating point is used.
17876
17877 @item -mwarn-framesize=@var{framesize}
17878 @opindex mwarn-framesize
17879 Emit a warning if the current function exceeds the given frame size.  Because
17880 this is a compile-time check it doesn't need to be a real problem when the program
17881 runs.  It is intended to identify functions that most probably cause
17882 a stack overflow.  It is useful to be used in an environment with limited stack
17883 size e.g.@: the linux kernel.
17884
17885 @item -mwarn-dynamicstack
17886 @opindex mwarn-dynamicstack
17887 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
17888 arrays.  This is generally a bad idea with a limited stack size.
17889
17890 @item -mstack-guard=@var{stack-guard}
17891 @itemx -mstack-size=@var{stack-size}
17892 @opindex mstack-guard
17893 @opindex mstack-size
17894 If these options are provided the s390 back end emits additional instructions in
17895 the function prologue which trigger a trap if the stack size is @var{stack-guard}
17896 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
17897 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
17898 the frame size of the compiled function is chosen.
17899 These options are intended to be used to help debugging stack overflow problems.
17900 The additionally emitted code causes only little overhead and hence can also be
17901 used in production like systems without greater performance degradation.  The given
17902 values have to be exact powers of 2 and @var{stack-size} has to be greater than
17903 @var{stack-guard} without exceeding 64k.
17904 In order to be efficient the extra code makes the assumption that the stack starts
17905 at an address aligned to the value given by @var{stack-size}.
17906 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
17907 @end table
17908
17909 @node Score Options
17910 @subsection Score Options
17911 @cindex Score Options
17912
17913 These options are defined for Score implementations:
17914
17915 @table @gcctabopt
17916 @item -meb
17917 @opindex meb
17918 Compile code for big-endian mode.  This is the default.
17919
17920 @item -mel
17921 @opindex mel
17922 Compile code for little-endian mode.
17923
17924 @item -mnhwloop
17925 @opindex mnhwloop
17926 Disable generate bcnz instruction.
17927
17928 @item -muls
17929 @opindex muls
17930 Enable generate unaligned load and store instruction.
17931
17932 @item -mmac
17933 @opindex mmac
17934 Enable the use of multiply-accumulate instructions. Disabled by default.
17935
17936 @item -mscore5
17937 @opindex mscore5
17938 Specify the SCORE5 as the target architecture.
17939
17940 @item -mscore5u
17941 @opindex mscore5u
17942 Specify the SCORE5U of the target architecture.
17943
17944 @item -mscore7
17945 @opindex mscore7
17946 Specify the SCORE7 as the target architecture. This is the default.
17947
17948 @item -mscore7d
17949 @opindex mscore7d
17950 Specify the SCORE7D as the target architecture.
17951 @end table
17952
17953 @node SH Options
17954 @subsection SH Options
17955
17956 These @samp{-m} options are defined for the SH implementations:
17957
17958 @table @gcctabopt
17959 @item -m1
17960 @opindex m1
17961 Generate code for the SH1.
17962
17963 @item -m2
17964 @opindex m2
17965 Generate code for the SH2.
17966
17967 @item -m2e
17968 Generate code for the SH2e.
17969
17970 @item -m2a-nofpu
17971 @opindex m2a-nofpu
17972 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
17973 that the floating-point unit is not used.
17974
17975 @item -m2a-single-only
17976 @opindex m2a-single-only
17977 Generate code for the SH2a-FPU, in such a way that no double-precision
17978 floating-point operations are used.
17979
17980 @item -m2a-single
17981 @opindex m2a-single
17982 Generate code for the SH2a-FPU assuming the floating-point unit is in
17983 single-precision mode by default.
17984
17985 @item -m2a
17986 @opindex m2a
17987 Generate code for the SH2a-FPU assuming the floating-point unit is in
17988 double-precision mode by default.
17989
17990 @item -m3
17991 @opindex m3
17992 Generate code for the SH3.
17993
17994 @item -m3e
17995 @opindex m3e
17996 Generate code for the SH3e.
17997
17998 @item -m4-nofpu
17999 @opindex m4-nofpu
18000 Generate code for the SH4 without a floating-point unit.
18001
18002 @item -m4-single-only
18003 @opindex m4-single-only
18004 Generate code for the SH4 with a floating-point unit that only
18005 supports single-precision arithmetic.
18006
18007 @item -m4-single
18008 @opindex m4-single
18009 Generate code for the SH4 assuming the floating-point unit is in
18010 single-precision mode by default.
18011
18012 @item -m4
18013 @opindex m4
18014 Generate code for the SH4.
18015
18016 @item -m4a-nofpu
18017 @opindex m4a-nofpu
18018 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
18019 floating-point unit is not used.
18020
18021 @item -m4a-single-only
18022 @opindex m4a-single-only
18023 Generate code for the SH4a, in such a way that no double-precision
18024 floating-point operations are used.
18025
18026 @item -m4a-single
18027 @opindex m4a-single
18028 Generate code for the SH4a assuming the floating-point unit is in
18029 single-precision mode by default.
18030
18031 @item -m4a
18032 @opindex m4a
18033 Generate code for the SH4a.
18034
18035 @item -m4al
18036 @opindex m4al
18037 Same as @option{-m4a-nofpu}, except that it implicitly passes
18038 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
18039 instructions at the moment.
18040
18041 @item -mb
18042 @opindex mb
18043 Compile code for the processor in big-endian mode.
18044
18045 @item -ml
18046 @opindex ml
18047 Compile code for the processor in little-endian mode.
18048
18049 @item -mdalign
18050 @opindex mdalign
18051 Align doubles at 64-bit boundaries.  Note that this changes the calling
18052 conventions, and thus some functions from the standard C library do
18053 not work unless you recompile it first with @option{-mdalign}.
18054
18055 @item -mrelax
18056 @opindex mrelax
18057 Shorten some address references at link time, when possible; uses the
18058 linker option @option{-relax}.
18059
18060 @item -mbigtable
18061 @opindex mbigtable
18062 Use 32-bit offsets in @code{switch} tables.  The default is to use
18063 16-bit offsets.
18064
18065 @item -mbitops
18066 @opindex mbitops
18067 Enable the use of bit manipulation instructions on SH2A.
18068
18069 @item -mfmovd
18070 @opindex mfmovd
18071 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
18072 alignment constraints.
18073
18074 @item -mhitachi
18075 @opindex mhitachi
18076 Comply with the calling conventions defined by Renesas.
18077
18078 @item -mrenesas
18079 @opindex mhitachi
18080 Comply with the calling conventions defined by Renesas.
18081
18082 @item -mno-renesas
18083 @opindex mhitachi
18084 Comply with the calling conventions defined for GCC before the Renesas
18085 conventions were available.  This option is the default for all
18086 targets of the SH toolchain.
18087
18088 @item -mnomacsave
18089 @opindex mnomacsave
18090 Mark the @code{MAC} register as call-clobbered, even if
18091 @option{-mhitachi} is given.
18092
18093 @item -mieee
18094 @opindex mieee
18095 Increase IEEE compliance of floating-point code.
18096 At the moment, this is equivalent to @option{-fno-finite-math-only}.
18097 When generating 16-bit SH opcodes, getting IEEE-conforming results for
18098 comparisons of NANs / infinities incurs extra overhead in every
18099 floating-point comparison, therefore the default is set to
18100 @option{-ffinite-math-only}.
18101
18102 @item -minline-ic_invalidate
18103 @opindex minline-ic_invalidate
18104 Inline code to invalidate instruction cache entries after setting up
18105 nested function trampolines.
18106 This option has no effect if @option{-musermode} is in effect and the selected
18107 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
18108 instruction.
18109 If the selected code generation option does not allow the use of the @code{icbi}
18110 instruction, and @option{-musermode} is not in effect, the inlined code
18111 manipulates the instruction cache address array directly with an associative
18112 write.  This not only requires privileged mode at run time, but it also
18113 fails if the cache line had been mapped via the TLB and has become unmapped.
18114
18115 @item -misize
18116 @opindex misize
18117 Dump instruction size and location in the assembly code.
18118
18119 @item -mpadstruct
18120 @opindex mpadstruct
18121 This option is deprecated.  It pads structures to multiple of 4 bytes,
18122 which is incompatible with the SH ABI@.
18123
18124 @item -msoft-atomic
18125 @opindex msoft-atomic
18126 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
18127 built-in functions.  The generated atomic sequences require support from the 
18128 interrupt / exception handling code of the system and are only suitable for
18129 single-core systems.  They will not operate correctly on multi-core systems.
18130 This option is enabled by default when the target is @code{sh-*-linux*}.
18131 When the target is SH4A, this option will also partially utilize the hardware
18132 atomic instructions @code{movli.l} and @code{movco.l} to create more
18133 efficient code.
18134 For details on the atomic built-in functions see @ref{__atomic Builtins}.
18135
18136 @item -mhard-atomic
18137 @opindex hard-atomic
18138 Generate hardware atomic sequences for the atomic built-in functions.  This
18139 is only available on SH4A and is suitable for multi-core systems.  Code
18140 compiled with this option will also be compatible with gUSA aware
18141 interrupt / exception handling systems.  In contrast to the
18142 @option{-msoft-atomic} option this will only use the instructions
18143 @code{movli.l} and @code{movco.l} to create atomic sequences.
18144
18145 @item -menable-tas
18146 @opindex menable-tas
18147 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
18148 Notice that depending on the particular hardware and software configuration
18149 this can degrade overall performance due to the operand cache line flushes
18150 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
18151 processors the @code{tas.b} instruction must be used with caution since it
18152 can result in data corruption for certain cache configurations.
18153
18154 @item -mspace
18155 @opindex mspace
18156 Optimize for space instead of speed.  Implied by @option{-Os}.
18157
18158 @item -mprefergot
18159 @opindex mprefergot
18160 When generating position-independent code, emit function calls using
18161 the Global Offset Table instead of the Procedure Linkage Table.
18162
18163 @item -musermode
18164 @opindex musermode
18165 Don't generate privileged mode only code.  This option
18166 implies @option{-mno-inline-ic_invalidate}
18167 if the inlined code would not work in user mode.
18168 This is the default when the target is @code{sh-*-linux*}.
18169
18170 @item -multcost=@var{number}
18171 @opindex multcost=@var{number}
18172 Set the cost to assume for a multiply insn.
18173
18174 @item -mdiv=@var{strategy}
18175 @opindex mdiv=@var{strategy}
18176 Set the division strategy to use for SHmedia code.  @var{strategy} must be
18177 one of: 
18178
18179 @table @samp
18180
18181 @item fp 
18182 Performs the operation in floating point.  This has a very high latency,
18183 but needs only a few instructions, so it might be a good choice if
18184 your code has enough easily-exploitable ILP to allow the compiler to
18185 schedule the floating-point instructions together with other instructions.
18186 Division by zero causes a floating-point exception.
18187
18188 @item inv
18189 Uses integer operations to calculate the inverse of the divisor,
18190 and then multiplies the dividend with the inverse.  This strategy allows
18191 CSE and hoisting of the inverse calculation.  Division by zero calculates
18192 an unspecified result, but does not trap.
18193
18194 @item inv:minlat
18195 A variant of @samp{inv} where, if no CSE or hoisting opportunities
18196 have been found, or if the entire operation has been hoisted to the same
18197 place, the last stages of the inverse calculation are intertwined with the
18198 final multiply to reduce the overall latency, at the expense of using a few
18199 more instructions, and thus offering fewer scheduling opportunities with
18200 other code.
18201
18202 @item call
18203 Calls a library function that usually implements the @samp{inv:minlat}
18204 strategy.
18205 This gives high code density for @code{m5-*media-nofpu} compilations.
18206
18207 @item call2
18208 Uses a different entry point of the same library function, where it
18209 assumes that a pointer to a lookup table has already been set up, which
18210 exposes the pointer load to CSE and code hoisting optimizations.
18211
18212 @item inv:call
18213 @itemx inv:call2
18214 @itemx inv:fp
18215 Use the @samp{inv} algorithm for initial
18216 code generation, but if the code stays unoptimized, revert to the @samp{call},
18217 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
18218 potentially-trapping side effect of division by zero is carried by a
18219 separate instruction, so it is possible that all the integer instructions
18220 are hoisted out, but the marker for the side effect stays where it is.
18221 A recombination to floating-point operations or a call is not possible
18222 in that case.
18223
18224 @item inv20u
18225 @itemx inv20l
18226 Variants of the @samp{inv:minlat} strategy.  In the case
18227 that the inverse calculation is not separated from the multiply, they speed
18228 up division where the dividend fits into 20 bits (plus sign where applicable)
18229 by inserting a test to skip a number of operations in this case; this test
18230 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
18231 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
18232
18233 @end table
18234
18235 @item -maccumulate-outgoing-args
18236 @opindex maccumulate-outgoing-args
18237 Reserve space once for outgoing arguments in the function prologue rather
18238 than around each call.  Generally beneficial for performance and size.  Also
18239 needed for unwinding to avoid changing the stack frame around conditional code.
18240
18241 @item -mdivsi3_libfunc=@var{name}
18242 @opindex mdivsi3_libfunc=@var{name}
18243 Set the name of the library function used for 32-bit signed division to
18244 @var{name}.
18245 This only affects the name used in the @samp{call} and @samp{inv:call}
18246 division strategies, and the compiler still expects the same
18247 sets of input/output/clobbered registers as if this option were not present.
18248
18249 @item -mfixed-range=@var{register-range}
18250 @opindex mfixed-range
18251 Generate code treating the given register range as fixed registers.
18252 A fixed register is one that the register allocator can not use.  This is
18253 useful when compiling kernel code.  A register range is specified as
18254 two registers separated by a dash.  Multiple register ranges can be
18255 specified separated by a comma.
18256
18257 @item -mindexed-addressing
18258 @opindex mindexed-addressing
18259 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
18260 This is only safe if the hardware and/or OS implement 32-bit wrap-around
18261 semantics for the indexed addressing mode.  The architecture allows the
18262 implementation of processors with 64-bit MMU, which the OS could use to
18263 get 32-bit addressing, but since no current hardware implementation supports
18264 this or any other way to make the indexed addressing mode safe to use in
18265 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
18266
18267 @item -mgettrcost=@var{number}
18268 @opindex mgettrcost=@var{number}
18269 Set the cost assumed for the @code{gettr} instruction to @var{number}.
18270 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
18271
18272 @item -mpt-fixed
18273 @opindex mpt-fixed
18274 Assume @code{pt*} instructions won't trap.  This generally generates
18275 better-scheduled code, but is unsafe on current hardware.
18276 The current architecture
18277 definition says that @code{ptabs} and @code{ptrel} trap when the target 
18278 anded with 3 is 3.
18279 This has the unintentional effect of making it unsafe to schedule these
18280 instructions before a branch, or hoist them out of a loop.  For example,
18281 @code{__do_global_ctors}, a part of @file{libgcc}
18282 that runs constructors at program
18283 startup, calls functions in a list which is delimited by @minus{}1.  With the
18284 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
18285 That means that all the constructors run a bit more quickly, but when
18286 the loop comes to the end of the list, the program crashes because @code{ptabs}
18287 loads @minus{}1 into a target register.  
18288
18289 Since this option is unsafe for any
18290 hardware implementing the current architecture specification, the default
18291 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
18292 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
18293 this deters register allocation from using target registers for storing
18294 ordinary integers.
18295
18296 @item -minvalid-symbols
18297 @opindex minvalid-symbols
18298 Assume symbols might be invalid.  Ordinary function symbols generated by
18299 the compiler are always valid to load with
18300 @code{movi}/@code{shori}/@code{ptabs} or
18301 @code{movi}/@code{shori}/@code{ptrel},
18302 but with assembler and/or linker tricks it is possible
18303 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
18304 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
18305 It prevents cross-basic-block CSE, hoisting and most scheduling
18306 of symbol loads.  The default is @option{-mno-invalid-symbols}.
18307
18308 @item -mbranch-cost=@var{num}
18309 @opindex mbranch-cost=@var{num}
18310 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
18311 make the compiler try to generate more branch-free code if possible.  
18312 If not specified the value is selected depending on the processor type that
18313 is being compiled for.
18314
18315 @item -mcbranchdi
18316 @opindex mcbranchdi
18317 Enable the @code{cbranchdi4} instruction pattern.
18318
18319 @item -mcmpeqdi
18320 @opindex mcmpeqdi
18321 Emit the @code{cmpeqdi_t} instruction pattern even when @option{-mcbranchdi}
18322 is in effect.
18323
18324 @item -mfused-madd
18325 @itemx -mno-fused-madd
18326 @opindex mfused-madd
18327 @opindex mno-fused-madd
18328 Generate code that uses (does not use) the floating-point multiply and
18329 accumulate instructions.  These instructions are generated by default
18330 if hardware floating point is used.  The machine-dependent
18331 @option{-mfused-madd} option is now mapped to the machine-independent
18332 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
18333 mapped to @option{-ffp-contract=off}.
18334
18335 @item -mfsca
18336 @itemx -mno-fsca
18337 @opindex mfsca
18338 @opindex mno-fsca
18339 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
18340 and cosine approximations.  The option @code{-mfsca} must be used in
18341 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
18342 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
18343 approximations even if @code{-funsafe-math-optimizations} is in effect.
18344
18345 @item -mfsrra
18346 @itemx -mno-fsrra
18347 @opindex mfsrra
18348 @opindex mno-fsrra
18349 Allow or disallow the compiler to emit the @code{fsrra} instruction for
18350 reciprocal square root approximations.  The option @code{-mfsrra} must be used
18351 in combination with @code{-funsafe-math-optimizations} and
18352 @code{-ffinite-math-only}.  It is enabled by default when generating code for
18353 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
18354 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
18355 in effect.
18356
18357 @item -mpretend-cmove
18358 @opindex mpretend-cmove
18359 Prefer zero-displacement conditional branches for conditional move instruction
18360 patterns.  This can result in faster code on the SH4 processor.
18361
18362 @end table
18363
18364 @node Solaris 2 Options
18365 @subsection Solaris 2 Options
18366 @cindex Solaris 2 options
18367
18368 These @samp{-m} options are supported on Solaris 2:
18369
18370 @table @gcctabopt
18371 @item -mimpure-text
18372 @opindex mimpure-text
18373 @option{-mimpure-text}, used in addition to @option{-shared}, tells
18374 the compiler to not pass @option{-z text} to the linker when linking a
18375 shared object.  Using this option, you can link position-dependent
18376 code into a shared object.
18377
18378 @option{-mimpure-text} suppresses the ``relocations remain against
18379 allocatable but non-writable sections'' linker error message.
18380 However, the necessary relocations trigger copy-on-write, and the
18381 shared object is not actually shared across processes.  Instead of
18382 using @option{-mimpure-text}, you should compile all source code with
18383 @option{-fpic} or @option{-fPIC}.
18384
18385 @end table
18386
18387 These switches are supported in addition to the above on Solaris 2:
18388
18389 @table @gcctabopt
18390 @item -pthreads
18391 @opindex pthreads
18392 Add support for multithreading using the POSIX threads library.  This
18393 option sets flags for both the preprocessor and linker.  This option does
18394 not affect the thread safety of object code produced  by the compiler or
18395 that of libraries supplied with it.
18396
18397 @item -pthread
18398 @opindex pthread
18399 This is a synonym for @option{-pthreads}.
18400 @end table
18401
18402 @node SPARC Options
18403 @subsection SPARC Options
18404 @cindex SPARC options
18405
18406 These @samp{-m} options are supported on the SPARC:
18407
18408 @table @gcctabopt
18409 @item -mno-app-regs
18410 @itemx -mapp-regs
18411 @opindex mno-app-regs
18412 @opindex mapp-regs
18413 Specify @option{-mapp-regs} to generate output using the global registers
18414 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
18415 is the default.
18416
18417 To be fully SVR4 ABI compliant at the cost of some performance loss,
18418 specify @option{-mno-app-regs}.  You should compile libraries and system
18419 software with this option.
18420
18421 @item -mflat
18422 @itemx -mno-flat
18423 @opindex mflat
18424 @opindex mno-flat
18425 With @option{-mflat}, the compiler does not generate save/restore instructions
18426 and uses a ``flat'' or single register window model.  This model is compatible
18427 with the regular register window model.  The local registers and the input
18428 registers (0--5) are still treated as ``call-saved'' registers and are
18429 saved on the stack as needed.
18430
18431 With @option{-mno-flat} (the default), the compiler generates save/restore
18432 instructions (except for leaf functions).  This is the normal operating mode.
18433
18434 @item -mfpu
18435 @itemx -mhard-float
18436 @opindex mfpu
18437 @opindex mhard-float
18438 Generate output containing floating-point instructions.  This is the
18439 default.
18440
18441 @item -mno-fpu
18442 @itemx -msoft-float
18443 @opindex mno-fpu
18444 @opindex msoft-float
18445 Generate output containing library calls for floating point.
18446 @strong{Warning:} the requisite libraries are not available for all SPARC
18447 targets.  Normally the facilities of the machine's usual C compiler are
18448 used, but this cannot be done directly in cross-compilation.  You must make
18449 your own arrangements to provide suitable library functions for
18450 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
18451 @samp{sparclite-*-*} do provide software floating-point support.
18452
18453 @option{-msoft-float} changes the calling convention in the output file;
18454 therefore, it is only useful if you compile @emph{all} of a program with
18455 this option.  In particular, you need to compile @file{libgcc.a}, the
18456 library that comes with GCC, with @option{-msoft-float} in order for
18457 this to work.
18458
18459 @item -mhard-quad-float
18460 @opindex mhard-quad-float
18461 Generate output containing quad-word (long double) floating-point
18462 instructions.
18463
18464 @item -msoft-quad-float
18465 @opindex msoft-quad-float
18466 Generate output containing library calls for quad-word (long double)
18467 floating-point instructions.  The functions called are those specified
18468 in the SPARC ABI@.  This is the default.
18469
18470 As of this writing, there are no SPARC implementations that have hardware
18471 support for the quad-word floating-point instructions.  They all invoke
18472 a trap handler for one of these instructions, and then the trap handler
18473 emulates the effect of the instruction.  Because of the trap handler overhead,
18474 this is much slower than calling the ABI library routines.  Thus the
18475 @option{-msoft-quad-float} option is the default.
18476
18477 @item -mno-unaligned-doubles
18478 @itemx -munaligned-doubles
18479 @opindex mno-unaligned-doubles
18480 @opindex munaligned-doubles
18481 Assume that doubles have 8-byte alignment.  This is the default.
18482
18483 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
18484 alignment only if they are contained in another type, or if they have an
18485 absolute address.  Otherwise, it assumes they have 4-byte alignment.
18486 Specifying this option avoids some rare compatibility problems with code
18487 generated by other compilers.  It is not the default because it results
18488 in a performance loss, especially for floating-point code.
18489
18490 @item -mno-faster-structs
18491 @itemx -mfaster-structs
18492 @opindex mno-faster-structs
18493 @opindex mfaster-structs
18494 With @option{-mfaster-structs}, the compiler assumes that structures
18495 should have 8-byte alignment.  This enables the use of pairs of
18496 @code{ldd} and @code{std} instructions for copies in structure
18497 assignment, in place of twice as many @code{ld} and @code{st} pairs.
18498 However, the use of this changed alignment directly violates the SPARC
18499 ABI@.  Thus, it's intended only for use on targets where the developer
18500 acknowledges that their resulting code is not directly in line with
18501 the rules of the ABI@.
18502
18503 @item -mcpu=@var{cpu_type}
18504 @opindex mcpu
18505 Set the instruction set, register set, and instruction scheduling parameters
18506 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
18507 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
18508 @samp{leon}, @samp{sparclite}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
18509 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
18510 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
18511 and @samp{niagara4}.
18512
18513 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
18514 which selects the best architecture option for the host processor.
18515 @option{-mcpu=native} has no effect if GCC does not recognize
18516 the processor.
18517
18518 Default instruction scheduling parameters are used for values that select
18519 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
18520 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
18521
18522 Here is a list of each supported architecture and their supported
18523 implementations.
18524
18525 @table @asis
18526 @item v7
18527 cypress
18528
18529 @item v8
18530 supersparc, hypersparc, leon
18531
18532 @item sparclite
18533 f930, f934, sparclite86x
18534
18535 @item sparclet
18536 tsc701
18537
18538 @item v9
18539 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
18540 @end table
18541
18542 By default (unless configured otherwise), GCC generates code for the V7
18543 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
18544 additionally optimizes it for the Cypress CY7C602 chip, as used in the
18545 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
18546 SPARCStation 1, 2, IPX etc.
18547
18548 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
18549 architecture.  The only difference from V7 code is that the compiler emits
18550 the integer multiply and integer divide instructions which exist in SPARC-V8
18551 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
18552 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
18553 2000 series.
18554
18555 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
18556 the SPARC architecture.  This adds the integer multiply, integer divide step
18557 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
18558 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
18559 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
18560 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
18561 MB86934 chip, which is the more recent SPARClite with FPU@.
18562
18563 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
18564 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
18565 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
18566 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
18567 optimizes it for the TEMIC SPARClet chip.
18568
18569 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
18570 architecture.  This adds 64-bit integer and floating-point move instructions,
18571 3 additional floating-point condition code registers and conditional move
18572 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
18573 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
18574 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
18575 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
18576 @option{-mcpu=niagara}, the compiler additionally optimizes it for
18577 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
18578 additionally optimizes it for Sun UltraSPARC T2 chips. With
18579 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
18580 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
18581 additionally optimizes it for Sun UltraSPARC T4 chips.
18582
18583 @item -mtune=@var{cpu_type}
18584 @opindex mtune
18585 Set the instruction scheduling parameters for machine type
18586 @var{cpu_type}, but do not set the instruction set or register set that the
18587 option @option{-mcpu=@var{cpu_type}} does.
18588
18589 The same values for @option{-mcpu=@var{cpu_type}} can be used for
18590 @option{-mtune=@var{cpu_type}}, but the only useful values are those
18591 that select a particular CPU implementation.  Those are @samp{cypress},
18592 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{f930}, @samp{f934},
18593 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, @samp{ultrasparc3},
18594 @samp{niagara}, @samp{niagara2}, @samp{niagara3} and @samp{niagara4}.  With
18595 native Solaris and GNU/Linux toolchains, @samp{native} can also be used.
18596
18597 @item -mv8plus
18598 @itemx -mno-v8plus
18599 @opindex mv8plus
18600 @opindex mno-v8plus
18601 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
18602 difference from the V8 ABI is that the global and out registers are
18603 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
18604 mode for all SPARC-V9 processors.
18605
18606 @item -mvis
18607 @itemx -mno-vis
18608 @opindex mvis
18609 @opindex mno-vis
18610 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
18611 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
18612
18613 @item -mvis2
18614 @itemx -mno-vis2
18615 @opindex mvis2
18616 @opindex mno-vis2
18617 With @option{-mvis2}, GCC generates code that takes advantage of
18618 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
18619 default is @option{-mvis2} when targeting a cpu that supports such
18620 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
18621 also sets @option{-mvis}.
18622
18623 @item -mvis3
18624 @itemx -mno-vis3
18625 @opindex mvis3
18626 @opindex mno-vis3
18627 With @option{-mvis3}, GCC generates code that takes advantage of
18628 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
18629 default is @option{-mvis3} when targeting a cpu that supports such
18630 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
18631 also sets @option{-mvis2} and @option{-mvis}.
18632
18633 @item -mpopc
18634 @itemx -mno-popc
18635 @opindex mpopc
18636 @opindex mno-popc
18637 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
18638 population count instruction.  The default is @option{-mpopc}
18639 when targeting a cpu that supports such instructions, such as Niagara-2 and
18640 later.
18641
18642 @item -mfmaf
18643 @itemx -mno-fmaf
18644 @opindex mfmaf
18645 @opindex mno-fmaf
18646 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
18647 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
18648 when targeting a cpu that supports such instructions, such as Niagara-3 and
18649 later.
18650
18651 @item -mfix-at697f
18652 @opindex mfix-at697f
18653 Enable the documented workaround for the single erratum of the Atmel AT697F
18654 processor (which corresponds to erratum #13 of the AT697E processor).
18655 @end table
18656
18657 These @samp{-m} options are supported in addition to the above
18658 on SPARC-V9 processors in 64-bit environments:
18659
18660 @table @gcctabopt
18661 @item -mlittle-endian
18662 @opindex mlittle-endian
18663 Generate code for a processor running in little-endian mode.  It is only
18664 available for a few configurations and most notably not on Solaris and Linux.
18665
18666 @item -m32
18667 @itemx -m64
18668 @opindex m32
18669 @opindex m64
18670 Generate code for a 32-bit or 64-bit environment.
18671 The 32-bit environment sets int, long and pointer to 32 bits.
18672 The 64-bit environment sets int to 32 bits and long and pointer
18673 to 64 bits.
18674
18675 @item -mcmodel=@var{which}
18676 @opindex mcmodel
18677 Set the code model to one of
18678
18679 @table @samp
18680 @item medlow
18681 The Medium/Low code model: 64-bit addresses, programs
18682 must be linked in the low 32 bits of memory.  Programs can be statically
18683 or dynamically linked.
18684
18685 @item medmid
18686 The Medium/Middle code model: 64-bit addresses, programs
18687 must be linked in the low 44 bits of memory, the text and data segments must
18688 be less than 2GB in size and the data segment must be located within 2GB of
18689 the text segment.
18690
18691 @item medany
18692 The Medium/Anywhere code model: 64-bit addresses, programs
18693 may be linked anywhere in memory, the text and data segments must be less
18694 than 2GB in size and the data segment must be located within 2GB of the
18695 text segment.
18696
18697 @item embmedany
18698 The Medium/Anywhere code model for embedded systems:
18699 64-bit addresses, the text and data segments must be less than 2GB in
18700 size, both starting anywhere in memory (determined at link time).  The
18701 global register %g4 points to the base of the data segment.  Programs
18702 are statically linked and PIC is not supported.
18703 @end table
18704
18705 @item -mmemory-model=@var{mem-model}
18706 @opindex mmemory-model
18707 Set the memory model in force on the processor to one of
18708
18709 @table @samp
18710 @item default
18711 The default memory model for the processor and operating system.
18712
18713 @item rmo
18714 Relaxed Memory Order
18715
18716 @item pso
18717 Partial Store Order
18718
18719 @item tso
18720 Total Store Order
18721
18722 @item sc
18723 Sequential Consistency
18724 @end table
18725
18726 These memory models are formally defined in Appendix D of the Sparc V9
18727 architecture manual, as set in the processor's @code{PSTATE.MM} field.
18728
18729 @item -mstack-bias
18730 @itemx -mno-stack-bias
18731 @opindex mstack-bias
18732 @opindex mno-stack-bias
18733 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
18734 frame pointer if present, are offset by @minus{}2047 which must be added back
18735 when making stack frame references.  This is the default in 64-bit mode.
18736 Otherwise, assume no such offset is present.
18737 @end table
18738
18739 @node SPU Options
18740 @subsection SPU Options
18741 @cindex SPU options
18742
18743 These @samp{-m} options are supported on the SPU:
18744
18745 @table @gcctabopt
18746 @item -mwarn-reloc
18747 @itemx -merror-reloc
18748 @opindex mwarn-reloc
18749 @opindex merror-reloc
18750
18751 The loader for SPU does not handle dynamic relocations.  By default, GCC
18752 gives an error when it generates code that requires a dynamic
18753 relocation.  @option{-mno-error-reloc} disables the error,
18754 @option{-mwarn-reloc} generates a warning instead.
18755
18756 @item -msafe-dma
18757 @itemx -munsafe-dma
18758 @opindex msafe-dma
18759 @opindex munsafe-dma
18760
18761 Instructions that initiate or test completion of DMA must not be
18762 reordered with respect to loads and stores of the memory that is being
18763 accessed.
18764 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
18765 memory accesses, but that can lead to inefficient code in places where the
18766 memory is known to not change.  Rather than mark the memory as volatile,
18767 you can use @option{-msafe-dma} to tell the compiler to treat
18768 the DMA instructions as potentially affecting all memory.  
18769
18770 @item -mbranch-hints
18771 @opindex mbranch-hints
18772
18773 By default, GCC generates a branch hint instruction to avoid
18774 pipeline stalls for always-taken or probably-taken branches.  A hint
18775 is not generated closer than 8 instructions away from its branch.
18776 There is little reason to disable them, except for debugging purposes,
18777 or to make an object a little bit smaller.
18778
18779 @item -msmall-mem
18780 @itemx -mlarge-mem
18781 @opindex msmall-mem
18782 @opindex mlarge-mem
18783
18784 By default, GCC generates code assuming that addresses are never larger
18785 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
18786 a full 32-bit address.
18787
18788 @item -mstdmain
18789 @opindex mstdmain
18790
18791 By default, GCC links against startup code that assumes the SPU-style
18792 main function interface (which has an unconventional parameter list).
18793 With @option{-mstdmain}, GCC links your program against startup
18794 code that assumes a C99-style interface to @code{main}, including a
18795 local copy of @code{argv} strings.
18796
18797 @item -mfixed-range=@var{register-range}
18798 @opindex mfixed-range
18799 Generate code treating the given register range as fixed registers.
18800 A fixed register is one that the register allocator can not use.  This is
18801 useful when compiling kernel code.  A register range is specified as
18802 two registers separated by a dash.  Multiple register ranges can be
18803 specified separated by a comma.
18804
18805 @item -mea32
18806 @itemx -mea64
18807 @opindex mea32
18808 @opindex mea64
18809 Compile code assuming that pointers to the PPU address space accessed
18810 via the @code{__ea} named address space qualifier are either 32 or 64
18811 bits wide.  The default is 32 bits.  As this is an ABI changing option,
18812 all object code in an executable must be compiled with the same setting.
18813
18814 @item -maddress-space-conversion
18815 @itemx -mno-address-space-conversion
18816 @opindex maddress-space-conversion
18817 @opindex mno-address-space-conversion
18818 Allow/disallow treating the @code{__ea} address space as superset
18819 of the generic address space.  This enables explicit type casts
18820 between @code{__ea} and generic pointer as well as implicit
18821 conversions of generic pointers to @code{__ea} pointers.  The
18822 default is to allow address space pointer conversions.
18823
18824 @item -mcache-size=@var{cache-size}
18825 @opindex mcache-size
18826 This option controls the version of libgcc that the compiler links to an
18827 executable and selects a software-managed cache for accessing variables
18828 in the @code{__ea} address space with a particular cache size.  Possible
18829 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
18830 and @samp{128}.  The default cache size is 64KB.
18831
18832 @item -matomic-updates
18833 @itemx -mno-atomic-updates
18834 @opindex matomic-updates
18835 @opindex mno-atomic-updates
18836 This option controls the version of libgcc that the compiler links to an
18837 executable and selects whether atomic updates to the software-managed
18838 cache of PPU-side variables are used.  If you use atomic updates, changes
18839 to a PPU variable from SPU code using the @code{__ea} named address space
18840 qualifier do not interfere with changes to other PPU variables residing
18841 in the same cache line from PPU code.  If you do not use atomic updates,
18842 such interference may occur; however, writing back cache lines is
18843 more efficient.  The default behavior is to use atomic updates.
18844
18845 @item -mdual-nops
18846 @itemx -mdual-nops=@var{n}
18847 @opindex mdual-nops
18848 By default, GCC inserts nops to increase dual issue when it expects
18849 it to increase performance.  @var{n} can be a value from 0 to 10.  A
18850 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
18851 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
18852
18853 @item -mhint-max-nops=@var{n}
18854 @opindex mhint-max-nops
18855 Maximum number of nops to insert for a branch hint.  A branch hint must
18856 be at least 8 instructions away from the branch it is affecting.  GCC
18857 inserts up to @var{n} nops to enforce this, otherwise it does not
18858 generate the branch hint.
18859
18860 @item -mhint-max-distance=@var{n}
18861 @opindex mhint-max-distance
18862 The encoding of the branch hint instruction limits the hint to be within
18863 256 instructions of the branch it is affecting.  By default, GCC makes
18864 sure it is within 125.
18865
18866 @item -msafe-hints
18867 @opindex msafe-hints
18868 Work around a hardware bug that causes the SPU to stall indefinitely.
18869 By default, GCC inserts the @code{hbrp} instruction to make sure
18870 this stall won't happen.
18871
18872 @end table
18873
18874 @node System V Options
18875 @subsection Options for System V
18876
18877 These additional options are available on System V Release 4 for
18878 compatibility with other compilers on those systems:
18879
18880 @table @gcctabopt
18881 @item -G
18882 @opindex G
18883 Create a shared object.
18884 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
18885
18886 @item -Qy
18887 @opindex Qy
18888 Identify the versions of each tool used by the compiler, in a
18889 @code{.ident} assembler directive in the output.
18890
18891 @item -Qn
18892 @opindex Qn
18893 Refrain from adding @code{.ident} directives to the output file (this is
18894 the default).
18895
18896 @item -YP,@var{dirs}
18897 @opindex YP
18898 Search the directories @var{dirs}, and no others, for libraries
18899 specified with @option{-l}.
18900
18901 @item -Ym,@var{dir}
18902 @opindex Ym
18903 Look in the directory @var{dir} to find the M4 preprocessor.
18904 The assembler uses this option.
18905 @c This is supposed to go with a -Yd for predefined M4 macro files, but
18906 @c the generic assembler that comes with Solaris takes just -Ym.
18907 @end table
18908
18909 @node TILE-Gx Options
18910 @subsection TILE-Gx Options
18911 @cindex TILE-Gx options
18912
18913 These @samp{-m} options are supported on the TILE-Gx:
18914
18915 @table @gcctabopt
18916 @item -mcpu=@var{name}
18917 @opindex mcpu
18918 Selects the type of CPU to be targeted.  Currently the only supported
18919 type is @samp{tilegx}.
18920
18921 @item -m32
18922 @itemx -m64
18923 @opindex m32
18924 @opindex m64
18925 Generate code for a 32-bit or 64-bit environment.  The 32-bit
18926 environment sets int, long, and pointer to 32 bits.  The 64-bit
18927 environment sets int to 32 bits and long and pointer to 64 bits.
18928 @end table
18929
18930 @node TILEPro Options
18931 @subsection TILEPro Options
18932 @cindex TILEPro options
18933
18934 These @samp{-m} options are supported on the TILEPro:
18935
18936 @table @gcctabopt
18937 @item -mcpu=@var{name}
18938 @opindex mcpu
18939 Selects the type of CPU to be targeted.  Currently the only supported
18940 type is @samp{tilepro}.
18941
18942 @item -m32
18943 @opindex m32
18944 Generate code for a 32-bit environment, which sets int, long, and
18945 pointer to 32 bits.  This is the only supported behavior so the flag
18946 is essentially ignored.
18947 @end table
18948
18949 @node V850 Options
18950 @subsection V850 Options
18951 @cindex V850 Options
18952
18953 These @samp{-m} options are defined for V850 implementations:
18954
18955 @table @gcctabopt
18956 @item -mlong-calls
18957 @itemx -mno-long-calls
18958 @opindex mlong-calls
18959 @opindex mno-long-calls
18960 Treat all calls as being far away (near).  If calls are assumed to be
18961 far away, the compiler always loads the function's address into a
18962 register, and calls indirect through the pointer.
18963
18964 @item -mno-ep
18965 @itemx -mep
18966 @opindex mno-ep
18967 @opindex mep
18968 Do not optimize (do optimize) basic blocks that use the same index
18969 pointer 4 or more times to copy pointer into the @code{ep} register, and
18970 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
18971 option is on by default if you optimize.
18972
18973 @item -mno-prolog-function
18974 @itemx -mprolog-function
18975 @opindex mno-prolog-function
18976 @opindex mprolog-function
18977 Do not use (do use) external functions to save and restore registers
18978 at the prologue and epilogue of a function.  The external functions
18979 are slower, but use less code space if more than one function saves
18980 the same number of registers.  The @option{-mprolog-function} option
18981 is on by default if you optimize.
18982
18983 @item -mspace
18984 @opindex mspace
18985 Try to make the code as small as possible.  At present, this just turns
18986 on the @option{-mep} and @option{-mprolog-function} options.
18987
18988 @item -mtda=@var{n}
18989 @opindex mtda
18990 Put static or global variables whose size is @var{n} bytes or less into
18991 the tiny data area that register @code{ep} points to.  The tiny data
18992 area can hold up to 256 bytes in total (128 bytes for byte references).
18993
18994 @item -msda=@var{n}
18995 @opindex msda
18996 Put static or global variables whose size is @var{n} bytes or less into
18997 the small data area that register @code{gp} points to.  The small data
18998 area can hold up to 64 kilobytes.
18999
19000 @item -mzda=@var{n}
19001 @opindex mzda
19002 Put static or global variables whose size is @var{n} bytes or less into
19003 the first 32 kilobytes of memory.
19004
19005 @item -mv850
19006 @opindex mv850
19007 Specify that the target processor is the V850.
19008
19009 @item -mbig-switch
19010 @opindex mbig-switch
19011 Generate code suitable for big switch tables.  Use this option only if
19012 the assembler/linker complain about out of range branches within a switch
19013 table.
19014
19015 @item -mapp-regs
19016 @opindex mapp-regs
19017 This option causes r2 and r5 to be used in the code generated by
19018 the compiler.  This setting is the default.
19019
19020 @item -mno-app-regs
19021 @opindex mno-app-regs
19022 This option causes r2 and r5 to be treated as fixed registers.
19023
19024 @item -mv850e2v3
19025 @opindex mv850e2v3
19026 Specify that the target processor is the V850E2V3.  The preprocessor
19027 constant @samp{__v850e2v3__} is defined if
19028 this option is used.
19029
19030 @item -mv850e2
19031 @opindex mv850e2
19032 Specify that the target processor is the V850E2.  The preprocessor
19033 constant @samp{__v850e2__} is defined if this option is used.
19034
19035 @item -mv850e1
19036 @opindex mv850e1
19037 Specify that the target processor is the V850E1.  The preprocessor
19038 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
19039 this option is used.
19040
19041 @item -mv850es
19042 @opindex mv850es
19043 Specify that the target processor is the V850ES.  This is an alias for
19044 the @option{-mv850e1} option.
19045
19046 @item -mv850e
19047 @opindex mv850e
19048 Specify that the target processor is the V850E@.  The preprocessor
19049 constant @samp{__v850e__} is defined if this option is used.
19050
19051 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
19052 nor @option{-mv850e2} nor @option{-mv850e2v3}
19053 are defined then a default target processor is chosen and the
19054 relevant @samp{__v850*__} preprocessor constant is defined.
19055
19056 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
19057 defined, regardless of which processor variant is the target.
19058
19059 @item -mdisable-callt
19060 @opindex mdisable-callt
19061 This option suppresses generation of the @code{CALLT} instruction for the
19062 v850e, v850e1, v850e2 and v850e2v3 flavors of the v850 architecture.  The default is
19063 @option{-mno-disable-callt} which allows the @code{CALLT} instruction to be used.
19064
19065 @end table
19066
19067 @node VAX Options
19068 @subsection VAX Options
19069 @cindex VAX options
19070
19071 These @samp{-m} options are defined for the VAX:
19072
19073 @table @gcctabopt
19074 @item -munix
19075 @opindex munix
19076 Do not output certain jump instructions (@code{aobleq} and so on)
19077 that the Unix assembler for the VAX cannot handle across long
19078 ranges.
19079
19080 @item -mgnu
19081 @opindex mgnu
19082 Do output those jump instructions, on the assumption that the
19083 GNU assembler is being used.
19084
19085 @item -mg
19086 @opindex mg
19087 Output code for G-format floating-point numbers instead of D-format.
19088 @end table
19089
19090 @node VMS Options
19091 @subsection VMS Options
19092
19093 These @samp{-m} options are defined for the VMS implementations:
19094
19095 @table @gcctabopt
19096 @item -mvms-return-codes
19097 @opindex mvms-return-codes
19098 Return VMS condition codes from @code{main}. The default is to return POSIX-style
19099 condition (e.g.@ error) codes.
19100
19101 @item -mdebug-main=@var{prefix}
19102 @opindex mdebug-main=@var{prefix}
19103 Flag the first routine whose name starts with @var{prefix} as the main
19104 routine for the debugger.
19105
19106 @item -mmalloc64
19107 @opindex mmalloc64
19108 Default to 64-bit memory allocation routines.
19109
19110 @item -mpointer-size=@var{size}
19111 @opindex -mpointer-size=@var{size}
19112 Set the default size of pointers. Possible options for @var{size} are
19113 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
19114 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
19115 The later option disables @code{pragma pointer_size}.
19116 @end table
19117
19118 @node VxWorks Options
19119 @subsection VxWorks Options
19120 @cindex VxWorks Options
19121
19122 The options in this section are defined for all VxWorks targets.
19123 Options specific to the target hardware are listed with the other
19124 options for that target.
19125
19126 @table @gcctabopt
19127 @item -mrtp
19128 @opindex mrtp
19129 GCC can generate code for both VxWorks kernels and real time processes
19130 (RTPs).  This option switches from the former to the latter.  It also
19131 defines the preprocessor macro @code{__RTP__}.
19132
19133 @item -non-static
19134 @opindex non-static
19135 Link an RTP executable against shared libraries rather than static
19136 libraries.  The options @option{-static} and @option{-shared} can
19137 also be used for RTPs (@pxref{Link Options}); @option{-static}
19138 is the default.
19139
19140 @item -Bstatic
19141 @itemx -Bdynamic
19142 @opindex Bstatic
19143 @opindex Bdynamic
19144 These options are passed down to the linker.  They are defined for
19145 compatibility with Diab.
19146
19147 @item -Xbind-lazy
19148 @opindex Xbind-lazy
19149 Enable lazy binding of function calls.  This option is equivalent to
19150 @option{-Wl,-z,now} and is defined for compatibility with Diab.
19151
19152 @item -Xbind-now
19153 @opindex Xbind-now
19154 Disable lazy binding of function calls.  This option is the default and
19155 is defined for compatibility with Diab.
19156 @end table
19157
19158 @node x86-64 Options
19159 @subsection x86-64 Options
19160 @cindex x86-64 options
19161
19162 These are listed under @xref{i386 and x86-64 Options}.
19163
19164 @node Xstormy16 Options
19165 @subsection Xstormy16 Options
19166 @cindex Xstormy16 Options
19167
19168 These options are defined for Xstormy16:
19169
19170 @table @gcctabopt
19171 @item -msim
19172 @opindex msim
19173 Choose startup files and linker script suitable for the simulator.
19174 @end table
19175
19176 @node Xtensa Options
19177 @subsection Xtensa Options
19178 @cindex Xtensa Options
19179
19180 These options are supported for Xtensa targets:
19181
19182 @table @gcctabopt
19183 @item -mconst16
19184 @itemx -mno-const16
19185 @opindex mconst16
19186 @opindex mno-const16
19187 Enable or disable use of @code{CONST16} instructions for loading
19188 constant values.  The @code{CONST16} instruction is currently not a
19189 standard option from Tensilica.  When enabled, @code{CONST16}
19190 instructions are always used in place of the standard @code{L32R}
19191 instructions.  The use of @code{CONST16} is enabled by default only if
19192 the @code{L32R} instruction is not available.
19193
19194 @item -mfused-madd
19195 @itemx -mno-fused-madd
19196 @opindex mfused-madd
19197 @opindex mno-fused-madd
19198 Enable or disable use of fused multiply/add and multiply/subtract
19199 instructions in the floating-point option.  This has no effect if the
19200 floating-point option is not also enabled.  Disabling fused multiply/add
19201 and multiply/subtract instructions forces the compiler to use separate
19202 instructions for the multiply and add/subtract operations.  This may be
19203 desirable in some cases where strict IEEE 754-compliant results are
19204 required: the fused multiply add/subtract instructions do not round the
19205 intermediate result, thereby producing results with @emph{more} bits of
19206 precision than specified by the IEEE standard.  Disabling fused multiply
19207 add/subtract instructions also ensures that the program output is not
19208 sensitive to the compiler's ability to combine multiply and add/subtract
19209 operations.
19210
19211 @item -mserialize-volatile
19212 @itemx -mno-serialize-volatile
19213 @opindex mserialize-volatile
19214 @opindex mno-serialize-volatile
19215 When this option is enabled, GCC inserts @code{MEMW} instructions before
19216 @code{volatile} memory references to guarantee sequential consistency.
19217 The default is @option{-mserialize-volatile}.  Use
19218 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
19219
19220 @item -mforce-no-pic
19221 @opindex mforce-no-pic
19222 For targets, like GNU/Linux, where all user-mode Xtensa code must be
19223 position-independent code (PIC), this option disables PIC for compiling
19224 kernel code.
19225
19226 @item -mtext-section-literals
19227 @itemx -mno-text-section-literals
19228 @opindex mtext-section-literals
19229 @opindex mno-text-section-literals
19230 Control the treatment of literal pools.  The default is
19231 @option{-mno-text-section-literals}, which places literals in a separate
19232 section in the output file.  This allows the literal pool to be placed
19233 in a data RAM/ROM, and it also allows the linker to combine literal
19234 pools from separate object files to remove redundant literals and
19235 improve code size.  With @option{-mtext-section-literals}, the literals
19236 are interspersed in the text section in order to keep them as close as
19237 possible to their references.  This may be necessary for large assembly
19238 files.
19239
19240 @item -mtarget-align
19241 @itemx -mno-target-align
19242 @opindex mtarget-align
19243 @opindex mno-target-align
19244 When this option is enabled, GCC instructs the assembler to
19245 automatically align instructions to reduce branch penalties at the
19246 expense of some code density.  The assembler attempts to widen density
19247 instructions to align branch targets and the instructions following call
19248 instructions.  If there are not enough preceding safe density
19249 instructions to align a target, no widening is performed.  The
19250 default is @option{-mtarget-align}.  These options do not affect the
19251 treatment of auto-aligned instructions like @code{LOOP}, which the
19252 assembler always aligns, either by widening density instructions or
19253 by inserting NOP instructions.
19254
19255 @item -mlongcalls
19256 @itemx -mno-longcalls
19257 @opindex mlongcalls
19258 @opindex mno-longcalls
19259 When this option is enabled, GCC instructs the assembler to translate
19260 direct calls to indirect calls unless it can determine that the target
19261 of a direct call is in the range allowed by the call instruction.  This
19262 translation typically occurs for calls to functions in other source
19263 files.  Specifically, the assembler translates a direct @code{CALL}
19264 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
19265 The default is @option{-mno-longcalls}.  This option should be used in
19266 programs where the call target can potentially be out of range.  This
19267 option is implemented in the assembler, not the compiler, so the
19268 assembly code generated by GCC still shows direct call
19269 instructions---look at the disassembled object code to see the actual
19270 instructions.  Note that the assembler uses an indirect call for
19271 every cross-file call, not just those that really are out of range.
19272 @end table
19273
19274 @node zSeries Options
19275 @subsection zSeries Options
19276 @cindex zSeries options
19277
19278 These are listed under @xref{S/390 and zSeries Options}.
19279
19280 @node Code Gen Options
19281 @section Options for Code Generation Conventions
19282 @cindex code generation conventions
19283 @cindex options, code generation
19284 @cindex run-time options
19285
19286 These machine-independent options control the interface conventions
19287 used in code generation.
19288
19289 Most of them have both positive and negative forms; the negative form
19290 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
19291 one of the forms is listed---the one that is not the default.  You
19292 can figure out the other form by either removing @samp{no-} or adding
19293 it.
19294
19295 @table @gcctabopt
19296 @item -fbounds-check
19297 @opindex fbounds-check
19298 For front ends that support it, generate additional code to check that
19299 indices used to access arrays are within the declared range.  This is
19300 currently only supported by the Java and Fortran front ends, where
19301 this option defaults to true and false respectively.
19302
19303 @item -ftrapv
19304 @opindex ftrapv
19305 This option generates traps for signed overflow on addition, subtraction,
19306 multiplication operations.
19307
19308 @item -fwrapv
19309 @opindex fwrapv
19310 This option instructs the compiler to assume that signed arithmetic
19311 overflow of addition, subtraction and multiplication wraps around
19312 using twos-complement representation.  This flag enables some optimizations
19313 and disables others.  This option is enabled by default for the Java
19314 front end, as required by the Java language specification.
19315
19316 @item -fexceptions
19317 @opindex fexceptions
19318 Enable exception handling.  Generates extra code needed to propagate
19319 exceptions.  For some targets, this implies GCC generates frame
19320 unwind information for all functions, which can produce significant data
19321 size overhead, although it does not affect execution.  If you do not
19322 specify this option, GCC enables it by default for languages like
19323 C++ that normally require exception handling, and disables it for
19324 languages like C that do not normally require it.  However, you may need
19325 to enable this option when compiling C code that needs to interoperate
19326 properly with exception handlers written in C++.  You may also wish to
19327 disable this option if you are compiling older C++ programs that don't
19328 use exception handling.
19329
19330 @item -fnon-call-exceptions
19331 @opindex fnon-call-exceptions
19332 Generate code that allows trapping instructions to throw exceptions.
19333 Note that this requires platform-specific runtime support that does
19334 not exist everywhere.  Moreover, it only allows @emph{trapping}
19335 instructions to throw exceptions, i.e.@: memory references or floating-point
19336 instructions.  It does not allow exceptions to be thrown from
19337 arbitrary signal handlers such as @code{SIGALRM}.
19338
19339 @item -fdelete-dead-exceptions
19340 @opindex fdelete-dead-exceptions
19341 Consider that instructions that may throw exceptions but don't otherwise
19342 contribute to the execution of the program can be optimized away.
19343 This option is enabled by default for the Ada front end, as permitted by
19344 the Ada language specification.
19345 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
19346
19347 @item -funwind-tables
19348 @opindex funwind-tables
19349 Similar to @option{-fexceptions}, except that it just generates any needed
19350 static data, but does not affect the generated code in any other way.
19351 You normally do not need to enable this option; instead, a language processor
19352 that needs this handling enables it on your behalf.
19353
19354 @item -fasynchronous-unwind-tables
19355 @opindex fasynchronous-unwind-tables
19356 Generate unwind table in DWARF 2 format, if supported by target machine.  The
19357 table is exact at each instruction boundary, so it can be used for stack
19358 unwinding from asynchronous events (such as debugger or garbage collector).
19359
19360 @item -fpcc-struct-return
19361 @opindex fpcc-struct-return
19362 Return ``short'' @code{struct} and @code{union} values in memory like
19363 longer ones, rather than in registers.  This convention is less
19364 efficient, but it has the advantage of allowing intercallability between
19365 GCC-compiled files and files compiled with other compilers, particularly
19366 the Portable C Compiler (pcc).
19367
19368 The precise convention for returning structures in memory depends
19369 on the target configuration macros.
19370
19371 Short structures and unions are those whose size and alignment match
19372 that of some integer type.
19373
19374 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
19375 switch is not binary compatible with code compiled with the
19376 @option{-freg-struct-return} switch.
19377 Use it to conform to a non-default application binary interface.
19378
19379 @item -freg-struct-return
19380 @opindex freg-struct-return
19381 Return @code{struct} and @code{union} values in registers when possible.
19382 This is more efficient for small structures than
19383 @option{-fpcc-struct-return}.
19384
19385 If you specify neither @option{-fpcc-struct-return} nor
19386 @option{-freg-struct-return}, GCC defaults to whichever convention is
19387 standard for the target.  If there is no standard convention, GCC
19388 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
19389 the principal compiler.  In those cases, we can choose the standard, and
19390 we chose the more efficient register return alternative.
19391
19392 @strong{Warning:} code compiled with the @option{-freg-struct-return}
19393 switch is not binary compatible with code compiled with the
19394 @option{-fpcc-struct-return} switch.
19395 Use it to conform to a non-default application binary interface.
19396
19397 @item -fshort-enums
19398 @opindex fshort-enums
19399 Allocate to an @code{enum} type only as many bytes as it needs for the
19400 declared range of possible values.  Specifically, the @code{enum} type
19401 is equivalent to the smallest integer type that has enough room.
19402
19403 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
19404 code that is not binary compatible with code generated without that switch.
19405 Use it to conform to a non-default application binary interface.
19406
19407 @item -fshort-double
19408 @opindex fshort-double
19409 Use the same size for @code{double} as for @code{float}.
19410
19411 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
19412 code that is not binary compatible with code generated without that switch.
19413 Use it to conform to a non-default application binary interface.
19414
19415 @item -fshort-wchar
19416 @opindex fshort-wchar
19417 Override the underlying type for @samp{wchar_t} to be @samp{short
19418 unsigned int} instead of the default for the target.  This option is
19419 useful for building programs to run under WINE@.
19420
19421 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
19422 code that is not binary compatible with code generated without that switch.
19423 Use it to conform to a non-default application binary interface.
19424
19425 @item -fno-common
19426 @opindex fno-common
19427 In C code, controls the placement of uninitialized global variables.
19428 Unix C compilers have traditionally permitted multiple definitions of
19429 such variables in different compilation units by placing the variables
19430 in a common block.
19431 This is the behavior specified by @option{-fcommon}, and is the default
19432 for GCC on most targets.
19433 On the other hand, this behavior is not required by ISO C, and on some
19434 targets may carry a speed or code size penalty on variable references.
19435 The @option{-fno-common} option specifies that the compiler should place
19436 uninitialized global variables in the data section of the object file,
19437 rather than generating them as common blocks.
19438 This has the effect that if the same variable is declared
19439 (without @code{extern}) in two different compilations,
19440 you get a multiple-definition error when you link them.
19441 In this case, you must compile with @option{-fcommon} instead.
19442 Compiling with @option{-fno-common} is useful on targets for which
19443 it provides better performance, or if you wish to verify that the
19444 program will work on other systems that always treat uninitialized
19445 variable declarations this way.
19446
19447 @item -fno-ident
19448 @opindex fno-ident
19449 Ignore the @samp{#ident} directive.
19450
19451 @item -finhibit-size-directive
19452 @opindex finhibit-size-directive
19453 Don't output a @code{.size} assembler directive, or anything else that
19454 would cause trouble if the function is split in the middle, and the
19455 two halves are placed at locations far apart in memory.  This option is
19456 used when compiling @file{crtstuff.c}; you should not need to use it
19457 for anything else.
19458
19459 @item -fverbose-asm
19460 @opindex fverbose-asm
19461 Put extra commentary information in the generated assembly code to
19462 make it more readable.  This option is generally only of use to those
19463 who actually need to read the generated assembly code (perhaps while
19464 debugging the compiler itself).
19465
19466 @option{-fno-verbose-asm}, the default, causes the
19467 extra information to be omitted and is useful when comparing two assembler
19468 files.
19469
19470 @item -frecord-gcc-switches
19471 @opindex frecord-gcc-switches
19472 This switch causes the command line used to invoke the
19473 compiler to be recorded into the object file that is being created.
19474 This switch is only implemented on some targets and the exact format
19475 of the recording is target and binary file format dependent, but it
19476 usually takes the form of a section containing ASCII text.  This
19477 switch is related to the @option{-fverbose-asm} switch, but that
19478 switch only records information in the assembler output file as
19479 comments, so it never reaches the object file.
19480 See also @option{-grecord-gcc-switches} for another
19481 way of storing compiler options into the object file.
19482
19483 @item -fpic
19484 @opindex fpic
19485 @cindex global offset table
19486 @cindex PIC
19487 Generate position-independent code (PIC) suitable for use in a shared
19488 library, if supported for the target machine.  Such code accesses all
19489 constant addresses through a global offset table (GOT)@.  The dynamic
19490 loader resolves the GOT entries when the program starts (the dynamic
19491 loader is not part of GCC; it is part of the operating system).  If
19492 the GOT size for the linked executable exceeds a machine-specific
19493 maximum size, you get an error message from the linker indicating that
19494 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
19495 instead.  (These maximums are 8k on the SPARC and 32k
19496 on the m68k and RS/6000.  The 386 has no such limit.)
19497
19498 Position-independent code requires special support, and therefore works
19499 only on certain machines.  For the 386, GCC supports PIC for System V
19500 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
19501 position-independent.
19502
19503 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19504 are defined to 1.
19505
19506 @item -fPIC
19507 @opindex fPIC
19508 If supported for the target machine, emit position-independent code,
19509 suitable for dynamic linking and avoiding any limit on the size of the
19510 global offset table.  This option makes a difference on the m68k,
19511 PowerPC and SPARC@.
19512
19513 Position-independent code requires special support, and therefore works
19514 only on certain machines.
19515
19516 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
19517 are defined to 2.
19518
19519 @item -fpie
19520 @itemx -fPIE
19521 @opindex fpie
19522 @opindex fPIE
19523 These options are similar to @option{-fpic} and @option{-fPIC}, but
19524 generated position independent code can be only linked into executables.
19525 Usually these options are used when @option{-pie} GCC option is
19526 used during linking.
19527
19528 @option{-fpie} and @option{-fPIE} both define the macros
19529 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
19530 for @option{-fpie} and 2 for @option{-fPIE}.
19531
19532 @item -fno-jump-tables
19533 @opindex fno-jump-tables
19534 Do not use jump tables for switch statements even where it would be
19535 more efficient than other code generation strategies.  This option is
19536 of use in conjunction with @option{-fpic} or @option{-fPIC} for
19537 building code that forms part of a dynamic linker and cannot
19538 reference the address of a jump table.  On some targets, jump tables
19539 do not require a GOT and this option is not needed.
19540
19541 @item -ffixed-@var{reg}
19542 @opindex ffixed
19543 Treat the register named @var{reg} as a fixed register; generated code
19544 should never refer to it (except perhaps as a stack pointer, frame
19545 pointer or in some other fixed role).
19546
19547 @var{reg} must be the name of a register.  The register names accepted
19548 are machine-specific and are defined in the @code{REGISTER_NAMES}
19549 macro in the machine description macro file.
19550
19551 This flag does not have a negative form, because it specifies a
19552 three-way choice.
19553
19554 @item -fcall-used-@var{reg}
19555 @opindex fcall-used
19556 Treat the register named @var{reg} as an allocable register that is
19557 clobbered by function calls.  It may be allocated for temporaries or
19558 variables that do not live across a call.  Functions compiled this way
19559 do not save and restore the register @var{reg}.
19560
19561 It is an error to use this flag with the frame pointer or stack pointer.
19562 Use of this flag for other registers that have fixed pervasive roles in
19563 the machine's execution model produces disastrous results.
19564
19565 This flag does not have a negative form, because it specifies a
19566 three-way choice.
19567
19568 @item -fcall-saved-@var{reg}
19569 @opindex fcall-saved
19570 Treat the register named @var{reg} as an allocable register saved by
19571 functions.  It may be allocated even for temporaries or variables that
19572 live across a call.  Functions compiled this way save and restore
19573 the register @var{reg} if they use it.
19574
19575 It is an error to use this flag with the frame pointer or stack pointer.
19576 Use of this flag for other registers that have fixed pervasive roles in
19577 the machine's execution model produces disastrous results.
19578
19579 A different sort of disaster results from the use of this flag for
19580 a register in which function values may be returned.
19581
19582 This flag does not have a negative form, because it specifies a
19583 three-way choice.
19584
19585 @item -fpack-struct[=@var{n}]
19586 @opindex fpack-struct
19587 Without a value specified, pack all structure members together without
19588 holes.  When a value is specified (which must be a small power of two), pack
19589 structure members according to this value, representing the maximum
19590 alignment (that is, objects with default alignment requirements larger than
19591 this are output potentially unaligned at the next fitting location.
19592
19593 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
19594 code that is not binary compatible with code generated without that switch.
19595 Additionally, it makes the code suboptimal.
19596 Use it to conform to a non-default application binary interface.
19597
19598 @item -finstrument-functions
19599 @opindex finstrument-functions
19600 Generate instrumentation calls for entry and exit to functions.  Just
19601 after function entry and just before function exit, the following
19602 profiling functions are called with the address of the current
19603 function and its call site.  (On some platforms,
19604 @code{__builtin_return_address} does not work beyond the current
19605 function, so the call site information may not be available to the
19606 profiling functions otherwise.)
19607
19608 @smallexample
19609 void __cyg_profile_func_enter (void *this_fn,
19610                                void *call_site);
19611 void __cyg_profile_func_exit  (void *this_fn,
19612                                void *call_site);
19613 @end smallexample
19614
19615 The first argument is the address of the start of the current function,
19616 which may be looked up exactly in the symbol table.
19617
19618 This instrumentation is also done for functions expanded inline in other
19619 functions.  The profiling calls indicate where, conceptually, the
19620 inline function is entered and exited.  This means that addressable
19621 versions of such functions must be available.  If all your uses of a
19622 function are expanded inline, this may mean an additional expansion of
19623 code size.  If you use @samp{extern inline} in your C code, an
19624 addressable version of such functions must be provided.  (This is
19625 normally the case anyway, but if you get lucky and the optimizer always
19626 expands the functions inline, you might have gotten away without
19627 providing static copies.)
19628
19629 A function may be given the attribute @code{no_instrument_function}, in
19630 which case this instrumentation is not done.  This can be used, for
19631 example, for the profiling functions listed above, high-priority
19632 interrupt routines, and any functions from which the profiling functions
19633 cannot safely be called (perhaps signal handlers, if the profiling
19634 routines generate output or allocate memory).
19635
19636 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
19637 @opindex finstrument-functions-exclude-file-list
19638
19639 Set the list of functions that are excluded from instrumentation (see
19640 the description of @code{-finstrument-functions}).  If the file that
19641 contains a function definition matches with one of @var{file}, then
19642 that function is not instrumented.  The match is done on substrings:
19643 if the @var{file} parameter is a substring of the file name, it is
19644 considered to be a match.
19645
19646 For example:
19647
19648 @smallexample
19649 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
19650 @end smallexample
19651
19652 @noindent
19653 excludes any inline function defined in files whose pathnames
19654 contain @code{/bits/stl} or @code{include/sys}.
19655
19656 If, for some reason, you want to include letter @code{','} in one of
19657 @var{sym}, write @code{'\,'}. For example,
19658 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
19659 (note the single quote surrounding the option).
19660
19661 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
19662 @opindex finstrument-functions-exclude-function-list
19663
19664 This is similar to @code{-finstrument-functions-exclude-file-list},
19665 but this option sets the list of function names to be excluded from
19666 instrumentation.  The function name to be matched is its user-visible
19667 name, such as @code{vector<int> blah(const vector<int> &)}, not the
19668 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
19669 match is done on substrings: if the @var{sym} parameter is a substring
19670 of the function name, it is considered to be a match.  For C99 and C++
19671 extended identifiers, the function name must be given in UTF-8, not
19672 using universal character names.
19673
19674 @item -fstack-check
19675 @opindex fstack-check
19676 Generate code to verify that you do not go beyond the boundary of the
19677 stack.  You should specify this flag if you are running in an
19678 environment with multiple threads, but only rarely need to specify it in
19679 a single-threaded environment since stack overflow is automatically
19680 detected on nearly all systems if there is only one stack.
19681
19682 Note that this switch does not actually cause checking to be done; the
19683 operating system or the language runtime must do that.  The switch causes
19684 generation of code to ensure that they see the stack being extended.
19685
19686 You can additionally specify a string parameter: @code{no} means no
19687 checking, @code{generic} means force the use of old-style checking,
19688 @code{specific} means use the best checking method and is equivalent
19689 to bare @option{-fstack-check}.
19690
19691 Old-style checking is a generic mechanism that requires no specific
19692 target support in the compiler but comes with the following drawbacks:
19693
19694 @enumerate
19695 @item
19696 Modified allocation strategy for large objects: they are always
19697 allocated dynamically if their size exceeds a fixed threshold.
19698
19699 @item
19700 Fixed limit on the size of the static frame of functions: when it is
19701 topped by a particular function, stack checking is not reliable and
19702 a warning is issued by the compiler.
19703
19704 @item
19705 Inefficiency: because of both the modified allocation strategy and the
19706 generic implementation, the performances of the code are hampered.
19707 @end enumerate
19708
19709 Note that old-style stack checking is also the fallback method for
19710 @code{specific} if no target support has been added in the compiler.
19711
19712 @item -fstack-limit-register=@var{reg}
19713 @itemx -fstack-limit-symbol=@var{sym}
19714 @itemx -fno-stack-limit
19715 @opindex fstack-limit-register
19716 @opindex fstack-limit-symbol
19717 @opindex fno-stack-limit
19718 Generate code to ensure that the stack does not grow beyond a certain value,
19719 either the value of a register or the address of a symbol.  If a larger
19720 stack is required, a signal is raised at run time.  For most targets,
19721 the signal is raised before the stack overruns the boundary, so
19722 it is possible to catch the signal without taking special precautions.
19723
19724 For instance, if the stack starts at absolute address @samp{0x80000000}
19725 and grows downwards, you can use the flags
19726 @option{-fstack-limit-symbol=__stack_limit} and
19727 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
19728 of 128KB@.  Note that this may only work with the GNU linker.
19729
19730 @item -fsplit-stack
19731 @opindex fsplit-stack
19732 Generate code to automatically split the stack before it overflows.
19733 The resulting program has a discontiguous stack which can only
19734 overflow if the program is unable to allocate any more memory.  This
19735 is most useful when running threaded programs, as it is no longer
19736 necessary to calculate a good stack size to use for each thread.  This
19737 is currently only implemented for the i386 and x86_64 back ends running
19738 GNU/Linux.
19739
19740 When code compiled with @option{-fsplit-stack} calls code compiled
19741 without @option{-fsplit-stack}, there may not be much stack space
19742 available for the latter code to run.  If compiling all code,
19743 including library code, with @option{-fsplit-stack} is not an option,
19744 then the linker can fix up these calls so that the code compiled
19745 without @option{-fsplit-stack} always has a large stack.  Support for
19746 this is implemented in the gold linker in GNU binutils release 2.21
19747 and later.
19748
19749 @item -fleading-underscore
19750 @opindex fleading-underscore
19751 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
19752 change the way C symbols are represented in the object file.  One use
19753 is to help link with legacy assembly code.
19754
19755 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
19756 generate code that is not binary compatible with code generated without that
19757 switch.  Use it to conform to a non-default application binary interface.
19758 Not all targets provide complete support for this switch.
19759
19760 @item -ftls-model=@var{model}
19761 @opindex ftls-model
19762 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
19763 The @var{model} argument should be one of @code{global-dynamic},
19764 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
19765
19766 The default without @option{-fpic} is @code{initial-exec}; with
19767 @option{-fpic} the default is @code{global-dynamic}.
19768
19769 @item -fvisibility=@var{default|internal|hidden|protected}
19770 @opindex fvisibility
19771 Set the default ELF image symbol visibility to the specified option---all
19772 symbols are marked with this unless overridden within the code.
19773 Using this feature can very substantially improve linking and
19774 load times of shared object libraries, produce more optimized
19775 code, provide near-perfect API export and prevent symbol clashes.
19776 It is @strong{strongly} recommended that you use this in any shared objects
19777 you distribute.
19778
19779 Despite the nomenclature, @code{default} always means public; i.e.,
19780 available to be linked against from outside the shared object.
19781 @code{protected} and @code{internal} are pretty useless in real-world
19782 usage so the only other commonly used option is @code{hidden}.
19783 The default if @option{-fvisibility} isn't specified is
19784 @code{default}, i.e., make every
19785 symbol public---this causes the same behavior as previous versions of
19786 GCC@.
19787
19788 A good explanation of the benefits offered by ensuring ELF
19789 symbols have the correct visibility is given by ``How To Write
19790 Shared Libraries'' by Ulrich Drepper (which can be found at
19791 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
19792 solution made possible by this option to marking things hidden when
19793 the default is public is to make the default hidden and mark things
19794 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
19795 and @code{__attribute__ ((visibility("default")))} instead of
19796 @code{__declspec(dllexport)} you get almost identical semantics with
19797 identical syntax.  This is a great boon to those working with
19798 cross-platform projects.
19799
19800 For those adding visibility support to existing code, you may find
19801 @samp{#pragma GCC visibility} of use.  This works by you enclosing
19802 the declarations you wish to set visibility for with (for example)
19803 @samp{#pragma GCC visibility push(hidden)} and
19804 @samp{#pragma GCC visibility pop}.
19805 Bear in mind that symbol visibility should be viewed @strong{as
19806 part of the API interface contract} and thus all new code should
19807 always specify visibility when it is not the default; i.e., declarations
19808 only for use within the local DSO should @strong{always} be marked explicitly
19809 as hidden as so to avoid PLT indirection overheads---making this
19810 abundantly clear also aids readability and self-documentation of the code.
19811 Note that due to ISO C++ specification requirements, @code{operator new} and
19812 @code{operator delete} must always be of default visibility.
19813
19814 Be aware that headers from outside your project, in particular system
19815 headers and headers from any other library you use, may not be
19816 expecting to be compiled with visibility other than the default.  You
19817 may need to explicitly say @samp{#pragma GCC visibility push(default)}
19818 before including any such headers.
19819
19820 @samp{extern} declarations are not affected by @option{-fvisibility}, so
19821 a lot of code can be recompiled with @option{-fvisibility=hidden} with
19822 no modifications.  However, this means that calls to @code{extern}
19823 functions with no explicit visibility use the PLT, so it is more
19824 effective to use @code{__attribute ((visibility))} and/or
19825 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
19826 declarations should be treated as hidden.
19827
19828 Note that @option{-fvisibility} does affect C++ vague linkage
19829 entities. This means that, for instance, an exception class that is
19830 be thrown between DSOs must be explicitly marked with default
19831 visibility so that the @samp{type_info} nodes are unified between
19832 the DSOs.
19833
19834 An overview of these techniques, their benefits and how to use them
19835 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
19836
19837 @item -fstrict-volatile-bitfields
19838 @opindex fstrict-volatile-bitfields
19839 This option should be used if accesses to volatile bit-fields (or other
19840 structure fields, although the compiler usually honors those types
19841 anyway) should use a single access of the width of the
19842 field's type, aligned to a natural alignment if possible.  For
19843 example, targets with memory-mapped peripheral registers might require
19844 all such accesses to be 16 bits wide; with this flag the user could
19845 declare all peripheral bit-fields as @code{unsigned short} (assuming short
19846 is 16 bits on these targets) to force GCC to use 16-bit accesses
19847 instead of, perhaps, a more efficient 32-bit access.
19848
19849 If this option is disabled, the compiler uses the most efficient
19850 instruction.  In the previous example, that might be a 32-bit load
19851 instruction, even though that accesses bytes that do not contain
19852 any portion of the bit-field, or memory-mapped registers unrelated to
19853 the one being updated.
19854
19855 If the target requires strict alignment, and honoring the field
19856 type would require violating this alignment, a warning is issued.
19857 If the field has @code{packed} attribute, the access is done without
19858 honoring the field type.  If the field doesn't have @code{packed}
19859 attribute, the access is done honoring the field type.  In both cases,
19860 GCC assumes that the user knows something about the target hardware
19861 that it is unaware of.
19862
19863 The default value of this option is determined by the application binary
19864 interface for the target processor.
19865
19866 @item -fsync-libcalls
19867 @opindex fsync-libcalls
19868 This option controls whether any out-of-line instance of the @code{__sync}
19869 family of functions may be used to implement the C++11 @code{__atomic}
19870 family of functions.
19871
19872 The default value of this option is enabled, thus the only useful form
19873 of the option is @option{-fno-sync-libcalls}.  This option is used in
19874 the implementation of the @file{libatomic} runtime library.
19875
19876 @end table
19877
19878 @c man end
19879
19880 @node Environment Variables
19881 @section Environment Variables Affecting GCC
19882 @cindex environment variables
19883
19884 @c man begin ENVIRONMENT
19885 This section describes several environment variables that affect how GCC
19886 operates.  Some of them work by specifying directories or prefixes to use
19887 when searching for various kinds of files.  Some are used to specify other
19888 aspects of the compilation environment.
19889
19890 Note that you can also specify places to search using options such as
19891 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
19892 take precedence over places specified using environment variables, which
19893 in turn take precedence over those specified by the configuration of GCC@.
19894 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
19895 GNU Compiler Collection (GCC) Internals}.
19896
19897 @table @env
19898 @item LANG
19899 @itemx LC_CTYPE
19900 @c @itemx LC_COLLATE
19901 @itemx LC_MESSAGES
19902 @c @itemx LC_MONETARY
19903 @c @itemx LC_NUMERIC
19904 @c @itemx LC_TIME
19905 @itemx LC_ALL
19906 @findex LANG
19907 @findex LC_CTYPE
19908 @c @findex LC_COLLATE
19909 @findex LC_MESSAGES
19910 @c @findex LC_MONETARY
19911 @c @findex LC_NUMERIC
19912 @c @findex LC_TIME
19913 @findex LC_ALL
19914 @cindex locale
19915 These environment variables control the way that GCC uses
19916 localization information which allows GCC to work with different
19917 national conventions.  GCC inspects the locale categories
19918 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
19919 so.  These locale categories can be set to any value supported by your
19920 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
19921 Kingdom encoded in UTF-8.
19922
19923 The @env{LC_CTYPE} environment variable specifies character
19924 classification.  GCC uses it to determine the character boundaries in
19925 a string; this is needed for some multibyte encodings that contain quote
19926 and escape characters that are otherwise interpreted as a string
19927 end or escape.
19928
19929 The @env{LC_MESSAGES} environment variable specifies the language to
19930 use in diagnostic messages.
19931
19932 If the @env{LC_ALL} environment variable is set, it overrides the value
19933 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
19934 and @env{LC_MESSAGES} default to the value of the @env{LANG}
19935 environment variable.  If none of these variables are set, GCC
19936 defaults to traditional C English behavior.
19937
19938 @item TMPDIR
19939 @findex TMPDIR
19940 If @env{TMPDIR} is set, it specifies the directory to use for temporary
19941 files.  GCC uses temporary files to hold the output of one stage of
19942 compilation which is to be used as input to the next stage: for example,
19943 the output of the preprocessor, which is the input to the compiler
19944 proper.
19945
19946 @item GCC_COMPARE_DEBUG
19947 @findex GCC_COMPARE_DEBUG
19948 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
19949 @option{-fcompare-debug} to the compiler driver.  See the documentation
19950 of this option for more details.
19951
19952 @item GCC_EXEC_PREFIX
19953 @findex GCC_EXEC_PREFIX
19954 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
19955 names of the subprograms executed by the compiler.  No slash is added
19956 when this prefix is combined with the name of a subprogram, but you can
19957 specify a prefix that ends with a slash if you wish.
19958
19959 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
19960 an appropriate prefix to use based on the pathname it is invoked with.
19961
19962 If GCC cannot find the subprogram using the specified prefix, it
19963 tries looking in the usual places for the subprogram.
19964
19965 The default value of @env{GCC_EXEC_PREFIX} is
19966 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
19967 the installed compiler. In many cases @var{prefix} is the value
19968 of @code{prefix} when you ran the @file{configure} script.
19969
19970 Other prefixes specified with @option{-B} take precedence over this prefix.
19971
19972 This prefix is also used for finding files such as @file{crt0.o} that are
19973 used for linking.
19974
19975 In addition, the prefix is used in an unusual way in finding the
19976 directories to search for header files.  For each of the standard
19977 directories whose name normally begins with @samp{/usr/local/lib/gcc}
19978 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
19979 replacing that beginning with the specified prefix to produce an
19980 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
19981 @file{foo/bar} just before it searches the standard directory 
19982 @file{/usr/local/lib/bar}.
19983 If a standard directory begins with the configured
19984 @var{prefix} then the value of @var{prefix} is replaced by
19985 @env{GCC_EXEC_PREFIX} when looking for header files.
19986
19987 @item COMPILER_PATH
19988 @findex COMPILER_PATH
19989 The value of @env{COMPILER_PATH} is a colon-separated list of
19990 directories, much like @env{PATH}.  GCC tries the directories thus
19991 specified when searching for subprograms, if it can't find the
19992 subprograms using @env{GCC_EXEC_PREFIX}.
19993
19994 @item LIBRARY_PATH
19995 @findex LIBRARY_PATH
19996 The value of @env{LIBRARY_PATH} is a colon-separated list of
19997 directories, much like @env{PATH}.  When configured as a native compiler,
19998 GCC tries the directories thus specified when searching for special
19999 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
20000 using GCC also uses these directories when searching for ordinary
20001 libraries for the @option{-l} option (but directories specified with
20002 @option{-L} come first).
20003
20004 @item LANG
20005 @findex LANG
20006 @cindex locale definition
20007 This variable is used to pass locale information to the compiler.  One way in
20008 which this information is used is to determine the character set to be used
20009 when character literals, string literals and comments are parsed in C and C++.
20010 When the compiler is configured to allow multibyte characters,
20011 the following values for @env{LANG} are recognized:
20012
20013 @table @samp
20014 @item C-JIS
20015 Recognize JIS characters.
20016 @item C-SJIS
20017 Recognize SJIS characters.
20018 @item C-EUCJP
20019 Recognize EUCJP characters.
20020 @end table
20021
20022 If @env{LANG} is not defined, or if it has some other value, then the
20023 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
20024 recognize and translate multibyte characters.
20025 @end table
20026
20027 @noindent
20028 Some additional environment variables affect the behavior of the
20029 preprocessor.
20030
20031 @include cppenv.texi
20032
20033 @c man end
20034
20035 @node Precompiled Headers
20036 @section Using Precompiled Headers
20037 @cindex precompiled headers
20038 @cindex speed of compilation
20039
20040 Often large projects have many header files that are included in every
20041 source file.  The time the compiler takes to process these header files
20042 over and over again can account for nearly all of the time required to
20043 build the project.  To make builds faster, GCC allows you to
20044 @dfn{precompile} a header file.
20045
20046 To create a precompiled header file, simply compile it as you would any
20047 other file, if necessary using the @option{-x} option to make the driver
20048 treat it as a C or C++ header file.  You may want to use a
20049 tool like @command{make} to keep the precompiled header up-to-date when
20050 the headers it contains change.
20051
20052 A precompiled header file is searched for when @code{#include} is
20053 seen in the compilation.  As it searches for the included file
20054 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
20055 compiler looks for a precompiled header in each directory just before it
20056 looks for the include file in that directory.  The name searched for is
20057 the name specified in the @code{#include} with @samp{.gch} appended.  If
20058 the precompiled header file can't be used, it is ignored.
20059
20060 For instance, if you have @code{#include "all.h"}, and you have
20061 @file{all.h.gch} in the same directory as @file{all.h}, then the
20062 precompiled header file is used if possible, and the original
20063 header is used otherwise.
20064
20065 Alternatively, you might decide to put the precompiled header file in a
20066 directory and use @option{-I} to ensure that directory is searched
20067 before (or instead of) the directory containing the original header.
20068 Then, if you want to check that the precompiled header file is always
20069 used, you can put a file of the same name as the original header in this
20070 directory containing an @code{#error} command.
20071
20072 This also works with @option{-include}.  So yet another way to use
20073 precompiled headers, good for projects not designed with precompiled
20074 header files in mind, is to simply take most of the header files used by
20075 a project, include them from another header file, precompile that header
20076 file, and @option{-include} the precompiled header.  If the header files
20077 have guards against multiple inclusion, they are skipped because
20078 they've already been included (in the precompiled header).
20079
20080 If you need to precompile the same header file for different
20081 languages, targets, or compiler options, you can instead make a
20082 @emph{directory} named like @file{all.h.gch}, and put each precompiled
20083 header in the directory, perhaps using @option{-o}.  It doesn't matter
20084 what you call the files in the directory; every precompiled header in
20085 the directory is considered.  The first precompiled header
20086 encountered in the directory that is valid for this compilation is
20087 used; they're searched in no particular order.
20088
20089 There are many other possibilities, limited only by your imagination,
20090 good sense, and the constraints of your build system.
20091
20092 A precompiled header file can be used only when these conditions apply:
20093
20094 @itemize
20095 @item
20096 Only one precompiled header can be used in a particular compilation.
20097
20098 @item
20099 A precompiled header can't be used once the first C token is seen.  You
20100 can have preprocessor directives before a precompiled header; you cannot
20101 include a precompiled header from inside another header.
20102
20103 @item
20104 The precompiled header file must be produced for the same language as
20105 the current compilation.  You can't use a C precompiled header for a C++
20106 compilation.
20107
20108 @item
20109 The precompiled header file must have been produced by the same compiler
20110 binary as the current compilation is using.
20111
20112 @item
20113 Any macros defined before the precompiled header is included must
20114 either be defined in the same way as when the precompiled header was
20115 generated, or must not affect the precompiled header, which usually
20116 means that they don't appear in the precompiled header at all.
20117
20118 The @option{-D} option is one way to define a macro before a
20119 precompiled header is included; using a @code{#define} can also do it.
20120 There are also some options that define macros implicitly, like
20121 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
20122 defined this way.
20123
20124 @item If debugging information is output when using the precompiled
20125 header, using @option{-g} or similar, the same kind of debugging information
20126 must have been output when building the precompiled header.  However,
20127 a precompiled header built using @option{-g} can be used in a compilation
20128 when no debugging information is being output.
20129
20130 @item The same @option{-m} options must generally be used when building
20131 and using the precompiled header.  @xref{Submodel Options},
20132 for any cases where this rule is relaxed.
20133
20134 @item Each of the following options must be the same when building and using
20135 the precompiled header:
20136
20137 @gccoptlist{-fexceptions}
20138
20139 @item
20140 Some other command-line options starting with @option{-f},
20141 @option{-p}, or @option{-O} must be defined in the same way as when
20142 the precompiled header was generated.  At present, it's not clear
20143 which options are safe to change and which are not; the safest choice
20144 is to use exactly the same options when generating and using the
20145 precompiled header.  The following are known to be safe:
20146
20147 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
20148 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
20149 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
20150 -pedantic-errors}
20151
20152 @end itemize
20153
20154 For all of these except the last, the compiler automatically
20155 ignores the precompiled header if the conditions aren't met.  If you
20156 find an option combination that doesn't work and doesn't cause the
20157 precompiled header to be ignored, please consider filing a bug report,
20158 see @ref{Bugs}.
20159
20160 If you do use differing options when generating and using the
20161 precompiled header, the actual behavior is a mixture of the
20162 behavior for the options.  For instance, if you use @option{-g} to
20163 generate the precompiled header but not when using it, you may or may
20164 not get debugging information for routines in the precompiled header.