OSDN Git Service

92652ccf1f65d1f2ec2c782ab1c4d9ffadbb58b6
[pf3gnuchains/gcc-fork.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
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
15 Free Software Foundation, Inc.
16
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.2 or
19 any later version published by the Free Software Foundation; with the
20 Invariant Sections being ``GNU General Public License'' and ``Funding
21 Free Software'', the Front-Cover texts being (a) (see below), and with
22 the Back-Cover Texts being (b) (see below).  A copy of the license is
23 included in the gfdl(7) man page.
24
25 (a) The FSF's Front-Cover Text is:
26
27      A GNU Manual
28
29 (b) The FSF's Back-Cover Text is:
30
31      You have freedom to copy and modify this GNU Manual, like GNU
32      software.  Copies published by the Free Software Foundation raise
33      funds for GNU development.
34 @c man end
35 @c Set file name and title for the man page.
36 @setfilename gcc
37 @settitle GNU project C and C++ compiler
38 @c man begin SYNOPSIS
39 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
40     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
41     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
42     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
43     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
44     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
45     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
46
47 Only the most useful options are listed here; see below for the
48 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
49 @c man end
50 @c man begin SEEALSO
51 gpl(7), gfdl(7), fsf-funding(7),
52 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
53 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
54 @file{ld}, @file{binutils} and @file{gdb}.
55 @c man end
56 @c man begin BUGS
57 For instructions on reporting bugs, see
58 @w{@value{BUGURL}}.
59 @c man end
60 @c man begin AUTHOR
61 See the Info entry for @command{gcc}, or
62 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
63 for contributors to GCC@.
64 @c man end
65 @end ignore
66
67 @node Invoking GCC
68 @chapter GCC Command Options
69 @cindex GCC command options
70 @cindex command options
71 @cindex options, GCC command
72
73 @c man begin DESCRIPTION
74 When you invoke GCC, it normally does preprocessing, compilation,
75 assembly and linking.  The ``overall options'' allow you to stop this
76 process at an intermediate stage.  For example, the @option{-c} option
77 says not to run the linker.  Then the output consists of object files
78 output by the assembler.
79
80 Other options are passed on to one stage of processing.  Some options
81 control the preprocessor and others the compiler itself.  Yet other
82 options control the assembler and linker; most of these are not
83 documented here, since you rarely need to use any of them.
84
85 @cindex C compilation options
86 Most of the command line options that you can use with GCC are useful
87 for C programs; when an option is only useful with another language
88 (usually C++), the explanation says so explicitly.  If the description
89 for a particular option does not mention a source language, you can use
90 that option with all supported languages.
91
92 @cindex C++ compilation options
93 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
94 options for compiling C++ programs.
95
96 @cindex grouping options
97 @cindex options, grouping
98 The @command{gcc} program accepts options and file names as operands.  Many
99 options have multi-letter names; therefore multiple single-letter options
100 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
101 -v}}.
102
103 @cindex order of options
104 @cindex options, order
105 You can mix options and other arguments.  For the most part, the order
106 you use doesn't matter.  Order does matter when you use several
107 options of the same kind; for example, if you specify @option{-L} more
108 than once, the directories are searched in the order specified.  Also,
109 the placement of the @option{-l} option is significant.
110
111 Many options have long names starting with @samp{-f} or with
112 @samp{-W}---for example,
113 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
114 these have both positive and negative forms; the negative form of
115 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
116 only one of these two forms, whichever one is not the default.
117
118 @c man end
119
120 @xref{Option Index}, for an index to GCC's options.
121
122 @menu
123 * Option Summary::      Brief list of all options, without explanations.
124 * Overall Options::     Controlling the kind of output:
125                         an executable, object files, assembler files,
126                         or preprocessed source.
127 * Invoking G++::        Compiling C++ programs.
128 * C Dialect Options::   Controlling the variant of C language compiled.
129 * C++ Dialect Options:: Variations on C++.
130 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
131                         and Objective-C++.
132 * Language Independent Options:: Controlling how diagnostics should be
133                         formatted.
134 * Warning Options::     How picky should the compiler be?
135 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
136 * Optimize Options::    How much optimization?
137 * Preprocessor Options:: Controlling header files and macro definitions.
138                          Also, getting dependency information for Make.
139 * Assembler Options::   Passing options to the assembler.
140 * Link Options::        Specifying libraries and so on.
141 * Directory Options::   Where to find header files and libraries.
142                         Where to find the compiler executable files.
143 * Spec Files::          How to pass switches to sub-processes.
144 * Target Options::      Running a cross-compiler, or an old version of GCC.
145 * Submodel Options::    Specifying minor hardware or convention variations,
146                         such as 68010 vs 68020.
147 * Code Gen Options::    Specifying conventions for function calls, data layout
148                         and register usage.
149 * Environment Variables:: Env vars that affect GCC.
150 * Precompiled Headers:: Compiling a header once, and using it many times.
151 @end menu
152
153 @c man begin OPTIONS
154
155 @node Option Summary
156 @section Option Summary
157
158 Here is a summary of all the options, grouped by type.  Explanations are
159 in the following sections.
160
161 @table @emph
162 @item Overall Options
163 @xref{Overall Options,,Options Controlling the Kind of Output}.
164 @gccoptlist{-c  -S  -E  -o @var{file}  -combine  -no-canonical-prefixes  @gol
165 -pipe  -pass-exit-codes  @gol
166 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
167 --version -wrapper@@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}}
168
169 @item C Language Options
170 @xref{C Dialect Options,,Options Controlling C Dialect}.
171 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
172 -aux-info @var{filename} @gol
173 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
174 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
175 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
176 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
177 -fsigned-bitfields  -fsigned-char @gol
178 -funsigned-bitfields  -funsigned-char}
179
180 @item C++ Language Options
181 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
182 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
183 -fconserve-space  -ffriend-injection @gol
184 -fno-elide-constructors @gol
185 -fno-enforce-eh-specs @gol
186 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
187 -fno-implicit-templates @gol
188 -fno-implicit-inline-templates @gol
189 -fno-implement-inlines  -fms-extensions @gol
190 -fno-nonansi-builtins  -fno-operator-names @gol
191 -fno-optional-diags  -fpermissive @gol
192 -fno-pretty-templates @gol
193 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
194 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
195 -fno-default-inline  -fvisibility-inlines-hidden @gol
196 -fvisibility-ms-compat @gol
197 -Wabi  -Wctor-dtor-privacy @gol
198 -Wnon-virtual-dtor  -Wreorder @gol
199 -Weffc++  -Wstrict-null-sentinel @gol
200 -Wno-non-template-friend  -Wold-style-cast @gol
201 -Woverloaded-virtual  -Wno-pmf-conversions @gol
202 -Wsign-promo}
203
204 @item Objective-C and Objective-C++ Language Options
205 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
206 Objective-C and Objective-C++ Dialects}.
207 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
208 -fgnu-runtime  -fnext-runtime @gol
209 -fno-nil-receivers @gol
210 -fobjc-call-cxx-cdtors @gol
211 -fobjc-direct-dispatch @gol
212 -fobjc-exceptions @gol
213 -fobjc-gc @gol
214 -freplace-objc-classes @gol
215 -fzero-link @gol
216 -gen-decls @gol
217 -Wassign-intercept @gol
218 -Wno-protocol  -Wselector @gol
219 -Wstrict-selector-match @gol
220 -Wundeclared-selector}
221
222 @item Language Independent Options
223 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
224 @gccoptlist{-fmessage-length=@var{n}  @gol
225 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
226 -fdiagnostics-show-option}
227
228 @item Warning Options
229 @xref{Warning Options,,Options to Request or Suppress Warnings}.
230 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
231 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
232 -Wno-attributes -Wno-builtin-macro-redefined @gol
233 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
234 -Wchar-subscripts -Wclobbered  -Wcomment @gol
235 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated  @gol
236 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
237 -Wno-div-by-zero -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
238 -Werror  -Werror=* @gol
239 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
240 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
241 -Wformat-security  -Wformat-y2k @gol
242 -Wframe-larger-than=@var{len} -Wjump-misses-init -Wignored-qualifiers @gol
243 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
244 -Winit-self  -Winline @gol
245 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
246 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
247 -Wlogical-op -Wlong-long @gol
248 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
249 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
250 -Wmissing-noreturn  -Wno-mudflap @gol
251 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
252 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
253 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
254 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
255 -Wredundant-decls @gol
256 -Wreturn-type  -Wsequence-point  -Wshadow @gol
257 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
258 -Wstrict-aliasing -Wstrict-aliasing=n @gol
259 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
260 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
261 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
262 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
263 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
264 -Wunused-label  -Wunused-parameter -Wno-unused-result -Wunused-value  -Wunused-variable @gol
265 -Wvariadic-macros -Wvla @gol
266 -Wvolatile-register-var  -Wwrite-strings}
267
268 @item C and Objective-C-only Warning Options
269 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
270 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
271 -Wold-style-declaration  -Wold-style-definition @gol
272 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
273 -Wdeclaration-after-statement -Wpointer-sign}
274
275 @item Debugging Options
276 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
277 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
278 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
279 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
280 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
281 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
282 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
283 -fdump-statistics @gol
284 -fdump-tree-all @gol
285 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
286 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
288 -fdump-tree-ch @gol
289 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-nrv -fdump-tree-vect @gol
299 -fdump-tree-sink @gol
300 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
301 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
303 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
304 -ftree-vectorizer-verbose=@var{n} @gol
305 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
306 -fdump-final-insns=@var{file} @gol
307 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
308 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
309 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
310 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
311 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
312 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
313 -ftest-coverage  -ftime-report -fvar-tracking @gol
314 -fvar-tracking-assigments  -fvar-tracking-assignments-toggle @gol
315 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
316 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
317 -gvms  -gxcoff  -gxcoff+ @gol
318 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
319 -fdebug-prefix-map=@var{old}=@var{new} @gol
320 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
321 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
322 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
323 -print-multi-directory  -print-multi-lib @gol
324 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
325 -print-sysroot -print-sysroot-headers-suffix @gol
326 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
327
328 @item Optimization Options
329 @xref{Optimize Options,,Options that Control Optimization}.
330 @gccoptlist{
331 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
332 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
333 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
334 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
335 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
336 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
337 -fdata-sections -fdce -fdce @gol
338 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
339 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
340 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
341 -fforward-propagate -ffunction-sections @gol
342 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
343 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
344 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
345 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
346 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
347 -fipa-type-escape -fira-algorithm=@var{algorithm} @gol
348 -fira-region=@var{region} -fira-coalesce -fno-ira-share-save-slots @gol
349 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
350 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
351 -floop-block -floop-interchange -floop-strip-mine -fgraphite-identity @gol
352 -floop-parallelize-all @gol
353 -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
354 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
355 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
356 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
357 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
358 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
359 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
360 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
361 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
362 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
363 -fprofile-generate=@var{path} @gol
364 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
365 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
366 -freorder-blocks-and-partition -freorder-functions @gol
367 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
368 -frounding-math -fsched2-use-superblocks @gol
369 -fsched2-use-traces -fsched-pressure @gol
370 -fsched-spec-load -fsched-spec-load-dangerous @gol
371 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
372 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
373 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
374 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
375 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
376 -fselective-scheduling -fselective-scheduling2 @gol
377 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
378 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
379 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
380 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
381 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
382 -ftree-copyrename -ftree-dce @gol
383 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
384 -ftree-phiprop -ftree-loop-distribution @gol
385 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
386 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
387 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
388 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
389 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
390 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
391 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
392 -fwhole-program @gol
393 --param @var{name}=@var{value}
394 -O  -O0  -O1  -O2  -O3  -Os}
395
396 @item Preprocessor Options
397 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
398 @gccoptlist{-A@var{question}=@var{answer} @gol
399 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
400 -C  -dD  -dI  -dM  -dN @gol
401 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
402 -idirafter @var{dir} @gol
403 -include @var{file}  -imacros @var{file} @gol
404 -iprefix @var{file}  -iwithprefix @var{dir} @gol
405 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
406 -imultilib @var{dir} -isysroot @var{dir} @gol
407 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
408 -P  -fworking-directory  -remap @gol
409 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
410 -Xpreprocessor @var{option}}
411
412 @item Assembler Option
413 @xref{Assembler Options,,Passing Options to the Assembler}.
414 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
415
416 @item Linker Options
417 @xref{Link Options,,Options for Linking}.
418 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
419 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
420 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
421 -shared-libgcc  -symbolic @gol
422 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
423 -u @var{symbol}}
424
425 @item Directory Options
426 @xref{Directory Options,,Options for Directory Search}.
427 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
428 -specs=@var{file}  -I- --sysroot=@var{dir}}
429
430 @item Target Options
431 @c I wrote this xref this way to avoid overfull hbox. -- rms
432 @xref{Target Options}.
433 @gccoptlist{-V @var{version}  -b @var{machine}}
434
435 @item Machine Dependent Options
436 @xref{Submodel Options,,Hardware Models and Configurations}.
437 @c This list is ordered alphanumerically by subsection name.
438 @c Try and put the significant identifier (CPU or system) first,
439 @c so users have a clue at guessing where the ones they want will be.
440
441 @emph{ARC Options}
442 @gccoptlist{-EB  -EL @gol
443 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
444 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
445
446 @emph{ARM Options}
447 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
448 -mabi=@var{name} @gol
449 -mapcs-stack-check  -mno-apcs-stack-check @gol
450 -mapcs-float  -mno-apcs-float @gol
451 -mapcs-reentrant  -mno-apcs-reentrant @gol
452 -msched-prolog  -mno-sched-prolog @gol
453 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
454 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
455 -mfp16-format=@var{name}
456 -mthumb-interwork  -mno-thumb-interwork @gol
457 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
458 -mstructure-size-boundary=@var{n} @gol
459 -mabort-on-noreturn @gol
460 -mlong-calls  -mno-long-calls @gol
461 -msingle-pic-base  -mno-single-pic-base @gol
462 -mpic-register=@var{reg} @gol
463 -mnop-fun-dllimport @gol
464 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
465 -mpoke-function-name @gol
466 -mthumb  -marm @gol
467 -mtpcs-frame  -mtpcs-leaf-frame @gol
468 -mcaller-super-interworking  -mcallee-super-interworking @gol
469 -mtp=@var{name} @gol
470 -mword-relocations @gol
471 -mfix-cortex-m3-ldrd}
472
473 @emph{AVR Options}
474 @gccoptlist{-mmcu=@var{mcu}  -msize  -mno-interrupts @gol
475 -mcall-prologues  -mtiny-stack  -mint8}
476
477 @emph{Blackfin Options}
478 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
479 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
480 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
481 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
482 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
483 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
484 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
485 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
486 -micplb}
487
488 @emph{CRIS Options}
489 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
490 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
491 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
492 -mstack-align  -mdata-align  -mconst-align @gol
493 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
494 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
495 -mmul-bug-workaround  -mno-mul-bug-workaround}
496
497 @emph{CRX Options}
498 @gccoptlist{-mmac -mpush-args}
499
500 @emph{Darwin Options}
501 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
502 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
503 -client_name  -compatibility_version  -current_version @gol
504 -dead_strip @gol
505 -dependency-file  -dylib_file  -dylinker_install_name @gol
506 -dynamic  -dynamiclib  -exported_symbols_list @gol
507 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
508 -force_flat_namespace  -headerpad_max_install_names @gol
509 -iframework @gol
510 -image_base  -init  -install_name  -keep_private_externs @gol
511 -multi_module  -multiply_defined  -multiply_defined_unused @gol
512 -noall_load   -no_dead_strip_inits_and_terms @gol
513 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
514 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
515 -private_bundle  -read_only_relocs  -sectalign @gol
516 -sectobjectsymbols  -whyload  -seg1addr @gol
517 -sectcreate  -sectobjectsymbols  -sectorder @gol
518 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
519 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
520 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
521 -single_module  -static  -sub_library  -sub_umbrella @gol
522 -twolevel_namespace  -umbrella  -undefined @gol
523 -unexported_symbols_list  -weak_reference_mismatches @gol
524 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
525 -mkernel -mone-byte-bool}
526
527 @emph{DEC Alpha Options}
528 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
529 -mieee  -mieee-with-inexact  -mieee-conformant @gol
530 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
531 -mtrap-precision=@var{mode}  -mbuild-constants @gol
532 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
533 -mbwx  -mmax  -mfix  -mcix @gol
534 -mfloat-vax  -mfloat-ieee @gol
535 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
536 -msmall-text  -mlarge-text @gol
537 -mmemory-latency=@var{time}}
538
539 @emph{DEC Alpha/VMS Options}
540 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
541
542 @emph{FR30 Options}
543 @gccoptlist{-msmall-model -mno-lsim}
544
545 @emph{FRV Options}
546 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
547 -mhard-float  -msoft-float @gol
548 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
549 -mdouble  -mno-double @gol
550 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
551 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
552 -mlinked-fp  -mlong-calls  -malign-labels @gol
553 -mlibrary-pic  -macc-4  -macc-8 @gol
554 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
555 -moptimize-membar -mno-optimize-membar @gol
556 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
557 -mvliw-branch  -mno-vliw-branch @gol
558 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
559 -mno-nested-cond-exec  -mtomcat-stats @gol
560 -mTLS -mtls @gol
561 -mcpu=@var{cpu}}
562
563 @emph{GNU/Linux Options}
564 @gccoptlist{-muclibc}
565
566 @emph{H8/300 Options}
567 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
568
569 @emph{HPPA Options}
570 @gccoptlist{-march=@var{architecture-type} @gol
571 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
572 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
573 -mfixed-range=@var{register-range} @gol
574 -mjump-in-delay -mlinker-opt -mlong-calls @gol
575 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
576 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
577 -mno-jump-in-delay  -mno-long-load-store @gol
578 -mno-portable-runtime  -mno-soft-float @gol
579 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
580 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
581 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
582 -munix=@var{unix-std}  -nolibdld  -static  -threads}
583
584 @emph{i386 and x86-64 Options}
585 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
586 -mfpmath=@var{unit} @gol
587 -masm=@var{dialect}  -mno-fancy-math-387 @gol
588 -mno-fp-ret-in-387  -msoft-float @gol
589 -mno-wide-multiply  -mrtd  -malign-double @gol
590 -mpreferred-stack-boundary=@var{num}
591 -mincoming-stack-boundary=@var{num}
592 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
593 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
594 -maes -mpclmul @gol
595 -msse4a -m3dnow -mpopcnt -mabm @gol
596 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
597 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
598 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
599 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
600 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
601 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
602 -mcmodel=@var{code-model} -mabi=@var{name} @gol
603 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
604 -msse2avx}
605
606 @emph{IA-64 Options}
607 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
608 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
609 -mconstant-gp  -mauto-pic  -mfused-madd @gol
610 -minline-float-divide-min-latency @gol
611 -minline-float-divide-max-throughput @gol
612 -mno-inline-float-divide @gol
613 -minline-int-divide-min-latency @gol
614 -minline-int-divide-max-throughput  @gol
615 -mno-inline-int-divide @gol
616 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
617 -mno-inline-sqrt @gol
618 -mdwarf2-asm -mearly-stop-bits @gol
619 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
620 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
621 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
622 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
623 -msched-spec-ldc -msched-spec-control-ldc @gol
624 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
625 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
626 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
627 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
628
629 @emph{IA-64/VMS Options}
630 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
631
632 @emph{M32R/D Options}
633 @gccoptlist{-m32r2 -m32rx -m32r @gol
634 -mdebug @gol
635 -malign-loops -mno-align-loops @gol
636 -missue-rate=@var{number} @gol
637 -mbranch-cost=@var{number} @gol
638 -mmodel=@var{code-size-model-type} @gol
639 -msdata=@var{sdata-type} @gol
640 -mno-flush-func -mflush-func=@var{name} @gol
641 -mno-flush-trap -mflush-trap=@var{number} @gol
642 -G @var{num}}
643
644 @emph{M32C Options}
645 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
646
647 @emph{M680x0 Options}
648 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
649 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
650 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
651 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
652 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
653 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
654 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
655 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
656 -mxgot -mno-xgot}
657
658 @emph{M68hc1x Options}
659 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
660 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
661 -msoft-reg-count=@var{count}}
662
663 @emph{MCore Options}
664 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
665 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
666 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
667 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
668 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
669
670 @emph{MeP Options}
671 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
672 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
673 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
674 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
675 -mtiny=@var{n}}
676
677 @emph{MIPS Options}
678 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
679 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
680 -mips64  -mips64r2 @gol
681 -mips16  -mno-mips16  -mflip-mips16 @gol
682 -minterlink-mips16  -mno-interlink-mips16 @gol
683 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
684 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
685 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
686 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
687 -mfpu=@var{fpu-type} @gol
688 -msmartmips  -mno-smartmips @gol
689 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
690 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
691 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
692 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
693 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
694 -membedded-data  -mno-embedded-data @gol
695 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
696 -mcode-readable=@var{setting} @gol
697 -msplit-addresses  -mno-split-addresses @gol
698 -mexplicit-relocs  -mno-explicit-relocs @gol
699 -mcheck-zero-division  -mno-check-zero-division @gol
700 -mdivide-traps  -mdivide-breaks @gol
701 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
702 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
703 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
704 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
705 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
706 -mflush-func=@var{func}  -mno-flush-func @gol
707 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
708 -mfp-exceptions -mno-fp-exceptions @gol
709 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
710 -mrelax-pic-calls -mno-relax-pic-calls}
711
712 @emph{MMIX Options}
713 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
714 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
715 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
716 -mno-base-addresses  -msingle-exit  -mno-single-exit}
717
718 @emph{MN10300 Options}
719 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
720 -mam33  -mno-am33 @gol
721 -mam33-2  -mno-am33-2 @gol
722 -mreturn-pointer-on-d0 @gol
723 -mno-crt0  -mrelax}
724
725 @emph{PDP-11 Options}
726 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
727 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
728 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
729 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
730 -mbranch-expensive  -mbranch-cheap @gol
731 -msplit  -mno-split  -munix-asm  -mdec-asm}
732
733 @emph{picoChip Options}
734 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
735 -msymbol-as-address -mno-inefficient-warnings}
736
737 @emph{PowerPC Options}
738 See RS/6000 and PowerPC Options.
739
740 @emph{RS/6000 and PowerPC Options}
741 @gccoptlist{-mcpu=@var{cpu-type} @gol
742 -mtune=@var{cpu-type} @gol
743 -mpower  -mno-power  -mpower2  -mno-power2 @gol
744 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
745 -maltivec  -mno-altivec @gol
746 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
747 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
748 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
749 -mfprnd  -mno-fprnd @gol
750 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
751 -mnew-mnemonics  -mold-mnemonics @gol
752 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
753 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
754 -malign-power  -malign-natural @gol
755 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
756 -msingle-float -mdouble-float -msimple-fpu @gol
757 -mstring  -mno-string  -mupdate  -mno-update @gol
758 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
759 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
760 -mstrict-align  -mno-strict-align  -mrelocatable @gol
761 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
762 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
763 -mdynamic-no-pic  -maltivec -mswdiv @gol
764 -mprioritize-restricted-insns=@var{priority} @gol
765 -msched-costly-dep=@var{dependence_type} @gol
766 -minsert-sched-nops=@var{scheme} @gol
767 -mcall-sysv  -mcall-netbsd @gol
768 -maix-struct-return  -msvr4-struct-return @gol
769 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
770 -misel -mno-isel @gol
771 -misel=yes  -misel=no @gol
772 -mspe -mno-spe @gol
773 -mspe=yes  -mspe=no @gol
774 -mpaired @gol
775 -mgen-cell-microcode -mwarn-cell-microcode @gol
776 -mvrsave -mno-vrsave @gol
777 -mmulhw -mno-mulhw @gol
778 -mdlmzb -mno-dlmzb @gol
779 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
780 -mprototype  -mno-prototype @gol
781 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
782 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
783
784 @emph{S/390 and zSeries Options}
785 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
786 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
787 -mlong-double-64 -mlong-double-128 @gol
788 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
789 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
790 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
791 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
792 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
793
794 @emph{Score Options}
795 @gccoptlist{-meb -mel @gol
796 -mnhwloop @gol
797 -muls @gol
798 -mmac @gol
799 -mscore5 -mscore5u -mscore7 -mscore7d}
800
801 @emph{SH Options}
802 @gccoptlist{-m1  -m2  -m2e @gol
803 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
804 -m3  -m3e @gol
805 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
806 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
807 -m5-64media  -m5-64media-nofpu @gol
808 -m5-32media  -m5-32media-nofpu @gol
809 -m5-compact  -m5-compact-nofpu @gol
810 -mb  -ml  -mdalign  -mrelax @gol
811 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
812 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
813 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
814 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
815 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
816 -minvalid-symbols}
817
818 @emph{SPARC Options}
819 @gccoptlist{-mcpu=@var{cpu-type} @gol
820 -mtune=@var{cpu-type} @gol
821 -mcmodel=@var{code-model} @gol
822 -m32  -m64  -mapp-regs  -mno-app-regs @gol
823 -mfaster-structs  -mno-faster-structs @gol
824 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
825 -mhard-quad-float  -msoft-quad-float @gol
826 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
827 -mstack-bias  -mno-stack-bias @gol
828 -munaligned-doubles  -mno-unaligned-doubles @gol
829 -mv8plus  -mno-v8plus  -mvis  -mno-vis
830 -threads -pthreads -pthread}
831
832 @emph{SPU Options}
833 @gccoptlist{-mwarn-reloc -merror-reloc @gol
834 -msafe-dma -munsafe-dma @gol
835 -mbranch-hints @gol
836 -msmall-mem -mlarge-mem -mstdmain @gol
837 -mfixed-range=@var{register-range}}
838
839 @emph{System V Options}
840 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
841
842 @emph{V850 Options}
843 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
844 -mprolog-function  -mno-prolog-function  -mspace @gol
845 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
846 -mapp-regs  -mno-app-regs @gol
847 -mdisable-callt  -mno-disable-callt @gol
848 -mv850e1 @gol
849 -mv850e @gol
850 -mv850  -mbig-switch}
851
852 @emph{VAX Options}
853 @gccoptlist{-mg  -mgnu  -munix}
854
855 @emph{VxWorks Options}
856 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
857 -Xbind-lazy  -Xbind-now}
858
859 @emph{x86-64 Options}
860 See i386 and x86-64 Options.
861
862 @emph{i386 and x86-64 Windows Options}
863 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
864 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows}
865
866 @emph{Xstormy16 Options}
867 @gccoptlist{-msim}
868
869 @emph{Xtensa Options}
870 @gccoptlist{-mconst16 -mno-const16 @gol
871 -mfused-madd  -mno-fused-madd @gol
872 -mserialize-volatile  -mno-serialize-volatile @gol
873 -mtext-section-literals  -mno-text-section-literals @gol
874 -mtarget-align  -mno-target-align @gol
875 -mlongcalls  -mno-longcalls}
876
877 @emph{zSeries Options}
878 See S/390 and zSeries Options.
879
880 @item Code Generation Options
881 @xref{Code Gen Options,,Options for Code Generation Conventions}.
882 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
883 -ffixed-@var{reg}  -fexceptions @gol
884 -fnon-call-exceptions  -funwind-tables @gol
885 -fasynchronous-unwind-tables @gol
886 -finhibit-size-directive  -finstrument-functions @gol
887 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
888 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
889 -fno-common  -fno-ident @gol
890 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
891 -fno-jump-tables @gol
892 -frecord-gcc-switches @gol
893 -freg-struct-return  -fshort-enums @gol
894 -fshort-double  -fshort-wchar @gol
895 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
896 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
897 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
898 -fargument-noalias-global  -fargument-noalias-anything @gol
899 -fleading-underscore  -ftls-model=@var{model} @gol
900 -ftrapv  -fwrapv  -fbounds-check @gol
901 -fvisibility}
902 @end table
903
904 @menu
905 * Overall Options::     Controlling the kind of output:
906                         an executable, object files, assembler files,
907                         or preprocessed source.
908 * C Dialect Options::   Controlling the variant of C language compiled.
909 * C++ Dialect Options:: Variations on C++.
910 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
911                         and Objective-C++.
912 * Language Independent Options:: Controlling how diagnostics should be
913                         formatted.
914 * Warning Options::     How picky should the compiler be?
915 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
916 * Optimize Options::    How much optimization?
917 * Preprocessor Options:: Controlling header files and macro definitions.
918                          Also, getting dependency information for Make.
919 * Assembler Options::   Passing options to the assembler.
920 * Link Options::        Specifying libraries and so on.
921 * Directory Options::   Where to find header files and libraries.
922                         Where to find the compiler executable files.
923 * Spec Files::          How to pass switches to sub-processes.
924 * Target Options::      Running a cross-compiler, or an old version of GCC.
925 @end menu
926
927 @node Overall Options
928 @section Options Controlling the Kind of Output
929
930 Compilation can involve up to four stages: preprocessing, compilation
931 proper, assembly and linking, always in that order.  GCC is capable of
932 preprocessing and compiling several files either into several
933 assembler input files, or into one assembler input file; then each
934 assembler input file produces an object file, and linking combines all
935 the object files (those newly compiled, and those specified as input)
936 into an executable file.
937
938 @cindex file name suffix
939 For any given input file, the file name suffix determines what kind of
940 compilation is done:
941
942 @table @gcctabopt
943 @item @var{file}.c
944 C source code which must be preprocessed.
945
946 @item @var{file}.i
947 C source code which should not be preprocessed.
948
949 @item @var{file}.ii
950 C++ source code which should not be preprocessed.
951
952 @item @var{file}.m
953 Objective-C source code.  Note that you must link with the @file{libobjc}
954 library to make an Objective-C program work.
955
956 @item @var{file}.mi
957 Objective-C source code which should not be preprocessed.
958
959 @item @var{file}.mm
960 @itemx @var{file}.M
961 Objective-C++ source code.  Note that you must link with the @file{libobjc}
962 library to make an Objective-C++ program work.  Note that @samp{.M} refers
963 to a literal capital M@.
964
965 @item @var{file}.mii
966 Objective-C++ source code which should not be preprocessed.
967
968 @item @var{file}.h
969 C, C++, Objective-C or Objective-C++ header file to be turned into a
970 precompiled header.
971
972 @item @var{file}.cc
973 @itemx @var{file}.cp
974 @itemx @var{file}.cxx
975 @itemx @var{file}.cpp
976 @itemx @var{file}.CPP
977 @itemx @var{file}.c++
978 @itemx @var{file}.C
979 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
980 the last two letters must both be literally @samp{x}.  Likewise,
981 @samp{.C} refers to a literal capital C@.
982
983 @item @var{file}.mm
984 @itemx @var{file}.M
985 Objective-C++ source code which must be preprocessed.
986
987 @item @var{file}.mii
988 Objective-C++ source code which should not be preprocessed.
989
990 @item @var{file}.hh
991 @itemx @var{file}.H
992 @itemx @var{file}.hp
993 @itemx @var{file}.hxx
994 @itemx @var{file}.hpp
995 @itemx @var{file}.HPP
996 @itemx @var{file}.h++
997 @itemx @var{file}.tcc
998 C++ header file to be turned into a precompiled header.
999
1000 @item @var{file}.f
1001 @itemx @var{file}.for
1002 @itemx @var{file}.ftn
1003 Fixed form Fortran source code which should not be preprocessed.
1004
1005 @item @var{file}.F
1006 @itemx @var{file}.FOR
1007 @itemx @var{file}.fpp
1008 @itemx @var{file}.FPP
1009 @itemx @var{file}.FTN
1010 Fixed form Fortran source code which must be preprocessed (with the traditional
1011 preprocessor).
1012
1013 @item @var{file}.f90
1014 @itemx @var{file}.f95
1015 @itemx @var{file}.f03
1016 @itemx @var{file}.f08
1017 Free form Fortran source code which should not be preprocessed.
1018
1019 @item @var{file}.F90
1020 @itemx @var{file}.F95
1021 @itemx @var{file}.F03
1022 @itemx @var{file}.F08
1023 Free form Fortran source code which must be preprocessed (with the
1024 traditional preprocessor).
1025
1026 @c FIXME: Descriptions of Java file types.
1027 @c @var{file}.java
1028 @c @var{file}.class
1029 @c @var{file}.zip
1030 @c @var{file}.jar
1031
1032 @item @var{file}.ads
1033 Ada source code file which contains a library unit declaration (a
1034 declaration of a package, subprogram, or generic, or a generic
1035 instantiation), or a library unit renaming declaration (a package,
1036 generic, or subprogram renaming declaration).  Such files are also
1037 called @dfn{specs}.
1038
1039 @item @var{file}.adb
1040 Ada source code file containing a library unit body (a subprogram or
1041 package body).  Such files are also called @dfn{bodies}.
1042
1043 @c GCC also knows about some suffixes for languages not yet included:
1044 @c Pascal:
1045 @c @var{file}.p
1046 @c @var{file}.pas
1047 @c Ratfor:
1048 @c @var{file}.r
1049
1050 @item @var{file}.s
1051 Assembler code.
1052
1053 @item @var{file}.S
1054 @itemx @var{file}.sx
1055 Assembler code which must be preprocessed.
1056
1057 @item @var{other}
1058 An object file to be fed straight into linking.
1059 Any file name with no recognized suffix is treated this way.
1060 @end table
1061
1062 @opindex x
1063 You can specify the input language explicitly with the @option{-x} option:
1064
1065 @table @gcctabopt
1066 @item -x @var{language}
1067 Specify explicitly the @var{language} for the following input files
1068 (rather than letting the compiler choose a default based on the file
1069 name suffix).  This option applies to all following input files until
1070 the next @option{-x} option.  Possible values for @var{language} are:
1071 @smallexample
1072 c  c-header  c-cpp-output
1073 c++  c++-header  c++-cpp-output
1074 objective-c  objective-c-header  objective-c-cpp-output
1075 objective-c++ objective-c++-header objective-c++-cpp-output
1076 assembler  assembler-with-cpp
1077 ada
1078 f77  f77-cpp-input f95  f95-cpp-input
1079 java
1080 @end smallexample
1081
1082 @item -x none
1083 Turn off any specification of a language, so that subsequent files are
1084 handled according to their file name suffixes (as they are if @option{-x}
1085 has not been used at all).
1086
1087 @item -pass-exit-codes
1088 @opindex pass-exit-codes
1089 Normally the @command{gcc} program will exit with the code of 1 if any
1090 phase of the compiler returns a non-success return code.  If you specify
1091 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1092 numerically highest error produced by any phase that returned an error
1093 indication.  The C, C++, and Fortran frontends return 4, if an internal
1094 compiler error is encountered.
1095 @end table
1096
1097 If you only want some of the stages of compilation, you can use
1098 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1099 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1100 @command{gcc} is to stop.  Note that some combinations (for example,
1101 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1102
1103 @table @gcctabopt
1104 @item -c
1105 @opindex c
1106 Compile or assemble the source files, but do not link.  The linking
1107 stage simply is not done.  The ultimate output is in the form of an
1108 object file for each source file.
1109
1110 By default, the object file name for a source file is made by replacing
1111 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1112
1113 Unrecognized input files, not requiring compilation or assembly, are
1114 ignored.
1115
1116 @item -S
1117 @opindex S
1118 Stop after the stage of compilation proper; do not assemble.  The output
1119 is in the form of an assembler code file for each non-assembler input
1120 file specified.
1121
1122 By default, the assembler file name for a source file is made by
1123 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1124
1125 Input files that don't require compilation are ignored.
1126
1127 @item -E
1128 @opindex E
1129 Stop after the preprocessing stage; do not run the compiler proper.  The
1130 output is in the form of preprocessed source code, which is sent to the
1131 standard output.
1132
1133 Input files which don't require preprocessing are ignored.
1134
1135 @cindex output file option
1136 @item -o @var{file}
1137 @opindex o
1138 Place output in file @var{file}.  This applies regardless to whatever
1139 sort of output is being produced, whether it be an executable file,
1140 an object file, an assembler file or preprocessed C code.
1141
1142 If @option{-o} is not specified, the default is to put an executable
1143 file in @file{a.out}, the object file for
1144 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1145 assembler file in @file{@var{source}.s}, a precompiled header file in
1146 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1147 standard output.
1148
1149 @item -v
1150 @opindex v
1151 Print (on standard error output) the commands executed to run the stages
1152 of compilation.  Also print the version number of the compiler driver
1153 program and of the preprocessor and the compiler proper.
1154
1155 @item -###
1156 @opindex ###
1157 Like @option{-v} except the commands are not executed and all command
1158 arguments are quoted.  This is useful for shell scripts to capture the
1159 driver-generated command lines.
1160
1161 @item -pipe
1162 @opindex pipe
1163 Use pipes rather than temporary files for communication between the
1164 various stages of compilation.  This fails to work on some systems where
1165 the assembler is unable to read from a pipe; but the GNU assembler has
1166 no trouble.
1167
1168 @item -combine
1169 @opindex combine
1170 If you are compiling multiple source files, this option tells the driver
1171 to pass all the source files to the compiler at once (for those
1172 languages for which the compiler can handle this).  This will allow
1173 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1174 language for which this is supported is C@.  If you pass source files for
1175 multiple languages to the driver, using this option, the driver will invoke
1176 the compiler(s) that support IMA once each, passing each compiler all the
1177 source files appropriate for it.  For those languages that do not support
1178 IMA this option will be ignored, and the compiler will be invoked once for
1179 each source file in that language.  If you use this option in conjunction
1180 with @option{-save-temps}, the compiler will generate multiple
1181 pre-processed files
1182 (one for each source file), but only one (combined) @file{.o} or
1183 @file{.s} file.
1184
1185 @item --help
1186 @opindex help
1187 Print (on the standard output) a description of the command line options
1188 understood by @command{gcc}.  If the @option{-v} option is also specified
1189 then @option{--help} will also be passed on to the various processes
1190 invoked by @command{gcc}, so that they can display the command line options
1191 they accept.  If the @option{-Wextra} option has also been specified
1192 (prior to the @option{--help} option), then command line options which
1193 have no documentation associated with them will also be displayed.
1194
1195 @item --target-help
1196 @opindex target-help
1197 Print (on the standard output) a description of target-specific command
1198 line options for each tool.  For some targets extra target-specific
1199 information may also be printed.
1200
1201 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1202 Print (on the standard output) a description of the command line
1203 options understood by the compiler that fit into all specified classes
1204 and qualifiers.  These are the supported classes:
1205
1206 @table @asis
1207 @item @samp{optimizers}
1208 This will display all of the optimization options supported by the
1209 compiler.
1210
1211 @item @samp{warnings}
1212 This will display all of the options controlling warning messages
1213 produced by the compiler.
1214
1215 @item @samp{target}
1216 This will display target-specific options.  Unlike the
1217 @option{--target-help} option however, target-specific options of the
1218 linker and assembler will not be displayed.  This is because those
1219 tools do not currently support the extended @option{--help=} syntax.
1220
1221 @item @samp{params}
1222 This will display the values recognized by the @option{--param}
1223 option.
1224
1225 @item @var{language}
1226 This will display the options supported for @var{language}, where
1227 @var{language} is the name of one of the languages supported in this
1228 version of GCC.
1229
1230 @item @samp{common}
1231 This will display the options that are common to all languages.
1232 @end table
1233
1234 These are the supported qualifiers:
1235
1236 @table @asis
1237 @item @samp{undocumented}
1238 Display only those options which are undocumented.
1239
1240 @item @samp{joined}
1241 Display options which take an argument that appears after an equal
1242 sign in the same continuous piece of text, such as:
1243 @samp{--help=target}.
1244
1245 @item @samp{separate}
1246 Display options which take an argument that appears as a separate word
1247 following the original option, such as: @samp{-o output-file}.
1248 @end table
1249
1250 Thus for example to display all the undocumented target-specific
1251 switches supported by the compiler the following can be used:
1252
1253 @smallexample
1254 --help=target,undocumented
1255 @end smallexample
1256
1257 The sense of a qualifier can be inverted by prefixing it with the
1258 @samp{^} character, so for example to display all binary warning
1259 options (i.e., ones that are either on or off and that do not take an
1260 argument), which have a description the following can be used:
1261
1262 @smallexample
1263 --help=warnings,^joined,^undocumented
1264 @end smallexample
1265
1266 The argument to @option{--help=} should not consist solely of inverted
1267 qualifiers.
1268
1269 Combining several classes is possible, although this usually
1270 restricts the output by so much that there is nothing to display.  One
1271 case where it does work however is when one of the classes is
1272 @var{target}.  So for example to display all the target-specific
1273 optimization options the following can be used:
1274
1275 @smallexample
1276 --help=target,optimizers
1277 @end smallexample
1278
1279 The @option{--help=} option can be repeated on the command line.  Each
1280 successive use will display its requested class of options, skipping
1281 those that have already been displayed.
1282
1283 If the @option{-Q} option appears on the command line before the
1284 @option{--help=} option, then the descriptive text displayed by
1285 @option{--help=} is changed.  Instead of describing the displayed
1286 options, an indication is given as to whether the option is enabled,
1287 disabled or set to a specific value (assuming that the compiler
1288 knows this at the point where the @option{--help=} option is used).
1289
1290 Here is a truncated example from the ARM port of @command{gcc}:
1291
1292 @smallexample
1293   % gcc -Q -mabi=2 --help=target -c
1294   The following options are target specific:
1295   -mabi=                                2
1296   -mabort-on-noreturn                   [disabled]
1297   -mapcs                                [disabled]
1298 @end smallexample
1299
1300 The output is sensitive to the effects of previous command line
1301 options, so for example it is possible to find out which optimizations
1302 are enabled at @option{-O2} by using:
1303
1304 @smallexample
1305 -Q -O2 --help=optimizers
1306 @end smallexample
1307
1308 Alternatively you can discover which binary optimizations are enabled
1309 by @option{-O3} by using:
1310
1311 @smallexample
1312 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1313 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1314 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1315 @end smallexample
1316
1317 @item -no-canonical-prefixes
1318 @opindex no-canonical-prefixes
1319 Do not expand any symbolic links, resolve references to @samp{/../}
1320 or @samp{/./}, or make the path absolute when generating a relative
1321 prefix.
1322
1323 @item --version
1324 @opindex version
1325 Display the version number and copyrights of the invoked GCC@.
1326
1327 @item -wrapper
1328 @opindex wrapper
1329 Invoke all subcommands under a wrapper program. It takes a single
1330 comma separated list as an argument, which will be used to invoke
1331 the wrapper:
1332
1333 @smallexample
1334 gcc -c t.c -wrapper gdb,--args
1335 @end smallexample
1336
1337 This will invoke all subprograms of gcc under "gdb --args",
1338 thus cc1 invocation will be "gdb --args cc1 ...".
1339
1340 @item -fplugin=@var{name}.so
1341 Load the plugin code in file @var{name}.so, assumed to be a
1342 shared object to be dlopen'd by the compiler.  The base name of
1343 the shared object file is used to identify the plugin for the
1344 purposes of argument parsing (See
1345 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1346 Each plugin should define the callback functions specified in the
1347 Plugins API.
1348
1349 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1350 Define an argument called @var{key} with a value of @var{value}
1351 for the plugin called @var{name}.
1352
1353 @include @value{srcdir}/../libiberty/at-file.texi
1354 @end table
1355
1356 @node Invoking G++
1357 @section Compiling C++ Programs
1358
1359 @cindex suffixes for C++ source
1360 @cindex C++ source file suffixes
1361 C++ source files conventionally use one of the suffixes @samp{.C},
1362 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1363 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1364 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1365 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1366 files with these names and compiles them as C++ programs even if you
1367 call the compiler the same way as for compiling C programs (usually
1368 with the name @command{gcc}).
1369
1370 @findex g++
1371 @findex c++
1372 However, the use of @command{gcc} does not add the C++ library.
1373 @command{g++} is a program that calls GCC and treats @samp{.c},
1374 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1375 files unless @option{-x} is used, and automatically specifies linking
1376 against the C++ library.  This program is also useful when
1377 precompiling a C header file with a @samp{.h} extension for use in C++
1378 compilations.  On many systems, @command{g++} is also installed with
1379 the name @command{c++}.
1380
1381 @cindex invoking @command{g++}
1382 When you compile C++ programs, you may specify many of the same
1383 command-line options that you use for compiling programs in any
1384 language; or command-line options meaningful for C and related
1385 languages; or options that are meaningful only for C++ programs.
1386 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1387 explanations of options for languages related to C@.
1388 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1389 explanations of options that are meaningful only for C++ programs.
1390
1391 @node C Dialect Options
1392 @section Options Controlling C Dialect
1393 @cindex dialect options
1394 @cindex language dialect options
1395 @cindex options, dialect
1396
1397 The following options control the dialect of C (or languages derived
1398 from C, such as C++, Objective-C and Objective-C++) that the compiler
1399 accepts:
1400
1401 @table @gcctabopt
1402 @cindex ANSI support
1403 @cindex ISO support
1404 @item -ansi
1405 @opindex ansi
1406 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1407 equivalent to @samp{-std=c++98}.
1408
1409 This turns off certain features of GCC that are incompatible with ISO
1410 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1411 such as the @code{asm} and @code{typeof} keywords, and
1412 predefined macros such as @code{unix} and @code{vax} that identify the
1413 type of system you are using.  It also enables the undesirable and
1414 rarely used ISO trigraph feature.  For the C compiler,
1415 it disables recognition of C++ style @samp{//} comments as well as
1416 the @code{inline} keyword.
1417
1418 The alternate keywords @code{__asm__}, @code{__extension__},
1419 @code{__inline__} and @code{__typeof__} continue to work despite
1420 @option{-ansi}.  You would not want to use them in an ISO C program, of
1421 course, but it is useful to put them in header files that might be included
1422 in compilations done with @option{-ansi}.  Alternate predefined macros
1423 such as @code{__unix__} and @code{__vax__} are also available, with or
1424 without @option{-ansi}.
1425
1426 The @option{-ansi} option does not cause non-ISO programs to be
1427 rejected gratuitously.  For that, @option{-pedantic} is required in
1428 addition to @option{-ansi}.  @xref{Warning Options}.
1429
1430 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1431 option is used.  Some header files may notice this macro and refrain
1432 from declaring certain functions or defining certain macros that the
1433 ISO standard doesn't call for; this is to avoid interfering with any
1434 programs that might use these names for other things.
1435
1436 Functions that would normally be built in but do not have semantics
1437 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1438 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1439 built-in functions provided by GCC}, for details of the functions
1440 affected.
1441
1442 @item -std=
1443 @opindex std
1444 Determine the language standard. @xref{Standards,,Language Standards
1445 Supported by GCC}, for details of these standard versions.  This option
1446 is currently only supported when compiling C or C++.
1447
1448 The compiler can accept several base standards, such as @samp{c89} or
1449 @samp{c++98}, and GNU dialects of those standards, such as
1450 @samp{gnu89} or @samp{gnu++98}.  By specifying a base standard, the
1451 compiler will accept all programs following that standard and those
1452 using GNU extensions that do not contradict it.  For example,
1453 @samp{-std=c89} turns off certain features of GCC that are
1454 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1455 keywords, but not other GNU extensions that do not have a meaning in
1456 ISO C90, such as omitting the middle term of a @code{?:}
1457 expression. On the other hand, by specifying a GNU dialect of a
1458 standard, all features the compiler support are enabled, even when
1459 those features change the meaning of the base standard and some
1460 strict-conforming programs may be rejected.  The particular standard
1461 is used by @option{-pedantic} to identify which features are GNU
1462 extensions given that version of the standard. For example
1463 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1464 comments, while @samp{-std=gnu99 -pedantic} would not.
1465
1466 A value for this option must be provided; possible values are
1467
1468 @table @samp
1469 @item c89
1470 @itemx iso9899:1990
1471 Support all ISO C90 programs (certain GNU extensions that conflict
1472 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1473
1474 @item iso9899:199409
1475 ISO C90 as modified in amendment 1.
1476
1477 @item c99
1478 @itemx c9x
1479 @itemx iso9899:1999
1480 @itemx iso9899:199x
1481 ISO C99.  Note that this standard is not yet fully supported; see
1482 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1483 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1484
1485 @item gnu89
1486 GNU dialect of ISO C90 (including some C99 features). This
1487 is the default for C code.
1488
1489 @item gnu99
1490 @itemx gnu9x
1491 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1492 this will become the default.  The name @samp{gnu9x} is deprecated.
1493
1494 @item c++98
1495 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1496 C++ code.
1497
1498 @item gnu++98
1499 GNU dialect of @option{-std=c++98}.  This is the default for
1500 C++ code.
1501
1502 @item c++0x
1503 The working draft of the upcoming ISO C++0x standard. This option
1504 enables experimental features that are likely to be included in
1505 C++0x. The working draft is constantly changing, and any feature that is
1506 enabled by this flag may be removed from future versions of GCC if it is
1507 not part of the C++0x standard.
1508
1509 @item gnu++0x
1510 GNU dialect of @option{-std=c++0x}. This option enables
1511 experimental features that may be removed in future versions of GCC.
1512 @end table
1513
1514 @item -fgnu89-inline
1515 @opindex fgnu89-inline
1516 The option @option{-fgnu89-inline} tells GCC to use the traditional
1517 GNU semantics for @code{inline} functions when in C99 mode.
1518 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1519 is accepted and ignored by GCC versions 4.1.3 up to but not including
1520 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1521 C99 mode.  Using this option is roughly equivalent to adding the
1522 @code{gnu_inline} function attribute to all inline functions
1523 (@pxref{Function Attributes}).
1524
1525 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1526 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1527 specifies the default behavior).  This option was first supported in
1528 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1529
1530 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1531 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1532 in effect for @code{inline} functions.  @xref{Common Predefined
1533 Macros,,,cpp,The C Preprocessor}.
1534
1535 @item -aux-info @var{filename}
1536 @opindex aux-info
1537 Output to the given filename prototyped declarations for all functions
1538 declared and/or defined in a translation unit, including those in header
1539 files.  This option is silently ignored in any language other than C@.
1540
1541 Besides declarations, the file indicates, in comments, the origin of
1542 each declaration (source file and line), whether the declaration was
1543 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1544 @samp{O} for old, respectively, in the first character after the line
1545 number and the colon), and whether it came from a declaration or a
1546 definition (@samp{C} or @samp{F}, respectively, in the following
1547 character).  In the case of function definitions, a K&R-style list of
1548 arguments followed by their declarations is also provided, inside
1549 comments, after the declaration.
1550
1551 @item -fno-asm
1552 @opindex fno-asm
1553 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1554 keyword, so that code can use these words as identifiers.  You can use
1555 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1556 instead.  @option{-ansi} implies @option{-fno-asm}.
1557
1558 In C++, this switch only affects the @code{typeof} keyword, since
1559 @code{asm} and @code{inline} are standard keywords.  You may want to
1560 use the @option{-fno-gnu-keywords} flag instead, which has the same
1561 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1562 switch only affects the @code{asm} and @code{typeof} keywords, since
1563 @code{inline} is a standard keyword in ISO C99.
1564
1565 @item -fno-builtin
1566 @itemx -fno-builtin-@var{function}
1567 @opindex fno-builtin
1568 @cindex built-in functions
1569 Don't recognize built-in functions that do not begin with
1570 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1571 functions provided by GCC}, for details of the functions affected,
1572 including those which are not built-in functions when @option{-ansi} or
1573 @option{-std} options for strict ISO C conformance are used because they
1574 do not have an ISO standard meaning.
1575
1576 GCC normally generates special code to handle certain built-in functions
1577 more efficiently; for instance, calls to @code{alloca} may become single
1578 instructions that adjust the stack directly, and calls to @code{memcpy}
1579 may become inline copy loops.  The resulting code is often both smaller
1580 and faster, but since the function calls no longer appear as such, you
1581 cannot set a breakpoint on those calls, nor can you change the behavior
1582 of the functions by linking with a different library.  In addition,
1583 when a function is recognized as a built-in function, GCC may use
1584 information about that function to warn about problems with calls to
1585 that function, or to generate more efficient code, even if the
1586 resulting code still contains calls to that function.  For example,
1587 warnings are given with @option{-Wformat} for bad calls to
1588 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1589 known not to modify global memory.
1590
1591 With the @option{-fno-builtin-@var{function}} option
1592 only the built-in function @var{function} is
1593 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1594 function is named that is not built-in in this version of GCC, this
1595 option is ignored.  There is no corresponding
1596 @option{-fbuiltin-@var{function}} option; if you wish to enable
1597 built-in functions selectively when using @option{-fno-builtin} or
1598 @option{-ffreestanding}, you may define macros such as:
1599
1600 @smallexample
1601 #define abs(n)          __builtin_abs ((n))
1602 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1603 @end smallexample
1604
1605 @item -fhosted
1606 @opindex fhosted
1607 @cindex hosted environment
1608
1609 Assert that compilation takes place in a hosted environment.  This implies
1610 @option{-fbuiltin}.  A hosted environment is one in which the
1611 entire standard library is available, and in which @code{main} has a return
1612 type of @code{int}.  Examples are nearly everything except a kernel.
1613 This is equivalent to @option{-fno-freestanding}.
1614
1615 @item -ffreestanding
1616 @opindex ffreestanding
1617 @cindex hosted environment
1618
1619 Assert that compilation takes place in a freestanding environment.  This
1620 implies @option{-fno-builtin}.  A freestanding environment
1621 is one in which the standard library may not exist, and program startup may
1622 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1623 This is equivalent to @option{-fno-hosted}.
1624
1625 @xref{Standards,,Language Standards Supported by GCC}, for details of
1626 freestanding and hosted environments.
1627
1628 @item -fopenmp
1629 @opindex fopenmp
1630 @cindex openmp parallel
1631 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1632 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1633 compiler generates parallel code according to the OpenMP Application
1634 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1635 implies @option{-pthread}, and thus is only supported on targets that
1636 have support for @option{-pthread}.
1637
1638 @item -fms-extensions
1639 @opindex fms-extensions
1640 Accept some non-standard constructs used in Microsoft header files.
1641
1642 Some cases of unnamed fields in structures and unions are only
1643 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1644 fields within structs/unions}, for details.
1645
1646 @item -trigraphs
1647 @opindex trigraphs
1648 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1649 options for strict ISO C conformance) implies @option{-trigraphs}.
1650
1651 @item -no-integrated-cpp
1652 @opindex no-integrated-cpp
1653 Performs a compilation in two passes: preprocessing and compiling.  This
1654 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1655 @option{-B} option.  The user supplied compilation step can then add in
1656 an additional preprocessing step after normal preprocessing but before
1657 compiling.  The default is to use the integrated cpp (internal cpp)
1658
1659 The semantics of this option will change if "cc1", "cc1plus", and
1660 "cc1obj" are merged.
1661
1662 @cindex traditional C language
1663 @cindex C language, traditional
1664 @item -traditional
1665 @itemx -traditional-cpp
1666 @opindex traditional-cpp
1667 @opindex traditional
1668 Formerly, these options caused GCC to attempt to emulate a pre-standard
1669 C compiler.  They are now only supported with the @option{-E} switch.
1670 The preprocessor continues to support a pre-standard mode.  See the GNU
1671 CPP manual for details.
1672
1673 @item -fcond-mismatch
1674 @opindex fcond-mismatch
1675 Allow conditional expressions with mismatched types in the second and
1676 third arguments.  The value of such an expression is void.  This option
1677 is not supported for C++.
1678
1679 @item -flax-vector-conversions
1680 @opindex flax-vector-conversions
1681 Allow implicit conversions between vectors with differing numbers of
1682 elements and/or incompatible element types.  This option should not be
1683 used for new code.
1684
1685 @item -funsigned-char
1686 @opindex funsigned-char
1687 Let the type @code{char} be unsigned, like @code{unsigned char}.
1688
1689 Each kind of machine has a default for what @code{char} should
1690 be.  It is either like @code{unsigned char} by default or like
1691 @code{signed char} by default.
1692
1693 Ideally, a portable program should always use @code{signed char} or
1694 @code{unsigned char} when it depends on the signedness of an object.
1695 But many programs have been written to use plain @code{char} and
1696 expect it to be signed, or expect it to be unsigned, depending on the
1697 machines they were written for.  This option, and its inverse, let you
1698 make such a program work with the opposite default.
1699
1700 The type @code{char} is always a distinct type from each of
1701 @code{signed char} or @code{unsigned char}, even though its behavior
1702 is always just like one of those two.
1703
1704 @item -fsigned-char
1705 @opindex fsigned-char
1706 Let the type @code{char} be signed, like @code{signed char}.
1707
1708 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1709 the negative form of @option{-funsigned-char}.  Likewise, the option
1710 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1711
1712 @item -fsigned-bitfields
1713 @itemx -funsigned-bitfields
1714 @itemx -fno-signed-bitfields
1715 @itemx -fno-unsigned-bitfields
1716 @opindex fsigned-bitfields
1717 @opindex funsigned-bitfields
1718 @opindex fno-signed-bitfields
1719 @opindex fno-unsigned-bitfields
1720 These options control whether a bit-field is signed or unsigned, when the
1721 declaration does not use either @code{signed} or @code{unsigned}.  By
1722 default, such a bit-field is signed, because this is consistent: the
1723 basic integer types such as @code{int} are signed types.
1724 @end table
1725
1726 @node C++ Dialect Options
1727 @section Options Controlling C++ Dialect
1728
1729 @cindex compiler options, C++
1730 @cindex C++ options, command line
1731 @cindex options, C++
1732 This section describes the command-line options that are only meaningful
1733 for C++ programs; but you can also use most of the GNU compiler options
1734 regardless of what language your program is in.  For example, you
1735 might compile a file @code{firstClass.C} like this:
1736
1737 @smallexample
1738 g++ -g -frepo -O -c firstClass.C
1739 @end smallexample
1740
1741 @noindent
1742 In this example, only @option{-frepo} is an option meant
1743 only for C++ programs; you can use the other options with any
1744 language supported by GCC@.
1745
1746 Here is a list of options that are @emph{only} for compiling C++ programs:
1747
1748 @table @gcctabopt
1749
1750 @item -fabi-version=@var{n}
1751 @opindex fabi-version
1752 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1753 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1754 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1755 the version that conforms most closely to the C++ ABI specification.
1756 Therefore, the ABI obtained using version 0 will change as ABI bugs
1757 are fixed.
1758
1759 The default is version 2.
1760
1761 @item -fno-access-control
1762 @opindex fno-access-control
1763 Turn off all access checking.  This switch is mainly useful for working
1764 around bugs in the access control code.
1765
1766 @item -fcheck-new
1767 @opindex fcheck-new
1768 Check that the pointer returned by @code{operator new} is non-null
1769 before attempting to modify the storage allocated.  This check is
1770 normally unnecessary because the C++ standard specifies that
1771 @code{operator new} will only return @code{0} if it is declared
1772 @samp{throw()}, in which case the compiler will always check the
1773 return value even without this option.  In all other cases, when
1774 @code{operator new} has a non-empty exception specification, memory
1775 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1776 @samp{new (nothrow)}.
1777
1778 @item -fconserve-space
1779 @opindex fconserve-space
1780 Put uninitialized or runtime-initialized global variables into the
1781 common segment, as C does.  This saves space in the executable at the
1782 cost of not diagnosing duplicate definitions.  If you compile with this
1783 flag and your program mysteriously crashes after @code{main()} has
1784 completed, you may have an object that is being destroyed twice because
1785 two definitions were merged.
1786
1787 This option is no longer useful on most targets, now that support has
1788 been added for putting variables into BSS without making them common.
1789
1790 @item -fno-deduce-init-list
1791 @opindex fno-deduce-init-list
1792 Disable deduction of a template type parameter as
1793 std::initializer_list from a brace-enclosed initializer list, i.e.
1794
1795 @smallexample
1796 template <class T> auto forward(T t) -> decltype (realfn (t))
1797 @{
1798   return realfn (t);
1799 @}
1800
1801 void f()
1802 @{
1803   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1804 @}
1805 @end smallexample
1806
1807 This option is present because this deduction is an extension to the
1808 current specification in the C++0x working draft, and there was
1809 some concern about potential overload resolution problems.
1810
1811 @item -ffriend-injection
1812 @opindex ffriend-injection
1813 Inject friend functions into the enclosing namespace, so that they are
1814 visible outside the scope of the class in which they are declared.
1815 Friend functions were documented to work this way in the old Annotated
1816 C++ Reference Manual, and versions of G++ before 4.1 always worked
1817 that way.  However, in ISO C++ a friend function which is not declared
1818 in an enclosing scope can only be found using argument dependent
1819 lookup.  This option causes friends to be injected as they were in
1820 earlier releases.
1821
1822 This option is for compatibility, and may be removed in a future
1823 release of G++.
1824
1825 @item -fno-elide-constructors
1826 @opindex fno-elide-constructors
1827 The C++ standard allows an implementation to omit creating a temporary
1828 which is only used to initialize another object of the same type.
1829 Specifying this option disables that optimization, and forces G++ to
1830 call the copy constructor in all cases.
1831
1832 @item -fno-enforce-eh-specs
1833 @opindex fno-enforce-eh-specs
1834 Don't generate code to check for violation of exception specifications
1835 at runtime.  This option violates the C++ standard, but may be useful
1836 for reducing code size in production builds, much like defining
1837 @samp{NDEBUG}.  This does not give user code permission to throw
1838 exceptions in violation of the exception specifications; the compiler
1839 will still optimize based on the specifications, so throwing an
1840 unexpected exception will result in undefined behavior.
1841
1842 @item -ffor-scope
1843 @itemx -fno-for-scope
1844 @opindex ffor-scope
1845 @opindex fno-for-scope
1846 If @option{-ffor-scope} is specified, the scope of variables declared in
1847 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1848 as specified by the C++ standard.
1849 If @option{-fno-for-scope} is specified, the scope of variables declared in
1850 a @i{for-init-statement} extends to the end of the enclosing scope,
1851 as was the case in old versions of G++, and other (traditional)
1852 implementations of C++.
1853
1854 The default if neither flag is given to follow the standard,
1855 but to allow and give a warning for old-style code that would
1856 otherwise be invalid, or have different behavior.
1857
1858 @item -fno-gnu-keywords
1859 @opindex fno-gnu-keywords
1860 Do not recognize @code{typeof} as a keyword, so that code can use this
1861 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1862 @option{-ansi} implies @option{-fno-gnu-keywords}.
1863
1864 @item -fno-implicit-templates
1865 @opindex fno-implicit-templates
1866 Never emit code for non-inline templates which are instantiated
1867 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1868 @xref{Template Instantiation}, for more information.
1869
1870 @item -fno-implicit-inline-templates
1871 @opindex fno-implicit-inline-templates
1872 Don't emit code for implicit instantiations of inline templates, either.
1873 The default is to handle inlines differently so that compiles with and
1874 without optimization will need the same set of explicit instantiations.
1875
1876 @item -fno-implement-inlines
1877 @opindex fno-implement-inlines
1878 To save space, do not emit out-of-line copies of inline functions
1879 controlled by @samp{#pragma implementation}.  This will cause linker
1880 errors if these functions are not inlined everywhere they are called.
1881
1882 @item -fms-extensions
1883 @opindex fms-extensions
1884 Disable pedantic warnings about constructs used in MFC, such as implicit
1885 int and getting a pointer to member function via non-standard syntax.
1886
1887 @item -fno-nonansi-builtins
1888 @opindex fno-nonansi-builtins
1889 Disable built-in declarations of functions that are not mandated by
1890 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1891 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1892
1893 @item -fno-operator-names
1894 @opindex fno-operator-names
1895 Do not treat the operator name keywords @code{and}, @code{bitand},
1896 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1897 synonyms as keywords.
1898
1899 @item -fno-optional-diags
1900 @opindex fno-optional-diags
1901 Disable diagnostics that the standard says a compiler does not need to
1902 issue.  Currently, the only such diagnostic issued by G++ is the one for
1903 a name having multiple meanings within a class.
1904
1905 @item -fpermissive
1906 @opindex fpermissive
1907 Downgrade some diagnostics about nonconformant code from errors to
1908 warnings.  Thus, using @option{-fpermissive} will allow some
1909 nonconforming code to compile.
1910
1911 @item -fno-pretty-templates
1912 @opindex fno-pretty-templates
1913 When an error message refers to a specialization of a function
1914 template, the compiler will normally print the signature of the
1915 template followed by the template arguments and any typedefs or
1916 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1917 rather than @code{void f(int)}) so that it's clear which template is
1918 involved.  When an error message refers to a specialization of a class
1919 template, the compiler will omit any template arguments which match
1920 the default template arguments for that template.  If either of these
1921 behaviors make it harder to understand the error message rather than
1922 easier, using @option{-fno-pretty-templates} will disable them.
1923
1924 @item -frepo
1925 @opindex frepo
1926 Enable automatic template instantiation at link time.  This option also
1927 implies @option{-fno-implicit-templates}.  @xref{Template
1928 Instantiation}, for more information.
1929
1930 @item -fno-rtti
1931 @opindex fno-rtti
1932 Disable generation of information about every class with virtual
1933 functions for use by the C++ runtime type identification features
1934 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1935 of the language, you can save some space by using this flag.  Note that
1936 exception handling uses the same information, but it will generate it as
1937 needed. The @samp{dynamic_cast} operator can still be used for casts that
1938 do not require runtime type information, i.e.@: casts to @code{void *} or to
1939 unambiguous base classes.
1940
1941 @item -fstats
1942 @opindex fstats
1943 Emit statistics about front-end processing at the end of the compilation.
1944 This information is generally only useful to the G++ development team.
1945
1946 @item -ftemplate-depth-@var{n}
1947 @opindex ftemplate-depth
1948 Set the maximum instantiation depth for template classes to @var{n}.
1949 A limit on the template instantiation depth is needed to detect
1950 endless recursions during template class instantiation.  ANSI/ISO C++
1951 conforming programs must not rely on a maximum depth greater than 17
1952 (changed to 1024 in C++0x).
1953
1954 @item -fno-threadsafe-statics
1955 @opindex fno-threadsafe-statics
1956 Do not emit the extra code to use the routines specified in the C++
1957 ABI for thread-safe initialization of local statics.  You can use this
1958 option to reduce code size slightly in code that doesn't need to be
1959 thread-safe.
1960
1961 @item -fuse-cxa-atexit
1962 @opindex fuse-cxa-atexit
1963 Register destructors for objects with static storage duration with the
1964 @code{__cxa_atexit} function rather than the @code{atexit} function.
1965 This option is required for fully standards-compliant handling of static
1966 destructors, but will only work if your C library supports
1967 @code{__cxa_atexit}.
1968
1969 @item -fno-use-cxa-get-exception-ptr
1970 @opindex fno-use-cxa-get-exception-ptr
1971 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1972 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1973 if the runtime routine is not available.
1974
1975 @item -fvisibility-inlines-hidden
1976 @opindex fvisibility-inlines-hidden
1977 This switch declares that the user does not attempt to compare
1978 pointers to inline methods where the addresses of the two functions
1979 were taken in different shared objects.
1980
1981 The effect of this is that GCC may, effectively, mark inline methods with
1982 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1983 appear in the export table of a DSO and do not require a PLT indirection
1984 when used within the DSO@.  Enabling this option can have a dramatic effect
1985 on load and link times of a DSO as it massively reduces the size of the
1986 dynamic export table when the library makes heavy use of templates.
1987
1988 The behavior of this switch is not quite the same as marking the
1989 methods as hidden directly, because it does not affect static variables
1990 local to the function or cause the compiler to deduce that
1991 the function is defined in only one shared object.
1992
1993 You may mark a method as having a visibility explicitly to negate the
1994 effect of the switch for that method.  For example, if you do want to
1995 compare pointers to a particular inline method, you might mark it as
1996 having default visibility.  Marking the enclosing class with explicit
1997 visibility will have no effect.
1998
1999 Explicitly instantiated inline methods are unaffected by this option
2000 as their linkage might otherwise cross a shared library boundary.
2001 @xref{Template Instantiation}.
2002
2003 @item -fvisibility-ms-compat
2004 @opindex fvisibility-ms-compat
2005 This flag attempts to use visibility settings to make GCC's C++
2006 linkage model compatible with that of Microsoft Visual Studio.
2007
2008 The flag makes these changes to GCC's linkage model:
2009
2010 @enumerate
2011 @item
2012 It sets the default visibility to @code{hidden}, like
2013 @option{-fvisibility=hidden}.
2014
2015 @item
2016 Types, but not their members, are not hidden by default.
2017
2018 @item
2019 The One Definition Rule is relaxed for types without explicit
2020 visibility specifications which are defined in more than one different
2021 shared object: those declarations are permitted if they would have
2022 been permitted when this option was not used.
2023 @end enumerate
2024
2025 In new code it is better to use @option{-fvisibility=hidden} and
2026 export those classes which are intended to be externally visible.
2027 Unfortunately it is possible for code to rely, perhaps accidentally,
2028 on the Visual Studio behavior.
2029
2030 Among the consequences of these changes are that static data members
2031 of the same type with the same name but defined in different shared
2032 objects will be different, so changing one will not change the other;
2033 and that pointers to function members defined in different shared
2034 objects may not compare equal.  When this flag is given, it is a
2035 violation of the ODR to define types with the same name differently.
2036
2037 @item -fno-weak
2038 @opindex fno-weak
2039 Do not use weak symbol support, even if it is provided by the linker.
2040 By default, G++ will use weak symbols if they are available.  This
2041 option exists only for testing, and should not be used by end-users;
2042 it will result in inferior code and has no benefits.  This option may
2043 be removed in a future release of G++.
2044
2045 @item -nostdinc++
2046 @opindex nostdinc++
2047 Do not search for header files in the standard directories specific to
2048 C++, but do still search the other standard directories.  (This option
2049 is used when building the C++ library.)
2050 @end table
2051
2052 In addition, these optimization, warning, and code generation options
2053 have meanings only for C++ programs:
2054
2055 @table @gcctabopt
2056 @item -fno-default-inline
2057 @opindex fno-default-inline
2058 Do not assume @samp{inline} for functions defined inside a class scope.
2059 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2060 functions will have linkage like inline functions; they just won't be
2061 inlined by default.
2062
2063 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2064 @opindex Wabi
2065 @opindex Wno-abi
2066 Warn when G++ generates code that is probably not compatible with the
2067 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2068 all such cases, there are probably some cases that are not warned about,
2069 even though G++ is generating incompatible code.  There may also be
2070 cases where warnings are emitted even though the code that is generated
2071 will be compatible.
2072
2073 You should rewrite your code to avoid these warnings if you are
2074 concerned about the fact that code generated by G++ may not be binary
2075 compatible with code generated by other compilers.
2076
2077 The known incompatibilities at this point include:
2078
2079 @itemize @bullet
2080
2081 @item
2082 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2083 pack data into the same byte as a base class.  For example:
2084
2085 @smallexample
2086 struct A @{ virtual void f(); int f1 : 1; @};
2087 struct B : public A @{ int f2 : 1; @};
2088 @end smallexample
2089
2090 @noindent
2091 In this case, G++ will place @code{B::f2} into the same byte
2092 as@code{A::f1}; other compilers will not.  You can avoid this problem
2093 by explicitly padding @code{A} so that its size is a multiple of the
2094 byte size on your platform; that will cause G++ and other compilers to
2095 layout @code{B} identically.
2096
2097 @item
2098 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2099 tail padding when laying out virtual bases.  For example:
2100
2101 @smallexample
2102 struct A @{ virtual void f(); char c1; @};
2103 struct B @{ B(); char c2; @};
2104 struct C : public A, public virtual B @{@};
2105 @end smallexample
2106
2107 @noindent
2108 In this case, G++ will not place @code{B} into the tail-padding for
2109 @code{A}; other compilers will.  You can avoid this problem by
2110 explicitly padding @code{A} so that its size is a multiple of its
2111 alignment (ignoring virtual base classes); that will cause G++ and other
2112 compilers to layout @code{C} identically.
2113
2114 @item
2115 Incorrect handling of bit-fields with declared widths greater than that
2116 of their underlying types, when the bit-fields appear in a union.  For
2117 example:
2118
2119 @smallexample
2120 union U @{ int i : 4096; @};
2121 @end smallexample
2122
2123 @noindent
2124 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2125 union too small by the number of bits in an @code{int}.
2126
2127 @item
2128 Empty classes can be placed at incorrect offsets.  For example:
2129
2130 @smallexample
2131 struct A @{@};
2132
2133 struct B @{
2134   A a;
2135   virtual void f ();
2136 @};
2137
2138 struct C : public B, public A @{@};
2139 @end smallexample
2140
2141 @noindent
2142 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2143 it should be placed at offset zero.  G++ mistakenly believes that the
2144 @code{A} data member of @code{B} is already at offset zero.
2145
2146 @item
2147 Names of template functions whose types involve @code{typename} or
2148 template template parameters can be mangled incorrectly.
2149
2150 @smallexample
2151 template <typename Q>
2152 void f(typename Q::X) @{@}
2153
2154 template <template <typename> class Q>
2155 void f(typename Q<int>::X) @{@}
2156 @end smallexample
2157
2158 @noindent
2159 Instantiations of these templates may be mangled incorrectly.
2160
2161 @end itemize
2162
2163 It also warns psABI related changes.  The known psABI changes at this
2164 point include:
2165
2166 @itemize @bullet
2167
2168 @item
2169 For SYSV/x86-64, when passing union with long double, it is changed to
2170 pass in memory as specified in psABI.  For example:
2171
2172 @smallexample
2173 union U @{
2174   long double ld;
2175   int i;
2176 @};
2177 @end smallexample
2178
2179 @noindent
2180 @code{union U} will always be passed in memory.
2181
2182 @end itemize
2183
2184 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2185 @opindex Wctor-dtor-privacy
2186 @opindex Wno-ctor-dtor-privacy
2187 Warn when a class seems unusable because all the constructors or
2188 destructors in that class are private, and it has neither friends nor
2189 public static member functions.
2190
2191 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2192 @opindex Wnon-virtual-dtor
2193 @opindex Wno-non-virtual-dtor
2194 Warn when a class has virtual functions and accessible non-virtual
2195 destructor, in which case it would be possible but unsafe to delete
2196 an instance of a derived class through a pointer to the base class.
2197 This warning is also enabled if -Weffc++ is specified.
2198
2199 @item -Wreorder @r{(C++ and Objective-C++ only)}
2200 @opindex Wreorder
2201 @opindex Wno-reorder
2202 @cindex reordering, warning
2203 @cindex warning for reordering of member initializers
2204 Warn when the order of member initializers given in the code does not
2205 match the order in which they must be executed.  For instance:
2206
2207 @smallexample
2208 struct A @{
2209   int i;
2210   int j;
2211   A(): j (0), i (1) @{ @}
2212 @};
2213 @end smallexample
2214
2215 The compiler will rearrange the member initializers for @samp{i}
2216 and @samp{j} to match the declaration order of the members, emitting
2217 a warning to that effect.  This warning is enabled by @option{-Wall}.
2218 @end table
2219
2220 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2221
2222 @table @gcctabopt
2223 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2224 @opindex Weffc++
2225 @opindex Wno-effc++
2226 Warn about violations of the following style guidelines from Scott Meyers'
2227 @cite{Effective C++} book:
2228
2229 @itemize @bullet
2230 @item
2231 Item 11:  Define a copy constructor and an assignment operator for classes
2232 with dynamically allocated memory.
2233
2234 @item
2235 Item 12:  Prefer initialization to assignment in constructors.
2236
2237 @item
2238 Item 14:  Make destructors virtual in base classes.
2239
2240 @item
2241 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2242
2243 @item
2244 Item 23:  Don't try to return a reference when you must return an object.
2245
2246 @end itemize
2247
2248 Also warn about violations of the following style guidelines from
2249 Scott Meyers' @cite{More Effective C++} book:
2250
2251 @itemize @bullet
2252 @item
2253 Item 6:  Distinguish between prefix and postfix forms of increment and
2254 decrement operators.
2255
2256 @item
2257 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2258
2259 @end itemize
2260
2261 When selecting this option, be aware that the standard library
2262 headers do not obey all of these guidelines; use @samp{grep -v}
2263 to filter out those warnings.
2264
2265 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2266 @opindex Wstrict-null-sentinel
2267 @opindex Wno-strict-null-sentinel
2268 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2269 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2270 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2271 it is guaranteed to be of the same size as a pointer.  But this use is
2272 not portable across different compilers.
2273
2274 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2275 @opindex Wno-non-template-friend
2276 @opindex Wnon-template-friend
2277 Disable warnings when non-templatized friend functions are declared
2278 within a template.  Since the advent of explicit template specification
2279 support in G++, if the name of the friend is an unqualified-id (i.e.,
2280 @samp{friend foo(int)}), the C++ language specification demands that the
2281 friend declare or define an ordinary, nontemplate function.  (Section
2282 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2283 could be interpreted as a particular specialization of a templatized
2284 function.  Because this non-conforming behavior is no longer the default
2285 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2286 check existing code for potential trouble spots and is on by default.
2287 This new compiler behavior can be turned off with
2288 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2289 but disables the helpful warning.
2290
2291 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2292 @opindex Wold-style-cast
2293 @opindex Wno-old-style-cast
2294 Warn if an old-style (C-style) cast to a non-void type is used within
2295 a C++ program.  The new-style casts (@samp{dynamic_cast},
2296 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2297 less vulnerable to unintended effects and much easier to search for.
2298
2299 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2300 @opindex Woverloaded-virtual
2301 @opindex Wno-overloaded-virtual
2302 @cindex overloaded virtual fn, warning
2303 @cindex warning for overloaded virtual fn
2304 Warn when a function declaration hides virtual functions from a
2305 base class.  For example, in:
2306
2307 @smallexample
2308 struct A @{
2309   virtual void f();
2310 @};
2311
2312 struct B: public A @{
2313   void f(int);
2314 @};
2315 @end smallexample
2316
2317 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2318 like:
2319
2320 @smallexample
2321 B* b;
2322 b->f();
2323 @end smallexample
2324
2325 will fail to compile.
2326
2327 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2328 @opindex Wno-pmf-conversions
2329 @opindex Wpmf-conversions
2330 Disable the diagnostic for converting a bound pointer to member function
2331 to a plain pointer.
2332
2333 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2334 @opindex Wsign-promo
2335 @opindex Wno-sign-promo
2336 Warn when overload resolution chooses a promotion from unsigned or
2337 enumerated type to a signed type, over a conversion to an unsigned type of
2338 the same size.  Previous versions of G++ would try to preserve
2339 unsignedness, but the standard mandates the current behavior.
2340
2341 @smallexample
2342 struct A @{
2343   operator int ();
2344   A& operator = (int);
2345 @};
2346
2347 main ()
2348 @{
2349   A a,b;
2350   a = b;
2351 @}
2352 @end smallexample
2353
2354 In this example, G++ will synthesize a default @samp{A& operator =
2355 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2356 @end table
2357
2358 @node Objective-C and Objective-C++ Dialect Options
2359 @section Options Controlling Objective-C and Objective-C++ Dialects
2360
2361 @cindex compiler options, Objective-C and Objective-C++
2362 @cindex Objective-C and Objective-C++ options, command line
2363 @cindex options, Objective-C and Objective-C++
2364 (NOTE: This manual does not describe the Objective-C and Objective-C++
2365 languages themselves.  See @xref{Standards,,Language Standards
2366 Supported by GCC}, for references.)
2367
2368 This section describes the command-line options that are only meaningful
2369 for Objective-C and Objective-C++ programs, but you can also use most of
2370 the language-independent GNU compiler options.
2371 For example, you might compile a file @code{some_class.m} like this:
2372
2373 @smallexample
2374 gcc -g -fgnu-runtime -O -c some_class.m
2375 @end smallexample
2376
2377 @noindent
2378 In this example, @option{-fgnu-runtime} is an option meant only for
2379 Objective-C and Objective-C++ programs; you can use the other options with
2380 any language supported by GCC@.
2381
2382 Note that since Objective-C is an extension of the C language, Objective-C
2383 compilations may also use options specific to the C front-end (e.g.,
2384 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2385 C++-specific options (e.g., @option{-Wabi}).
2386
2387 Here is a list of options that are @emph{only} for compiling Objective-C
2388 and Objective-C++ programs:
2389
2390 @table @gcctabopt
2391 @item -fconstant-string-class=@var{class-name}
2392 @opindex fconstant-string-class
2393 Use @var{class-name} as the name of the class to instantiate for each
2394 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2395 class name is @code{NXConstantString} if the GNU runtime is being used, and
2396 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2397 @option{-fconstant-cfstrings} option, if also present, will override the
2398 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2399 to be laid out as constant CoreFoundation strings.
2400
2401 @item -fgnu-runtime
2402 @opindex fgnu-runtime
2403 Generate object code compatible with the standard GNU Objective-C
2404 runtime.  This is the default for most types of systems.
2405
2406 @item -fnext-runtime
2407 @opindex fnext-runtime
2408 Generate output compatible with the NeXT runtime.  This is the default
2409 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2410 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2411 used.
2412
2413 @item -fno-nil-receivers
2414 @opindex fno-nil-receivers
2415 Assume that all Objective-C message dispatches (e.g.,
2416 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2417 is not @code{nil}.  This allows for more efficient entry points in the runtime
2418 to be used.  Currently, this option is only available in conjunction with
2419 the NeXT runtime on Mac OS X 10.3 and later.
2420
2421 @item -fobjc-call-cxx-cdtors
2422 @opindex fobjc-call-cxx-cdtors
2423 For each Objective-C class, check if any of its instance variables is a
2424 C++ object with a non-trivial default constructor.  If so, synthesize a
2425 special @code{- (id) .cxx_construct} instance method that will run
2426 non-trivial default constructors on any such instance variables, in order,
2427 and then return @code{self}.  Similarly, check if any instance variable
2428 is a C++ object with a non-trivial destructor, and if so, synthesize a
2429 special @code{- (void) .cxx_destruct} method that will run
2430 all such default destructors, in reverse order.
2431
2432 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2433 thusly generated will only operate on instance variables declared in the
2434 current Objective-C class, and not those inherited from superclasses.  It
2435 is the responsibility of the Objective-C runtime to invoke all such methods
2436 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2437 will be invoked by the runtime immediately after a new object
2438 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2439 be invoked immediately before the runtime deallocates an object instance.
2440
2441 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2442 support for invoking the @code{- (id) .cxx_construct} and
2443 @code{- (void) .cxx_destruct} methods.
2444
2445 @item -fobjc-direct-dispatch
2446 @opindex fobjc-direct-dispatch
2447 Allow fast jumps to the message dispatcher.  On Darwin this is
2448 accomplished via the comm page.
2449
2450 @item -fobjc-exceptions
2451 @opindex fobjc-exceptions
2452 Enable syntactic support for structured exception handling in Objective-C,
2453 similar to what is offered by C++ and Java.  This option is
2454 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2455 earlier.
2456
2457 @smallexample
2458   @@try @{
2459     @dots{}
2460        @@throw expr;
2461     @dots{}
2462   @}
2463   @@catch (AnObjCClass *exc) @{
2464     @dots{}
2465       @@throw expr;
2466     @dots{}
2467       @@throw;
2468     @dots{}
2469   @}
2470   @@catch (AnotherClass *exc) @{
2471     @dots{}
2472   @}
2473   @@catch (id allOthers) @{
2474     @dots{}
2475   @}
2476   @@finally @{
2477     @dots{}
2478       @@throw expr;
2479     @dots{}
2480   @}
2481 @end smallexample
2482
2483 The @code{@@throw} statement may appear anywhere in an Objective-C or
2484 Objective-C++ program; when used inside of a @code{@@catch} block, the
2485 @code{@@throw} may appear without an argument (as shown above), in which case
2486 the object caught by the @code{@@catch} will be rethrown.
2487
2488 Note that only (pointers to) Objective-C objects may be thrown and
2489 caught using this scheme.  When an object is thrown, it will be caught
2490 by the nearest @code{@@catch} clause capable of handling objects of that type,
2491 analogously to how @code{catch} blocks work in C++ and Java.  A
2492 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2493 any and all Objective-C exceptions not caught by previous @code{@@catch}
2494 clauses (if any).
2495
2496 The @code{@@finally} clause, if present, will be executed upon exit from the
2497 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2498 regardless of whether any exceptions are thrown, caught or rethrown
2499 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2500 of the @code{finally} clause in Java.
2501
2502 There are several caveats to using the new exception mechanism:
2503
2504 @itemize @bullet
2505 @item
2506 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2507 idioms provided by the @code{NSException} class, the new
2508 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2509 systems, due to additional functionality needed in the (NeXT) Objective-C
2510 runtime.
2511
2512 @item
2513 As mentioned above, the new exceptions do not support handling
2514 types other than Objective-C objects.   Furthermore, when used from
2515 Objective-C++, the Objective-C exception model does not interoperate with C++
2516 exceptions at this time.  This means you cannot @code{@@throw} an exception
2517 from Objective-C and @code{catch} it in C++, or vice versa
2518 (i.e., @code{throw @dots{} @@catch}).
2519 @end itemize
2520
2521 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2522 blocks for thread-safe execution:
2523
2524 @smallexample
2525   @@synchronized (ObjCClass *guard) @{
2526     @dots{}
2527   @}
2528 @end smallexample
2529
2530 Upon entering the @code{@@synchronized} block, a thread of execution shall
2531 first check whether a lock has been placed on the corresponding @code{guard}
2532 object by another thread.  If it has, the current thread shall wait until
2533 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2534 the current thread will place its own lock on it, execute the code contained in
2535 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2536 making @code{guard} available to other threads).
2537
2538 Unlike Java, Objective-C does not allow for entire methods to be marked
2539 @code{@@synchronized}.  Note that throwing exceptions out of
2540 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2541 to be unlocked properly.
2542
2543 @item -fobjc-gc
2544 @opindex fobjc-gc
2545 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2546
2547 @item -freplace-objc-classes
2548 @opindex freplace-objc-classes
2549 Emit a special marker instructing @command{ld(1)} not to statically link in
2550 the resulting object file, and allow @command{dyld(1)} to load it in at
2551 run time instead.  This is used in conjunction with the Fix-and-Continue
2552 debugging mode, where the object file in question may be recompiled and
2553 dynamically reloaded in the course of program execution, without the need
2554 to restart the program itself.  Currently, Fix-and-Continue functionality
2555 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2556 and later.
2557
2558 @item -fzero-link
2559 @opindex fzero-link
2560 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2561 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2562 compile time) with static class references that get initialized at load time,
2563 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2564 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2565 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2566 for individual class implementations to be modified during program execution.
2567
2568 @item -gen-decls
2569 @opindex gen-decls
2570 Dump interface declarations for all classes seen in the source file to a
2571 file named @file{@var{sourcename}.decl}.
2572
2573 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2574 @opindex Wassign-intercept
2575 @opindex Wno-assign-intercept
2576 Warn whenever an Objective-C assignment is being intercepted by the
2577 garbage collector.
2578
2579 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2580 @opindex Wno-protocol
2581 @opindex Wprotocol
2582 If a class is declared to implement a protocol, a warning is issued for
2583 every method in the protocol that is not implemented by the class.  The
2584 default behavior is to issue a warning for every method not explicitly
2585 implemented in the class, even if a method implementation is inherited
2586 from the superclass.  If you use the @option{-Wno-protocol} option, then
2587 methods inherited from the superclass are considered to be implemented,
2588 and no warning is issued for them.
2589
2590 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2591 @opindex Wselector
2592 @opindex Wno-selector
2593 Warn if multiple methods of different types for the same selector are
2594 found during compilation.  The check is performed on the list of methods
2595 in the final stage of compilation.  Additionally, a check is performed
2596 for each selector appearing in a @code{@@selector(@dots{})}
2597 expression, and a corresponding method for that selector has been found
2598 during compilation.  Because these checks scan the method table only at
2599 the end of compilation, these warnings are not produced if the final
2600 stage of compilation is not reached, for example because an error is
2601 found during compilation, or because the @option{-fsyntax-only} option is
2602 being used.
2603
2604 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2605 @opindex Wstrict-selector-match
2606 @opindex Wno-strict-selector-match
2607 Warn if multiple methods with differing argument and/or return types are
2608 found for a given selector when attempting to send a message using this
2609 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2610 is off (which is the default behavior), the compiler will omit such warnings
2611 if any differences found are confined to types which share the same size
2612 and alignment.
2613
2614 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2615 @opindex Wundeclared-selector
2616 @opindex Wno-undeclared-selector
2617 Warn if a @code{@@selector(@dots{})} expression referring to an
2618 undeclared selector is found.  A selector is considered undeclared if no
2619 method with that name has been declared before the
2620 @code{@@selector(@dots{})} expression, either explicitly in an
2621 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2622 an @code{@@implementation} section.  This option always performs its
2623 checks as soon as a @code{@@selector(@dots{})} expression is found,
2624 while @option{-Wselector} only performs its checks in the final stage of
2625 compilation.  This also enforces the coding style convention
2626 that methods and selectors must be declared before being used.
2627
2628 @item -print-objc-runtime-info
2629 @opindex print-objc-runtime-info
2630 Generate C header describing the largest structure that is passed by
2631 value, if any.
2632
2633 @end table
2634
2635 @node Language Independent Options
2636 @section Options to Control Diagnostic Messages Formatting
2637 @cindex options to control diagnostics formatting
2638 @cindex diagnostic messages
2639 @cindex message formatting
2640
2641 Traditionally, diagnostic messages have been formatted irrespective of
2642 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2643 below can be used to control the diagnostic messages formatting
2644 algorithm, e.g.@: how many characters per line, how often source location
2645 information should be reported.  Right now, only the C++ front end can
2646 honor these options.  However it is expected, in the near future, that
2647 the remaining front ends would be able to digest them correctly.
2648
2649 @table @gcctabopt
2650 @item -fmessage-length=@var{n}
2651 @opindex fmessage-length
2652 Try to format error messages so that they fit on lines of about @var{n}
2653 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2654 the front ends supported by GCC@.  If @var{n} is zero, then no
2655 line-wrapping will be done; each error message will appear on a single
2656 line.
2657
2658 @opindex fdiagnostics-show-location
2659 @item -fdiagnostics-show-location=once
2660 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2661 reporter to emit @emph{once} source location information; that is, in
2662 case the message is too long to fit on a single physical line and has to
2663 be wrapped, the source location won't be emitted (as prefix) again,
2664 over and over, in subsequent continuation lines.  This is the default
2665 behavior.
2666
2667 @item -fdiagnostics-show-location=every-line
2668 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2669 messages reporter to emit the same source location information (as
2670 prefix) for physical lines that result from the process of breaking
2671 a message which is too long to fit on a single line.
2672
2673 @item -fdiagnostics-show-option
2674 @opindex fdiagnostics-show-option
2675 This option instructs the diagnostic machinery to add text to each
2676 diagnostic emitted, which indicates which command line option directly
2677 controls that diagnostic, when such an option is known to the
2678 diagnostic machinery.
2679
2680 @item -Wcoverage-mismatch
2681 @opindex Wcoverage-mismatch
2682 Warn if feedback profiles do not match when using the
2683 @option{-fprofile-use} option.
2684 If a source file was changed between @option{-fprofile-gen} and
2685 @option{-fprofile-use}, the files with the profile feedback can fail
2686 to match the source file and GCC can not use the profile feedback
2687 information.  By default, GCC emits an error message in this case.
2688 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2689 error.  GCC does not use appropriate feedback profiles, so using this
2690 option can result in poorly optimized code.  This option is useful
2691 only in the case of very minor changes such as bug fixes to an
2692 existing code-base.
2693
2694 @end table
2695
2696 @node Warning Options
2697 @section Options to Request or Suppress Warnings
2698 @cindex options to control warnings
2699 @cindex warning messages
2700 @cindex messages, warning
2701 @cindex suppressing warnings
2702
2703 Warnings are diagnostic messages that report constructions which
2704 are not inherently erroneous but which are risky or suggest there
2705 may have been an error.
2706
2707 The following language-independent options do not enable specific
2708 warnings but control the kinds of diagnostics produced by GCC.
2709
2710 @table @gcctabopt
2711 @cindex syntax checking
2712 @item -fsyntax-only
2713 @opindex fsyntax-only
2714 Check the code for syntax errors, but don't do anything beyond that.
2715
2716 @item -w
2717 @opindex w
2718 Inhibit all warning messages.
2719
2720 @item -Werror
2721 @opindex Werror
2722 @opindex Wno-error
2723 Make all warnings into errors.
2724
2725 @item -Werror=
2726 @opindex Werror=
2727 @opindex Wno-error=
2728 Make the specified warning into an error.  The specifier for a warning
2729 is appended, for example @option{-Werror=switch} turns the warnings
2730 controlled by @option{-Wswitch} into errors.  This switch takes a
2731 negative form, to be used to negate @option{-Werror} for specific
2732 warnings, for example @option{-Wno-error=switch} makes
2733 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2734 is in effect.  You can use the @option{-fdiagnostics-show-option}
2735 option to have each controllable warning amended with the option which
2736 controls it, to determine what to use with this option.
2737
2738 Note that specifying @option{-Werror=}@var{foo} automatically implies
2739 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2740 imply anything.
2741
2742 @item -Wfatal-errors
2743 @opindex Wfatal-errors
2744 @opindex Wno-fatal-errors
2745 This option causes the compiler to abort compilation on the first error
2746 occurred rather than trying to keep going and printing further error
2747 messages.
2748
2749 @end table
2750
2751 You can request many specific warnings with options beginning
2752 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2753 implicit declarations.  Each of these specific warning options also
2754 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2755 example, @option{-Wno-implicit}.  This manual lists only one of the
2756 two forms, whichever is not the default.  For further,
2757 language-specific options also refer to @ref{C++ Dialect Options} and
2758 @ref{Objective-C and Objective-C++ Dialect Options}.
2759
2760 @table @gcctabopt
2761 @item -pedantic
2762 @opindex pedantic
2763 Issue all the warnings demanded by strict ISO C and ISO C++;
2764 reject all programs that use forbidden extensions, and some other
2765 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2766 version of the ISO C standard specified by any @option{-std} option used.
2767
2768 Valid ISO C and ISO C++ programs should compile properly with or without
2769 this option (though a rare few will require @option{-ansi} or a
2770 @option{-std} option specifying the required version of ISO C)@.  However,
2771 without this option, certain GNU extensions and traditional C and C++
2772 features are supported as well.  With this option, they are rejected.
2773
2774 @option{-pedantic} does not cause warning messages for use of the
2775 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2776 warnings are also disabled in the expression that follows
2777 @code{__extension__}.  However, only system header files should use
2778 these escape routes; application programs should avoid them.
2779 @xref{Alternate Keywords}.
2780
2781 Some users try to use @option{-pedantic} to check programs for strict ISO
2782 C conformance.  They soon find that it does not do quite what they want:
2783 it finds some non-ISO practices, but not all---only those for which
2784 ISO C @emph{requires} a diagnostic, and some others for which
2785 diagnostics have been added.
2786
2787 A feature to report any failure to conform to ISO C might be useful in
2788 some instances, but would require considerable additional work and would
2789 be quite different from @option{-pedantic}.  We don't have plans to
2790 support such a feature in the near future.
2791
2792 Where the standard specified with @option{-std} represents a GNU
2793 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2794 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2795 extended dialect is based.  Warnings from @option{-pedantic} are given
2796 where they are required by the base standard.  (It would not make sense
2797 for such warnings to be given only for features not in the specified GNU
2798 C dialect, since by definition the GNU dialects of C include all
2799 features the compiler supports with the given option, and there would be
2800 nothing to warn about.)
2801
2802 @item -pedantic-errors
2803 @opindex pedantic-errors
2804 Like @option{-pedantic}, except that errors are produced rather than
2805 warnings.
2806
2807 @item -Wall
2808 @opindex Wall
2809 @opindex Wno-all
2810 This enables all the warnings about constructions that some users
2811 consider questionable, and that are easy to avoid (or modify to
2812 prevent the warning), even in conjunction with macros.  This also
2813 enables some language-specific warnings described in @ref{C++ Dialect
2814 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2815
2816 @option{-Wall} turns on the following warning flags:
2817
2818 @gccoptlist{-Waddress   @gol
2819 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2820 -Wc++0x-compat  @gol
2821 -Wchar-subscripts  @gol
2822 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2823 -Wimplicit-int  @gol
2824 -Wimplicit-function-declaration  @gol
2825 -Wcomment  @gol
2826 -Wformat   @gol
2827 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2828 -Wmissing-braces  @gol
2829 -Wnonnull  @gol
2830 -Wparentheses  @gol
2831 -Wpointer-sign  @gol
2832 -Wreorder   @gol
2833 -Wreturn-type  @gol
2834 -Wsequence-point  @gol
2835 -Wsign-compare @r{(only in C++)}  @gol
2836 -Wstrict-aliasing  @gol
2837 -Wstrict-overflow=1  @gol
2838 -Wswitch  @gol
2839 -Wtrigraphs  @gol
2840 -Wuninitialized  @gol
2841 -Wunknown-pragmas  @gol
2842 -Wunused-function  @gol
2843 -Wunused-label     @gol
2844 -Wunused-value     @gol
2845 -Wunused-variable  @gol
2846 -Wvolatile-register-var @gol
2847 }
2848
2849 Note that some warning flags are not implied by @option{-Wall}.  Some of
2850 them warn about constructions that users generally do not consider
2851 questionable, but which occasionally you might wish to check for;
2852 others warn about constructions that are necessary or hard to avoid in
2853 some cases, and there is no simple way to modify the code to suppress
2854 the warning. Some of them are enabled by @option{-Wextra} but many of
2855 them must be enabled individually.
2856
2857 @item -Wextra
2858 @opindex W
2859 @opindex Wextra
2860 @opindex Wno-extra
2861 This enables some extra warning flags that are not enabled by
2862 @option{-Wall}. (This option used to be called @option{-W}.  The older
2863 name is still supported, but the newer name is more descriptive.)
2864
2865 @gccoptlist{-Wclobbered  @gol
2866 -Wempty-body  @gol
2867 -Wignored-qualifiers @gol
2868 -Wmissing-field-initializers  @gol
2869 -Wmissing-parameter-type @r{(C only)}  @gol
2870 -Wold-style-declaration @r{(C only)}  @gol
2871 -Woverride-init  @gol
2872 -Wsign-compare  @gol
2873 -Wtype-limits  @gol
2874 -Wuninitialized  @gol
2875 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2876 }
2877
2878 The option @option{-Wextra} also prints warning messages for the
2879 following cases:
2880
2881 @itemize @bullet
2882
2883 @item
2884 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2885 @samp{>}, or @samp{>=}.
2886
2887 @item
2888 (C++ only) An enumerator and a non-enumerator both appear in a
2889 conditional expression.
2890
2891 @item
2892 (C++ only) Ambiguous virtual bases.
2893
2894 @item
2895 (C++ only) Subscripting an array which has been declared @samp{register}.
2896
2897 @item
2898 (C++ only) Taking the address of a variable which has been declared
2899 @samp{register}.
2900
2901 @item
2902 (C++ only) A base class is not initialized in a derived class' copy
2903 constructor.
2904
2905 @end itemize
2906
2907 @item -Wchar-subscripts
2908 @opindex Wchar-subscripts
2909 @opindex Wno-char-subscripts
2910 Warn if an array subscript has type @code{char}.  This is a common cause
2911 of error, as programmers often forget that this type is signed on some
2912 machines.
2913 This warning is enabled by @option{-Wall}.
2914
2915 @item -Wcomment
2916 @opindex Wcomment
2917 @opindex Wno-comment
2918 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2919 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2920 This warning is enabled by @option{-Wall}.
2921
2922 @item -Wformat
2923 @opindex Wformat
2924 @opindex Wno-format
2925 @opindex ffreestanding
2926 @opindex fno-builtin
2927 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2928 the arguments supplied have types appropriate to the format string
2929 specified, and that the conversions specified in the format string make
2930 sense.  This includes standard functions, and others specified by format
2931 attributes (@pxref{Function Attributes}), in the @code{printf},
2932 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2933 not in the C standard) families (or other target-specific families).
2934 Which functions are checked without format attributes having been
2935 specified depends on the standard version selected, and such checks of
2936 functions without the attribute specified are disabled by
2937 @option{-ffreestanding} or @option{-fno-builtin}.
2938
2939 The formats are checked against the format features supported by GNU
2940 libc version 2.2.  These include all ISO C90 and C99 features, as well
2941 as features from the Single Unix Specification and some BSD and GNU
2942 extensions.  Other library implementations may not support all these
2943 features; GCC does not support warning about features that go beyond a
2944 particular library's limitations.  However, if @option{-pedantic} is used
2945 with @option{-Wformat}, warnings will be given about format features not
2946 in the selected standard version (but not for @code{strfmon} formats,
2947 since those are not in any version of the C standard).  @xref{C Dialect
2948 Options,,Options Controlling C Dialect}.
2949
2950 Since @option{-Wformat} also checks for null format arguments for
2951 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2952
2953 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2954 aspects of format checking, the options @option{-Wformat-y2k},
2955 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2956 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2957 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2958
2959 @item -Wformat-y2k
2960 @opindex Wformat-y2k
2961 @opindex Wno-format-y2k
2962 If @option{-Wformat} is specified, also warn about @code{strftime}
2963 formats which may yield only a two-digit year.
2964
2965 @item -Wno-format-contains-nul
2966 @opindex Wno-format-contains-nul
2967 @opindex Wformat-contains-nul
2968 If @option{-Wformat} is specified, do not warn about format strings that
2969 contain NUL bytes.
2970
2971 @item -Wno-format-extra-args
2972 @opindex Wno-format-extra-args
2973 @opindex Wformat-extra-args
2974 If @option{-Wformat} is specified, do not warn about excess arguments to a
2975 @code{printf} or @code{scanf} format function.  The C standard specifies
2976 that such arguments are ignored.
2977
2978 Where the unused arguments lie between used arguments that are
2979 specified with @samp{$} operand number specifications, normally
2980 warnings are still given, since the implementation could not know what
2981 type to pass to @code{va_arg} to skip the unused arguments.  However,
2982 in the case of @code{scanf} formats, this option will suppress the
2983 warning if the unused arguments are all pointers, since the Single
2984 Unix Specification says that such unused arguments are allowed.
2985
2986 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2987 @opindex Wno-format-zero-length
2988 @opindex Wformat-zero-length
2989 If @option{-Wformat} is specified, do not warn about zero-length formats.
2990 The C standard specifies that zero-length formats are allowed.
2991
2992 @item -Wformat-nonliteral
2993 @opindex Wformat-nonliteral
2994 @opindex Wno-format-nonliteral
2995 If @option{-Wformat} is specified, also warn if the format string is not a
2996 string literal and so cannot be checked, unless the format function
2997 takes its format arguments as a @code{va_list}.
2998
2999 @item -Wformat-security
3000 @opindex Wformat-security
3001 @opindex Wno-format-security
3002 If @option{-Wformat} is specified, also warn about uses of format
3003 functions that represent possible security problems.  At present, this
3004 warns about calls to @code{printf} and @code{scanf} functions where the
3005 format string is not a string literal and there are no format arguments,
3006 as in @code{printf (foo);}.  This may be a security hole if the format
3007 string came from untrusted input and contains @samp{%n}.  (This is
3008 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3009 in future warnings may be added to @option{-Wformat-security} that are not
3010 included in @option{-Wformat-nonliteral}.)
3011
3012 @item -Wformat=2
3013 @opindex Wformat=2
3014 @opindex Wno-format=2
3015 Enable @option{-Wformat} plus format checks not included in
3016 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3017 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3018
3019 @item -Wnonnull @r{(C and Objective-C only)}
3020 @opindex Wnonnull
3021 @opindex Wno-nonnull
3022 Warn about passing a null pointer for arguments marked as
3023 requiring a non-null value by the @code{nonnull} function attribute.
3024
3025 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3026 can be disabled with the @option{-Wno-nonnull} option.
3027
3028 @item -Wjump-misses-init @r{(C, Objective-C only)}
3029 @opindex Wjump-misses-init
3030 @opindex Wno-jump-misses-init
3031 Warn if a @code{goto} statement or a @code{switch} statement jumps
3032 forward across the initialization of a variable, or jumps backward to a
3033 label after the variable has been initialized.  This only warns about
3034 variables which are initialized when they are declared.  This warning is
3035 only supported for C and Objective C; in C++ this sort of branch is an
3036 error in any case.
3037
3038 @option{-Wjump-misses-init} is included in @option{-Wall} and
3039 @option{-Wc++-compat}.  It can be disabled with the
3040 @option{-Wno-jump-misses-init} option.
3041
3042 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3043 @opindex Winit-self
3044 @opindex Wno-init-self
3045 Warn about uninitialized variables which are initialized with themselves.
3046 Note this option can only be used with the @option{-Wuninitialized} option.
3047
3048 For example, GCC will warn about @code{i} being uninitialized in the
3049 following snippet only when @option{-Winit-self} has been specified:
3050 @smallexample
3051 @group
3052 int f()
3053 @{
3054   int i = i;
3055   return i;
3056 @}
3057 @end group
3058 @end smallexample
3059
3060 @item -Wimplicit-int @r{(C and Objective-C only)}
3061 @opindex Wimplicit-int
3062 @opindex Wno-implicit-int
3063 Warn when a declaration does not specify a type.
3064 This warning is enabled by @option{-Wall}.
3065
3066 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3067 @opindex Wimplicit-function-declaration
3068 @opindex Wno-implicit-function-declaration
3069 Give a warning whenever a function is used before being declared. In
3070 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3071 enabled by default and it is made into an error by
3072 @option{-pedantic-errors}. This warning is also enabled by
3073 @option{-Wall}.
3074
3075 @item -Wimplicit
3076 @opindex Wimplicit
3077 @opindex Wno-implicit
3078 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3079 This warning is enabled by @option{-Wall}.
3080
3081 @item -Wignored-qualifiers @r{(C and C++ only)}
3082 @opindex Wignored-qualifiers
3083 @opindex Wno-ignored-qualifiers
3084 Warn if the return type of a function has a type qualifier
3085 such as @code{const}.  For ISO C such a type qualifier has no effect,
3086 since the value returned by a function is not an lvalue.
3087 For C++, the warning is only emitted for scalar types or @code{void}.
3088 ISO C prohibits qualified @code{void} return types on function
3089 definitions, so such return types always receive a warning
3090 even without this option.
3091
3092 This warning is also enabled by @option{-Wextra}.
3093
3094 @item -Wmain
3095 @opindex Wmain
3096 @opindex Wno-main
3097 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3098 a function with external linkage, returning int, taking either zero
3099 arguments, two, or three arguments of appropriate types.  This warning
3100 is enabled by default in C++ and is enabled by either @option{-Wall}
3101 or @option{-pedantic}.
3102
3103 @item -Wmissing-braces
3104 @opindex Wmissing-braces
3105 @opindex Wno-missing-braces
3106 Warn if an aggregate or union initializer is not fully bracketed.  In
3107 the following example, the initializer for @samp{a} is not fully
3108 bracketed, but that for @samp{b} is fully bracketed.
3109
3110 @smallexample
3111 int a[2][2] = @{ 0, 1, 2, 3 @};
3112 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3113 @end smallexample
3114
3115 This warning is enabled by @option{-Wall}.
3116
3117 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3118 @opindex Wmissing-include-dirs
3119 @opindex Wno-missing-include-dirs
3120 Warn if a user-supplied include directory does not exist.
3121
3122 @item -Wparentheses
3123 @opindex Wparentheses
3124 @opindex Wno-parentheses
3125 Warn if parentheses are omitted in certain contexts, such
3126 as when there is an assignment in a context where a truth value
3127 is expected, or when operators are nested whose precedence people
3128 often get confused about.
3129
3130 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3131 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3132 interpretation from that of ordinary mathematical notation.
3133
3134 Also warn about constructions where there may be confusion to which
3135 @code{if} statement an @code{else} branch belongs.  Here is an example of
3136 such a case:
3137
3138 @smallexample
3139 @group
3140 @{
3141   if (a)
3142     if (b)
3143       foo ();
3144   else
3145     bar ();
3146 @}
3147 @end group
3148 @end smallexample
3149
3150 In C/C++, every @code{else} branch belongs to the innermost possible
3151 @code{if} statement, which in this example is @code{if (b)}.  This is
3152 often not what the programmer expected, as illustrated in the above
3153 example by indentation the programmer chose.  When there is the
3154 potential for this confusion, GCC will issue a warning when this flag
3155 is specified.  To eliminate the warning, add explicit braces around
3156 the innermost @code{if} statement so there is no way the @code{else}
3157 could belong to the enclosing @code{if}.  The resulting code would
3158 look like this:
3159
3160 @smallexample
3161 @group
3162 @{
3163   if (a)
3164     @{
3165       if (b)
3166         foo ();
3167       else
3168         bar ();
3169     @}
3170 @}
3171 @end group
3172 @end smallexample
3173
3174 This warning is enabled by @option{-Wall}.
3175
3176 @item -Wsequence-point
3177 @opindex Wsequence-point
3178 @opindex Wno-sequence-point
3179 Warn about code that may have undefined semantics because of violations
3180 of sequence point rules in the C and C++ standards.
3181
3182 The C and C++ standards defines the order in which expressions in a C/C++
3183 program are evaluated in terms of @dfn{sequence points}, which represent
3184 a partial ordering between the execution of parts of the program: those
3185 executed before the sequence point, and those executed after it.  These
3186 occur after the evaluation of a full expression (one which is not part
3187 of a larger expression), after the evaluation of the first operand of a
3188 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3189 function is called (but after the evaluation of its arguments and the
3190 expression denoting the called function), and in certain other places.
3191 Other than as expressed by the sequence point rules, the order of
3192 evaluation of subexpressions of an expression is not specified.  All
3193 these rules describe only a partial order rather than a total order,
3194 since, for example, if two functions are called within one expression
3195 with no sequence point between them, the order in which the functions
3196 are called is not specified.  However, the standards committee have
3197 ruled that function calls do not overlap.
3198
3199 It is not specified when between sequence points modifications to the
3200 values of objects take effect.  Programs whose behavior depends on this
3201 have undefined behavior; the C and C++ standards specify that ``Between
3202 the previous and next sequence point an object shall have its stored
3203 value modified at most once by the evaluation of an expression.
3204 Furthermore, the prior value shall be read only to determine the value
3205 to be stored.''.  If a program breaks these rules, the results on any
3206 particular implementation are entirely unpredictable.
3207
3208 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3209 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3210 diagnosed by this option, and it may give an occasional false positive
3211 result, but in general it has been found fairly effective at detecting
3212 this sort of problem in programs.
3213
3214 The standard is worded confusingly, therefore there is some debate
3215 over the precise meaning of the sequence point rules in subtle cases.
3216 Links to discussions of the problem, including proposed formal
3217 definitions, may be found on the GCC readings page, at
3218 @w{@uref{http://gcc.gnu.org/readings.html}}.
3219
3220 This warning is enabled by @option{-Wall} for C and C++.
3221
3222 @item -Wreturn-type
3223 @opindex Wreturn-type
3224 @opindex Wno-return-type
3225 Warn whenever a function is defined with a return-type that defaults
3226 to @code{int}.  Also warn about any @code{return} statement with no
3227 return-value in a function whose return-type is not @code{void}
3228 (falling off the end of the function body is considered returning
3229 without a value), and about a @code{return} statement with an
3230 expression in a function whose return-type is @code{void}.
3231
3232 For C++, a function without return type always produces a diagnostic
3233 message, even when @option{-Wno-return-type} is specified.  The only
3234 exceptions are @samp{main} and functions defined in system headers.
3235
3236 This warning is enabled by @option{-Wall}.
3237
3238 @item -Wswitch
3239 @opindex Wswitch
3240 @opindex Wno-switch
3241 Warn whenever a @code{switch} statement has an index of enumerated type
3242 and lacks a @code{case} for one or more of the named codes of that
3243 enumeration.  (The presence of a @code{default} label prevents this
3244 warning.)  @code{case} labels outside the enumeration range also
3245 provoke warnings when this option is used (even if there is a
3246 @code{default} label).
3247 This warning is enabled by @option{-Wall}.
3248
3249 @item -Wswitch-default
3250 @opindex Wswitch-default
3251 @opindex Wno-switch-default
3252 Warn whenever a @code{switch} statement does not have a @code{default}
3253 case.
3254
3255 @item -Wswitch-enum
3256 @opindex Wswitch-enum
3257 @opindex Wno-switch-enum
3258 Warn whenever a @code{switch} statement has an index of enumerated type
3259 and lacks a @code{case} for one or more of the named codes of that
3260 enumeration.  @code{case} labels outside the enumeration range also
3261 provoke warnings when this option is used.  The only difference
3262 between @option{-Wswitch} and this option is that this option gives a
3263 warning about an omitted enumeration code even if there is a
3264 @code{default} label.
3265
3266 @item -Wsync-nand @r{(C and C++ only)}
3267 @opindex Wsync-nand
3268 @opindex Wno-sync-nand
3269 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3270 built-in functions are used.  These functions changed semantics in GCC 4.4.
3271
3272 @item -Wtrigraphs
3273 @opindex Wtrigraphs
3274 @opindex Wno-trigraphs
3275 Warn if any trigraphs are encountered that might change the meaning of
3276 the program (trigraphs within comments are not warned about).
3277 This warning is enabled by @option{-Wall}.
3278
3279 @item -Wunused-function
3280 @opindex Wunused-function
3281 @opindex Wno-unused-function
3282 Warn whenever a static function is declared but not defined or a
3283 non-inline static function is unused.
3284 This warning is enabled by @option{-Wall}.
3285
3286 @item -Wunused-label
3287 @opindex Wunused-label
3288 @opindex Wno-unused-label
3289 Warn whenever a label is declared but not used.
3290 This warning is enabled by @option{-Wall}.
3291
3292 To suppress this warning use the @samp{unused} attribute
3293 (@pxref{Variable Attributes}).
3294
3295 @item -Wunused-parameter
3296 @opindex Wunused-parameter
3297 @opindex Wno-unused-parameter
3298 Warn whenever a function parameter is unused aside from its declaration.
3299
3300 To suppress this warning use the @samp{unused} attribute
3301 (@pxref{Variable Attributes}).
3302
3303 @item -Wno-unused-result
3304 @opindex Wunused-result
3305 @opindex Wno-unused-result
3306 Do not warn if a caller of a function marked with attribute
3307 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3308 its return value. The default is @option{-Wunused-result}.
3309
3310 @item -Wunused-variable
3311 @opindex Wunused-variable
3312 @opindex Wno-unused-variable
3313 Warn whenever a local variable or non-constant static variable is unused
3314 aside from its declaration.
3315 This warning is enabled by @option{-Wall}.
3316
3317 To suppress this warning use the @samp{unused} attribute
3318 (@pxref{Variable Attributes}).
3319
3320 @item -Wunused-value
3321 @opindex Wunused-value
3322 @opindex Wno-unused-value
3323 Warn whenever a statement computes a result that is explicitly not
3324 used. To suppress this warning cast the unused expression to
3325 @samp{void}. This includes an expression-statement or the left-hand
3326 side of a comma expression that contains no side effects. For example,
3327 an expression such as @samp{x[i,j]} will cause a warning, while
3328 @samp{x[(void)i,j]} will not.
3329
3330 This warning is enabled by @option{-Wall}.
3331
3332 @item -Wunused
3333 @opindex Wunused
3334 @opindex Wno-unused
3335 All the above @option{-Wunused} options combined.
3336
3337 In order to get a warning about an unused function parameter, you must
3338 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3339 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3340
3341 @item -Wuninitialized
3342 @opindex Wuninitialized
3343 @opindex Wno-uninitialized
3344 Warn if an automatic variable is used without first being initialized
3345 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3346 warn if a non-static reference or non-static @samp{const} member
3347 appears in a class without constructors.
3348
3349 If you want to warn about code which uses the uninitialized value of the
3350 variable in its own initializer, use the @option{-Winit-self} option.
3351
3352 These warnings occur for individual uninitialized or clobbered
3353 elements of structure, union or array variables as well as for
3354 variables which are uninitialized or clobbered as a whole.  They do
3355 not occur for variables or elements declared @code{volatile}.  Because
3356 these warnings depend on optimization, the exact variables or elements
3357 for which there are warnings will depend on the precise optimization
3358 options and version of GCC used.
3359
3360 Note that there may be no warning about a variable that is used only
3361 to compute a value that itself is never used, because such
3362 computations may be deleted by data flow analysis before the warnings
3363 are printed.
3364
3365 These warnings are made optional because GCC is not smart
3366 enough to see all the reasons why the code might be correct
3367 despite appearing to have an error.  Here is one example of how
3368 this can happen:
3369
3370 @smallexample
3371 @group
3372 @{
3373   int x;
3374   switch (y)
3375     @{
3376     case 1: x = 1;
3377       break;
3378     case 2: x = 4;
3379       break;
3380     case 3: x = 5;
3381     @}
3382   foo (x);
3383 @}
3384 @end group
3385 @end smallexample
3386
3387 @noindent
3388 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3389 always initialized, but GCC doesn't know this.  Here is
3390 another common case:
3391
3392 @smallexample
3393 @{
3394   int save_y;
3395   if (change_y) save_y = y, y = new_y;
3396   @dots{}
3397   if (change_y) y = save_y;
3398 @}
3399 @end smallexample
3400
3401 @noindent
3402 This has no bug because @code{save_y} is used only if it is set.
3403
3404 @cindex @code{longjmp} warnings
3405 This option also warns when a non-volatile automatic variable might be
3406 changed by a call to @code{longjmp}.  These warnings as well are possible
3407 only in optimizing compilation.
3408
3409 The compiler sees only the calls to @code{setjmp}.  It cannot know
3410 where @code{longjmp} will be called; in fact, a signal handler could
3411 call it at any point in the code.  As a result, you may get a warning
3412 even when there is in fact no problem because @code{longjmp} cannot
3413 in fact be called at the place which would cause a problem.
3414
3415 Some spurious warnings can be avoided if you declare all the functions
3416 you use that never return as @code{noreturn}.  @xref{Function
3417 Attributes}.
3418
3419 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3420
3421 @item -Wunknown-pragmas
3422 @opindex Wunknown-pragmas
3423 @opindex Wno-unknown-pragmas
3424 @cindex warning for unknown pragmas
3425 @cindex unknown pragmas, warning
3426 @cindex pragmas, warning of unknown
3427 Warn when a #pragma directive is encountered which is not understood by
3428 GCC@.  If this command line option is used, warnings will even be issued
3429 for unknown pragmas in system header files.  This is not the case if
3430 the warnings were only enabled by the @option{-Wall} command line option.
3431
3432 @item -Wno-pragmas
3433 @opindex Wno-pragmas
3434 @opindex Wpragmas
3435 Do not warn about misuses of pragmas, such as incorrect parameters,
3436 invalid syntax, or conflicts between pragmas.  See also
3437 @samp{-Wunknown-pragmas}.
3438
3439 @item -Wstrict-aliasing
3440 @opindex Wstrict-aliasing
3441 @opindex Wno-strict-aliasing
3442 This option is only active when @option{-fstrict-aliasing} is active.
3443 It warns about code which might break the strict aliasing rules that the
3444 compiler is using for optimization.  The warning does not catch all
3445 cases, but does attempt to catch the more common pitfalls.  It is
3446 included in @option{-Wall}.
3447 It is equivalent to @option{-Wstrict-aliasing=3}
3448
3449 @item -Wstrict-aliasing=n
3450 @opindex Wstrict-aliasing=n
3451 @opindex Wno-strict-aliasing=n
3452 This option is only active when @option{-fstrict-aliasing} is active.
3453 It warns about code which might break the strict aliasing rules that the
3454 compiler is using for optimization.
3455 Higher levels correspond to higher accuracy (fewer false positives).
3456 Higher levels also correspond to more effort, similar to the way -O works.
3457 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3458 with n=3.
3459
3460 Level 1: Most aggressive, quick, least accurate.
3461 Possibly useful when higher levels
3462 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3463 false negatives.  However, it has many false positives.
3464 Warns for all pointer conversions between possibly incompatible types,
3465 even if never dereferenced.  Runs in the frontend only.
3466
3467 Level 2: Aggressive, quick, not too precise.
3468 May still have many false positives (not as many as level 1 though),
3469 and few false negatives (but possibly more than level 1).
3470 Unlike level 1, it only warns when an address is taken.  Warns about
3471 incomplete types.  Runs in the frontend only.
3472
3473 Level 3 (default for @option{-Wstrict-aliasing}):
3474 Should have very few false positives and few false
3475 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3476 Takes care of the common punn+dereference pattern in the frontend:
3477 @code{*(int*)&some_float}.
3478 If optimization is enabled, it also runs in the backend, where it deals
3479 with multiple statement cases using flow-sensitive points-to information.
3480 Only warns when the converted pointer is dereferenced.
3481 Does not warn about incomplete types.
3482
3483 @item -Wstrict-overflow
3484 @itemx -Wstrict-overflow=@var{n}
3485 @opindex Wstrict-overflow
3486 @opindex Wno-strict-overflow
3487 This option is only active when @option{-fstrict-overflow} is active.
3488 It warns about cases where the compiler optimizes based on the
3489 assumption that signed overflow does not occur.  Note that it does not
3490 warn about all cases where the code might overflow: it only warns
3491 about cases where the compiler implements some optimization.  Thus
3492 this warning depends on the optimization level.
3493
3494 An optimization which assumes that signed overflow does not occur is
3495 perfectly safe if the values of the variables involved are such that
3496 overflow never does, in fact, occur.  Therefore this warning can
3497 easily give a false positive: a warning about code which is not
3498 actually a problem.  To help focus on important issues, several
3499 warning levels are defined.  No warnings are issued for the use of
3500 undefined signed overflow when estimating how many iterations a loop
3501 will require, in particular when determining whether a loop will be
3502 executed at all.
3503
3504 @table @gcctabopt
3505 @item -Wstrict-overflow=1
3506 Warn about cases which are both questionable and easy to avoid.  For
3507 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3508 compiler will simplify this to @code{1}.  This level of
3509 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3510 are not, and must be explicitly requested.
3511
3512 @item -Wstrict-overflow=2
3513 Also warn about other cases where a comparison is simplified to a
3514 constant.  For example: @code{abs (x) >= 0}.  This can only be
3515 simplified when @option{-fstrict-overflow} is in effect, because
3516 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3517 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3518 @option{-Wstrict-overflow=2}.
3519
3520 @item -Wstrict-overflow=3
3521 Also warn about other cases where a comparison is simplified.  For
3522 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3523
3524 @item -Wstrict-overflow=4
3525 Also warn about other simplifications not covered by the above cases.
3526 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3527
3528 @item -Wstrict-overflow=5
3529 Also warn about cases where the compiler reduces the magnitude of a
3530 constant involved in a comparison.  For example: @code{x + 2 > y} will
3531 be simplified to @code{x + 1 >= y}.  This is reported only at the
3532 highest warning level because this simplification applies to many
3533 comparisons, so this warning level will give a very large number of
3534 false positives.
3535 @end table
3536
3537 @item -Warray-bounds
3538 @opindex Wno-array-bounds
3539 @opindex Warray-bounds
3540 This option is only active when @option{-ftree-vrp} is active
3541 (default for -O2 and above). It warns about subscripts to arrays
3542 that are always out of bounds. This warning is enabled by @option{-Wall}.
3543
3544 @item -Wno-div-by-zero
3545 @opindex Wno-div-by-zero
3546 @opindex Wdiv-by-zero
3547 Do not warn about compile-time integer division by zero.  Floating point
3548 division by zero is not warned about, as it can be a legitimate way of
3549 obtaining infinities and NaNs.
3550
3551 @item -Wsystem-headers
3552 @opindex Wsystem-headers
3553 @opindex Wno-system-headers
3554 @cindex warnings from system headers
3555 @cindex system headers, warnings from
3556 Print warning messages for constructs found in system header files.
3557 Warnings from system headers are normally suppressed, on the assumption
3558 that they usually do not indicate real problems and would only make the
3559 compiler output harder to read.  Using this command line option tells
3560 GCC to emit warnings from system headers as if they occurred in user
3561 code.  However, note that using @option{-Wall} in conjunction with this
3562 option will @emph{not} warn about unknown pragmas in system
3563 headers---for that, @option{-Wunknown-pragmas} must also be used.
3564
3565 @item -Wfloat-equal
3566 @opindex Wfloat-equal
3567 @opindex Wno-float-equal
3568 Warn if floating point values are used in equality comparisons.
3569
3570 The idea behind this is that sometimes it is convenient (for the
3571 programmer) to consider floating-point values as approximations to
3572 infinitely precise real numbers.  If you are doing this, then you need
3573 to compute (by analyzing the code, or in some other way) the maximum or
3574 likely maximum error that the computation introduces, and allow for it
3575 when performing comparisons (and when producing output, but that's a
3576 different problem).  In particular, instead of testing for equality, you
3577 would check to see whether the two values have ranges that overlap; and
3578 this is done with the relational operators, so equality comparisons are
3579 probably mistaken.
3580
3581 @item -Wtraditional @r{(C and Objective-C only)}
3582 @opindex Wtraditional
3583 @opindex Wno-traditional
3584 Warn about certain constructs that behave differently in traditional and
3585 ISO C@.  Also warn about ISO C constructs that have no traditional C
3586 equivalent, and/or problematic constructs which should be avoided.
3587
3588 @itemize @bullet
3589 @item
3590 Macro parameters that appear within string literals in the macro body.
3591 In traditional C macro replacement takes place within string literals,
3592 but does not in ISO C@.
3593
3594 @item
3595 In traditional C, some preprocessor directives did not exist.
3596 Traditional preprocessors would only consider a line to be a directive
3597 if the @samp{#} appeared in column 1 on the line.  Therefore
3598 @option{-Wtraditional} warns about directives that traditional C
3599 understands but would ignore because the @samp{#} does not appear as the
3600 first character on the line.  It also suggests you hide directives like
3601 @samp{#pragma} not understood by traditional C by indenting them.  Some
3602 traditional implementations would not recognize @samp{#elif}, so it
3603 suggests avoiding it altogether.
3604
3605 @item
3606 A function-like macro that appears without arguments.
3607
3608 @item
3609 The unary plus operator.
3610
3611 @item
3612 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3613 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3614 constants.)  Note, these suffixes appear in macros defined in the system
3615 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3616 Use of these macros in user code might normally lead to spurious
3617 warnings, however GCC's integrated preprocessor has enough context to
3618 avoid warning in these cases.
3619
3620 @item
3621 A function declared external in one block and then used after the end of
3622 the block.
3623
3624 @item
3625 A @code{switch} statement has an operand of type @code{long}.
3626
3627 @item
3628 A non-@code{static} function declaration follows a @code{static} one.
3629 This construct is not accepted by some traditional C compilers.
3630
3631 @item
3632 The ISO type of an integer constant has a different width or
3633 signedness from its traditional type.  This warning is only issued if
3634 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3635 typically represent bit patterns, are not warned about.
3636
3637 @item
3638 Usage of ISO string concatenation is detected.
3639
3640 @item
3641 Initialization of automatic aggregates.
3642
3643 @item
3644 Identifier conflicts with labels.  Traditional C lacks a separate
3645 namespace for labels.
3646
3647 @item
3648 Initialization of unions.  If the initializer is zero, the warning is
3649 omitted.  This is done under the assumption that the zero initializer in
3650 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3651 initializer warnings and relies on default initialization to zero in the
3652 traditional C case.
3653
3654 @item
3655 Conversions by prototypes between fixed/floating point values and vice
3656 versa.  The absence of these prototypes when compiling with traditional
3657 C would cause serious problems.  This is a subset of the possible
3658 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3659
3660 @item
3661 Use of ISO C style function definitions.  This warning intentionally is
3662 @emph{not} issued for prototype declarations or variadic functions
3663 because these ISO C features will appear in your code when using
3664 libiberty's traditional C compatibility macros, @code{PARAMS} and
3665 @code{VPARAMS}.  This warning is also bypassed for nested functions
3666 because that feature is already a GCC extension and thus not relevant to
3667 traditional C compatibility.
3668 @end itemize
3669
3670 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3671 @opindex Wtraditional-conversion
3672 @opindex Wno-traditional-conversion
3673 Warn if a prototype causes a type conversion that is different from what
3674 would happen to the same argument in the absence of a prototype.  This
3675 includes conversions of fixed point to floating and vice versa, and
3676 conversions changing the width or signedness of a fixed point argument
3677 except when the same as the default promotion.
3678
3679 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3680 @opindex Wdeclaration-after-statement
3681 @opindex Wno-declaration-after-statement
3682 Warn when a declaration is found after a statement in a block.  This
3683 construct, known from C++, was introduced with ISO C99 and is by default
3684 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3685 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3686
3687 @item -Wundef
3688 @opindex Wundef
3689 @opindex Wno-undef
3690 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3691
3692 @item -Wno-endif-labels
3693 @opindex Wno-endif-labels
3694 @opindex Wendif-labels
3695 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3696
3697 @item -Wshadow
3698 @opindex Wshadow
3699 @opindex Wno-shadow
3700 Warn whenever a local variable shadows another local variable, parameter or
3701 global variable or whenever a built-in function is shadowed.
3702
3703 @item -Wlarger-than=@var{len}
3704 @opindex Wlarger-than=@var{len}
3705 @opindex Wlarger-than-@var{len}
3706 Warn whenever an object of larger than @var{len} bytes is defined.
3707
3708 @item -Wframe-larger-than=@var{len}
3709 @opindex Wframe-larger-than
3710 Warn if the size of a function frame is larger than @var{len} bytes.
3711 The computation done to determine the stack frame size is approximate
3712 and not conservative.
3713 The actual requirements may be somewhat greater than @var{len}
3714 even if you do not get a warning.  In addition, any space allocated
3715 via @code{alloca}, variable-length arrays, or related constructs
3716 is not included by the compiler when determining
3717 whether or not to issue a warning.
3718
3719 @item -Wunsafe-loop-optimizations
3720 @opindex Wunsafe-loop-optimizations
3721 @opindex Wno-unsafe-loop-optimizations
3722 Warn if the loop cannot be optimized because the compiler could not
3723 assume anything on the bounds of the loop indices.  With
3724 @option{-funsafe-loop-optimizations} warn if the compiler made
3725 such assumptions.
3726
3727 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3728 @opindex Wno-pedantic-ms-format
3729 @opindex Wpedantic-ms-format
3730 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3731 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3732 depending on the MS runtime, when you are using the options @option{-Wformat}
3733 and @option{-pedantic} without gnu-extensions.
3734
3735 @item -Wpointer-arith
3736 @opindex Wpointer-arith
3737 @opindex Wno-pointer-arith
3738 Warn about anything that depends on the ``size of'' a function type or
3739 of @code{void}.  GNU C assigns these types a size of 1, for
3740 convenience in calculations with @code{void *} pointers and pointers
3741 to functions.  In C++, warn also when an arithmetic operation involves
3742 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3743
3744 @item -Wtype-limits
3745 @opindex Wtype-limits
3746 @opindex Wno-type-limits
3747 Warn if a comparison is always true or always false due to the limited
3748 range of the data type, but do not warn for constant expressions.  For
3749 example, warn if an unsigned variable is compared against zero with
3750 @samp{<} or @samp{>=}.  This warning is also enabled by
3751 @option{-Wextra}.
3752
3753 @item -Wbad-function-cast @r{(C and Objective-C only)}
3754 @opindex Wbad-function-cast
3755 @opindex Wno-bad-function-cast
3756 Warn whenever a function call is cast to a non-matching type.
3757 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3758
3759 @item -Wc++-compat @r{(C and Objective-C only)}
3760 Warn about ISO C constructs that are outside of the common subset of
3761 ISO C and ISO C++, e.g.@: request for implicit conversion from
3762 @code{void *} to a pointer to non-@code{void} type.
3763
3764 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3765 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3766 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3767 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3768
3769 @item -Wcast-qual
3770 @opindex Wcast-qual
3771 @opindex Wno-cast-qual
3772 Warn whenever a pointer is cast so as to remove a type qualifier from
3773 the target type.  For example, warn if a @code{const char *} is cast
3774 to an ordinary @code{char *}.
3775
3776 Also warn when making a cast which introduces a type qualifier in an
3777 unsafe way.  For example, casting @code{char **} to @code{const char **}
3778 is unsafe, as in this example:
3779
3780 @smallexample
3781   /* p is char ** value.  */
3782   const char **q = (const char **) p;
3783   /* Assignment of readonly string to const char * is OK.  */
3784   *q = "string";
3785   /* Now char** pointer points to read-only memory.  */
3786   **p = 'b';
3787 @end smallexample
3788
3789 @item -Wcast-align
3790 @opindex Wcast-align
3791 @opindex Wno-cast-align
3792 Warn whenever a pointer is cast such that the required alignment of the
3793 target is increased.  For example, warn if a @code{char *} is cast to
3794 an @code{int *} on machines where integers can only be accessed at
3795 two- or four-byte boundaries.
3796
3797 @item -Wwrite-strings
3798 @opindex Wwrite-strings
3799 @opindex Wno-write-strings
3800 When compiling C, give string constants the type @code{const
3801 char[@var{length}]} so that copying the address of one into a
3802 non-@code{const} @code{char *} pointer will get a warning.  These
3803 warnings will help you find at compile time code that can try to write
3804 into a string constant, but only if you have been very careful about
3805 using @code{const} in declarations and prototypes.  Otherwise, it will
3806 just be a nuisance. This is why we did not make @option{-Wall} request
3807 these warnings.
3808
3809 When compiling C++, warn about the deprecated conversion from string
3810 literals to @code{char *}.  This warning is enabled by default for C++
3811 programs.
3812
3813 @item -Wclobbered
3814 @opindex Wclobbered
3815 @opindex Wno-clobbered
3816 Warn for variables that might be changed by @samp{longjmp} or
3817 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3818
3819 @item -Wconversion
3820 @opindex Wconversion
3821 @opindex Wno-conversion
3822 Warn for implicit conversions that may alter a value. This includes
3823 conversions between real and integer, like @code{abs (x)} when
3824 @code{x} is @code{double}; conversions between signed and unsigned,
3825 like @code{unsigned ui = -1}; and conversions to smaller types, like
3826 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3827 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3828 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3829 conversions between signed and unsigned integers can be disabled by
3830 using @option{-Wno-sign-conversion}.
3831
3832 For C++, also warn for conversions between @code{NULL} and non-pointer
3833 types; confusing overload resolution for user-defined conversions; and
3834 conversions that will never use a type conversion operator:
3835 conversions to @code{void}, the same type, a base class or a reference
3836 to them. Warnings about conversions between signed and unsigned
3837 integers are disabled by default in C++ unless
3838 @option{-Wsign-conversion} is explicitly enabled.
3839
3840 @item -Wempty-body
3841 @opindex Wempty-body
3842 @opindex Wno-empty-body
3843 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3844 while} statement.  This warning is also enabled by @option{-Wextra}.
3845
3846 @item -Wenum-compare
3847 @opindex Wenum-compare
3848 @opindex Wno-enum-compare
3849 Warn about a comparison between values of different enum types. In C++
3850 this warning is enabled by default.  In C this warning is enabled by
3851 @option{-Wall}.
3852
3853 @item -Wsign-compare
3854 @opindex Wsign-compare
3855 @opindex Wno-sign-compare
3856 @cindex warning for comparison of signed and unsigned values
3857 @cindex comparison of signed and unsigned values, warning
3858 @cindex signed and unsigned values, comparison warning
3859 Warn when a comparison between signed and unsigned values could produce
3860 an incorrect result when the signed value is converted to unsigned.
3861 This warning is also enabled by @option{-Wextra}; to get the other warnings
3862 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3863
3864 @item -Wsign-conversion
3865 @opindex Wsign-conversion
3866 @opindex Wno-sign-conversion
3867 Warn for implicit conversions that may change the sign of an integer
3868 value, like assigning a signed integer expression to an unsigned
3869 integer variable. An explicit cast silences the warning. In C, this
3870 option is enabled also by @option{-Wconversion}.
3871
3872 @item -Waddress
3873 @opindex Waddress
3874 @opindex Wno-address
3875 Warn about suspicious uses of memory addresses. These include using
3876 the address of a function in a conditional expression, such as
3877 @code{void func(void); if (func)}, and comparisons against the memory
3878 address of a string literal, such as @code{if (x == "abc")}.  Such
3879 uses typically indicate a programmer error: the address of a function
3880 always evaluates to true, so their use in a conditional usually
3881 indicate that the programmer forgot the parentheses in a function
3882 call; and comparisons against string literals result in unspecified
3883 behavior and are not portable in C, so they usually indicate that the
3884 programmer intended to use @code{strcmp}.  This warning is enabled by
3885 @option{-Wall}.
3886
3887 @item -Wlogical-op
3888 @opindex Wlogical-op
3889 @opindex Wno-logical-op
3890 Warn about suspicious uses of logical operators in expressions.
3891 This includes using logical operators in contexts where a
3892 bit-wise operator is likely to be expected.
3893
3894 @item -Waggregate-return
3895 @opindex Waggregate-return
3896 @opindex Wno-aggregate-return
3897 Warn if any functions that return structures or unions are defined or
3898 called.  (In languages where you can return an array, this also elicits
3899 a warning.)
3900
3901 @item -Wno-attributes
3902 @opindex Wno-attributes
3903 @opindex Wattributes
3904 Do not warn if an unexpected @code{__attribute__} is used, such as
3905 unrecognized attributes, function attributes applied to variables,
3906 etc.  This will not stop errors for incorrect use of supported
3907 attributes.
3908
3909 @item -Wno-builtin-macro-redefined
3910 @opindex Wno-builtin-macro-redefined
3911 @opindex Wbuiltin-macro-redefined
3912 Do not warn if certain built-in macros are redefined.  This suppresses
3913 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
3914 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
3915
3916 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3917 @opindex Wstrict-prototypes
3918 @opindex Wno-strict-prototypes
3919 Warn if a function is declared or defined without specifying the
3920 argument types.  (An old-style function definition is permitted without
3921 a warning if preceded by a declaration which specifies the argument
3922 types.)
3923
3924 @item -Wold-style-declaration @r{(C and Objective-C only)}
3925 @opindex Wold-style-declaration
3926 @opindex Wno-old-style-declaration
3927 Warn for obsolescent usages, according to the C Standard, in a
3928 declaration. For example, warn if storage-class specifiers like
3929 @code{static} are not the first things in a declaration.  This warning
3930 is also enabled by @option{-Wextra}.
3931
3932 @item -Wold-style-definition @r{(C and Objective-C only)}
3933 @opindex Wold-style-definition
3934 @opindex Wno-old-style-definition
3935 Warn if an old-style function definition is used.  A warning is given
3936 even if there is a previous prototype.
3937
3938 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3939 @opindex Wmissing-parameter-type
3940 @opindex Wno-missing-parameter-type
3941 A function parameter is declared without a type specifier in K&R-style
3942 functions:
3943
3944 @smallexample
3945 void foo(bar) @{ @}
3946 @end smallexample
3947
3948 This warning is also enabled by @option{-Wextra}.
3949
3950 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3951 @opindex Wmissing-prototypes
3952 @opindex Wno-missing-prototypes
3953 Warn if a global function is defined without a previous prototype
3954 declaration.  This warning is issued even if the definition itself
3955 provides a prototype.  The aim is to detect global functions that fail
3956 to be declared in header files.
3957
3958 @item -Wmissing-declarations
3959 @opindex Wmissing-declarations
3960 @opindex Wno-missing-declarations
3961 Warn if a global function is defined without a previous declaration.
3962 Do so even if the definition itself provides a prototype.
3963 Use this option to detect global functions that are not declared in
3964 header files.  In C++, no warnings are issued for function templates,
3965 or for inline functions, or for functions in anonymous namespaces.
3966
3967 @item -Wmissing-field-initializers
3968 @opindex Wmissing-field-initializers
3969 @opindex Wno-missing-field-initializers
3970 @opindex W
3971 @opindex Wextra
3972 @opindex Wno-extra
3973 Warn if a structure's initializer has some fields missing.  For
3974 example, the following code would cause such a warning, because
3975 @code{x.h} is implicitly zero:
3976
3977 @smallexample
3978 struct s @{ int f, g, h; @};
3979 struct s x = @{ 3, 4 @};
3980 @end smallexample
3981
3982 This option does not warn about designated initializers, so the following
3983 modification would not trigger a warning:
3984
3985 @smallexample
3986 struct s @{ int f, g, h; @};
3987 struct s x = @{ .f = 3, .g = 4 @};
3988 @end smallexample
3989
3990 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3991 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3992
3993 @item -Wmissing-noreturn
3994 @opindex Wmissing-noreturn
3995 @opindex Wno-missing-noreturn
3996 Warn about functions which might be candidates for attribute @code{noreturn}.
3997 Note these are only possible candidates, not absolute ones.  Care should
3998 be taken to manually verify functions actually do not ever return before
3999 adding the @code{noreturn} attribute, otherwise subtle code generation
4000 bugs could be introduced.  You will not get a warning for @code{main} in
4001 hosted C environments.
4002
4003 @item -Wmissing-format-attribute
4004 @opindex Wmissing-format-attribute
4005 @opindex Wno-missing-format-attribute
4006 @opindex Wformat
4007 @opindex Wno-format
4008 Warn about function pointers which might be candidates for @code{format}
4009 attributes.  Note these are only possible candidates, not absolute ones.
4010 GCC will guess that function pointers with @code{format} attributes that
4011 are used in assignment, initialization, parameter passing or return
4012 statements should have a corresponding @code{format} attribute in the
4013 resulting type.  I.e.@: the left-hand side of the assignment or
4014 initialization, the type of the parameter variable, or the return type
4015 of the containing function respectively should also have a @code{format}
4016 attribute to avoid the warning.
4017
4018 GCC will also warn about function definitions which might be
4019 candidates for @code{format} attributes.  Again, these are only
4020 possible candidates.  GCC will guess that @code{format} attributes
4021 might be appropriate for any function that calls a function like
4022 @code{vprintf} or @code{vscanf}, but this might not always be the
4023 case, and some functions for which @code{format} attributes are
4024 appropriate may not be detected.
4025
4026 @item -Wno-multichar
4027 @opindex Wno-multichar
4028 @opindex Wmultichar
4029 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4030 Usually they indicate a typo in the user's code, as they have
4031 implementation-defined values, and should not be used in portable code.
4032
4033 @item -Wnormalized=<none|id|nfc|nfkc>
4034 @opindex Wnormalized=
4035 @cindex NFC
4036 @cindex NFKC
4037 @cindex character set, input normalization
4038 In ISO C and ISO C++, two identifiers are different if they are
4039 different sequences of characters.  However, sometimes when characters
4040 outside the basic ASCII character set are used, you can have two
4041 different character sequences that look the same.  To avoid confusion,
4042 the ISO 10646 standard sets out some @dfn{normalization rules} which
4043 when applied ensure that two sequences that look the same are turned into
4044 the same sequence.  GCC can warn you if you are using identifiers which
4045 have not been normalized; this option controls that warning.
4046
4047 There are four levels of warning that GCC supports.  The default is
4048 @option{-Wnormalized=nfc}, which warns about any identifier which is
4049 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4050 recommended form for most uses.
4051
4052 Unfortunately, there are some characters which ISO C and ISO C++ allow
4053 in identifiers that when turned into NFC aren't allowable as
4054 identifiers.  That is, there's no way to use these symbols in portable
4055 ISO C or C++ and have all your identifiers in NFC@.
4056 @option{-Wnormalized=id} suppresses the warning for these characters.
4057 It is hoped that future versions of the standards involved will correct
4058 this, which is why this option is not the default.
4059
4060 You can switch the warning off for all characters by writing
4061 @option{-Wnormalized=none}.  You would only want to do this if you
4062 were using some other normalization scheme (like ``D''), because
4063 otherwise you can easily create bugs that are literally impossible to see.
4064
4065 Some characters in ISO 10646 have distinct meanings but look identical
4066 in some fonts or display methodologies, especially once formatting has
4067 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4068 LETTER N'', will display just like a regular @code{n} which has been
4069 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4070 normalization scheme to convert all these into a standard form as
4071 well, and GCC will warn if your code is not in NFKC if you use
4072 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4073 about every identifier that contains the letter O because it might be
4074 confused with the digit 0, and so is not the default, but may be
4075 useful as a local coding convention if the programming environment is
4076 unable to be fixed to display these characters distinctly.
4077
4078 @item -Wno-deprecated
4079 @opindex Wno-deprecated
4080 @opindex Wdeprecated
4081 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4082
4083 @item -Wno-deprecated-declarations
4084 @opindex Wno-deprecated-declarations
4085 @opindex Wdeprecated-declarations
4086 Do not warn about uses of functions (@pxref{Function Attributes}),
4087 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4088 Attributes}) marked as deprecated by using the @code{deprecated}
4089 attribute.
4090
4091 @item -Wno-overflow
4092 @opindex Wno-overflow
4093 @opindex Woverflow
4094 Do not warn about compile-time overflow in constant expressions.
4095
4096 @item -Woverride-init @r{(C and Objective-C only)}
4097 @opindex Woverride-init
4098 @opindex Wno-override-init
4099 @opindex W
4100 @opindex Wextra
4101 @opindex Wno-extra
4102 Warn if an initialized field without side effects is overridden when
4103 using designated initializers (@pxref{Designated Inits, , Designated
4104 Initializers}).
4105
4106 This warning is included in @option{-Wextra}.  To get other
4107 @option{-Wextra} warnings without this one, use @samp{-Wextra
4108 -Wno-override-init}.
4109
4110 @item -Wpacked
4111 @opindex Wpacked
4112 @opindex Wno-packed
4113 Warn if a structure is given the packed attribute, but the packed
4114 attribute has no effect on the layout or size of the structure.
4115 Such structures may be mis-aligned for little benefit.  For
4116 instance, in this code, the variable @code{f.x} in @code{struct bar}
4117 will be misaligned even though @code{struct bar} does not itself
4118 have the packed attribute:
4119
4120 @smallexample
4121 @group
4122 struct foo @{
4123   int x;
4124   char a, b, c, d;
4125 @} __attribute__((packed));
4126 struct bar @{
4127   char z;
4128   struct foo f;
4129 @};
4130 @end group
4131 @end smallexample
4132
4133 @item -Wpacked-bitfield-compat
4134 @opindex Wpacked-bitfield-compat
4135 @opindex Wno-packed-bitfield-compat
4136 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4137 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4138 the change can lead to differences in the structure layout.  GCC
4139 informs you when the offset of such a field has changed in GCC 4.4.
4140 For example there is no longer a 4-bit padding between field @code{a}
4141 and @code{b} in this structure:
4142
4143 @smallexample
4144 struct foo
4145 @{
4146   char a:4;
4147   char b:8;
4148 @} __attribute__ ((packed));
4149 @end smallexample
4150
4151 This warning is enabled by default.  Use
4152 @option{-Wno-packed-bitfield-compat} to disable this warning.
4153
4154 @item -Wpadded
4155 @opindex Wpadded
4156 @opindex Wno-padded
4157 Warn if padding is included in a structure, either to align an element
4158 of the structure or to align the whole structure.  Sometimes when this
4159 happens it is possible to rearrange the fields of the structure to
4160 reduce the padding and so make the structure smaller.
4161
4162 @item -Wredundant-decls
4163 @opindex Wredundant-decls
4164 @opindex Wno-redundant-decls
4165 Warn if anything is declared more than once in the same scope, even in
4166 cases where multiple declaration is valid and changes nothing.
4167
4168 @item -Wnested-externs @r{(C and Objective-C only)}
4169 @opindex Wnested-externs
4170 @opindex Wno-nested-externs
4171 Warn if an @code{extern} declaration is encountered within a function.
4172
4173 @item -Wunreachable-code
4174 @opindex Wunreachable-code
4175 @opindex Wno-unreachable-code
4176 Warn if the compiler detects that code will never be executed.
4177
4178 This option is intended to warn when the compiler detects that at
4179 least a whole line of source code will never be executed, because
4180 some condition is never satisfied or because it is after a
4181 procedure that never returns.
4182
4183 It is possible for this option to produce a warning even though there
4184 are circumstances under which part of the affected line can be executed,
4185 so care should be taken when removing apparently-unreachable code.
4186
4187 For instance, when a function is inlined, a warning may mean that the
4188 line is unreachable in only one inlined copy of the function.
4189
4190 This option is not made part of @option{-Wall} because in a debugging
4191 version of a program there is often substantial code which checks
4192 correct functioning of the program and is, hopefully, unreachable
4193 because the program does work.  Another common use of unreachable
4194 code is to provide behavior which is selectable at compile-time.
4195
4196 @item -Winline
4197 @opindex Winline
4198 @opindex Wno-inline
4199 Warn if a function can not be inlined and it was declared as inline.
4200 Even with this option, the compiler will not warn about failures to
4201 inline functions declared in system headers.
4202
4203 The compiler uses a variety of heuristics to determine whether or not
4204 to inline a function.  For example, the compiler takes into account
4205 the size of the function being inlined and the amount of inlining
4206 that has already been done in the current function.  Therefore,
4207 seemingly insignificant changes in the source program can cause the
4208 warnings produced by @option{-Winline} to appear or disappear.
4209
4210 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4211 @opindex Wno-invalid-offsetof
4212 @opindex Winvalid-offsetof
4213 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4214 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4215 to a non-POD type is undefined.  In existing C++ implementations,
4216 however, @samp{offsetof} typically gives meaningful results even when
4217 applied to certain kinds of non-POD types. (Such as a simple
4218 @samp{struct} that fails to be a POD type only by virtue of having a
4219 constructor.)  This flag is for users who are aware that they are
4220 writing nonportable code and who have deliberately chosen to ignore the
4221 warning about it.
4222
4223 The restrictions on @samp{offsetof} may be relaxed in a future version
4224 of the C++ standard.
4225
4226 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4227 @opindex Wno-int-to-pointer-cast
4228 @opindex Wint-to-pointer-cast
4229 Suppress warnings from casts to pointer type of an integer of a
4230 different size.
4231
4232 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4233 @opindex Wno-pointer-to-int-cast
4234 @opindex Wpointer-to-int-cast
4235 Suppress warnings from casts from a pointer to an integer type of a
4236 different size.
4237
4238 @item -Winvalid-pch
4239 @opindex Winvalid-pch
4240 @opindex Wno-invalid-pch
4241 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4242 the search path but can't be used.
4243
4244 @item -Wlong-long
4245 @opindex Wlong-long
4246 @opindex Wno-long-long
4247 Warn if @samp{long long} type is used.  This is enabled by either
4248 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4249 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4250
4251 @item -Wvariadic-macros
4252 @opindex Wvariadic-macros
4253 @opindex Wno-variadic-macros
4254 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4255 alternate syntax when in pedantic ISO C99 mode.  This is default.
4256 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4257
4258 @item -Wvla
4259 @opindex Wvla
4260 @opindex Wno-vla
4261 Warn if variable length array is used in the code.
4262 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4263 the variable length array.
4264
4265 @item -Wvolatile-register-var
4266 @opindex Wvolatile-register-var
4267 @opindex Wno-volatile-register-var
4268 Warn if a register variable is declared volatile.  The volatile
4269 modifier does not inhibit all optimizations that may eliminate reads
4270 and/or writes to register variables.  This warning is enabled by
4271 @option{-Wall}.
4272
4273 @item -Wdisabled-optimization
4274 @opindex Wdisabled-optimization
4275 @opindex Wno-disabled-optimization
4276 Warn if a requested optimization pass is disabled.  This warning does
4277 not generally indicate that there is anything wrong with your code; it
4278 merely indicates that GCC's optimizers were unable to handle the code
4279 effectively.  Often, the problem is that your code is too big or too
4280 complex; GCC will refuse to optimize programs when the optimization
4281 itself is likely to take inordinate amounts of time.
4282
4283 @item -Wpointer-sign @r{(C and Objective-C only)}
4284 @opindex Wpointer-sign
4285 @opindex Wno-pointer-sign
4286 Warn for pointer argument passing or assignment with different signedness.
4287 This option is only supported for C and Objective-C@.  It is implied by
4288 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4289 @option{-Wno-pointer-sign}.
4290
4291 @item -Wstack-protector
4292 @opindex Wstack-protector
4293 @opindex Wno-stack-protector
4294 This option is only active when @option{-fstack-protector} is active.  It
4295 warns about functions that will not be protected against stack smashing.
4296
4297 @item -Wno-mudflap
4298 @opindex Wno-mudflap
4299 Suppress warnings about constructs that cannot be instrumented by
4300 @option{-fmudflap}.
4301
4302 @item -Woverlength-strings
4303 @opindex Woverlength-strings
4304 @opindex Wno-overlength-strings
4305 Warn about string constants which are longer than the ``minimum
4306 maximum'' length specified in the C standard.  Modern compilers
4307 generally allow string constants which are much longer than the
4308 standard's minimum limit, but very portable programs should avoid
4309 using longer strings.
4310
4311 The limit applies @emph{after} string constant concatenation, and does
4312 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4313 C99, it was raised to 4095.  C++98 does not specify a normative
4314 minimum maximum, so we do not diagnose overlength strings in C++@.
4315
4316 This option is implied by @option{-pedantic}, and can be disabled with
4317 @option{-Wno-overlength-strings}.
4318
4319 @item -Wunsuffixed-float-constants
4320 @opindex Wunsuffixed-float-constants
4321
4322 GCC will issue a warning for any floating constant that does not have
4323 a suffix.  When used together with @option{-Wsystem-headers} it will
4324 warn about such constants in system header files.  This can be useful
4325 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4326 from the decimal floating-point extension to C99.
4327 @end table
4328
4329 @node Debugging Options
4330 @section Options for Debugging Your Program or GCC
4331 @cindex options, debugging
4332 @cindex debugging information options
4333
4334 GCC has various special options that are used for debugging
4335 either your program or GCC:
4336
4337 @table @gcctabopt
4338 @item -g
4339 @opindex g
4340 Produce debugging information in the operating system's native format
4341 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4342 information.
4343
4344 On most systems that use stabs format, @option{-g} enables use of extra
4345 debugging information that only GDB can use; this extra information
4346 makes debugging work better in GDB but will probably make other debuggers
4347 crash or
4348 refuse to read the program.  If you want to control for certain whether
4349 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4350 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4351
4352 GCC allows you to use @option{-g} with
4353 @option{-O}.  The shortcuts taken by optimized code may occasionally
4354 produce surprising results: some variables you declared may not exist
4355 at all; flow of control may briefly move where you did not expect it;
4356 some statements may not be executed because they compute constant
4357 results or their values were already at hand; some statements may
4358 execute in different places because they were moved out of loops.
4359
4360 Nevertheless it proves possible to debug optimized output.  This makes
4361 it reasonable to use the optimizer for programs that might have bugs.
4362
4363 The following options are useful when GCC is generated with the
4364 capability for more than one debugging format.
4365
4366 @item -ggdb
4367 @opindex ggdb
4368 Produce debugging information for use by GDB@.  This means to use the
4369 most expressive format available (DWARF 2, stabs, or the native format
4370 if neither of those are supported), including GDB extensions if at all
4371 possible.
4372
4373 @item -gstabs
4374 @opindex gstabs
4375 Produce debugging information in stabs format (if that is supported),
4376 without GDB extensions.  This is the format used by DBX on most BSD
4377 systems.  On MIPS, Alpha and System V Release 4 systems this option
4378 produces stabs debugging output which is not understood by DBX or SDB@.
4379 On System V Release 4 systems this option requires the GNU assembler.
4380
4381 @item -feliminate-unused-debug-symbols
4382 @opindex feliminate-unused-debug-symbols
4383 Produce debugging information in stabs format (if that is supported),
4384 for only symbols that are actually used.
4385
4386 @item -femit-class-debug-always
4387 Instead of emitting debugging information for a C++ class in only one
4388 object file, emit it in all object files using the class.  This option
4389 should be used only with debuggers that are unable to handle the way GCC
4390 normally emits debugging information for classes because using this
4391 option will increase the size of debugging information by as much as a
4392 factor of two.
4393
4394 @item -gstabs+
4395 @opindex gstabs+
4396 Produce debugging information in stabs format (if that is supported),
4397 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4398 use of these extensions is likely to make other debuggers crash or
4399 refuse to read the program.
4400
4401 @item -gcoff
4402 @opindex gcoff
4403 Produce debugging information in COFF format (if that is supported).
4404 This is the format used by SDB on most System V systems prior to
4405 System V Release 4.
4406
4407 @item -gxcoff
4408 @opindex gxcoff
4409 Produce debugging information in XCOFF format (if that is supported).
4410 This is the format used by the DBX debugger on IBM RS/6000 systems.
4411
4412 @item -gxcoff+
4413 @opindex gxcoff+
4414 Produce debugging information in XCOFF format (if that is supported),
4415 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4416 use of these extensions is likely to make other debuggers crash or
4417 refuse to read the program, and may cause assemblers other than the GNU
4418 assembler (GAS) to fail with an error.
4419
4420 @item -gdwarf-@var{version}
4421 @opindex gdwarf-@var{version}
4422 Produce debugging information in DWARF format (if that is
4423 supported).  This is the format used by DBX on IRIX 6.  The value
4424 of @var{version} may be either 2, 3 or 4; the default version is 2.
4425
4426 Note that with DWARF version 2 some ports require, and will always
4427 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4428
4429 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4430 for maximum benefit.
4431
4432 @item -gstrict-dwarf
4433 @opindex gstrict-dwarf
4434 Disallow using extensions of later DWARF standard version than selected
4435 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4436 DWARF extensions from later standard versions is allowed.
4437
4438 @item -gno-strict-dwarf
4439 @opindex gno-strict-dwarf
4440 Allow using extensions of later DWARF standard version than selected with
4441 @option{-gdwarf-@var{version}}.
4442
4443 @item -gvms
4444 @opindex gvms
4445 Produce debugging information in VMS debug format (if that is
4446 supported).  This is the format used by DEBUG on VMS systems.
4447
4448 @item -g@var{level}
4449 @itemx -ggdb@var{level}
4450 @itemx -gstabs@var{level}
4451 @itemx -gcoff@var{level}
4452 @itemx -gxcoff@var{level}
4453 @itemx -gvms@var{level}
4454 Request debugging information and also use @var{level} to specify how
4455 much information.  The default level is 2.
4456
4457 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4458 @option{-g}.
4459
4460 Level 1 produces minimal information, enough for making backtraces in
4461 parts of the program that you don't plan to debug.  This includes
4462 descriptions of functions and external variables, but no information
4463 about local variables and no line numbers.
4464
4465 Level 3 includes extra information, such as all the macro definitions
4466 present in the program.  Some debuggers support macro expansion when
4467 you use @option{-g3}.
4468
4469 @option{-gdwarf-2} does not accept a concatenated debug level, because
4470 GCC used to support an option @option{-gdwarf} that meant to generate
4471 debug information in version 1 of the DWARF format (which is very
4472 different from version 2), and it would have been too confusing.  That
4473 debug format is long obsolete, but the option cannot be changed now.
4474 Instead use an additional @option{-g@var{level}} option to change the
4475 debug level for DWARF.
4476
4477 @item -gtoggle
4478 @opindex gtoggle
4479 Turn off generation of debug info, if leaving out this option would have
4480 generated it, or turn it on at level 2 otherwise.  The position of this
4481 argument in the command line does not matter, it takes effect after all
4482 other options are processed, and it does so only once, no matter how
4483 many times it is given.  This is mainly intended to be used with
4484 @option{-fcompare-debug}.
4485
4486 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4487 @opindex fdump-final-insns
4488 Dump the final internal representation (RTL) to @var{file}.  If the
4489 optional argument is omitted (or if @var{file} is @code{.}), the name
4490 of the dump file will be determined by appending @code{.gkd} to the
4491 compilation output file name.
4492
4493 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4494 @opindex fcompare-debug
4495 @opindex fno-compare-debug
4496 If no error occurs during compilation, run the compiler a second time,
4497 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4498 passed to the second compilation.  Dump the final internal
4499 representation in both compilations, and print an error if they differ.
4500
4501 If the equal sign is omitted, the default @option{-gtoggle} is used.
4502
4503 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4504 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4505 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4506 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4507 is used.
4508
4509 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4510 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4511 of the final representation and the second compilation, preventing even
4512 @env{GCC_COMPARE_DEBUG} from taking effect.
4513
4514 To verify full coverage during @option{-fcompare-debug} testing, set
4515 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4516 which GCC will reject as an invalid option in any actual compilation
4517 (rather than preprocessing, assembly or linking).  To get just a
4518 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4519 not overridden} will do.
4520
4521 @item -fcompare-debug-second
4522 @opindex fcompare-debug-second
4523 This option is implicitly passed to the compiler for the second
4524 compilation requested by @option{-fcompare-debug}, along with options to
4525 silence warnings, and omitting other options that would cause
4526 side-effect compiler outputs to files or to the standard output.  Dump
4527 files and preserved temporary files are renamed so as to contain the
4528 @code{.gk} additional extension during the second compilation, to avoid
4529 overwriting those generated by the first.
4530
4531 When this option is passed to the compiler driver, it causes the
4532 @emph{first} compilation to be skipped, which makes it useful for little
4533 other than debugging the compiler proper.
4534
4535 @item -feliminate-dwarf2-dups
4536 @opindex feliminate-dwarf2-dups
4537 Compress DWARF2 debugging information by eliminating duplicated
4538 information about each symbol.  This option only makes sense when
4539 generating DWARF2 debugging information with @option{-gdwarf-2}.
4540
4541 @item -femit-struct-debug-baseonly
4542 Emit debug information for struct-like types
4543 only when the base name of the compilation source file
4544 matches the base name of file in which the struct was defined.
4545
4546 This option substantially reduces the size of debugging information,
4547 but at significant potential loss in type information to the debugger.
4548 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4549 See @option{-femit-struct-debug-detailed} for more detailed control.
4550
4551 This option works only with DWARF 2.
4552
4553 @item -femit-struct-debug-reduced
4554 Emit debug information for struct-like types
4555 only when the base name of the compilation source file
4556 matches the base name of file in which the type was defined,
4557 unless the struct is a template or defined in a system header.
4558
4559 This option significantly reduces the size of debugging information,
4560 with some potential loss in type information to the debugger.
4561 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4562 See @option{-femit-struct-debug-detailed} for more detailed control.
4563
4564 This option works only with DWARF 2.
4565
4566 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4567 Specify the struct-like types
4568 for which the compiler will generate debug information.
4569 The intent is to reduce duplicate struct debug information
4570 between different object files within the same program.
4571
4572 This option is a detailed version of
4573 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4574 which will serve for most needs.
4575
4576 A specification has the syntax
4577 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4578
4579 The optional first word limits the specification to
4580 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4581 A struct type is used directly when it is the type of a variable, member.
4582 Indirect uses arise through pointers to structs.
4583 That is, when use of an incomplete struct would be legal, the use is indirect.
4584 An example is
4585 @samp{struct one direct; struct two * indirect;}.
4586
4587 The optional second word limits the specification to
4588 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4589 Generic structs are a bit complicated to explain.
4590 For C++, these are non-explicit specializations of template classes,
4591 or non-template classes within the above.
4592 Other programming languages have generics,
4593 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4594
4595 The third word specifies the source files for those
4596 structs for which the compiler will emit debug information.
4597 The values @samp{none} and @samp{any} have the normal meaning.
4598 The value @samp{base} means that
4599 the base of name of the file in which the type declaration appears
4600 must match the base of the name of the main compilation file.
4601 In practice, this means that
4602 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4603 but types declared in other header will not.
4604 The value @samp{sys} means those types satisfying @samp{base}
4605 or declared in system or compiler headers.
4606
4607 You may need to experiment to determine the best settings for your application.
4608
4609 The default is @samp{-femit-struct-debug-detailed=all}.
4610
4611 This option works only with DWARF 2.
4612
4613 @item -fno-merge-debug-strings
4614 @opindex fmerge-debug-strings
4615 @opindex fno-merge-debug-strings
4616 Direct the linker to not merge together strings in the debugging
4617 information which are identical in different object files.  Merging is
4618 not supported by all assemblers or linkers.  Merging decreases the size
4619 of the debug information in the output file at the cost of increasing
4620 link processing time.  Merging is enabled by default.
4621
4622 @item -fdebug-prefix-map=@var{old}=@var{new}
4623 @opindex fdebug-prefix-map
4624 When compiling files in directory @file{@var{old}}, record debugging
4625 information describing them as in @file{@var{new}} instead.
4626
4627 @item -fno-dwarf2-cfi-asm
4628 @opindex fdwarf2-cfi-asm
4629 @opindex fno-dwarf2-cfi-asm
4630 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4631 instead of using GAS @code{.cfi_*} directives.
4632
4633 @cindex @command{prof}
4634 @item -p
4635 @opindex p
4636 Generate extra code to write profile information suitable for the
4637 analysis program @command{prof}.  You must use this option when compiling
4638 the source files you want data about, and you must also use it when
4639 linking.
4640
4641 @cindex @command{gprof}
4642 @item -pg
4643 @opindex pg
4644 Generate extra code to write profile information suitable for the
4645 analysis program @command{gprof}.  You must use this option when compiling
4646 the source files you want data about, and you must also use it when
4647 linking.
4648
4649 @item -Q
4650 @opindex Q
4651 Makes the compiler print out each function name as it is compiled, and
4652 print some statistics about each pass when it finishes.
4653
4654 @item -ftime-report
4655 @opindex ftime-report
4656 Makes the compiler print some statistics about the time consumed by each
4657 pass when it finishes.
4658
4659 @item -fmem-report
4660 @opindex fmem-report
4661 Makes the compiler print some statistics about permanent memory
4662 allocation when it finishes.
4663
4664 @item -fpre-ipa-mem-report
4665 @opindex fpre-ipa-mem-report
4666 @item -fpost-ipa-mem-report
4667 @opindex fpost-ipa-mem-report
4668 Makes the compiler print some statistics about permanent memory
4669 allocation before or after interprocedural optimization.
4670
4671 @item -fprofile-arcs
4672 @opindex fprofile-arcs
4673 Add code so that program flow @dfn{arcs} are instrumented.  During
4674 execution the program records how many times each branch and call is
4675 executed and how many times it is taken or returns.  When the compiled
4676 program exits it saves this data to a file called
4677 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4678 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4679 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4680 @var{auxname} is generated from the name of the output file, if
4681 explicitly specified and it is not the final executable, otherwise it is
4682 the basename of the source file.  In both cases any suffix is removed
4683 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4684 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4685 @xref{Cross-profiling}.
4686
4687 @cindex @command{gcov}
4688 @item --coverage
4689 @opindex coverage
4690
4691 This option is used to compile and link code instrumented for coverage
4692 analysis.  The option is a synonym for @option{-fprofile-arcs}
4693 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4694 linking).  See the documentation for those options for more details.
4695
4696 @itemize
4697
4698 @item
4699 Compile the source files with @option{-fprofile-arcs} plus optimization
4700 and code generation options.  For test coverage analysis, use the
4701 additional @option{-ftest-coverage} option.  You do not need to profile
4702 every source file in a program.
4703
4704 @item
4705 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4706 (the latter implies the former).
4707
4708 @item
4709 Run the program on a representative workload to generate the arc profile
4710 information.  This may be repeated any number of times.  You can run
4711 concurrent instances of your program, and provided that the file system
4712 supports locking, the data files will be correctly updated.  Also
4713 @code{fork} calls are detected and correctly handled (double counting
4714 will not happen).
4715
4716 @item
4717 For profile-directed optimizations, compile the source files again with
4718 the same optimization and code generation options plus
4719 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4720 Control Optimization}).
4721
4722 @item
4723 For test coverage analysis, use @command{gcov} to produce human readable
4724 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4725 @command{gcov} documentation for further information.
4726
4727 @end itemize
4728
4729 With @option{-fprofile-arcs}, for each function of your program GCC
4730 creates a program flow graph, then finds a spanning tree for the graph.
4731 Only arcs that are not on the spanning tree have to be instrumented: the
4732 compiler adds code to count the number of times that these arcs are
4733 executed.  When an arc is the only exit or only entrance to a block, the
4734 instrumentation code can be added to the block; otherwise, a new basic
4735 block must be created to hold the instrumentation code.
4736
4737 @need 2000
4738 @item -ftest-coverage
4739 @opindex ftest-coverage
4740 Produce a notes file that the @command{gcov} code-coverage utility
4741 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4742 show program coverage.  Each source file's note file is called
4743 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4744 above for a description of @var{auxname} and instructions on how to
4745 generate test coverage data.  Coverage data will match the source files
4746 more closely, if you do not optimize.
4747
4748 @item -fdbg-cnt-list
4749 @opindex fdbg-cnt-list
4750 Print the name and the counter upperbound for all debug counters.
4751
4752 @item -fdbg-cnt=@var{counter-value-list}
4753 @opindex fdbg-cnt
4754 Set the internal debug counter upperbound. @var{counter-value-list}
4755 is a comma-separated list of @var{name}:@var{value} pairs
4756 which sets the upperbound of each debug counter @var{name} to @var{value}.
4757 All debug counters have the initial upperbound of @var{UINT_MAX},
4758 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4759 e.g. With -fdbg-cnt=dce:10,tail_call:0
4760 dbg_cnt(dce) will return true only for first 10 invocations
4761 and dbg_cnt(tail_call) will return false always.
4762
4763 @item -d@var{letters}
4764 @itemx -fdump-rtl-@var{pass}
4765 @opindex d
4766 Says to make debugging dumps during compilation at times specified by
4767 @var{letters}.  This is used for debugging the RTL-based passes of the
4768 compiler.  The file names for most of the dumps are made by appending
4769 a pass number and a word to the @var{dumpname}, and the files are
4770 created in the directory of the output file.  @var{dumpname} is
4771 generated from the name of the output file, if explicitly specified
4772 and it is not an executable, otherwise it is the basename of the
4773 source file. These switches may have different effects when
4774 @option{-E} is used for preprocessing.
4775
4776 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4777 @option{-d} option @var{letters}.  Here are the possible
4778 letters for use in @var{pass} and @var{letters}, and their meanings:
4779
4780 @table @gcctabopt
4781
4782 @item -fdump-rtl-alignments
4783 @opindex fdump-rtl-alignments
4784 Dump after branch alignments have been computed.
4785
4786 @item -fdump-rtl-asmcons
4787 @opindex fdump-rtl-asmcons
4788 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4789
4790 @item -fdump-rtl-auto_inc_dec
4791 @opindex fdump-rtl-auto_inc_dec
4792 Dump after auto-inc-dec discovery.  This pass is only run on
4793 architectures that have auto inc or auto dec instructions.
4794
4795 @item -fdump-rtl-barriers
4796 @opindex fdump-rtl-barriers
4797 Dump after cleaning up the barrier instructions.
4798
4799 @item -fdump-rtl-bbpart
4800 @opindex fdump-rtl-bbpart
4801 Dump after partitioning hot and cold basic blocks.
4802
4803 @item -fdump-rtl-bbro
4804 @opindex fdump-rtl-bbro
4805 Dump after block reordering.
4806
4807 @item -fdump-rtl-btl1
4808 @itemx -fdump-rtl-btl2
4809 @opindex fdump-rtl-btl2
4810 @opindex fdump-rtl-btl2
4811 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4812 after the two branch
4813 target load optimization passes.
4814
4815 @item -fdump-rtl-bypass
4816 @opindex fdump-rtl-bypass
4817 Dump after jump bypassing and control flow optimizations.
4818
4819 @item -fdump-rtl-combine
4820 @opindex fdump-rtl-combine
4821 Dump after the RTL instruction combination pass.
4822
4823 @item -fdump-rtl-compgotos
4824 @opindex fdump-rtl-compgotos
4825 Dump after duplicating the computed gotos.
4826
4827 @item -fdump-rtl-ce1
4828 @itemx -fdump-rtl-ce2
4829 @itemx -fdump-rtl-ce3
4830 @opindex fdump-rtl-ce1
4831 @opindex fdump-rtl-ce2
4832 @opindex fdump-rtl-ce3
4833 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4834 @option{-fdump-rtl-ce3} enable dumping after the three
4835 if conversion passes.
4836
4837 @itemx -fdump-rtl-cprop_hardreg
4838 @opindex fdump-rtl-cprop_hardreg
4839 Dump after hard register copy propagation.
4840
4841 @itemx -fdump-rtl-csa
4842 @opindex fdump-rtl-csa
4843 Dump after combining stack adjustments.
4844
4845 @item -fdump-rtl-cse1
4846 @itemx -fdump-rtl-cse2
4847 @opindex fdump-rtl-cse1
4848 @opindex fdump-rtl-cse2
4849 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4850 the two common sub-expression elimination passes.
4851
4852 @itemx -fdump-rtl-dce
4853 @opindex fdump-rtl-dce
4854 Dump after the standalone dead code elimination passes.
4855
4856 @itemx -fdump-rtl-dbr
4857 @opindex fdump-rtl-dbr
4858 Dump after delayed branch scheduling.
4859
4860 @item -fdump-rtl-dce1
4861 @itemx -fdump-rtl-dce2
4862 @opindex fdump-rtl-dce1
4863 @opindex fdump-rtl-dce2
4864 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4865 the two dead store elimination passes.
4866
4867 @item -fdump-rtl-eh
4868 @opindex fdump-rtl-eh
4869 Dump after finalization of EH handling code.
4870
4871 @item -fdump-rtl-eh_ranges
4872 @opindex fdump-rtl-eh_ranges
4873 Dump after conversion of EH handling range regions.
4874
4875 @item -fdump-rtl-expand
4876 @opindex fdump-rtl-expand
4877 Dump after RTL generation.
4878
4879 @item -fdump-rtl-fwprop1
4880 @itemx -fdump-rtl-fwprop2
4881 @opindex fdump-rtl-fwprop1
4882 @opindex fdump-rtl-fwprop2
4883 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
4884 dumping after the two forward propagation passes.
4885
4886 @item -fdump-rtl-gcse1
4887 @itemx -fdump-rtl-gcse2
4888 @opindex fdump-rtl-gcse1
4889 @opindex fdump-rtl-gcse2
4890 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
4891 after global common subexpression elimination.
4892
4893 @item -fdump-rtl-init-regs
4894 @opindex fdump-rtl-init-regs
4895 Dump after the initialization of the registers.
4896
4897 @item -fdump-rtl-initvals
4898 @opindex fdump-rtl-initvals
4899 Dump after the computation of the initial value sets.
4900
4901 @itemx -fdump-rtl-into_cfglayout
4902 @opindex fdump-rtl-into_cfglayout
4903 Dump after converting to cfglayout mode.
4904
4905 @item -fdump-rtl-ira
4906 @opindex fdump-rtl-ira
4907 Dump after iterated register allocation.
4908
4909 @item -fdump-rtl-jump
4910 @opindex fdump-rtl-jump
4911 Dump after the second jump optimization.
4912
4913 @item -fdump-rtl-loop2
4914 @opindex fdump-rtl-loop2
4915 @option{-fdump-rtl-loop2} enables dumping after the rtl
4916 loop optimization passes.
4917
4918 @item -fdump-rtl-mach
4919 @opindex fdump-rtl-mach
4920 Dump after performing the machine dependent reorganization pass, if that
4921 pass exists.
4922
4923 @item -fdump-rtl-mode_sw
4924 @opindex fdump-rtl-mode_sw
4925 Dump after removing redundant mode switches.
4926
4927 @item -fdump-rtl-rnreg
4928 @opindex fdump-rtl-rnreg
4929 Dump after register renumbering.
4930
4931 @itemx -fdump-rtl-outof_cfglayout
4932 @opindex fdump-rtl-outof_cfglayout
4933 Dump after converting from cfglayout mode.
4934
4935 @item -fdump-rtl-peephole2
4936 @opindex fdump-rtl-peephole2
4937 Dump after the peephole pass.
4938
4939 @item -fdump-rtl-postreload
4940 @opindex fdump-rtl-postreload
4941 Dump after post-reload optimizations.
4942
4943 @itemx -fdump-rtl-pro_and_epilogue
4944 @opindex fdump-rtl-pro_and_epilogue
4945 Dump after generating the function pro and epilogues.
4946
4947 @item -fdump-rtl-regmove
4948 @opindex fdump-rtl-regmove
4949 Dump after the register move pass.
4950
4951 @item -fdump-rtl-sched1
4952 @itemx -fdump-rtl-sched2
4953 @opindex fdump-rtl-sched1
4954 @opindex fdump-rtl-sched2
4955 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
4956 after the basic block scheduling passes.
4957
4958 @item -fdump-rtl-see
4959 @opindex fdump-rtl-see
4960 Dump after sign extension elimination.
4961
4962 @item -fdump-rtl-seqabstr
4963 @opindex fdump-rtl-seqabstr
4964 Dump after common sequence discovery.
4965
4966 @item -fdump-rtl-shorten
4967 @opindex fdump-rtl-shorten
4968 Dump after shortening branches.
4969
4970 @item -fdump-rtl-sibling
4971 @opindex fdump-rtl-sibling
4972 Dump after sibling call optimizations.
4973
4974 @item -fdump-rtl-split1
4975 @itemx -fdump-rtl-split2
4976 @itemx -fdump-rtl-split3
4977 @itemx -fdump-rtl-split4
4978 @itemx -fdump-rtl-split5
4979 @opindex fdump-rtl-split1
4980 @opindex fdump-rtl-split2
4981 @opindex fdump-rtl-split3
4982 @opindex fdump-rtl-split4
4983 @opindex fdump-rtl-split5
4984 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
4985 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
4986 @option{-fdump-rtl-split5} enable dumping after five rounds of
4987 instruction splitting.
4988
4989 @item -fdump-rtl-sms
4990 @opindex fdump-rtl-sms
4991 Dump after modulo scheduling.  This pass is only run on some
4992 architectures.
4993
4994 @item -fdump-rtl-stack
4995 @opindex fdump-rtl-stack
4996 Dump after conversion from GCC's "flat register file" registers to the
4997 x87's stack-like registers.  This pass is only run on x86 variants.
4998
4999 @item -fdump-rtl-subreg1
5000 @itemx -fdump-rtl-subreg2
5001 @opindex fdump-rtl-subreg1
5002 @opindex fdump-rtl-subreg2
5003 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5004 the two subreg expansion passes.
5005
5006 @item -fdump-rtl-unshare
5007 @opindex fdump-rtl-unshare
5008 Dump after all rtl has been unshared.
5009
5010 @item -fdump-rtl-vartrack
5011 @opindex fdump-rtl-vartrack
5012 Dump after variable tracking.
5013
5014 @item -fdump-rtl-vregs
5015 @opindex fdump-rtl-vregs
5016 Dump after converting virtual registers to hard registers.
5017
5018 @item -fdump-rtl-web
5019 @opindex fdump-rtl-web
5020 Dump after live range splitting.
5021
5022 @item -fdump-rtl-regclass
5023 @itemx -fdump-rtl-subregs_of_mode_init
5024 @itemx -fdump-rtl-subregs_of_mode_finish
5025 @itemx -fdump-rtl-dfinit
5026 @itemx -fdump-rtl-dfinish
5027 @opindex fdump-rtl-regclass
5028 @opindex fdump-rtl-subregs_of_mode_init
5029 @opindex fdump-rtl-subregs_of_mode_finish
5030 @opindex fdump-rtl-dfinit
5031 @opindex fdump-rtl-dfinish
5032 These dumps are defined but always produce empty files.
5033
5034 @item -fdump-rtl-all
5035 @opindex fdump-rtl-all
5036 Produce all the dumps listed above.
5037
5038 @item -dA
5039 @opindex dA
5040 Annotate the assembler output with miscellaneous debugging information.
5041
5042 @item -dD
5043 @opindex dD
5044 Dump all macro definitions, at the end of preprocessing, in addition to
5045 normal output.
5046
5047 @item -dH
5048 @opindex dH
5049 Produce a core dump whenever an error occurs.
5050
5051 @item -dm
5052 @opindex dm
5053 Print statistics on memory usage, at the end of the run, to
5054 standard error.
5055
5056 @item -dp
5057 @opindex dp
5058 Annotate the assembler output with a comment indicating which
5059 pattern and alternative was used.  The length of each instruction is
5060 also printed.
5061
5062 @item -dP
5063 @opindex dP
5064 Dump the RTL in the assembler output as a comment before each instruction.
5065 Also turns on @option{-dp} annotation.
5066
5067 @item -dv
5068 @opindex dv
5069 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5070 dump a representation of the control flow graph suitable for viewing with VCG
5071 to @file{@var{file}.@var{pass}.vcg}.
5072
5073 @item -dx
5074 @opindex dx
5075 Just generate RTL for a function instead of compiling it.  Usually used
5076 with @option{-fdump-rtl-expand}.
5077
5078 @item -dy
5079 @opindex dy
5080 Dump debugging information during parsing, to standard error.
5081 @end table
5082
5083 @item -fdump-noaddr
5084 @opindex fdump-noaddr
5085 When doing debugging dumps, suppress address output.  This makes it more
5086 feasible to use diff on debugging dumps for compiler invocations with
5087 different compiler binaries and/or different
5088 text / bss / data / heap / stack / dso start locations.
5089
5090 @item -fdump-unnumbered
5091 @opindex fdump-unnumbered
5092 When doing debugging dumps, suppress instruction numbers and address output.
5093 This makes it more feasible to use diff on debugging dumps for compiler
5094 invocations with different options, in particular with and without
5095 @option{-g}.
5096
5097 @item -fdump-unnumbered-links
5098 @opindex fdump-unnumbered-links
5099 When doing debugging dumps (see @option{-d} option above), suppress
5100 instruction numbers for the links to the previous and next instructions
5101 in a sequence.
5102
5103 @item -fdump-translation-unit @r{(C++ only)}
5104 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5105 @opindex fdump-translation-unit
5106 Dump a representation of the tree structure for the entire translation
5107 unit to a file.  The file name is made by appending @file{.tu} to the
5108 source file name, and the file is created in the same directory as the
5109 output file.  If the @samp{-@var{options}} form is used, @var{options}
5110 controls the details of the dump as described for the
5111 @option{-fdump-tree} options.
5112
5113 @item -fdump-class-hierarchy @r{(C++ only)}
5114 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5115 @opindex fdump-class-hierarchy
5116 Dump a representation of each class's hierarchy and virtual function
5117 table layout to a file.  The file name is made by appending
5118 @file{.class} to the source file name, and the file is created in the
5119 same directory as the output file.  If the @samp{-@var{options}} form
5120 is used, @var{options} controls the details of the dump as described
5121 for the @option{-fdump-tree} options.
5122
5123 @item -fdump-ipa-@var{switch}
5124 @opindex fdump-ipa
5125 Control the dumping at various stages of inter-procedural analysis
5126 language tree to a file.  The file name is generated by appending a
5127 switch specific suffix to the source file name, and the file is created
5128 in the same directory as the output file.  The following dumps are
5129 possible:
5130
5131 @table @samp
5132 @item all
5133 Enables all inter-procedural analysis dumps.
5134
5135 @item cgraph
5136 Dumps information about call-graph optimization, unused function removal,
5137 and inlining decisions.
5138
5139 @item inline
5140 Dump after function inlining.
5141
5142 @end table
5143
5144 @item -fdump-statistics-@var{option}
5145 @opindex fdump-statistics
5146 Enable and control dumping of pass statistics in a separate file.  The
5147 file name is generated by appending a suffix ending in
5148 @samp{.statistics} to the source file name, and the file is created in
5149 the same directory as the output file.  If the @samp{-@var{option}}
5150 form is used, @samp{-stats} will cause counters to be summed over the
5151 whole compilation unit while @samp{-details} will dump every event as
5152 the passes generate them.  The default with no option is to sum
5153 counters for each function compiled.
5154
5155 @item -fdump-tree-@var{switch}
5156 @itemx -fdump-tree-@var{switch}-@var{options}
5157 @opindex fdump-tree
5158 Control the dumping at various stages of processing the intermediate
5159 language tree to a file.  The file name is generated by appending a
5160 switch specific suffix to the source file name, and the file is
5161 created in the same directory as the output file.  If the
5162 @samp{-@var{options}} form is used, @var{options} is a list of
5163 @samp{-} separated options that control the details of the dump.  Not
5164 all options are applicable to all dumps, those which are not
5165 meaningful will be ignored.  The following options are available
5166
5167 @table @samp
5168 @item address
5169 Print the address of each node.  Usually this is not meaningful as it
5170 changes according to the environment and source file.  Its primary use
5171 is for tying up a dump file with a debug environment.
5172 @item asmname
5173 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5174 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5175 use working backward from mangled names in the assembly file.
5176 @item slim
5177 Inhibit dumping of members of a scope or body of a function merely
5178 because that scope has been reached.  Only dump such items when they
5179 are directly reachable by some other path.  When dumping pretty-printed
5180 trees, this option inhibits dumping the bodies of control structures.
5181 @item raw
5182 Print a raw representation of the tree.  By default, trees are
5183 pretty-printed into a C-like representation.
5184 @item details
5185 Enable more detailed dumps (not honored by every dump option).
5186 @item stats
5187 Enable dumping various statistics about the pass (not honored by every dump
5188 option).
5189 @item blocks
5190 Enable showing basic block boundaries (disabled in raw dumps).
5191 @item vops
5192 Enable showing virtual operands for every statement.
5193 @item lineno
5194 Enable showing line numbers for statements.
5195 @item uid
5196 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5197 @item verbose
5198 Enable showing the tree dump for each statement.
5199 @item eh
5200 Enable showing the EH region number holding each statement.
5201 @item all
5202 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5203 and @option{lineno}.
5204 @end table
5205
5206 The following tree dumps are possible:
5207 @table @samp
5208
5209 @item original
5210 @opindex fdump-tree-original
5211 Dump before any tree based optimization, to @file{@var{file}.original}.
5212
5213 @item optimized
5214 @opindex fdump-tree-optimized
5215 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5216
5217 @item gimple
5218 @opindex fdump-tree-gimple
5219 Dump each function before and after the gimplification pass to a file.  The
5220 file name is made by appending @file{.gimple} to the source file name.
5221
5222 @item cfg
5223 @opindex fdump-tree-cfg
5224 Dump the control flow graph of each function to a file.  The file name is
5225 made by appending @file{.cfg} to the source file name.
5226
5227 @item vcg
5228 @opindex fdump-tree-vcg
5229 Dump the control flow graph of each function to a file in VCG format.  The
5230 file name is made by appending @file{.vcg} to the source file name.  Note
5231 that if the file contains more than one function, the generated file cannot
5232 be used directly by VCG@.  You will need to cut and paste each function's
5233 graph into its own separate file first.
5234
5235 @item ch
5236 @opindex fdump-tree-ch
5237 Dump each function after copying loop headers.  The file name is made by
5238 appending @file{.ch} to the source file name.
5239
5240 @item ssa
5241 @opindex fdump-tree-ssa
5242 Dump SSA related information to a file.  The file name is made by appending
5243 @file{.ssa} to the source file name.
5244
5245 @item alias
5246 @opindex fdump-tree-alias
5247 Dump aliasing information for each function.  The file name is made by
5248 appending @file{.alias} to the source file name.
5249
5250 @item ccp
5251 @opindex fdump-tree-ccp
5252 Dump each function after CCP@.  The file name is made by appending
5253 @file{.ccp} to the source file name.
5254
5255 @item storeccp
5256 @opindex fdump-tree-storeccp
5257 Dump each function after STORE-CCP@.  The file name is made by appending
5258 @file{.storeccp} to the source file name.
5259
5260 @item pre
5261 @opindex fdump-tree-pre
5262 Dump trees after partial redundancy elimination.  The file name is made
5263 by appending @file{.pre} to the source file name.
5264
5265 @item fre
5266 @opindex fdump-tree-fre
5267 Dump trees after full redundancy elimination.  The file name is made
5268 by appending @file{.fre} to the source file name.
5269
5270 @item copyprop
5271 @opindex fdump-tree-copyprop
5272 Dump trees after copy propagation.  The file name is made
5273 by appending @file{.copyprop} to the source file name.
5274
5275 @item store_copyprop
5276 @opindex fdump-tree-store_copyprop
5277 Dump trees after store copy-propagation.  The file name is made
5278 by appending @file{.store_copyprop} to the source file name.
5279
5280 @item dce
5281 @opindex fdump-tree-dce
5282 Dump each function after dead code elimination.  The file name is made by
5283 appending @file{.dce} to the source file name.
5284
5285 @item mudflap
5286 @opindex fdump-tree-mudflap
5287 Dump each function after adding mudflap instrumentation.  The file name is
5288 made by appending @file{.mudflap} to the source file name.
5289
5290 @item sra
5291 @opindex fdump-tree-sra
5292 Dump each function after performing scalar replacement of aggregates.  The
5293 file name is made by appending @file{.sra} to the source file name.
5294
5295 @item sink
5296 @opindex fdump-tree-sink
5297 Dump each function after performing code sinking.  The file name is made
5298 by appending @file{.sink} to the source file name.
5299
5300 @item dom
5301 @opindex fdump-tree-dom
5302 Dump each function after applying dominator tree optimizations.  The file
5303 name is made by appending @file{.dom} to the source file name.
5304
5305 @item dse
5306 @opindex fdump-tree-dse
5307 Dump each function after applying dead store elimination.  The file
5308 name is made by appending @file{.dse} to the source file name.
5309
5310 @item phiopt
5311 @opindex fdump-tree-phiopt
5312 Dump each function after optimizing PHI nodes into straightline code.  The file
5313 name is made by appending @file{.phiopt} to the source file name.
5314
5315 @item forwprop
5316 @opindex fdump-tree-forwprop
5317 Dump each function after forward propagating single use variables.  The file
5318 name is made by appending @file{.forwprop} to the source file name.
5319
5320 @item copyrename
5321 @opindex fdump-tree-copyrename
5322 Dump each function after applying the copy rename optimization.  The file
5323 name is made by appending @file{.copyrename} to the source file name.
5324
5325 @item nrv
5326 @opindex fdump-tree-nrv
5327 Dump each function after applying the named return value optimization on
5328 generic trees.  The file name is made by appending @file{.nrv} to the source
5329 file name.
5330
5331 @item vect
5332 @opindex fdump-tree-vect
5333 Dump each function after applying vectorization of loops.  The file name is
5334 made by appending @file{.vect} to the source file name.
5335
5336 @item vrp
5337 @opindex fdump-tree-vrp
5338 Dump each function after Value Range Propagation (VRP).  The file name
5339 is made by appending @file{.vrp} to the source file name.
5340
5341 @item all
5342 @opindex fdump-tree-all
5343 Enable all the available tree dumps with the flags provided in this option.
5344 @end table
5345
5346 @item -ftree-vectorizer-verbose=@var{n}
5347 @opindex ftree-vectorizer-verbose
5348 This option controls the amount of debugging output the vectorizer prints.
5349 This information is written to standard error, unless
5350 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5351 in which case it is output to the usual dump listing file, @file{.vect}.
5352 For @var{n}=0 no diagnostic information is reported.
5353 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5354 and the total number of loops that got vectorized.
5355 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5356 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5357 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5358 level that @option{-fdump-tree-vect-stats} uses.
5359 Higher verbosity levels mean either more information dumped for each
5360 reported loop, or same amount of information reported for more loops:
5361 If @var{n}=3, alignment related information is added to the reports.
5362 If @var{n}=4, data-references related information (e.g.@: memory dependences,
5363 memory access-patterns) is added to the reports.
5364 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
5365 that did not pass the first analysis phase (i.e., may not be countable, or
5366 may have complicated control-flow).
5367 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
5368 For @var{n}=7, all the information the vectorizer generates during its
5369 analysis and transformation is reported.  This is the same verbosity level
5370 that @option{-fdump-tree-vect-details} uses.
5371
5372 @item -frandom-seed=@var{string}
5373 @opindex frandom-seed
5374 This option provides a seed that GCC uses when it would otherwise use
5375 random numbers.  It is used to generate certain symbol names
5376 that have to be different in every compiled file.  It is also used to
5377 place unique stamps in coverage data files and the object files that
5378 produce them.  You can use the @option{-frandom-seed} option to produce
5379 reproducibly identical object files.
5380
5381 The @var{string} should be different for every file you compile.
5382
5383 @item -fsched-verbose=@var{n}
5384 @opindex fsched-verbose
5385 On targets that use instruction scheduling, this option controls the
5386 amount of debugging output the scheduler prints.  This information is
5387 written to standard error, unless @option{-fdump-rtl-sched1} or
5388 @option{-fdump-rtl-sched2} is specified, in which case it is output
5389 to the usual dump listing file, @file{.sched} or @file{.sched2}
5390 respectively.  However for @var{n} greater than nine, the output is
5391 always printed to standard error.
5392
5393 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5394 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5395 For @var{n} greater than one, it also output basic block probabilities,
5396 detailed ready list information and unit/insn info.  For @var{n} greater
5397 than two, it includes RTL at abort point, control-flow and regions info.
5398 And for @var{n} over four, @option{-fsched-verbose} also includes
5399 dependence info.
5400
5401 @item -save-temps
5402 @itemx -save-temps=cwd
5403 @opindex save-temps
5404 Store the usual ``temporary'' intermediate files permanently; place them
5405 in the current directory and name them based on the source file.  Thus,
5406 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5407 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5408 preprocessed @file{foo.i} output file even though the compiler now
5409 normally uses an integrated preprocessor.
5410
5411 When used in combination with the @option{-x} command line option,
5412 @option{-save-temps} is sensible enough to avoid over writing an
5413 input source file with the same extension as an intermediate file.
5414 The corresponding intermediate file may be obtained by renaming the
5415 source file before using @option{-save-temps}.
5416
5417 If you invoke GCC in parallel, compiling several different source
5418 files that share a common base name in different subdirectories or the
5419 same source file compiled for multiple output destinations, it is
5420 likely that the different parallel compilers will interfere with each
5421 other, and overwrite the temporary files.  For instance:
5422
5423 @smallexample
5424 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5425 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5426 @end smallexample
5427
5428 may result in @file{foo.i} and @file{foo.o} being written to
5429 simultaneously by both compilers.
5430
5431 @item -save-temps=obj
5432 @opindex save-temps=obj
5433 Store the usual ``temporary'' intermediate files permanently.  If the
5434 @option{-o} option is used, the temporary files are based on the
5435 object file.  If the @option{-o} option is not used, the
5436 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5437
5438 For example:
5439
5440 @smallexample
5441 gcc -save-temps=obj -c foo.c
5442 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5443 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5444 @end smallexample
5445
5446 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5447 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5448 @file{dir2/yfoobar.o}.
5449
5450 @item -time@r{[}=@var{file}@r{]}
5451 @opindex time
5452 Report the CPU time taken by each subprocess in the compilation
5453 sequence.  For C source files, this is the compiler proper and assembler
5454 (plus the linker if linking is done).
5455
5456 Without the specification of an output file, the output looks like this:
5457
5458 @smallexample
5459 # cc1 0.12 0.01
5460 # as 0.00 0.01
5461 @end smallexample
5462
5463 The first number on each line is the ``user time'', that is time spent
5464 executing the program itself.  The second number is ``system time'',
5465 time spent executing operating system routines on behalf of the program.
5466 Both numbers are in seconds.
5467
5468 With the specification of an output file, the output is appended to the
5469 named file, and it looks like this:
5470
5471 @smallexample
5472 0.12 0.01 cc1 @var{options}
5473 0.00 0.01 as @var{options}
5474 @end smallexample
5475
5476 The ``user time'' and the ``system time'' are moved before the program
5477 name, and the options passed to the program are displayed, so that one
5478 can later tell what file was being compiled, and with which options.
5479
5480 @item -fvar-tracking
5481 @opindex fvar-tracking
5482 Run variable tracking pass.  It computes where variables are stored at each
5483 position in code.  Better debugging information is then generated
5484 (if the debugging information format supports this information).
5485
5486 It is enabled by default when compiling with optimization (@option{-Os},
5487 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5488 the debug info format supports it.
5489
5490 @item -fvar-tracking-assignments
5491 @opindex fvar-tracking-assignments
5492 @opindex fno-var-tracking-assignments
5493 Annotate assignments to user variables early in the compilation and
5494 attempt to carry the annotations over throughout the compilation all the
5495 way to the end, in an attempt to improve debug information while
5496 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5497
5498 It can be enabled even if var-tracking is disabled, in which case
5499 annotations will be created and maintained, but discarded at the end.
5500
5501 @item -fvar-tracking-assignments-toggle
5502 @opindex fvar-tracking-assignments-toggle
5503 @opindex fno-var-tracking-assignments-toggle
5504 Toggle @option{-fvar-tracking-assignments}, in the same way that
5505 @option{-gtoggle} toggles @option{-g}.
5506
5507 @item -print-file-name=@var{library}
5508 @opindex print-file-name
5509 Print the full absolute name of the library file @var{library} that
5510 would be used when linking---and don't do anything else.  With this
5511 option, GCC does not compile or link anything; it just prints the
5512 file name.
5513
5514 @item -print-multi-directory
5515 @opindex print-multi-directory
5516 Print the directory name corresponding to the multilib selected by any
5517 other switches present in the command line.  This directory is supposed
5518 to exist in @env{GCC_EXEC_PREFIX}.
5519
5520 @item -print-multi-lib
5521 @opindex print-multi-lib
5522 Print the mapping from multilib directory names to compiler switches
5523 that enable them.  The directory name is separated from the switches by
5524 @samp{;}, and each switch starts with an @samp{@@} instead of the
5525 @samp{-}, without spaces between multiple switches.  This is supposed to
5526 ease shell-processing.
5527
5528 @item -print-prog-name=@var{program}
5529 @opindex print-prog-name
5530 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5531
5532 @item -print-libgcc-file-name
5533 @opindex print-libgcc-file-name
5534 Same as @option{-print-file-name=libgcc.a}.
5535
5536 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5537 but you do want to link with @file{libgcc.a}.  You can do
5538
5539 @smallexample
5540 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5541 @end smallexample
5542
5543 @item -print-search-dirs
5544 @opindex print-search-dirs
5545 Print the name of the configured installation directory and a list of
5546 program and library directories @command{gcc} will search---and don't do anything else.
5547
5548 This is useful when @command{gcc} prints the error message
5549 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5550 To resolve this you either need to put @file{cpp0} and the other compiler
5551 components where @command{gcc} expects to find them, or you can set the environment
5552 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5553 Don't forget the trailing @samp{/}.
5554 @xref{Environment Variables}.
5555
5556 @item -print-sysroot
5557 @opindex print-sysroot
5558 Print the target sysroot directory that will be used during
5559 compilation.  This is the target sysroot specified either at configure
5560 time or using the @option{--sysroot} option, possibly with an extra
5561 suffix that depends on compilation options.  If no target sysroot is
5562 specified, the option prints nothing.
5563
5564 @item -print-sysroot-headers-suffix
5565 @opindex print-sysroot-headers-suffix
5566 Print the suffix added to the target sysroot when searching for
5567 headers, or give an error if the compiler is not configured with such
5568 a suffix---and don't do anything else.
5569
5570 @item -dumpmachine
5571 @opindex dumpmachine
5572 Print the compiler's target machine (for example,
5573 @samp{i686-pc-linux-gnu})---and don't do anything else.
5574
5575 @item -dumpversion
5576 @opindex dumpversion
5577 Print the compiler version (for example, @samp{3.0})---and don't do
5578 anything else.
5579
5580 @item -dumpspecs
5581 @opindex dumpspecs
5582 Print the compiler's built-in specs---and don't do anything else.  (This
5583 is used when GCC itself is being built.)  @xref{Spec Files}.
5584
5585 @item -feliminate-unused-debug-types
5586 @opindex feliminate-unused-debug-types
5587 Normally, when producing DWARF2 output, GCC will emit debugging
5588 information for all types declared in a compilation
5589 unit, regardless of whether or not they are actually used
5590 in that compilation unit.  Sometimes this is useful, such as
5591 if, in the debugger, you want to cast a value to a type that is
5592 not actually used in your program (but is declared).  More often,
5593 however, this results in a significant amount of wasted space.
5594 With this option, GCC will avoid producing debug symbol output
5595 for types that are nowhere used in the source file being compiled.
5596 @end table
5597
5598 @node Optimize Options
5599 @section Options That Control Optimization
5600 @cindex optimize options
5601 @cindex options, optimization
5602
5603 These options control various sorts of optimizations.
5604
5605 Without any optimization option, the compiler's goal is to reduce the
5606 cost of compilation and to make debugging produce the expected
5607 results.  Statements are independent: if you stop the program with a
5608 breakpoint between statements, you can then assign a new value to any
5609 variable or change the program counter to any other statement in the
5610 function and get exactly the results you would expect from the source
5611 code.
5612
5613 Turning on optimization flags makes the compiler attempt to improve
5614 the performance and/or code size at the expense of compilation time
5615 and possibly the ability to debug the program.
5616
5617 The compiler performs optimization based on the knowledge it has of the
5618 program.  Compiling multiple files at once to a single output file mode allows
5619 the compiler to use information gained from all of the files when compiling
5620 each of them.
5621
5622 Not all optimizations are controlled directly by a flag.  Only
5623 optimizations that have a flag are listed in this section.
5624
5625 Depending on the target and how GCC was configured, a slightly different
5626 set of optimizations may be enabled at each @option{-O} level than
5627 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5628 to find out the exact set of optimizations that are enabled at each level.
5629 @xref{Overall Options}, for examples.
5630
5631 @table @gcctabopt
5632 @item -O
5633 @itemx -O1
5634 @opindex O
5635 @opindex O1
5636 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5637 more memory for a large function.
5638
5639 With @option{-O}, the compiler tries to reduce code size and execution
5640 time, without performing any optimizations that take a great deal of
5641 compilation time.
5642
5643 @option{-O} turns on the following optimization flags:
5644 @gccoptlist{
5645 -fauto-inc-dec @gol
5646 -fcprop-registers @gol
5647 -fdce @gol
5648 -fdefer-pop @gol
5649 -fdelayed-branch @gol
5650 -fdse @gol
5651 -fguess-branch-probability @gol
5652 -fif-conversion2 @gol
5653 -fif-conversion @gol
5654 -fipa-pure-const @gol
5655 -fipa-reference @gol
5656 -fmerge-constants
5657 -fsplit-wide-types @gol
5658 -ftree-builtin-call-dce @gol
5659 -ftree-ccp @gol
5660 -ftree-ch @gol
5661 -ftree-copyrename @gol
5662 -ftree-dce @gol
5663 -ftree-dominator-opts @gol
5664 -ftree-dse @gol
5665 -ftree-forwprop @gol
5666 -ftree-fre @gol
5667 -ftree-phiprop @gol
5668 -ftree-sra @gol
5669 -ftree-pta @gol
5670 -ftree-ter @gol
5671 -funit-at-a-time}
5672
5673 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5674 where doing so does not interfere with debugging.
5675
5676 @item -O2
5677 @opindex O2
5678 Optimize even more.  GCC performs nearly all supported optimizations
5679 that do not involve a space-speed tradeoff.
5680 As compared to @option{-O}, this option increases both compilation time
5681 and the performance of the generated code.
5682
5683 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5684 also turns on the following optimization flags:
5685 @gccoptlist{-fthread-jumps @gol
5686 -falign-functions  -falign-jumps @gol
5687 -falign-loops  -falign-labels @gol
5688 -fcaller-saves @gol
5689 -fcrossjumping @gol
5690 -fcse-follow-jumps  -fcse-skip-blocks @gol
5691 -fdelete-null-pointer-checks @gol
5692 -fexpensive-optimizations @gol
5693 -fgcse  -fgcse-lm  @gol
5694 -finline-small-functions @gol
5695 -findirect-inlining @gol
5696 -fipa-sra @gol
5697 -foptimize-sibling-calls @gol
5698 -fpeephole2 @gol
5699 -fregmove @gol
5700 -freorder-blocks  -freorder-functions @gol
5701 -frerun-cse-after-loop  @gol
5702 -fsched-interblock  -fsched-spec @gol
5703 -fschedule-insns  -fschedule-insns2 @gol
5704 -fstrict-aliasing -fstrict-overflow @gol
5705 -ftree-switch-conversion @gol
5706 -ftree-pre @gol
5707 -ftree-vrp}
5708
5709 Please note the warning under @option{-fgcse} about
5710 invoking @option{-O2} on programs that use computed gotos.
5711
5712 @item -O3
5713 @opindex O3
5714 Optimize yet more.  @option{-O3} turns on all optimizations specified
5715 by @option{-O2} and also turns on the @option{-finline-functions},
5716 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5717 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5718
5719 @item -O0
5720 @opindex O0
5721 Reduce compilation time and make debugging produce the expected
5722 results.  This is the default.
5723
5724 @item -Os
5725 @opindex Os
5726 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5727 do not typically increase code size.  It also performs further
5728 optimizations designed to reduce code size.
5729
5730 @option{-Os} disables the following optimization flags:
5731 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5732 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5733 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5734
5735 If you use multiple @option{-O} options, with or without level numbers,
5736 the last such option is the one that is effective.
5737 @end table
5738
5739 Options of the form @option{-f@var{flag}} specify machine-independent
5740 flags.  Most flags have both positive and negative forms; the negative
5741 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5742 below, only one of the forms is listed---the one you typically will
5743 use.  You can figure out the other form by either removing @samp{no-}
5744 or adding it.
5745
5746 The following options control specific optimizations.  They are either
5747 activated by @option{-O} options or are related to ones that are.  You
5748 can use the following flags in the rare cases when ``fine-tuning'' of
5749 optimizations to be performed is desired.
5750
5751 @table @gcctabopt
5752 @item -fno-default-inline
5753 @opindex fno-default-inline
5754 Do not make member functions inline by default merely because they are
5755 defined inside the class scope (C++ only).  Otherwise, when you specify
5756 @w{@option{-O}}, member functions defined inside class scope are compiled
5757 inline by default; i.e., you don't need to add @samp{inline} in front of
5758 the member function name.
5759
5760 @item -fno-defer-pop
5761 @opindex fno-defer-pop
5762 Always pop the arguments to each function call as soon as that function
5763 returns.  For machines which must pop arguments after a function call,
5764 the compiler normally lets arguments accumulate on the stack for several
5765 function calls and pops them all at once.
5766
5767 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5768
5769 @item -fforward-propagate
5770 @opindex fforward-propagate
5771 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5772 instructions and checks if the result can be simplified.  If loop unrolling
5773 is active, two passes are performed and the second is scheduled after
5774 loop unrolling.
5775
5776 This option is enabled by default at optimization levels @option{-O},
5777 @option{-O2}, @option{-O3}, @option{-Os}.
5778
5779 @item -fomit-frame-pointer
5780 @opindex fomit-frame-pointer
5781 Don't keep the frame pointer in a register for functions that
5782 don't need one.  This avoids the instructions to save, set up and
5783 restore frame pointers; it also makes an extra register available
5784 in many functions.  @strong{It also makes debugging impossible on
5785 some machines.}
5786
5787 On some machines, such as the VAX, this flag has no effect, because
5788 the standard calling sequence automatically handles the frame pointer
5789 and nothing is saved by pretending it doesn't exist.  The
5790 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5791 whether a target machine supports this flag.  @xref{Registers,,Register
5792 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5793
5794 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5795
5796 @item -foptimize-sibling-calls
5797 @opindex foptimize-sibling-calls
5798 Optimize sibling and tail recursive calls.
5799
5800 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5801
5802 @item -fno-inline
5803 @opindex fno-inline
5804 Don't pay attention to the @code{inline} keyword.  Normally this option
5805 is used to keep the compiler from expanding any functions inline.
5806 Note that if you are not optimizing, no functions can be expanded inline.
5807
5808 @item -finline-small-functions
5809 @opindex finline-small-functions
5810 Integrate functions into their callers when their body is smaller than expected
5811 function call code (so overall size of program gets smaller).  The compiler
5812 heuristically decides which functions are simple enough to be worth integrating
5813 in this way.
5814
5815 Enabled at level @option{-O2}.
5816
5817 @item -findirect-inlining
5818 @opindex findirect-inlining
5819 Inline also indirect calls that are discovered to be known at compile
5820 time thanks to previous inlining.  This option has any effect only
5821 when inlining itself is turned on by the @option{-finline-functions}
5822 or @option{-finline-small-functions} options.
5823
5824 Enabled at level @option{-O2}.
5825
5826 @item -finline-functions
5827 @opindex finline-functions
5828 Integrate all simple functions into their callers.  The compiler
5829 heuristically decides which functions are simple enough to be worth
5830 integrating in this way.
5831
5832 If all calls to a given function are integrated, and the function is
5833 declared @code{static}, then the function is normally not output as
5834 assembler code in its own right.
5835
5836 Enabled at level @option{-O3}.
5837
5838 @item -finline-functions-called-once
5839 @opindex finline-functions-called-once
5840 Consider all @code{static} functions called once for inlining into their
5841 caller even if they are not marked @code{inline}.  If a call to a given
5842 function is integrated, then the function is not output as assembler code
5843 in its own right.
5844
5845 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5846
5847 @item -fearly-inlining
5848 @opindex fearly-inlining
5849 Inline functions marked by @code{always_inline} and functions whose body seems
5850 smaller than the function call overhead early before doing
5851 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5852 makes profiling significantly cheaper and usually inlining faster on programs
5853 having large chains of nested wrapper functions.
5854
5855 Enabled by default.
5856
5857 @item -fipa-sra
5858 @opindex fipa-sra
5859 Perform interprocedural scalar replacement of aggregates, removal of
5860 unused parameters and replacement of parameters passed by reference
5861 by parameters passed by value.
5862
5863 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
5864
5865 @item -finline-limit=@var{n}
5866 @opindex finline-limit
5867 By default, GCC limits the size of functions that can be inlined.  This flag
5868 allows coarse control of this limit.  @var{n} is the size of functions that
5869 can be inlined in number of pseudo instructions.
5870
5871 Inlining is actually controlled by a number of parameters, which may be
5872 specified individually by using @option{--param @var{name}=@var{value}}.
5873 The @option{-finline-limit=@var{n}} option sets some of these parameters
5874 as follows:
5875
5876 @table @gcctabopt
5877 @item max-inline-insns-single
5878 is set to @var{n}/2.
5879 @item max-inline-insns-auto
5880 is set to @var{n}/2.
5881 @end table
5882
5883 See below for a documentation of the individual
5884 parameters controlling inlining and for the defaults of these parameters.
5885
5886 @emph{Note:} there may be no value to @option{-finline-limit} that results
5887 in default behavior.
5888
5889 @emph{Note:} pseudo instruction represents, in this particular context, an
5890 abstract measurement of function's size.  In no way does it represent a count
5891 of assembly instructions and as such its exact meaning might change from one
5892 release to an another.
5893
5894 @item -fkeep-inline-functions
5895 @opindex fkeep-inline-functions
5896 In C, emit @code{static} functions that are declared @code{inline}
5897 into the object file, even if the function has been inlined into all
5898 of its callers.  This switch does not affect functions using the
5899 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5900 inline functions into the object file.
5901
5902 @item -fkeep-static-consts
5903 @opindex fkeep-static-consts
5904 Emit variables declared @code{static const} when optimization isn't turned
5905 on, even if the variables aren't referenced.
5906
5907 GCC enables this option by default.  If you want to force the compiler to
5908 check if the variable was referenced, regardless of whether or not
5909 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5910
5911 @item -fmerge-constants
5912 @opindex fmerge-constants
5913 Attempt to merge identical constants (string constants and floating point
5914 constants) across compilation units.
5915
5916 This option is the default for optimized compilation if the assembler and
5917 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5918 behavior.
5919
5920 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5921
5922 @item -fmerge-all-constants
5923 @opindex fmerge-all-constants
5924 Attempt to merge identical constants and identical variables.
5925
5926 This option implies @option{-fmerge-constants}.  In addition to
5927 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5928 arrays or initialized constant variables with integral or floating point
5929 types.  Languages like C or C++ require each variable, including multiple
5930 instances of the same variable in recursive calls, to have distinct locations,
5931 so using this option will result in non-conforming
5932 behavior.
5933
5934 @item -fmodulo-sched
5935 @opindex fmodulo-sched
5936 Perform swing modulo scheduling immediately before the first scheduling
5937 pass.  This pass looks at innermost loops and reorders their
5938 instructions by overlapping different iterations.
5939
5940 @item -fmodulo-sched-allow-regmoves
5941 @opindex fmodulo-sched-allow-regmoves
5942 Perform more aggressive SMS based modulo scheduling with register moves
5943 allowed.  By setting this flag certain anti-dependences edges will be
5944 deleted which will trigger the generation of reg-moves based on the
5945 life-range analysis.  This option is effective only with
5946 @option{-fmodulo-sched} enabled.
5947
5948 @item -fno-branch-count-reg
5949 @opindex fno-branch-count-reg
5950 Do not use ``decrement and branch'' instructions on a count register,
5951 but instead generate a sequence of instructions that decrement a
5952 register, compare it against zero, then branch based upon the result.
5953 This option is only meaningful on architectures that support such
5954 instructions, which include x86, PowerPC, IA-64 and S/390.
5955
5956 The default is @option{-fbranch-count-reg}.
5957
5958 @item -fno-function-cse
5959 @opindex fno-function-cse
5960 Do not put function addresses in registers; make each instruction that
5961 calls a constant function contain the function's address explicitly.
5962
5963 This option results in less efficient code, but some strange hacks
5964 that alter the assembler output may be confused by the optimizations
5965 performed when this option is not used.
5966
5967 The default is @option{-ffunction-cse}
5968
5969 @item -fno-zero-initialized-in-bss
5970 @opindex fno-zero-initialized-in-bss
5971 If the target supports a BSS section, GCC by default puts variables that
5972 are initialized to zero into BSS@.  This can save space in the resulting
5973 code.
5974
5975 This option turns off this behavior because some programs explicitly
5976 rely on variables going to the data section.  E.g., so that the
5977 resulting executable can find the beginning of that section and/or make
5978 assumptions based on that.
5979
5980 The default is @option{-fzero-initialized-in-bss}.
5981
5982 @item -fmudflap -fmudflapth -fmudflapir
5983 @opindex fmudflap
5984 @opindex fmudflapth
5985 @opindex fmudflapir
5986 @cindex bounds checking
5987 @cindex mudflap
5988 For front-ends that support it (C and C++), instrument all risky
5989 pointer/array dereferencing operations, some standard library
5990 string/heap functions, and some other associated constructs with
5991 range/validity tests.  Modules so instrumented should be immune to
5992 buffer overflows, invalid heap use, and some other classes of C/C++
5993 programming errors.  The instrumentation relies on a separate runtime
5994 library (@file{libmudflap}), which will be linked into a program if
5995 @option{-fmudflap} is given at link time.  Run-time behavior of the
5996 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5997 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5998 for its options.
5999
6000 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6001 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6002 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6003 instrumentation should ignore pointer reads.  This produces less
6004 instrumentation (and therefore faster execution) and still provides
6005 some protection against outright memory corrupting writes, but allows
6006 erroneously read data to propagate within a program.
6007
6008 @item -fthread-jumps
6009 @opindex fthread-jumps
6010 Perform optimizations where we check to see if a jump branches to a
6011 location where another comparison subsumed by the first is found.  If
6012 so, the first branch is redirected to either the destination of the
6013 second branch or a point immediately following it, depending on whether
6014 the condition is known to be true or false.
6015
6016 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6017
6018 @item -fsplit-wide-types
6019 @opindex fsplit-wide-types
6020 When using a type that occupies multiple registers, such as @code{long
6021 long} on a 32-bit system, split the registers apart and allocate them
6022 independently.  This normally generates better code for those types,
6023 but may make debugging more difficult.
6024
6025 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6026 @option{-Os}.
6027
6028 @item -fcse-follow-jumps
6029 @opindex fcse-follow-jumps
6030 In common subexpression elimination (CSE), scan through jump instructions
6031 when the target of the jump is not reached by any other path.  For
6032 example, when CSE encounters an @code{if} statement with an
6033 @code{else} clause, CSE will follow the jump when the condition
6034 tested is false.
6035
6036 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6037
6038 @item -fcse-skip-blocks
6039 @opindex fcse-skip-blocks
6040 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6041 follow jumps which conditionally skip over blocks.  When CSE
6042 encounters a simple @code{if} statement with no else clause,
6043 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6044 body of the @code{if}.
6045
6046 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6047
6048 @item -frerun-cse-after-loop
6049 @opindex frerun-cse-after-loop
6050 Re-run common subexpression elimination after loop optimizations has been
6051 performed.
6052
6053 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6054
6055 @item -fgcse
6056 @opindex fgcse
6057 Perform a global common subexpression elimination pass.
6058 This pass also performs global constant and copy propagation.
6059
6060 @emph{Note:} When compiling a program using computed gotos, a GCC
6061 extension, you may get better runtime performance if you disable
6062 the global common subexpression elimination pass by adding
6063 @option{-fno-gcse} to the command line.
6064
6065 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6066
6067 @item -fgcse-lm
6068 @opindex fgcse-lm
6069 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6070 attempt to move loads which are only killed by stores into themselves.  This
6071 allows a loop containing a load/store sequence to be changed to a load outside
6072 the loop, and a copy/store within the loop.
6073
6074 Enabled by default when gcse is enabled.
6075
6076 @item -fgcse-sm
6077 @opindex fgcse-sm
6078 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6079 global common subexpression elimination.  This pass will attempt to move
6080 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6081 loops containing a load/store sequence can be changed to a load before
6082 the loop and a store after the loop.
6083
6084 Not enabled at any optimization level.
6085
6086 @item -fgcse-las
6087 @opindex fgcse-las
6088 When @option{-fgcse-las} is enabled, the global common subexpression
6089 elimination pass eliminates redundant loads that come after stores to the
6090 same memory location (both partial and full redundancies).
6091
6092 Not enabled at any optimization level.
6093
6094 @item -fgcse-after-reload
6095 @opindex fgcse-after-reload
6096 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6097 pass is performed after reload.  The purpose of this pass is to cleanup
6098 redundant spilling.
6099
6100 @item -funsafe-loop-optimizations
6101 @opindex funsafe-loop-optimizations
6102 If given, the loop optimizer will assume that loop indices do not
6103 overflow, and that the loops with nontrivial exit condition are not
6104 infinite.  This enables a wider range of loop optimizations even if
6105 the loop optimizer itself cannot prove that these assumptions are valid.
6106 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6107 if it finds this kind of loop.
6108
6109 @item -fcrossjumping
6110 @opindex fcrossjumping
6111 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6112 resulting code may or may not perform better than without cross-jumping.
6113
6114 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6115
6116 @item -fauto-inc-dec
6117 @opindex fauto-inc-dec
6118 Combine increments or decrements of addresses with memory accesses.
6119 This pass is always skipped on architectures that do not have
6120 instructions to support this.  Enabled by default at @option{-O} and
6121 higher on architectures that support this.
6122
6123 @item -fdce
6124 @opindex fdce
6125 Perform dead code elimination (DCE) on RTL@.
6126 Enabled by default at @option{-O} and higher.
6127
6128 @item -fdse
6129 @opindex fdse
6130 Perform dead store elimination (DSE) on RTL@.
6131 Enabled by default at @option{-O} and higher.
6132
6133 @item -fif-conversion
6134 @opindex fif-conversion
6135 Attempt to transform conditional jumps into branch-less equivalents.  This
6136 include use of conditional moves, min, max, set flags and abs instructions, and
6137 some tricks doable by standard arithmetics.  The use of conditional execution
6138 on chips where it is available is controlled by @code{if-conversion2}.
6139
6140 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6141
6142 @item -fif-conversion2
6143 @opindex fif-conversion2
6144 Use conditional execution (where available) to transform conditional jumps into
6145 branch-less equivalents.
6146
6147 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6148
6149 @item -fdelete-null-pointer-checks
6150 @opindex fdelete-null-pointer-checks
6151 Assume that programs cannot safely dereference null pointers, and that
6152 no code or data element resides there.  This enables simple constant
6153 folding optimizations at all optimization levels.  In addition, other
6154 optimization passes in GCC use this flag to control global dataflow
6155 analyses that eliminate useless checks for null pointers; these assume
6156 that if a pointer is checked after it has already been dereferenced,
6157 it cannot be null.
6158
6159 Note however that in some environments this assumption is not true.
6160 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6161 for programs which depend on that behavior.
6162
6163 Some targets, especially embedded ones, disable this option at all levels.
6164 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6165 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6166 are enabled independently at different optimization levels.
6167
6168 @item -fexpensive-optimizations
6169 @opindex fexpensive-optimizations
6170 Perform a number of minor optimizations that are relatively expensive.
6171
6172 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6173
6174 @item -foptimize-register-move
6175 @itemx -fregmove
6176 @opindex foptimize-register-move
6177 @opindex fregmove
6178 Attempt to reassign register numbers in move instructions and as
6179 operands of other simple instructions in order to maximize the amount of
6180 register tying.  This is especially helpful on machines with two-operand
6181 instructions.
6182
6183 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6184 optimization.
6185
6186 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6187
6188 @item -fira-algorithm=@var{algorithm}
6189 Use specified coloring algorithm for the integrated register
6190 allocator.  The @var{algorithm} argument should be @code{priority} or
6191 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6192 the second one specifies Chaitin-Briggs coloring.  The second
6193 algorithm can be unimplemented for some architectures.  If it is
6194 implemented, it is the default because Chaitin-Briggs coloring as a
6195 rule generates a better code.
6196
6197 @item -fira-region=@var{region}
6198 Use specified regions for the integrated register allocator.  The
6199 @var{region} argument should be one of @code{all}, @code{mixed}, or
6200 @code{one}.  The first value means using all loops as register
6201 allocation regions, the second value which is the default means using
6202 all loops except for loops with small register pressure as the
6203 regions, and third one means using all function as a single region.
6204 The first value can give best result for machines with small size and
6205 irregular register set, the third one results in faster and generates
6206 decent code and the smallest size code, and the default value usually
6207 give the best results in most cases and for most architectures.
6208
6209 @item -fira-coalesce
6210 @opindex fira-coalesce
6211 Do optimistic register coalescing.  This option might be profitable for
6212 architectures with big regular register files.
6213
6214 @item -fno-ira-share-save-slots
6215 @opindex fno-ira-share-save-slots
6216 Switch off sharing stack slots used for saving call used hard
6217 registers living through a call.  Each hard register will get a
6218 separate stack slot and as a result function stack frame will be
6219 bigger.
6220
6221 @item -fno-ira-share-spill-slots
6222 @opindex fno-ira-share-spill-slots
6223 Switch off sharing stack slots allocated for pseudo-registers.  Each
6224 pseudo-register which did not get a hard register will get a separate
6225 stack slot and as a result function stack frame will be bigger.
6226
6227 @item -fira-verbose=@var{n}
6228 @opindex fira-verbose
6229 Set up how verbose dump file for the integrated register allocator
6230 will be.  Default value is 5.  If the value is greater or equal to 10,
6231 the dump file will be stderr as if the value were @var{n} minus 10.
6232
6233 @item -fdelayed-branch
6234 @opindex fdelayed-branch
6235 If supported for the target machine, attempt to reorder instructions
6236 to exploit instruction slots available after delayed branch
6237 instructions.
6238
6239 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6240
6241 @item -fschedule-insns
6242 @opindex fschedule-insns
6243 If supported for the target machine, attempt to reorder instructions to
6244 eliminate execution stalls due to required data being unavailable.  This
6245 helps machines that have slow floating point or memory load instructions
6246 by allowing other instructions to be issued until the result of the load
6247 or floating point instruction is required.
6248
6249 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6250
6251 @item -fschedule-insns2
6252 @opindex fschedule-insns2
6253 Similar to @option{-fschedule-insns}, but requests an additional pass of
6254 instruction scheduling after register allocation has been done.  This is
6255 especially useful on machines with a relatively small number of
6256 registers and where memory load instructions take more than one cycle.
6257
6258 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6259
6260 @item -fno-sched-interblock
6261 @opindex fno-sched-interblock
6262 Don't schedule instructions across basic blocks.  This is normally
6263 enabled by default when scheduling before register allocation, i.e.@:
6264 with @option{-fschedule-insns} or at @option{-O2} or higher.
6265
6266 @item -fno-sched-spec
6267 @opindex fno-sched-spec
6268 Don't allow speculative motion of non-load instructions.  This is normally
6269 enabled by default when scheduling before register allocation, i.e.@:
6270 with @option{-fschedule-insns} or at @option{-O2} or higher.
6271
6272 @item -fsched-pressure
6273 @opindex fsched-pressure
6274 Enable register pressure sensitive insn scheduling before the register
6275 allocation.  This only makes sense when scheduling before register
6276 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6277 @option{-O2} or higher.  Usage of this option can improve the
6278 generated code and decrease its size by preventing register pressure
6279 increase above the number of available hard registers and as a
6280 consequence register spills in the register allocation.
6281
6282 @item -fsched-spec-load
6283 @opindex fsched-spec-load
6284 Allow speculative motion of some load instructions.  This only makes
6285 sense when scheduling before register allocation, i.e.@: with
6286 @option{-fschedule-insns} or at @option{-O2} or higher.
6287
6288 @item -fsched-spec-load-dangerous
6289 @opindex fsched-spec-load-dangerous
6290 Allow speculative motion of more load instructions.  This only makes
6291 sense when scheduling before register allocation, i.e.@: with
6292 @option{-fschedule-insns} or at @option{-O2} or higher.
6293
6294 @item -fsched-stalled-insns
6295 @itemx -fsched-stalled-insns=@var{n}
6296 @opindex fsched-stalled-insns
6297 Define how many insns (if any) can be moved prematurely from the queue
6298 of stalled insns into the ready list, during the second scheduling pass.
6299 @option{-fno-sched-stalled-insns} means that no insns will be moved
6300 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6301 on how many queued insns can be moved prematurely.
6302 @option{-fsched-stalled-insns} without a value is equivalent to
6303 @option{-fsched-stalled-insns=1}.
6304
6305 @item -fsched-stalled-insns-dep
6306 @itemx -fsched-stalled-insns-dep=@var{n}
6307 @opindex fsched-stalled-insns-dep
6308 Define how many insn groups (cycles) will be examined for a dependency
6309 on a stalled insn that is candidate for premature removal from the queue
6310 of stalled insns.  This has an effect only during the second scheduling pass,
6311 and only if @option{-fsched-stalled-insns} is used.
6312 @option{-fno-sched-stalled-insns-dep} is equivalent to
6313 @option{-fsched-stalled-insns-dep=0}.
6314 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6315 @option{-fsched-stalled-insns-dep=1}.
6316
6317 @item -fsched2-use-superblocks
6318 @opindex fsched2-use-superblocks
6319 When scheduling after register allocation, do use superblock scheduling
6320 algorithm.  Superblock scheduling allows motion across basic block boundaries
6321 resulting on faster schedules.  This option is experimental, as not all machine
6322 descriptions used by GCC model the CPU closely enough to avoid unreliable
6323 results from the algorithm.
6324
6325 This only makes sense when scheduling after register allocation, i.e.@: with
6326 @option{-fschedule-insns2} or at @option{-O2} or higher.
6327
6328 @item -fsched-group-heuristic
6329 @opindex fsched-group-heuristic
6330 Enable the group heuristic in the scheduler.  This heuristic favors 
6331 the instruction that belongs to a schedule group.  This is enabled 
6332 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6333 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6334
6335 @item -fsched-critical-path-heuristic
6336 @opindex fsched-critical-path-heuristic
6337 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6338 instructions on the critical path.  This is enabled by default when 
6339 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6340 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6341
6342 @item -fsched-spec-insn-heuristic
6343 @opindex fsched-spec-insn-heuristic
6344 Enable the speculative instruction heuristic in the scheduler.  This 
6345 heuristic favors speculative instructions with greater dependency weakness.  
6346 This is enabled by default when scheduling is enabled, i.e.@: 
6347 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6348 or at @option{-O2} or higher.
6349
6350 @item -fsched-rank-heuristic
6351 @opindex fsched-rank-heuristic
6352 Enable the rank heuristic in the scheduler.  This heuristic favors 
6353 the instruction belonging to a basic block with greater size or frequency.  
6354 This is enabled by default when scheduling is enabled, i.e.@: 
6355 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6356 at @option{-O2} or higher.
6357
6358 @item -fsched-last-insn-heuristic
6359 @opindex fsched-last-insn-heuristic
6360 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6361 favors the instruction that is less dependent on the last instruction
6362 scheduled.  This is enabled by default when scheduling is enabled, 
6363 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6364 at @option{-O2} or higher.
6365
6366 @item -fsched-dep-count-heuristic
6367 @opindex fsched-dep-count-heuristic
6368 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6369 favors the instruction that has more instructions depending on it.  
6370 This is enabled by default when scheduling is enabled, i.e.@: 
6371 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6372 at @option{-O2} or higher.
6373
6374 @item -fsched2-use-traces
6375 @opindex fsched2-use-traces
6376 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
6377 allocation and additionally perform code duplication in order to increase the
6378 size of superblocks using tracer pass.  See @option{-ftracer} for details on
6379 trace formation.
6380
6381 This mode should produce faster but significantly longer programs.  Also
6382 without @option{-fbranch-probabilities} the traces constructed may not
6383 match the reality and hurt the performance.  This only makes
6384 sense when scheduling after register allocation, i.e.@: with
6385 @option{-fschedule-insns2} or at @option{-O2} or higher.
6386
6387 @item -freschedule-modulo-scheduled-loops
6388 @opindex freschedule-modulo-scheduled-loops
6389 The modulo scheduling comes before the traditional scheduling, if a loop
6390 was modulo scheduled we may want to prevent the later scheduling passes
6391 from changing its schedule, we use this option to control that.
6392
6393 @item -fselective-scheduling
6394 @opindex fselective-scheduling
6395 Schedule instructions using selective scheduling algorithm.  Selective
6396 scheduling runs instead of the first scheduler pass.
6397
6398 @item -fselective-scheduling2
6399 @opindex fselective-scheduling2
6400 Schedule instructions using selective scheduling algorithm.  Selective
6401 scheduling runs instead of the second scheduler pass.
6402
6403 @item -fsel-sched-pipelining
6404 @opindex fsel-sched-pipelining
6405 Enable software pipelining of innermost loops during selective scheduling.
6406 This option has no effect until one of @option{-fselective-scheduling} or
6407 @option{-fselective-scheduling2} is turned on.
6408
6409 @item -fsel-sched-pipelining-outer-loops
6410 @opindex fsel-sched-pipelining-outer-loops
6411 When pipelining loops during selective scheduling, also pipeline outer loops.
6412 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6413
6414 @item -fcaller-saves
6415 @opindex fcaller-saves
6416 Enable values to be allocated in registers that will be clobbered by
6417 function calls, by emitting extra instructions to save and restore the
6418 registers around such calls.  Such allocation is done only when it
6419 seems to result in better code than would otherwise be produced.
6420
6421 This option is always enabled by default on certain machines, usually
6422 those which have no call-preserved registers to use instead.
6423
6424 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6425
6426 @item -fconserve-stack
6427 @opindex fconserve-stack
6428 Attempt to minimize stack usage.  The compiler will attempt to use less
6429 stack space, even if that makes the program slower.  This option
6430 implies setting the @option{large-stack-frame} parameter to 100
6431 and the @option{large-stack-frame-growth} parameter to 400.
6432
6433 @item -ftree-reassoc
6434 @opindex ftree-reassoc
6435 Perform reassociation on trees.  This flag is enabled by default
6436 at @option{-O} and higher.
6437
6438 @item -ftree-pre
6439 @opindex ftree-pre
6440 Perform partial redundancy elimination (PRE) on trees.  This flag is
6441 enabled by default at @option{-O2} and @option{-O3}.
6442
6443 @item -ftree-forwprop
6444 @opindex ftree-forwprop
6445 Perform forward propagation on trees.  This flag is enabled by default
6446 at @option{-O} and higher.
6447
6448 @item -ftree-fre
6449 @opindex ftree-fre
6450 Perform full redundancy elimination (FRE) on trees.  The difference
6451 between FRE and PRE is that FRE only considers expressions
6452 that are computed on all paths leading to the redundant computation.
6453 This analysis is faster than PRE, though it exposes fewer redundancies.
6454 This flag is enabled by default at @option{-O} and higher.
6455
6456 @item -ftree-phiprop
6457 @opindex ftree-phiprop
6458 Perform hoisting of loads from conditional pointers on trees.  This
6459 pass is enabled by default at @option{-O} and higher.
6460
6461 @item -ftree-copy-prop
6462 @opindex ftree-copy-prop
6463 Perform copy propagation on trees.  This pass eliminates unnecessary
6464 copy operations.  This flag is enabled by default at @option{-O} and
6465 higher.
6466
6467 @item -fipa-pure-const
6468 @opindex fipa-pure-const
6469 Discover which functions are pure or constant.
6470 Enabled by default at @option{-O} and higher.
6471
6472 @item -fipa-reference
6473 @opindex fipa-reference
6474 Discover which static variables do not escape cannot escape the
6475 compilation unit.
6476 Enabled by default at @option{-O} and higher.
6477
6478 @item -fipa-struct-reorg
6479 @opindex fipa-struct-reorg
6480 Perform structure reorganization optimization, that change C-like structures
6481 layout in order to better utilize spatial locality.  This transformation is
6482 affective for programs containing arrays of structures.  Available in two
6483 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6484 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
6485 to provide the safety of this transformation.  It works only in whole program
6486 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6487 enabled.  Structures considered @samp{cold} by this transformation are not
6488 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6489
6490 With this flag, the program debug info reflects a new structure layout.
6491
6492 @item -fipa-pta
6493 @opindex fipa-pta
6494 Perform interprocedural pointer analysis.  This option is experimental
6495 and does not affect generated code.
6496
6497 @item -fipa-cp
6498 @opindex fipa-cp
6499 Perform interprocedural constant propagation.
6500 This optimization analyzes the program to determine when values passed
6501 to functions are constants and then optimizes accordingly.
6502 This optimization can substantially increase performance
6503 if the application has constants passed to functions.
6504 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6505
6506 @item -fipa-cp-clone
6507 @opindex fipa-cp-clone
6508 Perform function cloning to make interprocedural constant propagation stronger.
6509 When enabled, interprocedural constant propagation will perform function cloning
6510 when externally visible function can be called with constant arguments.
6511 Because this optimization can create multiple copies of functions,
6512 it may significantly increase code size
6513 (see @option{--param ipcp-unit-growth=@var{value}}).
6514 This flag is enabled by default at @option{-O3}.
6515
6516 @item -fipa-matrix-reorg
6517 @opindex fipa-matrix-reorg
6518 Perform matrix flattening and transposing.
6519 Matrix flattening tries to replace an @math{m}-dimensional matrix
6520 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6521 This reduces the level of indirection needed for accessing the elements
6522 of the matrix. The second optimization is matrix transposing that
6523 attempts to change the order of the matrix's dimensions in order to
6524 improve cache locality.
6525 Both optimizations need the @option{-fwhole-program} flag.
6526 Transposing is enabled only if profiling information is available.
6527
6528 @item -ftree-sink
6529 @opindex ftree-sink
6530 Perform forward store motion  on trees.  This flag is
6531 enabled by default at @option{-O} and higher.
6532
6533 @item -ftree-ccp
6534 @opindex ftree-ccp
6535 Perform sparse conditional constant propagation (CCP) on trees.  This
6536 pass only operates on local scalar variables and is enabled by default
6537 at @option{-O} and higher.
6538
6539 @item -ftree-switch-conversion
6540 Perform conversion of simple initializations in a switch to
6541 initializations from a scalar array.  This flag is enabled by default
6542 at @option{-O2} and higher.
6543
6544 @item -ftree-dce
6545 @opindex ftree-dce
6546 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6547 default at @option{-O} and higher.
6548
6549 @item -ftree-builtin-call-dce
6550 @opindex ftree-builtin-call-dce
6551 Perform conditional dead code elimination (DCE) for calls to builtin functions
6552 that may set @code{errno} but are otherwise side-effect free.  This flag is
6553 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6554 specified.
6555
6556 @item -ftree-dominator-opts
6557 @opindex ftree-dominator-opts
6558 Perform a variety of simple scalar cleanups (constant/copy
6559 propagation, redundancy elimination, range propagation and expression
6560 simplification) based on a dominator tree traversal.  This also
6561 performs jump threading (to reduce jumps to jumps). This flag is
6562 enabled by default at @option{-O} and higher.
6563
6564 @item -ftree-dse
6565 @opindex ftree-dse
6566 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6567 a memory location which will later be overwritten by another store without
6568 any intervening loads.  In this case the earlier store can be deleted.  This
6569 flag is enabled by default at @option{-O} and higher.
6570
6571 @item -ftree-ch
6572 @opindex ftree-ch
6573 Perform loop header copying on trees.  This is beneficial since it increases
6574 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6575 is enabled by default at @option{-O} and higher.  It is not enabled
6576 for @option{-Os}, since it usually increases code size.
6577
6578 @item -ftree-loop-optimize
6579 @opindex ftree-loop-optimize
6580 Perform loop optimizations on trees.  This flag is enabled by default
6581 at @option{-O} and higher.
6582
6583 @item -ftree-loop-linear
6584 @opindex ftree-loop-linear
6585 Perform linear loop transformations on tree.  This flag can improve cache
6586 performance and allow further loop optimizations to take place.
6587
6588 @item -floop-interchange
6589 Perform loop interchange transformations on loops.  Interchanging two
6590 nested loops switches the inner and outer loops.  For example, given a
6591 loop like:
6592 @smallexample
6593 DO J = 1, M
6594   DO I = 1, N
6595     A(J, I) = A(J, I) * C
6596   ENDDO
6597 ENDDO
6598 @end smallexample
6599 loop interchange will transform the loop as if the user had written:
6600 @smallexample
6601 DO I = 1, N
6602   DO J = 1, M
6603     A(J, I) = A(J, I) * C
6604   ENDDO
6605 ENDDO
6606 @end smallexample
6607 which can be beneficial when @code{N} is larger than the caches,
6608 because in Fortran, the elements of an array are stored in memory
6609 contiguously by column, and the original loop iterates over rows,
6610 potentially creating at each access a cache miss.  This optimization
6611 applies to all the languages supported by GCC and is not limited to
6612 Fortran.  To use this code transformation, GCC has to be configured
6613 with @option{--with-ppl} and @option{--with-cloog} to enable the
6614 Graphite loop transformation infrastructure.
6615
6616 @item -floop-strip-mine
6617 Perform loop strip mining transformations on loops.  Strip mining
6618 splits a loop into two nested loops.  The outer loop has strides
6619 equal to the strip size and the inner loop has strides of the
6620 original loop within a strip.  For example, given a loop like:
6621 @smallexample
6622 DO I = 1, N
6623   A(I) = A(I) + C
6624 ENDDO
6625 @end smallexample
6626 loop strip mining will transform the loop as if the user had written:
6627 @smallexample
6628 DO II = 1, N, 4
6629   DO I = II, min (II + 3, N)
6630     A(I) = A(I) + C
6631   ENDDO
6632 ENDDO
6633 @end smallexample
6634 This optimization applies to all the languages supported by GCC and is
6635 not limited to Fortran.  To use this code transformation, GCC has to
6636 be configured with @option{--with-ppl} and @option{--with-cloog} to
6637 enable the Graphite loop transformation infrastructure.
6638
6639 @item -floop-block
6640 Perform loop blocking transformations on loops.  Blocking strip mines
6641 each loop in the loop nest such that the memory accesses of the
6642 element loops fit inside caches.  For example, given a loop like:
6643 @smallexample
6644 DO I = 1, N
6645   DO J = 1, M
6646     A(J, I) = B(I) + C(J)
6647   ENDDO
6648 ENDDO
6649 @end smallexample
6650 loop blocking will transform the loop as if the user had written:
6651 @smallexample
6652 DO II = 1, N, 64
6653   DO JJ = 1, M, 64
6654     DO I = II, min (II + 63, N)
6655       DO J = JJ, min (JJ + 63, M)
6656         A(J, I) = B(I) + C(J)
6657       ENDDO
6658     ENDDO
6659   ENDDO
6660 ENDDO
6661 @end smallexample
6662 which can be beneficial when @code{M} is larger than the caches,
6663 because the innermost loop will iterate over a smaller amount of data
6664 that can be kept in the caches.  This optimization applies to all the
6665 languages supported by GCC and is not limited to Fortran.  To use this
6666 code transformation, GCC has to be configured with @option{--with-ppl}
6667 and @option{--with-cloog} to enable the Graphite loop transformation
6668 infrastructure.
6669
6670 @item -fgraphite-identity
6671 @opindex fgraphite-identity
6672 Enable the identity transformation for graphite.  For every SCoP we generate
6673 the polyhedral representation and transform it back to gimple.  Using
6674 @option{-fgraphite-identity} we can check the costs or benefits of the
6675 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6676 are also performed by the code generator CLooG, like index splitting and
6677 dead code elimination in loops.
6678
6679 @item -floop-parallelize-all
6680 Use the Graphite data dependence analysis to identify loops that can
6681 be parallelized.  Parallelize all the loops that can be analyzed to
6682 not contain loop carried dependences without checking that it is
6683 profitable to parallelize the loops.
6684
6685 @item -fcheck-data-deps
6686 @opindex fcheck-data-deps
6687 Compare the results of several data dependence analyzers.  This option
6688 is used for debugging the data dependence analyzers.
6689
6690 @item -ftree-loop-distribution
6691 Perform loop distribution.  This flag can improve cache performance on
6692 big loop bodies and allow further loop optimizations, like
6693 parallelization or vectorization, to take place.  For example, the loop
6694 @smallexample
6695 DO I = 1, N
6696   A(I) = B(I) + C
6697   D(I) = E(I) * F
6698 ENDDO
6699 @end smallexample
6700 is transformed to
6701 @smallexample
6702 DO I = 1, N
6703    A(I) = B(I) + C
6704 ENDDO
6705 DO I = 1, N
6706    D(I) = E(I) * F
6707 ENDDO
6708 @end smallexample
6709
6710 @item -ftree-loop-im
6711 @opindex ftree-loop-im
6712 Perform loop invariant motion on trees.  This pass moves only invariants that
6713 would be hard to handle at RTL level (function calls, operations that expand to
6714 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6715 operands of conditions that are invariant out of the loop, so that we can use
6716 just trivial invariantness analysis in loop unswitching.  The pass also includes
6717 store motion.
6718
6719 @item -ftree-loop-ivcanon
6720 @opindex ftree-loop-ivcanon
6721 Create a canonical counter for number of iterations in the loop for that
6722 determining number of iterations requires complicated analysis.  Later
6723 optimizations then may determine the number easily.  Useful especially
6724 in connection with unrolling.
6725
6726 @item -fivopts
6727 @opindex fivopts
6728 Perform induction variable optimizations (strength reduction, induction
6729 variable merging and induction variable elimination) on trees.
6730
6731 @item -ftree-parallelize-loops=n
6732 @opindex ftree-parallelize-loops
6733 Parallelize loops, i.e., split their iteration space to run in n threads.
6734 This is only possible for loops whose iterations are independent
6735 and can be arbitrarily reordered.  The optimization is only
6736 profitable on multiprocessor machines, for loops that are CPU-intensive,
6737 rather than constrained e.g.@: by memory bandwidth.  This option
6738 implies @option{-pthread}, and thus is only supported on targets
6739 that have support for @option{-pthread}.
6740
6741 @item -ftree-pta
6742 @opindex ftree-pta
6743 Perform function-local points-to analysis on trees.  This flag is
6744 enabled by default at @option{-O} and higher.
6745
6746 @item -ftree-sra
6747 @opindex ftree-sra
6748 Perform scalar replacement of aggregates.  This pass replaces structure
6749 references with scalars to prevent committing structures to memory too
6750 early.  This flag is enabled by default at @option{-O} and higher.
6751
6752 @item -ftree-copyrename
6753 @opindex ftree-copyrename
6754 Perform copy renaming on trees.  This pass attempts to rename compiler
6755 temporaries to other variables at copy locations, usually resulting in
6756 variable names which more closely resemble the original variables.  This flag
6757 is enabled by default at @option{-O} and higher.
6758
6759 @item -ftree-ter
6760 @opindex ftree-ter
6761 Perform temporary expression replacement during the SSA->normal phase.  Single
6762 use/single def temporaries are replaced at their use location with their
6763 defining expression.  This results in non-GIMPLE code, but gives the expanders
6764 much more complex trees to work on resulting in better RTL generation.  This is
6765 enabled by default at @option{-O} and higher.
6766
6767 @item -ftree-vectorize
6768 @opindex ftree-vectorize
6769 Perform loop vectorization on trees. This flag is enabled by default at
6770 @option{-O3}.
6771
6772 @item -ftree-vect-loop-version
6773 @opindex ftree-vect-loop-version
6774 Perform loop versioning when doing loop vectorization on trees.  When a loop
6775 appears to be vectorizable except that data alignment or data dependence cannot
6776 be determined at compile time then vectorized and non-vectorized versions of
6777 the loop are generated along with runtime checks for alignment or dependence
6778 to control which version is executed.  This option is enabled by default
6779 except at level @option{-Os} where it is disabled.
6780
6781 @item -fvect-cost-model
6782 @opindex fvect-cost-model
6783 Enable cost model for vectorization.
6784
6785 @item -ftree-vrp
6786 @opindex ftree-vrp
6787 Perform Value Range Propagation on trees.  This is similar to the
6788 constant propagation pass, but instead of values, ranges of values are
6789 propagated.  This allows the optimizers to remove unnecessary range
6790 checks like array bound checks and null pointer checks.  This is
6791 enabled by default at @option{-O2} and higher.  Null pointer check
6792 elimination is only done if @option{-fdelete-null-pointer-checks} is
6793 enabled.
6794
6795 @item -ftracer
6796 @opindex ftracer
6797 Perform tail duplication to enlarge superblock size.  This transformation
6798 simplifies the control flow of the function allowing other optimizations to do
6799 better job.
6800
6801 @item -funroll-loops
6802 @opindex funroll-loops
6803 Unroll loops whose number of iterations can be determined at compile
6804 time or upon entry to the loop.  @option{-funroll-loops} implies
6805 @option{-frerun-cse-after-loop}.  This option makes code larger,
6806 and may or may not make it run faster.
6807
6808 @item -funroll-all-loops
6809 @opindex funroll-all-loops
6810 Unroll all loops, even if their number of iterations is uncertain when
6811 the loop is entered.  This usually makes programs run more slowly.
6812 @option{-funroll-all-loops} implies the same options as
6813 @option{-funroll-loops},
6814
6815 @item -fsplit-ivs-in-unroller
6816 @opindex fsplit-ivs-in-unroller
6817 Enables expressing of values of induction variables in later iterations
6818 of the unrolled loop using the value in the first iteration.  This breaks
6819 long dependency chains, thus improving efficiency of the scheduling passes.
6820
6821 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6822 same effect.  However in cases the loop body is more complicated than
6823 a single basic block, this is not reliable.  It also does not work at all
6824 on some of the architectures due to restrictions in the CSE pass.
6825
6826 This optimization is enabled by default.
6827
6828 @item -fvariable-expansion-in-unroller
6829 @opindex fvariable-expansion-in-unroller
6830 With this option, the compiler will create multiple copies of some
6831 local variables when unrolling a loop which can result in superior code.
6832
6833 @item -fpredictive-commoning
6834 @opindex fpredictive-commoning
6835 Perform predictive commoning optimization, i.e., reusing computations
6836 (especially memory loads and stores) performed in previous
6837 iterations of loops.
6838
6839 This option is enabled at level @option{-O3}.
6840
6841 @item -fprefetch-loop-arrays
6842 @opindex fprefetch-loop-arrays
6843 If supported by the target machine, generate instructions to prefetch
6844 memory to improve the performance of loops that access large arrays.
6845
6846 This option may generate better or worse code; results are highly
6847 dependent on the structure of loops within the source code.
6848
6849 Disabled at level @option{-Os}.
6850
6851 @item -fno-peephole
6852 @itemx -fno-peephole2
6853 @opindex fno-peephole
6854 @opindex fno-peephole2
6855 Disable any machine-specific peephole optimizations.  The difference
6856 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6857 are implemented in the compiler; some targets use one, some use the
6858 other, a few use both.
6859
6860 @option{-fpeephole} is enabled by default.
6861 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6862
6863 @item -fno-guess-branch-probability
6864 @opindex fno-guess-branch-probability
6865 Do not guess branch probabilities using heuristics.
6866
6867 GCC will use heuristics to guess branch probabilities if they are
6868 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6869 heuristics are based on the control flow graph.  If some branch probabilities
6870 are specified by @samp{__builtin_expect}, then the heuristics will be
6871 used to guess branch probabilities for the rest of the control flow graph,
6872 taking the @samp{__builtin_expect} info into account.  The interactions
6873 between the heuristics and @samp{__builtin_expect} can be complex, and in
6874 some cases, it may be useful to disable the heuristics so that the effects
6875 of @samp{__builtin_expect} are easier to understand.
6876
6877 The default is @option{-fguess-branch-probability} at levels
6878 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6879
6880 @item -freorder-blocks
6881 @opindex freorder-blocks
6882 Reorder basic blocks in the compiled function in order to reduce number of
6883 taken branches and improve code locality.
6884
6885 Enabled at levels @option{-O2}, @option{-O3}.
6886
6887 @item -freorder-blocks-and-partition
6888 @opindex freorder-blocks-and-partition
6889 In addition to reordering basic blocks in the compiled function, in order
6890 to reduce number of taken branches, partitions hot and cold basic blocks
6891 into separate sections of the assembly and .o files, to improve
6892 paging and cache locality performance.
6893
6894 This optimization is automatically turned off in the presence of
6895 exception handling, for linkonce sections, for functions with a user-defined
6896 section attribute and on any architecture that does not support named
6897 sections.
6898
6899 @item -freorder-functions
6900 @opindex freorder-functions
6901 Reorder functions in the object file in order to
6902 improve code locality.  This is implemented by using special
6903 subsections @code{.text.hot} for most frequently executed functions and
6904 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6905 the linker so object file format must support named sections and linker must
6906 place them in a reasonable way.
6907
6908 Also profile feedback must be available in to make this option effective.  See
6909 @option{-fprofile-arcs} for details.
6910
6911 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6912
6913 @item -fstrict-aliasing
6914 @opindex fstrict-aliasing
6915 Allow the compiler to assume the strictest aliasing rules applicable to
6916 the language being compiled.  For C (and C++), this activates
6917 optimizations based on the type of expressions.  In particular, an
6918 object of one type is assumed never to reside at the same address as an
6919 object of a different type, unless the types are almost the same.  For
6920 example, an @code{unsigned int} can alias an @code{int}, but not a
6921 @code{void*} or a @code{double}.  A character type may alias any other
6922 type.
6923
6924 @anchor{Type-punning}Pay special attention to code like this:
6925 @smallexample
6926 union a_union @{
6927   int i;
6928   double d;
6929 @};
6930
6931 int f() @{
6932   union a_union t;
6933   t.d = 3.0;
6934   return t.i;
6935 @}
6936 @end smallexample
6937 The practice of reading from a different union member than the one most
6938 recently written to (called ``type-punning'') is common.  Even with
6939 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6940 is accessed through the union type.  So, the code above will work as
6941 expected.  @xref{Structures unions enumerations and bit-fields
6942 implementation}.  However, this code might not:
6943 @smallexample
6944 int f() @{
6945   union a_union t;
6946   int* ip;
6947   t.d = 3.0;
6948   ip = &t.i;
6949   return *ip;
6950 @}
6951 @end smallexample
6952
6953 Similarly, access by taking the address, casting the resulting pointer
6954 and dereferencing the result has undefined behavior, even if the cast
6955 uses a union type, e.g.:
6956 @smallexample
6957 int f() @{
6958   double d = 3.0;
6959   return ((union a_union *) &d)->i;
6960 @}
6961 @end smallexample
6962
6963 The @option{-fstrict-aliasing} option is enabled at levels
6964 @option{-O2}, @option{-O3}, @option{-Os}.
6965
6966 @item -fstrict-overflow
6967 @opindex fstrict-overflow
6968 Allow the compiler to assume strict signed overflow rules, depending
6969 on the language being compiled.  For C (and C++) this means that
6970 overflow when doing arithmetic with signed numbers is undefined, which
6971 means that the compiler may assume that it will not happen.  This
6972 permits various optimizations.  For example, the compiler will assume
6973 that an expression like @code{i + 10 > i} will always be true for
6974 signed @code{i}.  This assumption is only valid if signed overflow is
6975 undefined, as the expression is false if @code{i + 10} overflows when
6976 using twos complement arithmetic.  When this option is in effect any
6977 attempt to determine whether an operation on signed numbers will
6978 overflow must be written carefully to not actually involve overflow.
6979
6980 This option also allows the compiler to assume strict pointer
6981 semantics: given a pointer to an object, if adding an offset to that
6982 pointer does not produce a pointer to the same object, the addition is
6983 undefined.  This permits the compiler to conclude that @code{p + u >
6984 p} is always true for a pointer @code{p} and unsigned integer
6985 @code{u}.  This assumption is only valid because pointer wraparound is
6986 undefined, as the expression is false if @code{p + u} overflows using
6987 twos complement arithmetic.
6988
6989 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6990 that integer signed overflow is fully defined: it wraps.  When
6991 @option{-fwrapv} is used, there is no difference between
6992 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6993 integers.  With @option{-fwrapv} certain types of overflow are
6994 permitted.  For example, if the compiler gets an overflow when doing
6995 arithmetic on constants, the overflowed value can still be used with
6996 @option{-fwrapv}, but not otherwise.
6997
6998 The @option{-fstrict-overflow} option is enabled at levels
6999 @option{-O2}, @option{-O3}, @option{-Os}.
7000
7001 @item -falign-functions
7002 @itemx -falign-functions=@var{n}
7003 @opindex falign-functions
7004 Align the start of functions to the next power-of-two greater than
7005 @var{n}, skipping up to @var{n} bytes.  For instance,
7006 @option{-falign-functions=32} aligns functions to the next 32-byte
7007 boundary, but @option{-falign-functions=24} would align to the next
7008 32-byte boundary only if this can be done by skipping 23 bytes or less.
7009
7010 @option{-fno-align-functions} and @option{-falign-functions=1} are
7011 equivalent and mean that functions will not be aligned.
7012
7013 Some assemblers only support this flag when @var{n} is a power of two;
7014 in that case, it is rounded up.
7015
7016 If @var{n} is not specified or is zero, use a machine-dependent default.
7017
7018 Enabled at levels @option{-O2}, @option{-O3}.
7019
7020 @item -falign-labels
7021 @itemx -falign-labels=@var{n}
7022 @opindex falign-labels
7023 Align all branch targets to a power-of-two boundary, skipping up to
7024 @var{n} bytes like @option{-falign-functions}.  This option can easily
7025 make code slower, because it must insert dummy operations for when the
7026 branch target is reached in the usual flow of the code.
7027
7028 @option{-fno-align-labels} and @option{-falign-labels=1} are
7029 equivalent and mean that labels will not be aligned.
7030
7031 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7032 are greater than this value, then their values are used instead.
7033
7034 If @var{n} is not specified or is zero, use a machine-dependent default
7035 which is very likely to be @samp{1}, meaning no alignment.
7036
7037 Enabled at levels @option{-O2}, @option{-O3}.
7038
7039 @item -falign-loops
7040 @itemx -falign-loops=@var{n}
7041 @opindex falign-loops
7042 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7043 like @option{-falign-functions}.  The hope is that the loop will be
7044 executed many times, which will make up for any execution of the dummy
7045 operations.
7046
7047 @option{-fno-align-loops} and @option{-falign-loops=1} are
7048 equivalent and mean that loops will not be aligned.
7049
7050 If @var{n} is not specified or is zero, use a machine-dependent default.
7051
7052 Enabled at levels @option{-O2}, @option{-O3}.
7053
7054 @item -falign-jumps
7055 @itemx -falign-jumps=@var{n}
7056 @opindex falign-jumps
7057 Align branch targets to a power-of-two boundary, for branch targets
7058 where the targets can only be reached by jumping, skipping up to @var{n}
7059 bytes like @option{-falign-functions}.  In this case, no dummy operations
7060 need be executed.
7061
7062 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7063 equivalent and mean that loops will not be aligned.
7064
7065 If @var{n} is not specified or is zero, use a machine-dependent default.
7066
7067 Enabled at levels @option{-O2}, @option{-O3}.
7068
7069 @item -funit-at-a-time
7070 @opindex funit-at-a-time
7071 This option is left for compatibility reasons. @option{-funit-at-a-time}
7072 has no effect, while @option{-fno-unit-at-a-time} implies
7073 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7074
7075 Enabled by default.
7076
7077 @item -fno-toplevel-reorder
7078 @opindex fno-toplevel-reorder
7079 Do not reorder top-level functions, variables, and @code{asm}
7080 statements.  Output them in the same order that they appear in the
7081 input file.  When this option is used, unreferenced static variables
7082 will not be removed.  This option is intended to support existing code
7083 which relies on a particular ordering.  For new code, it is better to
7084 use attributes.
7085
7086 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7087 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7088 targets.
7089
7090 @item -fweb
7091 @opindex fweb
7092 Constructs webs as commonly used for register allocation purposes and assign
7093 each web individual pseudo register.  This allows the register allocation pass
7094 to operate on pseudos directly, but also strengthens several other optimization
7095 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7096 however, make debugging impossible, since variables will no longer stay in a
7097 ``home register''.
7098
7099 Enabled by default with @option{-funroll-loops}.
7100
7101 @item -fwhole-program
7102 @opindex fwhole-program
7103 Assume that the current compilation unit represents the whole program being
7104 compiled.  All public functions and variables with the exception of @code{main}
7105 and those merged by attribute @code{externally_visible} become static functions
7106 and in effect are optimized more aggressively by interprocedural optimizers.
7107 While this option is equivalent to proper use of the @code{static} keyword for
7108 programs consisting of a single file, in combination with option
7109 @option{--combine} this flag can be used to compile many smaller scale C
7110 programs since the functions and variables become local for the whole combined
7111 compilation unit, not for the single source file itself.
7112
7113 This option implies @option{-fwhole-file} for Fortran programs.
7114
7115 @item -fcprop-registers
7116 @opindex fcprop-registers
7117 After register allocation and post-register allocation instruction splitting,
7118 we perform a copy-propagation pass to try to reduce scheduling dependencies
7119 and occasionally eliminate the copy.
7120
7121 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7122
7123 @item -fprofile-correction
7124 @opindex fprofile-correction
7125 Profiles collected using an instrumented binary for multi-threaded programs may
7126 be inconsistent due to missed counter updates. When this option is specified,
7127 GCC will use heuristics to correct or smooth out such inconsistencies. By
7128 default, GCC will emit an error message when an inconsistent profile is detected.
7129
7130 @item -fprofile-dir=@var{path}
7131 @opindex fprofile-dir
7132
7133 Set the directory to search the profile data files in to @var{path}.
7134 This option affects only the profile data generated by
7135 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7136 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7137 and its related options.
7138 By default, GCC will use the current directory as @var{path}
7139 thus the profile data file will appear in the same directory as the object file.
7140
7141 @item -fprofile-generate
7142 @itemx -fprofile-generate=@var{path}
7143 @opindex fprofile-generate
7144
7145 Enable options usually used for instrumenting application to produce
7146 profile useful for later recompilation with profile feedback based
7147 optimization.  You must use @option{-fprofile-generate} both when
7148 compiling and when linking your program.
7149
7150 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7151
7152 If @var{path} is specified, GCC will look at the @var{path} to find
7153 the profile feedback data files. See @option{-fprofile-dir}.
7154
7155 @item -fprofile-use
7156 @itemx -fprofile-use=@var{path}
7157 @opindex fprofile-use
7158 Enable profile feedback directed optimizations, and optimizations
7159 generally profitable only with profile feedback available.
7160
7161 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7162 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7163
7164 By default, GCC emits an error message if the feedback profiles do not
7165 match the source code.  This error can be turned into a warning by using
7166 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7167 code.
7168
7169 If @var{path} is specified, GCC will look at the @var{path} to find
7170 the profile feedback data files. See @option{-fprofile-dir}.
7171 @end table
7172
7173 The following options control compiler behavior regarding floating
7174 point arithmetic.  These options trade off between speed and
7175 correctness.  All must be specifically enabled.
7176
7177 @table @gcctabopt
7178 @item -ffloat-store
7179 @opindex ffloat-store
7180 Do not store floating point variables in registers, and inhibit other
7181 options that might change whether a floating point value is taken from a
7182 register or memory.
7183
7184 @cindex floating point precision
7185 This option prevents undesirable excess precision on machines such as
7186 the 68000 where the floating registers (of the 68881) keep more
7187 precision than a @code{double} is supposed to have.  Similarly for the
7188 x86 architecture.  For most programs, the excess precision does only
7189 good, but a few programs rely on the precise definition of IEEE floating
7190 point.  Use @option{-ffloat-store} for such programs, after modifying
7191 them to store all pertinent intermediate computations into variables.
7192
7193 @item -fexcess-precision=@var{style}
7194 @opindex fexcess-precision
7195 This option allows further control over excess precision on machines
7196 where floating-point registers have more precision than the IEEE
7197 @code{float} and @code{double} types and the processor does not
7198 support operations rounding to those types.  By default,
7199 @option{-fexcess-precision=fast} is in effect; this means that
7200 operations are carried out in the precision of the registers and that
7201 it is unpredictable when rounding to the types specified in the source
7202 code takes place.  When compiling C, if
7203 @option{-fexcess-precision=standard} is specified then excess
7204 precision will follow the rules specified in ISO C99; in particular,
7205 both casts and assignments cause values to be rounded to their
7206 semantic types (whereas @option{-ffloat-store} only affects
7207 assignments).  This option is enabled by default for C if a strict
7208 conformance option such as @option{-std=c99} is used.
7209
7210 @opindex mfpmath
7211 @option{-fexcess-precision=standard} is not implemented for languages
7212 other than C, and has no effect if
7213 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7214 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7215 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7216 semantics apply without excess precision, and in the latter, rounding
7217 is unpredictable.
7218
7219 @item -ffast-math
7220 @opindex ffast-math
7221 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7222 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7223 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7224
7225 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7226
7227 This option is not turned on by any @option{-O} option since
7228 it can result in incorrect output for programs which depend on
7229 an exact implementation of IEEE or ISO rules/specifications for
7230 math functions. It may, however, yield faster code for programs
7231 that do not require the guarantees of these specifications.
7232
7233 @item -fno-math-errno
7234 @opindex fno-math-errno
7235 Do not set ERRNO after calling math functions that are executed
7236 with a single instruction, e.g., sqrt.  A program that relies on
7237 IEEE exceptions for math error handling may want to use this flag
7238 for speed while maintaining IEEE arithmetic compatibility.
7239
7240 This option is not turned on by any @option{-O} option since
7241 it can result in incorrect output for programs which depend on
7242 an exact implementation of IEEE or ISO rules/specifications for
7243 math functions. It may, however, yield faster code for programs
7244 that do not require the guarantees of these specifications.
7245
7246 The default is @option{-fmath-errno}.
7247
7248 On Darwin systems, the math library never sets @code{errno}.  There is
7249 therefore no reason for the compiler to consider the possibility that
7250 it might, and @option{-fno-math-errno} is the default.
7251
7252 @item -funsafe-math-optimizations
7253 @opindex funsafe-math-optimizations
7254
7255 Allow optimizations for floating-point arithmetic that (a) assume
7256 that arguments and results are valid and (b) may violate IEEE or
7257 ANSI standards.  When used at link-time, it may include libraries
7258 or startup files that change the default FPU control word or other
7259 similar optimizations.
7260
7261 This option is not turned on by any @option{-O} option since
7262 it can result in incorrect output for programs which depend on
7263 an exact implementation of IEEE or ISO rules/specifications for
7264 math functions. It may, however, yield faster code for programs
7265 that do not require the guarantees of these specifications.
7266 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7267 @option{-fassociative-math} and @option{-freciprocal-math}.
7268
7269 The default is @option{-fno-unsafe-math-optimizations}.
7270
7271 @item -fassociative-math
7272 @opindex fassociative-math
7273
7274 Allow re-association of operands in series of floating-point operations.
7275 This violates the ISO C and C++ language standard by possibly changing
7276 computation result.  NOTE: re-ordering may change the sign of zero as
7277 well as ignore NaNs and inhibit or create underflow or overflow (and
7278 thus cannot be used on a code which relies on rounding behavior like
7279 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7280 and thus may not be used when ordered comparisons are required.
7281 This option requires that both @option{-fno-signed-zeros} and
7282 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7283 much sense with @option{-frounding-math}.
7284
7285 The default is @option{-fno-associative-math}.
7286
7287 @item -freciprocal-math
7288 @opindex freciprocal-math
7289
7290 Allow the reciprocal of a value to be used instead of dividing by
7291 the value if this enables optimizations.  For example @code{x / y}
7292 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7293 is subject to common subexpression elimination.  Note that this loses
7294 precision and increases the number of flops operating on the value.
7295
7296 The default is @option{-fno-reciprocal-math}.
7297
7298 @item -ffinite-math-only
7299 @opindex ffinite-math-only
7300 Allow optimizations for floating-point arithmetic that assume
7301 that arguments and results are not NaNs or +-Infs.
7302
7303 This option is not turned on by any @option{-O} option since
7304 it can result in incorrect output for programs which depend on
7305 an exact implementation of IEEE or ISO rules/specifications for
7306 math functions. It may, however, yield faster code for programs
7307 that do not require the guarantees of these specifications.
7308
7309 The default is @option{-fno-finite-math-only}.
7310
7311 @item -fno-signed-zeros
7312 @opindex fno-signed-zeros
7313 Allow optimizations for floating point arithmetic that ignore the
7314 signedness of zero.  IEEE arithmetic specifies the behavior of
7315 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7316 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7317 This option implies that the sign of a zero result isn't significant.
7318
7319 The default is @option{-fsigned-zeros}.
7320
7321 @item -fno-trapping-math
7322 @opindex fno-trapping-math
7323 Compile code assuming that floating-point operations cannot generate
7324 user-visible traps.  These traps include division by zero, overflow,
7325 underflow, inexact result and invalid operation.  This option requires
7326 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7327 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7328
7329 This option should never be turned on by any @option{-O} option since
7330 it can result in incorrect output for programs which depend on
7331 an exact implementation of IEEE or ISO rules/specifications for
7332 math functions.
7333
7334 The default is @option{-ftrapping-math}.
7335
7336 @item -frounding-math
7337 @opindex frounding-math
7338 Disable transformations and optimizations that assume default floating
7339 point rounding behavior.  This is round-to-zero for all floating point
7340 to integer conversions, and round-to-nearest for all other arithmetic
7341 truncations.  This option should be specified for programs that change
7342 the FP rounding mode dynamically, or that may be executed with a
7343 non-default rounding mode.  This option disables constant folding of
7344 floating point expressions at compile-time (which may be affected by
7345 rounding mode) and arithmetic transformations that are unsafe in the
7346 presence of sign-dependent rounding modes.
7347
7348 The default is @option{-fno-rounding-math}.
7349
7350 This option is experimental and does not currently guarantee to
7351 disable all GCC optimizations that are affected by rounding mode.
7352 Future versions of GCC may provide finer control of this setting
7353 using C99's @code{FENV_ACCESS} pragma.  This command line option
7354 will be used to specify the default state for @code{FENV_ACCESS}.
7355
7356 @item -fsignaling-nans
7357 @opindex fsignaling-nans
7358 Compile code assuming that IEEE signaling NaNs may generate user-visible
7359 traps during floating-point operations.  Setting this option disables
7360 optimizations that may change the number of exceptions visible with
7361 signaling NaNs.  This option implies @option{-ftrapping-math}.
7362
7363 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7364 be defined.
7365
7366 The default is @option{-fno-signaling-nans}.
7367
7368 This option is experimental and does not currently guarantee to
7369 disable all GCC optimizations that affect signaling NaN behavior.
7370
7371 @item -fsingle-precision-constant
7372 @opindex fsingle-precision-constant
7373 Treat floating point constant as single precision constant instead of
7374 implicitly converting it to double precision constant.
7375
7376 @item -fcx-limited-range
7377 @opindex fcx-limited-range
7378 When enabled, this option states that a range reduction step is not
7379 needed when performing complex division.  Also, there is no checking
7380 whether the result of a complex multiplication or division is @code{NaN
7381 + I*NaN}, with an attempt to rescue the situation in that case.  The
7382 default is @option{-fno-cx-limited-range}, but is enabled by
7383 @option{-ffast-math}.
7384
7385 This option controls the default setting of the ISO C99
7386 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7387 all languages.
7388
7389 @item -fcx-fortran-rules
7390 @opindex fcx-fortran-rules
7391 Complex multiplication and division follow Fortran rules.  Range
7392 reduction is done as part of complex division, but there is no checking
7393 whether the result of a complex multiplication or division is @code{NaN
7394 + I*NaN}, with an attempt to rescue the situation in that case.
7395
7396 The default is @option{-fno-cx-fortran-rules}.
7397
7398 @end table
7399
7400 The following options control optimizations that may improve
7401 performance, but are not enabled by any @option{-O} options.  This
7402 section includes experimental options that may produce broken code.
7403
7404 @table @gcctabopt
7405 @item -fbranch-probabilities
7406 @opindex fbranch-probabilities
7407 After running a program compiled with @option{-fprofile-arcs}
7408 (@pxref{Debugging Options,, Options for Debugging Your Program or
7409 @command{gcc}}), you can compile it a second time using
7410 @option{-fbranch-probabilities}, to improve optimizations based on
7411 the number of times each branch was taken.  When the program
7412 compiled with @option{-fprofile-arcs} exits it saves arc execution
7413 counts to a file called @file{@var{sourcename}.gcda} for each source
7414 file.  The information in this data file is very dependent on the
7415 structure of the generated code, so you must use the same source code
7416 and the same optimization options for both compilations.
7417
7418 With @option{-fbranch-probabilities}, GCC puts a
7419 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7420 These can be used to improve optimization.  Currently, they are only
7421 used in one place: in @file{reorg.c}, instead of guessing which path a
7422 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7423 exactly determine which path is taken more often.
7424
7425 @item -fprofile-values
7426 @opindex fprofile-values
7427 If combined with @option{-fprofile-arcs}, it adds code so that some
7428 data about values of expressions in the program is gathered.
7429
7430 With @option{-fbranch-probabilities}, it reads back the data gathered
7431 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7432 notes to instructions for their later usage in optimizations.
7433
7434 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7435
7436 @item -fvpt
7437 @opindex fvpt
7438 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7439 a code to gather information about values of expressions.
7440
7441 With @option{-fbranch-probabilities}, it reads back the data gathered
7442 and actually performs the optimizations based on them.
7443 Currently the optimizations include specialization of division operation
7444 using the knowledge about the value of the denominator.
7445
7446 @item -frename-registers
7447 @opindex frename-registers
7448 Attempt to avoid false dependencies in scheduled code by making use
7449 of registers left over after register allocation.  This optimization
7450 will most benefit processors with lots of registers.  Depending on the
7451 debug information format adopted by the target, however, it can
7452 make debugging impossible, since variables will no longer stay in
7453 a ``home register''.
7454
7455 Enabled by default with @option{-funroll-loops}.
7456
7457 @item -ftracer
7458 @opindex ftracer
7459 Perform tail duplication to enlarge superblock size.  This transformation
7460 simplifies the control flow of the function allowing other optimizations to do
7461 better job.
7462
7463 Enabled with @option{-fprofile-use}.
7464
7465 @item -funroll-loops
7466 @opindex funroll-loops
7467 Unroll loops whose number of iterations can be determined at compile time or
7468 upon entry to the loop.  @option{-funroll-loops} implies
7469 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
7470 It also turns on complete loop peeling (i.e.@: complete removal of loops with
7471 small constant number of iterations).  This option makes code larger, and may
7472 or may not make it run faster.
7473
7474 Enabled with @option{-fprofile-use}.
7475
7476 @item -funroll-all-loops
7477 @opindex funroll-all-loops
7478 Unroll all loops, even if their number of iterations is uncertain when
7479 the loop is entered.  This usually makes programs run more slowly.
7480 @option{-funroll-all-loops} implies the same options as
7481 @option{-funroll-loops}.
7482
7483 @item -fpeel-loops
7484 @opindex fpeel-loops
7485 Peels the loops for that there is enough information that they do not
7486 roll much (from profile feedback).  It also turns on complete loop peeling
7487 (i.e.@: complete removal of loops with small constant number of iterations).
7488
7489 Enabled with @option{-fprofile-use}.
7490
7491 @item -fmove-loop-invariants
7492 @opindex fmove-loop-invariants
7493 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
7494 at level @option{-O1}
7495
7496 @item -funswitch-loops
7497 @opindex funswitch-loops
7498 Move branches with loop invariant conditions out of the loop, with duplicates
7499 of the loop on both branches (modified according to result of the condition).
7500
7501 @item -ffunction-sections
7502 @itemx -fdata-sections
7503 @opindex ffunction-sections
7504 @opindex fdata-sections
7505 Place each function or data item into its own section in the output
7506 file if the target supports arbitrary sections.  The name of the
7507 function or the name of the data item determines the section's name
7508 in the output file.
7509
7510 Use these options on systems where the linker can perform optimizations
7511 to improve locality of reference in the instruction space.  Most systems
7512 using the ELF object format and SPARC processors running Solaris 2 have
7513 linkers with such optimizations.  AIX may have these optimizations in
7514 the future.
7515
7516 Only use these options when there are significant benefits from doing
7517 so.  When you specify these options, the assembler and linker will
7518 create larger object and executable files and will also be slower.
7519 You will not be able to use @code{gprof} on all systems if you
7520 specify this option and you may have problems with debugging if
7521 you specify both this option and @option{-g}.
7522
7523 @item -fbranch-target-load-optimize
7524 @opindex fbranch-target-load-optimize
7525 Perform branch target register load optimization before prologue / epilogue
7526 threading.
7527 The use of target registers can typically be exposed only during reload,
7528 thus hoisting loads out of loops and doing inter-block scheduling needs
7529 a separate optimization pass.
7530
7531 @item -fbranch-target-load-optimize2
7532 @opindex fbranch-target-load-optimize2
7533 Perform branch target register load optimization after prologue / epilogue
7534 threading.
7535
7536 @item -fbtr-bb-exclusive
7537 @opindex fbtr-bb-exclusive
7538 When performing branch target register load optimization, don't reuse
7539 branch target registers in within any basic block.
7540
7541 @item -fstack-protector
7542 @opindex fstack-protector
7543 Emit extra code to check for buffer overflows, such as stack smashing
7544 attacks.  This is done by adding a guard variable to functions with
7545 vulnerable objects.  This includes functions that call alloca, and
7546 functions with buffers larger than 8 bytes.  The guards are initialized
7547 when a function is entered and then checked when the function exits.
7548 If a guard check fails, an error message is printed and the program exits.
7549
7550 @item -fstack-protector-all
7551 @opindex fstack-protector-all
7552 Like @option{-fstack-protector} except that all functions are protected.
7553
7554 @item -fsection-anchors
7555 @opindex fsection-anchors
7556 Try to reduce the number of symbolic address calculations by using
7557 shared ``anchor'' symbols to address nearby objects.  This transformation
7558 can help to reduce the number of GOT entries and GOT accesses on some
7559 targets.
7560
7561 For example, the implementation of the following function @code{foo}:
7562
7563 @smallexample
7564 static int a, b, c;
7565 int foo (void) @{ return a + b + c; @}
7566 @end smallexample
7567
7568 would usually calculate the addresses of all three variables, but if you
7569 compile it with @option{-fsection-anchors}, it will access the variables
7570 from a common anchor point instead.  The effect is similar to the
7571 following pseudocode (which isn't valid C):
7572
7573 @smallexample
7574 int foo (void)
7575 @{
7576   register int *xr = &x;
7577   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7578 @}
7579 @end smallexample
7580
7581 Not all targets support this option.
7582
7583 @item --param @var{name}=@var{value}
7584 @opindex param
7585 In some places, GCC uses various constants to control the amount of
7586 optimization that is done.  For example, GCC will not inline functions
7587 that contain more that a certain number of instructions.  You can
7588 control some of these constants on the command-line using the
7589 @option{--param} option.
7590
7591 The names of specific parameters, and the meaning of the values, are
7592 tied to the internals of the compiler, and are subject to change
7593 without notice in future releases.
7594
7595 In each case, the @var{value} is an integer.  The allowable choices for
7596 @var{name} are given in the following table:
7597
7598 @table @gcctabopt
7599 @item struct-reorg-cold-struct-ratio
7600 The threshold ratio (as a percentage) between a structure frequency
7601 and the frequency of the hottest structure in the program.  This parameter
7602 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
7603 We say that if the ratio of a structure frequency, calculated by profiling,
7604 to the hottest structure frequency in the program is less than this
7605 parameter, then structure reorganization is not applied to this structure.
7606 The default is 10.
7607
7608 @item predictable-branch-cost-outcome
7609 When branch is predicted to be taken with probability lower than this threshold
7610 (in percent), then it is considered well predictable. The default is 10.
7611
7612 @item max-crossjump-edges
7613 The maximum number of incoming edges to consider for crossjumping.
7614 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
7615 the number of edges incoming to each block.  Increasing values mean
7616 more aggressive optimization, making the compile time increase with
7617 probably small improvement in executable size.
7618
7619 @item min-crossjump-insns
7620 The minimum number of instructions which must be matched at the end
7621 of two blocks before crossjumping will be performed on them.  This
7622 value is ignored in the case where all instructions in the block being
7623 crossjumped from are matched.  The default value is 5.
7624
7625 @item max-grow-copy-bb-insns
7626 The maximum code size expansion factor when copying basic blocks
7627 instead of jumping.  The expansion is relative to a jump instruction.
7628 The default value is 8.
7629
7630 @item max-goto-duplication-insns
7631 The maximum number of instructions to duplicate to a block that jumps
7632 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
7633 passes, GCC factors computed gotos early in the compilation process,
7634 and unfactors them as late as possible.  Only computed jumps at the
7635 end of a basic blocks with no more than max-goto-duplication-insns are
7636 unfactored.  The default value is 8.
7637
7638 @item max-delay-slot-insn-search
7639 The maximum number of instructions to consider when looking for an
7640 instruction to fill a delay slot.  If more than this arbitrary number of
7641 instructions is searched, the time savings from filling the delay slot
7642 will be minimal so stop searching.  Increasing values mean more
7643 aggressive optimization, making the compile time increase with probably
7644 small improvement in executable run time.
7645
7646 @item max-delay-slot-live-search
7647 When trying to fill delay slots, the maximum number of instructions to
7648 consider when searching for a block with valid live register
7649 information.  Increasing this arbitrarily chosen value means more
7650 aggressive optimization, increasing the compile time.  This parameter
7651 should be removed when the delay slot code is rewritten to maintain the
7652 control-flow graph.
7653
7654 @item max-gcse-memory
7655 The approximate maximum amount of memory that will be allocated in
7656 order to perform the global common subexpression elimination
7657 optimization.  If more memory than specified is required, the
7658 optimization will not be done.
7659
7660 @item max-pending-list-length
7661 The maximum number of pending dependencies scheduling will allow
7662 before flushing the current state and starting over.  Large functions
7663 with few branches or calls can create excessively large lists which
7664 needlessly consume memory and resources.
7665
7666 @item max-inline-insns-single
7667 Several parameters control the tree inliner used in gcc.
7668 This number sets the maximum number of instructions (counted in GCC's
7669 internal representation) in a single function that the tree inliner
7670 will consider for inlining.  This only affects functions declared
7671 inline and methods implemented in a class declaration (C++).
7672 The default value is 300.
7673
7674 @item max-inline-insns-auto
7675 When you use @option{-finline-functions} (included in @option{-O3}),
7676 a lot of functions that would otherwise not be considered for inlining
7677 by the compiler will be investigated.  To those functions, a different
7678 (more restrictive) limit compared to functions declared inline can
7679 be applied.
7680 The default value is 50.
7681
7682 @item large-function-insns
7683 The limit specifying really large functions.  For functions larger than this
7684 limit after inlining, inlining is constrained by
7685 @option{--param large-function-growth}.  This parameter is useful primarily
7686 to avoid extreme compilation time caused by non-linear algorithms used by the
7687 backend.
7688 The default value is 2700.
7689
7690 @item large-function-growth
7691 Specifies maximal growth of large function caused by inlining in percents.
7692 The default value is 100 which limits large function growth to 2.0 times
7693 the original size.
7694
7695 @item large-unit-insns
7696 The limit specifying large translation unit.  Growth caused by inlining of
7697 units larger than this limit is limited by @option{--param inline-unit-growth}.
7698 For small units this might be too tight (consider unit consisting of function A
7699 that is inline and B that just calls A three time.  If B is small relative to
7700 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
7701 large units consisting of small inlineable functions however the overall unit
7702 growth limit is needed to avoid exponential explosion of code size.  Thus for
7703 smaller units, the size is increased to @option{--param large-unit-insns}
7704 before applying @option{--param inline-unit-growth}.  The default is 10000
7705
7706 @item inline-unit-growth
7707 Specifies maximal overall growth of the compilation unit caused by inlining.
7708 The default value is 30 which limits unit growth to 1.3 times the original
7709 size.
7710
7711 @item ipcp-unit-growth
7712 Specifies maximal overall growth of the compilation unit caused by
7713 interprocedural constant propagation.  The default value is 10 which limits
7714 unit growth to 1.1 times the original size.
7715
7716 @item large-stack-frame
7717 The limit specifying large stack frames.  While inlining the algorithm is trying
7718 to not grow past this limit too much.  Default value is 256 bytes.
7719
7720 @item large-stack-frame-growth
7721 Specifies maximal growth of large stack frames caused by inlining in percents.
7722 The default value is 1000 which limits large stack frame growth to 11 times
7723 the original size.
7724
7725 @item max-inline-insns-recursive
7726 @itemx max-inline-insns-recursive-auto
7727 Specifies maximum number of instructions out-of-line copy of self recursive inline
7728 function can grow into by performing recursive inlining.
7729
7730 For functions declared inline @option{--param max-inline-insns-recursive} is
7731 taken into account.  For function not declared inline, recursive inlining
7732 happens only when @option{-finline-functions} (included in @option{-O3}) is
7733 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
7734 default value is 450.
7735
7736 @item max-inline-recursive-depth
7737 @itemx max-inline-recursive-depth-auto
7738 Specifies maximum recursion depth used by the recursive inlining.
7739
7740 For functions declared inline @option{--param max-inline-recursive-depth} is
7741 taken into account.  For function not declared inline, recursive inlining
7742 happens only when @option{-finline-functions} (included in @option{-O3}) is
7743 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
7744 default value is 8.
7745
7746 @item min-inline-recursive-probability
7747 Recursive inlining is profitable only for function having deep recursion
7748 in average and can hurt for function having little recursion depth by
7749 increasing the prologue size or complexity of function body to other
7750 optimizers.
7751
7752 When profile feedback is available (see @option{-fprofile-generate}) the actual
7753 recursion depth can be guessed from probability that function will recurse via
7754 given call expression.  This parameter limits inlining only to call expression
7755 whose probability exceeds given threshold (in percents).  The default value is
7756 10.
7757
7758 @item early-inlining-insns
7759 Specify growth that early inliner can make.  In effect it increases amount of
7760 inlining for code having large abstraction penalty.  The default value is 8.
7761
7762 @item max-early-inliner-iterations
7763 @itemx max-early-inliner-iterations
7764 Limit of iterations of early inliner.  This basically bounds number of nested
7765 indirect calls early inliner can resolve.  Deeper chains are still handled by
7766 late inlining.
7767
7768 @item min-vect-loop-bound
7769 The minimum number of iterations under which a loop will not get vectorized
7770 when @option{-ftree-vectorize} is used.  The number of iterations after
7771 vectorization needs to be greater than the value specified by this option
7772 to allow vectorization.  The default value is 0.
7773
7774 @item max-unrolled-insns
7775 The maximum number of instructions that a loop should have if that loop
7776 is unrolled, and if the loop is unrolled, it determines how many times
7777 the loop code is unrolled.
7778
7779 @item max-average-unrolled-insns
7780 The maximum number of instructions biased by probabilities of their execution
7781 that a loop should have if that loop is unrolled, and if the loop is unrolled,
7782 it determines how many times the loop code is unrolled.
7783
7784 @item max-unroll-times
7785 The maximum number of unrollings of a single loop.
7786
7787 @item max-peeled-insns
7788 The maximum number of instructions that a loop should have if that loop
7789 is peeled, and if the loop is peeled, it determines how many times
7790 the loop code is peeled.
7791
7792 @item max-peel-times
7793 The maximum number of peelings of a single loop.
7794
7795 @item max-completely-peeled-insns
7796 The maximum number of insns of a completely peeled loop.
7797
7798 @item max-completely-peel-times
7799 The maximum number of iterations of a loop to be suitable for complete peeling.
7800
7801 @item max-unswitch-insns
7802 The maximum number of insns of an unswitched loop.
7803
7804 @item max-unswitch-level
7805 The maximum number of branches unswitched in a single loop.
7806
7807 @item lim-expensive
7808 The minimum cost of an expensive expression in the loop invariant motion.
7809
7810 @item iv-consider-all-candidates-bound
7811 Bound on number of candidates for induction variables below that
7812 all candidates are considered for each use in induction variable
7813 optimizations.  Only the most relevant candidates are considered
7814 if there are more candidates, to avoid quadratic time complexity.
7815
7816 @item iv-max-considered-uses
7817 The induction variable optimizations give up on loops that contain more
7818 induction variable uses.
7819
7820 @item iv-always-prune-cand-set-bound
7821 If number of candidates in the set is smaller than this value,
7822 we always try to remove unnecessary ivs from the set during its
7823 optimization when a new iv is added to the set.
7824
7825 @item scev-max-expr-size
7826 Bound on size of expressions used in the scalar evolutions analyzer.
7827 Large expressions slow the analyzer.
7828
7829 @item omega-max-vars
7830 The maximum number of variables in an Omega constraint system.
7831 The default value is 128.
7832
7833 @item omega-max-geqs
7834 The maximum number of inequalities in an Omega constraint system.
7835 The default value is 256.
7836
7837 @item omega-max-eqs
7838 The maximum number of equalities in an Omega constraint system.
7839 The default value is 128.
7840
7841 @item omega-max-wild-cards
7842 The maximum number of wildcard variables that the Omega solver will
7843 be able to insert.  The default value is 18.
7844
7845 @item omega-hash-table-size
7846 The size of the hash table in the Omega solver.  The default value is
7847 550.
7848
7849 @item omega-max-keys
7850 The maximal number of keys used by the Omega solver.  The default
7851 value is 500.
7852
7853 @item omega-eliminate-redundant-constraints
7854 When set to 1, use expensive methods to eliminate all redundant
7855 constraints.  The default value is 0.
7856
7857 @item vect-max-version-for-alignment-checks
7858 The maximum number of runtime checks that can be performed when
7859 doing loop versioning for alignment in the vectorizer.  See option
7860 ftree-vect-loop-version for more information.
7861
7862 @item vect-max-version-for-alias-checks
7863 The maximum number of runtime checks that can be performed when
7864 doing loop versioning for alias in the vectorizer.  See option
7865 ftree-vect-loop-version for more information.
7866
7867 @item max-iterations-to-track
7868
7869 The maximum number of iterations of a loop the brute force algorithm
7870 for analysis of # of iterations of the loop tries to evaluate.
7871
7872 @item hot-bb-count-fraction
7873 Select fraction of the maximal count of repetitions of basic block in program
7874 given basic block needs to have to be considered hot.
7875
7876 @item hot-bb-frequency-fraction
7877 Select fraction of the maximal frequency of executions of basic block in
7878 function given basic block needs to have to be considered hot
7879
7880 @item max-predicted-iterations
7881 The maximum number of loop iterations we predict statically.  This is useful
7882 in cases where function contain single loop with known bound and other loop
7883 with unknown.  We predict the known number of iterations correctly, while
7884 the unknown number of iterations average to roughly 10.  This means that the
7885 loop without bounds would appear artificially cold relative to the other one.
7886
7887 @item align-threshold
7888
7889 Select fraction of the maximal frequency of executions of basic block in
7890 function given basic block will get aligned.
7891
7892 @item align-loop-iterations
7893
7894 A loop expected to iterate at lest the selected number of iterations will get
7895 aligned.
7896
7897 @item tracer-dynamic-coverage
7898 @itemx tracer-dynamic-coverage-feedback
7899
7900 This value is used to limit superblock formation once the given percentage of
7901 executed instructions is covered.  This limits unnecessary code size
7902 expansion.
7903
7904 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7905 feedback is available.  The real profiles (as opposed to statically estimated
7906 ones) are much less balanced allowing the threshold to be larger value.
7907
7908 @item tracer-max-code-growth
7909 Stop tail duplication once code growth has reached given percentage.  This is
7910 rather hokey argument, as most of the duplicates will be eliminated later in
7911 cross jumping, so it may be set to much higher values than is the desired code
7912 growth.
7913
7914 @item tracer-min-branch-ratio
7915
7916 Stop reverse growth when the reverse probability of best edge is less than this
7917 threshold (in percent).
7918
7919 @item tracer-min-branch-ratio
7920 @itemx tracer-min-branch-ratio-feedback
7921
7922 Stop forward growth if the best edge do have probability lower than this
7923 threshold.
7924
7925 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7926 compilation for profile feedback and one for compilation without.  The value
7927 for compilation with profile feedback needs to be more conservative (higher) in
7928 order to make tracer effective.
7929
7930 @item max-cse-path-length
7931
7932 Maximum number of basic blocks on path that cse considers.  The default is 10.
7933
7934 @item max-cse-insns
7935 The maximum instructions CSE process before flushing. The default is 1000.
7936
7937 @item ggc-min-expand
7938
7939 GCC uses a garbage collector to manage its own memory allocation.  This
7940 parameter specifies the minimum percentage by which the garbage
7941 collector's heap should be allowed to expand between collections.
7942 Tuning this may improve compilation speed; it has no effect on code
7943 generation.
7944
7945 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7946 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7947 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7948 GCC is not able to calculate RAM on a particular platform, the lower
7949 bound of 30% is used.  Setting this parameter and
7950 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7951 every opportunity.  This is extremely slow, but can be useful for
7952 debugging.
7953
7954 @item ggc-min-heapsize
7955
7956 Minimum size of the garbage collector's heap before it begins bothering
7957 to collect garbage.  The first collection occurs after the heap expands
7958 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7959 tuning this may improve compilation speed, and has no effect on code
7960 generation.
7961
7962 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7963 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7964 with a lower bound of 4096 (four megabytes) and an upper bound of
7965 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7966 particular platform, the lower bound is used.  Setting this parameter
7967 very large effectively disables garbage collection.  Setting this
7968 parameter and @option{ggc-min-expand} to zero causes a full collection
7969 to occur at every opportunity.
7970
7971 @item max-reload-search-insns
7972 The maximum number of instruction reload should look backward for equivalent
7973 register.  Increasing values mean more aggressive optimization, making the
7974 compile time increase with probably slightly better performance.  The default
7975 value is 100.
7976
7977 @item max-cselib-memory-locations
7978 The maximum number of memory locations cselib should take into account.
7979 Increasing values mean more aggressive optimization, making the compile time
7980 increase with probably slightly better performance.  The default value is 500.
7981
7982 @item reorder-blocks-duplicate
7983 @itemx reorder-blocks-duplicate-feedback
7984
7985 Used by basic block reordering pass to decide whether to use unconditional
7986 branch or duplicate the code on its destination.  Code is duplicated when its
7987 estimated size is smaller than this value multiplied by the estimated size of
7988 unconditional jump in the hot spots of the program.
7989
7990 The @option{reorder-block-duplicate-feedback} is used only when profile
7991 feedback is available and may be set to higher values than
7992 @option{reorder-block-duplicate} since information about the hot spots is more
7993 accurate.
7994
7995 @item max-sched-ready-insns
7996 The maximum number of instructions ready to be issued the scheduler should
7997 consider at any given time during the first scheduling pass.  Increasing
7998 values mean more thorough searches, making the compilation time increase
7999 with probably little benefit.  The default value is 100.
8000
8001 @item max-sched-region-blocks
8002 The maximum number of blocks in a region to be considered for
8003 interblock scheduling.  The default value is 10.
8004
8005 @item max-pipeline-region-blocks
8006 The maximum number of blocks in a region to be considered for
8007 pipelining in the selective scheduler.  The default value is 15.
8008
8009 @item max-sched-region-insns
8010 The maximum number of insns in a region to be considered for
8011 interblock scheduling.  The default value is 100.
8012
8013 @item max-pipeline-region-insns
8014 The maximum number of insns in a region to be considered for
8015 pipelining in the selective scheduler.  The default value is 200.
8016
8017 @item min-spec-prob
8018 The minimum probability (in percents) of reaching a source block
8019 for interblock speculative scheduling.  The default value is 40.
8020
8021 @item max-sched-extend-regions-iters
8022 The maximum number of iterations through CFG to extend regions.
8023 0 - disable region extension,
8024 N - do at most N iterations.
8025 The default value is 0.
8026
8027 @item max-sched-insn-conflict-delay
8028 The maximum conflict delay for an insn to be considered for speculative motion.
8029 The default value is 3.
8030
8031 @item sched-spec-prob-cutoff
8032 The minimal probability of speculation success (in percents), so that
8033 speculative insn will be scheduled.
8034 The default value is 40.
8035
8036 @item sched-mem-true-dep-cost
8037 Minimal distance (in CPU cycles) between store and load targeting same
8038 memory locations.  The default value is 1.
8039
8040 @item selsched-max-lookahead
8041 The maximum size of the lookahead window of selective scheduling.  It is a
8042 depth of search for available instructions.
8043 The default value is 50.
8044
8045 @item selsched-max-sched-times
8046 The maximum number of times that an instruction will be scheduled during
8047 selective scheduling.  This is the limit on the number of iterations
8048 through which the instruction may be pipelined.  The default value is 2.
8049
8050 @item selsched-max-insns-to-rename
8051 The maximum number of best instructions in the ready list that are considered
8052 for renaming in the selective scheduler.  The default value is 2.
8053
8054 @item max-last-value-rtl
8055 The maximum size measured as number of RTLs that can be recorded in an expression
8056 in combiner for a pseudo register as last known value of that register.  The default
8057 is 10000.
8058
8059 @item integer-share-limit
8060 Small integer constants can use a shared data structure, reducing the
8061 compiler's memory usage and increasing its speed.  This sets the maximum
8062 value of a shared integer constant.  The default value is 256.
8063
8064 @item min-virtual-mappings
8065 Specifies the minimum number of virtual mappings in the incremental
8066 SSA updater that should be registered to trigger the virtual mappings
8067 heuristic defined by virtual-mappings-ratio.  The default value is
8068 100.
8069
8070 @item virtual-mappings-ratio
8071 If the number of virtual mappings is virtual-mappings-ratio bigger
8072 than the number of virtual symbols to be updated, then the incremental
8073 SSA updater switches to a full update for those symbols.  The default
8074 ratio is 3.
8075
8076 @item ssp-buffer-size
8077 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8078 protection when @option{-fstack-protection} is used.
8079
8080 @item max-jump-thread-duplication-stmts
8081 Maximum number of statements allowed in a block that needs to be
8082 duplicated when threading jumps.
8083
8084 @item max-fields-for-field-sensitive
8085 Maximum number of fields in a structure we will treat in
8086 a field sensitive manner during pointer analysis.  The default is zero
8087 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8088
8089 @item prefetch-latency
8090 Estimate on average number of instructions that are executed before
8091 prefetch finishes.  The distance we prefetch ahead is proportional
8092 to this constant.  Increasing this number may also lead to less
8093 streams being prefetched (see @option{simultaneous-prefetches}).
8094
8095 @item simultaneous-prefetches
8096 Maximum number of prefetches that can run at the same time.
8097
8098 @item l1-cache-line-size
8099 The size of cache line in L1 cache, in bytes.
8100
8101 @item l1-cache-size
8102 The size of L1 cache, in kilobytes.
8103
8104 @item l2-cache-size
8105 The size of L2 cache, in kilobytes.
8106
8107 @item min-insn-to-prefetch-ratio
8108 The minimum ratio between the number of instructions and the
8109 number of prefetches to enable prefetching in a loop with an
8110 unknown trip count.
8111
8112 @item prefetch-min-insn-to-mem-ratio
8113 The minimum ratio between the number of instructions and the
8114 number of memory references to enable prefetching in a loop.
8115
8116 @item use-canonical-types
8117 Whether the compiler should use the ``canonical'' type system.  By
8118 default, this should always be 1, which uses a more efficient internal
8119 mechanism for comparing types in C++ and Objective-C++.  However, if
8120 bugs in the canonical type system are causing compilation failures,
8121 set this value to 0 to disable canonical types.
8122
8123 @item switch-conversion-max-branch-ratio
8124 Switch initialization conversion will refuse to create arrays that are
8125 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8126 branches in the switch.
8127
8128 @item max-partial-antic-length
8129 Maximum length of the partial antic set computed during the tree
8130 partial redundancy elimination optimization (@option{-ftree-pre}) when
8131 optimizing at @option{-O3} and above.  For some sorts of source code
8132 the enhanced partial redundancy elimination optimization can run away,
8133 consuming all of the memory available on the host machine.  This
8134 parameter sets a limit on the length of the sets that are computed,
8135 which prevents the runaway behavior.  Setting a value of 0 for
8136 this parameter will allow an unlimited set length.
8137
8138 @item sccvn-max-scc-size
8139 Maximum size of a strongly connected component (SCC) during SCCVN
8140 processing.  If this limit is hit, SCCVN processing for the whole
8141 function will not be done and optimizations depending on it will
8142 be disabled.  The default maximum SCC size is 10000.
8143
8144 @item ira-max-loops-num
8145 IRA uses a regional register allocation by default.  If a function
8146 contains loops more than number given by the parameter, only at most
8147 given number of the most frequently executed loops will form regions
8148 for the regional register allocation.  The default value of the
8149 parameter is 100.
8150
8151 @item ira-max-conflict-table-size
8152 Although IRA uses a sophisticated algorithm of compression conflict
8153 table, the table can be still big for huge functions.  If the conflict
8154 table for a function could be more than size in MB given by the
8155 parameter, the conflict table is not built and faster, simpler, and
8156 lower quality register allocation algorithm will be used.  The
8157 algorithm do not use pseudo-register conflicts.  The default value of
8158 the parameter is 2000.
8159
8160 @item loop-invariant-max-bbs-in-loop
8161 Loop invariant motion can be very expensive, both in compile time and
8162 in amount of needed compile time memory, with very large loops.  Loops
8163 with more basic blocks than this parameter won't have loop invariant
8164 motion optimization performed on them.  The default value of the
8165 parameter is 1000 for -O1 and 10000 for -O2 and above.
8166
8167 @item min-nondebug-insn-uid
8168 Use uids starting at this parameter for nondebug insns.  The range below
8169 the parameter is reserved exclusively for debug insns created by
8170 @option{-fvar-tracking-assignments}, but debug insns may get
8171 (non-overlapping) uids above it if the reserved range is exhausted.
8172
8173 @item ipa-sra-ptr-growth-factor
8174 IPA-SRA will replace a pointer to an aggregate with one or more new
8175 parameters only when their cumulative size is less or equal to
8176 @option{ipa-sra-ptr-growth-factor} times the size of the original
8177 pointer parameter.
8178
8179 @end table
8180 @end table
8181
8182 @node Preprocessor Options
8183 @section Options Controlling the Preprocessor
8184 @cindex preprocessor options
8185 @cindex options, preprocessor
8186
8187 These options control the C preprocessor, which is run on each C source
8188 file before actual compilation.
8189
8190 If you use the @option{-E} option, nothing is done except preprocessing.
8191 Some of these options make sense only together with @option{-E} because
8192 they cause the preprocessor output to be unsuitable for actual
8193 compilation.
8194
8195 @table @gcctabopt
8196 @item -Wp,@var{option}
8197 @opindex Wp
8198 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8199 and pass @var{option} directly through to the preprocessor.  If
8200 @var{option} contains commas, it is split into multiple options at the
8201 commas.  However, many options are modified, translated or interpreted
8202 by the compiler driver before being passed to the preprocessor, and
8203 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8204 interface is undocumented and subject to change, so whenever possible
8205 you should avoid using @option{-Wp} and let the driver handle the
8206 options instead.
8207
8208 @item -Xpreprocessor @var{option}
8209 @opindex Xpreprocessor
8210 Pass @var{option} as an option to the preprocessor.  You can use this to
8211 supply system-specific preprocessor options which GCC does not know how to
8212 recognize.
8213
8214 If you want to pass an option that takes an argument, you must use
8215 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8216 @end table
8217
8218 @include cppopts.texi
8219
8220 @node Assembler Options
8221 @section Passing Options to the Assembler
8222
8223 @c prevent bad page break with this line
8224 You can pass options to the assembler.
8225
8226 @table @gcctabopt
8227 @item -Wa,@var{option}
8228 @opindex Wa
8229 Pass @var{option} as an option to the assembler.  If @var{option}
8230 contains commas, it is split into multiple options at the commas.
8231
8232 @item -Xassembler @var{option}
8233 @opindex Xassembler
8234 Pass @var{option} as an option to the assembler.  You can use this to
8235 supply system-specific assembler options which GCC does not know how to
8236 recognize.
8237
8238 If you want to pass an option that takes an argument, you must use
8239 @option{-Xassembler} twice, once for the option and once for the argument.
8240
8241 @end table
8242
8243 @node Link Options
8244 @section Options for Linking
8245 @cindex link options
8246 @cindex options, linking
8247
8248 These options come into play when the compiler links object files into
8249 an executable output file.  They are meaningless if the compiler is
8250 not doing a link step.
8251
8252 @table @gcctabopt
8253 @cindex file names
8254 @item @var{object-file-name}
8255 A file name that does not end in a special recognized suffix is
8256 considered to name an object file or library.  (Object files are
8257 distinguished from libraries by the linker according to the file
8258 contents.)  If linking is done, these object files are used as input
8259 to the linker.
8260
8261 @item -c
8262 @itemx -S
8263 @itemx -E
8264 @opindex c
8265 @opindex S
8266 @opindex E
8267 If any of these options is used, then the linker is not run, and
8268 object file names should not be used as arguments.  @xref{Overall
8269 Options}.
8270
8271 @cindex Libraries
8272 @item -l@var{library}
8273 @itemx -l @var{library}
8274 @opindex l
8275 Search the library named @var{library} when linking.  (The second
8276 alternative with the library as a separate argument is only for
8277 POSIX compliance and is not recommended.)
8278
8279 It makes a difference where in the command you write this option; the
8280 linker searches and processes libraries and object files in the order they
8281 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8282 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8283 to functions in @samp{z}, those functions may not be loaded.
8284
8285 The linker searches a standard list of directories for the library,
8286 which is actually a file named @file{lib@var{library}.a}.  The linker
8287 then uses this file as if it had been specified precisely by name.
8288
8289 The directories searched include several standard system directories
8290 plus any that you specify with @option{-L}.
8291
8292 Normally the files found this way are library files---archive files
8293 whose members are object files.  The linker handles an archive file by
8294 scanning through it for members which define symbols that have so far
8295 been referenced but not defined.  But if the file that is found is an
8296 ordinary object file, it is linked in the usual fashion.  The only
8297 difference between using an @option{-l} option and specifying a file name
8298 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8299 and searches several directories.
8300
8301 @item -lobjc
8302 @opindex lobjc
8303 You need this special case of the @option{-l} option in order to
8304 link an Objective-C or Objective-C++ program.
8305
8306 @item -nostartfiles
8307 @opindex nostartfiles
8308 Do not use the standard system startup files when linking.
8309 The standard system libraries are used normally, unless @option{-nostdlib}
8310 or @option{-nodefaultlibs} is used.
8311
8312 @item -nodefaultlibs
8313 @opindex nodefaultlibs
8314 Do not use the standard system libraries when linking.
8315 Only the libraries you specify will be passed to the linker, options
8316 specifying linkage of the system libraries, such as @code{-static-libgcc}
8317 or @code{-shared-libgcc}, will be ignored.
8318 The standard startup files are used normally, unless @option{-nostartfiles}
8319 is used.  The compiler may generate calls to @code{memcmp},
8320 @code{memset}, @code{memcpy} and @code{memmove}.
8321 These entries are usually resolved by entries in
8322 libc.  These entry points should be supplied through some other
8323 mechanism when this option is specified.
8324
8325 @item -nostdlib
8326 @opindex nostdlib
8327 Do not use the standard system startup files or libraries when linking.
8328 No startup files and only the libraries you specify will be passed to
8329 the linker, options specifying linkage of the system libraries, such as
8330 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8331 The compiler may generate calls to @code{memcmp}, @code{memset},
8332 @code{memcpy} and @code{memmove}.
8333 These entries are usually resolved by entries in
8334 libc.  These entry points should be supplied through some other
8335 mechanism when this option is specified.
8336
8337 @cindex @option{-lgcc}, use with @option{-nostdlib}
8338 @cindex @option{-nostdlib} and unresolved references
8339 @cindex unresolved references and @option{-nostdlib}
8340 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8341 @cindex @option{-nodefaultlibs} and unresolved references
8342 @cindex unresolved references and @option{-nodefaultlibs}
8343 One of the standard libraries bypassed by @option{-nostdlib} and
8344 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8345 that GCC uses to overcome shortcomings of particular machines, or special
8346 needs for some languages.
8347 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8348 Collection (GCC) Internals},
8349 for more discussion of @file{libgcc.a}.)
8350 In most cases, you need @file{libgcc.a} even when you want to avoid
8351 other standard libraries.  In other words, when you specify @option{-nostdlib}
8352 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8353 This ensures that you have no unresolved references to internal GCC
8354 library subroutines.  (For example, @samp{__main}, used to ensure C++
8355 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8356 GNU Compiler Collection (GCC) Internals}.)
8357
8358 @item -pie
8359 @opindex pie
8360 Produce a position independent executable on targets which support it.
8361 For predictable results, you must also specify the same set of options
8362 that were used to generate code (@option{-fpie}, @option{-fPIE},
8363 or model suboptions) when you specify this option.
8364
8365 @item -rdynamic
8366 @opindex rdynamic
8367 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8368 that support it. This instructs the linker to add all symbols, not
8369 only used ones, to the dynamic symbol table. This option is needed
8370 for some uses of @code{dlopen} or to allow obtaining backtraces
8371 from within a program.
8372
8373 @item -s
8374 @opindex s
8375 Remove all symbol table and relocation information from the executable.
8376
8377 @item -static
8378 @opindex static
8379 On systems that support dynamic linking, this prevents linking with the shared
8380 libraries.  On other systems, this option has no effect.
8381
8382 @item -shared
8383 @opindex shared
8384 Produce a shared object which can then be linked with other objects to
8385 form an executable.  Not all systems support this option.  For predictable
8386 results, you must also specify the same set of options that were used to
8387 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8388 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8389 needs to build supplementary stub code for constructors to work.  On
8390 multi-libbed systems, @samp{gcc -shared} must select the correct support
8391 libraries to link against.  Failing to supply the correct flags may lead
8392 to subtle defects.  Supplying them in cases where they are not necessary
8393 is innocuous.}
8394
8395 @item -shared-libgcc
8396 @itemx -static-libgcc
8397 @opindex shared-libgcc
8398 @opindex static-libgcc
8399 On systems that provide @file{libgcc} as a shared library, these options
8400 force the use of either the shared or static version respectively.
8401 If no shared version of @file{libgcc} was built when the compiler was
8402 configured, these options have no effect.
8403
8404 There are several situations in which an application should use the
8405 shared @file{libgcc} instead of the static version.  The most common
8406 of these is when the application wishes to throw and catch exceptions
8407 across different shared libraries.  In that case, each of the libraries
8408 as well as the application itself should use the shared @file{libgcc}.
8409
8410 Therefore, the G++ and GCJ drivers automatically add
8411 @option{-shared-libgcc} whenever you build a shared library or a main
8412 executable, because C++ and Java programs typically use exceptions, so
8413 this is the right thing to do.
8414
8415 If, instead, you use the GCC driver to create shared libraries, you may
8416 find that they will not always be linked with the shared @file{libgcc}.
8417 If GCC finds, at its configuration time, that you have a non-GNU linker
8418 or a GNU linker that does not support option @option{--eh-frame-hdr},
8419 it will link the shared version of @file{libgcc} into shared libraries
8420 by default.  Otherwise, it will take advantage of the linker and optimize
8421 away the linking with the shared version of @file{libgcc}, linking with
8422 the static version of libgcc by default.  This allows exceptions to
8423 propagate through such shared libraries, without incurring relocation
8424 costs at library load time.
8425
8426 However, if a library or main executable is supposed to throw or catch
8427 exceptions, you must link it using the G++ or GCJ driver, as appropriate
8428 for the languages used in the program, or using the option
8429 @option{-shared-libgcc}, such that it is linked with the shared
8430 @file{libgcc}.
8431
8432 @item -static-libstdc++
8433 When the @command{g++} program is used to link a C++ program, it will
8434 normally automatically link against @option{libstdc++}.  If
8435 @file{libstdc++} is available as a shared library, and the
8436 @option{-static} option is not used, then this will link against the
8437 shared version of @file{libstdc++}.  That is normally fine.  However, it
8438 is sometimes useful to freeze the version of @file{libstdc++} used by
8439 the program without going all the way to a fully static link.  The
8440 @option{-static-libstdc++} option directs the @command{g++} driver to
8441 link @file{libstdc++} statically, without necessarily linking other
8442 libraries statically.
8443
8444 @item -symbolic
8445 @opindex symbolic
8446 Bind references to global symbols when building a shared object.  Warn
8447 about any unresolved references (unless overridden by the link editor
8448 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8449 this option.
8450
8451 @item -T @var{script}
8452 @opindex T
8453 @cindex linker script
8454 Use @var{script} as the linker script.  This option is supported by most
8455 systems using the GNU linker.  On some targets, such as bare-board
8456 targets without an operating system, the @option{-T} option may be required
8457 when linking to avoid references to undefined symbols.
8458
8459 @item -Xlinker @var{option}
8460 @opindex Xlinker
8461 Pass @var{option} as an option to the linker.  You can use this to
8462 supply system-specific linker options which GCC does not know how to
8463 recognize.
8464
8465 If you want to pass an option that takes a separate argument, you must use
8466 @option{-Xlinker} twice, once for the option and once for the argument.
8467 For example, to pass @option{-assert definitions}, you must write
8468 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8469 @option{-Xlinker "-assert definitions"}, because this passes the entire
8470 string as a single argument, which is not what the linker expects.
8471
8472 When using the GNU linker, it is usually more convenient to pass
8473 arguments to linker options using the @option{@var{option}=@var{value}}
8474 syntax than as separate arguments.  For example, you can specify
8475 @samp{-Xlinker -Map=output.map} rather than
8476 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
8477 this syntax for command-line options.
8478
8479 @item -Wl,@var{option}
8480 @opindex Wl
8481 Pass @var{option} as an option to the linker.  If @var{option} contains
8482 commas, it is split into multiple options at the commas.  You can use this
8483 syntax to pass an argument to the option.
8484 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
8485 linker.  When using the GNU linker, you can also get the same effect with
8486 @samp{-Wl,-Map=output.map}.
8487
8488 @item -u @var{symbol}
8489 @opindex u
8490 Pretend the symbol @var{symbol} is undefined, to force linking of
8491 library modules to define it.  You can use @option{-u} multiple times with
8492 different symbols to force loading of additional library modules.
8493 @end table
8494
8495 @node Directory Options
8496 @section Options for Directory Search
8497 @cindex directory options
8498 @cindex options, directory search
8499 @cindex search path
8500
8501 These options specify directories to search for header files, for
8502 libraries and for parts of the compiler:
8503
8504 @table @gcctabopt
8505 @item -I@var{dir}
8506 @opindex I
8507 Add the directory @var{dir} to the head of the list of directories to be
8508 searched for header files.  This can be used to override a system header
8509 file, substituting your own version, since these directories are
8510 searched before the system header file directories.  However, you should
8511 not use this option to add directories that contain vendor-supplied
8512 system header files (use @option{-isystem} for that).  If you use more than
8513 one @option{-I} option, the directories are scanned in left-to-right
8514 order; the standard system directories come after.
8515
8516 If a standard system include directory, or a directory specified with
8517 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8518 option will be ignored.  The directory will still be searched but as a
8519 system directory at its normal position in the system include chain.
8520 This is to ensure that GCC's procedure to fix buggy system headers and
8521 the ordering for the include_next directive are not inadvertently changed.
8522 If you really need to change the search order for system directories,
8523 use the @option{-nostdinc} and/or @option{-isystem} options.
8524
8525 @item -iquote@var{dir}
8526 @opindex iquote
8527 Add the directory @var{dir} to the head of the list of directories to
8528 be searched for header files only for the case of @samp{#include
8529 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8530 otherwise just like @option{-I}.
8531
8532 @item -L@var{dir}
8533 @opindex L
8534 Add directory @var{dir} to the list of directories to be searched
8535 for @option{-l}.
8536
8537 @item -B@var{prefix}
8538 @opindex B
8539 This option specifies where to find the executables, libraries,
8540 include files, and data files of the compiler itself.
8541
8542 The compiler driver program runs one or more of the subprograms
8543 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8544 @var{prefix} as a prefix for each program it tries to run, both with and
8545 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
8546
8547 For each subprogram to be run, the compiler driver first tries the
8548 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
8549 was not specified, the driver tries two standard prefixes, which are
8550 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
8551 those results in a file name that is found, the unmodified program
8552 name is searched for using the directories specified in your
8553 @env{PATH} environment variable.
8554
8555 The compiler will check to see if the path provided by the @option{-B}
8556 refers to a directory, and if necessary it will add a directory
8557 separator character at the end of the path.
8558
8559 @option{-B} prefixes that effectively specify directory names also apply
8560 to libraries in the linker, because the compiler translates these
8561 options into @option{-L} options for the linker.  They also apply to
8562 includes files in the preprocessor, because the compiler translates these
8563 options into @option{-isystem} options for the preprocessor.  In this case,
8564 the compiler appends @samp{include} to the prefix.
8565
8566 The run-time support file @file{libgcc.a} can also be searched for using
8567 the @option{-B} prefix, if needed.  If it is not found there, the two
8568 standard prefixes above are tried, and that is all.  The file is left
8569 out of the link if it is not found by those means.
8570
8571 Another way to specify a prefix much like the @option{-B} prefix is to use
8572 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
8573 Variables}.
8574
8575 As a special kludge, if the path provided by @option{-B} is
8576 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
8577 9, then it will be replaced by @file{[dir/]include}.  This is to help
8578 with boot-strapping the compiler.
8579
8580 @item -specs=@var{file}
8581 @opindex specs
8582 Process @var{file} after the compiler reads in the standard @file{specs}
8583 file, in order to override the defaults that the @file{gcc} driver
8584 program uses when determining what switches to pass to @file{cc1},
8585 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
8586 @option{-specs=@var{file}} can be specified on the command line, and they
8587 are processed in order, from left to right.
8588
8589 @item --sysroot=@var{dir}
8590 @opindex sysroot
8591 Use @var{dir} as the logical root directory for headers and libraries.
8592 For example, if the compiler would normally search for headers in
8593 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
8594 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
8595
8596 If you use both this option and the @option{-isysroot} option, then
8597 the @option{--sysroot} option will apply to libraries, but the
8598 @option{-isysroot} option will apply to header files.
8599
8600 The GNU linker (beginning with version 2.16) has the necessary support
8601 for this option.  If your linker does not support this option, the
8602 header file aspect of @option{--sysroot} will still work, but the
8603 library aspect will not.
8604
8605 @item -I-
8606 @opindex I-
8607 This option has been deprecated.  Please use @option{-iquote} instead for
8608 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
8609 Any directories you specify with @option{-I} options before the @option{-I-}
8610 option are searched only for the case of @samp{#include "@var{file}"};
8611 they are not searched for @samp{#include <@var{file}>}.
8612
8613 If additional directories are specified with @option{-I} options after
8614 the @option{-I-}, these directories are searched for all @samp{#include}
8615 directives.  (Ordinarily @emph{all} @option{-I} directories are used
8616 this way.)
8617
8618 In addition, the @option{-I-} option inhibits the use of the current
8619 directory (where the current input file came from) as the first search
8620 directory for @samp{#include "@var{file}"}.  There is no way to
8621 override this effect of @option{-I-}.  With @option{-I.} you can specify
8622 searching the directory which was current when the compiler was
8623 invoked.  That is not exactly the same as what the preprocessor does
8624 by default, but it is often satisfactory.
8625
8626 @option{-I-} does not inhibit the use of the standard system directories
8627 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
8628 independent.
8629 @end table
8630
8631 @c man end
8632
8633 @node Spec Files
8634 @section Specifying subprocesses and the switches to pass to them
8635 @cindex Spec Files
8636
8637 @command{gcc} is a driver program.  It performs its job by invoking a
8638 sequence of other programs to do the work of compiling, assembling and
8639 linking.  GCC interprets its command-line parameters and uses these to
8640 deduce which programs it should invoke, and which command-line options
8641 it ought to place on their command lines.  This behavior is controlled
8642 by @dfn{spec strings}.  In most cases there is one spec string for each
8643 program that GCC can invoke, but a few programs have multiple spec
8644 strings to control their behavior.  The spec strings built into GCC can
8645 be overridden by using the @option{-specs=} command-line switch to specify
8646 a spec file.
8647
8648 @dfn{Spec files} are plaintext files that are used to construct spec
8649 strings.  They consist of a sequence of directives separated by blank
8650 lines.  The type of directive is determined by the first non-whitespace
8651 character on the line and it can be one of the following:
8652
8653 @table @code
8654 @item %@var{command}
8655 Issues a @var{command} to the spec file processor.  The commands that can
8656 appear here are:
8657
8658 @table @code
8659 @item %include <@var{file}>
8660 @cindex %include
8661 Search for @var{file} and insert its text at the current point in the
8662 specs file.
8663
8664 @item %include_noerr <@var{file}>
8665 @cindex %include_noerr
8666 Just like @samp{%include}, but do not generate an error message if the include
8667 file cannot be found.
8668
8669 @item %rename @var{old_name} @var{new_name}
8670 @cindex %rename
8671 Rename the spec string @var{old_name} to @var{new_name}.
8672
8673 @end table
8674
8675 @item *[@var{spec_name}]:
8676 This tells the compiler to create, override or delete the named spec
8677 string.  All lines after this directive up to the next directive or
8678 blank line are considered to be the text for the spec string.  If this
8679 results in an empty string then the spec will be deleted.  (Or, if the
8680 spec did not exist, then nothing will happened.)  Otherwise, if the spec
8681 does not currently exist a new spec will be created.  If the spec does
8682 exist then its contents will be overridden by the text of this
8683 directive, unless the first character of that text is the @samp{+}
8684 character, in which case the text will be appended to the spec.
8685
8686 @item [@var{suffix}]:
8687 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
8688 and up to the next directive or blank line are considered to make up the
8689 spec string for the indicated suffix.  When the compiler encounters an
8690 input file with the named suffix, it will processes the spec string in
8691 order to work out how to compile that file.  For example:
8692
8693 @smallexample
8694 .ZZ:
8695 z-compile -input %i
8696 @end smallexample
8697
8698 This says that any input file whose name ends in @samp{.ZZ} should be
8699 passed to the program @samp{z-compile}, which should be invoked with the
8700 command-line switch @option{-input} and with the result of performing the
8701 @samp{%i} substitution.  (See below.)
8702
8703 As an alternative to providing a spec string, the text that follows a
8704 suffix directive can be one of the following:
8705
8706 @table @code
8707 @item @@@var{language}
8708 This says that the suffix is an alias for a known @var{language}.  This is
8709 similar to using the @option{-x} command-line switch to GCC to specify a
8710 language explicitly.  For example:
8711
8712 @smallexample
8713 .ZZ:
8714 @@c++
8715 @end smallexample
8716
8717 Says that .ZZ files are, in fact, C++ source files.
8718
8719 @item #@var{name}
8720 This causes an error messages saying:
8721
8722 @smallexample
8723 @var{name} compiler not installed on this system.
8724 @end smallexample
8725 @end table
8726
8727 GCC already has an extensive list of suffixes built into it.
8728 This directive will add an entry to the end of the list of suffixes, but
8729 since the list is searched from the end backwards, it is effectively
8730 possible to override earlier entries using this technique.
8731
8732 @end table
8733
8734 GCC has the following spec strings built into it.  Spec files can
8735 override these strings or create their own.  Note that individual
8736 targets can also add their own spec strings to this list.
8737
8738 @smallexample
8739 asm          Options to pass to the assembler
8740 asm_final    Options to pass to the assembler post-processor
8741 cpp          Options to pass to the C preprocessor
8742 cc1          Options to pass to the C compiler
8743 cc1plus      Options to pass to the C++ compiler
8744 endfile      Object files to include at the end of the link
8745 link         Options to pass to the linker
8746 lib          Libraries to include on the command line to the linker
8747 libgcc       Decides which GCC support library to pass to the linker
8748 linker       Sets the name of the linker
8749 predefines   Defines to be passed to the C preprocessor
8750 signed_char  Defines to pass to CPP to say whether @code{char} is signed
8751              by default
8752 startfile    Object files to include at the start of the link
8753 @end smallexample
8754
8755 Here is a small example of a spec file:
8756
8757 @smallexample
8758 %rename lib                 old_lib
8759
8760 *lib:
8761 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
8762 @end smallexample
8763
8764 This example renames the spec called @samp{lib} to @samp{old_lib} and
8765 then overrides the previous definition of @samp{lib} with a new one.
8766 The new definition adds in some extra command-line options before
8767 including the text of the old definition.
8768
8769 @dfn{Spec strings} are a list of command-line options to be passed to their
8770 corresponding program.  In addition, the spec strings can contain
8771 @samp{%}-prefixed sequences to substitute variable text or to
8772 conditionally insert text into the command line.  Using these constructs
8773 it is possible to generate quite complex command lines.
8774
8775 Here is a table of all defined @samp{%}-sequences for spec
8776 strings.  Note that spaces are not generated automatically around the
8777 results of expanding these sequences.  Therefore you can concatenate them
8778 together or combine them with constant text in a single argument.
8779
8780 @table @code
8781 @item %%
8782 Substitute one @samp{%} into the program name or argument.
8783
8784 @item %i
8785 Substitute the name of the input file being processed.
8786
8787 @item %b
8788 Substitute the basename of the input file being processed.
8789 This is the substring up to (and not including) the last period
8790 and not including the directory.
8791
8792 @item %B
8793 This is the same as @samp{%b}, but include the file suffix (text after
8794 the last period).
8795
8796 @item %d
8797 Marks the argument containing or following the @samp{%d} as a
8798 temporary file name, so that that file will be deleted if GCC exits
8799 successfully.  Unlike @samp{%g}, this contributes no text to the
8800 argument.
8801
8802 @item %g@var{suffix}
8803 Substitute a file name that has suffix @var{suffix} and is chosen
8804 once per compilation, and mark the argument in the same way as
8805 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
8806 name is now chosen in a way that is hard to predict even when previously
8807 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
8808 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
8809 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
8810 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
8811 was simply substituted with a file name chosen once per compilation,
8812 without regard to any appended suffix (which was therefore treated
8813 just like ordinary text), making such attacks more likely to succeed.
8814
8815 @item %u@var{suffix}
8816 Like @samp{%g}, but generates a new temporary file name even if
8817 @samp{%u@var{suffix}} was already seen.
8818
8819 @item %U@var{suffix}
8820 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
8821 new one if there is no such last file name.  In the absence of any
8822 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
8823 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
8824 would involve the generation of two distinct file names, one
8825 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
8826 simply substituted with a file name chosen for the previous @samp{%u},
8827 without regard to any appended suffix.
8828
8829 @item %j@var{suffix}
8830 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
8831 writable, and if save-temps is off; otherwise, substitute the name
8832 of a temporary file, just like @samp{%u}.  This temporary file is not
8833 meant for communication between processes, but rather as a junk
8834 disposal mechanism.
8835
8836 @item %|@var{suffix}
8837 @itemx %m@var{suffix}
8838 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
8839 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
8840 all.  These are the two most common ways to instruct a program that it
8841 should read from standard input or write to standard output.  If you
8842 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
8843 construct: see for example @file{f/lang-specs.h}.
8844
8845 @item %.@var{SUFFIX}
8846 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
8847 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
8848 terminated by the next space or %.
8849
8850 @item %w
8851 Marks the argument containing or following the @samp{%w} as the
8852 designated output file of this compilation.  This puts the argument
8853 into the sequence of arguments that @samp{%o} will substitute later.
8854
8855 @item %o
8856 Substitutes the names of all the output files, with spaces
8857 automatically placed around them.  You should write spaces
8858 around the @samp{%o} as well or the results are undefined.
8859 @samp{%o} is for use in the specs for running the linker.
8860 Input files whose names have no recognized suffix are not compiled
8861 at all, but they are included among the output files, so they will
8862 be linked.
8863
8864 @item %O
8865 Substitutes the suffix for object files.  Note that this is
8866 handled specially when it immediately follows @samp{%g, %u, or %U},
8867 because of the need for those to form complete file names.  The
8868 handling is such that @samp{%O} is treated exactly as if it had already
8869 been substituted, except that @samp{%g, %u, and %U} do not currently
8870 support additional @var{suffix} characters following @samp{%O} as they would
8871 following, for example, @samp{.o}.
8872
8873 @item %p
8874 Substitutes the standard macro predefinitions for the
8875 current target machine.  Use this when running @code{cpp}.
8876
8877 @item %P
8878 Like @samp{%p}, but puts @samp{__} before and after the name of each
8879 predefined macro, except for macros that start with @samp{__} or with
8880 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8881 C@.
8882
8883 @item %I
8884 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8885 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8886 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8887 and @option{-imultilib} as necessary.
8888
8889 @item %s
8890 Current argument is the name of a library or startup file of some sort.
8891 Search for that file in a standard list of directories and substitute
8892 the full name found.  The current working directory is included in the
8893 list of directories scanned.
8894
8895 @item %T
8896 Current argument is the name of a linker script.  Search for that file
8897 in the current list of directories to scan for libraries. If the file
8898 is located insert a @option{--script} option into the command line
8899 followed by the full path name found.  If the file is not found then
8900 generate an error message.  Note: the current working directory is not
8901 searched.
8902
8903 @item %e@var{str}
8904 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8905 Use this when inconsistent options are detected.
8906
8907 @item %(@var{name})
8908 Substitute the contents of spec string @var{name} at this point.
8909
8910 @item %[@var{name}]
8911 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8912
8913 @item %x@{@var{option}@}
8914 Accumulate an option for @samp{%X}.
8915
8916 @item %X
8917 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8918 spec string.
8919
8920 @item %Y
8921 Output the accumulated assembler options specified by @option{-Wa}.
8922
8923 @item %Z
8924 Output the accumulated preprocessor options specified by @option{-Wp}.
8925
8926 @item %a
8927 Process the @code{asm} spec.  This is used to compute the
8928 switches to be passed to the assembler.
8929
8930 @item %A
8931 Process the @code{asm_final} spec.  This is a spec string for
8932 passing switches to an assembler post-processor, if such a program is
8933 needed.
8934
8935 @item %l
8936 Process the @code{link} spec.  This is the spec for computing the
8937 command line passed to the linker.  Typically it will make use of the
8938 @samp{%L %G %S %D and %E} sequences.
8939
8940 @item %D
8941 Dump out a @option{-L} option for each directory that GCC believes might
8942 contain startup files.  If the target supports multilibs then the
8943 current multilib directory will be prepended to each of these paths.
8944
8945 @item %L
8946 Process the @code{lib} spec.  This is a spec string for deciding which
8947 libraries should be included on the command line to the linker.
8948
8949 @item %G
8950 Process the @code{libgcc} spec.  This is a spec string for deciding
8951 which GCC support library should be included on the command line to the linker.
8952
8953 @item %S
8954 Process the @code{startfile} spec.  This is a spec for deciding which
8955 object files should be the first ones passed to the linker.  Typically
8956 this might be a file named @file{crt0.o}.
8957
8958 @item %E
8959 Process the @code{endfile} spec.  This is a spec string that specifies
8960 the last object files that will be passed to the linker.
8961
8962 @item %C
8963 Process the @code{cpp} spec.  This is used to construct the arguments
8964 to be passed to the C preprocessor.
8965
8966 @item %1
8967 Process the @code{cc1} spec.  This is used to construct the options to be
8968 passed to the actual C compiler (@samp{cc1}).
8969
8970 @item %2
8971 Process the @code{cc1plus} spec.  This is used to construct the options to be
8972 passed to the actual C++ compiler (@samp{cc1plus}).
8973
8974 @item %*
8975 Substitute the variable part of a matched option.  See below.
8976 Note that each comma in the substituted string is replaced by
8977 a single space.
8978
8979 @item %<@code{S}
8980 Remove all occurrences of @code{-S} from the command line.  Note---this
8981 command is position dependent.  @samp{%} commands in the spec string
8982 before this one will see @code{-S}, @samp{%} commands in the spec string
8983 after this one will not.
8984
8985 @item %:@var{function}(@var{args})
8986 Call the named function @var{function}, passing it @var{args}.
8987 @var{args} is first processed as a nested spec string, then split
8988 into an argument vector in the usual fashion.  The function returns
8989 a string which is processed as if it had appeared literally as part
8990 of the current spec.
8991
8992 The following built-in spec functions are provided:
8993
8994 @table @code
8995 @item @code{getenv}
8996 The @code{getenv} spec function takes two arguments: an environment
8997 variable name and a string.  If the environment variable is not
8998 defined, a fatal error is issued.  Otherwise, the return value is the
8999 value of the environment variable concatenated with the string.  For
9000 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9001
9002 @smallexample
9003 %:getenv(TOPDIR /include)
9004 @end smallexample
9005
9006 expands to @file{/path/to/top/include}.
9007
9008 @item @code{if-exists}
9009 The @code{if-exists} spec function takes one argument, an absolute
9010 pathname to a file.  If the file exists, @code{if-exists} returns the
9011 pathname.  Here is a small example of its usage:
9012
9013 @smallexample
9014 *startfile:
9015 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9016 @end smallexample
9017
9018 @item @code{if-exists-else}
9019 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9020 spec function, except that it takes two arguments.  The first argument is
9021 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9022 returns the pathname.  If it does not exist, it returns the second argument.
9023 This way, @code{if-exists-else} can be used to select one file or another,
9024 based on the existence of the first.  Here is a small example of its usage:
9025
9026 @smallexample
9027 *startfile:
9028 crt0%O%s %:if-exists(crti%O%s) \
9029 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9030 @end smallexample
9031
9032 @item @code{replace-outfile}
9033 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9034 first argument in the outfiles array and replaces it with the second argument.  Here
9035 is a small example of its usage:
9036
9037 @smallexample
9038 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9039 @end smallexample
9040
9041 @item @code{print-asm-header}
9042 The @code{print-asm-header} function takes no arguments and simply
9043 prints a banner like:
9044
9045 @smallexample
9046 Assembler options
9047 =================
9048
9049 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9050 @end smallexample
9051
9052 It is used to separate compiler options from assembler options
9053 in the @option{--target-help} output.
9054 @end table
9055
9056 @item %@{@code{S}@}
9057 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9058 If that switch was not specified, this substitutes nothing.  Note that
9059 the leading dash is omitted when specifying this option, and it is
9060 automatically inserted if the substitution is performed.  Thus the spec
9061 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9062 and would output the command line option @option{-foo}.
9063
9064 @item %W@{@code{S}@}
9065 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9066 deleted on failure.
9067
9068 @item %@{@code{S}*@}
9069 Substitutes all the switches specified to GCC whose names start
9070 with @code{-S}, but which also take an argument.  This is used for
9071 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9072 GCC considers @option{-o foo} as being
9073 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9074 text, including the space.  Thus two arguments would be generated.
9075
9076 @item %@{@code{S}*&@code{T}*@}
9077 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9078 (the order of @code{S} and @code{T} in the spec is not significant).
9079 There can be any number of ampersand-separated variables; for each the
9080 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9081
9082 @item %@{@code{S}:@code{X}@}
9083 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9084
9085 @item %@{!@code{S}:@code{X}@}
9086 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9087
9088 @item %@{@code{S}*:@code{X}@}
9089 Substitutes @code{X} if one or more switches whose names start with
9090 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9091 once, no matter how many such switches appeared.  However, if @code{%*}
9092 appears somewhere in @code{X}, then @code{X} will be substituted once
9093 for each matching switch, with the @code{%*} replaced by the part of
9094 that switch that matched the @code{*}.
9095
9096 @item %@{.@code{S}:@code{X}@}
9097 Substitutes @code{X}, if processing a file with suffix @code{S}.
9098
9099 @item %@{!.@code{S}:@code{X}@}
9100 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9101
9102 @item %@{,@code{S}:@code{X}@}
9103 Substitutes @code{X}, if processing a file for language @code{S}.
9104
9105 @item %@{!,@code{S}:@code{X}@}
9106 Substitutes @code{X}, if not processing a file for language @code{S}.
9107
9108 @item %@{@code{S}|@code{P}:@code{X}@}
9109 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9110 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9111 @code{*} sequences as well, although they have a stronger binding than
9112 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9113 alternatives must be starred, and only the first matching alternative
9114 is substituted.
9115
9116 For example, a spec string like this:
9117
9118 @smallexample
9119 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9120 @end smallexample
9121
9122 will output the following command-line options from the following input
9123 command-line options:
9124
9125 @smallexample
9126 fred.c        -foo -baz
9127 jim.d         -bar -boggle
9128 -d fred.c     -foo -baz -boggle
9129 -d jim.d      -bar -baz -boggle
9130 @end smallexample
9131
9132 @item %@{S:X; T:Y; :D@}
9133
9134 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9135 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9136 be as many clauses as you need.  This may be combined with @code{.},
9137 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9138
9139
9140 @end table
9141
9142 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9143 construct may contain other nested @samp{%} constructs or spaces, or
9144 even newlines.  They are processed as usual, as described above.
9145 Trailing white space in @code{X} is ignored.  White space may also
9146 appear anywhere on the left side of the colon in these constructs,
9147 except between @code{.} or @code{*} and the corresponding word.
9148
9149 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9150 handled specifically in these constructs.  If another value of
9151 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9152 @option{-W} switch is found later in the command line, the earlier
9153 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9154 just one letter, which passes all matching options.
9155
9156 The character @samp{|} at the beginning of the predicate text is used to
9157 indicate that a command should be piped to the following command, but
9158 only if @option{-pipe} is specified.
9159
9160 It is built into GCC which switches take arguments and which do not.
9161 (You might think it would be useful to generalize this to allow each
9162 compiler's spec to say which switches take arguments.  But this cannot
9163 be done in a consistent fashion.  GCC cannot even decide which input
9164 files have been specified without knowing which switches take arguments,
9165 and it must know which input files to compile in order to tell which
9166 compilers to run).
9167
9168 GCC also knows implicitly that arguments starting in @option{-l} are to be
9169 treated as compiler output files, and passed to the linker in their
9170 proper position among the other output files.
9171
9172 @c man begin OPTIONS
9173
9174 @node Target Options
9175 @section Specifying Target Machine and Compiler Version
9176 @cindex target options
9177 @cindex cross compiling
9178 @cindex specifying machine version
9179 @cindex specifying compiler version and target machine
9180 @cindex compiler version, specifying
9181 @cindex target machine, specifying
9182
9183 The usual way to run GCC is to run the executable called @file{gcc}, or
9184 @file{<machine>-gcc} when cross-compiling, or
9185 @file{<machine>-gcc-<version>} to run a version other than the one that
9186 was installed last.  Sometimes this is inconvenient, so GCC provides
9187 options that will switch to another cross-compiler or version.
9188
9189 @table @gcctabopt
9190 @item -b @var{machine}
9191 @opindex b
9192 The argument @var{machine} specifies the target machine for compilation.
9193
9194 The value to use for @var{machine} is the same as was specified as the
9195 machine type when configuring GCC as a cross-compiler.  For
9196 example, if a cross-compiler was configured with @samp{configure
9197 arm-elf}, meaning to compile for an arm processor with elf binaries,
9198 then you would specify @option{-b arm-elf} to run that cross compiler.
9199 Because there are other options beginning with @option{-b}, the
9200 configuration must contain a hyphen, or @option{-b} alone should be one
9201 argument followed by the configuration in the next argument.
9202
9203 @item -V @var{version}
9204 @opindex V
9205 The argument @var{version} specifies which version of GCC to run.
9206 This is useful when multiple versions are installed.  For example,
9207 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
9208 @end table
9209
9210 The @option{-V} and @option{-b} options work by running the
9211 @file{<machine>-gcc-<version>} executable, so there's no real reason to
9212 use them if you can just run that directly.
9213
9214 @node Submodel Options
9215 @section Hardware Models and Configurations
9216 @cindex submodel options
9217 @cindex specifying hardware config
9218 @cindex hardware models and configurations, specifying
9219 @cindex machine dependent options
9220
9221 Earlier we discussed the standard option @option{-b} which chooses among
9222 different installed compilers for completely different target
9223 machines, such as VAX vs.@: 68000 vs.@: 80386.
9224
9225 In addition, each of these target machine types can have its own
9226 special options, starting with @samp{-m}, to choose among various
9227 hardware models or configurations---for example, 68010 vs 68020,
9228 floating coprocessor or none.  A single installed version of the
9229 compiler can compile for any model or configuration, according to the
9230 options specified.
9231
9232 Some configurations of the compiler also support additional special
9233 options, usually for compatibility with other compilers on the same
9234 platform.
9235
9236 @c This list is ordered alphanumerically by subsection name.
9237 @c It should be the same order and spelling as these options are listed
9238 @c in Machine Dependent Options
9239
9240 @menu
9241 * ARC Options::
9242 * ARM Options::
9243 * AVR Options::
9244 * Blackfin Options::
9245 * CRIS Options::
9246 * CRX Options::
9247 * Darwin Options::
9248 * DEC Alpha Options::
9249 * DEC Alpha/VMS Options::
9250 * FR30 Options::
9251 * FRV Options::
9252 * GNU/Linux Options::
9253 * H8/300 Options::
9254 * HPPA Options::
9255 * i386 and x86-64 Options::
9256 * i386 and x86-64 Windows Options::
9257 * IA-64 Options::
9258 * IA-64/VMS Options::
9259 * M32C Options::
9260 * M32R/D Options::
9261 * M680x0 Options::
9262 * M68hc1x Options::
9263 * MCore Options::
9264 * MeP Options::
9265 * MIPS Options::
9266 * MMIX Options::
9267 * MN10300 Options::
9268 * PDP-11 Options::
9269 * picoChip Options::
9270 * PowerPC Options::
9271 * RS/6000 and PowerPC Options::
9272 * S/390 and zSeries Options::
9273 * Score Options::
9274 * SH Options::
9275 * SPARC Options::
9276 * SPU Options::
9277 * System V Options::
9278 * V850 Options::
9279 * VAX Options::
9280 * VxWorks Options::
9281 * x86-64 Options::
9282 * Xstormy16 Options::
9283 * Xtensa Options::
9284 * zSeries Options::
9285 @end menu
9286
9287 @node ARC Options
9288 @subsection ARC Options
9289 @cindex ARC Options
9290
9291 These options are defined for ARC implementations:
9292
9293 @table @gcctabopt
9294 @item -EL
9295 @opindex EL
9296 Compile code for little endian mode.  This is the default.
9297
9298 @item -EB
9299 @opindex EB
9300 Compile code for big endian mode.
9301
9302 @item -mmangle-cpu
9303 @opindex mmangle-cpu
9304 Prepend the name of the cpu to all public symbol names.
9305 In multiple-processor systems, there are many ARC variants with different
9306 instruction and register set characteristics.  This flag prevents code
9307 compiled for one cpu to be linked with code compiled for another.
9308 No facility exists for handling variants that are ``almost identical''.
9309 This is an all or nothing option.
9310
9311 @item -mcpu=@var{cpu}
9312 @opindex mcpu
9313 Compile code for ARC variant @var{cpu}.
9314 Which variants are supported depend on the configuration.
9315 All variants support @option{-mcpu=base}, this is the default.
9316
9317 @item -mtext=@var{text-section}
9318 @itemx -mdata=@var{data-section}
9319 @itemx -mrodata=@var{readonly-data-section}
9320 @opindex mtext
9321 @opindex mdata
9322 @opindex mrodata
9323 Put functions, data, and readonly data in @var{text-section},
9324 @var{data-section}, and @var{readonly-data-section} respectively
9325 by default.  This can be overridden with the @code{section} attribute.
9326 @xref{Variable Attributes}.
9327
9328 @item -mfix-cortex-m3-ldrd
9329 @opindex mfix-cortex-m3-ldrd
9330 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
9331 with overlapping destination and base registers are used.  This option avoids
9332 generating these instructions.  This option is enabled by default when
9333 @option{-mcpu=cortex-m3} is specified.
9334
9335 @end table
9336
9337 @node ARM Options
9338 @subsection ARM Options
9339 @cindex ARM options
9340
9341 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9342 architectures:
9343
9344 @table @gcctabopt
9345 @item -mabi=@var{name}
9346 @opindex mabi
9347 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9348 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9349
9350 @item -mapcs-frame
9351 @opindex mapcs-frame
9352 Generate a stack frame that is compliant with the ARM Procedure Call
9353 Standard for all functions, even if this is not strictly necessary for
9354 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9355 with this option will cause the stack frames not to be generated for
9356 leaf functions.  The default is @option{-mno-apcs-frame}.
9357
9358 @item -mapcs
9359 @opindex mapcs
9360 This is a synonym for @option{-mapcs-frame}.
9361
9362 @ignore
9363 @c not currently implemented
9364 @item -mapcs-stack-check
9365 @opindex mapcs-stack-check
9366 Generate code to check the amount of stack space available upon entry to
9367 every function (that actually uses some stack space).  If there is
9368 insufficient space available then either the function
9369 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9370 called, depending upon the amount of stack space required.  The run time
9371 system is required to provide these functions.  The default is
9372 @option{-mno-apcs-stack-check}, since this produces smaller code.
9373
9374 @c not currently implemented
9375 @item -mapcs-float
9376 @opindex mapcs-float
9377 Pass floating point arguments using the float point registers.  This is
9378 one of the variants of the APCS@.  This option is recommended if the
9379 target hardware has a floating point unit or if a lot of floating point
9380 arithmetic is going to be performed by the code.  The default is
9381 @option{-mno-apcs-float}, since integer only code is slightly increased in
9382 size if @option{-mapcs-float} is used.
9383
9384 @c not currently implemented
9385 @item -mapcs-reentrant
9386 @opindex mapcs-reentrant
9387 Generate reentrant, position independent code.  The default is
9388 @option{-mno-apcs-reentrant}.
9389 @end ignore
9390
9391 @item -mthumb-interwork
9392 @opindex mthumb-interwork
9393 Generate code which supports calling between the ARM and Thumb
9394 instruction sets.  Without this option the two instruction sets cannot
9395 be reliably used inside one program.  The default is
9396 @option{-mno-thumb-interwork}, since slightly larger code is generated
9397 when @option{-mthumb-interwork} is specified.
9398
9399 @item -mno-sched-prolog
9400 @opindex mno-sched-prolog
9401 Prevent the reordering of instructions in the function prolog, or the
9402 merging of those instruction with the instructions in the function's
9403 body.  This means that all functions will start with a recognizable set
9404 of instructions (or in fact one of a choice from a small set of
9405 different function prologues), and this information can be used to
9406 locate the start if functions inside an executable piece of code.  The
9407 default is @option{-msched-prolog}.
9408
9409 @item -mfloat-abi=@var{name}
9410 @opindex mfloat-abi
9411 Specifies which floating-point ABI to use.  Permissible values
9412 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9413
9414 Specifying @samp{soft} causes GCC to generate output containing
9415 library calls for floating-point operations.
9416 @samp{softfp} allows the generation of code using hardware floating-point
9417 instructions, but still uses the soft-float calling conventions.
9418 @samp{hard} allows generation of floating-point instructions
9419 and uses FPU-specific calling conventions.
9420
9421 The default depends on the specific target configuration.  Note that
9422 the hard-float and soft-float ABIs are not link-compatible; you must
9423 compile your entire program with the same ABI, and link with a
9424 compatible set of libraries.
9425
9426 @item -mhard-float
9427 @opindex mhard-float
9428 Equivalent to @option{-mfloat-abi=hard}.
9429
9430 @item -msoft-float
9431 @opindex msoft-float
9432 Equivalent to @option{-mfloat-abi=soft}.
9433
9434 @item -mlittle-endian
9435 @opindex mlittle-endian
9436 Generate code for a processor running in little-endian mode.  This is
9437 the default for all standard configurations.
9438
9439 @item -mbig-endian
9440 @opindex mbig-endian
9441 Generate code for a processor running in big-endian mode; the default is
9442 to compile code for a little-endian processor.
9443
9444 @item -mwords-little-endian
9445 @opindex mwords-little-endian
9446 This option only applies when generating code for big-endian processors.
9447 Generate code for a little-endian word order but a big-endian byte
9448 order.  That is, a byte order of the form @samp{32107654}.  Note: this
9449 option should only be used if you require compatibility with code for
9450 big-endian ARM processors generated by versions of the compiler prior to
9451 2.8.
9452
9453 @item -mcpu=@var{name}
9454 @opindex mcpu
9455 This specifies the name of the target ARM processor.  GCC uses this name
9456 to determine what kind of instructions it can emit when generating
9457 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
9458 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
9459 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
9460 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9461 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9462 @samp{arm720},
9463 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9464 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9465 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9466 @samp{strongarm1110},
9467 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9468 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9469 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9470 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9471 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9472 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9473 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9474 @samp{cortex-a8}, @samp{cortex-a9},
9475 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9476 @samp{cortex-m1},
9477 @samp{cortex-m0},
9478 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9479
9480 @item -mtune=@var{name}
9481 @opindex mtune
9482 This option is very similar to the @option{-mcpu=} option, except that
9483 instead of specifying the actual target processor type, and hence
9484 restricting which instructions can be used, it specifies that GCC should
9485 tune the performance of the code as if the target were of the type
9486 specified in this option, but still choosing the instructions that it
9487 will generate based on the cpu specified by a @option{-mcpu=} option.
9488 For some ARM implementations better performance can be obtained by using
9489 this option.
9490
9491 @item -march=@var{name}
9492 @opindex march
9493 This specifies the name of the target ARM architecture.  GCC uses this
9494 name to determine what kind of instructions it can emit when generating
9495 assembly code.  This option can be used in conjunction with or instead
9496 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9497 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9498 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9499 @samp{armv6}, @samp{armv6j},
9500 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9501 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9502 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9503
9504 @item -mfpu=@var{name}
9505 @itemx -mfpe=@var{number}
9506 @itemx -mfp=@var{number}
9507 @opindex mfpu
9508 @opindex mfpe
9509 @opindex mfp
9510 This specifies what floating point hardware (or hardware emulation) is
9511 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9512 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-d16},
9513 @samp{neon}, and @samp{neon-fp16}.  @option{-mfp} and @option{-mfpe}
9514 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
9515 with older versions of GCC@.
9516
9517 If @option{-msoft-float} is specified this specifies the format of
9518 floating point values.
9519
9520 @item -mfp16-format=@var{name}
9521 @opindex mfp16-format
9522 Specify the format of the @code{__fp16} half-precision floating-point type.
9523 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
9524 the default is @samp{none}, in which case the @code{__fp16} type is not
9525 defined.  @xref{Half-Precision}, for more information.
9526
9527 @item -mstructure-size-boundary=@var{n}
9528 @opindex mstructure-size-boundary
9529 The size of all structures and unions will be rounded up to a multiple
9530 of the number of bits set by this option.  Permissible values are 8, 32
9531 and 64.  The default value varies for different toolchains.  For the COFF
9532 targeted toolchain the default value is 8.  A value of 64 is only allowed
9533 if the underlying ABI supports it.
9534
9535 Specifying the larger number can produce faster, more efficient code, but
9536 can also increase the size of the program.  Different values are potentially
9537 incompatible.  Code compiled with one value cannot necessarily expect to
9538 work with code or libraries compiled with another value, if they exchange
9539 information using structures or unions.
9540
9541 @item -mabort-on-noreturn
9542 @opindex mabort-on-noreturn
9543 Generate a call to the function @code{abort} at the end of a
9544 @code{noreturn} function.  It will be executed if the function tries to
9545 return.
9546
9547 @item -mlong-calls
9548 @itemx -mno-long-calls
9549 @opindex mlong-calls
9550 @opindex mno-long-calls
9551 Tells the compiler to perform function calls by first loading the
9552 address of the function into a register and then performing a subroutine
9553 call on this register.  This switch is needed if the target function
9554 will lie outside of the 64 megabyte addressing range of the offset based
9555 version of subroutine call instruction.
9556
9557 Even if this switch is enabled, not all function calls will be turned
9558 into long calls.  The heuristic is that static functions, functions
9559 which have the @samp{short-call} attribute, functions that are inside
9560 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9561 definitions have already been compiled within the current compilation
9562 unit, will not be turned into long calls.  The exception to this rule is
9563 that weak function definitions, functions with the @samp{long-call}
9564 attribute or the @samp{section} attribute, and functions that are within
9565 the scope of a @samp{#pragma long_calls} directive, will always be
9566 turned into long calls.
9567
9568 This feature is not enabled by default.  Specifying
9569 @option{-mno-long-calls} will restore the default behavior, as will
9570 placing the function calls within the scope of a @samp{#pragma
9571 long_calls_off} directive.  Note these switches have no effect on how
9572 the compiler generates code to handle function calls via function
9573 pointers.
9574
9575 @item -msingle-pic-base
9576 @opindex msingle-pic-base
9577 Treat the register used for PIC addressing as read-only, rather than
9578 loading it in the prologue for each function.  The run-time system is
9579 responsible for initializing this register with an appropriate value
9580 before execution begins.
9581
9582 @item -mpic-register=@var{reg}
9583 @opindex mpic-register
9584 Specify the register to be used for PIC addressing.  The default is R10
9585 unless stack-checking is enabled, when R9 is used.
9586
9587 @item -mcirrus-fix-invalid-insns
9588 @opindex mcirrus-fix-invalid-insns
9589 @opindex mno-cirrus-fix-invalid-insns
9590 Insert NOPs into the instruction stream to in order to work around
9591 problems with invalid Maverick instruction combinations.  This option
9592 is only valid if the @option{-mcpu=ep9312} option has been used to
9593 enable generation of instructions for the Cirrus Maverick floating
9594 point co-processor.  This option is not enabled by default, since the
9595 problem is only present in older Maverick implementations.  The default
9596 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
9597 switch.
9598
9599 @item -mpoke-function-name
9600 @opindex mpoke-function-name
9601 Write the name of each function into the text section, directly
9602 preceding the function prologue.  The generated code is similar to this:
9603
9604 @smallexample
9605      t0
9606          .ascii "arm_poke_function_name", 0
9607          .align
9608      t1
9609          .word 0xff000000 + (t1 - t0)
9610      arm_poke_function_name
9611          mov     ip, sp
9612          stmfd   sp!, @{fp, ip, lr, pc@}
9613          sub     fp, ip, #4
9614 @end smallexample
9615
9616 When performing a stack backtrace, code can inspect the value of
9617 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
9618 location @code{pc - 12} and the top 8 bits are set, then we know that
9619 there is a function name embedded immediately preceding this location
9620 and has length @code{((pc[-3]) & 0xff000000)}.
9621
9622 @item -mthumb
9623 @opindex mthumb
9624 Generate code for the Thumb instruction set.  The default is to
9625 use the 32-bit ARM instruction set.
9626 This option automatically enables either 16-bit Thumb-1 or
9627 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
9628 and @option{-march=@var{name}} options.  This option is not passed to the
9629 assembler. If you want to force assembler files to be interpreted as Thumb code,
9630 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
9631 option directly to the assembler by prefixing it with @option{-Wa}.
9632
9633 @item -mtpcs-frame
9634 @opindex mtpcs-frame
9635 Generate a stack frame that is compliant with the Thumb Procedure Call
9636 Standard for all non-leaf functions.  (A leaf function is one that does
9637 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
9638
9639 @item -mtpcs-leaf-frame
9640 @opindex mtpcs-leaf-frame
9641 Generate a stack frame that is compliant with the Thumb Procedure Call
9642 Standard for all leaf functions.  (A leaf function is one that does
9643 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
9644
9645 @item -mcallee-super-interworking
9646 @opindex mcallee-super-interworking
9647 Gives all externally visible functions in the file being compiled an ARM
9648 instruction set header which switches to Thumb mode before executing the
9649 rest of the function.  This allows these functions to be called from
9650 non-interworking code.  This option is not valid in AAPCS configurations
9651 because interworking is enabled by default.
9652
9653 @item -mcaller-super-interworking
9654 @opindex mcaller-super-interworking
9655 Allows calls via function pointers (including virtual functions) to
9656 execute correctly regardless of whether the target code has been
9657 compiled for interworking or not.  There is a small overhead in the cost
9658 of executing a function pointer if this option is enabled.  This option
9659 is not valid in AAPCS configurations because interworking is enabled
9660 by default.
9661
9662 @item -mtp=@var{name}
9663 @opindex mtp
9664 Specify the access model for the thread local storage pointer.  The valid
9665 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
9666 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
9667 (supported in the arm6k architecture), and @option{auto}, which uses the
9668 best available method for the selected processor.  The default setting is
9669 @option{auto}.
9670
9671 @item -mword-relocations
9672 @opindex mword-relocations
9673 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
9674 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
9675 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
9676 is specified.
9677
9678 @end table
9679
9680 @node AVR Options
9681 @subsection AVR Options
9682 @cindex AVR Options
9683
9684 These options are defined for AVR implementations:
9685
9686 @table @gcctabopt
9687 @item -mmcu=@var{mcu}
9688 @opindex mmcu
9689 Specify ATMEL AVR instruction set or MCU type.
9690
9691 Instruction set avr1 is for the minimal AVR core, not supported by the C
9692 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9693 attiny11, attiny12, attiny15, attiny28).
9694
9695 Instruction set avr2 (default) is for the classic AVR core with up to
9696 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9697 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9698 at90c8534, at90s8535).
9699
9700 Instruction set avr3 is for the classic AVR core with up to 128K program
9701 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9702
9703 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9704 memory space (MCU types: atmega8, atmega83, atmega85).
9705
9706 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9707 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9708 atmega64, atmega128, at43usb355, at94k).
9709
9710 @item -msize
9711 @opindex msize
9712 Output instruction sizes to the asm file.
9713
9714 @item -mno-interrupts
9715 @opindex mno-interrupts
9716 Generated code is not compatible with hardware interrupts.
9717 Code size will be smaller.
9718
9719 @item -mcall-prologues
9720 @opindex mcall-prologues
9721 Functions prologues/epilogues expanded as call to appropriate
9722 subroutines.  Code size will be smaller.
9723
9724 @item -mtiny-stack
9725 @opindex mtiny-stack
9726 Change only the low 8 bits of the stack pointer.
9727
9728 @item -mint8
9729 @opindex mint8
9730 Assume int to be 8 bit integer.  This affects the sizes of all types: A
9731 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
9732 and long long will be 4 bytes.  Please note that this option does not
9733 comply to the C standards, but it will provide you with smaller code
9734 size.
9735 @end table
9736
9737 @node Blackfin Options
9738 @subsection Blackfin Options
9739 @cindex Blackfin Options
9740
9741 @table @gcctabopt
9742 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
9743 @opindex mcpu=
9744 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
9745 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
9746 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
9747 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
9748 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
9749 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
9750 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
9751 @samp{bf561}.
9752 The optional @var{sirevision} specifies the silicon revision of the target
9753 Blackfin processor.  Any workarounds available for the targeted silicon revision
9754 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
9755 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
9756 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
9757 hexadecimal digits representing the major and minor numbers in the silicon
9758 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
9759 is not defined.  If @var{sirevision} is @samp{any}, the
9760 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
9761 If this optional @var{sirevision} is not used, GCC assumes the latest known
9762 silicon revision of the targeted Blackfin processor.
9763
9764 Support for @samp{bf561} is incomplete.  For @samp{bf561},
9765 Only the processor macro is defined.
9766 Without this option, @samp{bf532} is used as the processor by default.
9767 The corresponding predefined processor macros for @var{cpu} is to
9768 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
9769 provided by libgloss to be linked in if @option{-msim} is not given.
9770
9771 @item -msim
9772 @opindex msim
9773 Specifies that the program will be run on the simulator.  This causes
9774 the simulator BSP provided by libgloss to be linked in.  This option
9775 has effect only for @samp{bfin-elf} toolchain.
9776 Certain other options, such as @option{-mid-shared-library} and
9777 @option{-mfdpic}, imply @option{-msim}.
9778
9779 @item -momit-leaf-frame-pointer
9780 @opindex momit-leaf-frame-pointer
9781 Don't keep the frame pointer in a register for leaf functions.  This
9782 avoids the instructions to save, set up and restore frame pointers and
9783 makes an extra register available in leaf functions.  The option
9784 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9785 which might make debugging harder.
9786
9787 @item -mspecld-anomaly
9788 @opindex mspecld-anomaly
9789 When enabled, the compiler will ensure that the generated code does not
9790 contain speculative loads after jump instructions. If this option is used,
9791 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
9792
9793 @item -mno-specld-anomaly
9794 @opindex mno-specld-anomaly
9795 Don't generate extra code to prevent speculative loads from occurring.
9796
9797 @item -mcsync-anomaly
9798 @opindex mcsync-anomaly
9799 When enabled, the compiler will ensure that the generated code does not
9800 contain CSYNC or SSYNC instructions too soon after conditional branches.
9801 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
9802
9803 @item -mno-csync-anomaly
9804 @opindex mno-csync-anomaly
9805 Don't generate extra code to prevent CSYNC or SSYNC instructions from
9806 occurring too soon after a conditional branch.
9807
9808 @item -mlow-64k
9809 @opindex mlow-64k
9810 When enabled, the compiler is free to take advantage of the knowledge that
9811 the entire program fits into the low 64k of memory.
9812
9813 @item -mno-low-64k
9814 @opindex mno-low-64k
9815 Assume that the program is arbitrarily large.  This is the default.
9816
9817 @item -mstack-check-l1
9818 @opindex mstack-check-l1
9819 Do stack checking using information placed into L1 scratchpad memory by the
9820 uClinux kernel.
9821
9822 @item -mid-shared-library
9823 @opindex mid-shared-library
9824 Generate code that supports shared libraries via the library ID method.
9825 This allows for execute in place and shared libraries in an environment
9826 without virtual memory management.  This option implies @option{-fPIC}.
9827 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9828
9829 @item -mno-id-shared-library
9830 @opindex mno-id-shared-library
9831 Generate code that doesn't assume ID based shared libraries are being used.
9832 This is the default.
9833
9834 @item -mleaf-id-shared-library
9835 @opindex mleaf-id-shared-library
9836 Generate code that supports shared libraries via the library ID method,
9837 but assumes that this library or executable won't link against any other
9838 ID shared libraries.  That allows the compiler to use faster code for jumps
9839 and calls.
9840
9841 @item -mno-leaf-id-shared-library
9842 @opindex mno-leaf-id-shared-library
9843 Do not assume that the code being compiled won't link against any ID shared
9844 libraries.  Slower code will be generated for jump and call insns.
9845
9846 @item -mshared-library-id=n
9847 @opindex mshared-library-id
9848 Specified the identification number of the ID based shared library being
9849 compiled.  Specifying a value of 0 will generate more compact code, specifying
9850 other values will force the allocation of that number to the current
9851 library but is no more space or time efficient than omitting this option.
9852
9853 @item -msep-data
9854 @opindex msep-data
9855 Generate code that allows the data segment to be located in a different
9856 area of memory from the text segment.  This allows for execute in place in
9857 an environment without virtual memory management by eliminating relocations
9858 against the text section.
9859
9860 @item -mno-sep-data
9861 @opindex mno-sep-data
9862 Generate code that assumes that the data segment follows the text segment.
9863 This is the default.
9864
9865 @item -mlong-calls
9866 @itemx -mno-long-calls
9867 @opindex mlong-calls
9868 @opindex mno-long-calls
9869 Tells the compiler to perform function calls by first loading the
9870 address of the function into a register and then performing a subroutine
9871 call on this register.  This switch is needed if the target function
9872 will lie outside of the 24 bit addressing range of the offset based
9873 version of subroutine call instruction.
9874
9875 This feature is not enabled by default.  Specifying
9876 @option{-mno-long-calls} will restore the default behavior.  Note these
9877 switches have no effect on how the compiler generates code to handle
9878 function calls via function pointers.
9879
9880 @item -mfast-fp
9881 @opindex mfast-fp
9882 Link with the fast floating-point library. This library relaxes some of
9883 the IEEE floating-point standard's rules for checking inputs against
9884 Not-a-Number (NAN), in the interest of performance.
9885
9886 @item -minline-plt
9887 @opindex minline-plt
9888 Enable inlining of PLT entries in function calls to functions that are
9889 not known to bind locally.  It has no effect without @option{-mfdpic}.
9890
9891 @item -mmulticore
9892 @opindex mmulticore
9893 Build standalone application for multicore Blackfin processor. Proper
9894 start files and link scripts will be used to support multicore.
9895 This option defines @code{__BFIN_MULTICORE}. It can only be used with
9896 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
9897 @option{-mcorea} or @option{-mcoreb}. If it's used without
9898 @option{-mcorea} or @option{-mcoreb}, single application/dual core
9899 programming model is used. In this model, the main function of Core B
9900 should be named as coreb_main. If it's used with @option{-mcorea} or
9901 @option{-mcoreb}, one application per core programming model is used.
9902 If this option is not used, single core application programming
9903 model is used.
9904
9905 @item -mcorea
9906 @opindex mcorea
9907 Build standalone application for Core A of BF561 when using
9908 one application per core programming model. Proper start files
9909 and link scripts will be used to support Core A. This option
9910 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
9911
9912 @item -mcoreb
9913 @opindex mcoreb
9914 Build standalone application for Core B of BF561 when using
9915 one application per core programming model. Proper start files
9916 and link scripts will be used to support Core B. This option
9917 defines @code{__BFIN_COREB}. When this option is used, coreb_main
9918 should be used instead of main. It must be used with
9919 @option{-mmulticore}.
9920
9921 @item -msdram
9922 @opindex msdram
9923 Build standalone application for SDRAM. Proper start files and
9924 link scripts will be used to put the application into SDRAM.
9925 Loader should initialize SDRAM before loading the application
9926 into SDRAM. This option defines @code{__BFIN_SDRAM}.
9927
9928 @item -micplb
9929 @opindex micplb
9930 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
9931 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
9932 are enabled; for standalone applications the default is off.
9933 @end table
9934
9935 @node CRIS Options
9936 @subsection CRIS Options
9937 @cindex CRIS Options
9938
9939 These options are defined specifically for the CRIS ports.
9940
9941 @table @gcctabopt
9942 @item -march=@var{architecture-type}
9943 @itemx -mcpu=@var{architecture-type}
9944 @opindex march
9945 @opindex mcpu
9946 Generate code for the specified architecture.  The choices for
9947 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9948 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9949 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9950 @samp{v10}.
9951
9952 @item -mtune=@var{architecture-type}
9953 @opindex mtune
9954 Tune to @var{architecture-type} everything applicable about the generated
9955 code, except for the ABI and the set of available instructions.  The
9956 choices for @var{architecture-type} are the same as for
9957 @option{-march=@var{architecture-type}}.
9958
9959 @item -mmax-stack-frame=@var{n}
9960 @opindex mmax-stack-frame
9961 Warn when the stack frame of a function exceeds @var{n} bytes.
9962
9963 @item -metrax4
9964 @itemx -metrax100
9965 @opindex metrax4
9966 @opindex metrax100
9967 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9968 @option{-march=v3} and @option{-march=v8} respectively.
9969
9970 @item -mmul-bug-workaround
9971 @itemx -mno-mul-bug-workaround
9972 @opindex mmul-bug-workaround
9973 @opindex mno-mul-bug-workaround
9974 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9975 models where it applies.  This option is active by default.
9976
9977 @item -mpdebug
9978 @opindex mpdebug
9979 Enable CRIS-specific verbose debug-related information in the assembly
9980 code.  This option also has the effect to turn off the @samp{#NO_APP}
9981 formatted-code indicator to the assembler at the beginning of the
9982 assembly file.
9983
9984 @item -mcc-init
9985 @opindex mcc-init
9986 Do not use condition-code results from previous instruction; always emit
9987 compare and test instructions before use of condition codes.
9988
9989 @item -mno-side-effects
9990 @opindex mno-side-effects
9991 Do not emit instructions with side-effects in addressing modes other than
9992 post-increment.
9993
9994 @item -mstack-align
9995 @itemx -mno-stack-align
9996 @itemx -mdata-align
9997 @itemx -mno-data-align
9998 @itemx -mconst-align
9999 @itemx -mno-const-align
10000 @opindex mstack-align
10001 @opindex mno-stack-align
10002 @opindex mdata-align
10003 @opindex mno-data-align
10004 @opindex mconst-align
10005 @opindex mno-const-align
10006 These options (no-options) arranges (eliminate arrangements) for the
10007 stack-frame, individual data and constants to be aligned for the maximum
10008 single data access size for the chosen CPU model.  The default is to
10009 arrange for 32-bit alignment.  ABI details such as structure layout are
10010 not affected by these options.
10011
10012 @item -m32-bit
10013 @itemx -m16-bit
10014 @itemx -m8-bit
10015 @opindex m32-bit
10016 @opindex m16-bit
10017 @opindex m8-bit
10018 Similar to the stack- data- and const-align options above, these options
10019 arrange for stack-frame, writable data and constants to all be 32-bit,
10020 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10021
10022 @item -mno-prologue-epilogue
10023 @itemx -mprologue-epilogue
10024 @opindex mno-prologue-epilogue
10025 @opindex mprologue-epilogue
10026 With @option{-mno-prologue-epilogue}, the normal function prologue and
10027 epilogue that sets up the stack-frame are omitted and no return
10028 instructions or return sequences are generated in the code.  Use this
10029 option only together with visual inspection of the compiled code: no
10030 warnings or errors are generated when call-saved registers must be saved,
10031 or storage for local variable needs to be allocated.
10032
10033 @item -mno-gotplt
10034 @itemx -mgotplt
10035 @opindex mno-gotplt
10036 @opindex mgotplt
10037 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10038 instruction sequences that load addresses for functions from the PLT part
10039 of the GOT rather than (traditional on other architectures) calls to the
10040 PLT@.  The default is @option{-mgotplt}.
10041
10042 @item -melf
10043 @opindex melf
10044 Legacy no-op option only recognized with the cris-axis-elf and
10045 cris-axis-linux-gnu targets.
10046
10047 @item -mlinux
10048 @opindex mlinux
10049 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10050
10051 @item -sim
10052 @opindex sim
10053 This option, recognized for the cris-axis-elf arranges
10054 to link with input-output functions from a simulator library.  Code,
10055 initialized data and zero-initialized data are allocated consecutively.
10056
10057 @item -sim2
10058 @opindex sim2
10059 Like @option{-sim}, but pass linker options to locate initialized data at
10060 0x40000000 and zero-initialized data at 0x80000000.
10061 @end table
10062
10063 @node CRX Options
10064 @subsection CRX Options
10065 @cindex CRX Options
10066
10067 These options are defined specifically for the CRX ports.
10068
10069 @table @gcctabopt
10070
10071 @item -mmac
10072 @opindex mmac
10073 Enable the use of multiply-accumulate instructions. Disabled by default.
10074
10075 @item -mpush-args
10076 @opindex mpush-args
10077 Push instructions will be used to pass outgoing arguments when functions
10078 are called. Enabled by default.
10079 @end table
10080
10081 @node Darwin Options
10082 @subsection Darwin Options
10083 @cindex Darwin options
10084
10085 These options are defined for all architectures running the Darwin operating
10086 system.
10087
10088 FSF GCC on Darwin does not create ``fat'' object files; it will create
10089 an object file for the single architecture that it was built to
10090 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10091 @option{-arch} options are used; it does so by running the compiler or
10092 linker multiple times and joining the results together with
10093 @file{lipo}.
10094
10095 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10096 @samp{i686}) is determined by the flags that specify the ISA
10097 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10098 @option{-force_cpusubtype_ALL} option can be used to override this.
10099
10100 The Darwin tools vary in their behavior when presented with an ISA
10101 mismatch.  The assembler, @file{as}, will only permit instructions to
10102 be used that are valid for the subtype of the file it is generating,
10103 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10104 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10105 and print an error if asked to create a shared library with a less
10106 restrictive subtype than its input files (for instance, trying to put
10107 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10108 for executables, @file{ld}, will quietly give the executable the most
10109 restrictive subtype of any of its input files.
10110
10111 @table @gcctabopt
10112 @item -F@var{dir}
10113 @opindex F
10114 Add the framework directory @var{dir} to the head of the list of
10115 directories to be searched for header files.  These directories are
10116 interleaved with those specified by @option{-I} options and are
10117 scanned in a left-to-right order.
10118
10119 A framework directory is a directory with frameworks in it.  A
10120 framework is a directory with a @samp{"Headers"} and/or
10121 @samp{"PrivateHeaders"} directory contained directly in it that ends
10122 in @samp{".framework"}.  The name of a framework is the name of this
10123 directory excluding the @samp{".framework"}.  Headers associated with
10124 the framework are found in one of those two directories, with
10125 @samp{"Headers"} being searched first.  A subframework is a framework
10126 directory that is in a framework's @samp{"Frameworks"} directory.
10127 Includes of subframework headers can only appear in a header of a
10128 framework that contains the subframework, or in a sibling subframework
10129 header.  Two subframeworks are siblings if they occur in the same
10130 framework.  A subframework should not have the same name as a
10131 framework, a warning will be issued if this is violated.  Currently a
10132 subframework cannot have subframeworks, in the future, the mechanism
10133 may be extended to support this.  The standard frameworks can be found
10134 in @samp{"/System/Library/Frameworks"} and
10135 @samp{"/Library/Frameworks"}.  An example include looks like
10136 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10137 the name of the framework and header.h is found in the
10138 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10139
10140 @item -iframework@var{dir}
10141 @opindex iframework
10142 Like @option{-F} except the directory is a treated as a system
10143 directory.  The main difference between this @option{-iframework} and
10144 @option{-F} is that with @option{-iframework} the compiler does not
10145 warn about constructs contained within header files found via
10146 @var{dir}.  This option is valid only for the C family of languages.
10147
10148 @item -gused
10149 @opindex gused
10150 Emit debugging information for symbols that are used.  For STABS
10151 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10152 This is by default ON@.
10153
10154 @item -gfull
10155 @opindex gfull
10156 Emit debugging information for all symbols and types.
10157
10158 @item -mmacosx-version-min=@var{version}
10159 The earliest version of MacOS X that this executable will run on
10160 is @var{version}.  Typical values of @var{version} include @code{10.1},
10161 @code{10.2}, and @code{10.3.9}.
10162
10163 If the compiler was built to use the system's headers by default,
10164 then the default for this option is the system version on which the
10165 compiler is running, otherwise the default is to make choices which
10166 are compatible with as many systems and code bases as possible.
10167
10168 @item -mkernel
10169 @opindex mkernel
10170 Enable kernel development mode.  The @option{-mkernel} option sets
10171 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10172 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10173 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10174 applicable.  This mode also sets @option{-mno-altivec},
10175 @option{-msoft-float}, @option{-fno-builtin} and
10176 @option{-mlong-branch} for PowerPC targets.
10177
10178 @item -mone-byte-bool
10179 @opindex mone-byte-bool
10180 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10181 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10182 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10183 option has no effect on x86.
10184
10185 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10186 to generate code that is not binary compatible with code generated
10187 without that switch.  Using this switch may require recompiling all
10188 other modules in a program, including system libraries.  Use this
10189 switch to conform to a non-default data model.
10190
10191 @item -mfix-and-continue
10192 @itemx -ffix-and-continue
10193 @itemx -findirect-data
10194 @opindex mfix-and-continue
10195 @opindex ffix-and-continue
10196 @opindex findirect-data
10197 Generate code suitable for fast turn around development.  Needed to
10198 enable gdb to dynamically load @code{.o} files into already running
10199 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10200 are provided for backwards compatibility.
10201
10202 @item -all_load
10203 @opindex all_load
10204 Loads all members of static archive libraries.
10205 See man ld(1) for more information.
10206
10207 @item -arch_errors_fatal
10208 @opindex arch_errors_fatal
10209 Cause the errors having to do with files that have the wrong architecture
10210 to be fatal.
10211
10212 @item -bind_at_load
10213 @opindex bind_at_load
10214 Causes the output file to be marked such that the dynamic linker will
10215 bind all undefined references when the file is loaded or launched.
10216
10217 @item -bundle
10218 @opindex bundle
10219 Produce a Mach-o bundle format file.
10220 See man ld(1) for more information.
10221
10222 @item -bundle_loader @var{executable}
10223 @opindex bundle_loader
10224 This option specifies the @var{executable} that will be loading the build
10225 output file being linked.  See man ld(1) for more information.
10226
10227 @item -dynamiclib
10228 @opindex dynamiclib
10229 When passed this option, GCC will produce a dynamic library instead of
10230 an executable when linking, using the Darwin @file{libtool} command.
10231
10232 @item -force_cpusubtype_ALL
10233 @opindex force_cpusubtype_ALL
10234 This causes GCC's output file to have the @var{ALL} subtype, instead of
10235 one controlled by the @option{-mcpu} or @option{-march} option.
10236
10237 @item -allowable_client  @var{client_name}
10238 @itemx -client_name
10239 @itemx -compatibility_version
10240 @itemx -current_version
10241 @itemx -dead_strip
10242 @itemx -dependency-file
10243 @itemx -dylib_file
10244 @itemx -dylinker_install_name
10245 @itemx -dynamic
10246 @itemx -exported_symbols_list
10247 @itemx -filelist
10248 @itemx -flat_namespace
10249 @itemx -force_flat_namespace
10250 @itemx -headerpad_max_install_names
10251 @itemx -image_base
10252 @itemx -init
10253 @itemx -install_name
10254 @itemx -keep_private_externs
10255 @itemx -multi_module
10256 @itemx -multiply_defined
10257 @itemx -multiply_defined_unused
10258 @itemx -noall_load
10259 @itemx -no_dead_strip_inits_and_terms
10260 @itemx -nofixprebinding
10261 @itemx -nomultidefs
10262 @itemx -noprebind
10263 @itemx -noseglinkedit
10264 @itemx -pagezero_size
10265 @itemx -prebind
10266 @itemx -prebind_all_twolevel_modules
10267 @itemx -private_bundle
10268 @itemx -read_only_relocs
10269 @itemx -sectalign
10270 @itemx -sectobjectsymbols
10271 @itemx -whyload
10272 @itemx -seg1addr
10273 @itemx -sectcreate
10274 @itemx -sectobjectsymbols
10275 @itemx -sectorder
10276 @itemx -segaddr
10277 @itemx -segs_read_only_addr
10278 @itemx -segs_read_write_addr
10279 @itemx -seg_addr_table
10280 @itemx -seg_addr_table_filename
10281 @itemx -seglinkedit
10282 @itemx -segprot
10283 @itemx -segs_read_only_addr
10284 @itemx -segs_read_write_addr
10285 @itemx -single_module
10286 @itemx -static
10287 @itemx -sub_library
10288 @itemx -sub_umbrella
10289 @itemx -twolevel_namespace
10290 @itemx -umbrella
10291 @itemx -undefined
10292 @itemx -unexported_symbols_list
10293 @itemx -weak_reference_mismatches
10294 @itemx -whatsloaded
10295 @opindex allowable_client
10296 @opindex client_name
10297 @opindex compatibility_version
10298 @opindex current_version
10299 @opindex dead_strip
10300 @opindex dependency-file
10301 @opindex dylib_file
10302 @opindex dylinker_install_name
10303 @opindex dynamic
10304 @opindex exported_symbols_list
10305 @opindex filelist
10306 @opindex flat_namespace
10307 @opindex force_flat_namespace
10308 @opindex headerpad_max_install_names
10309 @opindex image_base
10310 @opindex init
10311 @opindex install_name
10312 @opindex keep_private_externs
10313 @opindex multi_module
10314 @opindex multiply_defined
10315 @opindex multiply_defined_unused
10316 @opindex noall_load
10317 @opindex no_dead_strip_inits_and_terms
10318 @opindex nofixprebinding
10319 @opindex nomultidefs
10320 @opindex noprebind
10321 @opindex noseglinkedit
10322 @opindex pagezero_size
10323 @opindex prebind
10324 @opindex prebind_all_twolevel_modules
10325 @opindex private_bundle
10326 @opindex read_only_relocs
10327 @opindex sectalign
10328 @opindex sectobjectsymbols
10329 @opindex whyload
10330 @opindex seg1addr
10331 @opindex sectcreate
10332 @opindex sectobjectsymbols
10333 @opindex sectorder
10334 @opindex segaddr
10335 @opindex segs_read_only_addr
10336 @opindex segs_read_write_addr
10337 @opindex seg_addr_table
10338 @opindex seg_addr_table_filename
10339 @opindex seglinkedit
10340 @opindex segprot
10341 @opindex segs_read_only_addr
10342 @opindex segs_read_write_addr
10343 @opindex single_module
10344 @opindex static
10345 @opindex sub_library
10346 @opindex sub_umbrella
10347 @opindex twolevel_namespace
10348 @opindex umbrella
10349 @opindex undefined
10350 @opindex unexported_symbols_list
10351 @opindex weak_reference_mismatches
10352 @opindex whatsloaded
10353 These options are passed to the Darwin linker.  The Darwin linker man page
10354 describes them in detail.
10355 @end table
10356
10357 @node DEC Alpha Options
10358 @subsection DEC Alpha Options
10359
10360 These @samp{-m} options are defined for the DEC Alpha implementations:
10361
10362 @table @gcctabopt
10363 @item -mno-soft-float
10364 @itemx -msoft-float
10365 @opindex mno-soft-float
10366 @opindex msoft-float
10367 Use (do not use) the hardware floating-point instructions for
10368 floating-point operations.  When @option{-msoft-float} is specified,
10369 functions in @file{libgcc.a} will be used to perform floating-point
10370 operations.  Unless they are replaced by routines that emulate the
10371 floating-point operations, or compiled in such a way as to call such
10372 emulations routines, these routines will issue floating-point
10373 operations.   If you are compiling for an Alpha without floating-point
10374 operations, you must ensure that the library is built so as not to call
10375 them.
10376
10377 Note that Alpha implementations without floating-point operations are
10378 required to have floating-point registers.
10379
10380 @item -mfp-reg
10381 @itemx -mno-fp-regs
10382 @opindex mfp-reg
10383 @opindex mno-fp-regs
10384 Generate code that uses (does not use) the floating-point register set.
10385 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10386 register set is not used, floating point operands are passed in integer
10387 registers as if they were integers and floating-point results are passed
10388 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10389 so any function with a floating-point argument or return value called by code
10390 compiled with @option{-mno-fp-regs} must also be compiled with that
10391 option.
10392
10393 A typical use of this option is building a kernel that does not use,
10394 and hence need not save and restore, any floating-point registers.
10395
10396 @item -mieee
10397 @opindex mieee
10398 The Alpha architecture implements floating-point hardware optimized for
10399 maximum performance.  It is mostly compliant with the IEEE floating
10400 point standard.  However, for full compliance, software assistance is
10401 required.  This option generates code fully IEEE compliant code
10402 @emph{except} that the @var{inexact-flag} is not maintained (see below).
10403 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
10404 defined during compilation.  The resulting code is less efficient but is
10405 able to correctly support denormalized numbers and exceptional IEEE
10406 values such as not-a-number and plus/minus infinity.  Other Alpha
10407 compilers call this option @option{-ieee_with_no_inexact}.
10408
10409 @item -mieee-with-inexact
10410 @opindex mieee-with-inexact
10411 This is like @option{-mieee} except the generated code also maintains
10412 the IEEE @var{inexact-flag}.  Turning on this option causes the
10413 generated code to implement fully-compliant IEEE math.  In addition to
10414 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
10415 macro.  On some Alpha implementations the resulting code may execute
10416 significantly slower than the code generated by default.  Since there is
10417 very little code that depends on the @var{inexact-flag}, you should
10418 normally not specify this option.  Other Alpha compilers call this
10419 option @option{-ieee_with_inexact}.
10420
10421 @item -mfp-trap-mode=@var{trap-mode}
10422 @opindex mfp-trap-mode
10423 This option controls what floating-point related traps are enabled.
10424 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
10425 The trap mode can be set to one of four values:
10426
10427 @table @samp
10428 @item n
10429 This is the default (normal) setting.  The only traps that are enabled
10430 are the ones that cannot be disabled in software (e.g., division by zero
10431 trap).
10432
10433 @item u
10434 In addition to the traps enabled by @samp{n}, underflow traps are enabled
10435 as well.
10436
10437 @item su
10438 Like @samp{u}, but the instructions are marked to be safe for software
10439 completion (see Alpha architecture manual for details).
10440
10441 @item sui
10442 Like @samp{su}, but inexact traps are enabled as well.
10443 @end table
10444
10445 @item -mfp-rounding-mode=@var{rounding-mode}
10446 @opindex mfp-rounding-mode
10447 Selects the IEEE rounding mode.  Other Alpha compilers call this option
10448 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
10449 of:
10450
10451 @table @samp
10452 @item n
10453 Normal IEEE rounding mode.  Floating point numbers are rounded towards
10454 the nearest machine number or towards the even machine number in case
10455 of a tie.
10456
10457 @item m
10458 Round towards minus infinity.
10459
10460 @item c
10461 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10462
10463 @item d
10464 Dynamic rounding mode.  A field in the floating point control register
10465 (@var{fpcr}, see Alpha architecture reference manual) controls the
10466 rounding mode in effect.  The C library initializes this register for
10467 rounding towards plus infinity.  Thus, unless your program modifies the
10468 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10469 @end table
10470
10471 @item -mtrap-precision=@var{trap-precision}
10472 @opindex mtrap-precision
10473 In the Alpha architecture, floating point traps are imprecise.  This
10474 means without software assistance it is impossible to recover from a
10475 floating trap and program execution normally needs to be terminated.
10476 GCC can generate code that can assist operating system trap handlers
10477 in determining the exact location that caused a floating point trap.
10478 Depending on the requirements of an application, different levels of
10479 precisions can be selected:
10480
10481 @table @samp
10482 @item p
10483 Program precision.  This option is the default and means a trap handler
10484 can only identify which program caused a floating point exception.
10485
10486 @item f
10487 Function precision.  The trap handler can determine the function that
10488 caused a floating point exception.
10489
10490 @item i
10491 Instruction precision.  The trap handler can determine the exact
10492 instruction that caused a floating point exception.
10493 @end table
10494
10495 Other Alpha compilers provide the equivalent options called
10496 @option{-scope_safe} and @option{-resumption_safe}.
10497
10498 @item -mieee-conformant
10499 @opindex mieee-conformant
10500 This option marks the generated code as IEEE conformant.  You must not
10501 use this option unless you also specify @option{-mtrap-precision=i} and either
10502 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10503 is to emit the line @samp{.eflag 48} in the function prologue of the
10504 generated assembly file.  Under DEC Unix, this has the effect that
10505 IEEE-conformant math library routines will be linked in.
10506
10507 @item -mbuild-constants
10508 @opindex mbuild-constants
10509 Normally GCC examines a 32- or 64-bit integer constant to
10510 see if it can construct it from smaller constants in two or three
10511 instructions.  If it cannot, it will output the constant as a literal and
10512 generate code to load it from the data segment at runtime.
10513
10514 Use this option to require GCC to construct @emph{all} integer constants
10515 using code, even if it takes more instructions (the maximum is six).
10516
10517 You would typically use this option to build a shared library dynamic
10518 loader.  Itself a shared library, it must relocate itself in memory
10519 before it can find the variables and constants in its own data segment.
10520
10521 @item -malpha-as
10522 @itemx -mgas
10523 @opindex malpha-as
10524 @opindex mgas
10525 Select whether to generate code to be assembled by the vendor-supplied
10526 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10527
10528 @item -mbwx
10529 @itemx -mno-bwx
10530 @itemx -mcix
10531 @itemx -mno-cix
10532 @itemx -mfix
10533 @itemx -mno-fix
10534 @itemx -mmax
10535 @itemx -mno-max
10536 @opindex mbwx
10537 @opindex mno-bwx
10538 @opindex mcix
10539 @opindex mno-cix
10540 @opindex mfix
10541 @opindex mno-fix
10542 @opindex mmax
10543 @opindex mno-max
10544 Indicate whether GCC should generate code to use the optional BWX,
10545 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10546 sets supported by the CPU type specified via @option{-mcpu=} option or that
10547 of the CPU on which GCC was built if none was specified.
10548
10549 @item -mfloat-vax
10550 @itemx -mfloat-ieee
10551 @opindex mfloat-vax
10552 @opindex mfloat-ieee
10553 Generate code that uses (does not use) VAX F and G floating point
10554 arithmetic instead of IEEE single and double precision.
10555
10556 @item -mexplicit-relocs
10557 @itemx -mno-explicit-relocs
10558 @opindex mexplicit-relocs
10559 @opindex mno-explicit-relocs
10560 Older Alpha assemblers provided no way to generate symbol relocations
10561 except via assembler macros.  Use of these macros does not allow
10562 optimal instruction scheduling.  GNU binutils as of version 2.12
10563 supports a new syntax that allows the compiler to explicitly mark
10564 which relocations should apply to which instructions.  This option
10565 is mostly useful for debugging, as GCC detects the capabilities of
10566 the assembler when it is built and sets the default accordingly.
10567
10568 @item -msmall-data
10569 @itemx -mlarge-data
10570 @opindex msmall-data
10571 @opindex mlarge-data
10572 When @option{-mexplicit-relocs} is in effect, static data is
10573 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10574 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
10575 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
10576 16-bit relocations off of the @code{$gp} register.  This limits the
10577 size of the small data area to 64KB, but allows the variables to be
10578 directly accessed via a single instruction.
10579
10580 The default is @option{-mlarge-data}.  With this option the data area
10581 is limited to just below 2GB@.  Programs that require more than 2GB of
10582 data must use @code{malloc} or @code{mmap} to allocate the data in the
10583 heap instead of in the program's data segment.
10584
10585 When generating code for shared libraries, @option{-fpic} implies
10586 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
10587
10588 @item -msmall-text
10589 @itemx -mlarge-text
10590 @opindex msmall-text
10591 @opindex mlarge-text
10592 When @option{-msmall-text} is used, the compiler assumes that the
10593 code of the entire program (or shared library) fits in 4MB, and is
10594 thus reachable with a branch instruction.  When @option{-msmall-data}
10595 is used, the compiler can assume that all local symbols share the
10596 same @code{$gp} value, and thus reduce the number of instructions
10597 required for a function call from 4 to 1.
10598
10599 The default is @option{-mlarge-text}.
10600
10601 @item -mcpu=@var{cpu_type}
10602 @opindex mcpu
10603 Set the instruction set and instruction scheduling parameters for
10604 machine type @var{cpu_type}.  You can specify either the @samp{EV}
10605 style name or the corresponding chip number.  GCC supports scheduling
10606 parameters for the EV4, EV5 and EV6 family of processors and will
10607 choose the default values for the instruction set from the processor
10608 you specify.  If you do not specify a processor type, GCC will default
10609 to the processor on which the compiler was built.
10610
10611 Supported values for @var{cpu_type} are
10612
10613 @table @samp
10614 @item ev4
10615 @itemx ev45
10616 @itemx 21064
10617 Schedules as an EV4 and has no instruction set extensions.
10618
10619 @item ev5
10620 @itemx 21164
10621 Schedules as an EV5 and has no instruction set extensions.
10622
10623 @item ev56
10624 @itemx 21164a
10625 Schedules as an EV5 and supports the BWX extension.
10626
10627 @item pca56
10628 @itemx 21164pc
10629 @itemx 21164PC
10630 Schedules as an EV5 and supports the BWX and MAX extensions.
10631
10632 @item ev6
10633 @itemx 21264
10634 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
10635
10636 @item ev67
10637 @itemx 21264a
10638 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
10639 @end table
10640
10641 Native Linux/GNU toolchains also support the value @samp{native},
10642 which selects the best architecture option for the host processor.
10643 @option{-mcpu=native} has no effect if GCC does not recognize
10644 the processor.
10645
10646 @item -mtune=@var{cpu_type}
10647 @opindex mtune
10648 Set only the instruction scheduling parameters for machine type
10649 @var{cpu_type}.  The instruction set is not changed.
10650
10651 Native Linux/GNU toolchains also support the value @samp{native},
10652 which selects the best architecture option for the host processor.
10653 @option{-mtune=native} has no effect if GCC does not recognize
10654 the processor.
10655
10656 @item -mmemory-latency=@var{time}
10657 @opindex mmemory-latency
10658 Sets the latency the scheduler should assume for typical memory
10659 references as seen by the application.  This number is highly
10660 dependent on the memory access patterns used by the application
10661 and the size of the external cache on the machine.
10662
10663 Valid options for @var{time} are
10664
10665 @table @samp
10666 @item @var{number}
10667 A decimal number representing clock cycles.
10668
10669 @item L1
10670 @itemx L2
10671 @itemx L3
10672 @itemx main
10673 The compiler contains estimates of the number of clock cycles for
10674 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
10675 (also called Dcache, Scache, and Bcache), as well as to main memory.
10676 Note that L3 is only valid for EV5.
10677
10678 @end table
10679 @end table
10680
10681 @node DEC Alpha/VMS Options
10682 @subsection DEC Alpha/VMS Options
10683
10684 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
10685
10686 @table @gcctabopt
10687 @item -mvms-return-codes
10688 @opindex mvms-return-codes
10689 Return VMS condition codes from main. The default is to return POSIX
10690 style condition (e.g.@: error) codes.
10691
10692 @item -mdebug-main=@var{prefix}
10693 @opindex mdebug-main=@var{prefix}
10694 Flag the first routine whose name starts with @var{prefix} as the main
10695 routine for the debugger.
10696
10697 @item -mmalloc64
10698 @opindex mmalloc64
10699 Default to 64bit memory allocation routines.
10700 @end table
10701
10702 @node FR30 Options
10703 @subsection FR30 Options
10704 @cindex FR30 Options
10705
10706 These options are defined specifically for the FR30 port.
10707
10708 @table @gcctabopt
10709
10710 @item -msmall-model
10711 @opindex msmall-model
10712 Use the small address space model.  This can produce smaller code, but
10713 it does assume that all symbolic values and addresses will fit into a
10714 20-bit range.
10715
10716 @item -mno-lsim
10717 @opindex mno-lsim
10718 Assume that run-time support has been provided and so there is no need
10719 to include the simulator library (@file{libsim.a}) on the linker
10720 command line.
10721
10722 @end table
10723
10724 @node FRV Options
10725 @subsection FRV Options
10726 @cindex FRV Options
10727
10728 @table @gcctabopt
10729 @item -mgpr-32
10730 @opindex mgpr-32
10731
10732 Only use the first 32 general purpose registers.
10733
10734 @item -mgpr-64
10735 @opindex mgpr-64
10736
10737 Use all 64 general purpose registers.
10738
10739 @item -mfpr-32
10740 @opindex mfpr-32
10741
10742 Use only the first 32 floating point registers.
10743
10744 @item -mfpr-64
10745 @opindex mfpr-64
10746
10747 Use all 64 floating point registers
10748
10749 @item -mhard-float
10750 @opindex mhard-float
10751
10752 Use hardware instructions for floating point operations.
10753
10754 @item -msoft-float
10755 @opindex msoft-float
10756
10757 Use library routines for floating point operations.
10758
10759 @item -malloc-cc
10760 @opindex malloc-cc
10761
10762 Dynamically allocate condition code registers.
10763
10764 @item -mfixed-cc
10765 @opindex mfixed-cc
10766
10767 Do not try to dynamically allocate condition code registers, only
10768 use @code{icc0} and @code{fcc0}.
10769
10770 @item -mdword
10771 @opindex mdword
10772
10773 Change ABI to use double word insns.
10774
10775 @item -mno-dword
10776 @opindex mno-dword
10777
10778 Do not use double word instructions.
10779
10780 @item -mdouble
10781 @opindex mdouble
10782
10783 Use floating point double instructions.
10784
10785 @item -mno-double
10786 @opindex mno-double
10787
10788 Do not use floating point double instructions.
10789
10790 @item -mmedia
10791 @opindex mmedia
10792
10793 Use media instructions.
10794
10795 @item -mno-media
10796 @opindex mno-media
10797
10798 Do not use media instructions.
10799
10800 @item -mmuladd
10801 @opindex mmuladd
10802
10803 Use multiply and add/subtract instructions.
10804
10805 @item -mno-muladd
10806 @opindex mno-muladd
10807
10808 Do not use multiply and add/subtract instructions.
10809
10810 @item -mfdpic
10811 @opindex mfdpic
10812
10813 Select the FDPIC ABI, that uses function descriptors to represent
10814 pointers to functions.  Without any PIC/PIE-related options, it
10815 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
10816 assumes GOT entries and small data are within a 12-bit range from the
10817 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
10818 are computed with 32 bits.
10819 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10820
10821 @item -minline-plt
10822 @opindex minline-plt
10823
10824 Enable inlining of PLT entries in function calls to functions that are
10825 not known to bind locally.  It has no effect without @option{-mfdpic}.
10826 It's enabled by default if optimizing for speed and compiling for
10827 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
10828 optimization option such as @option{-O3} or above is present in the
10829 command line.
10830
10831 @item -mTLS
10832 @opindex mTLS
10833
10834 Assume a large TLS segment when generating thread-local code.
10835
10836 @item -mtls
10837 @opindex mtls
10838
10839 Do not assume a large TLS segment when generating thread-local code.
10840
10841 @item -mgprel-ro
10842 @opindex mgprel-ro
10843
10844 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
10845 that is known to be in read-only sections.  It's enabled by default,
10846 except for @option{-fpic} or @option{-fpie}: even though it may help
10847 make the global offset table smaller, it trades 1 instruction for 4.
10848 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
10849 one of which may be shared by multiple symbols, and it avoids the need
10850 for a GOT entry for the referenced symbol, so it's more likely to be a
10851 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
10852
10853 @item -multilib-library-pic
10854 @opindex multilib-library-pic
10855
10856 Link with the (library, not FD) pic libraries.  It's implied by
10857 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
10858 @option{-fpic} without @option{-mfdpic}.  You should never have to use
10859 it explicitly.
10860
10861 @item -mlinked-fp
10862 @opindex mlinked-fp
10863
10864 Follow the EABI requirement of always creating a frame pointer whenever
10865 a stack frame is allocated.  This option is enabled by default and can
10866 be disabled with @option{-mno-linked-fp}.
10867
10868 @item -mlong-calls
10869 @opindex mlong-calls
10870
10871 Use indirect addressing to call functions outside the current
10872 compilation unit.  This allows the functions to be placed anywhere
10873 within the 32-bit address space.
10874
10875 @item -malign-labels
10876 @opindex malign-labels
10877
10878 Try to align labels to an 8-byte boundary by inserting nops into the
10879 previous packet.  This option only has an effect when VLIW packing
10880 is enabled.  It doesn't create new packets; it merely adds nops to
10881 existing ones.
10882
10883 @item -mlibrary-pic
10884 @opindex mlibrary-pic
10885
10886 Generate position-independent EABI code.
10887
10888 @item -macc-4
10889 @opindex macc-4
10890
10891 Use only the first four media accumulator registers.
10892
10893 @item -macc-8
10894 @opindex macc-8
10895
10896 Use all eight media accumulator registers.
10897
10898 @item -mpack
10899 @opindex mpack
10900
10901 Pack VLIW instructions.
10902
10903 @item -mno-pack
10904 @opindex mno-pack
10905
10906 Do not pack VLIW instructions.
10907
10908 @item -mno-eflags
10909 @opindex mno-eflags
10910
10911 Do not mark ABI switches in e_flags.
10912
10913 @item -mcond-move
10914 @opindex mcond-move
10915
10916 Enable the use of conditional-move instructions (default).
10917
10918 This switch is mainly for debugging the compiler and will likely be removed
10919 in a future version.
10920
10921 @item -mno-cond-move
10922 @opindex mno-cond-move
10923
10924 Disable the use of conditional-move instructions.
10925
10926 This switch is mainly for debugging the compiler and will likely be removed
10927 in a future version.
10928
10929 @item -mscc
10930 @opindex mscc
10931
10932 Enable the use of conditional set instructions (default).
10933
10934 This switch is mainly for debugging the compiler and will likely be removed
10935 in a future version.
10936
10937 @item -mno-scc
10938 @opindex mno-scc
10939
10940 Disable the use of conditional set instructions.
10941
10942 This switch is mainly for debugging the compiler and will likely be removed
10943 in a future version.
10944
10945 @item -mcond-exec
10946 @opindex mcond-exec
10947
10948 Enable the use of conditional execution (default).
10949
10950 This switch is mainly for debugging the compiler and will likely be removed
10951 in a future version.
10952
10953 @item -mno-cond-exec
10954 @opindex mno-cond-exec
10955
10956 Disable the use of conditional execution.
10957
10958 This switch is mainly for debugging the compiler and will likely be removed
10959 in a future version.
10960
10961 @item -mvliw-branch
10962 @opindex mvliw-branch
10963
10964 Run a pass to pack branches into VLIW instructions (default).
10965
10966 This switch is mainly for debugging the compiler and will likely be removed
10967 in a future version.
10968
10969 @item -mno-vliw-branch
10970 @opindex mno-vliw-branch
10971
10972 Do not run a pass to pack branches into VLIW instructions.
10973
10974 This switch is mainly for debugging the compiler and will likely be removed
10975 in a future version.
10976
10977 @item -mmulti-cond-exec
10978 @opindex mmulti-cond-exec
10979
10980 Enable optimization of @code{&&} and @code{||} in conditional execution
10981 (default).
10982
10983 This switch is mainly for debugging the compiler and will likely be removed
10984 in a future version.
10985
10986 @item -mno-multi-cond-exec
10987 @opindex mno-multi-cond-exec
10988
10989 Disable optimization of @code{&&} and @code{||} in conditional execution.
10990
10991 This switch is mainly for debugging the compiler and will likely be removed
10992 in a future version.
10993
10994 @item -mnested-cond-exec
10995 @opindex mnested-cond-exec
10996
10997 Enable nested conditional execution optimizations (default).
10998
10999 This switch is mainly for debugging the compiler and will likely be removed
11000 in a future version.
11001
11002 @item -mno-nested-cond-exec
11003 @opindex mno-nested-cond-exec
11004
11005 Disable nested conditional execution optimizations.
11006
11007 This switch is mainly for debugging the compiler and will likely be removed
11008 in a future version.
11009
11010 @item -moptimize-membar
11011 @opindex moptimize-membar
11012
11013 This switch removes redundant @code{membar} instructions from the
11014 compiler generated code.  It is enabled by default.
11015
11016 @item -mno-optimize-membar
11017 @opindex mno-optimize-membar
11018
11019 This switch disables the automatic removal of redundant @code{membar}
11020 instructions from the generated code.
11021
11022 @item -mtomcat-stats
11023 @opindex mtomcat-stats
11024
11025 Cause gas to print out tomcat statistics.
11026
11027 @item -mcpu=@var{cpu}
11028 @opindex mcpu
11029
11030 Select the processor type for which to generate code.  Possible values are
11031 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11032 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11033
11034 @end table
11035
11036 @node GNU/Linux Options
11037 @subsection GNU/Linux Options
11038
11039 These @samp{-m} options are defined for GNU/Linux targets:
11040
11041 @table @gcctabopt
11042 @item -mglibc
11043 @opindex mglibc
11044 Use the GNU C library instead of uClibc.  This is the default except
11045 on @samp{*-*-linux-*uclibc*} targets.
11046
11047 @item -muclibc
11048 @opindex muclibc
11049 Use uClibc instead of the GNU C library.  This is the default on
11050 @samp{*-*-linux-*uclibc*} targets.
11051 @end table
11052
11053 @node H8/300 Options
11054 @subsection H8/300 Options
11055
11056 These @samp{-m} options are defined for the H8/300 implementations:
11057
11058 @table @gcctabopt
11059 @item -mrelax
11060 @opindex mrelax
11061 Shorten some address references at link time, when possible; uses the
11062 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11063 ld, Using ld}, for a fuller description.
11064
11065 @item -mh
11066 @opindex mh
11067 Generate code for the H8/300H@.
11068
11069 @item -ms
11070 @opindex ms
11071 Generate code for the H8S@.
11072
11073 @item -mn
11074 @opindex mn
11075 Generate code for the H8S and H8/300H in the normal mode.  This switch
11076 must be used either with @option{-mh} or @option{-ms}.
11077
11078 @item -ms2600
11079 @opindex ms2600
11080 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11081
11082 @item -mint32
11083 @opindex mint32
11084 Make @code{int} data 32 bits by default.
11085
11086 @item -malign-300
11087 @opindex malign-300
11088 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11089 The default for the H8/300H and H8S is to align longs and floats on 4
11090 byte boundaries.
11091 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11092 This option has no effect on the H8/300.
11093 @end table
11094
11095 @node HPPA Options
11096 @subsection HPPA Options
11097 @cindex HPPA Options
11098
11099 These @samp{-m} options are defined for the HPPA family of computers:
11100
11101 @table @gcctabopt
11102 @item -march=@var{architecture-type}
11103 @opindex march
11104 Generate code for the specified architecture.  The choices for
11105 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11106 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11107 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11108 architecture option for your machine.  Code compiled for lower numbered
11109 architectures will run on higher numbered architectures, but not the
11110 other way around.
11111
11112 @item -mpa-risc-1-0
11113 @itemx -mpa-risc-1-1
11114 @itemx -mpa-risc-2-0
11115 @opindex mpa-risc-1-0
11116 @opindex mpa-risc-1-1
11117 @opindex mpa-risc-2-0
11118 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11119
11120 @item -mbig-switch
11121 @opindex mbig-switch
11122 Generate code suitable for big switch tables.  Use this option only if
11123 the assembler/linker complain about out of range branches within a switch
11124 table.
11125
11126 @item -mjump-in-delay
11127 @opindex mjump-in-delay
11128 Fill delay slots of function calls with unconditional jump instructions
11129 by modifying the return pointer for the function call to be the target
11130 of the conditional jump.
11131
11132 @item -mdisable-fpregs
11133 @opindex mdisable-fpregs
11134 Prevent floating point registers from being used in any manner.  This is
11135 necessary for compiling kernels which perform lazy context switching of
11136 floating point registers.  If you use this option and attempt to perform
11137 floating point operations, the compiler will abort.
11138
11139 @item -mdisable-indexing
11140 @opindex mdisable-indexing
11141 Prevent the compiler from using indexing address modes.  This avoids some
11142 rather obscure problems when compiling MIG generated code under MACH@.
11143
11144 @item -mno-space-regs
11145 @opindex mno-space-regs
11146 Generate code that assumes the target has no space registers.  This allows
11147 GCC to generate faster indirect calls and use unscaled index address modes.
11148
11149 Such code is suitable for level 0 PA systems and kernels.
11150
11151 @item -mfast-indirect-calls
11152 @opindex mfast-indirect-calls
11153 Generate code that assumes calls never cross space boundaries.  This
11154 allows GCC to emit code which performs faster indirect calls.
11155
11156 This option will not work in the presence of shared libraries or nested
11157 functions.
11158
11159 @item -mfixed-range=@var{register-range}
11160 @opindex mfixed-range
11161 Generate code treating the given register range as fixed registers.
11162 A fixed register is one that the register allocator can not use.  This is
11163 useful when compiling kernel code.  A register range is specified as
11164 two registers separated by a dash.  Multiple register ranges can be
11165 specified separated by a comma.
11166
11167 @item -mlong-load-store
11168 @opindex mlong-load-store
11169 Generate 3-instruction load and store sequences as sometimes required by
11170 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11171 the HP compilers.
11172
11173 @item -mportable-runtime
11174 @opindex mportable-runtime
11175 Use the portable calling conventions proposed by HP for ELF systems.
11176
11177 @item -mgas
11178 @opindex mgas
11179 Enable the use of assembler directives only GAS understands.
11180
11181 @item -mschedule=@var{cpu-type}
11182 @opindex mschedule
11183 Schedule code according to the constraints for the machine type
11184 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11185 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11186 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11187 proper scheduling option for your machine.  The default scheduling is
11188 @samp{8000}.
11189
11190 @item -mlinker-opt
11191 @opindex mlinker-opt
11192 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11193 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11194 linkers in which they give bogus error messages when linking some programs.
11195
11196 @item -msoft-float
11197 @opindex msoft-float
11198 Generate output containing library calls for floating point.
11199 @strong{Warning:} the requisite libraries are not available for all HPPA
11200 targets.  Normally the facilities of the machine's usual C compiler are
11201 used, but this cannot be done directly in cross-compilation.  You must make
11202 your own arrangements to provide suitable library functions for
11203 cross-compilation.
11204
11205 @option{-msoft-float} changes the calling convention in the output file;
11206 therefore, it is only useful if you compile @emph{all} of a program with
11207 this option.  In particular, you need to compile @file{libgcc.a}, the
11208 library that comes with GCC, with @option{-msoft-float} in order for
11209 this to work.
11210
11211 @item -msio
11212 @opindex msio
11213 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11214 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11215 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11216 options are available under HP-UX and HI-UX@.
11217
11218 @item -mgnu-ld
11219 @opindex mgnu-ld
11220 Use GNU ld specific options.  This passes @option{-shared} to ld when
11221 building a shared library.  It is the default when GCC is configured,
11222 explicitly or implicitly, with the GNU linker.  This option does not
11223 have any affect on which ld is called, it only changes what parameters
11224 are passed to that ld.  The ld that is called is determined by the
11225 @option{--with-ld} configure option, GCC's program search path, and
11226 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11227 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11228 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11229
11230 @item -mhp-ld
11231 @opindex mhp-ld
11232 Use HP ld specific options.  This passes @option{-b} to ld when building
11233 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11234 links.  It is the default when GCC is configured, explicitly or
11235 implicitly, with the HP linker.  This option does not have any affect on
11236 which ld is called, it only changes what parameters are passed to that
11237 ld.  The ld that is called is determined by the @option{--with-ld}
11238 configure option, GCC's program search path, and finally by the user's
11239 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11240 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11241 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11242
11243 @item -mlong-calls
11244 @opindex mno-long-calls
11245 Generate code that uses long call sequences.  This ensures that a call
11246 is always able to reach linker generated stubs.  The default is to generate
11247 long calls only when the distance from the call site to the beginning
11248 of the function or translation unit, as the case may be, exceeds a
11249 predefined limit set by the branch type being used.  The limits for
11250 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11251 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11252 240,000 bytes.
11253
11254 Distances are measured from the beginning of functions when using the
11255 @option{-ffunction-sections} option, or when using the @option{-mgas}
11256 and @option{-mno-portable-runtime} options together under HP-UX with
11257 the SOM linker.
11258
11259 It is normally not desirable to use this option as it will degrade
11260 performance.  However, it may be useful in large applications,
11261 particularly when partial linking is used to build the application.
11262
11263 The types of long calls used depends on the capabilities of the
11264 assembler and linker, and the type of code being generated.  The
11265 impact on systems that support long absolute calls, and long pic
11266 symbol-difference or pc-relative calls should be relatively small.
11267 However, an indirect call is used on 32-bit ELF systems in pic code
11268 and it is quite long.
11269
11270 @item -munix=@var{unix-std}
11271 @opindex march
11272 Generate compiler predefines and select a startfile for the specified
11273 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11274 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11275 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11276 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11277 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11278 and later.
11279
11280 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11281 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11282 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11283 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11284 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11285 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11286
11287 It is @emph{important} to note that this option changes the interfaces
11288 for various library routines.  It also affects the operational behavior
11289 of the C library.  Thus, @emph{extreme} care is needed in using this
11290 option.
11291
11292 Library code that is intended to operate with more than one UNIX
11293 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11294 as appropriate.  Most GNU software doesn't provide this capability.
11295
11296 @item -nolibdld
11297 @opindex nolibdld
11298 Suppress the generation of link options to search libdld.sl when the
11299 @option{-static} option is specified on HP-UX 10 and later.
11300
11301 @item -static
11302 @opindex static
11303 The HP-UX implementation of setlocale in libc has a dependency on
11304 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11305 when the @option{-static} option is specified, special link options
11306 are needed to resolve this dependency.
11307
11308 On HP-UX 10 and later, the GCC driver adds the necessary options to
11309 link with libdld.sl when the @option{-static} option is specified.
11310 This causes the resulting binary to be dynamic.  On the 64-bit port,
11311 the linkers generate dynamic binaries by default in any case.  The
11312 @option{-nolibdld} option can be used to prevent the GCC driver from
11313 adding these link options.
11314
11315 @item -threads
11316 @opindex threads
11317 Add support for multithreading with the @dfn{dce thread} library
11318 under HP-UX@.  This option sets flags for both the preprocessor and
11319 linker.
11320 @end table
11321
11322 @node i386 and x86-64 Options
11323 @subsection Intel 386 and AMD x86-64 Options
11324 @cindex i386 Options
11325 @cindex x86-64 Options
11326 @cindex Intel 386 Options
11327 @cindex AMD x86-64 Options
11328
11329 These @samp{-m} options are defined for the i386 and x86-64 family of
11330 computers:
11331
11332 @table @gcctabopt
11333 @item -mtune=@var{cpu-type}
11334 @opindex mtune
11335 Tune to @var{cpu-type} everything applicable about the generated code, except
11336 for the ABI and the set of available instructions.  The choices for
11337 @var{cpu-type} are:
11338 @table @emph
11339 @item generic
11340 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11341 If you know the CPU on which your code will run, then you should use
11342 the corresponding @option{-mtune} option instead of
11343 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11344 of your application will have, then you should use this option.
11345
11346 As new processors are deployed in the marketplace, the behavior of this
11347 option will change.  Therefore, if you upgrade to a newer version of
11348 GCC, the code generated option will change to reflect the processors
11349 that were most common when that version of GCC was released.
11350
11351 There is no @option{-march=generic} option because @option{-march}
11352 indicates the instruction set the compiler can use, and there is no
11353 generic instruction set applicable to all processors.  In contrast,
11354 @option{-mtune} indicates the processor (or, in this case, collection of
11355 processors) for which the code is optimized.
11356 @item native
11357 This selects the CPU to tune for at compilation time by determining
11358 the processor type of the compiling machine.  Using @option{-mtune=native}
11359 will produce code optimized for the local machine under the constraints
11360 of the selected instruction set.  Using @option{-march=native} will
11361 enable all instruction subsets supported by the local machine (hence
11362 the result might not run on different machines).
11363 @item i386
11364 Original Intel's i386 CPU@.
11365 @item i486
11366 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11367 @item i586, pentium
11368 Intel Pentium CPU with no MMX support.
11369 @item pentium-mmx
11370 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11371 @item pentiumpro
11372 Intel PentiumPro CPU@.
11373 @item i686
11374 Same as @code{generic}, but when used as @code{march} option, PentiumPro
11375 instruction set will be used, so the code will run on all i686 family chips.
11376 @item pentium2
11377 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
11378 @item pentium3, pentium3m
11379 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
11380 support.
11381 @item pentium-m
11382 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
11383 support.  Used by Centrino notebooks.
11384 @item pentium4, pentium4m
11385 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
11386 @item prescott
11387 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
11388 set support.
11389 @item nocona
11390 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
11391 SSE2 and SSE3 instruction set support.
11392 @item core2
11393 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11394 instruction set support.
11395 @item atom
11396 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11397 instruction set support.
11398 @item k6
11399 AMD K6 CPU with MMX instruction set support.
11400 @item k6-2, k6-3
11401 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
11402 @item athlon, athlon-tbird
11403 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
11404 support.
11405 @item athlon-4, athlon-xp, athlon-mp
11406 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
11407 instruction set support.
11408 @item k8, opteron, athlon64, athlon-fx
11409 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
11410 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
11411 @item k8-sse3, opteron-sse3, athlon64-sse3
11412 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
11413 @item amdfam10, barcelona
11414 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
11415 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
11416 instruction set extensions.)
11417 @item winchip-c6
11418 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
11419 set support.
11420 @item winchip2
11421 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
11422 instruction set support.
11423 @item c3
11424 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
11425 implemented for this chip.)
11426 @item c3-2
11427 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
11428 implemented for this chip.)
11429 @item geode
11430 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
11431 @end table
11432
11433 While picking a specific @var{cpu-type} will schedule things appropriately
11434 for that particular chip, the compiler will not generate any code that
11435 does not run on the i386 without the @option{-march=@var{cpu-type}} option
11436 being used.
11437
11438 @item -march=@var{cpu-type}
11439 @opindex march
11440 Generate instructions for the machine type @var{cpu-type}.  The choices
11441 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
11442 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
11443
11444 @item -mcpu=@var{cpu-type}
11445 @opindex mcpu
11446 A deprecated synonym for @option{-mtune}.
11447
11448 @item -mfpmath=@var{unit}
11449 @opindex mfpmath
11450 Generate floating point arithmetics for selected unit @var{unit}.  The choices
11451 for @var{unit} are:
11452
11453 @table @samp
11454 @item 387
11455 Use the standard 387 floating point coprocessor present majority of chips and
11456 emulated otherwise.  Code compiled with this option will run almost everywhere.
11457 The temporary results are computed in 80bit precision instead of precision
11458 specified by the type resulting in slightly different results compared to most
11459 of other chips.  See @option{-ffloat-store} for more detailed description.
11460
11461 This is the default choice for i386 compiler.
11462
11463 @item sse
11464 Use scalar floating point instructions present in the SSE instruction set.
11465 This instruction set is supported by Pentium3 and newer chips, in the AMD line
11466 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
11467 instruction set supports only single precision arithmetics, thus the double and
11468 extended precision arithmetics is still done using 387.  Later version, present
11469 only in Pentium4 and the future AMD x86-64 chips supports double precision
11470 arithmetics too.
11471
11472 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
11473 or @option{-msse2} switches to enable SSE extensions and make this option
11474 effective.  For the x86-64 compiler, these extensions are enabled by default.
11475
11476 The resulting code should be considerably faster in the majority of cases and avoid
11477 the numerical instability problems of 387 code, but may break some existing
11478 code that expects temporaries to be 80bit.
11479
11480 This is the default choice for the x86-64 compiler.
11481
11482 @item sse,387
11483 @itemx sse+387
11484 @itemx both
11485 Attempt to utilize both instruction sets at once.  This effectively double the
11486 amount of available registers and on chips with separate execution units for
11487 387 and SSE the execution resources too.  Use this option with care, as it is
11488 still experimental, because the GCC register allocator does not model separate
11489 functional units well resulting in instable performance.
11490 @end table
11491
11492 @item -masm=@var{dialect}
11493 @opindex masm=@var{dialect}
11494 Output asm instructions using selected @var{dialect}.  Supported
11495 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
11496 not support @samp{intel}.
11497
11498 @item -mieee-fp
11499 @itemx -mno-ieee-fp
11500 @opindex mieee-fp
11501 @opindex mno-ieee-fp
11502 Control whether or not the compiler uses IEEE floating point
11503 comparisons.  These handle correctly the case where the result of a
11504 comparison is unordered.
11505
11506 @item -msoft-float
11507 @opindex msoft-float
11508 Generate output containing library calls for floating point.
11509 @strong{Warning:} the requisite libraries are not part of GCC@.
11510 Normally the facilities of the machine's usual C compiler are used, but
11511 this can't be done directly in cross-compilation.  You must make your
11512 own arrangements to provide suitable library functions for
11513 cross-compilation.
11514
11515 On machines where a function returns floating point results in the 80387
11516 register stack, some floating point opcodes may be emitted even if
11517 @option{-msoft-float} is used.
11518
11519 @item -mno-fp-ret-in-387
11520 @opindex mno-fp-ret-in-387
11521 Do not use the FPU registers for return values of functions.
11522
11523 The usual calling convention has functions return values of types
11524 @code{float} and @code{double} in an FPU register, even if there
11525 is no FPU@.  The idea is that the operating system should emulate
11526 an FPU@.
11527
11528 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11529 in ordinary CPU registers instead.
11530
11531 @item -mno-fancy-math-387
11532 @opindex mno-fancy-math-387
11533 Some 387 emulators do not support the @code{sin}, @code{cos} and
11534 @code{sqrt} instructions for the 387.  Specify this option to avoid
11535 generating those instructions.  This option is the default on FreeBSD,
11536 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11537 indicates that the target cpu will always have an FPU and so the
11538 instruction will not need emulation.  As of revision 2.6.1, these
11539 instructions are not generated unless you also use the
11540 @option{-funsafe-math-optimizations} switch.
11541
11542 @item -malign-double
11543 @itemx -mno-align-double
11544 @opindex malign-double
11545 @opindex mno-align-double
11546 Control whether GCC aligns @code{double}, @code{long double}, and
11547 @code{long long} variables on a two word boundary or a one word
11548 boundary.  Aligning @code{double} variables on a two word boundary will
11549 produce code that runs somewhat faster on a @samp{Pentium} at the
11550 expense of more memory.
11551
11552 On x86-64, @option{-malign-double} is enabled by default.
11553
11554 @strong{Warning:} if you use the @option{-malign-double} switch,
11555 structures containing the above types will be aligned differently than
11556 the published application binary interface specifications for the 386
11557 and will not be binary compatible with structures in code compiled
11558 without that switch.
11559
11560 @item -m96bit-long-double
11561 @itemx -m128bit-long-double
11562 @opindex m96bit-long-double
11563 @opindex m128bit-long-double
11564 These switches control the size of @code{long double} type.  The i386
11565 application binary interface specifies the size to be 96 bits,
11566 so @option{-m96bit-long-double} is the default in 32 bit mode.
11567
11568 Modern architectures (Pentium and newer) would prefer @code{long double}
11569 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11570 conforming to the ABI, this would not be possible.  So specifying a
11571 @option{-m128bit-long-double} will align @code{long double}
11572 to a 16 byte boundary by padding the @code{long double} with an additional
11573 32 bit zero.
11574
11575 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
11576 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
11577
11578 Notice that neither of these options enable any extra precision over the x87
11579 standard of 80 bits for a @code{long double}.
11580
11581 @strong{Warning:} if you override the default value for your target ABI, the
11582 structures and arrays containing @code{long double} variables will change
11583 their size as well as function calling convention for function taking
11584 @code{long double} will be modified.  Hence they will not be binary
11585 compatible with arrays or structures in code compiled without that switch.
11586
11587 @item -mlarge-data-threshold=@var{number}
11588 @opindex mlarge-data-threshold=@var{number}
11589 When @option{-mcmodel=medium} is specified, the data greater than
11590 @var{threshold} are placed in large data section.  This value must be the
11591 same across all object linked into the binary and defaults to 65535.
11592
11593 @item -mrtd
11594 @opindex mrtd
11595 Use a different function-calling convention, in which functions that
11596 take a fixed number of arguments return with the @code{ret} @var{num}
11597 instruction, which pops their arguments while returning.  This saves one
11598 instruction in the caller since there is no need to pop the arguments
11599 there.
11600
11601 You can specify that an individual function is called with this calling
11602 sequence with the function attribute @samp{stdcall}.  You can also
11603 override the @option{-mrtd} option by using the function attribute
11604 @samp{cdecl}.  @xref{Function Attributes}.
11605
11606 @strong{Warning:} this calling convention is incompatible with the one
11607 normally used on Unix, so you cannot use it if you need to call
11608 libraries compiled with the Unix compiler.
11609
11610 Also, you must provide function prototypes for all functions that
11611 take variable numbers of arguments (including @code{printf});
11612 otherwise incorrect code will be generated for calls to those
11613 functions.
11614
11615 In addition, seriously incorrect code will result if you call a
11616 function with too many arguments.  (Normally, extra arguments are
11617 harmlessly ignored.)
11618
11619 @item -mregparm=@var{num}
11620 @opindex mregparm
11621 Control how many registers are used to pass integer arguments.  By
11622 default, no registers are used to pass arguments, and at most 3
11623 registers can be used.  You can control this behavior for a specific
11624 function by using the function attribute @samp{regparm}.
11625 @xref{Function Attributes}.
11626
11627 @strong{Warning:} if you use this switch, and
11628 @var{num} is nonzero, then you must build all modules with the same
11629 value, including any libraries.  This includes the system libraries and
11630 startup modules.
11631
11632 @item -msseregparm
11633 @opindex msseregparm
11634 Use SSE register passing conventions for float and double arguments
11635 and return values.  You can control this behavior for a specific
11636 function by using the function attribute @samp{sseregparm}.
11637 @xref{Function Attributes}.
11638
11639 @strong{Warning:} if you use this switch then you must build all
11640 modules with the same value, including any libraries.  This includes
11641 the system libraries and startup modules.
11642
11643 @item -mpc32
11644 @itemx -mpc64
11645 @itemx -mpc80
11646 @opindex mpc32
11647 @opindex mpc64
11648 @opindex mpc80
11649
11650 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
11651 is specified, the significands of results of floating-point operations are
11652 rounded to 24 bits (single precision); @option{-mpc64} rounds the
11653 significands of results of floating-point operations to 53 bits (double
11654 precision) and @option{-mpc80} rounds the significands of results of
11655 floating-point operations to 64 bits (extended double precision), which is
11656 the default.  When this option is used, floating-point operations in higher
11657 precisions are not available to the programmer without setting the FPU
11658 control word explicitly.
11659
11660 Setting the rounding of floating-point operations to less than the default
11661 80 bits can speed some programs by 2% or more.  Note that some mathematical
11662 libraries assume that extended precision (80 bit) floating-point operations
11663 are enabled by default; routines in such libraries could suffer significant
11664 loss of accuracy, typically through so-called "catastrophic cancellation",
11665 when this option is used to set the precision to less than extended precision.
11666
11667 @item -mstackrealign
11668 @opindex mstackrealign
11669 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
11670 option will generate an alternate prologue and epilogue that realigns the
11671 runtime stack if necessary.  This supports mixing legacy codes that keep
11672 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
11673 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
11674 applicable to individual functions.
11675
11676 @item -mpreferred-stack-boundary=@var{num}
11677 @opindex mpreferred-stack-boundary
11678 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
11679 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
11680 the default is 4 (16 bytes or 128 bits).
11681
11682 @item -mincoming-stack-boundary=@var{num}
11683 @opindex mincoming-stack-boundary
11684 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
11685 boundary.  If @option{-mincoming-stack-boundary} is not specified,
11686 the one specified by @option{-mpreferred-stack-boundary} will be used.
11687
11688 On Pentium and PentiumPro, @code{double} and @code{long double} values
11689 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
11690 suffer significant run time performance penalties.  On Pentium III, the
11691 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
11692 properly if it is not 16 byte aligned.
11693
11694 To ensure proper alignment of this values on the stack, the stack boundary
11695 must be as aligned as that required by any value stored on the stack.
11696 Further, every function must be generated such that it keeps the stack
11697 aligned.  Thus calling a function compiled with a higher preferred
11698 stack boundary from a function compiled with a lower preferred stack
11699 boundary will most likely misalign the stack.  It is recommended that
11700 libraries that use callbacks always use the default setting.
11701
11702 This extra alignment does consume extra stack space, and generally
11703 increases code size.  Code that is sensitive to stack space usage, such
11704 as embedded systems and operating system kernels, may want to reduce the
11705 preferred alignment to @option{-mpreferred-stack-boundary=2}.
11706
11707 @item -mmmx
11708 @itemx -mno-mmx
11709 @itemx -msse
11710 @itemx -mno-sse
11711 @itemx -msse2
11712 @itemx -mno-sse2
11713 @itemx -msse3
11714 @itemx -mno-sse3
11715 @itemx -mssse3
11716 @itemx -mno-ssse3
11717 @itemx -msse4.1
11718 @itemx -mno-sse4.1
11719 @itemx -msse4.2
11720 @itemx -mno-sse4.2
11721 @itemx -msse4
11722 @itemx -mno-sse4
11723 @itemx -mavx
11724 @itemx -mno-avx
11725 @itemx -maes
11726 @itemx -mno-aes
11727 @itemx -mpclmul
11728 @itemx -mno-pclmul
11729 @itemx -msse4a
11730 @itemx -mno-sse4a
11731 @itemx -m3dnow
11732 @itemx -mno-3dnow
11733 @itemx -mpopcnt
11734 @itemx -mno-popcnt
11735 @itemx -mabm
11736 @itemx -mno-abm
11737 @opindex mmmx
11738 @opindex mno-mmx
11739 @opindex msse
11740 @opindex mno-sse
11741 @opindex m3dnow
11742 @opindex mno-3dnow
11743 These switches enable or disable the use of instructions in the MMX,
11744 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, ABM or
11745 3DNow!@: extended instruction sets.
11746 These extensions are also available as built-in functions: see
11747 @ref{X86 Built-in Functions}, for details of the functions enabled and
11748 disabled by these switches.
11749
11750 To have SSE/SSE2 instructions generated automatically from floating-point
11751 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
11752
11753 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
11754 generates new AVX instructions or AVX equivalence for all SSEx instructions
11755 when needed.
11756
11757 These options will enable GCC to use these extended instructions in
11758 generated code, even without @option{-mfpmath=sse}.  Applications which
11759 perform runtime CPU detection must compile separate files for each
11760 supported architecture, using the appropriate flags.  In particular,
11761 the file containing the CPU detection code should be compiled without
11762 these options.
11763
11764 @item -mcld
11765 @opindex mcld
11766 This option instructs GCC to emit a @code{cld} instruction in the prologue
11767 of functions that use string instructions.  String instructions depend on
11768 the DF flag to select between autoincrement or autodecrement mode.  While the
11769 ABI specifies the DF flag to be cleared on function entry, some operating
11770 systems violate this specification by not clearing the DF flag in their
11771 exception dispatchers.  The exception handler can be invoked with the DF flag
11772 set which leads to wrong direction mode, when string instructions are used.
11773 This option can be enabled by default on 32-bit x86 targets by configuring
11774 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
11775 instructions can be suppressed with the @option{-mno-cld} compiler option
11776 in this case.
11777
11778 @item -mcx16
11779 @opindex mcx16
11780 This option will enable GCC to use CMPXCHG16B instruction in generated code.
11781 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
11782 data types.  This is useful for high resolution counters that could be updated
11783 by multiple processors (or cores).  This instruction is generated as part of
11784 atomic built-in functions: see @ref{Atomic Builtins} for details.
11785
11786 @item -msahf
11787 @opindex msahf
11788 This option will enable GCC to use SAHF instruction in generated 64-bit code.
11789 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
11790 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
11791 SAHF are load and store instructions, respectively, for certain status flags.
11792 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
11793 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
11794
11795 @item -mmovbe
11796 @opindex mmovbe
11797 This option will enable GCC to use movbe instruction to implement
11798 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
11799
11800 @item -mcrc32
11801 @opindex mcrc32
11802 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
11803 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
11804 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
11805
11806 @item -mrecip
11807 @opindex mrecip
11808 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
11809 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
11810 to increase precision instead of DIVSS and SQRTSS (and their vectorized
11811 variants) for single precision floating point arguments.  These instructions
11812 are generated only when @option{-funsafe-math-optimizations} is enabled
11813 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
11814 Note that while the throughput of the sequence is higher than the throughput
11815 of the non-reciprocal instruction, the precision of the sequence can be
11816 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
11817
11818 @item -mveclibabi=@var{type}
11819 @opindex mveclibabi
11820 Specifies the ABI type to use for vectorizing intrinsics using an
11821 external library.  Supported types are @code{svml} for the Intel short
11822 vector math library and @code{acml} for the AMD math core library style
11823 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
11824 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
11825 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
11826 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
11827 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
11828 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
11829 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
11830 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
11831 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
11832 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
11833 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
11834 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
11835 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
11836 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
11837 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
11838 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
11839 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
11840 compatible library will have to be specified at link time.
11841
11842 @item -mabi=@var{name}
11843 @opindex mabi
11844 Generate code for the specified calling convention.  Permissible values
11845 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
11846 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
11847 ABI when targeting Windows.  On all other systems, the default is the
11848 SYSV ABI.  You can control this behavior for a specific function by
11849 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
11850 @xref{Function Attributes}.
11851
11852 @item -mpush-args
11853 @itemx -mno-push-args
11854 @opindex mpush-args
11855 @opindex mno-push-args
11856 Use PUSH operations to store outgoing parameters.  This method is shorter
11857 and usually equally fast as method using SUB/MOV operations and is enabled
11858 by default.  In some cases disabling it may improve performance because of
11859 improved scheduling and reduced dependencies.
11860
11861 @item -maccumulate-outgoing-args
11862 @opindex maccumulate-outgoing-args
11863 If enabled, the maximum amount of space required for outgoing arguments will be
11864 computed in the function prologue.  This is faster on most modern CPUs
11865 because of reduced dependencies, improved scheduling and reduced stack usage
11866 when preferred stack boundary is not equal to 2.  The drawback is a notable
11867 increase in code size.  This switch implies @option{-mno-push-args}.
11868
11869 @item -mthreads
11870 @opindex mthreads
11871 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
11872 on thread-safe exception handling must compile and link all code with the
11873 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
11874 @option{-D_MT}; when linking, it links in a special thread helper library
11875 @option{-lmingwthrd} which cleans up per thread exception handling data.
11876
11877 @item -mno-align-stringops
11878 @opindex mno-align-stringops
11879 Do not align destination of inlined string operations.  This switch reduces
11880 code size and improves performance in case the destination is already aligned,
11881 but GCC doesn't know about it.
11882
11883 @item -minline-all-stringops
11884 @opindex minline-all-stringops
11885 By default GCC inlines string operations only when destination is known to be
11886 aligned at least to 4 byte boundary.  This enables more inlining, increase code
11887 size, but may improve performance of code that depends on fast memcpy, strlen
11888 and memset for short lengths.
11889
11890 @item -minline-stringops-dynamically
11891 @opindex minline-stringops-dynamically
11892 For string operation of unknown size, inline runtime checks so for small
11893 blocks inline code is used, while for large blocks library call is used.
11894
11895 @item -mstringop-strategy=@var{alg}
11896 @opindex mstringop-strategy=@var{alg}
11897 Overwrite internal decision heuristic about particular algorithm to inline
11898 string operation with.  The allowed values are @code{rep_byte},
11899 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
11900 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
11901 expanding inline loop, @code{libcall} for always expanding library call.
11902
11903 @item -momit-leaf-frame-pointer
11904 @opindex momit-leaf-frame-pointer
11905 Don't keep the frame pointer in a register for leaf functions.  This
11906 avoids the instructions to save, set up and restore frame pointers and
11907 makes an extra register available in leaf functions.  The option
11908 @option{-fomit-frame-pointer} removes the frame pointer for all functions
11909 which might make debugging harder.
11910
11911 @item -mtls-direct-seg-refs
11912 @itemx -mno-tls-direct-seg-refs
11913 @opindex mtls-direct-seg-refs
11914 Controls whether TLS variables may be accessed with offsets from the
11915 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
11916 or whether the thread base pointer must be added.  Whether or not this
11917 is legal depends on the operating system, and whether it maps the
11918 segment to cover the entire TLS area.
11919
11920 For systems that use GNU libc, the default is on.
11921
11922 @item -msse2avx
11923 @itemx -mno-sse2avx
11924 @opindex msse2avx
11925 Specify that the assembler should encode SSE instructions with VEX
11926 prefix.  The option @option{-mavx} turns this on by default.
11927 @end table
11928
11929 These @samp{-m} switches are supported in addition to the above
11930 on AMD x86-64 processors in 64-bit environments.
11931
11932 @table @gcctabopt
11933 @item -m32
11934 @itemx -m64
11935 @opindex m32
11936 @opindex m64
11937 Generate code for a 32-bit or 64-bit environment.
11938 The 32-bit environment sets int, long and pointer to 32 bits and
11939 generates code that runs on any i386 system.
11940 The 64-bit environment sets int to 32 bits and long and pointer
11941 to 64 bits and generates code for AMD's x86-64 architecture. For
11942 darwin only the -m64 option turns off the @option{-fno-pic} and
11943 @option{-mdynamic-no-pic} options.
11944
11945 @item -mno-red-zone
11946 @opindex mno-red-zone
11947 Do not use a so called red zone for x86-64 code.  The red zone is mandated
11948 by the x86-64 ABI, it is a 128-byte area beyond the location of the
11949 stack pointer that will not be modified by signal or interrupt handlers
11950 and therefore can be used for temporary data without adjusting the stack
11951 pointer.  The flag @option{-mno-red-zone} disables this red zone.
11952
11953 @item -mcmodel=small
11954 @opindex mcmodel=small
11955 Generate code for the small code model: the program and its symbols must
11956 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
11957 Programs can be statically or dynamically linked.  This is the default
11958 code model.
11959
11960 @item -mcmodel=kernel
11961 @opindex mcmodel=kernel
11962 Generate code for the kernel code model.  The kernel runs in the
11963 negative 2 GB of the address space.
11964 This model has to be used for Linux kernel code.
11965
11966 @item -mcmodel=medium
11967 @opindex mcmodel=medium
11968 Generate code for the medium model: The program is linked in the lower 2
11969 GB of the address space.  Small symbols are also placed there.  Symbols
11970 with sizes larger than @option{-mlarge-data-threshold} are put into
11971 large data or bss sections and can be located above 2GB.  Programs can
11972 be statically or dynamically linked.
11973
11974 @item -mcmodel=large
11975 @opindex mcmodel=large
11976 Generate code for the large model: This model makes no assumptions
11977 about addresses and sizes of sections.
11978 @end table
11979
11980 @node IA-64 Options
11981 @subsection IA-64 Options
11982 @cindex IA-64 Options
11983
11984 These are the @samp{-m} options defined for the Intel IA-64 architecture.
11985
11986 @table @gcctabopt
11987 @item -mbig-endian
11988 @opindex mbig-endian
11989 Generate code for a big endian target.  This is the default for HP-UX@.
11990
11991 @item -mlittle-endian
11992 @opindex mlittle-endian
11993 Generate code for a little endian target.  This is the default for AIX5
11994 and GNU/Linux.
11995
11996 @item -mgnu-as
11997 @itemx -mno-gnu-as
11998 @opindex mgnu-as
11999 @opindex mno-gnu-as
12000 Generate (or don't) code for the GNU assembler.  This is the default.
12001 @c Also, this is the default if the configure option @option{--with-gnu-as}
12002 @c is used.
12003
12004 @item -mgnu-ld
12005 @itemx -mno-gnu-ld
12006 @opindex mgnu-ld
12007 @opindex mno-gnu-ld
12008 Generate (or don't) code for the GNU linker.  This is the default.
12009 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12010 @c is used.
12011
12012 @item -mno-pic
12013 @opindex mno-pic
12014 Generate code that does not use a global pointer register.  The result
12015 is not position independent code, and violates the IA-64 ABI@.
12016
12017 @item -mvolatile-asm-stop
12018 @itemx -mno-volatile-asm-stop
12019 @opindex mvolatile-asm-stop
12020 @opindex mno-volatile-asm-stop
12021 Generate (or don't) a stop bit immediately before and after volatile asm
12022 statements.
12023
12024 @item -mregister-names
12025 @itemx -mno-register-names
12026 @opindex mregister-names
12027 @opindex mno-register-names
12028 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12029 the stacked registers.  This may make assembler output more readable.
12030
12031 @item -mno-sdata
12032 @itemx -msdata
12033 @opindex mno-sdata
12034 @opindex msdata
12035 Disable (or enable) optimizations that use the small data section.  This may
12036 be useful for working around optimizer bugs.
12037
12038 @item -mconstant-gp
12039 @opindex mconstant-gp
12040 Generate code that uses a single constant global pointer value.  This is
12041 useful when compiling kernel code.
12042
12043 @item -mauto-pic
12044 @opindex mauto-pic
12045 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12046 This is useful when compiling firmware code.
12047
12048 @item -minline-float-divide-min-latency
12049 @opindex minline-float-divide-min-latency
12050 Generate code for inline divides of floating point values
12051 using the minimum latency algorithm.
12052
12053 @item -minline-float-divide-max-throughput
12054 @opindex minline-float-divide-max-throughput
12055 Generate code for inline divides of floating point values
12056 using the maximum throughput algorithm.
12057
12058 @item -mno-inline-float-divide
12059 @opindex mno-inline-float-divide
12060 Do not generate inline code for divides of floating point values.
12061
12062 @item -minline-int-divide-min-latency
12063 @opindex minline-int-divide-min-latency
12064 Generate code for inline divides of integer values
12065 using the minimum latency algorithm.
12066
12067 @item -minline-int-divide-max-throughput
12068 @opindex minline-int-divide-max-throughput
12069 Generate code for inline divides of integer values
12070 using the maximum throughput algorithm.
12071
12072 @item -mno-inline-int-divide
12073 @opindex mno-inline-int-divide
12074 Do not generate inline code for divides of integer values.
12075
12076 @item -minline-sqrt-min-latency
12077 @opindex minline-sqrt-min-latency
12078 Generate code for inline square roots
12079 using the minimum latency algorithm.
12080
12081 @item -minline-sqrt-max-throughput
12082 @opindex minline-sqrt-max-throughput
12083 Generate code for inline square roots
12084 using the maximum throughput algorithm.
12085
12086 @item -mno-inline-sqrt
12087 @opindex mno-inline-sqrt
12088 Do not generate inline code for sqrt.
12089
12090 @item -mfused-madd
12091 @itemx -mno-fused-madd
12092 @opindex mfused-madd
12093 @opindex mno-fused-madd
12094 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12095 instructions.    The default is to use these instructions.
12096
12097 @item -mno-dwarf2-asm
12098 @itemx -mdwarf2-asm
12099 @opindex mno-dwarf2-asm
12100 @opindex mdwarf2-asm
12101 Don't (or do) generate assembler code for the DWARF2 line number debugging
12102 info.  This may be useful when not using the GNU assembler.
12103
12104 @item -mearly-stop-bits
12105 @itemx -mno-early-stop-bits
12106 @opindex mearly-stop-bits
12107 @opindex mno-early-stop-bits
12108 Allow stop bits to be placed earlier than immediately preceding the
12109 instruction that triggered the stop bit.  This can improve instruction
12110 scheduling, but does not always do so.
12111
12112 @item -mfixed-range=@var{register-range}
12113 @opindex mfixed-range
12114 Generate code treating the given register range as fixed registers.
12115 A fixed register is one that the register allocator can not use.  This is
12116 useful when compiling kernel code.  A register range is specified as
12117 two registers separated by a dash.  Multiple register ranges can be
12118 specified separated by a comma.
12119
12120 @item -mtls-size=@var{tls-size}
12121 @opindex mtls-size
12122 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12123 64.
12124
12125 @item -mtune=@var{cpu-type}
12126 @opindex mtune
12127 Tune the instruction scheduling for a particular CPU, Valid values are
12128 itanium, itanium1, merced, itanium2, and mckinley.
12129
12130 @item -milp32
12131 @itemx -mlp64
12132 @opindex milp32
12133 @opindex mlp64
12134 Generate code for a 32-bit or 64-bit environment.
12135 The 32-bit environment sets int, long and pointer to 32 bits.
12136 The 64-bit environment sets int to 32 bits and long and pointer
12137 to 64 bits.  These are HP-UX specific flags.
12138
12139 @item -mno-sched-br-data-spec
12140 @itemx -msched-br-data-spec
12141 @opindex mno-sched-br-data-spec
12142 @opindex msched-br-data-spec
12143 (Dis/En)able data speculative scheduling before reload.
12144 This will result in generation of the ld.a instructions and
12145 the corresponding check instructions (ld.c / chk.a).
12146 The default is 'disable'.
12147
12148 @item -msched-ar-data-spec
12149 @itemx -mno-sched-ar-data-spec
12150 @opindex msched-ar-data-spec
12151 @opindex mno-sched-ar-data-spec
12152 (En/Dis)able data speculative scheduling after reload.
12153 This will result in generation of the ld.a instructions and
12154 the corresponding check instructions (ld.c / chk.a).
12155 The default is 'enable'.
12156
12157 @item -mno-sched-control-spec
12158 @itemx -msched-control-spec
12159 @opindex mno-sched-control-spec
12160 @opindex msched-control-spec
12161 (Dis/En)able control speculative scheduling.  This feature is
12162 available only during region scheduling (i.e.@: before reload).
12163 This will result in generation of the ld.s instructions and
12164 the corresponding check instructions chk.s .
12165 The default is 'disable'.
12166
12167 @item -msched-br-in-data-spec
12168 @itemx -mno-sched-br-in-data-spec
12169 @opindex msched-br-in-data-spec
12170 @opindex mno-sched-br-in-data-spec
12171 (En/Dis)able speculative scheduling of the instructions that
12172 are dependent on the data speculative loads before reload.
12173 This is effective only with @option{-msched-br-data-spec} enabled.
12174 The default is 'enable'.
12175
12176 @item -msched-ar-in-data-spec
12177 @itemx -mno-sched-ar-in-data-spec
12178 @opindex msched-ar-in-data-spec
12179 @opindex mno-sched-ar-in-data-spec
12180 (En/Dis)able speculative scheduling of the instructions that
12181 are dependent on the data speculative loads after reload.
12182 This is effective only with @option{-msched-ar-data-spec} enabled.
12183 The default is 'enable'.
12184
12185 @item -msched-in-control-spec
12186 @itemx -mno-sched-in-control-spec
12187 @opindex msched-in-control-spec
12188 @opindex mno-sched-in-control-spec
12189 (En/Dis)able speculative scheduling of the instructions that
12190 are dependent on the control speculative loads.
12191 This is effective only with @option{-msched-control-spec} enabled.
12192 The default is 'enable'.
12193
12194 @item -mno-sched-prefer-non-data-spec-insns
12195 @itemx -msched-prefer-non-data-spec-insns
12196 @opindex mno-sched-prefer-non-data-spec-insns
12197 @opindex msched-prefer-non-data-spec-insns
12198 If enabled, data speculative instructions will be chosen for schedule
12199 only if there are no other choices at the moment.  This will make
12200 the use of the data speculation much more conservative.
12201 The default is 'disable'.
12202
12203 @item -mno-sched-prefer-non-control-spec-insns
12204 @itemx -msched-prefer-non-control-spec-insns
12205 @opindex mno-sched-prefer-non-control-spec-insns
12206 @opindex msched-prefer-non-control-spec-insns
12207 If enabled, control speculative instructions will be chosen for schedule
12208 only if there are no other choices at the moment.  This will make
12209 the use of the control speculation much more conservative.
12210 The default is 'disable'.
12211
12212 @item -mno-sched-count-spec-in-critical-path
12213 @itemx -msched-count-spec-in-critical-path
12214 @opindex mno-sched-count-spec-in-critical-path
12215 @opindex msched-count-spec-in-critical-path
12216 If enabled, speculative dependencies will be considered during
12217 computation of the instructions priorities.  This will make the use of the
12218 speculation a bit more conservative.
12219 The default is 'disable'.
12220
12221 @item -msched-spec-ldc
12222 @opindex msched-spec-ldc
12223 Use a simple data speculation check.  This option is on by default.
12224
12225 @item -msched-control-spec-ldc
12226 @opindex msched-spec-ldc
12227 Use a simple check for control speculation.  This option is on by default.
12228
12229 @item -msched-stop-bits-after-every-cycle
12230 @opindex msched-stop-bits-after-every-cycle
12231 Place a stop bit after every cycle when scheduling.  This option is on
12232 by default.
12233
12234 @item -msched-fp-mem-deps-zero-cost
12235 @opindex msched-fp-mem-deps-zero-cost
12236 Assume that floating-point stores and loads are not likely to cause a conflict
12237 when placed into the same instruction group.  This option is disabled by
12238 default.
12239
12240 @item -msel-sched-dont-check-control-spec
12241 @opindex msel-sched-dont-check-control-spec
12242 Generate checks for control speculation in selective scheduling.
12243 This flag is disabled by default.
12244
12245 @item -msched-max-memory-insns=@var{max-insns}
12246 @opindex msched-max-memory-insns
12247 Limit on the number of memory insns per instruction group, giving lower
12248 priority to subsequent memory insns attempting to schedule in the same
12249 instruction group. Frequently useful to prevent cache bank conflicts.
12250 The default value is 1.
12251
12252 @item -msched-max-memory-insns-hard-limit
12253 @opindex msched-max-memory-insns-hard-limit
12254 Disallow more than `msched-max-memory-insns' in instruction group.
12255 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12256 when limit is reached but may still schedule memory operations.
12257
12258 @end table
12259
12260 @node IA-64/VMS Options
12261 @subsection IA-64/VMS Options
12262
12263 These @samp{-m} options are defined for the IA-64/VMS implementations:
12264
12265 @table @gcctabopt
12266 @item -mvms-return-codes
12267 @opindex mvms-return-codes
12268 Return VMS condition codes from main. The default is to return POSIX
12269 style condition (e.g.@ error) codes.
12270
12271 @item -mdebug-main=@var{prefix}
12272 @opindex mdebug-main=@var{prefix}
12273 Flag the first routine whose name starts with @var{prefix} as the main
12274 routine for the debugger.
12275
12276 @item -mmalloc64
12277 @opindex mmalloc64
12278 Default to 64bit memory allocation routines.
12279 @end table
12280
12281 @node M32C Options
12282 @subsection M32C Options
12283 @cindex M32C options
12284
12285 @table @gcctabopt
12286 @item -mcpu=@var{name}
12287 @opindex mcpu=
12288 Select the CPU for which code is generated.  @var{name} may be one of
12289 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12290 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12291 the M32C/80 series.
12292
12293 @item -msim
12294 @opindex msim
12295 Specifies that the program will be run on the simulator.  This causes
12296 an alternate runtime library to be linked in which supports, for
12297 example, file I/O@.  You must not use this option when generating
12298 programs that will run on real hardware; you must provide your own
12299 runtime library for whatever I/O functions are needed.
12300
12301 @item -memregs=@var{number}
12302 @opindex memregs=
12303 Specifies the number of memory-based pseudo-registers GCC will use
12304 during code generation.  These pseudo-registers will be used like real
12305 registers, so there is a tradeoff between GCC's ability to fit the
12306 code into available registers, and the performance penalty of using
12307 memory instead of registers.  Note that all modules in a program must
12308 be compiled with the same value for this option.  Because of that, you
12309 must not use this option with the default runtime libraries gcc
12310 builds.
12311
12312 @end table
12313
12314 @node M32R/D Options
12315 @subsection M32R/D Options
12316 @cindex M32R/D options
12317
12318 These @option{-m} options are defined for Renesas M32R/D architectures:
12319
12320 @table @gcctabopt
12321 @item -m32r2
12322 @opindex m32r2
12323 Generate code for the M32R/2@.
12324
12325 @item -m32rx
12326 @opindex m32rx
12327 Generate code for the M32R/X@.
12328
12329 @item -m32r
12330 @opindex m32r
12331 Generate code for the M32R@.  This is the default.
12332
12333 @item -mmodel=small
12334 @opindex mmodel=small
12335 Assume all objects live in the lower 16MB of memory (so that their addresses
12336 can be loaded with the @code{ld24} instruction), and assume all subroutines
12337 are reachable with the @code{bl} instruction.
12338 This is the default.
12339
12340 The addressability of a particular object can be set with the
12341 @code{model} attribute.
12342
12343 @item -mmodel=medium
12344 @opindex mmodel=medium
12345 Assume objects may be anywhere in the 32-bit address space (the compiler
12346 will generate @code{seth/add3} instructions to load their addresses), and
12347 assume all subroutines are reachable with the @code{bl} instruction.
12348
12349 @item -mmodel=large
12350 @opindex mmodel=large
12351 Assume objects may be anywhere in the 32-bit address space (the compiler
12352 will generate @code{seth/add3} instructions to load their addresses), and
12353 assume subroutines may not be reachable with the @code{bl} instruction
12354 (the compiler will generate the much slower @code{seth/add3/jl}
12355 instruction sequence).
12356
12357 @item -msdata=none
12358 @opindex msdata=none
12359 Disable use of the small data area.  Variables will be put into
12360 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
12361 @code{section} attribute has been specified).
12362 This is the default.
12363
12364 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
12365 Objects may be explicitly put in the small data area with the
12366 @code{section} attribute using one of these sections.
12367
12368 @item -msdata=sdata
12369 @opindex msdata=sdata
12370 Put small global and static data in the small data area, but do not
12371 generate special code to reference them.
12372
12373 @item -msdata=use
12374 @opindex msdata=use
12375 Put small global and static data in the small data area, and generate
12376 special instructions to reference them.
12377
12378 @item -G @var{num}
12379 @opindex G
12380 @cindex smaller data references
12381 Put global and static objects less than or equal to @var{num} bytes
12382 into the small data or bss sections instead of the normal data or bss
12383 sections.  The default value of @var{num} is 8.
12384 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
12385 for this option to have any effect.
12386
12387 All modules should be compiled with the same @option{-G @var{num}} value.
12388 Compiling with different values of @var{num} may or may not work; if it
12389 doesn't the linker will give an error message---incorrect code will not be
12390 generated.
12391
12392 @item -mdebug
12393 @opindex mdebug
12394 Makes the M32R specific code in the compiler display some statistics
12395 that might help in debugging programs.
12396
12397 @item -malign-loops
12398 @opindex malign-loops
12399 Align all loops to a 32-byte boundary.
12400
12401 @item -mno-align-loops
12402 @opindex mno-align-loops
12403 Do not enforce a 32-byte alignment for loops.  This is the default.
12404
12405 @item -missue-rate=@var{number}
12406 @opindex missue-rate=@var{number}
12407 Issue @var{number} instructions per cycle.  @var{number} can only be 1
12408 or 2.
12409
12410 @item -mbranch-cost=@var{number}
12411 @opindex mbranch-cost=@var{number}
12412 @var{number} can only be 1 or 2.  If it is 1 then branches will be
12413 preferred over conditional code, if it is 2, then the opposite will
12414 apply.
12415
12416 @item -mflush-trap=@var{number}
12417 @opindex mflush-trap=@var{number}
12418 Specifies the trap number to use to flush the cache.  The default is
12419 12.  Valid numbers are between 0 and 15 inclusive.
12420
12421 @item -mno-flush-trap
12422 @opindex mno-flush-trap
12423 Specifies that the cache cannot be flushed by using a trap.
12424
12425 @item -mflush-func=@var{name}
12426 @opindex mflush-func=@var{name}
12427 Specifies the name of the operating system function to call to flush
12428 the cache.  The default is @emph{_flush_cache}, but a function call
12429 will only be used if a trap is not available.
12430
12431 @item -mno-flush-func
12432 @opindex mno-flush-func
12433 Indicates that there is no OS function for flushing the cache.
12434
12435 @end table
12436
12437 @node M680x0 Options
12438 @subsection M680x0 Options
12439 @cindex M680x0 options
12440
12441 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
12442 The default settings depend on which architecture was selected when
12443 the compiler was configured; the defaults for the most common choices
12444 are given below.
12445
12446 @table @gcctabopt
12447 @item -march=@var{arch}
12448 @opindex march
12449 Generate code for a specific M680x0 or ColdFire instruction set
12450 architecture.  Permissible values of @var{arch} for M680x0
12451 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
12452 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
12453 architectures are selected according to Freescale's ISA classification
12454 and the permissible values are: @samp{isaa}, @samp{isaaplus},
12455 @samp{isab} and @samp{isac}.
12456
12457 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
12458 code for a ColdFire target.  The @var{arch} in this macro is one of the
12459 @option{-march} arguments given above.
12460
12461 When used together, @option{-march} and @option{-mtune} select code
12462 that runs on a family of similar processors but that is optimized
12463 for a particular microarchitecture.
12464
12465 @item -mcpu=@var{cpu}
12466 @opindex mcpu
12467 Generate code for a specific M680x0 or ColdFire processor.
12468 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
12469 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
12470 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
12471 below, which also classifies the CPUs into families:
12472
12473 @multitable @columnfractions 0.20 0.80
12474 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
12475 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
12476 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
12477 @item @samp{5206e} @tab @samp{5206e}
12478 @item @samp{5208} @tab @samp{5207} @samp{5208}
12479 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
12480 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
12481 @item @samp{5216} @tab @samp{5214} @samp{5216}
12482 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
12483 @item @samp{5225} @tab @samp{5224} @samp{5225}
12484 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
12485 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
12486 @item @samp{5249} @tab @samp{5249}
12487 @item @samp{5250} @tab @samp{5250}
12488 @item @samp{5271} @tab @samp{5270} @samp{5271}
12489 @item @samp{5272} @tab @samp{5272}
12490 @item @samp{5275} @tab @samp{5274} @samp{5275}
12491 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
12492 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
12493 @item @samp{5307} @tab @samp{5307}
12494 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
12495 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
12496 @item @samp{5407} @tab @samp{5407}
12497 @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}
12498 @end multitable
12499
12500 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
12501 @var{arch} is compatible with @var{cpu}.  Other combinations of
12502 @option{-mcpu} and @option{-march} are rejected.
12503
12504 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
12505 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
12506 where the value of @var{family} is given by the table above.
12507
12508 @item -mtune=@var{tune}
12509 @opindex mtune
12510 Tune the code for a particular microarchitecture, within the
12511 constraints set by @option{-march} and @option{-mcpu}.
12512 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
12513 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
12514 and @samp{cpu32}.  The ColdFire microarchitectures
12515 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
12516
12517 You can also use @option{-mtune=68020-40} for code that needs
12518 to run relatively well on 68020, 68030 and 68040 targets.
12519 @option{-mtune=68020-60} is similar but includes 68060 targets
12520 as well.  These two options select the same tuning decisions as
12521 @option{-m68020-40} and @option{-m68020-60} respectively.
12522
12523 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
12524 when tuning for 680x0 architecture @var{arch}.  It also defines
12525 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
12526 option is used.  If gcc is tuning for a range of architectures,
12527 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
12528 it defines the macros for every architecture in the range.
12529
12530 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
12531 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
12532 of the arguments given above.
12533
12534 @item -m68000
12535 @itemx -mc68000
12536 @opindex m68000
12537 @opindex mc68000
12538 Generate output for a 68000.  This is the default
12539 when the compiler is configured for 68000-based systems.
12540 It is equivalent to @option{-march=68000}.
12541
12542 Use this option for microcontrollers with a 68000 or EC000 core,
12543 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
12544
12545 @item -m68010
12546 @opindex m68010
12547 Generate output for a 68010.  This is the default
12548 when the compiler is configured for 68010-based systems.
12549 It is equivalent to @option{-march=68010}.
12550
12551 @item -m68020
12552 @itemx -mc68020
12553 @opindex m68020
12554 @opindex mc68020
12555 Generate output for a 68020.  This is the default
12556 when the compiler is configured for 68020-based systems.
12557 It is equivalent to @option{-march=68020}.
12558
12559 @item -m68030
12560 @opindex m68030
12561 Generate output for a 68030.  This is the default when the compiler is
12562 configured for 68030-based systems.  It is equivalent to
12563 @option{-march=68030}.
12564
12565 @item -m68040
12566 @opindex m68040
12567 Generate output for a 68040.  This is the default when the compiler is
12568 configured for 68040-based systems.  It is equivalent to
12569 @option{-march=68040}.
12570
12571 This option inhibits the use of 68881/68882 instructions that have to be
12572 emulated by software on the 68040.  Use this option if your 68040 does not
12573 have code to emulate those instructions.
12574
12575 @item -m68060
12576 @opindex m68060
12577 Generate output for a 68060.  This is the default when the compiler is
12578 configured for 68060-based systems.  It is equivalent to
12579 @option{-march=68060}.
12580
12581 This option inhibits the use of 68020 and 68881/68882 instructions that
12582 have to be emulated by software on the 68060.  Use this option if your 68060
12583 does not have code to emulate those instructions.
12584
12585 @item -mcpu32
12586 @opindex mcpu32
12587 Generate output for a CPU32.  This is the default
12588 when the compiler is configured for CPU32-based systems.
12589 It is equivalent to @option{-march=cpu32}.
12590
12591 Use this option for microcontrollers with a
12592 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
12593 68336, 68340, 68341, 68349 and 68360.
12594
12595 @item -m5200
12596 @opindex m5200
12597 Generate output for a 520X ColdFire CPU@.  This is the default
12598 when the compiler is configured for 520X-based systems.
12599 It is equivalent to @option{-mcpu=5206}, and is now deprecated
12600 in favor of that option.
12601
12602 Use this option for microcontroller with a 5200 core, including
12603 the MCF5202, MCF5203, MCF5204 and MCF5206.
12604
12605 @item -m5206e
12606 @opindex m5206e
12607 Generate output for a 5206e ColdFire CPU@.  The option is now
12608 deprecated in favor of the equivalent @option{-mcpu=5206e}.
12609
12610 @item -m528x
12611 @opindex m528x
12612 Generate output for a member of the ColdFire 528X family.
12613 The option is now deprecated in favor of the equivalent
12614 @option{-mcpu=528x}.
12615
12616 @item -m5307
12617 @opindex m5307
12618 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
12619 in favor of the equivalent @option{-mcpu=5307}.
12620
12621 @item -m5407
12622 @opindex m5407
12623 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
12624 in favor of the equivalent @option{-mcpu=5407}.
12625
12626 @item -mcfv4e
12627 @opindex mcfv4e
12628 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
12629 This includes use of hardware floating point instructions.
12630 The option is equivalent to @option{-mcpu=547x}, and is now
12631 deprecated in favor of that option.
12632
12633 @item -m68020-40
12634 @opindex m68020-40
12635 Generate output for a 68040, without using any of the new instructions.
12636 This results in code which can run relatively efficiently on either a
12637 68020/68881 or a 68030 or a 68040.  The generated code does use the
12638 68881 instructions that are emulated on the 68040.
12639
12640 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
12641
12642 @item -m68020-60
12643 @opindex m68020-60
12644 Generate output for a 68060, without using any of the new instructions.
12645 This results in code which can run relatively efficiently on either a
12646 68020/68881 or a 68030 or a 68040.  The generated code does use the
12647 68881 instructions that are emulated on the 68060.
12648
12649 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
12650
12651 @item -mhard-float
12652 @itemx -m68881
12653 @opindex mhard-float
12654 @opindex m68881
12655 Generate floating-point instructions.  This is the default for 68020
12656 and above, and for ColdFire devices that have an FPU@.  It defines the
12657 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
12658 on ColdFire targets.
12659
12660 @item -msoft-float
12661 @opindex msoft-float
12662 Do not generate floating-point instructions; use library calls instead.
12663 This is the default for 68000, 68010, and 68832 targets.  It is also
12664 the default for ColdFire devices that have no FPU.
12665
12666 @item -mdiv
12667 @itemx -mno-div
12668 @opindex mdiv
12669 @opindex mno-div
12670 Generate (do not generate) ColdFire hardware divide and remainder
12671 instructions.  If @option{-march} is used without @option{-mcpu},
12672 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
12673 architectures.  Otherwise, the default is taken from the target CPU
12674 (either the default CPU, or the one specified by @option{-mcpu}).  For
12675 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
12676 @option{-mcpu=5206e}.
12677
12678 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
12679
12680 @item -mshort
12681 @opindex mshort
12682 Consider type @code{int} to be 16 bits wide, like @code{short int}.
12683 Additionally, parameters passed on the stack are also aligned to a
12684 16-bit boundary even on targets whose API mandates promotion to 32-bit.
12685
12686 @item -mno-short
12687 @opindex mno-short
12688 Do not consider type @code{int} to be 16 bits wide.  This is the default.
12689
12690 @item -mnobitfield
12691 @itemx -mno-bitfield
12692 @opindex mnobitfield
12693 @opindex mno-bitfield
12694 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
12695 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
12696
12697 @item -mbitfield
12698 @opindex mbitfield
12699 Do use the bit-field instructions.  The @option{-m68020} option implies
12700 @option{-mbitfield}.  This is the default if you use a configuration
12701 designed for a 68020.
12702
12703 @item -mrtd
12704 @opindex mrtd
12705 Use a different function-calling convention, in which functions
12706 that take a fixed number of arguments return with the @code{rtd}
12707 instruction, which pops their arguments while returning.  This
12708 saves one instruction in the caller since there is no need to pop
12709 the arguments there.
12710
12711 This calling convention is incompatible with the one normally
12712 used on Unix, so you cannot use it if you need to call libraries
12713 compiled with the Unix compiler.
12714
12715 Also, you must provide function prototypes for all functions that
12716 take variable numbers of arguments (including @code{printf});
12717 otherwise incorrect code will be generated for calls to those
12718 functions.
12719
12720 In addition, seriously incorrect code will result if you call a
12721 function with too many arguments.  (Normally, extra arguments are
12722 harmlessly ignored.)
12723
12724 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
12725 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
12726
12727 @item -mno-rtd
12728 @opindex mno-rtd
12729 Do not use the calling conventions selected by @option{-mrtd}.
12730 This is the default.
12731
12732 @item -malign-int
12733 @itemx -mno-align-int
12734 @opindex malign-int
12735 @opindex mno-align-int
12736 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
12737 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
12738 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
12739 Aligning variables on 32-bit boundaries produces code that runs somewhat
12740 faster on processors with 32-bit busses at the expense of more memory.
12741
12742 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
12743 align structures containing the above types  differently than
12744 most published application binary interface specifications for the m68k.
12745
12746 @item -mpcrel
12747 @opindex mpcrel
12748 Use the pc-relative addressing mode of the 68000 directly, instead of
12749 using a global offset table.  At present, this option implies @option{-fpic},
12750 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
12751 not presently supported with @option{-mpcrel}, though this could be supported for
12752 68020 and higher processors.
12753
12754 @item -mno-strict-align
12755 @itemx -mstrict-align
12756 @opindex mno-strict-align
12757 @opindex mstrict-align
12758 Do not (do) assume that unaligned memory references will be handled by
12759 the system.
12760
12761 @item -msep-data
12762 Generate code that allows the data segment to be located in a different
12763 area of memory from the text segment.  This allows for execute in place in
12764 an environment without virtual memory management.  This option implies
12765 @option{-fPIC}.
12766
12767 @item -mno-sep-data
12768 Generate code that assumes that the data segment follows the text segment.
12769 This is the default.
12770
12771 @item -mid-shared-library
12772 Generate code that supports shared libraries via the library ID method.
12773 This allows for execute in place and shared libraries in an environment
12774 without virtual memory management.  This option implies @option{-fPIC}.
12775
12776 @item -mno-id-shared-library
12777 Generate code that doesn't assume ID based shared libraries are being used.
12778 This is the default.
12779
12780 @item -mshared-library-id=n
12781 Specified the identification number of the ID based shared library being
12782 compiled.  Specifying a value of 0 will generate more compact code, specifying
12783 other values will force the allocation of that number to the current
12784 library but is no more space or time efficient than omitting this option.
12785
12786 @item -mxgot
12787 @itemx -mno-xgot
12788 @opindex mxgot
12789 @opindex mno-xgot
12790 When generating position-independent code for ColdFire, generate code
12791 that works if the GOT has more than 8192 entries.  This code is
12792 larger and slower than code generated without this option.  On M680x0
12793 processors, this option is not needed; @option{-fPIC} suffices.
12794
12795 GCC normally uses a single instruction to load values from the GOT@.
12796 While this is relatively efficient, it only works if the GOT
12797 is smaller than about 64k.  Anything larger causes the linker
12798 to report an error such as:
12799
12800 @cindex relocation truncated to fit (ColdFire)
12801 @smallexample
12802 relocation truncated to fit: R_68K_GOT16O foobar
12803 @end smallexample
12804
12805 If this happens, you should recompile your code with @option{-mxgot}.
12806 It should then work with very large GOTs.  However, code generated with
12807 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
12808 the value of a global symbol.
12809
12810 Note that some linkers, including newer versions of the GNU linker,
12811 can create multiple GOTs and sort GOT entries.  If you have such a linker,
12812 you should only need to use @option{-mxgot} when compiling a single
12813 object file that accesses more than 8192 GOT entries.  Very few do.
12814
12815 These options have no effect unless GCC is generating
12816 position-independent code.
12817
12818 @end table
12819
12820 @node M68hc1x Options
12821 @subsection M68hc1x Options
12822 @cindex M68hc1x options
12823
12824 These are the @samp{-m} options defined for the 68hc11 and 68hc12
12825 microcontrollers.  The default values for these options depends on
12826 which style of microcontroller was selected when the compiler was configured;
12827 the defaults for the most common choices are given below.
12828
12829 @table @gcctabopt
12830 @item -m6811
12831 @itemx -m68hc11
12832 @opindex m6811
12833 @opindex m68hc11
12834 Generate output for a 68HC11.  This is the default
12835 when the compiler is configured for 68HC11-based systems.
12836
12837 @item -m6812
12838 @itemx -m68hc12
12839 @opindex m6812
12840 @opindex m68hc12
12841 Generate output for a 68HC12.  This is the default
12842 when the compiler is configured for 68HC12-based systems.
12843
12844 @item -m68S12
12845 @itemx -m68hcs12
12846 @opindex m68S12
12847 @opindex m68hcs12
12848 Generate output for a 68HCS12.
12849
12850 @item -mauto-incdec
12851 @opindex mauto-incdec
12852 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
12853 addressing modes.
12854
12855 @item -minmax
12856 @itemx -mnominmax
12857 @opindex minmax
12858 @opindex mnominmax
12859 Enable the use of 68HC12 min and max instructions.
12860
12861 @item -mlong-calls
12862 @itemx -mno-long-calls
12863 @opindex mlong-calls
12864 @opindex mno-long-calls
12865 Treat all calls as being far away (near).  If calls are assumed to be
12866 far away, the compiler will use the @code{call} instruction to
12867 call a function and the @code{rtc} instruction for returning.
12868
12869 @item -mshort
12870 @opindex mshort
12871 Consider type @code{int} to be 16 bits wide, like @code{short int}.
12872
12873 @item -msoft-reg-count=@var{count}
12874 @opindex msoft-reg-count
12875 Specify the number of pseudo-soft registers which are used for the
12876 code generation.  The maximum number is 32.  Using more pseudo-soft
12877 register may or may not result in better code depending on the program.
12878 The default is 4 for 68HC11 and 2 for 68HC12.
12879
12880 @end table
12881
12882 @node MCore Options
12883 @subsection MCore Options
12884 @cindex MCore options
12885
12886 These are the @samp{-m} options defined for the Motorola M*Core
12887 processors.
12888
12889 @table @gcctabopt
12890
12891 @item -mhardlit
12892 @itemx -mno-hardlit
12893 @opindex mhardlit
12894 @opindex mno-hardlit
12895 Inline constants into the code stream if it can be done in two
12896 instructions or less.
12897
12898 @item -mdiv
12899 @itemx -mno-div
12900 @opindex mdiv
12901 @opindex mno-div
12902 Use the divide instruction.  (Enabled by default).
12903
12904 @item -mrelax-immediate
12905 @itemx -mno-relax-immediate
12906 @opindex mrelax-immediate
12907 @opindex mno-relax-immediate
12908 Allow arbitrary sized immediates in bit operations.
12909
12910 @item -mwide-bitfields
12911 @itemx -mno-wide-bitfields
12912 @opindex mwide-bitfields
12913 @opindex mno-wide-bitfields
12914 Always treat bit-fields as int-sized.
12915
12916 @item -m4byte-functions
12917 @itemx -mno-4byte-functions
12918 @opindex m4byte-functions
12919 @opindex mno-4byte-functions
12920 Force all functions to be aligned to a four byte boundary.
12921
12922 @item -mcallgraph-data
12923 @itemx -mno-callgraph-data
12924 @opindex mcallgraph-data
12925 @opindex mno-callgraph-data
12926 Emit callgraph information.
12927
12928 @item -mslow-bytes
12929 @itemx -mno-slow-bytes
12930 @opindex mslow-bytes
12931 @opindex mno-slow-bytes
12932 Prefer word access when reading byte quantities.
12933
12934 @item -mlittle-endian
12935 @itemx -mbig-endian
12936 @opindex mlittle-endian
12937 @opindex mbig-endian
12938 Generate code for a little endian target.
12939
12940 @item -m210
12941 @itemx -m340
12942 @opindex m210
12943 @opindex m340
12944 Generate code for the 210 processor.
12945
12946 @item -mno-lsim
12947 @opindex mno-lsim
12948 Assume that run-time support has been provided and so omit the
12949 simulator library (@file{libsim.a)} from the linker command line.
12950
12951 @item -mstack-increment=@var{size}
12952 @opindex mstack-increment
12953 Set the maximum amount for a single stack increment operation.  Large
12954 values can increase the speed of programs which contain functions
12955 that need a large amount of stack space, but they can also trigger a
12956 segmentation fault if the stack is extended too much.  The default
12957 value is 0x1000.
12958
12959 @end table
12960
12961 @node MeP Options
12962 @subsection MeP Options
12963 @cindex MeP options
12964
12965 @table @gcctabopt
12966
12967 @item -mabsdiff
12968 @opindex mabsdiff
12969 Enables the @code{abs} instruction, which is the absolute difference
12970 between two registers.
12971
12972 @item -mall-opts
12973 @opindex mall-opts
12974 Enables all the optional instructions - average, multiply, divide, bit
12975 operations, leading zero, absolute difference, min/max, clip, and
12976 saturation.
12977
12978
12979 @item -maverage
12980 @opindex maverage
12981 Enables the @code{ave} instruction, which computes the average of two
12982 registers.
12983
12984 @item -mbased=@var{n}
12985 @opindex mbased=
12986 Variables of size @var{n} bytes or smaller will be placed in the
12987 @code{.based} section by default.  Based variables use the @code{$tp}
12988 register as a base register, and there is a 128 byte limit to the
12989 @code{.based} section.
12990
12991 @item -mbitops
12992 @opindex mbitops
12993 Enables the bit operation instructions - bit test (@code{btstm}), set
12994 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
12995 test-and-set (@code{tas}).
12996
12997 @item -mc=@var{name}
12998 @opindex mc=
12999 Selects which section constant data will be placed in.  @var{name} may
13000 be @code{tiny}, @code{near}, or @code{far}.
13001
13002 @item -mclip
13003 @opindex mclip
13004 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13005 useful unless you also provide @code{-mminmax}.
13006
13007 @item -mconfig=@var{name}
13008 @opindex mconfig=
13009 Selects one of the build-in core configurations.  Each MeP chip has
13010 one or more modules in it; each module has a core CPU and a variety of
13011 coprocessors, optional instructions, and peripherals.  The
13012 @code{MeP-Integrator} tool, not part of GCC, provides these
13013 configurations through this option; using this option is the same as
13014 using all the corresponding command line options.  The default
13015 configuration is @code{default}.
13016
13017 @item -mcop
13018 @opindex mcop
13019 Enables the coprocessor instructions.  By default, this is a 32-bit
13020 coprocessor.  Note that the coprocessor is normally enabled via the
13021 @code{-mconfig=} option.
13022
13023 @item -mcop32
13024 @opindex mcop32
13025 Enables the 32-bit coprocessor's instructions.
13026
13027 @item -mcop64
13028 @opindex mcop64
13029 Enables the 64-bit coprocessor's instructions.
13030
13031 @item -mivc2
13032 @opindex mivc2
13033 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13034
13035 @item -mdc
13036 @opindex mdc
13037 Causes constant variables to be placed in the @code{.near} section.
13038
13039 @item -mdiv
13040 @opindex mdiv
13041 Enables the @code{div} and @code{divu} instructions.
13042
13043 @item -meb
13044 @opindex meb
13045 Generate big-endian code.
13046
13047 @item -mel
13048 @opindex mel
13049 Generate little-endian code.
13050
13051 @item -mio-volatile
13052 @opindex mio-volatile
13053 Tells the compiler that any variable marked with the @code{io}
13054 attribute is to be considered volatile.
13055
13056 @item -ml
13057 @opindex ml
13058 Causes variables to be assigned to the @code{.far} section by default.
13059
13060 @item -mleadz
13061 @opindex mleadz
13062 Enables the @code{leadz} (leading zero) instruction.
13063
13064 @item -mm
13065 @opindex mm
13066 Causes variables to be assigned to the @code{.near} section by default.
13067
13068 @item -mminmax
13069 @opindex mminmax
13070 Enables the @code{min} and @code{max} instructions.
13071
13072 @item -mmult
13073 @opindex mmult
13074 Enables the multiplication and multiply-accumulate instructions.
13075
13076 @item -mno-opts
13077 @opindex mno-opts
13078 Disables all the optional instructions enabled by @code{-mall-opts}.
13079
13080 @item -mrepeat
13081 @opindex mrepeat
13082 Enables the @code{repeat} and @code{erepeat} instructions, used for
13083 low-overhead looping.
13084
13085 @item -ms
13086 @opindex ms
13087 Causes all variables to default to the @code{.tiny} section.  Note
13088 that there is a 65536 byte limit to this section.  Accesses to these
13089 variables use the @code{%gp} base register.
13090
13091 @item -msatur
13092 @opindex msatur
13093 Enables the saturation instructions.  Note that the compiler does not
13094 currently generate these itself, but this option is included for
13095 compatibility with other tools, like @code{as}.
13096
13097 @item -msdram
13098 @opindex msdram
13099 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13100
13101 @item -msim
13102 @opindex msim
13103 Link the simulator runtime libraries.
13104
13105 @item -msimnovec
13106 @opindex msimnovec
13107 Link the simulator runtime libraries, excluding built-in support
13108 for reset and exception vectors and tables.
13109
13110 @item -mtf
13111 @opindex mtf
13112 Causes all functions to default to the @code{.far} section.  Without
13113 this option, functions default to the @code{.near} section.
13114
13115 @item -mtiny=@var{n}
13116 @opindex mtiny=
13117 Variables that are @var{n} bytes or smaller will be allocated to the
13118 @code{.tiny} section.  These variables use the @code{$gp} base
13119 register.  The default for this option is 4, but note that there's a
13120 65536 byte limit to the @code{.tiny} section.
13121
13122 @end table
13123
13124 @node MIPS Options
13125 @subsection MIPS Options
13126 @cindex MIPS options
13127
13128 @table @gcctabopt
13129
13130 @item -EB
13131 @opindex EB
13132 Generate big-endian code.
13133
13134 @item -EL
13135 @opindex EL
13136 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13137 configurations.
13138
13139 @item -march=@var{arch}
13140 @opindex march
13141 Generate code that will run on @var{arch}, which can be the name of a
13142 generic MIPS ISA, or the name of a particular processor.
13143 The ISA names are:
13144 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13145 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13146 The processor names are:
13147 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13148 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13149 @samp{5kc}, @samp{5kf},
13150 @samp{20kc},
13151 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13152 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13153 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13154 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13155 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13156 @samp{loongson2e}, @samp{loongson2f},
13157 @samp{m4k},
13158 @samp{octeon},
13159 @samp{orion},
13160 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13161 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13162 @samp{rm7000}, @samp{rm9000},
13163 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13164 @samp{sb1},
13165 @samp{sr71000},
13166 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13167 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13168 and @samp{xlr}.
13169 The special value @samp{from-abi} selects the
13170 most compatible architecture for the selected ABI (that is,
13171 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13172
13173 Native Linux/GNU toolchains also support the value @samp{native},
13174 which selects the best architecture option for the host processor.
13175 @option{-march=native} has no effect if GCC does not recognize
13176 the processor.
13177
13178 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13179 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13180 @samp{vr} may be written @samp{r}.
13181
13182 Names of the form @samp{@var{n}f2_1} refer to processors with
13183 FPUs clocked at half the rate of the core, names of the form
13184 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13185 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13186 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13187 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13188 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13189 accepted as synonyms for @samp{@var{n}f1_1}.
13190
13191 GCC defines two macros based on the value of this option.  The first
13192 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13193 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13194 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13195 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13196 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13197
13198 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13199 above.  In other words, it will have the full prefix and will not
13200 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13201 the macro names the resolved architecture (either @samp{"mips1"} or
13202 @samp{"mips3"}).  It names the default architecture when no
13203 @option{-march} option is given.
13204
13205 @item -mtune=@var{arch}
13206 @opindex mtune
13207 Optimize for @var{arch}.  Among other things, this option controls
13208 the way instructions are scheduled, and the perceived cost of arithmetic
13209 operations.  The list of @var{arch} values is the same as for
13210 @option{-march}.
13211
13212 When this option is not used, GCC will optimize for the processor
13213 specified by @option{-march}.  By using @option{-march} and
13214 @option{-mtune} together, it is possible to generate code that will
13215 run on a family of processors, but optimize the code for one
13216 particular member of that family.
13217
13218 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13219 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13220 @samp{-march} ones described above.
13221
13222 @item -mips1
13223 @opindex mips1
13224 Equivalent to @samp{-march=mips1}.
13225
13226 @item -mips2
13227 @opindex mips2
13228 Equivalent to @samp{-march=mips2}.
13229
13230 @item -mips3
13231 @opindex mips3
13232 Equivalent to @samp{-march=mips3}.
13233
13234 @item -mips4
13235 @opindex mips4
13236 Equivalent to @samp{-march=mips4}.
13237
13238 @item -mips32
13239 @opindex mips32
13240 Equivalent to @samp{-march=mips32}.
13241
13242 @item -mips32r2
13243 @opindex mips32r2
13244 Equivalent to @samp{-march=mips32r2}.
13245
13246 @item -mips64
13247 @opindex mips64
13248 Equivalent to @samp{-march=mips64}.
13249
13250 @item -mips64r2
13251 @opindex mips64r2
13252 Equivalent to @samp{-march=mips64r2}.
13253
13254 @item -mips16
13255 @itemx -mno-mips16
13256 @opindex mips16
13257 @opindex mno-mips16
13258 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13259 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13260
13261 MIPS16 code generation can also be controlled on a per-function basis
13262 by means of @code{mips16} and @code{nomips16} attributes.
13263 @xref{Function Attributes}, for more information.
13264
13265 @item -mflip-mips16
13266 @opindex mflip-mips16
13267 Generate MIPS16 code on alternating functions.  This option is provided
13268 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13269 not intended for ordinary use in compiling user code.
13270
13271 @item -minterlink-mips16
13272 @itemx -mno-interlink-mips16
13273 @opindex minterlink-mips16
13274 @opindex mno-interlink-mips16
13275 Require (do not require) that non-MIPS16 code be link-compatible with
13276 MIPS16 code.
13277
13278 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13279 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13280 therefore disables direct jumps unless GCC knows that the target of the
13281 jump is not MIPS16.
13282
13283 @item -mabi=32
13284 @itemx -mabi=o64
13285 @itemx -mabi=n32
13286 @itemx -mabi=64
13287 @itemx -mabi=eabi
13288 @opindex mabi=32
13289 @opindex mabi=o64
13290 @opindex mabi=n32
13291 @opindex mabi=64
13292 @opindex mabi=eabi
13293 Generate code for the given ABI@.
13294
13295 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13296 generates 64-bit code when you select a 64-bit architecture, but you
13297 can use @option{-mgp32} to get 32-bit code instead.
13298
13299 For information about the O64 ABI, see
13300 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13301
13302 GCC supports a variant of the o32 ABI in which floating-point registers
13303 are 64 rather than 32 bits wide.  You can select this combination with
13304 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13305 and @samp{mfhc1} instructions and is therefore only supported for
13306 MIPS32R2 processors.
13307
13308 The register assignments for arguments and return values remain the
13309 same, but each scalar value is passed in a single 64-bit register
13310 rather than a pair of 32-bit registers.  For example, scalar
13311 floating-point values are returned in @samp{$f0} only, not a
13312 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
13313 remains the same, but all 64 bits are saved.
13314
13315 @item -mabicalls
13316 @itemx -mno-abicalls
13317 @opindex mabicalls
13318 @opindex mno-abicalls
13319 Generate (do not generate) code that is suitable for SVR4-style
13320 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
13321 systems.
13322
13323 @item -mshared
13324 @itemx -mno-shared
13325 Generate (do not generate) code that is fully position-independent,
13326 and that can therefore be linked into shared libraries.  This option
13327 only affects @option{-mabicalls}.
13328
13329 All @option{-mabicalls} code has traditionally been position-independent,
13330 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
13331 as an extension, the GNU toolchain allows executables to use absolute
13332 accesses for locally-binding symbols.  It can also use shorter GP
13333 initialization sequences and generate direct calls to locally-defined
13334 functions.  This mode is selected by @option{-mno-shared}.
13335
13336 @option{-mno-shared} depends on binutils 2.16 or higher and generates
13337 objects that can only be linked by the GNU linker.  However, the option
13338 does not affect the ABI of the final executable; it only affects the ABI
13339 of relocatable objects.  Using @option{-mno-shared} will generally make
13340 executables both smaller and quicker.
13341
13342 @option{-mshared} is the default.
13343
13344 @item -mplt
13345 @itemx -mno-plt
13346 @opindex mplt
13347 @opindex mno-plt
13348 Assume (do not assume) that the static and dynamic linkers
13349 support PLTs and copy relocations.  This option only affects
13350 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
13351 has no effect without @samp{-msym32}.
13352
13353 You can make @option{-mplt} the default by configuring
13354 GCC with @option{--with-mips-plt}.  The default is
13355 @option{-mno-plt} otherwise.
13356
13357 @item -mxgot
13358 @itemx -mno-xgot
13359 @opindex mxgot
13360 @opindex mno-xgot
13361 Lift (do not lift) the usual restrictions on the size of the global
13362 offset table.
13363
13364 GCC normally uses a single instruction to load values from the GOT@.
13365 While this is relatively efficient, it will only work if the GOT
13366 is smaller than about 64k.  Anything larger will cause the linker
13367 to report an error such as:
13368
13369 @cindex relocation truncated to fit (MIPS)
13370 @smallexample
13371 relocation truncated to fit: R_MIPS_GOT16 foobar
13372 @end smallexample
13373
13374 If this happens, you should recompile your code with @option{-mxgot}.
13375 It should then work with very large GOTs, although it will also be
13376 less efficient, since it will take three instructions to fetch the
13377 value of a global symbol.
13378
13379 Note that some linkers can create multiple GOTs.  If you have such a
13380 linker, you should only need to use @option{-mxgot} when a single object
13381 file accesses more than 64k's worth of GOT entries.  Very few do.
13382
13383 These options have no effect unless GCC is generating position
13384 independent code.
13385
13386 @item -mgp32
13387 @opindex mgp32
13388 Assume that general-purpose registers are 32 bits wide.
13389
13390 @item -mgp64
13391 @opindex mgp64
13392 Assume that general-purpose registers are 64 bits wide.
13393
13394 @item -mfp32
13395 @opindex mfp32
13396 Assume that floating-point registers are 32 bits wide.
13397
13398 @item -mfp64
13399 @opindex mfp64
13400 Assume that floating-point registers are 64 bits wide.
13401
13402 @item -mhard-float
13403 @opindex mhard-float
13404 Use floating-point coprocessor instructions.
13405
13406 @item -msoft-float
13407 @opindex msoft-float
13408 Do not use floating-point coprocessor instructions.  Implement
13409 floating-point calculations using library calls instead.
13410
13411 @item -msingle-float
13412 @opindex msingle-float
13413 Assume that the floating-point coprocessor only supports single-precision
13414 operations.
13415
13416 @item -mdouble-float
13417 @opindex mdouble-float
13418 Assume that the floating-point coprocessor supports double-precision
13419 operations.  This is the default.
13420
13421 @item -mllsc
13422 @itemx -mno-llsc
13423 @opindex mllsc
13424 @opindex mno-llsc
13425 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
13426 implement atomic memory built-in functions.  When neither option is
13427 specified, GCC will use the instructions if the target architecture
13428 supports them.
13429
13430 @option{-mllsc} is useful if the runtime environment can emulate the
13431 instructions and @option{-mno-llsc} can be useful when compiling for
13432 nonstandard ISAs.  You can make either option the default by
13433 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
13434 respectively.  @option{--with-llsc} is the default for some
13435 configurations; see the installation documentation for details.
13436
13437 @item -mdsp
13438 @itemx -mno-dsp
13439 @opindex mdsp
13440 @opindex mno-dsp
13441 Use (do not use) revision 1 of the MIPS DSP ASE@.
13442 @xref{MIPS DSP Built-in Functions}.  This option defines the
13443 preprocessor macro @samp{__mips_dsp}.  It also defines
13444 @samp{__mips_dsp_rev} to 1.
13445
13446 @item -mdspr2
13447 @itemx -mno-dspr2
13448 @opindex mdspr2
13449 @opindex mno-dspr2
13450 Use (do not use) revision 2 of the MIPS DSP ASE@.
13451 @xref{MIPS DSP Built-in Functions}.  This option defines the
13452 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
13453 It also defines @samp{__mips_dsp_rev} to 2.
13454
13455 @item -msmartmips
13456 @itemx -mno-smartmips
13457 @opindex msmartmips
13458 @opindex mno-smartmips
13459 Use (do not use) the MIPS SmartMIPS ASE.
13460
13461 @item -mpaired-single
13462 @itemx -mno-paired-single
13463 @opindex mpaired-single
13464 @opindex mno-paired-single
13465 Use (do not use) paired-single floating-point instructions.
13466 @xref{MIPS Paired-Single Support}.  This option requires
13467 hardware floating-point support to be enabled.
13468
13469 @item -mdmx
13470 @itemx -mno-mdmx
13471 @opindex mdmx
13472 @opindex mno-mdmx
13473 Use (do not use) MIPS Digital Media Extension instructions.
13474 This option can only be used when generating 64-bit code and requires
13475 hardware floating-point support to be enabled.
13476
13477 @item -mips3d
13478 @itemx -mno-mips3d
13479 @opindex mips3d
13480 @opindex mno-mips3d
13481 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
13482 The option @option{-mips3d} implies @option{-mpaired-single}.
13483
13484 @item -mmt
13485 @itemx -mno-mt
13486 @opindex mmt
13487 @opindex mno-mt
13488 Use (do not use) MT Multithreading instructions.
13489
13490 @item -mlong64
13491 @opindex mlong64
13492 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
13493 an explanation of the default and the way that the pointer size is
13494 determined.
13495
13496 @item -mlong32
13497 @opindex mlong32
13498 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
13499
13500 The default size of @code{int}s, @code{long}s and pointers depends on
13501 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
13502 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
13503 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
13504 or the same size as integer registers, whichever is smaller.
13505
13506 @item -msym32
13507 @itemx -mno-sym32
13508 @opindex msym32
13509 @opindex mno-sym32
13510 Assume (do not assume) that all symbols have 32-bit values, regardless
13511 of the selected ABI@.  This option is useful in combination with
13512 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
13513 to generate shorter and faster references to symbolic addresses.
13514
13515 @item -G @var{num}
13516 @opindex G
13517 Put definitions of externally-visible data in a small data section
13518 if that data is no bigger than @var{num} bytes.  GCC can then access
13519 the data more efficiently; see @option{-mgpopt} for details.
13520
13521 The default @option{-G} option depends on the configuration.
13522
13523 @item -mlocal-sdata
13524 @itemx -mno-local-sdata
13525 @opindex mlocal-sdata
13526 @opindex mno-local-sdata
13527 Extend (do not extend) the @option{-G} behavior to local data too,
13528 such as to static variables in C@.  @option{-mlocal-sdata} is the
13529 default for all configurations.
13530
13531 If the linker complains that an application is using too much small data,
13532 you might want to try rebuilding the less performance-critical parts with
13533 @option{-mno-local-sdata}.  You might also want to build large
13534 libraries with @option{-mno-local-sdata}, so that the libraries leave
13535 more room for the main program.
13536
13537 @item -mextern-sdata
13538 @itemx -mno-extern-sdata
13539 @opindex mextern-sdata
13540 @opindex mno-extern-sdata
13541 Assume (do not assume) that externally-defined data will be in
13542 a small data section if that data is within the @option{-G} limit.
13543 @option{-mextern-sdata} is the default for all configurations.
13544
13545 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
13546 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
13547 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
13548 is placed in a small data section.  If @var{Var} is defined by another
13549 module, you must either compile that module with a high-enough
13550 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
13551 definition.  If @var{Var} is common, you must link the application
13552 with a high-enough @option{-G} setting.
13553
13554 The easiest way of satisfying these restrictions is to compile
13555 and link every module with the same @option{-G} option.  However,
13556 you may wish to build a library that supports several different
13557 small data limits.  You can do this by compiling the library with
13558 the highest supported @option{-G} setting and additionally using
13559 @option{-mno-extern-sdata} to stop the library from making assumptions
13560 about externally-defined data.
13561
13562 @item -mgpopt
13563 @itemx -mno-gpopt
13564 @opindex mgpopt
13565 @opindex mno-gpopt
13566 Use (do not use) GP-relative accesses for symbols that are known to be
13567 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
13568 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
13569 configurations.
13570
13571 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
13572 might not hold the value of @code{_gp}.  For example, if the code is
13573 part of a library that might be used in a boot monitor, programs that
13574 call boot monitor routines will pass an unknown value in @code{$gp}.
13575 (In such situations, the boot monitor itself would usually be compiled
13576 with @option{-G0}.)
13577
13578 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
13579 @option{-mno-extern-sdata}.
13580
13581 @item -membedded-data
13582 @itemx -mno-embedded-data
13583 @opindex membedded-data
13584 @opindex mno-embedded-data
13585 Allocate variables to the read-only data section first if possible, then
13586 next in the small data section if possible, otherwise in data.  This gives
13587 slightly slower code than the default, but reduces the amount of RAM required
13588 when executing, and thus may be preferred for some embedded systems.
13589
13590 @item -muninit-const-in-rodata
13591 @itemx -mno-uninit-const-in-rodata
13592 @opindex muninit-const-in-rodata
13593 @opindex mno-uninit-const-in-rodata
13594 Put uninitialized @code{const} variables in the read-only data section.
13595 This option is only meaningful in conjunction with @option{-membedded-data}.
13596
13597 @item -mcode-readable=@var{setting}
13598 @opindex mcode-readable
13599 Specify whether GCC may generate code that reads from executable sections.
13600 There are three possible settings:
13601
13602 @table @gcctabopt
13603 @item -mcode-readable=yes
13604 Instructions may freely access executable sections.  This is the
13605 default setting.
13606
13607 @item -mcode-readable=pcrel
13608 MIPS16 PC-relative load instructions can access executable sections,
13609 but other instructions must not do so.  This option is useful on 4KSc
13610 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
13611 It is also useful on processors that can be configured to have a dual
13612 instruction/data SRAM interface and that, like the M4K, automatically
13613 redirect PC-relative loads to the instruction RAM.
13614
13615 @item -mcode-readable=no
13616 Instructions must not access executable sections.  This option can be
13617 useful on targets that are configured to have a dual instruction/data
13618 SRAM interface but that (unlike the M4K) do not automatically redirect
13619 PC-relative loads to the instruction RAM.
13620 @end table
13621
13622 @item -msplit-addresses
13623 @itemx -mno-split-addresses
13624 @opindex msplit-addresses
13625 @opindex mno-split-addresses
13626 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
13627 relocation operators.  This option has been superseded by
13628 @option{-mexplicit-relocs} but is retained for backwards compatibility.
13629
13630 @item -mexplicit-relocs
13631 @itemx -mno-explicit-relocs
13632 @opindex mexplicit-relocs
13633 @opindex mno-explicit-relocs
13634 Use (do not use) assembler relocation operators when dealing with symbolic
13635 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
13636 is to use assembler macros instead.
13637
13638 @option{-mexplicit-relocs} is the default if GCC was configured
13639 to use an assembler that supports relocation operators.
13640
13641 @item -mcheck-zero-division
13642 @itemx -mno-check-zero-division
13643 @opindex mcheck-zero-division
13644 @opindex mno-check-zero-division
13645 Trap (do not trap) on integer division by zero.
13646
13647 The default is @option{-mcheck-zero-division}.
13648
13649 @item -mdivide-traps
13650 @itemx -mdivide-breaks
13651 @opindex mdivide-traps
13652 @opindex mdivide-breaks
13653 MIPS systems check for division by zero by generating either a
13654 conditional trap or a break instruction.  Using traps results in
13655 smaller code, but is only supported on MIPS II and later.  Also, some
13656 versions of the Linux kernel have a bug that prevents trap from
13657 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
13658 allow conditional traps on architectures that support them and
13659 @option{-mdivide-breaks} to force the use of breaks.
13660
13661 The default is usually @option{-mdivide-traps}, but this can be
13662 overridden at configure time using @option{--with-divide=breaks}.
13663 Divide-by-zero checks can be completely disabled using
13664 @option{-mno-check-zero-division}.
13665
13666 @item -mmemcpy
13667 @itemx -mno-memcpy
13668 @opindex mmemcpy
13669 @opindex mno-memcpy
13670 Force (do not force) the use of @code{memcpy()} for non-trivial block
13671 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
13672 most constant-sized copies.
13673
13674 @item -mlong-calls
13675 @itemx -mno-long-calls
13676 @opindex mlong-calls
13677 @opindex mno-long-calls
13678 Disable (do not disable) use of the @code{jal} instruction.  Calling
13679 functions using @code{jal} is more efficient but requires the caller
13680 and callee to be in the same 256 megabyte segment.
13681
13682 This option has no effect on abicalls code.  The default is
13683 @option{-mno-long-calls}.
13684
13685 @item -mmad
13686 @itemx -mno-mad
13687 @opindex mmad
13688 @opindex mno-mad
13689 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
13690 instructions, as provided by the R4650 ISA@.
13691
13692 @item -mfused-madd
13693 @itemx -mno-fused-madd
13694 @opindex mfused-madd
13695 @opindex mno-fused-madd
13696 Enable (disable) use of the floating point multiply-accumulate
13697 instructions, when they are available.  The default is
13698 @option{-mfused-madd}.
13699
13700 When multiply-accumulate instructions are used, the intermediate
13701 product is calculated to infinite precision and is not subject to
13702 the FCSR Flush to Zero bit.  This may be undesirable in some
13703 circumstances.
13704
13705 @item -nocpp
13706 @opindex nocpp
13707 Tell the MIPS assembler to not run its preprocessor over user
13708 assembler files (with a @samp{.s} suffix) when assembling them.
13709
13710 @item -mfix-r4000
13711 @itemx -mno-fix-r4000
13712 @opindex mfix-r4000
13713 @opindex mno-fix-r4000
13714 Work around certain R4000 CPU errata:
13715 @itemize @minus
13716 @item
13717 A double-word or a variable shift may give an incorrect result if executed
13718 immediately after starting an integer division.
13719 @item
13720 A double-word or a variable shift may give an incorrect result if executed
13721 while an integer multiplication is in progress.
13722 @item
13723 An integer division may give an incorrect result if started in a delay slot
13724 of a taken branch or a jump.
13725 @end itemize
13726
13727 @item -mfix-r4400
13728 @itemx -mno-fix-r4400
13729 @opindex mfix-r4400
13730 @opindex mno-fix-r4400
13731 Work around certain R4400 CPU errata:
13732 @itemize @minus
13733 @item
13734 A double-word or a variable shift may give an incorrect result if executed
13735 immediately after starting an integer division.
13736 @end itemize
13737
13738 @item -mfix-r10000
13739 @itemx -mno-fix-r10000
13740 @opindex mfix-r10000
13741 @opindex mno-fix-r10000
13742 Work around certain R10000 errata:
13743 @itemize @minus
13744 @item
13745 @code{ll}/@code{sc} sequences may not behave atomically on revisions
13746 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
13747 @end itemize
13748
13749 This option can only be used if the target architecture supports
13750 branch-likely instructions.  @option{-mfix-r10000} is the default when
13751 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
13752 otherwise.
13753
13754 @item -mfix-vr4120
13755 @itemx -mno-fix-vr4120
13756 @opindex mfix-vr4120
13757 Work around certain VR4120 errata:
13758 @itemize @minus
13759 @item
13760 @code{dmultu} does not always produce the correct result.
13761 @item
13762 @code{div} and @code{ddiv} do not always produce the correct result if one
13763 of the operands is negative.
13764 @end itemize
13765 The workarounds for the division errata rely on special functions in
13766 @file{libgcc.a}.  At present, these functions are only provided by
13767 the @code{mips64vr*-elf} configurations.
13768
13769 Other VR4120 errata require a nop to be inserted between certain pairs of
13770 instructions.  These errata are handled by the assembler, not by GCC itself.
13771
13772 @item -mfix-vr4130
13773 @opindex mfix-vr4130
13774 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
13775 workarounds are implemented by the assembler rather than by GCC,
13776 although GCC will avoid using @code{mflo} and @code{mfhi} if the
13777 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
13778 instructions are available instead.
13779
13780 @item -mfix-sb1
13781 @itemx -mno-fix-sb1
13782 @opindex mfix-sb1
13783 Work around certain SB-1 CPU core errata.
13784 (This flag currently works around the SB-1 revision 2
13785 ``F1'' and ``F2'' floating point errata.)
13786
13787 @item -mr10k-cache-barrier=@var{setting}
13788 @opindex mr10k-cache-barrier
13789 Specify whether GCC should insert cache barriers to avoid the
13790 side-effects of speculation on R10K processors.
13791
13792 In common with many processors, the R10K tries to predict the outcome
13793 of a conditional branch and speculatively executes instructions from
13794 the ``taken'' branch.  It later aborts these instructions if the
13795 predicted outcome was wrong.  However, on the R10K, even aborted
13796 instructions can have side effects.
13797
13798 This problem only affects kernel stores and, depending on the system,
13799 kernel loads.  As an example, a speculatively-executed store may load
13800 the target memory into cache and mark the cache line as dirty, even if
13801 the store itself is later aborted.  If a DMA operation writes to the
13802 same area of memory before the ``dirty'' line is flushed, the cached
13803 data will overwrite the DMA-ed data.  See the R10K processor manual
13804 for a full description, including other potential problems.
13805
13806 One workaround is to insert cache barrier instructions before every memory
13807 access that might be speculatively executed and that might have side
13808 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
13809 controls GCC's implementation of this workaround.  It assumes that
13810 aborted accesses to any byte in the following regions will not have
13811 side effects:
13812
13813 @enumerate
13814 @item
13815 the memory occupied by the current function's stack frame;
13816
13817 @item
13818 the memory occupied by an incoming stack argument;
13819
13820 @item
13821 the memory occupied by an object with a link-time-constant address.
13822 @end enumerate
13823
13824 It is the kernel's responsibility to ensure that speculative
13825 accesses to these regions are indeed safe.
13826
13827 If the input program contains a function declaration such as:
13828
13829 @smallexample
13830 void foo (void);
13831 @end smallexample
13832
13833 then the implementation of @code{foo} must allow @code{j foo} and
13834 @code{jal foo} to be executed speculatively.  GCC honors this
13835 restriction for functions it compiles itself.  It expects non-GCC
13836 functions (such as hand-written assembly code) to do the same.
13837
13838 The option has three forms:
13839
13840 @table @gcctabopt
13841 @item -mr10k-cache-barrier=load-store
13842 Insert a cache barrier before a load or store that might be
13843 speculatively executed and that might have side effects even
13844 if aborted.
13845
13846 @item -mr10k-cache-barrier=store
13847 Insert a cache barrier before a store that might be speculatively
13848 executed and that might have side effects even if aborted.
13849
13850 @item -mr10k-cache-barrier=none
13851 Disable the insertion of cache barriers.  This is the default setting.
13852 @end table
13853
13854 @item -mflush-func=@var{func}
13855 @itemx -mno-flush-func
13856 @opindex mflush-func
13857 Specifies the function to call to flush the I and D caches, or to not
13858 call any such function.  If called, the function must take the same
13859 arguments as the common @code{_flush_func()}, that is, the address of the
13860 memory range for which the cache is being flushed, the size of the
13861 memory range, and the number 3 (to flush both caches).  The default
13862 depends on the target GCC was configured for, but commonly is either
13863 @samp{_flush_func} or @samp{__cpu_flush}.
13864
13865 @item mbranch-cost=@var{num}
13866 @opindex mbranch-cost
13867 Set the cost of branches to roughly @var{num} ``simple'' instructions.
13868 This cost is only a heuristic and is not guaranteed to produce
13869 consistent results across releases.  A zero cost redundantly selects
13870 the default, which is based on the @option{-mtune} setting.
13871
13872 @item -mbranch-likely
13873 @itemx -mno-branch-likely
13874 @opindex mbranch-likely
13875 @opindex mno-branch-likely
13876 Enable or disable use of Branch Likely instructions, regardless of the
13877 default for the selected architecture.  By default, Branch Likely
13878 instructions may be generated if they are supported by the selected
13879 architecture.  An exception is for the MIPS32 and MIPS64 architectures
13880 and processors which implement those architectures; for those, Branch
13881 Likely instructions will not be generated by default because the MIPS32
13882 and MIPS64 architectures specifically deprecate their use.
13883
13884 @item -mfp-exceptions
13885 @itemx -mno-fp-exceptions
13886 @opindex mfp-exceptions
13887 Specifies whether FP exceptions are enabled.  This affects how we schedule
13888 FP instructions for some processors.  The default is that FP exceptions are
13889 enabled.
13890
13891 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
13892 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
13893 FP pipe.
13894
13895 @item -mvr4130-align
13896 @itemx -mno-vr4130-align
13897 @opindex mvr4130-align
13898 The VR4130 pipeline is two-way superscalar, but can only issue two
13899 instructions together if the first one is 8-byte aligned.  When this
13900 option is enabled, GCC will align pairs of instructions that it
13901 thinks should execute in parallel.
13902
13903 This option only has an effect when optimizing for the VR4130.
13904 It normally makes code faster, but at the expense of making it bigger.
13905 It is enabled by default at optimization level @option{-O3}.
13906
13907 @item -msynci
13908 @itemx -mno-synci
13909 @opindex msynci
13910 Enable (disable) generation of @code{synci} instructions on
13911 architectures that support it.  The @code{synci} instructions (if
13912 enabled) will be generated when @code{__builtin___clear_cache()} is
13913 compiled.
13914
13915 This option defaults to @code{-mno-synci}, but the default can be
13916 overridden by configuring with @code{--with-synci}.
13917
13918 When compiling code for single processor systems, it is generally safe
13919 to use @code{synci}.  However, on many multi-core (SMP) systems, it
13920 will not invalidate the instruction caches on all cores and may lead
13921 to undefined behavior.
13922
13923 @item -mrelax-pic-calls
13924 @itemx -mno-relax-pic-calls
13925 @opindex mrelax-pic-calls
13926 Try to turn PIC calls that are normally dispatched via register
13927 @code{$25} into direct calls.  This is only possible if the linker can
13928 resolve the destination at link-time and if the destination is within
13929 range for a direct call.
13930
13931 @option{-mrelax-pic-calls} is the default if GCC was configured to use
13932 an assembler and a linker that supports the @code{.reloc} assembly
13933 directive and @code{-mexplicit-relocs} is in effect.  With
13934 @code{-mno-explicit-relocs}, this optimization can be performed by the
13935 assembler and the linker alone without help from the compiler.
13936 @end table
13937
13938 @node MMIX Options
13939 @subsection MMIX Options
13940 @cindex MMIX Options
13941
13942 These options are defined for the MMIX:
13943
13944 @table @gcctabopt
13945 @item -mlibfuncs
13946 @itemx -mno-libfuncs
13947 @opindex mlibfuncs
13948 @opindex mno-libfuncs
13949 Specify that intrinsic library functions are being compiled, passing all
13950 values in registers, no matter the size.
13951
13952 @item -mepsilon
13953 @itemx -mno-epsilon
13954 @opindex mepsilon
13955 @opindex mno-epsilon
13956 Generate floating-point comparison instructions that compare with respect
13957 to the @code{rE} epsilon register.
13958
13959 @item -mabi=mmixware
13960 @itemx -mabi=gnu
13961 @opindex mabi=mmixware
13962 @opindex mabi=gnu
13963 Generate code that passes function parameters and return values that (in
13964 the called function) are seen as registers @code{$0} and up, as opposed to
13965 the GNU ABI which uses global registers @code{$231} and up.
13966
13967 @item -mzero-extend
13968 @itemx -mno-zero-extend
13969 @opindex mzero-extend
13970 @opindex mno-zero-extend
13971 When reading data from memory in sizes shorter than 64 bits, use (do not
13972 use) zero-extending load instructions by default, rather than
13973 sign-extending ones.
13974
13975 @item -mknuthdiv
13976 @itemx -mno-knuthdiv
13977 @opindex mknuthdiv
13978 @opindex mno-knuthdiv
13979 Make the result of a division yielding a remainder have the same sign as
13980 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
13981 remainder follows the sign of the dividend.  Both methods are
13982 arithmetically valid, the latter being almost exclusively used.
13983
13984 @item -mtoplevel-symbols
13985 @itemx -mno-toplevel-symbols
13986 @opindex mtoplevel-symbols
13987 @opindex mno-toplevel-symbols
13988 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
13989 code can be used with the @code{PREFIX} assembly directive.
13990
13991 @item -melf
13992 @opindex melf
13993 Generate an executable in the ELF format, rather than the default
13994 @samp{mmo} format used by the @command{mmix} simulator.
13995
13996 @item -mbranch-predict
13997 @itemx -mno-branch-predict
13998 @opindex mbranch-predict
13999 @opindex mno-branch-predict
14000 Use (do not use) the probable-branch instructions, when static branch
14001 prediction indicates a probable branch.
14002
14003 @item -mbase-addresses
14004 @itemx -mno-base-addresses
14005 @opindex mbase-addresses
14006 @opindex mno-base-addresses
14007 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14008 base address automatically generates a request (handled by the assembler
14009 and the linker) for a constant to be set up in a global register.  The
14010 register is used for one or more base address requests within the range 0
14011 to 255 from the value held in the register.  The generally leads to short
14012 and fast code, but the number of different data items that can be
14013 addressed is limited.  This means that a program that uses lots of static
14014 data may require @option{-mno-base-addresses}.
14015
14016 @item -msingle-exit
14017 @itemx -mno-single-exit
14018 @opindex msingle-exit
14019 @opindex mno-single-exit
14020 Force (do not force) generated code to have a single exit point in each
14021 function.
14022 @end table
14023
14024 @node MN10300 Options
14025 @subsection MN10300 Options
14026 @cindex MN10300 options
14027
14028 These @option{-m} options are defined for Matsushita MN10300 architectures:
14029
14030 @table @gcctabopt
14031 @item -mmult-bug
14032 @opindex mmult-bug
14033 Generate code to avoid bugs in the multiply instructions for the MN10300
14034 processors.  This is the default.
14035
14036 @item -mno-mult-bug
14037 @opindex mno-mult-bug
14038 Do not generate code to avoid bugs in the multiply instructions for the
14039 MN10300 processors.
14040
14041 @item -mam33
14042 @opindex mam33
14043 Generate code which uses features specific to the AM33 processor.
14044
14045 @item -mno-am33
14046 @opindex mno-am33
14047 Do not generate code which uses features specific to the AM33 processor.  This
14048 is the default.
14049
14050 @item -mreturn-pointer-on-d0
14051 @opindex mreturn-pointer-on-d0
14052 When generating a function which returns a pointer, return the pointer
14053 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14054 only in a0, and attempts to call such functions without a prototype
14055 would result in errors.  Note that this option is on by default; use
14056 @option{-mno-return-pointer-on-d0} to disable it.
14057
14058 @item -mno-crt0
14059 @opindex mno-crt0
14060 Do not link in the C run-time initialization object file.
14061
14062 @item -mrelax
14063 @opindex mrelax
14064 Indicate to the linker that it should perform a relaxation optimization pass
14065 to shorten branches, calls and absolute memory addresses.  This option only
14066 has an effect when used on the command line for the final link step.
14067
14068 This option makes symbolic debugging impossible.
14069 @end table
14070
14071 @node PDP-11 Options
14072 @subsection PDP-11 Options
14073 @cindex PDP-11 Options
14074
14075 These options are defined for the PDP-11:
14076
14077 @table @gcctabopt
14078 @item -mfpu
14079 @opindex mfpu
14080 Use hardware FPP floating point.  This is the default.  (FIS floating
14081 point on the PDP-11/40 is not supported.)
14082
14083 @item -msoft-float
14084 @opindex msoft-float
14085 Do not use hardware floating point.
14086
14087 @item -mac0
14088 @opindex mac0
14089 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14090
14091 @item -mno-ac0
14092 @opindex mno-ac0
14093 Return floating-point results in memory.  This is the default.
14094
14095 @item -m40
14096 @opindex m40
14097 Generate code for a PDP-11/40.
14098
14099 @item -m45
14100 @opindex m45
14101 Generate code for a PDP-11/45.  This is the default.
14102
14103 @item -m10
14104 @opindex m10
14105 Generate code for a PDP-11/10.
14106
14107 @item -mbcopy-builtin
14108 @opindex mbcopy-builtin
14109 Use inline @code{movmemhi} patterns for copying memory.  This is the
14110 default.
14111
14112 @item -mbcopy
14113 @opindex mbcopy
14114 Do not use inline @code{movmemhi} patterns for copying memory.
14115
14116 @item -mint16
14117 @itemx -mno-int32
14118 @opindex mint16
14119 @opindex mno-int32
14120 Use 16-bit @code{int}.  This is the default.
14121
14122 @item -mint32
14123 @itemx -mno-int16
14124 @opindex mint32
14125 @opindex mno-int16
14126 Use 32-bit @code{int}.
14127
14128 @item -mfloat64
14129 @itemx -mno-float32
14130 @opindex mfloat64
14131 @opindex mno-float32
14132 Use 64-bit @code{float}.  This is the default.
14133
14134 @item -mfloat32
14135 @itemx -mno-float64
14136 @opindex mfloat32
14137 @opindex mno-float64
14138 Use 32-bit @code{float}.
14139
14140 @item -mabshi
14141 @opindex mabshi
14142 Use @code{abshi2} pattern.  This is the default.
14143
14144 @item -mno-abshi
14145 @opindex mno-abshi
14146 Do not use @code{abshi2} pattern.
14147
14148 @item -mbranch-expensive
14149 @opindex mbranch-expensive
14150 Pretend that branches are expensive.  This is for experimenting with
14151 code generation only.
14152
14153 @item -mbranch-cheap
14154 @opindex mbranch-cheap
14155 Do not pretend that branches are expensive.  This is the default.
14156
14157 @item -msplit
14158 @opindex msplit
14159 Generate code for a system with split I&D@.
14160
14161 @item -mno-split
14162 @opindex mno-split
14163 Generate code for a system without split I&D@.  This is the default.
14164
14165 @item -munix-asm
14166 @opindex munix-asm
14167 Use Unix assembler syntax.  This is the default when configured for
14168 @samp{pdp11-*-bsd}.
14169
14170 @item -mdec-asm
14171 @opindex mdec-asm
14172 Use DEC assembler syntax.  This is the default when configured for any
14173 PDP-11 target other than @samp{pdp11-*-bsd}.
14174 @end table
14175
14176 @node picoChip Options
14177 @subsection picoChip Options
14178 @cindex picoChip options
14179
14180 These @samp{-m} options are defined for picoChip implementations:
14181
14182 @table @gcctabopt
14183
14184 @item -mae=@var{ae_type}
14185 @opindex mcpu
14186 Set the instruction set, register set, and instruction scheduling
14187 parameters for array element type @var{ae_type}.  Supported values
14188 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14189
14190 @option{-mae=ANY} selects a completely generic AE type.  Code
14191 generated with this option will run on any of the other AE types.  The
14192 code will not be as efficient as it would be if compiled for a specific
14193 AE type, and some types of operation (e.g., multiplication) will not
14194 work properly on all types of AE.
14195
14196 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14197 for compiled code, and is the default.
14198
14199 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14200 option may suffer from poor performance of byte (char) manipulation,
14201 since the DSP AE does not provide hardware support for byte load/stores.
14202
14203 @item -msymbol-as-address
14204 Enable the compiler to directly use a symbol name as an address in a
14205 load/store instruction, without first loading it into a
14206 register.  Typically, the use of this option will generate larger
14207 programs, which run faster than when the option isn't used.  However, the
14208 results vary from program to program, so it is left as a user option,
14209 rather than being permanently enabled.
14210
14211 @item -mno-inefficient-warnings
14212 Disables warnings about the generation of inefficient code.  These
14213 warnings can be generated, for example, when compiling code which
14214 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14215 no hardware support for byte-level memory operations, so all byte
14216 load/stores must be synthesized from word load/store operations.  This is
14217 inefficient and a warning will be generated indicating to the programmer
14218 that they should rewrite the code to avoid byte operations, or to target
14219 an AE type which has the necessary hardware support.  This option enables
14220 the warning to be turned off.
14221
14222 @end table
14223
14224 @node PowerPC Options
14225 @subsection PowerPC Options
14226 @cindex PowerPC options
14227
14228 These are listed under @xref{RS/6000 and PowerPC Options}.
14229
14230 @node RS/6000 and PowerPC Options
14231 @subsection IBM RS/6000 and PowerPC Options
14232 @cindex RS/6000 and PowerPC Options
14233 @cindex IBM RS/6000 and PowerPC Options
14234
14235 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14236 @table @gcctabopt
14237 @item -mpower
14238 @itemx -mno-power
14239 @itemx -mpower2
14240 @itemx -mno-power2
14241 @itemx -mpowerpc
14242 @itemx -mno-powerpc
14243 @itemx -mpowerpc-gpopt
14244 @itemx -mno-powerpc-gpopt
14245 @itemx -mpowerpc-gfxopt
14246 @itemx -mno-powerpc-gfxopt
14247 @itemx -mpowerpc64
14248 @itemx -mno-powerpc64
14249 @itemx -mmfcrf
14250 @itemx -mno-mfcrf
14251 @itemx -mpopcntb
14252 @itemx -mno-popcntb
14253 @itemx -mpopcntd
14254 @itemx -mno-popcntd
14255 @itemx -mfprnd
14256 @itemx -mno-fprnd
14257 @itemx -mcmpb
14258 @itemx -mno-cmpb
14259 @itemx -mmfpgpr
14260 @itemx -mno-mfpgpr
14261 @itemx -mhard-dfp
14262 @itemx -mno-hard-dfp
14263 @opindex mpower
14264 @opindex mno-power
14265 @opindex mpower2
14266 @opindex mno-power2
14267 @opindex mpowerpc
14268 @opindex mno-powerpc
14269 @opindex mpowerpc-gpopt
14270 @opindex mno-powerpc-gpopt
14271 @opindex mpowerpc-gfxopt
14272 @opindex mno-powerpc-gfxopt
14273 @opindex mpowerpc64
14274 @opindex mno-powerpc64
14275 @opindex mmfcrf
14276 @opindex mno-mfcrf
14277 @opindex mpopcntb
14278 @opindex mno-popcntb
14279 @opindex mpopcntd
14280 @opindex mno-popcntd
14281 @opindex mfprnd
14282 @opindex mno-fprnd
14283 @opindex mcmpb
14284 @opindex mno-cmpb
14285 @opindex mmfpgpr
14286 @opindex mno-mfpgpr
14287 @opindex mhard-dfp
14288 @opindex mno-hard-dfp
14289 GCC supports two related instruction set architectures for the
14290 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14291 instructions supported by the @samp{rios} chip set used in the original
14292 RS/6000 systems and the @dfn{PowerPC} instruction set is the
14293 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
14294 the IBM 4xx, 6xx, and follow-on microprocessors.
14295
14296 Neither architecture is a subset of the other.  However there is a
14297 large common subset of instructions supported by both.  An MQ
14298 register is included in processors supporting the POWER architecture.
14299
14300 You use these options to specify which instructions are available on the
14301 processor you are using.  The default value of these options is
14302 determined when configuring GCC@.  Specifying the
14303 @option{-mcpu=@var{cpu_type}} overrides the specification of these
14304 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
14305 rather than the options listed above.
14306
14307 The @option{-mpower} option allows GCC to generate instructions that
14308 are found only in the POWER architecture and to use the MQ register.
14309 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
14310 to generate instructions that are present in the POWER2 architecture but
14311 not the original POWER architecture.
14312
14313 The @option{-mpowerpc} option allows GCC to generate instructions that
14314 are found only in the 32-bit subset of the PowerPC architecture.
14315 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
14316 GCC to use the optional PowerPC architecture instructions in the
14317 General Purpose group, including floating-point square root.  Specifying
14318 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
14319 use the optional PowerPC architecture instructions in the Graphics
14320 group, including floating-point select.
14321
14322 The @option{-mmfcrf} option allows GCC to generate the move from
14323 condition register field instruction implemented on the POWER4
14324 processor and other processors that support the PowerPC V2.01
14325 architecture.
14326 The @option{-mpopcntb} option allows GCC to generate the popcount and
14327 double precision FP reciprocal estimate instruction implemented on the
14328 POWER5 processor and other processors that support the PowerPC V2.02
14329 architecture.
14330 The @option{-mpopcntd} option allows GCC to generate the popcount
14331 instruction implemented on the POWER7 processor and other processors
14332 that support the PowerPC V2.06 architecture.
14333 The @option{-mfprnd} option allows GCC to generate the FP round to
14334 integer instructions implemented on the POWER5+ processor and other
14335 processors that support the PowerPC V2.03 architecture.
14336 The @option{-mcmpb} option allows GCC to generate the compare bytes
14337 instruction implemented on the POWER6 processor and other processors
14338 that support the PowerPC V2.05 architecture.
14339 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
14340 general purpose register instructions implemented on the POWER6X
14341 processor and other processors that support the extended PowerPC V2.05
14342 architecture.
14343 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
14344 point instructions implemented on some POWER processors.
14345
14346 The @option{-mpowerpc64} option allows GCC to generate the additional
14347 64-bit instructions that are found in the full PowerPC64 architecture
14348 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
14349 @option{-mno-powerpc64}.
14350
14351 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
14352 will use only the instructions in the common subset of both
14353 architectures plus some special AIX common-mode calls, and will not use
14354 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
14355 permits GCC to use any instruction from either architecture and to
14356 allow use of the MQ register; specify this for the Motorola MPC601.
14357
14358 @item -mnew-mnemonics
14359 @itemx -mold-mnemonics
14360 @opindex mnew-mnemonics
14361 @opindex mold-mnemonics
14362 Select which mnemonics to use in the generated assembler code.  With
14363 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
14364 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
14365 assembler mnemonics defined for the POWER architecture.  Instructions
14366 defined in only one architecture have only one mnemonic; GCC uses that
14367 mnemonic irrespective of which of these options is specified.
14368
14369 GCC defaults to the mnemonics appropriate for the architecture in
14370 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
14371 value of these option.  Unless you are building a cross-compiler, you
14372 should normally not specify either @option{-mnew-mnemonics} or
14373 @option{-mold-mnemonics}, but should instead accept the default.
14374
14375 @item -mcpu=@var{cpu_type}
14376 @opindex mcpu
14377 Set architecture type, register usage, choice of mnemonics, and
14378 instruction scheduling parameters for machine type @var{cpu_type}.
14379 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
14380 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
14381 @samp{505}, @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
14382 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
14383 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
14384 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
14385 @samp{e500mc}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
14386 @samp{power}, @samp{power2}, @samp{power3}, @samp{power4},
14387 @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{power7},
14388 @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
14389 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
14390
14391 @option{-mcpu=common} selects a completely generic processor.  Code
14392 generated under this option will run on any POWER or PowerPC processor.
14393 GCC will use only the instructions in the common subset of both
14394 architectures, and will not use the MQ register.  GCC assumes a generic
14395 processor model for scheduling purposes.
14396
14397 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
14398 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
14399 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
14400 types, with an appropriate, generic processor model assumed for
14401 scheduling purposes.
14402
14403 The other options specify a specific processor.  Code generated under
14404 those options will run best on that processor, and may not run at all on
14405 others.
14406
14407 The @option{-mcpu} options automatically enable or disable the
14408 following options:
14409
14410 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
14411 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
14412 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
14413 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
14414
14415 The particular options set for any particular CPU will vary between
14416 compiler versions, depending on what setting seems to produce optimal
14417 code for that CPU; it doesn't necessarily reflect the actual hardware's
14418 capabilities.  If you wish to set an individual option to a particular
14419 value, you may specify it after the @option{-mcpu} option, like
14420 @samp{-mcpu=970 -mno-altivec}.
14421
14422 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
14423 not enabled or disabled by the @option{-mcpu} option at present because
14424 AIX does not have full support for these options.  You may still
14425 enable or disable them individually if you're sure it'll work in your
14426 environment.
14427
14428 @item -mtune=@var{cpu_type}
14429 @opindex mtune
14430 Set the instruction scheduling parameters for machine type
14431 @var{cpu_type}, but do not set the architecture type, register usage, or
14432 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
14433 values for @var{cpu_type} are used for @option{-mtune} as for
14434 @option{-mcpu}.  If both are specified, the code generated will use the
14435 architecture, registers, and mnemonics set by @option{-mcpu}, but the
14436 scheduling parameters set by @option{-mtune}.
14437
14438 @item -mswdiv
14439 @itemx -mno-swdiv
14440 @opindex mswdiv
14441 @opindex mno-swdiv
14442 Generate code to compute division as reciprocal estimate and iterative
14443 refinement, creating opportunities for increased throughput.  This
14444 feature requires: optional PowerPC Graphics instruction set for single
14445 precision and FRE instruction for double precision, assuming divides
14446 cannot generate user-visible traps, and the domain values not include
14447 Infinities, denormals or zero denominator.
14448
14449 @item -maltivec
14450 @itemx -mno-altivec
14451 @opindex maltivec
14452 @opindex mno-altivec
14453 Generate code that uses (does not use) AltiVec instructions, and also
14454 enable the use of built-in functions that allow more direct access to
14455 the AltiVec instruction set.  You may also need to set
14456 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
14457 enhancements.
14458
14459 @item -mvrsave
14460 @itemx -mno-vrsave
14461 @opindex mvrsave
14462 @opindex mno-vrsave
14463 Generate VRSAVE instructions when generating AltiVec code.
14464
14465 @item -mgen-cell-microcode
14466 @opindex mgen-cell-microcode
14467 Generate Cell microcode instructions
14468
14469 @item -mwarn-cell-microcode
14470 @opindex mwarn-cell-microcode
14471 Warning when a Cell microcode instruction is going to emitted.  An example
14472 of a Cell microcode instruction is a variable shift.
14473
14474 @item -msecure-plt
14475 @opindex msecure-plt
14476 Generate code that allows ld and ld.so to build executables and shared
14477 libraries with non-exec .plt and .got sections.  This is a PowerPC
14478 32-bit SYSV ABI option.
14479
14480 @item -mbss-plt
14481 @opindex mbss-plt
14482 Generate code that uses a BSS .plt section that ld.so fills in, and
14483 requires .plt and .got sections that are both writable and executable.
14484 This is a PowerPC 32-bit SYSV ABI option.
14485
14486 @item -misel
14487 @itemx -mno-isel
14488 @opindex misel
14489 @opindex mno-isel
14490 This switch enables or disables the generation of ISEL instructions.
14491
14492 @item -misel=@var{yes/no}
14493 This switch has been deprecated.  Use @option{-misel} and
14494 @option{-mno-isel} instead.
14495
14496 @item -mspe
14497 @itemx -mno-spe
14498 @opindex mspe
14499 @opindex mno-spe
14500 This switch enables or disables the generation of SPE simd
14501 instructions.
14502
14503 @item -mpaired
14504 @itemx -mno-paired
14505 @opindex mpaired
14506 @opindex mno-paired
14507 This switch enables or disables the generation of PAIRED simd
14508 instructions.
14509
14510 @item -mspe=@var{yes/no}
14511 This option has been deprecated.  Use @option{-mspe} and
14512 @option{-mno-spe} instead.
14513
14514 @item -mvsx
14515 @itemx -mno-vsx
14516 @opindex mvsx
14517 @opindex mno-vsx
14518 Generate code that uses (does not use) vector/scalar (VSX)
14519 instructions, and also enable the use of built-in functions that allow
14520 more direct access to the VSX instruction set.
14521
14522 @item -mfloat-gprs=@var{yes/single/double/no}
14523 @itemx -mfloat-gprs
14524 @opindex mfloat-gprs
14525 This switch enables or disables the generation of floating point
14526 operations on the general purpose registers for architectures that
14527 support it.
14528
14529 The argument @var{yes} or @var{single} enables the use of
14530 single-precision floating point operations.
14531
14532 The argument @var{double} enables the use of single and
14533 double-precision floating point operations.
14534
14535 The argument @var{no} disables floating point operations on the
14536 general purpose registers.
14537
14538 This option is currently only available on the MPC854x.
14539
14540 @item -m32
14541 @itemx -m64
14542 @opindex m32
14543 @opindex m64
14544 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
14545 targets (including GNU/Linux).  The 32-bit environment sets int, long
14546 and pointer to 32 bits and generates code that runs on any PowerPC
14547 variant.  The 64-bit environment sets int to 32 bits and long and
14548 pointer to 64 bits, and generates code for PowerPC64, as for
14549 @option{-mpowerpc64}.
14550
14551 @item -mfull-toc
14552 @itemx -mno-fp-in-toc
14553 @itemx -mno-sum-in-toc
14554 @itemx -mminimal-toc
14555 @opindex mfull-toc
14556 @opindex mno-fp-in-toc
14557 @opindex mno-sum-in-toc
14558 @opindex mminimal-toc
14559 Modify generation of the TOC (Table Of Contents), which is created for
14560 every executable file.  The @option{-mfull-toc} option is selected by
14561 default.  In that case, GCC will allocate at least one TOC entry for
14562 each unique non-automatic variable reference in your program.  GCC
14563 will also place floating-point constants in the TOC@.  However, only
14564 16,384 entries are available in the TOC@.
14565
14566 If you receive a linker error message that saying you have overflowed
14567 the available TOC space, you can reduce the amount of TOC space used
14568 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
14569 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
14570 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
14571 generate code to calculate the sum of an address and a constant at
14572 run-time instead of putting that sum into the TOC@.  You may specify one
14573 or both of these options.  Each causes GCC to produce very slightly
14574 slower and larger code at the expense of conserving TOC space.
14575
14576 If you still run out of space in the TOC even when you specify both of
14577 these options, specify @option{-mminimal-toc} instead.  This option causes
14578 GCC to make only one TOC entry for every file.  When you specify this
14579 option, GCC will produce code that is slower and larger but which
14580 uses extremely little TOC space.  You may wish to use this option
14581 only on files that contain less frequently executed code.
14582
14583 @item -maix64
14584 @itemx -maix32
14585 @opindex maix64
14586 @opindex maix32
14587 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
14588 @code{long} type, and the infrastructure needed to support them.
14589 Specifying @option{-maix64} implies @option{-mpowerpc64} and
14590 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
14591 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
14592
14593 @item -mxl-compat
14594 @itemx -mno-xl-compat
14595 @opindex mxl-compat
14596 @opindex mno-xl-compat
14597 Produce code that conforms more closely to IBM XL compiler semantics
14598 when using AIX-compatible ABI@.  Pass floating-point arguments to
14599 prototyped functions beyond the register save area (RSA) on the stack
14600 in addition to argument FPRs.  Do not assume that most significant
14601 double in 128-bit long double value is properly rounded when comparing
14602 values and converting to double.  Use XL symbol names for long double
14603 support routines.
14604
14605 The AIX calling convention was extended but not initially documented to
14606 handle an obscure K&R C case of calling a function that takes the
14607 address of its arguments with fewer arguments than declared.  IBM XL
14608 compilers access floating point arguments which do not fit in the
14609 RSA from the stack when a subroutine is compiled without
14610 optimization.  Because always storing floating-point arguments on the
14611 stack is inefficient and rarely needed, this option is not enabled by
14612 default and only is necessary when calling subroutines compiled by IBM
14613 XL compilers without optimization.
14614
14615 @item -mpe
14616 @opindex mpe
14617 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
14618 application written to use message passing with special startup code to
14619 enable the application to run.  The system must have PE installed in the
14620 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
14621 must be overridden with the @option{-specs=} option to specify the
14622 appropriate directory location.  The Parallel Environment does not
14623 support threads, so the @option{-mpe} option and the @option{-pthread}
14624 option are incompatible.
14625
14626 @item -malign-natural
14627 @itemx -malign-power
14628 @opindex malign-natural
14629 @opindex malign-power
14630 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
14631 @option{-malign-natural} overrides the ABI-defined alignment of larger
14632 types, such as floating-point doubles, on their natural size-based boundary.
14633 The option @option{-malign-power} instructs GCC to follow the ABI-specified
14634 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
14635
14636 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
14637 is not supported.
14638
14639 @item -msoft-float
14640 @itemx -mhard-float
14641 @opindex msoft-float
14642 @opindex mhard-float
14643 Generate code that does not use (uses) the floating-point register set.
14644 Software floating point emulation is provided if you use the
14645 @option{-msoft-float} option, and pass the option to GCC when linking.
14646
14647 @item -msingle-float
14648 @itemx -mdouble-float
14649 @opindex msingle-float
14650 @opindex mdouble-float
14651 Generate code for single or double-precision floating point operations.
14652 @option{-mdouble-float} implies @option{-msingle-float}.
14653
14654 @item -msimple-fpu
14655 @opindex msimple-fpu
14656 Do not generate sqrt and div instructions for hardware floating point unit.
14657
14658 @item -mfpu
14659 @opindex mfpu
14660 Specify type of floating point unit.  Valid values are @var{sp_lite}
14661 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
14662 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
14663 and @var{dp_full} (equivalent to -mdouble-float).
14664
14665 @item -mxilinx-fpu
14666 @opindex mxilinx-fpu
14667 Perform optimizations for floating point unit on Xilinx PPC 405/440.
14668
14669 @item -mmultiple
14670 @itemx -mno-multiple
14671 @opindex mmultiple
14672 @opindex mno-multiple
14673 Generate code that uses (does not use) the load multiple word
14674 instructions and the store multiple word instructions.  These
14675 instructions are generated by default on POWER systems, and not
14676 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
14677 endian PowerPC systems, since those instructions do not work when the
14678 processor is in little endian mode.  The exceptions are PPC740 and
14679 PPC750 which permit the instructions usage in little endian mode.
14680
14681 @item -mstring
14682 @itemx -mno-string
14683 @opindex mstring
14684 @opindex mno-string
14685 Generate code that uses (does not use) the load string instructions
14686 and the store string word instructions to save multiple registers and
14687 do small block moves.  These instructions are generated by default on
14688 POWER systems, and not generated on PowerPC systems.  Do not use
14689 @option{-mstring} on little endian PowerPC systems, since those
14690 instructions do not work when the processor is in little endian mode.
14691 The exceptions are PPC740 and PPC750 which permit the instructions
14692 usage in little endian mode.
14693
14694 @item -mupdate
14695 @itemx -mno-update
14696 @opindex mupdate
14697 @opindex mno-update
14698 Generate code that uses (does not use) the load or store instructions
14699 that update the base register to the address of the calculated memory
14700 location.  These instructions are generated by default.  If you use
14701 @option{-mno-update}, there is a small window between the time that the
14702 stack pointer is updated and the address of the previous frame is
14703 stored, which means code that walks the stack frame across interrupts or
14704 signals may get corrupted data.
14705
14706 @item -mavoid-indexed-addresses
14707 @item -mno-avoid-indexed-addresses
14708 @opindex mavoid-indexed-addresses
14709 @opindex mno-avoid-indexed-addresses
14710 Generate code that tries to avoid (not avoid) the use of indexed load
14711 or store instructions. These instructions can incur a performance
14712 penalty on Power6 processors in certain situations, such as when
14713 stepping through large arrays that cross a 16M boundary.  This option
14714 is enabled by default when targetting Power6 and disabled otherwise.
14715
14716 @item -mfused-madd
14717 @itemx -mno-fused-madd
14718 @opindex mfused-madd
14719 @opindex mno-fused-madd
14720 Generate code that uses (does not use) the floating point multiply and
14721 accumulate instructions.  These instructions are generated by default if
14722 hardware floating is used.
14723
14724 @item -mmulhw
14725 @itemx -mno-mulhw
14726 @opindex mmulhw
14727 @opindex mno-mulhw
14728 Generate code that uses (does not use) the half-word multiply and
14729 multiply-accumulate instructions on the IBM 405, 440 and 464 processors.
14730 These instructions are generated by default when targetting those
14731 processors.
14732
14733 @item -mdlmzb
14734 @itemx -mno-dlmzb
14735 @opindex mdlmzb
14736 @opindex mno-dlmzb
14737 Generate code that uses (does not use) the string-search @samp{dlmzb}
14738 instruction on the IBM 405, 440 and 464 processors.  This instruction is
14739 generated by default when targetting those processors.
14740
14741 @item -mno-bit-align
14742 @itemx -mbit-align
14743 @opindex mno-bit-align
14744 @opindex mbit-align
14745 On System V.4 and embedded PowerPC systems do not (do) force structures
14746 and unions that contain bit-fields to be aligned to the base type of the
14747 bit-field.
14748
14749 For example, by default a structure containing nothing but 8
14750 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
14751 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
14752 the structure would be aligned to a 1 byte boundary and be one byte in
14753 size.
14754
14755 @item -mno-strict-align
14756 @itemx -mstrict-align
14757 @opindex mno-strict-align
14758 @opindex mstrict-align
14759 On System V.4 and embedded PowerPC systems do not (do) assume that
14760 unaligned memory references will be handled by the system.
14761
14762 @item -mrelocatable
14763 @itemx -mno-relocatable
14764 @opindex mrelocatable
14765 @opindex mno-relocatable
14766 On embedded PowerPC systems generate code that allows (does not allow)
14767 the program to be relocated to a different address at runtime.  If you
14768 use @option{-mrelocatable} on any module, all objects linked together must
14769 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
14770
14771 @item -mrelocatable-lib
14772 @itemx -mno-relocatable-lib
14773 @opindex mrelocatable-lib
14774 @opindex mno-relocatable-lib
14775 On embedded PowerPC systems generate code that allows (does not allow)
14776 the program to be relocated to a different address at runtime.  Modules
14777 compiled with @option{-mrelocatable-lib} can be linked with either modules
14778 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
14779 with modules compiled with the @option{-mrelocatable} options.
14780
14781 @item -mno-toc
14782 @itemx -mtoc
14783 @opindex mno-toc
14784 @opindex mtoc
14785 On System V.4 and embedded PowerPC systems do not (do) assume that
14786 register 2 contains a pointer to a global area pointing to the addresses
14787 used in the program.
14788
14789 @item -mlittle
14790 @itemx -mlittle-endian
14791 @opindex mlittle
14792 @opindex mlittle-endian
14793 On System V.4 and embedded PowerPC systems compile code for the
14794 processor in little endian mode.  The @option{-mlittle-endian} option is
14795 the same as @option{-mlittle}.
14796
14797 @item -mbig
14798 @itemx -mbig-endian
14799 @opindex mbig
14800 @opindex mbig-endian
14801 On System V.4 and embedded PowerPC systems compile code for the
14802 processor in big endian mode.  The @option{-mbig-endian} option is
14803 the same as @option{-mbig}.
14804
14805 @item -mdynamic-no-pic
14806 @opindex mdynamic-no-pic
14807 On Darwin and Mac OS X systems, compile code so that it is not
14808 relocatable, but that its external references are relocatable.  The
14809 resulting code is suitable for applications, but not shared
14810 libraries.
14811
14812 @item -mprioritize-restricted-insns=@var{priority}
14813 @opindex mprioritize-restricted-insns
14814 This option controls the priority that is assigned to
14815 dispatch-slot restricted instructions during the second scheduling
14816 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
14817 @var{no/highest/second-highest} priority to dispatch slot restricted
14818 instructions.
14819
14820 @item -msched-costly-dep=@var{dependence_type}
14821 @opindex msched-costly-dep
14822 This option controls which dependences are considered costly
14823 by the target during instruction scheduling.  The argument
14824 @var{dependence_type} takes one of the following values:
14825 @var{no}: no dependence is costly,
14826 @var{all}: all dependences are costly,
14827 @var{true_store_to_load}: a true dependence from store to load is costly,
14828 @var{store_to_load}: any dependence from store to load is costly,
14829 @var{number}: any dependence which latency >= @var{number} is costly.
14830
14831 @item -minsert-sched-nops=@var{scheme}
14832 @opindex minsert-sched-nops
14833 This option controls which nop insertion scheme will be used during
14834 the second scheduling pass.  The argument @var{scheme} takes one of the
14835 following values:
14836 @var{no}: Don't insert nops.
14837 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
14838 according to the scheduler's grouping.
14839 @var{regroup_exact}: Insert nops to force costly dependent insns into
14840 separate groups.  Insert exactly as many nops as needed to force an insn
14841 to a new group, according to the estimated processor grouping.
14842 @var{number}: Insert nops to force costly dependent insns into
14843 separate groups.  Insert @var{number} nops to force an insn to a new group.
14844
14845 @item -mcall-sysv
14846 @opindex mcall-sysv
14847 On System V.4 and embedded PowerPC systems compile code using calling
14848 conventions that adheres to the March 1995 draft of the System V
14849 Application Binary Interface, PowerPC processor supplement.  This is the
14850 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
14851
14852 @item -mcall-sysv-eabi
14853 @itemx -mcall-eabi
14854 @opindex mcall-sysv-eabi
14855 @opindex mcall-eabi
14856 Specify both @option{-mcall-sysv} and @option{-meabi} options.
14857
14858 @item -mcall-sysv-noeabi
14859 @opindex mcall-sysv-noeabi
14860 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
14861
14862 @item -mcall-aixdesc
14863 @opindex m
14864 On System V.4 and embedded PowerPC systems compile code for the AIX
14865 operating system.
14866
14867 @item -mcall-linux
14868 @opindex mcall-linux
14869 On System V.4 and embedded PowerPC systems compile code for the
14870 Linux-based GNU system.
14871
14872 @item -mcall-gnu
14873 @opindex mcall-gnu
14874 On System V.4 and embedded PowerPC systems compile code for the
14875 Hurd-based GNU system.
14876
14877 @item -mcall-freebsd
14878 @opindex mcall-freebsd
14879 On System V.4 and embedded PowerPC systems compile code for the
14880 FreeBSD operating system.
14881
14882 @item -mcall-netbsd
14883 @opindex mcall-netbsd
14884 On System V.4 and embedded PowerPC systems compile code for the
14885 NetBSD operating system.
14886
14887 @item -mcall-openbsd
14888 @opindex mcall-netbsd
14889 On System V.4 and embedded PowerPC systems compile code for the
14890 OpenBSD operating system.
14891
14892 @item -maix-struct-return
14893 @opindex maix-struct-return
14894 Return all structures in memory (as specified by the AIX ABI)@.
14895
14896 @item -msvr4-struct-return
14897 @opindex msvr4-struct-return
14898 Return structures smaller than 8 bytes in registers (as specified by the
14899 SVR4 ABI)@.
14900
14901 @item -mabi=@var{abi-type}
14902 @opindex mabi
14903 Extend the current ABI with a particular extension, or remove such extension.
14904 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
14905 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
14906
14907 @item -mabi=spe
14908 @opindex mabi=spe
14909 Extend the current ABI with SPE ABI extensions.  This does not change
14910 the default ABI, instead it adds the SPE ABI extensions to the current
14911 ABI@.
14912
14913 @item -mabi=no-spe
14914 @opindex mabi=no-spe
14915 Disable Booke SPE ABI extensions for the current ABI@.
14916
14917 @item -mabi=ibmlongdouble
14918 @opindex mabi=ibmlongdouble
14919 Change the current ABI to use IBM extended precision long double.
14920 This is a PowerPC 32-bit SYSV ABI option.
14921
14922 @item -mabi=ieeelongdouble
14923 @opindex mabi=ieeelongdouble
14924 Change the current ABI to use IEEE extended precision long double.
14925 This is a PowerPC 32-bit Linux ABI option.
14926
14927 @item -mprototype
14928 @itemx -mno-prototype
14929 @opindex mprototype
14930 @opindex mno-prototype
14931 On System V.4 and embedded PowerPC systems assume that all calls to
14932 variable argument functions are properly prototyped.  Otherwise, the
14933 compiler must insert an instruction before every non prototyped call to
14934 set or clear bit 6 of the condition code register (@var{CR}) to
14935 indicate whether floating point values were passed in the floating point
14936 registers in case the function takes a variable arguments.  With
14937 @option{-mprototype}, only calls to prototyped variable argument functions
14938 will set or clear the bit.
14939
14940 @item -msim
14941 @opindex msim
14942 On embedded PowerPC systems, assume that the startup module is called
14943 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
14944 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
14945 configurations.
14946
14947 @item -mmvme
14948 @opindex mmvme
14949 On embedded PowerPC systems, assume that the startup module is called
14950 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
14951 @file{libc.a}.
14952
14953 @item -mads
14954 @opindex mads
14955 On embedded PowerPC systems, assume that the startup module is called
14956 @file{crt0.o} and the standard C libraries are @file{libads.a} and
14957 @file{libc.a}.
14958
14959 @item -myellowknife
14960 @opindex myellowknife
14961 On embedded PowerPC systems, assume that the startup module is called
14962 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
14963 @file{libc.a}.
14964
14965 @item -mvxworks
14966 @opindex mvxworks
14967 On System V.4 and embedded PowerPC systems, specify that you are
14968 compiling for a VxWorks system.
14969
14970 @item -memb
14971 @opindex memb
14972 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
14973 header to indicate that @samp{eabi} extended relocations are used.
14974
14975 @item -meabi
14976 @itemx -mno-eabi
14977 @opindex meabi
14978 @opindex mno-eabi
14979 On System V.4 and embedded PowerPC systems do (do not) adhere to the
14980 Embedded Applications Binary Interface (eabi) which is a set of
14981 modifications to the System V.4 specifications.  Selecting @option{-meabi}
14982 means that the stack is aligned to an 8 byte boundary, a function
14983 @code{__eabi} is called to from @code{main} to set up the eabi
14984 environment, and the @option{-msdata} option can use both @code{r2} and
14985 @code{r13} to point to two separate small data areas.  Selecting
14986 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
14987 do not call an initialization function from @code{main}, and the
14988 @option{-msdata} option will only use @code{r13} to point to a single
14989 small data area.  The @option{-meabi} option is on by default if you
14990 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
14991
14992 @item -msdata=eabi
14993 @opindex msdata=eabi
14994 On System V.4 and embedded PowerPC systems, put small initialized
14995 @code{const} global and static data in the @samp{.sdata2} section, which
14996 is pointed to by register @code{r2}.  Put small initialized
14997 non-@code{const} global and static data in the @samp{.sdata} section,
14998 which is pointed to by register @code{r13}.  Put small uninitialized
14999 global and static data in the @samp{.sbss} section, which is adjacent to
15000 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15001 incompatible with the @option{-mrelocatable} option.  The
15002 @option{-msdata=eabi} option also sets the @option{-memb} option.
15003
15004 @item -msdata=sysv
15005 @opindex msdata=sysv
15006 On System V.4 and embedded PowerPC systems, put small global and static
15007 data in the @samp{.sdata} section, which is pointed to by register
15008 @code{r13}.  Put small uninitialized global and static data in the
15009 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15010 The @option{-msdata=sysv} option is incompatible with the
15011 @option{-mrelocatable} option.
15012
15013 @item -msdata=default
15014 @itemx -msdata
15015 @opindex msdata=default
15016 @opindex msdata
15017 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15018 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15019 same as @option{-msdata=sysv}.
15020
15021 @item -msdata=data
15022 @opindex msdata=data
15023 On System V.4 and embedded PowerPC systems, put small global
15024 data in the @samp{.sdata} section.  Put small uninitialized global
15025 data in the @samp{.sbss} section.  Do not use register @code{r13}
15026 to address small data however.  This is the default behavior unless
15027 other @option{-msdata} options are used.
15028
15029 @item -msdata=none
15030 @itemx -mno-sdata
15031 @opindex msdata=none
15032 @opindex mno-sdata
15033 On embedded PowerPC systems, put all initialized global and static data
15034 in the @samp{.data} section, and all uninitialized data in the
15035 @samp{.bss} section.
15036
15037 @item -G @var{num}
15038 @opindex G
15039 @cindex smaller data references (PowerPC)
15040 @cindex .sdata/.sdata2 references (PowerPC)
15041 On embedded PowerPC systems, put global and static items less than or
15042 equal to @var{num} bytes into the small data or bss sections instead of
15043 the normal data or bss section.  By default, @var{num} is 8.  The
15044 @option{-G @var{num}} switch is also passed to the linker.
15045 All modules should be compiled with the same @option{-G @var{num}} value.
15046
15047 @item -mregnames
15048 @itemx -mno-regnames
15049 @opindex mregnames
15050 @opindex mno-regnames
15051 On System V.4 and embedded PowerPC systems do (do not) emit register
15052 names in the assembly language output using symbolic forms.
15053
15054 @item -mlongcall
15055 @itemx -mno-longcall
15056 @opindex mlongcall
15057 @opindex mno-longcall
15058 By default assume that all calls are far away so that a longer more
15059 expensive calling sequence is required.  This is required for calls
15060 further than 32 megabytes (33,554,432 bytes) from the current location.
15061 A short call will be generated if the compiler knows
15062 the call cannot be that far away.  This setting can be overridden by
15063 the @code{shortcall} function attribute, or by @code{#pragma
15064 longcall(0)}.
15065
15066 Some linkers are capable of detecting out-of-range calls and generating
15067 glue code on the fly.  On these systems, long calls are unnecessary and
15068 generate slower code.  As of this writing, the AIX linker can do this,
15069 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15070 to the GNU linker for 32-bit PowerPC systems as well.
15071
15072 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15073 callee, L42'', plus a ``branch island'' (glue code).  The two target
15074 addresses represent the callee and the ``branch island''.  The
15075 Darwin/PPC linker will prefer the first address and generate a ``bl
15076 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15077 otherwise, the linker will generate ``bl L42'' to call the ``branch
15078 island''.  The ``branch island'' is appended to the body of the
15079 calling function; it computes the full 32-bit address of the callee
15080 and jumps to it.
15081
15082 On Mach-O (Darwin) systems, this option directs the compiler emit to
15083 the glue for every direct call, and the Darwin linker decides whether
15084 to use or discard it.
15085
15086 In the future, we may cause GCC to ignore all longcall specifications
15087 when the linker is known to generate glue.
15088
15089 @item -mtls-markers
15090 @itemx -mno-tls-markers
15091 @opindex mtls-markers
15092 @opindex mno-tls-markers
15093 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15094 specifying the function argument.  The relocation allows ld to
15095 reliably associate function call with argument setup instructions for
15096 TLS optimization, which in turn allows gcc to better schedule the
15097 sequence.
15098
15099 @item -pthread
15100 @opindex pthread
15101 Adds support for multithreading with the @dfn{pthreads} library.
15102 This option sets flags for both the preprocessor and linker.
15103
15104 @end table
15105
15106 @node S/390 and zSeries Options
15107 @subsection S/390 and zSeries Options
15108 @cindex S/390 and zSeries Options
15109
15110 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
15111
15112 @table @gcctabopt
15113 @item -mhard-float
15114 @itemx -msoft-float
15115 @opindex mhard-float
15116 @opindex msoft-float
15117 Use (do not use) the hardware floating-point instructions and registers
15118 for floating-point operations.  When @option{-msoft-float} is specified,
15119 functions in @file{libgcc.a} will be used to perform floating-point
15120 operations.  When @option{-mhard-float} is specified, the compiler
15121 generates IEEE floating-point instructions.  This is the default.
15122
15123 @item -mhard-dfp
15124 @itemx -mno-hard-dfp
15125 @opindex mhard-dfp
15126 @opindex mno-hard-dfp
15127 Use (do not use) the hardware decimal-floating-point instructions for
15128 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
15129 specified, functions in @file{libgcc.a} will be used to perform
15130 decimal-floating-point operations.  When @option{-mhard-dfp} is
15131 specified, the compiler generates decimal-floating-point hardware
15132 instructions.  This is the default for @option{-march=z9-ec} or higher.
15133
15134 @item -mlong-double-64
15135 @itemx -mlong-double-128
15136 @opindex mlong-double-64
15137 @opindex mlong-double-128
15138 These switches control the size of @code{long double} type. A size
15139 of 64bit makes the @code{long double} type equivalent to the @code{double}
15140 type. This is the default.
15141
15142 @item -mbackchain
15143 @itemx -mno-backchain
15144 @opindex mbackchain
15145 @opindex mno-backchain
15146 Store (do not store) the address of the caller's frame as backchain pointer
15147 into the callee's stack frame.
15148 A backchain may be needed to allow debugging using tools that do not understand
15149 DWARF-2 call frame information.
15150 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
15151 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
15152 the backchain is placed into the topmost word of the 96/160 byte register
15153 save area.
15154
15155 In general, code compiled with @option{-mbackchain} is call-compatible with
15156 code compiled with @option{-mmo-backchain}; however, use of the backchain
15157 for debugging purposes usually requires that the whole binary is built with
15158 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
15159 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15160 to build a linux kernel use @option{-msoft-float}.
15161
15162 The default is to not maintain the backchain.
15163
15164 @item -mpacked-stack
15165 @itemx -mno-packed-stack
15166 @opindex mpacked-stack
15167 @opindex mno-packed-stack
15168 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
15169 specified, the compiler uses the all fields of the 96/160 byte register save
15170 area only for their default purpose; unused fields still take up stack space.
15171 When @option{-mpacked-stack} is specified, register save slots are densely
15172 packed at the top of the register save area; unused space is reused for other
15173 purposes, allowing for more efficient use of the available stack space.
15174 However, when @option{-mbackchain} is also in effect, the topmost word of
15175 the save area is always used to store the backchain, and the return address
15176 register is always saved two words below the backchain.
15177
15178 As long as the stack frame backchain is not used, code generated with
15179 @option{-mpacked-stack} is call-compatible with code generated with
15180 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
15181 S/390 or zSeries generated code that uses the stack frame backchain at run
15182 time, not just for debugging purposes.  Such code is not call-compatible
15183 with code compiled with @option{-mpacked-stack}.  Also, note that the
15184 combination of @option{-mbackchain},
15185 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15186 to build a linux kernel use @option{-msoft-float}.
15187
15188 The default is to not use the packed stack layout.
15189
15190 @item -msmall-exec
15191 @itemx -mno-small-exec
15192 @opindex msmall-exec
15193 @opindex mno-small-exec
15194 Generate (or do not generate) code using the @code{bras} instruction
15195 to do subroutine calls.
15196 This only works reliably if the total executable size does not
15197 exceed 64k.  The default is to use the @code{basr} instruction instead,
15198 which does not have this limitation.
15199
15200 @item -m64
15201 @itemx -m31
15202 @opindex m64
15203 @opindex m31
15204 When @option{-m31} is specified, generate code compliant to the
15205 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
15206 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
15207 particular to generate 64-bit instructions.  For the @samp{s390}
15208 targets, the default is @option{-m31}, while the @samp{s390x}
15209 targets default to @option{-m64}.
15210
15211 @item -mzarch
15212 @itemx -mesa
15213 @opindex mzarch
15214 @opindex mesa
15215 When @option{-mzarch} is specified, generate code using the
15216 instructions available on z/Architecture.
15217 When @option{-mesa} is specified, generate code using the
15218 instructions available on ESA/390.  Note that @option{-mesa} is
15219 not possible with @option{-m64}.
15220 When generating code compliant to the GNU/Linux for S/390 ABI,
15221 the default is @option{-mesa}.  When generating code compliant
15222 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
15223
15224 @item -mmvcle
15225 @itemx -mno-mvcle
15226 @opindex mmvcle
15227 @opindex mno-mvcle
15228 Generate (or do not generate) code using the @code{mvcle} instruction
15229 to perform block moves.  When @option{-mno-mvcle} is specified,
15230 use a @code{mvc} loop instead.  This is the default unless optimizing for
15231 size.
15232
15233 @item -mdebug
15234 @itemx -mno-debug
15235 @opindex mdebug
15236 @opindex mno-debug
15237 Print (or do not print) additional debug information when compiling.
15238 The default is to not print debug information.
15239
15240 @item -march=@var{cpu-type}
15241 @opindex march
15242 Generate code that will run on @var{cpu-type}, which is the name of a system
15243 representing a certain processor type.  Possible values for
15244 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
15245 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
15246 When generating code using the instructions available on z/Architecture,
15247 the default is @option{-march=z900}.  Otherwise, the default is
15248 @option{-march=g5}.
15249
15250 @item -mtune=@var{cpu-type}
15251 @opindex mtune
15252 Tune to @var{cpu-type} everything applicable about the generated code,
15253 except for the ABI and the set of available instructions.
15254 The list of @var{cpu-type} values is the same as for @option{-march}.
15255 The default is the value used for @option{-march}.
15256
15257 @item -mtpf-trace
15258 @itemx -mno-tpf-trace
15259 @opindex mtpf-trace
15260 @opindex mno-tpf-trace
15261 Generate code that adds (does not add) in TPF OS specific branches to trace
15262 routines in the operating system.  This option is off by default, even
15263 when compiling for the TPF OS@.
15264
15265 @item -mfused-madd
15266 @itemx -mno-fused-madd
15267 @opindex mfused-madd
15268 @opindex mno-fused-madd
15269 Generate code that uses (does not use) the floating point multiply and
15270 accumulate instructions.  These instructions are generated by default if
15271 hardware floating point is used.
15272
15273 @item -mwarn-framesize=@var{framesize}
15274 @opindex mwarn-framesize
15275 Emit a warning if the current function exceeds the given frame size.  Because
15276 this is a compile time check it doesn't need to be a real problem when the program
15277 runs.  It is intended to identify functions which most probably cause
15278 a stack overflow.  It is useful to be used in an environment with limited stack
15279 size e.g.@: the linux kernel.
15280
15281 @item -mwarn-dynamicstack
15282 @opindex mwarn-dynamicstack
15283 Emit a warning if the function calls alloca or uses dynamically
15284 sized arrays.  This is generally a bad idea with a limited stack size.
15285
15286 @item -mstack-guard=@var{stack-guard}
15287 @itemx -mstack-size=@var{stack-size}
15288 @opindex mstack-guard
15289 @opindex mstack-size
15290 If these options are provided the s390 back end emits additional instructions in
15291 the function prologue which trigger a trap if the stack size is @var{stack-guard}
15292 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
15293 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
15294 the frame size of the compiled function is chosen.
15295 These options are intended to be used to help debugging stack overflow problems.
15296 The additionally emitted code causes only little overhead and hence can also be
15297 used in production like systems without greater performance degradation.  The given
15298 values have to be exact powers of 2 and @var{stack-size} has to be greater than
15299 @var{stack-guard} without exceeding 64k.
15300 In order to be efficient the extra code makes the assumption that the stack starts
15301 at an address aligned to the value given by @var{stack-size}.
15302 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
15303 @end table
15304
15305 @node Score Options
15306 @subsection Score Options
15307 @cindex Score Options
15308
15309 These options are defined for Score implementations:
15310
15311 @table @gcctabopt
15312 @item -meb
15313 @opindex meb
15314 Compile code for big endian mode.  This is the default.
15315
15316 @item -mel
15317 @opindex mel
15318 Compile code for little endian mode.
15319
15320 @item -mnhwloop
15321 @opindex mnhwloop
15322 Disable generate bcnz instruction.
15323
15324 @item -muls
15325 @opindex muls
15326 Enable generate unaligned load and store instruction.
15327
15328 @item -mmac
15329 @opindex mmac
15330 Enable the use of multiply-accumulate instructions. Disabled by default.
15331
15332 @item -mscore5
15333 @opindex mscore5
15334 Specify the SCORE5 as the target architecture.
15335
15336 @item -mscore5u
15337 @opindex mscore5u
15338 Specify the SCORE5U of the target architecture.
15339
15340 @item -mscore7
15341 @opindex mscore7
15342 Specify the SCORE7 as the target architecture. This is the default.
15343
15344 @item -mscore7d
15345 @opindex mscore7d
15346 Specify the SCORE7D as the target architecture.
15347 @end table
15348
15349 @node SH Options
15350 @subsection SH Options
15351
15352 These @samp{-m} options are defined for the SH implementations:
15353
15354 @table @gcctabopt
15355 @item -m1
15356 @opindex m1
15357 Generate code for the SH1.
15358
15359 @item -m2
15360 @opindex m2
15361 Generate code for the SH2.
15362
15363 @item -m2e
15364 Generate code for the SH2e.
15365
15366 @item -m2a-nofpu
15367 @opindex m2a-nofpu
15368 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
15369 that the floating-point unit is not used.
15370
15371 @item -m2a-single-only
15372 @opindex m2a-single-only
15373 Generate code for the SH2a-FPU, in such a way that no double-precision
15374 floating point operations are used.
15375
15376 @item -m2a-single
15377 @opindex m2a-single
15378 Generate code for the SH2a-FPU assuming the floating-point unit is in
15379 single-precision mode by default.
15380
15381 @item -m2a
15382 @opindex m2a
15383 Generate code for the SH2a-FPU assuming the floating-point unit is in
15384 double-precision mode by default.
15385
15386 @item -m3
15387 @opindex m3
15388 Generate code for the SH3.
15389
15390 @item -m3e
15391 @opindex m3e
15392 Generate code for the SH3e.
15393
15394 @item -m4-nofpu
15395 @opindex m4-nofpu
15396 Generate code for the SH4 without a floating-point unit.
15397
15398 @item -m4-single-only
15399 @opindex m4-single-only
15400 Generate code for the SH4 with a floating-point unit that only
15401 supports single-precision arithmetic.
15402
15403 @item -m4-single
15404 @opindex m4-single
15405 Generate code for the SH4 assuming the floating-point unit is in
15406 single-precision mode by default.
15407
15408 @item -m4
15409 @opindex m4
15410 Generate code for the SH4.
15411
15412 @item -m4a-nofpu
15413 @opindex m4a-nofpu
15414 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
15415 floating-point unit is not used.
15416
15417 @item -m4a-single-only
15418 @opindex m4a-single-only
15419 Generate code for the SH4a, in such a way that no double-precision
15420 floating point operations are used.
15421
15422 @item -m4a-single
15423 @opindex m4a-single
15424 Generate code for the SH4a assuming the floating-point unit is in
15425 single-precision mode by default.
15426
15427 @item -m4a
15428 @opindex m4a
15429 Generate code for the SH4a.
15430
15431 @item -m4al
15432 @opindex m4al
15433 Same as @option{-m4a-nofpu}, except that it implicitly passes
15434 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
15435 instructions at the moment.
15436
15437 @item -mb
15438 @opindex mb
15439 Compile code for the processor in big endian mode.
15440
15441 @item -ml
15442 @opindex ml
15443 Compile code for the processor in little endian mode.
15444
15445 @item -mdalign
15446 @opindex mdalign
15447 Align doubles at 64-bit boundaries.  Note that this changes the calling
15448 conventions, and thus some functions from the standard C library will
15449 not work unless you recompile it first with @option{-mdalign}.
15450
15451 @item -mrelax
15452 @opindex mrelax
15453 Shorten some address references at link time, when possible; uses the
15454 linker option @option{-relax}.
15455
15456 @item -mbigtable
15457 @opindex mbigtable
15458 Use 32-bit offsets in @code{switch} tables.  The default is to use
15459 16-bit offsets.
15460
15461 @item -mbitops
15462 @opindex mbitops
15463 Enable the use of bit manipulation instructions on SH2A.
15464
15465 @item -mfmovd
15466 @opindex mfmovd
15467 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
15468 alignment constraints.
15469
15470 @item -mhitachi
15471 @opindex mhitachi
15472 Comply with the calling conventions defined by Renesas.
15473
15474 @item -mrenesas
15475 @opindex mhitachi
15476 Comply with the calling conventions defined by Renesas.
15477
15478 @item -mno-renesas
15479 @opindex mhitachi
15480 Comply with the calling conventions defined for GCC before the Renesas
15481 conventions were available.  This option is the default for all
15482 targets of the SH toolchain except for @samp{sh-symbianelf}.
15483
15484 @item -mnomacsave
15485 @opindex mnomacsave
15486 Mark the @code{MAC} register as call-clobbered, even if
15487 @option{-mhitachi} is given.
15488
15489 @item -mieee
15490 @opindex mieee
15491 Increase IEEE-compliance of floating-point code.
15492 At the moment, this is equivalent to @option{-fno-finite-math-only}.
15493 When generating 16 bit SH opcodes, getting IEEE-conforming results for
15494 comparisons of NANs / infinities incurs extra overhead in every
15495 floating point comparison, therefore the default is set to
15496 @option{-ffinite-math-only}.
15497
15498 @item -minline-ic_invalidate
15499 @opindex minline-ic_invalidate
15500 Inline code to invalidate instruction cache entries after setting up
15501 nested function trampolines.
15502 This option has no effect if -musermode is in effect and the selected
15503 code generation option (e.g. -m4) does not allow the use of the icbi
15504 instruction.
15505 If the selected code generation option does not allow the use of the icbi
15506 instruction, and -musermode is not in effect, the inlined code will
15507 manipulate the instruction cache address array directly with an associative
15508 write.  This not only requires privileged mode, but it will also
15509 fail if the cache line had been mapped via the TLB and has become unmapped.
15510
15511 @item -misize
15512 @opindex misize
15513 Dump instruction size and location in the assembly code.
15514
15515 @item -mpadstruct
15516 @opindex mpadstruct
15517 This option is deprecated.  It pads structures to multiple of 4 bytes,
15518 which is incompatible with the SH ABI@.
15519
15520 @item -mspace
15521 @opindex mspace
15522 Optimize for space instead of speed.  Implied by @option{-Os}.
15523
15524 @item -mprefergot
15525 @opindex mprefergot
15526 When generating position-independent code, emit function calls using
15527 the Global Offset Table instead of the Procedure Linkage Table.
15528
15529 @item -musermode
15530 @opindex musermode
15531 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
15532 if the inlined code would not work in user mode.
15533 This is the default when the target is @code{sh-*-linux*}.
15534
15535 @item -multcost=@var{number}
15536 @opindex multcost=@var{number}
15537 Set the cost to assume for a multiply insn.
15538
15539 @item -mdiv=@var{strategy}
15540 @opindex mdiv=@var{strategy}
15541 Set the division strategy to use for SHmedia code.  @var{strategy} must be
15542 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
15543 inv:call2, inv:fp .
15544 "fp" performs the operation in floating point.  This has a very high latency,
15545 but needs only a few instructions, so it might be a good choice if
15546 your code has enough easily exploitable ILP to allow the compiler to
15547 schedule the floating point instructions together with other instructions.
15548 Division by zero causes a floating point exception.
15549 "inv" uses integer operations to calculate the inverse of the divisor,
15550 and then multiplies the dividend with the inverse.  This strategy allows
15551 cse and hoisting of the inverse calculation.  Division by zero calculates
15552 an unspecified result, but does not trap.
15553 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
15554 have been found, or if the entire operation has been hoisted to the same
15555 place, the last stages of the inverse calculation are intertwined with the
15556 final multiply to reduce the overall latency, at the expense of using a few
15557 more instructions, and thus offering fewer scheduling opportunities with
15558 other code.
15559 "call" calls a library function that usually implements the inv:minlat
15560 strategy.
15561 This gives high code density for m5-*media-nofpu compilations.
15562 "call2" uses a different entry point of the same library function, where it
15563 assumes that a pointer to a lookup table has already been set up, which
15564 exposes the pointer load to cse / code hoisting optimizations.
15565 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
15566 code generation, but if the code stays unoptimized, revert to the "call",
15567 "call2", or "fp" strategies, respectively.  Note that the
15568 potentially-trapping side effect of division by zero is carried by a
15569 separate instruction, so it is possible that all the integer instructions
15570 are hoisted out, but the marker for the side effect stays where it is.
15571 A recombination to fp operations or a call is not possible in that case.
15572 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
15573 that the inverse calculation was nor separated from the multiply, they speed
15574 up division where the dividend fits into 20 bits (plus sign where applicable),
15575 by inserting a test to skip a number of operations in this case; this test
15576 slows down the case of larger dividends.  inv20u assumes the case of a such
15577 a small dividend to be unlikely, and inv20l assumes it to be likely.
15578
15579 @item -mdivsi3_libfunc=@var{name}
15580 @opindex mdivsi3_libfunc=@var{name}
15581 Set the name of the library function used for 32 bit signed division to
15582 @var{name}.  This only affect the name used in the call and inv:call
15583 division strategies, and the compiler will still expect the same
15584 sets of input/output/clobbered registers as if this option was not present.
15585
15586 @item -mfixed-range=@var{register-range}
15587 @opindex mfixed-range
15588 Generate code treating the given register range as fixed registers.
15589 A fixed register is one that the register allocator can not use.  This is
15590 useful when compiling kernel code.  A register range is specified as
15591 two registers separated by a dash.  Multiple register ranges can be
15592 specified separated by a comma.
15593
15594 @item -madjust-unroll
15595 @opindex madjust-unroll
15596 Throttle unrolling to avoid thrashing target registers.
15597 This option only has an effect if the gcc code base supports the
15598 TARGET_ADJUST_UNROLL_MAX target hook.
15599
15600 @item -mindexed-addressing
15601 @opindex mindexed-addressing
15602 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
15603 This is only safe if the hardware and/or OS implement 32 bit wrap-around
15604 semantics for the indexed addressing mode.  The architecture allows the
15605 implementation of processors with 64 bit MMU, which the OS could use to
15606 get 32 bit addressing, but since no current hardware implementation supports
15607 this or any other way to make the indexed addressing mode safe to use in
15608 the 32 bit ABI, the default is -mno-indexed-addressing.
15609
15610 @item -mgettrcost=@var{number}
15611 @opindex mgettrcost=@var{number}
15612 Set the cost assumed for the gettr instruction to @var{number}.
15613 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
15614
15615 @item -mpt-fixed
15616 @opindex mpt-fixed
15617 Assume pt* instructions won't trap.  This will generally generate better
15618 scheduled code, but is unsafe on current hardware.  The current architecture
15619 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
15620 This has the unintentional effect of making it unsafe to schedule ptabs /
15621 ptrel before a branch, or hoist it out of a loop.  For example,
15622 __do_global_ctors, a part of libgcc that runs constructors at program
15623 startup, calls functions in a list which is delimited by @minus{}1.  With the
15624 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
15625 That means that all the constructors will be run a bit quicker, but when
15626 the loop comes to the end of the list, the program crashes because ptabs
15627 loads @minus{}1 into a target register.  Since this option is unsafe for any
15628 hardware implementing the current architecture specification, the default
15629 is -mno-pt-fixed.  Unless the user specifies a specific cost with
15630 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
15631 this deters register allocation using target registers for storing
15632 ordinary integers.
15633
15634 @item -minvalid-symbols
15635 @opindex minvalid-symbols
15636 Assume symbols might be invalid.  Ordinary function symbols generated by
15637 the compiler will always be valid to load with movi/shori/ptabs or
15638 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
15639 to generate symbols that will cause ptabs / ptrel to trap.
15640 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
15641 It will then prevent cross-basic-block cse, hoisting and most scheduling
15642 of symbol loads.  The default is @option{-mno-invalid-symbols}.
15643 @end table
15644
15645 @node SPARC Options
15646 @subsection SPARC Options
15647 @cindex SPARC options
15648
15649 These @samp{-m} options are supported on the SPARC:
15650
15651 @table @gcctabopt
15652 @item -mno-app-regs
15653 @itemx -mapp-regs
15654 @opindex mno-app-regs
15655 @opindex mapp-regs
15656 Specify @option{-mapp-regs} to generate output using the global registers
15657 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
15658 is the default.
15659
15660 To be fully SVR4 ABI compliant at the cost of some performance loss,
15661 specify @option{-mno-app-regs}.  You should compile libraries and system
15662 software with this option.
15663
15664 @item -mfpu
15665 @itemx -mhard-float
15666 @opindex mfpu
15667 @opindex mhard-float
15668 Generate output containing floating point instructions.  This is the
15669 default.
15670
15671 @item -mno-fpu
15672 @itemx -msoft-float
15673 @opindex mno-fpu
15674 @opindex msoft-float
15675 Generate output containing library calls for floating point.
15676 @strong{Warning:} the requisite libraries are not available for all SPARC
15677 targets.  Normally the facilities of the machine's usual C compiler are
15678 used, but this cannot be done directly in cross-compilation.  You must make
15679 your own arrangements to provide suitable library functions for
15680 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
15681 @samp{sparclite-*-*} do provide software floating point support.
15682
15683 @option{-msoft-float} changes the calling convention in the output file;
15684 therefore, it is only useful if you compile @emph{all} of a program with
15685 this option.  In particular, you need to compile @file{libgcc.a}, the
15686 library that comes with GCC, with @option{-msoft-float} in order for
15687 this to work.
15688
15689 @item -mhard-quad-float
15690 @opindex mhard-quad-float
15691 Generate output containing quad-word (long double) floating point
15692 instructions.
15693
15694 @item -msoft-quad-float
15695 @opindex msoft-quad-float
15696 Generate output containing library calls for quad-word (long double)
15697 floating point instructions.  The functions called are those specified
15698 in the SPARC ABI@.  This is the default.
15699
15700 As of this writing, there are no SPARC implementations that have hardware
15701 support for the quad-word floating point instructions.  They all invoke
15702 a trap handler for one of these instructions, and then the trap handler
15703 emulates the effect of the instruction.  Because of the trap handler overhead,
15704 this is much slower than calling the ABI library routines.  Thus the
15705 @option{-msoft-quad-float} option is the default.
15706
15707 @item -mno-unaligned-doubles
15708 @itemx -munaligned-doubles
15709 @opindex mno-unaligned-doubles
15710 @opindex munaligned-doubles
15711 Assume that doubles have 8 byte alignment.  This is the default.
15712
15713 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
15714 alignment only if they are contained in another type, or if they have an
15715 absolute address.  Otherwise, it assumes they have 4 byte alignment.
15716 Specifying this option avoids some rare compatibility problems with code
15717 generated by other compilers.  It is not the default because it results
15718 in a performance loss, especially for floating point code.
15719
15720 @item -mno-faster-structs
15721 @itemx -mfaster-structs
15722 @opindex mno-faster-structs
15723 @opindex mfaster-structs
15724 With @option{-mfaster-structs}, the compiler assumes that structures
15725 should have 8 byte alignment.  This enables the use of pairs of
15726 @code{ldd} and @code{std} instructions for copies in structure
15727 assignment, in place of twice as many @code{ld} and @code{st} pairs.
15728 However, the use of this changed alignment directly violates the SPARC
15729 ABI@.  Thus, it's intended only for use on targets where the developer
15730 acknowledges that their resulting code will not be directly in line with
15731 the rules of the ABI@.
15732
15733 @item -mimpure-text
15734 @opindex mimpure-text
15735 @option{-mimpure-text}, used in addition to @option{-shared}, tells
15736 the compiler to not pass @option{-z text} to the linker when linking a
15737 shared object.  Using this option, you can link position-dependent
15738 code into a shared object.
15739
15740 @option{-mimpure-text} suppresses the ``relocations remain against
15741 allocatable but non-writable sections'' linker error message.
15742 However, the necessary relocations will trigger copy-on-write, and the
15743 shared object is not actually shared across processes.  Instead of
15744 using @option{-mimpure-text}, you should compile all source code with
15745 @option{-fpic} or @option{-fPIC}.
15746
15747 This option is only available on SunOS and Solaris.
15748
15749 @item -mcpu=@var{cpu_type}
15750 @opindex mcpu
15751 Set the instruction set, register set, and instruction scheduling parameters
15752 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
15753 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
15754 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
15755 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
15756 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
15757
15758 Default instruction scheduling parameters are used for values that select
15759 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
15760 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
15761
15762 Here is a list of each supported architecture and their supported
15763 implementations.
15764
15765 @smallexample
15766     v7:             cypress
15767     v8:             supersparc, hypersparc
15768     sparclite:      f930, f934, sparclite86x
15769     sparclet:       tsc701
15770     v9:             ultrasparc, ultrasparc3, niagara, niagara2
15771 @end smallexample
15772
15773 By default (unless configured otherwise), GCC generates code for the V7
15774 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
15775 additionally optimizes it for the Cypress CY7C602 chip, as used in the
15776 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
15777 SPARCStation 1, 2, IPX etc.
15778
15779 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
15780 architecture.  The only difference from V7 code is that the compiler emits
15781 the integer multiply and integer divide instructions which exist in SPARC-V8
15782 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
15783 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
15784 2000 series.
15785
15786 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
15787 the SPARC architecture.  This adds the integer multiply, integer divide step
15788 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
15789 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
15790 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
15791 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
15792 MB86934 chip, which is the more recent SPARClite with FPU@.
15793
15794 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
15795 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
15796 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
15797 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
15798 optimizes it for the TEMIC SPARClet chip.
15799
15800 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
15801 architecture.  This adds 64-bit integer and floating-point move instructions,
15802 3 additional floating-point condition code registers and conditional move
15803 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
15804 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
15805 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
15806 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
15807 @option{-mcpu=niagara}, the compiler additionally optimizes it for
15808 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
15809 additionally optimizes it for Sun UltraSPARC T2 chips.
15810
15811 @item -mtune=@var{cpu_type}
15812 @opindex mtune
15813 Set the instruction scheduling parameters for machine type
15814 @var{cpu_type}, but do not set the instruction set or register set that the
15815 option @option{-mcpu=@var{cpu_type}} would.
15816
15817 The same values for @option{-mcpu=@var{cpu_type}} can be used for
15818 @option{-mtune=@var{cpu_type}}, but the only useful values are those
15819 that select a particular cpu implementation.  Those are @samp{cypress},
15820 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
15821 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
15822 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
15823
15824 @item -mv8plus
15825 @itemx -mno-v8plus
15826 @opindex mv8plus
15827 @opindex mno-v8plus
15828 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
15829 difference from the V8 ABI is that the global and out registers are
15830 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
15831 mode for all SPARC-V9 processors.
15832
15833 @item -mvis
15834 @itemx -mno-vis
15835 @opindex mvis
15836 @opindex mno-vis
15837 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
15838 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
15839 @end table
15840
15841 These @samp{-m} options are supported in addition to the above
15842 on SPARC-V9 processors in 64-bit environments:
15843
15844 @table @gcctabopt
15845 @item -mlittle-endian
15846 @opindex mlittle-endian
15847 Generate code for a processor running in little-endian mode.  It is only
15848 available for a few configurations and most notably not on Solaris and Linux.
15849
15850 @item -m32
15851 @itemx -m64
15852 @opindex m32
15853 @opindex m64
15854 Generate code for a 32-bit or 64-bit environment.
15855 The 32-bit environment sets int, long and pointer to 32 bits.
15856 The 64-bit environment sets int to 32 bits and long and pointer
15857 to 64 bits.
15858
15859 @item -mcmodel=medlow
15860 @opindex mcmodel=medlow
15861 Generate code for the Medium/Low code model: 64-bit addresses, programs
15862 must be linked in the low 32 bits of memory.  Programs can be statically
15863 or dynamically linked.
15864
15865 @item -mcmodel=medmid
15866 @opindex mcmodel=medmid
15867 Generate code for the Medium/Middle code model: 64-bit addresses, programs
15868 must be linked in the low 44 bits of memory, the text and data segments must
15869 be less than 2GB in size and the data segment must be located within 2GB of
15870 the text segment.
15871
15872 @item -mcmodel=medany
15873 @opindex mcmodel=medany
15874 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
15875 may be linked anywhere in memory, the text and data segments must be less
15876 than 2GB in size and the data segment must be located within 2GB of the
15877 text segment.
15878
15879 @item -mcmodel=embmedany
15880 @opindex mcmodel=embmedany
15881 Generate code for the Medium/Anywhere code model for embedded systems:
15882 64-bit addresses, the text and data segments must be less than 2GB in
15883 size, both starting anywhere in memory (determined at link time).  The
15884 global register %g4 points to the base of the data segment.  Programs
15885 are statically linked and PIC is not supported.
15886
15887 @item -mstack-bias
15888 @itemx -mno-stack-bias
15889 @opindex mstack-bias
15890 @opindex mno-stack-bias
15891 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
15892 frame pointer if present, are offset by @minus{}2047 which must be added back
15893 when making stack frame references.  This is the default in 64-bit mode.
15894 Otherwise, assume no such offset is present.
15895 @end table
15896
15897 These switches are supported in addition to the above on Solaris:
15898
15899 @table @gcctabopt
15900 @item -threads
15901 @opindex threads
15902 Add support for multithreading using the Solaris threads library.  This
15903 option sets flags for both the preprocessor and linker.  This option does
15904 not affect the thread safety of object code produced by the compiler or
15905 that of libraries supplied with it.
15906
15907 @item -pthreads
15908 @opindex pthreads
15909 Add support for multithreading using the POSIX threads library.  This
15910 option sets flags for both the preprocessor and linker.  This option does
15911 not affect the thread safety of object code produced  by the compiler or
15912 that of libraries supplied with it.
15913
15914 @item -pthread
15915 @opindex pthread
15916 This is a synonym for @option{-pthreads}.
15917 @end table
15918
15919 @node SPU Options
15920 @subsection SPU Options
15921 @cindex SPU options
15922
15923 These @samp{-m} options are supported on the SPU:
15924
15925 @table @gcctabopt
15926 @item -mwarn-reloc
15927 @itemx -merror-reloc
15928 @opindex mwarn-reloc
15929 @opindex merror-reloc
15930
15931 The loader for SPU does not handle dynamic relocations.  By default, GCC
15932 will give an error when it generates code that requires a dynamic
15933 relocation.  @option{-mno-error-reloc} disables the error,
15934 @option{-mwarn-reloc} will generate a warning instead.
15935
15936 @item -msafe-dma
15937 @itemx -munsafe-dma
15938 @opindex msafe-dma
15939 @opindex munsafe-dma
15940
15941 Instructions which initiate or test completion of DMA must not be
15942 reordered with respect to loads and stores of the memory which is being
15943 accessed.  Users typically address this problem using the volatile
15944 keyword, but that can lead to inefficient code in places where the
15945 memory is known to not change.  Rather than mark the memory as volatile
15946 we treat the DMA instructions as potentially effecting all memory.  With
15947 @option{-munsafe-dma} users must use the volatile keyword to protect
15948 memory accesses.
15949
15950 @item -mbranch-hints
15951 @opindex mbranch-hints
15952
15953 By default, GCC will generate a branch hint instruction to avoid
15954 pipeline stalls for always taken or probably taken branches.  A hint
15955 will not be generated closer than 8 instructions away from its branch.
15956 There is little reason to disable them, except for debugging purposes,
15957 or to make an object a little bit smaller.
15958
15959 @item -msmall-mem
15960 @itemx -mlarge-mem
15961 @opindex msmall-mem
15962 @opindex mlarge-mem
15963
15964 By default, GCC generates code assuming that addresses are never larger
15965 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
15966 a full 32 bit address.
15967
15968 @item -mstdmain
15969 @opindex mstdmain
15970
15971 By default, GCC links against startup code that assumes the SPU-style
15972 main function interface (which has an unconventional parameter list).
15973 With @option{-mstdmain}, GCC will link your program against startup
15974 code that assumes a C99-style interface to @code{main}, including a
15975 local copy of @code{argv} strings.
15976
15977 @item -mfixed-range=@var{register-range}
15978 @opindex mfixed-range
15979 Generate code treating the given register range as fixed registers.
15980 A fixed register is one that the register allocator can not use.  This is
15981 useful when compiling kernel code.  A register range is specified as
15982 two registers separated by a dash.  Multiple register ranges can be
15983 specified separated by a comma.
15984
15985 @item -mdual-nops
15986 @itemx -mdual-nops=@var{n}
15987 @opindex mdual-nops
15988 By default, GCC will insert nops to increase dual issue when it expects
15989 it to increase performance.  @var{n} can be a value from 0 to 10.  A
15990 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
15991 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
15992
15993 @item -mhint-max-nops=@var{n}
15994 @opindex mhint-max-nops
15995 Maximum number of nops to insert for a branch hint.  A branch hint must
15996 be at least 8 instructions away from the branch it is effecting.  GCC
15997 will insert up to @var{n} nops to enforce this, otherwise it will not
15998 generate the branch hint.
15999
16000 @item -mhint-max-distance=@var{n}
16001 @opindex mhint-max-distance
16002 The encoding of the branch hint instruction limits the hint to be within
16003 256 instructions of the branch it is effecting.  By default, GCC makes
16004 sure it is within 125.
16005
16006 @item -msafe-hints
16007 @opindex msafe-hints
16008 Work around a hardware bug which causes the SPU to stall indefinitely.
16009 By default, GCC will insert the @code{hbrp} instruction to make sure
16010 this stall won't happen.
16011
16012 @end table
16013
16014 @node System V Options
16015 @subsection Options for System V
16016
16017 These additional options are available on System V Release 4 for
16018 compatibility with other compilers on those systems:
16019
16020 @table @gcctabopt
16021 @item -G
16022 @opindex G
16023 Create a shared object.
16024 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
16025
16026 @item -Qy
16027 @opindex Qy
16028 Identify the versions of each tool used by the compiler, in a
16029 @code{.ident} assembler directive in the output.
16030
16031 @item -Qn
16032 @opindex Qn
16033 Refrain from adding @code{.ident} directives to the output file (this is
16034 the default).
16035
16036 @item -YP,@var{dirs}
16037 @opindex YP
16038 Search the directories @var{dirs}, and no others, for libraries
16039 specified with @option{-l}.
16040
16041 @item -Ym,@var{dir}
16042 @opindex Ym
16043 Look in the directory @var{dir} to find the M4 preprocessor.
16044 The assembler uses this option.
16045 @c This is supposed to go with a -Yd for predefined M4 macro files, but
16046 @c the generic assembler that comes with Solaris takes just -Ym.
16047 @end table
16048
16049 @node V850 Options
16050 @subsection V850 Options
16051 @cindex V850 Options
16052
16053 These @samp{-m} options are defined for V850 implementations:
16054
16055 @table @gcctabopt
16056 @item -mlong-calls
16057 @itemx -mno-long-calls
16058 @opindex mlong-calls
16059 @opindex mno-long-calls
16060 Treat all calls as being far away (near).  If calls are assumed to be
16061 far away, the compiler will always load the functions address up into a
16062 register, and call indirect through the pointer.
16063
16064 @item -mno-ep
16065 @itemx -mep
16066 @opindex mno-ep
16067 @opindex mep
16068 Do not optimize (do optimize) basic blocks that use the same index
16069 pointer 4 or more times to copy pointer into the @code{ep} register, and
16070 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
16071 option is on by default if you optimize.
16072
16073 @item -mno-prolog-function
16074 @itemx -mprolog-function
16075 @opindex mno-prolog-function
16076 @opindex mprolog-function
16077 Do not use (do use) external functions to save and restore registers
16078 at the prologue and epilogue of a function.  The external functions
16079 are slower, but use less code space if more than one function saves
16080 the same number of registers.  The @option{-mprolog-function} option
16081 is on by default if you optimize.
16082
16083 @item -mspace
16084 @opindex mspace
16085 Try to make the code as small as possible.  At present, this just turns
16086 on the @option{-mep} and @option{-mprolog-function} options.
16087
16088 @item -mtda=@var{n}
16089 @opindex mtda
16090 Put static or global variables whose size is @var{n} bytes or less into
16091 the tiny data area that register @code{ep} points to.  The tiny data
16092 area can hold up to 256 bytes in total (128 bytes for byte references).
16093
16094 @item -msda=@var{n}
16095 @opindex msda
16096 Put static or global variables whose size is @var{n} bytes or less into
16097 the small data area that register @code{gp} points to.  The small data
16098 area can hold up to 64 kilobytes.
16099
16100 @item -mzda=@var{n}
16101 @opindex mzda
16102 Put static or global variables whose size is @var{n} bytes or less into
16103 the first 32 kilobytes of memory.
16104
16105 @item -mv850
16106 @opindex mv850
16107 Specify that the target processor is the V850.
16108
16109 @item -mbig-switch
16110 @opindex mbig-switch
16111 Generate code suitable for big switch tables.  Use this option only if
16112 the assembler/linker complain about out of range branches within a switch
16113 table.
16114
16115 @item -mapp-regs
16116 @opindex mapp-regs
16117 This option will cause r2 and r5 to be used in the code generated by
16118 the compiler.  This setting is the default.
16119
16120 @item -mno-app-regs
16121 @opindex mno-app-regs
16122 This option will cause r2 and r5 to be treated as fixed registers.
16123
16124 @item -mv850e1
16125 @opindex mv850e1
16126 Specify that the target processor is the V850E1.  The preprocessor
16127 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
16128 this option is used.
16129
16130 @item -mv850e
16131 @opindex mv850e
16132 Specify that the target processor is the V850E@.  The preprocessor
16133 constant @samp{__v850e__} will be defined if this option is used.
16134
16135 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
16136 are defined then a default target processor will be chosen and the
16137 relevant @samp{__v850*__} preprocessor constant will be defined.
16138
16139 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
16140 defined, regardless of which processor variant is the target.
16141
16142 @item -mdisable-callt
16143 @opindex mdisable-callt
16144 This option will suppress generation of the CALLT instruction for the
16145 v850e and v850e1 flavors of the v850 architecture.  The default is
16146 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
16147
16148 @end table
16149
16150 @node VAX Options
16151 @subsection VAX Options
16152 @cindex VAX options
16153
16154 These @samp{-m} options are defined for the VAX:
16155
16156 @table @gcctabopt
16157 @item -munix
16158 @opindex munix
16159 Do not output certain jump instructions (@code{aobleq} and so on)
16160 that the Unix assembler for the VAX cannot handle across long
16161 ranges.
16162
16163 @item -mgnu
16164 @opindex mgnu
16165 Do output those jump instructions, on the assumption that you
16166 will assemble with the GNU assembler.
16167
16168 @item -mg
16169 @opindex mg
16170 Output code for g-format floating point numbers instead of d-format.
16171 @end table
16172
16173 @node VxWorks Options
16174 @subsection VxWorks Options
16175 @cindex VxWorks Options
16176
16177 The options in this section are defined for all VxWorks targets.
16178 Options specific to the target hardware are listed with the other
16179 options for that target.
16180
16181 @table @gcctabopt
16182 @item -mrtp
16183 @opindex mrtp
16184 GCC can generate code for both VxWorks kernels and real time processes
16185 (RTPs).  This option switches from the former to the latter.  It also
16186 defines the preprocessor macro @code{__RTP__}.
16187
16188 @item -non-static
16189 @opindex non-static
16190 Link an RTP executable against shared libraries rather than static
16191 libraries.  The options @option{-static} and @option{-shared} can
16192 also be used for RTPs (@pxref{Link Options}); @option{-static}
16193 is the default.
16194
16195 @item -Bstatic
16196 @itemx -Bdynamic
16197 @opindex Bstatic
16198 @opindex Bdynamic
16199 These options are passed down to the linker.  They are defined for
16200 compatibility with Diab.
16201
16202 @item -Xbind-lazy
16203 @opindex Xbind-lazy
16204 Enable lazy binding of function calls.  This option is equivalent to
16205 @option{-Wl,-z,now} and is defined for compatibility with Diab.
16206
16207 @item -Xbind-now
16208 @opindex Xbind-now
16209 Disable lazy binding of function calls.  This option is the default and
16210 is defined for compatibility with Diab.
16211 @end table
16212
16213 @node x86-64 Options
16214 @subsection x86-64 Options
16215 @cindex x86-64 options
16216
16217 These are listed under @xref{i386 and x86-64 Options}.
16218
16219 @node i386 and x86-64 Windows Options
16220 @subsection i386 and x86-64 Windows Options
16221 @cindex i386 and x86-64 Windows Options
16222
16223 These additional options are available for Windows targets:
16224
16225 @table @gcctabopt
16226 @item -mconsole
16227 @opindex mconsole
16228 This option is available for Cygwin and MinGW targets.  It
16229 specifies that a console application is to be generated, by
16230 instructing the linker to set the PE header subsystem type
16231 required for console applications.
16232 This is the default behavior for Cygwin and MinGW targets.
16233
16234 @item -mcygwin
16235 @opindex mcygwin
16236 This option is available for Cygwin targets.  It specifies that
16237 the Cygwin internal interface is to be used for predefined
16238 preprocessor macros, C runtime libraries and related linker
16239 paths and options.  For Cygwin targets this is the default behavior.
16240 This option is deprecated and will be removed in a future release.
16241
16242 @item -mno-cygwin
16243 @opindex mno-cygwin
16244 This option is available for Cygwin targets.  It specifies that
16245 the MinGW internal interface is to be used instead of Cygwin's, by
16246 setting MinGW-related predefined macros and linker paths and default
16247 library options.
16248 This option is deprecated and will be removed in a future release.
16249
16250 @item -mdll
16251 @opindex mdll
16252 This option is available for Cygwin and MinGW targets.  It
16253 specifies that a DLL - a dynamic link library - is to be
16254 generated, enabling the selection of the required runtime
16255 startup object and entry point.
16256
16257 @item -mnop-fun-dllimport
16258 @opindex mnop-fun-dllimport
16259 This option is available for Cygwin and MinGW targets.  It
16260 specifies that the dllimport attribute should be ignored.
16261
16262 @item -mthread
16263 @opindex mthread
16264 This option is available for MinGW targets. It specifies
16265 that MinGW-specific thread support is to be used.
16266
16267 @item -municode
16268 @opindex municode
16269 This option is available for mingw-w64 targets.  It specifies
16270 that the UNICODE macro is getting pre-defined and that the
16271 unicode capable runtime startup code is choosen.
16272
16273 @item -mwin32
16274 @opindex mwin32
16275 This option is available for Cygwin and MinGW targets.  It
16276 specifies that the typical Windows pre-defined macros are to
16277 be set in the pre-processor, but does not influence the choice
16278 of runtime library/startup code.
16279
16280 @item -mwindows
16281 @opindex mwindows
16282 This option is available for Cygwin and MinGW targets.  It
16283 specifies that a GUI application is to be generated by
16284 instructing the linker to set the PE header subsystem type
16285 appropriately.
16286
16287 @item -mpe-aligned-commons
16288 @opindex mpe-aligned-commons
16289 This option is available for Cygwin and MinGW targets.  It
16290 specifies that the GNU extension to the PE file format that
16291 permits the correct alignment of COMMON variables should be
16292 used when generating code.  It will be enabled by default if
16293 GCC detects that the target assembler found during configuration
16294 supports the feature.
16295 @end table
16296
16297 See also under @ref{i386 and x86-64 Options} for standard options.
16298
16299 @node Xstormy16 Options
16300 @subsection Xstormy16 Options
16301 @cindex Xstormy16 Options
16302
16303 These options are defined for Xstormy16:
16304
16305 @table @gcctabopt
16306 @item -msim
16307 @opindex msim
16308 Choose startup files and linker script suitable for the simulator.
16309 @end table
16310
16311 @node Xtensa Options
16312 @subsection Xtensa Options
16313 @cindex Xtensa Options
16314
16315 These options are supported for Xtensa targets:
16316
16317 @table @gcctabopt
16318 @item -mconst16
16319 @itemx -mno-const16
16320 @opindex mconst16
16321 @opindex mno-const16
16322 Enable or disable use of @code{CONST16} instructions for loading
16323 constant values.  The @code{CONST16} instruction is currently not a
16324 standard option from Tensilica.  When enabled, @code{CONST16}
16325 instructions are always used in place of the standard @code{L32R}
16326 instructions.  The use of @code{CONST16} is enabled by default only if
16327 the @code{L32R} instruction is not available.
16328
16329 @item -mfused-madd
16330 @itemx -mno-fused-madd
16331 @opindex mfused-madd
16332 @opindex mno-fused-madd
16333 Enable or disable use of fused multiply/add and multiply/subtract
16334 instructions in the floating-point option.  This has no effect if the
16335 floating-point option is not also enabled.  Disabling fused multiply/add
16336 and multiply/subtract instructions forces the compiler to use separate
16337 instructions for the multiply and add/subtract operations.  This may be
16338 desirable in some cases where strict IEEE 754-compliant results are
16339 required: the fused multiply add/subtract instructions do not round the
16340 intermediate result, thereby producing results with @emph{more} bits of
16341 precision than specified by the IEEE standard.  Disabling fused multiply
16342 add/subtract instructions also ensures that the program output is not
16343 sensitive to the compiler's ability to combine multiply and add/subtract
16344 operations.
16345
16346 @item -mserialize-volatile
16347 @itemx -mno-serialize-volatile
16348 @opindex mserialize-volatile
16349 @opindex mno-serialize-volatile
16350 When this option is enabled, GCC inserts @code{MEMW} instructions before
16351 @code{volatile} memory references to guarantee sequential consistency.
16352 The default is @option{-mserialize-volatile}.  Use
16353 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
16354
16355 @item -mtext-section-literals
16356 @itemx -mno-text-section-literals
16357 @opindex mtext-section-literals
16358 @opindex mno-text-section-literals
16359 Control the treatment of literal pools.  The default is
16360 @option{-mno-text-section-literals}, which places literals in a separate
16361 section in the output file.  This allows the literal pool to be placed
16362 in a data RAM/ROM, and it also allows the linker to combine literal
16363 pools from separate object files to remove redundant literals and
16364 improve code size.  With @option{-mtext-section-literals}, the literals
16365 are interspersed in the text section in order to keep them as close as
16366 possible to their references.  This may be necessary for large assembly
16367 files.
16368
16369 @item -mtarget-align
16370 @itemx -mno-target-align
16371 @opindex mtarget-align
16372 @opindex mno-target-align
16373 When this option is enabled, GCC instructs the assembler to
16374 automatically align instructions to reduce branch penalties at the
16375 expense of some code density.  The assembler attempts to widen density
16376 instructions to align branch targets and the instructions following call
16377 instructions.  If there are not enough preceding safe density
16378 instructions to align a target, no widening will be performed.  The
16379 default is @option{-mtarget-align}.  These options do not affect the
16380 treatment of auto-aligned instructions like @code{LOOP}, which the
16381 assembler will always align, either by widening density instructions or
16382 by inserting no-op instructions.
16383
16384 @item -mlongcalls
16385 @itemx -mno-longcalls
16386 @opindex mlongcalls
16387 @opindex mno-longcalls
16388 When this option is enabled, GCC instructs the assembler to translate
16389 direct calls to indirect calls unless it can determine that the target
16390 of a direct call is in the range allowed by the call instruction.  This
16391 translation typically occurs for calls to functions in other source
16392 files.  Specifically, the assembler translates a direct @code{CALL}
16393 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
16394 The default is @option{-mno-longcalls}.  This option should be used in
16395 programs where the call target can potentially be out of range.  This
16396 option is implemented in the assembler, not the compiler, so the
16397 assembly code generated by GCC will still show direct call
16398 instructions---look at the disassembled object code to see the actual
16399 instructions.  Note that the assembler will use an indirect call for
16400 every cross-file call, not just those that really will be out of range.
16401 @end table
16402
16403 @node zSeries Options
16404 @subsection zSeries Options
16405 @cindex zSeries options
16406
16407 These are listed under @xref{S/390 and zSeries Options}.
16408
16409 @node Code Gen Options
16410 @section Options for Code Generation Conventions
16411 @cindex code generation conventions
16412 @cindex options, code generation
16413 @cindex run-time options
16414
16415 These machine-independent options control the interface conventions
16416 used in code generation.
16417
16418 Most of them have both positive and negative forms; the negative form
16419 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
16420 one of the forms is listed---the one which is not the default.  You
16421 can figure out the other form by either removing @samp{no-} or adding
16422 it.
16423
16424 @table @gcctabopt
16425 @item -fbounds-check
16426 @opindex fbounds-check
16427 For front-ends that support it, generate additional code to check that
16428 indices used to access arrays are within the declared range.  This is
16429 currently only supported by the Java and Fortran front-ends, where
16430 this option defaults to true and false respectively.
16431
16432 @item -ftrapv
16433 @opindex ftrapv
16434 This option generates traps for signed overflow on addition, subtraction,
16435 multiplication operations.
16436
16437 @item -fwrapv
16438 @opindex fwrapv
16439 This option instructs the compiler to assume that signed arithmetic
16440 overflow of addition, subtraction and multiplication wraps around
16441 using twos-complement representation.  This flag enables some optimizations
16442 and disables others.  This option is enabled by default for the Java
16443 front-end, as required by the Java language specification.
16444
16445 @item -fexceptions
16446 @opindex fexceptions
16447 Enable exception handling.  Generates extra code needed to propagate
16448 exceptions.  For some targets, this implies GCC will generate frame
16449 unwind information for all functions, which can produce significant data
16450 size overhead, although it does not affect execution.  If you do not
16451 specify this option, GCC will enable it by default for languages like
16452 C++ which normally require exception handling, and disable it for
16453 languages like C that do not normally require it.  However, you may need
16454 to enable this option when compiling C code that needs to interoperate
16455 properly with exception handlers written in C++.  You may also wish to
16456 disable this option if you are compiling older C++ programs that don't
16457 use exception handling.
16458
16459 @item -fnon-call-exceptions
16460 @opindex fnon-call-exceptions
16461 Generate code that allows trapping instructions to throw exceptions.
16462 Note that this requires platform-specific runtime support that does
16463 not exist everywhere.  Moreover, it only allows @emph{trapping}
16464 instructions to throw exceptions, i.e.@: memory references or floating
16465 point instructions.  It does not allow exceptions to be thrown from
16466 arbitrary signal handlers such as @code{SIGALRM}.
16467
16468 @item -funwind-tables
16469 @opindex funwind-tables
16470 Similar to @option{-fexceptions}, except that it will just generate any needed
16471 static data, but will not affect the generated code in any other way.
16472 You will normally not enable this option; instead, a language processor
16473 that needs this handling would enable it on your behalf.
16474
16475 @item -fasynchronous-unwind-tables
16476 @opindex fasynchronous-unwind-tables
16477 Generate unwind table in dwarf2 format, if supported by target machine.  The
16478 table is exact at each instruction boundary, so it can be used for stack
16479 unwinding from asynchronous events (such as debugger or garbage collector).
16480
16481 @item -fpcc-struct-return
16482 @opindex fpcc-struct-return
16483 Return ``short'' @code{struct} and @code{union} values in memory like
16484 longer ones, rather than in registers.  This convention is less
16485 efficient, but it has the advantage of allowing intercallability between
16486 GCC-compiled files and files compiled with other compilers, particularly
16487 the Portable C Compiler (pcc).
16488
16489 The precise convention for returning structures in memory depends
16490 on the target configuration macros.
16491
16492 Short structures and unions are those whose size and alignment match
16493 that of some integer type.
16494
16495 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
16496 switch is not binary compatible with code compiled with the
16497 @option{-freg-struct-return} switch.
16498 Use it to conform to a non-default application binary interface.
16499
16500 @item -freg-struct-return
16501 @opindex freg-struct-return
16502 Return @code{struct} and @code{union} values in registers when possible.
16503 This is more efficient for small structures than
16504 @option{-fpcc-struct-return}.
16505
16506 If you specify neither @option{-fpcc-struct-return} nor
16507 @option{-freg-struct-return}, GCC defaults to whichever convention is
16508 standard for the target.  If there is no standard convention, GCC
16509 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
16510 the principal compiler.  In those cases, we can choose the standard, and
16511 we chose the more efficient register return alternative.
16512
16513 @strong{Warning:} code compiled with the @option{-freg-struct-return}
16514 switch is not binary compatible with code compiled with the
16515 @option{-fpcc-struct-return} switch.
16516 Use it to conform to a non-default application binary interface.
16517
16518 @item -fshort-enums
16519 @opindex fshort-enums
16520 Allocate to an @code{enum} type only as many bytes as it needs for the
16521 declared range of possible values.  Specifically, the @code{enum} type
16522 will be equivalent to the smallest integer type which has enough room.
16523
16524 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
16525 code that is not binary compatible with code generated without that switch.
16526 Use it to conform to a non-default application binary interface.
16527
16528 @item -fshort-double
16529 @opindex fshort-double
16530 Use the same size for @code{double} as for @code{float}.
16531
16532 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
16533 code that is not binary compatible with code generated without that switch.
16534 Use it to conform to a non-default application binary interface.
16535
16536 @item -fshort-wchar
16537 @opindex fshort-wchar
16538 Override the underlying type for @samp{wchar_t} to be @samp{short
16539 unsigned int} instead of the default for the target.  This option is
16540 useful for building programs to run under WINE@.
16541
16542 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
16543 code that is not binary compatible with code generated without that switch.
16544 Use it to conform to a non-default application binary interface.
16545
16546 @item -fno-common
16547 @opindex fno-common
16548 In C code, controls the placement of uninitialized global variables.
16549 Unix C compilers have traditionally permitted multiple definitions of
16550 such variables in different compilation units by placing the variables
16551 in a common block.
16552 This is the behavior specified by @option{-fcommon}, and is the default
16553 for GCC on most targets.
16554 On the other hand, this behavior is not required by ISO C, and on some
16555 targets may carry a speed or code size penalty on variable references.
16556 The @option{-fno-common} option specifies that the compiler should place
16557 uninitialized global variables in the data section of the object file,
16558 rather than generating them as common blocks.
16559 This has the effect that if the same variable is declared
16560 (without @code{extern}) in two different compilations,
16561 you will get a multiple-definition error when you link them.
16562 In this case, you must compile with @option{-fcommon} instead.
16563 Compiling with @option{-fno-common} is useful on targets for which
16564 it provides better performance, or if you wish to verify that the
16565 program will work on other systems which always treat uninitialized
16566 variable declarations this way.
16567
16568 @item -fno-ident
16569 @opindex fno-ident
16570 Ignore the @samp{#ident} directive.
16571
16572 @item -finhibit-size-directive
16573 @opindex finhibit-size-directive
16574 Don't output a @code{.size} assembler directive, or anything else that
16575 would cause trouble if the function is split in the middle, and the
16576 two halves are placed at locations far apart in memory.  This option is
16577 used when compiling @file{crtstuff.c}; you should not need to use it
16578 for anything else.
16579
16580 @item -fverbose-asm
16581 @opindex fverbose-asm
16582 Put extra commentary information in the generated assembly code to
16583 make it more readable.  This option is generally only of use to those
16584 who actually need to read the generated assembly code (perhaps while
16585 debugging the compiler itself).
16586
16587 @option{-fno-verbose-asm}, the default, causes the
16588 extra information to be omitted and is useful when comparing two assembler
16589 files.
16590
16591 @item -frecord-gcc-switches
16592 @opindex frecord-gcc-switches
16593 This switch causes the command line that was used to invoke the
16594 compiler to be recorded into the object file that is being created.
16595 This switch is only implemented on some targets and the exact format
16596 of the recording is target and binary file format dependent, but it
16597 usually takes the form of a section containing ASCII text.  This
16598 switch is related to the @option{-fverbose-asm} switch, but that
16599 switch only records information in the assembler output file as
16600 comments, so it never reaches the object file.
16601
16602 @item -fpic
16603 @opindex fpic
16604 @cindex global offset table
16605 @cindex PIC
16606 Generate position-independent code (PIC) suitable for use in a shared
16607 library, if supported for the target machine.  Such code accesses all
16608 constant addresses through a global offset table (GOT)@.  The dynamic
16609 loader resolves the GOT entries when the program starts (the dynamic
16610 loader is not part of GCC; it is part of the operating system).  If
16611 the GOT size for the linked executable exceeds a machine-specific
16612 maximum size, you get an error message from the linker indicating that
16613 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
16614 instead.  (These maximums are 8k on the SPARC and 32k
16615 on the m68k and RS/6000.  The 386 has no such limit.)
16616
16617 Position-independent code requires special support, and therefore works
16618 only on certain machines.  For the 386, GCC supports PIC for System V
16619 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
16620 position-independent.
16621
16622 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
16623 are defined to 1.
16624
16625 @item -fPIC
16626 @opindex fPIC
16627 If supported for the target machine, emit position-independent code,
16628 suitable for dynamic linking and avoiding any limit on the size of the
16629 global offset table.  This option makes a difference on the m68k,
16630 PowerPC and SPARC@.
16631
16632 Position-independent code requires special support, and therefore works
16633 only on certain machines.
16634
16635 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
16636 are defined to 2.
16637
16638 @item -fpie
16639 @itemx -fPIE
16640 @opindex fpie
16641 @opindex fPIE
16642 These options are similar to @option{-fpic} and @option{-fPIC}, but
16643 generated position independent code can be only linked into executables.
16644 Usually these options are used when @option{-pie} GCC option will be
16645 used during linking.
16646
16647 @option{-fpie} and @option{-fPIE} both define the macros
16648 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
16649 for @option{-fpie} and 2 for @option{-fPIE}.
16650
16651 @item -fno-jump-tables
16652 @opindex fno-jump-tables
16653 Do not use jump tables for switch statements even where it would be
16654 more efficient than other code generation strategies.  This option is
16655 of use in conjunction with @option{-fpic} or @option{-fPIC} for
16656 building code which forms part of a dynamic linker and cannot
16657 reference the address of a jump table.  On some targets, jump tables
16658 do not require a GOT and this option is not needed.
16659
16660 @item -ffixed-@var{reg}
16661 @opindex ffixed
16662 Treat the register named @var{reg} as a fixed register; generated code
16663 should never refer to it (except perhaps as a stack pointer, frame
16664 pointer or in some other fixed role).
16665
16666 @var{reg} must be the name of a register.  The register names accepted
16667 are machine-specific and are defined in the @code{REGISTER_NAMES}
16668 macro in the machine description macro file.
16669
16670 This flag does not have a negative form, because it specifies a
16671 three-way choice.
16672
16673 @item -fcall-used-@var{reg}
16674 @opindex fcall-used
16675 Treat the register named @var{reg} as an allocable register that is
16676 clobbered by function calls.  It may be allocated for temporaries or
16677 variables that do not live across a call.  Functions compiled this way
16678 will not save and restore the register @var{reg}.
16679
16680 It is an error to used this flag with the frame pointer or stack pointer.
16681 Use of this flag for other registers that have fixed pervasive roles in
16682 the machine's execution model will produce disastrous results.
16683
16684 This flag does not have a negative form, because it specifies a
16685 three-way choice.
16686
16687 @item -fcall-saved-@var{reg}
16688 @opindex fcall-saved
16689 Treat the register named @var{reg} as an allocable register saved by
16690 functions.  It may be allocated even for temporaries or variables that
16691 live across a call.  Functions compiled this way will save and restore
16692 the register @var{reg} if they use it.
16693
16694 It is an error to used this flag with the frame pointer or stack pointer.
16695 Use of this flag for other registers that have fixed pervasive roles in
16696 the machine's execution model will produce disastrous results.
16697
16698 A different sort of disaster will result from the use of this flag for
16699 a register in which function values may be returned.
16700
16701 This flag does not have a negative form, because it specifies a
16702 three-way choice.
16703
16704 @item -fpack-struct[=@var{n}]
16705 @opindex fpack-struct
16706 Without a value specified, pack all structure members together without
16707 holes.  When a value is specified (which must be a small power of two), pack
16708 structure members according to this value, representing the maximum
16709 alignment (that is, objects with default alignment requirements larger than
16710 this will be output potentially unaligned at the next fitting location.
16711
16712 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
16713 code that is not binary compatible with code generated without that switch.
16714 Additionally, it makes the code suboptimal.
16715 Use it to conform to a non-default application binary interface.
16716
16717 @item -finstrument-functions
16718 @opindex finstrument-functions
16719 Generate instrumentation calls for entry and exit to functions.  Just
16720 after function entry and just before function exit, the following
16721 profiling functions will be called with the address of the current
16722 function and its call site.  (On some platforms,
16723 @code{__builtin_return_address} does not work beyond the current
16724 function, so the call site information may not be available to the
16725 profiling functions otherwise.)
16726
16727 @smallexample
16728 void __cyg_profile_func_enter (void *this_fn,
16729                                void *call_site);
16730 void __cyg_profile_func_exit  (void *this_fn,
16731                                void *call_site);
16732 @end smallexample
16733
16734 The first argument is the address of the start of the current function,
16735 which may be looked up exactly in the symbol table.
16736
16737 This instrumentation is also done for functions expanded inline in other
16738 functions.  The profiling calls will indicate where, conceptually, the
16739 inline function is entered and exited.  This means that addressable
16740 versions of such functions must be available.  If all your uses of a
16741 function are expanded inline, this may mean an additional expansion of
16742 code size.  If you use @samp{extern inline} in your C code, an
16743 addressable version of such functions must be provided.  (This is
16744 normally the case anyways, but if you get lucky and the optimizer always
16745 expands the functions inline, you might have gotten away without
16746 providing static copies.)
16747
16748 A function may be given the attribute @code{no_instrument_function}, in
16749 which case this instrumentation will not be done.  This can be used, for
16750 example, for the profiling functions listed above, high-priority
16751 interrupt routines, and any functions from which the profiling functions
16752 cannot safely be called (perhaps signal handlers, if the profiling
16753 routines generate output or allocate memory).
16754
16755 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
16756 @opindex finstrument-functions-exclude-file-list
16757
16758 Set the list of functions that are excluded from instrumentation (see
16759 the description of @code{-finstrument-functions}).  If the file that
16760 contains a function definition matches with one of @var{file}, then
16761 that function is not instrumented.  The match is done on substrings:
16762 if the @var{file} parameter is a substring of the file name, it is
16763 considered to be a match.
16764
16765 For example,
16766 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
16767 will exclude any inline function defined in files whose pathnames
16768 contain @code{/bits/stl} or @code{include/sys}.
16769
16770 If, for some reason, you want to include letter @code{','} in one of
16771 @var{sym}, write @code{'\,'}. For example,
16772 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
16773 (note the single quote surrounding the option).
16774
16775 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
16776 @opindex finstrument-functions-exclude-function-list
16777
16778 This is similar to @code{-finstrument-functions-exclude-file-list},
16779 but this option sets the list of function names to be excluded from
16780 instrumentation.  The function name to be matched is its user-visible
16781 name, such as @code{vector<int> blah(const vector<int> &)}, not the
16782 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
16783 match is done on substrings: if the @var{sym} parameter is a substring
16784 of the function name, it is considered to be a match.  For C99 and C++
16785 extended identifiers, the function name must be given in UTF-8, not
16786 using universal character names.
16787
16788 @item -fstack-check
16789 @opindex fstack-check
16790 Generate code to verify that you do not go beyond the boundary of the
16791 stack.  You should specify this flag if you are running in an
16792 environment with multiple threads, but only rarely need to specify it in
16793 a single-threaded environment since stack overflow is automatically
16794 detected on nearly all systems if there is only one stack.
16795
16796 Note that this switch does not actually cause checking to be done; the
16797 operating system or the language runtime must do that.  The switch causes
16798 generation of code to ensure that they see the stack being extended.
16799
16800 You can additionally specify a string parameter: @code{no} means no
16801 checking, @code{generic} means force the use of old-style checking,
16802 @code{specific} means use the best checking method and is equivalent
16803 to bare @option{-fstack-check}.
16804
16805 Old-style checking is a generic mechanism that requires no specific
16806 target support in the compiler but comes with the following drawbacks:
16807
16808 @enumerate
16809 @item
16810 Modified allocation strategy for large objects: they will always be
16811 allocated dynamically if their size exceeds a fixed threshold.
16812
16813 @item
16814 Fixed limit on the size of the static frame of functions: when it is
16815 topped by a particular function, stack checking is not reliable and
16816 a warning is issued by the compiler.
16817
16818 @item
16819 Inefficiency: because of both the modified allocation strategy and the
16820 generic implementation, the performances of the code are hampered.
16821 @end enumerate
16822
16823 Note that old-style stack checking is also the fallback method for
16824 @code{specific} if no target support has been added in the compiler.
16825
16826 @item -fstack-limit-register=@var{reg}
16827 @itemx -fstack-limit-symbol=@var{sym}
16828 @itemx -fno-stack-limit
16829 @opindex fstack-limit-register
16830 @opindex fstack-limit-symbol
16831 @opindex fno-stack-limit
16832 Generate code to ensure that the stack does not grow beyond a certain value,
16833 either the value of a register or the address of a symbol.  If the stack
16834 would grow beyond the value, a signal is raised.  For most targets,
16835 the signal is raised before the stack overruns the boundary, so
16836 it is possible to catch the signal without taking special precautions.
16837
16838 For instance, if the stack starts at absolute address @samp{0x80000000}
16839 and grows downwards, you can use the flags
16840 @option{-fstack-limit-symbol=__stack_limit} and
16841 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
16842 of 128KB@.  Note that this may only work with the GNU linker.
16843
16844 @cindex aliasing of parameters
16845 @cindex parameters, aliased
16846 @item -fargument-alias
16847 @itemx -fargument-noalias
16848 @itemx -fargument-noalias-global
16849 @itemx -fargument-noalias-anything
16850 @opindex fargument-alias
16851 @opindex fargument-noalias
16852 @opindex fargument-noalias-global
16853 @opindex fargument-noalias-anything
16854 Specify the possible relationships among parameters and between
16855 parameters and global data.
16856
16857 @option{-fargument-alias} specifies that arguments (parameters) may
16858 alias each other and may alias global storage.@*
16859 @option{-fargument-noalias} specifies that arguments do not alias
16860 each other, but may alias global storage.@*
16861 @option{-fargument-noalias-global} specifies that arguments do not
16862 alias each other and do not alias global storage.
16863 @option{-fargument-noalias-anything} specifies that arguments do not
16864 alias any other storage.
16865
16866 Each language will automatically use whatever option is required by
16867 the language standard.  You should not need to use these options yourself.
16868
16869 @item -fleading-underscore
16870 @opindex fleading-underscore
16871 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
16872 change the way C symbols are represented in the object file.  One use
16873 is to help link with legacy assembly code.
16874
16875 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
16876 generate code that is not binary compatible with code generated without that
16877 switch.  Use it to conform to a non-default application binary interface.
16878 Not all targets provide complete support for this switch.
16879
16880 @item -ftls-model=@var{model}
16881 @opindex ftls-model
16882 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
16883 The @var{model} argument should be one of @code{global-dynamic},
16884 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
16885
16886 The default without @option{-fpic} is @code{initial-exec}; with
16887 @option{-fpic} the default is @code{global-dynamic}.
16888
16889 @item -fvisibility=@var{default|internal|hidden|protected}
16890 @opindex fvisibility
16891 Set the default ELF image symbol visibility to the specified option---all
16892 symbols will be marked with this unless overridden within the code.
16893 Using this feature can very substantially improve linking and
16894 load times of shared object libraries, produce more optimized
16895 code, provide near-perfect API export and prevent symbol clashes.
16896 It is @strong{strongly} recommended that you use this in any shared objects
16897 you distribute.
16898
16899 Despite the nomenclature, @code{default} always means public ie;
16900 available to be linked against from outside the shared object.
16901 @code{protected} and @code{internal} are pretty useless in real-world
16902 usage so the only other commonly used option will be @code{hidden}.
16903 The default if @option{-fvisibility} isn't specified is
16904 @code{default}, i.e., make every
16905 symbol public---this causes the same behavior as previous versions of
16906 GCC@.
16907
16908 A good explanation of the benefits offered by ensuring ELF
16909 symbols have the correct visibility is given by ``How To Write
16910 Shared Libraries'' by Ulrich Drepper (which can be found at
16911 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
16912 solution made possible by this option to marking things hidden when
16913 the default is public is to make the default hidden and mark things
16914 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
16915 and @code{__attribute__ ((visibility("default")))} instead of
16916 @code{__declspec(dllexport)} you get almost identical semantics with
16917 identical syntax.  This is a great boon to those working with
16918 cross-platform projects.
16919
16920 For those adding visibility support to existing code, you may find
16921 @samp{#pragma GCC visibility} of use.  This works by you enclosing
16922 the declarations you wish to set visibility for with (for example)
16923 @samp{#pragma GCC visibility push(hidden)} and
16924 @samp{#pragma GCC visibility pop}.
16925 Bear in mind that symbol visibility should be viewed @strong{as
16926 part of the API interface contract} and thus all new code should
16927 always specify visibility when it is not the default ie; declarations
16928 only for use within the local DSO should @strong{always} be marked explicitly
16929 as hidden as so to avoid PLT indirection overheads---making this
16930 abundantly clear also aids readability and self-documentation of the code.
16931 Note that due to ISO C++ specification requirements, operator new and
16932 operator delete must always be of default visibility.
16933
16934 Be aware that headers from outside your project, in particular system
16935 headers and headers from any other library you use, may not be
16936 expecting to be compiled with visibility other than the default.  You
16937 may need to explicitly say @samp{#pragma GCC visibility push(default)}
16938 before including any such headers.
16939
16940 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
16941 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
16942 no modifications.  However, this means that calls to @samp{extern}
16943 functions with no explicit visibility will use the PLT, so it is more
16944 effective to use @samp{__attribute ((visibility))} and/or
16945 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
16946 declarations should be treated as hidden.
16947
16948 Note that @samp{-fvisibility} does affect C++ vague linkage
16949 entities. This means that, for instance, an exception class that will
16950 be thrown between DSOs must be explicitly marked with default
16951 visibility so that the @samp{type_info} nodes will be unified between
16952 the DSOs.
16953
16954 An overview of these techniques, their benefits and how to use them
16955 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
16956
16957 @end table
16958
16959 @c man end
16960
16961 @node Environment Variables
16962 @section Environment Variables Affecting GCC
16963 @cindex environment variables
16964
16965 @c man begin ENVIRONMENT
16966 This section describes several environment variables that affect how GCC
16967 operates.  Some of them work by specifying directories or prefixes to use
16968 when searching for various kinds of files.  Some are used to specify other
16969 aspects of the compilation environment.
16970
16971 Note that you can also specify places to search using options such as
16972 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
16973 take precedence over places specified using environment variables, which
16974 in turn take precedence over those specified by the configuration of GCC@.
16975 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
16976 GNU Compiler Collection (GCC) Internals}.
16977
16978 @table @env
16979 @item LANG
16980 @itemx LC_CTYPE
16981 @c @itemx LC_COLLATE
16982 @itemx LC_MESSAGES
16983 @c @itemx LC_MONETARY
16984 @c @itemx LC_NUMERIC
16985 @c @itemx LC_TIME
16986 @itemx LC_ALL
16987 @findex LANG
16988 @findex LC_CTYPE
16989 @c @findex LC_COLLATE
16990 @findex LC_MESSAGES
16991 @c @findex LC_MONETARY
16992 @c @findex LC_NUMERIC
16993 @c @findex LC_TIME
16994 @findex LC_ALL
16995 @cindex locale
16996 These environment variables control the way that GCC uses
16997 localization information that allow GCC to work with different
16998 national conventions.  GCC inspects the locale categories
16999 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
17000 so.  These locale categories can be set to any value supported by your
17001 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
17002 Kingdom encoded in UTF-8.
17003
17004 The @env{LC_CTYPE} environment variable specifies character
17005 classification.  GCC uses it to determine the character boundaries in
17006 a string; this is needed for some multibyte encodings that contain quote
17007 and escape characters that would otherwise be interpreted as a string
17008 end or escape.
17009
17010 The @env{LC_MESSAGES} environment variable specifies the language to
17011 use in diagnostic messages.
17012
17013 If the @env{LC_ALL} environment variable is set, it overrides the value
17014 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
17015 and @env{LC_MESSAGES} default to the value of the @env{LANG}
17016 environment variable.  If none of these variables are set, GCC
17017 defaults to traditional C English behavior.
17018
17019 @item TMPDIR
17020 @findex TMPDIR
17021 If @env{TMPDIR} is set, it specifies the directory to use for temporary
17022 files.  GCC uses temporary files to hold the output of one stage of
17023 compilation which is to be used as input to the next stage: for example,
17024 the output of the preprocessor, which is the input to the compiler
17025 proper.
17026
17027 @item GCC_EXEC_PREFIX
17028 @findex GCC_EXEC_PREFIX
17029 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
17030 names of the subprograms executed by the compiler.  No slash is added
17031 when this prefix is combined with the name of a subprogram, but you can
17032 specify a prefix that ends with a slash if you wish.
17033
17034 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
17035 an appropriate prefix to use based on the pathname it was invoked with.
17036
17037 If GCC cannot find the subprogram using the specified prefix, it
17038 tries looking in the usual places for the subprogram.
17039
17040 The default value of @env{GCC_EXEC_PREFIX} is
17041 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
17042 the installed compiler. In many cases @var{prefix} is the value
17043 of @code{prefix} when you ran the @file{configure} script.
17044
17045 Other prefixes specified with @option{-B} take precedence over this prefix.
17046
17047 This prefix is also used for finding files such as @file{crt0.o} that are
17048 used for linking.
17049
17050 In addition, the prefix is used in an unusual way in finding the
17051 directories to search for header files.  For each of the standard
17052 directories whose name normally begins with @samp{/usr/local/lib/gcc}
17053 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
17054 replacing that beginning with the specified prefix to produce an
17055 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
17056 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
17057 These alternate directories are searched first; the standard directories
17058 come next. If a standard directory begins with the configured
17059 @var{prefix} then the value of @var{prefix} is replaced by
17060 @env{GCC_EXEC_PREFIX} when looking for header files.
17061
17062 @item COMPILER_PATH
17063 @findex COMPILER_PATH
17064 The value of @env{COMPILER_PATH} is a colon-separated list of
17065 directories, much like @env{PATH}.  GCC tries the directories thus
17066 specified when searching for subprograms, if it can't find the
17067 subprograms using @env{GCC_EXEC_PREFIX}.
17068
17069 @item LIBRARY_PATH
17070 @findex LIBRARY_PATH
17071 The value of @env{LIBRARY_PATH} is a colon-separated list of
17072 directories, much like @env{PATH}.  When configured as a native compiler,
17073 GCC tries the directories thus specified when searching for special
17074 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
17075 using GCC also uses these directories when searching for ordinary
17076 libraries for the @option{-l} option (but directories specified with
17077 @option{-L} come first).
17078
17079 @item LANG
17080 @findex LANG
17081 @cindex locale definition
17082 This variable is used to pass locale information to the compiler.  One way in
17083 which this information is used is to determine the character set to be used
17084 when character literals, string literals and comments are parsed in C and C++.
17085 When the compiler is configured to allow multibyte characters,
17086 the following values for @env{LANG} are recognized:
17087
17088 @table @samp
17089 @item C-JIS
17090 Recognize JIS characters.
17091 @item C-SJIS
17092 Recognize SJIS characters.
17093 @item C-EUCJP
17094 Recognize EUCJP characters.
17095 @end table
17096
17097 If @env{LANG} is not defined, or if it has some other value, then the
17098 compiler will use mblen and mbtowc as defined by the default locale to
17099 recognize and translate multibyte characters.
17100 @end table
17101
17102 @noindent
17103 Some additional environments variables affect the behavior of the
17104 preprocessor.
17105
17106 @include cppenv.texi
17107
17108 @c man end
17109
17110 @node Precompiled Headers
17111 @section Using Precompiled Headers
17112 @cindex precompiled headers
17113 @cindex speed of compilation
17114
17115 Often large projects have many header files that are included in every
17116 source file.  The time the compiler takes to process these header files
17117 over and over again can account for nearly all of the time required to
17118 build the project.  To make builds faster, GCC allows users to
17119 `precompile' a header file; then, if builds can use the precompiled
17120 header file they will be much faster.
17121
17122 To create a precompiled header file, simply compile it as you would any
17123 other file, if necessary using the @option{-x} option to make the driver
17124 treat it as a C or C++ header file.  You will probably want to use a
17125 tool like @command{make} to keep the precompiled header up-to-date when
17126 the headers it contains change.
17127
17128 A precompiled header file will be searched for when @code{#include} is
17129 seen in the compilation.  As it searches for the included file
17130 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17131 compiler looks for a precompiled header in each directory just before it
17132 looks for the include file in that directory.  The name searched for is
17133 the name specified in the @code{#include} with @samp{.gch} appended.  If
17134 the precompiled header file can't be used, it is ignored.
17135
17136 For instance, if you have @code{#include "all.h"}, and you have
17137 @file{all.h.gch} in the same directory as @file{all.h}, then the
17138 precompiled header file will be used if possible, and the original
17139 header will be used otherwise.
17140
17141 Alternatively, you might decide to put the precompiled header file in a
17142 directory and use @option{-I} to ensure that directory is searched
17143 before (or instead of) the directory containing the original header.
17144 Then, if you want to check that the precompiled header file is always
17145 used, you can put a file of the same name as the original header in this
17146 directory containing an @code{#error} command.
17147
17148 This also works with @option{-include}.  So yet another way to use
17149 precompiled headers, good for projects not designed with precompiled
17150 header files in mind, is to simply take most of the header files used by
17151 a project, include them from another header file, precompile that header
17152 file, and @option{-include} the precompiled header.  If the header files
17153 have guards against multiple inclusion, they will be skipped because
17154 they've already been included (in the precompiled header).
17155
17156 If you need to precompile the same header file for different
17157 languages, targets, or compiler options, you can instead make a
17158 @emph{directory} named like @file{all.h.gch}, and put each precompiled
17159 header in the directory, perhaps using @option{-o}.  It doesn't matter
17160 what you call the files in the directory, every precompiled header in
17161 the directory will be considered.  The first precompiled header
17162 encountered in the directory that is valid for this compilation will
17163 be used; they're searched in no particular order.
17164
17165 There are many other possibilities, limited only by your imagination,
17166 good sense, and the constraints of your build system.
17167
17168 A precompiled header file can be used only when these conditions apply:
17169
17170 @itemize
17171 @item
17172 Only one precompiled header can be used in a particular compilation.
17173
17174 @item
17175 A precompiled header can't be used once the first C token is seen.  You
17176 can have preprocessor directives before a precompiled header; you can
17177 even include a precompiled header from inside another header, so long as
17178 there are no C tokens before the @code{#include}.
17179
17180 @item
17181 The precompiled header file must be produced for the same language as
17182 the current compilation.  You can't use a C precompiled header for a C++
17183 compilation.
17184
17185 @item
17186 The precompiled header file must have been produced by the same compiler
17187 binary as the current compilation is using.
17188
17189 @item
17190 Any macros defined before the precompiled header is included must
17191 either be defined in the same way as when the precompiled header was
17192 generated, or must not affect the precompiled header, which usually
17193 means that they don't appear in the precompiled header at all.
17194
17195 The @option{-D} option is one way to define a macro before a
17196 precompiled header is included; using a @code{#define} can also do it.
17197 There are also some options that define macros implicitly, like
17198 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
17199 defined this way.
17200
17201 @item If debugging information is output when using the precompiled
17202 header, using @option{-g} or similar, the same kind of debugging information
17203 must have been output when building the precompiled header.  However,
17204 a precompiled header built using @option{-g} can be used in a compilation
17205 when no debugging information is being output.
17206
17207 @item The same @option{-m} options must generally be used when building
17208 and using the precompiled header.  @xref{Submodel Options},
17209 for any cases where this rule is relaxed.
17210
17211 @item Each of the following options must be the same when building and using
17212 the precompiled header:
17213
17214 @gccoptlist{-fexceptions}
17215
17216 @item
17217 Some other command-line options starting with @option{-f},
17218 @option{-p}, or @option{-O} must be defined in the same way as when
17219 the precompiled header was generated.  At present, it's not clear
17220 which options are safe to change and which are not; the safest choice
17221 is to use exactly the same options when generating and using the
17222 precompiled header.  The following are known to be safe:
17223
17224 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
17225 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
17226 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
17227 -pedantic-errors}
17228
17229 @end itemize
17230
17231 For all of these except the last, the compiler will automatically
17232 ignore the precompiled header if the conditions aren't met.  If you
17233 find an option combination that doesn't work and doesn't cause the
17234 precompiled header to be ignored, please consider filing a bug report,
17235 see @ref{Bugs}.
17236
17237 If you do use differing options when generating and using the
17238 precompiled header, the actual behavior will be a mixture of the
17239 behavior for the options.  For instance, if you use @option{-g} to
17240 generate the precompiled header but not when using it, you may or may
17241 not get debugging information for routines in the precompiled header.