OSDN Git Service

doc: normalize 3DNow! spelling and spacing.
[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, 2010
3 @c Free Software Foundation, Inc.
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
6
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
11
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
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  -Wconversion-null  -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 @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 -fenable-icf-debug @gol
311 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
312 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
313 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
314 -ftest-coverage  -ftime-report -fvar-tracking @gol
315 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
316 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
317 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
318 -gvms  -gxcoff  -gxcoff+ @gol
319 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
320 -fdebug-prefix-map=@var{old}=@var{new} @gol
321 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
322 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
323 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
324 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
325 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
326 -print-sysroot -print-sysroot-headers-suffix @gol
327 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
328
329 @item Optimization Options
330 @xref{Optimize Options,,Options that Control Optimization}.
331 @gccoptlist{
332 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
333 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
334 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
335 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
336 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
337 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
338 -fdata-sections -fdce -fdce @gol
339 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
340 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
341 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
342 -fforward-propagate -ffunction-sections @gol
343 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
344 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
345 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
346 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
347 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
348 -fipa-type-escape -fira-algorithm=@var{algorithm} @gol
349 -fira-region=@var{region} -fira-coalesce @gol
350 -fira-loop-pressure -fno-ira-share-save-slots @gol
351 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
352 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
353 -floop-block -floop-interchange -floop-strip-mine -fgraphite-identity @gol
354 -floop-parallelize-all -flto -flto-compression-level -flto-report -fltrans @gol
355 -fltrans-output-list -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
356 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
357 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
358 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
359 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
360 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
361 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
362 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
363 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
364 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
365 -fprofile-generate=@var{path} @gol
366 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
367 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
368 -freorder-blocks-and-partition -freorder-functions @gol
369 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
370 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
371 -fsched-spec-load -fsched-spec-load-dangerous @gol
372 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
373 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
374 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
375 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
376 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
377 -fselective-scheduling -fselective-scheduling2 @gol
378 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
379 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
380 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
381 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
382 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
383 -ftree-copyrename -ftree-dce @gol
384 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
385 -ftree-phiprop -ftree-loop-distribution @gol
386 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
387 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
388 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
389 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
390 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
391 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
392 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
393 -fwhole-program -fwhopr -fwpa -fuse-linker-plugin @gol
394 --param @var{name}=@var{value}
395 -O  -O0  -O1  -O2  -O3  -Os}
396
397 @item Preprocessor Options
398 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
399 @gccoptlist{-A@var{question}=@var{answer} @gol
400 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
401 -C  -dD  -dI  -dM  -dN @gol
402 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
403 -idirafter @var{dir} @gol
404 -include @var{file}  -imacros @var{file} @gol
405 -iprefix @var{file}  -iwithprefix @var{dir} @gol
406 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
407 -imultilib @var{dir} -isysroot @var{dir} @gol
408 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
409 -P  -fworking-directory  -remap @gol
410 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
411 -Xpreprocessor @var{option}}
412
413 @item Assembler Option
414 @xref{Assembler Options,,Passing Options to the Assembler}.
415 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
416
417 @item Linker Options
418 @xref{Link Options,,Options for Linking}.
419 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
420 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
421 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
422 -shared-libgcc  -symbolic @gol
423 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
424 -u @var{symbol}}
425
426 @item Directory Options
427 @xref{Directory Options,,Options for Directory Search}.
428 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
429 -specs=@var{file}  -I- --sysroot=@var{dir}}
430
431 @item Target Options
432 @c I wrote this xref this way to avoid overfull hbox. -- rms
433 @xref{Target Options}.
434 @gccoptlist{-V @var{version}  -b @var{machine}}
435
436 @item Machine Dependent Options
437 @xref{Submodel Options,,Hardware Models and Configurations}.
438 @c This list is ordered alphanumerically by subsection name.
439 @c Try and put the significant identifier (CPU or system) first,
440 @c so users have a clue at guessing where the ones they want will be.
441
442 @emph{ARC Options}
443 @gccoptlist{-EB  -EL @gol
444 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
445 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
446
447 @emph{ARM Options}
448 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
449 -mabi=@var{name} @gol
450 -mapcs-stack-check  -mno-apcs-stack-check @gol
451 -mapcs-float  -mno-apcs-float @gol
452 -mapcs-reentrant  -mno-apcs-reentrant @gol
453 -msched-prolog  -mno-sched-prolog @gol
454 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
455 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
456 -mfp16-format=@var{name}
457 -mthumb-interwork  -mno-thumb-interwork @gol
458 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
459 -mstructure-size-boundary=@var{n} @gol
460 -mabort-on-noreturn @gol
461 -mlong-calls  -mno-long-calls @gol
462 -msingle-pic-base  -mno-single-pic-base @gol
463 -mpic-register=@var{reg} @gol
464 -mnop-fun-dllimport @gol
465 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
466 -mpoke-function-name @gol
467 -mthumb  -marm @gol
468 -mtpcs-frame  -mtpcs-leaf-frame @gol
469 -mcaller-super-interworking  -mcallee-super-interworking @gol
470 -mtp=@var{name} @gol
471 -mword-relocations @gol
472 -mfix-cortex-m3-ldrd}
473
474 @emph{AVR Options}
475 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
476 -mcall-prologues  -mtiny-stack  -mint8}
477
478 @emph{Blackfin Options}
479 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
480 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
481 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
482 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
483 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
484 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
485 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
486 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
487 -micplb}
488
489 @emph{CRIS Options}
490 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
491 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
492 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
493 -mstack-align  -mdata-align  -mconst-align @gol
494 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
495 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
496 -mmul-bug-workaround  -mno-mul-bug-workaround}
497
498 @emph{CRX Options}
499 @gccoptlist{-mmac -mpush-args}
500
501 @emph{Darwin Options}
502 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
503 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
504 -client_name  -compatibility_version  -current_version @gol
505 -dead_strip @gol
506 -dependency-file  -dylib_file  -dylinker_install_name @gol
507 -dynamic  -dynamiclib  -exported_symbols_list @gol
508 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
509 -force_flat_namespace  -headerpad_max_install_names @gol
510 -iframework @gol
511 -image_base  -init  -install_name  -keep_private_externs @gol
512 -multi_module  -multiply_defined  -multiply_defined_unused @gol
513 -noall_load   -no_dead_strip_inits_and_terms @gol
514 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
515 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
516 -private_bundle  -read_only_relocs  -sectalign @gol
517 -sectobjectsymbols  -whyload  -seg1addr @gol
518 -sectcreate  -sectobjectsymbols  -sectorder @gol
519 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
520 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
521 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
522 -single_module  -static  -sub_library  -sub_umbrella @gol
523 -twolevel_namespace  -umbrella  -undefined @gol
524 -unexported_symbols_list  -weak_reference_mismatches @gol
525 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
526 -mkernel -mone-byte-bool}
527
528 @emph{DEC Alpha Options}
529 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
530 -mieee  -mieee-with-inexact  -mieee-conformant @gol
531 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
532 -mtrap-precision=@var{mode}  -mbuild-constants @gol
533 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
534 -mbwx  -mmax  -mfix  -mcix @gol
535 -mfloat-vax  -mfloat-ieee @gol
536 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
537 -msmall-text  -mlarge-text @gol
538 -mmemory-latency=@var{time}}
539
540 @emph{DEC Alpha/VMS Options}
541 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
542
543 @emph{FR30 Options}
544 @gccoptlist{-msmall-model -mno-lsim}
545
546 @emph{FRV Options}
547 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
548 -mhard-float  -msoft-float @gol
549 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
550 -mdouble  -mno-double @gol
551 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
552 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
553 -mlinked-fp  -mlong-calls  -malign-labels @gol
554 -mlibrary-pic  -macc-4  -macc-8 @gol
555 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
556 -moptimize-membar -mno-optimize-membar @gol
557 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
558 -mvliw-branch  -mno-vliw-branch @gol
559 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
560 -mno-nested-cond-exec  -mtomcat-stats @gol
561 -mTLS -mtls @gol
562 -mcpu=@var{cpu}}
563
564 @emph{GNU/Linux Options}
565 @gccoptlist{-muclibc}
566
567 @emph{H8/300 Options}
568 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
569
570 @emph{HPPA Options}
571 @gccoptlist{-march=@var{architecture-type} @gol
572 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
573 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
574 -mfixed-range=@var{register-range} @gol
575 -mjump-in-delay -mlinker-opt -mlong-calls @gol
576 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
577 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
578 -mno-jump-in-delay  -mno-long-load-store @gol
579 -mno-portable-runtime  -mno-soft-float @gol
580 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
581 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
582 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
583 -munix=@var{unix-std}  -nolibdld  -static  -threads}
584
585 @emph{i386 and x86-64 Options}
586 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
587 -mfpmath=@var{unit} @gol
588 -masm=@var{dialect}  -mno-fancy-math-387 @gol
589 -mno-fp-ret-in-387  -msoft-float @gol
590 -mno-wide-multiply  -mrtd  -malign-double @gol
591 -mpreferred-stack-boundary=@var{num}
592 -mincoming-stack-boundary=@var{num}
593 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
594 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
595 -maes -mpclmul -mfused-madd @gol
596 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
597 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
598 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
599 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
600 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
601 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
602 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
603 -mcmodel=@var{code-model} -mabi=@var{name} @gol
604 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
605 -msse2avx}
606
607 @emph{IA-64 Options}
608 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
609 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
610 -mconstant-gp  -mauto-pic  -mfused-madd @gol
611 -minline-float-divide-min-latency @gol
612 -minline-float-divide-max-throughput @gol
613 -mno-inline-float-divide @gol
614 -minline-int-divide-min-latency @gol
615 -minline-int-divide-max-throughput  @gol
616 -mno-inline-int-divide @gol
617 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
618 -mno-inline-sqrt @gol
619 -mdwarf2-asm -mearly-stop-bits @gol
620 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
621 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
622 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
623 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
624 -msched-spec-ldc -msched-spec-control-ldc @gol
625 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
626 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
627 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
628 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
629
630 @emph{IA-64/VMS Options}
631 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
632
633 @emph{LM32 Options}
634 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
635 -msign-extend-enabled -muser-enabled}
636
637 @emph{M32R/D Options}
638 @gccoptlist{-m32r2 -m32rx -m32r @gol
639 -mdebug @gol
640 -malign-loops -mno-align-loops @gol
641 -missue-rate=@var{number} @gol
642 -mbranch-cost=@var{number} @gol
643 -mmodel=@var{code-size-model-type} @gol
644 -msdata=@var{sdata-type} @gol
645 -mno-flush-func -mflush-func=@var{name} @gol
646 -mno-flush-trap -mflush-trap=@var{number} @gol
647 -G @var{num}}
648
649 @emph{M32C Options}
650 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
651
652 @emph{M680x0 Options}
653 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
654 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
655 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
656 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
657 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
658 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
659 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
660 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
661 -mxgot -mno-xgot}
662
663 @emph{M68hc1x Options}
664 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
665 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
666 -msoft-reg-count=@var{count}}
667
668 @emph{MCore Options}
669 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
670 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
671 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
672 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
673 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
674
675 @emph{MeP Options}
676 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
677 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
678 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
679 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
680 -mtiny=@var{n}}
681
682 @emph{MIPS Options}
683 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
684 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
685 -mips64  -mips64r2 @gol
686 -mips16  -mno-mips16  -mflip-mips16 @gol
687 -minterlink-mips16  -mno-interlink-mips16 @gol
688 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
689 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
690 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
691 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
692 -mfpu=@var{fpu-type} @gol
693 -msmartmips  -mno-smartmips @gol
694 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
695 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
696 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
697 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
698 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
699 -membedded-data  -mno-embedded-data @gol
700 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
701 -mcode-readable=@var{setting} @gol
702 -msplit-addresses  -mno-split-addresses @gol
703 -mexplicit-relocs  -mno-explicit-relocs @gol
704 -mcheck-zero-division  -mno-check-zero-division @gol
705 -mdivide-traps  -mdivide-breaks @gol
706 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
707 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
708 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
709 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
710 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
711 -mflush-func=@var{func}  -mno-flush-func @gol
712 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
713 -mfp-exceptions -mno-fp-exceptions @gol
714 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
715 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
716
717 @emph{MMIX Options}
718 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
719 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
720 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
721 -mno-base-addresses  -msingle-exit  -mno-single-exit}
722
723 @emph{MN10300 Options}
724 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
725 -mam33  -mno-am33 @gol
726 -mam33-2  -mno-am33-2 @gol
727 -mreturn-pointer-on-d0 @gol
728 -mno-crt0  -mrelax}
729
730 @emph{PDP-11 Options}
731 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
732 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
733 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
734 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
735 -mbranch-expensive  -mbranch-cheap @gol
736 -msplit  -mno-split  -munix-asm  -mdec-asm}
737
738 @emph{picoChip Options}
739 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
740 -msymbol-as-address -mno-inefficient-warnings}
741
742 @emph{PowerPC Options}
743 See RS/6000 and PowerPC Options.
744
745 @emph{RS/6000 and PowerPC Options}
746 @gccoptlist{-mcpu=@var{cpu-type} @gol
747 -mtune=@var{cpu-type} @gol
748 -mpower  -mno-power  -mpower2  -mno-power2 @gol
749 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
750 -maltivec  -mno-altivec @gol
751 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
752 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
753 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
754 -mfprnd  -mno-fprnd @gol
755 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
756 -mnew-mnemonics  -mold-mnemonics @gol
757 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
758 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
759 -malign-power  -malign-natural @gol
760 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
761 -msingle-float -mdouble-float -msimple-fpu @gol
762 -mstring  -mno-string  -mupdate  -mno-update @gol
763 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
764 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
765 -mstrict-align  -mno-strict-align  -mrelocatable @gol
766 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
767 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
768 -mdynamic-no-pic  -maltivec -mswdiv @gol
769 -mprioritize-restricted-insns=@var{priority} @gol
770 -msched-costly-dep=@var{dependence_type} @gol
771 -minsert-sched-nops=@var{scheme} @gol
772 -mcall-sysv  -mcall-netbsd @gol
773 -maix-struct-return  -msvr4-struct-return @gol
774 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
775 -misel -mno-isel @gol
776 -misel=yes  -misel=no @gol
777 -mspe -mno-spe @gol
778 -mspe=yes  -mspe=no @gol
779 -mpaired @gol
780 -mgen-cell-microcode -mwarn-cell-microcode @gol
781 -mvrsave -mno-vrsave @gol
782 -mmulhw -mno-mulhw @gol
783 -mdlmzb -mno-dlmzb @gol
784 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
785 -mprototype  -mno-prototype @gol
786 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
787 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
788
789 @emph{RX Options}
790 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
791 -mcpu= -patch=@gol
792 -mbig-endian-data -mlittle-endian-data @gol
793 -msmall-data @gol
794 -msim  -mno-sim@gol
795 -mas100-syntax -mno-as100-syntax@gol
796 -mrelax@gol
797 -mmax-constant-size=@gol
798 -mint-register=@gol
799 -msave-acc-in-interrupts}
800
801 @emph{S/390 and zSeries Options}
802 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
803 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
804 -mlong-double-64 -mlong-double-128 @gol
805 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
806 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
807 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
808 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
809 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
810
811 @emph{Score Options}
812 @gccoptlist{-meb -mel @gol
813 -mnhwloop @gol
814 -muls @gol
815 -mmac @gol
816 -mscore5 -mscore5u -mscore7 -mscore7d}
817
818 @emph{SH Options}
819 @gccoptlist{-m1  -m2  -m2e @gol
820 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
821 -m3  -m3e @gol
822 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
823 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
824 -m5-64media  -m5-64media-nofpu @gol
825 -m5-32media  -m5-32media-nofpu @gol
826 -m5-compact  -m5-compact-nofpu @gol
827 -mb  -ml  -mdalign  -mrelax @gol
828 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
829 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
830 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
831 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
832 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
833 -minvalid-symbols}
834
835 @emph{SPARC Options}
836 @gccoptlist{-mcpu=@var{cpu-type} @gol
837 -mtune=@var{cpu-type} @gol
838 -mcmodel=@var{code-model} @gol
839 -m32  -m64  -mapp-regs  -mno-app-regs @gol
840 -mfaster-structs  -mno-faster-structs @gol
841 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
842 -mhard-quad-float  -msoft-quad-float @gol
843 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
844 -mstack-bias  -mno-stack-bias @gol
845 -munaligned-doubles  -mno-unaligned-doubles @gol
846 -mv8plus  -mno-v8plus  -mvis  -mno-vis
847 -threads -pthreads -pthread}
848
849 @emph{SPU Options}
850 @gccoptlist{-mwarn-reloc -merror-reloc @gol
851 -msafe-dma -munsafe-dma @gol
852 -mbranch-hints @gol
853 -msmall-mem -mlarge-mem -mstdmain @gol
854 -mfixed-range=@var{register-range} @gol
855 -mea32 -mea64 @gol
856 -maddress-space-conversion -mno-address-space-conversion @gol
857 -mcache-size=@var{cache-size} @gol
858 -matomic-updates -mno-atomic-updates}
859
860 @emph{System V Options}
861 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
862
863 @emph{V850 Options}
864 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
865 -mprolog-function  -mno-prolog-function  -mspace @gol
866 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
867 -mapp-regs  -mno-app-regs @gol
868 -mdisable-callt  -mno-disable-callt @gol
869 -mv850e1 @gol
870 -mv850e @gol
871 -mv850  -mbig-switch}
872
873 @emph{VAX Options}
874 @gccoptlist{-mg  -mgnu  -munix}
875
876 @emph{VxWorks Options}
877 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
878 -Xbind-lazy  -Xbind-now}
879
880 @emph{x86-64 Options}
881 See i386 and x86-64 Options.
882
883 @emph{i386 and x86-64 Windows Options}
884 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
885 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
886 -fno-set-stack-executable}
887
888 @emph{Xstormy16 Options}
889 @gccoptlist{-msim}
890
891 @emph{Xtensa Options}
892 @gccoptlist{-mconst16 -mno-const16 @gol
893 -mfused-madd  -mno-fused-madd @gol
894 -mserialize-volatile  -mno-serialize-volatile @gol
895 -mtext-section-literals  -mno-text-section-literals @gol
896 -mtarget-align  -mno-target-align @gol
897 -mlongcalls  -mno-longcalls}
898
899 @emph{zSeries Options}
900 See S/390 and zSeries Options.
901
902 @item Code Generation Options
903 @xref{Code Gen Options,,Options for Code Generation Conventions}.
904 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
905 -ffixed-@var{reg}  -fexceptions @gol
906 -fnon-call-exceptions  -funwind-tables @gol
907 -fasynchronous-unwind-tables @gol
908 -finhibit-size-directive  -finstrument-functions @gol
909 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
910 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
911 -fno-common  -fno-ident @gol
912 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
913 -fno-jump-tables @gol
914 -frecord-gcc-switches @gol
915 -freg-struct-return  -fshort-enums @gol
916 -fshort-double  -fshort-wchar @gol
917 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
918 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
919 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
920 -fargument-noalias-global  -fargument-noalias-anything @gol
921 -fleading-underscore  -ftls-model=@var{model} @gol
922 -ftrapv  -fwrapv  -fbounds-check @gol
923 -fvisibility}
924 @end table
925
926 @menu
927 * Overall Options::     Controlling the kind of output:
928                         an executable, object files, assembler files,
929                         or preprocessed source.
930 * C Dialect Options::   Controlling the variant of C language compiled.
931 * C++ Dialect Options:: Variations on C++.
932 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
933                         and Objective-C++.
934 * Language Independent Options:: Controlling how diagnostics should be
935                         formatted.
936 * Warning Options::     How picky should the compiler be?
937 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
938 * Optimize Options::    How much optimization?
939 * Preprocessor Options:: Controlling header files and macro definitions.
940                          Also, getting dependency information for Make.
941 * Assembler Options::   Passing options to the assembler.
942 * Link Options::        Specifying libraries and so on.
943 * Directory Options::   Where to find header files and libraries.
944                         Where to find the compiler executable files.
945 * Spec Files::          How to pass switches to sub-processes.
946 * Target Options::      Running a cross-compiler, or an old version of GCC.
947 @end menu
948
949 @node Overall Options
950 @section Options Controlling the Kind of Output
951
952 Compilation can involve up to four stages: preprocessing, compilation
953 proper, assembly and linking, always in that order.  GCC is capable of
954 preprocessing and compiling several files either into several
955 assembler input files, or into one assembler input file; then each
956 assembler input file produces an object file, and linking combines all
957 the object files (those newly compiled, and those specified as input)
958 into an executable file.
959
960 @cindex file name suffix
961 For any given input file, the file name suffix determines what kind of
962 compilation is done:
963
964 @table @gcctabopt
965 @item @var{file}.c
966 C source code which must be preprocessed.
967
968 @item @var{file}.i
969 C source code which should not be preprocessed.
970
971 @item @var{file}.ii
972 C++ source code which should not be preprocessed.
973
974 @item @var{file}.m
975 Objective-C source code.  Note that you must link with the @file{libobjc}
976 library to make an Objective-C program work.
977
978 @item @var{file}.mi
979 Objective-C source code which should not be preprocessed.
980
981 @item @var{file}.mm
982 @itemx @var{file}.M
983 Objective-C++ source code.  Note that you must link with the @file{libobjc}
984 library to make an Objective-C++ program work.  Note that @samp{.M} refers
985 to a literal capital M@.
986
987 @item @var{file}.mii
988 Objective-C++ source code which should not be preprocessed.
989
990 @item @var{file}.h
991 C, C++, Objective-C or Objective-C++ header file to be turned into a
992 precompiled header.
993
994 @item @var{file}.cc
995 @itemx @var{file}.cp
996 @itemx @var{file}.cxx
997 @itemx @var{file}.cpp
998 @itemx @var{file}.CPP
999 @itemx @var{file}.c++
1000 @itemx @var{file}.C
1001 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
1002 the last two letters must both be literally @samp{x}.  Likewise,
1003 @samp{.C} refers to a literal capital C@.
1004
1005 @item @var{file}.mm
1006 @itemx @var{file}.M
1007 Objective-C++ source code which must be preprocessed.
1008
1009 @item @var{file}.mii
1010 Objective-C++ source code which should not be preprocessed.
1011
1012 @item @var{file}.hh
1013 @itemx @var{file}.H
1014 @itemx @var{file}.hp
1015 @itemx @var{file}.hxx
1016 @itemx @var{file}.hpp
1017 @itemx @var{file}.HPP
1018 @itemx @var{file}.h++
1019 @itemx @var{file}.tcc
1020 C++ header file to be turned into a precompiled header.
1021
1022 @item @var{file}.f
1023 @itemx @var{file}.for
1024 @itemx @var{file}.ftn
1025 Fixed form Fortran source code which should not be preprocessed.
1026
1027 @item @var{file}.F
1028 @itemx @var{file}.FOR
1029 @itemx @var{file}.fpp
1030 @itemx @var{file}.FPP
1031 @itemx @var{file}.FTN
1032 Fixed form Fortran source code which must be preprocessed (with the traditional
1033 preprocessor).
1034
1035 @item @var{file}.f90
1036 @itemx @var{file}.f95
1037 @itemx @var{file}.f03
1038 @itemx @var{file}.f08
1039 Free form Fortran source code which should not be preprocessed.
1040
1041 @item @var{file}.F90
1042 @itemx @var{file}.F95
1043 @itemx @var{file}.F03
1044 @itemx @var{file}.F08
1045 Free form Fortran source code which must be preprocessed (with the
1046 traditional preprocessor).
1047
1048 @c FIXME: Descriptions of Java file types.
1049 @c @var{file}.java
1050 @c @var{file}.class
1051 @c @var{file}.zip
1052 @c @var{file}.jar
1053
1054 @item @var{file}.ads
1055 Ada source code file which contains a library unit declaration (a
1056 declaration of a package, subprogram, or generic, or a generic
1057 instantiation), or a library unit renaming declaration (a package,
1058 generic, or subprogram renaming declaration).  Such files are also
1059 called @dfn{specs}.
1060
1061 @item @var{file}.adb
1062 Ada source code file containing a library unit body (a subprogram or
1063 package body).  Such files are also called @dfn{bodies}.
1064
1065 @c GCC also knows about some suffixes for languages not yet included:
1066 @c Pascal:
1067 @c @var{file}.p
1068 @c @var{file}.pas
1069 @c Ratfor:
1070 @c @var{file}.r
1071
1072 @item @var{file}.s
1073 Assembler code.
1074
1075 @item @var{file}.S
1076 @itemx @var{file}.sx
1077 Assembler code which must be preprocessed.
1078
1079 @item @var{other}
1080 An object file to be fed straight into linking.
1081 Any file name with no recognized suffix is treated this way.
1082 @end table
1083
1084 @opindex x
1085 You can specify the input language explicitly with the @option{-x} option:
1086
1087 @table @gcctabopt
1088 @item -x @var{language}
1089 Specify explicitly the @var{language} for the following input files
1090 (rather than letting the compiler choose a default based on the file
1091 name suffix).  This option applies to all following input files until
1092 the next @option{-x} option.  Possible values for @var{language} are:
1093 @smallexample
1094 c  c-header  c-cpp-output
1095 c++  c++-header  c++-cpp-output
1096 objective-c  objective-c-header  objective-c-cpp-output
1097 objective-c++ objective-c++-header objective-c++-cpp-output
1098 assembler  assembler-with-cpp
1099 ada
1100 f77  f77-cpp-input f95  f95-cpp-input
1101 java
1102 @end smallexample
1103
1104 @item -x none
1105 Turn off any specification of a language, so that subsequent files are
1106 handled according to their file name suffixes (as they are if @option{-x}
1107 has not been used at all).
1108
1109 @item -pass-exit-codes
1110 @opindex pass-exit-codes
1111 Normally the @command{gcc} program will exit with the code of 1 if any
1112 phase of the compiler returns a non-success return code.  If you specify
1113 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1114 numerically highest error produced by any phase that returned an error
1115 indication.  The C, C++, and Fortran frontends return 4, if an internal
1116 compiler error is encountered.
1117 @end table
1118
1119 If you only want some of the stages of compilation, you can use
1120 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1121 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1122 @command{gcc} is to stop.  Note that some combinations (for example,
1123 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1124
1125 @table @gcctabopt
1126 @item -c
1127 @opindex c
1128 Compile or assemble the source files, but do not link.  The linking
1129 stage simply is not done.  The ultimate output is in the form of an
1130 object file for each source file.
1131
1132 By default, the object file name for a source file is made by replacing
1133 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1134
1135 Unrecognized input files, not requiring compilation or assembly, are
1136 ignored.
1137
1138 @item -S
1139 @opindex S
1140 Stop after the stage of compilation proper; do not assemble.  The output
1141 is in the form of an assembler code file for each non-assembler input
1142 file specified.
1143
1144 By default, the assembler file name for a source file is made by
1145 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1146
1147 Input files that don't require compilation are ignored.
1148
1149 @item -E
1150 @opindex E
1151 Stop after the preprocessing stage; do not run the compiler proper.  The
1152 output is in the form of preprocessed source code, which is sent to the
1153 standard output.
1154
1155 Input files which don't require preprocessing are ignored.
1156
1157 @cindex output file option
1158 @item -o @var{file}
1159 @opindex o
1160 Place output in file @var{file}.  This applies regardless to whatever
1161 sort of output is being produced, whether it be an executable file,
1162 an object file, an assembler file or preprocessed C code.
1163
1164 If @option{-o} is not specified, the default is to put an executable
1165 file in @file{a.out}, the object file for
1166 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1167 assembler file in @file{@var{source}.s}, a precompiled header file in
1168 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1169 standard output.
1170
1171 @item -v
1172 @opindex v
1173 Print (on standard error output) the commands executed to run the stages
1174 of compilation.  Also print the version number of the compiler driver
1175 program and of the preprocessor and the compiler proper.
1176
1177 @item -###
1178 @opindex ###
1179 Like @option{-v} except the commands are not executed and all command
1180 arguments are quoted.  This is useful for shell scripts to capture the
1181 driver-generated command lines.
1182
1183 @item -pipe
1184 @opindex pipe
1185 Use pipes rather than temporary files for communication between the
1186 various stages of compilation.  This fails to work on some systems where
1187 the assembler is unable to read from a pipe; but the GNU assembler has
1188 no trouble.
1189
1190 @item -combine
1191 @opindex combine
1192 If you are compiling multiple source files, this option tells the driver
1193 to pass all the source files to the compiler at once (for those
1194 languages for which the compiler can handle this).  This will allow
1195 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1196 language for which this is supported is C@.  If you pass source files for
1197 multiple languages to the driver, using this option, the driver will invoke
1198 the compiler(s) that support IMA once each, passing each compiler all the
1199 source files appropriate for it.  For those languages that do not support
1200 IMA this option will be ignored, and the compiler will be invoked once for
1201 each source file in that language.  If you use this option in conjunction
1202 with @option{-save-temps}, the compiler will generate multiple
1203 pre-processed files
1204 (one for each source file), but only one (combined) @file{.o} or
1205 @file{.s} file.
1206
1207 @item --help
1208 @opindex help
1209 Print (on the standard output) a description of the command line options
1210 understood by @command{gcc}.  If the @option{-v} option is also specified
1211 then @option{--help} will also be passed on to the various processes
1212 invoked by @command{gcc}, so that they can display the command line options
1213 they accept.  If the @option{-Wextra} option has also been specified
1214 (prior to the @option{--help} option), then command line options which
1215 have no documentation associated with them will also be displayed.
1216
1217 @item --target-help
1218 @opindex target-help
1219 Print (on the standard output) a description of target-specific command
1220 line options for each tool.  For some targets extra target-specific
1221 information may also be printed.
1222
1223 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1224 Print (on the standard output) a description of the command line
1225 options understood by the compiler that fit into all specified classes
1226 and qualifiers.  These are the supported classes:
1227
1228 @table @asis
1229 @item @samp{optimizers}
1230 This will display all of the optimization options supported by the
1231 compiler.
1232
1233 @item @samp{warnings}
1234 This will display all of the options controlling warning messages
1235 produced by the compiler.
1236
1237 @item @samp{target}
1238 This will display target-specific options.  Unlike the
1239 @option{--target-help} option however, target-specific options of the
1240 linker and assembler will not be displayed.  This is because those
1241 tools do not currently support the extended @option{--help=} syntax.
1242
1243 @item @samp{params}
1244 This will display the values recognized by the @option{--param}
1245 option.
1246
1247 @item @var{language}
1248 This will display the options supported for @var{language}, where
1249 @var{language} is the name of one of the languages supported in this
1250 version of GCC.
1251
1252 @item @samp{common}
1253 This will display the options that are common to all languages.
1254 @end table
1255
1256 These are the supported qualifiers:
1257
1258 @table @asis
1259 @item @samp{undocumented}
1260 Display only those options which are undocumented.
1261
1262 @item @samp{joined}
1263 Display options which take an argument that appears after an equal
1264 sign in the same continuous piece of text, such as:
1265 @samp{--help=target}.
1266
1267 @item @samp{separate}
1268 Display options which take an argument that appears as a separate word
1269 following the original option, such as: @samp{-o output-file}.
1270 @end table
1271
1272 Thus for example to display all the undocumented target-specific
1273 switches supported by the compiler the following can be used:
1274
1275 @smallexample
1276 --help=target,undocumented
1277 @end smallexample
1278
1279 The sense of a qualifier can be inverted by prefixing it with the
1280 @samp{^} character, so for example to display all binary warning
1281 options (i.e., ones that are either on or off and that do not take an
1282 argument), which have a description the following can be used:
1283
1284 @smallexample
1285 --help=warnings,^joined,^undocumented
1286 @end smallexample
1287
1288 The argument to @option{--help=} should not consist solely of inverted
1289 qualifiers.
1290
1291 Combining several classes is possible, although this usually
1292 restricts the output by so much that there is nothing to display.  One
1293 case where it does work however is when one of the classes is
1294 @var{target}.  So for example to display all the target-specific
1295 optimization options the following can be used:
1296
1297 @smallexample
1298 --help=target,optimizers
1299 @end smallexample
1300
1301 The @option{--help=} option can be repeated on the command line.  Each
1302 successive use will display its requested class of options, skipping
1303 those that have already been displayed.
1304
1305 If the @option{-Q} option appears on the command line before the
1306 @option{--help=} option, then the descriptive text displayed by
1307 @option{--help=} is changed.  Instead of describing the displayed
1308 options, an indication is given as to whether the option is enabled,
1309 disabled or set to a specific value (assuming that the compiler
1310 knows this at the point where the @option{--help=} option is used).
1311
1312 Here is a truncated example from the ARM port of @command{gcc}:
1313
1314 @smallexample
1315   % gcc -Q -mabi=2 --help=target -c
1316   The following options are target specific:
1317   -mabi=                                2
1318   -mabort-on-noreturn                   [disabled]
1319   -mapcs                                [disabled]
1320 @end smallexample
1321
1322 The output is sensitive to the effects of previous command line
1323 options, so for example it is possible to find out which optimizations
1324 are enabled at @option{-O2} by using:
1325
1326 @smallexample
1327 -Q -O2 --help=optimizers
1328 @end smallexample
1329
1330 Alternatively you can discover which binary optimizations are enabled
1331 by @option{-O3} by using:
1332
1333 @smallexample
1334 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1335 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1336 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1337 @end smallexample
1338
1339 @item -no-canonical-prefixes
1340 @opindex no-canonical-prefixes
1341 Do not expand any symbolic links, resolve references to @samp{/../}
1342 or @samp{/./}, or make the path absolute when generating a relative
1343 prefix.
1344
1345 @item --version
1346 @opindex version
1347 Display the version number and copyrights of the invoked GCC@.
1348
1349 @item -wrapper
1350 @opindex wrapper
1351 Invoke all subcommands under a wrapper program. It takes a single
1352 comma separated list as an argument, which will be used to invoke
1353 the wrapper:
1354
1355 @smallexample
1356 gcc -c t.c -wrapper gdb,--args
1357 @end smallexample
1358
1359 This will invoke all subprograms of gcc under "gdb --args",
1360 thus cc1 invocation will be "gdb --args cc1 ...".
1361
1362 @item -fplugin=@var{name}.so
1363 Load the plugin code in file @var{name}.so, assumed to be a
1364 shared object to be dlopen'd by the compiler.  The base name of
1365 the shared object file is used to identify the plugin for the
1366 purposes of argument parsing (See
1367 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1368 Each plugin should define the callback functions specified in the
1369 Plugins API.
1370
1371 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1372 Define an argument called @var{key} with a value of @var{value}
1373 for the plugin called @var{name}.
1374
1375 @include @value{srcdir}/../libiberty/at-file.texi
1376 @end table
1377
1378 @node Invoking G++
1379 @section Compiling C++ Programs
1380
1381 @cindex suffixes for C++ source
1382 @cindex C++ source file suffixes
1383 C++ source files conventionally use one of the suffixes @samp{.C},
1384 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1385 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1386 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1387 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1388 files with these names and compiles them as C++ programs even if you
1389 call the compiler the same way as for compiling C programs (usually
1390 with the name @command{gcc}).
1391
1392 @findex g++
1393 @findex c++
1394 However, the use of @command{gcc} does not add the C++ library.
1395 @command{g++} is a program that calls GCC and treats @samp{.c},
1396 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1397 files unless @option{-x} is used, and automatically specifies linking
1398 against the C++ library.  This program is also useful when
1399 precompiling a C header file with a @samp{.h} extension for use in C++
1400 compilations.  On many systems, @command{g++} is also installed with
1401 the name @command{c++}.
1402
1403 @cindex invoking @command{g++}
1404 When you compile C++ programs, you may specify many of the same
1405 command-line options that you use for compiling programs in any
1406 language; or command-line options meaningful for C and related
1407 languages; or options that are meaningful only for C++ programs.
1408 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1409 explanations of options for languages related to C@.
1410 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1411 explanations of options that are meaningful only for C++ programs.
1412
1413 @node C Dialect Options
1414 @section Options Controlling C Dialect
1415 @cindex dialect options
1416 @cindex language dialect options
1417 @cindex options, dialect
1418
1419 The following options control the dialect of C (or languages derived
1420 from C, such as C++, Objective-C and Objective-C++) that the compiler
1421 accepts:
1422
1423 @table @gcctabopt
1424 @cindex ANSI support
1425 @cindex ISO support
1426 @item -ansi
1427 @opindex ansi
1428 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1429 equivalent to @samp{-std=c++98}.
1430
1431 This turns off certain features of GCC that are incompatible with ISO
1432 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1433 such as the @code{asm} and @code{typeof} keywords, and
1434 predefined macros such as @code{unix} and @code{vax} that identify the
1435 type of system you are using.  It also enables the undesirable and
1436 rarely used ISO trigraph feature.  For the C compiler,
1437 it disables recognition of C++ style @samp{//} comments as well as
1438 the @code{inline} keyword.
1439
1440 The alternate keywords @code{__asm__}, @code{__extension__},
1441 @code{__inline__} and @code{__typeof__} continue to work despite
1442 @option{-ansi}.  You would not want to use them in an ISO C program, of
1443 course, but it is useful to put them in header files that might be included
1444 in compilations done with @option{-ansi}.  Alternate predefined macros
1445 such as @code{__unix__} and @code{__vax__} are also available, with or
1446 without @option{-ansi}.
1447
1448 The @option{-ansi} option does not cause non-ISO programs to be
1449 rejected gratuitously.  For that, @option{-pedantic} is required in
1450 addition to @option{-ansi}.  @xref{Warning Options}.
1451
1452 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1453 option is used.  Some header files may notice this macro and refrain
1454 from declaring certain functions or defining certain macros that the
1455 ISO standard doesn't call for; this is to avoid interfering with any
1456 programs that might use these names for other things.
1457
1458 Functions that would normally be built in but do not have semantics
1459 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1460 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1461 built-in functions provided by GCC}, for details of the functions
1462 affected.
1463
1464 @item -std=
1465 @opindex std
1466 Determine the language standard. @xref{Standards,,Language Standards
1467 Supported by GCC}, for details of these standard versions.  This option
1468 is currently only supported when compiling C or C++.
1469
1470 The compiler can accept several base standards, such as @samp{c90} or
1471 @samp{c++98}, and GNU dialects of those standards, such as
1472 @samp{gnu90} or @samp{gnu++98}.  By specifying a base standard, the
1473 compiler will accept all programs following that standard and those
1474 using GNU extensions that do not contradict it.  For example,
1475 @samp{-std=c90} turns off certain features of GCC that are
1476 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1477 keywords, but not other GNU extensions that do not have a meaning in
1478 ISO C90, such as omitting the middle term of a @code{?:}
1479 expression. On the other hand, by specifying a GNU dialect of a
1480 standard, all features the compiler support are enabled, even when
1481 those features change the meaning of the base standard and some
1482 strict-conforming programs may be rejected.  The particular standard
1483 is used by @option{-pedantic} to identify which features are GNU
1484 extensions given that version of the standard. For example
1485 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1486 comments, while @samp{-std=gnu99 -pedantic} would not.
1487
1488 A value for this option must be provided; possible values are
1489
1490 @table @samp
1491 @item c90
1492 @itemx c89
1493 @itemx iso9899:1990
1494 Support all ISO C90 programs (certain GNU extensions that conflict
1495 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1496
1497 @item iso9899:199409
1498 ISO C90 as modified in amendment 1.
1499
1500 @item c99
1501 @itemx c9x
1502 @itemx iso9899:1999
1503 @itemx iso9899:199x
1504 ISO C99.  Note that this standard is not yet fully supported; see
1505 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1506 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1507
1508 @item gnu90
1509 @itemx gnu89
1510 GNU dialect of ISO C90 (including some C99 features). This
1511 is the default for C code.
1512
1513 @item gnu99
1514 @itemx gnu9x
1515 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1516 this will become the default.  The name @samp{gnu9x} is deprecated.
1517
1518 @item c++98
1519 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1520 C++ code.
1521
1522 @item gnu++98
1523 GNU dialect of @option{-std=c++98}.  This is the default for
1524 C++ code.
1525
1526 @item c++0x
1527 The working draft of the upcoming ISO C++0x standard. This option
1528 enables experimental features that are likely to be included in
1529 C++0x. The working draft is constantly changing, and any feature that is
1530 enabled by this flag may be removed from future versions of GCC if it is
1531 not part of the C++0x standard.
1532
1533 @item gnu++0x
1534 GNU dialect of @option{-std=c++0x}. This option enables
1535 experimental features that may be removed in future versions of GCC.
1536 @end table
1537
1538 @item -fgnu89-inline
1539 @opindex fgnu89-inline
1540 The option @option{-fgnu89-inline} tells GCC to use the traditional
1541 GNU semantics for @code{inline} functions when in C99 mode.
1542 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1543 is accepted and ignored by GCC versions 4.1.3 up to but not including
1544 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1545 C99 mode.  Using this option is roughly equivalent to adding the
1546 @code{gnu_inline} function attribute to all inline functions
1547 (@pxref{Function Attributes}).
1548
1549 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1550 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1551 specifies the default behavior).  This option was first supported in
1552 GCC 4.3.  This option is not supported in @option{-std=c90} or
1553 @option{-std=gnu90} mode.
1554
1555 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1556 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1557 in effect for @code{inline} functions.  @xref{Common Predefined
1558 Macros,,,cpp,The C Preprocessor}.
1559
1560 @item -aux-info @var{filename}
1561 @opindex aux-info
1562 Output to the given filename prototyped declarations for all functions
1563 declared and/or defined in a translation unit, including those in header
1564 files.  This option is silently ignored in any language other than C@.
1565
1566 Besides declarations, the file indicates, in comments, the origin of
1567 each declaration (source file and line), whether the declaration was
1568 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1569 @samp{O} for old, respectively, in the first character after the line
1570 number and the colon), and whether it came from a declaration or a
1571 definition (@samp{C} or @samp{F}, respectively, in the following
1572 character).  In the case of function definitions, a K&R-style list of
1573 arguments followed by their declarations is also provided, inside
1574 comments, after the declaration.
1575
1576 @item -fno-asm
1577 @opindex fno-asm
1578 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1579 keyword, so that code can use these words as identifiers.  You can use
1580 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1581 instead.  @option{-ansi} implies @option{-fno-asm}.
1582
1583 In C++, this switch only affects the @code{typeof} keyword, since
1584 @code{asm} and @code{inline} are standard keywords.  You may want to
1585 use the @option{-fno-gnu-keywords} flag instead, which has the same
1586 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1587 switch only affects the @code{asm} and @code{typeof} keywords, since
1588 @code{inline} is a standard keyword in ISO C99.
1589
1590 @item -fno-builtin
1591 @itemx -fno-builtin-@var{function}
1592 @opindex fno-builtin
1593 @cindex built-in functions
1594 Don't recognize built-in functions that do not begin with
1595 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1596 functions provided by GCC}, for details of the functions affected,
1597 including those which are not built-in functions when @option{-ansi} or
1598 @option{-std} options for strict ISO C conformance are used because they
1599 do not have an ISO standard meaning.
1600
1601 GCC normally generates special code to handle certain built-in functions
1602 more efficiently; for instance, calls to @code{alloca} may become single
1603 instructions that adjust the stack directly, and calls to @code{memcpy}
1604 may become inline copy loops.  The resulting code is often both smaller
1605 and faster, but since the function calls no longer appear as such, you
1606 cannot set a breakpoint on those calls, nor can you change the behavior
1607 of the functions by linking with a different library.  In addition,
1608 when a function is recognized as a built-in function, GCC may use
1609 information about that function to warn about problems with calls to
1610 that function, or to generate more efficient code, even if the
1611 resulting code still contains calls to that function.  For example,
1612 warnings are given with @option{-Wformat} for bad calls to
1613 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1614 known not to modify global memory.
1615
1616 With the @option{-fno-builtin-@var{function}} option
1617 only the built-in function @var{function} is
1618 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1619 function is named that is not built-in in this version of GCC, this
1620 option is ignored.  There is no corresponding
1621 @option{-fbuiltin-@var{function}} option; if you wish to enable
1622 built-in functions selectively when using @option{-fno-builtin} or
1623 @option{-ffreestanding}, you may define macros such as:
1624
1625 @smallexample
1626 #define abs(n)          __builtin_abs ((n))
1627 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1628 @end smallexample
1629
1630 @item -fhosted
1631 @opindex fhosted
1632 @cindex hosted environment
1633
1634 Assert that compilation takes place in a hosted environment.  This implies
1635 @option{-fbuiltin}.  A hosted environment is one in which the
1636 entire standard library is available, and in which @code{main} has a return
1637 type of @code{int}.  Examples are nearly everything except a kernel.
1638 This is equivalent to @option{-fno-freestanding}.
1639
1640 @item -ffreestanding
1641 @opindex ffreestanding
1642 @cindex hosted environment
1643
1644 Assert that compilation takes place in a freestanding environment.  This
1645 implies @option{-fno-builtin}.  A freestanding environment
1646 is one in which the standard library may not exist, and program startup may
1647 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1648 This is equivalent to @option{-fno-hosted}.
1649
1650 @xref{Standards,,Language Standards Supported by GCC}, for details of
1651 freestanding and hosted environments.
1652
1653 @item -fopenmp
1654 @opindex fopenmp
1655 @cindex openmp parallel
1656 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1657 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1658 compiler generates parallel code according to the OpenMP Application
1659 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1660 implies @option{-pthread}, and thus is only supported on targets that
1661 have support for @option{-pthread}.
1662
1663 @item -fms-extensions
1664 @opindex fms-extensions
1665 Accept some non-standard constructs used in Microsoft header files.
1666
1667 Some cases of unnamed fields in structures and unions are only
1668 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1669 fields within structs/unions}, for details.
1670
1671 @item -trigraphs
1672 @opindex trigraphs
1673 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1674 options for strict ISO C conformance) implies @option{-trigraphs}.
1675
1676 @item -no-integrated-cpp
1677 @opindex no-integrated-cpp
1678 Performs a compilation in two passes: preprocessing and compiling.  This
1679 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1680 @option{-B} option.  The user supplied compilation step can then add in
1681 an additional preprocessing step after normal preprocessing but before
1682 compiling.  The default is to use the integrated cpp (internal cpp)
1683
1684 The semantics of this option will change if "cc1", "cc1plus", and
1685 "cc1obj" are merged.
1686
1687 @cindex traditional C language
1688 @cindex C language, traditional
1689 @item -traditional
1690 @itemx -traditional-cpp
1691 @opindex traditional-cpp
1692 @opindex traditional
1693 Formerly, these options caused GCC to attempt to emulate a pre-standard
1694 C compiler.  They are now only supported with the @option{-E} switch.
1695 The preprocessor continues to support a pre-standard mode.  See the GNU
1696 CPP manual for details.
1697
1698 @item -fcond-mismatch
1699 @opindex fcond-mismatch
1700 Allow conditional expressions with mismatched types in the second and
1701 third arguments.  The value of such an expression is void.  This option
1702 is not supported for C++.
1703
1704 @item -flax-vector-conversions
1705 @opindex flax-vector-conversions
1706 Allow implicit conversions between vectors with differing numbers of
1707 elements and/or incompatible element types.  This option should not be
1708 used for new code.
1709
1710 @item -funsigned-char
1711 @opindex funsigned-char
1712 Let the type @code{char} be unsigned, like @code{unsigned char}.
1713
1714 Each kind of machine has a default for what @code{char} should
1715 be.  It is either like @code{unsigned char} by default or like
1716 @code{signed char} by default.
1717
1718 Ideally, a portable program should always use @code{signed char} or
1719 @code{unsigned char} when it depends on the signedness of an object.
1720 But many programs have been written to use plain @code{char} and
1721 expect it to be signed, or expect it to be unsigned, depending on the
1722 machines they were written for.  This option, and its inverse, let you
1723 make such a program work with the opposite default.
1724
1725 The type @code{char} is always a distinct type from each of
1726 @code{signed char} or @code{unsigned char}, even though its behavior
1727 is always just like one of those two.
1728
1729 @item -fsigned-char
1730 @opindex fsigned-char
1731 Let the type @code{char} be signed, like @code{signed char}.
1732
1733 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1734 the negative form of @option{-funsigned-char}.  Likewise, the option
1735 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1736
1737 @item -fsigned-bitfields
1738 @itemx -funsigned-bitfields
1739 @itemx -fno-signed-bitfields
1740 @itemx -fno-unsigned-bitfields
1741 @opindex fsigned-bitfields
1742 @opindex funsigned-bitfields
1743 @opindex fno-signed-bitfields
1744 @opindex fno-unsigned-bitfields
1745 These options control whether a bit-field is signed or unsigned, when the
1746 declaration does not use either @code{signed} or @code{unsigned}.  By
1747 default, such a bit-field is signed, because this is consistent: the
1748 basic integer types such as @code{int} are signed types.
1749 @end table
1750
1751 @node C++ Dialect Options
1752 @section Options Controlling C++ Dialect
1753
1754 @cindex compiler options, C++
1755 @cindex C++ options, command line
1756 @cindex options, C++
1757 This section describes the command-line options that are only meaningful
1758 for C++ programs; but you can also use most of the GNU compiler options
1759 regardless of what language your program is in.  For example, you
1760 might compile a file @code{firstClass.C} like this:
1761
1762 @smallexample
1763 g++ -g -frepo -O -c firstClass.C
1764 @end smallexample
1765
1766 @noindent
1767 In this example, only @option{-frepo} is an option meant
1768 only for C++ programs; you can use the other options with any
1769 language supported by GCC@.
1770
1771 Here is a list of options that are @emph{only} for compiling C++ programs:
1772
1773 @table @gcctabopt
1774
1775 @item -fabi-version=@var{n}
1776 @opindex fabi-version
1777 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1778 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1779 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1780 the version that conforms most closely to the C++ ABI specification.
1781 Therefore, the ABI obtained using version 0 will change as ABI bugs
1782 are fixed.
1783
1784 The default is version 2.
1785
1786 Version 3 corrects an error in mangling a constant address as a
1787 template argument.
1788
1789 Version 4 implements a standard mangling for vector types.
1790
1791 See also @option{-Wabi}.
1792
1793 @item -fno-access-control
1794 @opindex fno-access-control
1795 Turn off all access checking.  This switch is mainly useful for working
1796 around bugs in the access control code.
1797
1798 @item -fcheck-new
1799 @opindex fcheck-new
1800 Check that the pointer returned by @code{operator new} is non-null
1801 before attempting to modify the storage allocated.  This check is
1802 normally unnecessary because the C++ standard specifies that
1803 @code{operator new} will only return @code{0} if it is declared
1804 @samp{throw()}, in which case the compiler will always check the
1805 return value even without this option.  In all other cases, when
1806 @code{operator new} has a non-empty exception specification, memory
1807 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1808 @samp{new (nothrow)}.
1809
1810 @item -fconserve-space
1811 @opindex fconserve-space
1812 Put uninitialized or runtime-initialized global variables into the
1813 common segment, as C does.  This saves space in the executable at the
1814 cost of not diagnosing duplicate definitions.  If you compile with this
1815 flag and your program mysteriously crashes after @code{main()} has
1816 completed, you may have an object that is being destroyed twice because
1817 two definitions were merged.
1818
1819 This option is no longer useful on most targets, now that support has
1820 been added for putting variables into BSS without making them common.
1821
1822 @item -fno-deduce-init-list
1823 @opindex fno-deduce-init-list
1824 Disable deduction of a template type parameter as
1825 std::initializer_list from a brace-enclosed initializer list, i.e.
1826
1827 @smallexample
1828 template <class T> auto forward(T t) -> decltype (realfn (t))
1829 @{
1830   return realfn (t);
1831 @}
1832
1833 void f()
1834 @{
1835   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1836 @}
1837 @end smallexample
1838
1839 This option is present because this deduction is an extension to the
1840 current specification in the C++0x working draft, and there was
1841 some concern about potential overload resolution problems.
1842
1843 @item -ffriend-injection
1844 @opindex ffriend-injection
1845 Inject friend functions into the enclosing namespace, so that they are
1846 visible outside the scope of the class in which they are declared.
1847 Friend functions were documented to work this way in the old Annotated
1848 C++ Reference Manual, and versions of G++ before 4.1 always worked
1849 that way.  However, in ISO C++ a friend function which is not declared
1850 in an enclosing scope can only be found using argument dependent
1851 lookup.  This option causes friends to be injected as they were in
1852 earlier releases.
1853
1854 This option is for compatibility, and may be removed in a future
1855 release of G++.
1856
1857 @item -fno-elide-constructors
1858 @opindex fno-elide-constructors
1859 The C++ standard allows an implementation to omit creating a temporary
1860 which is only used to initialize another object of the same type.
1861 Specifying this option disables that optimization, and forces G++ to
1862 call the copy constructor in all cases.
1863
1864 @item -fno-enforce-eh-specs
1865 @opindex fno-enforce-eh-specs
1866 Don't generate code to check for violation of exception specifications
1867 at runtime.  This option violates the C++ standard, but may be useful
1868 for reducing code size in production builds, much like defining
1869 @samp{NDEBUG}.  This does not give user code permission to throw
1870 exceptions in violation of the exception specifications; the compiler
1871 will still optimize based on the specifications, so throwing an
1872 unexpected exception will result in undefined behavior.
1873
1874 @item -ffor-scope
1875 @itemx -fno-for-scope
1876 @opindex ffor-scope
1877 @opindex fno-for-scope
1878 If @option{-ffor-scope} is specified, the scope of variables declared in
1879 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1880 as specified by the C++ standard.
1881 If @option{-fno-for-scope} is specified, the scope of variables declared in
1882 a @i{for-init-statement} extends to the end of the enclosing scope,
1883 as was the case in old versions of G++, and other (traditional)
1884 implementations of C++.
1885
1886 The default if neither flag is given to follow the standard,
1887 but to allow and give a warning for old-style code that would
1888 otherwise be invalid, or have different behavior.
1889
1890 @item -fno-gnu-keywords
1891 @opindex fno-gnu-keywords
1892 Do not recognize @code{typeof} as a keyword, so that code can use this
1893 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1894 @option{-ansi} implies @option{-fno-gnu-keywords}.
1895
1896 @item -fno-implicit-templates
1897 @opindex fno-implicit-templates
1898 Never emit code for non-inline templates which are instantiated
1899 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1900 @xref{Template Instantiation}, for more information.
1901
1902 @item -fno-implicit-inline-templates
1903 @opindex fno-implicit-inline-templates
1904 Don't emit code for implicit instantiations of inline templates, either.
1905 The default is to handle inlines differently so that compiles with and
1906 without optimization will need the same set of explicit instantiations.
1907
1908 @item -fno-implement-inlines
1909 @opindex fno-implement-inlines
1910 To save space, do not emit out-of-line copies of inline functions
1911 controlled by @samp{#pragma implementation}.  This will cause linker
1912 errors if these functions are not inlined everywhere they are called.
1913
1914 @item -fms-extensions
1915 @opindex fms-extensions
1916 Disable pedantic warnings about constructs used in MFC, such as implicit
1917 int and getting a pointer to member function via non-standard syntax.
1918
1919 @item -fno-nonansi-builtins
1920 @opindex fno-nonansi-builtins
1921 Disable built-in declarations of functions that are not mandated by
1922 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1923 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1924
1925 @item -fno-operator-names
1926 @opindex fno-operator-names
1927 Do not treat the operator name keywords @code{and}, @code{bitand},
1928 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1929 synonyms as keywords.
1930
1931 @item -fno-optional-diags
1932 @opindex fno-optional-diags
1933 Disable diagnostics that the standard says a compiler does not need to
1934 issue.  Currently, the only such diagnostic issued by G++ is the one for
1935 a name having multiple meanings within a class.
1936
1937 @item -fpermissive
1938 @opindex fpermissive
1939 Downgrade some diagnostics about nonconformant code from errors to
1940 warnings.  Thus, using @option{-fpermissive} will allow some
1941 nonconforming code to compile.
1942
1943 @item -fno-pretty-templates
1944 @opindex fno-pretty-templates
1945 When an error message refers to a specialization of a function
1946 template, the compiler will normally print the signature of the
1947 template followed by the template arguments and any typedefs or
1948 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1949 rather than @code{void f(int)}) so that it's clear which template is
1950 involved.  When an error message refers to a specialization of a class
1951 template, the compiler will omit any template arguments which match
1952 the default template arguments for that template.  If either of these
1953 behaviors make it harder to understand the error message rather than
1954 easier, using @option{-fno-pretty-templates} will disable them.
1955
1956 @item -frepo
1957 @opindex frepo
1958 Enable automatic template instantiation at link time.  This option also
1959 implies @option{-fno-implicit-templates}.  @xref{Template
1960 Instantiation}, for more information.
1961
1962 @item -fno-rtti
1963 @opindex fno-rtti
1964 Disable generation of information about every class with virtual
1965 functions for use by the C++ runtime type identification features
1966 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1967 of the language, you can save some space by using this flag.  Note that
1968 exception handling uses the same information, but it will generate it as
1969 needed. The @samp{dynamic_cast} operator can still be used for casts that
1970 do not require runtime type information, i.e.@: casts to @code{void *} or to
1971 unambiguous base classes.
1972
1973 @item -fstats
1974 @opindex fstats
1975 Emit statistics about front-end processing at the end of the compilation.
1976 This information is generally only useful to the G++ development team.
1977
1978 @item -ftemplate-depth=@var{n}
1979 @opindex ftemplate-depth
1980 Set the maximum instantiation depth for template classes to @var{n}.
1981 A limit on the template instantiation depth is needed to detect
1982 endless recursions during template class instantiation.  ANSI/ISO C++
1983 conforming programs must not rely on a maximum depth greater than 17
1984 (changed to 1024 in C++0x).
1985
1986 @item -fno-threadsafe-statics
1987 @opindex fno-threadsafe-statics
1988 Do not emit the extra code to use the routines specified in the C++
1989 ABI for thread-safe initialization of local statics.  You can use this
1990 option to reduce code size slightly in code that doesn't need to be
1991 thread-safe.
1992
1993 @item -fuse-cxa-atexit
1994 @opindex fuse-cxa-atexit
1995 Register destructors for objects with static storage duration with the
1996 @code{__cxa_atexit} function rather than the @code{atexit} function.
1997 This option is required for fully standards-compliant handling of static
1998 destructors, but will only work if your C library supports
1999 @code{__cxa_atexit}.
2000
2001 @item -fno-use-cxa-get-exception-ptr
2002 @opindex fno-use-cxa-get-exception-ptr
2003 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2004 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2005 if the runtime routine is not available.
2006
2007 @item -fvisibility-inlines-hidden
2008 @opindex fvisibility-inlines-hidden
2009 This switch declares that the user does not attempt to compare
2010 pointers to inline methods where the addresses of the two functions
2011 were taken in different shared objects.
2012
2013 The effect of this is that GCC may, effectively, mark inline methods with
2014 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2015 appear in the export table of a DSO and do not require a PLT indirection
2016 when used within the DSO@.  Enabling this option can have a dramatic effect
2017 on load and link times of a DSO as it massively reduces the size of the
2018 dynamic export table when the library makes heavy use of templates.
2019
2020 The behavior of this switch is not quite the same as marking the
2021 methods as hidden directly, because it does not affect static variables
2022 local to the function or cause the compiler to deduce that
2023 the function is defined in only one shared object.
2024
2025 You may mark a method as having a visibility explicitly to negate the
2026 effect of the switch for that method.  For example, if you do want to
2027 compare pointers to a particular inline method, you might mark it as
2028 having default visibility.  Marking the enclosing class with explicit
2029 visibility will have no effect.
2030
2031 Explicitly instantiated inline methods are unaffected by this option
2032 as their linkage might otherwise cross a shared library boundary.
2033 @xref{Template Instantiation}.
2034
2035 @item -fvisibility-ms-compat
2036 @opindex fvisibility-ms-compat
2037 This flag attempts to use visibility settings to make GCC's C++
2038 linkage model compatible with that of Microsoft Visual Studio.
2039
2040 The flag makes these changes to GCC's linkage model:
2041
2042 @enumerate
2043 @item
2044 It sets the default visibility to @code{hidden}, like
2045 @option{-fvisibility=hidden}.
2046
2047 @item
2048 Types, but not their members, are not hidden by default.
2049
2050 @item
2051 The One Definition Rule is relaxed for types without explicit
2052 visibility specifications which are defined in more than one different
2053 shared object: those declarations are permitted if they would have
2054 been permitted when this option was not used.
2055 @end enumerate
2056
2057 In new code it is better to use @option{-fvisibility=hidden} and
2058 export those classes which are intended to be externally visible.
2059 Unfortunately it is possible for code to rely, perhaps accidentally,
2060 on the Visual Studio behavior.
2061
2062 Among the consequences of these changes are that static data members
2063 of the same type with the same name but defined in different shared
2064 objects will be different, so changing one will not change the other;
2065 and that pointers to function members defined in different shared
2066 objects may not compare equal.  When this flag is given, it is a
2067 violation of the ODR to define types with the same name differently.
2068
2069 @item -fno-weak
2070 @opindex fno-weak
2071 Do not use weak symbol support, even if it is provided by the linker.
2072 By default, G++ will use weak symbols if they are available.  This
2073 option exists only for testing, and should not be used by end-users;
2074 it will result in inferior code and has no benefits.  This option may
2075 be removed in a future release of G++.
2076
2077 @item -nostdinc++
2078 @opindex nostdinc++
2079 Do not search for header files in the standard directories specific to
2080 C++, but do still search the other standard directories.  (This option
2081 is used when building the C++ library.)
2082 @end table
2083
2084 In addition, these optimization, warning, and code generation options
2085 have meanings only for C++ programs:
2086
2087 @table @gcctabopt
2088 @item -fno-default-inline
2089 @opindex fno-default-inline
2090 Do not assume @samp{inline} for functions defined inside a class scope.
2091 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2092 functions will have linkage like inline functions; they just won't be
2093 inlined by default.
2094
2095 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2096 @opindex Wabi
2097 @opindex Wno-abi
2098 Warn when G++ generates code that is probably not compatible with the
2099 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2100 all such cases, there are probably some cases that are not warned about,
2101 even though G++ is generating incompatible code.  There may also be
2102 cases where warnings are emitted even though the code that is generated
2103 will be compatible.
2104
2105 You should rewrite your code to avoid these warnings if you are
2106 concerned about the fact that code generated by G++ may not be binary
2107 compatible with code generated by other compilers.
2108
2109 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2110
2111 @itemize @bullet
2112
2113 @item
2114 A template with a non-type template parameter of reference type is
2115 mangled incorrectly:
2116 @smallexample
2117 extern int N;
2118 template <int &> struct S @{@};
2119 void n (S<N>) @{2@}
2120 @end smallexample
2121
2122 This is fixed in @option{-fabi-version=3}.
2123
2124 @item
2125 SIMD vector types declared using @code{__attribute ((vector_size))} are
2126 mangled in a non-standard way that does not allow for overloading of
2127 functions taking vectors of different sizes.
2128
2129 The mangling is changed in @option{-fabi-version=4}.
2130 @end itemize
2131
2132 The known incompatibilities in @option{-fabi-version=1} include:
2133
2134 @itemize @bullet
2135
2136 @item
2137 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2138 pack data into the same byte as a base class.  For example:
2139
2140 @smallexample
2141 struct A @{ virtual void f(); int f1 : 1; @};
2142 struct B : public A @{ int f2 : 1; @};
2143 @end smallexample
2144
2145 @noindent
2146 In this case, G++ will place @code{B::f2} into the same byte
2147 as@code{A::f1}; other compilers will not.  You can avoid this problem
2148 by explicitly padding @code{A} so that its size is a multiple of the
2149 byte size on your platform; that will cause G++ and other compilers to
2150 layout @code{B} identically.
2151
2152 @item
2153 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2154 tail padding when laying out virtual bases.  For example:
2155
2156 @smallexample
2157 struct A @{ virtual void f(); char c1; @};
2158 struct B @{ B(); char c2; @};
2159 struct C : public A, public virtual B @{@};
2160 @end smallexample
2161
2162 @noindent
2163 In this case, G++ will not place @code{B} into the tail-padding for
2164 @code{A}; other compilers will.  You can avoid this problem by
2165 explicitly padding @code{A} so that its size is a multiple of its
2166 alignment (ignoring virtual base classes); that will cause G++ and other
2167 compilers to layout @code{C} identically.
2168
2169 @item
2170 Incorrect handling of bit-fields with declared widths greater than that
2171 of their underlying types, when the bit-fields appear in a union.  For
2172 example:
2173
2174 @smallexample
2175 union U @{ int i : 4096; @};
2176 @end smallexample
2177
2178 @noindent
2179 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2180 union too small by the number of bits in an @code{int}.
2181
2182 @item
2183 Empty classes can be placed at incorrect offsets.  For example:
2184
2185 @smallexample
2186 struct A @{@};
2187
2188 struct B @{
2189   A a;
2190   virtual void f ();
2191 @};
2192
2193 struct C : public B, public A @{@};
2194 @end smallexample
2195
2196 @noindent
2197 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2198 it should be placed at offset zero.  G++ mistakenly believes that the
2199 @code{A} data member of @code{B} is already at offset zero.
2200
2201 @item
2202 Names of template functions whose types involve @code{typename} or
2203 template template parameters can be mangled incorrectly.
2204
2205 @smallexample
2206 template <typename Q>
2207 void f(typename Q::X) @{@}
2208
2209 template <template <typename> class Q>
2210 void f(typename Q<int>::X) @{@}
2211 @end smallexample
2212
2213 @noindent
2214 Instantiations of these templates may be mangled incorrectly.
2215
2216 @end itemize
2217
2218 It also warns psABI related changes.  The known psABI changes at this
2219 point include:
2220
2221 @itemize @bullet
2222
2223 @item
2224 For SYSV/x86-64, when passing union with long double, it is changed to
2225 pass in memory as specified in psABI.  For example:
2226
2227 @smallexample
2228 union U @{
2229   long double ld;
2230   int i;
2231 @};
2232 @end smallexample
2233
2234 @noindent
2235 @code{union U} will always be passed in memory.
2236
2237 @end itemize
2238
2239 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2240 @opindex Wctor-dtor-privacy
2241 @opindex Wno-ctor-dtor-privacy
2242 Warn when a class seems unusable because all the constructors or
2243 destructors in that class are private, and it has neither friends nor
2244 public static member functions.
2245
2246 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2247 @opindex Wnon-virtual-dtor
2248 @opindex Wno-non-virtual-dtor
2249 Warn when a class has virtual functions and accessible non-virtual
2250 destructor, in which case it would be possible but unsafe to delete
2251 an instance of a derived class through a pointer to the base class.
2252 This warning is also enabled if -Weffc++ is specified.
2253
2254 @item -Wreorder @r{(C++ and Objective-C++ only)}
2255 @opindex Wreorder
2256 @opindex Wno-reorder
2257 @cindex reordering, warning
2258 @cindex warning for reordering of member initializers
2259 Warn when the order of member initializers given in the code does not
2260 match the order in which they must be executed.  For instance:
2261
2262 @smallexample
2263 struct A @{
2264   int i;
2265   int j;
2266   A(): j (0), i (1) @{ @}
2267 @};
2268 @end smallexample
2269
2270 The compiler will rearrange the member initializers for @samp{i}
2271 and @samp{j} to match the declaration order of the members, emitting
2272 a warning to that effect.  This warning is enabled by @option{-Wall}.
2273 @end table
2274
2275 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2276
2277 @table @gcctabopt
2278 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2279 @opindex Weffc++
2280 @opindex Wno-effc++
2281 Warn about violations of the following style guidelines from Scott Meyers'
2282 @cite{Effective C++} book:
2283
2284 @itemize @bullet
2285 @item
2286 Item 11:  Define a copy constructor and an assignment operator for classes
2287 with dynamically allocated memory.
2288
2289 @item
2290 Item 12:  Prefer initialization to assignment in constructors.
2291
2292 @item
2293 Item 14:  Make destructors virtual in base classes.
2294
2295 @item
2296 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2297
2298 @item
2299 Item 23:  Don't try to return a reference when you must return an object.
2300
2301 @end itemize
2302
2303 Also warn about violations of the following style guidelines from
2304 Scott Meyers' @cite{More Effective C++} book:
2305
2306 @itemize @bullet
2307 @item
2308 Item 6:  Distinguish between prefix and postfix forms of increment and
2309 decrement operators.
2310
2311 @item
2312 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2313
2314 @end itemize
2315
2316 When selecting this option, be aware that the standard library
2317 headers do not obey all of these guidelines; use @samp{grep -v}
2318 to filter out those warnings.
2319
2320 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2321 @opindex Wstrict-null-sentinel
2322 @opindex Wno-strict-null-sentinel
2323 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2324 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2325 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2326 it is guaranteed to be of the same size as a pointer.  But this use is
2327 not portable across different compilers.
2328
2329 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2330 @opindex Wno-non-template-friend
2331 @opindex Wnon-template-friend
2332 Disable warnings when non-templatized friend functions are declared
2333 within a template.  Since the advent of explicit template specification
2334 support in G++, if the name of the friend is an unqualified-id (i.e.,
2335 @samp{friend foo(int)}), the C++ language specification demands that the
2336 friend declare or define an ordinary, nontemplate function.  (Section
2337 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2338 could be interpreted as a particular specialization of a templatized
2339 function.  Because this non-conforming behavior is no longer the default
2340 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2341 check existing code for potential trouble spots and is on by default.
2342 This new compiler behavior can be turned off with
2343 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2344 but disables the helpful warning.
2345
2346 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2347 @opindex Wold-style-cast
2348 @opindex Wno-old-style-cast
2349 Warn if an old-style (C-style) cast to a non-void type is used within
2350 a C++ program.  The new-style casts (@samp{dynamic_cast},
2351 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2352 less vulnerable to unintended effects and much easier to search for.
2353
2354 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2355 @opindex Woverloaded-virtual
2356 @opindex Wno-overloaded-virtual
2357 @cindex overloaded virtual fn, warning
2358 @cindex warning for overloaded virtual fn
2359 Warn when a function declaration hides virtual functions from a
2360 base class.  For example, in:
2361
2362 @smallexample
2363 struct A @{
2364   virtual void f();
2365 @};
2366
2367 struct B: public A @{
2368   void f(int);
2369 @};
2370 @end smallexample
2371
2372 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2373 like:
2374
2375 @smallexample
2376 B* b;
2377 b->f();
2378 @end smallexample
2379
2380 will fail to compile.
2381
2382 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2383 @opindex Wno-pmf-conversions
2384 @opindex Wpmf-conversions
2385 Disable the diagnostic for converting a bound pointer to member function
2386 to a plain pointer.
2387
2388 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2389 @opindex Wsign-promo
2390 @opindex Wno-sign-promo
2391 Warn when overload resolution chooses a promotion from unsigned or
2392 enumerated type to a signed type, over a conversion to an unsigned type of
2393 the same size.  Previous versions of G++ would try to preserve
2394 unsignedness, but the standard mandates the current behavior.
2395
2396 @smallexample
2397 struct A @{
2398   operator int ();
2399   A& operator = (int);
2400 @};
2401
2402 main ()
2403 @{
2404   A a,b;
2405   a = b;
2406 @}
2407 @end smallexample
2408
2409 In this example, G++ will synthesize a default @samp{A& operator =
2410 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2411 @end table
2412
2413 @node Objective-C and Objective-C++ Dialect Options
2414 @section Options Controlling Objective-C and Objective-C++ Dialects
2415
2416 @cindex compiler options, Objective-C and Objective-C++
2417 @cindex Objective-C and Objective-C++ options, command line
2418 @cindex options, Objective-C and Objective-C++
2419 (NOTE: This manual does not describe the Objective-C and Objective-C++
2420 languages themselves.  See @xref{Standards,,Language Standards
2421 Supported by GCC}, for references.)
2422
2423 This section describes the command-line options that are only meaningful
2424 for Objective-C and Objective-C++ programs, but you can also use most of
2425 the language-independent GNU compiler options.
2426 For example, you might compile a file @code{some_class.m} like this:
2427
2428 @smallexample
2429 gcc -g -fgnu-runtime -O -c some_class.m
2430 @end smallexample
2431
2432 @noindent
2433 In this example, @option{-fgnu-runtime} is an option meant only for
2434 Objective-C and Objective-C++ programs; you can use the other options with
2435 any language supported by GCC@.
2436
2437 Note that since Objective-C is an extension of the C language, Objective-C
2438 compilations may also use options specific to the C front-end (e.g.,
2439 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2440 C++-specific options (e.g., @option{-Wabi}).
2441
2442 Here is a list of options that are @emph{only} for compiling Objective-C
2443 and Objective-C++ programs:
2444
2445 @table @gcctabopt
2446 @item -fconstant-string-class=@var{class-name}
2447 @opindex fconstant-string-class
2448 Use @var{class-name} as the name of the class to instantiate for each
2449 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2450 class name is @code{NXConstantString} if the GNU runtime is being used, and
2451 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2452 @option{-fconstant-cfstrings} option, if also present, will override the
2453 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2454 to be laid out as constant CoreFoundation strings.
2455
2456 @item -fgnu-runtime
2457 @opindex fgnu-runtime
2458 Generate object code compatible with the standard GNU Objective-C
2459 runtime.  This is the default for most types of systems.
2460
2461 @item -fnext-runtime
2462 @opindex fnext-runtime
2463 Generate output compatible with the NeXT runtime.  This is the default
2464 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2465 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2466 used.
2467
2468 @item -fno-nil-receivers
2469 @opindex fno-nil-receivers
2470 Assume that all Objective-C message dispatches (e.g.,
2471 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2472 is not @code{nil}.  This allows for more efficient entry points in the runtime
2473 to be used.  Currently, this option is only available in conjunction with
2474 the NeXT runtime on Mac OS X 10.3 and later.
2475
2476 @item -fobjc-call-cxx-cdtors
2477 @opindex fobjc-call-cxx-cdtors
2478 For each Objective-C class, check if any of its instance variables is a
2479 C++ object with a non-trivial default constructor.  If so, synthesize a
2480 special @code{- (id) .cxx_construct} instance method that will run
2481 non-trivial default constructors on any such instance variables, in order,
2482 and then return @code{self}.  Similarly, check if any instance variable
2483 is a C++ object with a non-trivial destructor, and if so, synthesize a
2484 special @code{- (void) .cxx_destruct} method that will run
2485 all such default destructors, in reverse order.
2486
2487 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2488 thusly generated will only operate on instance variables declared in the
2489 current Objective-C class, and not those inherited from superclasses.  It
2490 is the responsibility of the Objective-C runtime to invoke all such methods
2491 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2492 will be invoked by the runtime immediately after a new object
2493 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2494 be invoked immediately before the runtime deallocates an object instance.
2495
2496 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2497 support for invoking the @code{- (id) .cxx_construct} and
2498 @code{- (void) .cxx_destruct} methods.
2499
2500 @item -fobjc-direct-dispatch
2501 @opindex fobjc-direct-dispatch
2502 Allow fast jumps to the message dispatcher.  On Darwin this is
2503 accomplished via the comm page.
2504
2505 @item -fobjc-exceptions
2506 @opindex fobjc-exceptions
2507 Enable syntactic support for structured exception handling in Objective-C,
2508 similar to what is offered by C++ and Java.  This option is
2509 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2510 earlier.
2511
2512 @smallexample
2513   @@try @{
2514     @dots{}
2515        @@throw expr;
2516     @dots{}
2517   @}
2518   @@catch (AnObjCClass *exc) @{
2519     @dots{}
2520       @@throw expr;
2521     @dots{}
2522       @@throw;
2523     @dots{}
2524   @}
2525   @@catch (AnotherClass *exc) @{
2526     @dots{}
2527   @}
2528   @@catch (id allOthers) @{
2529     @dots{}
2530   @}
2531   @@finally @{
2532     @dots{}
2533       @@throw expr;
2534     @dots{}
2535   @}
2536 @end smallexample
2537
2538 The @code{@@throw} statement may appear anywhere in an Objective-C or
2539 Objective-C++ program; when used inside of a @code{@@catch} block, the
2540 @code{@@throw} may appear without an argument (as shown above), in which case
2541 the object caught by the @code{@@catch} will be rethrown.
2542
2543 Note that only (pointers to) Objective-C objects may be thrown and
2544 caught using this scheme.  When an object is thrown, it will be caught
2545 by the nearest @code{@@catch} clause capable of handling objects of that type,
2546 analogously to how @code{catch} blocks work in C++ and Java.  A
2547 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2548 any and all Objective-C exceptions not caught by previous @code{@@catch}
2549 clauses (if any).
2550
2551 The @code{@@finally} clause, if present, will be executed upon exit from the
2552 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2553 regardless of whether any exceptions are thrown, caught or rethrown
2554 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2555 of the @code{finally} clause in Java.
2556
2557 There are several caveats to using the new exception mechanism:
2558
2559 @itemize @bullet
2560 @item
2561 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2562 idioms provided by the @code{NSException} class, the new
2563 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2564 systems, due to additional functionality needed in the (NeXT) Objective-C
2565 runtime.
2566
2567 @item
2568 As mentioned above, the new exceptions do not support handling
2569 types other than Objective-C objects.   Furthermore, when used from
2570 Objective-C++, the Objective-C exception model does not interoperate with C++
2571 exceptions at this time.  This means you cannot @code{@@throw} an exception
2572 from Objective-C and @code{catch} it in C++, or vice versa
2573 (i.e., @code{throw @dots{} @@catch}).
2574 @end itemize
2575
2576 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2577 blocks for thread-safe execution:
2578
2579 @smallexample
2580   @@synchronized (ObjCClass *guard) @{
2581     @dots{}
2582   @}
2583 @end smallexample
2584
2585 Upon entering the @code{@@synchronized} block, a thread of execution shall
2586 first check whether a lock has been placed on the corresponding @code{guard}
2587 object by another thread.  If it has, the current thread shall wait until
2588 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2589 the current thread will place its own lock on it, execute the code contained in
2590 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2591 making @code{guard} available to other threads).
2592
2593 Unlike Java, Objective-C does not allow for entire methods to be marked
2594 @code{@@synchronized}.  Note that throwing exceptions out of
2595 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2596 to be unlocked properly.
2597
2598 @item -fobjc-gc
2599 @opindex fobjc-gc
2600 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2601
2602 @item -freplace-objc-classes
2603 @opindex freplace-objc-classes
2604 Emit a special marker instructing @command{ld(1)} not to statically link in
2605 the resulting object file, and allow @command{dyld(1)} to load it in at
2606 run time instead.  This is used in conjunction with the Fix-and-Continue
2607 debugging mode, where the object file in question may be recompiled and
2608 dynamically reloaded in the course of program execution, without the need
2609 to restart the program itself.  Currently, Fix-and-Continue functionality
2610 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2611 and later.
2612
2613 @item -fzero-link
2614 @opindex fzero-link
2615 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2616 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2617 compile time) with static class references that get initialized at load time,
2618 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2619 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2620 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2621 for individual class implementations to be modified during program execution.
2622
2623 @item -gen-decls
2624 @opindex gen-decls
2625 Dump interface declarations for all classes seen in the source file to a
2626 file named @file{@var{sourcename}.decl}.
2627
2628 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2629 @opindex Wassign-intercept
2630 @opindex Wno-assign-intercept
2631 Warn whenever an Objective-C assignment is being intercepted by the
2632 garbage collector.
2633
2634 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2635 @opindex Wno-protocol
2636 @opindex Wprotocol
2637 If a class is declared to implement a protocol, a warning is issued for
2638 every method in the protocol that is not implemented by the class.  The
2639 default behavior is to issue a warning for every method not explicitly
2640 implemented in the class, even if a method implementation is inherited
2641 from the superclass.  If you use the @option{-Wno-protocol} option, then
2642 methods inherited from the superclass are considered to be implemented,
2643 and no warning is issued for them.
2644
2645 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2646 @opindex Wselector
2647 @opindex Wno-selector
2648 Warn if multiple methods of different types for the same selector are
2649 found during compilation.  The check is performed on the list of methods
2650 in the final stage of compilation.  Additionally, a check is performed
2651 for each selector appearing in a @code{@@selector(@dots{})}
2652 expression, and a corresponding method for that selector has been found
2653 during compilation.  Because these checks scan the method table only at
2654 the end of compilation, these warnings are not produced if the final
2655 stage of compilation is not reached, for example because an error is
2656 found during compilation, or because the @option{-fsyntax-only} option is
2657 being used.
2658
2659 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2660 @opindex Wstrict-selector-match
2661 @opindex Wno-strict-selector-match
2662 Warn if multiple methods with differing argument and/or return types are
2663 found for a given selector when attempting to send a message using this
2664 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2665 is off (which is the default behavior), the compiler will omit such warnings
2666 if any differences found are confined to types which share the same size
2667 and alignment.
2668
2669 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2670 @opindex Wundeclared-selector
2671 @opindex Wno-undeclared-selector
2672 Warn if a @code{@@selector(@dots{})} expression referring to an
2673 undeclared selector is found.  A selector is considered undeclared if no
2674 method with that name has been declared before the
2675 @code{@@selector(@dots{})} expression, either explicitly in an
2676 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2677 an @code{@@implementation} section.  This option always performs its
2678 checks as soon as a @code{@@selector(@dots{})} expression is found,
2679 while @option{-Wselector} only performs its checks in the final stage of
2680 compilation.  This also enforces the coding style convention
2681 that methods and selectors must be declared before being used.
2682
2683 @item -print-objc-runtime-info
2684 @opindex print-objc-runtime-info
2685 Generate C header describing the largest structure that is passed by
2686 value, if any.
2687
2688 @end table
2689
2690 @node Language Independent Options
2691 @section Options to Control Diagnostic Messages Formatting
2692 @cindex options to control diagnostics formatting
2693 @cindex diagnostic messages
2694 @cindex message formatting
2695
2696 Traditionally, diagnostic messages have been formatted irrespective of
2697 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2698 below can be used to control the diagnostic messages formatting
2699 algorithm, e.g.@: how many characters per line, how often source location
2700 information should be reported.  Right now, only the C++ front end can
2701 honor these options.  However it is expected, in the near future, that
2702 the remaining front ends would be able to digest them correctly.
2703
2704 @table @gcctabopt
2705 @item -fmessage-length=@var{n}
2706 @opindex fmessage-length
2707 Try to format error messages so that they fit on lines of about @var{n}
2708 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2709 the front ends supported by GCC@.  If @var{n} is zero, then no
2710 line-wrapping will be done; each error message will appear on a single
2711 line.
2712
2713 @opindex fdiagnostics-show-location
2714 @item -fdiagnostics-show-location=once
2715 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2716 reporter to emit @emph{once} source location information; that is, in
2717 case the message is too long to fit on a single physical line and has to
2718 be wrapped, the source location won't be emitted (as prefix) again,
2719 over and over, in subsequent continuation lines.  This is the default
2720 behavior.
2721
2722 @item -fdiagnostics-show-location=every-line
2723 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2724 messages reporter to emit the same source location information (as
2725 prefix) for physical lines that result from the process of breaking
2726 a message which is too long to fit on a single line.
2727
2728 @item -fdiagnostics-show-option
2729 @opindex fdiagnostics-show-option
2730 This option instructs the diagnostic machinery to add text to each
2731 diagnostic emitted, which indicates which command line option directly
2732 controls that diagnostic, when such an option is known to the
2733 diagnostic machinery.
2734
2735 @item -Wcoverage-mismatch
2736 @opindex Wcoverage-mismatch
2737 Warn if feedback profiles do not match when using the
2738 @option{-fprofile-use} option.
2739 If a source file was changed between @option{-fprofile-gen} and
2740 @option{-fprofile-use}, the files with the profile feedback can fail
2741 to match the source file and GCC can not use the profile feedback
2742 information.  By default, GCC emits an error message in this case.
2743 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2744 error.  GCC does not use appropriate feedback profiles, so using this
2745 option can result in poorly optimized code.  This option is useful
2746 only in the case of very minor changes such as bug fixes to an
2747 existing code-base.
2748
2749 @end table
2750
2751 @node Warning Options
2752 @section Options to Request or Suppress Warnings
2753 @cindex options to control warnings
2754 @cindex warning messages
2755 @cindex messages, warning
2756 @cindex suppressing warnings
2757
2758 Warnings are diagnostic messages that report constructions which
2759 are not inherently erroneous but which are risky or suggest there
2760 may have been an error.
2761
2762 The following language-independent options do not enable specific
2763 warnings but control the kinds of diagnostics produced by GCC.
2764
2765 @table @gcctabopt
2766 @cindex syntax checking
2767 @item -fsyntax-only
2768 @opindex fsyntax-only
2769 Check the code for syntax errors, but don't do anything beyond that.
2770
2771 @item -w
2772 @opindex w
2773 Inhibit all warning messages.
2774
2775 @item -Werror
2776 @opindex Werror
2777 @opindex Wno-error
2778 Make all warnings into errors.
2779
2780 @item -Werror=
2781 @opindex Werror=
2782 @opindex Wno-error=
2783 Make the specified warning into an error.  The specifier for a warning
2784 is appended, for example @option{-Werror=switch} turns the warnings
2785 controlled by @option{-Wswitch} into errors.  This switch takes a
2786 negative form, to be used to negate @option{-Werror} for specific
2787 warnings, for example @option{-Wno-error=switch} makes
2788 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2789 is in effect.  You can use the @option{-fdiagnostics-show-option}
2790 option to have each controllable warning amended with the option which
2791 controls it, to determine what to use with this option.
2792
2793 Note that specifying @option{-Werror=}@var{foo} automatically implies
2794 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2795 imply anything.
2796
2797 @item -Wfatal-errors
2798 @opindex Wfatal-errors
2799 @opindex Wno-fatal-errors
2800 This option causes the compiler to abort compilation on the first error
2801 occurred rather than trying to keep going and printing further error
2802 messages.
2803
2804 @end table
2805
2806 You can request many specific warnings with options beginning
2807 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2808 implicit declarations.  Each of these specific warning options also
2809 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2810 example, @option{-Wno-implicit}.  This manual lists only one of the
2811 two forms, whichever is not the default.  For further,
2812 language-specific options also refer to @ref{C++ Dialect Options} and
2813 @ref{Objective-C and Objective-C++ Dialect Options}.
2814
2815 @table @gcctabopt
2816 @item -pedantic
2817 @opindex pedantic
2818 Issue all the warnings demanded by strict ISO C and ISO C++;
2819 reject all programs that use forbidden extensions, and some other
2820 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2821 version of the ISO C standard specified by any @option{-std} option used.
2822
2823 Valid ISO C and ISO C++ programs should compile properly with or without
2824 this option (though a rare few will require @option{-ansi} or a
2825 @option{-std} option specifying the required version of ISO C)@.  However,
2826 without this option, certain GNU extensions and traditional C and C++
2827 features are supported as well.  With this option, they are rejected.
2828
2829 @option{-pedantic} does not cause warning messages for use of the
2830 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2831 warnings are also disabled in the expression that follows
2832 @code{__extension__}.  However, only system header files should use
2833 these escape routes; application programs should avoid them.
2834 @xref{Alternate Keywords}.
2835
2836 Some users try to use @option{-pedantic} to check programs for strict ISO
2837 C conformance.  They soon find that it does not do quite what they want:
2838 it finds some non-ISO practices, but not all---only those for which
2839 ISO C @emph{requires} a diagnostic, and some others for which
2840 diagnostics have been added.
2841
2842 A feature to report any failure to conform to ISO C might be useful in
2843 some instances, but would require considerable additional work and would
2844 be quite different from @option{-pedantic}.  We don't have plans to
2845 support such a feature in the near future.
2846
2847 Where the standard specified with @option{-std} represents a GNU
2848 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
2849 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2850 extended dialect is based.  Warnings from @option{-pedantic} are given
2851 where they are required by the base standard.  (It would not make sense
2852 for such warnings to be given only for features not in the specified GNU
2853 C dialect, since by definition the GNU dialects of C include all
2854 features the compiler supports with the given option, and there would be
2855 nothing to warn about.)
2856
2857 @item -pedantic-errors
2858 @opindex pedantic-errors
2859 Like @option{-pedantic}, except that errors are produced rather than
2860 warnings.
2861
2862 @item -Wall
2863 @opindex Wall
2864 @opindex Wno-all
2865 This enables all the warnings about constructions that some users
2866 consider questionable, and that are easy to avoid (or modify to
2867 prevent the warning), even in conjunction with macros.  This also
2868 enables some language-specific warnings described in @ref{C++ Dialect
2869 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2870
2871 @option{-Wall} turns on the following warning flags:
2872
2873 @gccoptlist{-Waddress   @gol
2874 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2875 -Wc++0x-compat  @gol
2876 -Wchar-subscripts  @gol
2877 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2878 -Wimplicit-int  @gol
2879 -Wimplicit-function-declaration  @gol
2880 -Wcomment  @gol
2881 -Wformat   @gol
2882 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2883 -Wmissing-braces  @gol
2884 -Wnonnull  @gol
2885 -Wparentheses  @gol
2886 -Wpointer-sign  @gol
2887 -Wreorder   @gol
2888 -Wreturn-type  @gol
2889 -Wsequence-point  @gol
2890 -Wsign-compare @r{(only in C++)}  @gol
2891 -Wstrict-aliasing  @gol
2892 -Wstrict-overflow=1  @gol
2893 -Wswitch  @gol
2894 -Wtrigraphs  @gol
2895 -Wuninitialized  @gol
2896 -Wunknown-pragmas  @gol
2897 -Wunused-function  @gol
2898 -Wunused-label     @gol
2899 -Wunused-value     @gol
2900 -Wunused-variable  @gol
2901 -Wvolatile-register-var @gol
2902 }
2903
2904 Note that some warning flags are not implied by @option{-Wall}.  Some of
2905 them warn about constructions that users generally do not consider
2906 questionable, but which occasionally you might wish to check for;
2907 others warn about constructions that are necessary or hard to avoid in
2908 some cases, and there is no simple way to modify the code to suppress
2909 the warning. Some of them are enabled by @option{-Wextra} but many of
2910 them must be enabled individually.
2911
2912 @item -Wextra
2913 @opindex W
2914 @opindex Wextra
2915 @opindex Wno-extra
2916 This enables some extra warning flags that are not enabled by
2917 @option{-Wall}. (This option used to be called @option{-W}.  The older
2918 name is still supported, but the newer name is more descriptive.)
2919
2920 @gccoptlist{-Wclobbered  @gol
2921 -Wempty-body  @gol
2922 -Wignored-qualifiers @gol
2923 -Wmissing-field-initializers  @gol
2924 -Wmissing-parameter-type @r{(C only)}  @gol
2925 -Wold-style-declaration @r{(C only)}  @gol
2926 -Woverride-init  @gol
2927 -Wsign-compare  @gol
2928 -Wtype-limits  @gol
2929 -Wuninitialized  @gol
2930 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2931 }
2932
2933 The option @option{-Wextra} also prints warning messages for the
2934 following cases:
2935
2936 @itemize @bullet
2937
2938 @item
2939 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2940 @samp{>}, or @samp{>=}.
2941
2942 @item
2943 (C++ only) An enumerator and a non-enumerator both appear in a
2944 conditional expression.
2945
2946 @item
2947 (C++ only) Ambiguous virtual bases.
2948
2949 @item
2950 (C++ only) Subscripting an array which has been declared @samp{register}.
2951
2952 @item
2953 (C++ only) Taking the address of a variable which has been declared
2954 @samp{register}.
2955
2956 @item
2957 (C++ only) A base class is not initialized in a derived class' copy
2958 constructor.
2959
2960 @end itemize
2961
2962 @item -Wchar-subscripts
2963 @opindex Wchar-subscripts
2964 @opindex Wno-char-subscripts
2965 Warn if an array subscript has type @code{char}.  This is a common cause
2966 of error, as programmers often forget that this type is signed on some
2967 machines.
2968 This warning is enabled by @option{-Wall}.
2969
2970 @item -Wcomment
2971 @opindex Wcomment
2972 @opindex Wno-comment
2973 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2974 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2975 This warning is enabled by @option{-Wall}.
2976
2977 @item -Wformat
2978 @opindex Wformat
2979 @opindex Wno-format
2980 @opindex ffreestanding
2981 @opindex fno-builtin
2982 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2983 the arguments supplied have types appropriate to the format string
2984 specified, and that the conversions specified in the format string make
2985 sense.  This includes standard functions, and others specified by format
2986 attributes (@pxref{Function Attributes}), in the @code{printf},
2987 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2988 not in the C standard) families (or other target-specific families).
2989 Which functions are checked without format attributes having been
2990 specified depends on the standard version selected, and such checks of
2991 functions without the attribute specified are disabled by
2992 @option{-ffreestanding} or @option{-fno-builtin}.
2993
2994 The formats are checked against the format features supported by GNU
2995 libc version 2.2.  These include all ISO C90 and C99 features, as well
2996 as features from the Single Unix Specification and some BSD and GNU
2997 extensions.  Other library implementations may not support all these
2998 features; GCC does not support warning about features that go beyond a
2999 particular library's limitations.  However, if @option{-pedantic} is used
3000 with @option{-Wformat}, warnings will be given about format features not
3001 in the selected standard version (but not for @code{strfmon} formats,
3002 since those are not in any version of the C standard).  @xref{C Dialect
3003 Options,,Options Controlling C Dialect}.
3004
3005 Since @option{-Wformat} also checks for null format arguments for
3006 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3007
3008 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3009 aspects of format checking, the options @option{-Wformat-y2k},
3010 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3011 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3012 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3013
3014 @item -Wformat-y2k
3015 @opindex Wformat-y2k
3016 @opindex Wno-format-y2k
3017 If @option{-Wformat} is specified, also warn about @code{strftime}
3018 formats which may yield only a two-digit year.
3019
3020 @item -Wno-format-contains-nul
3021 @opindex Wno-format-contains-nul
3022 @opindex Wformat-contains-nul
3023 If @option{-Wformat} is specified, do not warn about format strings that
3024 contain NUL bytes.
3025
3026 @item -Wno-format-extra-args
3027 @opindex Wno-format-extra-args
3028 @opindex Wformat-extra-args
3029 If @option{-Wformat} is specified, do not warn about excess arguments to a
3030 @code{printf} or @code{scanf} format function.  The C standard specifies
3031 that such arguments are ignored.
3032
3033 Where the unused arguments lie between used arguments that are
3034 specified with @samp{$} operand number specifications, normally
3035 warnings are still given, since the implementation could not know what
3036 type to pass to @code{va_arg} to skip the unused arguments.  However,
3037 in the case of @code{scanf} formats, this option will suppress the
3038 warning if the unused arguments are all pointers, since the Single
3039 Unix Specification says that such unused arguments are allowed.
3040
3041 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3042 @opindex Wno-format-zero-length
3043 @opindex Wformat-zero-length
3044 If @option{-Wformat} is specified, do not warn about zero-length formats.
3045 The C standard specifies that zero-length formats are allowed.
3046
3047 @item -Wformat-nonliteral
3048 @opindex Wformat-nonliteral
3049 @opindex Wno-format-nonliteral
3050 If @option{-Wformat} is specified, also warn if the format string is not a
3051 string literal and so cannot be checked, unless the format function
3052 takes its format arguments as a @code{va_list}.
3053
3054 @item -Wformat-security
3055 @opindex Wformat-security
3056 @opindex Wno-format-security
3057 If @option{-Wformat} is specified, also warn about uses of format
3058 functions that represent possible security problems.  At present, this
3059 warns about calls to @code{printf} and @code{scanf} functions where the
3060 format string is not a string literal and there are no format arguments,
3061 as in @code{printf (foo);}.  This may be a security hole if the format
3062 string came from untrusted input and contains @samp{%n}.  (This is
3063 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3064 in future warnings may be added to @option{-Wformat-security} that are not
3065 included in @option{-Wformat-nonliteral}.)
3066
3067 @item -Wformat=2
3068 @opindex Wformat=2
3069 @opindex Wno-format=2
3070 Enable @option{-Wformat} plus format checks not included in
3071 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3072 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3073
3074 @item -Wnonnull @r{(C and Objective-C only)}
3075 @opindex Wnonnull
3076 @opindex Wno-nonnull
3077 Warn about passing a null pointer for arguments marked as
3078 requiring a non-null value by the @code{nonnull} function attribute.
3079
3080 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3081 can be disabled with the @option{-Wno-nonnull} option.
3082
3083 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3084 @opindex Winit-self
3085 @opindex Wno-init-self
3086 Warn about uninitialized variables which are initialized with themselves.
3087 Note this option can only be used with the @option{-Wuninitialized} option.
3088
3089 For example, GCC will warn about @code{i} being uninitialized in the
3090 following snippet only when @option{-Winit-self} has been specified:
3091 @smallexample
3092 @group
3093 int f()
3094 @{
3095   int i = i;
3096   return i;
3097 @}
3098 @end group
3099 @end smallexample
3100
3101 @item -Wimplicit-int @r{(C and Objective-C only)}
3102 @opindex Wimplicit-int
3103 @opindex Wno-implicit-int
3104 Warn when a declaration does not specify a type.
3105 This warning is enabled by @option{-Wall}.
3106
3107 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3108 @opindex Wimplicit-function-declaration
3109 @opindex Wno-implicit-function-declaration
3110 Give a warning whenever a function is used before being declared. In
3111 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3112 enabled by default and it is made into an error by
3113 @option{-pedantic-errors}. This warning is also enabled by
3114 @option{-Wall}.
3115
3116 @item -Wimplicit
3117 @opindex Wimplicit
3118 @opindex Wno-implicit
3119 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3120 This warning is enabled by @option{-Wall}.
3121
3122 @item -Wignored-qualifiers @r{(C and C++ only)}
3123 @opindex Wignored-qualifiers
3124 @opindex Wno-ignored-qualifiers
3125 Warn if the return type of a function has a type qualifier
3126 such as @code{const}.  For ISO C such a type qualifier has no effect,
3127 since the value returned by a function is not an lvalue.
3128 For C++, the warning is only emitted for scalar types or @code{void}.
3129 ISO C prohibits qualified @code{void} return types on function
3130 definitions, so such return types always receive a warning
3131 even without this option.
3132
3133 This warning is also enabled by @option{-Wextra}.
3134
3135 @item -Wmain
3136 @opindex Wmain
3137 @opindex Wno-main
3138 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3139 a function with external linkage, returning int, taking either zero
3140 arguments, two, or three arguments of appropriate types.  This warning
3141 is enabled by default in C++ and is enabled by either @option{-Wall}
3142 or @option{-pedantic}.
3143
3144 @item -Wmissing-braces
3145 @opindex Wmissing-braces
3146 @opindex Wno-missing-braces
3147 Warn if an aggregate or union initializer is not fully bracketed.  In
3148 the following example, the initializer for @samp{a} is not fully
3149 bracketed, but that for @samp{b} is fully bracketed.
3150
3151 @smallexample
3152 int a[2][2] = @{ 0, 1, 2, 3 @};
3153 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3154 @end smallexample
3155
3156 This warning is enabled by @option{-Wall}.
3157
3158 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3159 @opindex Wmissing-include-dirs
3160 @opindex Wno-missing-include-dirs
3161 Warn if a user-supplied include directory does not exist.
3162
3163 @item -Wparentheses
3164 @opindex Wparentheses
3165 @opindex Wno-parentheses
3166 Warn if parentheses are omitted in certain contexts, such
3167 as when there is an assignment in a context where a truth value
3168 is expected, or when operators are nested whose precedence people
3169 often get confused about.
3170
3171 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3172 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3173 interpretation from that of ordinary mathematical notation.
3174
3175 Also warn about constructions where there may be confusion to which
3176 @code{if} statement an @code{else} branch belongs.  Here is an example of
3177 such a case:
3178
3179 @smallexample
3180 @group
3181 @{
3182   if (a)
3183     if (b)
3184       foo ();
3185   else
3186     bar ();
3187 @}
3188 @end group
3189 @end smallexample
3190
3191 In C/C++, every @code{else} branch belongs to the innermost possible
3192 @code{if} statement, which in this example is @code{if (b)}.  This is
3193 often not what the programmer expected, as illustrated in the above
3194 example by indentation the programmer chose.  When there is the
3195 potential for this confusion, GCC will issue a warning when this flag
3196 is specified.  To eliminate the warning, add explicit braces around
3197 the innermost @code{if} statement so there is no way the @code{else}
3198 could belong to the enclosing @code{if}.  The resulting code would
3199 look like this:
3200
3201 @smallexample
3202 @group
3203 @{
3204   if (a)
3205     @{
3206       if (b)
3207         foo ();
3208       else
3209         bar ();
3210     @}
3211 @}
3212 @end group
3213 @end smallexample
3214
3215 This warning is enabled by @option{-Wall}.
3216
3217 @item -Wsequence-point
3218 @opindex Wsequence-point
3219 @opindex Wno-sequence-point
3220 Warn about code that may have undefined semantics because of violations
3221 of sequence point rules in the C and C++ standards.
3222
3223 The C and C++ standards defines the order in which expressions in a C/C++
3224 program are evaluated in terms of @dfn{sequence points}, which represent
3225 a partial ordering between the execution of parts of the program: those
3226 executed before the sequence point, and those executed after it.  These
3227 occur after the evaluation of a full expression (one which is not part
3228 of a larger expression), after the evaluation of the first operand of a
3229 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3230 function is called (but after the evaluation of its arguments and the
3231 expression denoting the called function), and in certain other places.
3232 Other than as expressed by the sequence point rules, the order of
3233 evaluation of subexpressions of an expression is not specified.  All
3234 these rules describe only a partial order rather than a total order,
3235 since, for example, if two functions are called within one expression
3236 with no sequence point between them, the order in which the functions
3237 are called is not specified.  However, the standards committee have
3238 ruled that function calls do not overlap.
3239
3240 It is not specified when between sequence points modifications to the
3241 values of objects take effect.  Programs whose behavior depends on this
3242 have undefined behavior; the C and C++ standards specify that ``Between
3243 the previous and next sequence point an object shall have its stored
3244 value modified at most once by the evaluation of an expression.
3245 Furthermore, the prior value shall be read only to determine the value
3246 to be stored.''.  If a program breaks these rules, the results on any
3247 particular implementation are entirely unpredictable.
3248
3249 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3250 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3251 diagnosed by this option, and it may give an occasional false positive
3252 result, but in general it has been found fairly effective at detecting
3253 this sort of problem in programs.
3254
3255 The standard is worded confusingly, therefore there is some debate
3256 over the precise meaning of the sequence point rules in subtle cases.
3257 Links to discussions of the problem, including proposed formal
3258 definitions, may be found on the GCC readings page, at
3259 @w{@uref{http://gcc.gnu.org/readings.html}}.
3260
3261 This warning is enabled by @option{-Wall} for C and C++.
3262
3263 @item -Wreturn-type
3264 @opindex Wreturn-type
3265 @opindex Wno-return-type
3266 Warn whenever a function is defined with a return-type that defaults
3267 to @code{int}.  Also warn about any @code{return} statement with no
3268 return-value in a function whose return-type is not @code{void}
3269 (falling off the end of the function body is considered returning
3270 without a value), and about a @code{return} statement with an
3271 expression in a function whose return-type is @code{void}.
3272
3273 For C++, a function without return type always produces a diagnostic
3274 message, even when @option{-Wno-return-type} is specified.  The only
3275 exceptions are @samp{main} and functions defined in system headers.
3276
3277 This warning is enabled by @option{-Wall}.
3278
3279 @item -Wswitch
3280 @opindex Wswitch
3281 @opindex Wno-switch
3282 Warn whenever a @code{switch} statement has an index of enumerated type
3283 and lacks a @code{case} for one or more of the named codes of that
3284 enumeration.  (The presence of a @code{default} label prevents this
3285 warning.)  @code{case} labels outside the enumeration range also
3286 provoke warnings when this option is used (even if there is a
3287 @code{default} label).
3288 This warning is enabled by @option{-Wall}.
3289
3290 @item -Wswitch-default
3291 @opindex Wswitch-default
3292 @opindex Wno-switch-default
3293 Warn whenever a @code{switch} statement does not have a @code{default}
3294 case.
3295
3296 @item -Wswitch-enum
3297 @opindex Wswitch-enum
3298 @opindex Wno-switch-enum
3299 Warn whenever a @code{switch} statement has an index of enumerated type
3300 and lacks a @code{case} for one or more of the named codes of that
3301 enumeration.  @code{case} labels outside the enumeration range also
3302 provoke warnings when this option is used.  The only difference
3303 between @option{-Wswitch} and this option is that this option gives a
3304 warning about an omitted enumeration code even if there is a
3305 @code{default} label.
3306
3307 @item -Wsync-nand @r{(C and C++ only)}
3308 @opindex Wsync-nand
3309 @opindex Wno-sync-nand
3310 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3311 built-in functions are used.  These functions changed semantics in GCC 4.4.
3312
3313 @item -Wtrigraphs
3314 @opindex Wtrigraphs
3315 @opindex Wno-trigraphs
3316 Warn if any trigraphs are encountered that might change the meaning of
3317 the program (trigraphs within comments are not warned about).
3318 This warning is enabled by @option{-Wall}.
3319
3320 @item -Wunused-function
3321 @opindex Wunused-function
3322 @opindex Wno-unused-function
3323 Warn whenever a static function is declared but not defined or a
3324 non-inline static function is unused.
3325 This warning is enabled by @option{-Wall}.
3326
3327 @item -Wunused-label
3328 @opindex Wunused-label
3329 @opindex Wno-unused-label
3330 Warn whenever a label is declared but not used.
3331 This warning is enabled by @option{-Wall}.
3332
3333 To suppress this warning use the @samp{unused} attribute
3334 (@pxref{Variable Attributes}).
3335
3336 @item -Wunused-parameter
3337 @opindex Wunused-parameter
3338 @opindex Wno-unused-parameter
3339 Warn whenever a function parameter is unused aside from its declaration.
3340
3341 To suppress this warning use the @samp{unused} attribute
3342 (@pxref{Variable Attributes}).
3343
3344 @item -Wno-unused-result
3345 @opindex Wunused-result
3346 @opindex Wno-unused-result
3347 Do not warn if a caller of a function marked with attribute
3348 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3349 its return value. The default is @option{-Wunused-result}.
3350
3351 @item -Wunused-variable
3352 @opindex Wunused-variable
3353 @opindex Wno-unused-variable
3354 Warn whenever a local variable or non-constant static variable is unused
3355 aside from its declaration.
3356 This warning is enabled by @option{-Wall}.
3357
3358 To suppress this warning use the @samp{unused} attribute
3359 (@pxref{Variable Attributes}).
3360
3361 @item -Wunused-value
3362 @opindex Wunused-value
3363 @opindex Wno-unused-value
3364 Warn whenever a statement computes a result that is explicitly not
3365 used. To suppress this warning cast the unused expression to
3366 @samp{void}. This includes an expression-statement or the left-hand
3367 side of a comma expression that contains no side effects. For example,
3368 an expression such as @samp{x[i,j]} will cause a warning, while
3369 @samp{x[(void)i,j]} will not.
3370
3371 This warning is enabled by @option{-Wall}.
3372
3373 @item -Wunused
3374 @opindex Wunused
3375 @opindex Wno-unused
3376 All the above @option{-Wunused} options combined.
3377
3378 In order to get a warning about an unused function parameter, you must
3379 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3380 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3381
3382 @item -Wuninitialized
3383 @opindex Wuninitialized
3384 @opindex Wno-uninitialized
3385 Warn if an automatic variable is used without first being initialized
3386 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3387 warn if a non-static reference or non-static @samp{const} member
3388 appears in a class without constructors.
3389
3390 If you want to warn about code which uses the uninitialized value of the
3391 variable in its own initializer, use the @option{-Winit-self} option.
3392
3393 These warnings occur for individual uninitialized or clobbered
3394 elements of structure, union or array variables as well as for
3395 variables which are uninitialized or clobbered as a whole.  They do
3396 not occur for variables or elements declared @code{volatile}.  Because
3397 these warnings depend on optimization, the exact variables or elements
3398 for which there are warnings will depend on the precise optimization
3399 options and version of GCC used.
3400
3401 Note that there may be no warning about a variable that is used only
3402 to compute a value that itself is never used, because such
3403 computations may be deleted by data flow analysis before the warnings
3404 are printed.
3405
3406 These warnings are made optional because GCC is not smart
3407 enough to see all the reasons why the code might be correct
3408 despite appearing to have an error.  Here is one example of how
3409 this can happen:
3410
3411 @smallexample
3412 @group
3413 @{
3414   int x;
3415   switch (y)
3416     @{
3417     case 1: x = 1;
3418       break;
3419     case 2: x = 4;
3420       break;
3421     case 3: x = 5;
3422     @}
3423   foo (x);
3424 @}
3425 @end group
3426 @end smallexample
3427
3428 @noindent
3429 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3430 always initialized, but GCC doesn't know this.  Here is
3431 another common case:
3432
3433 @smallexample
3434 @{
3435   int save_y;
3436   if (change_y) save_y = y, y = new_y;
3437   @dots{}
3438   if (change_y) y = save_y;
3439 @}
3440 @end smallexample
3441
3442 @noindent
3443 This has no bug because @code{save_y} is used only if it is set.
3444
3445 @cindex @code{longjmp} warnings
3446 This option also warns when a non-volatile automatic variable might be
3447 changed by a call to @code{longjmp}.  These warnings as well are possible
3448 only in optimizing compilation.
3449
3450 The compiler sees only the calls to @code{setjmp}.  It cannot know
3451 where @code{longjmp} will be called; in fact, a signal handler could
3452 call it at any point in the code.  As a result, you may get a warning
3453 even when there is in fact no problem because @code{longjmp} cannot
3454 in fact be called at the place which would cause a problem.
3455
3456 Some spurious warnings can be avoided if you declare all the functions
3457 you use that never return as @code{noreturn}.  @xref{Function
3458 Attributes}.
3459
3460 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3461
3462 @item -Wunknown-pragmas
3463 @opindex Wunknown-pragmas
3464 @opindex Wno-unknown-pragmas
3465 @cindex warning for unknown pragmas
3466 @cindex unknown pragmas, warning
3467 @cindex pragmas, warning of unknown
3468 Warn when a #pragma directive is encountered which is not understood by
3469 GCC@.  If this command line option is used, warnings will even be issued
3470 for unknown pragmas in system header files.  This is not the case if
3471 the warnings were only enabled by the @option{-Wall} command line option.
3472
3473 @item -Wno-pragmas
3474 @opindex Wno-pragmas
3475 @opindex Wpragmas
3476 Do not warn about misuses of pragmas, such as incorrect parameters,
3477 invalid syntax, or conflicts between pragmas.  See also
3478 @samp{-Wunknown-pragmas}.
3479
3480 @item -Wstrict-aliasing
3481 @opindex Wstrict-aliasing
3482 @opindex Wno-strict-aliasing
3483 This option is only active when @option{-fstrict-aliasing} is active.
3484 It warns about code which might break the strict aliasing rules that the
3485 compiler is using for optimization.  The warning does not catch all
3486 cases, but does attempt to catch the more common pitfalls.  It is
3487 included in @option{-Wall}.
3488 It is equivalent to @option{-Wstrict-aliasing=3}
3489
3490 @item -Wstrict-aliasing=n
3491 @opindex Wstrict-aliasing=n
3492 @opindex Wno-strict-aliasing=n
3493 This option is only active when @option{-fstrict-aliasing} is active.
3494 It warns about code which might break the strict aliasing rules that the
3495 compiler is using for optimization.
3496 Higher levels correspond to higher accuracy (fewer false positives).
3497 Higher levels also correspond to more effort, similar to the way -O works.
3498 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3499 with n=3.
3500
3501 Level 1: Most aggressive, quick, least accurate.
3502 Possibly useful when higher levels
3503 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3504 false negatives.  However, it has many false positives.
3505 Warns for all pointer conversions between possibly incompatible types,
3506 even if never dereferenced.  Runs in the frontend only.
3507
3508 Level 2: Aggressive, quick, not too precise.
3509 May still have many false positives (not as many as level 1 though),
3510 and few false negatives (but possibly more than level 1).
3511 Unlike level 1, it only warns when an address is taken.  Warns about
3512 incomplete types.  Runs in the frontend only.
3513
3514 Level 3 (default for @option{-Wstrict-aliasing}):
3515 Should have very few false positives and few false
3516 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3517 Takes care of the common pun+dereference pattern in the frontend:
3518 @code{*(int*)&some_float}.
3519 If optimization is enabled, it also runs in the backend, where it deals
3520 with multiple statement cases using flow-sensitive points-to information.
3521 Only warns when the converted pointer is dereferenced.
3522 Does not warn about incomplete types.
3523
3524 @item -Wstrict-overflow
3525 @itemx -Wstrict-overflow=@var{n}
3526 @opindex Wstrict-overflow
3527 @opindex Wno-strict-overflow
3528 This option is only active when @option{-fstrict-overflow} is active.
3529 It warns about cases where the compiler optimizes based on the
3530 assumption that signed overflow does not occur.  Note that it does not
3531 warn about all cases where the code might overflow: it only warns
3532 about cases where the compiler implements some optimization.  Thus
3533 this warning depends on the optimization level.
3534
3535 An optimization which assumes that signed overflow does not occur is
3536 perfectly safe if the values of the variables involved are such that
3537 overflow never does, in fact, occur.  Therefore this warning can
3538 easily give a false positive: a warning about code which is not
3539 actually a problem.  To help focus on important issues, several
3540 warning levels are defined.  No warnings are issued for the use of
3541 undefined signed overflow when estimating how many iterations a loop
3542 will require, in particular when determining whether a loop will be
3543 executed at all.
3544
3545 @table @gcctabopt
3546 @item -Wstrict-overflow=1
3547 Warn about cases which are both questionable and easy to avoid.  For
3548 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3549 compiler will simplify this to @code{1}.  This level of
3550 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3551 are not, and must be explicitly requested.
3552
3553 @item -Wstrict-overflow=2
3554 Also warn about other cases where a comparison is simplified to a
3555 constant.  For example: @code{abs (x) >= 0}.  This can only be
3556 simplified when @option{-fstrict-overflow} is in effect, because
3557 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3558 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3559 @option{-Wstrict-overflow=2}.
3560
3561 @item -Wstrict-overflow=3
3562 Also warn about other cases where a comparison is simplified.  For
3563 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3564
3565 @item -Wstrict-overflow=4
3566 Also warn about other simplifications not covered by the above cases.
3567 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3568
3569 @item -Wstrict-overflow=5
3570 Also warn about cases where the compiler reduces the magnitude of a
3571 constant involved in a comparison.  For example: @code{x + 2 > y} will
3572 be simplified to @code{x + 1 >= y}.  This is reported only at the
3573 highest warning level because this simplification applies to many
3574 comparisons, so this warning level will give a very large number of
3575 false positives.
3576 @end table
3577
3578 @item -Warray-bounds
3579 @opindex Wno-array-bounds
3580 @opindex Warray-bounds
3581 This option is only active when @option{-ftree-vrp} is active
3582 (default for -O2 and above). It warns about subscripts to arrays
3583 that are always out of bounds. This warning is enabled by @option{-Wall}.
3584
3585 @item -Wno-div-by-zero
3586 @opindex Wno-div-by-zero
3587 @opindex Wdiv-by-zero
3588 Do not warn about compile-time integer division by zero.  Floating point
3589 division by zero is not warned about, as it can be a legitimate way of
3590 obtaining infinities and NaNs.
3591
3592 @item -Wsystem-headers
3593 @opindex Wsystem-headers
3594 @opindex Wno-system-headers
3595 @cindex warnings from system headers
3596 @cindex system headers, warnings from
3597 Print warning messages for constructs found in system header files.
3598 Warnings from system headers are normally suppressed, on the assumption
3599 that they usually do not indicate real problems and would only make the
3600 compiler output harder to read.  Using this command line option tells
3601 GCC to emit warnings from system headers as if they occurred in user
3602 code.  However, note that using @option{-Wall} in conjunction with this
3603 option will @emph{not} warn about unknown pragmas in system
3604 headers---for that, @option{-Wunknown-pragmas} must also be used.
3605
3606 @item -Wfloat-equal
3607 @opindex Wfloat-equal
3608 @opindex Wno-float-equal
3609 Warn if floating point values are used in equality comparisons.
3610
3611 The idea behind this is that sometimes it is convenient (for the
3612 programmer) to consider floating-point values as approximations to
3613 infinitely precise real numbers.  If you are doing this, then you need
3614 to compute (by analyzing the code, or in some other way) the maximum or
3615 likely maximum error that the computation introduces, and allow for it
3616 when performing comparisons (and when producing output, but that's a
3617 different problem).  In particular, instead of testing for equality, you
3618 would check to see whether the two values have ranges that overlap; and
3619 this is done with the relational operators, so equality comparisons are
3620 probably mistaken.
3621
3622 @item -Wtraditional @r{(C and Objective-C only)}
3623 @opindex Wtraditional
3624 @opindex Wno-traditional
3625 Warn about certain constructs that behave differently in traditional and
3626 ISO C@.  Also warn about ISO C constructs that have no traditional C
3627 equivalent, and/or problematic constructs which should be avoided.
3628
3629 @itemize @bullet
3630 @item
3631 Macro parameters that appear within string literals in the macro body.
3632 In traditional C macro replacement takes place within string literals,
3633 but does not in ISO C@.
3634
3635 @item
3636 In traditional C, some preprocessor directives did not exist.
3637 Traditional preprocessors would only consider a line to be a directive
3638 if the @samp{#} appeared in column 1 on the line.  Therefore
3639 @option{-Wtraditional} warns about directives that traditional C
3640 understands but would ignore because the @samp{#} does not appear as the
3641 first character on the line.  It also suggests you hide directives like
3642 @samp{#pragma} not understood by traditional C by indenting them.  Some
3643 traditional implementations would not recognize @samp{#elif}, so it
3644 suggests avoiding it altogether.
3645
3646 @item
3647 A function-like macro that appears without arguments.
3648
3649 @item
3650 The unary plus operator.
3651
3652 @item
3653 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3654 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3655 constants.)  Note, these suffixes appear in macros defined in the system
3656 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3657 Use of these macros in user code might normally lead to spurious
3658 warnings, however GCC's integrated preprocessor has enough context to
3659 avoid warning in these cases.
3660
3661 @item
3662 A function declared external in one block and then used after the end of
3663 the block.
3664
3665 @item
3666 A @code{switch} statement has an operand of type @code{long}.
3667
3668 @item
3669 A non-@code{static} function declaration follows a @code{static} one.
3670 This construct is not accepted by some traditional C compilers.
3671
3672 @item
3673 The ISO type of an integer constant has a different width or
3674 signedness from its traditional type.  This warning is only issued if
3675 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3676 typically represent bit patterns, are not warned about.
3677
3678 @item
3679 Usage of ISO string concatenation is detected.
3680
3681 @item
3682 Initialization of automatic aggregates.
3683
3684 @item
3685 Identifier conflicts with labels.  Traditional C lacks a separate
3686 namespace for labels.
3687
3688 @item
3689 Initialization of unions.  If the initializer is zero, the warning is
3690 omitted.  This is done under the assumption that the zero initializer in
3691 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3692 initializer warnings and relies on default initialization to zero in the
3693 traditional C case.
3694
3695 @item
3696 Conversions by prototypes between fixed/floating point values and vice
3697 versa.  The absence of these prototypes when compiling with traditional
3698 C would cause serious problems.  This is a subset of the possible
3699 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3700
3701 @item
3702 Use of ISO C style function definitions.  This warning intentionally is
3703 @emph{not} issued for prototype declarations or variadic functions
3704 because these ISO C features will appear in your code when using
3705 libiberty's traditional C compatibility macros, @code{PARAMS} and
3706 @code{VPARAMS}.  This warning is also bypassed for nested functions
3707 because that feature is already a GCC extension and thus not relevant to
3708 traditional C compatibility.
3709 @end itemize
3710
3711 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3712 @opindex Wtraditional-conversion
3713 @opindex Wno-traditional-conversion
3714 Warn if a prototype causes a type conversion that is different from what
3715 would happen to the same argument in the absence of a prototype.  This
3716 includes conversions of fixed point to floating and vice versa, and
3717 conversions changing the width or signedness of a fixed point argument
3718 except when the same as the default promotion.
3719
3720 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3721 @opindex Wdeclaration-after-statement
3722 @opindex Wno-declaration-after-statement
3723 Warn when a declaration is found after a statement in a block.  This
3724 construct, known from C++, was introduced with ISO C99 and is by default
3725 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3726 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3727
3728 @item -Wundef
3729 @opindex Wundef
3730 @opindex Wno-undef
3731 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3732
3733 @item -Wno-endif-labels
3734 @opindex Wno-endif-labels
3735 @opindex Wendif-labels
3736 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3737
3738 @item -Wshadow
3739 @opindex Wshadow
3740 @opindex Wno-shadow
3741 Warn whenever a local variable shadows another local variable, parameter or
3742 global variable or whenever a built-in function is shadowed.
3743
3744 @item -Wlarger-than=@var{len}
3745 @opindex Wlarger-than=@var{len}
3746 @opindex Wlarger-than-@var{len}
3747 Warn whenever an object of larger than @var{len} bytes is defined.
3748
3749 @item -Wframe-larger-than=@var{len}
3750 @opindex Wframe-larger-than
3751 Warn if the size of a function frame is larger than @var{len} bytes.
3752 The computation done to determine the stack frame size is approximate
3753 and not conservative.
3754 The actual requirements may be somewhat greater than @var{len}
3755 even if you do not get a warning.  In addition, any space allocated
3756 via @code{alloca}, variable-length arrays, or related constructs
3757 is not included by the compiler when determining
3758 whether or not to issue a warning.
3759
3760 @item -Wunsafe-loop-optimizations
3761 @opindex Wunsafe-loop-optimizations
3762 @opindex Wno-unsafe-loop-optimizations
3763 Warn if the loop cannot be optimized because the compiler could not
3764 assume anything on the bounds of the loop indices.  With
3765 @option{-funsafe-loop-optimizations} warn if the compiler made
3766 such assumptions.
3767
3768 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3769 @opindex Wno-pedantic-ms-format
3770 @opindex Wpedantic-ms-format
3771 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3772 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3773 depending on the MS runtime, when you are using the options @option{-Wformat}
3774 and @option{-pedantic} without gnu-extensions.
3775
3776 @item -Wpointer-arith
3777 @opindex Wpointer-arith
3778 @opindex Wno-pointer-arith
3779 Warn about anything that depends on the ``size of'' a function type or
3780 of @code{void}.  GNU C assigns these types a size of 1, for
3781 convenience in calculations with @code{void *} pointers and pointers
3782 to functions.  In C++, warn also when an arithmetic operation involves
3783 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3784
3785 @item -Wtype-limits
3786 @opindex Wtype-limits
3787 @opindex Wno-type-limits
3788 Warn if a comparison is always true or always false due to the limited
3789 range of the data type, but do not warn for constant expressions.  For
3790 example, warn if an unsigned variable is compared against zero with
3791 @samp{<} or @samp{>=}.  This warning is also enabled by
3792 @option{-Wextra}.
3793
3794 @item -Wbad-function-cast @r{(C and Objective-C only)}
3795 @opindex Wbad-function-cast
3796 @opindex Wno-bad-function-cast
3797 Warn whenever a function call is cast to a non-matching type.
3798 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3799
3800 @item -Wc++-compat @r{(C and Objective-C only)}
3801 Warn about ISO C constructs that are outside of the common subset of
3802 ISO C and ISO C++, e.g.@: request for implicit conversion from
3803 @code{void *} to a pointer to non-@code{void} type.
3804
3805 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3806 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3807 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3808 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3809
3810 @item -Wcast-qual
3811 @opindex Wcast-qual
3812 @opindex Wno-cast-qual
3813 Warn whenever a pointer is cast so as to remove a type qualifier from
3814 the target type.  For example, warn if a @code{const char *} is cast
3815 to an ordinary @code{char *}.
3816
3817 Also warn when making a cast which introduces a type qualifier in an
3818 unsafe way.  For example, casting @code{char **} to @code{const char **}
3819 is unsafe, as in this example:
3820
3821 @smallexample
3822   /* p is char ** value.  */
3823   const char **q = (const char **) p;
3824   /* Assignment of readonly string to const char * is OK.  */
3825   *q = "string";
3826   /* Now char** pointer points to read-only memory.  */
3827   **p = 'b';
3828 @end smallexample
3829
3830 @item -Wcast-align
3831 @opindex Wcast-align
3832 @opindex Wno-cast-align
3833 Warn whenever a pointer is cast such that the required alignment of the
3834 target is increased.  For example, warn if a @code{char *} is cast to
3835 an @code{int *} on machines where integers can only be accessed at
3836 two- or four-byte boundaries.
3837
3838 @item -Wwrite-strings
3839 @opindex Wwrite-strings
3840 @opindex Wno-write-strings
3841 When compiling C, give string constants the type @code{const
3842 char[@var{length}]} so that copying the address of one into a
3843 non-@code{const} @code{char *} pointer will get a warning.  These
3844 warnings will help you find at compile time code that can try to write
3845 into a string constant, but only if you have been very careful about
3846 using @code{const} in declarations and prototypes.  Otherwise, it will
3847 just be a nuisance. This is why we did not make @option{-Wall} request
3848 these warnings.
3849
3850 When compiling C++, warn about the deprecated conversion from string
3851 literals to @code{char *}.  This warning is enabled by default for C++
3852 programs.
3853
3854 @item -Wclobbered
3855 @opindex Wclobbered
3856 @opindex Wno-clobbered
3857 Warn for variables that might be changed by @samp{longjmp} or
3858 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3859
3860 @item -Wconversion
3861 @opindex Wconversion
3862 @opindex Wno-conversion
3863 Warn for implicit conversions that may alter a value. This includes
3864 conversions between real and integer, like @code{abs (x)} when
3865 @code{x} is @code{double}; conversions between signed and unsigned,
3866 like @code{unsigned ui = -1}; and conversions to smaller types, like
3867 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3868 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3869 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3870 conversions between signed and unsigned integers can be disabled by
3871 using @option{-Wno-sign-conversion}.
3872
3873 For C++, also warn for confusing overload resolution for user-defined
3874 conversions; and conversions that will never use a type conversion
3875 operator: conversions to @code{void}, the same type, a base class or a
3876 reference to them. Warnings about conversions between signed and
3877 unsigned integers are disabled by default in C++ unless
3878 @option{-Wsign-conversion} is explicitly enabled.
3879
3880 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
3881 @opindex Wconversion-null
3882 @opindex Wno-conversion-null
3883 Do not warn for conversions between @code{NULL} and non-pointer
3884 types. @option{-Wconversion-null} is enabled by default.
3885
3886 @item -Wempty-body
3887 @opindex Wempty-body
3888 @opindex Wno-empty-body
3889 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3890 while} statement.  This warning is also enabled by @option{-Wextra}.
3891
3892 @item -Wenum-compare
3893 @opindex Wenum-compare
3894 @opindex Wno-enum-compare
3895 Warn about a comparison between values of different enum types. In C++
3896 this warning is enabled by default.  In C this warning is enabled by
3897 @option{-Wall}.
3898
3899 @item -Wjump-misses-init @r{(C, Objective-C only)}
3900 @opindex Wjump-misses-init
3901 @opindex Wno-jump-misses-init
3902 Warn if a @code{goto} statement or a @code{switch} statement jumps
3903 forward across the initialization of a variable, or jumps backward to a
3904 label after the variable has been initialized.  This only warns about
3905 variables which are initialized when they are declared.  This warning is
3906 only supported for C and Objective C; in C++ this sort of branch is an
3907 error in any case.
3908
3909 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
3910 can be disabled with the @option{-Wno-jump-misses-init} option.
3911
3912 @item -Wsign-compare
3913 @opindex Wsign-compare
3914 @opindex Wno-sign-compare
3915 @cindex warning for comparison of signed and unsigned values
3916 @cindex comparison of signed and unsigned values, warning
3917 @cindex signed and unsigned values, comparison warning
3918 Warn when a comparison between signed and unsigned values could produce
3919 an incorrect result when the signed value is converted to unsigned.
3920 This warning is also enabled by @option{-Wextra}; to get the other warnings
3921 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3922
3923 @item -Wsign-conversion
3924 @opindex Wsign-conversion
3925 @opindex Wno-sign-conversion
3926 Warn for implicit conversions that may change the sign of an integer
3927 value, like assigning a signed integer expression to an unsigned
3928 integer variable. An explicit cast silences the warning. In C, this
3929 option is enabled also by @option{-Wconversion}.
3930
3931 @item -Waddress
3932 @opindex Waddress
3933 @opindex Wno-address
3934 Warn about suspicious uses of memory addresses. These include using
3935 the address of a function in a conditional expression, such as
3936 @code{void func(void); if (func)}, and comparisons against the memory
3937 address of a string literal, such as @code{if (x == "abc")}.  Such
3938 uses typically indicate a programmer error: the address of a function
3939 always evaluates to true, so their use in a conditional usually
3940 indicate that the programmer forgot the parentheses in a function
3941 call; and comparisons against string literals result in unspecified
3942 behavior and are not portable in C, so they usually indicate that the
3943 programmer intended to use @code{strcmp}.  This warning is enabled by
3944 @option{-Wall}.
3945
3946 @item -Wlogical-op
3947 @opindex Wlogical-op
3948 @opindex Wno-logical-op
3949 Warn about suspicious uses of logical operators in expressions.
3950 This includes using logical operators in contexts where a
3951 bit-wise operator is likely to be expected.
3952
3953 @item -Waggregate-return
3954 @opindex Waggregate-return
3955 @opindex Wno-aggregate-return
3956 Warn if any functions that return structures or unions are defined or
3957 called.  (In languages where you can return an array, this also elicits
3958 a warning.)
3959
3960 @item -Wno-attributes
3961 @opindex Wno-attributes
3962 @opindex Wattributes
3963 Do not warn if an unexpected @code{__attribute__} is used, such as
3964 unrecognized attributes, function attributes applied to variables,
3965 etc.  This will not stop errors for incorrect use of supported
3966 attributes.
3967
3968 @item -Wno-builtin-macro-redefined
3969 @opindex Wno-builtin-macro-redefined
3970 @opindex Wbuiltin-macro-redefined
3971 Do not warn if certain built-in macros are redefined.  This suppresses
3972 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
3973 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
3974
3975 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3976 @opindex Wstrict-prototypes
3977 @opindex Wno-strict-prototypes
3978 Warn if a function is declared or defined without specifying the
3979 argument types.  (An old-style function definition is permitted without
3980 a warning if preceded by a declaration which specifies the argument
3981 types.)
3982
3983 @item -Wold-style-declaration @r{(C and Objective-C only)}
3984 @opindex Wold-style-declaration
3985 @opindex Wno-old-style-declaration
3986 Warn for obsolescent usages, according to the C Standard, in a
3987 declaration. For example, warn if storage-class specifiers like
3988 @code{static} are not the first things in a declaration.  This warning
3989 is also enabled by @option{-Wextra}.
3990
3991 @item -Wold-style-definition @r{(C and Objective-C only)}
3992 @opindex Wold-style-definition
3993 @opindex Wno-old-style-definition
3994 Warn if an old-style function definition is used.  A warning is given
3995 even if there is a previous prototype.
3996
3997 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3998 @opindex Wmissing-parameter-type
3999 @opindex Wno-missing-parameter-type
4000 A function parameter is declared without a type specifier in K&R-style
4001 functions:
4002
4003 @smallexample
4004 void foo(bar) @{ @}
4005 @end smallexample
4006
4007 This warning is also enabled by @option{-Wextra}.
4008
4009 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4010 @opindex Wmissing-prototypes
4011 @opindex Wno-missing-prototypes
4012 Warn if a global function is defined without a previous prototype
4013 declaration.  This warning is issued even if the definition itself
4014 provides a prototype.  The aim is to detect global functions that fail
4015 to be declared in header files.
4016
4017 @item -Wmissing-declarations
4018 @opindex Wmissing-declarations
4019 @opindex Wno-missing-declarations
4020 Warn if a global function is defined without a previous declaration.
4021 Do so even if the definition itself provides a prototype.
4022 Use this option to detect global functions that are not declared in
4023 header files.  In C++, no warnings are issued for function templates,
4024 or for inline functions, or for functions in anonymous namespaces.
4025
4026 @item -Wmissing-field-initializers
4027 @opindex Wmissing-field-initializers
4028 @opindex Wno-missing-field-initializers
4029 @opindex W
4030 @opindex Wextra
4031 @opindex Wno-extra
4032 Warn if a structure's initializer has some fields missing.  For
4033 example, the following code would cause such a warning, because
4034 @code{x.h} is implicitly zero:
4035
4036 @smallexample
4037 struct s @{ int f, g, h; @};
4038 struct s x = @{ 3, 4 @};
4039 @end smallexample
4040
4041 This option does not warn about designated initializers, so the following
4042 modification would not trigger a warning:
4043
4044 @smallexample
4045 struct s @{ int f, g, h; @};
4046 struct s x = @{ .f = 3, .g = 4 @};
4047 @end smallexample
4048
4049 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4050 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4051
4052 @item -Wmissing-noreturn
4053 @opindex Wmissing-noreturn
4054 @opindex Wno-missing-noreturn
4055 Warn about functions which might be candidates for attribute @code{noreturn}.
4056 Note these are only possible candidates, not absolute ones.  Care should
4057 be taken to manually verify functions actually do not ever return before
4058 adding the @code{noreturn} attribute, otherwise subtle code generation
4059 bugs could be introduced.  You will not get a warning for @code{main} in
4060 hosted C environments.
4061
4062 @item -Wmissing-format-attribute
4063 @opindex Wmissing-format-attribute
4064 @opindex Wno-missing-format-attribute
4065 @opindex Wformat
4066 @opindex Wno-format
4067 Warn about function pointers which might be candidates for @code{format}
4068 attributes.  Note these are only possible candidates, not absolute ones.
4069 GCC will guess that function pointers with @code{format} attributes that
4070 are used in assignment, initialization, parameter passing or return
4071 statements should have a corresponding @code{format} attribute in the
4072 resulting type.  I.e.@: the left-hand side of the assignment or
4073 initialization, the type of the parameter variable, or the return type
4074 of the containing function respectively should also have a @code{format}
4075 attribute to avoid the warning.
4076
4077 GCC will also warn about function definitions which might be
4078 candidates for @code{format} attributes.  Again, these are only
4079 possible candidates.  GCC will guess that @code{format} attributes
4080 might be appropriate for any function that calls a function like
4081 @code{vprintf} or @code{vscanf}, but this might not always be the
4082 case, and some functions for which @code{format} attributes are
4083 appropriate may not be detected.
4084
4085 @item -Wno-multichar
4086 @opindex Wno-multichar
4087 @opindex Wmultichar
4088 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4089 Usually they indicate a typo in the user's code, as they have
4090 implementation-defined values, and should not be used in portable code.
4091
4092 @item -Wnormalized=<none|id|nfc|nfkc>
4093 @opindex Wnormalized=
4094 @cindex NFC
4095 @cindex NFKC
4096 @cindex character set, input normalization
4097 In ISO C and ISO C++, two identifiers are different if they are
4098 different sequences of characters.  However, sometimes when characters
4099 outside the basic ASCII character set are used, you can have two
4100 different character sequences that look the same.  To avoid confusion,
4101 the ISO 10646 standard sets out some @dfn{normalization rules} which
4102 when applied ensure that two sequences that look the same are turned into
4103 the same sequence.  GCC can warn you if you are using identifiers which
4104 have not been normalized; this option controls that warning.
4105
4106 There are four levels of warning that GCC supports.  The default is
4107 @option{-Wnormalized=nfc}, which warns about any identifier which is
4108 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4109 recommended form for most uses.
4110
4111 Unfortunately, there are some characters which ISO C and ISO C++ allow
4112 in identifiers that when turned into NFC aren't allowable as
4113 identifiers.  That is, there's no way to use these symbols in portable
4114 ISO C or C++ and have all your identifiers in NFC@.
4115 @option{-Wnormalized=id} suppresses the warning for these characters.
4116 It is hoped that future versions of the standards involved will correct
4117 this, which is why this option is not the default.
4118
4119 You can switch the warning off for all characters by writing
4120 @option{-Wnormalized=none}.  You would only want to do this if you
4121 were using some other normalization scheme (like ``D''), because
4122 otherwise you can easily create bugs that are literally impossible to see.
4123
4124 Some characters in ISO 10646 have distinct meanings but look identical
4125 in some fonts or display methodologies, especially once formatting has
4126 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4127 LETTER N'', will display just like a regular @code{n} which has been
4128 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4129 normalization scheme to convert all these into a standard form as
4130 well, and GCC will warn if your code is not in NFKC if you use
4131 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4132 about every identifier that contains the letter O because it might be
4133 confused with the digit 0, and so is not the default, but may be
4134 useful as a local coding convention if the programming environment is
4135 unable to be fixed to display these characters distinctly.
4136
4137 @item -Wno-deprecated
4138 @opindex Wno-deprecated
4139 @opindex Wdeprecated
4140 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4141
4142 @item -Wno-deprecated-declarations
4143 @opindex Wno-deprecated-declarations
4144 @opindex Wdeprecated-declarations
4145 Do not warn about uses of functions (@pxref{Function Attributes}),
4146 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4147 Attributes}) marked as deprecated by using the @code{deprecated}
4148 attribute.
4149
4150 @item -Wno-overflow
4151 @opindex Wno-overflow
4152 @opindex Woverflow
4153 Do not warn about compile-time overflow in constant expressions.
4154
4155 @item -Woverride-init @r{(C and Objective-C only)}
4156 @opindex Woverride-init
4157 @opindex Wno-override-init
4158 @opindex W
4159 @opindex Wextra
4160 @opindex Wno-extra
4161 Warn if an initialized field without side effects is overridden when
4162 using designated initializers (@pxref{Designated Inits, , Designated
4163 Initializers}).
4164
4165 This warning is included in @option{-Wextra}.  To get other
4166 @option{-Wextra} warnings without this one, use @samp{-Wextra
4167 -Wno-override-init}.
4168
4169 @item -Wpacked
4170 @opindex Wpacked
4171 @opindex Wno-packed
4172 Warn if a structure is given the packed attribute, but the packed
4173 attribute has no effect on the layout or size of the structure.
4174 Such structures may be mis-aligned for little benefit.  For
4175 instance, in this code, the variable @code{f.x} in @code{struct bar}
4176 will be misaligned even though @code{struct bar} does not itself
4177 have the packed attribute:
4178
4179 @smallexample
4180 @group
4181 struct foo @{
4182   int x;
4183   char a, b, c, d;
4184 @} __attribute__((packed));
4185 struct bar @{
4186   char z;
4187   struct foo f;
4188 @};
4189 @end group
4190 @end smallexample
4191
4192 @item -Wpacked-bitfield-compat
4193 @opindex Wpacked-bitfield-compat
4194 @opindex Wno-packed-bitfield-compat
4195 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4196 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4197 the change can lead to differences in the structure layout.  GCC
4198 informs you when the offset of such a field has changed in GCC 4.4.
4199 For example there is no longer a 4-bit padding between field @code{a}
4200 and @code{b} in this structure:
4201
4202 @smallexample
4203 struct foo
4204 @{
4205   char a:4;
4206   char b:8;
4207 @} __attribute__ ((packed));
4208 @end smallexample
4209
4210 This warning is enabled by default.  Use
4211 @option{-Wno-packed-bitfield-compat} to disable this warning.
4212
4213 @item -Wpadded
4214 @opindex Wpadded
4215 @opindex Wno-padded
4216 Warn if padding is included in a structure, either to align an element
4217 of the structure or to align the whole structure.  Sometimes when this
4218 happens it is possible to rearrange the fields of the structure to
4219 reduce the padding and so make the structure smaller.
4220
4221 @item -Wredundant-decls
4222 @opindex Wredundant-decls
4223 @opindex Wno-redundant-decls
4224 Warn if anything is declared more than once in the same scope, even in
4225 cases where multiple declaration is valid and changes nothing.
4226
4227 @item -Wnested-externs @r{(C and Objective-C only)}
4228 @opindex Wnested-externs
4229 @opindex Wno-nested-externs
4230 Warn if an @code{extern} declaration is encountered within a function.
4231
4232 @item -Winline
4233 @opindex Winline
4234 @opindex Wno-inline
4235 Warn if a function can not be inlined and it was declared as inline.
4236 Even with this option, the compiler will not warn about failures to
4237 inline functions declared in system headers.
4238
4239 The compiler uses a variety of heuristics to determine whether or not
4240 to inline a function.  For example, the compiler takes into account
4241 the size of the function being inlined and the amount of inlining
4242 that has already been done in the current function.  Therefore,
4243 seemingly insignificant changes in the source program can cause the
4244 warnings produced by @option{-Winline} to appear or disappear.
4245
4246 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4247 @opindex Wno-invalid-offsetof
4248 @opindex Winvalid-offsetof
4249 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4250 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4251 to a non-POD type is undefined.  In existing C++ implementations,
4252 however, @samp{offsetof} typically gives meaningful results even when
4253 applied to certain kinds of non-POD types. (Such as a simple
4254 @samp{struct} that fails to be a POD type only by virtue of having a
4255 constructor.)  This flag is for users who are aware that they are
4256 writing nonportable code and who have deliberately chosen to ignore the
4257 warning about it.
4258
4259 The restrictions on @samp{offsetof} may be relaxed in a future version
4260 of the C++ standard.
4261
4262 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4263 @opindex Wno-int-to-pointer-cast
4264 @opindex Wint-to-pointer-cast
4265 Suppress warnings from casts to pointer type of an integer of a
4266 different size.
4267
4268 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4269 @opindex Wno-pointer-to-int-cast
4270 @opindex Wpointer-to-int-cast
4271 Suppress warnings from casts from a pointer to an integer type of a
4272 different size.
4273
4274 @item -Winvalid-pch
4275 @opindex Winvalid-pch
4276 @opindex Wno-invalid-pch
4277 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4278 the search path but can't be used.
4279
4280 @item -Wlong-long
4281 @opindex Wlong-long
4282 @opindex Wno-long-long
4283 Warn if @samp{long long} type is used.  This is enabled by either
4284 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4285 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4286
4287 @item -Wvariadic-macros
4288 @opindex Wvariadic-macros
4289 @opindex Wno-variadic-macros
4290 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4291 alternate syntax when in pedantic ISO C99 mode.  This is default.
4292 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4293
4294 @item -Wvla
4295 @opindex Wvla
4296 @opindex Wno-vla
4297 Warn if variable length array is used in the code.
4298 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4299 the variable length array.
4300
4301 @item -Wvolatile-register-var
4302 @opindex Wvolatile-register-var
4303 @opindex Wno-volatile-register-var
4304 Warn if a register variable is declared volatile.  The volatile
4305 modifier does not inhibit all optimizations that may eliminate reads
4306 and/or writes to register variables.  This warning is enabled by
4307 @option{-Wall}.
4308
4309 @item -Wdisabled-optimization
4310 @opindex Wdisabled-optimization
4311 @opindex Wno-disabled-optimization
4312 Warn if a requested optimization pass is disabled.  This warning does
4313 not generally indicate that there is anything wrong with your code; it
4314 merely indicates that GCC's optimizers were unable to handle the code
4315 effectively.  Often, the problem is that your code is too big or too
4316 complex; GCC will refuse to optimize programs when the optimization
4317 itself is likely to take inordinate amounts of time.
4318
4319 @item -Wpointer-sign @r{(C and Objective-C only)}
4320 @opindex Wpointer-sign
4321 @opindex Wno-pointer-sign
4322 Warn for pointer argument passing or assignment with different signedness.
4323 This option is only supported for C and Objective-C@.  It is implied by
4324 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4325 @option{-Wno-pointer-sign}.
4326
4327 @item -Wstack-protector
4328 @opindex Wstack-protector
4329 @opindex Wno-stack-protector
4330 This option is only active when @option{-fstack-protector} is active.  It
4331 warns about functions that will not be protected against stack smashing.
4332
4333 @item -Wno-mudflap
4334 @opindex Wno-mudflap
4335 Suppress warnings about constructs that cannot be instrumented by
4336 @option{-fmudflap}.
4337
4338 @item -Woverlength-strings
4339 @opindex Woverlength-strings
4340 @opindex Wno-overlength-strings
4341 Warn about string constants which are longer than the ``minimum
4342 maximum'' length specified in the C standard.  Modern compilers
4343 generally allow string constants which are much longer than the
4344 standard's minimum limit, but very portable programs should avoid
4345 using longer strings.
4346
4347 The limit applies @emph{after} string constant concatenation, and does
4348 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4349 C99, it was raised to 4095.  C++98 does not specify a normative
4350 minimum maximum, so we do not diagnose overlength strings in C++@.
4351
4352 This option is implied by @option{-pedantic}, and can be disabled with
4353 @option{-Wno-overlength-strings}.
4354
4355 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4356 @opindex Wunsuffixed-float-constants
4357
4358 GCC will issue a warning for any floating constant that does not have
4359 a suffix.  When used together with @option{-Wsystem-headers} it will
4360 warn about such constants in system header files.  This can be useful
4361 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4362 from the decimal floating-point extension to C99.
4363 @end table
4364
4365 @node Debugging Options
4366 @section Options for Debugging Your Program or GCC
4367 @cindex options, debugging
4368 @cindex debugging information options
4369
4370 GCC has various special options that are used for debugging
4371 either your program or GCC:
4372
4373 @table @gcctabopt
4374 @item -g
4375 @opindex g
4376 Produce debugging information in the operating system's native format
4377 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4378 information.
4379
4380 On most systems that use stabs format, @option{-g} enables use of extra
4381 debugging information that only GDB can use; this extra information
4382 makes debugging work better in GDB but will probably make other debuggers
4383 crash or
4384 refuse to read the program.  If you want to control for certain whether
4385 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4386 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4387
4388 GCC allows you to use @option{-g} with
4389 @option{-O}.  The shortcuts taken by optimized code may occasionally
4390 produce surprising results: some variables you declared may not exist
4391 at all; flow of control may briefly move where you did not expect it;
4392 some statements may not be executed because they compute constant
4393 results or their values were already at hand; some statements may
4394 execute in different places because they were moved out of loops.
4395
4396 Nevertheless it proves possible to debug optimized output.  This makes
4397 it reasonable to use the optimizer for programs that might have bugs.
4398
4399 The following options are useful when GCC is generated with the
4400 capability for more than one debugging format.
4401
4402 @item -ggdb
4403 @opindex ggdb
4404 Produce debugging information for use by GDB@.  This means to use the
4405 most expressive format available (DWARF 2, stabs, or the native format
4406 if neither of those are supported), including GDB extensions if at all
4407 possible.
4408
4409 @item -gstabs
4410 @opindex gstabs
4411 Produce debugging information in stabs format (if that is supported),
4412 without GDB extensions.  This is the format used by DBX on most BSD
4413 systems.  On MIPS, Alpha and System V Release 4 systems this option
4414 produces stabs debugging output which is not understood by DBX or SDB@.
4415 On System V Release 4 systems this option requires the GNU assembler.
4416
4417 @item -feliminate-unused-debug-symbols
4418 @opindex feliminate-unused-debug-symbols
4419 Produce debugging information in stabs format (if that is supported),
4420 for only symbols that are actually used.
4421
4422 @item -femit-class-debug-always
4423 Instead of emitting debugging information for a C++ class in only one
4424 object file, emit it in all object files using the class.  This option
4425 should be used only with debuggers that are unable to handle the way GCC
4426 normally emits debugging information for classes because using this
4427 option will increase the size of debugging information by as much as a
4428 factor of two.
4429
4430 @item -gstabs+
4431 @opindex gstabs+
4432 Produce debugging information in stabs format (if that is supported),
4433 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4434 use of these extensions is likely to make other debuggers crash or
4435 refuse to read the program.
4436
4437 @item -gcoff
4438 @opindex gcoff
4439 Produce debugging information in COFF format (if that is supported).
4440 This is the format used by SDB on most System V systems prior to
4441 System V Release 4.
4442
4443 @item -gxcoff
4444 @opindex gxcoff
4445 Produce debugging information in XCOFF format (if that is supported).
4446 This is the format used by the DBX debugger on IBM RS/6000 systems.
4447
4448 @item -gxcoff+
4449 @opindex gxcoff+
4450 Produce debugging information in XCOFF format (if that is supported),
4451 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4452 use of these extensions is likely to make other debuggers crash or
4453 refuse to read the program, and may cause assemblers other than the GNU
4454 assembler (GAS) to fail with an error.
4455
4456 @item -gdwarf-@var{version}
4457 @opindex gdwarf-@var{version}
4458 Produce debugging information in DWARF format (if that is
4459 supported).  This is the format used by DBX on IRIX 6.  The value
4460 of @var{version} may be either 2, 3 or 4; the default version is 2.
4461
4462 Note that with DWARF version 2 some ports require, and will always
4463 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4464
4465 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4466 for maximum benefit.
4467
4468 @item -gstrict-dwarf
4469 @opindex gstrict-dwarf
4470 Disallow using extensions of later DWARF standard version than selected
4471 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4472 DWARF extensions from later standard versions is allowed.
4473
4474 @item -gno-strict-dwarf
4475 @opindex gno-strict-dwarf
4476 Allow using extensions of later DWARF standard version than selected with
4477 @option{-gdwarf-@var{version}}.
4478
4479 @item -gvms
4480 @opindex gvms
4481 Produce debugging information in VMS debug format (if that is
4482 supported).  This is the format used by DEBUG on VMS systems.
4483
4484 @item -g@var{level}
4485 @itemx -ggdb@var{level}
4486 @itemx -gstabs@var{level}
4487 @itemx -gcoff@var{level}
4488 @itemx -gxcoff@var{level}
4489 @itemx -gvms@var{level}
4490 Request debugging information and also use @var{level} to specify how
4491 much information.  The default level is 2.
4492
4493 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4494 @option{-g}.
4495
4496 Level 1 produces minimal information, enough for making backtraces in
4497 parts of the program that you don't plan to debug.  This includes
4498 descriptions of functions and external variables, but no information
4499 about local variables and no line numbers.
4500
4501 Level 3 includes extra information, such as all the macro definitions
4502 present in the program.  Some debuggers support macro expansion when
4503 you use @option{-g3}.
4504
4505 @option{-gdwarf-2} does not accept a concatenated debug level, because
4506 GCC used to support an option @option{-gdwarf} that meant to generate
4507 debug information in version 1 of the DWARF format (which is very
4508 different from version 2), and it would have been too confusing.  That
4509 debug format is long obsolete, but the option cannot be changed now.
4510 Instead use an additional @option{-g@var{level}} option to change the
4511 debug level for DWARF.
4512
4513 @item -gtoggle
4514 @opindex gtoggle
4515 Turn off generation of debug info, if leaving out this option would have
4516 generated it, or turn it on at level 2 otherwise.  The position of this
4517 argument in the command line does not matter, it takes effect after all
4518 other options are processed, and it does so only once, no matter how
4519 many times it is given.  This is mainly intended to be used with
4520 @option{-fcompare-debug}.
4521
4522 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4523 @opindex fdump-final-insns
4524 Dump the final internal representation (RTL) to @var{file}.  If the
4525 optional argument is omitted (or if @var{file} is @code{.}), the name
4526 of the dump file will be determined by appending @code{.gkd} to the
4527 compilation output file name.
4528
4529 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4530 @opindex fcompare-debug
4531 @opindex fno-compare-debug
4532 If no error occurs during compilation, run the compiler a second time,
4533 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4534 passed to the second compilation.  Dump the final internal
4535 representation in both compilations, and print an error if they differ.
4536
4537 If the equal sign is omitted, the default @option{-gtoggle} is used.
4538
4539 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4540 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4541 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4542 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4543 is used.
4544
4545 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4546 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4547 of the final representation and the second compilation, preventing even
4548 @env{GCC_COMPARE_DEBUG} from taking effect.
4549
4550 To verify full coverage during @option{-fcompare-debug} testing, set
4551 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4552 which GCC will reject as an invalid option in any actual compilation
4553 (rather than preprocessing, assembly or linking).  To get just a
4554 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4555 not overridden} will do.
4556
4557 @item -fcompare-debug-second
4558 @opindex fcompare-debug-second
4559 This option is implicitly passed to the compiler for the second
4560 compilation requested by @option{-fcompare-debug}, along with options to
4561 silence warnings, and omitting other options that would cause
4562 side-effect compiler outputs to files or to the standard output.  Dump
4563 files and preserved temporary files are renamed so as to contain the
4564 @code{.gk} additional extension during the second compilation, to avoid
4565 overwriting those generated by the first.
4566
4567 When this option is passed to the compiler driver, it causes the
4568 @emph{first} compilation to be skipped, which makes it useful for little
4569 other than debugging the compiler proper.
4570
4571 @item -feliminate-dwarf2-dups
4572 @opindex feliminate-dwarf2-dups
4573 Compress DWARF2 debugging information by eliminating duplicated
4574 information about each symbol.  This option only makes sense when
4575 generating DWARF2 debugging information with @option{-gdwarf-2}.
4576
4577 @item -femit-struct-debug-baseonly
4578 Emit debug information for struct-like types
4579 only when the base name of the compilation source file
4580 matches the base name of file in which the struct was defined.
4581
4582 This option substantially reduces the size of debugging information,
4583 but at significant potential loss in type information to the debugger.
4584 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4585 See @option{-femit-struct-debug-detailed} for more detailed control.
4586
4587 This option works only with DWARF 2.
4588
4589 @item -femit-struct-debug-reduced
4590 Emit debug information for struct-like types
4591 only when the base name of the compilation source file
4592 matches the base name of file in which the type was defined,
4593 unless the struct is a template or defined in a system header.
4594
4595 This option significantly reduces the size of debugging information,
4596 with some potential loss in type information to the debugger.
4597 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4598 See @option{-femit-struct-debug-detailed} for more detailed control.
4599
4600 This option works only with DWARF 2.
4601
4602 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4603 Specify the struct-like types
4604 for which the compiler will generate debug information.
4605 The intent is to reduce duplicate struct debug information
4606 between different object files within the same program.
4607
4608 This option is a detailed version of
4609 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4610 which will serve for most needs.
4611
4612 A specification has the syntax
4613 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4614
4615 The optional first word limits the specification to
4616 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4617 A struct type is used directly when it is the type of a variable, member.
4618 Indirect uses arise through pointers to structs.
4619 That is, when use of an incomplete struct would be legal, the use is indirect.
4620 An example is
4621 @samp{struct one direct; struct two * indirect;}.
4622
4623 The optional second word limits the specification to
4624 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4625 Generic structs are a bit complicated to explain.
4626 For C++, these are non-explicit specializations of template classes,
4627 or non-template classes within the above.
4628 Other programming languages have generics,
4629 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4630
4631 The third word specifies the source files for those
4632 structs for which the compiler will emit debug information.
4633 The values @samp{none} and @samp{any} have the normal meaning.
4634 The value @samp{base} means that
4635 the base of name of the file in which the type declaration appears
4636 must match the base of the name of the main compilation file.
4637 In practice, this means that
4638 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4639 but types declared in other header will not.
4640 The value @samp{sys} means those types satisfying @samp{base}
4641 or declared in system or compiler headers.
4642
4643 You may need to experiment to determine the best settings for your application.
4644
4645 The default is @samp{-femit-struct-debug-detailed=all}.
4646
4647 This option works only with DWARF 2.
4648
4649 @item -fenable-icf-debug
4650 @opindex fenable-icf-debug
4651 Generate additional debug information to support identical code folding (ICF).
4652 This option only works with DWARF version 2 or higher.
4653
4654 @item -fno-merge-debug-strings
4655 @opindex fmerge-debug-strings
4656 @opindex fno-merge-debug-strings
4657 Direct the linker to not merge together strings in the debugging
4658 information which are identical in different object files.  Merging is
4659 not supported by all assemblers or linkers.  Merging decreases the size
4660 of the debug information in the output file at the cost of increasing
4661 link processing time.  Merging is enabled by default.
4662
4663 @item -fdebug-prefix-map=@var{old}=@var{new}
4664 @opindex fdebug-prefix-map
4665 When compiling files in directory @file{@var{old}}, record debugging
4666 information describing them as in @file{@var{new}} instead.
4667
4668 @item -fno-dwarf2-cfi-asm
4669 @opindex fdwarf2-cfi-asm
4670 @opindex fno-dwarf2-cfi-asm
4671 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4672 instead of using GAS @code{.cfi_*} directives.
4673
4674 @cindex @command{prof}
4675 @item -p
4676 @opindex p
4677 Generate extra code to write profile information suitable for the
4678 analysis program @command{prof}.  You must use this option when compiling
4679 the source files you want data about, and you must also use it when
4680 linking.
4681
4682 @cindex @command{gprof}
4683 @item -pg
4684 @opindex pg
4685 Generate extra code to write profile information suitable for the
4686 analysis program @command{gprof}.  You must use this option when compiling
4687 the source files you want data about, and you must also use it when
4688 linking.
4689
4690 @item -Q
4691 @opindex Q
4692 Makes the compiler print out each function name as it is compiled, and
4693 print some statistics about each pass when it finishes.
4694
4695 @item -ftime-report
4696 @opindex ftime-report
4697 Makes the compiler print some statistics about the time consumed by each
4698 pass when it finishes.
4699
4700 @item -fmem-report
4701 @opindex fmem-report
4702 Makes the compiler print some statistics about permanent memory
4703 allocation when it finishes.
4704
4705 @item -fpre-ipa-mem-report
4706 @opindex fpre-ipa-mem-report
4707 @item -fpost-ipa-mem-report
4708 @opindex fpost-ipa-mem-report
4709 Makes the compiler print some statistics about permanent memory
4710 allocation before or after interprocedural optimization.
4711
4712 @item -fprofile-arcs
4713 @opindex fprofile-arcs
4714 Add code so that program flow @dfn{arcs} are instrumented.  During
4715 execution the program records how many times each branch and call is
4716 executed and how many times it is taken or returns.  When the compiled
4717 program exits it saves this data to a file called
4718 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4719 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4720 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4721 @var{auxname} is generated from the name of the output file, if
4722 explicitly specified and it is not the final executable, otherwise it is
4723 the basename of the source file.  In both cases any suffix is removed
4724 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4725 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4726 @xref{Cross-profiling}.
4727
4728 @cindex @command{gcov}
4729 @item --coverage
4730 @opindex coverage
4731
4732 This option is used to compile and link code instrumented for coverage
4733 analysis.  The option is a synonym for @option{-fprofile-arcs}
4734 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4735 linking).  See the documentation for those options for more details.
4736
4737 @itemize
4738
4739 @item
4740 Compile the source files with @option{-fprofile-arcs} plus optimization
4741 and code generation options.  For test coverage analysis, use the
4742 additional @option{-ftest-coverage} option.  You do not need to profile
4743 every source file in a program.
4744
4745 @item
4746 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4747 (the latter implies the former).
4748
4749 @item
4750 Run the program on a representative workload to generate the arc profile
4751 information.  This may be repeated any number of times.  You can run
4752 concurrent instances of your program, and provided that the file system
4753 supports locking, the data files will be correctly updated.  Also
4754 @code{fork} calls are detected and correctly handled (double counting
4755 will not happen).
4756
4757 @item
4758 For profile-directed optimizations, compile the source files again with
4759 the same optimization and code generation options plus
4760 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4761 Control Optimization}).
4762
4763 @item
4764 For test coverage analysis, use @command{gcov} to produce human readable
4765 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4766 @command{gcov} documentation for further information.
4767
4768 @end itemize
4769
4770 With @option{-fprofile-arcs}, for each function of your program GCC
4771 creates a program flow graph, then finds a spanning tree for the graph.
4772 Only arcs that are not on the spanning tree have to be instrumented: the
4773 compiler adds code to count the number of times that these arcs are
4774 executed.  When an arc is the only exit or only entrance to a block, the
4775 instrumentation code can be added to the block; otherwise, a new basic
4776 block must be created to hold the instrumentation code.
4777
4778 @need 2000
4779 @item -ftest-coverage
4780 @opindex ftest-coverage
4781 Produce a notes file that the @command{gcov} code-coverage utility
4782 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4783 show program coverage.  Each source file's note file is called
4784 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4785 above for a description of @var{auxname} and instructions on how to
4786 generate test coverage data.  Coverage data will match the source files
4787 more closely, if you do not optimize.
4788
4789 @item -fdbg-cnt-list
4790 @opindex fdbg-cnt-list
4791 Print the name and the counter upperbound for all debug counters.
4792
4793 @item -fdbg-cnt=@var{counter-value-list}
4794 @opindex fdbg-cnt
4795 Set the internal debug counter upperbound. @var{counter-value-list}
4796 is a comma-separated list of @var{name}:@var{value} pairs
4797 which sets the upperbound of each debug counter @var{name} to @var{value}.
4798 All debug counters have the initial upperbound of @var{UINT_MAX},
4799 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4800 e.g. With -fdbg-cnt=dce:10,tail_call:0
4801 dbg_cnt(dce) will return true only for first 10 invocations
4802 and dbg_cnt(tail_call) will return false always.
4803
4804 @item -d@var{letters}
4805 @itemx -fdump-rtl-@var{pass}
4806 @opindex d
4807 Says to make debugging dumps during compilation at times specified by
4808 @var{letters}.  This is used for debugging the RTL-based passes of the
4809 compiler.  The file names for most of the dumps are made by appending
4810 a pass number and a word to the @var{dumpname}, and the files are
4811 created in the directory of the output file.  @var{dumpname} is
4812 generated from the name of the output file, if explicitly specified
4813 and it is not an executable, otherwise it is the basename of the
4814 source file. These switches may have different effects when
4815 @option{-E} is used for preprocessing.
4816
4817 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4818 @option{-d} option @var{letters}.  Here are the possible
4819 letters for use in @var{pass} and @var{letters}, and their meanings:
4820
4821 @table @gcctabopt
4822
4823 @item -fdump-rtl-alignments
4824 @opindex fdump-rtl-alignments
4825 Dump after branch alignments have been computed.
4826
4827 @item -fdump-rtl-asmcons
4828 @opindex fdump-rtl-asmcons
4829 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4830
4831 @item -fdump-rtl-auto_inc_dec
4832 @opindex fdump-rtl-auto_inc_dec
4833 Dump after auto-inc-dec discovery.  This pass is only run on
4834 architectures that have auto inc or auto dec instructions.
4835
4836 @item -fdump-rtl-barriers
4837 @opindex fdump-rtl-barriers
4838 Dump after cleaning up the barrier instructions.
4839
4840 @item -fdump-rtl-bbpart
4841 @opindex fdump-rtl-bbpart
4842 Dump after partitioning hot and cold basic blocks.
4843
4844 @item -fdump-rtl-bbro
4845 @opindex fdump-rtl-bbro
4846 Dump after block reordering.
4847
4848 @item -fdump-rtl-btl1
4849 @itemx -fdump-rtl-btl2
4850 @opindex fdump-rtl-btl2
4851 @opindex fdump-rtl-btl2
4852 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4853 after the two branch
4854 target load optimization passes.
4855
4856 @item -fdump-rtl-bypass
4857 @opindex fdump-rtl-bypass
4858 Dump after jump bypassing and control flow optimizations.
4859
4860 @item -fdump-rtl-combine
4861 @opindex fdump-rtl-combine
4862 Dump after the RTL instruction combination pass.
4863
4864 @item -fdump-rtl-compgotos
4865 @opindex fdump-rtl-compgotos
4866 Dump after duplicating the computed gotos.
4867
4868 @item -fdump-rtl-ce1
4869 @itemx -fdump-rtl-ce2
4870 @itemx -fdump-rtl-ce3
4871 @opindex fdump-rtl-ce1
4872 @opindex fdump-rtl-ce2
4873 @opindex fdump-rtl-ce3
4874 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4875 @option{-fdump-rtl-ce3} enable dumping after the three
4876 if conversion passes.
4877
4878 @itemx -fdump-rtl-cprop_hardreg
4879 @opindex fdump-rtl-cprop_hardreg
4880 Dump after hard register copy propagation.
4881
4882 @itemx -fdump-rtl-csa
4883 @opindex fdump-rtl-csa
4884 Dump after combining stack adjustments.
4885
4886 @item -fdump-rtl-cse1
4887 @itemx -fdump-rtl-cse2
4888 @opindex fdump-rtl-cse1
4889 @opindex fdump-rtl-cse2
4890 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4891 the two common sub-expression elimination passes.
4892
4893 @itemx -fdump-rtl-dce
4894 @opindex fdump-rtl-dce
4895 Dump after the standalone dead code elimination passes.
4896
4897 @itemx -fdump-rtl-dbr
4898 @opindex fdump-rtl-dbr
4899 Dump after delayed branch scheduling.
4900
4901 @item -fdump-rtl-dce1
4902 @itemx -fdump-rtl-dce2
4903 @opindex fdump-rtl-dce1
4904 @opindex fdump-rtl-dce2
4905 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4906 the two dead store elimination passes.
4907
4908 @item -fdump-rtl-eh
4909 @opindex fdump-rtl-eh
4910 Dump after finalization of EH handling code.
4911
4912 @item -fdump-rtl-eh_ranges
4913 @opindex fdump-rtl-eh_ranges
4914 Dump after conversion of EH handling range regions.
4915
4916 @item -fdump-rtl-expand
4917 @opindex fdump-rtl-expand
4918 Dump after RTL generation.
4919
4920 @item -fdump-rtl-fwprop1
4921 @itemx -fdump-rtl-fwprop2
4922 @opindex fdump-rtl-fwprop1
4923 @opindex fdump-rtl-fwprop2
4924 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
4925 dumping after the two forward propagation passes.
4926
4927 @item -fdump-rtl-gcse1
4928 @itemx -fdump-rtl-gcse2
4929 @opindex fdump-rtl-gcse1
4930 @opindex fdump-rtl-gcse2
4931 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
4932 after global common subexpression elimination.
4933
4934 @item -fdump-rtl-init-regs
4935 @opindex fdump-rtl-init-regs
4936 Dump after the initialization of the registers.
4937
4938 @item -fdump-rtl-initvals
4939 @opindex fdump-rtl-initvals
4940 Dump after the computation of the initial value sets.
4941
4942 @itemx -fdump-rtl-into_cfglayout
4943 @opindex fdump-rtl-into_cfglayout
4944 Dump after converting to cfglayout mode.
4945
4946 @item -fdump-rtl-ira
4947 @opindex fdump-rtl-ira
4948 Dump after iterated register allocation.
4949
4950 @item -fdump-rtl-jump
4951 @opindex fdump-rtl-jump
4952 Dump after the second jump optimization.
4953
4954 @item -fdump-rtl-loop2
4955 @opindex fdump-rtl-loop2
4956 @option{-fdump-rtl-loop2} enables dumping after the rtl
4957 loop optimization passes.
4958
4959 @item -fdump-rtl-mach
4960 @opindex fdump-rtl-mach
4961 Dump after performing the machine dependent reorganization pass, if that
4962 pass exists.
4963
4964 @item -fdump-rtl-mode_sw
4965 @opindex fdump-rtl-mode_sw
4966 Dump after removing redundant mode switches.
4967
4968 @item -fdump-rtl-rnreg
4969 @opindex fdump-rtl-rnreg
4970 Dump after register renumbering.
4971
4972 @itemx -fdump-rtl-outof_cfglayout
4973 @opindex fdump-rtl-outof_cfglayout
4974 Dump after converting from cfglayout mode.
4975
4976 @item -fdump-rtl-peephole2
4977 @opindex fdump-rtl-peephole2
4978 Dump after the peephole pass.
4979
4980 @item -fdump-rtl-postreload
4981 @opindex fdump-rtl-postreload
4982 Dump after post-reload optimizations.
4983
4984 @itemx -fdump-rtl-pro_and_epilogue
4985 @opindex fdump-rtl-pro_and_epilogue
4986 Dump after generating the function pro and epilogues.
4987
4988 @item -fdump-rtl-regmove
4989 @opindex fdump-rtl-regmove
4990 Dump after the register move pass.
4991
4992 @item -fdump-rtl-sched1
4993 @itemx -fdump-rtl-sched2
4994 @opindex fdump-rtl-sched1
4995 @opindex fdump-rtl-sched2
4996 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
4997 after the basic block scheduling passes.
4998
4999 @item -fdump-rtl-see
5000 @opindex fdump-rtl-see
5001 Dump after sign extension elimination.
5002
5003 @item -fdump-rtl-seqabstr
5004 @opindex fdump-rtl-seqabstr
5005 Dump after common sequence discovery.
5006
5007 @item -fdump-rtl-shorten
5008 @opindex fdump-rtl-shorten
5009 Dump after shortening branches.
5010
5011 @item -fdump-rtl-sibling
5012 @opindex fdump-rtl-sibling
5013 Dump after sibling call optimizations.
5014
5015 @item -fdump-rtl-split1
5016 @itemx -fdump-rtl-split2
5017 @itemx -fdump-rtl-split3
5018 @itemx -fdump-rtl-split4
5019 @itemx -fdump-rtl-split5
5020 @opindex fdump-rtl-split1
5021 @opindex fdump-rtl-split2
5022 @opindex fdump-rtl-split3
5023 @opindex fdump-rtl-split4
5024 @opindex fdump-rtl-split5
5025 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5026 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5027 @option{-fdump-rtl-split5} enable dumping after five rounds of
5028 instruction splitting.
5029
5030 @item -fdump-rtl-sms
5031 @opindex fdump-rtl-sms
5032 Dump after modulo scheduling.  This pass is only run on some
5033 architectures.
5034
5035 @item -fdump-rtl-stack
5036 @opindex fdump-rtl-stack
5037 Dump after conversion from GCC's "flat register file" registers to the
5038 x87's stack-like registers.  This pass is only run on x86 variants.
5039
5040 @item -fdump-rtl-subreg1
5041 @itemx -fdump-rtl-subreg2
5042 @opindex fdump-rtl-subreg1
5043 @opindex fdump-rtl-subreg2
5044 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5045 the two subreg expansion passes.
5046
5047 @item -fdump-rtl-unshare
5048 @opindex fdump-rtl-unshare
5049 Dump after all rtl has been unshared.
5050
5051 @item -fdump-rtl-vartrack
5052 @opindex fdump-rtl-vartrack
5053 Dump after variable tracking.
5054
5055 @item -fdump-rtl-vregs
5056 @opindex fdump-rtl-vregs
5057 Dump after converting virtual registers to hard registers.
5058
5059 @item -fdump-rtl-web
5060 @opindex fdump-rtl-web
5061 Dump after live range splitting.
5062
5063 @item -fdump-rtl-regclass
5064 @itemx -fdump-rtl-subregs_of_mode_init
5065 @itemx -fdump-rtl-subregs_of_mode_finish
5066 @itemx -fdump-rtl-dfinit
5067 @itemx -fdump-rtl-dfinish
5068 @opindex fdump-rtl-regclass
5069 @opindex fdump-rtl-subregs_of_mode_init
5070 @opindex fdump-rtl-subregs_of_mode_finish
5071 @opindex fdump-rtl-dfinit
5072 @opindex fdump-rtl-dfinish
5073 These dumps are defined but always produce empty files.
5074
5075 @item -fdump-rtl-all
5076 @opindex fdump-rtl-all
5077 Produce all the dumps listed above.
5078
5079 @item -dA
5080 @opindex dA
5081 Annotate the assembler output with miscellaneous debugging information.
5082
5083 @item -dD
5084 @opindex dD
5085 Dump all macro definitions, at the end of preprocessing, in addition to
5086 normal output.
5087
5088 @item -dH
5089 @opindex dH
5090 Produce a core dump whenever an error occurs.
5091
5092 @item -dm
5093 @opindex dm
5094 Print statistics on memory usage, at the end of the run, to
5095 standard error.
5096
5097 @item -dp
5098 @opindex dp
5099 Annotate the assembler output with a comment indicating which
5100 pattern and alternative was used.  The length of each instruction is
5101 also printed.
5102
5103 @item -dP
5104 @opindex dP
5105 Dump the RTL in the assembler output as a comment before each instruction.
5106 Also turns on @option{-dp} annotation.
5107
5108 @item -dv
5109 @opindex dv
5110 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5111 dump a representation of the control flow graph suitable for viewing with VCG
5112 to @file{@var{file}.@var{pass}.vcg}.
5113
5114 @item -dx
5115 @opindex dx
5116 Just generate RTL for a function instead of compiling it.  Usually used
5117 with @option{-fdump-rtl-expand}.
5118
5119 @item -dy
5120 @opindex dy
5121 Dump debugging information during parsing, to standard error.
5122 @end table
5123
5124 @item -fdump-noaddr
5125 @opindex fdump-noaddr
5126 When doing debugging dumps, suppress address output.  This makes it more
5127 feasible to use diff on debugging dumps for compiler invocations with
5128 different compiler binaries and/or different
5129 text / bss / data / heap / stack / dso start locations.
5130
5131 @item -fdump-unnumbered
5132 @opindex fdump-unnumbered
5133 When doing debugging dumps, suppress instruction numbers and address output.
5134 This makes it more feasible to use diff on debugging dumps for compiler
5135 invocations with different options, in particular with and without
5136 @option{-g}.
5137
5138 @item -fdump-unnumbered-links
5139 @opindex fdump-unnumbered-links
5140 When doing debugging dumps (see @option{-d} option above), suppress
5141 instruction numbers for the links to the previous and next instructions
5142 in a sequence.
5143
5144 @item -fdump-translation-unit @r{(C++ only)}
5145 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5146 @opindex fdump-translation-unit
5147 Dump a representation of the tree structure for the entire translation
5148 unit to a file.  The file name is made by appending @file{.tu} to the
5149 source file name, and the file is created in the same directory as the
5150 output file.  If the @samp{-@var{options}} form is used, @var{options}
5151 controls the details of the dump as described for the
5152 @option{-fdump-tree} options.
5153
5154 @item -fdump-class-hierarchy @r{(C++ only)}
5155 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5156 @opindex fdump-class-hierarchy
5157 Dump a representation of each class's hierarchy and virtual function
5158 table layout to a file.  The file name is made by appending
5159 @file{.class} to the source file name, and the file is created in the
5160 same directory as the output file.  If the @samp{-@var{options}} form
5161 is used, @var{options} controls the details of the dump as described
5162 for the @option{-fdump-tree} options.
5163
5164 @item -fdump-ipa-@var{switch}
5165 @opindex fdump-ipa
5166 Control the dumping at various stages of inter-procedural analysis
5167 language tree to a file.  The file name is generated by appending a
5168 switch specific suffix to the source file name, and the file is created
5169 in the same directory as the output file.  The following dumps are
5170 possible:
5171
5172 @table @samp
5173 @item all
5174 Enables all inter-procedural analysis dumps.
5175
5176 @item cgraph
5177 Dumps information about call-graph optimization, unused function removal,
5178 and inlining decisions.
5179
5180 @item inline
5181 Dump after function inlining.
5182
5183 @end table
5184
5185 @item -fdump-statistics-@var{option}
5186 @opindex fdump-statistics
5187 Enable and control dumping of pass statistics in a separate file.  The
5188 file name is generated by appending a suffix ending in
5189 @samp{.statistics} to the source file name, and the file is created in
5190 the same directory as the output file.  If the @samp{-@var{option}}
5191 form is used, @samp{-stats} will cause counters to be summed over the
5192 whole compilation unit while @samp{-details} will dump every event as
5193 the passes generate them.  The default with no option is to sum
5194 counters for each function compiled.
5195
5196 @item -fdump-tree-@var{switch}
5197 @itemx -fdump-tree-@var{switch}-@var{options}
5198 @opindex fdump-tree
5199 Control the dumping at various stages of processing the intermediate
5200 language tree to a file.  The file name is generated by appending a
5201 switch specific suffix to the source file name, and the file is
5202 created in the same directory as the output file.  If the
5203 @samp{-@var{options}} form is used, @var{options} is a list of
5204 @samp{-} separated options that control the details of the dump.  Not
5205 all options are applicable to all dumps, those which are not
5206 meaningful will be ignored.  The following options are available
5207
5208 @table @samp
5209 @item address
5210 Print the address of each node.  Usually this is not meaningful as it
5211 changes according to the environment and source file.  Its primary use
5212 is for tying up a dump file with a debug environment.
5213 @item asmname
5214 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5215 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5216 use working backward from mangled names in the assembly file.
5217 @item slim
5218 Inhibit dumping of members of a scope or body of a function merely
5219 because that scope has been reached.  Only dump such items when they
5220 are directly reachable by some other path.  When dumping pretty-printed
5221 trees, this option inhibits dumping the bodies of control structures.
5222 @item raw
5223 Print a raw representation of the tree.  By default, trees are
5224 pretty-printed into a C-like representation.
5225 @item details
5226 Enable more detailed dumps (not honored by every dump option).
5227 @item stats
5228 Enable dumping various statistics about the pass (not honored by every dump
5229 option).
5230 @item blocks
5231 Enable showing basic block boundaries (disabled in raw dumps).
5232 @item vops
5233 Enable showing virtual operands for every statement.
5234 @item lineno
5235 Enable showing line numbers for statements.
5236 @item uid
5237 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5238 @item verbose
5239 Enable showing the tree dump for each statement.
5240 @item eh
5241 Enable showing the EH region number holding each statement.
5242 @item all
5243 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5244 and @option{lineno}.
5245 @end table
5246
5247 The following tree dumps are possible:
5248 @table @samp
5249
5250 @item original
5251 @opindex fdump-tree-original
5252 Dump before any tree based optimization, to @file{@var{file}.original}.
5253
5254 @item optimized
5255 @opindex fdump-tree-optimized
5256 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5257
5258 @item gimple
5259 @opindex fdump-tree-gimple
5260 Dump each function before and after the gimplification pass to a file.  The
5261 file name is made by appending @file{.gimple} to the source file name.
5262
5263 @item cfg
5264 @opindex fdump-tree-cfg
5265 Dump the control flow graph of each function to a file.  The file name is
5266 made by appending @file{.cfg} to the source file name.
5267
5268 @item vcg
5269 @opindex fdump-tree-vcg
5270 Dump the control flow graph of each function to a file in VCG format.  The
5271 file name is made by appending @file{.vcg} to the source file name.  Note
5272 that if the file contains more than one function, the generated file cannot
5273 be used directly by VCG@.  You will need to cut and paste each function's
5274 graph into its own separate file first.
5275
5276 @item ch
5277 @opindex fdump-tree-ch
5278 Dump each function after copying loop headers.  The file name is made by
5279 appending @file{.ch} to the source file name.
5280
5281 @item ssa
5282 @opindex fdump-tree-ssa
5283 Dump SSA related information to a file.  The file name is made by appending
5284 @file{.ssa} to the source file name.
5285
5286 @item alias
5287 @opindex fdump-tree-alias
5288 Dump aliasing information for each function.  The file name is made by
5289 appending @file{.alias} to the source file name.
5290
5291 @item ccp
5292 @opindex fdump-tree-ccp
5293 Dump each function after CCP@.  The file name is made by appending
5294 @file{.ccp} to the source file name.
5295
5296 @item storeccp
5297 @opindex fdump-tree-storeccp
5298 Dump each function after STORE-CCP@.  The file name is made by appending
5299 @file{.storeccp} to the source file name.
5300
5301 @item pre
5302 @opindex fdump-tree-pre
5303 Dump trees after partial redundancy elimination.  The file name is made
5304 by appending @file{.pre} to the source file name.
5305
5306 @item fre
5307 @opindex fdump-tree-fre
5308 Dump trees after full redundancy elimination.  The file name is made
5309 by appending @file{.fre} to the source file name.
5310
5311 @item copyprop
5312 @opindex fdump-tree-copyprop
5313 Dump trees after copy propagation.  The file name is made
5314 by appending @file{.copyprop} to the source file name.
5315
5316 @item store_copyprop
5317 @opindex fdump-tree-store_copyprop
5318 Dump trees after store copy-propagation.  The file name is made
5319 by appending @file{.store_copyprop} to the source file name.
5320
5321 @item dce
5322 @opindex fdump-tree-dce
5323 Dump each function after dead code elimination.  The file name is made by
5324 appending @file{.dce} to the source file name.
5325
5326 @item mudflap
5327 @opindex fdump-tree-mudflap
5328 Dump each function after adding mudflap instrumentation.  The file name is
5329 made by appending @file{.mudflap} to the source file name.
5330
5331 @item sra
5332 @opindex fdump-tree-sra
5333 Dump each function after performing scalar replacement of aggregates.  The
5334 file name is made by appending @file{.sra} to the source file name.
5335
5336 @item sink
5337 @opindex fdump-tree-sink
5338 Dump each function after performing code sinking.  The file name is made
5339 by appending @file{.sink} to the source file name.
5340
5341 @item dom
5342 @opindex fdump-tree-dom
5343 Dump each function after applying dominator tree optimizations.  The file
5344 name is made by appending @file{.dom} to the source file name.
5345
5346 @item dse
5347 @opindex fdump-tree-dse
5348 Dump each function after applying dead store elimination.  The file
5349 name is made by appending @file{.dse} to the source file name.
5350
5351 @item phiopt
5352 @opindex fdump-tree-phiopt
5353 Dump each function after optimizing PHI nodes into straightline code.  The file
5354 name is made by appending @file{.phiopt} to the source file name.
5355
5356 @item forwprop
5357 @opindex fdump-tree-forwprop
5358 Dump each function after forward propagating single use variables.  The file
5359 name is made by appending @file{.forwprop} to the source file name.
5360
5361 @item copyrename
5362 @opindex fdump-tree-copyrename
5363 Dump each function after applying the copy rename optimization.  The file
5364 name is made by appending @file{.copyrename} to the source file name.
5365
5366 @item nrv
5367 @opindex fdump-tree-nrv
5368 Dump each function after applying the named return value optimization on
5369 generic trees.  The file name is made by appending @file{.nrv} to the source
5370 file name.
5371
5372 @item vect
5373 @opindex fdump-tree-vect
5374 Dump each function after applying vectorization of loops.  The file name is
5375 made by appending @file{.vect} to the source file name.
5376
5377 @item slp
5378 @opindex fdump-tree-slp
5379 Dump each function after applying vectorization of basic blocks.  The file name
5380 is made by appending @file{.slp} to the source file name.
5381
5382 @item vrp
5383 @opindex fdump-tree-vrp
5384 Dump each function after Value Range Propagation (VRP).  The file name
5385 is made by appending @file{.vrp} to the source file name.
5386
5387 @item all
5388 @opindex fdump-tree-all
5389 Enable all the available tree dumps with the flags provided in this option.
5390 @end table
5391
5392 @item -ftree-vectorizer-verbose=@var{n}
5393 @opindex ftree-vectorizer-verbose
5394 This option controls the amount of debugging output the vectorizer prints.
5395 This information is written to standard error, unless
5396 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5397 in which case it is output to the usual dump listing file, @file{.vect}.
5398 For @var{n}=0 no diagnostic information is reported.
5399 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5400 and the total number of loops that got vectorized.
5401 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5402 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5403 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5404 level that @option{-fdump-tree-vect-stats} uses.
5405 Higher verbosity levels mean either more information dumped for each
5406 reported loop, or same amount of information reported for more loops:
5407 if @var{n}=3, vectorizer cost model information is reported.
5408 If @var{n}=4, alignment related information is added to the reports.
5409 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5410 memory access-patterns) is added to the reports.
5411 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5412 that did not pass the first analysis phase (i.e., may not be countable, or
5413 may have complicated control-flow).
5414 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5415 If @var{n}=8, SLP related information is added to the reports.
5416 For @var{n}=9, all the information the vectorizer generates during its
5417 analysis and transformation is reported.  This is the same verbosity level
5418 that @option{-fdump-tree-vect-details} uses.
5419
5420 @item -frandom-seed=@var{string}
5421 @opindex frandom-seed
5422 This option provides a seed that GCC uses when it would otherwise use
5423 random numbers.  It is used to generate certain symbol names
5424 that have to be different in every compiled file.  It is also used to
5425 place unique stamps in coverage data files and the object files that
5426 produce them.  You can use the @option{-frandom-seed} option to produce
5427 reproducibly identical object files.
5428
5429 The @var{string} should be different for every file you compile.
5430
5431 @item -fsched-verbose=@var{n}
5432 @opindex fsched-verbose
5433 On targets that use instruction scheduling, this option controls the
5434 amount of debugging output the scheduler prints.  This information is
5435 written to standard error, unless @option{-fdump-rtl-sched1} or
5436 @option{-fdump-rtl-sched2} is specified, in which case it is output
5437 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5438 respectively.  However for @var{n} greater than nine, the output is
5439 always printed to standard error.
5440
5441 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5442 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5443 For @var{n} greater than one, it also output basic block probabilities,
5444 detailed ready list information and unit/insn info.  For @var{n} greater
5445 than two, it includes RTL at abort point, control-flow and regions info.
5446 And for @var{n} over four, @option{-fsched-verbose} also includes
5447 dependence info.
5448
5449 @item -save-temps
5450 @itemx -save-temps=cwd
5451 @opindex save-temps
5452 Store the usual ``temporary'' intermediate files permanently; place them
5453 in the current directory and name them based on the source file.  Thus,
5454 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5455 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5456 preprocessed @file{foo.i} output file even though the compiler now
5457 normally uses an integrated preprocessor.
5458
5459 When used in combination with the @option{-x} command line option,
5460 @option{-save-temps} is sensible enough to avoid over writing an
5461 input source file with the same extension as an intermediate file.
5462 The corresponding intermediate file may be obtained by renaming the
5463 source file before using @option{-save-temps}.
5464
5465 If you invoke GCC in parallel, compiling several different source
5466 files that share a common base name in different subdirectories or the
5467 same source file compiled for multiple output destinations, it is
5468 likely that the different parallel compilers will interfere with each
5469 other, and overwrite the temporary files.  For instance:
5470
5471 @smallexample
5472 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5473 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5474 @end smallexample
5475
5476 may result in @file{foo.i} and @file{foo.o} being written to
5477 simultaneously by both compilers.
5478
5479 @item -save-temps=obj
5480 @opindex save-temps=obj
5481 Store the usual ``temporary'' intermediate files permanently.  If the
5482 @option{-o} option is used, the temporary files are based on the
5483 object file.  If the @option{-o} option is not used, the
5484 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5485
5486 For example:
5487
5488 @smallexample
5489 gcc -save-temps=obj -c foo.c
5490 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5491 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5492 @end smallexample
5493
5494 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5495 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5496 @file{dir2/yfoobar.o}.
5497
5498 @item -time@r{[}=@var{file}@r{]}
5499 @opindex time
5500 Report the CPU time taken by each subprocess in the compilation
5501 sequence.  For C source files, this is the compiler proper and assembler
5502 (plus the linker if linking is done).
5503
5504 Without the specification of an output file, the output looks like this:
5505
5506 @smallexample
5507 # cc1 0.12 0.01
5508 # as 0.00 0.01
5509 @end smallexample
5510
5511 The first number on each line is the ``user time'', that is time spent
5512 executing the program itself.  The second number is ``system time'',
5513 time spent executing operating system routines on behalf of the program.
5514 Both numbers are in seconds.
5515
5516 With the specification of an output file, the output is appended to the
5517 named file, and it looks like this:
5518
5519 @smallexample
5520 0.12 0.01 cc1 @var{options}
5521 0.00 0.01 as @var{options}
5522 @end smallexample
5523
5524 The ``user time'' and the ``system time'' are moved before the program
5525 name, and the options passed to the program are displayed, so that one
5526 can later tell what file was being compiled, and with which options.
5527
5528 @item -fvar-tracking
5529 @opindex fvar-tracking
5530 Run variable tracking pass.  It computes where variables are stored at each
5531 position in code.  Better debugging information is then generated
5532 (if the debugging information format supports this information).
5533
5534 It is enabled by default when compiling with optimization (@option{-Os},
5535 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5536 the debug info format supports it.
5537
5538 @item -fvar-tracking-assignments
5539 @opindex fvar-tracking-assignments
5540 @opindex fno-var-tracking-assignments
5541 Annotate assignments to user variables early in the compilation and
5542 attempt to carry the annotations over throughout the compilation all the
5543 way to the end, in an attempt to improve debug information while
5544 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5545
5546 It can be enabled even if var-tracking is disabled, in which case
5547 annotations will be created and maintained, but discarded at the end.
5548
5549 @item -fvar-tracking-assignments-toggle
5550 @opindex fvar-tracking-assignments-toggle
5551 @opindex fno-var-tracking-assignments-toggle
5552 Toggle @option{-fvar-tracking-assignments}, in the same way that
5553 @option{-gtoggle} toggles @option{-g}.
5554
5555 @item -print-file-name=@var{library}
5556 @opindex print-file-name
5557 Print the full absolute name of the library file @var{library} that
5558 would be used when linking---and don't do anything else.  With this
5559 option, GCC does not compile or link anything; it just prints the
5560 file name.
5561
5562 @item -print-multi-directory
5563 @opindex print-multi-directory
5564 Print the directory name corresponding to the multilib selected by any
5565 other switches present in the command line.  This directory is supposed
5566 to exist in @env{GCC_EXEC_PREFIX}.
5567
5568 @item -print-multi-lib
5569 @opindex print-multi-lib
5570 Print the mapping from multilib directory names to compiler switches
5571 that enable them.  The directory name is separated from the switches by
5572 @samp{;}, and each switch starts with an @samp{@@} instead of the
5573 @samp{-}, without spaces between multiple switches.  This is supposed to
5574 ease shell-processing.
5575
5576 @item -print-multi-os-directory
5577 @opindex print-multi-os-directory
5578 Print the path to OS libraries for the selected
5579 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5580 present in the @file{lib} subdirectory and no multilibs are used, this is
5581 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5582 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5583 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5584 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5585
5586 @item -print-prog-name=@var{program}
5587 @opindex print-prog-name
5588 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5589
5590 @item -print-libgcc-file-name
5591 @opindex print-libgcc-file-name
5592 Same as @option{-print-file-name=libgcc.a}.
5593
5594 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5595 but you do want to link with @file{libgcc.a}.  You can do
5596
5597 @smallexample
5598 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5599 @end smallexample
5600
5601 @item -print-search-dirs
5602 @opindex print-search-dirs
5603 Print the name of the configured installation directory and a list of
5604 program and library directories @command{gcc} will search---and don't do anything else.
5605
5606 This is useful when @command{gcc} prints the error message
5607 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5608 To resolve this you either need to put @file{cpp0} and the other compiler
5609 components where @command{gcc} expects to find them, or you can set the environment
5610 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5611 Don't forget the trailing @samp{/}.
5612 @xref{Environment Variables}.
5613
5614 @item -print-sysroot
5615 @opindex print-sysroot
5616 Print the target sysroot directory that will be used during
5617 compilation.  This is the target sysroot specified either at configure
5618 time or using the @option{--sysroot} option, possibly with an extra
5619 suffix that depends on compilation options.  If no target sysroot is
5620 specified, the option prints nothing.
5621
5622 @item -print-sysroot-headers-suffix
5623 @opindex print-sysroot-headers-suffix
5624 Print the suffix added to the target sysroot when searching for
5625 headers, or give an error if the compiler is not configured with such
5626 a suffix---and don't do anything else.
5627
5628 @item -dumpmachine
5629 @opindex dumpmachine
5630 Print the compiler's target machine (for example,
5631 @samp{i686-pc-linux-gnu})---and don't do anything else.
5632
5633 @item -dumpversion
5634 @opindex dumpversion
5635 Print the compiler version (for example, @samp{3.0})---and don't do
5636 anything else.
5637
5638 @item -dumpspecs
5639 @opindex dumpspecs
5640 Print the compiler's built-in specs---and don't do anything else.  (This
5641 is used when GCC itself is being built.)  @xref{Spec Files}.
5642
5643 @item -feliminate-unused-debug-types
5644 @opindex feliminate-unused-debug-types
5645 Normally, when producing DWARF2 output, GCC will emit debugging
5646 information for all types declared in a compilation
5647 unit, regardless of whether or not they are actually used
5648 in that compilation unit.  Sometimes this is useful, such as
5649 if, in the debugger, you want to cast a value to a type that is
5650 not actually used in your program (but is declared).  More often,
5651 however, this results in a significant amount of wasted space.
5652 With this option, GCC will avoid producing debug symbol output
5653 for types that are nowhere used in the source file being compiled.
5654 @end table
5655
5656 @node Optimize Options
5657 @section Options That Control Optimization
5658 @cindex optimize options
5659 @cindex options, optimization
5660
5661 These options control various sorts of optimizations.
5662
5663 Without any optimization option, the compiler's goal is to reduce the
5664 cost of compilation and to make debugging produce the expected
5665 results.  Statements are independent: if you stop the program with a
5666 breakpoint between statements, you can then assign a new value to any
5667 variable or change the program counter to any other statement in the
5668 function and get exactly the results you would expect from the source
5669 code.
5670
5671 Turning on optimization flags makes the compiler attempt to improve
5672 the performance and/or code size at the expense of compilation time
5673 and possibly the ability to debug the program.
5674
5675 The compiler performs optimization based on the knowledge it has of the
5676 program.  Compiling multiple files at once to a single output file mode allows
5677 the compiler to use information gained from all of the files when compiling
5678 each of them.
5679
5680 Not all optimizations are controlled directly by a flag.  Only
5681 optimizations that have a flag are listed in this section.
5682
5683 Most optimizations are only enabled if an @option{-O} level is set on
5684 the command line.  Otherwise they are disabled, even if individual             
5685 optimization flags are specified.
5686
5687 Depending on the target and how GCC was configured, a slightly different
5688 set of optimizations may be enabled at each @option{-O} level than
5689 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5690 to find out the exact set of optimizations that are enabled at each level.
5691 @xref{Overall Options}, for examples.
5692
5693 @table @gcctabopt
5694 @item -O
5695 @itemx -O1
5696 @opindex O
5697 @opindex O1
5698 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5699 more memory for a large function.
5700
5701 With @option{-O}, the compiler tries to reduce code size and execution
5702 time, without performing any optimizations that take a great deal of
5703 compilation time.
5704
5705 @option{-O} turns on the following optimization flags:
5706 @gccoptlist{
5707 -fauto-inc-dec @gol
5708 -fcprop-registers @gol
5709 -fdce @gol
5710 -fdefer-pop @gol
5711 -fdelayed-branch @gol
5712 -fdse @gol
5713 -fguess-branch-probability @gol
5714 -fif-conversion2 @gol
5715 -fif-conversion @gol
5716 -fipa-pure-const @gol
5717 -fipa-reference @gol
5718 -fmerge-constants
5719 -fsplit-wide-types @gol
5720 -ftree-builtin-call-dce @gol
5721 -ftree-ccp @gol
5722 -ftree-ch @gol
5723 -ftree-copyrename @gol
5724 -ftree-dce @gol
5725 -ftree-dominator-opts @gol
5726 -ftree-dse @gol
5727 -ftree-forwprop @gol
5728 -ftree-fre @gol
5729 -ftree-phiprop @gol
5730 -ftree-sra @gol
5731 -ftree-pta @gol
5732 -ftree-ter @gol
5733 -funit-at-a-time}
5734
5735 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5736 where doing so does not interfere with debugging.
5737
5738 @item -O2
5739 @opindex O2
5740 Optimize even more.  GCC performs nearly all supported optimizations
5741 that do not involve a space-speed tradeoff.
5742 As compared to @option{-O}, this option increases both compilation time
5743 and the performance of the generated code.
5744
5745 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5746 also turns on the following optimization flags:
5747 @gccoptlist{-fthread-jumps @gol
5748 -falign-functions  -falign-jumps @gol
5749 -falign-loops  -falign-labels @gol
5750 -fcaller-saves @gol
5751 -fcrossjumping @gol
5752 -fcse-follow-jumps  -fcse-skip-blocks @gol
5753 -fdelete-null-pointer-checks @gol
5754 -fexpensive-optimizations @gol
5755 -fgcse  -fgcse-lm  @gol
5756 -finline-small-functions @gol
5757 -findirect-inlining @gol
5758 -fipa-sra @gol
5759 -foptimize-sibling-calls @gol
5760 -fpeephole2 @gol
5761 -fregmove @gol
5762 -freorder-blocks  -freorder-functions @gol
5763 -frerun-cse-after-loop  @gol
5764 -fsched-interblock  -fsched-spec @gol
5765 -fschedule-insns  -fschedule-insns2 @gol
5766 -fstrict-aliasing -fstrict-overflow @gol
5767 -ftree-switch-conversion @gol
5768 -ftree-pre @gol
5769 -ftree-vrp}
5770
5771 Please note the warning under @option{-fgcse} about
5772 invoking @option{-O2} on programs that use computed gotos.
5773
5774 @item -O3
5775 @opindex O3
5776 Optimize yet more.  @option{-O3} turns on all optimizations specified
5777 by @option{-O2} and also turns on the @option{-finline-functions},
5778 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5779 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5780
5781 @item -O0
5782 @opindex O0
5783 Reduce compilation time and make debugging produce the expected
5784 results.  This is the default.
5785
5786 @item -Os
5787 @opindex Os
5788 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5789 do not typically increase code size.  It also performs further
5790 optimizations designed to reduce code size.
5791
5792 @option{-Os} disables the following optimization flags:
5793 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5794 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5795 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5796
5797 If you use multiple @option{-O} options, with or without level numbers,
5798 the last such option is the one that is effective.
5799 @end table
5800
5801 Options of the form @option{-f@var{flag}} specify machine-independent
5802 flags.  Most flags have both positive and negative forms; the negative
5803 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5804 below, only one of the forms is listed---the one you typically will
5805 use.  You can figure out the other form by either removing @samp{no-}
5806 or adding it.
5807
5808 The following options control specific optimizations.  They are either
5809 activated by @option{-O} options or are related to ones that are.  You
5810 can use the following flags in the rare cases when ``fine-tuning'' of
5811 optimizations to be performed is desired.
5812
5813 @table @gcctabopt
5814 @item -fno-default-inline
5815 @opindex fno-default-inline
5816 Do not make member functions inline by default merely because they are
5817 defined inside the class scope (C++ only).  Otherwise, when you specify
5818 @w{@option{-O}}, member functions defined inside class scope are compiled
5819 inline by default; i.e., you don't need to add @samp{inline} in front of
5820 the member function name.
5821
5822 @item -fno-defer-pop
5823 @opindex fno-defer-pop
5824 Always pop the arguments to each function call as soon as that function
5825 returns.  For machines which must pop arguments after a function call,
5826 the compiler normally lets arguments accumulate on the stack for several
5827 function calls and pops them all at once.
5828
5829 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5830
5831 @item -fforward-propagate
5832 @opindex fforward-propagate
5833 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5834 instructions and checks if the result can be simplified.  If loop unrolling
5835 is active, two passes are performed and the second is scheduled after
5836 loop unrolling.
5837
5838 This option is enabled by default at optimization levels @option{-O},
5839 @option{-O2}, @option{-O3}, @option{-Os}.
5840
5841 @item -fomit-frame-pointer
5842 @opindex fomit-frame-pointer
5843 Don't keep the frame pointer in a register for functions that
5844 don't need one.  This avoids the instructions to save, set up and
5845 restore frame pointers; it also makes an extra register available
5846 in many functions.  @strong{It also makes debugging impossible on
5847 some machines.}
5848
5849 On some machines, such as the VAX, this flag has no effect, because
5850 the standard calling sequence automatically handles the frame pointer
5851 and nothing is saved by pretending it doesn't exist.  The
5852 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5853 whether a target machine supports this flag.  @xref{Registers,,Register
5854 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5855
5856 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5857
5858 @item -foptimize-sibling-calls
5859 @opindex foptimize-sibling-calls
5860 Optimize sibling and tail recursive calls.
5861
5862 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5863
5864 @item -fno-inline
5865 @opindex fno-inline
5866 Don't pay attention to the @code{inline} keyword.  Normally this option
5867 is used to keep the compiler from expanding any functions inline.
5868 Note that if you are not optimizing, no functions can be expanded inline.
5869
5870 @item -finline-small-functions
5871 @opindex finline-small-functions
5872 Integrate functions into their callers when their body is smaller than expected
5873 function call code (so overall size of program gets smaller).  The compiler
5874 heuristically decides which functions are simple enough to be worth integrating
5875 in this way.
5876
5877 Enabled at level @option{-O2}.
5878
5879 @item -findirect-inlining
5880 @opindex findirect-inlining
5881 Inline also indirect calls that are discovered to be known at compile
5882 time thanks to previous inlining.  This option has any effect only
5883 when inlining itself is turned on by the @option{-finline-functions}
5884 or @option{-finline-small-functions} options.
5885
5886 Enabled at level @option{-O2}.
5887
5888 @item -finline-functions
5889 @opindex finline-functions
5890 Integrate all simple functions into their callers.  The compiler
5891 heuristically decides which functions are simple enough to be worth
5892 integrating in this way.
5893
5894 If all calls to a given function are integrated, and the function is
5895 declared @code{static}, then the function is normally not output as
5896 assembler code in its own right.
5897
5898 Enabled at level @option{-O3}.
5899
5900 @item -finline-functions-called-once
5901 @opindex finline-functions-called-once
5902 Consider all @code{static} functions called once for inlining into their
5903 caller even if they are not marked @code{inline}.  If a call to a given
5904 function is integrated, then the function is not output as assembler code
5905 in its own right.
5906
5907 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5908
5909 @item -fearly-inlining
5910 @opindex fearly-inlining
5911 Inline functions marked by @code{always_inline} and functions whose body seems
5912 smaller than the function call overhead early before doing
5913 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5914 makes profiling significantly cheaper and usually inlining faster on programs
5915 having large chains of nested wrapper functions.
5916
5917 Enabled by default.
5918
5919 @item -fipa-sra
5920 @opindex fipa-sra
5921 Perform interprocedural scalar replacement of aggregates, removal of
5922 unused parameters and replacement of parameters passed by reference
5923 by parameters passed by value.
5924
5925 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
5926
5927 @item -finline-limit=@var{n}
5928 @opindex finline-limit
5929 By default, GCC limits the size of functions that can be inlined.  This flag
5930 allows coarse control of this limit.  @var{n} is the size of functions that
5931 can be inlined in number of pseudo instructions.
5932
5933 Inlining is actually controlled by a number of parameters, which may be
5934 specified individually by using @option{--param @var{name}=@var{value}}.
5935 The @option{-finline-limit=@var{n}} option sets some of these parameters
5936 as follows:
5937
5938 @table @gcctabopt
5939 @item max-inline-insns-single
5940 is set to @var{n}/2.
5941 @item max-inline-insns-auto
5942 is set to @var{n}/2.
5943 @end table
5944
5945 See below for a documentation of the individual
5946 parameters controlling inlining and for the defaults of these parameters.
5947
5948 @emph{Note:} there may be no value to @option{-finline-limit} that results
5949 in default behavior.
5950
5951 @emph{Note:} pseudo instruction represents, in this particular context, an
5952 abstract measurement of function's size.  In no way does it represent a count
5953 of assembly instructions and as such its exact meaning might change from one
5954 release to an another.
5955
5956 @item -fkeep-inline-functions
5957 @opindex fkeep-inline-functions
5958 In C, emit @code{static} functions that are declared @code{inline}
5959 into the object file, even if the function has been inlined into all
5960 of its callers.  This switch does not affect functions using the
5961 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
5962 inline functions into the object file.
5963
5964 @item -fkeep-static-consts
5965 @opindex fkeep-static-consts
5966 Emit variables declared @code{static const} when optimization isn't turned
5967 on, even if the variables aren't referenced.
5968
5969 GCC enables this option by default.  If you want to force the compiler to
5970 check if the variable was referenced, regardless of whether or not
5971 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5972
5973 @item -fmerge-constants
5974 @opindex fmerge-constants
5975 Attempt to merge identical constants (string constants and floating point
5976 constants) across compilation units.
5977
5978 This option is the default for optimized compilation if the assembler and
5979 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5980 behavior.
5981
5982 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5983
5984 @item -fmerge-all-constants
5985 @opindex fmerge-all-constants
5986 Attempt to merge identical constants and identical variables.
5987
5988 This option implies @option{-fmerge-constants}.  In addition to
5989 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5990 arrays or initialized constant variables with integral or floating point
5991 types.  Languages like C or C++ require each variable, including multiple
5992 instances of the same variable in recursive calls, to have distinct locations,
5993 so using this option will result in non-conforming
5994 behavior.
5995
5996 @item -fmodulo-sched
5997 @opindex fmodulo-sched
5998 Perform swing modulo scheduling immediately before the first scheduling
5999 pass.  This pass looks at innermost loops and reorders their
6000 instructions by overlapping different iterations.
6001
6002 @item -fmodulo-sched-allow-regmoves
6003 @opindex fmodulo-sched-allow-regmoves
6004 Perform more aggressive SMS based modulo scheduling with register moves
6005 allowed.  By setting this flag certain anti-dependences edges will be
6006 deleted which will trigger the generation of reg-moves based on the
6007 life-range analysis.  This option is effective only with
6008 @option{-fmodulo-sched} enabled.
6009
6010 @item -fno-branch-count-reg
6011 @opindex fno-branch-count-reg
6012 Do not use ``decrement and branch'' instructions on a count register,
6013 but instead generate a sequence of instructions that decrement a
6014 register, compare it against zero, then branch based upon the result.
6015 This option is only meaningful on architectures that support such
6016 instructions, which include x86, PowerPC, IA-64 and S/390.
6017
6018 The default is @option{-fbranch-count-reg}.
6019
6020 @item -fno-function-cse
6021 @opindex fno-function-cse
6022 Do not put function addresses in registers; make each instruction that
6023 calls a constant function contain the function's address explicitly.
6024
6025 This option results in less efficient code, but some strange hacks
6026 that alter the assembler output may be confused by the optimizations
6027 performed when this option is not used.
6028
6029 The default is @option{-ffunction-cse}
6030
6031 @item -fno-zero-initialized-in-bss
6032 @opindex fno-zero-initialized-in-bss
6033 If the target supports a BSS section, GCC by default puts variables that
6034 are initialized to zero into BSS@.  This can save space in the resulting
6035 code.
6036
6037 This option turns off this behavior because some programs explicitly
6038 rely on variables going to the data section.  E.g., so that the
6039 resulting executable can find the beginning of that section and/or make
6040 assumptions based on that.
6041
6042 The default is @option{-fzero-initialized-in-bss}.
6043
6044 @item -fmudflap -fmudflapth -fmudflapir
6045 @opindex fmudflap
6046 @opindex fmudflapth
6047 @opindex fmudflapir
6048 @cindex bounds checking
6049 @cindex mudflap
6050 For front-ends that support it (C and C++), instrument all risky
6051 pointer/array dereferencing operations, some standard library
6052 string/heap functions, and some other associated constructs with
6053 range/validity tests.  Modules so instrumented should be immune to
6054 buffer overflows, invalid heap use, and some other classes of C/C++
6055 programming errors.  The instrumentation relies on a separate runtime
6056 library (@file{libmudflap}), which will be linked into a program if
6057 @option{-fmudflap} is given at link time.  Run-time behavior of the
6058 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6059 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6060 for its options.
6061
6062 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6063 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6064 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6065 instrumentation should ignore pointer reads.  This produces less
6066 instrumentation (and therefore faster execution) and still provides
6067 some protection against outright memory corrupting writes, but allows
6068 erroneously read data to propagate within a program.
6069
6070 @item -fthread-jumps
6071 @opindex fthread-jumps
6072 Perform optimizations where we check to see if a jump branches to a
6073 location where another comparison subsumed by the first is found.  If
6074 so, the first branch is redirected to either the destination of the
6075 second branch or a point immediately following it, depending on whether
6076 the condition is known to be true or false.
6077
6078 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6079
6080 @item -fsplit-wide-types
6081 @opindex fsplit-wide-types
6082 When using a type that occupies multiple registers, such as @code{long
6083 long} on a 32-bit system, split the registers apart and allocate them
6084 independently.  This normally generates better code for those types,
6085 but may make debugging more difficult.
6086
6087 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6088 @option{-Os}.
6089
6090 @item -fcse-follow-jumps
6091 @opindex fcse-follow-jumps
6092 In common subexpression elimination (CSE), scan through jump instructions
6093 when the target of the jump is not reached by any other path.  For
6094 example, when CSE encounters an @code{if} statement with an
6095 @code{else} clause, CSE will follow the jump when the condition
6096 tested is false.
6097
6098 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6099
6100 @item -fcse-skip-blocks
6101 @opindex fcse-skip-blocks
6102 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6103 follow jumps which conditionally skip over blocks.  When CSE
6104 encounters a simple @code{if} statement with no else clause,
6105 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6106 body of the @code{if}.
6107
6108 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6109
6110 @item -frerun-cse-after-loop
6111 @opindex frerun-cse-after-loop
6112 Re-run common subexpression elimination after loop optimizations has been
6113 performed.
6114
6115 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6116
6117 @item -fgcse
6118 @opindex fgcse
6119 Perform a global common subexpression elimination pass.
6120 This pass also performs global constant and copy propagation.
6121
6122 @emph{Note:} When compiling a program using computed gotos, a GCC
6123 extension, you may get better runtime performance if you disable
6124 the global common subexpression elimination pass by adding
6125 @option{-fno-gcse} to the command line.
6126
6127 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6128
6129 @item -fgcse-lm
6130 @opindex fgcse-lm
6131 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6132 attempt to move loads which are only killed by stores into themselves.  This
6133 allows a loop containing a load/store sequence to be changed to a load outside
6134 the loop, and a copy/store within the loop.
6135
6136 Enabled by default when gcse is enabled.
6137
6138 @item -fgcse-sm
6139 @opindex fgcse-sm
6140 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6141 global common subexpression elimination.  This pass will attempt to move
6142 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6143 loops containing a load/store sequence can be changed to a load before
6144 the loop and a store after the loop.
6145
6146 Not enabled at any optimization level.
6147
6148 @item -fgcse-las
6149 @opindex fgcse-las
6150 When @option{-fgcse-las} is enabled, the global common subexpression
6151 elimination pass eliminates redundant loads that come after stores to the
6152 same memory location (both partial and full redundancies).
6153
6154 Not enabled at any optimization level.
6155
6156 @item -fgcse-after-reload
6157 @opindex fgcse-after-reload
6158 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6159 pass is performed after reload.  The purpose of this pass is to cleanup
6160 redundant spilling.
6161
6162 @item -funsafe-loop-optimizations
6163 @opindex funsafe-loop-optimizations
6164 If given, the loop optimizer will assume that loop indices do not
6165 overflow, and that the loops with nontrivial exit condition are not
6166 infinite.  This enables a wider range of loop optimizations even if
6167 the loop optimizer itself cannot prove that these assumptions are valid.
6168 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6169 if it finds this kind of loop.
6170
6171 @item -fcrossjumping
6172 @opindex fcrossjumping
6173 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6174 resulting code may or may not perform better than without cross-jumping.
6175
6176 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6177
6178 @item -fauto-inc-dec
6179 @opindex fauto-inc-dec
6180 Combine increments or decrements of addresses with memory accesses.
6181 This pass is always skipped on architectures that do not have
6182 instructions to support this.  Enabled by default at @option{-O} and
6183 higher on architectures that support this.
6184
6185 @item -fdce
6186 @opindex fdce
6187 Perform dead code elimination (DCE) on RTL@.
6188 Enabled by default at @option{-O} and higher.
6189
6190 @item -fdse
6191 @opindex fdse
6192 Perform dead store elimination (DSE) on RTL@.
6193 Enabled by default at @option{-O} and higher.
6194
6195 @item -fif-conversion
6196 @opindex fif-conversion
6197 Attempt to transform conditional jumps into branch-less equivalents.  This
6198 include use of conditional moves, min, max, set flags and abs instructions, and
6199 some tricks doable by standard arithmetics.  The use of conditional execution
6200 on chips where it is available is controlled by @code{if-conversion2}.
6201
6202 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6203
6204 @item -fif-conversion2
6205 @opindex fif-conversion2
6206 Use conditional execution (where available) to transform conditional jumps into
6207 branch-less equivalents.
6208
6209 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6210
6211 @item -fdelete-null-pointer-checks
6212 @opindex fdelete-null-pointer-checks
6213 Assume that programs cannot safely dereference null pointers, and that
6214 no code or data element resides there.  This enables simple constant
6215 folding optimizations at all optimization levels.  In addition, other
6216 optimization passes in GCC use this flag to control global dataflow
6217 analyses that eliminate useless checks for null pointers; these assume
6218 that if a pointer is checked after it has already been dereferenced,
6219 it cannot be null.
6220
6221 Note however that in some environments this assumption is not true.
6222 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6223 for programs which depend on that behavior.
6224
6225 Some targets, especially embedded ones, disable this option at all levels.
6226 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6227 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6228 are enabled independently at different optimization levels.
6229
6230 @item -fexpensive-optimizations
6231 @opindex fexpensive-optimizations
6232 Perform a number of minor optimizations that are relatively expensive.
6233
6234 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6235
6236 @item -foptimize-register-move
6237 @itemx -fregmove
6238 @opindex foptimize-register-move
6239 @opindex fregmove
6240 Attempt to reassign register numbers in move instructions and as
6241 operands of other simple instructions in order to maximize the amount of
6242 register tying.  This is especially helpful on machines with two-operand
6243 instructions.
6244
6245 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6246 optimization.
6247
6248 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6249
6250 @item -fira-algorithm=@var{algorithm}
6251 Use specified coloring algorithm for the integrated register
6252 allocator.  The @var{algorithm} argument should be @code{priority} or
6253 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6254 the second one specifies Chaitin-Briggs coloring.  The second
6255 algorithm can be unimplemented for some architectures.  If it is
6256 implemented, it is the default because Chaitin-Briggs coloring as a
6257 rule generates a better code.
6258
6259 @item -fira-region=@var{region}
6260 Use specified regions for the integrated register allocator.  The
6261 @var{region} argument should be one of @code{all}, @code{mixed}, or
6262 @code{one}.  The first value means using all loops as register
6263 allocation regions, the second value which is the default means using
6264 all loops except for loops with small register pressure as the
6265 regions, and third one means using all function as a single region.
6266 The first value can give best result for machines with small size and
6267 irregular register set, the third one results in faster and generates
6268 decent code and the smallest size code, and the default value usually
6269 give the best results in most cases and for most architectures.
6270
6271 @item -fira-coalesce
6272 @opindex fira-coalesce
6273 Do optimistic register coalescing.  This option might be profitable for
6274 architectures with big regular register files.
6275
6276 @item -fira-loop-pressure
6277 @opindex fira-loop-pressure
6278 Use IRA to evaluate register pressure in loops for decision to move
6279 loop invariants.  Usage of this option usually results in generation
6280 of faster and smaller code on machines with big register files (>= 32
6281 registers) but it can slow compiler down.
6282
6283 This option is enabled at level @option{-O3} for some targets.
6284
6285 @item -fno-ira-share-save-slots
6286 @opindex fno-ira-share-save-slots
6287 Switch off sharing stack slots used for saving call used hard
6288 registers living through a call.  Each hard register will get a
6289 separate stack slot and as a result function stack frame will be
6290 bigger.
6291
6292 @item -fno-ira-share-spill-slots
6293 @opindex fno-ira-share-spill-slots
6294 Switch off sharing stack slots allocated for pseudo-registers.  Each
6295 pseudo-register which did not get a hard register will get a separate
6296 stack slot and as a result function stack frame will be bigger.
6297
6298 @item -fira-verbose=@var{n}
6299 @opindex fira-verbose
6300 Set up how verbose dump file for the integrated register allocator
6301 will be.  Default value is 5.  If the value is greater or equal to 10,
6302 the dump file will be stderr as if the value were @var{n} minus 10.
6303
6304 @item -fdelayed-branch
6305 @opindex fdelayed-branch
6306 If supported for the target machine, attempt to reorder instructions
6307 to exploit instruction slots available after delayed branch
6308 instructions.
6309
6310 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6311
6312 @item -fschedule-insns
6313 @opindex fschedule-insns
6314 If supported for the target machine, attempt to reorder instructions to
6315 eliminate execution stalls due to required data being unavailable.  This
6316 helps machines that have slow floating point or memory load instructions
6317 by allowing other instructions to be issued until the result of the load
6318 or floating point instruction is required.
6319
6320 Enabled at levels @option{-O2}, @option{-O3}.
6321
6322 @item -fschedule-insns2
6323 @opindex fschedule-insns2
6324 Similar to @option{-fschedule-insns}, but requests an additional pass of
6325 instruction scheduling after register allocation has been done.  This is
6326 especially useful on machines with a relatively small number of
6327 registers and where memory load instructions take more than one cycle.
6328
6329 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6330
6331 @item -fno-sched-interblock
6332 @opindex fno-sched-interblock
6333 Don't schedule instructions across basic blocks.  This is normally
6334 enabled by default when scheduling before register allocation, i.e.@:
6335 with @option{-fschedule-insns} or at @option{-O2} or higher.
6336
6337 @item -fno-sched-spec
6338 @opindex fno-sched-spec
6339 Don't allow speculative motion of non-load instructions.  This is normally
6340 enabled by default when scheduling before register allocation, i.e.@:
6341 with @option{-fschedule-insns} or at @option{-O2} or higher.
6342
6343 @item -fsched-pressure
6344 @opindex fsched-pressure
6345 Enable register pressure sensitive insn scheduling before the register
6346 allocation.  This only makes sense when scheduling before register
6347 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6348 @option{-O2} or higher.  Usage of this option can improve the
6349 generated code and decrease its size by preventing register pressure
6350 increase above the number of available hard registers and as a
6351 consequence register spills in the register allocation.
6352
6353 @item -fsched-spec-load
6354 @opindex fsched-spec-load
6355 Allow speculative motion of some load instructions.  This only makes
6356 sense when scheduling before register allocation, i.e.@: with
6357 @option{-fschedule-insns} or at @option{-O2} or higher.
6358
6359 @item -fsched-spec-load-dangerous
6360 @opindex fsched-spec-load-dangerous
6361 Allow speculative motion of more load instructions.  This only makes
6362 sense when scheduling before register allocation, i.e.@: with
6363 @option{-fschedule-insns} or at @option{-O2} or higher.
6364
6365 @item -fsched-stalled-insns
6366 @itemx -fsched-stalled-insns=@var{n}
6367 @opindex fsched-stalled-insns
6368 Define how many insns (if any) can be moved prematurely from the queue
6369 of stalled insns into the ready list, during the second scheduling pass.
6370 @option{-fno-sched-stalled-insns} means that no insns will be moved
6371 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6372 on how many queued insns can be moved prematurely.
6373 @option{-fsched-stalled-insns} without a value is equivalent to
6374 @option{-fsched-stalled-insns=1}.
6375
6376 @item -fsched-stalled-insns-dep
6377 @itemx -fsched-stalled-insns-dep=@var{n}
6378 @opindex fsched-stalled-insns-dep
6379 Define how many insn groups (cycles) will be examined for a dependency
6380 on a stalled insn that is candidate for premature removal from the queue
6381 of stalled insns.  This has an effect only during the second scheduling pass,
6382 and only if @option{-fsched-stalled-insns} is used.
6383 @option{-fno-sched-stalled-insns-dep} is equivalent to
6384 @option{-fsched-stalled-insns-dep=0}.
6385 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6386 @option{-fsched-stalled-insns-dep=1}.
6387
6388 @item -fsched2-use-superblocks
6389 @opindex fsched2-use-superblocks
6390 When scheduling after register allocation, do use superblock scheduling
6391 algorithm.  Superblock scheduling allows motion across basic block boundaries
6392 resulting on faster schedules.  This option is experimental, as not all machine
6393 descriptions used by GCC model the CPU closely enough to avoid unreliable
6394 results from the algorithm.
6395
6396 This only makes sense when scheduling after register allocation, i.e.@: with
6397 @option{-fschedule-insns2} or at @option{-O2} or higher.
6398
6399 @item -fsched-group-heuristic
6400 @opindex fsched-group-heuristic
6401 Enable the group heuristic in the scheduler.  This heuristic favors 
6402 the instruction that belongs to a schedule group.  This is enabled 
6403 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6404 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6405
6406 @item -fsched-critical-path-heuristic
6407 @opindex fsched-critical-path-heuristic
6408 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6409 instructions on the critical path.  This is enabled by default when 
6410 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6411 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6412
6413 @item -fsched-spec-insn-heuristic
6414 @opindex fsched-spec-insn-heuristic
6415 Enable the speculative instruction heuristic in the scheduler.  This 
6416 heuristic favors speculative instructions with greater dependency weakness.  
6417 This is enabled by default when scheduling is enabled, i.e.@: 
6418 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6419 or at @option{-O2} or higher.
6420
6421 @item -fsched-rank-heuristic
6422 @opindex fsched-rank-heuristic
6423 Enable the rank heuristic in the scheduler.  This heuristic favors 
6424 the instruction belonging to a basic block with greater size or frequency.  
6425 This is enabled by default when scheduling is enabled, i.e.@: 
6426 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6427 at @option{-O2} or higher.
6428
6429 @item -fsched-last-insn-heuristic
6430 @opindex fsched-last-insn-heuristic
6431 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6432 favors the instruction that is less dependent on the last instruction
6433 scheduled.  This is enabled by default when scheduling is enabled, 
6434 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6435 at @option{-O2} or higher.
6436
6437 @item -fsched-dep-count-heuristic
6438 @opindex fsched-dep-count-heuristic
6439 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6440 favors the instruction that has more instructions depending on it.  
6441 This is enabled by default when scheduling is enabled, i.e.@: 
6442 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6443 at @option{-O2} or higher.
6444
6445 @item -freschedule-modulo-scheduled-loops
6446 @opindex freschedule-modulo-scheduled-loops
6447 The modulo scheduling comes before the traditional scheduling, if a loop
6448 was modulo scheduled we may want to prevent the later scheduling passes
6449 from changing its schedule, we use this option to control that.
6450
6451 @item -fselective-scheduling
6452 @opindex fselective-scheduling
6453 Schedule instructions using selective scheduling algorithm.  Selective
6454 scheduling runs instead of the first scheduler pass.
6455
6456 @item -fselective-scheduling2
6457 @opindex fselective-scheduling2
6458 Schedule instructions using selective scheduling algorithm.  Selective
6459 scheduling runs instead of the second scheduler pass.
6460
6461 @item -fsel-sched-pipelining
6462 @opindex fsel-sched-pipelining
6463 Enable software pipelining of innermost loops during selective scheduling.
6464 This option has no effect until one of @option{-fselective-scheduling} or
6465 @option{-fselective-scheduling2} is turned on.
6466
6467 @item -fsel-sched-pipelining-outer-loops
6468 @opindex fsel-sched-pipelining-outer-loops
6469 When pipelining loops during selective scheduling, also pipeline outer loops.
6470 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6471
6472 @item -fcaller-saves
6473 @opindex fcaller-saves
6474 Enable values to be allocated in registers that will be clobbered by
6475 function calls, by emitting extra instructions to save and restore the
6476 registers around such calls.  Such allocation is done only when it
6477 seems to result in better code than would otherwise be produced.
6478
6479 This option is always enabled by default on certain machines, usually
6480 those which have no call-preserved registers to use instead.
6481
6482 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6483
6484 @item -fconserve-stack
6485 @opindex fconserve-stack
6486 Attempt to minimize stack usage.  The compiler will attempt to use less
6487 stack space, even if that makes the program slower.  This option
6488 implies setting the @option{large-stack-frame} parameter to 100
6489 and the @option{large-stack-frame-growth} parameter to 400.
6490
6491 @item -ftree-reassoc
6492 @opindex ftree-reassoc
6493 Perform reassociation on trees.  This flag is enabled by default
6494 at @option{-O} and higher.
6495
6496 @item -ftree-pre
6497 @opindex ftree-pre
6498 Perform partial redundancy elimination (PRE) on trees.  This flag is
6499 enabled by default at @option{-O2} and @option{-O3}.
6500
6501 @item -ftree-forwprop
6502 @opindex ftree-forwprop
6503 Perform forward propagation on trees.  This flag is enabled by default
6504 at @option{-O} and higher.
6505
6506 @item -ftree-fre
6507 @opindex ftree-fre
6508 Perform full redundancy elimination (FRE) on trees.  The difference
6509 between FRE and PRE is that FRE only considers expressions
6510 that are computed on all paths leading to the redundant computation.
6511 This analysis is faster than PRE, though it exposes fewer redundancies.
6512 This flag is enabled by default at @option{-O} and higher.
6513
6514 @item -ftree-phiprop
6515 @opindex ftree-phiprop
6516 Perform hoisting of loads from conditional pointers on trees.  This
6517 pass is enabled by default at @option{-O} and higher.
6518
6519 @item -ftree-copy-prop
6520 @opindex ftree-copy-prop
6521 Perform copy propagation on trees.  This pass eliminates unnecessary
6522 copy operations.  This flag is enabled by default at @option{-O} and
6523 higher.
6524
6525 @item -fipa-pure-const
6526 @opindex fipa-pure-const
6527 Discover which functions are pure or constant.
6528 Enabled by default at @option{-O} and higher.
6529
6530 @item -fipa-reference
6531 @opindex fipa-reference
6532 Discover which static variables do not escape cannot escape the
6533 compilation unit.
6534 Enabled by default at @option{-O} and higher.
6535
6536 @item -fipa-struct-reorg
6537 @opindex fipa-struct-reorg
6538 Perform structure reorganization optimization, that change C-like structures
6539 layout in order to better utilize spatial locality.  This transformation is
6540 affective for programs containing arrays of structures.  Available in two
6541 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6542 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
6543 to provide the safety of this transformation.  It works only in whole program
6544 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6545 enabled.  Structures considered @samp{cold} by this transformation are not
6546 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6547
6548 With this flag, the program debug info reflects a new structure layout.
6549
6550 @item -fipa-pta
6551 @opindex fipa-pta
6552 Perform interprocedural pointer analysis.  This option is experimental
6553 and does not affect generated code.
6554
6555 @item -fipa-cp
6556 @opindex fipa-cp
6557 Perform interprocedural constant propagation.
6558 This optimization analyzes the program to determine when values passed
6559 to functions are constants and then optimizes accordingly.
6560 This optimization can substantially increase performance
6561 if the application has constants passed to functions.
6562 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6563
6564 @item -fipa-cp-clone
6565 @opindex fipa-cp-clone
6566 Perform function cloning to make interprocedural constant propagation stronger.
6567 When enabled, interprocedural constant propagation will perform function cloning
6568 when externally visible function can be called with constant arguments.
6569 Because this optimization can create multiple copies of functions,
6570 it may significantly increase code size
6571 (see @option{--param ipcp-unit-growth=@var{value}}).
6572 This flag is enabled by default at @option{-O3}.
6573
6574 @item -fipa-matrix-reorg
6575 @opindex fipa-matrix-reorg
6576 Perform matrix flattening and transposing.
6577 Matrix flattening tries to replace an @math{m}-dimensional matrix
6578 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6579 This reduces the level of indirection needed for accessing the elements
6580 of the matrix. The second optimization is matrix transposing that
6581 attempts to change the order of the matrix's dimensions in order to
6582 improve cache locality.
6583 Both optimizations need the @option{-fwhole-program} flag.
6584 Transposing is enabled only if profiling information is available.
6585
6586 @item -ftree-sink
6587 @opindex ftree-sink
6588 Perform forward store motion  on trees.  This flag is
6589 enabled by default at @option{-O} and higher.
6590
6591 @item -ftree-ccp
6592 @opindex ftree-ccp
6593 Perform sparse conditional constant propagation (CCP) on trees.  This
6594 pass only operates on local scalar variables and is enabled by default
6595 at @option{-O} and higher.
6596
6597 @item -ftree-switch-conversion
6598 Perform conversion of simple initializations in a switch to
6599 initializations from a scalar array.  This flag is enabled by default
6600 at @option{-O2} and higher.
6601
6602 @item -ftree-dce
6603 @opindex ftree-dce
6604 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6605 default at @option{-O} and higher.
6606
6607 @item -ftree-builtin-call-dce
6608 @opindex ftree-builtin-call-dce
6609 Perform conditional dead code elimination (DCE) for calls to builtin functions
6610 that may set @code{errno} but are otherwise side-effect free.  This flag is
6611 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6612 specified.
6613
6614 @item -ftree-dominator-opts
6615 @opindex ftree-dominator-opts
6616 Perform a variety of simple scalar cleanups (constant/copy
6617 propagation, redundancy elimination, range propagation and expression
6618 simplification) based on a dominator tree traversal.  This also
6619 performs jump threading (to reduce jumps to jumps). This flag is
6620 enabled by default at @option{-O} and higher.
6621
6622 @item -ftree-dse
6623 @opindex ftree-dse
6624 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6625 a memory location which will later be overwritten by another store without
6626 any intervening loads.  In this case the earlier store can be deleted.  This
6627 flag is enabled by default at @option{-O} and higher.
6628
6629 @item -ftree-ch
6630 @opindex ftree-ch
6631 Perform loop header copying on trees.  This is beneficial since it increases
6632 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6633 is enabled by default at @option{-O} and higher.  It is not enabled
6634 for @option{-Os}, since it usually increases code size.
6635
6636 @item -ftree-loop-optimize
6637 @opindex ftree-loop-optimize
6638 Perform loop optimizations on trees.  This flag is enabled by default
6639 at @option{-O} and higher.
6640
6641 @item -ftree-loop-linear
6642 @opindex ftree-loop-linear
6643 Perform linear loop transformations on tree.  This flag can improve cache
6644 performance and allow further loop optimizations to take place.
6645
6646 @item -floop-interchange
6647 Perform loop interchange transformations on loops.  Interchanging two
6648 nested loops switches the inner and outer loops.  For example, given a
6649 loop like:
6650 @smallexample
6651 DO J = 1, M
6652   DO I = 1, N
6653     A(J, I) = A(J, I) * C
6654   ENDDO
6655 ENDDO
6656 @end smallexample
6657 loop interchange will transform the loop as if the user had written:
6658 @smallexample
6659 DO I = 1, N
6660   DO J = 1, M
6661     A(J, I) = A(J, I) * C
6662   ENDDO
6663 ENDDO
6664 @end smallexample
6665 which can be beneficial when @code{N} is larger than the caches,
6666 because in Fortran, the elements of an array are stored in memory
6667 contiguously by column, and the original loop iterates over rows,
6668 potentially creating at each access a cache miss.  This optimization
6669 applies to all the languages supported by GCC and is not limited to
6670 Fortran.  To use this code transformation, GCC has to be configured
6671 with @option{--with-ppl} and @option{--with-cloog} to enable the
6672 Graphite loop transformation infrastructure.
6673
6674 @item -floop-strip-mine
6675 Perform loop strip mining transformations on loops.  Strip mining
6676 splits a loop into two nested loops.  The outer loop has strides
6677 equal to the strip size and the inner loop has strides of the
6678 original loop within a strip.  For example, given a loop like:
6679 @smallexample
6680 DO I = 1, N
6681   A(I) = A(I) + C
6682 ENDDO
6683 @end smallexample
6684 loop strip mining will transform the loop as if the user had written:
6685 @smallexample
6686 DO II = 1, N, 4
6687   DO I = II, min (II + 3, N)
6688     A(I) = A(I) + C
6689   ENDDO
6690 ENDDO
6691 @end smallexample
6692 This optimization applies to all the languages supported by GCC and is
6693 not limited to Fortran.  To use this code transformation, GCC has to
6694 be configured with @option{--with-ppl} and @option{--with-cloog} to
6695 enable the Graphite loop transformation infrastructure.
6696
6697 @item -floop-block
6698 Perform loop blocking transformations on loops.  Blocking strip mines
6699 each loop in the loop nest such that the memory accesses of the
6700 element loops fit inside caches.  For example, given a loop like:
6701 @smallexample
6702 DO I = 1, N
6703   DO J = 1, M
6704     A(J, I) = B(I) + C(J)
6705   ENDDO
6706 ENDDO
6707 @end smallexample
6708 loop blocking will transform the loop as if the user had written:
6709 @smallexample
6710 DO II = 1, N, 64
6711   DO JJ = 1, M, 64
6712     DO I = II, min (II + 63, N)
6713       DO J = JJ, min (JJ + 63, M)
6714         A(J, I) = B(I) + C(J)
6715       ENDDO
6716     ENDDO
6717   ENDDO
6718 ENDDO
6719 @end smallexample
6720 which can be beneficial when @code{M} is larger than the caches,
6721 because the innermost loop will iterate over a smaller amount of data
6722 that can be kept in the caches.  This optimization applies to all the
6723 languages supported by GCC and is not limited to Fortran.  To use this
6724 code transformation, GCC has to be configured with @option{--with-ppl}
6725 and @option{--with-cloog} to enable the Graphite loop transformation
6726 infrastructure.
6727
6728 @item -fgraphite-identity
6729 @opindex fgraphite-identity
6730 Enable the identity transformation for graphite.  For every SCoP we generate
6731 the polyhedral representation and transform it back to gimple.  Using
6732 @option{-fgraphite-identity} we can check the costs or benefits of the
6733 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6734 are also performed by the code generator CLooG, like index splitting and
6735 dead code elimination in loops.
6736
6737 @item -floop-parallelize-all
6738 Use the Graphite data dependence analysis to identify loops that can
6739 be parallelized.  Parallelize all the loops that can be analyzed to
6740 not contain loop carried dependences without checking that it is
6741 profitable to parallelize the loops.
6742
6743 @item -fcheck-data-deps
6744 @opindex fcheck-data-deps
6745 Compare the results of several data dependence analyzers.  This option
6746 is used for debugging the data dependence analyzers.
6747
6748 @item -ftree-loop-distribution
6749 Perform loop distribution.  This flag can improve cache performance on
6750 big loop bodies and allow further loop optimizations, like
6751 parallelization or vectorization, to take place.  For example, the loop
6752 @smallexample
6753 DO I = 1, N
6754   A(I) = B(I) + C
6755   D(I) = E(I) * F
6756 ENDDO
6757 @end smallexample
6758 is transformed to
6759 @smallexample
6760 DO I = 1, N
6761    A(I) = B(I) + C
6762 ENDDO
6763 DO I = 1, N
6764    D(I) = E(I) * F
6765 ENDDO
6766 @end smallexample
6767
6768 @item -ftree-loop-im
6769 @opindex ftree-loop-im
6770 Perform loop invariant motion on trees.  This pass moves only invariants that
6771 would be hard to handle at RTL level (function calls, operations that expand to
6772 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6773 operands of conditions that are invariant out of the loop, so that we can use
6774 just trivial invariantness analysis in loop unswitching.  The pass also includes
6775 store motion.
6776
6777 @item -ftree-loop-ivcanon
6778 @opindex ftree-loop-ivcanon
6779 Create a canonical counter for number of iterations in the loop for that
6780 determining number of iterations requires complicated analysis.  Later
6781 optimizations then may determine the number easily.  Useful especially
6782 in connection with unrolling.
6783
6784 @item -fivopts
6785 @opindex fivopts
6786 Perform induction variable optimizations (strength reduction, induction
6787 variable merging and induction variable elimination) on trees.
6788
6789 @item -ftree-parallelize-loops=n
6790 @opindex ftree-parallelize-loops
6791 Parallelize loops, i.e., split their iteration space to run in n threads.
6792 This is only possible for loops whose iterations are independent
6793 and can be arbitrarily reordered.  The optimization is only
6794 profitable on multiprocessor machines, for loops that are CPU-intensive,
6795 rather than constrained e.g.@: by memory bandwidth.  This option
6796 implies @option{-pthread}, and thus is only supported on targets
6797 that have support for @option{-pthread}.
6798
6799 @item -ftree-pta
6800 @opindex ftree-pta
6801 Perform function-local points-to analysis on trees.  This flag is
6802 enabled by default at @option{-O} and higher.
6803
6804 @item -ftree-sra
6805 @opindex ftree-sra
6806 Perform scalar replacement of aggregates.  This pass replaces structure
6807 references with scalars to prevent committing structures to memory too
6808 early.  This flag is enabled by default at @option{-O} and higher.
6809
6810 @item -ftree-copyrename
6811 @opindex ftree-copyrename
6812 Perform copy renaming on trees.  This pass attempts to rename compiler
6813 temporaries to other variables at copy locations, usually resulting in
6814 variable names which more closely resemble the original variables.  This flag
6815 is enabled by default at @option{-O} and higher.
6816
6817 @item -ftree-ter
6818 @opindex ftree-ter
6819 Perform temporary expression replacement during the SSA->normal phase.  Single
6820 use/single def temporaries are replaced at their use location with their
6821 defining expression.  This results in non-GIMPLE code, but gives the expanders
6822 much more complex trees to work on resulting in better RTL generation.  This is
6823 enabled by default at @option{-O} and higher.
6824
6825 @item -ftree-vectorize
6826 @opindex ftree-vectorize
6827 Perform loop vectorization on trees. This flag is enabled by default at
6828 @option{-O3}.
6829
6830 @item -ftree-slp-vectorize
6831 @opindex ftree-slp-vectorize
6832 Perform basic block vectorization on trees. This flag is enabled by default at
6833 @option{-O3} and when @option{-ftree-vectorize} is enabled.
6834
6835 @item -ftree-vect-loop-version
6836 @opindex ftree-vect-loop-version
6837 Perform loop versioning when doing loop vectorization on trees.  When a loop
6838 appears to be vectorizable except that data alignment or data dependence cannot
6839 be determined at compile time then vectorized and non-vectorized versions of
6840 the loop are generated along with runtime checks for alignment or dependence
6841 to control which version is executed.  This option is enabled by default
6842 except at level @option{-Os} where it is disabled.
6843
6844 @item -fvect-cost-model
6845 @opindex fvect-cost-model
6846 Enable cost model for vectorization.
6847
6848 @item -ftree-vrp
6849 @opindex ftree-vrp
6850 Perform Value Range Propagation on trees.  This is similar to the
6851 constant propagation pass, but instead of values, ranges of values are
6852 propagated.  This allows the optimizers to remove unnecessary range
6853 checks like array bound checks and null pointer checks.  This is
6854 enabled by default at @option{-O2} and higher.  Null pointer check
6855 elimination is only done if @option{-fdelete-null-pointer-checks} is
6856 enabled.
6857
6858 @item -ftracer
6859 @opindex ftracer
6860 Perform tail duplication to enlarge superblock size.  This transformation
6861 simplifies the control flow of the function allowing other optimizations to do
6862 better job.
6863
6864 @item -funroll-loops
6865 @opindex funroll-loops
6866 Unroll loops whose number of iterations can be determined at compile
6867 time or upon entry to the loop.  @option{-funroll-loops} implies
6868 @option{-frerun-cse-after-loop}.  This option makes code larger,
6869 and may or may not make it run faster.
6870
6871 @item -funroll-all-loops
6872 @opindex funroll-all-loops
6873 Unroll all loops, even if their number of iterations is uncertain when
6874 the loop is entered.  This usually makes programs run more slowly.
6875 @option{-funroll-all-loops} implies the same options as
6876 @option{-funroll-loops},
6877
6878 @item -fsplit-ivs-in-unroller
6879 @opindex fsplit-ivs-in-unroller
6880 Enables expressing of values of induction variables in later iterations
6881 of the unrolled loop using the value in the first iteration.  This breaks
6882 long dependency chains, thus improving efficiency of the scheduling passes.
6883
6884 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6885 same effect.  However in cases the loop body is more complicated than
6886 a single basic block, this is not reliable.  It also does not work at all
6887 on some of the architectures due to restrictions in the CSE pass.
6888
6889 This optimization is enabled by default.
6890
6891 @item -fvariable-expansion-in-unroller
6892 @opindex fvariable-expansion-in-unroller
6893 With this option, the compiler will create multiple copies of some
6894 local variables when unrolling a loop which can result in superior code.
6895
6896 @item -fpredictive-commoning
6897 @opindex fpredictive-commoning
6898 Perform predictive commoning optimization, i.e., reusing computations
6899 (especially memory loads and stores) performed in previous
6900 iterations of loops.
6901
6902 This option is enabled at level @option{-O3}.
6903
6904 @item -fprefetch-loop-arrays
6905 @opindex fprefetch-loop-arrays
6906 If supported by the target machine, generate instructions to prefetch
6907 memory to improve the performance of loops that access large arrays.
6908
6909 This option may generate better or worse code; results are highly
6910 dependent on the structure of loops within the source code.
6911
6912 Disabled at level @option{-Os}.
6913
6914 @item -fno-peephole
6915 @itemx -fno-peephole2
6916 @opindex fno-peephole
6917 @opindex fno-peephole2
6918 Disable any machine-specific peephole optimizations.  The difference
6919 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6920 are implemented in the compiler; some targets use one, some use the
6921 other, a few use both.
6922
6923 @option{-fpeephole} is enabled by default.
6924 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6925
6926 @item -fno-guess-branch-probability
6927 @opindex fno-guess-branch-probability
6928 Do not guess branch probabilities using heuristics.
6929
6930 GCC will use heuristics to guess branch probabilities if they are
6931 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6932 heuristics are based on the control flow graph.  If some branch probabilities
6933 are specified by @samp{__builtin_expect}, then the heuristics will be
6934 used to guess branch probabilities for the rest of the control flow graph,
6935 taking the @samp{__builtin_expect} info into account.  The interactions
6936 between the heuristics and @samp{__builtin_expect} can be complex, and in
6937 some cases, it may be useful to disable the heuristics so that the effects
6938 of @samp{__builtin_expect} are easier to understand.
6939
6940 The default is @option{-fguess-branch-probability} at levels
6941 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6942
6943 @item -freorder-blocks
6944 @opindex freorder-blocks
6945 Reorder basic blocks in the compiled function in order to reduce number of
6946 taken branches and improve code locality.
6947
6948 Enabled at levels @option{-O2}, @option{-O3}.
6949
6950 @item -freorder-blocks-and-partition
6951 @opindex freorder-blocks-and-partition
6952 In addition to reordering basic blocks in the compiled function, in order
6953 to reduce number of taken branches, partitions hot and cold basic blocks
6954 into separate sections of the assembly and .o files, to improve
6955 paging and cache locality performance.
6956
6957 This optimization is automatically turned off in the presence of
6958 exception handling, for linkonce sections, for functions with a user-defined
6959 section attribute and on any architecture that does not support named
6960 sections.
6961
6962 @item -freorder-functions
6963 @opindex freorder-functions
6964 Reorder functions in the object file in order to
6965 improve code locality.  This is implemented by using special
6966 subsections @code{.text.hot} for most frequently executed functions and
6967 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6968 the linker so object file format must support named sections and linker must
6969 place them in a reasonable way.
6970
6971 Also profile feedback must be available in to make this option effective.  See
6972 @option{-fprofile-arcs} for details.
6973
6974 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6975
6976 @item -fstrict-aliasing
6977 @opindex fstrict-aliasing
6978 Allow the compiler to assume the strictest aliasing rules applicable to
6979 the language being compiled.  For C (and C++), this activates
6980 optimizations based on the type of expressions.  In particular, an
6981 object of one type is assumed never to reside at the same address as an
6982 object of a different type, unless the types are almost the same.  For
6983 example, an @code{unsigned int} can alias an @code{int}, but not a
6984 @code{void*} or a @code{double}.  A character type may alias any other
6985 type.
6986
6987 @anchor{Type-punning}Pay special attention to code like this:
6988 @smallexample
6989 union a_union @{
6990   int i;
6991   double d;
6992 @};
6993
6994 int f() @{
6995   union a_union t;
6996   t.d = 3.0;
6997   return t.i;
6998 @}
6999 @end smallexample
7000 The practice of reading from a different union member than the one most
7001 recently written to (called ``type-punning'') is common.  Even with
7002 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7003 is accessed through the union type.  So, the code above will work as
7004 expected.  @xref{Structures unions enumerations and bit-fields
7005 implementation}.  However, this code might not:
7006 @smallexample
7007 int f() @{
7008   union a_union t;
7009   int* ip;
7010   t.d = 3.0;
7011   ip = &t.i;
7012   return *ip;
7013 @}
7014 @end smallexample
7015
7016 Similarly, access by taking the address, casting the resulting pointer
7017 and dereferencing the result has undefined behavior, even if the cast
7018 uses a union type, e.g.:
7019 @smallexample
7020 int f() @{
7021   double d = 3.0;
7022   return ((union a_union *) &d)->i;
7023 @}
7024 @end smallexample
7025
7026 The @option{-fstrict-aliasing} option is enabled at levels
7027 @option{-O2}, @option{-O3}, @option{-Os}.
7028
7029 @item -fstrict-overflow
7030 @opindex fstrict-overflow
7031 Allow the compiler to assume strict signed overflow rules, depending
7032 on the language being compiled.  For C (and C++) this means that
7033 overflow when doing arithmetic with signed numbers is undefined, which
7034 means that the compiler may assume that it will not happen.  This
7035 permits various optimizations.  For example, the compiler will assume
7036 that an expression like @code{i + 10 > i} will always be true for
7037 signed @code{i}.  This assumption is only valid if signed overflow is
7038 undefined, as the expression is false if @code{i + 10} overflows when
7039 using twos complement arithmetic.  When this option is in effect any
7040 attempt to determine whether an operation on signed numbers will
7041 overflow must be written carefully to not actually involve overflow.
7042
7043 This option also allows the compiler to assume strict pointer
7044 semantics: given a pointer to an object, if adding an offset to that
7045 pointer does not produce a pointer to the same object, the addition is
7046 undefined.  This permits the compiler to conclude that @code{p + u >
7047 p} is always true for a pointer @code{p} and unsigned integer
7048 @code{u}.  This assumption is only valid because pointer wraparound is
7049 undefined, as the expression is false if @code{p + u} overflows using
7050 twos complement arithmetic.
7051
7052 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7053 that integer signed overflow is fully defined: it wraps.  When
7054 @option{-fwrapv} is used, there is no difference between
7055 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7056 integers.  With @option{-fwrapv} certain types of overflow are
7057 permitted.  For example, if the compiler gets an overflow when doing
7058 arithmetic on constants, the overflowed value can still be used with
7059 @option{-fwrapv}, but not otherwise.
7060
7061 The @option{-fstrict-overflow} option is enabled at levels
7062 @option{-O2}, @option{-O3}, @option{-Os}.
7063
7064 @item -falign-functions
7065 @itemx -falign-functions=@var{n}
7066 @opindex falign-functions
7067 Align the start of functions to the next power-of-two greater than
7068 @var{n}, skipping up to @var{n} bytes.  For instance,
7069 @option{-falign-functions=32} aligns functions to the next 32-byte
7070 boundary, but @option{-falign-functions=24} would align to the next
7071 32-byte boundary only if this can be done by skipping 23 bytes or less.
7072
7073 @option{-fno-align-functions} and @option{-falign-functions=1} are
7074 equivalent and mean that functions will not be aligned.
7075
7076 Some assemblers only support this flag when @var{n} is a power of two;
7077 in that case, it is rounded up.
7078
7079 If @var{n} is not specified or is zero, use a machine-dependent default.
7080
7081 Enabled at levels @option{-O2}, @option{-O3}.
7082
7083 @item -falign-labels
7084 @itemx -falign-labels=@var{n}
7085 @opindex falign-labels
7086 Align all branch targets to a power-of-two boundary, skipping up to
7087 @var{n} bytes like @option{-falign-functions}.  This option can easily
7088 make code slower, because it must insert dummy operations for when the
7089 branch target is reached in the usual flow of the code.
7090
7091 @option{-fno-align-labels} and @option{-falign-labels=1} are
7092 equivalent and mean that labels will not be aligned.
7093
7094 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7095 are greater than this value, then their values are used instead.
7096
7097 If @var{n} is not specified or is zero, use a machine-dependent default
7098 which is very likely to be @samp{1}, meaning no alignment.
7099
7100 Enabled at levels @option{-O2}, @option{-O3}.
7101
7102 @item -falign-loops
7103 @itemx -falign-loops=@var{n}
7104 @opindex falign-loops
7105 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7106 like @option{-falign-functions}.  The hope is that the loop will be
7107 executed many times, which will make up for any execution of the dummy
7108 operations.
7109
7110 @option{-fno-align-loops} and @option{-falign-loops=1} are
7111 equivalent and mean that loops will not be aligned.
7112
7113 If @var{n} is not specified or is zero, use a machine-dependent default.
7114
7115 Enabled at levels @option{-O2}, @option{-O3}.
7116
7117 @item -falign-jumps
7118 @itemx -falign-jumps=@var{n}
7119 @opindex falign-jumps
7120 Align branch targets to a power-of-two boundary, for branch targets
7121 where the targets can only be reached by jumping, skipping up to @var{n}
7122 bytes like @option{-falign-functions}.  In this case, no dummy operations
7123 need be executed.
7124
7125 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7126 equivalent and mean that loops will not be aligned.
7127
7128 If @var{n} is not specified or is zero, use a machine-dependent default.
7129
7130 Enabled at levels @option{-O2}, @option{-O3}.
7131
7132 @item -funit-at-a-time
7133 @opindex funit-at-a-time
7134 This option is left for compatibility reasons. @option{-funit-at-a-time}
7135 has no effect, while @option{-fno-unit-at-a-time} implies
7136 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7137
7138 Enabled by default.
7139
7140 @item -fno-toplevel-reorder
7141 @opindex fno-toplevel-reorder
7142 Do not reorder top-level functions, variables, and @code{asm}
7143 statements.  Output them in the same order that they appear in the
7144 input file.  When this option is used, unreferenced static variables
7145 will not be removed.  This option is intended to support existing code
7146 which relies on a particular ordering.  For new code, it is better to
7147 use attributes.
7148
7149 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7150 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7151 targets.
7152
7153 @item -fweb
7154 @opindex fweb
7155 Constructs webs as commonly used for register allocation purposes and assign
7156 each web individual pseudo register.  This allows the register allocation pass
7157 to operate on pseudos directly, but also strengthens several other optimization
7158 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7159 however, make debugging impossible, since variables will no longer stay in a
7160 ``home register''.
7161
7162 Enabled by default with @option{-funroll-loops}.
7163
7164 @item -fwhole-program
7165 @opindex fwhole-program
7166 Assume that the current compilation unit represents the whole program being
7167 compiled.  All public functions and variables with the exception of @code{main}
7168 and those merged by attribute @code{externally_visible} become static functions
7169 and in effect are optimized more aggressively by interprocedural optimizers.
7170 While this option is equivalent to proper use of the @code{static} keyword for
7171 programs consisting of a single file, in combination with option
7172 @option{-combine}, @option{-flto} or @option{-fwhopr} this flag can be used to
7173 compile many smaller scale programs since the functions and variables become
7174 local for the whole combined compilation unit, not for the single source file
7175 itself.
7176
7177 This option implies @option{-fwhole-file} for Fortran programs.
7178
7179 @item -flto
7180 @opindex flto
7181 This option runs the standard link-time optimizer.  When invoked
7182 with source code, it generates GIMPLE (one of GCC's internal
7183 representations) and writes it to special ELF sections in the object
7184 file.  When the object files are linked together, all the function
7185 bodies are read from these ELF sections and instantiated as if they
7186 had been part of the same translation unit.
7187
7188 To use the link-timer optimizer, @option{-flto} needs to be specified at
7189 compile time and during the final link.  For example,
7190
7191 @smallexample
7192 gcc -c -O2 -flto foo.c
7193 gcc -c -O2 -flto bar.c
7194 gcc -o myprog -flto -O2 foo.o bar.o
7195 @end smallexample
7196
7197 The first two invocations to GCC will save a bytecode representation
7198 of GIMPLE into special ELF sections inside @file{foo.o} and
7199 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7200 @file{foo.o} and @file{bar.o}, merge the two files into a single
7201 internal image, and compile the result as usual.  Since both
7202 @file{foo.o} and @file{bar.o} are merged into a single image, this
7203 causes all the inter-procedural analyses and optimizations in GCC to
7204 work across the two files as if they were a single one.  This means,
7205 for example, that the inliner will be able to inline functions in
7206 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7207
7208 Another (simpler) way to enable link-time optimization is,
7209
7210 @smallexample
7211 gcc -o myprog -flto -O2 foo.c bar.c
7212 @end smallexample
7213
7214 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7215 merge them together into a single GIMPLE representation and optimize
7216 them as usual to produce @file{myprog}.
7217
7218 The only important thing to keep in mind is that to enable link-time
7219 optimizations the @option{-flto} flag needs to be passed to both the
7220 compile and the link commands.
7221
7222 Note that when a file is compiled with @option{-flto}, the generated
7223 object file will be larger than a regular object file because it will
7224 contain GIMPLE bytecodes and the usual final code.  This means that
7225 object files with LTO information can be linked as a normal object
7226 file.  So, in the previous example, if the final link is done with
7227
7228 @smallexample
7229 gcc -o myprog foo.o bar.o
7230 @end smallexample
7231
7232 The only difference will be that no inter-procedural optimizations
7233 will be applied to produce @file{myprog}.  The two object files
7234 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7235 linker.
7236
7237 Additionally, the optimization flags used to compile individual files
7238 are not necessarily related to those used at link-time.  For instance,
7239
7240 @smallexample
7241 gcc -c -O0 -flto foo.c
7242 gcc -c -O0 -flto bar.c
7243 gcc -o myprog -flto -O3 foo.o bar.o
7244 @end smallexample
7245
7246 This will produce individual object files with unoptimized assembler
7247 code, but the resulting binary @file{myprog} will be optimized at
7248 @option{-O3}.  Now, if the final binary is generated without
7249 @option{-flto}, then @file{myprog} will not be optimized.
7250
7251 When producing the final binary with @option{-flto}, GCC will only
7252 apply link-time optimizations to those files that contain bytecode.
7253 Therefore, you can mix and match object files and libraries with
7254 GIMPLE bytecodes and final object code.  GCC will automatically select
7255 which files to optimize in LTO mode and which files to link without
7256 further processing.
7257
7258 There are some code generation flags that GCC will preserve when
7259 generating bytecodes, as they need to be used during the final link
7260 stage.  Currently, the following options are saved into the GIMPLE
7261 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7262 @option{-m} target flags.
7263
7264 At link time, these options are read-in and reapplied.  Note that the
7265 current implementation makes no attempt at recognizing conflicting
7266 values for these options.  If two or more files have a conflicting
7267 value (e.g., one file is compiled with @option{-fPIC} and another
7268 isn't), the compiler will simply use the last value read from the
7269 bytecode files.  It is recommended, then, that all the files
7270 participating in the same link be compiled with the same options.
7271
7272 Another feature of LTO is that it is possible to apply interprocedural
7273 optimizations on files written in different languages.  This requires
7274 some support in the language front end.  Currently, the C, C++ and
7275 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7276 something like this should work
7277
7278 @smallexample
7279 gcc -c -flto foo.c
7280 g++ -c -flto bar.cc
7281 gfortran -c -flto baz.f90
7282 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7283 @end smallexample
7284
7285 Notice that the final link is done with @command{g++} to get the C++
7286 runtime libraries and @option{-lgfortran} is added to get the Fortran
7287 runtime libraries.  In general, when mixing languages in LTO mode, you
7288 should use the same link command used when mixing languages in a
7289 regular (non-LTO) compilation.  This means that if your build process
7290 was mixing languages before, all you need to add is @option{-flto} to
7291 all the compile and link commands.
7292
7293 If object files containing GIMPLE bytecode are stored in a library
7294 archive, say @file{libfoo.a}, it is possible to extract and use them
7295 in an LTO link if you are using @command{gold} as the linker (which,
7296 in turn requires GCC to be configured with @option{--enable-gold}).
7297 To enable this feature, use the flag @option{-fuse-linker-plugin} at
7298 link-time:
7299
7300 @smallexample
7301 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7302 @end smallexample
7303
7304 With the linker plugin enabled, @command{gold} will extract the needed
7305 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7306 to make them part of the aggregated GIMPLE image to be optimized.
7307
7308 If you are not using @command{gold} and/or do not specify
7309 @option{-fuse-linker-plugin} then the objects inside @file{libfoo.a}
7310 will be extracted and linked as usual, but they will not participate
7311 in the LTO optimization process.
7312
7313 Link time optimizations do not require the presence of the whole
7314 program to operate.  If the program does not require any symbols to
7315 be exported, it is possible to combine @option{-flto} and
7316 @option{-fwhopr} with @option{-fwhole-program} to allow the
7317 interprocedural optimizers to use more aggressive assumptions which
7318 may lead to improved optimization opportunities.
7319
7320 Regarding portability: the current implementation of LTO makes no
7321 attempt at generating bytecode that can be ported between different
7322 types of hosts.  The bytecode files are versioned and there is a
7323 strict version check, so bytecode files generated in one version of
7324 GCC will not work with an older/newer version of GCC.
7325
7326 Link time optimization does not play well with generating debugging
7327 information.  Combining @option{-flto} or @option{-fwhopr} with
7328 @option{-g} is experimental.
7329
7330 This option is disabled by default.
7331
7332 @item -fwhopr
7333 @opindex fwhopr
7334 This option is identical in functionality to @option{-flto} but it
7335 differs in how the final link stage is executed.  Instead of loading
7336 all the function bodies in memory, the callgraph is analyzed and
7337 optimization decisions are made (whole program analysis or WPA). Once
7338 optimization decisions are made, the callgraph is partitioned and the
7339 different sections are compiled separately (local transformations or
7340 LTRANS)@.  This process allows optimizations on very large programs
7341 that otherwise would not fit in memory.  This option enables
7342 @option{-fwpa} and @option{-fltrans} automatically.
7343
7344 Disabled by default.
7345
7346 This option is experimental.
7347
7348 @item -fwpa
7349 @opindex fwpa
7350 This is an internal option used by GCC when compiling with
7351 @option{-fwhopr}.  You should never need to use it.
7352
7353 This option runs the link-time optimizer in the whole-program-analysis
7354 (WPA) mode, which reads in summary information from all inputs and
7355 performs a whole-program analysis based on summary information only.
7356 It generates object files for subsequent runs of the link-time
7357 optimizer where individual object files are optimized using both
7358 summary information from the WPA mode and the actual function bodies.
7359 It then drives the LTRANS phase.
7360
7361 Disabled by default.
7362
7363 @item -fltrans
7364 @opindex fltrans
7365 This is an internal option used by GCC when compiling with
7366 @option{-fwhopr}.  You should never need to use it.
7367
7368 This option runs the link-time optimizer in the local-transformation (LTRANS)
7369 mode, which reads in output from a previous run of the LTO in WPA mode.
7370 In the LTRANS mode, LTO optimizes an object and produces the final assembly.
7371
7372 Disabled by default.
7373
7374 @item -fltrans-output-list=@var{file}
7375 @opindex fltrans-output-list
7376 This is an internal option used by GCC when compiling with
7377 @option{-fwhopr}.  You should never need to use it.
7378
7379 This option specifies a file to which the names of LTRANS output files are
7380 written.  This option is only meaningful in conjunction with @option{-fwpa}.
7381
7382 Disabled by default.
7383
7384 @item -flto-compression-level=@var{n}
7385 This option specifies the level of compression used for intermediate
7386 language written to LTO object files, and is only meaningful in
7387 conjunction with LTO mode (@option{-fwhopr}, @option{-flto}).  Valid
7388 values are 0 (no compression) to 9 (maximum compression).  Values
7389 outside this range are clamped to either 0 or 9.  If the option is not
7390 given, a default balanced compression setting is used.
7391
7392 @item -flto-report
7393 Prints a report with internal details on the workings of the link-time
7394 optimizer.  The contents of this report vary from version to version,
7395 it is meant to be useful to GCC developers when processing object
7396 files in LTO mode (via @option{-fwhopr} or @option{-flto}).
7397
7398 Disabled by default.
7399
7400 @item -fuse-linker-plugin
7401 Enables the extraction of objects with GIMPLE bytecode information
7402 from library archives.  This option relies on features available only
7403 in @command{gold}, so to use this you must configure GCC with
7404 @option{--enable-gold}.  See @option{-flto} for a description on the
7405 effect of this flag and how to use it.
7406
7407 Disabled by default.
7408
7409 @item -fcprop-registers
7410 @opindex fcprop-registers
7411 After register allocation and post-register allocation instruction splitting,
7412 we perform a copy-propagation pass to try to reduce scheduling dependencies
7413 and occasionally eliminate the copy.
7414
7415 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7416
7417 @item -fprofile-correction
7418 @opindex fprofile-correction
7419 Profiles collected using an instrumented binary for multi-threaded programs may
7420 be inconsistent due to missed counter updates. When this option is specified,
7421 GCC will use heuristics to correct or smooth out such inconsistencies. By
7422 default, GCC will emit an error message when an inconsistent profile is detected.
7423
7424 @item -fprofile-dir=@var{path}
7425 @opindex fprofile-dir
7426
7427 Set the directory to search the profile data files in to @var{path}.
7428 This option affects only the profile data generated by
7429 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7430 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7431 and its related options.
7432 By default, GCC will use the current directory as @var{path}
7433 thus the profile data file will appear in the same directory as the object file.
7434
7435 @item -fprofile-generate
7436 @itemx -fprofile-generate=@var{path}
7437 @opindex fprofile-generate
7438
7439 Enable options usually used for instrumenting application to produce
7440 profile useful for later recompilation with profile feedback based
7441 optimization.  You must use @option{-fprofile-generate} both when
7442 compiling and when linking your program.
7443
7444 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7445
7446 If @var{path} is specified, GCC will look at the @var{path} to find
7447 the profile feedback data files. See @option{-fprofile-dir}.
7448
7449 @item -fprofile-use
7450 @itemx -fprofile-use=@var{path}
7451 @opindex fprofile-use
7452 Enable profile feedback directed optimizations, and optimizations
7453 generally profitable only with profile feedback available.
7454
7455 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7456 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7457
7458 By default, GCC emits an error message if the feedback profiles do not
7459 match the source code.  This error can be turned into a warning by using
7460 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7461 code.
7462
7463 If @var{path} is specified, GCC will look at the @var{path} to find
7464 the profile feedback data files. See @option{-fprofile-dir}.
7465 @end table
7466
7467 The following options control compiler behavior regarding floating
7468 point arithmetic.  These options trade off between speed and
7469 correctness.  All must be specifically enabled.
7470
7471 @table @gcctabopt
7472 @item -ffloat-store
7473 @opindex ffloat-store
7474 Do not store floating point variables in registers, and inhibit other
7475 options that might change whether a floating point value is taken from a
7476 register or memory.
7477
7478 @cindex floating point precision
7479 This option prevents undesirable excess precision on machines such as
7480 the 68000 where the floating registers (of the 68881) keep more
7481 precision than a @code{double} is supposed to have.  Similarly for the
7482 x86 architecture.  For most programs, the excess precision does only
7483 good, but a few programs rely on the precise definition of IEEE floating
7484 point.  Use @option{-ffloat-store} for such programs, after modifying
7485 them to store all pertinent intermediate computations into variables.
7486
7487 @item -fexcess-precision=@var{style}
7488 @opindex fexcess-precision
7489 This option allows further control over excess precision on machines
7490 where floating-point registers have more precision than the IEEE
7491 @code{float} and @code{double} types and the processor does not
7492 support operations rounding to those types.  By default,
7493 @option{-fexcess-precision=fast} is in effect; this means that
7494 operations are carried out in the precision of the registers and that
7495 it is unpredictable when rounding to the types specified in the source
7496 code takes place.  When compiling C, if
7497 @option{-fexcess-precision=standard} is specified then excess
7498 precision will follow the rules specified in ISO C99; in particular,
7499 both casts and assignments cause values to be rounded to their
7500 semantic types (whereas @option{-ffloat-store} only affects
7501 assignments).  This option is enabled by default for C if a strict
7502 conformance option such as @option{-std=c99} is used.
7503
7504 @opindex mfpmath
7505 @option{-fexcess-precision=standard} is not implemented for languages
7506 other than C, and has no effect if
7507 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7508 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7509 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7510 semantics apply without excess precision, and in the latter, rounding
7511 is unpredictable.
7512
7513 @item -ffast-math
7514 @opindex ffast-math
7515 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7516 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7517 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7518
7519 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7520
7521 This option is not turned on by any @option{-O} option since
7522 it can result in incorrect output for programs which depend on
7523 an exact implementation of IEEE or ISO rules/specifications for
7524 math functions. It may, however, yield faster code for programs
7525 that do not require the guarantees of these specifications.
7526
7527 @item -fno-math-errno
7528 @opindex fno-math-errno
7529 Do not set ERRNO after calling math functions that are executed
7530 with a single instruction, e.g., sqrt.  A program that relies on
7531 IEEE exceptions for math error handling may want to use this flag
7532 for speed while maintaining IEEE arithmetic compatibility.
7533
7534 This option is not turned on by any @option{-O} option since
7535 it can result in incorrect output for programs which depend on
7536 an exact implementation of IEEE or ISO rules/specifications for
7537 math functions. It may, however, yield faster code for programs
7538 that do not require the guarantees of these specifications.
7539
7540 The default is @option{-fmath-errno}.
7541
7542 On Darwin systems, the math library never sets @code{errno}.  There is
7543 therefore no reason for the compiler to consider the possibility that
7544 it might, and @option{-fno-math-errno} is the default.
7545
7546 @item -funsafe-math-optimizations
7547 @opindex funsafe-math-optimizations
7548
7549 Allow optimizations for floating-point arithmetic that (a) assume
7550 that arguments and results are valid and (b) may violate IEEE or
7551 ANSI standards.  When used at link-time, it may include libraries
7552 or startup files that change the default FPU control word or other
7553 similar optimizations.
7554
7555 This option is not turned on by any @option{-O} option since
7556 it can result in incorrect output for programs which depend on
7557 an exact implementation of IEEE or ISO rules/specifications for
7558 math functions. It may, however, yield faster code for programs
7559 that do not require the guarantees of these specifications.
7560 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7561 @option{-fassociative-math} and @option{-freciprocal-math}.
7562
7563 The default is @option{-fno-unsafe-math-optimizations}.
7564
7565 @item -fassociative-math
7566 @opindex fassociative-math
7567
7568 Allow re-association of operands in series of floating-point operations.
7569 This violates the ISO C and C++ language standard by possibly changing
7570 computation result.  NOTE: re-ordering may change the sign of zero as
7571 well as ignore NaNs and inhibit or create underflow or overflow (and
7572 thus cannot be used on a code which relies on rounding behavior like
7573 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7574 and thus may not be used when ordered comparisons are required.
7575 This option requires that both @option{-fno-signed-zeros} and
7576 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7577 much sense with @option{-frounding-math}. For Fortran the option
7578 is automatically enabled when both @option{-fno-signed-zeros} and
7579 @option{-fno-trapping-math} are in effect.
7580
7581 The default is @option{-fno-associative-math}.
7582
7583 @item -freciprocal-math
7584 @opindex freciprocal-math
7585
7586 Allow the reciprocal of a value to be used instead of dividing by
7587 the value if this enables optimizations.  For example @code{x / y}
7588 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7589 is subject to common subexpression elimination.  Note that this loses
7590 precision and increases the number of flops operating on the value.
7591
7592 The default is @option{-fno-reciprocal-math}.
7593
7594 @item -ffinite-math-only
7595 @opindex ffinite-math-only
7596 Allow optimizations for floating-point arithmetic that assume
7597 that arguments and results are not NaNs or +-Infs.
7598
7599 This option is not turned on by any @option{-O} option since
7600 it can result in incorrect output for programs which depend on
7601 an exact implementation of IEEE or ISO rules/specifications for
7602 math functions. It may, however, yield faster code for programs
7603 that do not require the guarantees of these specifications.
7604
7605 The default is @option{-fno-finite-math-only}.
7606
7607 @item -fno-signed-zeros
7608 @opindex fno-signed-zeros
7609 Allow optimizations for floating point arithmetic that ignore the
7610 signedness of zero.  IEEE arithmetic specifies the behavior of
7611 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7612 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7613 This option implies that the sign of a zero result isn't significant.
7614
7615 The default is @option{-fsigned-zeros}.
7616
7617 @item -fno-trapping-math
7618 @opindex fno-trapping-math
7619 Compile code assuming that floating-point operations cannot generate
7620 user-visible traps.  These traps include division by zero, overflow,
7621 underflow, inexact result and invalid operation.  This option requires
7622 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7623 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7624
7625 This option should never be turned on by any @option{-O} option since
7626 it can result in incorrect output for programs which depend on
7627 an exact implementation of IEEE or ISO rules/specifications for
7628 math functions.
7629
7630 The default is @option{-ftrapping-math}.
7631
7632 @item -frounding-math
7633 @opindex frounding-math
7634 Disable transformations and optimizations that assume default floating
7635 point rounding behavior.  This is round-to-zero for all floating point
7636 to integer conversions, and round-to-nearest for all other arithmetic
7637 truncations.  This option should be specified for programs that change
7638 the FP rounding mode dynamically, or that may be executed with a
7639 non-default rounding mode.  This option disables constant folding of
7640 floating point expressions at compile-time (which may be affected by
7641 rounding mode) and arithmetic transformations that are unsafe in the
7642 presence of sign-dependent rounding modes.
7643
7644 The default is @option{-fno-rounding-math}.
7645
7646 This option is experimental and does not currently guarantee to
7647 disable all GCC optimizations that are affected by rounding mode.
7648 Future versions of GCC may provide finer control of this setting
7649 using C99's @code{FENV_ACCESS} pragma.  This command line option
7650 will be used to specify the default state for @code{FENV_ACCESS}.
7651
7652 @item -fsignaling-nans
7653 @opindex fsignaling-nans
7654 Compile code assuming that IEEE signaling NaNs may generate user-visible
7655 traps during floating-point operations.  Setting this option disables
7656 optimizations that may change the number of exceptions visible with
7657 signaling NaNs.  This option implies @option{-ftrapping-math}.
7658
7659 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7660 be defined.
7661
7662 The default is @option{-fno-signaling-nans}.
7663
7664 This option is experimental and does not currently guarantee to
7665 disable all GCC optimizations that affect signaling NaN behavior.
7666
7667 @item -fsingle-precision-constant
7668 @opindex fsingle-precision-constant
7669 Treat floating point constant as single precision constant instead of
7670 implicitly converting it to double precision constant.
7671
7672 @item -fcx-limited-range
7673 @opindex fcx-limited-range
7674 When enabled, this option states that a range reduction step is not
7675 needed when performing complex division.  Also, there is no checking
7676 whether the result of a complex multiplication or division is @code{NaN
7677 + I*NaN}, with an attempt to rescue the situation in that case.  The
7678 default is @option{-fno-cx-limited-range}, but is enabled by
7679 @option{-ffast-math}.
7680
7681 This option controls the default setting of the ISO C99
7682 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7683 all languages.
7684
7685 @item -fcx-fortran-rules
7686 @opindex fcx-fortran-rules
7687 Complex multiplication and division follow Fortran rules.  Range
7688 reduction is done as part of complex division, but there is no checking
7689 whether the result of a complex multiplication or division is @code{NaN
7690 + I*NaN}, with an attempt to rescue the situation in that case.
7691
7692 The default is @option{-fno-cx-fortran-rules}.
7693
7694 @end table
7695
7696 The following options control optimizations that may improve
7697 performance, but are not enabled by any @option{-O} options.  This
7698 section includes experimental options that may produce broken code.
7699
7700 @table @gcctabopt
7701 @item -fbranch-probabilities
7702 @opindex fbranch-probabilities
7703 After running a program compiled with @option{-fprofile-arcs}
7704 (@pxref{Debugging Options,, Options for Debugging Your Program or
7705 @command{gcc}}), you can compile it a second time using
7706 @option{-fbranch-probabilities}, to improve optimizations based on
7707 the number of times each branch was taken.  When the program
7708 compiled with @option{-fprofile-arcs} exits it saves arc execution
7709 counts to a file called @file{@var{sourcename}.gcda} for each source
7710 file.  The information in this data file is very dependent on the
7711 structure of the generated code, so you must use the same source code
7712 and the same optimization options for both compilations.
7713
7714 With @option{-fbranch-probabilities}, GCC puts a
7715 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7716 These can be used to improve optimization.  Currently, they are only
7717 used in one place: in @file{reorg.c}, instead of guessing which path a
7718 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7719 exactly determine which path is taken more often.
7720
7721 @item -fprofile-values
7722 @opindex fprofile-values
7723 If combined with @option{-fprofile-arcs}, it adds code so that some
7724 data about values of expressions in the program is gathered.
7725
7726 With @option{-fbranch-probabilities}, it reads back the data gathered
7727 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7728 notes to instructions for their later usage in optimizations.
7729
7730 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7731
7732 @item -fvpt
7733 @opindex fvpt
7734 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7735 a code to gather information about values of expressions.
7736
7737 With @option{-fbranch-probabilities}, it reads back the data gathered
7738 and actually performs the optimizations based on them.
7739 Currently the optimizations include specialization of division operation
7740 using the knowledge about the value of the denominator.
7741
7742 @item -frename-registers
7743 @opindex frename-registers
7744 Attempt to avoid false dependencies in scheduled code by making use
7745 of registers left over after register allocation.  This optimization
7746 will most benefit processors with lots of registers.  Depending on the
7747 debug information format adopted by the target, however, it can
7748 make debugging impossible, since variables will no longer stay in
7749 a ``home register''.
7750
7751 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
7752
7753 @item -ftracer
7754 @opindex ftracer
7755 Perform tail duplication to enlarge superblock size.  This transformation
7756 simplifies the control flow of the function allowing other optimizations to do
7757 better job.
7758
7759 Enabled with @option{-fprofile-use}.
7760
7761 @item -funroll-loops
7762 @opindex funroll-loops
7763 Unroll loops whose number of iterations can be determined at compile time or
7764 upon entry to the loop.  @option{-funroll-loops} implies
7765 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
7766 It also turns on complete loop peeling (i.e.@: complete removal of loops with
7767 small constant number of iterations).  This option makes code larger, and may
7768 or may not make it run faster.
7769
7770 Enabled with @option{-fprofile-use}.
7771
7772 @item -funroll-all-loops
7773 @opindex funroll-all-loops
7774 Unroll all loops, even if their number of iterations is uncertain when
7775 the loop is entered.  This usually makes programs run more slowly.
7776 @option{-funroll-all-loops} implies the same options as
7777 @option{-funroll-loops}.
7778
7779 @item -fpeel-loops
7780 @opindex fpeel-loops
7781 Peels the loops for that there is enough information that they do not
7782 roll much (from profile feedback).  It also turns on complete loop peeling
7783 (i.e.@: complete removal of loops with small constant number of iterations).
7784
7785 Enabled with @option{-fprofile-use}.
7786
7787 @item -fmove-loop-invariants
7788 @opindex fmove-loop-invariants
7789 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
7790 at level @option{-O1}
7791
7792 @item -funswitch-loops
7793 @opindex funswitch-loops
7794 Move branches with loop invariant conditions out of the loop, with duplicates
7795 of the loop on both branches (modified according to result of the condition).
7796
7797 @item -ffunction-sections
7798 @itemx -fdata-sections
7799 @opindex ffunction-sections
7800 @opindex fdata-sections
7801 Place each function or data item into its own section in the output
7802 file if the target supports arbitrary sections.  The name of the
7803 function or the name of the data item determines the section's name
7804 in the output file.
7805
7806 Use these options on systems where the linker can perform optimizations
7807 to improve locality of reference in the instruction space.  Most systems
7808 using the ELF object format and SPARC processors running Solaris 2 have
7809 linkers with such optimizations.  AIX may have these optimizations in
7810 the future.
7811
7812 Only use these options when there are significant benefits from doing
7813 so.  When you specify these options, the assembler and linker will
7814 create larger object and executable files and will also be slower.
7815 You will not be able to use @code{gprof} on all systems if you
7816 specify this option and you may have problems with debugging if
7817 you specify both this option and @option{-g}.
7818
7819 @item -fbranch-target-load-optimize
7820 @opindex fbranch-target-load-optimize
7821 Perform branch target register load optimization before prologue / epilogue
7822 threading.
7823 The use of target registers can typically be exposed only during reload,
7824 thus hoisting loads out of loops and doing inter-block scheduling needs
7825 a separate optimization pass.
7826
7827 @item -fbranch-target-load-optimize2
7828 @opindex fbranch-target-load-optimize2
7829 Perform branch target register load optimization after prologue / epilogue
7830 threading.
7831
7832 @item -fbtr-bb-exclusive
7833 @opindex fbtr-bb-exclusive
7834 When performing branch target register load optimization, don't reuse
7835 branch target registers in within any basic block.
7836
7837 @item -fstack-protector
7838 @opindex fstack-protector
7839 Emit extra code to check for buffer overflows, such as stack smashing
7840 attacks.  This is done by adding a guard variable to functions with
7841 vulnerable objects.  This includes functions that call alloca, and
7842 functions with buffers larger than 8 bytes.  The guards are initialized
7843 when a function is entered and then checked when the function exits.
7844 If a guard check fails, an error message is printed and the program exits.
7845
7846 @item -fstack-protector-all
7847 @opindex fstack-protector-all
7848 Like @option{-fstack-protector} except that all functions are protected.
7849
7850 @item -fsection-anchors
7851 @opindex fsection-anchors
7852 Try to reduce the number of symbolic address calculations by using
7853 shared ``anchor'' symbols to address nearby objects.  This transformation
7854 can help to reduce the number of GOT entries and GOT accesses on some
7855 targets.
7856
7857 For example, the implementation of the following function @code{foo}:
7858
7859 @smallexample
7860 static int a, b, c;
7861 int foo (void) @{ return a + b + c; @}
7862 @end smallexample
7863
7864 would usually calculate the addresses of all three variables, but if you
7865 compile it with @option{-fsection-anchors}, it will access the variables
7866 from a common anchor point instead.  The effect is similar to the
7867 following pseudocode (which isn't valid C):
7868
7869 @smallexample
7870 int foo (void)
7871 @{
7872   register int *xr = &x;
7873   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7874 @}
7875 @end smallexample
7876
7877 Not all targets support this option.
7878
7879 @item --param @var{name}=@var{value}
7880 @opindex param
7881 In some places, GCC uses various constants to control the amount of
7882 optimization that is done.  For example, GCC will not inline functions
7883 that contain more that a certain number of instructions.  You can
7884 control some of these constants on the command-line using the
7885 @option{--param} option.
7886
7887 The names of specific parameters, and the meaning of the values, are
7888 tied to the internals of the compiler, and are subject to change
7889 without notice in future releases.
7890
7891 In each case, the @var{value} is an integer.  The allowable choices for
7892 @var{name} are given in the following table:
7893
7894 @table @gcctabopt
7895 @item struct-reorg-cold-struct-ratio
7896 The threshold ratio (as a percentage) between a structure frequency
7897 and the frequency of the hottest structure in the program.  This parameter
7898 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
7899 We say that if the ratio of a structure frequency, calculated by profiling,
7900 to the hottest structure frequency in the program is less than this
7901 parameter, then structure reorganization is not applied to this structure.
7902 The default is 10.
7903
7904 @item predictable-branch-outcome
7905 When branch is predicted to be taken with probability lower than this threshold
7906 (in percent), then it is considered well predictable. The default is 10.
7907
7908 @item max-crossjump-edges
7909 The maximum number of incoming edges to consider for crossjumping.
7910 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
7911 the number of edges incoming to each block.  Increasing values mean
7912 more aggressive optimization, making the compile time increase with
7913 probably small improvement in executable size.
7914
7915 @item min-crossjump-insns
7916 The minimum number of instructions which must be matched at the end
7917 of two blocks before crossjumping will be performed on them.  This
7918 value is ignored in the case where all instructions in the block being
7919 crossjumped from are matched.  The default value is 5.
7920
7921 @item max-grow-copy-bb-insns
7922 The maximum code size expansion factor when copying basic blocks
7923 instead of jumping.  The expansion is relative to a jump instruction.
7924 The default value is 8.
7925
7926 @item max-goto-duplication-insns
7927 The maximum number of instructions to duplicate to a block that jumps
7928 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
7929 passes, GCC factors computed gotos early in the compilation process,
7930 and unfactors them as late as possible.  Only computed jumps at the
7931 end of a basic blocks with no more than max-goto-duplication-insns are
7932 unfactored.  The default value is 8.
7933
7934 @item max-delay-slot-insn-search
7935 The maximum number of instructions to consider when looking for an
7936 instruction to fill a delay slot.  If more than this arbitrary number of
7937 instructions is searched, the time savings from filling the delay slot
7938 will be minimal so stop searching.  Increasing values mean more
7939 aggressive optimization, making the compile time increase with probably
7940 small improvement in executable run time.
7941
7942 @item max-delay-slot-live-search
7943 When trying to fill delay slots, the maximum number of instructions to
7944 consider when searching for a block with valid live register
7945 information.  Increasing this arbitrarily chosen value means more
7946 aggressive optimization, increasing the compile time.  This parameter
7947 should be removed when the delay slot code is rewritten to maintain the
7948 control-flow graph.
7949
7950 @item max-gcse-memory
7951 The approximate maximum amount of memory that will be allocated in
7952 order to perform the global common subexpression elimination
7953 optimization.  If more memory than specified is required, the
7954 optimization will not be done.
7955
7956 @item max-pending-list-length
7957 The maximum number of pending dependencies scheduling will allow
7958 before flushing the current state and starting over.  Large functions
7959 with few branches or calls can create excessively large lists which
7960 needlessly consume memory and resources.
7961
7962 @item max-inline-insns-single
7963 Several parameters control the tree inliner used in gcc.
7964 This number sets the maximum number of instructions (counted in GCC's
7965 internal representation) in a single function that the tree inliner
7966 will consider for inlining.  This only affects functions declared
7967 inline and methods implemented in a class declaration (C++).
7968 The default value is 300.
7969
7970 @item max-inline-insns-auto
7971 When you use @option{-finline-functions} (included in @option{-O3}),
7972 a lot of functions that would otherwise not be considered for inlining
7973 by the compiler will be investigated.  To those functions, a different
7974 (more restrictive) limit compared to functions declared inline can
7975 be applied.
7976 The default value is 50.
7977
7978 @item large-function-insns
7979 The limit specifying really large functions.  For functions larger than this
7980 limit after inlining, inlining is constrained by
7981 @option{--param large-function-growth}.  This parameter is useful primarily
7982 to avoid extreme compilation time caused by non-linear algorithms used by the
7983 backend.
7984 The default value is 2700.
7985
7986 @item large-function-growth
7987 Specifies maximal growth of large function caused by inlining in percents.
7988 The default value is 100 which limits large function growth to 2.0 times
7989 the original size.
7990
7991 @item large-unit-insns
7992 The limit specifying large translation unit.  Growth caused by inlining of
7993 units larger than this limit is limited by @option{--param inline-unit-growth}.
7994 For small units this might be too tight (consider unit consisting of function A
7995 that is inline and B that just calls A three time.  If B is small relative to
7996 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
7997 large units consisting of small inlineable functions however the overall unit
7998 growth limit is needed to avoid exponential explosion of code size.  Thus for
7999 smaller units, the size is increased to @option{--param large-unit-insns}
8000 before applying @option{--param inline-unit-growth}.  The default is 10000
8001
8002 @item inline-unit-growth
8003 Specifies maximal overall growth of the compilation unit caused by inlining.
8004 The default value is 30 which limits unit growth to 1.3 times the original
8005 size.
8006
8007 @item ipcp-unit-growth
8008 Specifies maximal overall growth of the compilation unit caused by
8009 interprocedural constant propagation.  The default value is 10 which limits
8010 unit growth to 1.1 times the original size.
8011
8012 @item large-stack-frame
8013 The limit specifying large stack frames.  While inlining the algorithm is trying
8014 to not grow past this limit too much.  Default value is 256 bytes.
8015
8016 @item large-stack-frame-growth
8017 Specifies maximal growth of large stack frames caused by inlining in percents.
8018 The default value is 1000 which limits large stack frame growth to 11 times
8019 the original size.
8020
8021 @item max-inline-insns-recursive
8022 @itemx max-inline-insns-recursive-auto
8023 Specifies maximum number of instructions out-of-line copy of self recursive inline
8024 function can grow into by performing recursive inlining.
8025
8026 For functions declared inline @option{--param max-inline-insns-recursive} is
8027 taken into account.  For function not declared inline, recursive inlining
8028 happens only when @option{-finline-functions} (included in @option{-O3}) is
8029 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8030 default value is 450.
8031
8032 @item max-inline-recursive-depth
8033 @itemx max-inline-recursive-depth-auto
8034 Specifies maximum recursion depth used by the recursive inlining.
8035
8036 For functions declared inline @option{--param max-inline-recursive-depth} is
8037 taken into account.  For function not declared inline, recursive inlining
8038 happens only when @option{-finline-functions} (included in @option{-O3}) is
8039 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8040 default value is 8.
8041
8042 @item min-inline-recursive-probability
8043 Recursive inlining is profitable only for function having deep recursion
8044 in average and can hurt for function having little recursion depth by
8045 increasing the prologue size or complexity of function body to other
8046 optimizers.
8047
8048 When profile feedback is available (see @option{-fprofile-generate}) the actual
8049 recursion depth can be guessed from probability that function will recurse via
8050 given call expression.  This parameter limits inlining only to call expression
8051 whose probability exceeds given threshold (in percents).  The default value is
8052 10.
8053
8054 @item early-inlining-insns
8055 Specify growth that early inliner can make.  In effect it increases amount of
8056 inlining for code having large abstraction penalty.  The default value is 8.
8057
8058 @item max-early-inliner-iterations
8059 @itemx max-early-inliner-iterations
8060 Limit of iterations of early inliner.  This basically bounds number of nested
8061 indirect calls early inliner can resolve.  Deeper chains are still handled by
8062 late inlining.
8063
8064 @item min-vect-loop-bound
8065 The minimum number of iterations under which a loop will not get vectorized
8066 when @option{-ftree-vectorize} is used.  The number of iterations after
8067 vectorization needs to be greater than the value specified by this option
8068 to allow vectorization.  The default value is 0.
8069
8070 @item max-unrolled-insns
8071 The maximum number of instructions that a loop should have if that loop
8072 is unrolled, and if the loop is unrolled, it determines how many times
8073 the loop code is unrolled.
8074
8075 @item max-average-unrolled-insns
8076 The maximum number of instructions biased by probabilities of their execution
8077 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8078 it determines how many times the loop code is unrolled.
8079
8080 @item max-unroll-times
8081 The maximum number of unrollings of a single loop.
8082
8083 @item max-peeled-insns
8084 The maximum number of instructions that a loop should have if that loop
8085 is peeled, and if the loop is peeled, it determines how many times
8086 the loop code is peeled.
8087
8088 @item max-peel-times
8089 The maximum number of peelings of a single loop.
8090
8091 @item max-completely-peeled-insns
8092 The maximum number of insns of a completely peeled loop.
8093
8094 @item max-completely-peel-times
8095 The maximum number of iterations of a loop to be suitable for complete peeling.
8096
8097 @item max-completely-peel-loop-nest-depth
8098 The maximum depth of a loop nest suitable for complete peeling.
8099
8100 @item max-unswitch-insns
8101 The maximum number of insns of an unswitched loop.
8102
8103 @item max-unswitch-level
8104 The maximum number of branches unswitched in a single loop.
8105
8106 @item lim-expensive
8107 The minimum cost of an expensive expression in the loop invariant motion.
8108
8109 @item iv-consider-all-candidates-bound
8110 Bound on number of candidates for induction variables below that
8111 all candidates are considered for each use in induction variable
8112 optimizations.  Only the most relevant candidates are considered
8113 if there are more candidates, to avoid quadratic time complexity.
8114
8115 @item iv-max-considered-uses
8116 The induction variable optimizations give up on loops that contain more
8117 induction variable uses.
8118
8119 @item iv-always-prune-cand-set-bound
8120 If number of candidates in the set is smaller than this value,
8121 we always try to remove unnecessary ivs from the set during its
8122 optimization when a new iv is added to the set.
8123
8124 @item scev-max-expr-size
8125 Bound on size of expressions used in the scalar evolutions analyzer.
8126 Large expressions slow the analyzer.
8127
8128 @item omega-max-vars
8129 The maximum number of variables in an Omega constraint system.
8130 The default value is 128.
8131
8132 @item omega-max-geqs
8133 The maximum number of inequalities in an Omega constraint system.
8134 The default value is 256.
8135
8136 @item omega-max-eqs
8137 The maximum number of equalities in an Omega constraint system.
8138 The default value is 128.
8139
8140 @item omega-max-wild-cards
8141 The maximum number of wildcard variables that the Omega solver will
8142 be able to insert.  The default value is 18.
8143
8144 @item omega-hash-table-size
8145 The size of the hash table in the Omega solver.  The default value is
8146 550.
8147
8148 @item omega-max-keys
8149 The maximal number of keys used by the Omega solver.  The default
8150 value is 500.
8151
8152 @item omega-eliminate-redundant-constraints
8153 When set to 1, use expensive methods to eliminate all redundant
8154 constraints.  The default value is 0.
8155
8156 @item vect-max-version-for-alignment-checks
8157 The maximum number of runtime checks that can be performed when
8158 doing loop versioning for alignment in the vectorizer.  See option
8159 ftree-vect-loop-version for more information.
8160
8161 @item vect-max-version-for-alias-checks
8162 The maximum number of runtime checks that can be performed when
8163 doing loop versioning for alias in the vectorizer.  See option
8164 ftree-vect-loop-version for more information.
8165
8166 @item max-iterations-to-track
8167
8168 The maximum number of iterations of a loop the brute force algorithm
8169 for analysis of # of iterations of the loop tries to evaluate.
8170
8171 @item hot-bb-count-fraction
8172 Select fraction of the maximal count of repetitions of basic block in program
8173 given basic block needs to have to be considered hot.
8174
8175 @item hot-bb-frequency-fraction
8176 Select fraction of the maximal frequency of executions of basic block in
8177 function given basic block needs to have to be considered hot
8178
8179 @item max-predicted-iterations
8180 The maximum number of loop iterations we predict statically.  This is useful
8181 in cases where function contain single loop with known bound and other loop
8182 with unknown.  We predict the known number of iterations correctly, while
8183 the unknown number of iterations average to roughly 10.  This means that the
8184 loop without bounds would appear artificially cold relative to the other one.
8185
8186 @item align-threshold
8187
8188 Select fraction of the maximal frequency of executions of basic block in
8189 function given basic block will get aligned.
8190
8191 @item align-loop-iterations
8192
8193 A loop expected to iterate at lest the selected number of iterations will get
8194 aligned.
8195
8196 @item tracer-dynamic-coverage
8197 @itemx tracer-dynamic-coverage-feedback
8198
8199 This value is used to limit superblock formation once the given percentage of
8200 executed instructions is covered.  This limits unnecessary code size
8201 expansion.
8202
8203 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8204 feedback is available.  The real profiles (as opposed to statically estimated
8205 ones) are much less balanced allowing the threshold to be larger value.
8206
8207 @item tracer-max-code-growth
8208 Stop tail duplication once code growth has reached given percentage.  This is
8209 rather hokey argument, as most of the duplicates will be eliminated later in
8210 cross jumping, so it may be set to much higher values than is the desired code
8211 growth.
8212
8213 @item tracer-min-branch-ratio
8214
8215 Stop reverse growth when the reverse probability of best edge is less than this
8216 threshold (in percent).
8217
8218 @item tracer-min-branch-ratio
8219 @itemx tracer-min-branch-ratio-feedback
8220
8221 Stop forward growth if the best edge do have probability lower than this
8222 threshold.
8223
8224 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8225 compilation for profile feedback and one for compilation without.  The value
8226 for compilation with profile feedback needs to be more conservative (higher) in
8227 order to make tracer effective.
8228
8229 @item max-cse-path-length
8230
8231 Maximum number of basic blocks on path that cse considers.  The default is 10.
8232
8233 @item max-cse-insns
8234 The maximum instructions CSE process before flushing. The default is 1000.
8235
8236 @item ggc-min-expand
8237
8238 GCC uses a garbage collector to manage its own memory allocation.  This
8239 parameter specifies the minimum percentage by which the garbage
8240 collector's heap should be allowed to expand between collections.
8241 Tuning this may improve compilation speed; it has no effect on code
8242 generation.
8243
8244 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8245 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8246 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8247 GCC is not able to calculate RAM on a particular platform, the lower
8248 bound of 30% is used.  Setting this parameter and
8249 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8250 every opportunity.  This is extremely slow, but can be useful for
8251 debugging.
8252
8253 @item ggc-min-heapsize
8254
8255 Minimum size of the garbage collector's heap before it begins bothering
8256 to collect garbage.  The first collection occurs after the heap expands
8257 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8258 tuning this may improve compilation speed, and has no effect on code
8259 generation.
8260
8261 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8262 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8263 with a lower bound of 4096 (four megabytes) and an upper bound of
8264 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8265 particular platform, the lower bound is used.  Setting this parameter
8266 very large effectively disables garbage collection.  Setting this
8267 parameter and @option{ggc-min-expand} to zero causes a full collection
8268 to occur at every opportunity.
8269
8270 @item max-reload-search-insns
8271 The maximum number of instruction reload should look backward for equivalent
8272 register.  Increasing values mean more aggressive optimization, making the
8273 compile time increase with probably slightly better performance.  The default
8274 value is 100.
8275
8276 @item max-cselib-memory-locations
8277 The maximum number of memory locations cselib should take into account.
8278 Increasing values mean more aggressive optimization, making the compile time
8279 increase with probably slightly better performance.  The default value is 500.
8280
8281 @item reorder-blocks-duplicate
8282 @itemx reorder-blocks-duplicate-feedback
8283
8284 Used by basic block reordering pass to decide whether to use unconditional
8285 branch or duplicate the code on its destination.  Code is duplicated when its
8286 estimated size is smaller than this value multiplied by the estimated size of
8287 unconditional jump in the hot spots of the program.
8288
8289 The @option{reorder-block-duplicate-feedback} is used only when profile
8290 feedback is available and may be set to higher values than
8291 @option{reorder-block-duplicate} since information about the hot spots is more
8292 accurate.
8293
8294 @item max-sched-ready-insns
8295 The maximum number of instructions ready to be issued the scheduler should
8296 consider at any given time during the first scheduling pass.  Increasing
8297 values mean more thorough searches, making the compilation time increase
8298 with probably little benefit.  The default value is 100.
8299
8300 @item max-sched-region-blocks
8301 The maximum number of blocks in a region to be considered for
8302 interblock scheduling.  The default value is 10.
8303
8304 @item max-pipeline-region-blocks
8305 The maximum number of blocks in a region to be considered for
8306 pipelining in the selective scheduler.  The default value is 15.
8307
8308 @item max-sched-region-insns
8309 The maximum number of insns in a region to be considered for
8310 interblock scheduling.  The default value is 100.
8311
8312 @item max-pipeline-region-insns
8313 The maximum number of insns in a region to be considered for
8314 pipelining in the selective scheduler.  The default value is 200.
8315
8316 @item min-spec-prob
8317 The minimum probability (in percents) of reaching a source block
8318 for interblock speculative scheduling.  The default value is 40.
8319
8320 @item max-sched-extend-regions-iters
8321 The maximum number of iterations through CFG to extend regions.
8322 0 - disable region extension,
8323 N - do at most N iterations.
8324 The default value is 0.
8325
8326 @item max-sched-insn-conflict-delay
8327 The maximum conflict delay for an insn to be considered for speculative motion.
8328 The default value is 3.
8329
8330 @item sched-spec-prob-cutoff
8331 The minimal probability of speculation success (in percents), so that
8332 speculative insn will be scheduled.
8333 The default value is 40.
8334
8335 @item sched-mem-true-dep-cost
8336 Minimal distance (in CPU cycles) between store and load targeting same
8337 memory locations.  The default value is 1.
8338
8339 @item selsched-max-lookahead
8340 The maximum size of the lookahead window of selective scheduling.  It is a
8341 depth of search for available instructions.
8342 The default value is 50.
8343
8344 @item selsched-max-sched-times
8345 The maximum number of times that an instruction will be scheduled during
8346 selective scheduling.  This is the limit on the number of iterations
8347 through which the instruction may be pipelined.  The default value is 2.
8348
8349 @item selsched-max-insns-to-rename
8350 The maximum number of best instructions in the ready list that are considered
8351 for renaming in the selective scheduler.  The default value is 2.
8352
8353 @item max-last-value-rtl
8354 The maximum size measured as number of RTLs that can be recorded in an expression
8355 in combiner for a pseudo register as last known value of that register.  The default
8356 is 10000.
8357
8358 @item integer-share-limit
8359 Small integer constants can use a shared data structure, reducing the
8360 compiler's memory usage and increasing its speed.  This sets the maximum
8361 value of a shared integer constant.  The default value is 256.
8362
8363 @item min-virtual-mappings
8364 Specifies the minimum number of virtual mappings in the incremental
8365 SSA updater that should be registered to trigger the virtual mappings
8366 heuristic defined by virtual-mappings-ratio.  The default value is
8367 100.
8368
8369 @item virtual-mappings-ratio
8370 If the number of virtual mappings is virtual-mappings-ratio bigger
8371 than the number of virtual symbols to be updated, then the incremental
8372 SSA updater switches to a full update for those symbols.  The default
8373 ratio is 3.
8374
8375 @item ssp-buffer-size
8376 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8377 protection when @option{-fstack-protection} is used.
8378
8379 @item max-jump-thread-duplication-stmts
8380 Maximum number of statements allowed in a block that needs to be
8381 duplicated when threading jumps.
8382
8383 @item max-fields-for-field-sensitive
8384 Maximum number of fields in a structure we will treat in
8385 a field sensitive manner during pointer analysis.  The default is zero
8386 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8387
8388 @item prefetch-latency
8389 Estimate on average number of instructions that are executed before
8390 prefetch finishes.  The distance we prefetch ahead is proportional
8391 to this constant.  Increasing this number may also lead to less
8392 streams being prefetched (see @option{simultaneous-prefetches}).
8393
8394 @item simultaneous-prefetches
8395 Maximum number of prefetches that can run at the same time.
8396
8397 @item l1-cache-line-size
8398 The size of cache line in L1 cache, in bytes.
8399
8400 @item l1-cache-size
8401 The size of L1 cache, in kilobytes.
8402
8403 @item l2-cache-size
8404 The size of L2 cache, in kilobytes.
8405
8406 @item min-insn-to-prefetch-ratio
8407 The minimum ratio between the number of instructions and the
8408 number of prefetches to enable prefetching in a loop with an
8409 unknown trip count.
8410
8411 @item prefetch-min-insn-to-mem-ratio
8412 The minimum ratio between the number of instructions and the
8413 number of memory references to enable prefetching in a loop.
8414
8415 @item use-canonical-types
8416 Whether the compiler should use the ``canonical'' type system.  By
8417 default, this should always be 1, which uses a more efficient internal
8418 mechanism for comparing types in C++ and Objective-C++.  However, if
8419 bugs in the canonical type system are causing compilation failures,
8420 set this value to 0 to disable canonical types.
8421
8422 @item switch-conversion-max-branch-ratio
8423 Switch initialization conversion will refuse to create arrays that are
8424 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8425 branches in the switch.
8426
8427 @item max-partial-antic-length
8428 Maximum length of the partial antic set computed during the tree
8429 partial redundancy elimination optimization (@option{-ftree-pre}) when
8430 optimizing at @option{-O3} and above.  For some sorts of source code
8431 the enhanced partial redundancy elimination optimization can run away,
8432 consuming all of the memory available on the host machine.  This
8433 parameter sets a limit on the length of the sets that are computed,
8434 which prevents the runaway behavior.  Setting a value of 0 for
8435 this parameter will allow an unlimited set length.
8436
8437 @item sccvn-max-scc-size
8438 Maximum size of a strongly connected component (SCC) during SCCVN
8439 processing.  If this limit is hit, SCCVN processing for the whole
8440 function will not be done and optimizations depending on it will
8441 be disabled.  The default maximum SCC size is 10000.
8442
8443 @item ira-max-loops-num
8444 IRA uses a regional register allocation by default.  If a function
8445 contains loops more than number given by the parameter, only at most
8446 given number of the most frequently executed loops will form regions
8447 for the regional register allocation.  The default value of the
8448 parameter is 100.
8449
8450 @item ira-max-conflict-table-size
8451 Although IRA uses a sophisticated algorithm of compression conflict
8452 table, the table can be still big for huge functions.  If the conflict
8453 table for a function could be more than size in MB given by the
8454 parameter, the conflict table is not built and faster, simpler, and
8455 lower quality register allocation algorithm will be used.  The
8456 algorithm do not use pseudo-register conflicts.  The default value of
8457 the parameter is 2000.
8458
8459 @item ira-loop-reserved-regs
8460 IRA can be used to evaluate more accurate register pressure in loops
8461 for decision to move loop invariants (see @option{-O3}).  The number
8462 of available registers reserved for some other purposes is described
8463 by this parameter.  The default value of the parameter is 2 which is
8464 minimal number of registers needed for execution of typical
8465 instruction.  This value is the best found from numerous experiments.
8466
8467 @item loop-invariant-max-bbs-in-loop
8468 Loop invariant motion can be very expensive, both in compile time and
8469 in amount of needed compile time memory, with very large loops.  Loops
8470 with more basic blocks than this parameter won't have loop invariant
8471 motion optimization performed on them.  The default value of the
8472 parameter is 1000 for -O1 and 10000 for -O2 and above.
8473
8474 @item max-vartrack-size
8475 Sets a maximum number of hash table slots to use during variable
8476 tracking dataflow analysis of any function.  If this limit is exceeded
8477 with variable tracking at assignments enabled, analysis for that
8478 function is retried without it, after removing all debug insns from
8479 the function.  If the limit is exceeded even without debug insns, var
8480 tracking analysis is completely disabled for the function.  Setting
8481 the parameter to zero makes it unlimited.
8482
8483 @item min-nondebug-insn-uid
8484 Use uids starting at this parameter for nondebug insns.  The range below
8485 the parameter is reserved exclusively for debug insns created by
8486 @option{-fvar-tracking-assignments}, but debug insns may get
8487 (non-overlapping) uids above it if the reserved range is exhausted.
8488
8489 @item ipa-sra-ptr-growth-factor
8490 IPA-SRA will replace a pointer to an aggregate with one or more new
8491 parameters only when their cumulative size is less or equal to
8492 @option{ipa-sra-ptr-growth-factor} times the size of the original
8493 pointer parameter.
8494
8495 @end table
8496 @end table
8497
8498 @node Preprocessor Options
8499 @section Options Controlling the Preprocessor
8500 @cindex preprocessor options
8501 @cindex options, preprocessor
8502
8503 These options control the C preprocessor, which is run on each C source
8504 file before actual compilation.
8505
8506 If you use the @option{-E} option, nothing is done except preprocessing.
8507 Some of these options make sense only together with @option{-E} because
8508 they cause the preprocessor output to be unsuitable for actual
8509 compilation.
8510
8511 @table @gcctabopt
8512 @item -Wp,@var{option}
8513 @opindex Wp
8514 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8515 and pass @var{option} directly through to the preprocessor.  If
8516 @var{option} contains commas, it is split into multiple options at the
8517 commas.  However, many options are modified, translated or interpreted
8518 by the compiler driver before being passed to the preprocessor, and
8519 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8520 interface is undocumented and subject to change, so whenever possible
8521 you should avoid using @option{-Wp} and let the driver handle the
8522 options instead.
8523
8524 @item -Xpreprocessor @var{option}
8525 @opindex Xpreprocessor
8526 Pass @var{option} as an option to the preprocessor.  You can use this to
8527 supply system-specific preprocessor options which GCC does not know how to
8528 recognize.
8529
8530 If you want to pass an option that takes an argument, you must use
8531 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8532 @end table
8533
8534 @include cppopts.texi
8535
8536 @node Assembler Options
8537 @section Passing Options to the Assembler
8538
8539 @c prevent bad page break with this line
8540 You can pass options to the assembler.
8541
8542 @table @gcctabopt
8543 @item -Wa,@var{option}
8544 @opindex Wa
8545 Pass @var{option} as an option to the assembler.  If @var{option}
8546 contains commas, it is split into multiple options at the commas.
8547
8548 @item -Xassembler @var{option}
8549 @opindex Xassembler
8550 Pass @var{option} as an option to the assembler.  You can use this to
8551 supply system-specific assembler options which GCC does not know how to
8552 recognize.
8553
8554 If you want to pass an option that takes an argument, you must use
8555 @option{-Xassembler} twice, once for the option and once for the argument.
8556
8557 @end table
8558
8559 @node Link Options
8560 @section Options for Linking
8561 @cindex link options
8562 @cindex options, linking
8563
8564 These options come into play when the compiler links object files into
8565 an executable output file.  They are meaningless if the compiler is
8566 not doing a link step.
8567
8568 @table @gcctabopt
8569 @cindex file names
8570 @item @var{object-file-name}
8571 A file name that does not end in a special recognized suffix is
8572 considered to name an object file or library.  (Object files are
8573 distinguished from libraries by the linker according to the file
8574 contents.)  If linking is done, these object files are used as input
8575 to the linker.
8576
8577 @item -c
8578 @itemx -S
8579 @itemx -E
8580 @opindex c
8581 @opindex S
8582 @opindex E
8583 If any of these options is used, then the linker is not run, and
8584 object file names should not be used as arguments.  @xref{Overall
8585 Options}.
8586
8587 @cindex Libraries
8588 @item -l@var{library}
8589 @itemx -l @var{library}
8590 @opindex l
8591 Search the library named @var{library} when linking.  (The second
8592 alternative with the library as a separate argument is only for
8593 POSIX compliance and is not recommended.)
8594
8595 It makes a difference where in the command you write this option; the
8596 linker searches and processes libraries and object files in the order they
8597 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8598 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8599 to functions in @samp{z}, those functions may not be loaded.
8600
8601 The linker searches a standard list of directories for the library,
8602 which is actually a file named @file{lib@var{library}.a}.  The linker
8603 then uses this file as if it had been specified precisely by name.
8604
8605 The directories searched include several standard system directories
8606 plus any that you specify with @option{-L}.
8607
8608 Normally the files found this way are library files---archive files
8609 whose members are object files.  The linker handles an archive file by
8610 scanning through it for members which define symbols that have so far
8611 been referenced but not defined.  But if the file that is found is an
8612 ordinary object file, it is linked in the usual fashion.  The only
8613 difference between using an @option{-l} option and specifying a file name
8614 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8615 and searches several directories.
8616
8617 @item -lobjc
8618 @opindex lobjc
8619 You need this special case of the @option{-l} option in order to
8620 link an Objective-C or Objective-C++ program.
8621
8622 @item -nostartfiles
8623 @opindex nostartfiles
8624 Do not use the standard system startup files when linking.
8625 The standard system libraries are used normally, unless @option{-nostdlib}
8626 or @option{-nodefaultlibs} is used.
8627
8628 @item -nodefaultlibs
8629 @opindex nodefaultlibs
8630 Do not use the standard system libraries when linking.
8631 Only the libraries you specify will be passed to the linker, options
8632 specifying linkage of the system libraries, such as @code{-static-libgcc}
8633 or @code{-shared-libgcc}, will be ignored.
8634 The standard startup files are used normally, unless @option{-nostartfiles}
8635 is used.  The compiler may generate calls to @code{memcmp},
8636 @code{memset}, @code{memcpy} and @code{memmove}.
8637 These entries are usually resolved by entries in
8638 libc.  These entry points should be supplied through some other
8639 mechanism when this option is specified.
8640
8641 @item -nostdlib
8642 @opindex nostdlib
8643 Do not use the standard system startup files or libraries when linking.
8644 No startup files and only the libraries you specify will be passed to
8645 the linker, options specifying linkage of the system libraries, such as
8646 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8647 The compiler may generate calls to @code{memcmp}, @code{memset},
8648 @code{memcpy} and @code{memmove}.
8649 These entries are usually resolved by entries in
8650 libc.  These entry points should be supplied through some other
8651 mechanism when this option is specified.
8652
8653 @cindex @option{-lgcc}, use with @option{-nostdlib}
8654 @cindex @option{-nostdlib} and unresolved references
8655 @cindex unresolved references and @option{-nostdlib}
8656 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8657 @cindex @option{-nodefaultlibs} and unresolved references
8658 @cindex unresolved references and @option{-nodefaultlibs}
8659 One of the standard libraries bypassed by @option{-nostdlib} and
8660 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8661 that GCC uses to overcome shortcomings of particular machines, or special
8662 needs for some languages.
8663 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8664 Collection (GCC) Internals},
8665 for more discussion of @file{libgcc.a}.)
8666 In most cases, you need @file{libgcc.a} even when you want to avoid
8667 other standard libraries.  In other words, when you specify @option{-nostdlib}
8668 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8669 This ensures that you have no unresolved references to internal GCC
8670 library subroutines.  (For example, @samp{__main}, used to ensure C++
8671 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8672 GNU Compiler Collection (GCC) Internals}.)
8673
8674 @item -pie
8675 @opindex pie
8676 Produce a position independent executable on targets which support it.
8677 For predictable results, you must also specify the same set of options
8678 that were used to generate code (@option{-fpie}, @option{-fPIE},
8679 or model suboptions) when you specify this option.
8680
8681 @item -rdynamic
8682 @opindex rdynamic
8683 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8684 that support it. This instructs the linker to add all symbols, not
8685 only used ones, to the dynamic symbol table. This option is needed
8686 for some uses of @code{dlopen} or to allow obtaining backtraces
8687 from within a program.
8688
8689 @item -s
8690 @opindex s
8691 Remove all symbol table and relocation information from the executable.
8692
8693 @item -static
8694 @opindex static
8695 On systems that support dynamic linking, this prevents linking with the shared
8696 libraries.  On other systems, this option has no effect.
8697
8698 @item -shared
8699 @opindex shared
8700 Produce a shared object which can then be linked with other objects to
8701 form an executable.  Not all systems support this option.  For predictable
8702 results, you must also specify the same set of options that were used to
8703 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8704 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8705 needs to build supplementary stub code for constructors to work.  On
8706 multi-libbed systems, @samp{gcc -shared} must select the correct support
8707 libraries to link against.  Failing to supply the correct flags may lead
8708 to subtle defects.  Supplying them in cases where they are not necessary
8709 is innocuous.}
8710
8711 @item -shared-libgcc
8712 @itemx -static-libgcc
8713 @opindex shared-libgcc
8714 @opindex static-libgcc
8715 On systems that provide @file{libgcc} as a shared library, these options
8716 force the use of either the shared or static version respectively.
8717 If no shared version of @file{libgcc} was built when the compiler was
8718 configured, these options have no effect.
8719
8720 There are several situations in which an application should use the
8721 shared @file{libgcc} instead of the static version.  The most common
8722 of these is when the application wishes to throw and catch exceptions
8723 across different shared libraries.  In that case, each of the libraries
8724 as well as the application itself should use the shared @file{libgcc}.
8725
8726 Therefore, the G++ and GCJ drivers automatically add
8727 @option{-shared-libgcc} whenever you build a shared library or a main
8728 executable, because C++ and Java programs typically use exceptions, so
8729 this is the right thing to do.
8730
8731 If, instead, you use the GCC driver to create shared libraries, you may
8732 find that they will not always be linked with the shared @file{libgcc}.
8733 If GCC finds, at its configuration time, that you have a non-GNU linker
8734 or a GNU linker that does not support option @option{--eh-frame-hdr},
8735 it will link the shared version of @file{libgcc} into shared libraries
8736 by default.  Otherwise, it will take advantage of the linker and optimize
8737 away the linking with the shared version of @file{libgcc}, linking with
8738 the static version of libgcc by default.  This allows exceptions to
8739 propagate through such shared libraries, without incurring relocation
8740 costs at library load time.
8741
8742 However, if a library or main executable is supposed to throw or catch
8743 exceptions, you must link it using the G++ or GCJ driver, as appropriate
8744 for the languages used in the program, or using the option
8745 @option{-shared-libgcc}, such that it is linked with the shared
8746 @file{libgcc}.
8747
8748 @item -static-libstdc++
8749 When the @command{g++} program is used to link a C++ program, it will
8750 normally automatically link against @option{libstdc++}.  If
8751 @file{libstdc++} is available as a shared library, and the
8752 @option{-static} option is not used, then this will link against the
8753 shared version of @file{libstdc++}.  That is normally fine.  However, it
8754 is sometimes useful to freeze the version of @file{libstdc++} used by
8755 the program without going all the way to a fully static link.  The
8756 @option{-static-libstdc++} option directs the @command{g++} driver to
8757 link @file{libstdc++} statically, without necessarily linking other
8758 libraries statically.
8759
8760 @item -symbolic
8761 @opindex symbolic
8762 Bind references to global symbols when building a shared object.  Warn
8763 about any unresolved references (unless overridden by the link editor
8764 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8765 this option.
8766
8767 @item -T @var{script}
8768 @opindex T
8769 @cindex linker script
8770 Use @var{script} as the linker script.  This option is supported by most
8771 systems using the GNU linker.  On some targets, such as bare-board
8772 targets without an operating system, the @option{-T} option may be required
8773 when linking to avoid references to undefined symbols.
8774
8775 @item -Xlinker @var{option}
8776 @opindex Xlinker
8777 Pass @var{option} as an option to the linker.  You can use this to
8778 supply system-specific linker options which GCC does not know how to
8779 recognize.
8780
8781 If you want to pass an option that takes a separate argument, you must use
8782 @option{-Xlinker} twice, once for the option and once for the argument.
8783 For example, to pass @option{-assert definitions}, you must write
8784 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8785 @option{-Xlinker "-assert definitions"}, because this passes the entire
8786 string as a single argument, which is not what the linker expects.
8787
8788 When using the GNU linker, it is usually more convenient to pass
8789 arguments to linker options using the @option{@var{option}=@var{value}}
8790 syntax than as separate arguments.  For example, you can specify
8791 @samp{-Xlinker -Map=output.map} rather than
8792 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
8793 this syntax for command-line options.
8794
8795 @item -Wl,@var{option}
8796 @opindex Wl
8797 Pass @var{option} as an option to the linker.  If @var{option} contains
8798 commas, it is split into multiple options at the commas.  You can use this
8799 syntax to pass an argument to the option.
8800 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
8801 linker.  When using the GNU linker, you can also get the same effect with
8802 @samp{-Wl,-Map=output.map}.
8803
8804 @item -u @var{symbol}
8805 @opindex u
8806 Pretend the symbol @var{symbol} is undefined, to force linking of
8807 library modules to define it.  You can use @option{-u} multiple times with
8808 different symbols to force loading of additional library modules.
8809 @end table
8810
8811 @node Directory Options
8812 @section Options for Directory Search
8813 @cindex directory options
8814 @cindex options, directory search
8815 @cindex search path
8816
8817 These options specify directories to search for header files, for
8818 libraries and for parts of the compiler:
8819
8820 @table @gcctabopt
8821 @item -I@var{dir}
8822 @opindex I
8823 Add the directory @var{dir} to the head of the list of directories to be
8824 searched for header files.  This can be used to override a system header
8825 file, substituting your own version, since these directories are
8826 searched before the system header file directories.  However, you should
8827 not use this option to add directories that contain vendor-supplied
8828 system header files (use @option{-isystem} for that).  If you use more than
8829 one @option{-I} option, the directories are scanned in left-to-right
8830 order; the standard system directories come after.
8831
8832 If a standard system include directory, or a directory specified with
8833 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8834 option will be ignored.  The directory will still be searched but as a
8835 system directory at its normal position in the system include chain.
8836 This is to ensure that GCC's procedure to fix buggy system headers and
8837 the ordering for the include_next directive are not inadvertently changed.
8838 If you really need to change the search order for system directories,
8839 use the @option{-nostdinc} and/or @option{-isystem} options.
8840
8841 @item -iquote@var{dir}
8842 @opindex iquote
8843 Add the directory @var{dir} to the head of the list of directories to
8844 be searched for header files only for the case of @samp{#include
8845 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8846 otherwise just like @option{-I}.
8847
8848 @item -L@var{dir}
8849 @opindex L
8850 Add directory @var{dir} to the list of directories to be searched
8851 for @option{-l}.
8852
8853 @item -B@var{prefix}
8854 @opindex B
8855 This option specifies where to find the executables, libraries,
8856 include files, and data files of the compiler itself.
8857
8858 The compiler driver program runs one or more of the subprograms
8859 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8860 @var{prefix} as a prefix for each program it tries to run, both with and
8861 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
8862
8863 For each subprogram to be run, the compiler driver first tries the
8864 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
8865 was not specified, the driver tries two standard prefixes, which are
8866 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
8867 those results in a file name that is found, the unmodified program
8868 name is searched for using the directories specified in your
8869 @env{PATH} environment variable.
8870
8871 The compiler will check to see if the path provided by the @option{-B}
8872 refers to a directory, and if necessary it will add a directory
8873 separator character at the end of the path.
8874
8875 @option{-B} prefixes that effectively specify directory names also apply
8876 to libraries in the linker, because the compiler translates these
8877 options into @option{-L} options for the linker.  They also apply to
8878 includes files in the preprocessor, because the compiler translates these
8879 options into @option{-isystem} options for the preprocessor.  In this case,
8880 the compiler appends @samp{include} to the prefix.
8881
8882 The run-time support file @file{libgcc.a} can also be searched for using
8883 the @option{-B} prefix, if needed.  If it is not found there, the two
8884 standard prefixes above are tried, and that is all.  The file is left
8885 out of the link if it is not found by those means.
8886
8887 Another way to specify a prefix much like the @option{-B} prefix is to use
8888 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
8889 Variables}.
8890
8891 As a special kludge, if the path provided by @option{-B} is
8892 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
8893 9, then it will be replaced by @file{[dir/]include}.  This is to help
8894 with boot-strapping the compiler.
8895
8896 @item -specs=@var{file}
8897 @opindex specs
8898 Process @var{file} after the compiler reads in the standard @file{specs}
8899 file, in order to override the defaults that the @file{gcc} driver
8900 program uses when determining what switches to pass to @file{cc1},
8901 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
8902 @option{-specs=@var{file}} can be specified on the command line, and they
8903 are processed in order, from left to right.
8904
8905 @item --sysroot=@var{dir}
8906 @opindex sysroot
8907 Use @var{dir} as the logical root directory for headers and libraries.
8908 For example, if the compiler would normally search for headers in
8909 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
8910 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
8911
8912 If you use both this option and the @option{-isysroot} option, then
8913 the @option{--sysroot} option will apply to libraries, but the
8914 @option{-isysroot} option will apply to header files.
8915
8916 The GNU linker (beginning with version 2.16) has the necessary support
8917 for this option.  If your linker does not support this option, the
8918 header file aspect of @option{--sysroot} will still work, but the
8919 library aspect will not.
8920
8921 @item -I-
8922 @opindex I-
8923 This option has been deprecated.  Please use @option{-iquote} instead for
8924 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
8925 Any directories you specify with @option{-I} options before the @option{-I-}
8926 option are searched only for the case of @samp{#include "@var{file}"};
8927 they are not searched for @samp{#include <@var{file}>}.
8928
8929 If additional directories are specified with @option{-I} options after
8930 the @option{-I-}, these directories are searched for all @samp{#include}
8931 directives.  (Ordinarily @emph{all} @option{-I} directories are used
8932 this way.)
8933
8934 In addition, the @option{-I-} option inhibits the use of the current
8935 directory (where the current input file came from) as the first search
8936 directory for @samp{#include "@var{file}"}.  There is no way to
8937 override this effect of @option{-I-}.  With @option{-I.} you can specify
8938 searching the directory which was current when the compiler was
8939 invoked.  That is not exactly the same as what the preprocessor does
8940 by default, but it is often satisfactory.
8941
8942 @option{-I-} does not inhibit the use of the standard system directories
8943 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
8944 independent.
8945 @end table
8946
8947 @c man end
8948
8949 @node Spec Files
8950 @section Specifying subprocesses and the switches to pass to them
8951 @cindex Spec Files
8952
8953 @command{gcc} is a driver program.  It performs its job by invoking a
8954 sequence of other programs to do the work of compiling, assembling and
8955 linking.  GCC interprets its command-line parameters and uses these to
8956 deduce which programs it should invoke, and which command-line options
8957 it ought to place on their command lines.  This behavior is controlled
8958 by @dfn{spec strings}.  In most cases there is one spec string for each
8959 program that GCC can invoke, but a few programs have multiple spec
8960 strings to control their behavior.  The spec strings built into GCC can
8961 be overridden by using the @option{-specs=} command-line switch to specify
8962 a spec file.
8963
8964 @dfn{Spec files} are plaintext files that are used to construct spec
8965 strings.  They consist of a sequence of directives separated by blank
8966 lines.  The type of directive is determined by the first non-whitespace
8967 character on the line and it can be one of the following:
8968
8969 @table @code
8970 @item %@var{command}
8971 Issues a @var{command} to the spec file processor.  The commands that can
8972 appear here are:
8973
8974 @table @code
8975 @item %include <@var{file}>
8976 @cindex %include
8977 Search for @var{file} and insert its text at the current point in the
8978 specs file.
8979
8980 @item %include_noerr <@var{file}>
8981 @cindex %include_noerr
8982 Just like @samp{%include}, but do not generate an error message if the include
8983 file cannot be found.
8984
8985 @item %rename @var{old_name} @var{new_name}
8986 @cindex %rename
8987 Rename the spec string @var{old_name} to @var{new_name}.
8988
8989 @end table
8990
8991 @item *[@var{spec_name}]:
8992 This tells the compiler to create, override or delete the named spec
8993 string.  All lines after this directive up to the next directive or
8994 blank line are considered to be the text for the spec string.  If this
8995 results in an empty string then the spec will be deleted.  (Or, if the
8996 spec did not exist, then nothing will happened.)  Otherwise, if the spec
8997 does not currently exist a new spec will be created.  If the spec does
8998 exist then its contents will be overridden by the text of this
8999 directive, unless the first character of that text is the @samp{+}
9000 character, in which case the text will be appended to the spec.
9001
9002 @item [@var{suffix}]:
9003 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9004 and up to the next directive or blank line are considered to make up the
9005 spec string for the indicated suffix.  When the compiler encounters an
9006 input file with the named suffix, it will processes the spec string in
9007 order to work out how to compile that file.  For example:
9008
9009 @smallexample
9010 .ZZ:
9011 z-compile -input %i
9012 @end smallexample
9013
9014 This says that any input file whose name ends in @samp{.ZZ} should be
9015 passed to the program @samp{z-compile}, which should be invoked with the
9016 command-line switch @option{-input} and with the result of performing the
9017 @samp{%i} substitution.  (See below.)
9018
9019 As an alternative to providing a spec string, the text that follows a
9020 suffix directive can be one of the following:
9021
9022 @table @code
9023 @item @@@var{language}
9024 This says that the suffix is an alias for a known @var{language}.  This is
9025 similar to using the @option{-x} command-line switch to GCC to specify a
9026 language explicitly.  For example:
9027
9028 @smallexample
9029 .ZZ:
9030 @@c++
9031 @end smallexample
9032
9033 Says that .ZZ files are, in fact, C++ source files.
9034
9035 @item #@var{name}
9036 This causes an error messages saying:
9037
9038 @smallexample
9039 @var{name} compiler not installed on this system.
9040 @end smallexample
9041 @end table
9042
9043 GCC already has an extensive list of suffixes built into it.
9044 This directive will add an entry to the end of the list of suffixes, but
9045 since the list is searched from the end backwards, it is effectively
9046 possible to override earlier entries using this technique.
9047
9048 @end table
9049
9050 GCC has the following spec strings built into it.  Spec files can
9051 override these strings or create their own.  Note that individual
9052 targets can also add their own spec strings to this list.
9053
9054 @smallexample
9055 asm          Options to pass to the assembler
9056 asm_final    Options to pass to the assembler post-processor
9057 cpp          Options to pass to the C preprocessor
9058 cc1          Options to pass to the C compiler
9059 cc1plus      Options to pass to the C++ compiler
9060 endfile      Object files to include at the end of the link
9061 link         Options to pass to the linker
9062 lib          Libraries to include on the command line to the linker
9063 libgcc       Decides which GCC support library to pass to the linker
9064 linker       Sets the name of the linker
9065 predefines   Defines to be passed to the C preprocessor
9066 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9067              by default
9068 startfile    Object files to include at the start of the link
9069 @end smallexample
9070
9071 Here is a small example of a spec file:
9072
9073 @smallexample
9074 %rename lib                 old_lib
9075
9076 *lib:
9077 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9078 @end smallexample
9079
9080 This example renames the spec called @samp{lib} to @samp{old_lib} and
9081 then overrides the previous definition of @samp{lib} with a new one.
9082 The new definition adds in some extra command-line options before
9083 including the text of the old definition.
9084
9085 @dfn{Spec strings} are a list of command-line options to be passed to their
9086 corresponding program.  In addition, the spec strings can contain
9087 @samp{%}-prefixed sequences to substitute variable text or to
9088 conditionally insert text into the command line.  Using these constructs
9089 it is possible to generate quite complex command lines.
9090
9091 Here is a table of all defined @samp{%}-sequences for spec
9092 strings.  Note that spaces are not generated automatically around the
9093 results of expanding these sequences.  Therefore you can concatenate them
9094 together or combine them with constant text in a single argument.
9095
9096 @table @code
9097 @item %%
9098 Substitute one @samp{%} into the program name or argument.
9099
9100 @item %i
9101 Substitute the name of the input file being processed.
9102
9103 @item %b
9104 Substitute the basename of the input file being processed.
9105 This is the substring up to (and not including) the last period
9106 and not including the directory.
9107
9108 @item %B
9109 This is the same as @samp{%b}, but include the file suffix (text after
9110 the last period).
9111
9112 @item %d
9113 Marks the argument containing or following the @samp{%d} as a
9114 temporary file name, so that that file will be deleted if GCC exits
9115 successfully.  Unlike @samp{%g}, this contributes no text to the
9116 argument.
9117
9118 @item %g@var{suffix}
9119 Substitute a file name that has suffix @var{suffix} and is chosen
9120 once per compilation, and mark the argument in the same way as
9121 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9122 name is now chosen in a way that is hard to predict even when previously
9123 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9124 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9125 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9126 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9127 was simply substituted with a file name chosen once per compilation,
9128 without regard to any appended suffix (which was therefore treated
9129 just like ordinary text), making such attacks more likely to succeed.
9130
9131 @item %u@var{suffix}
9132 Like @samp{%g}, but generates a new temporary file name even if
9133 @samp{%u@var{suffix}} was already seen.
9134
9135 @item %U@var{suffix}
9136 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9137 new one if there is no such last file name.  In the absence of any
9138 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9139 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9140 would involve the generation of two distinct file names, one
9141 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9142 simply substituted with a file name chosen for the previous @samp{%u},
9143 without regard to any appended suffix.
9144
9145 @item %j@var{suffix}
9146 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9147 writable, and if save-temps is off; otherwise, substitute the name
9148 of a temporary file, just like @samp{%u}.  This temporary file is not
9149 meant for communication between processes, but rather as a junk
9150 disposal mechanism.
9151
9152 @item %|@var{suffix}
9153 @itemx %m@var{suffix}
9154 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9155 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9156 all.  These are the two most common ways to instruct a program that it
9157 should read from standard input or write to standard output.  If you
9158 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9159 construct: see for example @file{f/lang-specs.h}.
9160
9161 @item %.@var{SUFFIX}
9162 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9163 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9164 terminated by the next space or %.
9165
9166 @item %w
9167 Marks the argument containing or following the @samp{%w} as the
9168 designated output file of this compilation.  This puts the argument
9169 into the sequence of arguments that @samp{%o} will substitute later.
9170
9171 @item %o
9172 Substitutes the names of all the output files, with spaces
9173 automatically placed around them.  You should write spaces
9174 around the @samp{%o} as well or the results are undefined.
9175 @samp{%o} is for use in the specs for running the linker.
9176 Input files whose names have no recognized suffix are not compiled
9177 at all, but they are included among the output files, so they will
9178 be linked.
9179
9180 @item %O
9181 Substitutes the suffix for object files.  Note that this is
9182 handled specially when it immediately follows @samp{%g, %u, or %U},
9183 because of the need for those to form complete file names.  The
9184 handling is such that @samp{%O} is treated exactly as if it had already
9185 been substituted, except that @samp{%g, %u, and %U} do not currently
9186 support additional @var{suffix} characters following @samp{%O} as they would
9187 following, for example, @samp{.o}.
9188
9189 @item %p
9190 Substitutes the standard macro predefinitions for the
9191 current target machine.  Use this when running @code{cpp}.
9192
9193 @item %P
9194 Like @samp{%p}, but puts @samp{__} before and after the name of each
9195 predefined macro, except for macros that start with @samp{__} or with
9196 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9197 C@.
9198
9199 @item %I
9200 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9201 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9202 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9203 and @option{-imultilib} as necessary.
9204
9205 @item %s
9206 Current argument is the name of a library or startup file of some sort.
9207 Search for that file in a standard list of directories and substitute
9208 the full name found.  The current working directory is included in the
9209 list of directories scanned.
9210
9211 @item %T
9212 Current argument is the name of a linker script.  Search for that file
9213 in the current list of directories to scan for libraries. If the file
9214 is located insert a @option{--script} option into the command line
9215 followed by the full path name found.  If the file is not found then
9216 generate an error message.  Note: the current working directory is not
9217 searched.
9218
9219 @item %e@var{str}
9220 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9221 Use this when inconsistent options are detected.
9222
9223 @item %(@var{name})
9224 Substitute the contents of spec string @var{name} at this point.
9225
9226 @item %[@var{name}]
9227 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9228
9229 @item %x@{@var{option}@}
9230 Accumulate an option for @samp{%X}.
9231
9232 @item %X
9233 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9234 spec string.
9235
9236 @item %Y
9237 Output the accumulated assembler options specified by @option{-Wa}.
9238
9239 @item %Z
9240 Output the accumulated preprocessor options specified by @option{-Wp}.
9241
9242 @item %a
9243 Process the @code{asm} spec.  This is used to compute the
9244 switches to be passed to the assembler.
9245
9246 @item %A
9247 Process the @code{asm_final} spec.  This is a spec string for
9248 passing switches to an assembler post-processor, if such a program is
9249 needed.
9250
9251 @item %l
9252 Process the @code{link} spec.  This is the spec for computing the
9253 command line passed to the linker.  Typically it will make use of the
9254 @samp{%L %G %S %D and %E} sequences.
9255
9256 @item %D
9257 Dump out a @option{-L} option for each directory that GCC believes might
9258 contain startup files.  If the target supports multilibs then the
9259 current multilib directory will be prepended to each of these paths.
9260
9261 @item %L
9262 Process the @code{lib} spec.  This is a spec string for deciding which
9263 libraries should be included on the command line to the linker.
9264
9265 @item %G
9266 Process the @code{libgcc} spec.  This is a spec string for deciding
9267 which GCC support library should be included on the command line to the linker.
9268
9269 @item %S
9270 Process the @code{startfile} spec.  This is a spec for deciding which
9271 object files should be the first ones passed to the linker.  Typically
9272 this might be a file named @file{crt0.o}.
9273
9274 @item %E
9275 Process the @code{endfile} spec.  This is a spec string that specifies
9276 the last object files that will be passed to the linker.
9277
9278 @item %C
9279 Process the @code{cpp} spec.  This is used to construct the arguments
9280 to be passed to the C preprocessor.
9281
9282 @item %1
9283 Process the @code{cc1} spec.  This is used to construct the options to be
9284 passed to the actual C compiler (@samp{cc1}).
9285
9286 @item %2
9287 Process the @code{cc1plus} spec.  This is used to construct the options to be
9288 passed to the actual C++ compiler (@samp{cc1plus}).
9289
9290 @item %*
9291 Substitute the variable part of a matched option.  See below.
9292 Note that each comma in the substituted string is replaced by
9293 a single space.
9294
9295 @item %<@code{S}
9296 Remove all occurrences of @code{-S} from the command line.  Note---this
9297 command is position dependent.  @samp{%} commands in the spec string
9298 before this one will see @code{-S}, @samp{%} commands in the spec string
9299 after this one will not.
9300
9301 @item %:@var{function}(@var{args})
9302 Call the named function @var{function}, passing it @var{args}.
9303 @var{args} is first processed as a nested spec string, then split
9304 into an argument vector in the usual fashion.  The function returns
9305 a string which is processed as if it had appeared literally as part
9306 of the current spec.
9307
9308 The following built-in spec functions are provided:
9309
9310 @table @code
9311 @item @code{getenv}
9312 The @code{getenv} spec function takes two arguments: an environment
9313 variable name and a string.  If the environment variable is not
9314 defined, a fatal error is issued.  Otherwise, the return value is the
9315 value of the environment variable concatenated with the string.  For
9316 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9317
9318 @smallexample
9319 %:getenv(TOPDIR /include)
9320 @end smallexample
9321
9322 expands to @file{/path/to/top/include}.
9323
9324 @item @code{if-exists}
9325 The @code{if-exists} spec function takes one argument, an absolute
9326 pathname to a file.  If the file exists, @code{if-exists} returns the
9327 pathname.  Here is a small example of its usage:
9328
9329 @smallexample
9330 *startfile:
9331 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9332 @end smallexample
9333
9334 @item @code{if-exists-else}
9335 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9336 spec function, except that it takes two arguments.  The first argument is
9337 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9338 returns the pathname.  If it does not exist, it returns the second argument.
9339 This way, @code{if-exists-else} can be used to select one file or another,
9340 based on the existence of the first.  Here is a small example of its usage:
9341
9342 @smallexample
9343 *startfile:
9344 crt0%O%s %:if-exists(crti%O%s) \
9345 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9346 @end smallexample
9347
9348 @item @code{replace-outfile}
9349 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9350 first argument in the outfiles array and replaces it with the second argument.  Here
9351 is a small example of its usage:
9352
9353 @smallexample
9354 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9355 @end smallexample
9356
9357 @item @code{print-asm-header}
9358 The @code{print-asm-header} function takes no arguments and simply
9359 prints a banner like:
9360
9361 @smallexample
9362 Assembler options
9363 =================
9364
9365 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9366 @end smallexample
9367
9368 It is used to separate compiler options from assembler options
9369 in the @option{--target-help} output.
9370 @end table
9371
9372 @item %@{@code{S}@}
9373 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9374 If that switch was not specified, this substitutes nothing.  Note that
9375 the leading dash is omitted when specifying this option, and it is
9376 automatically inserted if the substitution is performed.  Thus the spec
9377 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9378 and would output the command line option @option{-foo}.
9379
9380 @item %W@{@code{S}@}
9381 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9382 deleted on failure.
9383
9384 @item %@{@code{S}*@}
9385 Substitutes all the switches specified to GCC whose names start
9386 with @code{-S}, but which also take an argument.  This is used for
9387 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9388 GCC considers @option{-o foo} as being
9389 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9390 text, including the space.  Thus two arguments would be generated.
9391
9392 @item %@{@code{S}*&@code{T}*@}
9393 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9394 (the order of @code{S} and @code{T} in the spec is not significant).
9395 There can be any number of ampersand-separated variables; for each the
9396 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9397
9398 @item %@{@code{S}:@code{X}@}
9399 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9400
9401 @item %@{!@code{S}:@code{X}@}
9402 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9403
9404 @item %@{@code{S}*:@code{X}@}
9405 Substitutes @code{X} if one or more switches whose names start with
9406 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9407 once, no matter how many such switches appeared.  However, if @code{%*}
9408 appears somewhere in @code{X}, then @code{X} will be substituted once
9409 for each matching switch, with the @code{%*} replaced by the part of
9410 that switch that matched the @code{*}.
9411
9412 @item %@{.@code{S}:@code{X}@}
9413 Substitutes @code{X}, if processing a file with suffix @code{S}.
9414
9415 @item %@{!.@code{S}:@code{X}@}
9416 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9417
9418 @item %@{,@code{S}:@code{X}@}
9419 Substitutes @code{X}, if processing a file for language @code{S}.
9420
9421 @item %@{!,@code{S}:@code{X}@}
9422 Substitutes @code{X}, if not processing a file for language @code{S}.
9423
9424 @item %@{@code{S}|@code{P}:@code{X}@}
9425 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9426 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9427 @code{*} sequences as well, although they have a stronger binding than
9428 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9429 alternatives must be starred, and only the first matching alternative
9430 is substituted.
9431
9432 For example, a spec string like this:
9433
9434 @smallexample
9435 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9436 @end smallexample
9437
9438 will output the following command-line options from the following input
9439 command-line options:
9440
9441 @smallexample
9442 fred.c        -foo -baz
9443 jim.d         -bar -boggle
9444 -d fred.c     -foo -baz -boggle
9445 -d jim.d      -bar -baz -boggle
9446 @end smallexample
9447
9448 @item %@{S:X; T:Y; :D@}
9449
9450 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9451 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9452 be as many clauses as you need.  This may be combined with @code{.},
9453 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9454
9455
9456 @end table
9457
9458 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9459 construct may contain other nested @samp{%} constructs or spaces, or
9460 even newlines.  They are processed as usual, as described above.
9461 Trailing white space in @code{X} is ignored.  White space may also
9462 appear anywhere on the left side of the colon in these constructs,
9463 except between @code{.} or @code{*} and the corresponding word.
9464
9465 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9466 handled specifically in these constructs.  If another value of
9467 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9468 @option{-W} switch is found later in the command line, the earlier
9469 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9470 just one letter, which passes all matching options.
9471
9472 The character @samp{|} at the beginning of the predicate text is used to
9473 indicate that a command should be piped to the following command, but
9474 only if @option{-pipe} is specified.
9475
9476 It is built into GCC which switches take arguments and which do not.
9477 (You might think it would be useful to generalize this to allow each
9478 compiler's spec to say which switches take arguments.  But this cannot
9479 be done in a consistent fashion.  GCC cannot even decide which input
9480 files have been specified without knowing which switches take arguments,
9481 and it must know which input files to compile in order to tell which
9482 compilers to run).
9483
9484 GCC also knows implicitly that arguments starting in @option{-l} are to be
9485 treated as compiler output files, and passed to the linker in their
9486 proper position among the other output files.
9487
9488 @c man begin OPTIONS
9489
9490 @node Target Options
9491 @section Specifying Target Machine and Compiler Version
9492 @cindex target options
9493 @cindex cross compiling
9494 @cindex specifying machine version
9495 @cindex specifying compiler version and target machine
9496 @cindex compiler version, specifying
9497 @cindex target machine, specifying
9498
9499 The usual way to run GCC is to run the executable called @file{gcc}, or
9500 @file{<machine>-gcc} when cross-compiling, or
9501 @file{<machine>-gcc-<version>} to run a version other than the one that
9502 was installed last.  Sometimes this is inconvenient, so GCC provides
9503 options that will switch to another cross-compiler or version.
9504
9505 @table @gcctabopt
9506 @item -b @var{machine}
9507 @opindex b
9508 The argument @var{machine} specifies the target machine for compilation.
9509
9510 The value to use for @var{machine} is the same as was specified as the
9511 machine type when configuring GCC as a cross-compiler.  For
9512 example, if a cross-compiler was configured with @samp{configure
9513 arm-elf}, meaning to compile for an arm processor with elf binaries,
9514 then you would specify @option{-b arm-elf} to run that cross compiler.
9515 Because there are other options beginning with @option{-b}, the
9516 configuration must contain a hyphen, or @option{-b} alone should be one
9517 argument followed by the configuration in the next argument.
9518
9519 @item -V @var{version}
9520 @opindex V
9521 The argument @var{version} specifies which version of GCC to run.
9522 This is useful when multiple versions are installed.  For example,
9523 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
9524 @end table
9525
9526 The @option{-V} and @option{-b} options work by running the
9527 @file{<machine>-gcc-<version>} executable, so there's no real reason to
9528 use them if you can just run that directly.
9529
9530 @node Submodel Options
9531 @section Hardware Models and Configurations
9532 @cindex submodel options
9533 @cindex specifying hardware config
9534 @cindex hardware models and configurations, specifying
9535 @cindex machine dependent options
9536
9537 Earlier we discussed the standard option @option{-b} which chooses among
9538 different installed compilers for completely different target
9539 machines, such as VAX vs.@: 68000 vs.@: 80386.
9540
9541 In addition, each of these target machine types can have its own
9542 special options, starting with @samp{-m}, to choose among various
9543 hardware models or configurations---for example, 68010 vs 68020,
9544 floating coprocessor or none.  A single installed version of the
9545 compiler can compile for any model or configuration, according to the
9546 options specified.
9547
9548 Some configurations of the compiler also support additional special
9549 options, usually for compatibility with other compilers on the same
9550 platform.
9551
9552 @c This list is ordered alphanumerically by subsection name.
9553 @c It should be the same order and spelling as these options are listed
9554 @c in Machine Dependent Options
9555
9556 @menu
9557 * ARC Options::
9558 * ARM Options::
9559 * AVR Options::
9560 * Blackfin Options::
9561 * CRIS Options::
9562 * CRX Options::
9563 * Darwin Options::
9564 * DEC Alpha Options::
9565 * DEC Alpha/VMS Options::
9566 * FR30 Options::
9567 * FRV Options::
9568 * GNU/Linux Options::
9569 * H8/300 Options::
9570 * HPPA Options::
9571 * i386 and x86-64 Options::
9572 * i386 and x86-64 Windows Options::
9573 * IA-64 Options::
9574 * IA-64/VMS Options::
9575 * LM32 Options::
9576 * M32C Options::
9577 * M32R/D Options::
9578 * M680x0 Options::
9579 * M68hc1x Options::
9580 * MCore Options::
9581 * MeP Options::
9582 * MIPS Options::
9583 * MMIX Options::
9584 * MN10300 Options::
9585 * PDP-11 Options::
9586 * picoChip Options::
9587 * PowerPC Options::
9588 * RS/6000 and PowerPC Options::
9589 * RX Options::
9590 * S/390 and zSeries Options::
9591 * Score Options::
9592 * SH Options::
9593 * SPARC Options::
9594 * SPU Options::
9595 * System V Options::
9596 * V850 Options::
9597 * VAX Options::
9598 * VxWorks Options::
9599 * x86-64 Options::
9600 * Xstormy16 Options::
9601 * Xtensa Options::
9602 * zSeries Options::
9603 @end menu
9604
9605 @node ARC Options
9606 @subsection ARC Options
9607 @cindex ARC Options
9608
9609 These options are defined for ARC implementations:
9610
9611 @table @gcctabopt
9612 @item -EL
9613 @opindex EL
9614 Compile code for little endian mode.  This is the default.
9615
9616 @item -EB
9617 @opindex EB
9618 Compile code for big endian mode.
9619
9620 @item -mmangle-cpu
9621 @opindex mmangle-cpu
9622 Prepend the name of the cpu to all public symbol names.
9623 In multiple-processor systems, there are many ARC variants with different
9624 instruction and register set characteristics.  This flag prevents code
9625 compiled for one cpu to be linked with code compiled for another.
9626 No facility exists for handling variants that are ``almost identical''.
9627 This is an all or nothing option.
9628
9629 @item -mcpu=@var{cpu}
9630 @opindex mcpu
9631 Compile code for ARC variant @var{cpu}.
9632 Which variants are supported depend on the configuration.
9633 All variants support @option{-mcpu=base}, this is the default.
9634
9635 @item -mtext=@var{text-section}
9636 @itemx -mdata=@var{data-section}
9637 @itemx -mrodata=@var{readonly-data-section}
9638 @opindex mtext
9639 @opindex mdata
9640 @opindex mrodata
9641 Put functions, data, and readonly data in @var{text-section},
9642 @var{data-section}, and @var{readonly-data-section} respectively
9643 by default.  This can be overridden with the @code{section} attribute.
9644 @xref{Variable Attributes}.
9645
9646 @item -mfix-cortex-m3-ldrd
9647 @opindex mfix-cortex-m3-ldrd
9648 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
9649 with overlapping destination and base registers are used.  This option avoids
9650 generating these instructions.  This option is enabled by default when
9651 @option{-mcpu=cortex-m3} is specified.
9652
9653 @end table
9654
9655 @node ARM Options
9656 @subsection ARM Options
9657 @cindex ARM options
9658
9659 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9660 architectures:
9661
9662 @table @gcctabopt
9663 @item -mabi=@var{name}
9664 @opindex mabi
9665 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9666 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9667
9668 @item -mapcs-frame
9669 @opindex mapcs-frame
9670 Generate a stack frame that is compliant with the ARM Procedure Call
9671 Standard for all functions, even if this is not strictly necessary for
9672 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9673 with this option will cause the stack frames not to be generated for
9674 leaf functions.  The default is @option{-mno-apcs-frame}.
9675
9676 @item -mapcs
9677 @opindex mapcs
9678 This is a synonym for @option{-mapcs-frame}.
9679
9680 @ignore
9681 @c not currently implemented
9682 @item -mapcs-stack-check
9683 @opindex mapcs-stack-check
9684 Generate code to check the amount of stack space available upon entry to
9685 every function (that actually uses some stack space).  If there is
9686 insufficient space available then either the function
9687 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9688 called, depending upon the amount of stack space required.  The run time
9689 system is required to provide these functions.  The default is
9690 @option{-mno-apcs-stack-check}, since this produces smaller code.
9691
9692 @c not currently implemented
9693 @item -mapcs-float
9694 @opindex mapcs-float
9695 Pass floating point arguments using the float point registers.  This is
9696 one of the variants of the APCS@.  This option is recommended if the
9697 target hardware has a floating point unit or if a lot of floating point
9698 arithmetic is going to be performed by the code.  The default is
9699 @option{-mno-apcs-float}, since integer only code is slightly increased in
9700 size if @option{-mapcs-float} is used.
9701
9702 @c not currently implemented
9703 @item -mapcs-reentrant
9704 @opindex mapcs-reentrant
9705 Generate reentrant, position independent code.  The default is
9706 @option{-mno-apcs-reentrant}.
9707 @end ignore
9708
9709 @item -mthumb-interwork
9710 @opindex mthumb-interwork
9711 Generate code which supports calling between the ARM and Thumb
9712 instruction sets.  Without this option the two instruction sets cannot
9713 be reliably used inside one program.  The default is
9714 @option{-mno-thumb-interwork}, since slightly larger code is generated
9715 when @option{-mthumb-interwork} is specified.
9716
9717 @item -mno-sched-prolog
9718 @opindex mno-sched-prolog
9719 Prevent the reordering of instructions in the function prolog, or the
9720 merging of those instruction with the instructions in the function's
9721 body.  This means that all functions will start with a recognizable set
9722 of instructions (or in fact one of a choice from a small set of
9723 different function prologues), and this information can be used to
9724 locate the start if functions inside an executable piece of code.  The
9725 default is @option{-msched-prolog}.
9726
9727 @item -mfloat-abi=@var{name}
9728 @opindex mfloat-abi
9729 Specifies which floating-point ABI to use.  Permissible values
9730 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9731
9732 Specifying @samp{soft} causes GCC to generate output containing
9733 library calls for floating-point operations.
9734 @samp{softfp} allows the generation of code using hardware floating-point
9735 instructions, but still uses the soft-float calling conventions.
9736 @samp{hard} allows generation of floating-point instructions
9737 and uses FPU-specific calling conventions.
9738
9739 The default depends on the specific target configuration.  Note that
9740 the hard-float and soft-float ABIs are not link-compatible; you must
9741 compile your entire program with the same ABI, and link with a
9742 compatible set of libraries.
9743
9744 @item -mhard-float
9745 @opindex mhard-float
9746 Equivalent to @option{-mfloat-abi=hard}.
9747
9748 @item -msoft-float
9749 @opindex msoft-float
9750 Equivalent to @option{-mfloat-abi=soft}.
9751
9752 @item -mlittle-endian
9753 @opindex mlittle-endian
9754 Generate code for a processor running in little-endian mode.  This is
9755 the default for all standard configurations.
9756
9757 @item -mbig-endian
9758 @opindex mbig-endian
9759 Generate code for a processor running in big-endian mode; the default is
9760 to compile code for a little-endian processor.
9761
9762 @item -mwords-little-endian
9763 @opindex mwords-little-endian
9764 This option only applies when generating code for big-endian processors.
9765 Generate code for a little-endian word order but a big-endian byte
9766 order.  That is, a byte order of the form @samp{32107654}.  Note: this
9767 option should only be used if you require compatibility with code for
9768 big-endian ARM processors generated by versions of the compiler prior to
9769 2.8.
9770
9771 @item -mcpu=@var{name}
9772 @opindex mcpu
9773 This specifies the name of the target ARM processor.  GCC uses this name
9774 to determine what kind of instructions it can emit when generating
9775 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
9776 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
9777 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
9778 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9779 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9780 @samp{arm720},
9781 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9782 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9783 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9784 @samp{strongarm1110},
9785 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9786 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9787 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9788 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9789 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9790 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9791 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9792 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9},
9793 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9794 @samp{cortex-m1},
9795 @samp{cortex-m0},
9796 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9797
9798 @item -mtune=@var{name}
9799 @opindex mtune
9800 This option is very similar to the @option{-mcpu=} option, except that
9801 instead of specifying the actual target processor type, and hence
9802 restricting which instructions can be used, it specifies that GCC should
9803 tune the performance of the code as if the target were of the type
9804 specified in this option, but still choosing the instructions that it
9805 will generate based on the cpu specified by a @option{-mcpu=} option.
9806 For some ARM implementations better performance can be obtained by using
9807 this option.
9808
9809 @item -march=@var{name}
9810 @opindex march
9811 This specifies the name of the target ARM architecture.  GCC uses this
9812 name to determine what kind of instructions it can emit when generating
9813 assembly code.  This option can be used in conjunction with or instead
9814 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9815 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9816 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9817 @samp{armv6}, @samp{armv6j},
9818 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9819 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9820 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9821
9822 @item -mfpu=@var{name}
9823 @itemx -mfpe=@var{number}
9824 @itemx -mfp=@var{number}
9825 @opindex mfpu
9826 @opindex mfpe
9827 @opindex mfp
9828 This specifies what floating point hardware (or hardware emulation) is
9829 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9830 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
9831 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
9832 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
9833 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
9834 @option{-mfp} and @option{-mfpe} are synonyms for
9835 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
9836 of GCC@.
9837
9838 If @option{-msoft-float} is specified this specifies the format of
9839 floating point values.
9840
9841 @item -mfp16-format=@var{name}
9842 @opindex mfp16-format
9843 Specify the format of the @code{__fp16} half-precision floating-point type.
9844 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
9845 the default is @samp{none}, in which case the @code{__fp16} type is not
9846 defined.  @xref{Half-Precision}, for more information.
9847
9848 @item -mstructure-size-boundary=@var{n}
9849 @opindex mstructure-size-boundary
9850 The size of all structures and unions will be rounded up to a multiple
9851 of the number of bits set by this option.  Permissible values are 8, 32
9852 and 64.  The default value varies for different toolchains.  For the COFF
9853 targeted toolchain the default value is 8.  A value of 64 is only allowed
9854 if the underlying ABI supports it.
9855
9856 Specifying the larger number can produce faster, more efficient code, but
9857 can also increase the size of the program.  Different values are potentially
9858 incompatible.  Code compiled with one value cannot necessarily expect to
9859 work with code or libraries compiled with another value, if they exchange
9860 information using structures or unions.
9861
9862 @item -mabort-on-noreturn
9863 @opindex mabort-on-noreturn
9864 Generate a call to the function @code{abort} at the end of a
9865 @code{noreturn} function.  It will be executed if the function tries to
9866 return.
9867
9868 @item -mlong-calls
9869 @itemx -mno-long-calls
9870 @opindex mlong-calls
9871 @opindex mno-long-calls
9872 Tells the compiler to perform function calls by first loading the
9873 address of the function into a register and then performing a subroutine
9874 call on this register.  This switch is needed if the target function
9875 will lie outside of the 64 megabyte addressing range of the offset based
9876 version of subroutine call instruction.
9877
9878 Even if this switch is enabled, not all function calls will be turned
9879 into long calls.  The heuristic is that static functions, functions
9880 which have the @samp{short-call} attribute, functions that are inside
9881 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9882 definitions have already been compiled within the current compilation
9883 unit, will not be turned into long calls.  The exception to this rule is
9884 that weak function definitions, functions with the @samp{long-call}
9885 attribute or the @samp{section} attribute, and functions that are within
9886 the scope of a @samp{#pragma long_calls} directive, will always be
9887 turned into long calls.
9888
9889 This feature is not enabled by default.  Specifying
9890 @option{-mno-long-calls} will restore the default behavior, as will
9891 placing the function calls within the scope of a @samp{#pragma
9892 long_calls_off} directive.  Note these switches have no effect on how
9893 the compiler generates code to handle function calls via function
9894 pointers.
9895
9896 @item -msingle-pic-base
9897 @opindex msingle-pic-base
9898 Treat the register used for PIC addressing as read-only, rather than
9899 loading it in the prologue for each function.  The run-time system is
9900 responsible for initializing this register with an appropriate value
9901 before execution begins.
9902
9903 @item -mpic-register=@var{reg}
9904 @opindex mpic-register
9905 Specify the register to be used for PIC addressing.  The default is R10
9906 unless stack-checking is enabled, when R9 is used.
9907
9908 @item -mcirrus-fix-invalid-insns
9909 @opindex mcirrus-fix-invalid-insns
9910 @opindex mno-cirrus-fix-invalid-insns
9911 Insert NOPs into the instruction stream to in order to work around
9912 problems with invalid Maverick instruction combinations.  This option
9913 is only valid if the @option{-mcpu=ep9312} option has been used to
9914 enable generation of instructions for the Cirrus Maverick floating
9915 point co-processor.  This option is not enabled by default, since the
9916 problem is only present in older Maverick implementations.  The default
9917 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
9918 switch.
9919
9920 @item -mpoke-function-name
9921 @opindex mpoke-function-name
9922 Write the name of each function into the text section, directly
9923 preceding the function prologue.  The generated code is similar to this:
9924
9925 @smallexample
9926      t0
9927          .ascii "arm_poke_function_name", 0
9928          .align
9929      t1
9930          .word 0xff000000 + (t1 - t0)
9931      arm_poke_function_name
9932          mov     ip, sp
9933          stmfd   sp!, @{fp, ip, lr, pc@}
9934          sub     fp, ip, #4
9935 @end smallexample
9936
9937 When performing a stack backtrace, code can inspect the value of
9938 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
9939 location @code{pc - 12} and the top 8 bits are set, then we know that
9940 there is a function name embedded immediately preceding this location
9941 and has length @code{((pc[-3]) & 0xff000000)}.
9942
9943 @item -mthumb
9944 @opindex mthumb
9945 Generate code for the Thumb instruction set.  The default is to
9946 use the 32-bit ARM instruction set.
9947 This option automatically enables either 16-bit Thumb-1 or
9948 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
9949 and @option{-march=@var{name}} options.  This option is not passed to the
9950 assembler. If you want to force assembler files to be interpreted as Thumb code,
9951 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
9952 option directly to the assembler by prefixing it with @option{-Wa}.
9953
9954 @item -mtpcs-frame
9955 @opindex mtpcs-frame
9956 Generate a stack frame that is compliant with the Thumb Procedure Call
9957 Standard for all non-leaf functions.  (A leaf function is one that does
9958 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
9959
9960 @item -mtpcs-leaf-frame
9961 @opindex mtpcs-leaf-frame
9962 Generate a stack frame that is compliant with the Thumb Procedure Call
9963 Standard for all leaf functions.  (A leaf function is one that does
9964 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
9965
9966 @item -mcallee-super-interworking
9967 @opindex mcallee-super-interworking
9968 Gives all externally visible functions in the file being compiled an ARM
9969 instruction set header which switches to Thumb mode before executing the
9970 rest of the function.  This allows these functions to be called from
9971 non-interworking code.  This option is not valid in AAPCS configurations
9972 because interworking is enabled by default.
9973
9974 @item -mcaller-super-interworking
9975 @opindex mcaller-super-interworking
9976 Allows calls via function pointers (including virtual functions) to
9977 execute correctly regardless of whether the target code has been
9978 compiled for interworking or not.  There is a small overhead in the cost
9979 of executing a function pointer if this option is enabled.  This option
9980 is not valid in AAPCS configurations because interworking is enabled
9981 by default.
9982
9983 @item -mtp=@var{name}
9984 @opindex mtp
9985 Specify the access model for the thread local storage pointer.  The valid
9986 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
9987 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
9988 (supported in the arm6k architecture), and @option{auto}, which uses the
9989 best available method for the selected processor.  The default setting is
9990 @option{auto}.
9991
9992 @item -mword-relocations
9993 @opindex mword-relocations
9994 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
9995 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
9996 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
9997 is specified.
9998
9999 @end table
10000
10001 @node AVR Options
10002 @subsection AVR Options
10003 @cindex AVR Options
10004
10005 These options are defined for AVR implementations:
10006
10007 @table @gcctabopt
10008 @item -mmcu=@var{mcu}
10009 @opindex mmcu
10010 Specify ATMEL AVR instruction set or MCU type.
10011
10012 Instruction set avr1 is for the minimal AVR core, not supported by the C
10013 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10014 attiny11, attiny12, attiny15, attiny28).
10015
10016 Instruction set avr2 (default) is for the classic AVR core with up to
10017 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10018 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10019 at90c8534, at90s8535).
10020
10021 Instruction set avr3 is for the classic AVR core with up to 128K program
10022 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10023
10024 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10025 memory space (MCU types: atmega8, atmega83, atmega85).
10026
10027 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10028 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10029 atmega64, atmega128, at43usb355, at94k).
10030
10031 @item -mno-interrupts
10032 @opindex mno-interrupts
10033 Generated code is not compatible with hardware interrupts.
10034 Code size will be smaller.
10035
10036 @item -mcall-prologues
10037 @opindex mcall-prologues
10038 Functions prologues/epilogues expanded as call to appropriate
10039 subroutines.  Code size will be smaller.
10040
10041 @item -mtiny-stack
10042 @opindex mtiny-stack
10043 Change only the low 8 bits of the stack pointer.
10044
10045 @item -mint8
10046 @opindex mint8
10047 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10048 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10049 and long long will be 4 bytes.  Please note that this option does not
10050 comply to the C standards, but it will provide you with smaller code
10051 size.
10052 @end table
10053
10054 @node Blackfin Options
10055 @subsection Blackfin Options
10056 @cindex Blackfin Options
10057
10058 @table @gcctabopt
10059 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10060 @opindex mcpu=
10061 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10062 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10063 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10064 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10065 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10066 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10067 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10068 @samp{bf561}.
10069 The optional @var{sirevision} specifies the silicon revision of the target
10070 Blackfin processor.  Any workarounds available for the targeted silicon revision
10071 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10072 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10073 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10074 hexadecimal digits representing the major and minor numbers in the silicon
10075 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10076 is not defined.  If @var{sirevision} is @samp{any}, the
10077 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10078 If this optional @var{sirevision} is not used, GCC assumes the latest known
10079 silicon revision of the targeted Blackfin processor.
10080
10081 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10082 Only the processor macro is defined.
10083 Without this option, @samp{bf532} is used as the processor by default.
10084 The corresponding predefined processor macros for @var{cpu} is to
10085 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10086 provided by libgloss to be linked in if @option{-msim} is not given.
10087
10088 @item -msim
10089 @opindex msim
10090 Specifies that the program will be run on the simulator.  This causes
10091 the simulator BSP provided by libgloss to be linked in.  This option
10092 has effect only for @samp{bfin-elf} toolchain.
10093 Certain other options, such as @option{-mid-shared-library} and
10094 @option{-mfdpic}, imply @option{-msim}.
10095
10096 @item -momit-leaf-frame-pointer
10097 @opindex momit-leaf-frame-pointer
10098 Don't keep the frame pointer in a register for leaf functions.  This
10099 avoids the instructions to save, set up and restore frame pointers and
10100 makes an extra register available in leaf functions.  The option
10101 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10102 which might make debugging harder.
10103
10104 @item -mspecld-anomaly
10105 @opindex mspecld-anomaly
10106 When enabled, the compiler will ensure that the generated code does not
10107 contain speculative loads after jump instructions. If this option is used,
10108 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10109
10110 @item -mno-specld-anomaly
10111 @opindex mno-specld-anomaly
10112 Don't generate extra code to prevent speculative loads from occurring.
10113
10114 @item -mcsync-anomaly
10115 @opindex mcsync-anomaly
10116 When enabled, the compiler will ensure that the generated code does not
10117 contain CSYNC or SSYNC instructions too soon after conditional branches.
10118 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10119
10120 @item -mno-csync-anomaly
10121 @opindex mno-csync-anomaly
10122 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10123 occurring too soon after a conditional branch.
10124
10125 @item -mlow-64k
10126 @opindex mlow-64k
10127 When enabled, the compiler is free to take advantage of the knowledge that
10128 the entire program fits into the low 64k of memory.
10129
10130 @item -mno-low-64k
10131 @opindex mno-low-64k
10132 Assume that the program is arbitrarily large.  This is the default.
10133
10134 @item -mstack-check-l1
10135 @opindex mstack-check-l1
10136 Do stack checking using information placed into L1 scratchpad memory by the
10137 uClinux kernel.
10138
10139 @item -mid-shared-library
10140 @opindex mid-shared-library
10141 Generate code that supports shared libraries via the library ID method.
10142 This allows for execute in place and shared libraries in an environment
10143 without virtual memory management.  This option implies @option{-fPIC}.
10144 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10145
10146 @item -mno-id-shared-library
10147 @opindex mno-id-shared-library
10148 Generate code that doesn't assume ID based shared libraries are being used.
10149 This is the default.
10150
10151 @item -mleaf-id-shared-library
10152 @opindex mleaf-id-shared-library
10153 Generate code that supports shared libraries via the library ID method,
10154 but assumes that this library or executable won't link against any other
10155 ID shared libraries.  That allows the compiler to use faster code for jumps
10156 and calls.
10157
10158 @item -mno-leaf-id-shared-library
10159 @opindex mno-leaf-id-shared-library
10160 Do not assume that the code being compiled won't link against any ID shared
10161 libraries.  Slower code will be generated for jump and call insns.
10162
10163 @item -mshared-library-id=n
10164 @opindex mshared-library-id
10165 Specified the identification number of the ID based shared library being
10166 compiled.  Specifying a value of 0 will generate more compact code, specifying
10167 other values will force the allocation of that number to the current
10168 library but is no more space or time efficient than omitting this option.
10169
10170 @item -msep-data
10171 @opindex msep-data
10172 Generate code that allows the data segment to be located in a different
10173 area of memory from the text segment.  This allows for execute in place in
10174 an environment without virtual memory management by eliminating relocations
10175 against the text section.
10176
10177 @item -mno-sep-data
10178 @opindex mno-sep-data
10179 Generate code that assumes that the data segment follows the text segment.
10180 This is the default.
10181
10182 @item -mlong-calls
10183 @itemx -mno-long-calls
10184 @opindex mlong-calls
10185 @opindex mno-long-calls
10186 Tells the compiler to perform function calls by first loading the
10187 address of the function into a register and then performing a subroutine
10188 call on this register.  This switch is needed if the target function
10189 will lie outside of the 24 bit addressing range of the offset based
10190 version of subroutine call instruction.
10191
10192 This feature is not enabled by default.  Specifying
10193 @option{-mno-long-calls} will restore the default behavior.  Note these
10194 switches have no effect on how the compiler generates code to handle
10195 function calls via function pointers.
10196
10197 @item -mfast-fp
10198 @opindex mfast-fp
10199 Link with the fast floating-point library. This library relaxes some of
10200 the IEEE floating-point standard's rules for checking inputs against
10201 Not-a-Number (NAN), in the interest of performance.
10202
10203 @item -minline-plt
10204 @opindex minline-plt
10205 Enable inlining of PLT entries in function calls to functions that are
10206 not known to bind locally.  It has no effect without @option{-mfdpic}.
10207
10208 @item -mmulticore
10209 @opindex mmulticore
10210 Build standalone application for multicore Blackfin processor. Proper
10211 start files and link scripts will be used to support multicore.
10212 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10213 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10214 @option{-mcorea} or @option{-mcoreb}. If it's used without
10215 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10216 programming model is used. In this model, the main function of Core B
10217 should be named as coreb_main. If it's used with @option{-mcorea} or
10218 @option{-mcoreb}, one application per core programming model is used.
10219 If this option is not used, single core application programming
10220 model is used.
10221
10222 @item -mcorea
10223 @opindex mcorea
10224 Build standalone application for Core A of BF561 when using
10225 one application per core programming model. Proper start files
10226 and link scripts will be used to support Core A. This option
10227 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10228
10229 @item -mcoreb
10230 @opindex mcoreb
10231 Build standalone application for Core B of BF561 when using
10232 one application per core programming model. Proper start files
10233 and link scripts will be used to support Core B. This option
10234 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10235 should be used instead of main. It must be used with
10236 @option{-mmulticore}.
10237
10238 @item -msdram
10239 @opindex msdram
10240 Build standalone application for SDRAM. Proper start files and
10241 link scripts will be used to put the application into SDRAM.
10242 Loader should initialize SDRAM before loading the application
10243 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10244
10245 @item -micplb
10246 @opindex micplb
10247 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10248 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10249 are enabled; for standalone applications the default is off.
10250 @end table
10251
10252 @node CRIS Options
10253 @subsection CRIS Options
10254 @cindex CRIS Options
10255
10256 These options are defined specifically for the CRIS ports.
10257
10258 @table @gcctabopt
10259 @item -march=@var{architecture-type}
10260 @itemx -mcpu=@var{architecture-type}
10261 @opindex march
10262 @opindex mcpu
10263 Generate code for the specified architecture.  The choices for
10264 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10265 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10266 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10267 @samp{v10}.
10268
10269 @item -mtune=@var{architecture-type}
10270 @opindex mtune
10271 Tune to @var{architecture-type} everything applicable about the generated
10272 code, except for the ABI and the set of available instructions.  The
10273 choices for @var{architecture-type} are the same as for
10274 @option{-march=@var{architecture-type}}.
10275
10276 @item -mmax-stack-frame=@var{n}
10277 @opindex mmax-stack-frame
10278 Warn when the stack frame of a function exceeds @var{n} bytes.
10279
10280 @item -metrax4
10281 @itemx -metrax100
10282 @opindex metrax4
10283 @opindex metrax100
10284 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10285 @option{-march=v3} and @option{-march=v8} respectively.
10286
10287 @item -mmul-bug-workaround
10288 @itemx -mno-mul-bug-workaround
10289 @opindex mmul-bug-workaround
10290 @opindex mno-mul-bug-workaround
10291 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10292 models where it applies.  This option is active by default.
10293
10294 @item -mpdebug
10295 @opindex mpdebug
10296 Enable CRIS-specific verbose debug-related information in the assembly
10297 code.  This option also has the effect to turn off the @samp{#NO_APP}
10298 formatted-code indicator to the assembler at the beginning of the
10299 assembly file.
10300
10301 @item -mcc-init
10302 @opindex mcc-init
10303 Do not use condition-code results from previous instruction; always emit
10304 compare and test instructions before use of condition codes.
10305
10306 @item -mno-side-effects
10307 @opindex mno-side-effects
10308 Do not emit instructions with side-effects in addressing modes other than
10309 post-increment.
10310
10311 @item -mstack-align
10312 @itemx -mno-stack-align
10313 @itemx -mdata-align
10314 @itemx -mno-data-align
10315 @itemx -mconst-align
10316 @itemx -mno-const-align
10317 @opindex mstack-align
10318 @opindex mno-stack-align
10319 @opindex mdata-align
10320 @opindex mno-data-align
10321 @opindex mconst-align
10322 @opindex mno-const-align
10323 These options (no-options) arranges (eliminate arrangements) for the
10324 stack-frame, individual data and constants to be aligned for the maximum
10325 single data access size for the chosen CPU model.  The default is to
10326 arrange for 32-bit alignment.  ABI details such as structure layout are
10327 not affected by these options.
10328
10329 @item -m32-bit
10330 @itemx -m16-bit
10331 @itemx -m8-bit
10332 @opindex m32-bit
10333 @opindex m16-bit
10334 @opindex m8-bit
10335 Similar to the stack- data- and const-align options above, these options
10336 arrange for stack-frame, writable data and constants to all be 32-bit,
10337 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10338
10339 @item -mno-prologue-epilogue
10340 @itemx -mprologue-epilogue
10341 @opindex mno-prologue-epilogue
10342 @opindex mprologue-epilogue
10343 With @option{-mno-prologue-epilogue}, the normal function prologue and
10344 epilogue that sets up the stack-frame are omitted and no return
10345 instructions or return sequences are generated in the code.  Use this
10346 option only together with visual inspection of the compiled code: no
10347 warnings or errors are generated when call-saved registers must be saved,
10348 or storage for local variable needs to be allocated.
10349
10350 @item -mno-gotplt
10351 @itemx -mgotplt
10352 @opindex mno-gotplt
10353 @opindex mgotplt
10354 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10355 instruction sequences that load addresses for functions from the PLT part
10356 of the GOT rather than (traditional on other architectures) calls to the
10357 PLT@.  The default is @option{-mgotplt}.
10358
10359 @item -melf
10360 @opindex melf
10361 Legacy no-op option only recognized with the cris-axis-elf and
10362 cris-axis-linux-gnu targets.
10363
10364 @item -mlinux
10365 @opindex mlinux
10366 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10367
10368 @item -sim
10369 @opindex sim
10370 This option, recognized for the cris-axis-elf arranges
10371 to link with input-output functions from a simulator library.  Code,
10372 initialized data and zero-initialized data are allocated consecutively.
10373
10374 @item -sim2
10375 @opindex sim2
10376 Like @option{-sim}, but pass linker options to locate initialized data at
10377 0x40000000 and zero-initialized data at 0x80000000.
10378 @end table
10379
10380 @node CRX Options
10381 @subsection CRX Options
10382 @cindex CRX Options
10383
10384 These options are defined specifically for the CRX ports.
10385
10386 @table @gcctabopt
10387
10388 @item -mmac
10389 @opindex mmac
10390 Enable the use of multiply-accumulate instructions. Disabled by default.
10391
10392 @item -mpush-args
10393 @opindex mpush-args
10394 Push instructions will be used to pass outgoing arguments when functions
10395 are called. Enabled by default.
10396 @end table
10397
10398 @node Darwin Options
10399 @subsection Darwin Options
10400 @cindex Darwin options
10401
10402 These options are defined for all architectures running the Darwin operating
10403 system.
10404
10405 FSF GCC on Darwin does not create ``fat'' object files; it will create
10406 an object file for the single architecture that it was built to
10407 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10408 @option{-arch} options are used; it does so by running the compiler or
10409 linker multiple times and joining the results together with
10410 @file{lipo}.
10411
10412 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10413 @samp{i686}) is determined by the flags that specify the ISA
10414 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10415 @option{-force_cpusubtype_ALL} option can be used to override this.
10416
10417 The Darwin tools vary in their behavior when presented with an ISA
10418 mismatch.  The assembler, @file{as}, will only permit instructions to
10419 be used that are valid for the subtype of the file it is generating,
10420 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10421 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10422 and print an error if asked to create a shared library with a less
10423 restrictive subtype than its input files (for instance, trying to put
10424 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10425 for executables, @file{ld}, will quietly give the executable the most
10426 restrictive subtype of any of its input files.
10427
10428 @table @gcctabopt
10429 @item -F@var{dir}
10430 @opindex F
10431 Add the framework directory @var{dir} to the head of the list of
10432 directories to be searched for header files.  These directories are
10433 interleaved with those specified by @option{-I} options and are
10434 scanned in a left-to-right order.
10435
10436 A framework directory is a directory with frameworks in it.  A
10437 framework is a directory with a @samp{"Headers"} and/or
10438 @samp{"PrivateHeaders"} directory contained directly in it that ends
10439 in @samp{".framework"}.  The name of a framework is the name of this
10440 directory excluding the @samp{".framework"}.  Headers associated with
10441 the framework are found in one of those two directories, with
10442 @samp{"Headers"} being searched first.  A subframework is a framework
10443 directory that is in a framework's @samp{"Frameworks"} directory.
10444 Includes of subframework headers can only appear in a header of a
10445 framework that contains the subframework, or in a sibling subframework
10446 header.  Two subframeworks are siblings if they occur in the same
10447 framework.  A subframework should not have the same name as a
10448 framework, a warning will be issued if this is violated.  Currently a
10449 subframework cannot have subframeworks, in the future, the mechanism
10450 may be extended to support this.  The standard frameworks can be found
10451 in @samp{"/System/Library/Frameworks"} and
10452 @samp{"/Library/Frameworks"}.  An example include looks like
10453 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10454 the name of the framework and header.h is found in the
10455 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10456
10457 @item -iframework@var{dir}
10458 @opindex iframework
10459 Like @option{-F} except the directory is a treated as a system
10460 directory.  The main difference between this @option{-iframework} and
10461 @option{-F} is that with @option{-iframework} the compiler does not
10462 warn about constructs contained within header files found via
10463 @var{dir}.  This option is valid only for the C family of languages.
10464
10465 @item -gused
10466 @opindex gused
10467 Emit debugging information for symbols that are used.  For STABS
10468 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10469 This is by default ON@.
10470
10471 @item -gfull
10472 @opindex gfull
10473 Emit debugging information for all symbols and types.
10474
10475 @item -mmacosx-version-min=@var{version}
10476 The earliest version of MacOS X that this executable will run on
10477 is @var{version}.  Typical values of @var{version} include @code{10.1},
10478 @code{10.2}, and @code{10.3.9}.
10479
10480 If the compiler was built to use the system's headers by default,
10481 then the default for this option is the system version on which the
10482 compiler is running, otherwise the default is to make choices which
10483 are compatible with as many systems and code bases as possible.
10484
10485 @item -mkernel
10486 @opindex mkernel
10487 Enable kernel development mode.  The @option{-mkernel} option sets
10488 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10489 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10490 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10491 applicable.  This mode also sets @option{-mno-altivec},
10492 @option{-msoft-float}, @option{-fno-builtin} and
10493 @option{-mlong-branch} for PowerPC targets.
10494
10495 @item -mone-byte-bool
10496 @opindex mone-byte-bool
10497 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10498 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10499 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10500 option has no effect on x86.
10501
10502 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10503 to generate code that is not binary compatible with code generated
10504 without that switch.  Using this switch may require recompiling all
10505 other modules in a program, including system libraries.  Use this
10506 switch to conform to a non-default data model.
10507
10508 @item -mfix-and-continue
10509 @itemx -ffix-and-continue
10510 @itemx -findirect-data
10511 @opindex mfix-and-continue
10512 @opindex ffix-and-continue
10513 @opindex findirect-data
10514 Generate code suitable for fast turn around development.  Needed to
10515 enable gdb to dynamically load @code{.o} files into already running
10516 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10517 are provided for backwards compatibility.
10518
10519 @item -all_load
10520 @opindex all_load
10521 Loads all members of static archive libraries.
10522 See man ld(1) for more information.
10523
10524 @item -arch_errors_fatal
10525 @opindex arch_errors_fatal
10526 Cause the errors having to do with files that have the wrong architecture
10527 to be fatal.
10528
10529 @item -bind_at_load
10530 @opindex bind_at_load
10531 Causes the output file to be marked such that the dynamic linker will
10532 bind all undefined references when the file is loaded or launched.
10533
10534 @item -bundle
10535 @opindex bundle
10536 Produce a Mach-o bundle format file.
10537 See man ld(1) for more information.
10538
10539 @item -bundle_loader @var{executable}
10540 @opindex bundle_loader
10541 This option specifies the @var{executable} that will be loading the build
10542 output file being linked.  See man ld(1) for more information.
10543
10544 @item -dynamiclib
10545 @opindex dynamiclib
10546 When passed this option, GCC will produce a dynamic library instead of
10547 an executable when linking, using the Darwin @file{libtool} command.
10548
10549 @item -force_cpusubtype_ALL
10550 @opindex force_cpusubtype_ALL
10551 This causes GCC's output file to have the @var{ALL} subtype, instead of
10552 one controlled by the @option{-mcpu} or @option{-march} option.
10553
10554 @item -allowable_client  @var{client_name}
10555 @itemx -client_name
10556 @itemx -compatibility_version
10557 @itemx -current_version
10558 @itemx -dead_strip
10559 @itemx -dependency-file
10560 @itemx -dylib_file
10561 @itemx -dylinker_install_name
10562 @itemx -dynamic
10563 @itemx -exported_symbols_list
10564 @itemx -filelist
10565 @itemx -flat_namespace
10566 @itemx -force_flat_namespace
10567 @itemx -headerpad_max_install_names
10568 @itemx -image_base
10569 @itemx -init
10570 @itemx -install_name
10571 @itemx -keep_private_externs
10572 @itemx -multi_module
10573 @itemx -multiply_defined
10574 @itemx -multiply_defined_unused
10575 @itemx -noall_load
10576 @itemx -no_dead_strip_inits_and_terms
10577 @itemx -nofixprebinding
10578 @itemx -nomultidefs
10579 @itemx -noprebind
10580 @itemx -noseglinkedit
10581 @itemx -pagezero_size
10582 @itemx -prebind
10583 @itemx -prebind_all_twolevel_modules
10584 @itemx -private_bundle
10585 @itemx -read_only_relocs
10586 @itemx -sectalign
10587 @itemx -sectobjectsymbols
10588 @itemx -whyload
10589 @itemx -seg1addr
10590 @itemx -sectcreate
10591 @itemx -sectobjectsymbols
10592 @itemx -sectorder
10593 @itemx -segaddr
10594 @itemx -segs_read_only_addr
10595 @itemx -segs_read_write_addr
10596 @itemx -seg_addr_table
10597 @itemx -seg_addr_table_filename
10598 @itemx -seglinkedit
10599 @itemx -segprot
10600 @itemx -segs_read_only_addr
10601 @itemx -segs_read_write_addr
10602 @itemx -single_module
10603 @itemx -static
10604 @itemx -sub_library
10605 @itemx -sub_umbrella
10606 @itemx -twolevel_namespace
10607 @itemx -umbrella
10608 @itemx -undefined
10609 @itemx -unexported_symbols_list
10610 @itemx -weak_reference_mismatches
10611 @itemx -whatsloaded
10612 @opindex allowable_client
10613 @opindex client_name
10614 @opindex compatibility_version
10615 @opindex current_version
10616 @opindex dead_strip
10617 @opindex dependency-file
10618 @opindex dylib_file
10619 @opindex dylinker_install_name
10620 @opindex dynamic
10621 @opindex exported_symbols_list
10622 @opindex filelist
10623 @opindex flat_namespace
10624 @opindex force_flat_namespace
10625 @opindex headerpad_max_install_names
10626 @opindex image_base
10627 @opindex init
10628 @opindex install_name
10629 @opindex keep_private_externs
10630 @opindex multi_module
10631 @opindex multiply_defined
10632 @opindex multiply_defined_unused
10633 @opindex noall_load
10634 @opindex no_dead_strip_inits_and_terms
10635 @opindex nofixprebinding
10636 @opindex nomultidefs
10637 @opindex noprebind
10638 @opindex noseglinkedit
10639 @opindex pagezero_size
10640 @opindex prebind
10641 @opindex prebind_all_twolevel_modules
10642 @opindex private_bundle
10643 @opindex read_only_relocs
10644 @opindex sectalign
10645 @opindex sectobjectsymbols
10646 @opindex whyload
10647 @opindex seg1addr
10648 @opindex sectcreate
10649 @opindex sectobjectsymbols
10650 @opindex sectorder
10651 @opindex segaddr
10652 @opindex segs_read_only_addr
10653 @opindex segs_read_write_addr
10654 @opindex seg_addr_table
10655 @opindex seg_addr_table_filename
10656 @opindex seglinkedit
10657 @opindex segprot
10658 @opindex segs_read_only_addr
10659 @opindex segs_read_write_addr
10660 @opindex single_module
10661 @opindex static
10662 @opindex sub_library
10663 @opindex sub_umbrella
10664 @opindex twolevel_namespace
10665 @opindex umbrella
10666 @opindex undefined
10667 @opindex unexported_symbols_list
10668 @opindex weak_reference_mismatches
10669 @opindex whatsloaded
10670 These options are passed to the Darwin linker.  The Darwin linker man page
10671 describes them in detail.
10672 @end table
10673
10674 @node DEC Alpha Options
10675 @subsection DEC Alpha Options
10676
10677 These @samp{-m} options are defined for the DEC Alpha implementations:
10678
10679 @table @gcctabopt
10680 @item -mno-soft-float
10681 @itemx -msoft-float
10682 @opindex mno-soft-float
10683 @opindex msoft-float
10684 Use (do not use) the hardware floating-point instructions for
10685 floating-point operations.  When @option{-msoft-float} is specified,
10686 functions in @file{libgcc.a} will be used to perform floating-point
10687 operations.  Unless they are replaced by routines that emulate the
10688 floating-point operations, or compiled in such a way as to call such
10689 emulations routines, these routines will issue floating-point
10690 operations.   If you are compiling for an Alpha without floating-point
10691 operations, you must ensure that the library is built so as not to call
10692 them.
10693
10694 Note that Alpha implementations without floating-point operations are
10695 required to have floating-point registers.
10696
10697 @item -mfp-reg
10698 @itemx -mno-fp-regs
10699 @opindex mfp-reg
10700 @opindex mno-fp-regs
10701 Generate code that uses (does not use) the floating-point register set.
10702 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10703 register set is not used, floating point operands are passed in integer
10704 registers as if they were integers and floating-point results are passed
10705 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10706 so any function with a floating-point argument or return value called by code
10707 compiled with @option{-mno-fp-regs} must also be compiled with that
10708 option.
10709
10710 A typical use of this option is building a kernel that does not use,
10711 and hence need not save and restore, any floating-point registers.
10712
10713 @item -mieee
10714 @opindex mieee
10715 The Alpha architecture implements floating-point hardware optimized for
10716 maximum performance.  It is mostly compliant with the IEEE floating
10717 point standard.  However, for full compliance, software assistance is
10718 required.  This option generates code fully IEEE compliant code
10719 @emph{except} that the @var{inexact-flag} is not maintained (see below).
10720 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
10721 defined during compilation.  The resulting code is less efficient but is
10722 able to correctly support denormalized numbers and exceptional IEEE
10723 values such as not-a-number and plus/minus infinity.  Other Alpha
10724 compilers call this option @option{-ieee_with_no_inexact}.
10725
10726 @item -mieee-with-inexact
10727 @opindex mieee-with-inexact
10728 This is like @option{-mieee} except the generated code also maintains
10729 the IEEE @var{inexact-flag}.  Turning on this option causes the
10730 generated code to implement fully-compliant IEEE math.  In addition to
10731 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
10732 macro.  On some Alpha implementations the resulting code may execute
10733 significantly slower than the code generated by default.  Since there is
10734 very little code that depends on the @var{inexact-flag}, you should
10735 normally not specify this option.  Other Alpha compilers call this
10736 option @option{-ieee_with_inexact}.
10737
10738 @item -mfp-trap-mode=@var{trap-mode}
10739 @opindex mfp-trap-mode
10740 This option controls what floating-point related traps are enabled.
10741 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
10742 The trap mode can be set to one of four values:
10743
10744 @table @samp
10745 @item n
10746 This is the default (normal) setting.  The only traps that are enabled
10747 are the ones that cannot be disabled in software (e.g., division by zero
10748 trap).
10749
10750 @item u
10751 In addition to the traps enabled by @samp{n}, underflow traps are enabled
10752 as well.
10753
10754 @item su
10755 Like @samp{u}, but the instructions are marked to be safe for software
10756 completion (see Alpha architecture manual for details).
10757
10758 @item sui
10759 Like @samp{su}, but inexact traps are enabled as well.
10760 @end table
10761
10762 @item -mfp-rounding-mode=@var{rounding-mode}
10763 @opindex mfp-rounding-mode
10764 Selects the IEEE rounding mode.  Other Alpha compilers call this option
10765 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
10766 of:
10767
10768 @table @samp
10769 @item n
10770 Normal IEEE rounding mode.  Floating point numbers are rounded towards
10771 the nearest machine number or towards the even machine number in case
10772 of a tie.
10773
10774 @item m
10775 Round towards minus infinity.
10776
10777 @item c
10778 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10779
10780 @item d
10781 Dynamic rounding mode.  A field in the floating point control register
10782 (@var{fpcr}, see Alpha architecture reference manual) controls the
10783 rounding mode in effect.  The C library initializes this register for
10784 rounding towards plus infinity.  Thus, unless your program modifies the
10785 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10786 @end table
10787
10788 @item -mtrap-precision=@var{trap-precision}
10789 @opindex mtrap-precision
10790 In the Alpha architecture, floating point traps are imprecise.  This
10791 means without software assistance it is impossible to recover from a
10792 floating trap and program execution normally needs to be terminated.
10793 GCC can generate code that can assist operating system trap handlers
10794 in determining the exact location that caused a floating point trap.
10795 Depending on the requirements of an application, different levels of
10796 precisions can be selected:
10797
10798 @table @samp
10799 @item p
10800 Program precision.  This option is the default and means a trap handler
10801 can only identify which program caused a floating point exception.
10802
10803 @item f
10804 Function precision.  The trap handler can determine the function that
10805 caused a floating point exception.
10806
10807 @item i
10808 Instruction precision.  The trap handler can determine the exact
10809 instruction that caused a floating point exception.
10810 @end table
10811
10812 Other Alpha compilers provide the equivalent options called
10813 @option{-scope_safe} and @option{-resumption_safe}.
10814
10815 @item -mieee-conformant
10816 @opindex mieee-conformant
10817 This option marks the generated code as IEEE conformant.  You must not
10818 use this option unless you also specify @option{-mtrap-precision=i} and either
10819 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10820 is to emit the line @samp{.eflag 48} in the function prologue of the
10821 generated assembly file.  Under DEC Unix, this has the effect that
10822 IEEE-conformant math library routines will be linked in.
10823
10824 @item -mbuild-constants
10825 @opindex mbuild-constants
10826 Normally GCC examines a 32- or 64-bit integer constant to
10827 see if it can construct it from smaller constants in two or three
10828 instructions.  If it cannot, it will output the constant as a literal and
10829 generate code to load it from the data segment at runtime.
10830
10831 Use this option to require GCC to construct @emph{all} integer constants
10832 using code, even if it takes more instructions (the maximum is six).
10833
10834 You would typically use this option to build a shared library dynamic
10835 loader.  Itself a shared library, it must relocate itself in memory
10836 before it can find the variables and constants in its own data segment.
10837
10838 @item -malpha-as
10839 @itemx -mgas
10840 @opindex malpha-as
10841 @opindex mgas
10842 Select whether to generate code to be assembled by the vendor-supplied
10843 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10844
10845 @item -mbwx
10846 @itemx -mno-bwx
10847 @itemx -mcix
10848 @itemx -mno-cix
10849 @itemx -mfix
10850 @itemx -mno-fix
10851 @itemx -mmax
10852 @itemx -mno-max
10853 @opindex mbwx
10854 @opindex mno-bwx
10855 @opindex mcix
10856 @opindex mno-cix
10857 @opindex mfix
10858 @opindex mno-fix
10859 @opindex mmax
10860 @opindex mno-max
10861 Indicate whether GCC should generate code to use the optional BWX,
10862 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10863 sets supported by the CPU type specified via @option{-mcpu=} option or that
10864 of the CPU on which GCC was built if none was specified.
10865
10866 @item -mfloat-vax
10867 @itemx -mfloat-ieee
10868 @opindex mfloat-vax
10869 @opindex mfloat-ieee
10870 Generate code that uses (does not use) VAX F and G floating point
10871 arithmetic instead of IEEE single and double precision.
10872
10873 @item -mexplicit-relocs
10874 @itemx -mno-explicit-relocs
10875 @opindex mexplicit-relocs
10876 @opindex mno-explicit-relocs
10877 Older Alpha assemblers provided no way to generate symbol relocations
10878 except via assembler macros.  Use of these macros does not allow
10879 optimal instruction scheduling.  GNU binutils as of version 2.12
10880 supports a new syntax that allows the compiler to explicitly mark
10881 which relocations should apply to which instructions.  This option
10882 is mostly useful for debugging, as GCC detects the capabilities of
10883 the assembler when it is built and sets the default accordingly.
10884
10885 @item -msmall-data
10886 @itemx -mlarge-data
10887 @opindex msmall-data
10888 @opindex mlarge-data
10889 When @option{-mexplicit-relocs} is in effect, static data is
10890 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10891 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
10892 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
10893 16-bit relocations off of the @code{$gp} register.  This limits the
10894 size of the small data area to 64KB, but allows the variables to be
10895 directly accessed via a single instruction.
10896
10897 The default is @option{-mlarge-data}.  With this option the data area
10898 is limited to just below 2GB@.  Programs that require more than 2GB of
10899 data must use @code{malloc} or @code{mmap} to allocate the data in the
10900 heap instead of in the program's data segment.
10901
10902 When generating code for shared libraries, @option{-fpic} implies
10903 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
10904
10905 @item -msmall-text
10906 @itemx -mlarge-text
10907 @opindex msmall-text
10908 @opindex mlarge-text
10909 When @option{-msmall-text} is used, the compiler assumes that the
10910 code of the entire program (or shared library) fits in 4MB, and is
10911 thus reachable with a branch instruction.  When @option{-msmall-data}
10912 is used, the compiler can assume that all local symbols share the
10913 same @code{$gp} value, and thus reduce the number of instructions
10914 required for a function call from 4 to 1.
10915
10916 The default is @option{-mlarge-text}.
10917
10918 @item -mcpu=@var{cpu_type}
10919 @opindex mcpu
10920 Set the instruction set and instruction scheduling parameters for
10921 machine type @var{cpu_type}.  You can specify either the @samp{EV}
10922 style name or the corresponding chip number.  GCC supports scheduling
10923 parameters for the EV4, EV5 and EV6 family of processors and will
10924 choose the default values for the instruction set from the processor
10925 you specify.  If you do not specify a processor type, GCC will default
10926 to the processor on which the compiler was built.
10927
10928 Supported values for @var{cpu_type} are
10929
10930 @table @samp
10931 @item ev4
10932 @itemx ev45
10933 @itemx 21064
10934 Schedules as an EV4 and has no instruction set extensions.
10935
10936 @item ev5
10937 @itemx 21164
10938 Schedules as an EV5 and has no instruction set extensions.
10939
10940 @item ev56
10941 @itemx 21164a
10942 Schedules as an EV5 and supports the BWX extension.
10943
10944 @item pca56
10945 @itemx 21164pc
10946 @itemx 21164PC
10947 Schedules as an EV5 and supports the BWX and MAX extensions.
10948
10949 @item ev6
10950 @itemx 21264
10951 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
10952
10953 @item ev67
10954 @itemx 21264a
10955 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
10956 @end table
10957
10958 Native Linux/GNU toolchains also support the value @samp{native},
10959 which selects the best architecture option for the host processor.
10960 @option{-mcpu=native} has no effect if GCC does not recognize
10961 the processor.
10962
10963 @item -mtune=@var{cpu_type}
10964 @opindex mtune
10965 Set only the instruction scheduling parameters for machine type
10966 @var{cpu_type}.  The instruction set is not changed.
10967
10968 Native Linux/GNU toolchains also support the value @samp{native},
10969 which selects the best architecture option for the host processor.
10970 @option{-mtune=native} has no effect if GCC does not recognize
10971 the processor.
10972
10973 @item -mmemory-latency=@var{time}
10974 @opindex mmemory-latency
10975 Sets the latency the scheduler should assume for typical memory
10976 references as seen by the application.  This number is highly
10977 dependent on the memory access patterns used by the application
10978 and the size of the external cache on the machine.
10979
10980 Valid options for @var{time} are
10981
10982 @table @samp
10983 @item @var{number}
10984 A decimal number representing clock cycles.
10985
10986 @item L1
10987 @itemx L2
10988 @itemx L3
10989 @itemx main
10990 The compiler contains estimates of the number of clock cycles for
10991 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
10992 (also called Dcache, Scache, and Bcache), as well as to main memory.
10993 Note that L3 is only valid for EV5.
10994
10995 @end table
10996 @end table
10997
10998 @node DEC Alpha/VMS Options
10999 @subsection DEC Alpha/VMS Options
11000
11001 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
11002
11003 @table @gcctabopt
11004 @item -mvms-return-codes
11005 @opindex mvms-return-codes
11006 Return VMS condition codes from main.  The default is to return POSIX
11007 style condition (e.g.@: error) codes.
11008
11009 @item -mdebug-main=@var{prefix}
11010 @opindex mdebug-main=@var{prefix}
11011 Flag the first routine whose name starts with @var{prefix} as the main
11012 routine for the debugger.
11013
11014 @item -mmalloc64
11015 @opindex mmalloc64
11016 Default to 64bit memory allocation routines.
11017 @end table
11018
11019 @node FR30 Options
11020 @subsection FR30 Options
11021 @cindex FR30 Options
11022
11023 These options are defined specifically for the FR30 port.
11024
11025 @table @gcctabopt
11026
11027 @item -msmall-model
11028 @opindex msmall-model
11029 Use the small address space model.  This can produce smaller code, but
11030 it does assume that all symbolic values and addresses will fit into a
11031 20-bit range.
11032
11033 @item -mno-lsim
11034 @opindex mno-lsim
11035 Assume that run-time support has been provided and so there is no need
11036 to include the simulator library (@file{libsim.a}) on the linker
11037 command line.
11038
11039 @end table
11040
11041 @node FRV Options
11042 @subsection FRV Options
11043 @cindex FRV Options
11044
11045 @table @gcctabopt
11046 @item -mgpr-32
11047 @opindex mgpr-32
11048
11049 Only use the first 32 general purpose registers.
11050
11051 @item -mgpr-64
11052 @opindex mgpr-64
11053
11054 Use all 64 general purpose registers.
11055
11056 @item -mfpr-32
11057 @opindex mfpr-32
11058
11059 Use only the first 32 floating point registers.
11060
11061 @item -mfpr-64
11062 @opindex mfpr-64
11063
11064 Use all 64 floating point registers
11065
11066 @item -mhard-float
11067 @opindex mhard-float
11068
11069 Use hardware instructions for floating point operations.
11070
11071 @item -msoft-float
11072 @opindex msoft-float
11073
11074 Use library routines for floating point operations.
11075
11076 @item -malloc-cc
11077 @opindex malloc-cc
11078
11079 Dynamically allocate condition code registers.
11080
11081 @item -mfixed-cc
11082 @opindex mfixed-cc
11083
11084 Do not try to dynamically allocate condition code registers, only
11085 use @code{icc0} and @code{fcc0}.
11086
11087 @item -mdword
11088 @opindex mdword
11089
11090 Change ABI to use double word insns.
11091
11092 @item -mno-dword
11093 @opindex mno-dword
11094
11095 Do not use double word instructions.
11096
11097 @item -mdouble
11098 @opindex mdouble
11099
11100 Use floating point double instructions.
11101
11102 @item -mno-double
11103 @opindex mno-double
11104
11105 Do not use floating point double instructions.
11106
11107 @item -mmedia
11108 @opindex mmedia
11109
11110 Use media instructions.
11111
11112 @item -mno-media
11113 @opindex mno-media
11114
11115 Do not use media instructions.
11116
11117 @item -mmuladd
11118 @opindex mmuladd
11119
11120 Use multiply and add/subtract instructions.
11121
11122 @item -mno-muladd
11123 @opindex mno-muladd
11124
11125 Do not use multiply and add/subtract instructions.
11126
11127 @item -mfdpic
11128 @opindex mfdpic
11129
11130 Select the FDPIC ABI, that uses function descriptors to represent
11131 pointers to functions.  Without any PIC/PIE-related options, it
11132 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11133 assumes GOT entries and small data are within a 12-bit range from the
11134 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11135 are computed with 32 bits.
11136 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11137
11138 @item -minline-plt
11139 @opindex minline-plt
11140
11141 Enable inlining of PLT entries in function calls to functions that are
11142 not known to bind locally.  It has no effect without @option{-mfdpic}.
11143 It's enabled by default if optimizing for speed and compiling for
11144 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11145 optimization option such as @option{-O3} or above is present in the
11146 command line.
11147
11148 @item -mTLS
11149 @opindex mTLS
11150
11151 Assume a large TLS segment when generating thread-local code.
11152
11153 @item -mtls
11154 @opindex mtls
11155
11156 Do not assume a large TLS segment when generating thread-local code.
11157
11158 @item -mgprel-ro
11159 @opindex mgprel-ro
11160
11161 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11162 that is known to be in read-only sections.  It's enabled by default,
11163 except for @option{-fpic} or @option{-fpie}: even though it may help
11164 make the global offset table smaller, it trades 1 instruction for 4.
11165 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11166 one of which may be shared by multiple symbols, and it avoids the need
11167 for a GOT entry for the referenced symbol, so it's more likely to be a
11168 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11169
11170 @item -multilib-library-pic
11171 @opindex multilib-library-pic
11172
11173 Link with the (library, not FD) pic libraries.  It's implied by
11174 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11175 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11176 it explicitly.
11177
11178 @item -mlinked-fp
11179 @opindex mlinked-fp
11180
11181 Follow the EABI requirement of always creating a frame pointer whenever
11182 a stack frame is allocated.  This option is enabled by default and can
11183 be disabled with @option{-mno-linked-fp}.
11184
11185 @item -mlong-calls
11186 @opindex mlong-calls
11187
11188 Use indirect addressing to call functions outside the current
11189 compilation unit.  This allows the functions to be placed anywhere
11190 within the 32-bit address space.
11191
11192 @item -malign-labels
11193 @opindex malign-labels
11194
11195 Try to align labels to an 8-byte boundary by inserting nops into the
11196 previous packet.  This option only has an effect when VLIW packing
11197 is enabled.  It doesn't create new packets; it merely adds nops to
11198 existing ones.
11199
11200 @item -mlibrary-pic
11201 @opindex mlibrary-pic
11202
11203 Generate position-independent EABI code.
11204
11205 @item -macc-4
11206 @opindex macc-4
11207
11208 Use only the first four media accumulator registers.
11209
11210 @item -macc-8
11211 @opindex macc-8
11212
11213 Use all eight media accumulator registers.
11214
11215 @item -mpack
11216 @opindex mpack
11217
11218 Pack VLIW instructions.
11219
11220 @item -mno-pack
11221 @opindex mno-pack
11222
11223 Do not pack VLIW instructions.
11224
11225 @item -mno-eflags
11226 @opindex mno-eflags
11227
11228 Do not mark ABI switches in e_flags.
11229
11230 @item -mcond-move
11231 @opindex mcond-move
11232
11233 Enable the use of conditional-move instructions (default).
11234
11235 This switch is mainly for debugging the compiler and will likely be removed
11236 in a future version.
11237
11238 @item -mno-cond-move
11239 @opindex mno-cond-move
11240
11241 Disable the use of conditional-move instructions.
11242
11243 This switch is mainly for debugging the compiler and will likely be removed
11244 in a future version.
11245
11246 @item -mscc
11247 @opindex mscc
11248
11249 Enable the use of conditional set instructions (default).
11250
11251 This switch is mainly for debugging the compiler and will likely be removed
11252 in a future version.
11253
11254 @item -mno-scc
11255 @opindex mno-scc
11256
11257 Disable the use of conditional set instructions.
11258
11259 This switch is mainly for debugging the compiler and will likely be removed
11260 in a future version.
11261
11262 @item -mcond-exec
11263 @opindex mcond-exec
11264
11265 Enable the use of conditional execution (default).
11266
11267 This switch is mainly for debugging the compiler and will likely be removed
11268 in a future version.
11269
11270 @item -mno-cond-exec
11271 @opindex mno-cond-exec
11272
11273 Disable the use of conditional execution.
11274
11275 This switch is mainly for debugging the compiler and will likely be removed
11276 in a future version.
11277
11278 @item -mvliw-branch
11279 @opindex mvliw-branch
11280
11281 Run a pass to pack branches into VLIW instructions (default).
11282
11283 This switch is mainly for debugging the compiler and will likely be removed
11284 in a future version.
11285
11286 @item -mno-vliw-branch
11287 @opindex mno-vliw-branch
11288
11289 Do not run a pass to pack branches into VLIW instructions.
11290
11291 This switch is mainly for debugging the compiler and will likely be removed
11292 in a future version.
11293
11294 @item -mmulti-cond-exec
11295 @opindex mmulti-cond-exec
11296
11297 Enable optimization of @code{&&} and @code{||} in conditional execution
11298 (default).
11299
11300 This switch is mainly for debugging the compiler and will likely be removed
11301 in a future version.
11302
11303 @item -mno-multi-cond-exec
11304 @opindex mno-multi-cond-exec
11305
11306 Disable optimization of @code{&&} and @code{||} in conditional execution.
11307
11308 This switch is mainly for debugging the compiler and will likely be removed
11309 in a future version.
11310
11311 @item -mnested-cond-exec
11312 @opindex mnested-cond-exec
11313
11314 Enable nested conditional execution optimizations (default).
11315
11316 This switch is mainly for debugging the compiler and will likely be removed
11317 in a future version.
11318
11319 @item -mno-nested-cond-exec
11320 @opindex mno-nested-cond-exec
11321
11322 Disable nested conditional execution optimizations.
11323
11324 This switch is mainly for debugging the compiler and will likely be removed
11325 in a future version.
11326
11327 @item -moptimize-membar
11328 @opindex moptimize-membar
11329
11330 This switch removes redundant @code{membar} instructions from the
11331 compiler generated code.  It is enabled by default.
11332
11333 @item -mno-optimize-membar
11334 @opindex mno-optimize-membar
11335
11336 This switch disables the automatic removal of redundant @code{membar}
11337 instructions from the generated code.
11338
11339 @item -mtomcat-stats
11340 @opindex mtomcat-stats
11341
11342 Cause gas to print out tomcat statistics.
11343
11344 @item -mcpu=@var{cpu}
11345 @opindex mcpu
11346
11347 Select the processor type for which to generate code.  Possible values are
11348 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11349 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11350
11351 @end table
11352
11353 @node GNU/Linux Options
11354 @subsection GNU/Linux Options
11355
11356 These @samp{-m} options are defined for GNU/Linux targets:
11357
11358 @table @gcctabopt
11359 @item -mglibc
11360 @opindex mglibc
11361 Use the GNU C library instead of uClibc.  This is the default except
11362 on @samp{*-*-linux-*uclibc*} targets.
11363
11364 @item -muclibc
11365 @opindex muclibc
11366 Use uClibc instead of the GNU C library.  This is the default on
11367 @samp{*-*-linux-*uclibc*} targets.
11368 @end table
11369
11370 @node H8/300 Options
11371 @subsection H8/300 Options
11372
11373 These @samp{-m} options are defined for the H8/300 implementations:
11374
11375 @table @gcctabopt
11376 @item -mrelax
11377 @opindex mrelax
11378 Shorten some address references at link time, when possible; uses the
11379 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11380 ld, Using ld}, for a fuller description.
11381
11382 @item -mh
11383 @opindex mh
11384 Generate code for the H8/300H@.
11385
11386 @item -ms
11387 @opindex ms
11388 Generate code for the H8S@.
11389
11390 @item -mn
11391 @opindex mn
11392 Generate code for the H8S and H8/300H in the normal mode.  This switch
11393 must be used either with @option{-mh} or @option{-ms}.
11394
11395 @item -ms2600
11396 @opindex ms2600
11397 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11398
11399 @item -mint32
11400 @opindex mint32
11401 Make @code{int} data 32 bits by default.
11402
11403 @item -malign-300
11404 @opindex malign-300
11405 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11406 The default for the H8/300H and H8S is to align longs and floats on 4
11407 byte boundaries.
11408 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11409 This option has no effect on the H8/300.
11410 @end table
11411
11412 @node HPPA Options
11413 @subsection HPPA Options
11414 @cindex HPPA Options
11415
11416 These @samp{-m} options are defined for the HPPA family of computers:
11417
11418 @table @gcctabopt
11419 @item -march=@var{architecture-type}
11420 @opindex march
11421 Generate code for the specified architecture.  The choices for
11422 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11423 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11424 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11425 architecture option for your machine.  Code compiled for lower numbered
11426 architectures will run on higher numbered architectures, but not the
11427 other way around.
11428
11429 @item -mpa-risc-1-0
11430 @itemx -mpa-risc-1-1
11431 @itemx -mpa-risc-2-0
11432 @opindex mpa-risc-1-0
11433 @opindex mpa-risc-1-1
11434 @opindex mpa-risc-2-0
11435 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11436
11437 @item -mbig-switch
11438 @opindex mbig-switch
11439 Generate code suitable for big switch tables.  Use this option only if
11440 the assembler/linker complain about out of range branches within a switch
11441 table.
11442
11443 @item -mjump-in-delay
11444 @opindex mjump-in-delay
11445 Fill delay slots of function calls with unconditional jump instructions
11446 by modifying the return pointer for the function call to be the target
11447 of the conditional jump.
11448
11449 @item -mdisable-fpregs
11450 @opindex mdisable-fpregs
11451 Prevent floating point registers from being used in any manner.  This is
11452 necessary for compiling kernels which perform lazy context switching of
11453 floating point registers.  If you use this option and attempt to perform
11454 floating point operations, the compiler will abort.
11455
11456 @item -mdisable-indexing
11457 @opindex mdisable-indexing
11458 Prevent the compiler from using indexing address modes.  This avoids some
11459 rather obscure problems when compiling MIG generated code under MACH@.
11460
11461 @item -mno-space-regs
11462 @opindex mno-space-regs
11463 Generate code that assumes the target has no space registers.  This allows
11464 GCC to generate faster indirect calls and use unscaled index address modes.
11465
11466 Such code is suitable for level 0 PA systems and kernels.
11467
11468 @item -mfast-indirect-calls
11469 @opindex mfast-indirect-calls
11470 Generate code that assumes calls never cross space boundaries.  This
11471 allows GCC to emit code which performs faster indirect calls.
11472
11473 This option will not work in the presence of shared libraries or nested
11474 functions.
11475
11476 @item -mfixed-range=@var{register-range}
11477 @opindex mfixed-range
11478 Generate code treating the given register range as fixed registers.
11479 A fixed register is one that the register allocator can not use.  This is
11480 useful when compiling kernel code.  A register range is specified as
11481 two registers separated by a dash.  Multiple register ranges can be
11482 specified separated by a comma.
11483
11484 @item -mlong-load-store
11485 @opindex mlong-load-store
11486 Generate 3-instruction load and store sequences as sometimes required by
11487 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11488 the HP compilers.
11489
11490 @item -mportable-runtime
11491 @opindex mportable-runtime
11492 Use the portable calling conventions proposed by HP for ELF systems.
11493
11494 @item -mgas
11495 @opindex mgas
11496 Enable the use of assembler directives only GAS understands.
11497
11498 @item -mschedule=@var{cpu-type}
11499 @opindex mschedule
11500 Schedule code according to the constraints for the machine type
11501 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11502 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11503 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11504 proper scheduling option for your machine.  The default scheduling is
11505 @samp{8000}.
11506
11507 @item -mlinker-opt
11508 @opindex mlinker-opt
11509 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11510 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11511 linkers in which they give bogus error messages when linking some programs.
11512
11513 @item -msoft-float
11514 @opindex msoft-float
11515 Generate output containing library calls for floating point.
11516 @strong{Warning:} the requisite libraries are not available for all HPPA
11517 targets.  Normally the facilities of the machine's usual C compiler are
11518 used, but this cannot be done directly in cross-compilation.  You must make
11519 your own arrangements to provide suitable library functions for
11520 cross-compilation.
11521
11522 @option{-msoft-float} changes the calling convention in the output file;
11523 therefore, it is only useful if you compile @emph{all} of a program with
11524 this option.  In particular, you need to compile @file{libgcc.a}, the
11525 library that comes with GCC, with @option{-msoft-float} in order for
11526 this to work.
11527
11528 @item -msio
11529 @opindex msio
11530 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11531 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11532 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11533 options are available under HP-UX and HI-UX@.
11534
11535 @item -mgnu-ld
11536 @opindex mgnu-ld
11537 Use GNU ld specific options.  This passes @option{-shared} to ld when
11538 building a shared library.  It is the default when GCC is configured,
11539 explicitly or implicitly, with the GNU linker.  This option does not
11540 have any affect on which ld is called, it only changes what parameters
11541 are passed to that ld.  The ld that is called is determined by the
11542 @option{--with-ld} configure option, GCC's program search path, and
11543 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11544 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11545 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11546
11547 @item -mhp-ld
11548 @opindex mhp-ld
11549 Use HP ld specific options.  This passes @option{-b} to ld when building
11550 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11551 links.  It is the default when GCC is configured, explicitly or
11552 implicitly, with the HP linker.  This option does not have any affect on
11553 which ld is called, it only changes what parameters are passed to that
11554 ld.  The ld that is called is determined by the @option{--with-ld}
11555 configure option, GCC's program search path, and finally by the user's
11556 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11557 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11558 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11559
11560 @item -mlong-calls
11561 @opindex mno-long-calls
11562 Generate code that uses long call sequences.  This ensures that a call
11563 is always able to reach linker generated stubs.  The default is to generate
11564 long calls only when the distance from the call site to the beginning
11565 of the function or translation unit, as the case may be, exceeds a
11566 predefined limit set by the branch type being used.  The limits for
11567 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11568 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11569 240,000 bytes.
11570
11571 Distances are measured from the beginning of functions when using the
11572 @option{-ffunction-sections} option, or when using the @option{-mgas}
11573 and @option{-mno-portable-runtime} options together under HP-UX with
11574 the SOM linker.
11575
11576 It is normally not desirable to use this option as it will degrade
11577 performance.  However, it may be useful in large applications,
11578 particularly when partial linking is used to build the application.
11579
11580 The types of long calls used depends on the capabilities of the
11581 assembler and linker, and the type of code being generated.  The
11582 impact on systems that support long absolute calls, and long pic
11583 symbol-difference or pc-relative calls should be relatively small.
11584 However, an indirect call is used on 32-bit ELF systems in pic code
11585 and it is quite long.
11586
11587 @item -munix=@var{unix-std}
11588 @opindex march
11589 Generate compiler predefines and select a startfile for the specified
11590 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11591 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11592 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11593 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11594 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11595 and later.
11596
11597 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11598 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11599 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11600 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11601 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11602 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11603
11604 It is @emph{important} to note that this option changes the interfaces
11605 for various library routines.  It also affects the operational behavior
11606 of the C library.  Thus, @emph{extreme} care is needed in using this
11607 option.
11608
11609 Library code that is intended to operate with more than one UNIX
11610 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11611 as appropriate.  Most GNU software doesn't provide this capability.
11612
11613 @item -nolibdld
11614 @opindex nolibdld
11615 Suppress the generation of link options to search libdld.sl when the
11616 @option{-static} option is specified on HP-UX 10 and later.
11617
11618 @item -static
11619 @opindex static
11620 The HP-UX implementation of setlocale in libc has a dependency on
11621 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11622 when the @option{-static} option is specified, special link options
11623 are needed to resolve this dependency.
11624
11625 On HP-UX 10 and later, the GCC driver adds the necessary options to
11626 link with libdld.sl when the @option{-static} option is specified.
11627 This causes the resulting binary to be dynamic.  On the 64-bit port,
11628 the linkers generate dynamic binaries by default in any case.  The
11629 @option{-nolibdld} option can be used to prevent the GCC driver from
11630 adding these link options.
11631
11632 @item -threads
11633 @opindex threads
11634 Add support for multithreading with the @dfn{dce thread} library
11635 under HP-UX@.  This option sets flags for both the preprocessor and
11636 linker.
11637 @end table
11638
11639 @node i386 and x86-64 Options
11640 @subsection Intel 386 and AMD x86-64 Options
11641 @cindex i386 Options
11642 @cindex x86-64 Options
11643 @cindex Intel 386 Options
11644 @cindex AMD x86-64 Options
11645
11646 These @samp{-m} options are defined for the i386 and x86-64 family of
11647 computers:
11648
11649 @table @gcctabopt
11650 @item -mtune=@var{cpu-type}
11651 @opindex mtune
11652 Tune to @var{cpu-type} everything applicable about the generated code, except
11653 for the ABI and the set of available instructions.  The choices for
11654 @var{cpu-type} are:
11655 @table @emph
11656 @item generic
11657 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11658 If you know the CPU on which your code will run, then you should use
11659 the corresponding @option{-mtune} option instead of
11660 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11661 of your application will have, then you should use this option.
11662
11663 As new processors are deployed in the marketplace, the behavior of this
11664 option will change.  Therefore, if you upgrade to a newer version of
11665 GCC, the code generated option will change to reflect the processors
11666 that were most common when that version of GCC was released.
11667
11668 There is no @option{-march=generic} option because @option{-march}
11669 indicates the instruction set the compiler can use, and there is no
11670 generic instruction set applicable to all processors.  In contrast,
11671 @option{-mtune} indicates the processor (or, in this case, collection of
11672 processors) for which the code is optimized.
11673 @item native
11674 This selects the CPU to tune for at compilation time by determining
11675 the processor type of the compiling machine.  Using @option{-mtune=native}
11676 will produce code optimized for the local machine under the constraints
11677 of the selected instruction set.  Using @option{-march=native} will
11678 enable all instruction subsets supported by the local machine (hence
11679 the result might not run on different machines).
11680 @item i386
11681 Original Intel's i386 CPU@.
11682 @item i486
11683 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11684 @item i586, pentium
11685 Intel Pentium CPU with no MMX support.
11686 @item pentium-mmx
11687 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11688 @item pentiumpro
11689 Intel PentiumPro CPU@.
11690 @item i686
11691 Same as @code{generic}, but when used as @code{march} option, PentiumPro
11692 instruction set will be used, so the code will run on all i686 family chips.
11693 @item pentium2
11694 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
11695 @item pentium3, pentium3m
11696 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
11697 support.
11698 @item pentium-m
11699 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
11700 support.  Used by Centrino notebooks.
11701 @item pentium4, pentium4m
11702 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
11703 @item prescott
11704 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
11705 set support.
11706 @item nocona
11707 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
11708 SSE2 and SSE3 instruction set support.
11709 @item core2
11710 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11711 instruction set support.
11712 @item atom
11713 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11714 instruction set support.
11715 @item k6
11716 AMD K6 CPU with MMX instruction set support.
11717 @item k6-2, k6-3
11718 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
11719 @item athlon, athlon-tbird
11720 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
11721 support.
11722 @item athlon-4, athlon-xp, athlon-mp
11723 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
11724 instruction set support.
11725 @item k8, opteron, athlon64, athlon-fx
11726 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
11727 MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit instruction set extensions.)
11728 @item k8-sse3, opteron-sse3, athlon64-sse3
11729 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
11730 @item amdfam10, barcelona
11731 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
11732 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
11733 instruction set extensions.)
11734 @item winchip-c6
11735 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
11736 set support.
11737 @item winchip2
11738 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
11739 instruction set support.
11740 @item c3
11741 Via C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
11742 implemented for this chip.)
11743 @item c3-2
11744 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
11745 implemented for this chip.)
11746 @item geode
11747 Embedded AMD CPU with MMX and 3DNow!@: instruction set support.
11748 @end table
11749
11750 While picking a specific @var{cpu-type} will schedule things appropriately
11751 for that particular chip, the compiler will not generate any code that
11752 does not run on the i386 without the @option{-march=@var{cpu-type}} option
11753 being used.
11754
11755 @item -march=@var{cpu-type}
11756 @opindex march
11757 Generate instructions for the machine type @var{cpu-type}.  The choices
11758 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
11759 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
11760
11761 @item -mcpu=@var{cpu-type}
11762 @opindex mcpu
11763 A deprecated synonym for @option{-mtune}.
11764
11765 @item -mfpmath=@var{unit}
11766 @opindex mfpmath
11767 Generate floating point arithmetics for selected unit @var{unit}.  The choices
11768 for @var{unit} are:
11769
11770 @table @samp
11771 @item 387
11772 Use the standard 387 floating point coprocessor present majority of chips and
11773 emulated otherwise.  Code compiled with this option will run almost everywhere.
11774 The temporary results are computed in 80bit precision instead of precision
11775 specified by the type resulting in slightly different results compared to most
11776 of other chips.  See @option{-ffloat-store} for more detailed description.
11777
11778 This is the default choice for i386 compiler.
11779
11780 @item sse
11781 Use scalar floating point instructions present in the SSE instruction set.
11782 This instruction set is supported by Pentium3 and newer chips, in the AMD line
11783 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
11784 instruction set supports only single precision arithmetics, thus the double and
11785 extended precision arithmetics is still done using 387.  Later version, present
11786 only in Pentium4 and the future AMD x86-64 chips supports double precision
11787 arithmetics too.
11788
11789 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
11790 or @option{-msse2} switches to enable SSE extensions and make this option
11791 effective.  For the x86-64 compiler, these extensions are enabled by default.
11792
11793 The resulting code should be considerably faster in the majority of cases and avoid
11794 the numerical instability problems of 387 code, but may break some existing
11795 code that expects temporaries to be 80bit.
11796
11797 This is the default choice for the x86-64 compiler.
11798
11799 @item sse,387
11800 @itemx sse+387
11801 @itemx both
11802 Attempt to utilize both instruction sets at once.  This effectively double the
11803 amount of available registers and on chips with separate execution units for
11804 387 and SSE the execution resources too.  Use this option with care, as it is
11805 still experimental, because the GCC register allocator does not model separate
11806 functional units well resulting in instable performance.
11807 @end table
11808
11809 @item -masm=@var{dialect}
11810 @opindex masm=@var{dialect}
11811 Output asm instructions using selected @var{dialect}.  Supported
11812 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
11813 not support @samp{intel}.
11814
11815 @item -mieee-fp
11816 @itemx -mno-ieee-fp
11817 @opindex mieee-fp
11818 @opindex mno-ieee-fp
11819 Control whether or not the compiler uses IEEE floating point
11820 comparisons.  These handle correctly the case where the result of a
11821 comparison is unordered.
11822
11823 @item -msoft-float
11824 @opindex msoft-float
11825 Generate output containing library calls for floating point.
11826 @strong{Warning:} the requisite libraries are not part of GCC@.
11827 Normally the facilities of the machine's usual C compiler are used, but
11828 this can't be done directly in cross-compilation.  You must make your
11829 own arrangements to provide suitable library functions for
11830 cross-compilation.
11831
11832 On machines where a function returns floating point results in the 80387
11833 register stack, some floating point opcodes may be emitted even if
11834 @option{-msoft-float} is used.
11835
11836 @item -mno-fp-ret-in-387
11837 @opindex mno-fp-ret-in-387
11838 Do not use the FPU registers for return values of functions.
11839
11840 The usual calling convention has functions return values of types
11841 @code{float} and @code{double} in an FPU register, even if there
11842 is no FPU@.  The idea is that the operating system should emulate
11843 an FPU@.
11844
11845 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11846 in ordinary CPU registers instead.
11847
11848 @item -mno-fancy-math-387
11849 @opindex mno-fancy-math-387
11850 Some 387 emulators do not support the @code{sin}, @code{cos} and
11851 @code{sqrt} instructions for the 387.  Specify this option to avoid
11852 generating those instructions.  This option is the default on FreeBSD,
11853 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11854 indicates that the target cpu will always have an FPU and so the
11855 instruction will not need emulation.  As of revision 2.6.1, these
11856 instructions are not generated unless you also use the
11857 @option{-funsafe-math-optimizations} switch.
11858
11859 @item -malign-double
11860 @itemx -mno-align-double
11861 @opindex malign-double
11862 @opindex mno-align-double
11863 Control whether GCC aligns @code{double}, @code{long double}, and
11864 @code{long long} variables on a two word boundary or a one word
11865 boundary.  Aligning @code{double} variables on a two word boundary will
11866 produce code that runs somewhat faster on a @samp{Pentium} at the
11867 expense of more memory.
11868
11869 On x86-64, @option{-malign-double} is enabled by default.
11870
11871 @strong{Warning:} if you use the @option{-malign-double} switch,
11872 structures containing the above types will be aligned differently than
11873 the published application binary interface specifications for the 386
11874 and will not be binary compatible with structures in code compiled
11875 without that switch.
11876
11877 @item -m96bit-long-double
11878 @itemx -m128bit-long-double
11879 @opindex m96bit-long-double
11880 @opindex m128bit-long-double
11881 These switches control the size of @code{long double} type.  The i386
11882 application binary interface specifies the size to be 96 bits,
11883 so @option{-m96bit-long-double} is the default in 32 bit mode.
11884
11885 Modern architectures (Pentium and newer) would prefer @code{long double}
11886 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11887 conforming to the ABI, this would not be possible.  So specifying a
11888 @option{-m128bit-long-double} will align @code{long double}
11889 to a 16 byte boundary by padding the @code{long double} with an additional
11890 32 bit zero.
11891
11892 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
11893 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
11894
11895 Notice that neither of these options enable any extra precision over the x87
11896 standard of 80 bits for a @code{long double}.
11897
11898 @strong{Warning:} if you override the default value for your target ABI, the
11899 structures and arrays containing @code{long double} variables will change
11900 their size as well as function calling convention for function taking
11901 @code{long double} will be modified.  Hence they will not be binary
11902 compatible with arrays or structures in code compiled without that switch.
11903
11904 @item -mlarge-data-threshold=@var{number}
11905 @opindex mlarge-data-threshold=@var{number}
11906 When @option{-mcmodel=medium} is specified, the data greater than
11907 @var{threshold} are placed in large data section.  This value must be the
11908 same across all object linked into the binary and defaults to 65535.
11909
11910 @item -mrtd
11911 @opindex mrtd
11912 Use a different function-calling convention, in which functions that
11913 take a fixed number of arguments return with the @code{ret} @var{num}
11914 instruction, which pops their arguments while returning.  This saves one
11915 instruction in the caller since there is no need to pop the arguments
11916 there.
11917
11918 You can specify that an individual function is called with this calling
11919 sequence with the function attribute @samp{stdcall}.  You can also
11920 override the @option{-mrtd} option by using the function attribute
11921 @samp{cdecl}.  @xref{Function Attributes}.
11922
11923 @strong{Warning:} this calling convention is incompatible with the one
11924 normally used on Unix, so you cannot use it if you need to call
11925 libraries compiled with the Unix compiler.
11926
11927 Also, you must provide function prototypes for all functions that
11928 take variable numbers of arguments (including @code{printf});
11929 otherwise incorrect code will be generated for calls to those
11930 functions.
11931
11932 In addition, seriously incorrect code will result if you call a
11933 function with too many arguments.  (Normally, extra arguments are
11934 harmlessly ignored.)
11935
11936 @item -mregparm=@var{num}
11937 @opindex mregparm
11938 Control how many registers are used to pass integer arguments.  By
11939 default, no registers are used to pass arguments, and at most 3
11940 registers can be used.  You can control this behavior for a specific
11941 function by using the function attribute @samp{regparm}.
11942 @xref{Function Attributes}.
11943
11944 @strong{Warning:} if you use this switch, and
11945 @var{num} is nonzero, then you must build all modules with the same
11946 value, including any libraries.  This includes the system libraries and
11947 startup modules.
11948
11949 @item -msseregparm
11950 @opindex msseregparm
11951 Use SSE register passing conventions for float and double arguments
11952 and return values.  You can control this behavior for a specific
11953 function by using the function attribute @samp{sseregparm}.
11954 @xref{Function Attributes}.
11955
11956 @strong{Warning:} if you use this switch then you must build all
11957 modules with the same value, including any libraries.  This includes
11958 the system libraries and startup modules.
11959
11960 @item -mpc32
11961 @itemx -mpc64
11962 @itemx -mpc80
11963 @opindex mpc32
11964 @opindex mpc64
11965 @opindex mpc80
11966
11967 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
11968 is specified, the significands of results of floating-point operations are
11969 rounded to 24 bits (single precision); @option{-mpc64} rounds the
11970 significands of results of floating-point operations to 53 bits (double
11971 precision) and @option{-mpc80} rounds the significands of results of
11972 floating-point operations to 64 bits (extended double precision), which is
11973 the default.  When this option is used, floating-point operations in higher
11974 precisions are not available to the programmer without setting the FPU
11975 control word explicitly.
11976
11977 Setting the rounding of floating-point operations to less than the default
11978 80 bits can speed some programs by 2% or more.  Note that some mathematical
11979 libraries assume that extended precision (80 bit) floating-point operations
11980 are enabled by default; routines in such libraries could suffer significant
11981 loss of accuracy, typically through so-called "catastrophic cancellation",
11982 when this option is used to set the precision to less than extended precision.
11983
11984 @item -mstackrealign
11985 @opindex mstackrealign
11986 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
11987 option will generate an alternate prologue and epilogue that realigns the
11988 runtime stack if necessary.  This supports mixing legacy codes that keep
11989 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
11990 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
11991 applicable to individual functions.
11992
11993 @item -mpreferred-stack-boundary=@var{num}
11994 @opindex mpreferred-stack-boundary
11995 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
11996 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
11997 the default is 4 (16 bytes or 128 bits).
11998
11999 @item -mincoming-stack-boundary=@var{num}
12000 @opindex mincoming-stack-boundary
12001 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
12002 boundary.  If @option{-mincoming-stack-boundary} is not specified,
12003 the one specified by @option{-mpreferred-stack-boundary} will be used.
12004
12005 On Pentium and PentiumPro, @code{double} and @code{long double} values
12006 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
12007 suffer significant run time performance penalties.  On Pentium III, the
12008 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
12009 properly if it is not 16 byte aligned.
12010
12011 To ensure proper alignment of this values on the stack, the stack boundary
12012 must be as aligned as that required by any value stored on the stack.
12013 Further, every function must be generated such that it keeps the stack
12014 aligned.  Thus calling a function compiled with a higher preferred
12015 stack boundary from a function compiled with a lower preferred stack
12016 boundary will most likely misalign the stack.  It is recommended that
12017 libraries that use callbacks always use the default setting.
12018
12019 This extra alignment does consume extra stack space, and generally
12020 increases code size.  Code that is sensitive to stack space usage, such
12021 as embedded systems and operating system kernels, may want to reduce the
12022 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12023
12024 @item -mmmx
12025 @itemx -mno-mmx
12026 @itemx -msse
12027 @itemx -mno-sse
12028 @itemx -msse2
12029 @itemx -mno-sse2
12030 @itemx -msse3
12031 @itemx -mno-sse3
12032 @itemx -mssse3
12033 @itemx -mno-ssse3
12034 @itemx -msse4.1
12035 @itemx -mno-sse4.1
12036 @itemx -msse4.2
12037 @itemx -mno-sse4.2
12038 @itemx -msse4
12039 @itemx -mno-sse4
12040 @itemx -mavx
12041 @itemx -mno-avx
12042 @itemx -maes
12043 @itemx -mno-aes
12044 @itemx -mpclmul
12045 @itemx -mno-pclmul
12046 @itemx -msse4a
12047 @itemx -mno-sse4a
12048 @itemx -mfma4
12049 @itemx -mno-fma4
12050 @itemx -mxop
12051 @itemx -mno-xop
12052 @itemx -mlwp
12053 @itemx -mno-lwp
12054 @itemx -m3dnow
12055 @itemx -mno-3dnow
12056 @itemx -mpopcnt
12057 @itemx -mno-popcnt
12058 @itemx -mabm
12059 @itemx -mno-abm
12060 @opindex mmmx
12061 @opindex mno-mmx
12062 @opindex msse
12063 @opindex mno-sse
12064 @opindex m3dnow
12065 @opindex mno-3dnow
12066 These switches enable or disable the use of instructions in the MMX,
12067 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, FMA4, XOP,
12068 LWP, ABM or 3DNow!@: extended instruction sets.
12069 These extensions are also available as built-in functions: see
12070 @ref{X86 Built-in Functions}, for details of the functions enabled and
12071 disabled by these switches.
12072
12073 To have SSE/SSE2 instructions generated automatically from floating-point
12074 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12075
12076 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12077 generates new AVX instructions or AVX equivalence for all SSEx instructions
12078 when needed.
12079
12080 These options will enable GCC to use these extended instructions in
12081 generated code, even without @option{-mfpmath=sse}.  Applications which
12082 perform runtime CPU detection must compile separate files for each
12083 supported architecture, using the appropriate flags.  In particular,
12084 the file containing the CPU detection code should be compiled without
12085 these options.
12086
12087 @item -mfused-madd
12088 @itemx -mno-fused-madd
12089 @opindex mfused-madd
12090 @opindex mno-fused-madd
12091 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12092 instructions.  The default is to use these instructions.
12093
12094 @item -mcld
12095 @opindex mcld
12096 This option instructs GCC to emit a @code{cld} instruction in the prologue
12097 of functions that use string instructions.  String instructions depend on
12098 the DF flag to select between autoincrement or autodecrement mode.  While the
12099 ABI specifies the DF flag to be cleared on function entry, some operating
12100 systems violate this specification by not clearing the DF flag in their
12101 exception dispatchers.  The exception handler can be invoked with the DF flag
12102 set which leads to wrong direction mode, when string instructions are used.
12103 This option can be enabled by default on 32-bit x86 targets by configuring
12104 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12105 instructions can be suppressed with the @option{-mno-cld} compiler option
12106 in this case.
12107
12108 @item -mcx16
12109 @opindex mcx16
12110 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12111 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12112 data types.  This is useful for high resolution counters that could be updated
12113 by multiple processors (or cores).  This instruction is generated as part of
12114 atomic built-in functions: see @ref{Atomic Builtins} for details.
12115
12116 @item -msahf
12117 @opindex msahf
12118 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12119 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12120 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12121 SAHF are load and store instructions, respectively, for certain status flags.
12122 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12123 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12124
12125 @item -mmovbe
12126 @opindex mmovbe
12127 This option will enable GCC to use movbe instruction to implement
12128 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12129
12130 @item -mcrc32
12131 @opindex mcrc32
12132 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12133 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12134 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12135
12136 @item -mrecip
12137 @opindex mrecip
12138 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12139 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12140 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12141 variants) for single precision floating point arguments.  These instructions
12142 are generated only when @option{-funsafe-math-optimizations} is enabled
12143 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12144 Note that while the throughput of the sequence is higher than the throughput
12145 of the non-reciprocal instruction, the precision of the sequence can be
12146 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12147
12148 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12149 already with @option{-ffast-math} (or the above option combination), and
12150 doesn't need @option{-mrecip}.
12151
12152 @item -mveclibabi=@var{type}
12153 @opindex mveclibabi
12154 Specifies the ABI type to use for vectorizing intrinsics using an
12155 external library.  Supported types are @code{svml} for the Intel short
12156 vector math library and @code{acml} for the AMD math core library style
12157 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12158 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12159 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12160 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12161 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12162 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12163 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12164 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12165 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12166 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12167 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12168 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12169 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12170 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12171 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12172 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12173 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12174 compatible library will have to be specified at link time.
12175
12176 @item -mabi=@var{name}
12177 @opindex mabi
12178 Generate code for the specified calling convention.  Permissible values
12179 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12180 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12181 ABI when targeting Windows.  On all other systems, the default is the
12182 SYSV ABI.  You can control this behavior for a specific function by
12183 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12184 @xref{Function Attributes}.
12185
12186 @item -mpush-args
12187 @itemx -mno-push-args
12188 @opindex mpush-args
12189 @opindex mno-push-args
12190 Use PUSH operations to store outgoing parameters.  This method is shorter
12191 and usually equally fast as method using SUB/MOV operations and is enabled
12192 by default.  In some cases disabling it may improve performance because of
12193 improved scheduling and reduced dependencies.
12194
12195 @item -maccumulate-outgoing-args
12196 @opindex maccumulate-outgoing-args
12197 If enabled, the maximum amount of space required for outgoing arguments will be
12198 computed in the function prologue.  This is faster on most modern CPUs
12199 because of reduced dependencies, improved scheduling and reduced stack usage
12200 when preferred stack boundary is not equal to 2.  The drawback is a notable
12201 increase in code size.  This switch implies @option{-mno-push-args}.
12202
12203 @item -mthreads
12204 @opindex mthreads
12205 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12206 on thread-safe exception handling must compile and link all code with the
12207 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12208 @option{-D_MT}; when linking, it links in a special thread helper library
12209 @option{-lmingwthrd} which cleans up per thread exception handling data.
12210
12211 @item -mno-align-stringops
12212 @opindex mno-align-stringops
12213 Do not align destination of inlined string operations.  This switch reduces
12214 code size and improves performance in case the destination is already aligned,
12215 but GCC doesn't know about it.
12216
12217 @item -minline-all-stringops
12218 @opindex minline-all-stringops
12219 By default GCC inlines string operations only when destination is known to be
12220 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12221 size, but may improve performance of code that depends on fast memcpy, strlen
12222 and memset for short lengths.
12223
12224 @item -minline-stringops-dynamically
12225 @opindex minline-stringops-dynamically
12226 For string operation of unknown size, inline runtime checks so for small
12227 blocks inline code is used, while for large blocks library call is used.
12228
12229 @item -mstringop-strategy=@var{alg}
12230 @opindex mstringop-strategy=@var{alg}
12231 Overwrite internal decision heuristic about particular algorithm to inline
12232 string operation with.  The allowed values are @code{rep_byte},
12233 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12234 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12235 expanding inline loop, @code{libcall} for always expanding library call.
12236
12237 @item -momit-leaf-frame-pointer
12238 @opindex momit-leaf-frame-pointer
12239 Don't keep the frame pointer in a register for leaf functions.  This
12240 avoids the instructions to save, set up and restore frame pointers and
12241 makes an extra register available in leaf functions.  The option
12242 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12243 which might make debugging harder.
12244
12245 @item -mtls-direct-seg-refs
12246 @itemx -mno-tls-direct-seg-refs
12247 @opindex mtls-direct-seg-refs
12248 Controls whether TLS variables may be accessed with offsets from the
12249 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12250 or whether the thread base pointer must be added.  Whether or not this
12251 is legal depends on the operating system, and whether it maps the
12252 segment to cover the entire TLS area.
12253
12254 For systems that use GNU libc, the default is on.
12255
12256 @item -msse2avx
12257 @itemx -mno-sse2avx
12258 @opindex msse2avx
12259 Specify that the assembler should encode SSE instructions with VEX
12260 prefix.  The option @option{-mavx} turns this on by default.
12261 @end table
12262
12263 These @samp{-m} switches are supported in addition to the above
12264 on AMD x86-64 processors in 64-bit environments.
12265
12266 @table @gcctabopt
12267 @item -m32
12268 @itemx -m64
12269 @opindex m32
12270 @opindex m64
12271 Generate code for a 32-bit or 64-bit environment.
12272 The 32-bit environment sets int, long and pointer to 32 bits and
12273 generates code that runs on any i386 system.
12274 The 64-bit environment sets int to 32 bits and long and pointer
12275 to 64 bits and generates code for AMD's x86-64 architecture. For
12276 darwin only the -m64 option turns off the @option{-fno-pic} and
12277 @option{-mdynamic-no-pic} options.
12278
12279 @item -mno-red-zone
12280 @opindex mno-red-zone
12281 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12282 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12283 stack pointer that will not be modified by signal or interrupt handlers
12284 and therefore can be used for temporary data without adjusting the stack
12285 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12286
12287 @item -mcmodel=small
12288 @opindex mcmodel=small
12289 Generate code for the small code model: the program and its symbols must
12290 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12291 Programs can be statically or dynamically linked.  This is the default
12292 code model.
12293
12294 @item -mcmodel=kernel
12295 @opindex mcmodel=kernel
12296 Generate code for the kernel code model.  The kernel runs in the
12297 negative 2 GB of the address space.
12298 This model has to be used for Linux kernel code.
12299
12300 @item -mcmodel=medium
12301 @opindex mcmodel=medium
12302 Generate code for the medium model: The program is linked in the lower 2
12303 GB of the address space.  Small symbols are also placed there.  Symbols
12304 with sizes larger than @option{-mlarge-data-threshold} are put into
12305 large data or bss sections and can be located above 2GB.  Programs can
12306 be statically or dynamically linked.
12307
12308 @item -mcmodel=large
12309 @opindex mcmodel=large
12310 Generate code for the large model: This model makes no assumptions
12311 about addresses and sizes of sections.
12312 @end table
12313
12314 @node IA-64 Options
12315 @subsection IA-64 Options
12316 @cindex IA-64 Options
12317
12318 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12319
12320 @table @gcctabopt
12321 @item -mbig-endian
12322 @opindex mbig-endian
12323 Generate code for a big endian target.  This is the default for HP-UX@.
12324
12325 @item -mlittle-endian
12326 @opindex mlittle-endian
12327 Generate code for a little endian target.  This is the default for AIX5
12328 and GNU/Linux.
12329
12330 @item -mgnu-as
12331 @itemx -mno-gnu-as
12332 @opindex mgnu-as
12333 @opindex mno-gnu-as
12334 Generate (or don't) code for the GNU assembler.  This is the default.
12335 @c Also, this is the default if the configure option @option{--with-gnu-as}
12336 @c is used.
12337
12338 @item -mgnu-ld
12339 @itemx -mno-gnu-ld
12340 @opindex mgnu-ld
12341 @opindex mno-gnu-ld
12342 Generate (or don't) code for the GNU linker.  This is the default.
12343 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12344 @c is used.
12345
12346 @item -mno-pic
12347 @opindex mno-pic
12348 Generate code that does not use a global pointer register.  The result
12349 is not position independent code, and violates the IA-64 ABI@.
12350
12351 @item -mvolatile-asm-stop
12352 @itemx -mno-volatile-asm-stop
12353 @opindex mvolatile-asm-stop
12354 @opindex mno-volatile-asm-stop
12355 Generate (or don't) a stop bit immediately before and after volatile asm
12356 statements.
12357
12358 @item -mregister-names
12359 @itemx -mno-register-names
12360 @opindex mregister-names
12361 @opindex mno-register-names
12362 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12363 the stacked registers.  This may make assembler output more readable.
12364
12365 @item -mno-sdata
12366 @itemx -msdata
12367 @opindex mno-sdata
12368 @opindex msdata
12369 Disable (or enable) optimizations that use the small data section.  This may
12370 be useful for working around optimizer bugs.
12371
12372 @item -mconstant-gp
12373 @opindex mconstant-gp
12374 Generate code that uses a single constant global pointer value.  This is
12375 useful when compiling kernel code.
12376
12377 @item -mauto-pic
12378 @opindex mauto-pic
12379 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12380 This is useful when compiling firmware code.
12381
12382 @item -minline-float-divide-min-latency
12383 @opindex minline-float-divide-min-latency
12384 Generate code for inline divides of floating point values
12385 using the minimum latency algorithm.
12386
12387 @item -minline-float-divide-max-throughput
12388 @opindex minline-float-divide-max-throughput
12389 Generate code for inline divides of floating point values
12390 using the maximum throughput algorithm.
12391
12392 @item -mno-inline-float-divide
12393 @opindex mno-inline-float-divide
12394 Do not generate inline code for divides of floating point values.
12395
12396 @item -minline-int-divide-min-latency
12397 @opindex minline-int-divide-min-latency
12398 Generate code for inline divides of integer values
12399 using the minimum latency algorithm.
12400
12401 @item -minline-int-divide-max-throughput
12402 @opindex minline-int-divide-max-throughput
12403 Generate code for inline divides of integer values
12404 using the maximum throughput algorithm.
12405
12406 @item -mno-inline-int-divide
12407 @opindex mno-inline-int-divide
12408 Do not generate inline code for divides of integer values.
12409
12410 @item -minline-sqrt-min-latency
12411 @opindex minline-sqrt-min-latency
12412 Generate code for inline square roots
12413 using the minimum latency algorithm.
12414
12415 @item -minline-sqrt-max-throughput
12416 @opindex minline-sqrt-max-throughput
12417 Generate code for inline square roots
12418 using the maximum throughput algorithm.
12419
12420 @item -mno-inline-sqrt
12421 @opindex mno-inline-sqrt
12422 Do not generate inline code for sqrt.
12423
12424 @item -mfused-madd
12425 @itemx -mno-fused-madd
12426 @opindex mfused-madd
12427 @opindex mno-fused-madd
12428 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12429 instructions.  The default is to use these instructions.
12430
12431 @item -mno-dwarf2-asm
12432 @itemx -mdwarf2-asm
12433 @opindex mno-dwarf2-asm
12434 @opindex mdwarf2-asm
12435 Don't (or do) generate assembler code for the DWARF2 line number debugging
12436 info.  This may be useful when not using the GNU assembler.
12437
12438 @item -mearly-stop-bits
12439 @itemx -mno-early-stop-bits
12440 @opindex mearly-stop-bits
12441 @opindex mno-early-stop-bits
12442 Allow stop bits to be placed earlier than immediately preceding the
12443 instruction that triggered the stop bit.  This can improve instruction
12444 scheduling, but does not always do so.
12445
12446 @item -mfixed-range=@var{register-range}
12447 @opindex mfixed-range
12448 Generate code treating the given register range as fixed registers.
12449 A fixed register is one that the register allocator can not use.  This is
12450 useful when compiling kernel code.  A register range is specified as
12451 two registers separated by a dash.  Multiple register ranges can be
12452 specified separated by a comma.
12453
12454 @item -mtls-size=@var{tls-size}
12455 @opindex mtls-size
12456 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12457 64.
12458
12459 @item -mtune=@var{cpu-type}
12460 @opindex mtune
12461 Tune the instruction scheduling for a particular CPU, Valid values are
12462 itanium, itanium1, merced, itanium2, and mckinley.
12463
12464 @item -milp32
12465 @itemx -mlp64
12466 @opindex milp32
12467 @opindex mlp64
12468 Generate code for a 32-bit or 64-bit environment.
12469 The 32-bit environment sets int, long and pointer to 32 bits.
12470 The 64-bit environment sets int to 32 bits and long and pointer
12471 to 64 bits.  These are HP-UX specific flags.
12472
12473 @item -mno-sched-br-data-spec
12474 @itemx -msched-br-data-spec
12475 @opindex mno-sched-br-data-spec
12476 @opindex msched-br-data-spec
12477 (Dis/En)able data speculative scheduling before reload.
12478 This will result in generation of the ld.a instructions and
12479 the corresponding check instructions (ld.c / chk.a).
12480 The default is 'disable'.
12481
12482 @item -msched-ar-data-spec
12483 @itemx -mno-sched-ar-data-spec
12484 @opindex msched-ar-data-spec
12485 @opindex mno-sched-ar-data-spec
12486 (En/Dis)able data speculative scheduling after reload.
12487 This will result in generation of the ld.a instructions and
12488 the corresponding check instructions (ld.c / chk.a).
12489 The default is 'enable'.
12490
12491 @item -mno-sched-control-spec
12492 @itemx -msched-control-spec
12493 @opindex mno-sched-control-spec
12494 @opindex msched-control-spec
12495 (Dis/En)able control speculative scheduling.  This feature is
12496 available only during region scheduling (i.e.@: before reload).
12497 This will result in generation of the ld.s instructions and
12498 the corresponding check instructions chk.s .
12499 The default is 'disable'.
12500
12501 @item -msched-br-in-data-spec
12502 @itemx -mno-sched-br-in-data-spec
12503 @opindex msched-br-in-data-spec
12504 @opindex mno-sched-br-in-data-spec
12505 (En/Dis)able speculative scheduling of the instructions that
12506 are dependent on the data speculative loads before reload.
12507 This is effective only with @option{-msched-br-data-spec} enabled.
12508 The default is 'enable'.
12509
12510 @item -msched-ar-in-data-spec
12511 @itemx -mno-sched-ar-in-data-spec
12512 @opindex msched-ar-in-data-spec
12513 @opindex mno-sched-ar-in-data-spec
12514 (En/Dis)able speculative scheduling of the instructions that
12515 are dependent on the data speculative loads after reload.
12516 This is effective only with @option{-msched-ar-data-spec} enabled.
12517 The default is 'enable'.
12518
12519 @item -msched-in-control-spec
12520 @itemx -mno-sched-in-control-spec
12521 @opindex msched-in-control-spec
12522 @opindex mno-sched-in-control-spec
12523 (En/Dis)able speculative scheduling of the instructions that
12524 are dependent on the control speculative loads.
12525 This is effective only with @option{-msched-control-spec} enabled.
12526 The default is 'enable'.
12527
12528 @item -mno-sched-prefer-non-data-spec-insns
12529 @itemx -msched-prefer-non-data-spec-insns
12530 @opindex mno-sched-prefer-non-data-spec-insns
12531 @opindex msched-prefer-non-data-spec-insns
12532 If enabled, data speculative instructions will be chosen for schedule
12533 only if there are no other choices at the moment.  This will make
12534 the use of the data speculation much more conservative.
12535 The default is 'disable'.
12536
12537 @item -mno-sched-prefer-non-control-spec-insns
12538 @itemx -msched-prefer-non-control-spec-insns
12539 @opindex mno-sched-prefer-non-control-spec-insns
12540 @opindex msched-prefer-non-control-spec-insns
12541 If enabled, control speculative instructions will be chosen for schedule
12542 only if there are no other choices at the moment.  This will make
12543 the use of the control speculation much more conservative.
12544 The default is 'disable'.
12545
12546 @item -mno-sched-count-spec-in-critical-path
12547 @itemx -msched-count-spec-in-critical-path
12548 @opindex mno-sched-count-spec-in-critical-path
12549 @opindex msched-count-spec-in-critical-path
12550 If enabled, speculative dependencies will be considered during
12551 computation of the instructions priorities.  This will make the use of the
12552 speculation a bit more conservative.
12553 The default is 'disable'.
12554
12555 @item -msched-spec-ldc
12556 @opindex msched-spec-ldc
12557 Use a simple data speculation check.  This option is on by default.
12558
12559 @item -msched-control-spec-ldc
12560 @opindex msched-spec-ldc
12561 Use a simple check for control speculation.  This option is on by default.
12562
12563 @item -msched-stop-bits-after-every-cycle
12564 @opindex msched-stop-bits-after-every-cycle
12565 Place a stop bit after every cycle when scheduling.  This option is on
12566 by default.
12567
12568 @item -msched-fp-mem-deps-zero-cost
12569 @opindex msched-fp-mem-deps-zero-cost
12570 Assume that floating-point stores and loads are not likely to cause a conflict
12571 when placed into the same instruction group.  This option is disabled by
12572 default.
12573
12574 @item -msel-sched-dont-check-control-spec
12575 @opindex msel-sched-dont-check-control-spec
12576 Generate checks for control speculation in selective scheduling.
12577 This flag is disabled by default.
12578
12579 @item -msched-max-memory-insns=@var{max-insns}
12580 @opindex msched-max-memory-insns
12581 Limit on the number of memory insns per instruction group, giving lower
12582 priority to subsequent memory insns attempting to schedule in the same
12583 instruction group. Frequently useful to prevent cache bank conflicts.
12584 The default value is 1.
12585
12586 @item -msched-max-memory-insns-hard-limit
12587 @opindex msched-max-memory-insns-hard-limit
12588 Disallow more than `msched-max-memory-insns' in instruction group.
12589 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12590 when limit is reached but may still schedule memory operations.
12591
12592 @end table
12593
12594 @node IA-64/VMS Options
12595 @subsection IA-64/VMS Options
12596
12597 These @samp{-m} options are defined for the IA-64/VMS implementations:
12598
12599 @table @gcctabopt
12600 @item -mvms-return-codes
12601 @opindex mvms-return-codes
12602 Return VMS condition codes from main. The default is to return POSIX
12603 style condition (e.g.@ error) codes.
12604
12605 @item -mdebug-main=@var{prefix}
12606 @opindex mdebug-main=@var{prefix}
12607 Flag the first routine whose name starts with @var{prefix} as the main
12608 routine for the debugger.
12609
12610 @item -mmalloc64
12611 @opindex mmalloc64
12612 Default to 64bit memory allocation routines.
12613 @end table
12614
12615 @node LM32 Options
12616 @subsection LM32 Options
12617 @cindex LM32 options
12618
12619 These @option{-m} options are defined for the Lattice Mico32 architecture:
12620
12621 @table @gcctabopt
12622 @item -mbarrel-shift-enabled
12623 @opindex mbarrel-shift-enabled
12624 Enable barrel-shift instructions.
12625
12626 @item -mdivide-enabled
12627 @opindex mdivide-enabled
12628 Enable divide and modulus instructions.
12629
12630 @item -mmultiply-enabled
12631 @opindex multiply-enabled
12632 Enable multiply instructions.
12633
12634 @item -msign-extend-enabled
12635 @opindex msign-extend-enabled
12636 Enable sign extend instructions.
12637
12638 @item -muser-enabled
12639 @opindex muser-enabled
12640 Enable user-defined instructions.
12641
12642 @end table
12643
12644 @node M32C Options
12645 @subsection M32C Options
12646 @cindex M32C options
12647
12648 @table @gcctabopt
12649 @item -mcpu=@var{name}
12650 @opindex mcpu=
12651 Select the CPU for which code is generated.  @var{name} may be one of
12652 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12653 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12654 the M32C/80 series.
12655
12656 @item -msim
12657 @opindex msim
12658 Specifies that the program will be run on the simulator.  This causes
12659 an alternate runtime library to be linked in which supports, for
12660 example, file I/O@.  You must not use this option when generating
12661 programs that will run on real hardware; you must provide your own
12662 runtime library for whatever I/O functions are needed.
12663
12664 @item -memregs=@var{number}
12665 @opindex memregs=
12666 Specifies the number of memory-based pseudo-registers GCC will use
12667 during code generation.  These pseudo-registers will be used like real
12668 registers, so there is a tradeoff between GCC's ability to fit the
12669 code into available registers, and the performance penalty of using
12670 memory instead of registers.  Note that all modules in a program must
12671 be compiled with the same value for this option.  Because of that, you
12672 must not use this option with the default runtime libraries gcc
12673 builds.
12674
12675 @end table
12676
12677 @node M32R/D Options
12678 @subsection M32R/D Options
12679 @cindex M32R/D options
12680
12681 These @option{-m} options are defined for Renesas M32R/D architectures:
12682
12683 @table @gcctabopt
12684 @item -m32r2
12685 @opindex m32r2
12686 Generate code for the M32R/2@.
12687
12688 @item -m32rx
12689 @opindex m32rx
12690 Generate code for the M32R/X@.
12691
12692 @item -m32r
12693 @opindex m32r
12694 Generate code for the M32R@.  This is the default.
12695
12696 @item -mmodel=small
12697 @opindex mmodel=small
12698 Assume all objects live in the lower 16MB of memory (so that their addresses
12699 can be loaded with the @code{ld24} instruction), and assume all subroutines
12700 are reachable with the @code{bl} instruction.
12701 This is the default.
12702
12703 The addressability of a particular object can be set with the
12704 @code{model} attribute.
12705
12706 @item -mmodel=medium
12707 @opindex mmodel=medium
12708 Assume objects may be anywhere in the 32-bit address space (the compiler
12709 will generate @code{seth/add3} instructions to load their addresses), and
12710 assume all subroutines are reachable with the @code{bl} instruction.
12711
12712 @item -mmodel=large
12713 @opindex mmodel=large
12714 Assume objects may be anywhere in the 32-bit address space (the compiler
12715 will generate @code{seth/add3} instructions to load their addresses), and
12716 assume subroutines may not be reachable with the @code{bl} instruction
12717 (the compiler will generate the much slower @code{seth/add3/jl}
12718 instruction sequence).
12719
12720 @item -msdata=none
12721 @opindex msdata=none
12722 Disable use of the small data area.  Variables will be put into
12723 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
12724 @code{section} attribute has been specified).
12725 This is the default.
12726
12727 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
12728 Objects may be explicitly put in the small data area with the
12729 @code{section} attribute using one of these sections.
12730
12731 @item -msdata=sdata
12732 @opindex msdata=sdata
12733 Put small global and static data in the small data area, but do not
12734 generate special code to reference them.
12735
12736 @item -msdata=use
12737 @opindex msdata=use
12738 Put small global and static data in the small data area, and generate
12739 special instructions to reference them.
12740
12741 @item -G @var{num}
12742 @opindex G
12743 @cindex smaller data references
12744 Put global and static objects less than or equal to @var{num} bytes
12745 into the small data or bss sections instead of the normal data or bss
12746 sections.  The default value of @var{num} is 8.
12747 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
12748 for this option to have any effect.
12749
12750 All modules should be compiled with the same @option{-G @var{num}} value.
12751 Compiling with different values of @var{num} may or may not work; if it
12752 doesn't the linker will give an error message---incorrect code will not be
12753 generated.
12754
12755 @item -mdebug
12756 @opindex mdebug
12757 Makes the M32R specific code in the compiler display some statistics
12758 that might help in debugging programs.
12759
12760 @item -malign-loops
12761 @opindex malign-loops
12762 Align all loops to a 32-byte boundary.
12763
12764 @item -mno-align-loops
12765 @opindex mno-align-loops
12766 Do not enforce a 32-byte alignment for loops.  This is the default.
12767
12768 @item -missue-rate=@var{number}
12769 @opindex missue-rate=@var{number}
12770 Issue @var{number} instructions per cycle.  @var{number} can only be 1
12771 or 2.
12772
12773 @item -mbranch-cost=@var{number}
12774 @opindex mbranch-cost=@var{number}
12775 @var{number} can only be 1 or 2.  If it is 1 then branches will be
12776 preferred over conditional code, if it is 2, then the opposite will
12777 apply.
12778
12779 @item -mflush-trap=@var{number}
12780 @opindex mflush-trap=@var{number}
12781 Specifies the trap number to use to flush the cache.  The default is
12782 12.  Valid numbers are between 0 and 15 inclusive.
12783
12784 @item -mno-flush-trap
12785 @opindex mno-flush-trap
12786 Specifies that the cache cannot be flushed by using a trap.
12787
12788 @item -mflush-func=@var{name}
12789 @opindex mflush-func=@var{name}
12790 Specifies the name of the operating system function to call to flush
12791 the cache.  The default is @emph{_flush_cache}, but a function call
12792 will only be used if a trap is not available.
12793
12794 @item -mno-flush-func
12795 @opindex mno-flush-func
12796 Indicates that there is no OS function for flushing the cache.
12797
12798 @end table
12799
12800 @node M680x0 Options
12801 @subsection M680x0 Options
12802 @cindex M680x0 options
12803
12804 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
12805 The default settings depend on which architecture was selected when
12806 the compiler was configured; the defaults for the most common choices
12807 are given below.
12808
12809 @table @gcctabopt
12810 @item -march=@var{arch}
12811 @opindex march
12812 Generate code for a specific M680x0 or ColdFire instruction set
12813 architecture.  Permissible values of @var{arch} for M680x0
12814 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
12815 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
12816 architectures are selected according to Freescale's ISA classification
12817 and the permissible values are: @samp{isaa}, @samp{isaaplus},
12818 @samp{isab} and @samp{isac}.
12819
12820 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
12821 code for a ColdFire target.  The @var{arch} in this macro is one of the
12822 @option{-march} arguments given above.
12823
12824 When used together, @option{-march} and @option{-mtune} select code
12825 that runs on a family of similar processors but that is optimized
12826 for a particular microarchitecture.
12827
12828 @item -mcpu=@var{cpu}
12829 @opindex mcpu
12830 Generate code for a specific M680x0 or ColdFire processor.
12831 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
12832 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
12833 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
12834 below, which also classifies the CPUs into families:
12835
12836 @multitable @columnfractions 0.20 0.80
12837 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
12838 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
12839 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
12840 @item @samp{5206e} @tab @samp{5206e}
12841 @item @samp{5208} @tab @samp{5207} @samp{5208}
12842 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
12843 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
12844 @item @samp{5216} @tab @samp{5214} @samp{5216}
12845 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
12846 @item @samp{5225} @tab @samp{5224} @samp{5225}
12847 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
12848 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
12849 @item @samp{5249} @tab @samp{5249}
12850 @item @samp{5250} @tab @samp{5250}
12851 @item @samp{5271} @tab @samp{5270} @samp{5271}
12852 @item @samp{5272} @tab @samp{5272}
12853 @item @samp{5275} @tab @samp{5274} @samp{5275}
12854 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
12855 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
12856 @item @samp{5307} @tab @samp{5307}
12857 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
12858 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
12859 @item @samp{5407} @tab @samp{5407}
12860 @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}
12861 @end multitable
12862
12863 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
12864 @var{arch} is compatible with @var{cpu}.  Other combinations of
12865 @option{-mcpu} and @option{-march} are rejected.
12866
12867 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
12868 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
12869 where the value of @var{family} is given by the table above.
12870
12871 @item -mtune=@var{tune}
12872 @opindex mtune
12873 Tune the code for a particular microarchitecture, within the
12874 constraints set by @option{-march} and @option{-mcpu}.
12875 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
12876 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
12877 and @samp{cpu32}.  The ColdFire microarchitectures
12878 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
12879
12880 You can also use @option{-mtune=68020-40} for code that needs
12881 to run relatively well on 68020, 68030 and 68040 targets.
12882 @option{-mtune=68020-60} is similar but includes 68060 targets
12883 as well.  These two options select the same tuning decisions as
12884 @option{-m68020-40} and @option{-m68020-60} respectively.
12885
12886 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
12887 when tuning for 680x0 architecture @var{arch}.  It also defines
12888 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
12889 option is used.  If gcc is tuning for a range of architectures,
12890 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
12891 it defines the macros for every architecture in the range.
12892
12893 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
12894 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
12895 of the arguments given above.
12896
12897 @item -m68000
12898 @itemx -mc68000
12899 @opindex m68000
12900 @opindex mc68000
12901 Generate output for a 68000.  This is the default
12902 when the compiler is configured for 68000-based systems.
12903 It is equivalent to @option{-march=68000}.
12904
12905 Use this option for microcontrollers with a 68000 or EC000 core,
12906 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
12907
12908 @item -m68010
12909 @opindex m68010
12910 Generate output for a 68010.  This is the default
12911 when the compiler is configured for 68010-based systems.
12912 It is equivalent to @option{-march=68010}.
12913
12914 @item -m68020
12915 @itemx -mc68020
12916 @opindex m68020
12917 @opindex mc68020
12918 Generate output for a 68020.  This is the default
12919 when the compiler is configured for 68020-based systems.
12920 It is equivalent to @option{-march=68020}.
12921
12922 @item -m68030
12923 @opindex m68030
12924 Generate output for a 68030.  This is the default when the compiler is
12925 configured for 68030-based systems.  It is equivalent to
12926 @option{-march=68030}.
12927
12928 @item -m68040
12929 @opindex m68040
12930 Generate output for a 68040.  This is the default when the compiler is
12931 configured for 68040-based systems.  It is equivalent to
12932 @option{-march=68040}.
12933
12934 This option inhibits the use of 68881/68882 instructions that have to be
12935 emulated by software on the 68040.  Use this option if your 68040 does not
12936 have code to emulate those instructions.
12937
12938 @item -m68060
12939 @opindex m68060
12940 Generate output for a 68060.  This is the default when the compiler is
12941 configured for 68060-based systems.  It is equivalent to
12942 @option{-march=68060}.
12943
12944 This option inhibits the use of 68020 and 68881/68882 instructions that
12945 have to be emulated by software on the 68060.  Use this option if your 68060
12946 does not have code to emulate those instructions.
12947
12948 @item -mcpu32
12949 @opindex mcpu32
12950 Generate output for a CPU32.  This is the default
12951 when the compiler is configured for CPU32-based systems.
12952 It is equivalent to @option{-march=cpu32}.
12953
12954 Use this option for microcontrollers with a
12955 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
12956 68336, 68340, 68341, 68349 and 68360.
12957
12958 @item -m5200
12959 @opindex m5200
12960 Generate output for a 520X ColdFire CPU@.  This is the default
12961 when the compiler is configured for 520X-based systems.
12962 It is equivalent to @option{-mcpu=5206}, and is now deprecated
12963 in favor of that option.
12964
12965 Use this option for microcontroller with a 5200 core, including
12966 the MCF5202, MCF5203, MCF5204 and MCF5206.
12967
12968 @item -m5206e
12969 @opindex m5206e
12970 Generate output for a 5206e ColdFire CPU@.  The option is now
12971 deprecated in favor of the equivalent @option{-mcpu=5206e}.
12972
12973 @item -m528x
12974 @opindex m528x
12975 Generate output for a member of the ColdFire 528X family.
12976 The option is now deprecated in favor of the equivalent
12977 @option{-mcpu=528x}.
12978
12979 @item -m5307
12980 @opindex m5307
12981 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
12982 in favor of the equivalent @option{-mcpu=5307}.
12983
12984 @item -m5407
12985 @opindex m5407
12986 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
12987 in favor of the equivalent @option{-mcpu=5407}.
12988
12989 @item -mcfv4e
12990 @opindex mcfv4e
12991 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
12992 This includes use of hardware floating point instructions.
12993 The option is equivalent to @option{-mcpu=547x}, and is now
12994 deprecated in favor of that option.
12995
12996 @item -m68020-40
12997 @opindex m68020-40
12998 Generate output for a 68040, without using any of the new instructions.
12999 This results in code which can run relatively efficiently on either a
13000 68020/68881 or a 68030 or a 68040.  The generated code does use the
13001 68881 instructions that are emulated on the 68040.
13002
13003 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
13004
13005 @item -m68020-60
13006 @opindex m68020-60
13007 Generate output for a 68060, without using any of the new instructions.
13008 This results in code which can run relatively efficiently on either a
13009 68020/68881 or a 68030 or a 68040.  The generated code does use the
13010 68881 instructions that are emulated on the 68060.
13011
13012 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
13013
13014 @item -mhard-float
13015 @itemx -m68881
13016 @opindex mhard-float
13017 @opindex m68881
13018 Generate floating-point instructions.  This is the default for 68020
13019 and above, and for ColdFire devices that have an FPU@.  It defines the
13020 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13021 on ColdFire targets.
13022
13023 @item -msoft-float
13024 @opindex msoft-float
13025 Do not generate floating-point instructions; use library calls instead.
13026 This is the default for 68000, 68010, and 68832 targets.  It is also
13027 the default for ColdFire devices that have no FPU.
13028
13029 @item -mdiv
13030 @itemx -mno-div
13031 @opindex mdiv
13032 @opindex mno-div
13033 Generate (do not generate) ColdFire hardware divide and remainder
13034 instructions.  If @option{-march} is used without @option{-mcpu},
13035 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13036 architectures.  Otherwise, the default is taken from the target CPU
13037 (either the default CPU, or the one specified by @option{-mcpu}).  For
13038 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13039 @option{-mcpu=5206e}.
13040
13041 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13042
13043 @item -mshort
13044 @opindex mshort
13045 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13046 Additionally, parameters passed on the stack are also aligned to a
13047 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13048
13049 @item -mno-short
13050 @opindex mno-short
13051 Do not consider type @code{int} to be 16 bits wide.  This is the default.
13052
13053 @item -mnobitfield
13054 @itemx -mno-bitfield
13055 @opindex mnobitfield
13056 @opindex mno-bitfield
13057 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
13058 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13059
13060 @item -mbitfield
13061 @opindex mbitfield
13062 Do use the bit-field instructions.  The @option{-m68020} option implies
13063 @option{-mbitfield}.  This is the default if you use a configuration
13064 designed for a 68020.
13065
13066 @item -mrtd
13067 @opindex mrtd
13068 Use a different function-calling convention, in which functions
13069 that take a fixed number of arguments return with the @code{rtd}
13070 instruction, which pops their arguments while returning.  This
13071 saves one instruction in the caller since there is no need to pop
13072 the arguments there.
13073
13074 This calling convention is incompatible with the one normally
13075 used on Unix, so you cannot use it if you need to call libraries
13076 compiled with the Unix compiler.
13077
13078 Also, you must provide function prototypes for all functions that
13079 take variable numbers of arguments (including @code{printf});
13080 otherwise incorrect code will be generated for calls to those
13081 functions.
13082
13083 In addition, seriously incorrect code will result if you call a
13084 function with too many arguments.  (Normally, extra arguments are
13085 harmlessly ignored.)
13086
13087 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13088 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13089
13090 @item -mno-rtd
13091 @opindex mno-rtd
13092 Do not use the calling conventions selected by @option{-mrtd}.
13093 This is the default.
13094
13095 @item -malign-int
13096 @itemx -mno-align-int
13097 @opindex malign-int
13098 @opindex mno-align-int
13099 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13100 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13101 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13102 Aligning variables on 32-bit boundaries produces code that runs somewhat
13103 faster on processors with 32-bit busses at the expense of more memory.
13104
13105 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13106 align structures containing the above types  differently than
13107 most published application binary interface specifications for the m68k.
13108
13109 @item -mpcrel
13110 @opindex mpcrel
13111 Use the pc-relative addressing mode of the 68000 directly, instead of
13112 using a global offset table.  At present, this option implies @option{-fpic},
13113 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13114 not presently supported with @option{-mpcrel}, though this could be supported for
13115 68020 and higher processors.
13116
13117 @item -mno-strict-align
13118 @itemx -mstrict-align
13119 @opindex mno-strict-align
13120 @opindex mstrict-align
13121 Do not (do) assume that unaligned memory references will be handled by
13122 the system.
13123
13124 @item -msep-data
13125 Generate code that allows the data segment to be located in a different
13126 area of memory from the text segment.  This allows for execute in place in
13127 an environment without virtual memory management.  This option implies
13128 @option{-fPIC}.
13129
13130 @item -mno-sep-data
13131 Generate code that assumes that the data segment follows the text segment.
13132 This is the default.
13133
13134 @item -mid-shared-library
13135 Generate code that supports shared libraries via the library ID method.
13136 This allows for execute in place and shared libraries in an environment
13137 without virtual memory management.  This option implies @option{-fPIC}.
13138
13139 @item -mno-id-shared-library
13140 Generate code that doesn't assume ID based shared libraries are being used.
13141 This is the default.
13142
13143 @item -mshared-library-id=n
13144 Specified the identification number of the ID based shared library being
13145 compiled.  Specifying a value of 0 will generate more compact code, specifying
13146 other values will force the allocation of that number to the current
13147 library but is no more space or time efficient than omitting this option.
13148
13149 @item -mxgot
13150 @itemx -mno-xgot
13151 @opindex mxgot
13152 @opindex mno-xgot
13153 When generating position-independent code for ColdFire, generate code
13154 that works if the GOT has more than 8192 entries.  This code is
13155 larger and slower than code generated without this option.  On M680x0
13156 processors, this option is not needed; @option{-fPIC} suffices.
13157
13158 GCC normally uses a single instruction to load values from the GOT@.
13159 While this is relatively efficient, it only works if the GOT
13160 is smaller than about 64k.  Anything larger causes the linker
13161 to report an error such as:
13162
13163 @cindex relocation truncated to fit (ColdFire)
13164 @smallexample
13165 relocation truncated to fit: R_68K_GOT16O foobar
13166 @end smallexample
13167
13168 If this happens, you should recompile your code with @option{-mxgot}.
13169 It should then work with very large GOTs.  However, code generated with
13170 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13171 the value of a global symbol.
13172
13173 Note that some linkers, including newer versions of the GNU linker,
13174 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13175 you should only need to use @option{-mxgot} when compiling a single
13176 object file that accesses more than 8192 GOT entries.  Very few do.
13177
13178 These options have no effect unless GCC is generating
13179 position-independent code.
13180
13181 @end table
13182
13183 @node M68hc1x Options
13184 @subsection M68hc1x Options
13185 @cindex M68hc1x options
13186
13187 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13188 microcontrollers.  The default values for these options depends on
13189 which style of microcontroller was selected when the compiler was configured;
13190 the defaults for the most common choices are given below.
13191
13192 @table @gcctabopt
13193 @item -m6811
13194 @itemx -m68hc11
13195 @opindex m6811
13196 @opindex m68hc11
13197 Generate output for a 68HC11.  This is the default
13198 when the compiler is configured for 68HC11-based systems.
13199
13200 @item -m6812
13201 @itemx -m68hc12
13202 @opindex m6812
13203 @opindex m68hc12
13204 Generate output for a 68HC12.  This is the default
13205 when the compiler is configured for 68HC12-based systems.
13206
13207 @item -m68S12
13208 @itemx -m68hcs12
13209 @opindex m68S12
13210 @opindex m68hcs12
13211 Generate output for a 68HCS12.
13212
13213 @item -mauto-incdec
13214 @opindex mauto-incdec
13215 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13216 addressing modes.
13217
13218 @item -minmax
13219 @itemx -mnominmax
13220 @opindex minmax
13221 @opindex mnominmax
13222 Enable the use of 68HC12 min and max instructions.
13223
13224 @item -mlong-calls
13225 @itemx -mno-long-calls
13226 @opindex mlong-calls
13227 @opindex mno-long-calls
13228 Treat all calls as being far away (near).  If calls are assumed to be
13229 far away, the compiler will use the @code{call} instruction to
13230 call a function and the @code{rtc} instruction for returning.
13231
13232 @item -mshort
13233 @opindex mshort
13234 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13235
13236 @item -msoft-reg-count=@var{count}
13237 @opindex msoft-reg-count
13238 Specify the number of pseudo-soft registers which are used for the
13239 code generation.  The maximum number is 32.  Using more pseudo-soft
13240 register may or may not result in better code depending on the program.
13241 The default is 4 for 68HC11 and 2 for 68HC12.
13242
13243 @end table
13244
13245 @node MCore Options
13246 @subsection MCore Options
13247 @cindex MCore options
13248
13249 These are the @samp{-m} options defined for the Motorola M*Core
13250 processors.
13251
13252 @table @gcctabopt
13253
13254 @item -mhardlit
13255 @itemx -mno-hardlit
13256 @opindex mhardlit
13257 @opindex mno-hardlit
13258 Inline constants into the code stream if it can be done in two
13259 instructions or less.
13260
13261 @item -mdiv
13262 @itemx -mno-div
13263 @opindex mdiv
13264 @opindex mno-div
13265 Use the divide instruction.  (Enabled by default).
13266
13267 @item -mrelax-immediate
13268 @itemx -mno-relax-immediate
13269 @opindex mrelax-immediate
13270 @opindex mno-relax-immediate
13271 Allow arbitrary sized immediates in bit operations.
13272
13273 @item -mwide-bitfields
13274 @itemx -mno-wide-bitfields
13275 @opindex mwide-bitfields
13276 @opindex mno-wide-bitfields
13277 Always treat bit-fields as int-sized.
13278
13279 @item -m4byte-functions
13280 @itemx -mno-4byte-functions
13281 @opindex m4byte-functions
13282 @opindex mno-4byte-functions
13283 Force all functions to be aligned to a four byte boundary.
13284
13285 @item -mcallgraph-data
13286 @itemx -mno-callgraph-data
13287 @opindex mcallgraph-data
13288 @opindex mno-callgraph-data
13289 Emit callgraph information.
13290
13291 @item -mslow-bytes
13292 @itemx -mno-slow-bytes
13293 @opindex mslow-bytes
13294 @opindex mno-slow-bytes
13295 Prefer word access when reading byte quantities.
13296
13297 @item -mlittle-endian
13298 @itemx -mbig-endian
13299 @opindex mlittle-endian
13300 @opindex mbig-endian
13301 Generate code for a little endian target.
13302
13303 @item -m210
13304 @itemx -m340
13305 @opindex m210
13306 @opindex m340
13307 Generate code for the 210 processor.
13308
13309 @item -mno-lsim
13310 @opindex mno-lsim
13311 Assume that run-time support has been provided and so omit the
13312 simulator library (@file{libsim.a)} from the linker command line.
13313
13314 @item -mstack-increment=@var{size}
13315 @opindex mstack-increment
13316 Set the maximum amount for a single stack increment operation.  Large
13317 values can increase the speed of programs which contain functions
13318 that need a large amount of stack space, but they can also trigger a
13319 segmentation fault if the stack is extended too much.  The default
13320 value is 0x1000.
13321
13322 @end table
13323
13324 @node MeP Options
13325 @subsection MeP Options
13326 @cindex MeP options
13327
13328 @table @gcctabopt
13329
13330 @item -mabsdiff
13331 @opindex mabsdiff
13332 Enables the @code{abs} instruction, which is the absolute difference
13333 between two registers.
13334
13335 @item -mall-opts
13336 @opindex mall-opts
13337 Enables all the optional instructions - average, multiply, divide, bit
13338 operations, leading zero, absolute difference, min/max, clip, and
13339 saturation.
13340
13341
13342 @item -maverage
13343 @opindex maverage
13344 Enables the @code{ave} instruction, which computes the average of two
13345 registers.
13346
13347 @item -mbased=@var{n}
13348 @opindex mbased=
13349 Variables of size @var{n} bytes or smaller will be placed in the
13350 @code{.based} section by default.  Based variables use the @code{$tp}
13351 register as a base register, and there is a 128 byte limit to the
13352 @code{.based} section.
13353
13354 @item -mbitops
13355 @opindex mbitops
13356 Enables the bit operation instructions - bit test (@code{btstm}), set
13357 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13358 test-and-set (@code{tas}).
13359
13360 @item -mc=@var{name}
13361 @opindex mc=
13362 Selects which section constant data will be placed in.  @var{name} may
13363 be @code{tiny}, @code{near}, or @code{far}.
13364
13365 @item -mclip
13366 @opindex mclip
13367 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13368 useful unless you also provide @code{-mminmax}.
13369
13370 @item -mconfig=@var{name}
13371 @opindex mconfig=
13372 Selects one of the build-in core configurations.  Each MeP chip has
13373 one or more modules in it; each module has a core CPU and a variety of
13374 coprocessors, optional instructions, and peripherals.  The
13375 @code{MeP-Integrator} tool, not part of GCC, provides these
13376 configurations through this option; using this option is the same as
13377 using all the corresponding command line options.  The default
13378 configuration is @code{default}.
13379
13380 @item -mcop
13381 @opindex mcop
13382 Enables the coprocessor instructions.  By default, this is a 32-bit
13383 coprocessor.  Note that the coprocessor is normally enabled via the
13384 @code{-mconfig=} option.
13385
13386 @item -mcop32
13387 @opindex mcop32
13388 Enables the 32-bit coprocessor's instructions.
13389
13390 @item -mcop64
13391 @opindex mcop64
13392 Enables the 64-bit coprocessor's instructions.
13393
13394 @item -mivc2
13395 @opindex mivc2
13396 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13397
13398 @item -mdc
13399 @opindex mdc
13400 Causes constant variables to be placed in the @code{.near} section.
13401
13402 @item -mdiv
13403 @opindex mdiv
13404 Enables the @code{div} and @code{divu} instructions.
13405
13406 @item -meb
13407 @opindex meb
13408 Generate big-endian code.
13409
13410 @item -mel
13411 @opindex mel
13412 Generate little-endian code.
13413
13414 @item -mio-volatile
13415 @opindex mio-volatile
13416 Tells the compiler that any variable marked with the @code{io}
13417 attribute is to be considered volatile.
13418
13419 @item -ml
13420 @opindex ml
13421 Causes variables to be assigned to the @code{.far} section by default.
13422
13423 @item -mleadz
13424 @opindex mleadz
13425 Enables the @code{leadz} (leading zero) instruction.
13426
13427 @item -mm
13428 @opindex mm
13429 Causes variables to be assigned to the @code{.near} section by default.
13430
13431 @item -mminmax
13432 @opindex mminmax
13433 Enables the @code{min} and @code{max} instructions.
13434
13435 @item -mmult
13436 @opindex mmult
13437 Enables the multiplication and multiply-accumulate instructions.
13438
13439 @item -mno-opts
13440 @opindex mno-opts
13441 Disables all the optional instructions enabled by @code{-mall-opts}.
13442
13443 @item -mrepeat
13444 @opindex mrepeat
13445 Enables the @code{repeat} and @code{erepeat} instructions, used for
13446 low-overhead looping.
13447
13448 @item -ms
13449 @opindex ms
13450 Causes all variables to default to the @code{.tiny} section.  Note
13451 that there is a 65536 byte limit to this section.  Accesses to these
13452 variables use the @code{%gp} base register.
13453
13454 @item -msatur
13455 @opindex msatur
13456 Enables the saturation instructions.  Note that the compiler does not
13457 currently generate these itself, but this option is included for
13458 compatibility with other tools, like @code{as}.
13459
13460 @item -msdram
13461 @opindex msdram
13462 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13463
13464 @item -msim
13465 @opindex msim
13466 Link the simulator runtime libraries.
13467
13468 @item -msimnovec
13469 @opindex msimnovec
13470 Link the simulator runtime libraries, excluding built-in support
13471 for reset and exception vectors and tables.
13472
13473 @item -mtf
13474 @opindex mtf
13475 Causes all functions to default to the @code{.far} section.  Without
13476 this option, functions default to the @code{.near} section.
13477
13478 @item -mtiny=@var{n}
13479 @opindex mtiny=
13480 Variables that are @var{n} bytes or smaller will be allocated to the
13481 @code{.tiny} section.  These variables use the @code{$gp} base
13482 register.  The default for this option is 4, but note that there's a
13483 65536 byte limit to the @code{.tiny} section.
13484
13485 @end table
13486
13487 @node MIPS Options
13488 @subsection MIPS Options
13489 @cindex MIPS options
13490
13491 @table @gcctabopt
13492
13493 @item -EB
13494 @opindex EB
13495 Generate big-endian code.
13496
13497 @item -EL
13498 @opindex EL
13499 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13500 configurations.
13501
13502 @item -march=@var{arch}
13503 @opindex march
13504 Generate code that will run on @var{arch}, which can be the name of a
13505 generic MIPS ISA, or the name of a particular processor.
13506 The ISA names are:
13507 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13508 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13509 The processor names are:
13510 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13511 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13512 @samp{5kc}, @samp{5kf},
13513 @samp{20kc},
13514 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13515 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13516 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13517 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13518 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13519 @samp{loongson2e}, @samp{loongson2f},
13520 @samp{m4k},
13521 @samp{octeon},
13522 @samp{orion},
13523 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13524 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13525 @samp{rm7000}, @samp{rm9000},
13526 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13527 @samp{sb1},
13528 @samp{sr71000},
13529 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13530 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13531 and @samp{xlr}.
13532 The special value @samp{from-abi} selects the
13533 most compatible architecture for the selected ABI (that is,
13534 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13535
13536 Native Linux/GNU toolchains also support the value @samp{native},
13537 which selects the best architecture option for the host processor.
13538 @option{-march=native} has no effect if GCC does not recognize
13539 the processor.
13540
13541 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13542 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13543 @samp{vr} may be written @samp{r}.
13544
13545 Names of the form @samp{@var{n}f2_1} refer to processors with
13546 FPUs clocked at half the rate of the core, names of the form
13547 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13548 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13549 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13550 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13551 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13552 accepted as synonyms for @samp{@var{n}f1_1}.
13553
13554 GCC defines two macros based on the value of this option.  The first
13555 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13556 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13557 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13558 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13559 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13560
13561 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13562 above.  In other words, it will have the full prefix and will not
13563 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13564 the macro names the resolved architecture (either @samp{"mips1"} or
13565 @samp{"mips3"}).  It names the default architecture when no
13566 @option{-march} option is given.
13567
13568 @item -mtune=@var{arch}
13569 @opindex mtune
13570 Optimize for @var{arch}.  Among other things, this option controls
13571 the way instructions are scheduled, and the perceived cost of arithmetic
13572 operations.  The list of @var{arch} values is the same as for
13573 @option{-march}.
13574
13575 When this option is not used, GCC will optimize for the processor
13576 specified by @option{-march}.  By using @option{-march} and
13577 @option{-mtune} together, it is possible to generate code that will
13578 run on a family of processors, but optimize the code for one
13579 particular member of that family.
13580
13581 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13582 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13583 @samp{-march} ones described above.
13584
13585 @item -mips1
13586 @opindex mips1
13587 Equivalent to @samp{-march=mips1}.
13588
13589 @item -mips2
13590 @opindex mips2
13591 Equivalent to @samp{-march=mips2}.
13592
13593 @item -mips3
13594 @opindex mips3
13595 Equivalent to @samp{-march=mips3}.
13596
13597 @item -mips4
13598 @opindex mips4
13599 Equivalent to @samp{-march=mips4}.
13600
13601 @item -mips32
13602 @opindex mips32
13603 Equivalent to @samp{-march=mips32}.
13604
13605 @item -mips32r2
13606 @opindex mips32r2
13607 Equivalent to @samp{-march=mips32r2}.
13608
13609 @item -mips64
13610 @opindex mips64
13611 Equivalent to @samp{-march=mips64}.
13612
13613 @item -mips64r2
13614 @opindex mips64r2
13615 Equivalent to @samp{-march=mips64r2}.
13616
13617 @item -mips16
13618 @itemx -mno-mips16
13619 @opindex mips16
13620 @opindex mno-mips16
13621 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13622 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13623
13624 MIPS16 code generation can also be controlled on a per-function basis
13625 by means of @code{mips16} and @code{nomips16} attributes.
13626 @xref{Function Attributes}, for more information.
13627
13628 @item -mflip-mips16
13629 @opindex mflip-mips16
13630 Generate MIPS16 code on alternating functions.  This option is provided
13631 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13632 not intended for ordinary use in compiling user code.
13633
13634 @item -minterlink-mips16
13635 @itemx -mno-interlink-mips16
13636 @opindex minterlink-mips16
13637 @opindex mno-interlink-mips16
13638 Require (do not require) that non-MIPS16 code be link-compatible with
13639 MIPS16 code.
13640
13641 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13642 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13643 therefore disables direct jumps unless GCC knows that the target of the
13644 jump is not MIPS16.
13645
13646 @item -mabi=32
13647 @itemx -mabi=o64
13648 @itemx -mabi=n32
13649 @itemx -mabi=64
13650 @itemx -mabi=eabi
13651 @opindex mabi=32
13652 @opindex mabi=o64
13653 @opindex mabi=n32
13654 @opindex mabi=64
13655 @opindex mabi=eabi
13656 Generate code for the given ABI@.
13657
13658 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13659 generates 64-bit code when you select a 64-bit architecture, but you
13660 can use @option{-mgp32} to get 32-bit code instead.
13661
13662 For information about the O64 ABI, see
13663 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13664
13665 GCC supports a variant of the o32 ABI in which floating-point registers
13666 are 64 rather than 32 bits wide.  You can select this combination with
13667 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13668 and @samp{mfhc1} instructions and is therefore only supported for
13669 MIPS32R2 processors.
13670
13671 The register assignments for arguments and return values remain the
13672 same, but each scalar value is passed in a single 64-bit register
13673 rather than a pair of 32-bit registers.  For example, scalar
13674 floating-point values are returned in @samp{$f0} only, not a
13675 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
13676 remains the same, but all 64 bits are saved.
13677
13678 @item -mabicalls
13679 @itemx -mno-abicalls
13680 @opindex mabicalls
13681 @opindex mno-abicalls
13682 Generate (do not generate) code that is suitable for SVR4-style
13683 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
13684 systems.
13685
13686 @item -mshared
13687 @itemx -mno-shared
13688 Generate (do not generate) code that is fully position-independent,
13689 and that can therefore be linked into shared libraries.  This option
13690 only affects @option{-mabicalls}.
13691
13692 All @option{-mabicalls} code has traditionally been position-independent,
13693 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
13694 as an extension, the GNU toolchain allows executables to use absolute
13695 accesses for locally-binding symbols.  It can also use shorter GP
13696 initialization sequences and generate direct calls to locally-defined
13697 functions.  This mode is selected by @option{-mno-shared}.
13698
13699 @option{-mno-shared} depends on binutils 2.16 or higher and generates
13700 objects that can only be linked by the GNU linker.  However, the option
13701 does not affect the ABI of the final executable; it only affects the ABI
13702 of relocatable objects.  Using @option{-mno-shared} will generally make
13703 executables both smaller and quicker.
13704
13705 @option{-mshared} is the default.
13706
13707 @item -mplt
13708 @itemx -mno-plt
13709 @opindex mplt
13710 @opindex mno-plt
13711 Assume (do not assume) that the static and dynamic linkers
13712 support PLTs and copy relocations.  This option only affects
13713 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
13714 has no effect without @samp{-msym32}.
13715
13716 You can make @option{-mplt} the default by configuring
13717 GCC with @option{--with-mips-plt}.  The default is
13718 @option{-mno-plt} otherwise.
13719
13720 @item -mxgot
13721 @itemx -mno-xgot
13722 @opindex mxgot
13723 @opindex mno-xgot
13724 Lift (do not lift) the usual restrictions on the size of the global
13725 offset table.
13726
13727 GCC normally uses a single instruction to load values from the GOT@.
13728 While this is relatively efficient, it will only work if the GOT
13729 is smaller than about 64k.  Anything larger will cause the linker
13730 to report an error such as:
13731
13732 @cindex relocation truncated to fit (MIPS)
13733 @smallexample
13734 relocation truncated to fit: R_MIPS_GOT16 foobar
13735 @end smallexample
13736
13737 If this happens, you should recompile your code with @option{-mxgot}.
13738 It should then work with very large GOTs, although it will also be
13739 less efficient, since it will take three instructions to fetch the
13740 value of a global symbol.
13741
13742 Note that some linkers can create multiple GOTs.  If you have such a
13743 linker, you should only need to use @option{-mxgot} when a single object
13744 file accesses more than 64k's worth of GOT entries.  Very few do.
13745
13746 These options have no effect unless GCC is generating position
13747 independent code.
13748
13749 @item -mgp32
13750 @opindex mgp32
13751 Assume that general-purpose registers are 32 bits wide.
13752
13753 @item -mgp64
13754 @opindex mgp64
13755 Assume that general-purpose registers are 64 bits wide.
13756
13757 @item -mfp32
13758 @opindex mfp32
13759 Assume that floating-point registers are 32 bits wide.
13760
13761 @item -mfp64
13762 @opindex mfp64
13763 Assume that floating-point registers are 64 bits wide.
13764
13765 @item -mhard-float
13766 @opindex mhard-float
13767 Use floating-point coprocessor instructions.
13768
13769 @item -msoft-float
13770 @opindex msoft-float
13771 Do not use floating-point coprocessor instructions.  Implement
13772 floating-point calculations using library calls instead.
13773
13774 @item -msingle-float
13775 @opindex msingle-float
13776 Assume that the floating-point coprocessor only supports single-precision
13777 operations.
13778
13779 @item -mdouble-float
13780 @opindex mdouble-float
13781 Assume that the floating-point coprocessor supports double-precision
13782 operations.  This is the default.
13783
13784 @item -mllsc
13785 @itemx -mno-llsc
13786 @opindex mllsc
13787 @opindex mno-llsc
13788 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
13789 implement atomic memory built-in functions.  When neither option is
13790 specified, GCC will use the instructions if the target architecture
13791 supports them.
13792
13793 @option{-mllsc} is useful if the runtime environment can emulate the
13794 instructions and @option{-mno-llsc} can be useful when compiling for
13795 nonstandard ISAs.  You can make either option the default by
13796 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
13797 respectively.  @option{--with-llsc} is the default for some
13798 configurations; see the installation documentation for details.
13799
13800 @item -mdsp
13801 @itemx -mno-dsp
13802 @opindex mdsp
13803 @opindex mno-dsp
13804 Use (do not use) revision 1 of the MIPS DSP ASE@.
13805 @xref{MIPS DSP Built-in Functions}.  This option defines the
13806 preprocessor macro @samp{__mips_dsp}.  It also defines
13807 @samp{__mips_dsp_rev} to 1.
13808
13809 @item -mdspr2
13810 @itemx -mno-dspr2
13811 @opindex mdspr2
13812 @opindex mno-dspr2
13813 Use (do not use) revision 2 of the MIPS DSP ASE@.
13814 @xref{MIPS DSP Built-in Functions}.  This option defines the
13815 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
13816 It also defines @samp{__mips_dsp_rev} to 2.
13817
13818 @item -msmartmips
13819 @itemx -mno-smartmips
13820 @opindex msmartmips
13821 @opindex mno-smartmips
13822 Use (do not use) the MIPS SmartMIPS ASE.
13823
13824 @item -mpaired-single
13825 @itemx -mno-paired-single
13826 @opindex mpaired-single
13827 @opindex mno-paired-single
13828 Use (do not use) paired-single floating-point instructions.
13829 @xref{MIPS Paired-Single Support}.  This option requires
13830 hardware floating-point support to be enabled.
13831
13832 @item -mdmx
13833 @itemx -mno-mdmx
13834 @opindex mdmx
13835 @opindex mno-mdmx
13836 Use (do not use) MIPS Digital Media Extension instructions.
13837 This option can only be used when generating 64-bit code and requires
13838 hardware floating-point support to be enabled.
13839
13840 @item -mips3d
13841 @itemx -mno-mips3d
13842 @opindex mips3d
13843 @opindex mno-mips3d
13844 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
13845 The option @option{-mips3d} implies @option{-mpaired-single}.
13846
13847 @item -mmt
13848 @itemx -mno-mt
13849 @opindex mmt
13850 @opindex mno-mt
13851 Use (do not use) MT Multithreading instructions.
13852
13853 @item -mlong64
13854 @opindex mlong64
13855 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
13856 an explanation of the default and the way that the pointer size is
13857 determined.
13858
13859 @item -mlong32
13860 @opindex mlong32
13861 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
13862
13863 The default size of @code{int}s, @code{long}s and pointers depends on
13864 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
13865 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
13866 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
13867 or the same size as integer registers, whichever is smaller.
13868
13869 @item -msym32
13870 @itemx -mno-sym32
13871 @opindex msym32
13872 @opindex mno-sym32
13873 Assume (do not assume) that all symbols have 32-bit values, regardless
13874 of the selected ABI@.  This option is useful in combination with
13875 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
13876 to generate shorter and faster references to symbolic addresses.
13877
13878 @item -G @var{num}
13879 @opindex G
13880 Put definitions of externally-visible data in a small data section
13881 if that data is no bigger than @var{num} bytes.  GCC can then access
13882 the data more efficiently; see @option{-mgpopt} for details.
13883
13884 The default @option{-G} option depends on the configuration.
13885
13886 @item -mlocal-sdata
13887 @itemx -mno-local-sdata
13888 @opindex mlocal-sdata
13889 @opindex mno-local-sdata
13890 Extend (do not extend) the @option{-G} behavior to local data too,
13891 such as to static variables in C@.  @option{-mlocal-sdata} is the
13892 default for all configurations.
13893
13894 If the linker complains that an application is using too much small data,
13895 you might want to try rebuilding the less performance-critical parts with
13896 @option{-mno-local-sdata}.  You might also want to build large
13897 libraries with @option{-mno-local-sdata}, so that the libraries leave
13898 more room for the main program.
13899
13900 @item -mextern-sdata
13901 @itemx -mno-extern-sdata
13902 @opindex mextern-sdata
13903 @opindex mno-extern-sdata
13904 Assume (do not assume) that externally-defined data will be in
13905 a small data section if that data is within the @option{-G} limit.
13906 @option{-mextern-sdata} is the default for all configurations.
13907
13908 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
13909 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
13910 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
13911 is placed in a small data section.  If @var{Var} is defined by another
13912 module, you must either compile that module with a high-enough
13913 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
13914 definition.  If @var{Var} is common, you must link the application
13915 with a high-enough @option{-G} setting.
13916
13917 The easiest way of satisfying these restrictions is to compile
13918 and link every module with the same @option{-G} option.  However,
13919 you may wish to build a library that supports several different
13920 small data limits.  You can do this by compiling the library with
13921 the highest supported @option{-G} setting and additionally using
13922 @option{-mno-extern-sdata} to stop the library from making assumptions
13923 about externally-defined data.
13924
13925 @item -mgpopt
13926 @itemx -mno-gpopt
13927 @opindex mgpopt
13928 @opindex mno-gpopt
13929 Use (do not use) GP-relative accesses for symbols that are known to be
13930 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
13931 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
13932 configurations.
13933
13934 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
13935 might not hold the value of @code{_gp}.  For example, if the code is
13936 part of a library that might be used in a boot monitor, programs that
13937 call boot monitor routines will pass an unknown value in @code{$gp}.
13938 (In such situations, the boot monitor itself would usually be compiled
13939 with @option{-G0}.)
13940
13941 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
13942 @option{-mno-extern-sdata}.
13943
13944 @item -membedded-data
13945 @itemx -mno-embedded-data
13946 @opindex membedded-data
13947 @opindex mno-embedded-data
13948 Allocate variables to the read-only data section first if possible, then
13949 next in the small data section if possible, otherwise in data.  This gives
13950 slightly slower code than the default, but reduces the amount of RAM required
13951 when executing, and thus may be preferred for some embedded systems.
13952
13953 @item -muninit-const-in-rodata
13954 @itemx -mno-uninit-const-in-rodata
13955 @opindex muninit-const-in-rodata
13956 @opindex mno-uninit-const-in-rodata
13957 Put uninitialized @code{const} variables in the read-only data section.
13958 This option is only meaningful in conjunction with @option{-membedded-data}.
13959
13960 @item -mcode-readable=@var{setting}
13961 @opindex mcode-readable
13962 Specify whether GCC may generate code that reads from executable sections.
13963 There are three possible settings:
13964
13965 @table @gcctabopt
13966 @item -mcode-readable=yes
13967 Instructions may freely access executable sections.  This is the
13968 default setting.
13969
13970 @item -mcode-readable=pcrel
13971 MIPS16 PC-relative load instructions can access executable sections,
13972 but other instructions must not do so.  This option is useful on 4KSc
13973 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
13974 It is also useful on processors that can be configured to have a dual
13975 instruction/data SRAM interface and that, like the M4K, automatically
13976 redirect PC-relative loads to the instruction RAM.
13977
13978 @item -mcode-readable=no
13979 Instructions must not access executable sections.  This option can be
13980 useful on targets that are configured to have a dual instruction/data
13981 SRAM interface but that (unlike the M4K) do not automatically redirect
13982 PC-relative loads to the instruction RAM.
13983 @end table
13984
13985 @item -msplit-addresses
13986 @itemx -mno-split-addresses
13987 @opindex msplit-addresses
13988 @opindex mno-split-addresses
13989 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
13990 relocation operators.  This option has been superseded by
13991 @option{-mexplicit-relocs} but is retained for backwards compatibility.
13992
13993 @item -mexplicit-relocs
13994 @itemx -mno-explicit-relocs
13995 @opindex mexplicit-relocs
13996 @opindex mno-explicit-relocs
13997 Use (do not use) assembler relocation operators when dealing with symbolic
13998 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
13999 is to use assembler macros instead.
14000
14001 @option{-mexplicit-relocs} is the default if GCC was configured
14002 to use an assembler that supports relocation operators.
14003
14004 @item -mcheck-zero-division
14005 @itemx -mno-check-zero-division
14006 @opindex mcheck-zero-division
14007 @opindex mno-check-zero-division
14008 Trap (do not trap) on integer division by zero.
14009
14010 The default is @option{-mcheck-zero-division}.
14011
14012 @item -mdivide-traps
14013 @itemx -mdivide-breaks
14014 @opindex mdivide-traps
14015 @opindex mdivide-breaks
14016 MIPS systems check for division by zero by generating either a
14017 conditional trap or a break instruction.  Using traps results in
14018 smaller code, but is only supported on MIPS II and later.  Also, some
14019 versions of the Linux kernel have a bug that prevents trap from
14020 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
14021 allow conditional traps on architectures that support them and
14022 @option{-mdivide-breaks} to force the use of breaks.
14023
14024 The default is usually @option{-mdivide-traps}, but this can be
14025 overridden at configure time using @option{--with-divide=breaks}.
14026 Divide-by-zero checks can be completely disabled using
14027 @option{-mno-check-zero-division}.
14028
14029 @item -mmemcpy
14030 @itemx -mno-memcpy
14031 @opindex mmemcpy
14032 @opindex mno-memcpy
14033 Force (do not force) the use of @code{memcpy()} for non-trivial block
14034 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
14035 most constant-sized copies.
14036
14037 @item -mlong-calls
14038 @itemx -mno-long-calls
14039 @opindex mlong-calls
14040 @opindex mno-long-calls
14041 Disable (do not disable) use of the @code{jal} instruction.  Calling
14042 functions using @code{jal} is more efficient but requires the caller
14043 and callee to be in the same 256 megabyte segment.
14044
14045 This option has no effect on abicalls code.  The default is
14046 @option{-mno-long-calls}.
14047
14048 @item -mmad
14049 @itemx -mno-mad
14050 @opindex mmad
14051 @opindex mno-mad
14052 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14053 instructions, as provided by the R4650 ISA@.
14054
14055 @item -mfused-madd
14056 @itemx -mno-fused-madd
14057 @opindex mfused-madd
14058 @opindex mno-fused-madd
14059 Enable (disable) use of the floating point multiply-accumulate
14060 instructions, when they are available.  The default is
14061 @option{-mfused-madd}.
14062
14063 When multiply-accumulate instructions are used, the intermediate
14064 product is calculated to infinite precision and is not subject to
14065 the FCSR Flush to Zero bit.  This may be undesirable in some
14066 circumstances.
14067
14068 @item -nocpp
14069 @opindex nocpp
14070 Tell the MIPS assembler to not run its preprocessor over user
14071 assembler files (with a @samp{.s} suffix) when assembling them.
14072
14073 @item -mfix-r4000
14074 @itemx -mno-fix-r4000
14075 @opindex mfix-r4000
14076 @opindex mno-fix-r4000
14077 Work around certain R4000 CPU errata:
14078 @itemize @minus
14079 @item
14080 A double-word or a variable shift may give an incorrect result if executed
14081 immediately after starting an integer division.
14082 @item
14083 A double-word or a variable shift may give an incorrect result if executed
14084 while an integer multiplication is in progress.
14085 @item
14086 An integer division may give an incorrect result if started in a delay slot
14087 of a taken branch or a jump.
14088 @end itemize
14089
14090 @item -mfix-r4400
14091 @itemx -mno-fix-r4400
14092 @opindex mfix-r4400
14093 @opindex mno-fix-r4400
14094 Work around certain R4400 CPU errata:
14095 @itemize @minus
14096 @item
14097 A double-word or a variable shift may give an incorrect result if executed
14098 immediately after starting an integer division.
14099 @end itemize
14100
14101 @item -mfix-r10000
14102 @itemx -mno-fix-r10000
14103 @opindex mfix-r10000
14104 @opindex mno-fix-r10000
14105 Work around certain R10000 errata:
14106 @itemize @minus
14107 @item
14108 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14109 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14110 @end itemize
14111
14112 This option can only be used if the target architecture supports
14113 branch-likely instructions.  @option{-mfix-r10000} is the default when
14114 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14115 otherwise.
14116
14117 @item -mfix-vr4120
14118 @itemx -mno-fix-vr4120
14119 @opindex mfix-vr4120
14120 Work around certain VR4120 errata:
14121 @itemize @minus
14122 @item
14123 @code{dmultu} does not always produce the correct result.
14124 @item
14125 @code{div} and @code{ddiv} do not always produce the correct result if one
14126 of the operands is negative.
14127 @end itemize
14128 The workarounds for the division errata rely on special functions in
14129 @file{libgcc.a}.  At present, these functions are only provided by
14130 the @code{mips64vr*-elf} configurations.
14131
14132 Other VR4120 errata require a nop to be inserted between certain pairs of
14133 instructions.  These errata are handled by the assembler, not by GCC itself.
14134
14135 @item -mfix-vr4130
14136 @opindex mfix-vr4130
14137 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14138 workarounds are implemented by the assembler rather than by GCC,
14139 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14140 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14141 instructions are available instead.
14142
14143 @item -mfix-sb1
14144 @itemx -mno-fix-sb1
14145 @opindex mfix-sb1
14146 Work around certain SB-1 CPU core errata.
14147 (This flag currently works around the SB-1 revision 2
14148 ``F1'' and ``F2'' floating point errata.)
14149
14150 @item -mr10k-cache-barrier=@var{setting}
14151 @opindex mr10k-cache-barrier
14152 Specify whether GCC should insert cache barriers to avoid the
14153 side-effects of speculation on R10K processors.
14154
14155 In common with many processors, the R10K tries to predict the outcome
14156 of a conditional branch and speculatively executes instructions from
14157 the ``taken'' branch.  It later aborts these instructions if the
14158 predicted outcome was wrong.  However, on the R10K, even aborted
14159 instructions can have side effects.
14160
14161 This problem only affects kernel stores and, depending on the system,
14162 kernel loads.  As an example, a speculatively-executed store may load
14163 the target memory into cache and mark the cache line as dirty, even if
14164 the store itself is later aborted.  If a DMA operation writes to the
14165 same area of memory before the ``dirty'' line is flushed, the cached
14166 data will overwrite the DMA-ed data.  See the R10K processor manual
14167 for a full description, including other potential problems.
14168
14169 One workaround is to insert cache barrier instructions before every memory
14170 access that might be speculatively executed and that might have side
14171 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14172 controls GCC's implementation of this workaround.  It assumes that
14173 aborted accesses to any byte in the following regions will not have
14174 side effects:
14175
14176 @enumerate
14177 @item
14178 the memory occupied by the current function's stack frame;
14179
14180 @item
14181 the memory occupied by an incoming stack argument;
14182
14183 @item
14184 the memory occupied by an object with a link-time-constant address.
14185 @end enumerate
14186
14187 It is the kernel's responsibility to ensure that speculative
14188 accesses to these regions are indeed safe.
14189
14190 If the input program contains a function declaration such as:
14191
14192 @smallexample
14193 void foo (void);
14194 @end smallexample
14195
14196 then the implementation of @code{foo} must allow @code{j foo} and
14197 @code{jal foo} to be executed speculatively.  GCC honors this
14198 restriction for functions it compiles itself.  It expects non-GCC
14199 functions (such as hand-written assembly code) to do the same.
14200
14201 The option has three forms:
14202
14203 @table @gcctabopt
14204 @item -mr10k-cache-barrier=load-store
14205 Insert a cache barrier before a load or store that might be
14206 speculatively executed and that might have side effects even
14207 if aborted.
14208
14209 @item -mr10k-cache-barrier=store
14210 Insert a cache barrier before a store that might be speculatively
14211 executed and that might have side effects even if aborted.
14212
14213 @item -mr10k-cache-barrier=none
14214 Disable the insertion of cache barriers.  This is the default setting.
14215 @end table
14216
14217 @item -mflush-func=@var{func}
14218 @itemx -mno-flush-func
14219 @opindex mflush-func
14220 Specifies the function to call to flush the I and D caches, or to not
14221 call any such function.  If called, the function must take the same
14222 arguments as the common @code{_flush_func()}, that is, the address of the
14223 memory range for which the cache is being flushed, the size of the
14224 memory range, and the number 3 (to flush both caches).  The default
14225 depends on the target GCC was configured for, but commonly is either
14226 @samp{_flush_func} or @samp{__cpu_flush}.
14227
14228 @item mbranch-cost=@var{num}
14229 @opindex mbranch-cost
14230 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14231 This cost is only a heuristic and is not guaranteed to produce
14232 consistent results across releases.  A zero cost redundantly selects
14233 the default, which is based on the @option{-mtune} setting.
14234
14235 @item -mbranch-likely
14236 @itemx -mno-branch-likely
14237 @opindex mbranch-likely
14238 @opindex mno-branch-likely
14239 Enable or disable use of Branch Likely instructions, regardless of the
14240 default for the selected architecture.  By default, Branch Likely
14241 instructions may be generated if they are supported by the selected
14242 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14243 and processors which implement those architectures; for those, Branch
14244 Likely instructions will not be generated by default because the MIPS32
14245 and MIPS64 architectures specifically deprecate their use.
14246
14247 @item -mfp-exceptions
14248 @itemx -mno-fp-exceptions
14249 @opindex mfp-exceptions
14250 Specifies whether FP exceptions are enabled.  This affects how we schedule
14251 FP instructions for some processors.  The default is that FP exceptions are
14252 enabled.
14253
14254 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14255 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14256 FP pipe.
14257
14258 @item -mvr4130-align
14259 @itemx -mno-vr4130-align
14260 @opindex mvr4130-align
14261 The VR4130 pipeline is two-way superscalar, but can only issue two
14262 instructions together if the first one is 8-byte aligned.  When this
14263 option is enabled, GCC will align pairs of instructions that it
14264 thinks should execute in parallel.
14265
14266 This option only has an effect when optimizing for the VR4130.
14267 It normally makes code faster, but at the expense of making it bigger.
14268 It is enabled by default at optimization level @option{-O3}.
14269
14270 @item -msynci
14271 @itemx -mno-synci
14272 @opindex msynci
14273 Enable (disable) generation of @code{synci} instructions on
14274 architectures that support it.  The @code{synci} instructions (if
14275 enabled) will be generated when @code{__builtin___clear_cache()} is
14276 compiled.
14277
14278 This option defaults to @code{-mno-synci}, but the default can be
14279 overridden by configuring with @code{--with-synci}.
14280
14281 When compiling code for single processor systems, it is generally safe
14282 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14283 will not invalidate the instruction caches on all cores and may lead
14284 to undefined behavior.
14285
14286 @item -mrelax-pic-calls
14287 @itemx -mno-relax-pic-calls
14288 @opindex mrelax-pic-calls
14289 Try to turn PIC calls that are normally dispatched via register
14290 @code{$25} into direct calls.  This is only possible if the linker can
14291 resolve the destination at link-time and if the destination is within
14292 range for a direct call.
14293
14294 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14295 an assembler and a linker that supports the @code{.reloc} assembly
14296 directive and @code{-mexplicit-relocs} is in effect.  With
14297 @code{-mno-explicit-relocs}, this optimization can be performed by the
14298 assembler and the linker alone without help from the compiler.
14299
14300 @item -mmcount-ra-address
14301 @itemx -mno-mcount-ra-address
14302 @opindex mmcount-ra-address
14303 @opindex mno-mcount-ra-address
14304 Emit (do not emit) code that allows @code{_mcount} to modify the
14305 calling function's return address.  When enabled, this option extends
14306 the usual @code{_mcount} interface with a new @var{ra-address}
14307 parameter, which has type @code{intptr_t *} and is passed in register
14308 @code{$12}.  @code{_mcount} can then modify the return address by
14309 doing both of the following:
14310 @itemize
14311 @item
14312 Returning the new address in register @code{$31}.
14313 @item
14314 Storing the new address in @code{*@var{ra-address}},
14315 if @var{ra-address} is nonnull.
14316 @end itemize
14317
14318 The default is @option{-mno-mcount-ra-address}.
14319
14320 @end table
14321
14322 @node MMIX Options
14323 @subsection MMIX Options
14324 @cindex MMIX Options
14325
14326 These options are defined for the MMIX:
14327
14328 @table @gcctabopt
14329 @item -mlibfuncs
14330 @itemx -mno-libfuncs
14331 @opindex mlibfuncs
14332 @opindex mno-libfuncs
14333 Specify that intrinsic library functions are being compiled, passing all
14334 values in registers, no matter the size.
14335
14336 @item -mepsilon
14337 @itemx -mno-epsilon
14338 @opindex mepsilon
14339 @opindex mno-epsilon
14340 Generate floating-point comparison instructions that compare with respect
14341 to the @code{rE} epsilon register.
14342
14343 @item -mabi=mmixware
14344 @itemx -mabi=gnu
14345 @opindex mabi=mmixware
14346 @opindex mabi=gnu
14347 Generate code that passes function parameters and return values that (in
14348 the called function) are seen as registers @code{$0} and up, as opposed to
14349 the GNU ABI which uses global registers @code{$231} and up.
14350
14351 @item -mzero-extend
14352 @itemx -mno-zero-extend
14353 @opindex mzero-extend
14354 @opindex mno-zero-extend
14355 When reading data from memory in sizes shorter than 64 bits, use (do not
14356 use) zero-extending load instructions by default, rather than
14357 sign-extending ones.
14358
14359 @item -mknuthdiv
14360 @itemx -mno-knuthdiv
14361 @opindex mknuthdiv
14362 @opindex mno-knuthdiv
14363 Make the result of a division yielding a remainder have the same sign as
14364 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
14365 remainder follows the sign of the dividend.  Both methods are
14366 arithmetically valid, the latter being almost exclusively used.
14367
14368 @item -mtoplevel-symbols
14369 @itemx -mno-toplevel-symbols
14370 @opindex mtoplevel-symbols
14371 @opindex mno-toplevel-symbols
14372 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14373 code can be used with the @code{PREFIX} assembly directive.
14374
14375 @item -melf
14376 @opindex melf
14377 Generate an executable in the ELF format, rather than the default
14378 @samp{mmo} format used by the @command{mmix} simulator.
14379
14380 @item -mbranch-predict
14381 @itemx -mno-branch-predict
14382 @opindex mbranch-predict
14383 @opindex mno-branch-predict
14384 Use (do not use) the probable-branch instructions, when static branch
14385 prediction indicates a probable branch.
14386
14387 @item -mbase-addresses
14388 @itemx -mno-base-addresses
14389 @opindex mbase-addresses
14390 @opindex mno-base-addresses
14391 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14392 base address automatically generates a request (handled by the assembler
14393 and the linker) for a constant to be set up in a global register.  The
14394 register is used for one or more base address requests within the range 0
14395 to 255 from the value held in the register.  The generally leads to short
14396 and fast code, but the number of different data items that can be
14397 addressed is limited.  This means that a program that uses lots of static
14398 data may require @option{-mno-base-addresses}.
14399
14400 @item -msingle-exit
14401 @itemx -mno-single-exit
14402 @opindex msingle-exit
14403 @opindex mno-single-exit
14404 Force (do not force) generated code to have a single exit point in each
14405 function.
14406 @end table
14407
14408 @node MN10300 Options
14409 @subsection MN10300 Options
14410 @cindex MN10300 options
14411
14412 These @option{-m} options are defined for Matsushita MN10300 architectures:
14413
14414 @table @gcctabopt
14415 @item -mmult-bug
14416 @opindex mmult-bug
14417 Generate code to avoid bugs in the multiply instructions for the MN10300
14418 processors.  This is the default.
14419
14420 @item -mno-mult-bug
14421 @opindex mno-mult-bug
14422 Do not generate code to avoid bugs in the multiply instructions for the
14423 MN10300 processors.
14424
14425 @item -mam33
14426 @opindex mam33
14427 Generate code which uses features specific to the AM33 processor.
14428
14429 @item -mno-am33
14430 @opindex mno-am33
14431 Do not generate code which uses features specific to the AM33 processor.  This
14432 is the default.
14433
14434 @item -mreturn-pointer-on-d0
14435 @opindex mreturn-pointer-on-d0
14436 When generating a function which returns a pointer, return the pointer
14437 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14438 only in a0, and attempts to call such functions without a prototype
14439 would result in errors.  Note that this option is on by default; use
14440 @option{-mno-return-pointer-on-d0} to disable it.
14441
14442 @item -mno-crt0
14443 @opindex mno-crt0
14444 Do not link in the C run-time initialization object file.
14445
14446 @item -mrelax
14447 @opindex mrelax
14448 Indicate to the linker that it should perform a relaxation optimization pass
14449 to shorten branches, calls and absolute memory addresses.  This option only
14450 has an effect when used on the command line for the final link step.
14451
14452 This option makes symbolic debugging impossible.
14453 @end table
14454
14455 @node PDP-11 Options
14456 @subsection PDP-11 Options
14457 @cindex PDP-11 Options
14458
14459 These options are defined for the PDP-11:
14460
14461 @table @gcctabopt
14462 @item -mfpu
14463 @opindex mfpu
14464 Use hardware FPP floating point.  This is the default.  (FIS floating
14465 point on the PDP-11/40 is not supported.)
14466
14467 @item -msoft-float
14468 @opindex msoft-float
14469 Do not use hardware floating point.
14470
14471 @item -mac0
14472 @opindex mac0
14473 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14474
14475 @item -mno-ac0
14476 @opindex mno-ac0
14477 Return floating-point results in memory.  This is the default.
14478
14479 @item -m40
14480 @opindex m40
14481 Generate code for a PDP-11/40.
14482
14483 @item -m45
14484 @opindex m45
14485 Generate code for a PDP-11/45.  This is the default.
14486
14487 @item -m10
14488 @opindex m10
14489 Generate code for a PDP-11/10.
14490
14491 @item -mbcopy-builtin
14492 @opindex mbcopy-builtin
14493 Use inline @code{movmemhi} patterns for copying memory.  This is the
14494 default.
14495
14496 @item -mbcopy
14497 @opindex mbcopy
14498 Do not use inline @code{movmemhi} patterns for copying memory.
14499
14500 @item -mint16
14501 @itemx -mno-int32
14502 @opindex mint16
14503 @opindex mno-int32
14504 Use 16-bit @code{int}.  This is the default.
14505
14506 @item -mint32
14507 @itemx -mno-int16
14508 @opindex mint32
14509 @opindex mno-int16
14510 Use 32-bit @code{int}.
14511
14512 @item -mfloat64
14513 @itemx -mno-float32
14514 @opindex mfloat64
14515 @opindex mno-float32
14516 Use 64-bit @code{float}.  This is the default.
14517
14518 @item -mfloat32
14519 @itemx -mno-float64
14520 @opindex mfloat32
14521 @opindex mno-float64
14522 Use 32-bit @code{float}.
14523
14524 @item -mabshi
14525 @opindex mabshi
14526 Use @code{abshi2} pattern.  This is the default.
14527
14528 @item -mno-abshi
14529 @opindex mno-abshi
14530 Do not use @code{abshi2} pattern.
14531
14532 @item -mbranch-expensive
14533 @opindex mbranch-expensive
14534 Pretend that branches are expensive.  This is for experimenting with
14535 code generation only.
14536
14537 @item -mbranch-cheap
14538 @opindex mbranch-cheap
14539 Do not pretend that branches are expensive.  This is the default.
14540
14541 @item -msplit
14542 @opindex msplit
14543 Generate code for a system with split I&D@.
14544
14545 @item -mno-split
14546 @opindex mno-split
14547 Generate code for a system without split I&D@.  This is the default.
14548
14549 @item -munix-asm
14550 @opindex munix-asm
14551 Use Unix assembler syntax.  This is the default when configured for
14552 @samp{pdp11-*-bsd}.
14553
14554 @item -mdec-asm
14555 @opindex mdec-asm
14556 Use DEC assembler syntax.  This is the default when configured for any
14557 PDP-11 target other than @samp{pdp11-*-bsd}.
14558 @end table
14559
14560 @node picoChip Options
14561 @subsection picoChip Options
14562 @cindex picoChip options
14563
14564 These @samp{-m} options are defined for picoChip implementations:
14565
14566 @table @gcctabopt
14567
14568 @item -mae=@var{ae_type}
14569 @opindex mcpu
14570 Set the instruction set, register set, and instruction scheduling
14571 parameters for array element type @var{ae_type}.  Supported values
14572 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14573
14574 @option{-mae=ANY} selects a completely generic AE type.  Code
14575 generated with this option will run on any of the other AE types.  The
14576 code will not be as efficient as it would be if compiled for a specific
14577 AE type, and some types of operation (e.g., multiplication) will not
14578 work properly on all types of AE.
14579
14580 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14581 for compiled code, and is the default.
14582
14583 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14584 option may suffer from poor performance of byte (char) manipulation,
14585 since the DSP AE does not provide hardware support for byte load/stores.
14586
14587 @item -msymbol-as-address
14588 Enable the compiler to directly use a symbol name as an address in a
14589 load/store instruction, without first loading it into a
14590 register.  Typically, the use of this option will generate larger
14591 programs, which run faster than when the option isn't used.  However, the
14592 results vary from program to program, so it is left as a user option,
14593 rather than being permanently enabled.
14594
14595 @item -mno-inefficient-warnings
14596 Disables warnings about the generation of inefficient code.  These
14597 warnings can be generated, for example, when compiling code which
14598 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14599 no hardware support for byte-level memory operations, so all byte
14600 load/stores must be synthesized from word load/store operations.  This is
14601 inefficient and a warning will be generated indicating to the programmer
14602 that they should rewrite the code to avoid byte operations, or to target
14603 an AE type which has the necessary hardware support.  This option enables
14604 the warning to be turned off.
14605
14606 @end table
14607
14608 @node PowerPC Options
14609 @subsection PowerPC Options
14610 @cindex PowerPC options
14611
14612 These are listed under @xref{RS/6000 and PowerPC Options}.
14613
14614 @node RS/6000 and PowerPC Options
14615 @subsection IBM RS/6000 and PowerPC Options
14616 @cindex RS/6000 and PowerPC Options
14617 @cindex IBM RS/6000 and PowerPC Options
14618
14619 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14620 @table @gcctabopt
14621 @item -mpower
14622 @itemx -mno-power
14623 @itemx -mpower2
14624 @itemx -mno-power2
14625 @itemx -mpowerpc
14626 @itemx -mno-powerpc
14627 @itemx -mpowerpc-gpopt
14628 @itemx -mno-powerpc-gpopt
14629 @itemx -mpowerpc-gfxopt
14630 @itemx -mno-powerpc-gfxopt
14631 @itemx -mpowerpc64
14632 @itemx -mno-powerpc64
14633 @itemx -mmfcrf
14634 @itemx -mno-mfcrf
14635 @itemx -mpopcntb
14636 @itemx -mno-popcntb
14637 @itemx -mpopcntd
14638 @itemx -mno-popcntd
14639 @itemx -mfprnd
14640 @itemx -mno-fprnd
14641 @itemx -mcmpb
14642 @itemx -mno-cmpb
14643 @itemx -mmfpgpr
14644 @itemx -mno-mfpgpr
14645 @itemx -mhard-dfp
14646 @itemx -mno-hard-dfp
14647 @opindex mpower
14648 @opindex mno-power
14649 @opindex mpower2
14650 @opindex mno-power2
14651 @opindex mpowerpc
14652 @opindex mno-powerpc
14653 @opindex mpowerpc-gpopt
14654 @opindex mno-powerpc-gpopt
14655 @opindex mpowerpc-gfxopt
14656 @opindex mno-powerpc-gfxopt
14657 @opindex mpowerpc64
14658 @opindex mno-powerpc64
14659 @opindex mmfcrf
14660 @opindex mno-mfcrf
14661 @opindex mpopcntb
14662 @opindex mno-popcntb
14663 @opindex mpopcntd
14664 @opindex mno-popcntd
14665 @opindex mfprnd
14666 @opindex mno-fprnd
14667 @opindex mcmpb
14668 @opindex mno-cmpb
14669 @opindex mmfpgpr
14670 @opindex mno-mfpgpr
14671 @opindex mhard-dfp
14672 @opindex mno-hard-dfp
14673 GCC supports two related instruction set architectures for the
14674 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14675 instructions supported by the @samp{rios} chip set used in the original
14676 RS/6000 systems and the @dfn{PowerPC} instruction set is the
14677 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
14678 the IBM 4xx, 6xx, and follow-on microprocessors.
14679
14680 Neither architecture is a subset of the other.  However there is a
14681 large common subset of instructions supported by both.  An MQ
14682 register is included in processors supporting the POWER architecture.
14683
14684 You use these options to specify which instructions are available on the
14685 processor you are using.  The default value of these options is
14686 determined when configuring GCC@.  Specifying the
14687 @option{-mcpu=@var{cpu_type}} overrides the specification of these
14688 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
14689 rather than the options listed above.
14690
14691 The @option{-mpower} option allows GCC to generate instructions that
14692 are found only in the POWER architecture and to use the MQ register.
14693 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
14694 to generate instructions that are present in the POWER2 architecture but
14695 not the original POWER architecture.
14696
14697 The @option{-mpowerpc} option allows GCC to generate instructions that
14698 are found only in the 32-bit subset of the PowerPC architecture.
14699 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
14700 GCC to use the optional PowerPC architecture instructions in the
14701 General Purpose group, including floating-point square root.  Specifying
14702 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
14703 use the optional PowerPC architecture instructions in the Graphics
14704 group, including floating-point select.
14705
14706 The @option{-mmfcrf} option allows GCC to generate the move from
14707 condition register field instruction implemented on the POWER4
14708 processor and other processors that support the PowerPC V2.01
14709 architecture.
14710 The @option{-mpopcntb} option allows GCC to generate the popcount and
14711 double precision FP reciprocal estimate instruction implemented on the
14712 POWER5 processor and other processors that support the PowerPC V2.02
14713 architecture.
14714 The @option{-mpopcntd} option allows GCC to generate the popcount
14715 instruction implemented on the POWER7 processor and other processors
14716 that support the PowerPC V2.06 architecture.
14717 The @option{-mfprnd} option allows GCC to generate the FP round to
14718 integer instructions implemented on the POWER5+ processor and other
14719 processors that support the PowerPC V2.03 architecture.
14720 The @option{-mcmpb} option allows GCC to generate the compare bytes
14721 instruction implemented on the POWER6 processor and other processors
14722 that support the PowerPC V2.05 architecture.
14723 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
14724 general purpose register instructions implemented on the POWER6X
14725 processor and other processors that support the extended PowerPC V2.05
14726 architecture.
14727 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
14728 point instructions implemented on some POWER processors.
14729
14730 The @option{-mpowerpc64} option allows GCC to generate the additional
14731 64-bit instructions that are found in the full PowerPC64 architecture
14732 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
14733 @option{-mno-powerpc64}.
14734
14735 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
14736 will use only the instructions in the common subset of both
14737 architectures plus some special AIX common-mode calls, and will not use
14738 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
14739 permits GCC to use any instruction from either architecture and to
14740 allow use of the MQ register; specify this for the Motorola MPC601.
14741
14742 @item -mnew-mnemonics
14743 @itemx -mold-mnemonics
14744 @opindex mnew-mnemonics
14745 @opindex mold-mnemonics
14746 Select which mnemonics to use in the generated assembler code.  With
14747 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
14748 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
14749 assembler mnemonics defined for the POWER architecture.  Instructions
14750 defined in only one architecture have only one mnemonic; GCC uses that
14751 mnemonic irrespective of which of these options is specified.
14752
14753 GCC defaults to the mnemonics appropriate for the architecture in
14754 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
14755 value of these option.  Unless you are building a cross-compiler, you
14756 should normally not specify either @option{-mnew-mnemonics} or
14757 @option{-mold-mnemonics}, but should instead accept the default.
14758
14759 @item -mcpu=@var{cpu_type}
14760 @opindex mcpu
14761 Set architecture type, register usage, choice of mnemonics, and
14762 instruction scheduling parameters for machine type @var{cpu_type}.
14763 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
14764 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
14765 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
14766 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
14767 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
14768 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
14769 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
14770 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
14771 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
14772 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
14773 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
14774
14775 @option{-mcpu=common} selects a completely generic processor.  Code
14776 generated under this option will run on any POWER or PowerPC processor.
14777 GCC will use only the instructions in the common subset of both
14778 architectures, and will not use the MQ register.  GCC assumes a generic
14779 processor model for scheduling purposes.
14780
14781 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
14782 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
14783 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
14784 types, with an appropriate, generic processor model assumed for
14785 scheduling purposes.
14786
14787 The other options specify a specific processor.  Code generated under
14788 those options will run best on that processor, and may not run at all on
14789 others.
14790
14791 The @option{-mcpu} options automatically enable or disable the
14792 following options:
14793
14794 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
14795 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
14796 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
14797 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
14798
14799 The particular options set for any particular CPU will vary between
14800 compiler versions, depending on what setting seems to produce optimal
14801 code for that CPU; it doesn't necessarily reflect the actual hardware's
14802 capabilities.  If you wish to set an individual option to a particular
14803 value, you may specify it after the @option{-mcpu} option, like
14804 @samp{-mcpu=970 -mno-altivec}.
14805
14806 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
14807 not enabled or disabled by the @option{-mcpu} option at present because
14808 AIX does not have full support for these options.  You may still
14809 enable or disable them individually if you're sure it'll work in your
14810 environment.
14811
14812 @item -mtune=@var{cpu_type}
14813 @opindex mtune
14814 Set the instruction scheduling parameters for machine type
14815 @var{cpu_type}, but do not set the architecture type, register usage, or
14816 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
14817 values for @var{cpu_type} are used for @option{-mtune} as for
14818 @option{-mcpu}.  If both are specified, the code generated will use the
14819 architecture, registers, and mnemonics set by @option{-mcpu}, but the
14820 scheduling parameters set by @option{-mtune}.
14821
14822 @item -mswdiv
14823 @itemx -mno-swdiv
14824 @opindex mswdiv
14825 @opindex mno-swdiv
14826 Generate code to compute division as reciprocal estimate and iterative
14827 refinement, creating opportunities for increased throughput.  This
14828 feature requires: optional PowerPC Graphics instruction set for single
14829 precision and FRE instruction for double precision, assuming divides
14830 cannot generate user-visible traps, and the domain values not include
14831 Infinities, denormals or zero denominator.
14832
14833 @item -maltivec
14834 @itemx -mno-altivec
14835 @opindex maltivec
14836 @opindex mno-altivec
14837 Generate code that uses (does not use) AltiVec instructions, and also
14838 enable the use of built-in functions that allow more direct access to
14839 the AltiVec instruction set.  You may also need to set
14840 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
14841 enhancements.
14842
14843 @item -mvrsave
14844 @itemx -mno-vrsave
14845 @opindex mvrsave
14846 @opindex mno-vrsave
14847 Generate VRSAVE instructions when generating AltiVec code.
14848
14849 @item -mgen-cell-microcode
14850 @opindex mgen-cell-microcode
14851 Generate Cell microcode instructions
14852
14853 @item -mwarn-cell-microcode
14854 @opindex mwarn-cell-microcode
14855 Warning when a Cell microcode instruction is going to emitted.  An example
14856 of a Cell microcode instruction is a variable shift.
14857
14858 @item -msecure-plt
14859 @opindex msecure-plt
14860 Generate code that allows ld and ld.so to build executables and shared
14861 libraries with non-exec .plt and .got sections.  This is a PowerPC
14862 32-bit SYSV ABI option.
14863
14864 @item -mbss-plt
14865 @opindex mbss-plt
14866 Generate code that uses a BSS .plt section that ld.so fills in, and
14867 requires .plt and .got sections that are both writable and executable.
14868 This is a PowerPC 32-bit SYSV ABI option.
14869
14870 @item -misel
14871 @itemx -mno-isel
14872 @opindex misel
14873 @opindex mno-isel
14874 This switch enables or disables the generation of ISEL instructions.
14875
14876 @item -misel=@var{yes/no}
14877 This switch has been deprecated.  Use @option{-misel} and
14878 @option{-mno-isel} instead.
14879
14880 @item -mspe
14881 @itemx -mno-spe
14882 @opindex mspe
14883 @opindex mno-spe
14884 This switch enables or disables the generation of SPE simd
14885 instructions.
14886
14887 @item -mpaired
14888 @itemx -mno-paired
14889 @opindex mpaired
14890 @opindex mno-paired
14891 This switch enables or disables the generation of PAIRED simd
14892 instructions.
14893
14894 @item -mspe=@var{yes/no}
14895 This option has been deprecated.  Use @option{-mspe} and
14896 @option{-mno-spe} instead.
14897
14898 @item -mvsx
14899 @itemx -mno-vsx
14900 @opindex mvsx
14901 @opindex mno-vsx
14902 Generate code that uses (does not use) vector/scalar (VSX)
14903 instructions, and also enable the use of built-in functions that allow
14904 more direct access to the VSX instruction set.
14905
14906 @item -mfloat-gprs=@var{yes/single/double/no}
14907 @itemx -mfloat-gprs
14908 @opindex mfloat-gprs
14909 This switch enables or disables the generation of floating point
14910 operations on the general purpose registers for architectures that
14911 support it.
14912
14913 The argument @var{yes} or @var{single} enables the use of
14914 single-precision floating point operations.
14915
14916 The argument @var{double} enables the use of single and
14917 double-precision floating point operations.
14918
14919 The argument @var{no} disables floating point operations on the
14920 general purpose registers.
14921
14922 This option is currently only available on the MPC854x.
14923
14924 @item -m32
14925 @itemx -m64
14926 @opindex m32
14927 @opindex m64
14928 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
14929 targets (including GNU/Linux).  The 32-bit environment sets int, long
14930 and pointer to 32 bits and generates code that runs on any PowerPC
14931 variant.  The 64-bit environment sets int to 32 bits and long and
14932 pointer to 64 bits, and generates code for PowerPC64, as for
14933 @option{-mpowerpc64}.
14934
14935 @item -mfull-toc
14936 @itemx -mno-fp-in-toc
14937 @itemx -mno-sum-in-toc
14938 @itemx -mminimal-toc
14939 @opindex mfull-toc
14940 @opindex mno-fp-in-toc
14941 @opindex mno-sum-in-toc
14942 @opindex mminimal-toc
14943 Modify generation of the TOC (Table Of Contents), which is created for
14944 every executable file.  The @option{-mfull-toc} option is selected by
14945 default.  In that case, GCC will allocate at least one TOC entry for
14946 each unique non-automatic variable reference in your program.  GCC
14947 will also place floating-point constants in the TOC@.  However, only
14948 16,384 entries are available in the TOC@.
14949
14950 If you receive a linker error message that saying you have overflowed
14951 the available TOC space, you can reduce the amount of TOC space used
14952 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
14953 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
14954 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
14955 generate code to calculate the sum of an address and a constant at
14956 run-time instead of putting that sum into the TOC@.  You may specify one
14957 or both of these options.  Each causes GCC to produce very slightly
14958 slower and larger code at the expense of conserving TOC space.
14959
14960 If you still run out of space in the TOC even when you specify both of
14961 these options, specify @option{-mminimal-toc} instead.  This option causes
14962 GCC to make only one TOC entry for every file.  When you specify this
14963 option, GCC will produce code that is slower and larger but which
14964 uses extremely little TOC space.  You may wish to use this option
14965 only on files that contain less frequently executed code.
14966
14967 @item -maix64
14968 @itemx -maix32
14969 @opindex maix64
14970 @opindex maix32
14971 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
14972 @code{long} type, and the infrastructure needed to support them.
14973 Specifying @option{-maix64} implies @option{-mpowerpc64} and
14974 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
14975 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
14976
14977 @item -mxl-compat
14978 @itemx -mno-xl-compat
14979 @opindex mxl-compat
14980 @opindex mno-xl-compat
14981 Produce code that conforms more closely to IBM XL compiler semantics
14982 when using AIX-compatible ABI@.  Pass floating-point arguments to
14983 prototyped functions beyond the register save area (RSA) on the stack
14984 in addition to argument FPRs.  Do not assume that most significant
14985 double in 128-bit long double value is properly rounded when comparing
14986 values and converting to double.  Use XL symbol names for long double
14987 support routines.
14988
14989 The AIX calling convention was extended but not initially documented to
14990 handle an obscure K&R C case of calling a function that takes the
14991 address of its arguments with fewer arguments than declared.  IBM XL
14992 compilers access floating point arguments which do not fit in the
14993 RSA from the stack when a subroutine is compiled without
14994 optimization.  Because always storing floating-point arguments on the
14995 stack is inefficient and rarely needed, this option is not enabled by
14996 default and only is necessary when calling subroutines compiled by IBM
14997 XL compilers without optimization.
14998
14999 @item -mpe
15000 @opindex mpe
15001 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
15002 application written to use message passing with special startup code to
15003 enable the application to run.  The system must have PE installed in the
15004 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
15005 must be overridden with the @option{-specs=} option to specify the
15006 appropriate directory location.  The Parallel Environment does not
15007 support threads, so the @option{-mpe} option and the @option{-pthread}
15008 option are incompatible.
15009
15010 @item -malign-natural
15011 @itemx -malign-power
15012 @opindex malign-natural
15013 @opindex malign-power
15014 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15015 @option{-malign-natural} overrides the ABI-defined alignment of larger
15016 types, such as floating-point doubles, on their natural size-based boundary.
15017 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15018 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
15019
15020 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15021 is not supported.
15022
15023 @item -msoft-float
15024 @itemx -mhard-float
15025 @opindex msoft-float
15026 @opindex mhard-float
15027 Generate code that does not use (uses) the floating-point register set.
15028 Software floating point emulation is provided if you use the
15029 @option{-msoft-float} option, and pass the option to GCC when linking.
15030
15031 @item -msingle-float
15032 @itemx -mdouble-float
15033 @opindex msingle-float
15034 @opindex mdouble-float
15035 Generate code for single or double-precision floating point operations.
15036 @option{-mdouble-float} implies @option{-msingle-float}.
15037
15038 @item -msimple-fpu
15039 @opindex msimple-fpu
15040 Do not generate sqrt and div instructions for hardware floating point unit.
15041
15042 @item -mfpu
15043 @opindex mfpu
15044 Specify type of floating point unit.  Valid values are @var{sp_lite}
15045 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15046 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15047 and @var{dp_full} (equivalent to -mdouble-float).
15048
15049 @item -mxilinx-fpu
15050 @opindex mxilinx-fpu
15051 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15052
15053 @item -mmultiple
15054 @itemx -mno-multiple
15055 @opindex mmultiple
15056 @opindex mno-multiple
15057 Generate code that uses (does not use) the load multiple word
15058 instructions and the store multiple word instructions.  These
15059 instructions are generated by default on POWER systems, and not
15060 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
15061 endian PowerPC systems, since those instructions do not work when the
15062 processor is in little endian mode.  The exceptions are PPC740 and
15063 PPC750 which permit the instructions usage in little endian mode.
15064
15065 @item -mstring
15066 @itemx -mno-string
15067 @opindex mstring
15068 @opindex mno-string
15069 Generate code that uses (does not use) the load string instructions
15070 and the store string word instructions to save multiple registers and
15071 do small block moves.  These instructions are generated by default on
15072 POWER systems, and not generated on PowerPC systems.  Do not use
15073 @option{-mstring} on little endian PowerPC systems, since those
15074 instructions do not work when the processor is in little endian mode.
15075 The exceptions are PPC740 and PPC750 which permit the instructions
15076 usage in little endian mode.
15077
15078 @item -mupdate
15079 @itemx -mno-update
15080 @opindex mupdate
15081 @opindex mno-update
15082 Generate code that uses (does not use) the load or store instructions
15083 that update the base register to the address of the calculated memory
15084 location.  These instructions are generated by default.  If you use
15085 @option{-mno-update}, there is a small window between the time that the
15086 stack pointer is updated and the address of the previous frame is
15087 stored, which means code that walks the stack frame across interrupts or
15088 signals may get corrupted data.
15089
15090 @item -mavoid-indexed-addresses
15091 @itemx -mno-avoid-indexed-addresses
15092 @opindex mavoid-indexed-addresses
15093 @opindex mno-avoid-indexed-addresses
15094 Generate code that tries to avoid (not avoid) the use of indexed load
15095 or store instructions. These instructions can incur a performance
15096 penalty on Power6 processors in certain situations, such as when
15097 stepping through large arrays that cross a 16M boundary.  This option
15098 is enabled by default when targetting Power6 and disabled otherwise.
15099
15100 @item -mfused-madd
15101 @itemx -mno-fused-madd
15102 @opindex mfused-madd
15103 @opindex mno-fused-madd
15104 Generate code that uses (does not use) the floating point multiply and
15105 accumulate instructions.  These instructions are generated by default if
15106 hardware floating is used.
15107
15108 @item -mmulhw
15109 @itemx -mno-mulhw
15110 @opindex mmulhw
15111 @opindex mno-mulhw
15112 Generate code that uses (does not use) the half-word multiply and
15113 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15114 These instructions are generated by default when targetting those
15115 processors.
15116
15117 @item -mdlmzb
15118 @itemx -mno-dlmzb
15119 @opindex mdlmzb
15120 @opindex mno-dlmzb
15121 Generate code that uses (does not use) the string-search @samp{dlmzb}
15122 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15123 generated by default when targetting those processors.
15124
15125 @item -mno-bit-align
15126 @itemx -mbit-align
15127 @opindex mno-bit-align
15128 @opindex mbit-align
15129 On System V.4 and embedded PowerPC systems do not (do) force structures
15130 and unions that contain bit-fields to be aligned to the base type of the
15131 bit-field.
15132
15133 For example, by default a structure containing nothing but 8
15134 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15135 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15136 the structure would be aligned to a 1 byte boundary and be one byte in
15137 size.
15138
15139 @item -mno-strict-align
15140 @itemx -mstrict-align
15141 @opindex mno-strict-align
15142 @opindex mstrict-align
15143 On System V.4 and embedded PowerPC systems do not (do) assume that
15144 unaligned memory references will be handled by the system.
15145
15146 @item -mrelocatable
15147 @itemx -mno-relocatable
15148 @opindex mrelocatable
15149 @opindex mno-relocatable
15150 On embedded PowerPC systems generate code that allows (does not allow)
15151 the program to be relocated to a different address at runtime.  If you
15152 use @option{-mrelocatable} on any module, all objects linked together must
15153 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
15154
15155 @item -mrelocatable-lib
15156 @itemx -mno-relocatable-lib
15157 @opindex mrelocatable-lib
15158 @opindex mno-relocatable-lib
15159 On embedded PowerPC systems generate code that allows (does not allow)
15160 the program to be relocated to a different address at runtime.  Modules
15161 compiled with @option{-mrelocatable-lib} can be linked with either modules
15162 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
15163 with modules compiled with the @option{-mrelocatable} options.
15164
15165 @item -mno-toc
15166 @itemx -mtoc
15167 @opindex mno-toc
15168 @opindex mtoc
15169 On System V.4 and embedded PowerPC systems do not (do) assume that
15170 register 2 contains a pointer to a global area pointing to the addresses
15171 used in the program.
15172
15173 @item -mlittle
15174 @itemx -mlittle-endian
15175 @opindex mlittle
15176 @opindex mlittle-endian
15177 On System V.4 and embedded PowerPC systems compile code for the
15178 processor in little endian mode.  The @option{-mlittle-endian} option is
15179 the same as @option{-mlittle}.
15180
15181 @item -mbig
15182 @itemx -mbig-endian
15183 @opindex mbig
15184 @opindex mbig-endian
15185 On System V.4 and embedded PowerPC systems compile code for the
15186 processor in big endian mode.  The @option{-mbig-endian} option is
15187 the same as @option{-mbig}.
15188
15189 @item -mdynamic-no-pic
15190 @opindex mdynamic-no-pic
15191 On Darwin and Mac OS X systems, compile code so that it is not
15192 relocatable, but that its external references are relocatable.  The
15193 resulting code is suitable for applications, but not shared
15194 libraries.
15195
15196 @item -mprioritize-restricted-insns=@var{priority}
15197 @opindex mprioritize-restricted-insns
15198 This option controls the priority that is assigned to
15199 dispatch-slot restricted instructions during the second scheduling
15200 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15201 @var{no/highest/second-highest} priority to dispatch slot restricted
15202 instructions.
15203
15204 @item -msched-costly-dep=@var{dependence_type}
15205 @opindex msched-costly-dep
15206 This option controls which dependences are considered costly
15207 by the target during instruction scheduling.  The argument
15208 @var{dependence_type} takes one of the following values:
15209 @var{no}: no dependence is costly,
15210 @var{all}: all dependences are costly,
15211 @var{true_store_to_load}: a true dependence from store to load is costly,
15212 @var{store_to_load}: any dependence from store to load is costly,
15213 @var{number}: any dependence which latency >= @var{number} is costly.
15214
15215 @item -minsert-sched-nops=@var{scheme}
15216 @opindex minsert-sched-nops
15217 This option controls which nop insertion scheme will be used during
15218 the second scheduling pass.  The argument @var{scheme} takes one of the
15219 following values:
15220 @var{no}: Don't insert nops.
15221 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15222 according to the scheduler's grouping.
15223 @var{regroup_exact}: Insert nops to force costly dependent insns into
15224 separate groups.  Insert exactly as many nops as needed to force an insn
15225 to a new group, according to the estimated processor grouping.
15226 @var{number}: Insert nops to force costly dependent insns into
15227 separate groups.  Insert @var{number} nops to force an insn to a new group.
15228
15229 @item -mcall-sysv
15230 @opindex mcall-sysv
15231 On System V.4 and embedded PowerPC systems compile code using calling
15232 conventions that adheres to the March 1995 draft of the System V
15233 Application Binary Interface, PowerPC processor supplement.  This is the
15234 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15235
15236 @item -mcall-sysv-eabi
15237 @itemx -mcall-eabi
15238 @opindex mcall-sysv-eabi
15239 @opindex mcall-eabi
15240 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15241
15242 @item -mcall-sysv-noeabi
15243 @opindex mcall-sysv-noeabi
15244 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15245
15246 @item -mcall-aixdesc
15247 @opindex m
15248 On System V.4 and embedded PowerPC systems compile code for the AIX
15249 operating system.
15250
15251 @item -mcall-linux
15252 @opindex mcall-linux
15253 On System V.4 and embedded PowerPC systems compile code for the
15254 Linux-based GNU system.
15255
15256 @item -mcall-gnu
15257 @opindex mcall-gnu
15258 On System V.4 and embedded PowerPC systems compile code for the
15259 Hurd-based GNU system.
15260
15261 @item -mcall-freebsd
15262 @opindex mcall-freebsd
15263 On System V.4 and embedded PowerPC systems compile code for the
15264 FreeBSD operating system.
15265
15266 @item -mcall-netbsd
15267 @opindex mcall-netbsd
15268 On System V.4 and embedded PowerPC systems compile code for the
15269 NetBSD operating system.
15270
15271 @item -mcall-openbsd
15272 @opindex mcall-netbsd
15273 On System V.4 and embedded PowerPC systems compile code for the
15274 OpenBSD operating system.
15275
15276 @item -maix-struct-return
15277 @opindex maix-struct-return
15278 Return all structures in memory (as specified by the AIX ABI)@.
15279
15280 @item -msvr4-struct-return
15281 @opindex msvr4-struct-return
15282 Return structures smaller than 8 bytes in registers (as specified by the
15283 SVR4 ABI)@.
15284
15285 @item -mabi=@var{abi-type}
15286 @opindex mabi
15287 Extend the current ABI with a particular extension, or remove such extension.
15288 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15289 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15290
15291 @item -mabi=spe
15292 @opindex mabi=spe
15293 Extend the current ABI with SPE ABI extensions.  This does not change
15294 the default ABI, instead it adds the SPE ABI extensions to the current
15295 ABI@.
15296
15297 @item -mabi=no-spe
15298 @opindex mabi=no-spe
15299 Disable Booke SPE ABI extensions for the current ABI@.
15300
15301 @item -mabi=ibmlongdouble
15302 @opindex mabi=ibmlongdouble
15303 Change the current ABI to use IBM extended precision long double.
15304 This is a PowerPC 32-bit SYSV ABI option.
15305
15306 @item -mabi=ieeelongdouble
15307 @opindex mabi=ieeelongdouble
15308 Change the current ABI to use IEEE extended precision long double.
15309 This is a PowerPC 32-bit Linux ABI option.
15310
15311 @item -mprototype
15312 @itemx -mno-prototype
15313 @opindex mprototype
15314 @opindex mno-prototype
15315 On System V.4 and embedded PowerPC systems assume that all calls to
15316 variable argument functions are properly prototyped.  Otherwise, the
15317 compiler must insert an instruction before every non prototyped call to
15318 set or clear bit 6 of the condition code register (@var{CR}) to
15319 indicate whether floating point values were passed in the floating point
15320 registers in case the function takes a variable arguments.  With
15321 @option{-mprototype}, only calls to prototyped variable argument functions
15322 will set or clear the bit.
15323
15324 @item -msim
15325 @opindex msim
15326 On embedded PowerPC systems, assume that the startup module is called
15327 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15328 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
15329 configurations.
15330
15331 @item -mmvme
15332 @opindex mmvme
15333 On embedded PowerPC systems, assume that the startup module is called
15334 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15335 @file{libc.a}.
15336
15337 @item -mads
15338 @opindex mads
15339 On embedded PowerPC systems, assume that the startup module is called
15340 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15341 @file{libc.a}.
15342
15343 @item -myellowknife
15344 @opindex myellowknife
15345 On embedded PowerPC systems, assume that the startup module is called
15346 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15347 @file{libc.a}.
15348
15349 @item -mvxworks
15350 @opindex mvxworks
15351 On System V.4 and embedded PowerPC systems, specify that you are
15352 compiling for a VxWorks system.
15353
15354 @item -memb
15355 @opindex memb
15356 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15357 header to indicate that @samp{eabi} extended relocations are used.
15358
15359 @item -meabi
15360 @itemx -mno-eabi
15361 @opindex meabi
15362 @opindex mno-eabi
15363 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15364 Embedded Applications Binary Interface (eabi) which is a set of
15365 modifications to the System V.4 specifications.  Selecting @option{-meabi}
15366 means that the stack is aligned to an 8 byte boundary, a function
15367 @code{__eabi} is called to from @code{main} to set up the eabi
15368 environment, and the @option{-msdata} option can use both @code{r2} and
15369 @code{r13} to point to two separate small data areas.  Selecting
15370 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15371 do not call an initialization function from @code{main}, and the
15372 @option{-msdata} option will only use @code{r13} to point to a single
15373 small data area.  The @option{-meabi} option is on by default if you
15374 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15375
15376 @item -msdata=eabi
15377 @opindex msdata=eabi
15378 On System V.4 and embedded PowerPC systems, put small initialized
15379 @code{const} global and static data in the @samp{.sdata2} section, which
15380 is pointed to by register @code{r2}.  Put small initialized
15381 non-@code{const} global and static data in the @samp{.sdata} section,
15382 which is pointed to by register @code{r13}.  Put small uninitialized
15383 global and static data in the @samp{.sbss} section, which is adjacent to
15384 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15385 incompatible with the @option{-mrelocatable} option.  The
15386 @option{-msdata=eabi} option also sets the @option{-memb} option.
15387
15388 @item -msdata=sysv
15389 @opindex msdata=sysv
15390 On System V.4 and embedded PowerPC systems, put small global and static
15391 data in the @samp{.sdata} section, which is pointed to by register
15392 @code{r13}.  Put small uninitialized global and static data in the
15393 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15394 The @option{-msdata=sysv} option is incompatible with the
15395 @option{-mrelocatable} option.
15396
15397 @item -msdata=default
15398 @itemx -msdata
15399 @opindex msdata=default
15400 @opindex msdata
15401 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15402 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15403 same as @option{-msdata=sysv}.
15404
15405 @item -msdata=data
15406 @opindex msdata=data
15407 On System V.4 and embedded PowerPC systems, put small global
15408 data in the @samp{.sdata} section.  Put small uninitialized global
15409 data in the @samp{.sbss} section.  Do not use register @code{r13}
15410 to address small data however.  This is the default behavior unless
15411 other @option{-msdata} options are used.
15412
15413 @item -msdata=none
15414 @itemx -mno-sdata
15415 @opindex msdata=none
15416 @opindex mno-sdata
15417 On embedded PowerPC systems, put all initialized global and static data
15418 in the @samp{.data} section, and all uninitialized data in the
15419 @samp{.bss} section.
15420
15421 @item -G @var{num}
15422 @opindex G
15423 @cindex smaller data references (PowerPC)
15424 @cindex .sdata/.sdata2 references (PowerPC)
15425 On embedded PowerPC systems, put global and static items less than or
15426 equal to @var{num} bytes into the small data or bss sections instead of
15427 the normal data or bss section.  By default, @var{num} is 8.  The
15428 @option{-G @var{num}} switch is also passed to the linker.
15429 All modules should be compiled with the same @option{-G @var{num}} value.
15430
15431 @item -mregnames
15432 @itemx -mno-regnames
15433 @opindex mregnames
15434 @opindex mno-regnames
15435 On System V.4 and embedded PowerPC systems do (do not) emit register
15436 names in the assembly language output using symbolic forms.
15437
15438 @item -mlongcall
15439 @itemx -mno-longcall
15440 @opindex mlongcall
15441 @opindex mno-longcall
15442 By default assume that all calls are far away so that a longer more
15443 expensive calling sequence is required.  This is required for calls
15444 further than 32 megabytes (33,554,432 bytes) from the current location.
15445 A short call will be generated if the compiler knows
15446 the call cannot be that far away.  This setting can be overridden by
15447 the @code{shortcall} function attribute, or by @code{#pragma
15448 longcall(0)}.
15449
15450 Some linkers are capable of detecting out-of-range calls and generating
15451 glue code on the fly.  On these systems, long calls are unnecessary and
15452 generate slower code.  As of this writing, the AIX linker can do this,
15453 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15454 to the GNU linker for 32-bit PowerPC systems as well.
15455
15456 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15457 callee, L42'', plus a ``branch island'' (glue code).  The two target
15458 addresses represent the callee and the ``branch island''.  The
15459 Darwin/PPC linker will prefer the first address and generate a ``bl
15460 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15461 otherwise, the linker will generate ``bl L42'' to call the ``branch
15462 island''.  The ``branch island'' is appended to the body of the
15463 calling function; it computes the full 32-bit address of the callee
15464 and jumps to it.
15465
15466 On Mach-O (Darwin) systems, this option directs the compiler emit to
15467 the glue for every direct call, and the Darwin linker decides whether
15468 to use or discard it.
15469
15470 In the future, we may cause GCC to ignore all longcall specifications
15471 when the linker is known to generate glue.
15472
15473 @item -mtls-markers
15474 @itemx -mno-tls-markers
15475 @opindex mtls-markers
15476 @opindex mno-tls-markers
15477 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15478 specifying the function argument.  The relocation allows ld to
15479 reliably associate function call with argument setup instructions for
15480 TLS optimization, which in turn allows gcc to better schedule the
15481 sequence.
15482
15483 @item -pthread
15484 @opindex pthread
15485 Adds support for multithreading with the @dfn{pthreads} library.
15486 This option sets flags for both the preprocessor and linker.
15487
15488 @end table
15489
15490 @node RX Options
15491 @subsection RX Options
15492 @cindex RX Options
15493
15494 These command line options are defined for RX targets:
15495
15496 @table @gcctabopt
15497 @item -m64bit-doubles
15498 @itemx -m32bit-doubles
15499 @opindex m64bit-doubles
15500 @opindex m32bit-doubles
15501 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
15502 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
15503 @option{-m32bit-doubles}.  @emph{Note} RX floating point hardware only
15504 works on 32-bit values, which is why the default is
15505 @option{-m32bit-doubles}.
15506
15507 @item -fpu
15508 @itemx -nofpu
15509 @opindex fpu
15510 @opindex nofpu
15511 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
15512 floating point hardware.  The default is enabled for the @var{RX600}
15513 series and disabled for the @var{RX200} series.
15514
15515 Floating point instructions will only be generated for 32-bit floating
15516 point values however, so if the @option{-m64bit-doubles} option is in
15517 use then the FPU hardware will not be used for doubles.
15518
15519 @emph{Note} If the @option{-fpu} option is enabled then
15520 @option{-funsafe-math-optimizations} is also enabled automatically.
15521 This is because the RX FPU instructions are themselves unsafe.
15522
15523 @item -mcpu=@var{name}
15524 @itemx -patch=@var{name}
15525 @opindex -mcpu
15526 @opindex -patch
15527 Selects the type of RX CPU to be targeted.  Currently three types are
15528 supported, the generic @var{RX600} and @var{RX200} series hardware and
15529 the specific @var{RX610} cpu.  The default is @var{RX600}.
15530
15531 The only difference between @var{RX600} and @var{RX610} is that the
15532 @var{RX610} does not support the @code{MVTIPL} instruction.
15533
15534 The @var{RX200} series does not have a hardware floating point unit
15535 and so @option{-nofpu} is enabled by default when this type is
15536 selected.
15537
15538 @item -mbig-endian-data
15539 @itemx -mlittle-endian-data
15540 @opindex mbig-endian-data
15541 @opindex mlittle-endian-data
15542 Store data (but not code) in the big-endian format.  The default is
15543 @option{-mlittle-endian-data}, ie to store data in the little endian
15544 format.
15545
15546 @item -msmall-data-limit=@var{N}
15547 @opindex msmall-data-limit
15548 Specifies the maximum size in bytes of global and static variables
15549 which can be placed into the small data area.  Using the small data
15550 area can lead to smaller and faster code, but the size of area is
15551 limited and it is up to the programmer to ensure that the area does
15552 not overflow.  Also when the small data area is used one of the RX's
15553 registers (@code{r13}) is reserved for use pointing to this area, so
15554 it is no longer available for use by the compiler.  This could result
15555 in slower and/or larger code if variables which once could have been
15556 held in @code{r13} are now pushed onto the stack.
15557
15558 Note, common variables (variables which have not been initialised) and
15559 constants are not placed into the small data area as they are assigned
15560 to other sections in the output executable.
15561
15562 The default value is zero, which disables this feature.  Note, this
15563 feature is not enabled by default with higher optimization levels
15564 (@option{-O2} etc) because of the potentially detrimental effects of
15565 reserving register @code{r13}.  It is up to the programmer to
15566 experiment and discover whether this feature is of benefit to their
15567 program.
15568
15569 @item -msim
15570 @itemx -mno-sim
15571 @opindex msim
15572 @opindex mno-sim
15573 Use the simulator runtime.  The default is to use the libgloss board
15574 specific runtime.
15575
15576 @item -mas100-syntax
15577 @itemx -mno-as100-syntax
15578 @opindex mas100-syntax
15579 @opindex mno-as100-syntax
15580 When generating assembler output use a syntax that is compatible with
15581 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
15582 assembler but it has some restrictions so generating it is not the
15583 default option.
15584
15585 @item -mmax-constant-size=@var{N}
15586 @opindex mmax-constant-size
15587 Specifies the maximum size, in bytes, of a constant that can be used as
15588 an operand in a RX instruction.  Although the RX instruction set does
15589 allow constants of up to 4 bytes in length to be used in instructions,
15590 a longer value equates to a longer instruction.  Thus in some
15591 circumstances it can be beneficial to restrict the size of constants
15592 that are used in instructions.  Constants that are too big are instead
15593 placed into a constant pool and referenced via register indirection.
15594
15595 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
15596 or 4 means that constants of any size are allowed.
15597
15598 @item -mrelax
15599 @opindex mrelax
15600 Enable linker relaxation.  Linker relaxation is a process whereby the
15601 linker will attempt to reduce the size of a program by finding shorter
15602 versions of various instructions.  Disabled by default.
15603
15604 @item -mint-register=@var{N}
15605 @opindex mint-register
15606 Specify the number of registers to reserve for fast interrupt handler
15607 functions.  The value @var{N} can be between 0 and 4.  A value of 1
15608 means that register @code{r13} will be reserved for the exclusive use
15609 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
15610 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
15611 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
15612 A value of 0, the default, does not reserve any registers.
15613
15614 @item -msave-acc-in-interrupts
15615 @opindex msave-acc-in-interrupts
15616 Specifies that interrupt handler functions should preserve the
15617 accumulator register.  This is only necessary if normal code might use
15618 the accumulator register, for example because it performs 64-bit
15619 multiplications.  The default is to ignore the accumulator as this
15620 makes the interrupt handlers faster.
15621
15622 @end table
15623
15624 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
15625 has special significance to the RX port when used with the
15626 @code{interrupt} function attribute.  This attribute indicates a
15627 function intended to process fast interrupts.  GCC will will ensure
15628 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
15629 and/or @code{r13} and only provided that the normal use of the
15630 corresponding registers have been restricted via the
15631 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
15632 options.
15633
15634 @node S/390 and zSeries Options
15635 @subsection S/390 and zSeries Options
15636 @cindex S/390 and zSeries Options
15637
15638 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
15639
15640 @table @gcctabopt
15641 @item -mhard-float
15642 @itemx -msoft-float
15643 @opindex mhard-float
15644 @opindex msoft-float
15645 Use (do not use) the hardware floating-point instructions and registers
15646 for floating-point operations.  When @option{-msoft-float} is specified,
15647 functions in @file{libgcc.a} will be used to perform floating-point
15648 operations.  When @option{-mhard-float} is specified, the compiler
15649 generates IEEE floating-point instructions.  This is the default.
15650
15651 @item -mhard-dfp
15652 @itemx -mno-hard-dfp
15653 @opindex mhard-dfp
15654 @opindex mno-hard-dfp
15655 Use (do not use) the hardware decimal-floating-point instructions for
15656 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
15657 specified, functions in @file{libgcc.a} will be used to perform
15658 decimal-floating-point operations.  When @option{-mhard-dfp} is
15659 specified, the compiler generates decimal-floating-point hardware
15660 instructions.  This is the default for @option{-march=z9-ec} or higher.
15661
15662 @item -mlong-double-64
15663 @itemx -mlong-double-128
15664 @opindex mlong-double-64
15665 @opindex mlong-double-128
15666 These switches control the size of @code{long double} type. A size
15667 of 64bit makes the @code{long double} type equivalent to the @code{double}
15668 type. This is the default.
15669
15670 @item -mbackchain
15671 @itemx -mno-backchain
15672 @opindex mbackchain
15673 @opindex mno-backchain
15674 Store (do not store) the address of the caller's frame as backchain pointer
15675 into the callee's stack frame.
15676 A backchain may be needed to allow debugging using tools that do not understand
15677 DWARF-2 call frame information.
15678 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
15679 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
15680 the backchain is placed into the topmost word of the 96/160 byte register
15681 save area.
15682
15683 In general, code compiled with @option{-mbackchain} is call-compatible with
15684 code compiled with @option{-mmo-backchain}; however, use of the backchain
15685 for debugging purposes usually requires that the whole binary is built with
15686 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
15687 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15688 to build a linux kernel use @option{-msoft-float}.
15689
15690 The default is to not maintain the backchain.
15691
15692 @item -mpacked-stack
15693 @itemx -mno-packed-stack
15694 @opindex mpacked-stack
15695 @opindex mno-packed-stack
15696 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
15697 specified, the compiler uses the all fields of the 96/160 byte register save
15698 area only for their default purpose; unused fields still take up stack space.
15699 When @option{-mpacked-stack} is specified, register save slots are densely
15700 packed at the top of the register save area; unused space is reused for other
15701 purposes, allowing for more efficient use of the available stack space.
15702 However, when @option{-mbackchain} is also in effect, the topmost word of
15703 the save area is always used to store the backchain, and the return address
15704 register is always saved two words below the backchain.
15705
15706 As long as the stack frame backchain is not used, code generated with
15707 @option{-mpacked-stack} is call-compatible with code generated with
15708 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
15709 S/390 or zSeries generated code that uses the stack frame backchain at run
15710 time, not just for debugging purposes.  Such code is not call-compatible
15711 with code compiled with @option{-mpacked-stack}.  Also, note that the
15712 combination of @option{-mbackchain},
15713 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15714 to build a linux kernel use @option{-msoft-float}.
15715
15716 The default is to not use the packed stack layout.
15717
15718 @item -msmall-exec
15719 @itemx -mno-small-exec
15720 @opindex msmall-exec
15721 @opindex mno-small-exec
15722 Generate (or do not generate) code using the @code{bras} instruction
15723 to do subroutine calls.
15724 This only works reliably if the total executable size does not
15725 exceed 64k.  The default is to use the @code{basr} instruction instead,
15726 which does not have this limitation.
15727
15728 @item -m64
15729 @itemx -m31
15730 @opindex m64
15731 @opindex m31
15732 When @option{-m31} is specified, generate code compliant to the
15733 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
15734 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
15735 particular to generate 64-bit instructions.  For the @samp{s390}
15736 targets, the default is @option{-m31}, while the @samp{s390x}
15737 targets default to @option{-m64}.
15738
15739 @item -mzarch
15740 @itemx -mesa
15741 @opindex mzarch
15742 @opindex mesa
15743 When @option{-mzarch} is specified, generate code using the
15744 instructions available on z/Architecture.
15745 When @option{-mesa} is specified, generate code using the
15746 instructions available on ESA/390.  Note that @option{-mesa} is
15747 not possible with @option{-m64}.
15748 When generating code compliant to the GNU/Linux for S/390 ABI,
15749 the default is @option{-mesa}.  When generating code compliant
15750 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
15751
15752 @item -mmvcle
15753 @itemx -mno-mvcle
15754 @opindex mmvcle
15755 @opindex mno-mvcle
15756 Generate (or do not generate) code using the @code{mvcle} instruction
15757 to perform block moves.  When @option{-mno-mvcle} is specified,
15758 use a @code{mvc} loop instead.  This is the default unless optimizing for
15759 size.
15760
15761 @item -mdebug
15762 @itemx -mno-debug
15763 @opindex mdebug
15764 @opindex mno-debug
15765 Print (or do not print) additional debug information when compiling.
15766 The default is to not print debug information.
15767
15768 @item -march=@var{cpu-type}
15769 @opindex march
15770 Generate code that will run on @var{cpu-type}, which is the name of a system
15771 representing a certain processor type.  Possible values for
15772 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
15773 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
15774 When generating code using the instructions available on z/Architecture,
15775 the default is @option{-march=z900}.  Otherwise, the default is
15776 @option{-march=g5}.
15777
15778 @item -mtune=@var{cpu-type}
15779 @opindex mtune
15780 Tune to @var{cpu-type} everything applicable about the generated code,
15781 except for the ABI and the set of available instructions.
15782 The list of @var{cpu-type} values is the same as for @option{-march}.
15783 The default is the value used for @option{-march}.
15784
15785 @item -mtpf-trace
15786 @itemx -mno-tpf-trace
15787 @opindex mtpf-trace
15788 @opindex mno-tpf-trace
15789 Generate code that adds (does not add) in TPF OS specific branches to trace
15790 routines in the operating system.  This option is off by default, even
15791 when compiling for the TPF OS@.
15792
15793 @item -mfused-madd
15794 @itemx -mno-fused-madd
15795 @opindex mfused-madd
15796 @opindex mno-fused-madd
15797 Generate code that uses (does not use) the floating point multiply and
15798 accumulate instructions.  These instructions are generated by default if
15799 hardware floating point is used.
15800
15801 @item -mwarn-framesize=@var{framesize}
15802 @opindex mwarn-framesize
15803 Emit a warning if the current function exceeds the given frame size.  Because
15804 this is a compile time check it doesn't need to be a real problem when the program
15805 runs.  It is intended to identify functions which most probably cause
15806 a stack overflow.  It is useful to be used in an environment with limited stack
15807 size e.g.@: the linux kernel.
15808
15809 @item -mwarn-dynamicstack
15810 @opindex mwarn-dynamicstack
15811 Emit a warning if the function calls alloca or uses dynamically
15812 sized arrays.  This is generally a bad idea with a limited stack size.
15813
15814 @item -mstack-guard=@var{stack-guard}
15815 @itemx -mstack-size=@var{stack-size}
15816 @opindex mstack-guard
15817 @opindex mstack-size
15818 If these options are provided the s390 back end emits additional instructions in
15819 the function prologue which trigger a trap if the stack size is @var{stack-guard}
15820 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
15821 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
15822 the frame size of the compiled function is chosen.
15823 These options are intended to be used to help debugging stack overflow problems.
15824 The additionally emitted code causes only little overhead and hence can also be
15825 used in production like systems without greater performance degradation.  The given
15826 values have to be exact powers of 2 and @var{stack-size} has to be greater than
15827 @var{stack-guard} without exceeding 64k.
15828 In order to be efficient the extra code makes the assumption that the stack starts
15829 at an address aligned to the value given by @var{stack-size}.
15830 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
15831 @end table
15832
15833 @node Score Options
15834 @subsection Score Options
15835 @cindex Score Options
15836
15837 These options are defined for Score implementations:
15838
15839 @table @gcctabopt
15840 @item -meb
15841 @opindex meb
15842 Compile code for big endian mode.  This is the default.
15843
15844 @item -mel
15845 @opindex mel
15846 Compile code for little endian mode.
15847
15848 @item -mnhwloop
15849 @opindex mnhwloop
15850 Disable generate bcnz instruction.
15851
15852 @item -muls
15853 @opindex muls
15854 Enable generate unaligned load and store instruction.
15855
15856 @item -mmac
15857 @opindex mmac
15858 Enable the use of multiply-accumulate instructions. Disabled by default.
15859
15860 @item -mscore5
15861 @opindex mscore5
15862 Specify the SCORE5 as the target architecture.
15863
15864 @item -mscore5u
15865 @opindex mscore5u
15866 Specify the SCORE5U of the target architecture.
15867
15868 @item -mscore7
15869 @opindex mscore7
15870 Specify the SCORE7 as the target architecture. This is the default.
15871
15872 @item -mscore7d
15873 @opindex mscore7d
15874 Specify the SCORE7D as the target architecture.
15875 @end table
15876
15877 @node SH Options
15878 @subsection SH Options
15879
15880 These @samp{-m} options are defined for the SH implementations:
15881
15882 @table @gcctabopt
15883 @item -m1
15884 @opindex m1
15885 Generate code for the SH1.
15886
15887 @item -m2
15888 @opindex m2
15889 Generate code for the SH2.
15890
15891 @item -m2e
15892 Generate code for the SH2e.
15893
15894 @item -m2a-nofpu
15895 @opindex m2a-nofpu
15896 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
15897 that the floating-point unit is not used.
15898
15899 @item -m2a-single-only
15900 @opindex m2a-single-only
15901 Generate code for the SH2a-FPU, in such a way that no double-precision
15902 floating point operations are used.
15903
15904 @item -m2a-single
15905 @opindex m2a-single
15906 Generate code for the SH2a-FPU assuming the floating-point unit is in
15907 single-precision mode by default.
15908
15909 @item -m2a
15910 @opindex m2a
15911 Generate code for the SH2a-FPU assuming the floating-point unit is in
15912 double-precision mode by default.
15913
15914 @item -m3
15915 @opindex m3
15916 Generate code for the SH3.
15917
15918 @item -m3e
15919 @opindex m3e
15920 Generate code for the SH3e.
15921
15922 @item -m4-nofpu
15923 @opindex m4-nofpu
15924 Generate code for the SH4 without a floating-point unit.
15925
15926 @item -m4-single-only
15927 @opindex m4-single-only
15928 Generate code for the SH4 with a floating-point unit that only
15929 supports single-precision arithmetic.
15930
15931 @item -m4-single
15932 @opindex m4-single
15933 Generate code for the SH4 assuming the floating-point unit is in
15934 single-precision mode by default.
15935
15936 @item -m4
15937 @opindex m4
15938 Generate code for the SH4.
15939
15940 @item -m4a-nofpu
15941 @opindex m4a-nofpu
15942 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
15943 floating-point unit is not used.
15944
15945 @item -m4a-single-only
15946 @opindex m4a-single-only
15947 Generate code for the SH4a, in such a way that no double-precision
15948 floating point operations are used.
15949
15950 @item -m4a-single
15951 @opindex m4a-single
15952 Generate code for the SH4a assuming the floating-point unit is in
15953 single-precision mode by default.
15954
15955 @item -m4a
15956 @opindex m4a
15957 Generate code for the SH4a.
15958
15959 @item -m4al
15960 @opindex m4al
15961 Same as @option{-m4a-nofpu}, except that it implicitly passes
15962 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
15963 instructions at the moment.
15964
15965 @item -mb
15966 @opindex mb
15967 Compile code for the processor in big endian mode.
15968
15969 @item -ml
15970 @opindex ml
15971 Compile code for the processor in little endian mode.
15972
15973 @item -mdalign
15974 @opindex mdalign
15975 Align doubles at 64-bit boundaries.  Note that this changes the calling
15976 conventions, and thus some functions from the standard C library will
15977 not work unless you recompile it first with @option{-mdalign}.
15978
15979 @item -mrelax
15980 @opindex mrelax
15981 Shorten some address references at link time, when possible; uses the
15982 linker option @option{-relax}.
15983
15984 @item -mbigtable
15985 @opindex mbigtable
15986 Use 32-bit offsets in @code{switch} tables.  The default is to use
15987 16-bit offsets.
15988
15989 @item -mbitops
15990 @opindex mbitops
15991 Enable the use of bit manipulation instructions on SH2A.
15992
15993 @item -mfmovd
15994 @opindex mfmovd
15995 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
15996 alignment constraints.
15997
15998 @item -mhitachi
15999 @opindex mhitachi
16000 Comply with the calling conventions defined by Renesas.
16001
16002 @item -mrenesas
16003 @opindex mhitachi
16004 Comply with the calling conventions defined by Renesas.
16005
16006 @item -mno-renesas
16007 @opindex mhitachi
16008 Comply with the calling conventions defined for GCC before the Renesas
16009 conventions were available.  This option is the default for all
16010 targets of the SH toolchain except for @samp{sh-symbianelf}.
16011
16012 @item -mnomacsave
16013 @opindex mnomacsave
16014 Mark the @code{MAC} register as call-clobbered, even if
16015 @option{-mhitachi} is given.
16016
16017 @item -mieee
16018 @opindex mieee
16019 Increase IEEE-compliance of floating-point code.
16020 At the moment, this is equivalent to @option{-fno-finite-math-only}.
16021 When generating 16 bit SH opcodes, getting IEEE-conforming results for
16022 comparisons of NANs / infinities incurs extra overhead in every
16023 floating point comparison, therefore the default is set to
16024 @option{-ffinite-math-only}.
16025
16026 @item -minline-ic_invalidate
16027 @opindex minline-ic_invalidate
16028 Inline code to invalidate instruction cache entries after setting up
16029 nested function trampolines.
16030 This option has no effect if -musermode is in effect and the selected
16031 code generation option (e.g. -m4) does not allow the use of the icbi
16032 instruction.
16033 If the selected code generation option does not allow the use of the icbi
16034 instruction, and -musermode is not in effect, the inlined code will
16035 manipulate the instruction cache address array directly with an associative
16036 write.  This not only requires privileged mode, but it will also
16037 fail if the cache line had been mapped via the TLB and has become unmapped.
16038
16039 @item -misize
16040 @opindex misize
16041 Dump instruction size and location in the assembly code.
16042
16043 @item -mpadstruct
16044 @opindex mpadstruct
16045 This option is deprecated.  It pads structures to multiple of 4 bytes,
16046 which is incompatible with the SH ABI@.
16047
16048 @item -mspace
16049 @opindex mspace
16050 Optimize for space instead of speed.  Implied by @option{-Os}.
16051
16052 @item -mprefergot
16053 @opindex mprefergot
16054 When generating position-independent code, emit function calls using
16055 the Global Offset Table instead of the Procedure Linkage Table.
16056
16057 @item -musermode
16058 @opindex musermode
16059 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16060 if the inlined code would not work in user mode.
16061 This is the default when the target is @code{sh-*-linux*}.
16062
16063 @item -multcost=@var{number}
16064 @opindex multcost=@var{number}
16065 Set the cost to assume for a multiply insn.
16066
16067 @item -mdiv=@var{strategy}
16068 @opindex mdiv=@var{strategy}
16069 Set the division strategy to use for SHmedia code.  @var{strategy} must be
16070 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16071 inv:call2, inv:fp .
16072 "fp" performs the operation in floating point.  This has a very high latency,
16073 but needs only a few instructions, so it might be a good choice if
16074 your code has enough easily exploitable ILP to allow the compiler to
16075 schedule the floating point instructions together with other instructions.
16076 Division by zero causes a floating point exception.
16077 "inv" uses integer operations to calculate the inverse of the divisor,
16078 and then multiplies the dividend with the inverse.  This strategy allows
16079 cse and hoisting of the inverse calculation.  Division by zero calculates
16080 an unspecified result, but does not trap.
16081 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16082 have been found, or if the entire operation has been hoisted to the same
16083 place, the last stages of the inverse calculation are intertwined with the
16084 final multiply to reduce the overall latency, at the expense of using a few
16085 more instructions, and thus offering fewer scheduling opportunities with
16086 other code.
16087 "call" calls a library function that usually implements the inv:minlat
16088 strategy.
16089 This gives high code density for m5-*media-nofpu compilations.
16090 "call2" uses a different entry point of the same library function, where it
16091 assumes that a pointer to a lookup table has already been set up, which
16092 exposes the pointer load to cse / code hoisting optimizations.
16093 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16094 code generation, but if the code stays unoptimized, revert to the "call",
16095 "call2", or "fp" strategies, respectively.  Note that the
16096 potentially-trapping side effect of division by zero is carried by a
16097 separate instruction, so it is possible that all the integer instructions
16098 are hoisted out, but the marker for the side effect stays where it is.
16099 A recombination to fp operations or a call is not possible in that case.
16100 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16101 that the inverse calculation was nor separated from the multiply, they speed
16102 up division where the dividend fits into 20 bits (plus sign where applicable),
16103 by inserting a test to skip a number of operations in this case; this test
16104 slows down the case of larger dividends.  inv20u assumes the case of a such
16105 a small dividend to be unlikely, and inv20l assumes it to be likely.
16106
16107 @item -mdivsi3_libfunc=@var{name}
16108 @opindex mdivsi3_libfunc=@var{name}
16109 Set the name of the library function used for 32 bit signed division to
16110 @var{name}.  This only affect the name used in the call and inv:call
16111 division strategies, and the compiler will still expect the same
16112 sets of input/output/clobbered registers as if this option was not present.
16113
16114 @item -mfixed-range=@var{register-range}
16115 @opindex mfixed-range
16116 Generate code treating the given register range as fixed registers.
16117 A fixed register is one that the register allocator can not use.  This is
16118 useful when compiling kernel code.  A register range is specified as
16119 two registers separated by a dash.  Multiple register ranges can be
16120 specified separated by a comma.
16121
16122 @item -madjust-unroll
16123 @opindex madjust-unroll
16124 Throttle unrolling to avoid thrashing target registers.
16125 This option only has an effect if the gcc code base supports the
16126 TARGET_ADJUST_UNROLL_MAX target hook.
16127
16128 @item -mindexed-addressing
16129 @opindex mindexed-addressing
16130 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16131 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16132 semantics for the indexed addressing mode.  The architecture allows the
16133 implementation of processors with 64 bit MMU, which the OS could use to
16134 get 32 bit addressing, but since no current hardware implementation supports
16135 this or any other way to make the indexed addressing mode safe to use in
16136 the 32 bit ABI, the default is -mno-indexed-addressing.
16137
16138 @item -mgettrcost=@var{number}
16139 @opindex mgettrcost=@var{number}
16140 Set the cost assumed for the gettr instruction to @var{number}.
16141 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16142
16143 @item -mpt-fixed
16144 @opindex mpt-fixed
16145 Assume pt* instructions won't trap.  This will generally generate better
16146 scheduled code, but is unsafe on current hardware.  The current architecture
16147 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16148 This has the unintentional effect of making it unsafe to schedule ptabs /
16149 ptrel before a branch, or hoist it out of a loop.  For example,
16150 __do_global_ctors, a part of libgcc that runs constructors at program
16151 startup, calls functions in a list which is delimited by @minus{}1.  With the
16152 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16153 That means that all the constructors will be run a bit quicker, but when
16154 the loop comes to the end of the list, the program crashes because ptabs
16155 loads @minus{}1 into a target register.  Since this option is unsafe for any
16156 hardware implementing the current architecture specification, the default
16157 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16158 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16159 this deters register allocation using target registers for storing
16160 ordinary integers.
16161
16162 @item -minvalid-symbols
16163 @opindex minvalid-symbols
16164 Assume symbols might be invalid.  Ordinary function symbols generated by
16165 the compiler will always be valid to load with movi/shori/ptabs or
16166 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16167 to generate symbols that will cause ptabs / ptrel to trap.
16168 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16169 It will then prevent cross-basic-block cse, hoisting and most scheduling
16170 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16171 @end table
16172
16173 @node SPARC Options
16174 @subsection SPARC Options
16175 @cindex SPARC options
16176
16177 These @samp{-m} options are supported on the SPARC:
16178
16179 @table @gcctabopt
16180 @item -mno-app-regs
16181 @itemx -mapp-regs
16182 @opindex mno-app-regs
16183 @opindex mapp-regs
16184 Specify @option{-mapp-regs} to generate output using the global registers
16185 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
16186 is the default.
16187
16188 To be fully SVR4 ABI compliant at the cost of some performance loss,
16189 specify @option{-mno-app-regs}.  You should compile libraries and system
16190 software with this option.
16191
16192 @item -mfpu
16193 @itemx -mhard-float
16194 @opindex mfpu
16195 @opindex mhard-float
16196 Generate output containing floating point instructions.  This is the
16197 default.
16198
16199 @item -mno-fpu
16200 @itemx -msoft-float
16201 @opindex mno-fpu
16202 @opindex msoft-float
16203 Generate output containing library calls for floating point.
16204 @strong{Warning:} the requisite libraries are not available for all SPARC
16205 targets.  Normally the facilities of the machine's usual C compiler are
16206 used, but this cannot be done directly in cross-compilation.  You must make
16207 your own arrangements to provide suitable library functions for
16208 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
16209 @samp{sparclite-*-*} do provide software floating point support.
16210
16211 @option{-msoft-float} changes the calling convention in the output file;
16212 therefore, it is only useful if you compile @emph{all} of a program with
16213 this option.  In particular, you need to compile @file{libgcc.a}, the
16214 library that comes with GCC, with @option{-msoft-float} in order for
16215 this to work.
16216
16217 @item -mhard-quad-float
16218 @opindex mhard-quad-float
16219 Generate output containing quad-word (long double) floating point
16220 instructions.
16221
16222 @item -msoft-quad-float
16223 @opindex msoft-quad-float
16224 Generate output containing library calls for quad-word (long double)
16225 floating point instructions.  The functions called are those specified
16226 in the SPARC ABI@.  This is the default.
16227
16228 As of this writing, there are no SPARC implementations that have hardware
16229 support for the quad-word floating point instructions.  They all invoke
16230 a trap handler for one of these instructions, and then the trap handler
16231 emulates the effect of the instruction.  Because of the trap handler overhead,
16232 this is much slower than calling the ABI library routines.  Thus the
16233 @option{-msoft-quad-float} option is the default.
16234
16235 @item -mno-unaligned-doubles
16236 @itemx -munaligned-doubles
16237 @opindex mno-unaligned-doubles
16238 @opindex munaligned-doubles
16239 Assume that doubles have 8 byte alignment.  This is the default.
16240
16241 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16242 alignment only if they are contained in another type, or if they have an
16243 absolute address.  Otherwise, it assumes they have 4 byte alignment.
16244 Specifying this option avoids some rare compatibility problems with code
16245 generated by other compilers.  It is not the default because it results
16246 in a performance loss, especially for floating point code.
16247
16248 @item -mno-faster-structs
16249 @itemx -mfaster-structs
16250 @opindex mno-faster-structs
16251 @opindex mfaster-structs
16252 With @option{-mfaster-structs}, the compiler assumes that structures
16253 should have 8 byte alignment.  This enables the use of pairs of
16254 @code{ldd} and @code{std} instructions for copies in structure
16255 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16256 However, the use of this changed alignment directly violates the SPARC
16257 ABI@.  Thus, it's intended only for use on targets where the developer
16258 acknowledges that their resulting code will not be directly in line with
16259 the rules of the ABI@.
16260
16261 @item -mimpure-text
16262 @opindex mimpure-text
16263 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16264 the compiler to not pass @option{-z text} to the linker when linking a
16265 shared object.  Using this option, you can link position-dependent
16266 code into a shared object.
16267
16268 @option{-mimpure-text} suppresses the ``relocations remain against
16269 allocatable but non-writable sections'' linker error message.
16270 However, the necessary relocations will trigger copy-on-write, and the
16271 shared object is not actually shared across processes.  Instead of
16272 using @option{-mimpure-text}, you should compile all source code with
16273 @option{-fpic} or @option{-fPIC}.
16274
16275 This option is only available on SunOS and Solaris.
16276
16277 @item -mcpu=@var{cpu_type}
16278 @opindex mcpu
16279 Set the instruction set, register set, and instruction scheduling parameters
16280 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
16281 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
16282 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
16283 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16284 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16285
16286 Default instruction scheduling parameters are used for values that select
16287 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
16288 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16289
16290 Here is a list of each supported architecture and their supported
16291 implementations.
16292
16293 @smallexample
16294     v7:             cypress
16295     v8:             supersparc, hypersparc
16296     sparclite:      f930, f934, sparclite86x
16297     sparclet:       tsc701
16298     v9:             ultrasparc, ultrasparc3, niagara, niagara2
16299 @end smallexample
16300
16301 By default (unless configured otherwise), GCC generates code for the V7
16302 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
16303 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16304 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
16305 SPARCStation 1, 2, IPX etc.
16306
16307 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
16308 architecture.  The only difference from V7 code is that the compiler emits
16309 the integer multiply and integer divide instructions which exist in SPARC-V8
16310 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
16311 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
16312 2000 series.
16313
16314 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
16315 the SPARC architecture.  This adds the integer multiply, integer divide step
16316 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
16317 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
16318 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
16319 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
16320 MB86934 chip, which is the more recent SPARClite with FPU@.
16321
16322 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
16323 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
16324 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
16325 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
16326 optimizes it for the TEMIC SPARClet chip.
16327
16328 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
16329 architecture.  This adds 64-bit integer and floating-point move instructions,
16330 3 additional floating-point condition code registers and conditional move
16331 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
16332 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
16333 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
16334 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
16335 @option{-mcpu=niagara}, the compiler additionally optimizes it for
16336 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
16337 additionally optimizes it for Sun UltraSPARC T2 chips.
16338
16339 @item -mtune=@var{cpu_type}
16340 @opindex mtune
16341 Set the instruction scheduling parameters for machine type
16342 @var{cpu_type}, but do not set the instruction set or register set that the
16343 option @option{-mcpu=@var{cpu_type}} would.
16344
16345 The same values for @option{-mcpu=@var{cpu_type}} can be used for
16346 @option{-mtune=@var{cpu_type}}, but the only useful values are those
16347 that select a particular cpu implementation.  Those are @samp{cypress},
16348 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
16349 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
16350 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
16351
16352 @item -mv8plus
16353 @itemx -mno-v8plus
16354 @opindex mv8plus
16355 @opindex mno-v8plus
16356 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
16357 difference from the V8 ABI is that the global and out registers are
16358 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
16359 mode for all SPARC-V9 processors.
16360
16361 @item -mvis
16362 @itemx -mno-vis
16363 @opindex mvis
16364 @opindex mno-vis
16365 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
16366 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
16367 @end table
16368
16369 These @samp{-m} options are supported in addition to the above
16370 on SPARC-V9 processors in 64-bit environments:
16371
16372 @table @gcctabopt
16373 @item -mlittle-endian
16374 @opindex mlittle-endian
16375 Generate code for a processor running in little-endian mode.  It is only
16376 available for a few configurations and most notably not on Solaris and Linux.
16377
16378 @item -m32
16379 @itemx -m64
16380 @opindex m32
16381 @opindex m64
16382 Generate code for a 32-bit or 64-bit environment.
16383 The 32-bit environment sets int, long and pointer to 32 bits.
16384 The 64-bit environment sets int to 32 bits and long and pointer
16385 to 64 bits.
16386
16387 @item -mcmodel=medlow
16388 @opindex mcmodel=medlow
16389 Generate code for the Medium/Low code model: 64-bit addresses, programs
16390 must be linked in the low 32 bits of memory.  Programs can be statically
16391 or dynamically linked.
16392
16393 @item -mcmodel=medmid
16394 @opindex mcmodel=medmid
16395 Generate code for the Medium/Middle code model: 64-bit addresses, programs
16396 must be linked in the low 44 bits of memory, the text and data segments must
16397 be less than 2GB in size and the data segment must be located within 2GB of
16398 the text segment.
16399
16400 @item -mcmodel=medany
16401 @opindex mcmodel=medany
16402 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
16403 may be linked anywhere in memory, the text and data segments must be less
16404 than 2GB in size and the data segment must be located within 2GB of the
16405 text segment.
16406
16407 @item -mcmodel=embmedany
16408 @opindex mcmodel=embmedany
16409 Generate code for the Medium/Anywhere code model for embedded systems:
16410 64-bit addresses, the text and data segments must be less than 2GB in
16411 size, both starting anywhere in memory (determined at link time).  The
16412 global register %g4 points to the base of the data segment.  Programs
16413 are statically linked and PIC is not supported.
16414
16415 @item -mstack-bias
16416 @itemx -mno-stack-bias
16417 @opindex mstack-bias
16418 @opindex mno-stack-bias
16419 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
16420 frame pointer if present, are offset by @minus{}2047 which must be added back
16421 when making stack frame references.  This is the default in 64-bit mode.
16422 Otherwise, assume no such offset is present.
16423 @end table
16424
16425 These switches are supported in addition to the above on Solaris:
16426
16427 @table @gcctabopt
16428 @item -threads
16429 @opindex threads
16430 Add support for multithreading using the Solaris threads library.  This
16431 option sets flags for both the preprocessor and linker.  This option does
16432 not affect the thread safety of object code produced by the compiler or
16433 that of libraries supplied with it.
16434
16435 @item -pthreads
16436 @opindex pthreads
16437 Add support for multithreading using the POSIX threads library.  This
16438 option sets flags for both the preprocessor and linker.  This option does
16439 not affect the thread safety of object code produced  by the compiler or
16440 that of libraries supplied with it.
16441
16442 @item -pthread
16443 @opindex pthread
16444 This is a synonym for @option{-pthreads}.
16445 @end table
16446
16447 @node SPU Options
16448 @subsection SPU Options
16449 @cindex SPU options
16450
16451 These @samp{-m} options are supported on the SPU:
16452
16453 @table @gcctabopt
16454 @item -mwarn-reloc
16455 @itemx -merror-reloc
16456 @opindex mwarn-reloc
16457 @opindex merror-reloc
16458
16459 The loader for SPU does not handle dynamic relocations.  By default, GCC
16460 will give an error when it generates code that requires a dynamic
16461 relocation.  @option{-mno-error-reloc} disables the error,
16462 @option{-mwarn-reloc} will generate a warning instead.
16463
16464 @item -msafe-dma
16465 @itemx -munsafe-dma
16466 @opindex msafe-dma
16467 @opindex munsafe-dma
16468
16469 Instructions which initiate or test completion of DMA must not be
16470 reordered with respect to loads and stores of the memory which is being
16471 accessed.  Users typically address this problem using the volatile
16472 keyword, but that can lead to inefficient code in places where the
16473 memory is known to not change.  Rather than mark the memory as volatile
16474 we treat the DMA instructions as potentially effecting all memory.  With
16475 @option{-munsafe-dma} users must use the volatile keyword to protect
16476 memory accesses.
16477
16478 @item -mbranch-hints
16479 @opindex mbranch-hints
16480
16481 By default, GCC will generate a branch hint instruction to avoid
16482 pipeline stalls for always taken or probably taken branches.  A hint
16483 will not be generated closer than 8 instructions away from its branch.
16484 There is little reason to disable them, except for debugging purposes,
16485 or to make an object a little bit smaller.
16486
16487 @item -msmall-mem
16488 @itemx -mlarge-mem
16489 @opindex msmall-mem
16490 @opindex mlarge-mem
16491
16492 By default, GCC generates code assuming that addresses are never larger
16493 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
16494 a full 32 bit address.
16495
16496 @item -mstdmain
16497 @opindex mstdmain
16498
16499 By default, GCC links against startup code that assumes the SPU-style
16500 main function interface (which has an unconventional parameter list).
16501 With @option{-mstdmain}, GCC will link your program against startup
16502 code that assumes a C99-style interface to @code{main}, including a
16503 local copy of @code{argv} strings.
16504
16505 @item -mfixed-range=@var{register-range}
16506 @opindex mfixed-range
16507 Generate code treating the given register range as fixed registers.
16508 A fixed register is one that the register allocator can not use.  This is
16509 useful when compiling kernel code.  A register range is specified as
16510 two registers separated by a dash.  Multiple register ranges can be
16511 specified separated by a comma.
16512
16513 @item -mea32
16514 @itemx -mea64
16515 @opindex mea32
16516 @opindex mea64
16517 Compile code assuming that pointers to the PPU address space accessed
16518 via the @code{__ea} named address space qualifier are either 32 or 64
16519 bits wide.  The default is 32 bits.  As this is an ABI changing option,
16520 all object code in an executable must be compiled with the same setting.
16521
16522 @item -maddress-space-conversion
16523 @itemx -mno-address-space-conversion
16524 @opindex maddress-space-conversion
16525 @opindex mno-address-space-conversion
16526 Allow/disallow treating the @code{__ea} address space as superset
16527 of the generic address space.  This enables explicit type casts
16528 between @code{__ea} and generic pointer as well as implicit
16529 conversions of generic pointers to @code{__ea} pointers.  The
16530 default is to allow address space pointer conversions.
16531
16532 @item -mcache-size=@var{cache-size}
16533 @opindex mcache-size
16534 This option controls the version of libgcc that the compiler links to an
16535 executable and selects a software-managed cache for accessing variables
16536 in the @code{__ea} address space with a particular cache size.  Possible
16537 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
16538 and @samp{128}.  The default cache size is 64KB.
16539
16540 @item -matomic-updates
16541 @itemx -mno-atomic-updates
16542 @opindex matomic-updates
16543 @opindex mno-atomic-updates
16544 This option controls the version of libgcc that the compiler links to an
16545 executable and selects whether atomic updates to the software-managed
16546 cache of PPU-side variables are used.  If you use atomic updates, changes
16547 to a PPU variable from SPU code using the @code{__ea} named address space
16548 qualifier will not interfere with changes to other PPU variables residing
16549 in the same cache line from PPU code.  If you do not use atomic updates,
16550 such interference may occur; however, writing back cache lines will be
16551 more efficient.  The default behavior is to use atomic updates.
16552
16553 @item -mdual-nops
16554 @itemx -mdual-nops=@var{n}
16555 @opindex mdual-nops
16556 By default, GCC will insert nops to increase dual issue when it expects
16557 it to increase performance.  @var{n} can be a value from 0 to 10.  A
16558 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
16559 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
16560
16561 @item -mhint-max-nops=@var{n}
16562 @opindex mhint-max-nops
16563 Maximum number of nops to insert for a branch hint.  A branch hint must
16564 be at least 8 instructions away from the branch it is effecting.  GCC
16565 will insert up to @var{n} nops to enforce this, otherwise it will not
16566 generate the branch hint.
16567
16568 @item -mhint-max-distance=@var{n}
16569 @opindex mhint-max-distance
16570 The encoding of the branch hint instruction limits the hint to be within
16571 256 instructions of the branch it is effecting.  By default, GCC makes
16572 sure it is within 125.
16573
16574 @item -msafe-hints
16575 @opindex msafe-hints
16576 Work around a hardware bug which causes the SPU to stall indefinitely.
16577 By default, GCC will insert the @code{hbrp} instruction to make sure
16578 this stall won't happen.
16579
16580 @end table
16581
16582 @node System V Options
16583 @subsection Options for System V
16584
16585 These additional options are available on System V Release 4 for
16586 compatibility with other compilers on those systems:
16587
16588 @table @gcctabopt
16589 @item -G
16590 @opindex G
16591 Create a shared object.
16592 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
16593
16594 @item -Qy
16595 @opindex Qy
16596 Identify the versions of each tool used by the compiler, in a
16597 @code{.ident} assembler directive in the output.
16598
16599 @item -Qn
16600 @opindex Qn
16601 Refrain from adding @code{.ident} directives to the output file (this is
16602 the default).
16603
16604 @item -YP,@var{dirs}
16605 @opindex YP
16606 Search the directories @var{dirs}, and no others, for libraries
16607 specified with @option{-l}.
16608
16609 @item -Ym,@var{dir}
16610 @opindex Ym
16611 Look in the directory @var{dir} to find the M4 preprocessor.
16612 The assembler uses this option.
16613 @c This is supposed to go with a -Yd for predefined M4 macro files, but
16614 @c the generic assembler that comes with Solaris takes just -Ym.
16615 @end table
16616
16617 @node V850 Options
16618 @subsection V850 Options
16619 @cindex V850 Options
16620
16621 These @samp{-m} options are defined for V850 implementations:
16622
16623 @table @gcctabopt
16624 @item -mlong-calls
16625 @itemx -mno-long-calls
16626 @opindex mlong-calls
16627 @opindex mno-long-calls
16628 Treat all calls as being far away (near).  If calls are assumed to be
16629 far away, the compiler will always load the functions address up into a
16630 register, and call indirect through the pointer.
16631
16632 @item -mno-ep
16633 @itemx -mep
16634 @opindex mno-ep
16635 @opindex mep
16636 Do not optimize (do optimize) basic blocks that use the same index
16637 pointer 4 or more times to copy pointer into the @code{ep} register, and
16638 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
16639 option is on by default if you optimize.
16640
16641 @item -mno-prolog-function
16642 @itemx -mprolog-function
16643 @opindex mno-prolog-function
16644 @opindex mprolog-function
16645 Do not use (do use) external functions to save and restore registers
16646 at the prologue and epilogue of a function.  The external functions
16647 are slower, but use less code space if more than one function saves
16648 the same number of registers.  The @option{-mprolog-function} option
16649 is on by default if you optimize.
16650
16651 @item -mspace
16652 @opindex mspace
16653 Try to make the code as small as possible.  At present, this just turns
16654 on the @option{-mep} and @option{-mprolog-function} options.
16655
16656 @item -mtda=@var{n}
16657 @opindex mtda
16658 Put static or global variables whose size is @var{n} bytes or less into
16659 the tiny data area that register @code{ep} points to.  The tiny data
16660 area can hold up to 256 bytes in total (128 bytes for byte references).
16661
16662 @item -msda=@var{n}
16663 @opindex msda
16664 Put static or global variables whose size is @var{n} bytes or less into
16665 the small data area that register @code{gp} points to.  The small data
16666 area can hold up to 64 kilobytes.
16667
16668 @item -mzda=@var{n}
16669 @opindex mzda
16670 Put static or global variables whose size is @var{n} bytes or less into
16671 the first 32 kilobytes of memory.
16672
16673 @item -mv850
16674 @opindex mv850
16675 Specify that the target processor is the V850.
16676
16677 @item -mbig-switch
16678 @opindex mbig-switch
16679 Generate code suitable for big switch tables.  Use this option only if
16680 the assembler/linker complain about out of range branches within a switch
16681 table.
16682
16683 @item -mapp-regs
16684 @opindex mapp-regs
16685 This option will cause r2 and r5 to be used in the code generated by
16686 the compiler.  This setting is the default.
16687
16688 @item -mno-app-regs
16689 @opindex mno-app-regs
16690 This option will cause r2 and r5 to be treated as fixed registers.
16691
16692 @item -mv850e1
16693 @opindex mv850e1
16694 Specify that the target processor is the V850E1.  The preprocessor
16695 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
16696 this option is used.
16697
16698 @item -mv850e
16699 @opindex mv850e
16700 Specify that the target processor is the V850E@.  The preprocessor
16701 constant @samp{__v850e__} will be defined if this option is used.
16702
16703 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
16704 are defined then a default target processor will be chosen and the
16705 relevant @samp{__v850*__} preprocessor constant will be defined.
16706
16707 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
16708 defined, regardless of which processor variant is the target.
16709
16710 @item -mdisable-callt
16711 @opindex mdisable-callt
16712 This option will suppress generation of the CALLT instruction for the
16713 v850e and v850e1 flavors of the v850 architecture.  The default is
16714 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
16715
16716 @end table
16717
16718 @node VAX Options
16719 @subsection VAX Options
16720 @cindex VAX options
16721
16722 These @samp{-m} options are defined for the VAX:
16723
16724 @table @gcctabopt
16725 @item -munix
16726 @opindex munix
16727 Do not output certain jump instructions (@code{aobleq} and so on)
16728 that the Unix assembler for the VAX cannot handle across long
16729 ranges.
16730
16731 @item -mgnu
16732 @opindex mgnu
16733 Do output those jump instructions, on the assumption that you
16734 will assemble with the GNU assembler.
16735
16736 @item -mg
16737 @opindex mg
16738 Output code for g-format floating point numbers instead of d-format.
16739 @end table
16740
16741 @node VxWorks Options
16742 @subsection VxWorks Options
16743 @cindex VxWorks Options
16744
16745 The options in this section are defined for all VxWorks targets.
16746 Options specific to the target hardware are listed with the other
16747 options for that target.
16748
16749 @table @gcctabopt
16750 @item -mrtp
16751 @opindex mrtp
16752 GCC can generate code for both VxWorks kernels and real time processes
16753 (RTPs).  This option switches from the former to the latter.  It also
16754 defines the preprocessor macro @code{__RTP__}.
16755
16756 @item -non-static
16757 @opindex non-static
16758 Link an RTP executable against shared libraries rather than static
16759 libraries.  The options @option{-static} and @option{-shared} can
16760 also be used for RTPs (@pxref{Link Options}); @option{-static}
16761 is the default.
16762
16763 @item -Bstatic
16764 @itemx -Bdynamic
16765 @opindex Bstatic
16766 @opindex Bdynamic
16767 These options are passed down to the linker.  They are defined for
16768 compatibility with Diab.
16769
16770 @item -Xbind-lazy
16771 @opindex Xbind-lazy
16772 Enable lazy binding of function calls.  This option is equivalent to
16773 @option{-Wl,-z,now} and is defined for compatibility with Diab.
16774
16775 @item -Xbind-now
16776 @opindex Xbind-now
16777 Disable lazy binding of function calls.  This option is the default and
16778 is defined for compatibility with Diab.
16779 @end table
16780
16781 @node x86-64 Options
16782 @subsection x86-64 Options
16783 @cindex x86-64 options
16784
16785 These are listed under @xref{i386 and x86-64 Options}.
16786
16787 @node i386 and x86-64 Windows Options
16788 @subsection i386 and x86-64 Windows Options
16789 @cindex i386 and x86-64 Windows Options
16790
16791 These additional options are available for Windows targets:
16792
16793 @table @gcctabopt
16794 @item -mconsole
16795 @opindex mconsole
16796 This option is available for Cygwin and MinGW targets.  It
16797 specifies that a console application is to be generated, by
16798 instructing the linker to set the PE header subsystem type
16799 required for console applications.
16800 This is the default behavior for Cygwin and MinGW targets.
16801
16802 @item -mcygwin
16803 @opindex mcygwin
16804 This option is available for Cygwin targets.  It specifies that
16805 the Cygwin internal interface is to be used for predefined
16806 preprocessor macros, C runtime libraries and related linker
16807 paths and options.  For Cygwin targets this is the default behavior.
16808 This option is deprecated and will be removed in a future release.
16809
16810 @item -mno-cygwin
16811 @opindex mno-cygwin
16812 This option is available for Cygwin targets.  It specifies that
16813 the MinGW internal interface is to be used instead of Cygwin's, by
16814 setting MinGW-related predefined macros and linker paths and default
16815 library options.
16816 This option is deprecated and will be removed in a future release.
16817
16818 @item -mdll
16819 @opindex mdll
16820 This option is available for Cygwin and MinGW targets.  It
16821 specifies that a DLL - a dynamic link library - is to be
16822 generated, enabling the selection of the required runtime
16823 startup object and entry point.
16824
16825 @item -mnop-fun-dllimport
16826 @opindex mnop-fun-dllimport
16827 This option is available for Cygwin and MinGW targets.  It
16828 specifies that the dllimport attribute should be ignored.
16829
16830 @item -mthread
16831 @opindex mthread
16832 This option is available for MinGW targets. It specifies
16833 that MinGW-specific thread support is to be used.
16834
16835 @item -municode
16836 @opindex municode
16837 This option is available for mingw-w64 targets.  It specifies
16838 that the UNICODE macro is getting pre-defined and that the
16839 unicode capable runtime startup code is chosen.
16840
16841 @item -mwin32
16842 @opindex mwin32
16843 This option is available for Cygwin and MinGW targets.  It
16844 specifies that the typical Windows pre-defined macros are to
16845 be set in the pre-processor, but does not influence the choice
16846 of runtime library/startup code.
16847
16848 @item -mwindows
16849 @opindex mwindows
16850 This option is available for Cygwin and MinGW targets.  It
16851 specifies that a GUI application is to be generated by
16852 instructing the linker to set the PE header subsystem type
16853 appropriately.
16854
16855 @item -fno-set-stack-executable
16856 @opindex fno-set-stack-executable
16857 This option is available for MinGW targets. It specifies that
16858 the executable flag for stack used by nested functions isn't
16859 set. This is necessary for binaries running in kernel mode of
16860 Windows, as there the user32 API, which is used to set executable
16861 privileges, isn't available.
16862
16863 @item -mpe-aligned-commons
16864 @opindex mpe-aligned-commons
16865 This option is available for Cygwin and MinGW targets.  It
16866 specifies that the GNU extension to the PE file format that
16867 permits the correct alignment of COMMON variables should be
16868 used when generating code.  It will be enabled by default if
16869 GCC detects that the target assembler found during configuration
16870 supports the feature.
16871 @end table
16872
16873 See also under @ref{i386 and x86-64 Options} for standard options.
16874
16875 @node Xstormy16 Options
16876 @subsection Xstormy16 Options
16877 @cindex Xstormy16 Options
16878
16879 These options are defined for Xstormy16:
16880
16881 @table @gcctabopt
16882 @item -msim
16883 @opindex msim
16884 Choose startup files and linker script suitable for the simulator.
16885 @end table
16886
16887 @node Xtensa Options
16888 @subsection Xtensa Options
16889 @cindex Xtensa Options
16890
16891 These options are supported for Xtensa targets:
16892
16893 @table @gcctabopt
16894 @item -mconst16
16895 @itemx -mno-const16
16896 @opindex mconst16
16897 @opindex mno-const16
16898 Enable or disable use of @code{CONST16} instructions for loading
16899 constant values.  The @code{CONST16} instruction is currently not a
16900 standard option from Tensilica.  When enabled, @code{CONST16}
16901 instructions are always used in place of the standard @code{L32R}
16902 instructions.  The use of @code{CONST16} is enabled by default only if
16903 the @code{L32R} instruction is not available.
16904
16905 @item -mfused-madd
16906 @itemx -mno-fused-madd
16907 @opindex mfused-madd
16908 @opindex mno-fused-madd
16909 Enable or disable use of fused multiply/add and multiply/subtract
16910 instructions in the floating-point option.  This has no effect if the
16911 floating-point option is not also enabled.  Disabling fused multiply/add
16912 and multiply/subtract instructions forces the compiler to use separate
16913 instructions for the multiply and add/subtract operations.  This may be
16914 desirable in some cases where strict IEEE 754-compliant results are
16915 required: the fused multiply add/subtract instructions do not round the
16916 intermediate result, thereby producing results with @emph{more} bits of
16917 precision than specified by the IEEE standard.  Disabling fused multiply
16918 add/subtract instructions also ensures that the program output is not
16919 sensitive to the compiler's ability to combine multiply and add/subtract
16920 operations.
16921
16922 @item -mserialize-volatile
16923 @itemx -mno-serialize-volatile
16924 @opindex mserialize-volatile
16925 @opindex mno-serialize-volatile
16926 When this option is enabled, GCC inserts @code{MEMW} instructions before
16927 @code{volatile} memory references to guarantee sequential consistency.
16928 The default is @option{-mserialize-volatile}.  Use
16929 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
16930
16931 @item -mtext-section-literals
16932 @itemx -mno-text-section-literals
16933 @opindex mtext-section-literals
16934 @opindex mno-text-section-literals
16935 Control the treatment of literal pools.  The default is
16936 @option{-mno-text-section-literals}, which places literals in a separate
16937 section in the output file.  This allows the literal pool to be placed
16938 in a data RAM/ROM, and it also allows the linker to combine literal
16939 pools from separate object files to remove redundant literals and
16940 improve code size.  With @option{-mtext-section-literals}, the literals
16941 are interspersed in the text section in order to keep them as close as
16942 possible to their references.  This may be necessary for large assembly
16943 files.
16944
16945 @item -mtarget-align
16946 @itemx -mno-target-align
16947 @opindex mtarget-align
16948 @opindex mno-target-align
16949 When this option is enabled, GCC instructs the assembler to
16950 automatically align instructions to reduce branch penalties at the
16951 expense of some code density.  The assembler attempts to widen density
16952 instructions to align branch targets and the instructions following call
16953 instructions.  If there are not enough preceding safe density
16954 instructions to align a target, no widening will be performed.  The
16955 default is @option{-mtarget-align}.  These options do not affect the
16956 treatment of auto-aligned instructions like @code{LOOP}, which the
16957 assembler will always align, either by widening density instructions or
16958 by inserting no-op instructions.
16959
16960 @item -mlongcalls
16961 @itemx -mno-longcalls
16962 @opindex mlongcalls
16963 @opindex mno-longcalls
16964 When this option is enabled, GCC instructs the assembler to translate
16965 direct calls to indirect calls unless it can determine that the target
16966 of a direct call is in the range allowed by the call instruction.  This
16967 translation typically occurs for calls to functions in other source
16968 files.  Specifically, the assembler translates a direct @code{CALL}
16969 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
16970 The default is @option{-mno-longcalls}.  This option should be used in
16971 programs where the call target can potentially be out of range.  This
16972 option is implemented in the assembler, not the compiler, so the
16973 assembly code generated by GCC will still show direct call
16974 instructions---look at the disassembled object code to see the actual
16975 instructions.  Note that the assembler will use an indirect call for
16976 every cross-file call, not just those that really will be out of range.
16977 @end table
16978
16979 @node zSeries Options
16980 @subsection zSeries Options
16981 @cindex zSeries options
16982
16983 These are listed under @xref{S/390 and zSeries Options}.
16984
16985 @node Code Gen Options
16986 @section Options for Code Generation Conventions
16987 @cindex code generation conventions
16988 @cindex options, code generation
16989 @cindex run-time options
16990
16991 These machine-independent options control the interface conventions
16992 used in code generation.
16993
16994 Most of them have both positive and negative forms; the negative form
16995 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
16996 one of the forms is listed---the one which is not the default.  You
16997 can figure out the other form by either removing @samp{no-} or adding
16998 it.
16999
17000 @table @gcctabopt
17001 @item -fbounds-check
17002 @opindex fbounds-check
17003 For front-ends that support it, generate additional code to check that
17004 indices used to access arrays are within the declared range.  This is
17005 currently only supported by the Java and Fortran front-ends, where
17006 this option defaults to true and false respectively.
17007
17008 @item -ftrapv
17009 @opindex ftrapv
17010 This option generates traps for signed overflow on addition, subtraction,
17011 multiplication operations.
17012
17013 @item -fwrapv
17014 @opindex fwrapv
17015 This option instructs the compiler to assume that signed arithmetic
17016 overflow of addition, subtraction and multiplication wraps around
17017 using twos-complement representation.  This flag enables some optimizations
17018 and disables others.  This option is enabled by default for the Java
17019 front-end, as required by the Java language specification.
17020
17021 @item -fexceptions
17022 @opindex fexceptions
17023 Enable exception handling.  Generates extra code needed to propagate
17024 exceptions.  For some targets, this implies GCC will generate frame
17025 unwind information for all functions, which can produce significant data
17026 size overhead, although it does not affect execution.  If you do not
17027 specify this option, GCC will enable it by default for languages like
17028 C++ which normally require exception handling, and disable it for
17029 languages like C that do not normally require it.  However, you may need
17030 to enable this option when compiling C code that needs to interoperate
17031 properly with exception handlers written in C++.  You may also wish to
17032 disable this option if you are compiling older C++ programs that don't
17033 use exception handling.
17034
17035 @item -fnon-call-exceptions
17036 @opindex fnon-call-exceptions
17037 Generate code that allows trapping instructions to throw exceptions.
17038 Note that this requires platform-specific runtime support that does
17039 not exist everywhere.  Moreover, it only allows @emph{trapping}
17040 instructions to throw exceptions, i.e.@: memory references or floating
17041 point instructions.  It does not allow exceptions to be thrown from
17042 arbitrary signal handlers such as @code{SIGALRM}.
17043
17044 @item -funwind-tables
17045 @opindex funwind-tables
17046 Similar to @option{-fexceptions}, except that it will just generate any needed
17047 static data, but will not affect the generated code in any other way.
17048 You will normally not enable this option; instead, a language processor
17049 that needs this handling would enable it on your behalf.
17050
17051 @item -fasynchronous-unwind-tables
17052 @opindex fasynchronous-unwind-tables
17053 Generate unwind table in dwarf2 format, if supported by target machine.  The
17054 table is exact at each instruction boundary, so it can be used for stack
17055 unwinding from asynchronous events (such as debugger or garbage collector).
17056
17057 @item -fpcc-struct-return
17058 @opindex fpcc-struct-return
17059 Return ``short'' @code{struct} and @code{union} values in memory like
17060 longer ones, rather than in registers.  This convention is less
17061 efficient, but it has the advantage of allowing intercallability between
17062 GCC-compiled files and files compiled with other compilers, particularly
17063 the Portable C Compiler (pcc).
17064
17065 The precise convention for returning structures in memory depends
17066 on the target configuration macros.
17067
17068 Short structures and unions are those whose size and alignment match
17069 that of some integer type.
17070
17071 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17072 switch is not binary compatible with code compiled with the
17073 @option{-freg-struct-return} switch.
17074 Use it to conform to a non-default application binary interface.
17075
17076 @item -freg-struct-return
17077 @opindex freg-struct-return
17078 Return @code{struct} and @code{union} values in registers when possible.
17079 This is more efficient for small structures than
17080 @option{-fpcc-struct-return}.
17081
17082 If you specify neither @option{-fpcc-struct-return} nor
17083 @option{-freg-struct-return}, GCC defaults to whichever convention is
17084 standard for the target.  If there is no standard convention, GCC
17085 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17086 the principal compiler.  In those cases, we can choose the standard, and
17087 we chose the more efficient register return alternative.
17088
17089 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17090 switch is not binary compatible with code compiled with the
17091 @option{-fpcc-struct-return} switch.
17092 Use it to conform to a non-default application binary interface.
17093
17094 @item -fshort-enums
17095 @opindex fshort-enums
17096 Allocate to an @code{enum} type only as many bytes as it needs for the
17097 declared range of possible values.  Specifically, the @code{enum} type
17098 will be equivalent to the smallest integer type which has enough room.
17099
17100 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17101 code that is not binary compatible with code generated without that switch.
17102 Use it to conform to a non-default application binary interface.
17103
17104 @item -fshort-double
17105 @opindex fshort-double
17106 Use the same size for @code{double} as for @code{float}.
17107
17108 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17109 code that is not binary compatible with code generated without that switch.
17110 Use it to conform to a non-default application binary interface.
17111
17112 @item -fshort-wchar
17113 @opindex fshort-wchar
17114 Override the underlying type for @samp{wchar_t} to be @samp{short
17115 unsigned int} instead of the default for the target.  This option is
17116 useful for building programs to run under WINE@.
17117
17118 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17119 code that is not binary compatible with code generated without that switch.
17120 Use it to conform to a non-default application binary interface.
17121
17122 @item -fno-common
17123 @opindex fno-common
17124 In C code, controls the placement of uninitialized global variables.
17125 Unix C compilers have traditionally permitted multiple definitions of
17126 such variables in different compilation units by placing the variables
17127 in a common block.
17128 This is the behavior specified by @option{-fcommon}, and is the default
17129 for GCC on most targets.
17130 On the other hand, this behavior is not required by ISO C, and on some
17131 targets may carry a speed or code size penalty on variable references.
17132 The @option{-fno-common} option specifies that the compiler should place
17133 uninitialized global variables in the data section of the object file,
17134 rather than generating them as common blocks.
17135 This has the effect that if the same variable is declared
17136 (without @code{extern}) in two different compilations,
17137 you will get a multiple-definition error when you link them.
17138 In this case, you must compile with @option{-fcommon} instead.
17139 Compiling with @option{-fno-common} is useful on targets for which
17140 it provides better performance, or if you wish to verify that the
17141 program will work on other systems which always treat uninitialized
17142 variable declarations this way.
17143
17144 @item -fno-ident
17145 @opindex fno-ident
17146 Ignore the @samp{#ident} directive.
17147
17148 @item -finhibit-size-directive
17149 @opindex finhibit-size-directive
17150 Don't output a @code{.size} assembler directive, or anything else that
17151 would cause trouble if the function is split in the middle, and the
17152 two halves are placed at locations far apart in memory.  This option is
17153 used when compiling @file{crtstuff.c}; you should not need to use it
17154 for anything else.
17155
17156 @item -fverbose-asm
17157 @opindex fverbose-asm
17158 Put extra commentary information in the generated assembly code to
17159 make it more readable.  This option is generally only of use to those
17160 who actually need to read the generated assembly code (perhaps while
17161 debugging the compiler itself).
17162
17163 @option{-fno-verbose-asm}, the default, causes the
17164 extra information to be omitted and is useful when comparing two assembler
17165 files.
17166
17167 @item -frecord-gcc-switches
17168 @opindex frecord-gcc-switches
17169 This switch causes the command line that was used to invoke the
17170 compiler to be recorded into the object file that is being created.
17171 This switch is only implemented on some targets and the exact format
17172 of the recording is target and binary file format dependent, but it
17173 usually takes the form of a section containing ASCII text.  This
17174 switch is related to the @option{-fverbose-asm} switch, but that
17175 switch only records information in the assembler output file as
17176 comments, so it never reaches the object file.
17177
17178 @item -fpic
17179 @opindex fpic
17180 @cindex global offset table
17181 @cindex PIC
17182 Generate position-independent code (PIC) suitable for use in a shared
17183 library, if supported for the target machine.  Such code accesses all
17184 constant addresses through a global offset table (GOT)@.  The dynamic
17185 loader resolves the GOT entries when the program starts (the dynamic
17186 loader is not part of GCC; it is part of the operating system).  If
17187 the GOT size for the linked executable exceeds a machine-specific
17188 maximum size, you get an error message from the linker indicating that
17189 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17190 instead.  (These maximums are 8k on the SPARC and 32k
17191 on the m68k and RS/6000.  The 386 has no such limit.)
17192
17193 Position-independent code requires special support, and therefore works
17194 only on certain machines.  For the 386, GCC supports PIC for System V
17195 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17196 position-independent.
17197
17198 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17199 are defined to 1.
17200
17201 @item -fPIC
17202 @opindex fPIC
17203 If supported for the target machine, emit position-independent code,
17204 suitable for dynamic linking and avoiding any limit on the size of the
17205 global offset table.  This option makes a difference on the m68k,
17206 PowerPC and SPARC@.
17207
17208 Position-independent code requires special support, and therefore works
17209 only on certain machines.
17210
17211 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17212 are defined to 2.
17213
17214 @item -fpie
17215 @itemx -fPIE
17216 @opindex fpie
17217 @opindex fPIE
17218 These options are similar to @option{-fpic} and @option{-fPIC}, but
17219 generated position independent code can be only linked into executables.
17220 Usually these options are used when @option{-pie} GCC option will be
17221 used during linking.
17222
17223 @option{-fpie} and @option{-fPIE} both define the macros
17224 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17225 for @option{-fpie} and 2 for @option{-fPIE}.
17226
17227 @item -fno-jump-tables
17228 @opindex fno-jump-tables
17229 Do not use jump tables for switch statements even where it would be
17230 more efficient than other code generation strategies.  This option is
17231 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17232 building code which forms part of a dynamic linker and cannot
17233 reference the address of a jump table.  On some targets, jump tables
17234 do not require a GOT and this option is not needed.
17235
17236 @item -ffixed-@var{reg}
17237 @opindex ffixed
17238 Treat the register named @var{reg} as a fixed register; generated code
17239 should never refer to it (except perhaps as a stack pointer, frame
17240 pointer or in some other fixed role).
17241
17242 @var{reg} must be the name of a register.  The register names accepted
17243 are machine-specific and are defined in the @code{REGISTER_NAMES}
17244 macro in the machine description macro file.
17245
17246 This flag does not have a negative form, because it specifies a
17247 three-way choice.
17248
17249 @item -fcall-used-@var{reg}
17250 @opindex fcall-used
17251 Treat the register named @var{reg} as an allocable register that is
17252 clobbered by function calls.  It may be allocated for temporaries or
17253 variables that do not live across a call.  Functions compiled this way
17254 will not save and restore the register @var{reg}.
17255
17256 It is an error to used this flag with the frame pointer or stack pointer.
17257 Use of this flag for other registers that have fixed pervasive roles in
17258 the machine's execution model will produce disastrous results.
17259
17260 This flag does not have a negative form, because it specifies a
17261 three-way choice.
17262
17263 @item -fcall-saved-@var{reg}
17264 @opindex fcall-saved
17265 Treat the register named @var{reg} as an allocable register saved by
17266 functions.  It may be allocated even for temporaries or variables that
17267 live across a call.  Functions compiled this way will save and restore
17268 the register @var{reg} if they use it.
17269
17270 It is an error to used this flag with the frame pointer or stack pointer.
17271 Use of this flag for other registers that have fixed pervasive roles in
17272 the machine's execution model will produce disastrous results.
17273
17274 A different sort of disaster will result from the use of this flag for
17275 a register in which function values may be returned.
17276
17277 This flag does not have a negative form, because it specifies a
17278 three-way choice.
17279
17280 @item -fpack-struct[=@var{n}]
17281 @opindex fpack-struct
17282 Without a value specified, pack all structure members together without
17283 holes.  When a value is specified (which must be a small power of two), pack
17284 structure members according to this value, representing the maximum
17285 alignment (that is, objects with default alignment requirements larger than
17286 this will be output potentially unaligned at the next fitting location.
17287
17288 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17289 code that is not binary compatible with code generated without that switch.
17290 Additionally, it makes the code suboptimal.
17291 Use it to conform to a non-default application binary interface.
17292
17293 @item -finstrument-functions
17294 @opindex finstrument-functions
17295 Generate instrumentation calls for entry and exit to functions.  Just
17296 after function entry and just before function exit, the following
17297 profiling functions will be called with the address of the current
17298 function and its call site.  (On some platforms,
17299 @code{__builtin_return_address} does not work beyond the current
17300 function, so the call site information may not be available to the
17301 profiling functions otherwise.)
17302
17303 @smallexample
17304 void __cyg_profile_func_enter (void *this_fn,
17305                                void *call_site);
17306 void __cyg_profile_func_exit  (void *this_fn,
17307                                void *call_site);
17308 @end smallexample
17309
17310 The first argument is the address of the start of the current function,
17311 which may be looked up exactly in the symbol table.
17312
17313 This instrumentation is also done for functions expanded inline in other
17314 functions.  The profiling calls will indicate where, conceptually, the
17315 inline function is entered and exited.  This means that addressable
17316 versions of such functions must be available.  If all your uses of a
17317 function are expanded inline, this may mean an additional expansion of
17318 code size.  If you use @samp{extern inline} in your C code, an
17319 addressable version of such functions must be provided.  (This is
17320 normally the case anyways, but if you get lucky and the optimizer always
17321 expands the functions inline, you might have gotten away without
17322 providing static copies.)
17323
17324 A function may be given the attribute @code{no_instrument_function}, in
17325 which case this instrumentation will not be done.  This can be used, for
17326 example, for the profiling functions listed above, high-priority
17327 interrupt routines, and any functions from which the profiling functions
17328 cannot safely be called (perhaps signal handlers, if the profiling
17329 routines generate output or allocate memory).
17330
17331 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
17332 @opindex finstrument-functions-exclude-file-list
17333
17334 Set the list of functions that are excluded from instrumentation (see
17335 the description of @code{-finstrument-functions}).  If the file that
17336 contains a function definition matches with one of @var{file}, then
17337 that function is not instrumented.  The match is done on substrings:
17338 if the @var{file} parameter is a substring of the file name, it is
17339 considered to be a match.
17340
17341 For example,
17342 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
17343 will exclude any inline function defined in files whose pathnames
17344 contain @code{/bits/stl} or @code{include/sys}.
17345
17346 If, for some reason, you want to include letter @code{','} in one of
17347 @var{sym}, write @code{'\,'}. For example,
17348 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
17349 (note the single quote surrounding the option).
17350
17351 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
17352 @opindex finstrument-functions-exclude-function-list
17353
17354 This is similar to @code{-finstrument-functions-exclude-file-list},
17355 but this option sets the list of function names to be excluded from
17356 instrumentation.  The function name to be matched is its user-visible
17357 name, such as @code{vector<int> blah(const vector<int> &)}, not the
17358 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
17359 match is done on substrings: if the @var{sym} parameter is a substring
17360 of the function name, it is considered to be a match.  For C99 and C++
17361 extended identifiers, the function name must be given in UTF-8, not
17362 using universal character names.
17363
17364 @item -fstack-check
17365 @opindex fstack-check
17366 Generate code to verify that you do not go beyond the boundary of the
17367 stack.  You should specify this flag if you are running in an
17368 environment with multiple threads, but only rarely need to specify it in
17369 a single-threaded environment since stack overflow is automatically
17370 detected on nearly all systems if there is only one stack.
17371
17372 Note that this switch does not actually cause checking to be done; the
17373 operating system or the language runtime must do that.  The switch causes
17374 generation of code to ensure that they see the stack being extended.
17375
17376 You can additionally specify a string parameter: @code{no} means no
17377 checking, @code{generic} means force the use of old-style checking,
17378 @code{specific} means use the best checking method and is equivalent
17379 to bare @option{-fstack-check}.
17380
17381 Old-style checking is a generic mechanism that requires no specific
17382 target support in the compiler but comes with the following drawbacks:
17383
17384 @enumerate
17385 @item
17386 Modified allocation strategy for large objects: they will always be
17387 allocated dynamically if their size exceeds a fixed threshold.
17388
17389 @item
17390 Fixed limit on the size of the static frame of functions: when it is
17391 topped by a particular function, stack checking is not reliable and
17392 a warning is issued by the compiler.
17393
17394 @item
17395 Inefficiency: because of both the modified allocation strategy and the
17396 generic implementation, the performances of the code are hampered.
17397 @end enumerate
17398
17399 Note that old-style stack checking is also the fallback method for
17400 @code{specific} if no target support has been added in the compiler.
17401
17402 @item -fstack-limit-register=@var{reg}
17403 @itemx -fstack-limit-symbol=@var{sym}
17404 @itemx -fno-stack-limit
17405 @opindex fstack-limit-register
17406 @opindex fstack-limit-symbol
17407 @opindex fno-stack-limit
17408 Generate code to ensure that the stack does not grow beyond a certain value,
17409 either the value of a register or the address of a symbol.  If the stack
17410 would grow beyond the value, a signal is raised.  For most targets,
17411 the signal is raised before the stack overruns the boundary, so
17412 it is possible to catch the signal without taking special precautions.
17413
17414 For instance, if the stack starts at absolute address @samp{0x80000000}
17415 and grows downwards, you can use the flags
17416 @option{-fstack-limit-symbol=__stack_limit} and
17417 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
17418 of 128KB@.  Note that this may only work with the GNU linker.
17419
17420 @cindex aliasing of parameters
17421 @cindex parameters, aliased
17422 @item -fargument-alias
17423 @itemx -fargument-noalias
17424 @itemx -fargument-noalias-global
17425 @itemx -fargument-noalias-anything
17426 @opindex fargument-alias
17427 @opindex fargument-noalias
17428 @opindex fargument-noalias-global
17429 @opindex fargument-noalias-anything
17430 Specify the possible relationships among parameters and between
17431 parameters and global data.
17432
17433 @option{-fargument-alias} specifies that arguments (parameters) may
17434 alias each other and may alias global storage.@*
17435 @option{-fargument-noalias} specifies that arguments do not alias
17436 each other, but may alias global storage.@*
17437 @option{-fargument-noalias-global} specifies that arguments do not
17438 alias each other and do not alias global storage.
17439 @option{-fargument-noalias-anything} specifies that arguments do not
17440 alias any other storage.
17441
17442 Each language will automatically use whatever option is required by
17443 the language standard.  You should not need to use these options yourself.
17444
17445 @item -fleading-underscore
17446 @opindex fleading-underscore
17447 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
17448 change the way C symbols are represented in the object file.  One use
17449 is to help link with legacy assembly code.
17450
17451 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
17452 generate code that is not binary compatible with code generated without that
17453 switch.  Use it to conform to a non-default application binary interface.
17454 Not all targets provide complete support for this switch.
17455
17456 @item -ftls-model=@var{model}
17457 @opindex ftls-model
17458 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
17459 The @var{model} argument should be one of @code{global-dynamic},
17460 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
17461
17462 The default without @option{-fpic} is @code{initial-exec}; with
17463 @option{-fpic} the default is @code{global-dynamic}.
17464
17465 @item -fvisibility=@var{default|internal|hidden|protected}
17466 @opindex fvisibility
17467 Set the default ELF image symbol visibility to the specified option---all
17468 symbols will be marked with this unless overridden within the code.
17469 Using this feature can very substantially improve linking and
17470 load times of shared object libraries, produce more optimized
17471 code, provide near-perfect API export and prevent symbol clashes.
17472 It is @strong{strongly} recommended that you use this in any shared objects
17473 you distribute.
17474
17475 Despite the nomenclature, @code{default} always means public ie;
17476 available to be linked against from outside the shared object.
17477 @code{protected} and @code{internal} are pretty useless in real-world
17478 usage so the only other commonly used option will be @code{hidden}.
17479 The default if @option{-fvisibility} isn't specified is
17480 @code{default}, i.e., make every
17481 symbol public---this causes the same behavior as previous versions of
17482 GCC@.
17483
17484 A good explanation of the benefits offered by ensuring ELF
17485 symbols have the correct visibility is given by ``How To Write
17486 Shared Libraries'' by Ulrich Drepper (which can be found at
17487 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
17488 solution made possible by this option to marking things hidden when
17489 the default is public is to make the default hidden and mark things
17490 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
17491 and @code{__attribute__ ((visibility("default")))} instead of
17492 @code{__declspec(dllexport)} you get almost identical semantics with
17493 identical syntax.  This is a great boon to those working with
17494 cross-platform projects.
17495
17496 For those adding visibility support to existing code, you may find
17497 @samp{#pragma GCC visibility} of use.  This works by you enclosing
17498 the declarations you wish to set visibility for with (for example)
17499 @samp{#pragma GCC visibility push(hidden)} and
17500 @samp{#pragma GCC visibility pop}.
17501 Bear in mind that symbol visibility should be viewed @strong{as
17502 part of the API interface contract} and thus all new code should
17503 always specify visibility when it is not the default ie; declarations
17504 only for use within the local DSO should @strong{always} be marked explicitly
17505 as hidden as so to avoid PLT indirection overheads---making this
17506 abundantly clear also aids readability and self-documentation of the code.
17507 Note that due to ISO C++ specification requirements, operator new and
17508 operator delete must always be of default visibility.
17509
17510 Be aware that headers from outside your project, in particular system
17511 headers and headers from any other library you use, may not be
17512 expecting to be compiled with visibility other than the default.  You
17513 may need to explicitly say @samp{#pragma GCC visibility push(default)}
17514 before including any such headers.
17515
17516 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
17517 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
17518 no modifications.  However, this means that calls to @samp{extern}
17519 functions with no explicit visibility will use the PLT, so it is more
17520 effective to use @samp{__attribute ((visibility))} and/or
17521 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
17522 declarations should be treated as hidden.
17523
17524 Note that @samp{-fvisibility} does affect C++ vague linkage
17525 entities. This means that, for instance, an exception class that will
17526 be thrown between DSOs must be explicitly marked with default
17527 visibility so that the @samp{type_info} nodes will be unified between
17528 the DSOs.
17529
17530 An overview of these techniques, their benefits and how to use them
17531 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
17532
17533 @end table
17534
17535 @c man end
17536
17537 @node Environment Variables
17538 @section Environment Variables Affecting GCC
17539 @cindex environment variables
17540
17541 @c man begin ENVIRONMENT
17542 This section describes several environment variables that affect how GCC
17543 operates.  Some of them work by specifying directories or prefixes to use
17544 when searching for various kinds of files.  Some are used to specify other
17545 aspects of the compilation environment.
17546
17547 Note that you can also specify places to search using options such as
17548 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
17549 take precedence over places specified using environment variables, which
17550 in turn take precedence over those specified by the configuration of GCC@.
17551 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
17552 GNU Compiler Collection (GCC) Internals}.
17553
17554 @table @env
17555 @item LANG
17556 @itemx LC_CTYPE
17557 @c @itemx LC_COLLATE
17558 @itemx LC_MESSAGES
17559 @c @itemx LC_MONETARY
17560 @c @itemx LC_NUMERIC
17561 @c @itemx LC_TIME
17562 @itemx LC_ALL
17563 @findex LANG
17564 @findex LC_CTYPE
17565 @c @findex LC_COLLATE
17566 @findex LC_MESSAGES
17567 @c @findex LC_MONETARY
17568 @c @findex LC_NUMERIC
17569 @c @findex LC_TIME
17570 @findex LC_ALL
17571 @cindex locale
17572 These environment variables control the way that GCC uses
17573 localization information that allow GCC to work with different
17574 national conventions.  GCC inspects the locale categories
17575 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
17576 so.  These locale categories can be set to any value supported by your
17577 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
17578 Kingdom encoded in UTF-8.
17579
17580 The @env{LC_CTYPE} environment variable specifies character
17581 classification.  GCC uses it to determine the character boundaries in
17582 a string; this is needed for some multibyte encodings that contain quote
17583 and escape characters that would otherwise be interpreted as a string
17584 end or escape.
17585
17586 The @env{LC_MESSAGES} environment variable specifies the language to
17587 use in diagnostic messages.
17588
17589 If the @env{LC_ALL} environment variable is set, it overrides the value
17590 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
17591 and @env{LC_MESSAGES} default to the value of the @env{LANG}
17592 environment variable.  If none of these variables are set, GCC
17593 defaults to traditional C English behavior.
17594
17595 @item TMPDIR
17596 @findex TMPDIR
17597 If @env{TMPDIR} is set, it specifies the directory to use for temporary
17598 files.  GCC uses temporary files to hold the output of one stage of
17599 compilation which is to be used as input to the next stage: for example,
17600 the output of the preprocessor, which is the input to the compiler
17601 proper.
17602
17603 @item GCC_EXEC_PREFIX
17604 @findex GCC_EXEC_PREFIX
17605 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
17606 names of the subprograms executed by the compiler.  No slash is added
17607 when this prefix is combined with the name of a subprogram, but you can
17608 specify a prefix that ends with a slash if you wish.
17609
17610 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
17611 an appropriate prefix to use based on the pathname it was invoked with.
17612
17613 If GCC cannot find the subprogram using the specified prefix, it
17614 tries looking in the usual places for the subprogram.
17615
17616 The default value of @env{GCC_EXEC_PREFIX} is
17617 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
17618 the installed compiler. In many cases @var{prefix} is the value
17619 of @code{prefix} when you ran the @file{configure} script.
17620
17621 Other prefixes specified with @option{-B} take precedence over this prefix.
17622
17623 This prefix is also used for finding files such as @file{crt0.o} that are
17624 used for linking.
17625
17626 In addition, the prefix is used in an unusual way in finding the
17627 directories to search for header files.  For each of the standard
17628 directories whose name normally begins with @samp{/usr/local/lib/gcc}
17629 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
17630 replacing that beginning with the specified prefix to produce an
17631 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
17632 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
17633 These alternate directories are searched first; the standard directories
17634 come next. If a standard directory begins with the configured
17635 @var{prefix} then the value of @var{prefix} is replaced by
17636 @env{GCC_EXEC_PREFIX} when looking for header files.
17637
17638 @item COMPILER_PATH
17639 @findex COMPILER_PATH
17640 The value of @env{COMPILER_PATH} is a colon-separated list of
17641 directories, much like @env{PATH}.  GCC tries the directories thus
17642 specified when searching for subprograms, if it can't find the
17643 subprograms using @env{GCC_EXEC_PREFIX}.
17644
17645 @item LIBRARY_PATH
17646 @findex LIBRARY_PATH
17647 The value of @env{LIBRARY_PATH} is a colon-separated list of
17648 directories, much like @env{PATH}.  When configured as a native compiler,
17649 GCC tries the directories thus specified when searching for special
17650 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
17651 using GCC also uses these directories when searching for ordinary
17652 libraries for the @option{-l} option (but directories specified with
17653 @option{-L} come first).
17654
17655 @item LANG
17656 @findex LANG
17657 @cindex locale definition
17658 This variable is used to pass locale information to the compiler.  One way in
17659 which this information is used is to determine the character set to be used
17660 when character literals, string literals and comments are parsed in C and C++.
17661 When the compiler is configured to allow multibyte characters,
17662 the following values for @env{LANG} are recognized:
17663
17664 @table @samp
17665 @item C-JIS
17666 Recognize JIS characters.
17667 @item C-SJIS
17668 Recognize SJIS characters.
17669 @item C-EUCJP
17670 Recognize EUCJP characters.
17671 @end table
17672
17673 If @env{LANG} is not defined, or if it has some other value, then the
17674 compiler will use mblen and mbtowc as defined by the default locale to
17675 recognize and translate multibyte characters.
17676 @end table
17677
17678 @noindent
17679 Some additional environments variables affect the behavior of the
17680 preprocessor.
17681
17682 @include cppenv.texi
17683
17684 @c man end
17685
17686 @node Precompiled Headers
17687 @section Using Precompiled Headers
17688 @cindex precompiled headers
17689 @cindex speed of compilation
17690
17691 Often large projects have many header files that are included in every
17692 source file.  The time the compiler takes to process these header files
17693 over and over again can account for nearly all of the time required to
17694 build the project.  To make builds faster, GCC allows users to
17695 `precompile' a header file; then, if builds can use the precompiled
17696 header file they will be much faster.
17697
17698 To create a precompiled header file, simply compile it as you would any
17699 other file, if necessary using the @option{-x} option to make the driver
17700 treat it as a C or C++ header file.  You will probably want to use a
17701 tool like @command{make} to keep the precompiled header up-to-date when
17702 the headers it contains change.
17703
17704 A precompiled header file will be searched for when @code{#include} is
17705 seen in the compilation.  As it searches for the included file
17706 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17707 compiler looks for a precompiled header in each directory just before it
17708 looks for the include file in that directory.  The name searched for is
17709 the name specified in the @code{#include} with @samp{.gch} appended.  If
17710 the precompiled header file can't be used, it is ignored.
17711
17712 For instance, if you have @code{#include "all.h"}, and you have
17713 @file{all.h.gch} in the same directory as @file{all.h}, then the
17714 precompiled header file will be used if possible, and the original
17715 header will be used otherwise.
17716
17717 Alternatively, you might decide to put the precompiled header file in a
17718 directory and use @option{-I} to ensure that directory is searched
17719 before (or instead of) the directory containing the original header.
17720 Then, if you want to check that the precompiled header file is always
17721 used, you can put a file of the same name as the original header in this
17722 directory containing an @code{#error} command.
17723
17724 This also works with @option{-include}.  So yet another way to use
17725 precompiled headers, good for projects not designed with precompiled
17726 header files in mind, is to simply take most of the header files used by
17727 a project, include them from another header file, precompile that header
17728 file, and @option{-include} the precompiled header.  If the header files
17729 have guards against multiple inclusion, they will be skipped because
17730 they've already been included (in the precompiled header).
17731
17732 If you need to precompile the same header file for different
17733 languages, targets, or compiler options, you can instead make a
17734 @emph{directory} named like @file{all.h.gch}, and put each precompiled
17735 header in the directory, perhaps using @option{-o}.  It doesn't matter
17736 what you call the files in the directory, every precompiled header in
17737 the directory will be considered.  The first precompiled header
17738 encountered in the directory that is valid for this compilation will
17739 be used; they're searched in no particular order.
17740
17741 There are many other possibilities, limited only by your imagination,
17742 good sense, and the constraints of your build system.
17743
17744 A precompiled header file can be used only when these conditions apply:
17745
17746 @itemize
17747 @item
17748 Only one precompiled header can be used in a particular compilation.
17749
17750 @item
17751 A precompiled header can't be used once the first C token is seen.  You
17752 can have preprocessor directives before a precompiled header; you can
17753 even include a precompiled header from inside another header, so long as
17754 there are no C tokens before the @code{#include}.
17755
17756 @item
17757 The precompiled header file must be produced for the same language as
17758 the current compilation.  You can't use a C precompiled header for a C++
17759 compilation.
17760
17761 @item
17762 The precompiled header file must have been produced by the same compiler
17763 binary as the current compilation is using.
17764
17765 @item
17766 Any macros defined before the precompiled header is included must
17767 either be defined in the same way as when the precompiled header was
17768 generated, or must not affect the precompiled header, which usually
17769 means that they don't appear in the precompiled header at all.
17770
17771 The @option{-D} option is one way to define a macro before a
17772 precompiled header is included; using a @code{#define} can also do it.
17773 There are also some options that define macros implicitly, like
17774 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
17775 defined this way.
17776
17777 @item If debugging information is output when using the precompiled
17778 header, using @option{-g} or similar, the same kind of debugging information
17779 must have been output when building the precompiled header.  However,
17780 a precompiled header built using @option{-g} can be used in a compilation
17781 when no debugging information is being output.
17782
17783 @item The same @option{-m} options must generally be used when building
17784 and using the precompiled header.  @xref{Submodel Options},
17785 for any cases where this rule is relaxed.
17786
17787 @item Each of the following options must be the same when building and using
17788 the precompiled header:
17789
17790 @gccoptlist{-fexceptions}
17791
17792 @item
17793 Some other command-line options starting with @option{-f},
17794 @option{-p}, or @option{-O} must be defined in the same way as when
17795 the precompiled header was generated.  At present, it's not clear
17796 which options are safe to change and which are not; the safest choice
17797 is to use exactly the same options when generating and using the
17798 precompiled header.  The following are known to be safe:
17799
17800 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
17801 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
17802 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
17803 -pedantic-errors}
17804
17805 @end itemize
17806
17807 For all of these except the last, the compiler will automatically
17808 ignore the precompiled header if the conditions aren't met.  If you
17809 find an option combination that doesn't work and doesn't cause the
17810 precompiled header to be ignored, please consider filing a bug report,
17811 see @ref{Bugs}.
17812
17813 If you do use differing options when generating and using the
17814 precompiled header, the actual behavior will be a mixture of the
17815 behavior for the options.  For instance, if you use @option{-g} to
17816 generate the precompiled header but not when using it, you may or may
17817 not get debugging information for routines in the precompiled header.