OSDN Git Service

2010-05-19 Richard Guenther <rguenther@suse.de>
[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  -Wcpp  -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 -Wsuggest-attribute=@r{[}const@r{|}pure@r{]} @gol
261 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
262 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
263 -Wunknown-pragmas  -Wno-pragmas @gol
264 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
265 -Wunused-label  -Wunused-parameter -Wno-unused-result -Wunused-value  -Wunused-variable @gol
266 -Wunused-but-set-parameter -Wunused-but-set-variable -Wvariadic-macros -Wvla @gol
267 -Wvolatile-register-var  -Wwrite-strings}
268
269 @item C and Objective-C-only Warning Options
270 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
271 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
272 -Wold-style-declaration  -Wold-style-definition @gol
273 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
274 -Wdeclaration-after-statement -Wpointer-sign}
275
276 @item Debugging Options
277 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
278 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
279 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
280 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
281 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
282 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
283 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
284 -fdump-statistics @gol
285 -fdump-tree-all @gol
286 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
287 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
289 -fdump-tree-ch @gol
290 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
299 -fdump-tree-nrv -fdump-tree-vect @gol
300 -fdump-tree-sink @gol
301 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
303 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
304 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
305 -ftree-vectorizer-verbose=@var{n} @gol
306 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
307 -fdump-final-insns=@var{file} @gol
308 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
309 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
310 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
311 -fenable-icf-debug @gol
312 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
313 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
314 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
315 -ftest-coverage  -ftime-report -fvar-tracking @gol
316 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
317 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
318 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
319 -gvms  -gxcoff  -gxcoff+ @gol
320 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
321 -fdebug-prefix-map=@var{old}=@var{new} @gol
322 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
323 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
324 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
325 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
326 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
327 -print-sysroot -print-sysroot-headers-suffix @gol
328 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
329
330 @item Optimization Options
331 @xref{Optimize Options,,Options that Control Optimization}.
332 @gccoptlist{
333 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
334 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
335 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
336 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
337 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
338 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
339 -fdata-sections -fdce -fdce @gol
340 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
341 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
342 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
343 -fforward-propagate -ffunction-sections @gol
344 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
345 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
346 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
347 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
348 -fipa-profile -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
349 -fira-algorithm=@var{algorithm} @gol
350 -fira-region=@var{region} -fira-coalesce @gol
351 -fira-loop-pressure -fno-ira-share-save-slots @gol
352 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
353 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
354 -floop-block -floop-interchange -floop-strip-mine -fgraphite-identity @gol
355 -floop-parallelize-all -flto -flto-compression-level -flto-report -fltrans @gol
356 -fltrans-output-list -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
357 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
358 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
359 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
360 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
361 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
362 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
363 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
364 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
365 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
366 -fprofile-generate=@var{path} @gol
367 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
368 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
369 -freorder-blocks-and-partition -freorder-functions @gol
370 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
371 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
372 -fsched-spec-load -fsched-spec-load-dangerous @gol
373 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
374 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
375 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
376 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
377 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
378 -fselective-scheduling -fselective-scheduling2 @gol
379 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
380 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
381 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
382 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
383 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
384 -ftree-copyrename -ftree-dce @gol
385 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
386 -ftree-phiprop -ftree-loop-distribution @gol
387 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
388 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
389 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
390 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
391 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
392 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
393 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
394 -fwhole-program -fwhopr[=@var{n}] -fwpa -fuse-linker-plugin @gol
395 --param @var{name}=@var{value}
396 -O  -O0  -O1  -O2  -O3  -Os}
397
398 @item Preprocessor Options
399 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
400 @gccoptlist{-A@var{question}=@var{answer} @gol
401 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
402 -C  -dD  -dI  -dM  -dN @gol
403 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
404 -idirafter @var{dir} @gol
405 -include @var{file}  -imacros @var{file} @gol
406 -iprefix @var{file}  -iwithprefix @var{dir} @gol
407 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
408 -imultilib @var{dir} -isysroot @var{dir} @gol
409 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
410 -P  -fworking-directory  -remap @gol
411 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
412 -Xpreprocessor @var{option}}
413
414 @item Assembler Option
415 @xref{Assembler Options,,Passing Options to the Assembler}.
416 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
417
418 @item Linker Options
419 @xref{Link Options,,Options for Linking}.
420 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
421 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
422 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
423 -shared-libgcc  -symbolic @gol
424 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
425 -u @var{symbol}}
426
427 @item Directory Options
428 @xref{Directory Options,,Options for Directory Search}.
429 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir}}
430 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-
431 --sysroot=@var{dir}
432
433 @item Machine Dependent Options
434 @xref{Submodel Options,,Hardware Models and Configurations}.
435 @c This list is ordered alphanumerically by subsection name.
436 @c Try and put the significant identifier (CPU or system) first,
437 @c so users have a clue at guessing where the ones they want will be.
438
439 @emph{ARC Options}
440 @gccoptlist{-EB  -EL @gol
441 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
442 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
443
444 @emph{ARM Options}
445 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
446 -mabi=@var{name} @gol
447 -mapcs-stack-check  -mno-apcs-stack-check @gol
448 -mapcs-float  -mno-apcs-float @gol
449 -mapcs-reentrant  -mno-apcs-reentrant @gol
450 -msched-prolog  -mno-sched-prolog @gol
451 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
452 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
453 -mfp16-format=@var{name}
454 -mthumb-interwork  -mno-thumb-interwork @gol
455 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
456 -mstructure-size-boundary=@var{n} @gol
457 -mabort-on-noreturn @gol
458 -mlong-calls  -mno-long-calls @gol
459 -msingle-pic-base  -mno-single-pic-base @gol
460 -mpic-register=@var{reg} @gol
461 -mnop-fun-dllimport @gol
462 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
463 -mpoke-function-name @gol
464 -mthumb  -marm @gol
465 -mtpcs-frame  -mtpcs-leaf-frame @gol
466 -mcaller-super-interworking  -mcallee-super-interworking @gol
467 -mtp=@var{name} @gol
468 -mword-relocations @gol
469 -mfix-cortex-m3-ldrd}
470
471 @emph{AVR Options}
472 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
473 -mcall-prologues  -mtiny-stack  -mint8}
474
475 @emph{Blackfin Options}
476 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
477 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
478 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
479 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
480 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
481 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
482 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
483 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
484 -micplb}
485
486 @emph{CRIS Options}
487 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
488 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
489 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
490 -mstack-align  -mdata-align  -mconst-align @gol
491 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
492 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
493 -mmul-bug-workaround  -mno-mul-bug-workaround}
494
495 @emph{CRX Options}
496 @gccoptlist{-mmac -mpush-args}
497
498 @emph{Darwin Options}
499 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
500 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
501 -client_name  -compatibility_version  -current_version @gol
502 -dead_strip @gol
503 -dependency-file  -dylib_file  -dylinker_install_name @gol
504 -dynamic  -dynamiclib  -exported_symbols_list @gol
505 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
506 -force_flat_namespace  -headerpad_max_install_names @gol
507 -iframework @gol
508 -image_base  -init  -install_name  -keep_private_externs @gol
509 -multi_module  -multiply_defined  -multiply_defined_unused @gol
510 -noall_load   -no_dead_strip_inits_and_terms @gol
511 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
512 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
513 -private_bundle  -read_only_relocs  -sectalign @gol
514 -sectobjectsymbols  -whyload  -seg1addr @gol
515 -sectcreate  -sectobjectsymbols  -sectorder @gol
516 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
517 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
518 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
519 -single_module  -static  -sub_library  -sub_umbrella @gol
520 -twolevel_namespace  -umbrella  -undefined @gol
521 -unexported_symbols_list  -weak_reference_mismatches @gol
522 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
523 -mkernel -mone-byte-bool}
524
525 @emph{DEC Alpha Options}
526 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
527 -mieee  -mieee-with-inexact  -mieee-conformant @gol
528 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
529 -mtrap-precision=@var{mode}  -mbuild-constants @gol
530 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
531 -mbwx  -mmax  -mfix  -mcix @gol
532 -mfloat-vax  -mfloat-ieee @gol
533 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
534 -msmall-text  -mlarge-text @gol
535 -mmemory-latency=@var{time}}
536
537 @emph{DEC Alpha/VMS Options}
538 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
539
540 @emph{FR30 Options}
541 @gccoptlist{-msmall-model -mno-lsim}
542
543 @emph{FRV Options}
544 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
545 -mhard-float  -msoft-float @gol
546 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
547 -mdouble  -mno-double @gol
548 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
549 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
550 -mlinked-fp  -mlong-calls  -malign-labels @gol
551 -mlibrary-pic  -macc-4  -macc-8 @gol
552 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
553 -moptimize-membar -mno-optimize-membar @gol
554 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
555 -mvliw-branch  -mno-vliw-branch @gol
556 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
557 -mno-nested-cond-exec  -mtomcat-stats @gol
558 -mTLS -mtls @gol
559 -mcpu=@var{cpu}}
560
561 @emph{GNU/Linux Options}
562 @gccoptlist{-muclibc}
563
564 @emph{H8/300 Options}
565 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
566
567 @emph{HPPA Options}
568 @gccoptlist{-march=@var{architecture-type} @gol
569 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
570 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
571 -mfixed-range=@var{register-range} @gol
572 -mjump-in-delay -mlinker-opt -mlong-calls @gol
573 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
574 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
575 -mno-jump-in-delay  -mno-long-load-store @gol
576 -mno-portable-runtime  -mno-soft-float @gol
577 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
578 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
579 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
580 -munix=@var{unix-std}  -nolibdld  -static  -threads}
581
582 @emph{i386 and x86-64 Options}
583 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
584 -mfpmath=@var{unit} @gol
585 -masm=@var{dialect}  -mno-fancy-math-387 @gol
586 -mno-fp-ret-in-387  -msoft-float @gol
587 -mno-wide-multiply  -mrtd  -malign-double @gol
588 -mpreferred-stack-boundary=@var{num}
589 -mincoming-stack-boundary=@var{num}
590 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
591 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
592 -maes -mpclmul -mfused-madd @gol
593 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
594 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
595 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
596 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
597 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
598 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
599 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
600 -mcmodel=@var{code-model} -mabi=@var{name} @gol
601 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
602 -msse2avx}
603
604 @emph{IA-64 Options}
605 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
606 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
607 -mconstant-gp  -mauto-pic  -mfused-madd @gol
608 -minline-float-divide-min-latency @gol
609 -minline-float-divide-max-throughput @gol
610 -mno-inline-float-divide @gol
611 -minline-int-divide-min-latency @gol
612 -minline-int-divide-max-throughput  @gol
613 -mno-inline-int-divide @gol
614 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
615 -mno-inline-sqrt @gol
616 -mdwarf2-asm -mearly-stop-bits @gol
617 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
618 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
619 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
620 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
621 -msched-spec-ldc -msched-spec-control-ldc @gol
622 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
623 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
624 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
625 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
626
627 @emph{IA-64/VMS Options}
628 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
629
630 @emph{LM32 Options}
631 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
632 -msign-extend-enabled -muser-enabled}
633
634 @emph{M32R/D Options}
635 @gccoptlist{-m32r2 -m32rx -m32r @gol
636 -mdebug @gol
637 -malign-loops -mno-align-loops @gol
638 -missue-rate=@var{number} @gol
639 -mbranch-cost=@var{number} @gol
640 -mmodel=@var{code-size-model-type} @gol
641 -msdata=@var{sdata-type} @gol
642 -mno-flush-func -mflush-func=@var{name} @gol
643 -mno-flush-trap -mflush-trap=@var{number} @gol
644 -G @var{num}}
645
646 @emph{M32C Options}
647 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
648
649 @emph{M680x0 Options}
650 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
651 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
652 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
653 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
654 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
655 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
656 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
657 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
658 -mxgot -mno-xgot}
659
660 @emph{M68hc1x Options}
661 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
662 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
663 -msoft-reg-count=@var{count}}
664
665 @emph{MCore Options}
666 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
667 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
668 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
669 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
670 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
671
672 @emph{MeP Options}
673 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
674 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
675 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
676 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
677 -mtiny=@var{n}}
678
679 @emph{MIPS Options}
680 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
681 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
682 -mips64  -mips64r2 @gol
683 -mips16  -mno-mips16  -mflip-mips16 @gol
684 -minterlink-mips16  -mno-interlink-mips16 @gol
685 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
686 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
687 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
688 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
689 -mfpu=@var{fpu-type} @gol
690 -msmartmips  -mno-smartmips @gol
691 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
692 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
693 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
694 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
695 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
696 -membedded-data  -mno-embedded-data @gol
697 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
698 -mcode-readable=@var{setting} @gol
699 -msplit-addresses  -mno-split-addresses @gol
700 -mexplicit-relocs  -mno-explicit-relocs @gol
701 -mcheck-zero-division  -mno-check-zero-division @gol
702 -mdivide-traps  -mdivide-breaks @gol
703 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
704 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
705 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
706 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
707 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
708 -mflush-func=@var{func}  -mno-flush-func @gol
709 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
710 -mfp-exceptions -mno-fp-exceptions @gol
711 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
712 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
713
714 @emph{MMIX Options}
715 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
716 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
717 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
718 -mno-base-addresses  -msingle-exit  -mno-single-exit}
719
720 @emph{MN10300 Options}
721 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
722 -mam33  -mno-am33 @gol
723 -mam33-2  -mno-am33-2 @gol
724 -mreturn-pointer-on-d0 @gol
725 -mno-crt0  -mrelax}
726
727 @emph{PDP-11 Options}
728 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
729 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
730 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
731 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
732 -mbranch-expensive  -mbranch-cheap @gol
733 -msplit  -mno-split  -munix-asm  -mdec-asm}
734
735 @emph{picoChip Options}
736 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
737 -msymbol-as-address -mno-inefficient-warnings}
738
739 @emph{PowerPC Options}
740 See RS/6000 and PowerPC Options.
741
742 @emph{RS/6000 and PowerPC Options}
743 @gccoptlist{-mcpu=@var{cpu-type} @gol
744 -mtune=@var{cpu-type} @gol
745 -mpower  -mno-power  -mpower2  -mno-power2 @gol
746 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
747 -maltivec  -mno-altivec @gol
748 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
749 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
750 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
751 -mfprnd  -mno-fprnd @gol
752 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
753 -mnew-mnemonics  -mold-mnemonics @gol
754 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
755 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
756 -malign-power  -malign-natural @gol
757 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
758 -msingle-float -mdouble-float -msimple-fpu @gol
759 -mstring  -mno-string  -mupdate  -mno-update @gol
760 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
761 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
762 -mstrict-align  -mno-strict-align  -mrelocatable @gol
763 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
764 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
765 -mdynamic-no-pic  -maltivec -mswdiv @gol
766 -mprioritize-restricted-insns=@var{priority} @gol
767 -msched-costly-dep=@var{dependence_type} @gol
768 -minsert-sched-nops=@var{scheme} @gol
769 -mcall-sysv  -mcall-netbsd @gol
770 -maix-struct-return  -msvr4-struct-return @gol
771 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
772 -misel -mno-isel @gol
773 -misel=yes  -misel=no @gol
774 -mspe -mno-spe @gol
775 -mspe=yes  -mspe=no @gol
776 -mpaired @gol
777 -mgen-cell-microcode -mwarn-cell-microcode @gol
778 -mvrsave -mno-vrsave @gol
779 -mmulhw -mno-mulhw @gol
780 -mdlmzb -mno-dlmzb @gol
781 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
782 -mprototype  -mno-prototype @gol
783 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
784 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
785
786 @emph{RX Options}
787 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
788 -mcpu= -patch=@gol
789 -mbig-endian-data -mlittle-endian-data @gol
790 -msmall-data @gol
791 -msim  -mno-sim@gol
792 -mas100-syntax -mno-as100-syntax@gol
793 -mrelax@gol
794 -mmax-constant-size=@gol
795 -mint-register=@gol
796 -msave-acc-in-interrupts}
797
798 @emph{S/390 and zSeries Options}
799 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
800 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
801 -mlong-double-64 -mlong-double-128 @gol
802 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
803 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
804 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
805 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
806 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
807
808 @emph{Score Options}
809 @gccoptlist{-meb -mel @gol
810 -mnhwloop @gol
811 -muls @gol
812 -mmac @gol
813 -mscore5 -mscore5u -mscore7 -mscore7d}
814
815 @emph{SH Options}
816 @gccoptlist{-m1  -m2  -m2e @gol
817 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
818 -m3  -m3e @gol
819 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
820 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
821 -m5-64media  -m5-64media-nofpu @gol
822 -m5-32media  -m5-32media-nofpu @gol
823 -m5-compact  -m5-compact-nofpu @gol
824 -mb  -ml  -mdalign  -mrelax @gol
825 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
826 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
827 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
828 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
829 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
830 -maccumulate-outgoing-args -minvalid-symbols}
831
832 @emph{SPARC Options}
833 @gccoptlist{-mcpu=@var{cpu-type} @gol
834 -mtune=@var{cpu-type} @gol
835 -mcmodel=@var{code-model} @gol
836 -m32  -m64  -mapp-regs  -mno-app-regs @gol
837 -mfaster-structs  -mno-faster-structs @gol
838 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
839 -mhard-quad-float  -msoft-quad-float @gol
840 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
841 -mstack-bias  -mno-stack-bias @gol
842 -munaligned-doubles  -mno-unaligned-doubles @gol
843 -mv8plus  -mno-v8plus  -mvis  -mno-vis
844 -threads -pthreads -pthread}
845
846 @emph{SPU Options}
847 @gccoptlist{-mwarn-reloc -merror-reloc @gol
848 -msafe-dma -munsafe-dma @gol
849 -mbranch-hints @gol
850 -msmall-mem -mlarge-mem -mstdmain @gol
851 -mfixed-range=@var{register-range} @gol
852 -mea32 -mea64 @gol
853 -maddress-space-conversion -mno-address-space-conversion @gol
854 -mcache-size=@var{cache-size} @gol
855 -matomic-updates -mno-atomic-updates}
856
857 @emph{System V Options}
858 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
859
860 @emph{V850 Options}
861 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
862 -mprolog-function  -mno-prolog-function  -mspace @gol
863 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
864 -mapp-regs  -mno-app-regs @gol
865 -mdisable-callt  -mno-disable-callt @gol
866 -mv850e1 @gol
867 -mv850e @gol
868 -mv850  -mbig-switch}
869
870 @emph{VAX Options}
871 @gccoptlist{-mg  -mgnu  -munix}
872
873 @emph{VxWorks Options}
874 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
875 -Xbind-lazy  -Xbind-now}
876
877 @emph{x86-64 Options}
878 See i386 and x86-64 Options.
879
880 @emph{i386 and x86-64 Windows Options}
881 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
882 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
883 -fno-set-stack-executable}
884
885 @emph{Xstormy16 Options}
886 @gccoptlist{-msim}
887
888 @emph{Xtensa Options}
889 @gccoptlist{-mconst16 -mno-const16 @gol
890 -mfused-madd  -mno-fused-madd @gol
891 -mserialize-volatile  -mno-serialize-volatile @gol
892 -mtext-section-literals  -mno-text-section-literals @gol
893 -mtarget-align  -mno-target-align @gol
894 -mlongcalls  -mno-longcalls}
895
896 @emph{zSeries Options}
897 See S/390 and zSeries Options.
898
899 @item Code Generation Options
900 @xref{Code Gen Options,,Options for Code Generation Conventions}.
901 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
902 -ffixed-@var{reg}  -fexceptions @gol
903 -fnon-call-exceptions  -funwind-tables @gol
904 -fasynchronous-unwind-tables @gol
905 -finhibit-size-directive  -finstrument-functions @gol
906 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
907 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
908 -fno-common  -fno-ident @gol
909 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
910 -fno-jump-tables @gol
911 -frecord-gcc-switches @gol
912 -freg-struct-return  -fshort-enums @gol
913 -fshort-double  -fshort-wchar @gol
914 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
915 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
916 -fno-stack-limit @gol
917 -fleading-underscore  -ftls-model=@var{model} @gol
918 -ftrapv  -fwrapv  -fbounds-check @gol
919 -fvisibility}
920 @end table
921
922 @menu
923 * Overall Options::     Controlling the kind of output:
924                         an executable, object files, assembler files,
925                         or preprocessed source.
926 * C Dialect Options::   Controlling the variant of C language compiled.
927 * C++ Dialect Options:: Variations on C++.
928 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
929                         and Objective-C++.
930 * Language Independent Options:: Controlling how diagnostics should be
931                         formatted.
932 * Warning Options::     How picky should the compiler be?
933 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
934 * Optimize Options::    How much optimization?
935 * Preprocessor Options:: Controlling header files and macro definitions.
936                          Also, getting dependency information for Make.
937 * Assembler Options::   Passing options to the assembler.
938 * Link Options::        Specifying libraries and so on.
939 * Directory Options::   Where to find header files and libraries.
940                         Where to find the compiler executable files.
941 * Spec Files::          How to pass switches to sub-processes.
942 * Target Options::      Running a cross-compiler, or an old version of GCC.
943 @end menu
944
945 @node Overall Options
946 @section Options Controlling the Kind of Output
947
948 Compilation can involve up to four stages: preprocessing, compilation
949 proper, assembly and linking, always in that order.  GCC is capable of
950 preprocessing and compiling several files either into several
951 assembler input files, or into one assembler input file; then each
952 assembler input file produces an object file, and linking combines all
953 the object files (those newly compiled, and those specified as input)
954 into an executable file.
955
956 @cindex file name suffix
957 For any given input file, the file name suffix determines what kind of
958 compilation is done:
959
960 @table @gcctabopt
961 @item @var{file}.c
962 C source code which must be preprocessed.
963
964 @item @var{file}.i
965 C source code which should not be preprocessed.
966
967 @item @var{file}.ii
968 C++ source code which should not be preprocessed.
969
970 @item @var{file}.m
971 Objective-C source code.  Note that you must link with the @file{libobjc}
972 library to make an Objective-C program work.
973
974 @item @var{file}.mi
975 Objective-C source code which should not be preprocessed.
976
977 @item @var{file}.mm
978 @itemx @var{file}.M
979 Objective-C++ source code.  Note that you must link with the @file{libobjc}
980 library to make an Objective-C++ program work.  Note that @samp{.M} refers
981 to a literal capital M@.
982
983 @item @var{file}.mii
984 Objective-C++ source code which should not be preprocessed.
985
986 @item @var{file}.h
987 C, C++, Objective-C or Objective-C++ header file to be turned into a
988 precompiled header.
989
990 @item @var{file}.cc
991 @itemx @var{file}.cp
992 @itemx @var{file}.cxx
993 @itemx @var{file}.cpp
994 @itemx @var{file}.CPP
995 @itemx @var{file}.c++
996 @itemx @var{file}.C
997 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
998 the last two letters must both be literally @samp{x}.  Likewise,
999 @samp{.C} refers to a literal capital C@.
1000
1001 @item @var{file}.mm
1002 @itemx @var{file}.M
1003 Objective-C++ source code which must be preprocessed.
1004
1005 @item @var{file}.mii
1006 Objective-C++ source code which should not be preprocessed.
1007
1008 @item @var{file}.hh
1009 @itemx @var{file}.H
1010 @itemx @var{file}.hp
1011 @itemx @var{file}.hxx
1012 @itemx @var{file}.hpp
1013 @itemx @var{file}.HPP
1014 @itemx @var{file}.h++
1015 @itemx @var{file}.tcc
1016 C++ header file to be turned into a precompiled header.
1017
1018 @item @var{file}.f
1019 @itemx @var{file}.for
1020 @itemx @var{file}.ftn
1021 Fixed form Fortran source code which should not be preprocessed.
1022
1023 @item @var{file}.F
1024 @itemx @var{file}.FOR
1025 @itemx @var{file}.fpp
1026 @itemx @var{file}.FPP
1027 @itemx @var{file}.FTN
1028 Fixed form Fortran source code which must be preprocessed (with the traditional
1029 preprocessor).
1030
1031 @item @var{file}.f90
1032 @itemx @var{file}.f95
1033 @itemx @var{file}.f03
1034 @itemx @var{file}.f08
1035 Free form Fortran source code which should not be preprocessed.
1036
1037 @item @var{file}.F90
1038 @itemx @var{file}.F95
1039 @itemx @var{file}.F03
1040 @itemx @var{file}.F08
1041 Free form Fortran source code which must be preprocessed (with the
1042 traditional preprocessor).
1043
1044 @c FIXME: Descriptions of Java file types.
1045 @c @var{file}.java
1046 @c @var{file}.class
1047 @c @var{file}.zip
1048 @c @var{file}.jar
1049
1050 @item @var{file}.ads
1051 Ada source code file which contains a library unit declaration (a
1052 declaration of a package, subprogram, or generic, or a generic
1053 instantiation), or a library unit renaming declaration (a package,
1054 generic, or subprogram renaming declaration).  Such files are also
1055 called @dfn{specs}.
1056
1057 @item @var{file}.adb
1058 Ada source code file containing a library unit body (a subprogram or
1059 package body).  Such files are also called @dfn{bodies}.
1060
1061 @c GCC also knows about some suffixes for languages not yet included:
1062 @c Pascal:
1063 @c @var{file}.p
1064 @c @var{file}.pas
1065 @c Ratfor:
1066 @c @var{file}.r
1067
1068 @item @var{file}.s
1069 Assembler code.
1070
1071 @item @var{file}.S
1072 @itemx @var{file}.sx
1073 Assembler code which must be preprocessed.
1074
1075 @item @var{other}
1076 An object file to be fed straight into linking.
1077 Any file name with no recognized suffix is treated this way.
1078 @end table
1079
1080 @opindex x
1081 You can specify the input language explicitly with the @option{-x} option:
1082
1083 @table @gcctabopt
1084 @item -x @var{language}
1085 Specify explicitly the @var{language} for the following input files
1086 (rather than letting the compiler choose a default based on the file
1087 name suffix).  This option applies to all following input files until
1088 the next @option{-x} option.  Possible values for @var{language} are:
1089 @smallexample
1090 c  c-header  c-cpp-output
1091 c++  c++-header  c++-cpp-output
1092 objective-c  objective-c-header  objective-c-cpp-output
1093 objective-c++ objective-c++-header objective-c++-cpp-output
1094 assembler  assembler-with-cpp
1095 ada
1096 f77  f77-cpp-input f95  f95-cpp-input
1097 java
1098 @end smallexample
1099
1100 @item -x none
1101 Turn off any specification of a language, so that subsequent files are
1102 handled according to their file name suffixes (as they are if @option{-x}
1103 has not been used at all).
1104
1105 @item -pass-exit-codes
1106 @opindex pass-exit-codes
1107 Normally the @command{gcc} program will exit with the code of 1 if any
1108 phase of the compiler returns a non-success return code.  If you specify
1109 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1110 numerically highest error produced by any phase that returned an error
1111 indication.  The C, C++, and Fortran frontends return 4, if an internal
1112 compiler error is encountered.
1113 @end table
1114
1115 If you only want some of the stages of compilation, you can use
1116 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1117 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1118 @command{gcc} is to stop.  Note that some combinations (for example,
1119 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1120
1121 @table @gcctabopt
1122 @item -c
1123 @opindex c
1124 Compile or assemble the source files, but do not link.  The linking
1125 stage simply is not done.  The ultimate output is in the form of an
1126 object file for each source file.
1127
1128 By default, the object file name for a source file is made by replacing
1129 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1130
1131 Unrecognized input files, not requiring compilation or assembly, are
1132 ignored.
1133
1134 @item -S
1135 @opindex S
1136 Stop after the stage of compilation proper; do not assemble.  The output
1137 is in the form of an assembler code file for each non-assembler input
1138 file specified.
1139
1140 By default, the assembler file name for a source file is made by
1141 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1142
1143 Input files that don't require compilation are ignored.
1144
1145 @item -E
1146 @opindex E
1147 Stop after the preprocessing stage; do not run the compiler proper.  The
1148 output is in the form of preprocessed source code, which is sent to the
1149 standard output.
1150
1151 Input files which don't require preprocessing are ignored.
1152
1153 @cindex output file option
1154 @item -o @var{file}
1155 @opindex o
1156 Place output in file @var{file}.  This applies regardless to whatever
1157 sort of output is being produced, whether it be an executable file,
1158 an object file, an assembler file or preprocessed C code.
1159
1160 If @option{-o} is not specified, the default is to put an executable
1161 file in @file{a.out}, the object file for
1162 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1163 assembler file in @file{@var{source}.s}, a precompiled header file in
1164 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1165 standard output.
1166
1167 @item -v
1168 @opindex v
1169 Print (on standard error output) the commands executed to run the stages
1170 of compilation.  Also print the version number of the compiler driver
1171 program and of the preprocessor and the compiler proper.
1172
1173 @item -###
1174 @opindex ###
1175 Like @option{-v} except the commands are not executed and arguments
1176 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1177 This is useful for shell scripts to capture the driver-generated command lines.
1178
1179 @item -pipe
1180 @opindex pipe
1181 Use pipes rather than temporary files for communication between the
1182 various stages of compilation.  This fails to work on some systems where
1183 the assembler is unable to read from a pipe; but the GNU assembler has
1184 no trouble.
1185
1186 @item -combine
1187 @opindex combine
1188 If you are compiling multiple source files, this option tells the driver
1189 to pass all the source files to the compiler at once (for those
1190 languages for which the compiler can handle this).  This will allow
1191 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1192 language for which this is supported is C@.  If you pass source files for
1193 multiple languages to the driver, using this option, the driver will invoke
1194 the compiler(s) that support IMA once each, passing each compiler all the
1195 source files appropriate for it.  For those languages that do not support
1196 IMA this option will be ignored, and the compiler will be invoked once for
1197 each source file in that language.  If you use this option in conjunction
1198 with @option{-save-temps}, the compiler will generate multiple
1199 pre-processed files
1200 (one for each source file), but only one (combined) @file{.o} or
1201 @file{.s} file.
1202
1203 @item --help
1204 @opindex help
1205 Print (on the standard output) a description of the command line options
1206 understood by @command{gcc}.  If the @option{-v} option is also specified
1207 then @option{--help} will also be passed on to the various processes
1208 invoked by @command{gcc}, so that they can display the command line options
1209 they accept.  If the @option{-Wextra} option has also been specified
1210 (prior to the @option{--help} option), then command line options which
1211 have no documentation associated with them will also be displayed.
1212
1213 @item --target-help
1214 @opindex target-help
1215 Print (on the standard output) a description of target-specific command
1216 line options for each tool.  For some targets extra target-specific
1217 information may also be printed.
1218
1219 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1220 Print (on the standard output) a description of the command line
1221 options understood by the compiler that fit into all specified classes
1222 and qualifiers.  These are the supported classes:
1223
1224 @table @asis
1225 @item @samp{optimizers}
1226 This will display all of the optimization options supported by the
1227 compiler.
1228
1229 @item @samp{warnings}
1230 This will display all of the options controlling warning messages
1231 produced by the compiler.
1232
1233 @item @samp{target}
1234 This will display target-specific options.  Unlike the
1235 @option{--target-help} option however, target-specific options of the
1236 linker and assembler will not be displayed.  This is because those
1237 tools do not currently support the extended @option{--help=} syntax.
1238
1239 @item @samp{params}
1240 This will display the values recognized by the @option{--param}
1241 option.
1242
1243 @item @var{language}
1244 This will display the options supported for @var{language}, where
1245 @var{language} is the name of one of the languages supported in this
1246 version of GCC.
1247
1248 @item @samp{common}
1249 This will display the options that are common to all languages.
1250 @end table
1251
1252 These are the supported qualifiers:
1253
1254 @table @asis
1255 @item @samp{undocumented}
1256 Display only those options which are undocumented.
1257
1258 @item @samp{joined}
1259 Display options which take an argument that appears after an equal
1260 sign in the same continuous piece of text, such as:
1261 @samp{--help=target}.
1262
1263 @item @samp{separate}
1264 Display options which take an argument that appears as a separate word
1265 following the original option, such as: @samp{-o output-file}.
1266 @end table
1267
1268 Thus for example to display all the undocumented target-specific
1269 switches supported by the compiler the following can be used:
1270
1271 @smallexample
1272 --help=target,undocumented
1273 @end smallexample
1274
1275 The sense of a qualifier can be inverted by prefixing it with the
1276 @samp{^} character, so for example to display all binary warning
1277 options (i.e., ones that are either on or off and that do not take an
1278 argument), which have a description the following can be used:
1279
1280 @smallexample
1281 --help=warnings,^joined,^undocumented
1282 @end smallexample
1283
1284 The argument to @option{--help=} should not consist solely of inverted
1285 qualifiers.
1286
1287 Combining several classes is possible, although this usually
1288 restricts the output by so much that there is nothing to display.  One
1289 case where it does work however is when one of the classes is
1290 @var{target}.  So for example to display all the target-specific
1291 optimization options the following can be used:
1292
1293 @smallexample
1294 --help=target,optimizers
1295 @end smallexample
1296
1297 The @option{--help=} option can be repeated on the command line.  Each
1298 successive use will display its requested class of options, skipping
1299 those that have already been displayed.
1300
1301 If the @option{-Q} option appears on the command line before the
1302 @option{--help=} option, then the descriptive text displayed by
1303 @option{--help=} is changed.  Instead of describing the displayed
1304 options, an indication is given as to whether the option is enabled,
1305 disabled or set to a specific value (assuming that the compiler
1306 knows this at the point where the @option{--help=} option is used).
1307
1308 Here is a truncated example from the ARM port of @command{gcc}:
1309
1310 @smallexample
1311   % gcc -Q -mabi=2 --help=target -c
1312   The following options are target specific:
1313   -mabi=                                2
1314   -mabort-on-noreturn                   [disabled]
1315   -mapcs                                [disabled]
1316 @end smallexample
1317
1318 The output is sensitive to the effects of previous command line
1319 options, so for example it is possible to find out which optimizations
1320 are enabled at @option{-O2} by using:
1321
1322 @smallexample
1323 -Q -O2 --help=optimizers
1324 @end smallexample
1325
1326 Alternatively you can discover which binary optimizations are enabled
1327 by @option{-O3} by using:
1328
1329 @smallexample
1330 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1331 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1332 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1333 @end smallexample
1334
1335 @item -no-canonical-prefixes
1336 @opindex no-canonical-prefixes
1337 Do not expand any symbolic links, resolve references to @samp{/../}
1338 or @samp{/./}, or make the path absolute when generating a relative
1339 prefix.
1340
1341 @item --version
1342 @opindex version
1343 Display the version number and copyrights of the invoked GCC@.
1344
1345 @item -wrapper
1346 @opindex wrapper
1347 Invoke all subcommands under a wrapper program. It takes a single
1348 comma separated list as an argument, which will be used to invoke
1349 the wrapper:
1350
1351 @smallexample
1352 gcc -c t.c -wrapper gdb,--args
1353 @end smallexample
1354
1355 This will invoke all subprograms of gcc under "gdb --args",
1356 thus cc1 invocation will be "gdb --args cc1 ...".
1357
1358 @item -fplugin=@var{name}.so
1359 Load the plugin code in file @var{name}.so, assumed to be a
1360 shared object to be dlopen'd by the compiler.  The base name of
1361 the shared object file is used to identify the plugin for the
1362 purposes of argument parsing (See
1363 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1364 Each plugin should define the callback functions specified in the
1365 Plugins API.
1366
1367 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1368 Define an argument called @var{key} with a value of @var{value}
1369 for the plugin called @var{name}.
1370
1371 @include @value{srcdir}/../libiberty/at-file.texi
1372 @end table
1373
1374 @node Invoking G++
1375 @section Compiling C++ Programs
1376
1377 @cindex suffixes for C++ source
1378 @cindex C++ source file suffixes
1379 C++ source files conventionally use one of the suffixes @samp{.C},
1380 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1381 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1382 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1383 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1384 files with these names and compiles them as C++ programs even if you
1385 call the compiler the same way as for compiling C programs (usually
1386 with the name @command{gcc}).
1387
1388 @findex g++
1389 @findex c++
1390 However, the use of @command{gcc} does not add the C++ library.
1391 @command{g++} is a program that calls GCC and treats @samp{.c},
1392 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1393 files unless @option{-x} is used, and automatically specifies linking
1394 against the C++ library.  This program is also useful when
1395 precompiling a C header file with a @samp{.h} extension for use in C++
1396 compilations.  On many systems, @command{g++} is also installed with
1397 the name @command{c++}.
1398
1399 @cindex invoking @command{g++}
1400 When you compile C++ programs, you may specify many of the same
1401 command-line options that you use for compiling programs in any
1402 language; or command-line options meaningful for C and related
1403 languages; or options that are meaningful only for C++ programs.
1404 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1405 explanations of options for languages related to C@.
1406 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1407 explanations of options that are meaningful only for C++ programs.
1408
1409 @node C Dialect Options
1410 @section Options Controlling C Dialect
1411 @cindex dialect options
1412 @cindex language dialect options
1413 @cindex options, dialect
1414
1415 The following options control the dialect of C (or languages derived
1416 from C, such as C++, Objective-C and Objective-C++) that the compiler
1417 accepts:
1418
1419 @table @gcctabopt
1420 @cindex ANSI support
1421 @cindex ISO support
1422 @item -ansi
1423 @opindex ansi
1424 In C mode, this is equivalent to @samp{-std=c90}. In C++ mode, it is
1425 equivalent to @samp{-std=c++98}.
1426
1427 This turns off certain features of GCC that are incompatible with ISO
1428 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1429 such as the @code{asm} and @code{typeof} keywords, and
1430 predefined macros such as @code{unix} and @code{vax} that identify the
1431 type of system you are using.  It also enables the undesirable and
1432 rarely used ISO trigraph feature.  For the C compiler,
1433 it disables recognition of C++ style @samp{//} comments as well as
1434 the @code{inline} keyword.
1435
1436 The alternate keywords @code{__asm__}, @code{__extension__},
1437 @code{__inline__} and @code{__typeof__} continue to work despite
1438 @option{-ansi}.  You would not want to use them in an ISO C program, of
1439 course, but it is useful to put them in header files that might be included
1440 in compilations done with @option{-ansi}.  Alternate predefined macros
1441 such as @code{__unix__} and @code{__vax__} are also available, with or
1442 without @option{-ansi}.
1443
1444 The @option{-ansi} option does not cause non-ISO programs to be
1445 rejected gratuitously.  For that, @option{-pedantic} is required in
1446 addition to @option{-ansi}.  @xref{Warning Options}.
1447
1448 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1449 option is used.  Some header files may notice this macro and refrain
1450 from declaring certain functions or defining certain macros that the
1451 ISO standard doesn't call for; this is to avoid interfering with any
1452 programs that might use these names for other things.
1453
1454 Functions that would normally be built in but do not have semantics
1455 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1456 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1457 built-in functions provided by GCC}, for details of the functions
1458 affected.
1459
1460 @item -std=
1461 @opindex std
1462 Determine the language standard. @xref{Standards,,Language Standards
1463 Supported by GCC}, for details of these standard versions.  This option
1464 is currently only supported when compiling C or C++.
1465
1466 The compiler can accept several base standards, such as @samp{c90} or
1467 @samp{c++98}, and GNU dialects of those standards, such as
1468 @samp{gnu90} or @samp{gnu++98}.  By specifying a base standard, the
1469 compiler will accept all programs following that standard and those
1470 using GNU extensions that do not contradict it.  For example,
1471 @samp{-std=c90} turns off certain features of GCC that are
1472 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1473 keywords, but not other GNU extensions that do not have a meaning in
1474 ISO C90, such as omitting the middle term of a @code{?:}
1475 expression. On the other hand, by specifying a GNU dialect of a
1476 standard, all features the compiler support are enabled, even when
1477 those features change the meaning of the base standard and some
1478 strict-conforming programs may be rejected.  The particular standard
1479 is used by @option{-pedantic} to identify which features are GNU
1480 extensions given that version of the standard. For example
1481 @samp{-std=gnu90 -pedantic} would warn about C++ style @samp{//}
1482 comments, while @samp{-std=gnu99 -pedantic} would not.
1483
1484 A value for this option must be provided; possible values are
1485
1486 @table @samp
1487 @item c90
1488 @itemx c89
1489 @itemx iso9899:1990
1490 Support all ISO C90 programs (certain GNU extensions that conflict
1491 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1492
1493 @item iso9899:199409
1494 ISO C90 as modified in amendment 1.
1495
1496 @item c99
1497 @itemx c9x
1498 @itemx iso9899:1999
1499 @itemx iso9899:199x
1500 ISO C99.  Note that this standard is not yet fully supported; see
1501 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1502 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1503
1504 @item c1x
1505 ISO C1X, the draft of the next revision of the ISO C standard.
1506 Support is limited and experimental and features enabled by this
1507 option may be changed or removed if changed in or removed from the
1508 standard draft.
1509
1510 @item gnu90
1511 @itemx gnu89
1512 GNU dialect of ISO C90 (including some C99 features). This
1513 is the default for C code.
1514
1515 @item gnu99
1516 @itemx gnu9x
1517 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1518 this will become the default.  The name @samp{gnu9x} is deprecated.
1519
1520 @item gnu1x
1521 GNU dialect of ISO C1X.  Support is limited and experimental and
1522 features enabled by this option may be changed or removed if changed
1523 in or removed from the standard draft.
1524
1525 @item c++98
1526 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1527 C++ code.
1528
1529 @item gnu++98
1530 GNU dialect of @option{-std=c++98}.  This is the default for
1531 C++ code.
1532
1533 @item c++0x
1534 The working draft of the upcoming ISO C++0x standard. This option
1535 enables experimental features that are likely to be included in
1536 C++0x. The working draft is constantly changing, and any feature that is
1537 enabled by this flag may be removed from future versions of GCC if it is
1538 not part of the C++0x standard.
1539
1540 @item gnu++0x
1541 GNU dialect of @option{-std=c++0x}. This option enables
1542 experimental features that may be removed in future versions of GCC.
1543 @end table
1544
1545 @item -fgnu89-inline
1546 @opindex fgnu89-inline
1547 The option @option{-fgnu89-inline} tells GCC to use the traditional
1548 GNU semantics for @code{inline} functions when in C99 mode.
1549 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1550 is accepted and ignored by GCC versions 4.1.3 up to but not including
1551 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1552 C99 mode.  Using this option is roughly equivalent to adding the
1553 @code{gnu_inline} function attribute to all inline functions
1554 (@pxref{Function Attributes}).
1555
1556 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1557 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1558 specifies the default behavior).  This option was first supported in
1559 GCC 4.3.  This option is not supported in @option{-std=c90} or
1560 @option{-std=gnu90} mode.
1561
1562 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1563 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1564 in effect for @code{inline} functions.  @xref{Common Predefined
1565 Macros,,,cpp,The C Preprocessor}.
1566
1567 @item -aux-info @var{filename}
1568 @opindex aux-info
1569 Output to the given filename prototyped declarations for all functions
1570 declared and/or defined in a translation unit, including those in header
1571 files.  This option is silently ignored in any language other than C@.
1572
1573 Besides declarations, the file indicates, in comments, the origin of
1574 each declaration (source file and line), whether the declaration was
1575 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1576 @samp{O} for old, respectively, in the first character after the line
1577 number and the colon), and whether it came from a declaration or a
1578 definition (@samp{C} or @samp{F}, respectively, in the following
1579 character).  In the case of function definitions, a K&R-style list of
1580 arguments followed by their declarations is also provided, inside
1581 comments, after the declaration.
1582
1583 @item -fno-asm
1584 @opindex fno-asm
1585 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1586 keyword, so that code can use these words as identifiers.  You can use
1587 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1588 instead.  @option{-ansi} implies @option{-fno-asm}.
1589
1590 In C++, this switch only affects the @code{typeof} keyword, since
1591 @code{asm} and @code{inline} are standard keywords.  You may want to
1592 use the @option{-fno-gnu-keywords} flag instead, which has the same
1593 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1594 switch only affects the @code{asm} and @code{typeof} keywords, since
1595 @code{inline} is a standard keyword in ISO C99.
1596
1597 @item -fno-builtin
1598 @itemx -fno-builtin-@var{function}
1599 @opindex fno-builtin
1600 @cindex built-in functions
1601 Don't recognize built-in functions that do not begin with
1602 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1603 functions provided by GCC}, for details of the functions affected,
1604 including those which are not built-in functions when @option{-ansi} or
1605 @option{-std} options for strict ISO C conformance are used because they
1606 do not have an ISO standard meaning.
1607
1608 GCC normally generates special code to handle certain built-in functions
1609 more efficiently; for instance, calls to @code{alloca} may become single
1610 instructions that adjust the stack directly, and calls to @code{memcpy}
1611 may become inline copy loops.  The resulting code is often both smaller
1612 and faster, but since the function calls no longer appear as such, you
1613 cannot set a breakpoint on those calls, nor can you change the behavior
1614 of the functions by linking with a different library.  In addition,
1615 when a function is recognized as a built-in function, GCC may use
1616 information about that function to warn about problems with calls to
1617 that function, or to generate more efficient code, even if the
1618 resulting code still contains calls to that function.  For example,
1619 warnings are given with @option{-Wformat} for bad calls to
1620 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1621 known not to modify global memory.
1622
1623 With the @option{-fno-builtin-@var{function}} option
1624 only the built-in function @var{function} is
1625 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1626 function is named that is not built-in in this version of GCC, this
1627 option is ignored.  There is no corresponding
1628 @option{-fbuiltin-@var{function}} option; if you wish to enable
1629 built-in functions selectively when using @option{-fno-builtin} or
1630 @option{-ffreestanding}, you may define macros such as:
1631
1632 @smallexample
1633 #define abs(n)          __builtin_abs ((n))
1634 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1635 @end smallexample
1636
1637 @item -fhosted
1638 @opindex fhosted
1639 @cindex hosted environment
1640
1641 Assert that compilation takes place in a hosted environment.  This implies
1642 @option{-fbuiltin}.  A hosted environment is one in which the
1643 entire standard library is available, and in which @code{main} has a return
1644 type of @code{int}.  Examples are nearly everything except a kernel.
1645 This is equivalent to @option{-fno-freestanding}.
1646
1647 @item -ffreestanding
1648 @opindex ffreestanding
1649 @cindex hosted environment
1650
1651 Assert that compilation takes place in a freestanding environment.  This
1652 implies @option{-fno-builtin}.  A freestanding environment
1653 is one in which the standard library may not exist, and program startup may
1654 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1655 This is equivalent to @option{-fno-hosted}.
1656
1657 @xref{Standards,,Language Standards Supported by GCC}, for details of
1658 freestanding and hosted environments.
1659
1660 @item -fopenmp
1661 @opindex fopenmp
1662 @cindex openmp parallel
1663 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1664 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1665 compiler generates parallel code according to the OpenMP Application
1666 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1667 implies @option{-pthread}, and thus is only supported on targets that
1668 have support for @option{-pthread}.
1669
1670 @item -fms-extensions
1671 @opindex fms-extensions
1672 Accept some non-standard constructs used in Microsoft header files.
1673
1674 Some cases of unnamed fields in structures and unions are only
1675 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1676 fields within structs/unions}, for details.
1677
1678 @item -trigraphs
1679 @opindex trigraphs
1680 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1681 options for strict ISO C conformance) implies @option{-trigraphs}.
1682
1683 @item -no-integrated-cpp
1684 @opindex no-integrated-cpp
1685 Performs a compilation in two passes: preprocessing and compiling.  This
1686 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1687 @option{-B} option.  The user supplied compilation step can then add in
1688 an additional preprocessing step after normal preprocessing but before
1689 compiling.  The default is to use the integrated cpp (internal cpp)
1690
1691 The semantics of this option will change if "cc1", "cc1plus", and
1692 "cc1obj" are merged.
1693
1694 @cindex traditional C language
1695 @cindex C language, traditional
1696 @item -traditional
1697 @itemx -traditional-cpp
1698 @opindex traditional-cpp
1699 @opindex traditional
1700 Formerly, these options caused GCC to attempt to emulate a pre-standard
1701 C compiler.  They are now only supported with the @option{-E} switch.
1702 The preprocessor continues to support a pre-standard mode.  See the GNU
1703 CPP manual for details.
1704
1705 @item -fcond-mismatch
1706 @opindex fcond-mismatch
1707 Allow conditional expressions with mismatched types in the second and
1708 third arguments.  The value of such an expression is void.  This option
1709 is not supported for C++.
1710
1711 @item -flax-vector-conversions
1712 @opindex flax-vector-conversions
1713 Allow implicit conversions between vectors with differing numbers of
1714 elements and/or incompatible element types.  This option should not be
1715 used for new code.
1716
1717 @item -funsigned-char
1718 @opindex funsigned-char
1719 Let the type @code{char} be unsigned, like @code{unsigned char}.
1720
1721 Each kind of machine has a default for what @code{char} should
1722 be.  It is either like @code{unsigned char} by default or like
1723 @code{signed char} by default.
1724
1725 Ideally, a portable program should always use @code{signed char} or
1726 @code{unsigned char} when it depends on the signedness of an object.
1727 But many programs have been written to use plain @code{char} and
1728 expect it to be signed, or expect it to be unsigned, depending on the
1729 machines they were written for.  This option, and its inverse, let you
1730 make such a program work with the opposite default.
1731
1732 The type @code{char} is always a distinct type from each of
1733 @code{signed char} or @code{unsigned char}, even though its behavior
1734 is always just like one of those two.
1735
1736 @item -fsigned-char
1737 @opindex fsigned-char
1738 Let the type @code{char} be signed, like @code{signed char}.
1739
1740 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1741 the negative form of @option{-funsigned-char}.  Likewise, the option
1742 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1743
1744 @item -fsigned-bitfields
1745 @itemx -funsigned-bitfields
1746 @itemx -fno-signed-bitfields
1747 @itemx -fno-unsigned-bitfields
1748 @opindex fsigned-bitfields
1749 @opindex funsigned-bitfields
1750 @opindex fno-signed-bitfields
1751 @opindex fno-unsigned-bitfields
1752 These options control whether a bit-field is signed or unsigned, when the
1753 declaration does not use either @code{signed} or @code{unsigned}.  By
1754 default, such a bit-field is signed, because this is consistent: the
1755 basic integer types such as @code{int} are signed types.
1756 @end table
1757
1758 @node C++ Dialect Options
1759 @section Options Controlling C++ Dialect
1760
1761 @cindex compiler options, C++
1762 @cindex C++ options, command line
1763 @cindex options, C++
1764 This section describes the command-line options that are only meaningful
1765 for C++ programs; but you can also use most of the GNU compiler options
1766 regardless of what language your program is in.  For example, you
1767 might compile a file @code{firstClass.C} like this:
1768
1769 @smallexample
1770 g++ -g -frepo -O -c firstClass.C
1771 @end smallexample
1772
1773 @noindent
1774 In this example, only @option{-frepo} is an option meant
1775 only for C++ programs; you can use the other options with any
1776 language supported by GCC@.
1777
1778 Here is a list of options that are @emph{only} for compiling C++ programs:
1779
1780 @table @gcctabopt
1781
1782 @item -fabi-version=@var{n}
1783 @opindex fabi-version
1784 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1785 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1786 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1787 the version that conforms most closely to the C++ ABI specification.
1788 Therefore, the ABI obtained using version 0 will change as ABI bugs
1789 are fixed.
1790
1791 The default is version 2.
1792
1793 Version 3 corrects an error in mangling a constant address as a
1794 template argument.
1795
1796 Version 4 implements a standard mangling for vector types.
1797
1798 See also @option{-Wabi}.
1799
1800 @item -fno-access-control
1801 @opindex fno-access-control
1802 Turn off all access checking.  This switch is mainly useful for working
1803 around bugs in the access control code.
1804
1805 @item -fcheck-new
1806 @opindex fcheck-new
1807 Check that the pointer returned by @code{operator new} is non-null
1808 before attempting to modify the storage allocated.  This check is
1809 normally unnecessary because the C++ standard specifies that
1810 @code{operator new} will only return @code{0} if it is declared
1811 @samp{throw()}, in which case the compiler will always check the
1812 return value even without this option.  In all other cases, when
1813 @code{operator new} has a non-empty exception specification, memory
1814 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1815 @samp{new (nothrow)}.
1816
1817 @item -fconserve-space
1818 @opindex fconserve-space
1819 Put uninitialized or runtime-initialized global variables into the
1820 common segment, as C does.  This saves space in the executable at the
1821 cost of not diagnosing duplicate definitions.  If you compile with this
1822 flag and your program mysteriously crashes after @code{main()} has
1823 completed, you may have an object that is being destroyed twice because
1824 two definitions were merged.
1825
1826 This option is no longer useful on most targets, now that support has
1827 been added for putting variables into BSS without making them common.
1828
1829 @item -fno-deduce-init-list
1830 @opindex fno-deduce-init-list
1831 Disable deduction of a template type parameter as
1832 std::initializer_list from a brace-enclosed initializer list, i.e.
1833
1834 @smallexample
1835 template <class T> auto forward(T t) -> decltype (realfn (t))
1836 @{
1837   return realfn (t);
1838 @}
1839
1840 void f()
1841 @{
1842   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1843 @}
1844 @end smallexample
1845
1846 This option is present because this deduction is an extension to the
1847 current specification in the C++0x working draft, and there was
1848 some concern about potential overload resolution problems.
1849
1850 @item -ffriend-injection
1851 @opindex ffriend-injection
1852 Inject friend functions into the enclosing namespace, so that they are
1853 visible outside the scope of the class in which they are declared.
1854 Friend functions were documented to work this way in the old Annotated
1855 C++ Reference Manual, and versions of G++ before 4.1 always worked
1856 that way.  However, in ISO C++ a friend function which is not declared
1857 in an enclosing scope can only be found using argument dependent
1858 lookup.  This option causes friends to be injected as they were in
1859 earlier releases.
1860
1861 This option is for compatibility, and may be removed in a future
1862 release of G++.
1863
1864 @item -fno-elide-constructors
1865 @opindex fno-elide-constructors
1866 The C++ standard allows an implementation to omit creating a temporary
1867 which is only used to initialize another object of the same type.
1868 Specifying this option disables that optimization, and forces G++ to
1869 call the copy constructor in all cases.
1870
1871 @item -fno-enforce-eh-specs
1872 @opindex fno-enforce-eh-specs
1873 Don't generate code to check for violation of exception specifications
1874 at runtime.  This option violates the C++ standard, but may be useful
1875 for reducing code size in production builds, much like defining
1876 @samp{NDEBUG}.  This does not give user code permission to throw
1877 exceptions in violation of the exception specifications; the compiler
1878 will still optimize based on the specifications, so throwing an
1879 unexpected exception will result in undefined behavior.
1880
1881 @item -ffor-scope
1882 @itemx -fno-for-scope
1883 @opindex ffor-scope
1884 @opindex fno-for-scope
1885 If @option{-ffor-scope} is specified, the scope of variables declared in
1886 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1887 as specified by the C++ standard.
1888 If @option{-fno-for-scope} is specified, the scope of variables declared in
1889 a @i{for-init-statement} extends to the end of the enclosing scope,
1890 as was the case in old versions of G++, and other (traditional)
1891 implementations of C++.
1892
1893 The default if neither flag is given to follow the standard,
1894 but to allow and give a warning for old-style code that would
1895 otherwise be invalid, or have different behavior.
1896
1897 @item -fno-gnu-keywords
1898 @opindex fno-gnu-keywords
1899 Do not recognize @code{typeof} as a keyword, so that code can use this
1900 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1901 @option{-ansi} implies @option{-fno-gnu-keywords}.
1902
1903 @item -fno-implicit-templates
1904 @opindex fno-implicit-templates
1905 Never emit code for non-inline templates which are instantiated
1906 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1907 @xref{Template Instantiation}, for more information.
1908
1909 @item -fno-implicit-inline-templates
1910 @opindex fno-implicit-inline-templates
1911 Don't emit code for implicit instantiations of inline templates, either.
1912 The default is to handle inlines differently so that compiles with and
1913 without optimization will need the same set of explicit instantiations.
1914
1915 @item -fno-implement-inlines
1916 @opindex fno-implement-inlines
1917 To save space, do not emit out-of-line copies of inline functions
1918 controlled by @samp{#pragma implementation}.  This will cause linker
1919 errors if these functions are not inlined everywhere they are called.
1920
1921 @item -fms-extensions
1922 @opindex fms-extensions
1923 Disable pedantic warnings about constructs used in MFC, such as implicit
1924 int and getting a pointer to member function via non-standard syntax.
1925
1926 @item -fno-nonansi-builtins
1927 @opindex fno-nonansi-builtins
1928 Disable built-in declarations of functions that are not mandated by
1929 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1930 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1931
1932 @item -fnothrow-opt
1933 @opindex fnothrow-opt
1934 Treat a @code{throw()} exception specification as though it were a
1935 @code{noexcept} specification to reduce or eliminate the text size
1936 overhead relative to a function with no exception specification.  The
1937 semantic effect is that an exception thrown out of a function with
1938 such an exception specification will result in a call to
1939 @code{terminate} rather than @code{unexpected}.
1940
1941 @item -fno-operator-names
1942 @opindex fno-operator-names
1943 Do not treat the operator name keywords @code{and}, @code{bitand},
1944 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1945 synonyms as keywords.
1946
1947 @item -fno-optional-diags
1948 @opindex fno-optional-diags
1949 Disable diagnostics that the standard says a compiler does not need to
1950 issue.  Currently, the only such diagnostic issued by G++ is the one for
1951 a name having multiple meanings within a class.
1952
1953 @item -fpermissive
1954 @opindex fpermissive
1955 Downgrade some diagnostics about nonconformant code from errors to
1956 warnings.  Thus, using @option{-fpermissive} will allow some
1957 nonconforming code to compile.
1958
1959 @item -fno-pretty-templates
1960 @opindex fno-pretty-templates
1961 When an error message refers to a specialization of a function
1962 template, the compiler will normally print the signature of the
1963 template followed by the template arguments and any typedefs or
1964 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1965 rather than @code{void f(int)}) so that it's clear which template is
1966 involved.  When an error message refers to a specialization of a class
1967 template, the compiler will omit any template arguments which match
1968 the default template arguments for that template.  If either of these
1969 behaviors make it harder to understand the error message rather than
1970 easier, using @option{-fno-pretty-templates} will disable them.
1971
1972 @item -frepo
1973 @opindex frepo
1974 Enable automatic template instantiation at link time.  This option also
1975 implies @option{-fno-implicit-templates}.  @xref{Template
1976 Instantiation}, for more information.
1977
1978 @item -fno-rtti
1979 @opindex fno-rtti
1980 Disable generation of information about every class with virtual
1981 functions for use by the C++ runtime type identification features
1982 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1983 of the language, you can save some space by using this flag.  Note that
1984 exception handling uses the same information, but it will generate it as
1985 needed. The @samp{dynamic_cast} operator can still be used for casts that
1986 do not require runtime type information, i.e.@: casts to @code{void *} or to
1987 unambiguous base classes.
1988
1989 @item -fstats
1990 @opindex fstats
1991 Emit statistics about front-end processing at the end of the compilation.
1992 This information is generally only useful to the G++ development team.
1993
1994 @item -fstrict-enums
1995 @opindex fstrict-enums
1996 Allow the compiler to optimize using the assumption that a value of
1997 enumeration type can only be one of the values of the enumeration (as
1998 defined in the C++ standard; basically, a value which can be
1999 represented in the minimum number of bits needed to represent all the
2000 enumerators).  This assumption may not be valid if the program uses a
2001 cast to convert an arbitrary integer value to the enumeration type.
2002
2003 @item -ftemplate-depth=@var{n}
2004 @opindex ftemplate-depth
2005 Set the maximum instantiation depth for template classes to @var{n}.
2006 A limit on the template instantiation depth is needed to detect
2007 endless recursions during template class instantiation.  ANSI/ISO C++
2008 conforming programs must not rely on a maximum depth greater than 17
2009 (changed to 1024 in C++0x).
2010
2011 @item -fno-threadsafe-statics
2012 @opindex fno-threadsafe-statics
2013 Do not emit the extra code to use the routines specified in the C++
2014 ABI for thread-safe initialization of local statics.  You can use this
2015 option to reduce code size slightly in code that doesn't need to be
2016 thread-safe.
2017
2018 @item -fuse-cxa-atexit
2019 @opindex fuse-cxa-atexit
2020 Register destructors for objects with static storage duration with the
2021 @code{__cxa_atexit} function rather than the @code{atexit} function.
2022 This option is required for fully standards-compliant handling of static
2023 destructors, but will only work if your C library supports
2024 @code{__cxa_atexit}.
2025
2026 @item -fno-use-cxa-get-exception-ptr
2027 @opindex fno-use-cxa-get-exception-ptr
2028 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2029 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2030 if the runtime routine is not available.
2031
2032 @item -fvisibility-inlines-hidden
2033 @opindex fvisibility-inlines-hidden
2034 This switch declares that the user does not attempt to compare
2035 pointers to inline methods where the addresses of the two functions
2036 were taken in different shared objects.
2037
2038 The effect of this is that GCC may, effectively, mark inline methods with
2039 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2040 appear in the export table of a DSO and do not require a PLT indirection
2041 when used within the DSO@.  Enabling this option can have a dramatic effect
2042 on load and link times of a DSO as it massively reduces the size of the
2043 dynamic export table when the library makes heavy use of templates.
2044
2045 The behavior of this switch is not quite the same as marking the
2046 methods as hidden directly, because it does not affect static variables
2047 local to the function or cause the compiler to deduce that
2048 the function is defined in only one shared object.
2049
2050 You may mark a method as having a visibility explicitly to negate the
2051 effect of the switch for that method.  For example, if you do want to
2052 compare pointers to a particular inline method, you might mark it as
2053 having default visibility.  Marking the enclosing class with explicit
2054 visibility will have no effect.
2055
2056 Explicitly instantiated inline methods are unaffected by this option
2057 as their linkage might otherwise cross a shared library boundary.
2058 @xref{Template Instantiation}.
2059
2060 @item -fvisibility-ms-compat
2061 @opindex fvisibility-ms-compat
2062 This flag attempts to use visibility settings to make GCC's C++
2063 linkage model compatible with that of Microsoft Visual Studio.
2064
2065 The flag makes these changes to GCC's linkage model:
2066
2067 @enumerate
2068 @item
2069 It sets the default visibility to @code{hidden}, like
2070 @option{-fvisibility=hidden}.
2071
2072 @item
2073 Types, but not their members, are not hidden by default.
2074
2075 @item
2076 The One Definition Rule is relaxed for types without explicit
2077 visibility specifications which are defined in more than one different
2078 shared object: those declarations are permitted if they would have
2079 been permitted when this option was not used.
2080 @end enumerate
2081
2082 In new code it is better to use @option{-fvisibility=hidden} and
2083 export those classes which are intended to be externally visible.
2084 Unfortunately it is possible for code to rely, perhaps accidentally,
2085 on the Visual Studio behavior.
2086
2087 Among the consequences of these changes are that static data members
2088 of the same type with the same name but defined in different shared
2089 objects will be different, so changing one will not change the other;
2090 and that pointers to function members defined in different shared
2091 objects may not compare equal.  When this flag is given, it is a
2092 violation of the ODR to define types with the same name differently.
2093
2094 @item -fno-weak
2095 @opindex fno-weak
2096 Do not use weak symbol support, even if it is provided by the linker.
2097 By default, G++ will use weak symbols if they are available.  This
2098 option exists only for testing, and should not be used by end-users;
2099 it will result in inferior code and has no benefits.  This option may
2100 be removed in a future release of G++.
2101
2102 @item -nostdinc++
2103 @opindex nostdinc++
2104 Do not search for header files in the standard directories specific to
2105 C++, but do still search the other standard directories.  (This option
2106 is used when building the C++ library.)
2107 @end table
2108
2109 In addition, these optimization, warning, and code generation options
2110 have meanings only for C++ programs:
2111
2112 @table @gcctabopt
2113 @item -fno-default-inline
2114 @opindex fno-default-inline
2115 Do not assume @samp{inline} for functions defined inside a class scope.
2116 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2117 functions will have linkage like inline functions; they just won't be
2118 inlined by default.
2119
2120 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2121 @opindex Wabi
2122 @opindex Wno-abi
2123 Warn when G++ generates code that is probably not compatible with the
2124 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2125 all such cases, there are probably some cases that are not warned about,
2126 even though G++ is generating incompatible code.  There may also be
2127 cases where warnings are emitted even though the code that is generated
2128 will be compatible.
2129
2130 You should rewrite your code to avoid these warnings if you are
2131 concerned about the fact that code generated by G++ may not be binary
2132 compatible with code generated by other compilers.
2133
2134 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2135
2136 @itemize @bullet
2137
2138 @item
2139 A template with a non-type template parameter of reference type is
2140 mangled incorrectly:
2141 @smallexample
2142 extern int N;
2143 template <int &> struct S @{@};
2144 void n (S<N>) @{2@}
2145 @end smallexample
2146
2147 This is fixed in @option{-fabi-version=3}.
2148
2149 @item
2150 SIMD vector types declared using @code{__attribute ((vector_size))} are
2151 mangled in a non-standard way that does not allow for overloading of
2152 functions taking vectors of different sizes.
2153
2154 The mangling is changed in @option{-fabi-version=4}.
2155 @end itemize
2156
2157 The known incompatibilities in @option{-fabi-version=1} include:
2158
2159 @itemize @bullet
2160
2161 @item
2162 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2163 pack data into the same byte as a base class.  For example:
2164
2165 @smallexample
2166 struct A @{ virtual void f(); int f1 : 1; @};
2167 struct B : public A @{ int f2 : 1; @};
2168 @end smallexample
2169
2170 @noindent
2171 In this case, G++ will place @code{B::f2} into the same byte
2172 as@code{A::f1}; other compilers will not.  You can avoid this problem
2173 by explicitly padding @code{A} so that its size is a multiple of the
2174 byte size on your platform; that will cause G++ and other compilers to
2175 layout @code{B} identically.
2176
2177 @item
2178 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2179 tail padding when laying out virtual bases.  For example:
2180
2181 @smallexample
2182 struct A @{ virtual void f(); char c1; @};
2183 struct B @{ B(); char c2; @};
2184 struct C : public A, public virtual B @{@};
2185 @end smallexample
2186
2187 @noindent
2188 In this case, G++ will not place @code{B} into the tail-padding for
2189 @code{A}; other compilers will.  You can avoid this problem by
2190 explicitly padding @code{A} so that its size is a multiple of its
2191 alignment (ignoring virtual base classes); that will cause G++ and other
2192 compilers to layout @code{C} identically.
2193
2194 @item
2195 Incorrect handling of bit-fields with declared widths greater than that
2196 of their underlying types, when the bit-fields appear in a union.  For
2197 example:
2198
2199 @smallexample
2200 union U @{ int i : 4096; @};
2201 @end smallexample
2202
2203 @noindent
2204 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2205 union too small by the number of bits in an @code{int}.
2206
2207 @item
2208 Empty classes can be placed at incorrect offsets.  For example:
2209
2210 @smallexample
2211 struct A @{@};
2212
2213 struct B @{
2214   A a;
2215   virtual void f ();
2216 @};
2217
2218 struct C : public B, public A @{@};
2219 @end smallexample
2220
2221 @noindent
2222 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2223 it should be placed at offset zero.  G++ mistakenly believes that the
2224 @code{A} data member of @code{B} is already at offset zero.
2225
2226 @item
2227 Names of template functions whose types involve @code{typename} or
2228 template template parameters can be mangled incorrectly.
2229
2230 @smallexample
2231 template <typename Q>
2232 void f(typename Q::X) @{@}
2233
2234 template <template <typename> class Q>
2235 void f(typename Q<int>::X) @{@}
2236 @end smallexample
2237
2238 @noindent
2239 Instantiations of these templates may be mangled incorrectly.
2240
2241 @end itemize
2242
2243 It also warns psABI related changes.  The known psABI changes at this
2244 point include:
2245
2246 @itemize @bullet
2247
2248 @item
2249 For SYSV/x86-64, when passing union with long double, it is changed to
2250 pass in memory as specified in psABI.  For example:
2251
2252 @smallexample
2253 union U @{
2254   long double ld;
2255   int i;
2256 @};
2257 @end smallexample
2258
2259 @noindent
2260 @code{union U} will always be passed in memory.
2261
2262 @end itemize
2263
2264 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2265 @opindex Wctor-dtor-privacy
2266 @opindex Wno-ctor-dtor-privacy
2267 Warn when a class seems unusable because all the constructors or
2268 destructors in that class are private, and it has neither friends nor
2269 public static member functions.
2270
2271 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2272 @opindex Wnon-virtual-dtor
2273 @opindex Wno-non-virtual-dtor
2274 Warn when a class has virtual functions and accessible non-virtual
2275 destructor, in which case it would be possible but unsafe to delete
2276 an instance of a derived class through a pointer to the base class.
2277 This warning is also enabled if -Weffc++ is specified.
2278
2279 @item -Wreorder @r{(C++ and Objective-C++ only)}
2280 @opindex Wreorder
2281 @opindex Wno-reorder
2282 @cindex reordering, warning
2283 @cindex warning for reordering of member initializers
2284 Warn when the order of member initializers given in the code does not
2285 match the order in which they must be executed.  For instance:
2286
2287 @smallexample
2288 struct A @{
2289   int i;
2290   int j;
2291   A(): j (0), i (1) @{ @}
2292 @};
2293 @end smallexample
2294
2295 The compiler will rearrange the member initializers for @samp{i}
2296 and @samp{j} to match the declaration order of the members, emitting
2297 a warning to that effect.  This warning is enabled by @option{-Wall}.
2298 @end table
2299
2300 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2301
2302 @table @gcctabopt
2303 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2304 @opindex Weffc++
2305 @opindex Wno-effc++
2306 Warn about violations of the following style guidelines from Scott Meyers'
2307 @cite{Effective C++} book:
2308
2309 @itemize @bullet
2310 @item
2311 Item 11:  Define a copy constructor and an assignment operator for classes
2312 with dynamically allocated memory.
2313
2314 @item
2315 Item 12:  Prefer initialization to assignment in constructors.
2316
2317 @item
2318 Item 14:  Make destructors virtual in base classes.
2319
2320 @item
2321 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2322
2323 @item
2324 Item 23:  Don't try to return a reference when you must return an object.
2325
2326 @end itemize
2327
2328 Also warn about violations of the following style guidelines from
2329 Scott Meyers' @cite{More Effective C++} book:
2330
2331 @itemize @bullet
2332 @item
2333 Item 6:  Distinguish between prefix and postfix forms of increment and
2334 decrement operators.
2335
2336 @item
2337 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2338
2339 @end itemize
2340
2341 When selecting this option, be aware that the standard library
2342 headers do not obey all of these guidelines; use @samp{grep -v}
2343 to filter out those warnings.
2344
2345 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2346 @opindex Wstrict-null-sentinel
2347 @opindex Wno-strict-null-sentinel
2348 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2349 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2350 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2351 it is guaranteed to be of the same size as a pointer.  But this use is
2352 not portable across different compilers.
2353
2354 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2355 @opindex Wno-non-template-friend
2356 @opindex Wnon-template-friend
2357 Disable warnings when non-templatized friend functions are declared
2358 within a template.  Since the advent of explicit template specification
2359 support in G++, if the name of the friend is an unqualified-id (i.e.,
2360 @samp{friend foo(int)}), the C++ language specification demands that the
2361 friend declare or define an ordinary, nontemplate function.  (Section
2362 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2363 could be interpreted as a particular specialization of a templatized
2364 function.  Because this non-conforming behavior is no longer the default
2365 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2366 check existing code for potential trouble spots and is on by default.
2367 This new compiler behavior can be turned off with
2368 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2369 but disables the helpful warning.
2370
2371 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2372 @opindex Wold-style-cast
2373 @opindex Wno-old-style-cast
2374 Warn if an old-style (C-style) cast to a non-void type is used within
2375 a C++ program.  The new-style casts (@samp{dynamic_cast},
2376 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2377 less vulnerable to unintended effects and much easier to search for.
2378
2379 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2380 @opindex Woverloaded-virtual
2381 @opindex Wno-overloaded-virtual
2382 @cindex overloaded virtual fn, warning
2383 @cindex warning for overloaded virtual fn
2384 Warn when a function declaration hides virtual functions from a
2385 base class.  For example, in:
2386
2387 @smallexample
2388 struct A @{
2389   virtual void f();
2390 @};
2391
2392 struct B: public A @{
2393   void f(int);
2394 @};
2395 @end smallexample
2396
2397 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2398 like:
2399
2400 @smallexample
2401 B* b;
2402 b->f();
2403 @end smallexample
2404
2405 will fail to compile.
2406
2407 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2408 @opindex Wno-pmf-conversions
2409 @opindex Wpmf-conversions
2410 Disable the diagnostic for converting a bound pointer to member function
2411 to a plain pointer.
2412
2413 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2414 @opindex Wsign-promo
2415 @opindex Wno-sign-promo
2416 Warn when overload resolution chooses a promotion from unsigned or
2417 enumerated type to a signed type, over a conversion to an unsigned type of
2418 the same size.  Previous versions of G++ would try to preserve
2419 unsignedness, but the standard mandates the current behavior.
2420
2421 @smallexample
2422 struct A @{
2423   operator int ();
2424   A& operator = (int);
2425 @};
2426
2427 main ()
2428 @{
2429   A a,b;
2430   a = b;
2431 @}
2432 @end smallexample
2433
2434 In this example, G++ will synthesize a default @samp{A& operator =
2435 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2436 @end table
2437
2438 @node Objective-C and Objective-C++ Dialect Options
2439 @section Options Controlling Objective-C and Objective-C++ Dialects
2440
2441 @cindex compiler options, Objective-C and Objective-C++
2442 @cindex Objective-C and Objective-C++ options, command line
2443 @cindex options, Objective-C and Objective-C++
2444 (NOTE: This manual does not describe the Objective-C and Objective-C++
2445 languages themselves.  See @xref{Standards,,Language Standards
2446 Supported by GCC}, for references.)
2447
2448 This section describes the command-line options that are only meaningful
2449 for Objective-C and Objective-C++ programs, but you can also use most of
2450 the language-independent GNU compiler options.
2451 For example, you might compile a file @code{some_class.m} like this:
2452
2453 @smallexample
2454 gcc -g -fgnu-runtime -O -c some_class.m
2455 @end smallexample
2456
2457 @noindent
2458 In this example, @option{-fgnu-runtime} is an option meant only for
2459 Objective-C and Objective-C++ programs; you can use the other options with
2460 any language supported by GCC@.
2461
2462 Note that since Objective-C is an extension of the C language, Objective-C
2463 compilations may also use options specific to the C front-end (e.g.,
2464 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2465 C++-specific options (e.g., @option{-Wabi}).
2466
2467 Here is a list of options that are @emph{only} for compiling Objective-C
2468 and Objective-C++ programs:
2469
2470 @table @gcctabopt
2471 @item -fconstant-string-class=@var{class-name}
2472 @opindex fconstant-string-class
2473 Use @var{class-name} as the name of the class to instantiate for each
2474 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2475 class name is @code{NXConstantString} if the GNU runtime is being used, and
2476 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2477 @option{-fconstant-cfstrings} option, if also present, will override the
2478 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2479 to be laid out as constant CoreFoundation strings.
2480
2481 @item -fgnu-runtime
2482 @opindex fgnu-runtime
2483 Generate object code compatible with the standard GNU Objective-C
2484 runtime.  This is the default for most types of systems.
2485
2486 @item -fnext-runtime
2487 @opindex fnext-runtime
2488 Generate output compatible with the NeXT runtime.  This is the default
2489 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2490 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2491 used.
2492
2493 @item -fno-nil-receivers
2494 @opindex fno-nil-receivers
2495 Assume that all Objective-C message dispatches (e.g.,
2496 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2497 is not @code{nil}.  This allows for more efficient entry points in the runtime
2498 to be used.  Currently, this option is only available in conjunction with
2499 the NeXT runtime on Mac OS X 10.3 and later.
2500
2501 @item -fobjc-call-cxx-cdtors
2502 @opindex fobjc-call-cxx-cdtors
2503 For each Objective-C class, check if any of its instance variables is a
2504 C++ object with a non-trivial default constructor.  If so, synthesize a
2505 special @code{- (id) .cxx_construct} instance method that will run
2506 non-trivial default constructors on any such instance variables, in order,
2507 and then return @code{self}.  Similarly, check if any instance variable
2508 is a C++ object with a non-trivial destructor, and if so, synthesize a
2509 special @code{- (void) .cxx_destruct} method that will run
2510 all such default destructors, in reverse order.
2511
2512 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2513 thusly generated will only operate on instance variables declared in the
2514 current Objective-C class, and not those inherited from superclasses.  It
2515 is the responsibility of the Objective-C runtime to invoke all such methods
2516 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2517 will be invoked by the runtime immediately after a new object
2518 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2519 be invoked immediately before the runtime deallocates an object instance.
2520
2521 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2522 support for invoking the @code{- (id) .cxx_construct} and
2523 @code{- (void) .cxx_destruct} methods.
2524
2525 @item -fobjc-direct-dispatch
2526 @opindex fobjc-direct-dispatch
2527 Allow fast jumps to the message dispatcher.  On Darwin this is
2528 accomplished via the comm page.
2529
2530 @item -fobjc-exceptions
2531 @opindex fobjc-exceptions
2532 Enable syntactic support for structured exception handling in Objective-C,
2533 similar to what is offered by C++ and Java.  This option is
2534 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2535 earlier.
2536
2537 @smallexample
2538   @@try @{
2539     @dots{}
2540        @@throw expr;
2541     @dots{}
2542   @}
2543   @@catch (AnObjCClass *exc) @{
2544     @dots{}
2545       @@throw expr;
2546     @dots{}
2547       @@throw;
2548     @dots{}
2549   @}
2550   @@catch (AnotherClass *exc) @{
2551     @dots{}
2552   @}
2553   @@catch (id allOthers) @{
2554     @dots{}
2555   @}
2556   @@finally @{
2557     @dots{}
2558       @@throw expr;
2559     @dots{}
2560   @}
2561 @end smallexample
2562
2563 The @code{@@throw} statement may appear anywhere in an Objective-C or
2564 Objective-C++ program; when used inside of a @code{@@catch} block, the
2565 @code{@@throw} may appear without an argument (as shown above), in which case
2566 the object caught by the @code{@@catch} will be rethrown.
2567
2568 Note that only (pointers to) Objective-C objects may be thrown and
2569 caught using this scheme.  When an object is thrown, it will be caught
2570 by the nearest @code{@@catch} clause capable of handling objects of that type,
2571 analogously to how @code{catch} blocks work in C++ and Java.  A
2572 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2573 any and all Objective-C exceptions not caught by previous @code{@@catch}
2574 clauses (if any).
2575
2576 The @code{@@finally} clause, if present, will be executed upon exit from the
2577 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2578 regardless of whether any exceptions are thrown, caught or rethrown
2579 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2580 of the @code{finally} clause in Java.
2581
2582 There are several caveats to using the new exception mechanism:
2583
2584 @itemize @bullet
2585 @item
2586 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2587 idioms provided by the @code{NSException} class, the new
2588 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2589 systems, due to additional functionality needed in the (NeXT) Objective-C
2590 runtime.
2591
2592 @item
2593 As mentioned above, the new exceptions do not support handling
2594 types other than Objective-C objects.   Furthermore, when used from
2595 Objective-C++, the Objective-C exception model does not interoperate with C++
2596 exceptions at this time.  This means you cannot @code{@@throw} an exception
2597 from Objective-C and @code{catch} it in C++, or vice versa
2598 (i.e., @code{throw @dots{} @@catch}).
2599 @end itemize
2600
2601 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2602 blocks for thread-safe execution:
2603
2604 @smallexample
2605   @@synchronized (ObjCClass *guard) @{
2606     @dots{}
2607   @}
2608 @end smallexample
2609
2610 Upon entering the @code{@@synchronized} block, a thread of execution shall
2611 first check whether a lock has been placed on the corresponding @code{guard}
2612 object by another thread.  If it has, the current thread shall wait until
2613 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2614 the current thread will place its own lock on it, execute the code contained in
2615 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2616 making @code{guard} available to other threads).
2617
2618 Unlike Java, Objective-C does not allow for entire methods to be marked
2619 @code{@@synchronized}.  Note that throwing exceptions out of
2620 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2621 to be unlocked properly.
2622
2623 @item -fobjc-gc
2624 @opindex fobjc-gc
2625 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2626
2627 @item -freplace-objc-classes
2628 @opindex freplace-objc-classes
2629 Emit a special marker instructing @command{ld(1)} not to statically link in
2630 the resulting object file, and allow @command{dyld(1)} to load it in at
2631 run time instead.  This is used in conjunction with the Fix-and-Continue
2632 debugging mode, where the object file in question may be recompiled and
2633 dynamically reloaded in the course of program execution, without the need
2634 to restart the program itself.  Currently, Fix-and-Continue functionality
2635 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2636 and later.
2637
2638 @item -fzero-link
2639 @opindex fzero-link
2640 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2641 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2642 compile time) with static class references that get initialized at load time,
2643 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2644 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2645 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2646 for individual class implementations to be modified during program execution.
2647
2648 @item -gen-decls
2649 @opindex gen-decls
2650 Dump interface declarations for all classes seen in the source file to a
2651 file named @file{@var{sourcename}.decl}.
2652
2653 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2654 @opindex Wassign-intercept
2655 @opindex Wno-assign-intercept
2656 Warn whenever an Objective-C assignment is being intercepted by the
2657 garbage collector.
2658
2659 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2660 @opindex Wno-protocol
2661 @opindex Wprotocol
2662 If a class is declared to implement a protocol, a warning is issued for
2663 every method in the protocol that is not implemented by the class.  The
2664 default behavior is to issue a warning for every method not explicitly
2665 implemented in the class, even if a method implementation is inherited
2666 from the superclass.  If you use the @option{-Wno-protocol} option, then
2667 methods inherited from the superclass are considered to be implemented,
2668 and no warning is issued for them.
2669
2670 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2671 @opindex Wselector
2672 @opindex Wno-selector
2673 Warn if multiple methods of different types for the same selector are
2674 found during compilation.  The check is performed on the list of methods
2675 in the final stage of compilation.  Additionally, a check is performed
2676 for each selector appearing in a @code{@@selector(@dots{})}
2677 expression, and a corresponding method for that selector has been found
2678 during compilation.  Because these checks scan the method table only at
2679 the end of compilation, these warnings are not produced if the final
2680 stage of compilation is not reached, for example because an error is
2681 found during compilation, or because the @option{-fsyntax-only} option is
2682 being used.
2683
2684 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2685 @opindex Wstrict-selector-match
2686 @opindex Wno-strict-selector-match
2687 Warn if multiple methods with differing argument and/or return types are
2688 found for a given selector when attempting to send a message using this
2689 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2690 is off (which is the default behavior), the compiler will omit such warnings
2691 if any differences found are confined to types which share the same size
2692 and alignment.
2693
2694 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2695 @opindex Wundeclared-selector
2696 @opindex Wno-undeclared-selector
2697 Warn if a @code{@@selector(@dots{})} expression referring to an
2698 undeclared selector is found.  A selector is considered undeclared if no
2699 method with that name has been declared before the
2700 @code{@@selector(@dots{})} expression, either explicitly in an
2701 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2702 an @code{@@implementation} section.  This option always performs its
2703 checks as soon as a @code{@@selector(@dots{})} expression is found,
2704 while @option{-Wselector} only performs its checks in the final stage of
2705 compilation.  This also enforces the coding style convention
2706 that methods and selectors must be declared before being used.
2707
2708 @item -print-objc-runtime-info
2709 @opindex print-objc-runtime-info
2710 Generate C header describing the largest structure that is passed by
2711 value, if any.
2712
2713 @end table
2714
2715 @node Language Independent Options
2716 @section Options to Control Diagnostic Messages Formatting
2717 @cindex options to control diagnostics formatting
2718 @cindex diagnostic messages
2719 @cindex message formatting
2720
2721 Traditionally, diagnostic messages have been formatted irrespective of
2722 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2723 below can be used to control the diagnostic messages formatting
2724 algorithm, e.g.@: how many characters per line, how often source location
2725 information should be reported.  Right now, only the C++ front end can
2726 honor these options.  However it is expected, in the near future, that
2727 the remaining front ends would be able to digest them correctly.
2728
2729 @table @gcctabopt
2730 @item -fmessage-length=@var{n}
2731 @opindex fmessage-length
2732 Try to format error messages so that they fit on lines of about @var{n}
2733 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2734 the front ends supported by GCC@.  If @var{n} is zero, then no
2735 line-wrapping will be done; each error message will appear on a single
2736 line.
2737
2738 @opindex fdiagnostics-show-location
2739 @item -fdiagnostics-show-location=once
2740 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2741 reporter to emit @emph{once} source location information; that is, in
2742 case the message is too long to fit on a single physical line and has to
2743 be wrapped, the source location won't be emitted (as prefix) again,
2744 over and over, in subsequent continuation lines.  This is the default
2745 behavior.
2746
2747 @item -fdiagnostics-show-location=every-line
2748 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2749 messages reporter to emit the same source location information (as
2750 prefix) for physical lines that result from the process of breaking
2751 a message which is too long to fit on a single line.
2752
2753 @item -fdiagnostics-show-option
2754 @opindex fdiagnostics-show-option
2755 This option instructs the diagnostic machinery to add text to each
2756 diagnostic emitted, which indicates which command line option directly
2757 controls that diagnostic, when such an option is known to the
2758 diagnostic machinery.
2759
2760 @item -Wcoverage-mismatch
2761 @opindex Wcoverage-mismatch
2762 Warn if feedback profiles do not match when using the
2763 @option{-fprofile-use} option.
2764 If a source file was changed between @option{-fprofile-gen} and
2765 @option{-fprofile-use}, the files with the profile feedback can fail
2766 to match the source file and GCC can not use the profile feedback
2767 information.  By default, this warning is enabled and is treated as an
2768 error.  @option{-Wno-coverage-mismatch} can be used to disable the
2769 warning or @option{-Wno-error=coverage-mismatch} can be used to
2770 disable the error.  Disable the error for this warning can result in
2771 poorly optimized code, so disabling the error is useful only in the
2772 case of very minor changes such as bug fixes to an existing code-base.
2773 Completely disabling the warning is not recommended.
2774
2775 @end table
2776
2777 @node Warning Options
2778 @section Options to Request or Suppress Warnings
2779 @cindex options to control warnings
2780 @cindex warning messages
2781 @cindex messages, warning
2782 @cindex suppressing warnings
2783
2784 Warnings are diagnostic messages that report constructions which
2785 are not inherently erroneous but which are risky or suggest there
2786 may have been an error.
2787
2788 The following language-independent options do not enable specific
2789 warnings but control the kinds of diagnostics produced by GCC.
2790
2791 @table @gcctabopt
2792 @cindex syntax checking
2793 @item -fsyntax-only
2794 @opindex fsyntax-only
2795 Check the code for syntax errors, but don't do anything beyond that.
2796
2797 @item -w
2798 @opindex w
2799 Inhibit all warning messages.
2800
2801 @item -Werror
2802 @opindex Werror
2803 @opindex Wno-error
2804 Make all warnings into errors.
2805
2806 @item -Werror=
2807 @opindex Werror=
2808 @opindex Wno-error=
2809 Make the specified warning into an error.  The specifier for a warning
2810 is appended, for example @option{-Werror=switch} turns the warnings
2811 controlled by @option{-Wswitch} into errors.  This switch takes a
2812 negative form, to be used to negate @option{-Werror} for specific
2813 warnings, for example @option{-Wno-error=switch} makes
2814 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2815 is in effect.  You can use the @option{-fdiagnostics-show-option}
2816 option to have each controllable warning amended with the option which
2817 controls it, to determine what to use with this option.
2818
2819 Note that specifying @option{-Werror=}@var{foo} automatically implies
2820 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2821 imply anything.
2822
2823 @item -Wfatal-errors
2824 @opindex Wfatal-errors
2825 @opindex Wno-fatal-errors
2826 This option causes the compiler to abort compilation on the first error
2827 occurred rather than trying to keep going and printing further error
2828 messages.
2829
2830 @end table
2831
2832 You can request many specific warnings with options beginning
2833 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2834 implicit declarations.  Each of these specific warning options also
2835 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2836 example, @option{-Wno-implicit}.  This manual lists only one of the
2837 two forms, whichever is not the default.  For further,
2838 language-specific options also refer to @ref{C++ Dialect Options} and
2839 @ref{Objective-C and Objective-C++ Dialect Options}.
2840
2841 When an unrecognized warning label is requested (e.g.,
2842 @option{-Wunknown-warning}), GCC will emit a diagnostic stating
2843 that the option is not recognized.  However, if the @samp{-Wno-} form
2844 is used, the behavior is slightly different: No diagnostic will be
2845 produced for @option{-Wno-unknown-warning} unless other diagnostics
2846 are being produced.  This allows the use of new @option{-Wno-} options
2847 with old compilers, but if something goes wrong, the compiler will
2848 warn that an unrecognized option was used.
2849
2850 @table @gcctabopt
2851 @item -pedantic
2852 @opindex pedantic
2853 Issue all the warnings demanded by strict ISO C and ISO C++;
2854 reject all programs that use forbidden extensions, and some other
2855 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2856 version of the ISO C standard specified by any @option{-std} option used.
2857
2858 Valid ISO C and ISO C++ programs should compile properly with or without
2859 this option (though a rare few will require @option{-ansi} or a
2860 @option{-std} option specifying the required version of ISO C)@.  However,
2861 without this option, certain GNU extensions and traditional C and C++
2862 features are supported as well.  With this option, they are rejected.
2863
2864 @option{-pedantic} does not cause warning messages for use of the
2865 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2866 warnings are also disabled in the expression that follows
2867 @code{__extension__}.  However, only system header files should use
2868 these escape routes; application programs should avoid them.
2869 @xref{Alternate Keywords}.
2870
2871 Some users try to use @option{-pedantic} to check programs for strict ISO
2872 C conformance.  They soon find that it does not do quite what they want:
2873 it finds some non-ISO practices, but not all---only those for which
2874 ISO C @emph{requires} a diagnostic, and some others for which
2875 diagnostics have been added.
2876
2877 A feature to report any failure to conform to ISO C might be useful in
2878 some instances, but would require considerable additional work and would
2879 be quite different from @option{-pedantic}.  We don't have plans to
2880 support such a feature in the near future.
2881
2882 Where the standard specified with @option{-std} represents a GNU
2883 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
2884 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2885 extended dialect is based.  Warnings from @option{-pedantic} are given
2886 where they are required by the base standard.  (It would not make sense
2887 for such warnings to be given only for features not in the specified GNU
2888 C dialect, since by definition the GNU dialects of C include all
2889 features the compiler supports with the given option, and there would be
2890 nothing to warn about.)
2891
2892 @item -pedantic-errors
2893 @opindex pedantic-errors
2894 Like @option{-pedantic}, except that errors are produced rather than
2895 warnings.
2896
2897 @item -Wall
2898 @opindex Wall
2899 @opindex Wno-all
2900 This enables all the warnings about constructions that some users
2901 consider questionable, and that are easy to avoid (or modify to
2902 prevent the warning), even in conjunction with macros.  This also
2903 enables some language-specific warnings described in @ref{C++ Dialect
2904 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2905
2906 @option{-Wall} turns on the following warning flags:
2907
2908 @gccoptlist{-Waddress   @gol
2909 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2910 -Wc++0x-compat  @gol
2911 -Wchar-subscripts  @gol
2912 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2913 -Wimplicit-int @r{(C and Objective-C only)} @gol
2914 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
2915 -Wcomment  @gol
2916 -Wformat   @gol
2917 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2918 -Wmissing-braces  @gol
2919 -Wnonnull  @gol
2920 -Wparentheses  @gol
2921 -Wpointer-sign  @gol
2922 -Wreorder   @gol
2923 -Wreturn-type  @gol
2924 -Wsequence-point  @gol
2925 -Wsign-compare @r{(only in C++)}  @gol
2926 -Wstrict-aliasing  @gol
2927 -Wstrict-overflow=1  @gol
2928 -Wswitch  @gol
2929 -Wtrigraphs  @gol
2930 -Wuninitialized  @gol
2931 -Wunknown-pragmas  @gol
2932 -Wunused-function  @gol
2933 -Wunused-label     @gol
2934 -Wunused-value     @gol
2935 -Wunused-variable  @gol
2936 -Wvolatile-register-var @gol
2937 }
2938
2939 Note that some warning flags are not implied by @option{-Wall}.  Some of
2940 them warn about constructions that users generally do not consider
2941 questionable, but which occasionally you might wish to check for;
2942 others warn about constructions that are necessary or hard to avoid in
2943 some cases, and there is no simple way to modify the code to suppress
2944 the warning. Some of them are enabled by @option{-Wextra} but many of
2945 them must be enabled individually.
2946
2947 @item -Wextra
2948 @opindex W
2949 @opindex Wextra
2950 @opindex Wno-extra
2951 This enables some extra warning flags that are not enabled by
2952 @option{-Wall}. (This option used to be called @option{-W}.  The older
2953 name is still supported, but the newer name is more descriptive.)
2954
2955 @gccoptlist{-Wclobbered  @gol
2956 -Wempty-body  @gol
2957 -Wignored-qualifiers @gol
2958 -Wmissing-field-initializers  @gol
2959 -Wmissing-parameter-type @r{(C only)}  @gol
2960 -Wold-style-declaration @r{(C only)}  @gol
2961 -Woverride-init  @gol
2962 -Wsign-compare  @gol
2963 -Wtype-limits  @gol
2964 -Wuninitialized  @gol
2965 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
2966 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2967 }
2968
2969 The option @option{-Wextra} also prints warning messages for the
2970 following cases:
2971
2972 @itemize @bullet
2973
2974 @item
2975 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2976 @samp{>}, or @samp{>=}.
2977
2978 @item
2979 (C++ only) An enumerator and a non-enumerator both appear in a
2980 conditional expression.
2981
2982 @item
2983 (C++ only) Ambiguous virtual bases.
2984
2985 @item
2986 (C++ only) Subscripting an array which has been declared @samp{register}.
2987
2988 @item
2989 (C++ only) Taking the address of a variable which has been declared
2990 @samp{register}.
2991
2992 @item
2993 (C++ only) A base class is not initialized in a derived class' copy
2994 constructor.
2995
2996 @end itemize
2997
2998 @item -Wchar-subscripts
2999 @opindex Wchar-subscripts
3000 @opindex Wno-char-subscripts
3001 Warn if an array subscript has type @code{char}.  This is a common cause
3002 of error, as programmers often forget that this type is signed on some
3003 machines.
3004 This warning is enabled by @option{-Wall}.
3005
3006 @item -Wcomment
3007 @opindex Wcomment
3008 @opindex Wno-comment
3009 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3010 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3011 This warning is enabled by @option{-Wall}.
3012
3013 @item -Wno-cpp \
3014 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3015
3016 Suppress warning messages emitted by @code{#warning} directives.
3017
3018 @item -Wformat
3019 @opindex Wformat
3020 @opindex Wno-format
3021 @opindex ffreestanding
3022 @opindex fno-builtin
3023 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3024 the arguments supplied have types appropriate to the format string
3025 specified, and that the conversions specified in the format string make
3026 sense.  This includes standard functions, and others specified by format
3027 attributes (@pxref{Function Attributes}), in the @code{printf},
3028 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3029 not in the C standard) families (or other target-specific families).
3030 Which functions are checked without format attributes having been
3031 specified depends on the standard version selected, and such checks of
3032 functions without the attribute specified are disabled by
3033 @option{-ffreestanding} or @option{-fno-builtin}.
3034
3035 The formats are checked against the format features supported by GNU
3036 libc version 2.2.  These include all ISO C90 and C99 features, as well
3037 as features from the Single Unix Specification and some BSD and GNU
3038 extensions.  Other library implementations may not support all these
3039 features; GCC does not support warning about features that go beyond a
3040 particular library's limitations.  However, if @option{-pedantic} is used
3041 with @option{-Wformat}, warnings will be given about format features not
3042 in the selected standard version (but not for @code{strfmon} formats,
3043 since those are not in any version of the C standard).  @xref{C Dialect
3044 Options,,Options Controlling C Dialect}.
3045
3046 Since @option{-Wformat} also checks for null format arguments for
3047 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3048
3049 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3050 aspects of format checking, the options @option{-Wformat-y2k},
3051 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3052 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3053 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3054
3055 @item -Wformat-y2k
3056 @opindex Wformat-y2k
3057 @opindex Wno-format-y2k
3058 If @option{-Wformat} is specified, also warn about @code{strftime}
3059 formats which may yield only a two-digit year.
3060
3061 @item -Wno-format-contains-nul
3062 @opindex Wno-format-contains-nul
3063 @opindex Wformat-contains-nul
3064 If @option{-Wformat} is specified, do not warn about format strings that
3065 contain NUL bytes.
3066
3067 @item -Wno-format-extra-args
3068 @opindex Wno-format-extra-args
3069 @opindex Wformat-extra-args
3070 If @option{-Wformat} is specified, do not warn about excess arguments to a
3071 @code{printf} or @code{scanf} format function.  The C standard specifies
3072 that such arguments are ignored.
3073
3074 Where the unused arguments lie between used arguments that are
3075 specified with @samp{$} operand number specifications, normally
3076 warnings are still given, since the implementation could not know what
3077 type to pass to @code{va_arg} to skip the unused arguments.  However,
3078 in the case of @code{scanf} formats, this option will suppress the
3079 warning if the unused arguments are all pointers, since the Single
3080 Unix Specification says that such unused arguments are allowed.
3081
3082 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3083 @opindex Wno-format-zero-length
3084 @opindex Wformat-zero-length
3085 If @option{-Wformat} is specified, do not warn about zero-length formats.
3086 The C standard specifies that zero-length formats are allowed.
3087
3088 @item -Wformat-nonliteral
3089 @opindex Wformat-nonliteral
3090 @opindex Wno-format-nonliteral
3091 If @option{-Wformat} is specified, also warn if the format string is not a
3092 string literal and so cannot be checked, unless the format function
3093 takes its format arguments as a @code{va_list}.
3094
3095 @item -Wformat-security
3096 @opindex Wformat-security
3097 @opindex Wno-format-security
3098 If @option{-Wformat} is specified, also warn about uses of format
3099 functions that represent possible security problems.  At present, this
3100 warns about calls to @code{printf} and @code{scanf} functions where the
3101 format string is not a string literal and there are no format arguments,
3102 as in @code{printf (foo);}.  This may be a security hole if the format
3103 string came from untrusted input and contains @samp{%n}.  (This is
3104 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3105 in future warnings may be added to @option{-Wformat-security} that are not
3106 included in @option{-Wformat-nonliteral}.)
3107
3108 @item -Wformat=2
3109 @opindex Wformat=2
3110 @opindex Wno-format=2
3111 Enable @option{-Wformat} plus format checks not included in
3112 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3113 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3114
3115 @item -Wnonnull @r{(C and Objective-C only)}
3116 @opindex Wnonnull
3117 @opindex Wno-nonnull
3118 Warn about passing a null pointer for arguments marked as
3119 requiring a non-null value by the @code{nonnull} function attribute.
3120
3121 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3122 can be disabled with the @option{-Wno-nonnull} option.
3123
3124 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3125 @opindex Winit-self
3126 @opindex Wno-init-self
3127 Warn about uninitialized variables which are initialized with themselves.
3128 Note this option can only be used with the @option{-Wuninitialized} option.
3129
3130 For example, GCC will warn about @code{i} being uninitialized in the
3131 following snippet only when @option{-Winit-self} has been specified:
3132 @smallexample
3133 @group
3134 int f()
3135 @{
3136   int i = i;
3137   return i;
3138 @}
3139 @end group
3140 @end smallexample
3141
3142 @item -Wimplicit-int @r{(C and Objective-C only)}
3143 @opindex Wimplicit-int
3144 @opindex Wno-implicit-int
3145 Warn when a declaration does not specify a type.
3146 This warning is enabled by @option{-Wall}.
3147
3148 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3149 @opindex Wimplicit-function-declaration
3150 @opindex Wno-implicit-function-declaration
3151 Give a warning whenever a function is used before being declared. In
3152 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3153 enabled by default and it is made into an error by
3154 @option{-pedantic-errors}. This warning is also enabled by
3155 @option{-Wall}.
3156
3157 @item -Wimplicit @r{(C and Objective-C only)}
3158 @opindex Wimplicit
3159 @opindex Wno-implicit
3160 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3161 This warning is enabled by @option{-Wall}.
3162
3163 @item -Wignored-qualifiers @r{(C and C++ only)}
3164 @opindex Wignored-qualifiers
3165 @opindex Wno-ignored-qualifiers
3166 Warn if the return type of a function has a type qualifier
3167 such as @code{const}.  For ISO C such a type qualifier has no effect,
3168 since the value returned by a function is not an lvalue.
3169 For C++, the warning is only emitted for scalar types or @code{void}.
3170 ISO C prohibits qualified @code{void} return types on function
3171 definitions, so such return types always receive a warning
3172 even without this option.
3173
3174 This warning is also enabled by @option{-Wextra}.
3175
3176 @item -Wmain
3177 @opindex Wmain
3178 @opindex Wno-main
3179 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3180 a function with external linkage, returning int, taking either zero
3181 arguments, two, or three arguments of appropriate types.  This warning
3182 is enabled by default in C++ and is enabled by either @option{-Wall}
3183 or @option{-pedantic}.
3184
3185 @item -Wmissing-braces
3186 @opindex Wmissing-braces
3187 @opindex Wno-missing-braces
3188 Warn if an aggregate or union initializer is not fully bracketed.  In
3189 the following example, the initializer for @samp{a} is not fully
3190 bracketed, but that for @samp{b} is fully bracketed.
3191
3192 @smallexample
3193 int a[2][2] = @{ 0, 1, 2, 3 @};
3194 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3195 @end smallexample
3196
3197 This warning is enabled by @option{-Wall}.
3198
3199 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3200 @opindex Wmissing-include-dirs
3201 @opindex Wno-missing-include-dirs
3202 Warn if a user-supplied include directory does not exist.
3203
3204 @item -Wparentheses
3205 @opindex Wparentheses
3206 @opindex Wno-parentheses
3207 Warn if parentheses are omitted in certain contexts, such
3208 as when there is an assignment in a context where a truth value
3209 is expected, or when operators are nested whose precedence people
3210 often get confused about.
3211
3212 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3213 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3214 interpretation from that of ordinary mathematical notation.
3215
3216 Also warn about constructions where there may be confusion to which
3217 @code{if} statement an @code{else} branch belongs.  Here is an example of
3218 such a case:
3219
3220 @smallexample
3221 @group
3222 @{
3223   if (a)
3224     if (b)
3225       foo ();
3226   else
3227     bar ();
3228 @}
3229 @end group
3230 @end smallexample
3231
3232 In C/C++, every @code{else} branch belongs to the innermost possible
3233 @code{if} statement, which in this example is @code{if (b)}.  This is
3234 often not what the programmer expected, as illustrated in the above
3235 example by indentation the programmer chose.  When there is the
3236 potential for this confusion, GCC will issue a warning when this flag
3237 is specified.  To eliminate the warning, add explicit braces around
3238 the innermost @code{if} statement so there is no way the @code{else}
3239 could belong to the enclosing @code{if}.  The resulting code would
3240 look like this:
3241
3242 @smallexample
3243 @group
3244 @{
3245   if (a)
3246     @{
3247       if (b)
3248         foo ();
3249       else
3250         bar ();
3251     @}
3252 @}
3253 @end group
3254 @end smallexample
3255
3256 This warning is enabled by @option{-Wall}.
3257
3258 @item -Wsequence-point
3259 @opindex Wsequence-point
3260 @opindex Wno-sequence-point
3261 Warn about code that may have undefined semantics because of violations
3262 of sequence point rules in the C and C++ standards.
3263
3264 The C and C++ standards defines the order in which expressions in a C/C++
3265 program are evaluated in terms of @dfn{sequence points}, which represent
3266 a partial ordering between the execution of parts of the program: those
3267 executed before the sequence point, and those executed after it.  These
3268 occur after the evaluation of a full expression (one which is not part
3269 of a larger expression), after the evaluation of the first operand of a
3270 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3271 function is called (but after the evaluation of its arguments and the
3272 expression denoting the called function), and in certain other places.
3273 Other than as expressed by the sequence point rules, the order of
3274 evaluation of subexpressions of an expression is not specified.  All
3275 these rules describe only a partial order rather than a total order,
3276 since, for example, if two functions are called within one expression
3277 with no sequence point between them, the order in which the functions
3278 are called is not specified.  However, the standards committee have
3279 ruled that function calls do not overlap.
3280
3281 It is not specified when between sequence points modifications to the
3282 values of objects take effect.  Programs whose behavior depends on this
3283 have undefined behavior; the C and C++ standards specify that ``Between
3284 the previous and next sequence point an object shall have its stored
3285 value modified at most once by the evaluation of an expression.
3286 Furthermore, the prior value shall be read only to determine the value
3287 to be stored.''.  If a program breaks these rules, the results on any
3288 particular implementation are entirely unpredictable.
3289
3290 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3291 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3292 diagnosed by this option, and it may give an occasional false positive
3293 result, but in general it has been found fairly effective at detecting
3294 this sort of problem in programs.
3295
3296 The standard is worded confusingly, therefore there is some debate
3297 over the precise meaning of the sequence point rules in subtle cases.
3298 Links to discussions of the problem, including proposed formal
3299 definitions, may be found on the GCC readings page, at
3300 @w{@uref{http://gcc.gnu.org/readings.html}}.
3301
3302 This warning is enabled by @option{-Wall} for C and C++.
3303
3304 @item -Wreturn-type
3305 @opindex Wreturn-type
3306 @opindex Wno-return-type
3307 Warn whenever a function is defined with a return-type that defaults
3308 to @code{int}.  Also warn about any @code{return} statement with no
3309 return-value in a function whose return-type is not @code{void}
3310 (falling off the end of the function body is considered returning
3311 without a value), and about a @code{return} statement with an
3312 expression in a function whose return-type is @code{void}.
3313
3314 For C++, a function without return type always produces a diagnostic
3315 message, even when @option{-Wno-return-type} is specified.  The only
3316 exceptions are @samp{main} and functions defined in system headers.
3317
3318 This warning is enabled by @option{-Wall}.
3319
3320 @item -Wswitch
3321 @opindex Wswitch
3322 @opindex Wno-switch
3323 Warn whenever a @code{switch} statement has an index of enumerated type
3324 and lacks a @code{case} for one or more of the named codes of that
3325 enumeration.  (The presence of a @code{default} label prevents this
3326 warning.)  @code{case} labels outside the enumeration range also
3327 provoke warnings when this option is used (even if there is a
3328 @code{default} label).
3329 This warning is enabled by @option{-Wall}.
3330
3331 @item -Wswitch-default
3332 @opindex Wswitch-default
3333 @opindex Wno-switch-default
3334 Warn whenever a @code{switch} statement does not have a @code{default}
3335 case.
3336
3337 @item -Wswitch-enum
3338 @opindex Wswitch-enum
3339 @opindex Wno-switch-enum
3340 Warn whenever a @code{switch} statement has an index of enumerated type
3341 and lacks a @code{case} for one or more of the named codes of that
3342 enumeration.  @code{case} labels outside the enumeration range also
3343 provoke warnings when this option is used.  The only difference
3344 between @option{-Wswitch} and this option is that this option gives a
3345 warning about an omitted enumeration code even if there is a
3346 @code{default} label.
3347
3348 @item -Wsync-nand @r{(C and C++ only)}
3349 @opindex Wsync-nand
3350 @opindex Wno-sync-nand
3351 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3352 built-in functions are used.  These functions changed semantics in GCC 4.4.
3353
3354 @item -Wtrigraphs
3355 @opindex Wtrigraphs
3356 @opindex Wno-trigraphs
3357 Warn if any trigraphs are encountered that might change the meaning of
3358 the program (trigraphs within comments are not warned about).
3359 This warning is enabled by @option{-Wall}.
3360
3361 @item -Wunused-but-set-parameter
3362 @opindex Wunused-but-set-parameter
3363 @opindex Wno-unused-but-set-parameter
3364 Warn whenever a function parameter is assigned to, but otherwise unused
3365 (aside from its declaration).
3366
3367 To suppress this warning use the @samp{unused} attribute
3368 (@pxref{Variable Attributes}).
3369
3370 This warning is also enabled by @option{-Wunused} together with
3371 @option{-Wextra}.
3372
3373 @item -Wunused-but-set-variable
3374 @opindex Wunused-but-set-variable
3375 @opindex Wno-unused-but-set-variable
3376 Warn whenever a local variable is assigned to, but otherwise unused
3377 (aside from its declaration).
3378 This warning is enabled by @option{-Wall}.
3379
3380 To suppress this warning use the @samp{unused} attribute
3381 (@pxref{Variable Attributes}).
3382
3383 This warning is also enabled by @option{-Wunused}, which is enabled
3384 by @option{-Wall}.
3385
3386 @item -Wunused-function
3387 @opindex Wunused-function
3388 @opindex Wno-unused-function
3389 Warn whenever a static function is declared but not defined or a
3390 non-inline static function is unused.
3391 This warning is enabled by @option{-Wall}.
3392
3393 @item -Wunused-label
3394 @opindex Wunused-label
3395 @opindex Wno-unused-label
3396 Warn whenever a label is declared but not used.
3397 This warning is enabled by @option{-Wall}.
3398
3399 To suppress this warning use the @samp{unused} attribute
3400 (@pxref{Variable Attributes}).
3401
3402 @item -Wunused-parameter
3403 @opindex Wunused-parameter
3404 @opindex Wno-unused-parameter
3405 Warn whenever a function parameter is unused aside from its declaration.
3406
3407 To suppress this warning use the @samp{unused} attribute
3408 (@pxref{Variable Attributes}).
3409
3410 @item -Wno-unused-result
3411 @opindex Wunused-result
3412 @opindex Wno-unused-result
3413 Do not warn if a caller of a function marked with attribute
3414 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3415 its return value. The default is @option{-Wunused-result}.
3416
3417 @item -Wunused-variable
3418 @opindex Wunused-variable
3419 @opindex Wno-unused-variable
3420 Warn whenever a local variable or non-constant static variable is unused
3421 aside from its declaration.
3422 This warning is enabled by @option{-Wall}.
3423
3424 To suppress this warning use the @samp{unused} attribute
3425 (@pxref{Variable Attributes}).
3426
3427 @item -Wunused-value
3428 @opindex Wunused-value
3429 @opindex Wno-unused-value
3430 Warn whenever a statement computes a result that is explicitly not
3431 used. To suppress this warning cast the unused expression to
3432 @samp{void}. This includes an expression-statement or the left-hand
3433 side of a comma expression that contains no side effects. For example,
3434 an expression such as @samp{x[i,j]} will cause a warning, while
3435 @samp{x[(void)i,j]} will not.
3436
3437 This warning is enabled by @option{-Wall}.
3438
3439 @item -Wunused
3440 @opindex Wunused
3441 @opindex Wno-unused
3442 All the above @option{-Wunused} options combined.
3443
3444 In order to get a warning about an unused function parameter, you must
3445 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3446 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3447
3448 @item -Wuninitialized
3449 @opindex Wuninitialized
3450 @opindex Wno-uninitialized
3451 Warn if an automatic variable is used without first being initialized
3452 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3453 warn if a non-static reference or non-static @samp{const} member
3454 appears in a class without constructors.
3455
3456 If you want to warn about code which uses the uninitialized value of the
3457 variable in its own initializer, use the @option{-Winit-self} option.
3458
3459 These warnings occur for individual uninitialized or clobbered
3460 elements of structure, union or array variables as well as for
3461 variables which are uninitialized or clobbered as a whole.  They do
3462 not occur for variables or elements declared @code{volatile}.  Because
3463 these warnings depend on optimization, the exact variables or elements
3464 for which there are warnings will depend on the precise optimization
3465 options and version of GCC used.
3466
3467 Note that there may be no warning about a variable that is used only
3468 to compute a value that itself is never used, because such
3469 computations may be deleted by data flow analysis before the warnings
3470 are printed.
3471
3472 These warnings are made optional because GCC is not smart
3473 enough to see all the reasons why the code might be correct
3474 despite appearing to have an error.  Here is one example of how
3475 this can happen:
3476
3477 @smallexample
3478 @group
3479 @{
3480   int x;
3481   switch (y)
3482     @{
3483     case 1: x = 1;
3484       break;
3485     case 2: x = 4;
3486       break;
3487     case 3: x = 5;
3488     @}
3489   foo (x);
3490 @}
3491 @end group
3492 @end smallexample
3493
3494 @noindent
3495 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3496 always initialized, but GCC doesn't know this.  Here is
3497 another common case:
3498
3499 @smallexample
3500 @{
3501   int save_y;
3502   if (change_y) save_y = y, y = new_y;
3503   @dots{}
3504   if (change_y) y = save_y;
3505 @}
3506 @end smallexample
3507
3508 @noindent
3509 This has no bug because @code{save_y} is used only if it is set.
3510
3511 @cindex @code{longjmp} warnings
3512 This option also warns when a non-volatile automatic variable might be
3513 changed by a call to @code{longjmp}.  These warnings as well are possible
3514 only in optimizing compilation.
3515
3516 The compiler sees only the calls to @code{setjmp}.  It cannot know
3517 where @code{longjmp} will be called; in fact, a signal handler could
3518 call it at any point in the code.  As a result, you may get a warning
3519 even when there is in fact no problem because @code{longjmp} cannot
3520 in fact be called at the place which would cause a problem.
3521
3522 Some spurious warnings can be avoided if you declare all the functions
3523 you use that never return as @code{noreturn}.  @xref{Function
3524 Attributes}.
3525
3526 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3527
3528 @item -Wunknown-pragmas
3529 @opindex Wunknown-pragmas
3530 @opindex Wno-unknown-pragmas
3531 @cindex warning for unknown pragmas
3532 @cindex unknown pragmas, warning
3533 @cindex pragmas, warning of unknown
3534 Warn when a #pragma directive is encountered which is not understood by
3535 GCC@.  If this command line option is used, warnings will even be issued
3536 for unknown pragmas in system header files.  This is not the case if
3537 the warnings were only enabled by the @option{-Wall} command line option.
3538
3539 @item -Wno-pragmas
3540 @opindex Wno-pragmas
3541 @opindex Wpragmas
3542 Do not warn about misuses of pragmas, such as incorrect parameters,
3543 invalid syntax, or conflicts between pragmas.  See also
3544 @samp{-Wunknown-pragmas}.
3545
3546 @item -Wstrict-aliasing
3547 @opindex Wstrict-aliasing
3548 @opindex Wno-strict-aliasing
3549 This option is only active when @option{-fstrict-aliasing} is active.
3550 It warns about code which might break the strict aliasing rules that the
3551 compiler is using for optimization.  The warning does not catch all
3552 cases, but does attempt to catch the more common pitfalls.  It is
3553 included in @option{-Wall}.
3554 It is equivalent to @option{-Wstrict-aliasing=3}
3555
3556 @item -Wstrict-aliasing=n
3557 @opindex Wstrict-aliasing=n
3558 @opindex Wno-strict-aliasing=n
3559 This option is only active when @option{-fstrict-aliasing} is active.
3560 It warns about code which might break the strict aliasing rules that the
3561 compiler is using for optimization.
3562 Higher levels correspond to higher accuracy (fewer false positives).
3563 Higher levels also correspond to more effort, similar to the way -O works.
3564 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3565 with n=3.
3566
3567 Level 1: Most aggressive, quick, least accurate.
3568 Possibly useful when higher levels
3569 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3570 false negatives.  However, it has many false positives.
3571 Warns for all pointer conversions between possibly incompatible types,
3572 even if never dereferenced.  Runs in the frontend only.
3573
3574 Level 2: Aggressive, quick, not too precise.
3575 May still have many false positives (not as many as level 1 though),
3576 and few false negatives (but possibly more than level 1).
3577 Unlike level 1, it only warns when an address is taken.  Warns about
3578 incomplete types.  Runs in the frontend only.
3579
3580 Level 3 (default for @option{-Wstrict-aliasing}):
3581 Should have very few false positives and few false
3582 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3583 Takes care of the common pun+dereference pattern in the frontend:
3584 @code{*(int*)&some_float}.
3585 If optimization is enabled, it also runs in the backend, where it deals
3586 with multiple statement cases using flow-sensitive points-to information.
3587 Only warns when the converted pointer is dereferenced.
3588 Does not warn about incomplete types.
3589
3590 @item -Wstrict-overflow
3591 @itemx -Wstrict-overflow=@var{n}
3592 @opindex Wstrict-overflow
3593 @opindex Wno-strict-overflow
3594 This option is only active when @option{-fstrict-overflow} is active.
3595 It warns about cases where the compiler optimizes based on the
3596 assumption that signed overflow does not occur.  Note that it does not
3597 warn about all cases where the code might overflow: it only warns
3598 about cases where the compiler implements some optimization.  Thus
3599 this warning depends on the optimization level.
3600
3601 An optimization which assumes that signed overflow does not occur is
3602 perfectly safe if the values of the variables involved are such that
3603 overflow never does, in fact, occur.  Therefore this warning can
3604 easily give a false positive: a warning about code which is not
3605 actually a problem.  To help focus on important issues, several
3606 warning levels are defined.  No warnings are issued for the use of
3607 undefined signed overflow when estimating how many iterations a loop
3608 will require, in particular when determining whether a loop will be
3609 executed at all.
3610
3611 @table @gcctabopt
3612 @item -Wstrict-overflow=1
3613 Warn about cases which are both questionable and easy to avoid.  For
3614 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3615 compiler will simplify this to @code{1}.  This level of
3616 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3617 are not, and must be explicitly requested.
3618
3619 @item -Wstrict-overflow=2
3620 Also warn about other cases where a comparison is simplified to a
3621 constant.  For example: @code{abs (x) >= 0}.  This can only be
3622 simplified when @option{-fstrict-overflow} is in effect, because
3623 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3624 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3625 @option{-Wstrict-overflow=2}.
3626
3627 @item -Wstrict-overflow=3
3628 Also warn about other cases where a comparison is simplified.  For
3629 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3630
3631 @item -Wstrict-overflow=4
3632 Also warn about other simplifications not covered by the above cases.
3633 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3634
3635 @item -Wstrict-overflow=5
3636 Also warn about cases where the compiler reduces the magnitude of a
3637 constant involved in a comparison.  For example: @code{x + 2 > y} will
3638 be simplified to @code{x + 1 >= y}.  This is reported only at the
3639 highest warning level because this simplification applies to many
3640 comparisons, so this warning level will give a very large number of
3641 false positives.
3642 @end table
3643
3644 @item -Wsuggest-attribute=@r{[}const@r{|}pure@r{]}
3645 @opindex Wsuggest-attribute=
3646 @opindex Wno-suggest-attribute=
3647 Warn for cases where adding an attribute may be beneficial. The
3648 attributes currently supported are listed below.
3649
3650 @table @gcctabopt
3651 @item -Wsuggest-attribute=pure
3652 @itemx -Wsuggest-attribute=const
3653 @opindex Wsuggest-attribute=pure
3654 @opindex Wno-suggest-attribute=pure
3655 @opindex Wsuggest-attribute=const
3656 @opindex Wno-suggest-attribute=const
3657
3658 Warn about functions which might be candidates for attributes
3659 @code{pure} or @code{const}.  The compiler only warns for functions
3660 visible in other compilation units or if it cannot prove that the
3661 function returns normally. A function returns normally if it doesn't
3662 contain an infinite loop nor returns abnormally by throwing, calling
3663 @code{abort()} or trapping.  This analysis requires option
3664 @option{-fipa-pure-const}, which is enabled by default at @option{-O}
3665 and higher.  Higher optimization levels improve the accuracy of the
3666 analysis.
3667 @end table
3668
3669 @item -Warray-bounds
3670 @opindex Wno-array-bounds
3671 @opindex Warray-bounds
3672 This option is only active when @option{-ftree-vrp} is active
3673 (default for @option{-O2} and above). It warns about subscripts to arrays
3674 that are always out of bounds. This warning is enabled by @option{-Wall}.
3675
3676 @item -Wno-div-by-zero
3677 @opindex Wno-div-by-zero
3678 @opindex Wdiv-by-zero
3679 Do not warn about compile-time integer division by zero.  Floating point
3680 division by zero is not warned about, as it can be a legitimate way of
3681 obtaining infinities and NaNs.
3682
3683 @item -Wsystem-headers
3684 @opindex Wsystem-headers
3685 @opindex Wno-system-headers
3686 @cindex warnings from system headers
3687 @cindex system headers, warnings from
3688 Print warning messages for constructs found in system header files.
3689 Warnings from system headers are normally suppressed, on the assumption
3690 that they usually do not indicate real problems and would only make the
3691 compiler output harder to read.  Using this command line option tells
3692 GCC to emit warnings from system headers as if they occurred in user
3693 code.  However, note that using @option{-Wall} in conjunction with this
3694 option will @emph{not} warn about unknown pragmas in system
3695 headers---for that, @option{-Wunknown-pragmas} must also be used.
3696
3697 @item -Wfloat-equal
3698 @opindex Wfloat-equal
3699 @opindex Wno-float-equal
3700 Warn if floating point values are used in equality comparisons.
3701
3702 The idea behind this is that sometimes it is convenient (for the
3703 programmer) to consider floating-point values as approximations to
3704 infinitely precise real numbers.  If you are doing this, then you need
3705 to compute (by analyzing the code, or in some other way) the maximum or
3706 likely maximum error that the computation introduces, and allow for it
3707 when performing comparisons (and when producing output, but that's a
3708 different problem).  In particular, instead of testing for equality, you
3709 would check to see whether the two values have ranges that overlap; and
3710 this is done with the relational operators, so equality comparisons are
3711 probably mistaken.
3712
3713 @item -Wtraditional @r{(C and Objective-C only)}
3714 @opindex Wtraditional
3715 @opindex Wno-traditional
3716 Warn about certain constructs that behave differently in traditional and
3717 ISO C@.  Also warn about ISO C constructs that have no traditional C
3718 equivalent, and/or problematic constructs which should be avoided.
3719
3720 @itemize @bullet
3721 @item
3722 Macro parameters that appear within string literals in the macro body.
3723 In traditional C macro replacement takes place within string literals,
3724 but does not in ISO C@.
3725
3726 @item
3727 In traditional C, some preprocessor directives did not exist.
3728 Traditional preprocessors would only consider a line to be a directive
3729 if the @samp{#} appeared in column 1 on the line.  Therefore
3730 @option{-Wtraditional} warns about directives that traditional C
3731 understands but would ignore because the @samp{#} does not appear as the
3732 first character on the line.  It also suggests you hide directives like
3733 @samp{#pragma} not understood by traditional C by indenting them.  Some
3734 traditional implementations would not recognize @samp{#elif}, so it
3735 suggests avoiding it altogether.
3736
3737 @item
3738 A function-like macro that appears without arguments.
3739
3740 @item
3741 The unary plus operator.
3742
3743 @item
3744 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3745 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3746 constants.)  Note, these suffixes appear in macros defined in the system
3747 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3748 Use of these macros in user code might normally lead to spurious
3749 warnings, however GCC's integrated preprocessor has enough context to
3750 avoid warning in these cases.
3751
3752 @item
3753 A function declared external in one block and then used after the end of
3754 the block.
3755
3756 @item
3757 A @code{switch} statement has an operand of type @code{long}.
3758
3759 @item
3760 A non-@code{static} function declaration follows a @code{static} one.
3761 This construct is not accepted by some traditional C compilers.
3762
3763 @item
3764 The ISO type of an integer constant has a different width or
3765 signedness from its traditional type.  This warning is only issued if
3766 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3767 typically represent bit patterns, are not warned about.
3768
3769 @item
3770 Usage of ISO string concatenation is detected.
3771
3772 @item
3773 Initialization of automatic aggregates.
3774
3775 @item
3776 Identifier conflicts with labels.  Traditional C lacks a separate
3777 namespace for labels.
3778
3779 @item
3780 Initialization of unions.  If the initializer is zero, the warning is
3781 omitted.  This is done under the assumption that the zero initializer in
3782 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3783 initializer warnings and relies on default initialization to zero in the
3784 traditional C case.
3785
3786 @item
3787 Conversions by prototypes between fixed/floating point values and vice
3788 versa.  The absence of these prototypes when compiling with traditional
3789 C would cause serious problems.  This is a subset of the possible
3790 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3791
3792 @item
3793 Use of ISO C style function definitions.  This warning intentionally is
3794 @emph{not} issued for prototype declarations or variadic functions
3795 because these ISO C features will appear in your code when using
3796 libiberty's traditional C compatibility macros, @code{PARAMS} and
3797 @code{VPARAMS}.  This warning is also bypassed for nested functions
3798 because that feature is already a GCC extension and thus not relevant to
3799 traditional C compatibility.
3800 @end itemize
3801
3802 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3803 @opindex Wtraditional-conversion
3804 @opindex Wno-traditional-conversion
3805 Warn if a prototype causes a type conversion that is different from what
3806 would happen to the same argument in the absence of a prototype.  This
3807 includes conversions of fixed point to floating and vice versa, and
3808 conversions changing the width or signedness of a fixed point argument
3809 except when the same as the default promotion.
3810
3811 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3812 @opindex Wdeclaration-after-statement
3813 @opindex Wno-declaration-after-statement
3814 Warn when a declaration is found after a statement in a block.  This
3815 construct, known from C++, was introduced with ISO C99 and is by default
3816 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3817 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3818
3819 @item -Wundef
3820 @opindex Wundef
3821 @opindex Wno-undef
3822 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3823
3824 @item -Wno-endif-labels
3825 @opindex Wno-endif-labels
3826 @opindex Wendif-labels
3827 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3828
3829 @item -Wshadow
3830 @opindex Wshadow
3831 @opindex Wno-shadow
3832 Warn whenever a local variable shadows another local variable, parameter or
3833 global variable or whenever a built-in function is shadowed.
3834
3835 @item -Wlarger-than=@var{len}
3836 @opindex Wlarger-than=@var{len}
3837 @opindex Wlarger-than-@var{len}
3838 Warn whenever an object of larger than @var{len} bytes is defined.
3839
3840 @item -Wframe-larger-than=@var{len}
3841 @opindex Wframe-larger-than
3842 Warn if the size of a function frame is larger than @var{len} bytes.
3843 The computation done to determine the stack frame size is approximate
3844 and not conservative.
3845 The actual requirements may be somewhat greater than @var{len}
3846 even if you do not get a warning.  In addition, any space allocated
3847 via @code{alloca}, variable-length arrays, or related constructs
3848 is not included by the compiler when determining
3849 whether or not to issue a warning.
3850
3851 @item -Wunsafe-loop-optimizations
3852 @opindex Wunsafe-loop-optimizations
3853 @opindex Wno-unsafe-loop-optimizations
3854 Warn if the loop cannot be optimized because the compiler could not
3855 assume anything on the bounds of the loop indices.  With
3856 @option{-funsafe-loop-optimizations} warn if the compiler made
3857 such assumptions.
3858
3859 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3860 @opindex Wno-pedantic-ms-format
3861 @opindex Wpedantic-ms-format
3862 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3863 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3864 depending on the MS runtime, when you are using the options @option{-Wformat}
3865 and @option{-pedantic} without gnu-extensions.
3866
3867 @item -Wpointer-arith
3868 @opindex Wpointer-arith
3869 @opindex Wno-pointer-arith
3870 Warn about anything that depends on the ``size of'' a function type or
3871 of @code{void}.  GNU C assigns these types a size of 1, for
3872 convenience in calculations with @code{void *} pointers and pointers
3873 to functions.  In C++, warn also when an arithmetic operation involves
3874 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3875
3876 @item -Wtype-limits
3877 @opindex Wtype-limits
3878 @opindex Wno-type-limits
3879 Warn if a comparison is always true or always false due to the limited
3880 range of the data type, but do not warn for constant expressions.  For
3881 example, warn if an unsigned variable is compared against zero with
3882 @samp{<} or @samp{>=}.  This warning is also enabled by
3883 @option{-Wextra}.
3884
3885 @item -Wbad-function-cast @r{(C and Objective-C only)}
3886 @opindex Wbad-function-cast
3887 @opindex Wno-bad-function-cast
3888 Warn whenever a function call is cast to a non-matching type.
3889 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3890
3891 @item -Wc++-compat @r{(C and Objective-C only)}
3892 Warn about ISO C constructs that are outside of the common subset of
3893 ISO C and ISO C++, e.g.@: request for implicit conversion from
3894 @code{void *} to a pointer to non-@code{void} type.
3895
3896 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3897 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3898 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3899 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3900
3901 @item -Wcast-qual
3902 @opindex Wcast-qual
3903 @opindex Wno-cast-qual
3904 Warn whenever a pointer is cast so as to remove a type qualifier from
3905 the target type.  For example, warn if a @code{const char *} is cast
3906 to an ordinary @code{char *}.
3907
3908 Also warn when making a cast which introduces a type qualifier in an
3909 unsafe way.  For example, casting @code{char **} to @code{const char **}
3910 is unsafe, as in this example:
3911
3912 @smallexample
3913   /* p is char ** value.  */
3914   const char **q = (const char **) p;
3915   /* Assignment of readonly string to const char * is OK.  */
3916   *q = "string";
3917   /* Now char** pointer points to read-only memory.  */
3918   **p = 'b';
3919 @end smallexample
3920
3921 @item -Wcast-align
3922 @opindex Wcast-align
3923 @opindex Wno-cast-align
3924 Warn whenever a pointer is cast such that the required alignment of the
3925 target is increased.  For example, warn if a @code{char *} is cast to
3926 an @code{int *} on machines where integers can only be accessed at
3927 two- or four-byte boundaries.
3928
3929 @item -Wwrite-strings
3930 @opindex Wwrite-strings
3931 @opindex Wno-write-strings
3932 When compiling C, give string constants the type @code{const
3933 char[@var{length}]} so that copying the address of one into a
3934 non-@code{const} @code{char *} pointer will get a warning.  These
3935 warnings will help you find at compile time code that can try to write
3936 into a string constant, but only if you have been very careful about
3937 using @code{const} in declarations and prototypes.  Otherwise, it will
3938 just be a nuisance. This is why we did not make @option{-Wall} request
3939 these warnings.
3940
3941 When compiling C++, warn about the deprecated conversion from string
3942 literals to @code{char *}.  This warning is enabled by default for C++
3943 programs.
3944
3945 @item -Wclobbered
3946 @opindex Wclobbered
3947 @opindex Wno-clobbered
3948 Warn for variables that might be changed by @samp{longjmp} or
3949 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3950
3951 @item -Wconversion
3952 @opindex Wconversion
3953 @opindex Wno-conversion
3954 Warn for implicit conversions that may alter a value. This includes
3955 conversions between real and integer, like @code{abs (x)} when
3956 @code{x} is @code{double}; conversions between signed and unsigned,
3957 like @code{unsigned ui = -1}; and conversions to smaller types, like
3958 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3959 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3960 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3961 conversions between signed and unsigned integers can be disabled by
3962 using @option{-Wno-sign-conversion}.
3963
3964 For C++, also warn for confusing overload resolution for user-defined
3965 conversions; and conversions that will never use a type conversion
3966 operator: conversions to @code{void}, the same type, a base class or a
3967 reference to them. Warnings about conversions between signed and
3968 unsigned integers are disabled by default in C++ unless
3969 @option{-Wsign-conversion} is explicitly enabled.
3970
3971 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
3972 @opindex Wconversion-null
3973 @opindex Wno-conversion-null
3974 Do not warn for conversions between @code{NULL} and non-pointer
3975 types. @option{-Wconversion-null} is enabled by default.
3976
3977 @item -Wempty-body
3978 @opindex Wempty-body
3979 @opindex Wno-empty-body
3980 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3981 while} statement.  This warning is also enabled by @option{-Wextra}.
3982
3983 @item -Wenum-compare
3984 @opindex Wenum-compare
3985 @opindex Wno-enum-compare
3986 Warn about a comparison between values of different enum types. In C++
3987 this warning is enabled by default.  In C this warning is enabled by
3988 @option{-Wall}.
3989
3990 @item -Wjump-misses-init @r{(C, Objective-C only)}
3991 @opindex Wjump-misses-init
3992 @opindex Wno-jump-misses-init
3993 Warn if a @code{goto} statement or a @code{switch} statement jumps
3994 forward across the initialization of a variable, or jumps backward to a
3995 label after the variable has been initialized.  This only warns about
3996 variables which are initialized when they are declared.  This warning is
3997 only supported for C and Objective C; in C++ this sort of branch is an
3998 error in any case.
3999
4000 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4001 can be disabled with the @option{-Wno-jump-misses-init} option.
4002
4003 @item -Wsign-compare
4004 @opindex Wsign-compare
4005 @opindex Wno-sign-compare
4006 @cindex warning for comparison of signed and unsigned values
4007 @cindex comparison of signed and unsigned values, warning
4008 @cindex signed and unsigned values, comparison warning
4009 Warn when a comparison between signed and unsigned values could produce
4010 an incorrect result when the signed value is converted to unsigned.
4011 This warning is also enabled by @option{-Wextra}; to get the other warnings
4012 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
4013
4014 @item -Wsign-conversion
4015 @opindex Wsign-conversion
4016 @opindex Wno-sign-conversion
4017 Warn for implicit conversions that may change the sign of an integer
4018 value, like assigning a signed integer expression to an unsigned
4019 integer variable. An explicit cast silences the warning. In C, this
4020 option is enabled also by @option{-Wconversion}.
4021
4022 @item -Waddress
4023 @opindex Waddress
4024 @opindex Wno-address
4025 Warn about suspicious uses of memory addresses. These include using
4026 the address of a function in a conditional expression, such as
4027 @code{void func(void); if (func)}, and comparisons against the memory
4028 address of a string literal, such as @code{if (x == "abc")}.  Such
4029 uses typically indicate a programmer error: the address of a function
4030 always evaluates to true, so their use in a conditional usually
4031 indicate that the programmer forgot the parentheses in a function
4032 call; and comparisons against string literals result in unspecified
4033 behavior and are not portable in C, so they usually indicate that the
4034 programmer intended to use @code{strcmp}.  This warning is enabled by
4035 @option{-Wall}.
4036
4037 @item -Wlogical-op
4038 @opindex Wlogical-op
4039 @opindex Wno-logical-op
4040 Warn about suspicious uses of logical operators in expressions.
4041 This includes using logical operators in contexts where a
4042 bit-wise operator is likely to be expected.
4043
4044 @item -Waggregate-return
4045 @opindex Waggregate-return
4046 @opindex Wno-aggregate-return
4047 Warn if any functions that return structures or unions are defined or
4048 called.  (In languages where you can return an array, this also elicits
4049 a warning.)
4050
4051 @item -Wno-attributes
4052 @opindex Wno-attributes
4053 @opindex Wattributes
4054 Do not warn if an unexpected @code{__attribute__} is used, such as
4055 unrecognized attributes, function attributes applied to variables,
4056 etc.  This will not stop errors for incorrect use of supported
4057 attributes.
4058
4059 @item -Wno-builtin-macro-redefined
4060 @opindex Wno-builtin-macro-redefined
4061 @opindex Wbuiltin-macro-redefined
4062 Do not warn if certain built-in macros are redefined.  This suppresses
4063 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4064 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4065
4066 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4067 @opindex Wstrict-prototypes
4068 @opindex Wno-strict-prototypes
4069 Warn if a function is declared or defined without specifying the
4070 argument types.  (An old-style function definition is permitted without
4071 a warning if preceded by a declaration which specifies the argument
4072 types.)
4073
4074 @item -Wold-style-declaration @r{(C and Objective-C only)}
4075 @opindex Wold-style-declaration
4076 @opindex Wno-old-style-declaration
4077 Warn for obsolescent usages, according to the C Standard, in a
4078 declaration. For example, warn if storage-class specifiers like
4079 @code{static} are not the first things in a declaration.  This warning
4080 is also enabled by @option{-Wextra}.
4081
4082 @item -Wold-style-definition @r{(C and Objective-C only)}
4083 @opindex Wold-style-definition
4084 @opindex Wno-old-style-definition
4085 Warn if an old-style function definition is used.  A warning is given
4086 even if there is a previous prototype.
4087
4088 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4089 @opindex Wmissing-parameter-type
4090 @opindex Wno-missing-parameter-type
4091 A function parameter is declared without a type specifier in K&R-style
4092 functions:
4093
4094 @smallexample
4095 void foo(bar) @{ @}
4096 @end smallexample
4097
4098 This warning is also enabled by @option{-Wextra}.
4099
4100 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4101 @opindex Wmissing-prototypes
4102 @opindex Wno-missing-prototypes
4103 Warn if a global function is defined without a previous prototype
4104 declaration.  This warning is issued even if the definition itself
4105 provides a prototype.  The aim is to detect global functions that fail
4106 to be declared in header files.
4107
4108 @item -Wmissing-declarations
4109 @opindex Wmissing-declarations
4110 @opindex Wno-missing-declarations
4111 Warn if a global function is defined without a previous declaration.
4112 Do so even if the definition itself provides a prototype.
4113 Use this option to detect global functions that are not declared in
4114 header files.  In C++, no warnings are issued for function templates,
4115 or for inline functions, or for functions in anonymous namespaces.
4116
4117 @item -Wmissing-field-initializers
4118 @opindex Wmissing-field-initializers
4119 @opindex Wno-missing-field-initializers
4120 @opindex W
4121 @opindex Wextra
4122 @opindex Wno-extra
4123 Warn if a structure's initializer has some fields missing.  For
4124 example, the following code would cause such a warning, because
4125 @code{x.h} is implicitly zero:
4126
4127 @smallexample
4128 struct s @{ int f, g, h; @};
4129 struct s x = @{ 3, 4 @};
4130 @end smallexample
4131
4132 This option does not warn about designated initializers, so the following
4133 modification would not trigger a warning:
4134
4135 @smallexample
4136 struct s @{ int f, g, h; @};
4137 struct s x = @{ .f = 3, .g = 4 @};
4138 @end smallexample
4139
4140 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4141 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4142
4143 @item -Wmissing-noreturn
4144 @opindex Wmissing-noreturn
4145 @opindex Wno-missing-noreturn
4146 Warn about functions which might be candidates for attribute @code{noreturn}.
4147 Note these are only possible candidates, not absolute ones.  Care should
4148 be taken to manually verify functions actually do not ever return before
4149 adding the @code{noreturn} attribute, otherwise subtle code generation
4150 bugs could be introduced.  You will not get a warning for @code{main} in
4151 hosted C environments.
4152
4153 @item -Wmissing-format-attribute
4154 @opindex Wmissing-format-attribute
4155 @opindex Wno-missing-format-attribute
4156 @opindex Wformat
4157 @opindex Wno-format
4158 Warn about function pointers which might be candidates for @code{format}
4159 attributes.  Note these are only possible candidates, not absolute ones.
4160 GCC will guess that function pointers with @code{format} attributes that
4161 are used in assignment, initialization, parameter passing or return
4162 statements should have a corresponding @code{format} attribute in the
4163 resulting type.  I.e.@: the left-hand side of the assignment or
4164 initialization, the type of the parameter variable, or the return type
4165 of the containing function respectively should also have a @code{format}
4166 attribute to avoid the warning.
4167
4168 GCC will also warn about function definitions which might be
4169 candidates for @code{format} attributes.  Again, these are only
4170 possible candidates.  GCC will guess that @code{format} attributes
4171 might be appropriate for any function that calls a function like
4172 @code{vprintf} or @code{vscanf}, but this might not always be the
4173 case, and some functions for which @code{format} attributes are
4174 appropriate may not be detected.
4175
4176 @item -Wno-multichar
4177 @opindex Wno-multichar
4178 @opindex Wmultichar
4179 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4180 Usually they indicate a typo in the user's code, as they have
4181 implementation-defined values, and should not be used in portable code.
4182
4183 @item -Wnormalized=<none|id|nfc|nfkc>
4184 @opindex Wnormalized=
4185 @cindex NFC
4186 @cindex NFKC
4187 @cindex character set, input normalization
4188 In ISO C and ISO C++, two identifiers are different if they are
4189 different sequences of characters.  However, sometimes when characters
4190 outside the basic ASCII character set are used, you can have two
4191 different character sequences that look the same.  To avoid confusion,
4192 the ISO 10646 standard sets out some @dfn{normalization rules} which
4193 when applied ensure that two sequences that look the same are turned into
4194 the same sequence.  GCC can warn you if you are using identifiers which
4195 have not been normalized; this option controls that warning.
4196
4197 There are four levels of warning that GCC supports.  The default is
4198 @option{-Wnormalized=nfc}, which warns about any identifier which is
4199 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4200 recommended form for most uses.
4201
4202 Unfortunately, there are some characters which ISO C and ISO C++ allow
4203 in identifiers that when turned into NFC aren't allowable as
4204 identifiers.  That is, there's no way to use these symbols in portable
4205 ISO C or C++ and have all your identifiers in NFC@.
4206 @option{-Wnormalized=id} suppresses the warning for these characters.
4207 It is hoped that future versions of the standards involved will correct
4208 this, which is why this option is not the default.
4209
4210 You can switch the warning off for all characters by writing
4211 @option{-Wnormalized=none}.  You would only want to do this if you
4212 were using some other normalization scheme (like ``D''), because
4213 otherwise you can easily create bugs that are literally impossible to see.
4214
4215 Some characters in ISO 10646 have distinct meanings but look identical
4216 in some fonts or display methodologies, especially once formatting has
4217 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4218 LETTER N'', will display just like a regular @code{n} which has been
4219 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4220 normalization scheme to convert all these into a standard form as
4221 well, and GCC will warn if your code is not in NFKC if you use
4222 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4223 about every identifier that contains the letter O because it might be
4224 confused with the digit 0, and so is not the default, but may be
4225 useful as a local coding convention if the programming environment is
4226 unable to be fixed to display these characters distinctly.
4227
4228 @item -Wno-deprecated
4229 @opindex Wno-deprecated
4230 @opindex Wdeprecated
4231 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4232
4233 @item -Wno-deprecated-declarations
4234 @opindex Wno-deprecated-declarations
4235 @opindex Wdeprecated-declarations
4236 Do not warn about uses of functions (@pxref{Function Attributes}),
4237 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4238 Attributes}) marked as deprecated by using the @code{deprecated}
4239 attribute.
4240
4241 @item -Wno-overflow
4242 @opindex Wno-overflow
4243 @opindex Woverflow
4244 Do not warn about compile-time overflow in constant expressions.
4245
4246 @item -Woverride-init @r{(C and Objective-C only)}
4247 @opindex Woverride-init
4248 @opindex Wno-override-init
4249 @opindex W
4250 @opindex Wextra
4251 @opindex Wno-extra
4252 Warn if an initialized field without side effects is overridden when
4253 using designated initializers (@pxref{Designated Inits, , Designated
4254 Initializers}).
4255
4256 This warning is included in @option{-Wextra}.  To get other
4257 @option{-Wextra} warnings without this one, use @samp{-Wextra
4258 -Wno-override-init}.
4259
4260 @item -Wpacked
4261 @opindex Wpacked
4262 @opindex Wno-packed
4263 Warn if a structure is given the packed attribute, but the packed
4264 attribute has no effect on the layout or size of the structure.
4265 Such structures may be mis-aligned for little benefit.  For
4266 instance, in this code, the variable @code{f.x} in @code{struct bar}
4267 will be misaligned even though @code{struct bar} does not itself
4268 have the packed attribute:
4269
4270 @smallexample
4271 @group
4272 struct foo @{
4273   int x;
4274   char a, b, c, d;
4275 @} __attribute__((packed));
4276 struct bar @{
4277   char z;
4278   struct foo f;
4279 @};
4280 @end group
4281 @end smallexample
4282
4283 @item -Wpacked-bitfield-compat
4284 @opindex Wpacked-bitfield-compat
4285 @opindex Wno-packed-bitfield-compat
4286 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4287 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4288 the change can lead to differences in the structure layout.  GCC
4289 informs you when the offset of such a field has changed in GCC 4.4.
4290 For example there is no longer a 4-bit padding between field @code{a}
4291 and @code{b} in this structure:
4292
4293 @smallexample
4294 struct foo
4295 @{
4296   char a:4;
4297   char b:8;
4298 @} __attribute__ ((packed));
4299 @end smallexample
4300
4301 This warning is enabled by default.  Use
4302 @option{-Wno-packed-bitfield-compat} to disable this warning.
4303
4304 @item -Wpadded
4305 @opindex Wpadded
4306 @opindex Wno-padded
4307 Warn if padding is included in a structure, either to align an element
4308 of the structure or to align the whole structure.  Sometimes when this
4309 happens it is possible to rearrange the fields of the structure to
4310 reduce the padding and so make the structure smaller.
4311
4312 @item -Wredundant-decls
4313 @opindex Wredundant-decls
4314 @opindex Wno-redundant-decls
4315 Warn if anything is declared more than once in the same scope, even in
4316 cases where multiple declaration is valid and changes nothing.
4317
4318 @item -Wnested-externs @r{(C and Objective-C only)}
4319 @opindex Wnested-externs
4320 @opindex Wno-nested-externs
4321 Warn if an @code{extern} declaration is encountered within a function.
4322
4323 @item -Winline
4324 @opindex Winline
4325 @opindex Wno-inline
4326 Warn if a function can not be inlined and it was declared as inline.
4327 Even with this option, the compiler will not warn about failures to
4328 inline functions declared in system headers.
4329
4330 The compiler uses a variety of heuristics to determine whether or not
4331 to inline a function.  For example, the compiler takes into account
4332 the size of the function being inlined and the amount of inlining
4333 that has already been done in the current function.  Therefore,
4334 seemingly insignificant changes in the source program can cause the
4335 warnings produced by @option{-Winline} to appear or disappear.
4336
4337 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4338 @opindex Wno-invalid-offsetof
4339 @opindex Winvalid-offsetof
4340 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4341 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4342 to a non-POD type is undefined.  In existing C++ implementations,
4343 however, @samp{offsetof} typically gives meaningful results even when
4344 applied to certain kinds of non-POD types. (Such as a simple
4345 @samp{struct} that fails to be a POD type only by virtue of having a
4346 constructor.)  This flag is for users who are aware that they are
4347 writing nonportable code and who have deliberately chosen to ignore the
4348 warning about it.
4349
4350 The restrictions on @samp{offsetof} may be relaxed in a future version
4351 of the C++ standard.
4352
4353 @item -Wno-int-to-pointer-cast
4354 @opindex Wno-int-to-pointer-cast
4355 @opindex Wint-to-pointer-cast
4356 Suppress warnings from casts to pointer type of an integer of a
4357 different size. In C++, casting to a pointer type of smaller size is
4358 an error. @option{Wint-to-pointer-cast} is enabled by default.
4359
4360
4361 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4362 @opindex Wno-pointer-to-int-cast
4363 @opindex Wpointer-to-int-cast
4364 Suppress warnings from casts from a pointer to an integer type of a
4365 different size.
4366
4367 @item -Winvalid-pch
4368 @opindex Winvalid-pch
4369 @opindex Wno-invalid-pch
4370 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4371 the search path but can't be used.
4372
4373 @item -Wlong-long
4374 @opindex Wlong-long
4375 @opindex Wno-long-long
4376 Warn if @samp{long long} type is used.  This is enabled by either
4377 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4378 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4379
4380 @item -Wvariadic-macros
4381 @opindex Wvariadic-macros
4382 @opindex Wno-variadic-macros
4383 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4384 alternate syntax when in pedantic ISO C99 mode.  This is default.
4385 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4386
4387 @item -Wvla
4388 @opindex Wvla
4389 @opindex Wno-vla
4390 Warn if variable length array is used in the code.
4391 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4392 the variable length array.
4393
4394 @item -Wvolatile-register-var
4395 @opindex Wvolatile-register-var
4396 @opindex Wno-volatile-register-var
4397 Warn if a register variable is declared volatile.  The volatile
4398 modifier does not inhibit all optimizations that may eliminate reads
4399 and/or writes to register variables.  This warning is enabled by
4400 @option{-Wall}.
4401
4402 @item -Wdisabled-optimization
4403 @opindex Wdisabled-optimization
4404 @opindex Wno-disabled-optimization
4405 Warn if a requested optimization pass is disabled.  This warning does
4406 not generally indicate that there is anything wrong with your code; it
4407 merely indicates that GCC's optimizers were unable to handle the code
4408 effectively.  Often, the problem is that your code is too big or too
4409 complex; GCC will refuse to optimize programs when the optimization
4410 itself is likely to take inordinate amounts of time.
4411
4412 @item -Wpointer-sign @r{(C and Objective-C only)}
4413 @opindex Wpointer-sign
4414 @opindex Wno-pointer-sign
4415 Warn for pointer argument passing or assignment with different signedness.
4416 This option is only supported for C and Objective-C@.  It is implied by
4417 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4418 @option{-Wno-pointer-sign}.
4419
4420 @item -Wstack-protector
4421 @opindex Wstack-protector
4422 @opindex Wno-stack-protector
4423 This option is only active when @option{-fstack-protector} is active.  It
4424 warns about functions that will not be protected against stack smashing.
4425
4426 @item -Wno-mudflap
4427 @opindex Wno-mudflap
4428 Suppress warnings about constructs that cannot be instrumented by
4429 @option{-fmudflap}.
4430
4431 @item -Woverlength-strings
4432 @opindex Woverlength-strings
4433 @opindex Wno-overlength-strings
4434 Warn about string constants which are longer than the ``minimum
4435 maximum'' length specified in the C standard.  Modern compilers
4436 generally allow string constants which are much longer than the
4437 standard's minimum limit, but very portable programs should avoid
4438 using longer strings.
4439
4440 The limit applies @emph{after} string constant concatenation, and does
4441 not count the trailing NUL@.  In C90, the limit was 509 characters; in
4442 C99, it was raised to 4095.  C++98 does not specify a normative
4443 minimum maximum, so we do not diagnose overlength strings in C++@.
4444
4445 This option is implied by @option{-pedantic}, and can be disabled with
4446 @option{-Wno-overlength-strings}.
4447
4448 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4449 @opindex Wunsuffixed-float-constants
4450
4451 GCC will issue a warning for any floating constant that does not have
4452 a suffix.  When used together with @option{-Wsystem-headers} it will
4453 warn about such constants in system header files.  This can be useful
4454 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4455 from the decimal floating-point extension to C99.
4456 @end table
4457
4458 @node Debugging Options
4459 @section Options for Debugging Your Program or GCC
4460 @cindex options, debugging
4461 @cindex debugging information options
4462
4463 GCC has various special options that are used for debugging
4464 either your program or GCC:
4465
4466 @table @gcctabopt
4467 @item -g
4468 @opindex g
4469 Produce debugging information in the operating system's native format
4470 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4471 information.
4472
4473 On most systems that use stabs format, @option{-g} enables use of extra
4474 debugging information that only GDB can use; this extra information
4475 makes debugging work better in GDB but will probably make other debuggers
4476 crash or
4477 refuse to read the program.  If you want to control for certain whether
4478 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4479 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4480
4481 GCC allows you to use @option{-g} with
4482 @option{-O}.  The shortcuts taken by optimized code may occasionally
4483 produce surprising results: some variables you declared may not exist
4484 at all; flow of control may briefly move where you did not expect it;
4485 some statements may not be executed because they compute constant
4486 results or their values were already at hand; some statements may
4487 execute in different places because they were moved out of loops.
4488
4489 Nevertheless it proves possible to debug optimized output.  This makes
4490 it reasonable to use the optimizer for programs that might have bugs.
4491
4492 The following options are useful when GCC is generated with the
4493 capability for more than one debugging format.
4494
4495 @item -ggdb
4496 @opindex ggdb
4497 Produce debugging information for use by GDB@.  This means to use the
4498 most expressive format available (DWARF 2, stabs, or the native format
4499 if neither of those are supported), including GDB extensions if at all
4500 possible.
4501
4502 @item -gstabs
4503 @opindex gstabs
4504 Produce debugging information in stabs format (if that is supported),
4505 without GDB extensions.  This is the format used by DBX on most BSD
4506 systems.  On MIPS, Alpha and System V Release 4 systems this option
4507 produces stabs debugging output which is not understood by DBX or SDB@.
4508 On System V Release 4 systems this option requires the GNU assembler.
4509
4510 @item -feliminate-unused-debug-symbols
4511 @opindex feliminate-unused-debug-symbols
4512 Produce debugging information in stabs format (if that is supported),
4513 for only symbols that are actually used.
4514
4515 @item -femit-class-debug-always
4516 Instead of emitting debugging information for a C++ class in only one
4517 object file, emit it in all object files using the class.  This option
4518 should be used only with debuggers that are unable to handle the way GCC
4519 normally emits debugging information for classes because using this
4520 option will increase the size of debugging information by as much as a
4521 factor of two.
4522
4523 @item -gstabs+
4524 @opindex gstabs+
4525 Produce debugging information in stabs format (if that is supported),
4526 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4527 use of these extensions is likely to make other debuggers crash or
4528 refuse to read the program.
4529
4530 @item -gcoff
4531 @opindex gcoff
4532 Produce debugging information in COFF format (if that is supported).
4533 This is the format used by SDB on most System V systems prior to
4534 System V Release 4.
4535
4536 @item -gxcoff
4537 @opindex gxcoff
4538 Produce debugging information in XCOFF format (if that is supported).
4539 This is the format used by the DBX debugger on IBM RS/6000 systems.
4540
4541 @item -gxcoff+
4542 @opindex gxcoff+
4543 Produce debugging information in XCOFF format (if that is supported),
4544 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4545 use of these extensions is likely to make other debuggers crash or
4546 refuse to read the program, and may cause assemblers other than the GNU
4547 assembler (GAS) to fail with an error.
4548
4549 @item -gdwarf-@var{version}
4550 @opindex gdwarf-@var{version}
4551 Produce debugging information in DWARF format (if that is
4552 supported).  This is the format used by DBX on IRIX 6.  The value
4553 of @var{version} may be either 2, 3 or 4; the default version is 2.
4554
4555 Note that with DWARF version 2 some ports require, and will always
4556 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4557
4558 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4559 for maximum benefit.
4560
4561 @item -gstrict-dwarf
4562 @opindex gstrict-dwarf
4563 Disallow using extensions of later DWARF standard version than selected
4564 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4565 DWARF extensions from later standard versions is allowed.
4566
4567 @item -gno-strict-dwarf
4568 @opindex gno-strict-dwarf
4569 Allow using extensions of later DWARF standard version than selected with
4570 @option{-gdwarf-@var{version}}.
4571
4572 @item -gvms
4573 @opindex gvms
4574 Produce debugging information in VMS debug format (if that is
4575 supported).  This is the format used by DEBUG on VMS systems.
4576
4577 @item -g@var{level}
4578 @itemx -ggdb@var{level}
4579 @itemx -gstabs@var{level}
4580 @itemx -gcoff@var{level}
4581 @itemx -gxcoff@var{level}
4582 @itemx -gvms@var{level}
4583 Request debugging information and also use @var{level} to specify how
4584 much information.  The default level is 2.
4585
4586 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4587 @option{-g}.
4588
4589 Level 1 produces minimal information, enough for making backtraces in
4590 parts of the program that you don't plan to debug.  This includes
4591 descriptions of functions and external variables, but no information
4592 about local variables and no line numbers.
4593
4594 Level 3 includes extra information, such as all the macro definitions
4595 present in the program.  Some debuggers support macro expansion when
4596 you use @option{-g3}.
4597
4598 @option{-gdwarf-2} does not accept a concatenated debug level, because
4599 GCC used to support an option @option{-gdwarf} that meant to generate
4600 debug information in version 1 of the DWARF format (which is very
4601 different from version 2), and it would have been too confusing.  That
4602 debug format is long obsolete, but the option cannot be changed now.
4603 Instead use an additional @option{-g@var{level}} option to change the
4604 debug level for DWARF.
4605
4606 @item -gtoggle
4607 @opindex gtoggle
4608 Turn off generation of debug info, if leaving out this option would have
4609 generated it, or turn it on at level 2 otherwise.  The position of this
4610 argument in the command line does not matter, it takes effect after all
4611 other options are processed, and it does so only once, no matter how
4612 many times it is given.  This is mainly intended to be used with
4613 @option{-fcompare-debug}.
4614
4615 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4616 @opindex fdump-final-insns
4617 Dump the final internal representation (RTL) to @var{file}.  If the
4618 optional argument is omitted (or if @var{file} is @code{.}), the name
4619 of the dump file will be determined by appending @code{.gkd} to the
4620 compilation output file name.
4621
4622 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4623 @opindex fcompare-debug
4624 @opindex fno-compare-debug
4625 If no error occurs during compilation, run the compiler a second time,
4626 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4627 passed to the second compilation.  Dump the final internal
4628 representation in both compilations, and print an error if they differ.
4629
4630 If the equal sign is omitted, the default @option{-gtoggle} is used.
4631
4632 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4633 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4634 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4635 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4636 is used.
4637
4638 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4639 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4640 of the final representation and the second compilation, preventing even
4641 @env{GCC_COMPARE_DEBUG} from taking effect.
4642
4643 To verify full coverage during @option{-fcompare-debug} testing, set
4644 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4645 which GCC will reject as an invalid option in any actual compilation
4646 (rather than preprocessing, assembly or linking).  To get just a
4647 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4648 not overridden} will do.
4649
4650 @item -fcompare-debug-second
4651 @opindex fcompare-debug-second
4652 This option is implicitly passed to the compiler for the second
4653 compilation requested by @option{-fcompare-debug}, along with options to
4654 silence warnings, and omitting other options that would cause
4655 side-effect compiler outputs to files or to the standard output.  Dump
4656 files and preserved temporary files are renamed so as to contain the
4657 @code{.gk} additional extension during the second compilation, to avoid
4658 overwriting those generated by the first.
4659
4660 When this option is passed to the compiler driver, it causes the
4661 @emph{first} compilation to be skipped, which makes it useful for little
4662 other than debugging the compiler proper.
4663
4664 @item -feliminate-dwarf2-dups
4665 @opindex feliminate-dwarf2-dups
4666 Compress DWARF2 debugging information by eliminating duplicated
4667 information about each symbol.  This option only makes sense when
4668 generating DWARF2 debugging information with @option{-gdwarf-2}.
4669
4670 @item -femit-struct-debug-baseonly
4671 Emit debug information for struct-like types
4672 only when the base name of the compilation source file
4673 matches the base name of file in which the struct was defined.
4674
4675 This option substantially reduces the size of debugging information,
4676 but at significant potential loss in type information to the debugger.
4677 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4678 See @option{-femit-struct-debug-detailed} for more detailed control.
4679
4680 This option works only with DWARF 2.
4681
4682 @item -femit-struct-debug-reduced
4683 Emit debug information for struct-like types
4684 only when the base name of the compilation source file
4685 matches the base name of file in which the type was defined,
4686 unless the struct is a template or defined in a system header.
4687
4688 This option significantly reduces the size of debugging information,
4689 with some potential loss in type information to the debugger.
4690 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4691 See @option{-femit-struct-debug-detailed} for more detailed control.
4692
4693 This option works only with DWARF 2.
4694
4695 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4696 Specify the struct-like types
4697 for which the compiler will generate debug information.
4698 The intent is to reduce duplicate struct debug information
4699 between different object files within the same program.
4700
4701 This option is a detailed version of
4702 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4703 which will serve for most needs.
4704
4705 A specification has the syntax
4706 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4707
4708 The optional first word limits the specification to
4709 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4710 A struct type is used directly when it is the type of a variable, member.
4711 Indirect uses arise through pointers to structs.
4712 That is, when use of an incomplete struct would be legal, the use is indirect.
4713 An example is
4714 @samp{struct one direct; struct two * indirect;}.
4715
4716 The optional second word limits the specification to
4717 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4718 Generic structs are a bit complicated to explain.
4719 For C++, these are non-explicit specializations of template classes,
4720 or non-template classes within the above.
4721 Other programming languages have generics,
4722 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4723
4724 The third word specifies the source files for those
4725 structs for which the compiler will emit debug information.
4726 The values @samp{none} and @samp{any} have the normal meaning.
4727 The value @samp{base} means that
4728 the base of name of the file in which the type declaration appears
4729 must match the base of the name of the main compilation file.
4730 In practice, this means that
4731 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4732 but types declared in other header will not.
4733 The value @samp{sys} means those types satisfying @samp{base}
4734 or declared in system or compiler headers.
4735
4736 You may need to experiment to determine the best settings for your application.
4737
4738 The default is @samp{-femit-struct-debug-detailed=all}.
4739
4740 This option works only with DWARF 2.
4741
4742 @item -fenable-icf-debug
4743 @opindex fenable-icf-debug
4744 Generate additional debug information to support identical code folding (ICF).
4745 This option only works with DWARF version 2 or higher.
4746
4747 @item -fno-merge-debug-strings
4748 @opindex fmerge-debug-strings
4749 @opindex fno-merge-debug-strings
4750 Direct the linker to not merge together strings in the debugging
4751 information which are identical in different object files.  Merging is
4752 not supported by all assemblers or linkers.  Merging decreases the size
4753 of the debug information in the output file at the cost of increasing
4754 link processing time.  Merging is enabled by default.
4755
4756 @item -fdebug-prefix-map=@var{old}=@var{new}
4757 @opindex fdebug-prefix-map
4758 When compiling files in directory @file{@var{old}}, record debugging
4759 information describing them as in @file{@var{new}} instead.
4760
4761 @item -fno-dwarf2-cfi-asm
4762 @opindex fdwarf2-cfi-asm
4763 @opindex fno-dwarf2-cfi-asm
4764 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4765 instead of using GAS @code{.cfi_*} directives.
4766
4767 @cindex @command{prof}
4768 @item -p
4769 @opindex p
4770 Generate extra code to write profile information suitable for the
4771 analysis program @command{prof}.  You must use this option when compiling
4772 the source files you want data about, and you must also use it when
4773 linking.
4774
4775 @cindex @command{gprof}
4776 @item -pg
4777 @opindex pg
4778 Generate extra code to write profile information suitable for the
4779 analysis program @command{gprof}.  You must use this option when compiling
4780 the source files you want data about, and you must also use it when
4781 linking.
4782
4783 @item -Q
4784 @opindex Q
4785 Makes the compiler print out each function name as it is compiled, and
4786 print some statistics about each pass when it finishes.
4787
4788 @item -ftime-report
4789 @opindex ftime-report
4790 Makes the compiler print some statistics about the time consumed by each
4791 pass when it finishes.
4792
4793 @item -fmem-report
4794 @opindex fmem-report
4795 Makes the compiler print some statistics about permanent memory
4796 allocation when it finishes.
4797
4798 @item -fpre-ipa-mem-report
4799 @opindex fpre-ipa-mem-report
4800 @item -fpost-ipa-mem-report
4801 @opindex fpost-ipa-mem-report
4802 Makes the compiler print some statistics about permanent memory
4803 allocation before or after interprocedural optimization.
4804
4805 @item -fprofile-arcs
4806 @opindex fprofile-arcs
4807 Add code so that program flow @dfn{arcs} are instrumented.  During
4808 execution the program records how many times each branch and call is
4809 executed and how many times it is taken or returns.  When the compiled
4810 program exits it saves this data to a file called
4811 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4812 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4813 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4814 @var{auxname} is generated from the name of the output file, if
4815 explicitly specified and it is not the final executable, otherwise it is
4816 the basename of the source file.  In both cases any suffix is removed
4817 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4818 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4819 @xref{Cross-profiling}.
4820
4821 @cindex @command{gcov}
4822 @item --coverage
4823 @opindex coverage
4824
4825 This option is used to compile and link code instrumented for coverage
4826 analysis.  The option is a synonym for @option{-fprofile-arcs}
4827 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4828 linking).  See the documentation for those options for more details.
4829
4830 @itemize
4831
4832 @item
4833 Compile the source files with @option{-fprofile-arcs} plus optimization
4834 and code generation options.  For test coverage analysis, use the
4835 additional @option{-ftest-coverage} option.  You do not need to profile
4836 every source file in a program.
4837
4838 @item
4839 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4840 (the latter implies the former).
4841
4842 @item
4843 Run the program on a representative workload to generate the arc profile
4844 information.  This may be repeated any number of times.  You can run
4845 concurrent instances of your program, and provided that the file system
4846 supports locking, the data files will be correctly updated.  Also
4847 @code{fork} calls are detected and correctly handled (double counting
4848 will not happen).
4849
4850 @item
4851 For profile-directed optimizations, compile the source files again with
4852 the same optimization and code generation options plus
4853 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4854 Control Optimization}).
4855
4856 @item
4857 For test coverage analysis, use @command{gcov} to produce human readable
4858 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4859 @command{gcov} documentation for further information.
4860
4861 @end itemize
4862
4863 With @option{-fprofile-arcs}, for each function of your program GCC
4864 creates a program flow graph, then finds a spanning tree for the graph.
4865 Only arcs that are not on the spanning tree have to be instrumented: the
4866 compiler adds code to count the number of times that these arcs are
4867 executed.  When an arc is the only exit or only entrance to a block, the
4868 instrumentation code can be added to the block; otherwise, a new basic
4869 block must be created to hold the instrumentation code.
4870
4871 @need 2000
4872 @item -ftest-coverage
4873 @opindex ftest-coverage
4874 Produce a notes file that the @command{gcov} code-coverage utility
4875 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4876 show program coverage.  Each source file's note file is called
4877 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4878 above for a description of @var{auxname} and instructions on how to
4879 generate test coverage data.  Coverage data will match the source files
4880 more closely, if you do not optimize.
4881
4882 @item -fdbg-cnt-list
4883 @opindex fdbg-cnt-list
4884 Print the name and the counter upperbound for all debug counters.
4885
4886 @item -fdbg-cnt=@var{counter-value-list}
4887 @opindex fdbg-cnt
4888 Set the internal debug counter upperbound. @var{counter-value-list}
4889 is a comma-separated list of @var{name}:@var{value} pairs
4890 which sets the upperbound of each debug counter @var{name} to @var{value}.
4891 All debug counters have the initial upperbound of @var{UINT_MAX},
4892 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4893 e.g. With -fdbg-cnt=dce:10,tail_call:0
4894 dbg_cnt(dce) will return true only for first 10 invocations
4895 and dbg_cnt(tail_call) will return false always.
4896
4897 @item -d@var{letters}
4898 @itemx -fdump-rtl-@var{pass}
4899 @opindex d
4900 Says to make debugging dumps during compilation at times specified by
4901 @var{letters}.  This is used for debugging the RTL-based passes of the
4902 compiler.  The file names for most of the dumps are made by appending
4903 a pass number and a word to the @var{dumpname}, and the files are
4904 created in the directory of the output file.  @var{dumpname} is
4905 generated from the name of the output file, if explicitly specified
4906 and it is not an executable, otherwise it is the basename of the
4907 source file. These switches may have different effects when
4908 @option{-E} is used for preprocessing.
4909
4910 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4911 @option{-d} option @var{letters}.  Here are the possible
4912 letters for use in @var{pass} and @var{letters}, and their meanings:
4913
4914 @table @gcctabopt
4915
4916 @item -fdump-rtl-alignments
4917 @opindex fdump-rtl-alignments
4918 Dump after branch alignments have been computed.
4919
4920 @item -fdump-rtl-asmcons
4921 @opindex fdump-rtl-asmcons
4922 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4923
4924 @item -fdump-rtl-auto_inc_dec
4925 @opindex fdump-rtl-auto_inc_dec
4926 Dump after auto-inc-dec discovery.  This pass is only run on
4927 architectures that have auto inc or auto dec instructions.
4928
4929 @item -fdump-rtl-barriers
4930 @opindex fdump-rtl-barriers
4931 Dump after cleaning up the barrier instructions.
4932
4933 @item -fdump-rtl-bbpart
4934 @opindex fdump-rtl-bbpart
4935 Dump after partitioning hot and cold basic blocks.
4936
4937 @item -fdump-rtl-bbro
4938 @opindex fdump-rtl-bbro
4939 Dump after block reordering.
4940
4941 @item -fdump-rtl-btl1
4942 @itemx -fdump-rtl-btl2
4943 @opindex fdump-rtl-btl2
4944 @opindex fdump-rtl-btl2
4945 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4946 after the two branch
4947 target load optimization passes.
4948
4949 @item -fdump-rtl-bypass
4950 @opindex fdump-rtl-bypass
4951 Dump after jump bypassing and control flow optimizations.
4952
4953 @item -fdump-rtl-combine
4954 @opindex fdump-rtl-combine
4955 Dump after the RTL instruction combination pass.
4956
4957 @item -fdump-rtl-compgotos
4958 @opindex fdump-rtl-compgotos
4959 Dump after duplicating the computed gotos.
4960
4961 @item -fdump-rtl-ce1
4962 @itemx -fdump-rtl-ce2
4963 @itemx -fdump-rtl-ce3
4964 @opindex fdump-rtl-ce1
4965 @opindex fdump-rtl-ce2
4966 @opindex fdump-rtl-ce3
4967 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4968 @option{-fdump-rtl-ce3} enable dumping after the three
4969 if conversion passes.
4970
4971 @itemx -fdump-rtl-cprop_hardreg
4972 @opindex fdump-rtl-cprop_hardreg
4973 Dump after hard register copy propagation.
4974
4975 @itemx -fdump-rtl-csa
4976 @opindex fdump-rtl-csa
4977 Dump after combining stack adjustments.
4978
4979 @item -fdump-rtl-cse1
4980 @itemx -fdump-rtl-cse2
4981 @opindex fdump-rtl-cse1
4982 @opindex fdump-rtl-cse2
4983 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4984 the two common sub-expression elimination passes.
4985
4986 @itemx -fdump-rtl-dce
4987 @opindex fdump-rtl-dce
4988 Dump after the standalone dead code elimination passes.
4989
4990 @itemx -fdump-rtl-dbr
4991 @opindex fdump-rtl-dbr
4992 Dump after delayed branch scheduling.
4993
4994 @item -fdump-rtl-dce1
4995 @itemx -fdump-rtl-dce2
4996 @opindex fdump-rtl-dce1
4997 @opindex fdump-rtl-dce2
4998 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4999 the two dead store elimination passes.
5000
5001 @item -fdump-rtl-eh
5002 @opindex fdump-rtl-eh
5003 Dump after finalization of EH handling code.
5004
5005 @item -fdump-rtl-eh_ranges
5006 @opindex fdump-rtl-eh_ranges
5007 Dump after conversion of EH handling range regions.
5008
5009 @item -fdump-rtl-expand
5010 @opindex fdump-rtl-expand
5011 Dump after RTL generation.
5012
5013 @item -fdump-rtl-fwprop1
5014 @itemx -fdump-rtl-fwprop2
5015 @opindex fdump-rtl-fwprop1
5016 @opindex fdump-rtl-fwprop2
5017 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5018 dumping after the two forward propagation passes.
5019
5020 @item -fdump-rtl-gcse1
5021 @itemx -fdump-rtl-gcse2
5022 @opindex fdump-rtl-gcse1
5023 @opindex fdump-rtl-gcse2
5024 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5025 after global common subexpression elimination.
5026
5027 @item -fdump-rtl-init-regs
5028 @opindex fdump-rtl-init-regs
5029 Dump after the initialization of the registers.
5030
5031 @item -fdump-rtl-initvals
5032 @opindex fdump-rtl-initvals
5033 Dump after the computation of the initial value sets.
5034
5035 @itemx -fdump-rtl-into_cfglayout
5036 @opindex fdump-rtl-into_cfglayout
5037 Dump after converting to cfglayout mode.
5038
5039 @item -fdump-rtl-ira
5040 @opindex fdump-rtl-ira
5041 Dump after iterated register allocation.
5042
5043 @item -fdump-rtl-jump
5044 @opindex fdump-rtl-jump
5045 Dump after the second jump optimization.
5046
5047 @item -fdump-rtl-loop2
5048 @opindex fdump-rtl-loop2
5049 @option{-fdump-rtl-loop2} enables dumping after the rtl
5050 loop optimization passes.
5051
5052 @item -fdump-rtl-mach
5053 @opindex fdump-rtl-mach
5054 Dump after performing the machine dependent reorganization pass, if that
5055 pass exists.
5056
5057 @item -fdump-rtl-mode_sw
5058 @opindex fdump-rtl-mode_sw
5059 Dump after removing redundant mode switches.
5060
5061 @item -fdump-rtl-rnreg
5062 @opindex fdump-rtl-rnreg
5063 Dump after register renumbering.
5064
5065 @itemx -fdump-rtl-outof_cfglayout
5066 @opindex fdump-rtl-outof_cfglayout
5067 Dump after converting from cfglayout mode.
5068
5069 @item -fdump-rtl-peephole2
5070 @opindex fdump-rtl-peephole2
5071 Dump after the peephole pass.
5072
5073 @item -fdump-rtl-postreload
5074 @opindex fdump-rtl-postreload
5075 Dump after post-reload optimizations.
5076
5077 @itemx -fdump-rtl-pro_and_epilogue
5078 @opindex fdump-rtl-pro_and_epilogue
5079 Dump after generating the function pro and epilogues.
5080
5081 @item -fdump-rtl-regmove
5082 @opindex fdump-rtl-regmove
5083 Dump after the register move pass.
5084
5085 @item -fdump-rtl-sched1
5086 @itemx -fdump-rtl-sched2
5087 @opindex fdump-rtl-sched1
5088 @opindex fdump-rtl-sched2
5089 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5090 after the basic block scheduling passes.
5091
5092 @item -fdump-rtl-see
5093 @opindex fdump-rtl-see
5094 Dump after sign extension elimination.
5095
5096 @item -fdump-rtl-seqabstr
5097 @opindex fdump-rtl-seqabstr
5098 Dump after common sequence discovery.
5099
5100 @item -fdump-rtl-shorten
5101 @opindex fdump-rtl-shorten
5102 Dump after shortening branches.
5103
5104 @item -fdump-rtl-sibling
5105 @opindex fdump-rtl-sibling
5106 Dump after sibling call optimizations.
5107
5108 @item -fdump-rtl-split1
5109 @itemx -fdump-rtl-split2
5110 @itemx -fdump-rtl-split3
5111 @itemx -fdump-rtl-split4
5112 @itemx -fdump-rtl-split5
5113 @opindex fdump-rtl-split1
5114 @opindex fdump-rtl-split2
5115 @opindex fdump-rtl-split3
5116 @opindex fdump-rtl-split4
5117 @opindex fdump-rtl-split5
5118 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5119 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5120 @option{-fdump-rtl-split5} enable dumping after five rounds of
5121 instruction splitting.
5122
5123 @item -fdump-rtl-sms
5124 @opindex fdump-rtl-sms
5125 Dump after modulo scheduling.  This pass is only run on some
5126 architectures.
5127
5128 @item -fdump-rtl-stack
5129 @opindex fdump-rtl-stack
5130 Dump after conversion from GCC's "flat register file" registers to the
5131 x87's stack-like registers.  This pass is only run on x86 variants.
5132
5133 @item -fdump-rtl-subreg1
5134 @itemx -fdump-rtl-subreg2
5135 @opindex fdump-rtl-subreg1
5136 @opindex fdump-rtl-subreg2
5137 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5138 the two subreg expansion passes.
5139
5140 @item -fdump-rtl-unshare
5141 @opindex fdump-rtl-unshare
5142 Dump after all rtl has been unshared.
5143
5144 @item -fdump-rtl-vartrack
5145 @opindex fdump-rtl-vartrack
5146 Dump after variable tracking.
5147
5148 @item -fdump-rtl-vregs
5149 @opindex fdump-rtl-vregs
5150 Dump after converting virtual registers to hard registers.
5151
5152 @item -fdump-rtl-web
5153 @opindex fdump-rtl-web
5154 Dump after live range splitting.
5155
5156 @item -fdump-rtl-regclass
5157 @itemx -fdump-rtl-subregs_of_mode_init
5158 @itemx -fdump-rtl-subregs_of_mode_finish
5159 @itemx -fdump-rtl-dfinit
5160 @itemx -fdump-rtl-dfinish
5161 @opindex fdump-rtl-regclass
5162 @opindex fdump-rtl-subregs_of_mode_init
5163 @opindex fdump-rtl-subregs_of_mode_finish
5164 @opindex fdump-rtl-dfinit
5165 @opindex fdump-rtl-dfinish
5166 These dumps are defined but always produce empty files.
5167
5168 @item -fdump-rtl-all
5169 @opindex fdump-rtl-all
5170 Produce all the dumps listed above.
5171
5172 @item -dA
5173 @opindex dA
5174 Annotate the assembler output with miscellaneous debugging information.
5175
5176 @item -dD
5177 @opindex dD
5178 Dump all macro definitions, at the end of preprocessing, in addition to
5179 normal output.
5180
5181 @item -dH
5182 @opindex dH
5183 Produce a core dump whenever an error occurs.
5184
5185 @item -dm
5186 @opindex dm
5187 Print statistics on memory usage, at the end of the run, to
5188 standard error.
5189
5190 @item -dp
5191 @opindex dp
5192 Annotate the assembler output with a comment indicating which
5193 pattern and alternative was used.  The length of each instruction is
5194 also printed.
5195
5196 @item -dP
5197 @opindex dP
5198 Dump the RTL in the assembler output as a comment before each instruction.
5199 Also turns on @option{-dp} annotation.
5200
5201 @item -dv
5202 @opindex dv
5203 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5204 dump a representation of the control flow graph suitable for viewing with VCG
5205 to @file{@var{file}.@var{pass}.vcg}.
5206
5207 @item -dx
5208 @opindex dx
5209 Just generate RTL for a function instead of compiling it.  Usually used
5210 with @option{-fdump-rtl-expand}.
5211
5212 @item -dy
5213 @opindex dy
5214 Dump debugging information during parsing, to standard error.
5215 @end table
5216
5217 @item -fdump-noaddr
5218 @opindex fdump-noaddr
5219 When doing debugging dumps, suppress address output.  This makes it more
5220 feasible to use diff on debugging dumps for compiler invocations with
5221 different compiler binaries and/or different
5222 text / bss / data / heap / stack / dso start locations.
5223
5224 @item -fdump-unnumbered
5225 @opindex fdump-unnumbered
5226 When doing debugging dumps, suppress instruction numbers and address output.
5227 This makes it more feasible to use diff on debugging dumps for compiler
5228 invocations with different options, in particular with and without
5229 @option{-g}.
5230
5231 @item -fdump-unnumbered-links
5232 @opindex fdump-unnumbered-links
5233 When doing debugging dumps (see @option{-d} option above), suppress
5234 instruction numbers for the links to the previous and next instructions
5235 in a sequence.
5236
5237 @item -fdump-translation-unit @r{(C++ only)}
5238 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5239 @opindex fdump-translation-unit
5240 Dump a representation of the tree structure for the entire translation
5241 unit to a file.  The file name is made by appending @file{.tu} to the
5242 source file name, and the file is created in the same directory as the
5243 output file.  If the @samp{-@var{options}} form is used, @var{options}
5244 controls the details of the dump as described for the
5245 @option{-fdump-tree} options.
5246
5247 @item -fdump-class-hierarchy @r{(C++ only)}
5248 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5249 @opindex fdump-class-hierarchy
5250 Dump a representation of each class's hierarchy and virtual function
5251 table layout to a file.  The file name is made by appending
5252 @file{.class} to the source file name, and the file is created in the
5253 same directory as the output file.  If the @samp{-@var{options}} form
5254 is used, @var{options} controls the details of the dump as described
5255 for the @option{-fdump-tree} options.
5256
5257 @item -fdump-ipa-@var{switch}
5258 @opindex fdump-ipa
5259 Control the dumping at various stages of inter-procedural analysis
5260 language tree to a file.  The file name is generated by appending a
5261 switch specific suffix to the source file name, and the file is created
5262 in the same directory as the output file.  The following dumps are
5263 possible:
5264
5265 @table @samp
5266 @item all
5267 Enables all inter-procedural analysis dumps.
5268
5269 @item cgraph
5270 Dumps information about call-graph optimization, unused function removal,
5271 and inlining decisions.
5272
5273 @item inline
5274 Dump after function inlining.
5275
5276 @end table
5277
5278 @item -fdump-statistics-@var{option}
5279 @opindex fdump-statistics
5280 Enable and control dumping of pass statistics in a separate file.  The
5281 file name is generated by appending a suffix ending in
5282 @samp{.statistics} to the source file name, and the file is created in
5283 the same directory as the output file.  If the @samp{-@var{option}}
5284 form is used, @samp{-stats} will cause counters to be summed over the
5285 whole compilation unit while @samp{-details} will dump every event as
5286 the passes generate them.  The default with no option is to sum
5287 counters for each function compiled.
5288
5289 @item -fdump-tree-@var{switch}
5290 @itemx -fdump-tree-@var{switch}-@var{options}
5291 @opindex fdump-tree
5292 Control the dumping at various stages of processing the intermediate
5293 language tree to a file.  The file name is generated by appending a
5294 switch specific suffix to the source file name, and the file is
5295 created in the same directory as the output file.  If the
5296 @samp{-@var{options}} form is used, @var{options} is a list of
5297 @samp{-} separated options that control the details of the dump.  Not
5298 all options are applicable to all dumps, those which are not
5299 meaningful will be ignored.  The following options are available
5300
5301 @table @samp
5302 @item address
5303 Print the address of each node.  Usually this is not meaningful as it
5304 changes according to the environment and source file.  Its primary use
5305 is for tying up a dump file with a debug environment.
5306 @item asmname
5307 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5308 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5309 use working backward from mangled names in the assembly file.
5310 @item slim
5311 Inhibit dumping of members of a scope or body of a function merely
5312 because that scope has been reached.  Only dump such items when they
5313 are directly reachable by some other path.  When dumping pretty-printed
5314 trees, this option inhibits dumping the bodies of control structures.
5315 @item raw
5316 Print a raw representation of the tree.  By default, trees are
5317 pretty-printed into a C-like representation.
5318 @item details
5319 Enable more detailed dumps (not honored by every dump option).
5320 @item stats
5321 Enable dumping various statistics about the pass (not honored by every dump
5322 option).
5323 @item blocks
5324 Enable showing basic block boundaries (disabled in raw dumps).
5325 @item vops
5326 Enable showing virtual operands for every statement.
5327 @item lineno
5328 Enable showing line numbers for statements.
5329 @item uid
5330 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5331 @item verbose
5332 Enable showing the tree dump for each statement.
5333 @item eh
5334 Enable showing the EH region number holding each statement.
5335 @item all
5336 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5337 and @option{lineno}.
5338 @end table
5339
5340 The following tree dumps are possible:
5341 @table @samp
5342
5343 @item original
5344 @opindex fdump-tree-original
5345 Dump before any tree based optimization, to @file{@var{file}.original}.
5346
5347 @item optimized
5348 @opindex fdump-tree-optimized
5349 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5350
5351 @item gimple
5352 @opindex fdump-tree-gimple
5353 Dump each function before and after the gimplification pass to a file.  The
5354 file name is made by appending @file{.gimple} to the source file name.
5355
5356 @item cfg
5357 @opindex fdump-tree-cfg
5358 Dump the control flow graph of each function to a file.  The file name is
5359 made by appending @file{.cfg} to the source file name.
5360
5361 @item vcg
5362 @opindex fdump-tree-vcg
5363 Dump the control flow graph of each function to a file in VCG format.  The
5364 file name is made by appending @file{.vcg} to the source file name.  Note
5365 that if the file contains more than one function, the generated file cannot
5366 be used directly by VCG@.  You will need to cut and paste each function's
5367 graph into its own separate file first.
5368
5369 @item ch
5370 @opindex fdump-tree-ch
5371 Dump each function after copying loop headers.  The file name is made by
5372 appending @file{.ch} to the source file name.
5373
5374 @item ssa
5375 @opindex fdump-tree-ssa
5376 Dump SSA related information to a file.  The file name is made by appending
5377 @file{.ssa} to the source file name.
5378
5379 @item alias
5380 @opindex fdump-tree-alias
5381 Dump aliasing information for each function.  The file name is made by
5382 appending @file{.alias} to the source file name.
5383
5384 @item ccp
5385 @opindex fdump-tree-ccp
5386 Dump each function after CCP@.  The file name is made by appending
5387 @file{.ccp} to the source file name.
5388
5389 @item storeccp
5390 @opindex fdump-tree-storeccp
5391 Dump each function after STORE-CCP@.  The file name is made by appending
5392 @file{.storeccp} to the source file name.
5393
5394 @item pre
5395 @opindex fdump-tree-pre
5396 Dump trees after partial redundancy elimination.  The file name is made
5397 by appending @file{.pre} to the source file name.
5398
5399 @item fre
5400 @opindex fdump-tree-fre
5401 Dump trees after full redundancy elimination.  The file name is made
5402 by appending @file{.fre} to the source file name.
5403
5404 @item copyprop
5405 @opindex fdump-tree-copyprop
5406 Dump trees after copy propagation.  The file name is made
5407 by appending @file{.copyprop} to the source file name.
5408
5409 @item store_copyprop
5410 @opindex fdump-tree-store_copyprop
5411 Dump trees after store copy-propagation.  The file name is made
5412 by appending @file{.store_copyprop} to the source file name.
5413
5414 @item dce
5415 @opindex fdump-tree-dce
5416 Dump each function after dead code elimination.  The file name is made by
5417 appending @file{.dce} to the source file name.
5418
5419 @item mudflap
5420 @opindex fdump-tree-mudflap
5421 Dump each function after adding mudflap instrumentation.  The file name is
5422 made by appending @file{.mudflap} to the source file name.
5423
5424 @item sra
5425 @opindex fdump-tree-sra
5426 Dump each function after performing scalar replacement of aggregates.  The
5427 file name is made by appending @file{.sra} to the source file name.
5428
5429 @item sink
5430 @opindex fdump-tree-sink
5431 Dump each function after performing code sinking.  The file name is made
5432 by appending @file{.sink} to the source file name.
5433
5434 @item dom
5435 @opindex fdump-tree-dom
5436 Dump each function after applying dominator tree optimizations.  The file
5437 name is made by appending @file{.dom} to the source file name.
5438
5439 @item dse
5440 @opindex fdump-tree-dse
5441 Dump each function after applying dead store elimination.  The file
5442 name is made by appending @file{.dse} to the source file name.
5443
5444 @item phiopt
5445 @opindex fdump-tree-phiopt
5446 Dump each function after optimizing PHI nodes into straightline code.  The file
5447 name is made by appending @file{.phiopt} to the source file name.
5448
5449 @item forwprop
5450 @opindex fdump-tree-forwprop
5451 Dump each function after forward propagating single use variables.  The file
5452 name is made by appending @file{.forwprop} to the source file name.
5453
5454 @item copyrename
5455 @opindex fdump-tree-copyrename
5456 Dump each function after applying the copy rename optimization.  The file
5457 name is made by appending @file{.copyrename} to the source file name.
5458
5459 @item nrv
5460 @opindex fdump-tree-nrv
5461 Dump each function after applying the named return value optimization on
5462 generic trees.  The file name is made by appending @file{.nrv} to the source
5463 file name.
5464
5465 @item vect
5466 @opindex fdump-tree-vect
5467 Dump each function after applying vectorization of loops.  The file name is
5468 made by appending @file{.vect} to the source file name.
5469
5470 @item slp
5471 @opindex fdump-tree-slp
5472 Dump each function after applying vectorization of basic blocks.  The file name
5473 is made by appending @file{.slp} to the source file name.
5474
5475 @item vrp
5476 @opindex fdump-tree-vrp
5477 Dump each function after Value Range Propagation (VRP).  The file name
5478 is made by appending @file{.vrp} to the source file name.
5479
5480 @item all
5481 @opindex fdump-tree-all
5482 Enable all the available tree dumps with the flags provided in this option.
5483 @end table
5484
5485 @item -ftree-vectorizer-verbose=@var{n}
5486 @opindex ftree-vectorizer-verbose
5487 This option controls the amount of debugging output the vectorizer prints.
5488 This information is written to standard error, unless
5489 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5490 in which case it is output to the usual dump listing file, @file{.vect}.
5491 For @var{n}=0 no diagnostic information is reported.
5492 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5493 and the total number of loops that got vectorized.
5494 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5495 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5496 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5497 level that @option{-fdump-tree-vect-stats} uses.
5498 Higher verbosity levels mean either more information dumped for each
5499 reported loop, or same amount of information reported for more loops:
5500 if @var{n}=3, vectorizer cost model information is reported.
5501 If @var{n}=4, alignment related information is added to the reports.
5502 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5503 memory access-patterns) is added to the reports.
5504 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5505 that did not pass the first analysis phase (i.e., may not be countable, or
5506 may have complicated control-flow).
5507 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5508 If @var{n}=8, SLP related information is added to the reports.
5509 For @var{n}=9, all the information the vectorizer generates during its
5510 analysis and transformation is reported.  This is the same verbosity level
5511 that @option{-fdump-tree-vect-details} uses.
5512
5513 @item -frandom-seed=@var{string}
5514 @opindex frandom-seed
5515 This option provides a seed that GCC uses when it would otherwise use
5516 random numbers.  It is used to generate certain symbol names
5517 that have to be different in every compiled file.  It is also used to
5518 place unique stamps in coverage data files and the object files that
5519 produce them.  You can use the @option{-frandom-seed} option to produce
5520 reproducibly identical object files.
5521
5522 The @var{string} should be different for every file you compile.
5523
5524 @item -fsched-verbose=@var{n}
5525 @opindex fsched-verbose
5526 On targets that use instruction scheduling, this option controls the
5527 amount of debugging output the scheduler prints.  This information is
5528 written to standard error, unless @option{-fdump-rtl-sched1} or
5529 @option{-fdump-rtl-sched2} is specified, in which case it is output
5530 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5531 respectively.  However for @var{n} greater than nine, the output is
5532 always printed to standard error.
5533
5534 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5535 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5536 For @var{n} greater than one, it also output basic block probabilities,
5537 detailed ready list information and unit/insn info.  For @var{n} greater
5538 than two, it includes RTL at abort point, control-flow and regions info.
5539 And for @var{n} over four, @option{-fsched-verbose} also includes
5540 dependence info.
5541
5542 @item -save-temps
5543 @itemx -save-temps=cwd
5544 @opindex save-temps
5545 Store the usual ``temporary'' intermediate files permanently; place them
5546 in the current directory and name them based on the source file.  Thus,
5547 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5548 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5549 preprocessed @file{foo.i} output file even though the compiler now
5550 normally uses an integrated preprocessor.
5551
5552 When used in combination with the @option{-x} command line option,
5553 @option{-save-temps} is sensible enough to avoid over writing an
5554 input source file with the same extension as an intermediate file.
5555 The corresponding intermediate file may be obtained by renaming the
5556 source file before using @option{-save-temps}.
5557
5558 If you invoke GCC in parallel, compiling several different source
5559 files that share a common base name in different subdirectories or the
5560 same source file compiled for multiple output destinations, it is
5561 likely that the different parallel compilers will interfere with each
5562 other, and overwrite the temporary files.  For instance:
5563
5564 @smallexample
5565 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5566 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5567 @end smallexample
5568
5569 may result in @file{foo.i} and @file{foo.o} being written to
5570 simultaneously by both compilers.
5571
5572 @item -save-temps=obj
5573 @opindex save-temps=obj
5574 Store the usual ``temporary'' intermediate files permanently.  If the
5575 @option{-o} option is used, the temporary files are based on the
5576 object file.  If the @option{-o} option is not used, the
5577 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5578
5579 For example:
5580
5581 @smallexample
5582 gcc -save-temps=obj -c foo.c
5583 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5584 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5585 @end smallexample
5586
5587 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5588 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5589 @file{dir2/yfoobar.o}.
5590
5591 @item -time@r{[}=@var{file}@r{]}
5592 @opindex time
5593 Report the CPU time taken by each subprocess in the compilation
5594 sequence.  For C source files, this is the compiler proper and assembler
5595 (plus the linker if linking is done).
5596
5597 Without the specification of an output file, the output looks like this:
5598
5599 @smallexample
5600 # cc1 0.12 0.01
5601 # as 0.00 0.01
5602 @end smallexample
5603
5604 The first number on each line is the ``user time'', that is time spent
5605 executing the program itself.  The second number is ``system time'',
5606 time spent executing operating system routines on behalf of the program.
5607 Both numbers are in seconds.
5608
5609 With the specification of an output file, the output is appended to the
5610 named file, and it looks like this:
5611
5612 @smallexample
5613 0.12 0.01 cc1 @var{options}
5614 0.00 0.01 as @var{options}
5615 @end smallexample
5616
5617 The ``user time'' and the ``system time'' are moved before the program
5618 name, and the options passed to the program are displayed, so that one
5619 can later tell what file was being compiled, and with which options.
5620
5621 @item -fvar-tracking
5622 @opindex fvar-tracking
5623 Run variable tracking pass.  It computes where variables are stored at each
5624 position in code.  Better debugging information is then generated
5625 (if the debugging information format supports this information).
5626
5627 It is enabled by default when compiling with optimization (@option{-Os},
5628 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5629 the debug info format supports it.
5630
5631 @item -fvar-tracking-assignments
5632 @opindex fvar-tracking-assignments
5633 @opindex fno-var-tracking-assignments
5634 Annotate assignments to user variables early in the compilation and
5635 attempt to carry the annotations over throughout the compilation all the
5636 way to the end, in an attempt to improve debug information while
5637 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5638
5639 It can be enabled even if var-tracking is disabled, in which case
5640 annotations will be created and maintained, but discarded at the end.
5641
5642 @item -fvar-tracking-assignments-toggle
5643 @opindex fvar-tracking-assignments-toggle
5644 @opindex fno-var-tracking-assignments-toggle
5645 Toggle @option{-fvar-tracking-assignments}, in the same way that
5646 @option{-gtoggle} toggles @option{-g}.
5647
5648 @item -print-file-name=@var{library}
5649 @opindex print-file-name
5650 Print the full absolute name of the library file @var{library} that
5651 would be used when linking---and don't do anything else.  With this
5652 option, GCC does not compile or link anything; it just prints the
5653 file name.
5654
5655 @item -print-multi-directory
5656 @opindex print-multi-directory
5657 Print the directory name corresponding to the multilib selected by any
5658 other switches present in the command line.  This directory is supposed
5659 to exist in @env{GCC_EXEC_PREFIX}.
5660
5661 @item -print-multi-lib
5662 @opindex print-multi-lib
5663 Print the mapping from multilib directory names to compiler switches
5664 that enable them.  The directory name is separated from the switches by
5665 @samp{;}, and each switch starts with an @samp{@@} instead of the
5666 @samp{-}, without spaces between multiple switches.  This is supposed to
5667 ease shell-processing.
5668
5669 @item -print-multi-os-directory
5670 @opindex print-multi-os-directory
5671 Print the path to OS libraries for the selected
5672 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5673 present in the @file{lib} subdirectory and no multilibs are used, this is
5674 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5675 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5676 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5677 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5678
5679 @item -print-prog-name=@var{program}
5680 @opindex print-prog-name
5681 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5682
5683 @item -print-libgcc-file-name
5684 @opindex print-libgcc-file-name
5685 Same as @option{-print-file-name=libgcc.a}.
5686
5687 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5688 but you do want to link with @file{libgcc.a}.  You can do
5689
5690 @smallexample
5691 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5692 @end smallexample
5693
5694 @item -print-search-dirs
5695 @opindex print-search-dirs
5696 Print the name of the configured installation directory and a list of
5697 program and library directories @command{gcc} will search---and don't do anything else.
5698
5699 This is useful when @command{gcc} prints the error message
5700 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5701 To resolve this you either need to put @file{cpp0} and the other compiler
5702 components where @command{gcc} expects to find them, or you can set the environment
5703 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5704 Don't forget the trailing @samp{/}.
5705 @xref{Environment Variables}.
5706
5707 @item -print-sysroot
5708 @opindex print-sysroot
5709 Print the target sysroot directory that will be used during
5710 compilation.  This is the target sysroot specified either at configure
5711 time or using the @option{--sysroot} option, possibly with an extra
5712 suffix that depends on compilation options.  If no target sysroot is
5713 specified, the option prints nothing.
5714
5715 @item -print-sysroot-headers-suffix
5716 @opindex print-sysroot-headers-suffix
5717 Print the suffix added to the target sysroot when searching for
5718 headers, or give an error if the compiler is not configured with such
5719 a suffix---and don't do anything else.
5720
5721 @item -dumpmachine
5722 @opindex dumpmachine
5723 Print the compiler's target machine (for example,
5724 @samp{i686-pc-linux-gnu})---and don't do anything else.
5725
5726 @item -dumpversion
5727 @opindex dumpversion
5728 Print the compiler version (for example, @samp{3.0})---and don't do
5729 anything else.
5730
5731 @item -dumpspecs
5732 @opindex dumpspecs
5733 Print the compiler's built-in specs---and don't do anything else.  (This
5734 is used when GCC itself is being built.)  @xref{Spec Files}.
5735
5736 @item -feliminate-unused-debug-types
5737 @opindex feliminate-unused-debug-types
5738 Normally, when producing DWARF2 output, GCC will emit debugging
5739 information for all types declared in a compilation
5740 unit, regardless of whether or not they are actually used
5741 in that compilation unit.  Sometimes this is useful, such as
5742 if, in the debugger, you want to cast a value to a type that is
5743 not actually used in your program (but is declared).  More often,
5744 however, this results in a significant amount of wasted space.
5745 With this option, GCC will avoid producing debug symbol output
5746 for types that are nowhere used in the source file being compiled.
5747 @end table
5748
5749 @node Optimize Options
5750 @section Options That Control Optimization
5751 @cindex optimize options
5752 @cindex options, optimization
5753
5754 These options control various sorts of optimizations.
5755
5756 Without any optimization option, the compiler's goal is to reduce the
5757 cost of compilation and to make debugging produce the expected
5758 results.  Statements are independent: if you stop the program with a
5759 breakpoint between statements, you can then assign a new value to any
5760 variable or change the program counter to any other statement in the
5761 function and get exactly the results you would expect from the source
5762 code.
5763
5764 Turning on optimization flags makes the compiler attempt to improve
5765 the performance and/or code size at the expense of compilation time
5766 and possibly the ability to debug the program.
5767
5768 The compiler performs optimization based on the knowledge it has of the
5769 program.  Compiling multiple files at once to a single output file mode allows
5770 the compiler to use information gained from all of the files when compiling
5771 each of them.
5772
5773 Not all optimizations are controlled directly by a flag.  Only
5774 optimizations that have a flag are listed in this section.
5775
5776 Most optimizations are only enabled if an @option{-O} level is set on
5777 the command line.  Otherwise they are disabled, even if individual             
5778 optimization flags are specified.
5779
5780 Depending on the target and how GCC was configured, a slightly different
5781 set of optimizations may be enabled at each @option{-O} level than
5782 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5783 to find out the exact set of optimizations that are enabled at each level.
5784 @xref{Overall Options}, for examples.
5785
5786 @table @gcctabopt
5787 @item -O
5788 @itemx -O1
5789 @opindex O
5790 @opindex O1
5791 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5792 more memory for a large function.
5793
5794 With @option{-O}, the compiler tries to reduce code size and execution
5795 time, without performing any optimizations that take a great deal of
5796 compilation time.
5797
5798 @option{-O} turns on the following optimization flags:
5799 @gccoptlist{
5800 -fauto-inc-dec @gol
5801 -fcprop-registers @gol
5802 -fdce @gol
5803 -fdefer-pop @gol
5804 -fdelayed-branch @gol
5805 -fdse @gol
5806 -fguess-branch-probability @gol
5807 -fif-conversion2 @gol
5808 -fif-conversion @gol
5809 -fipa-pure-const @gol
5810 -fipa-profile @gol
5811 -fipa-reference @gol
5812 -fmerge-constants
5813 -fsplit-wide-types @gol
5814 -ftree-builtin-call-dce @gol
5815 -ftree-ccp @gol
5816 -ftree-ch @gol
5817 -ftree-copyrename @gol
5818 -ftree-dce @gol
5819 -ftree-dominator-opts @gol
5820 -ftree-dse @gol
5821 -ftree-forwprop @gol
5822 -ftree-fre @gol
5823 -ftree-phiprop @gol
5824 -ftree-sra @gol
5825 -ftree-pta @gol
5826 -ftree-ter @gol
5827 -funit-at-a-time}
5828
5829 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5830 where doing so does not interfere with debugging.
5831
5832 @item -O2
5833 @opindex O2
5834 Optimize even more.  GCC performs nearly all supported optimizations
5835 that do not involve a space-speed tradeoff.
5836 As compared to @option{-O}, this option increases both compilation time
5837 and the performance of the generated code.
5838
5839 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5840 also turns on the following optimization flags:
5841 @gccoptlist{-fthread-jumps @gol
5842 -falign-functions  -falign-jumps @gol
5843 -falign-loops  -falign-labels @gol
5844 -fcaller-saves @gol
5845 -fcrossjumping @gol
5846 -fcse-follow-jumps  -fcse-skip-blocks @gol
5847 -fdelete-null-pointer-checks @gol
5848 -fexpensive-optimizations @gol
5849 -fgcse  -fgcse-lm  @gol
5850 -finline-small-functions @gol
5851 -findirect-inlining @gol
5852 -fipa-sra @gol
5853 -foptimize-sibling-calls @gol
5854 -fpeephole2 @gol
5855 -fregmove @gol
5856 -freorder-blocks  -freorder-functions @gol
5857 -frerun-cse-after-loop  @gol
5858 -fsched-interblock  -fsched-spec @gol
5859 -fschedule-insns  -fschedule-insns2 @gol
5860 -fstrict-aliasing -fstrict-overflow @gol
5861 -ftree-switch-conversion @gol
5862 -ftree-pre @gol
5863 -ftree-vrp}
5864
5865 Please note the warning under @option{-fgcse} about
5866 invoking @option{-O2} on programs that use computed gotos.
5867
5868 @item -O3
5869 @opindex O3
5870 Optimize yet more.  @option{-O3} turns on all optimizations specified
5871 by @option{-O2} and also turns on the @option{-finline-functions},
5872 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5873 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5874
5875 @item -O0
5876 @opindex O0
5877 Reduce compilation time and make debugging produce the expected
5878 results.  This is the default.
5879
5880 @item -Os
5881 @opindex Os
5882 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5883 do not typically increase code size.  It also performs further
5884 optimizations designed to reduce code size.
5885
5886 @option{-Os} disables the following optimization flags:
5887 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5888 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5889 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5890
5891 If you use multiple @option{-O} options, with or without level numbers,
5892 the last such option is the one that is effective.
5893 @end table
5894
5895 Options of the form @option{-f@var{flag}} specify machine-independent
5896 flags.  Most flags have both positive and negative forms; the negative
5897 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5898 below, only one of the forms is listed---the one you typically will
5899 use.  You can figure out the other form by either removing @samp{no-}
5900 or adding it.
5901
5902 The following options control specific optimizations.  They are either
5903 activated by @option{-O} options or are related to ones that are.  You
5904 can use the following flags in the rare cases when ``fine-tuning'' of
5905 optimizations to be performed is desired.
5906
5907 @table @gcctabopt
5908 @item -fno-default-inline
5909 @opindex fno-default-inline
5910 Do not make member functions inline by default merely because they are
5911 defined inside the class scope (C++ only).  Otherwise, when you specify
5912 @w{@option{-O}}, member functions defined inside class scope are compiled
5913 inline by default; i.e., you don't need to add @samp{inline} in front of
5914 the member function name.
5915
5916 @item -fno-defer-pop
5917 @opindex fno-defer-pop
5918 Always pop the arguments to each function call as soon as that function
5919 returns.  For machines which must pop arguments after a function call,
5920 the compiler normally lets arguments accumulate on the stack for several
5921 function calls and pops them all at once.
5922
5923 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5924
5925 @item -fforward-propagate
5926 @opindex fforward-propagate
5927 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5928 instructions and checks if the result can be simplified.  If loop unrolling
5929 is active, two passes are performed and the second is scheduled after
5930 loop unrolling.
5931
5932 This option is enabled by default at optimization levels @option{-O},
5933 @option{-O2}, @option{-O3}, @option{-Os}.
5934
5935 @item -fomit-frame-pointer
5936 @opindex fomit-frame-pointer
5937 Don't keep the frame pointer in a register for functions that
5938 don't need one.  This avoids the instructions to save, set up and
5939 restore frame pointers; it also makes an extra register available
5940 in many functions.  @strong{It also makes debugging impossible on
5941 some machines.}
5942
5943 On some machines, such as the VAX, this flag has no effect, because
5944 the standard calling sequence automatically handles the frame pointer
5945 and nothing is saved by pretending it doesn't exist.  The
5946 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5947 whether a target machine supports this flag.  @xref{Registers,,Register
5948 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5949
5950 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5951
5952 @item -foptimize-sibling-calls
5953 @opindex foptimize-sibling-calls
5954 Optimize sibling and tail recursive calls.
5955
5956 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5957
5958 @item -fno-inline
5959 @opindex fno-inline
5960 Don't pay attention to the @code{inline} keyword.  Normally this option
5961 is used to keep the compiler from expanding any functions inline.
5962 Note that if you are not optimizing, no functions can be expanded inline.
5963
5964 @item -finline-small-functions
5965 @opindex finline-small-functions
5966 Integrate functions into their callers when their body is smaller than expected
5967 function call code (so overall size of program gets smaller).  The compiler
5968 heuristically decides which functions are simple enough to be worth integrating
5969 in this way.
5970
5971 Enabled at level @option{-O2}.
5972
5973 @item -findirect-inlining
5974 @opindex findirect-inlining
5975 Inline also indirect calls that are discovered to be known at compile
5976 time thanks to previous inlining.  This option has any effect only
5977 when inlining itself is turned on by the @option{-finline-functions}
5978 or @option{-finline-small-functions} options.
5979
5980 Enabled at level @option{-O2}.
5981
5982 @item -finline-functions
5983 @opindex finline-functions
5984 Integrate all simple functions into their callers.  The compiler
5985 heuristically decides which functions are simple enough to be worth
5986 integrating in this way.
5987
5988 If all calls to a given function are integrated, and the function is
5989 declared @code{static}, then the function is normally not output as
5990 assembler code in its own right.
5991
5992 Enabled at level @option{-O3}.
5993
5994 @item -finline-functions-called-once
5995 @opindex finline-functions-called-once
5996 Consider all @code{static} functions called once for inlining into their
5997 caller even if they are not marked @code{inline}.  If a call to a given
5998 function is integrated, then the function is not output as assembler code
5999 in its own right.
6000
6001 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
6002
6003 @item -fearly-inlining
6004 @opindex fearly-inlining
6005 Inline functions marked by @code{always_inline} and functions whose body seems
6006 smaller than the function call overhead early before doing
6007 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
6008 makes profiling significantly cheaper and usually inlining faster on programs
6009 having large chains of nested wrapper functions.
6010
6011 Enabled by default.
6012
6013 @item -fipa-sra
6014 @opindex fipa-sra
6015 Perform interprocedural scalar replacement of aggregates, removal of
6016 unused parameters and replacement of parameters passed by reference
6017 by parameters passed by value.
6018
6019 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
6020
6021 @item -finline-limit=@var{n}
6022 @opindex finline-limit
6023 By default, GCC limits the size of functions that can be inlined.  This flag
6024 allows coarse control of this limit.  @var{n} is the size of functions that
6025 can be inlined in number of pseudo instructions.
6026
6027 Inlining is actually controlled by a number of parameters, which may be
6028 specified individually by using @option{--param @var{name}=@var{value}}.
6029 The @option{-finline-limit=@var{n}} option sets some of these parameters
6030 as follows:
6031
6032 @table @gcctabopt
6033 @item max-inline-insns-single
6034 is set to @var{n}/2.
6035 @item max-inline-insns-auto
6036 is set to @var{n}/2.
6037 @end table
6038
6039 See below for a documentation of the individual
6040 parameters controlling inlining and for the defaults of these parameters.
6041
6042 @emph{Note:} there may be no value to @option{-finline-limit} that results
6043 in default behavior.
6044
6045 @emph{Note:} pseudo instruction represents, in this particular context, an
6046 abstract measurement of function's size.  In no way does it represent a count
6047 of assembly instructions and as such its exact meaning might change from one
6048 release to an another.
6049
6050 @item -fkeep-inline-functions
6051 @opindex fkeep-inline-functions
6052 In C, emit @code{static} functions that are declared @code{inline}
6053 into the object file, even if the function has been inlined into all
6054 of its callers.  This switch does not affect functions using the
6055 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
6056 inline functions into the object file.
6057
6058 @item -fkeep-static-consts
6059 @opindex fkeep-static-consts
6060 Emit variables declared @code{static const} when optimization isn't turned
6061 on, even if the variables aren't referenced.
6062
6063 GCC enables this option by default.  If you want to force the compiler to
6064 check if the variable was referenced, regardless of whether or not
6065 optimization is turned on, use the @option{-fno-keep-static-consts} option.
6066
6067 @item -fmerge-constants
6068 @opindex fmerge-constants
6069 Attempt to merge identical constants (string constants and floating point
6070 constants) across compilation units.
6071
6072 This option is the default for optimized compilation if the assembler and
6073 linker support it.  Use @option{-fno-merge-constants} to inhibit this
6074 behavior.
6075
6076 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6077
6078 @item -fmerge-all-constants
6079 @opindex fmerge-all-constants
6080 Attempt to merge identical constants and identical variables.
6081
6082 This option implies @option{-fmerge-constants}.  In addition to
6083 @option{-fmerge-constants} this considers e.g.@: even constant initialized
6084 arrays or initialized constant variables with integral or floating point
6085 types.  Languages like C or C++ require each variable, including multiple
6086 instances of the same variable in recursive calls, to have distinct locations,
6087 so using this option will result in non-conforming
6088 behavior.
6089
6090 @item -fmodulo-sched
6091 @opindex fmodulo-sched
6092 Perform swing modulo scheduling immediately before the first scheduling
6093 pass.  This pass looks at innermost loops and reorders their
6094 instructions by overlapping different iterations.
6095
6096 @item -fmodulo-sched-allow-regmoves
6097 @opindex fmodulo-sched-allow-regmoves
6098 Perform more aggressive SMS based modulo scheduling with register moves
6099 allowed.  By setting this flag certain anti-dependences edges will be
6100 deleted which will trigger the generation of reg-moves based on the
6101 life-range analysis.  This option is effective only with
6102 @option{-fmodulo-sched} enabled.
6103
6104 @item -fno-branch-count-reg
6105 @opindex fno-branch-count-reg
6106 Do not use ``decrement and branch'' instructions on a count register,
6107 but instead generate a sequence of instructions that decrement a
6108 register, compare it against zero, then branch based upon the result.
6109 This option is only meaningful on architectures that support such
6110 instructions, which include x86, PowerPC, IA-64 and S/390.
6111
6112 The default is @option{-fbranch-count-reg}.
6113
6114 @item -fno-function-cse
6115 @opindex fno-function-cse
6116 Do not put function addresses in registers; make each instruction that
6117 calls a constant function contain the function's address explicitly.
6118
6119 This option results in less efficient code, but some strange hacks
6120 that alter the assembler output may be confused by the optimizations
6121 performed when this option is not used.
6122
6123 The default is @option{-ffunction-cse}
6124
6125 @item -fno-zero-initialized-in-bss
6126 @opindex fno-zero-initialized-in-bss
6127 If the target supports a BSS section, GCC by default puts variables that
6128 are initialized to zero into BSS@.  This can save space in the resulting
6129 code.
6130
6131 This option turns off this behavior because some programs explicitly
6132 rely on variables going to the data section.  E.g., so that the
6133 resulting executable can find the beginning of that section and/or make
6134 assumptions based on that.
6135
6136 The default is @option{-fzero-initialized-in-bss}.
6137
6138 @item -fmudflap -fmudflapth -fmudflapir
6139 @opindex fmudflap
6140 @opindex fmudflapth
6141 @opindex fmudflapir
6142 @cindex bounds checking
6143 @cindex mudflap
6144 For front-ends that support it (C and C++), instrument all risky
6145 pointer/array dereferencing operations, some standard library
6146 string/heap functions, and some other associated constructs with
6147 range/validity tests.  Modules so instrumented should be immune to
6148 buffer overflows, invalid heap use, and some other classes of C/C++
6149 programming errors.  The instrumentation relies on a separate runtime
6150 library (@file{libmudflap}), which will be linked into a program if
6151 @option{-fmudflap} is given at link time.  Run-time behavior of the
6152 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6153 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6154 for its options.
6155
6156 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6157 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6158 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6159 instrumentation should ignore pointer reads.  This produces less
6160 instrumentation (and therefore faster execution) and still provides
6161 some protection against outright memory corrupting writes, but allows
6162 erroneously read data to propagate within a program.
6163
6164 @item -fthread-jumps
6165 @opindex fthread-jumps
6166 Perform optimizations where we check to see if a jump branches to a
6167 location where another comparison subsumed by the first is found.  If
6168 so, the first branch is redirected to either the destination of the
6169 second branch or a point immediately following it, depending on whether
6170 the condition is known to be true or false.
6171
6172 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6173
6174 @item -fsplit-wide-types
6175 @opindex fsplit-wide-types
6176 When using a type that occupies multiple registers, such as @code{long
6177 long} on a 32-bit system, split the registers apart and allocate them
6178 independently.  This normally generates better code for those types,
6179 but may make debugging more difficult.
6180
6181 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6182 @option{-Os}.
6183
6184 @item -fcse-follow-jumps
6185 @opindex fcse-follow-jumps
6186 In common subexpression elimination (CSE), scan through jump instructions
6187 when the target of the jump is not reached by any other path.  For
6188 example, when CSE encounters an @code{if} statement with an
6189 @code{else} clause, CSE will follow the jump when the condition
6190 tested is false.
6191
6192 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6193
6194 @item -fcse-skip-blocks
6195 @opindex fcse-skip-blocks
6196 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6197 follow jumps which conditionally skip over blocks.  When CSE
6198 encounters a simple @code{if} statement with no else clause,
6199 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6200 body of the @code{if}.
6201
6202 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6203
6204 @item -frerun-cse-after-loop
6205 @opindex frerun-cse-after-loop
6206 Re-run common subexpression elimination after loop optimizations has been
6207 performed.
6208
6209 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6210
6211 @item -fgcse
6212 @opindex fgcse
6213 Perform a global common subexpression elimination pass.
6214 This pass also performs global constant and copy propagation.
6215
6216 @emph{Note:} When compiling a program using computed gotos, a GCC
6217 extension, you may get better runtime performance if you disable
6218 the global common subexpression elimination pass by adding
6219 @option{-fno-gcse} to the command line.
6220
6221 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6222
6223 @item -fgcse-lm
6224 @opindex fgcse-lm
6225 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6226 attempt to move loads which are only killed by stores into themselves.  This
6227 allows a loop containing a load/store sequence to be changed to a load outside
6228 the loop, and a copy/store within the loop.
6229
6230 Enabled by default when gcse is enabled.
6231
6232 @item -fgcse-sm
6233 @opindex fgcse-sm
6234 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6235 global common subexpression elimination.  This pass will attempt to move
6236 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6237 loops containing a load/store sequence can be changed to a load before
6238 the loop and a store after the loop.
6239
6240 Not enabled at any optimization level.
6241
6242 @item -fgcse-las
6243 @opindex fgcse-las
6244 When @option{-fgcse-las} is enabled, the global common subexpression
6245 elimination pass eliminates redundant loads that come after stores to the
6246 same memory location (both partial and full redundancies).
6247
6248 Not enabled at any optimization level.
6249
6250 @item -fgcse-after-reload
6251 @opindex fgcse-after-reload
6252 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6253 pass is performed after reload.  The purpose of this pass is to cleanup
6254 redundant spilling.
6255
6256 @item -funsafe-loop-optimizations
6257 @opindex funsafe-loop-optimizations
6258 If given, the loop optimizer will assume that loop indices do not
6259 overflow, and that the loops with nontrivial exit condition are not
6260 infinite.  This enables a wider range of loop optimizations even if
6261 the loop optimizer itself cannot prove that these assumptions are valid.
6262 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6263 if it finds this kind of loop.
6264
6265 @item -fcrossjumping
6266 @opindex fcrossjumping
6267 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6268 resulting code may or may not perform better than without cross-jumping.
6269
6270 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6271
6272 @item -fauto-inc-dec
6273 @opindex fauto-inc-dec
6274 Combine increments or decrements of addresses with memory accesses.
6275 This pass is always skipped on architectures that do not have
6276 instructions to support this.  Enabled by default at @option{-O} and
6277 higher on architectures that support this.
6278
6279 @item -fdce
6280 @opindex fdce
6281 Perform dead code elimination (DCE) on RTL@.
6282 Enabled by default at @option{-O} and higher.
6283
6284 @item -fdse
6285 @opindex fdse
6286 Perform dead store elimination (DSE) on RTL@.
6287 Enabled by default at @option{-O} and higher.
6288
6289 @item -fif-conversion
6290 @opindex fif-conversion
6291 Attempt to transform conditional jumps into branch-less equivalents.  This
6292 include use of conditional moves, min, max, set flags and abs instructions, and
6293 some tricks doable by standard arithmetics.  The use of conditional execution
6294 on chips where it is available is controlled by @code{if-conversion2}.
6295
6296 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6297
6298 @item -fif-conversion2
6299 @opindex fif-conversion2
6300 Use conditional execution (where available) to transform conditional jumps into
6301 branch-less equivalents.
6302
6303 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6304
6305 @item -fdelete-null-pointer-checks
6306 @opindex fdelete-null-pointer-checks
6307 Assume that programs cannot safely dereference null pointers, and that
6308 no code or data element resides there.  This enables simple constant
6309 folding optimizations at all optimization levels.  In addition, other
6310 optimization passes in GCC use this flag to control global dataflow
6311 analyses that eliminate useless checks for null pointers; these assume
6312 that if a pointer is checked after it has already been dereferenced,
6313 it cannot be null.
6314
6315 Note however that in some environments this assumption is not true.
6316 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6317 for programs which depend on that behavior.
6318
6319 Some targets, especially embedded ones, disable this option at all levels.
6320 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6321 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6322 are enabled independently at different optimization levels.
6323
6324 @item -fexpensive-optimizations
6325 @opindex fexpensive-optimizations
6326 Perform a number of minor optimizations that are relatively expensive.
6327
6328 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6329
6330 @item -foptimize-register-move
6331 @itemx -fregmove
6332 @opindex foptimize-register-move
6333 @opindex fregmove
6334 Attempt to reassign register numbers in move instructions and as
6335 operands of other simple instructions in order to maximize the amount of
6336 register tying.  This is especially helpful on machines with two-operand
6337 instructions.
6338
6339 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6340 optimization.
6341
6342 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6343
6344 @item -fira-algorithm=@var{algorithm}
6345 Use specified coloring algorithm for the integrated register
6346 allocator.  The @var{algorithm} argument should be @code{priority} or
6347 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6348 the second one specifies Chaitin-Briggs coloring.  The second
6349 algorithm can be unimplemented for some architectures.  If it is
6350 implemented, it is the default because Chaitin-Briggs coloring as a
6351 rule generates a better code.
6352
6353 @item -fira-region=@var{region}
6354 Use specified regions for the integrated register allocator.  The
6355 @var{region} argument should be one of @code{all}, @code{mixed}, or
6356 @code{one}.  The first value means using all loops as register
6357 allocation regions, the second value which is the default means using
6358 all loops except for loops with small register pressure as the
6359 regions, and third one means using all function as a single region.
6360 The first value can give best result for machines with small size and
6361 irregular register set, the third one results in faster and generates
6362 decent code and the smallest size code, and the default value usually
6363 give the best results in most cases and for most architectures.
6364
6365 @item -fira-coalesce
6366 @opindex fira-coalesce
6367 Do optimistic register coalescing.  This option might be profitable for
6368 architectures with big regular register files.
6369
6370 @item -fira-loop-pressure
6371 @opindex fira-loop-pressure
6372 Use IRA to evaluate register pressure in loops for decision to move
6373 loop invariants.  Usage of this option usually results in generation
6374 of faster and smaller code on machines with big register files (>= 32
6375 registers) but it can slow compiler down.
6376
6377 This option is enabled at level @option{-O3} for some targets.
6378
6379 @item -fno-ira-share-save-slots
6380 @opindex fno-ira-share-save-slots
6381 Switch off sharing stack slots used for saving call used hard
6382 registers living through a call.  Each hard register will get a
6383 separate stack slot and as a result function stack frame will be
6384 bigger.
6385
6386 @item -fno-ira-share-spill-slots
6387 @opindex fno-ira-share-spill-slots
6388 Switch off sharing stack slots allocated for pseudo-registers.  Each
6389 pseudo-register which did not get a hard register will get a separate
6390 stack slot and as a result function stack frame will be bigger.
6391
6392 @item -fira-verbose=@var{n}
6393 @opindex fira-verbose
6394 Set up how verbose dump file for the integrated register allocator
6395 will be.  Default value is 5.  If the value is greater or equal to 10,
6396 the dump file will be stderr as if the value were @var{n} minus 10.
6397
6398 @item -fdelayed-branch
6399 @opindex fdelayed-branch
6400 If supported for the target machine, attempt to reorder instructions
6401 to exploit instruction slots available after delayed branch
6402 instructions.
6403
6404 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6405
6406 @item -fschedule-insns
6407 @opindex fschedule-insns
6408 If supported for the target machine, attempt to reorder instructions to
6409 eliminate execution stalls due to required data being unavailable.  This
6410 helps machines that have slow floating point or memory load instructions
6411 by allowing other instructions to be issued until the result of the load
6412 or floating point instruction is required.
6413
6414 Enabled at levels @option{-O2}, @option{-O3}.
6415
6416 @item -fschedule-insns2
6417 @opindex fschedule-insns2
6418 Similar to @option{-fschedule-insns}, but requests an additional pass of
6419 instruction scheduling after register allocation has been done.  This is
6420 especially useful on machines with a relatively small number of
6421 registers and where memory load instructions take more than one cycle.
6422
6423 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6424
6425 @item -fno-sched-interblock
6426 @opindex fno-sched-interblock
6427 Don't schedule instructions across basic blocks.  This is normally
6428 enabled by default when scheduling before register allocation, i.e.@:
6429 with @option{-fschedule-insns} or at @option{-O2} or higher.
6430
6431 @item -fno-sched-spec
6432 @opindex fno-sched-spec
6433 Don't allow speculative motion of non-load instructions.  This is normally
6434 enabled by default when scheduling before register allocation, i.e.@:
6435 with @option{-fschedule-insns} or at @option{-O2} or higher.
6436
6437 @item -fsched-pressure
6438 @opindex fsched-pressure
6439 Enable register pressure sensitive insn scheduling before the register
6440 allocation.  This only makes sense when scheduling before register
6441 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6442 @option{-O2} or higher.  Usage of this option can improve the
6443 generated code and decrease its size by preventing register pressure
6444 increase above the number of available hard registers and as a
6445 consequence register spills in the register allocation.
6446
6447 @item -fsched-spec-load
6448 @opindex fsched-spec-load
6449 Allow speculative motion of some load instructions.  This only makes
6450 sense when scheduling before register allocation, i.e.@: with
6451 @option{-fschedule-insns} or at @option{-O2} or higher.
6452
6453 @item -fsched-spec-load-dangerous
6454 @opindex fsched-spec-load-dangerous
6455 Allow speculative motion of more load instructions.  This only makes
6456 sense when scheduling before register allocation, i.e.@: with
6457 @option{-fschedule-insns} or at @option{-O2} or higher.
6458
6459 @item -fsched-stalled-insns
6460 @itemx -fsched-stalled-insns=@var{n}
6461 @opindex fsched-stalled-insns
6462 Define how many insns (if any) can be moved prematurely from the queue
6463 of stalled insns into the ready list, during the second scheduling pass.
6464 @option{-fno-sched-stalled-insns} means that no insns will be moved
6465 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6466 on how many queued insns can be moved prematurely.
6467 @option{-fsched-stalled-insns} without a value is equivalent to
6468 @option{-fsched-stalled-insns=1}.
6469
6470 @item -fsched-stalled-insns-dep
6471 @itemx -fsched-stalled-insns-dep=@var{n}
6472 @opindex fsched-stalled-insns-dep
6473 Define how many insn groups (cycles) will be examined for a dependency
6474 on a stalled insn that is candidate for premature removal from the queue
6475 of stalled insns.  This has an effect only during the second scheduling pass,
6476 and only if @option{-fsched-stalled-insns} is used.
6477 @option{-fno-sched-stalled-insns-dep} is equivalent to
6478 @option{-fsched-stalled-insns-dep=0}.
6479 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6480 @option{-fsched-stalled-insns-dep=1}.
6481
6482 @item -fsched2-use-superblocks
6483 @opindex fsched2-use-superblocks
6484 When scheduling after register allocation, do use superblock scheduling
6485 algorithm.  Superblock scheduling allows motion across basic block boundaries
6486 resulting on faster schedules.  This option is experimental, as not all machine
6487 descriptions used by GCC model the CPU closely enough to avoid unreliable
6488 results from the algorithm.
6489
6490 This only makes sense when scheduling after register allocation, i.e.@: with
6491 @option{-fschedule-insns2} or at @option{-O2} or higher.
6492
6493 @item -fsched-group-heuristic
6494 @opindex fsched-group-heuristic
6495 Enable the group heuristic in the scheduler.  This heuristic favors 
6496 the instruction that belongs to a schedule group.  This is enabled 
6497 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6498 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6499
6500 @item -fsched-critical-path-heuristic
6501 @opindex fsched-critical-path-heuristic
6502 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6503 instructions on the critical path.  This is enabled by default when 
6504 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6505 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6506
6507 @item -fsched-spec-insn-heuristic
6508 @opindex fsched-spec-insn-heuristic
6509 Enable the speculative instruction heuristic in the scheduler.  This 
6510 heuristic favors speculative instructions with greater dependency weakness.  
6511 This is enabled by default when scheduling is enabled, i.e.@: 
6512 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6513 or at @option{-O2} or higher.
6514
6515 @item -fsched-rank-heuristic
6516 @opindex fsched-rank-heuristic
6517 Enable the rank heuristic in the scheduler.  This heuristic favors 
6518 the instruction belonging to a basic block with greater size or frequency.  
6519 This is enabled by default when scheduling is enabled, i.e.@: 
6520 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6521 at @option{-O2} or higher.
6522
6523 @item -fsched-last-insn-heuristic
6524 @opindex fsched-last-insn-heuristic
6525 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6526 favors the instruction that is less dependent on the last instruction
6527 scheduled.  This is enabled by default when scheduling is enabled, 
6528 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6529 at @option{-O2} or higher.
6530
6531 @item -fsched-dep-count-heuristic
6532 @opindex fsched-dep-count-heuristic
6533 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6534 favors the instruction that has more instructions depending on it.  
6535 This is enabled by default when scheduling is enabled, i.e.@: 
6536 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6537 at @option{-O2} or higher.
6538
6539 @item -freschedule-modulo-scheduled-loops
6540 @opindex freschedule-modulo-scheduled-loops
6541 The modulo scheduling comes before the traditional scheduling, if a loop
6542 was modulo scheduled we may want to prevent the later scheduling passes
6543 from changing its schedule, we use this option to control that.
6544
6545 @item -fselective-scheduling
6546 @opindex fselective-scheduling
6547 Schedule instructions using selective scheduling algorithm.  Selective
6548 scheduling runs instead of the first scheduler pass.
6549
6550 @item -fselective-scheduling2
6551 @opindex fselective-scheduling2
6552 Schedule instructions using selective scheduling algorithm.  Selective
6553 scheduling runs instead of the second scheduler pass.
6554
6555 @item -fsel-sched-pipelining
6556 @opindex fsel-sched-pipelining
6557 Enable software pipelining of innermost loops during selective scheduling.
6558 This option has no effect until one of @option{-fselective-scheduling} or
6559 @option{-fselective-scheduling2} is turned on.
6560
6561 @item -fsel-sched-pipelining-outer-loops
6562 @opindex fsel-sched-pipelining-outer-loops
6563 When pipelining loops during selective scheduling, also pipeline outer loops.
6564 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6565
6566 @item -fcaller-saves
6567 @opindex fcaller-saves
6568 Enable values to be allocated in registers that will be clobbered by
6569 function calls, by emitting extra instructions to save and restore the
6570 registers around such calls.  Such allocation is done only when it
6571 seems to result in better code than would otherwise be produced.
6572
6573 This option is always enabled by default on certain machines, usually
6574 those which have no call-preserved registers to use instead.
6575
6576 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6577
6578 @item -fconserve-stack
6579 @opindex fconserve-stack
6580 Attempt to minimize stack usage.  The compiler will attempt to use less
6581 stack space, even if that makes the program slower.  This option
6582 implies setting the @option{large-stack-frame} parameter to 100
6583 and the @option{large-stack-frame-growth} parameter to 400.
6584
6585 @item -ftree-reassoc
6586 @opindex ftree-reassoc
6587 Perform reassociation on trees.  This flag is enabled by default
6588 at @option{-O} and higher.
6589
6590 @item -ftree-pre
6591 @opindex ftree-pre
6592 Perform partial redundancy elimination (PRE) on trees.  This flag is
6593 enabled by default at @option{-O2} and @option{-O3}.
6594
6595 @item -ftree-forwprop
6596 @opindex ftree-forwprop
6597 Perform forward propagation on trees.  This flag is enabled by default
6598 at @option{-O} and higher.
6599
6600 @item -ftree-fre
6601 @opindex ftree-fre
6602 Perform full redundancy elimination (FRE) on trees.  The difference
6603 between FRE and PRE is that FRE only considers expressions
6604 that are computed on all paths leading to the redundant computation.
6605 This analysis is faster than PRE, though it exposes fewer redundancies.
6606 This flag is enabled by default at @option{-O} and higher.
6607
6608 @item -ftree-phiprop
6609 @opindex ftree-phiprop
6610 Perform hoisting of loads from conditional pointers on trees.  This
6611 pass is enabled by default at @option{-O} and higher.
6612
6613 @item -ftree-copy-prop
6614 @opindex ftree-copy-prop
6615 Perform copy propagation on trees.  This pass eliminates unnecessary
6616 copy operations.  This flag is enabled by default at @option{-O} and
6617 higher.
6618
6619 @item -fipa-pure-const
6620 @opindex fipa-pure-const
6621 Discover which functions are pure or constant.
6622 Enabled by default at @option{-O} and higher.
6623
6624 @item -fipa-reference
6625 @opindex fipa-reference
6626 Discover which static variables do not escape cannot escape the
6627 compilation unit.
6628 Enabled by default at @option{-O} and higher.
6629
6630 @item -fipa-struct-reorg
6631 @opindex fipa-struct-reorg
6632 Perform structure reorganization optimization, that change C-like structures
6633 layout in order to better utilize spatial locality.  This transformation is
6634 affective for programs containing arrays of structures.  Available in two
6635 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6636 or static (which uses built-in heuristics).  It works only in whole program
6637 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6638 enabled.  Structures considered @samp{cold} by this transformation are not
6639 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6640
6641 With this flag, the program debug info reflects a new structure layout.
6642
6643 @item -fipa-pta
6644 @opindex fipa-pta
6645 Perform interprocedural pointer analysis and interprocedural modification
6646 and reference analysis.  This option can cause excessive memory and
6647 compile-time usage on large compilation units.  It is not enabled by
6648 default at any optimization level.
6649
6650 @item -fipa-profile
6651 @opindex fipa-profile
6652 Perform interprocedural profile propagation.  The functions called only from
6653 cold functions are marked as cold. Also functions executed once (such as
6654 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
6655 functions and loop less parts of functions executed once are then optimized for
6656 size.
6657 Enabled by default at @option{-O} and higher.
6658
6659 @item -fipa-cp
6660 @opindex fipa-cp
6661 Perform interprocedural constant propagation.
6662 This optimization analyzes the program to determine when values passed
6663 to functions are constants and then optimizes accordingly.
6664 This optimization can substantially increase performance
6665 if the application has constants passed to functions.
6666 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6667
6668 @item -fipa-cp-clone
6669 @opindex fipa-cp-clone
6670 Perform function cloning to make interprocedural constant propagation stronger.
6671 When enabled, interprocedural constant propagation will perform function cloning
6672 when externally visible function can be called with constant arguments.
6673 Because this optimization can create multiple copies of functions,
6674 it may significantly increase code size
6675 (see @option{--param ipcp-unit-growth=@var{value}}).
6676 This flag is enabled by default at @option{-O3}.
6677
6678 @item -fipa-matrix-reorg
6679 @opindex fipa-matrix-reorg
6680 Perform matrix flattening and transposing.
6681 Matrix flattening tries to replace an @math{m}-dimensional matrix
6682 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6683 This reduces the level of indirection needed for accessing the elements
6684 of the matrix. The second optimization is matrix transposing that
6685 attempts to change the order of the matrix's dimensions in order to
6686 improve cache locality.
6687 Both optimizations need the @option{-fwhole-program} flag.
6688 Transposing is enabled only if profiling information is available.
6689
6690 @item -ftree-sink
6691 @opindex ftree-sink
6692 Perform forward store motion  on trees.  This flag is
6693 enabled by default at @option{-O} and higher.
6694
6695 @item -ftree-ccp
6696 @opindex ftree-ccp
6697 Perform sparse conditional constant propagation (CCP) on trees.  This
6698 pass only operates on local scalar variables and is enabled by default
6699 at @option{-O} and higher.
6700
6701 @item -ftree-switch-conversion
6702 Perform conversion of simple initializations in a switch to
6703 initializations from a scalar array.  This flag is enabled by default
6704 at @option{-O2} and higher.
6705
6706 @item -ftree-dce
6707 @opindex ftree-dce
6708 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6709 default at @option{-O} and higher.
6710
6711 @item -ftree-builtin-call-dce
6712 @opindex ftree-builtin-call-dce
6713 Perform conditional dead code elimination (DCE) for calls to builtin functions
6714 that may set @code{errno} but are otherwise side-effect free.  This flag is
6715 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6716 specified.
6717
6718 @item -ftree-dominator-opts
6719 @opindex ftree-dominator-opts
6720 Perform a variety of simple scalar cleanups (constant/copy
6721 propagation, redundancy elimination, range propagation and expression
6722 simplification) based on a dominator tree traversal.  This also
6723 performs jump threading (to reduce jumps to jumps). This flag is
6724 enabled by default at @option{-O} and higher.
6725
6726 @item -ftree-dse
6727 @opindex ftree-dse
6728 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6729 a memory location which will later be overwritten by another store without
6730 any intervening loads.  In this case the earlier store can be deleted.  This
6731 flag is enabled by default at @option{-O} and higher.
6732
6733 @item -ftree-ch
6734 @opindex ftree-ch
6735 Perform loop header copying on trees.  This is beneficial since it increases
6736 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6737 is enabled by default at @option{-O} and higher.  It is not enabled
6738 for @option{-Os}, since it usually increases code size.
6739
6740 @item -ftree-loop-optimize
6741 @opindex ftree-loop-optimize
6742 Perform loop optimizations on trees.  This flag is enabled by default
6743 at @option{-O} and higher.
6744
6745 @item -ftree-loop-linear
6746 @opindex ftree-loop-linear
6747 Perform linear loop transformations on tree.  This flag can improve cache
6748 performance and allow further loop optimizations to take place.
6749
6750 @item -floop-interchange
6751 Perform loop interchange transformations on loops.  Interchanging two
6752 nested loops switches the inner and outer loops.  For example, given a
6753 loop like:
6754 @smallexample
6755 DO J = 1, M
6756   DO I = 1, N
6757     A(J, I) = A(J, I) * C
6758   ENDDO
6759 ENDDO
6760 @end smallexample
6761 loop interchange will transform the loop as if the user had written:
6762 @smallexample
6763 DO I = 1, N
6764   DO J = 1, M
6765     A(J, I) = A(J, I) * C
6766   ENDDO
6767 ENDDO
6768 @end smallexample
6769 which can be beneficial when @code{N} is larger than the caches,
6770 because in Fortran, the elements of an array are stored in memory
6771 contiguously by column, and the original loop iterates over rows,
6772 potentially creating at each access a cache miss.  This optimization
6773 applies to all the languages supported by GCC and is not limited to
6774 Fortran.  To use this code transformation, GCC has to be configured
6775 with @option{--with-ppl} and @option{--with-cloog} to enable the
6776 Graphite loop transformation infrastructure.
6777
6778 @item -floop-strip-mine
6779 Perform loop strip mining transformations on loops.  Strip mining
6780 splits a loop into two nested loops.  The outer loop has strides
6781 equal to the strip size and the inner loop has strides of the
6782 original loop within a strip.  The strip length can be changed
6783 using the @option{loop-block-tile-size} parameter.  For example,
6784 given a loop like:
6785 @smallexample
6786 DO I = 1, N
6787   A(I) = A(I) + C
6788 ENDDO
6789 @end smallexample
6790 loop strip mining will transform the loop as if the user had written:
6791 @smallexample
6792 DO II = 1, N, 51
6793   DO I = II, min (II + 50, N)
6794     A(I) = A(I) + C
6795   ENDDO
6796 ENDDO
6797 @end smallexample
6798 This optimization applies to all the languages supported by GCC and is
6799 not limited to Fortran.  To use this code transformation, GCC has to
6800 be configured with @option{--with-ppl} and @option{--with-cloog} to
6801 enable the Graphite loop transformation infrastructure.
6802
6803 @item -floop-block
6804 Perform loop blocking transformations on loops.  Blocking strip mines
6805 each loop in the loop nest such that the memory accesses of the
6806 element loops fit inside caches.  The strip length can be changed
6807 using the @option{loop-block-tile-size} parameter.  For example, given
6808 a loop like:
6809 @smallexample
6810 DO I = 1, N
6811   DO J = 1, M
6812     A(J, I) = B(I) + C(J)
6813   ENDDO
6814 ENDDO
6815 @end smallexample
6816 loop blocking will transform the loop as if the user had written:
6817 @smallexample
6818 DO II = 1, N, 51
6819   DO JJ = 1, M, 51
6820     DO I = II, min (II + 50, N)
6821       DO J = JJ, min (JJ + 50, M)
6822         A(J, I) = B(I) + C(J)
6823       ENDDO
6824     ENDDO
6825   ENDDO
6826 ENDDO
6827 @end smallexample
6828 which can be beneficial when @code{M} is larger than the caches,
6829 because the innermost loop will iterate over a smaller amount of data
6830 that can be kept in the caches.  This optimization applies to all the
6831 languages supported by GCC and is not limited to Fortran.  To use this
6832 code transformation, GCC has to be configured with @option{--with-ppl}
6833 and @option{--with-cloog} to enable the Graphite loop transformation
6834 infrastructure.
6835
6836 @item -fgraphite-identity
6837 @opindex fgraphite-identity
6838 Enable the identity transformation for graphite.  For every SCoP we generate
6839 the polyhedral representation and transform it back to gimple.  Using
6840 @option{-fgraphite-identity} we can check the costs or benefits of the
6841 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6842 are also performed by the code generator CLooG, like index splitting and
6843 dead code elimination in loops.
6844
6845 @item -floop-parallelize-all
6846 Use the Graphite data dependence analysis to identify loops that can
6847 be parallelized.  Parallelize all the loops that can be analyzed to
6848 not contain loop carried dependences without checking that it is
6849 profitable to parallelize the loops.
6850
6851 @item -fcheck-data-deps
6852 @opindex fcheck-data-deps
6853 Compare the results of several data dependence analyzers.  This option
6854 is used for debugging the data dependence analyzers.
6855
6856 @item -ftree-loop-distribution
6857 Perform loop distribution.  This flag can improve cache performance on
6858 big loop bodies and allow further loop optimizations, like
6859 parallelization or vectorization, to take place.  For example, the loop
6860 @smallexample
6861 DO I = 1, N
6862   A(I) = B(I) + C
6863   D(I) = E(I) * F
6864 ENDDO
6865 @end smallexample
6866 is transformed to
6867 @smallexample
6868 DO I = 1, N
6869    A(I) = B(I) + C
6870 ENDDO
6871 DO I = 1, N
6872    D(I) = E(I) * F
6873 ENDDO
6874 @end smallexample
6875
6876 @item -ftree-loop-im
6877 @opindex ftree-loop-im
6878 Perform loop invariant motion on trees.  This pass moves only invariants that
6879 would be hard to handle at RTL level (function calls, operations that expand to
6880 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6881 operands of conditions that are invariant out of the loop, so that we can use
6882 just trivial invariantness analysis in loop unswitching.  The pass also includes
6883 store motion.
6884
6885 @item -ftree-loop-ivcanon
6886 @opindex ftree-loop-ivcanon
6887 Create a canonical counter for number of iterations in the loop for that
6888 determining number of iterations requires complicated analysis.  Later
6889 optimizations then may determine the number easily.  Useful especially
6890 in connection with unrolling.
6891
6892 @item -fivopts
6893 @opindex fivopts
6894 Perform induction variable optimizations (strength reduction, induction
6895 variable merging and induction variable elimination) on trees.
6896
6897 @item -ftree-parallelize-loops=n
6898 @opindex ftree-parallelize-loops
6899 Parallelize loops, i.e., split their iteration space to run in n threads.
6900 This is only possible for loops whose iterations are independent
6901 and can be arbitrarily reordered.  The optimization is only
6902 profitable on multiprocessor machines, for loops that are CPU-intensive,
6903 rather than constrained e.g.@: by memory bandwidth.  This option
6904 implies @option{-pthread}, and thus is only supported on targets
6905 that have support for @option{-pthread}.
6906
6907 @item -ftree-pta
6908 @opindex ftree-pta
6909 Perform function-local points-to analysis on trees.  This flag is
6910 enabled by default at @option{-O} and higher.
6911
6912 @item -ftree-sra
6913 @opindex ftree-sra
6914 Perform scalar replacement of aggregates.  This pass replaces structure
6915 references with scalars to prevent committing structures to memory too
6916 early.  This flag is enabled by default at @option{-O} and higher.
6917
6918 @item -ftree-copyrename
6919 @opindex ftree-copyrename
6920 Perform copy renaming on trees.  This pass attempts to rename compiler
6921 temporaries to other variables at copy locations, usually resulting in
6922 variable names which more closely resemble the original variables.  This flag
6923 is enabled by default at @option{-O} and higher.
6924
6925 @item -ftree-ter
6926 @opindex ftree-ter
6927 Perform temporary expression replacement during the SSA->normal phase.  Single
6928 use/single def temporaries are replaced at their use location with their
6929 defining expression.  This results in non-GIMPLE code, but gives the expanders
6930 much more complex trees to work on resulting in better RTL generation.  This is
6931 enabled by default at @option{-O} and higher.
6932
6933 @item -ftree-vectorize
6934 @opindex ftree-vectorize
6935 Perform loop vectorization on trees. This flag is enabled by default at
6936 @option{-O3}.
6937
6938 @item -ftree-slp-vectorize
6939 @opindex ftree-slp-vectorize
6940 Perform basic block vectorization on trees. This flag is enabled by default at
6941 @option{-O3} and when @option{-ftree-vectorize} is enabled.
6942
6943 @item -ftree-vect-loop-version
6944 @opindex ftree-vect-loop-version
6945 Perform loop versioning when doing loop vectorization on trees.  When a loop
6946 appears to be vectorizable except that data alignment or data dependence cannot
6947 be determined at compile time then vectorized and non-vectorized versions of
6948 the loop are generated along with runtime checks for alignment or dependence
6949 to control which version is executed.  This option is enabled by default
6950 except at level @option{-Os} where it is disabled.
6951
6952 @item -fvect-cost-model
6953 @opindex fvect-cost-model
6954 Enable cost model for vectorization.
6955
6956 @item -ftree-vrp
6957 @opindex ftree-vrp
6958 Perform Value Range Propagation on trees.  This is similar to the
6959 constant propagation pass, but instead of values, ranges of values are
6960 propagated.  This allows the optimizers to remove unnecessary range
6961 checks like array bound checks and null pointer checks.  This is
6962 enabled by default at @option{-O2} and higher.  Null pointer check
6963 elimination is only done if @option{-fdelete-null-pointer-checks} is
6964 enabled.
6965
6966 @item -ftracer
6967 @opindex ftracer
6968 Perform tail duplication to enlarge superblock size.  This transformation
6969 simplifies the control flow of the function allowing other optimizations to do
6970 better job.
6971
6972 @item -funroll-loops
6973 @opindex funroll-loops
6974 Unroll loops whose number of iterations can be determined at compile
6975 time or upon entry to the loop.  @option{-funroll-loops} implies
6976 @option{-frerun-cse-after-loop}.  This option makes code larger,
6977 and may or may not make it run faster.
6978
6979 @item -funroll-all-loops
6980 @opindex funroll-all-loops
6981 Unroll all loops, even if their number of iterations is uncertain when
6982 the loop is entered.  This usually makes programs run more slowly.
6983 @option{-funroll-all-loops} implies the same options as
6984 @option{-funroll-loops},
6985
6986 @item -fsplit-ivs-in-unroller
6987 @opindex fsplit-ivs-in-unroller
6988 Enables expressing of values of induction variables in later iterations
6989 of the unrolled loop using the value in the first iteration.  This breaks
6990 long dependency chains, thus improving efficiency of the scheduling passes.
6991
6992 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6993 same effect.  However in cases the loop body is more complicated than
6994 a single basic block, this is not reliable.  It also does not work at all
6995 on some of the architectures due to restrictions in the CSE pass.
6996
6997 This optimization is enabled by default.
6998
6999 @item -fvariable-expansion-in-unroller
7000 @opindex fvariable-expansion-in-unroller
7001 With this option, the compiler will create multiple copies of some
7002 local variables when unrolling a loop which can result in superior code.
7003
7004 @item -fpredictive-commoning
7005 @opindex fpredictive-commoning
7006 Perform predictive commoning optimization, i.e., reusing computations
7007 (especially memory loads and stores) performed in previous
7008 iterations of loops.
7009
7010 This option is enabled at level @option{-O3}.
7011
7012 @item -fprefetch-loop-arrays
7013 @opindex fprefetch-loop-arrays
7014 If supported by the target machine, generate instructions to prefetch
7015 memory to improve the performance of loops that access large arrays.
7016
7017 This option may generate better or worse code; results are highly
7018 dependent on the structure of loops within the source code.
7019
7020 Disabled at level @option{-Os}.
7021
7022 @item -fno-peephole
7023 @itemx -fno-peephole2
7024 @opindex fno-peephole
7025 @opindex fno-peephole2
7026 Disable any machine-specific peephole optimizations.  The difference
7027 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
7028 are implemented in the compiler; some targets use one, some use the
7029 other, a few use both.
7030
7031 @option{-fpeephole} is enabled by default.
7032 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7033
7034 @item -fno-guess-branch-probability
7035 @opindex fno-guess-branch-probability
7036 Do not guess branch probabilities using heuristics.
7037
7038 GCC will use heuristics to guess branch probabilities if they are
7039 not provided by profiling feedback (@option{-fprofile-arcs}).  These
7040 heuristics are based on the control flow graph.  If some branch probabilities
7041 are specified by @samp{__builtin_expect}, then the heuristics will be
7042 used to guess branch probabilities for the rest of the control flow graph,
7043 taking the @samp{__builtin_expect} info into account.  The interactions
7044 between the heuristics and @samp{__builtin_expect} can be complex, and in
7045 some cases, it may be useful to disable the heuristics so that the effects
7046 of @samp{__builtin_expect} are easier to understand.
7047
7048 The default is @option{-fguess-branch-probability} at levels
7049 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7050
7051 @item -freorder-blocks
7052 @opindex freorder-blocks
7053 Reorder basic blocks in the compiled function in order to reduce number of
7054 taken branches and improve code locality.
7055
7056 Enabled at levels @option{-O2}, @option{-O3}.
7057
7058 @item -freorder-blocks-and-partition
7059 @opindex freorder-blocks-and-partition
7060 In addition to reordering basic blocks in the compiled function, in order
7061 to reduce number of taken branches, partitions hot and cold basic blocks
7062 into separate sections of the assembly and .o files, to improve
7063 paging and cache locality performance.
7064
7065 This optimization is automatically turned off in the presence of
7066 exception handling, for linkonce sections, for functions with a user-defined
7067 section attribute and on any architecture that does not support named
7068 sections.
7069
7070 @item -freorder-functions
7071 @opindex freorder-functions
7072 Reorder functions in the object file in order to
7073 improve code locality.  This is implemented by using special
7074 subsections @code{.text.hot} for most frequently executed functions and
7075 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
7076 the linker so object file format must support named sections and linker must
7077 place them in a reasonable way.
7078
7079 Also profile feedback must be available in to make this option effective.  See
7080 @option{-fprofile-arcs} for details.
7081
7082 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7083
7084 @item -fstrict-aliasing
7085 @opindex fstrict-aliasing
7086 Allow the compiler to assume the strictest aliasing rules applicable to
7087 the language being compiled.  For C (and C++), this activates
7088 optimizations based on the type of expressions.  In particular, an
7089 object of one type is assumed never to reside at the same address as an
7090 object of a different type, unless the types are almost the same.  For
7091 example, an @code{unsigned int} can alias an @code{int}, but not a
7092 @code{void*} or a @code{double}.  A character type may alias any other
7093 type.
7094
7095 @anchor{Type-punning}Pay special attention to code like this:
7096 @smallexample
7097 union a_union @{
7098   int i;
7099   double d;
7100 @};
7101
7102 int f() @{
7103   union a_union t;
7104   t.d = 3.0;
7105   return t.i;
7106 @}
7107 @end smallexample
7108 The practice of reading from a different union member than the one most
7109 recently written to (called ``type-punning'') is common.  Even with
7110 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7111 is accessed through the union type.  So, the code above will work as
7112 expected.  @xref{Structures unions enumerations and bit-fields
7113 implementation}.  However, this code might not:
7114 @smallexample
7115 int f() @{
7116   union a_union t;
7117   int* ip;
7118   t.d = 3.0;
7119   ip = &t.i;
7120   return *ip;
7121 @}
7122 @end smallexample
7123
7124 Similarly, access by taking the address, casting the resulting pointer
7125 and dereferencing the result has undefined behavior, even if the cast
7126 uses a union type, e.g.:
7127 @smallexample
7128 int f() @{
7129   double d = 3.0;
7130   return ((union a_union *) &d)->i;
7131 @}
7132 @end smallexample
7133
7134 The @option{-fstrict-aliasing} option is enabled at levels
7135 @option{-O2}, @option{-O3}, @option{-Os}.
7136
7137 @item -fstrict-overflow
7138 @opindex fstrict-overflow
7139 Allow the compiler to assume strict signed overflow rules, depending
7140 on the language being compiled.  For C (and C++) this means that
7141 overflow when doing arithmetic with signed numbers is undefined, which
7142 means that the compiler may assume that it will not happen.  This
7143 permits various optimizations.  For example, the compiler will assume
7144 that an expression like @code{i + 10 > i} will always be true for
7145 signed @code{i}.  This assumption is only valid if signed overflow is
7146 undefined, as the expression is false if @code{i + 10} overflows when
7147 using twos complement arithmetic.  When this option is in effect any
7148 attempt to determine whether an operation on signed numbers will
7149 overflow must be written carefully to not actually involve overflow.
7150
7151 This option also allows the compiler to assume strict pointer
7152 semantics: given a pointer to an object, if adding an offset to that
7153 pointer does not produce a pointer to the same object, the addition is
7154 undefined.  This permits the compiler to conclude that @code{p + u >
7155 p} is always true for a pointer @code{p} and unsigned integer
7156 @code{u}.  This assumption is only valid because pointer wraparound is
7157 undefined, as the expression is false if @code{p + u} overflows using
7158 twos complement arithmetic.
7159
7160 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7161 that integer signed overflow is fully defined: it wraps.  When
7162 @option{-fwrapv} is used, there is no difference between
7163 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7164 integers.  With @option{-fwrapv} certain types of overflow are
7165 permitted.  For example, if the compiler gets an overflow when doing
7166 arithmetic on constants, the overflowed value can still be used with
7167 @option{-fwrapv}, but not otherwise.
7168
7169 The @option{-fstrict-overflow} option is enabled at levels
7170 @option{-O2}, @option{-O3}, @option{-Os}.
7171
7172 @item -falign-functions
7173 @itemx -falign-functions=@var{n}
7174 @opindex falign-functions
7175 Align the start of functions to the next power-of-two greater than
7176 @var{n}, skipping up to @var{n} bytes.  For instance,
7177 @option{-falign-functions=32} aligns functions to the next 32-byte
7178 boundary, but @option{-falign-functions=24} would align to the next
7179 32-byte boundary only if this can be done by skipping 23 bytes or less.
7180
7181 @option{-fno-align-functions} and @option{-falign-functions=1} are
7182 equivalent and mean that functions will not be aligned.
7183
7184 Some assemblers only support this flag when @var{n} is a power of two;
7185 in that case, it is rounded up.
7186
7187 If @var{n} is not specified or is zero, use a machine-dependent default.
7188
7189 Enabled at levels @option{-O2}, @option{-O3}.
7190
7191 @item -falign-labels
7192 @itemx -falign-labels=@var{n}
7193 @opindex falign-labels
7194 Align all branch targets to a power-of-two boundary, skipping up to
7195 @var{n} bytes like @option{-falign-functions}.  This option can easily
7196 make code slower, because it must insert dummy operations for when the
7197 branch target is reached in the usual flow of the code.
7198
7199 @option{-fno-align-labels} and @option{-falign-labels=1} are
7200 equivalent and mean that labels will not be aligned.
7201
7202 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7203 are greater than this value, then their values are used instead.
7204
7205 If @var{n} is not specified or is zero, use a machine-dependent default
7206 which is very likely to be @samp{1}, meaning no alignment.
7207
7208 Enabled at levels @option{-O2}, @option{-O3}.
7209
7210 @item -falign-loops
7211 @itemx -falign-loops=@var{n}
7212 @opindex falign-loops
7213 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7214 like @option{-falign-functions}.  The hope is that the loop will be
7215 executed many times, which will make up for any execution of the dummy
7216 operations.
7217
7218 @option{-fno-align-loops} and @option{-falign-loops=1} are
7219 equivalent and mean that loops will not be aligned.
7220
7221 If @var{n} is not specified or is zero, use a machine-dependent default.
7222
7223 Enabled at levels @option{-O2}, @option{-O3}.
7224
7225 @item -falign-jumps
7226 @itemx -falign-jumps=@var{n}
7227 @opindex falign-jumps
7228 Align branch targets to a power-of-two boundary, for branch targets
7229 where the targets can only be reached by jumping, skipping up to @var{n}
7230 bytes like @option{-falign-functions}.  In this case, no dummy operations
7231 need be executed.
7232
7233 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7234 equivalent and mean that loops will not be aligned.
7235
7236 If @var{n} is not specified or is zero, use a machine-dependent default.
7237
7238 Enabled at levels @option{-O2}, @option{-O3}.
7239
7240 @item -funit-at-a-time
7241 @opindex funit-at-a-time
7242 This option is left for compatibility reasons. @option{-funit-at-a-time}
7243 has no effect, while @option{-fno-unit-at-a-time} implies
7244 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7245
7246 Enabled by default.
7247
7248 @item -fno-toplevel-reorder
7249 @opindex fno-toplevel-reorder
7250 Do not reorder top-level functions, variables, and @code{asm}
7251 statements.  Output them in the same order that they appear in the
7252 input file.  When this option is used, unreferenced static variables
7253 will not be removed.  This option is intended to support existing code
7254 which relies on a particular ordering.  For new code, it is better to
7255 use attributes.
7256
7257 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7258 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7259 targets.
7260
7261 @item -fweb
7262 @opindex fweb
7263 Constructs webs as commonly used for register allocation purposes and assign
7264 each web individual pseudo register.  This allows the register allocation pass
7265 to operate on pseudos directly, but also strengthens several other optimization
7266 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7267 however, make debugging impossible, since variables will no longer stay in a
7268 ``home register''.
7269
7270 Enabled by default with @option{-funroll-loops}.
7271
7272 @item -fwhole-program
7273 @opindex fwhole-program
7274 Assume that the current compilation unit represents the whole program being
7275 compiled.  All public functions and variables with the exception of @code{main}
7276 and those merged by attribute @code{externally_visible} become static functions
7277 and in effect are optimized more aggressively by interprocedural optimizers.
7278 While this option is equivalent to proper use of the @code{static} keyword for
7279 programs consisting of a single file, in combination with option
7280 @option{-combine}, @option{-flto} or @option{-fwhopr} this flag can be used to
7281 compile many smaller scale programs since the functions and variables become
7282 local for the whole combined compilation unit, not for the single source file
7283 itself.
7284
7285 This option implies @option{-fwhole-file} for Fortran programs.
7286
7287 @item -flto
7288 @opindex flto
7289 This option runs the standard link-time optimizer.  When invoked
7290 with source code, it generates GIMPLE (one of GCC's internal
7291 representations) and writes it to special ELF sections in the object
7292 file.  When the object files are linked together, all the function
7293 bodies are read from these ELF sections and instantiated as if they
7294 had been part of the same translation unit.
7295
7296 To use the link-timer optimizer, @option{-flto} needs to be specified at
7297 compile time and during the final link.  For example,
7298
7299 @smallexample
7300 gcc -c -O2 -flto foo.c
7301 gcc -c -O2 -flto bar.c
7302 gcc -o myprog -flto -O2 foo.o bar.o
7303 @end smallexample
7304
7305 The first two invocations to GCC will save a bytecode representation
7306 of GIMPLE into special ELF sections inside @file{foo.o} and
7307 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7308 @file{foo.o} and @file{bar.o}, merge the two files into a single
7309 internal image, and compile the result as usual.  Since both
7310 @file{foo.o} and @file{bar.o} are merged into a single image, this
7311 causes all the inter-procedural analyses and optimizations in GCC to
7312 work across the two files as if they were a single one.  This means,
7313 for example, that the inliner will be able to inline functions in
7314 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7315
7316 Another (simpler) way to enable link-time optimization is,
7317
7318 @smallexample
7319 gcc -o myprog -flto -O2 foo.c bar.c
7320 @end smallexample
7321
7322 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7323 merge them together into a single GIMPLE representation and optimize
7324 them as usual to produce @file{myprog}.
7325
7326 The only important thing to keep in mind is that to enable link-time
7327 optimizations the @option{-flto} flag needs to be passed to both the
7328 compile and the link commands.
7329
7330 Note that when a file is compiled with @option{-flto}, the generated
7331 object file will be larger than a regular object file because it will
7332 contain GIMPLE bytecodes and the usual final code.  This means that
7333 object files with LTO information can be linked as a normal object
7334 file.  So, in the previous example, if the final link is done with
7335
7336 @smallexample
7337 gcc -o myprog foo.o bar.o
7338 @end smallexample
7339
7340 The only difference will be that no inter-procedural optimizations
7341 will be applied to produce @file{myprog}.  The two object files
7342 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7343 linker.
7344
7345 Additionally, the optimization flags used to compile individual files
7346 are not necessarily related to those used at link-time.  For instance,
7347
7348 @smallexample
7349 gcc -c -O0 -flto foo.c
7350 gcc -c -O0 -flto bar.c
7351 gcc -o myprog -flto -O3 foo.o bar.o
7352 @end smallexample
7353
7354 This will produce individual object files with unoptimized assembler
7355 code, but the resulting binary @file{myprog} will be optimized at
7356 @option{-O3}.  Now, if the final binary is generated without
7357 @option{-flto}, then @file{myprog} will not be optimized.
7358
7359 When producing the final binary with @option{-flto}, GCC will only
7360 apply link-time optimizations to those files that contain bytecode.
7361 Therefore, you can mix and match object files and libraries with
7362 GIMPLE bytecodes and final object code.  GCC will automatically select
7363 which files to optimize in LTO mode and which files to link without
7364 further processing.
7365
7366 There are some code generation flags that GCC will preserve when
7367 generating bytecodes, as they need to be used during the final link
7368 stage.  Currently, the following options are saved into the GIMPLE
7369 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7370 @option{-m} target flags.
7371
7372 At link time, these options are read-in and reapplied.  Note that the
7373 current implementation makes no attempt at recognizing conflicting
7374 values for these options.  If two or more files have a conflicting
7375 value (e.g., one file is compiled with @option{-fPIC} and another
7376 isn't), the compiler will simply use the last value read from the
7377 bytecode files.  It is recommended, then, that all the files
7378 participating in the same link be compiled with the same options.
7379
7380 Another feature of LTO is that it is possible to apply interprocedural
7381 optimizations on files written in different languages.  This requires
7382 some support in the language front end.  Currently, the C, C++ and
7383 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7384 something like this should work
7385
7386 @smallexample
7387 gcc -c -flto foo.c
7388 g++ -c -flto bar.cc
7389 gfortran -c -flto baz.f90
7390 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7391 @end smallexample
7392
7393 Notice that the final link is done with @command{g++} to get the C++
7394 runtime libraries and @option{-lgfortran} is added to get the Fortran
7395 runtime libraries.  In general, when mixing languages in LTO mode, you
7396 should use the same link command used when mixing languages in a
7397 regular (non-LTO) compilation.  This means that if your build process
7398 was mixing languages before, all you need to add is @option{-flto} to
7399 all the compile and link commands.
7400
7401 If LTO encounters objects with C linkage declared with incompatible
7402 types in separate translation units to be linked together (undefined
7403 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
7404 issued.  The behavior is still undefined at runtime.
7405
7406 If object files containing GIMPLE bytecode are stored in a library
7407 archive, say @file{libfoo.a}, it is possible to extract and use them
7408 in an LTO link if you are using @command{gold} as the linker (which,
7409 in turn requires GCC to be configured with @option{--enable-gold}).
7410 To enable this feature, use the flag @option{-fuse-linker-plugin} at
7411 link-time:
7412
7413 @smallexample
7414 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7415 @end smallexample
7416
7417 With the linker plugin enabled, @command{gold} will extract the needed
7418 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7419 to make them part of the aggregated GIMPLE image to be optimized.
7420
7421 If you are not using @command{gold} and/or do not specify
7422 @option{-fuse-linker-plugin} then the objects inside @file{libfoo.a}
7423 will be extracted and linked as usual, but they will not participate
7424 in the LTO optimization process.
7425
7426 Link time optimizations do not require the presence of the whole
7427 program to operate.  If the program does not require any symbols to
7428 be exported, it is possible to combine @option{-flto} and
7429 @option{-fwhopr} with @option{-fwhole-program} to allow the
7430 interprocedural optimizers to use more aggressive assumptions which
7431 may lead to improved optimization opportunities.
7432
7433 Regarding portability: the current implementation of LTO makes no
7434 attempt at generating bytecode that can be ported between different
7435 types of hosts.  The bytecode files are versioned and there is a
7436 strict version check, so bytecode files generated in one version of
7437 GCC will not work with an older/newer version of GCC.
7438
7439 Link time optimization does not play well with generating debugging
7440 information.  Combining @option{-flto} or @option{-fwhopr} with
7441 @option{-g} is experimental.
7442
7443 This option is disabled by default.
7444
7445 @item -fwhopr[=@var{n}]
7446 @opindex fwhopr
7447 This option is identical in functionality to @option{-flto} but it
7448 differs in how the final link stage is executed.  Instead of loading
7449 all the function bodies in memory, the callgraph is analyzed and
7450 optimization decisions are made (whole program analysis or WPA). Once
7451 optimization decisions are made, the callgraph is partitioned and the
7452 different sections are compiled separately (local transformations or
7453 LTRANS)@.  This process allows optimizations on very large programs
7454 that otherwise would not fit in memory.  This option enables
7455 @option{-fwpa} and @option{-fltrans} automatically.
7456
7457 If you specify the optional @var{n} the link stage is executed in
7458 parallel using @var{n} parallel jobs by utilizing an installed
7459 @code{make} program.
7460
7461 Disabled by default.
7462
7463 @item -fwpa
7464 @opindex fwpa
7465 This is an internal option used by GCC when compiling with
7466 @option{-fwhopr}.  You should never need to use it.
7467
7468 This option runs the link-time optimizer in the whole-program-analysis
7469 (WPA) mode, which reads in summary information from all inputs and
7470 performs a whole-program analysis based on summary information only.
7471 It generates object files for subsequent runs of the link-time
7472 optimizer where individual object files are optimized using both
7473 summary information from the WPA mode and the actual function bodies.
7474 It then drives the LTRANS phase.
7475
7476 Disabled by default.
7477
7478 @item -fltrans
7479 @opindex fltrans
7480 This is an internal option used by GCC when compiling with
7481 @option{-fwhopr}.  You should never need to use it.
7482
7483 This option runs the link-time optimizer in the local-transformation (LTRANS)
7484 mode, which reads in output from a previous run of the LTO in WPA mode.
7485 In the LTRANS mode, LTO optimizes an object and produces the final assembly.
7486
7487 Disabled by default.
7488
7489 @item -fltrans-output-list=@var{file}
7490 @opindex fltrans-output-list
7491 This is an internal option used by GCC when compiling with
7492 @option{-fwhopr}.  You should never need to use it.
7493
7494 This option specifies a file to which the names of LTRANS output files are
7495 written.  This option is only meaningful in conjunction with @option{-fwpa}.
7496
7497 Disabled by default.
7498
7499 @item -flto-compression-level=@var{n}
7500 This option specifies the level of compression used for intermediate
7501 language written to LTO object files, and is only meaningful in
7502 conjunction with LTO mode (@option{-fwhopr}, @option{-flto}).  Valid
7503 values are 0 (no compression) to 9 (maximum compression).  Values
7504 outside this range are clamped to either 0 or 9.  If the option is not
7505 given, a default balanced compression setting is used.
7506
7507 @item -flto-report
7508 Prints a report with internal details on the workings of the link-time
7509 optimizer.  The contents of this report vary from version to version,
7510 it is meant to be useful to GCC developers when processing object
7511 files in LTO mode (via @option{-fwhopr} or @option{-flto}).
7512
7513 Disabled by default.
7514
7515 @item -fuse-linker-plugin
7516 Enables the extraction of objects with GIMPLE bytecode information
7517 from library archives.  This option relies on features available only
7518 in @command{gold}, so to use this you must configure GCC with
7519 @option{--enable-gold}.  See @option{-flto} for a description on the
7520 effect of this flag and how to use it.
7521
7522 Disabled by default.
7523
7524 @item -fcprop-registers
7525 @opindex fcprop-registers
7526 After register allocation and post-register allocation instruction splitting,
7527 we perform a copy-propagation pass to try to reduce scheduling dependencies
7528 and occasionally eliminate the copy.
7529
7530 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7531
7532 @item -fprofile-correction
7533 @opindex fprofile-correction
7534 Profiles collected using an instrumented binary for multi-threaded programs may
7535 be inconsistent due to missed counter updates. When this option is specified,
7536 GCC will use heuristics to correct or smooth out such inconsistencies. By
7537 default, GCC will emit an error message when an inconsistent profile is detected.
7538
7539 @item -fprofile-dir=@var{path}
7540 @opindex fprofile-dir
7541
7542 Set the directory to search the profile data files in to @var{path}.
7543 This option affects only the profile data generated by
7544 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7545 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7546 and its related options.
7547 By default, GCC will use the current directory as @var{path}
7548 thus the profile data file will appear in the same directory as the object file.
7549
7550 @item -fprofile-generate
7551 @itemx -fprofile-generate=@var{path}
7552 @opindex fprofile-generate
7553
7554 Enable options usually used for instrumenting application to produce
7555 profile useful for later recompilation with profile feedback based
7556 optimization.  You must use @option{-fprofile-generate} both when
7557 compiling and when linking your program.
7558
7559 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7560
7561 If @var{path} is specified, GCC will look at the @var{path} to find
7562 the profile feedback data files. See @option{-fprofile-dir}.
7563
7564 @item -fprofile-use
7565 @itemx -fprofile-use=@var{path}
7566 @opindex fprofile-use
7567 Enable profile feedback directed optimizations, and optimizations
7568 generally profitable only with profile feedback available.
7569
7570 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7571 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7572
7573 By default, GCC emits an error message if the feedback profiles do not
7574 match the source code.  This error can be turned into a warning by using
7575 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7576 code.
7577
7578 If @var{path} is specified, GCC will look at the @var{path} to find
7579 the profile feedback data files. See @option{-fprofile-dir}.
7580 @end table
7581
7582 The following options control compiler behavior regarding floating
7583 point arithmetic.  These options trade off between speed and
7584 correctness.  All must be specifically enabled.
7585
7586 @table @gcctabopt
7587 @item -ffloat-store
7588 @opindex ffloat-store
7589 Do not store floating point variables in registers, and inhibit other
7590 options that might change whether a floating point value is taken from a
7591 register or memory.
7592
7593 @cindex floating point precision
7594 This option prevents undesirable excess precision on machines such as
7595 the 68000 where the floating registers (of the 68881) keep more
7596 precision than a @code{double} is supposed to have.  Similarly for the
7597 x86 architecture.  For most programs, the excess precision does only
7598 good, but a few programs rely on the precise definition of IEEE floating
7599 point.  Use @option{-ffloat-store} for such programs, after modifying
7600 them to store all pertinent intermediate computations into variables.
7601
7602 @item -fexcess-precision=@var{style}
7603 @opindex fexcess-precision
7604 This option allows further control over excess precision on machines
7605 where floating-point registers have more precision than the IEEE
7606 @code{float} and @code{double} types and the processor does not
7607 support operations rounding to those types.  By default,
7608 @option{-fexcess-precision=fast} is in effect; this means that
7609 operations are carried out in the precision of the registers and that
7610 it is unpredictable when rounding to the types specified in the source
7611 code takes place.  When compiling C, if
7612 @option{-fexcess-precision=standard} is specified then excess
7613 precision will follow the rules specified in ISO C99; in particular,
7614 both casts and assignments cause values to be rounded to their
7615 semantic types (whereas @option{-ffloat-store} only affects
7616 assignments).  This option is enabled by default for C if a strict
7617 conformance option such as @option{-std=c99} is used.
7618
7619 @opindex mfpmath
7620 @option{-fexcess-precision=standard} is not implemented for languages
7621 other than C, and has no effect if
7622 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7623 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7624 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7625 semantics apply without excess precision, and in the latter, rounding
7626 is unpredictable.
7627
7628 @item -ffast-math
7629 @opindex ffast-math
7630 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7631 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7632 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7633
7634 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7635
7636 This option is not turned on by any @option{-O} option since
7637 it can result in incorrect output for programs which depend on
7638 an exact implementation of IEEE or ISO rules/specifications for
7639 math functions. It may, however, yield faster code for programs
7640 that do not require the guarantees of these specifications.
7641
7642 @item -fno-math-errno
7643 @opindex fno-math-errno
7644 Do not set ERRNO after calling math functions that are executed
7645 with a single instruction, e.g., sqrt.  A program that relies on
7646 IEEE exceptions for math error handling may want to use this flag
7647 for speed while maintaining IEEE arithmetic compatibility.
7648
7649 This option is not turned on by any @option{-O} option since
7650 it can result in incorrect output for programs which depend on
7651 an exact implementation of IEEE or ISO rules/specifications for
7652 math functions. It may, however, yield faster code for programs
7653 that do not require the guarantees of these specifications.
7654
7655 The default is @option{-fmath-errno}.
7656
7657 On Darwin systems, the math library never sets @code{errno}.  There is
7658 therefore no reason for the compiler to consider the possibility that
7659 it might, and @option{-fno-math-errno} is the default.
7660
7661 @item -funsafe-math-optimizations
7662 @opindex funsafe-math-optimizations
7663
7664 Allow optimizations for floating-point arithmetic that (a) assume
7665 that arguments and results are valid and (b) may violate IEEE or
7666 ANSI standards.  When used at link-time, it may include libraries
7667 or startup files that change the default FPU control word or other
7668 similar optimizations.
7669
7670 This option is not turned on by any @option{-O} option since
7671 it can result in incorrect output for programs which depend on
7672 an exact implementation of IEEE or ISO rules/specifications for
7673 math functions. It may, however, yield faster code for programs
7674 that do not require the guarantees of these specifications.
7675 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7676 @option{-fassociative-math} and @option{-freciprocal-math}.
7677
7678 The default is @option{-fno-unsafe-math-optimizations}.
7679
7680 @item -fassociative-math
7681 @opindex fassociative-math
7682
7683 Allow re-association of operands in series of floating-point operations.
7684 This violates the ISO C and C++ language standard by possibly changing
7685 computation result.  NOTE: re-ordering may change the sign of zero as
7686 well as ignore NaNs and inhibit or create underflow or overflow (and
7687 thus cannot be used on a code which relies on rounding behavior like
7688 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7689 and thus may not be used when ordered comparisons are required.
7690 This option requires that both @option{-fno-signed-zeros} and
7691 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7692 much sense with @option{-frounding-math}. For Fortran the option
7693 is automatically enabled when both @option{-fno-signed-zeros} and
7694 @option{-fno-trapping-math} are in effect.
7695
7696 The default is @option{-fno-associative-math}.
7697
7698 @item -freciprocal-math
7699 @opindex freciprocal-math
7700
7701 Allow the reciprocal of a value to be used instead of dividing by
7702 the value if this enables optimizations.  For example @code{x / y}
7703 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7704 is subject to common subexpression elimination.  Note that this loses
7705 precision and increases the number of flops operating on the value.
7706
7707 The default is @option{-fno-reciprocal-math}.
7708
7709 @item -ffinite-math-only
7710 @opindex ffinite-math-only
7711 Allow optimizations for floating-point arithmetic that assume
7712 that arguments and results are not NaNs or +-Infs.
7713
7714 This option is not turned on by any @option{-O} option since
7715 it can result in incorrect output for programs which depend on
7716 an exact implementation of IEEE or ISO rules/specifications for
7717 math functions. It may, however, yield faster code for programs
7718 that do not require the guarantees of these specifications.
7719
7720 The default is @option{-fno-finite-math-only}.
7721
7722 @item -fno-signed-zeros
7723 @opindex fno-signed-zeros
7724 Allow optimizations for floating point arithmetic that ignore the
7725 signedness of zero.  IEEE arithmetic specifies the behavior of
7726 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7727 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7728 This option implies that the sign of a zero result isn't significant.
7729
7730 The default is @option{-fsigned-zeros}.
7731
7732 @item -fno-trapping-math
7733 @opindex fno-trapping-math
7734 Compile code assuming that floating-point operations cannot generate
7735 user-visible traps.  These traps include division by zero, overflow,
7736 underflow, inexact result and invalid operation.  This option requires
7737 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7738 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7739
7740 This option should never be turned on by any @option{-O} option since
7741 it can result in incorrect output for programs which depend on
7742 an exact implementation of IEEE or ISO rules/specifications for
7743 math functions.
7744
7745 The default is @option{-ftrapping-math}.
7746
7747 @item -frounding-math
7748 @opindex frounding-math
7749 Disable transformations and optimizations that assume default floating
7750 point rounding behavior.  This is round-to-zero for all floating point
7751 to integer conversions, and round-to-nearest for all other arithmetic
7752 truncations.  This option should be specified for programs that change
7753 the FP rounding mode dynamically, or that may be executed with a
7754 non-default rounding mode.  This option disables constant folding of
7755 floating point expressions at compile-time (which may be affected by
7756 rounding mode) and arithmetic transformations that are unsafe in the
7757 presence of sign-dependent rounding modes.
7758
7759 The default is @option{-fno-rounding-math}.
7760
7761 This option is experimental and does not currently guarantee to
7762 disable all GCC optimizations that are affected by rounding mode.
7763 Future versions of GCC may provide finer control of this setting
7764 using C99's @code{FENV_ACCESS} pragma.  This command line option
7765 will be used to specify the default state for @code{FENV_ACCESS}.
7766
7767 @item -fsignaling-nans
7768 @opindex fsignaling-nans
7769 Compile code assuming that IEEE signaling NaNs may generate user-visible
7770 traps during floating-point operations.  Setting this option disables
7771 optimizations that may change the number of exceptions visible with
7772 signaling NaNs.  This option implies @option{-ftrapping-math}.
7773
7774 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7775 be defined.
7776
7777 The default is @option{-fno-signaling-nans}.
7778
7779 This option is experimental and does not currently guarantee to
7780 disable all GCC optimizations that affect signaling NaN behavior.
7781
7782 @item -fsingle-precision-constant
7783 @opindex fsingle-precision-constant
7784 Treat floating point constant as single precision constant instead of
7785 implicitly converting it to double precision constant.
7786
7787 @item -fcx-limited-range
7788 @opindex fcx-limited-range
7789 When enabled, this option states that a range reduction step is not
7790 needed when performing complex division.  Also, there is no checking
7791 whether the result of a complex multiplication or division is @code{NaN
7792 + I*NaN}, with an attempt to rescue the situation in that case.  The
7793 default is @option{-fno-cx-limited-range}, but is enabled by
7794 @option{-ffast-math}.
7795
7796 This option controls the default setting of the ISO C99
7797 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7798 all languages.
7799
7800 @item -fcx-fortran-rules
7801 @opindex fcx-fortran-rules
7802 Complex multiplication and division follow Fortran rules.  Range
7803 reduction is done as part of complex division, but there is no checking
7804 whether the result of a complex multiplication or division is @code{NaN
7805 + I*NaN}, with an attempt to rescue the situation in that case.
7806
7807 The default is @option{-fno-cx-fortran-rules}.
7808
7809 @end table
7810
7811 The following options control optimizations that may improve
7812 performance, but are not enabled by any @option{-O} options.  This
7813 section includes experimental options that may produce broken code.
7814
7815 @table @gcctabopt
7816 @item -fbranch-probabilities
7817 @opindex fbranch-probabilities
7818 After running a program compiled with @option{-fprofile-arcs}
7819 (@pxref{Debugging Options,, Options for Debugging Your Program or
7820 @command{gcc}}), you can compile it a second time using
7821 @option{-fbranch-probabilities}, to improve optimizations based on
7822 the number of times each branch was taken.  When the program
7823 compiled with @option{-fprofile-arcs} exits it saves arc execution
7824 counts to a file called @file{@var{sourcename}.gcda} for each source
7825 file.  The information in this data file is very dependent on the
7826 structure of the generated code, so you must use the same source code
7827 and the same optimization options for both compilations.
7828
7829 With @option{-fbranch-probabilities}, GCC puts a
7830 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7831 These can be used to improve optimization.  Currently, they are only
7832 used in one place: in @file{reorg.c}, instead of guessing which path a
7833 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7834 exactly determine which path is taken more often.
7835
7836 @item -fprofile-values
7837 @opindex fprofile-values
7838 If combined with @option{-fprofile-arcs}, it adds code so that some
7839 data about values of expressions in the program is gathered.
7840
7841 With @option{-fbranch-probabilities}, it reads back the data gathered
7842 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7843 notes to instructions for their later usage in optimizations.
7844
7845 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7846
7847 @item -fvpt
7848 @opindex fvpt
7849 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7850 a code to gather information about values of expressions.
7851
7852 With @option{-fbranch-probabilities}, it reads back the data gathered
7853 and actually performs the optimizations based on them.
7854 Currently the optimizations include specialization of division operation
7855 using the knowledge about the value of the denominator.
7856
7857 @item -frename-registers
7858 @opindex frename-registers
7859 Attempt to avoid false dependencies in scheduled code by making use
7860 of registers left over after register allocation.  This optimization
7861 will most benefit processors with lots of registers.  Depending on the
7862 debug information format adopted by the target, however, it can
7863 make debugging impossible, since variables will no longer stay in
7864 a ``home register''.
7865
7866 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
7867
7868 @item -ftracer
7869 @opindex ftracer
7870 Perform tail duplication to enlarge superblock size.  This transformation
7871 simplifies the control flow of the function allowing other optimizations to do
7872 better job.
7873
7874 Enabled with @option{-fprofile-use}.
7875
7876 @item -funroll-loops
7877 @opindex funroll-loops
7878 Unroll loops whose number of iterations can be determined at compile time or
7879 upon entry to the loop.  @option{-funroll-loops} implies
7880 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
7881 It also turns on complete loop peeling (i.e.@: complete removal of loops with
7882 small constant number of iterations).  This option makes code larger, and may
7883 or may not make it run faster.
7884
7885 Enabled with @option{-fprofile-use}.
7886
7887 @item -funroll-all-loops
7888 @opindex funroll-all-loops
7889 Unroll all loops, even if their number of iterations is uncertain when
7890 the loop is entered.  This usually makes programs run more slowly.
7891 @option{-funroll-all-loops} implies the same options as
7892 @option{-funroll-loops}.
7893
7894 @item -fpeel-loops
7895 @opindex fpeel-loops
7896 Peels the loops for that there is enough information that they do not
7897 roll much (from profile feedback).  It also turns on complete loop peeling
7898 (i.e.@: complete removal of loops with small constant number of iterations).
7899
7900 Enabled with @option{-fprofile-use}.
7901
7902 @item -fmove-loop-invariants
7903 @opindex fmove-loop-invariants
7904 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
7905 at level @option{-O1}
7906
7907 @item -funswitch-loops
7908 @opindex funswitch-loops
7909 Move branches with loop invariant conditions out of the loop, with duplicates
7910 of the loop on both branches (modified according to result of the condition).
7911
7912 @item -ffunction-sections
7913 @itemx -fdata-sections
7914 @opindex ffunction-sections
7915 @opindex fdata-sections
7916 Place each function or data item into its own section in the output
7917 file if the target supports arbitrary sections.  The name of the
7918 function or the name of the data item determines the section's name
7919 in the output file.
7920
7921 Use these options on systems where the linker can perform optimizations
7922 to improve locality of reference in the instruction space.  Most systems
7923 using the ELF object format and SPARC processors running Solaris 2 have
7924 linkers with such optimizations.  AIX may have these optimizations in
7925 the future.
7926
7927 Only use these options when there are significant benefits from doing
7928 so.  When you specify these options, the assembler and linker will
7929 create larger object and executable files and will also be slower.
7930 You will not be able to use @code{gprof} on all systems if you
7931 specify this option and you may have problems with debugging if
7932 you specify both this option and @option{-g}.
7933
7934 @item -fbranch-target-load-optimize
7935 @opindex fbranch-target-load-optimize
7936 Perform branch target register load optimization before prologue / epilogue
7937 threading.
7938 The use of target registers can typically be exposed only during reload,
7939 thus hoisting loads out of loops and doing inter-block scheduling needs
7940 a separate optimization pass.
7941
7942 @item -fbranch-target-load-optimize2
7943 @opindex fbranch-target-load-optimize2
7944 Perform branch target register load optimization after prologue / epilogue
7945 threading.
7946
7947 @item -fbtr-bb-exclusive
7948 @opindex fbtr-bb-exclusive
7949 When performing branch target register load optimization, don't reuse
7950 branch target registers in within any basic block.
7951
7952 @item -fstack-protector
7953 @opindex fstack-protector
7954 Emit extra code to check for buffer overflows, such as stack smashing
7955 attacks.  This is done by adding a guard variable to functions with
7956 vulnerable objects.  This includes functions that call alloca, and
7957 functions with buffers larger than 8 bytes.  The guards are initialized
7958 when a function is entered and then checked when the function exits.
7959 If a guard check fails, an error message is printed and the program exits.
7960
7961 @item -fstack-protector-all
7962 @opindex fstack-protector-all
7963 Like @option{-fstack-protector} except that all functions are protected.
7964
7965 @item -fsection-anchors
7966 @opindex fsection-anchors
7967 Try to reduce the number of symbolic address calculations by using
7968 shared ``anchor'' symbols to address nearby objects.  This transformation
7969 can help to reduce the number of GOT entries and GOT accesses on some
7970 targets.
7971
7972 For example, the implementation of the following function @code{foo}:
7973
7974 @smallexample
7975 static int a, b, c;
7976 int foo (void) @{ return a + b + c; @}
7977 @end smallexample
7978
7979 would usually calculate the addresses of all three variables, but if you
7980 compile it with @option{-fsection-anchors}, it will access the variables
7981 from a common anchor point instead.  The effect is similar to the
7982 following pseudocode (which isn't valid C):
7983
7984 @smallexample
7985 int foo (void)
7986 @{
7987   register int *xr = &x;
7988   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7989 @}
7990 @end smallexample
7991
7992 Not all targets support this option.
7993
7994 @item --param @var{name}=@var{value}
7995 @opindex param
7996 In some places, GCC uses various constants to control the amount of
7997 optimization that is done.  For example, GCC will not inline functions
7998 that contain more that a certain number of instructions.  You can
7999 control some of these constants on the command-line using the
8000 @option{--param} option.
8001
8002 The names of specific parameters, and the meaning of the values, are
8003 tied to the internals of the compiler, and are subject to change
8004 without notice in future releases.
8005
8006 In each case, the @var{value} is an integer.  The allowable choices for
8007 @var{name} are given in the following table:
8008
8009 @table @gcctabopt
8010 @item struct-reorg-cold-struct-ratio
8011 The threshold ratio (as a percentage) between a structure frequency
8012 and the frequency of the hottest structure in the program.  This parameter
8013 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
8014 We say that if the ratio of a structure frequency, calculated by profiling,
8015 to the hottest structure frequency in the program is less than this
8016 parameter, then structure reorganization is not applied to this structure.
8017 The default is 10.
8018
8019 @item predictable-branch-outcome
8020 When branch is predicted to be taken with probability lower than this threshold
8021 (in percent), then it is considered well predictable. The default is 10.
8022
8023 @item max-crossjump-edges
8024 The maximum number of incoming edges to consider for crossjumping.
8025 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
8026 the number of edges incoming to each block.  Increasing values mean
8027 more aggressive optimization, making the compile time increase with
8028 probably small improvement in executable size.
8029
8030 @item min-crossjump-insns
8031 The minimum number of instructions which must be matched at the end
8032 of two blocks before crossjumping will be performed on them.  This
8033 value is ignored in the case where all instructions in the block being
8034 crossjumped from are matched.  The default value is 5.
8035
8036 @item max-grow-copy-bb-insns
8037 The maximum code size expansion factor when copying basic blocks
8038 instead of jumping.  The expansion is relative to a jump instruction.
8039 The default value is 8.
8040
8041 @item max-goto-duplication-insns
8042 The maximum number of instructions to duplicate to a block that jumps
8043 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
8044 passes, GCC factors computed gotos early in the compilation process,
8045 and unfactors them as late as possible.  Only computed jumps at the
8046 end of a basic blocks with no more than max-goto-duplication-insns are
8047 unfactored.  The default value is 8.
8048
8049 @item max-delay-slot-insn-search
8050 The maximum number of instructions to consider when looking for an
8051 instruction to fill a delay slot.  If more than this arbitrary number of
8052 instructions is searched, the time savings from filling the delay slot
8053 will be minimal so stop searching.  Increasing values mean more
8054 aggressive optimization, making the compile time increase with probably
8055 small improvement in executable run time.
8056
8057 @item max-delay-slot-live-search
8058 When trying to fill delay slots, the maximum number of instructions to
8059 consider when searching for a block with valid live register
8060 information.  Increasing this arbitrarily chosen value means more
8061 aggressive optimization, increasing the compile time.  This parameter
8062 should be removed when the delay slot code is rewritten to maintain the
8063 control-flow graph.
8064
8065 @item max-gcse-memory
8066 The approximate maximum amount of memory that will be allocated in
8067 order to perform the global common subexpression elimination
8068 optimization.  If more memory than specified is required, the
8069 optimization will not be done.
8070
8071 @item max-pending-list-length
8072 The maximum number of pending dependencies scheduling will allow
8073 before flushing the current state and starting over.  Large functions
8074 with few branches or calls can create excessively large lists which
8075 needlessly consume memory and resources.
8076
8077 @item max-inline-insns-single
8078 Several parameters control the tree inliner used in gcc.
8079 This number sets the maximum number of instructions (counted in GCC's
8080 internal representation) in a single function that the tree inliner
8081 will consider for inlining.  This only affects functions declared
8082 inline and methods implemented in a class declaration (C++).
8083 The default value is 300.
8084
8085 @item max-inline-insns-auto
8086 When you use @option{-finline-functions} (included in @option{-O3}),
8087 a lot of functions that would otherwise not be considered for inlining
8088 by the compiler will be investigated.  To those functions, a different
8089 (more restrictive) limit compared to functions declared inline can
8090 be applied.
8091 The default value is 50.
8092
8093 @item large-function-insns
8094 The limit specifying really large functions.  For functions larger than this
8095 limit after inlining, inlining is constrained by
8096 @option{--param large-function-growth}.  This parameter is useful primarily
8097 to avoid extreme compilation time caused by non-linear algorithms used by the
8098 backend.
8099 The default value is 2700.
8100
8101 @item large-function-growth
8102 Specifies maximal growth of large function caused by inlining in percents.
8103 The default value is 100 which limits large function growth to 2.0 times
8104 the original size.
8105
8106 @item large-unit-insns
8107 The limit specifying large translation unit.  Growth caused by inlining of
8108 units larger than this limit is limited by @option{--param inline-unit-growth}.
8109 For small units this might be too tight (consider unit consisting of function A
8110 that is inline and B that just calls A three time.  If B is small relative to
8111 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
8112 large units consisting of small inlineable functions however the overall unit
8113 growth limit is needed to avoid exponential explosion of code size.  Thus for
8114 smaller units, the size is increased to @option{--param large-unit-insns}
8115 before applying @option{--param inline-unit-growth}.  The default is 10000
8116
8117 @item inline-unit-growth
8118 Specifies maximal overall growth of the compilation unit caused by inlining.
8119 The default value is 30 which limits unit growth to 1.3 times the original
8120 size.
8121
8122 @item ipcp-unit-growth
8123 Specifies maximal overall growth of the compilation unit caused by
8124 interprocedural constant propagation.  The default value is 10 which limits
8125 unit growth to 1.1 times the original size.
8126
8127 @item large-stack-frame
8128 The limit specifying large stack frames.  While inlining the algorithm is trying
8129 to not grow past this limit too much.  Default value is 256 bytes.
8130
8131 @item large-stack-frame-growth
8132 Specifies maximal growth of large stack frames caused by inlining in percents.
8133 The default value is 1000 which limits large stack frame growth to 11 times
8134 the original size.
8135
8136 @item max-inline-insns-recursive
8137 @itemx max-inline-insns-recursive-auto
8138 Specifies maximum number of instructions out-of-line copy of self recursive inline
8139 function can grow into by performing recursive inlining.
8140
8141 For functions declared inline @option{--param max-inline-insns-recursive} is
8142 taken into account.  For function not declared inline, recursive inlining
8143 happens only when @option{-finline-functions} (included in @option{-O3}) is
8144 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8145 default value is 450.
8146
8147 @item max-inline-recursive-depth
8148 @itemx max-inline-recursive-depth-auto
8149 Specifies maximum recursion depth used by the recursive inlining.
8150
8151 For functions declared inline @option{--param max-inline-recursive-depth} is
8152 taken into account.  For function not declared inline, recursive inlining
8153 happens only when @option{-finline-functions} (included in @option{-O3}) is
8154 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8155 default value is 8.
8156
8157 @item min-inline-recursive-probability
8158 Recursive inlining is profitable only for function having deep recursion
8159 in average and can hurt for function having little recursion depth by
8160 increasing the prologue size or complexity of function body to other
8161 optimizers.
8162
8163 When profile feedback is available (see @option{-fprofile-generate}) the actual
8164 recursion depth can be guessed from probability that function will recurse via
8165 given call expression.  This parameter limits inlining only to call expression
8166 whose probability exceeds given threshold (in percents).  The default value is
8167 10.
8168
8169 @item early-inlining-insns
8170 Specify growth that early inliner can make.  In effect it increases amount of
8171 inlining for code having large abstraction penalty.  The default value is 8.
8172
8173 @item max-early-inliner-iterations
8174 @itemx max-early-inliner-iterations
8175 Limit of iterations of early inliner.  This basically bounds number of nested
8176 indirect calls early inliner can resolve.  Deeper chains are still handled by
8177 late inlining.
8178
8179 @item min-vect-loop-bound
8180 The minimum number of iterations under which a loop will not get vectorized
8181 when @option{-ftree-vectorize} is used.  The number of iterations after
8182 vectorization needs to be greater than the value specified by this option
8183 to allow vectorization.  The default value is 0.
8184
8185 @item max-unrolled-insns
8186 The maximum number of instructions that a loop should have if that loop
8187 is unrolled, and if the loop is unrolled, it determines how many times
8188 the loop code is unrolled.
8189
8190 @item max-average-unrolled-insns
8191 The maximum number of instructions biased by probabilities of their execution
8192 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8193 it determines how many times the loop code is unrolled.
8194
8195 @item max-unroll-times
8196 The maximum number of unrollings of a single loop.
8197
8198 @item max-peeled-insns
8199 The maximum number of instructions that a loop should have if that loop
8200 is peeled, and if the loop is peeled, it determines how many times
8201 the loop code is peeled.
8202
8203 @item max-peel-times
8204 The maximum number of peelings of a single loop.
8205
8206 @item max-completely-peeled-insns
8207 The maximum number of insns of a completely peeled loop.
8208
8209 @item max-completely-peel-times
8210 The maximum number of iterations of a loop to be suitable for complete peeling.
8211
8212 @item max-completely-peel-loop-nest-depth
8213 The maximum depth of a loop nest suitable for complete peeling.
8214
8215 @item max-unswitch-insns
8216 The maximum number of insns of an unswitched loop.
8217
8218 @item max-unswitch-level
8219 The maximum number of branches unswitched in a single loop.
8220
8221 @item lim-expensive
8222 The minimum cost of an expensive expression in the loop invariant motion.
8223
8224 @item iv-consider-all-candidates-bound
8225 Bound on number of candidates for induction variables below that
8226 all candidates are considered for each use in induction variable
8227 optimizations.  Only the most relevant candidates are considered
8228 if there are more candidates, to avoid quadratic time complexity.
8229
8230 @item iv-max-considered-uses
8231 The induction variable optimizations give up on loops that contain more
8232 induction variable uses.
8233
8234 @item iv-always-prune-cand-set-bound
8235 If number of candidates in the set is smaller than this value,
8236 we always try to remove unnecessary ivs from the set during its
8237 optimization when a new iv is added to the set.
8238
8239 @item scev-max-expr-size
8240 Bound on size of expressions used in the scalar evolutions analyzer.
8241 Large expressions slow the analyzer.
8242
8243 @item omega-max-vars
8244 The maximum number of variables in an Omega constraint system.
8245 The default value is 128.
8246
8247 @item omega-max-geqs
8248 The maximum number of inequalities in an Omega constraint system.
8249 The default value is 256.
8250
8251 @item omega-max-eqs
8252 The maximum number of equalities in an Omega constraint system.
8253 The default value is 128.
8254
8255 @item omega-max-wild-cards
8256 The maximum number of wildcard variables that the Omega solver will
8257 be able to insert.  The default value is 18.
8258
8259 @item omega-hash-table-size
8260 The size of the hash table in the Omega solver.  The default value is
8261 550.
8262
8263 @item omega-max-keys
8264 The maximal number of keys used by the Omega solver.  The default
8265 value is 500.
8266
8267 @item omega-eliminate-redundant-constraints
8268 When set to 1, use expensive methods to eliminate all redundant
8269 constraints.  The default value is 0.
8270
8271 @item vect-max-version-for-alignment-checks
8272 The maximum number of runtime checks that can be performed when
8273 doing loop versioning for alignment in the vectorizer.  See option
8274 ftree-vect-loop-version for more information.
8275
8276 @item vect-max-version-for-alias-checks
8277 The maximum number of runtime checks that can be performed when
8278 doing loop versioning for alias in the vectorizer.  See option
8279 ftree-vect-loop-version for more information.
8280
8281 @item max-iterations-to-track
8282
8283 The maximum number of iterations of a loop the brute force algorithm
8284 for analysis of # of iterations of the loop tries to evaluate.
8285
8286 @item hot-bb-count-fraction
8287 Select fraction of the maximal count of repetitions of basic block in program
8288 given basic block needs to have to be considered hot.
8289
8290 @item hot-bb-frequency-fraction
8291 Select fraction of the maximal frequency of executions of basic block in
8292 function given basic block needs to have to be considered hot
8293
8294 @item max-predicted-iterations
8295 The maximum number of loop iterations we predict statically.  This is useful
8296 in cases where function contain single loop with known bound and other loop
8297 with unknown.  We predict the known number of iterations correctly, while
8298 the unknown number of iterations average to roughly 10.  This means that the
8299 loop without bounds would appear artificially cold relative to the other one.
8300
8301 @item align-threshold
8302
8303 Select fraction of the maximal frequency of executions of basic block in
8304 function given basic block will get aligned.
8305
8306 @item align-loop-iterations
8307
8308 A loop expected to iterate at lest the selected number of iterations will get
8309 aligned.
8310
8311 @item tracer-dynamic-coverage
8312 @itemx tracer-dynamic-coverage-feedback
8313
8314 This value is used to limit superblock formation once the given percentage of
8315 executed instructions is covered.  This limits unnecessary code size
8316 expansion.
8317
8318 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8319 feedback is available.  The real profiles (as opposed to statically estimated
8320 ones) are much less balanced allowing the threshold to be larger value.
8321
8322 @item tracer-max-code-growth
8323 Stop tail duplication once code growth has reached given percentage.  This is
8324 rather hokey argument, as most of the duplicates will be eliminated later in
8325 cross jumping, so it may be set to much higher values than is the desired code
8326 growth.
8327
8328 @item tracer-min-branch-ratio
8329
8330 Stop reverse growth when the reverse probability of best edge is less than this
8331 threshold (in percent).
8332
8333 @item tracer-min-branch-ratio
8334 @itemx tracer-min-branch-ratio-feedback
8335
8336 Stop forward growth if the best edge do have probability lower than this
8337 threshold.
8338
8339 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8340 compilation for profile feedback and one for compilation without.  The value
8341 for compilation with profile feedback needs to be more conservative (higher) in
8342 order to make tracer effective.
8343
8344 @item max-cse-path-length
8345
8346 Maximum number of basic blocks on path that cse considers.  The default is 10.
8347
8348 @item max-cse-insns
8349 The maximum instructions CSE process before flushing. The default is 1000.
8350
8351 @item ggc-min-expand
8352
8353 GCC uses a garbage collector to manage its own memory allocation.  This
8354 parameter specifies the minimum percentage by which the garbage
8355 collector's heap should be allowed to expand between collections.
8356 Tuning this may improve compilation speed; it has no effect on code
8357 generation.
8358
8359 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8360 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8361 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8362 GCC is not able to calculate RAM on a particular platform, the lower
8363 bound of 30% is used.  Setting this parameter and
8364 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8365 every opportunity.  This is extremely slow, but can be useful for
8366 debugging.
8367
8368 @item ggc-min-heapsize
8369
8370 Minimum size of the garbage collector's heap before it begins bothering
8371 to collect garbage.  The first collection occurs after the heap expands
8372 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8373 tuning this may improve compilation speed, and has no effect on code
8374 generation.
8375
8376 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8377 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8378 with a lower bound of 4096 (four megabytes) and an upper bound of
8379 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8380 particular platform, the lower bound is used.  Setting this parameter
8381 very large effectively disables garbage collection.  Setting this
8382 parameter and @option{ggc-min-expand} to zero causes a full collection
8383 to occur at every opportunity.
8384
8385 @item max-reload-search-insns
8386 The maximum number of instruction reload should look backward for equivalent
8387 register.  Increasing values mean more aggressive optimization, making the
8388 compile time increase with probably slightly better performance.  The default
8389 value is 100.
8390
8391 @item max-cselib-memory-locations
8392 The maximum number of memory locations cselib should take into account.
8393 Increasing values mean more aggressive optimization, making the compile time
8394 increase with probably slightly better performance.  The default value is 500.
8395
8396 @item reorder-blocks-duplicate
8397 @itemx reorder-blocks-duplicate-feedback
8398
8399 Used by basic block reordering pass to decide whether to use unconditional
8400 branch or duplicate the code on its destination.  Code is duplicated when its
8401 estimated size is smaller than this value multiplied by the estimated size of
8402 unconditional jump in the hot spots of the program.
8403
8404 The @option{reorder-block-duplicate-feedback} is used only when profile
8405 feedback is available and may be set to higher values than
8406 @option{reorder-block-duplicate} since information about the hot spots is more
8407 accurate.
8408
8409 @item max-sched-ready-insns
8410 The maximum number of instructions ready to be issued the scheduler should
8411 consider at any given time during the first scheduling pass.  Increasing
8412 values mean more thorough searches, making the compilation time increase
8413 with probably little benefit.  The default value is 100.
8414
8415 @item max-sched-region-blocks
8416 The maximum number of blocks in a region to be considered for
8417 interblock scheduling.  The default value is 10.
8418
8419 @item max-pipeline-region-blocks
8420 The maximum number of blocks in a region to be considered for
8421 pipelining in the selective scheduler.  The default value is 15.
8422
8423 @item max-sched-region-insns
8424 The maximum number of insns in a region to be considered for
8425 interblock scheduling.  The default value is 100.
8426
8427 @item max-pipeline-region-insns
8428 The maximum number of insns in a region to be considered for
8429 pipelining in the selective scheduler.  The default value is 200.
8430
8431 @item min-spec-prob
8432 The minimum probability (in percents) of reaching a source block
8433 for interblock speculative scheduling.  The default value is 40.
8434
8435 @item max-sched-extend-regions-iters
8436 The maximum number of iterations through CFG to extend regions.
8437 0 - disable region extension,
8438 N - do at most N iterations.
8439 The default value is 0.
8440
8441 @item max-sched-insn-conflict-delay
8442 The maximum conflict delay for an insn to be considered for speculative motion.
8443 The default value is 3.
8444
8445 @item sched-spec-prob-cutoff
8446 The minimal probability of speculation success (in percents), so that
8447 speculative insn will be scheduled.
8448 The default value is 40.
8449
8450 @item sched-mem-true-dep-cost
8451 Minimal distance (in CPU cycles) between store and load targeting same
8452 memory locations.  The default value is 1.
8453
8454 @item selsched-max-lookahead
8455 The maximum size of the lookahead window of selective scheduling.  It is a
8456 depth of search for available instructions.
8457 The default value is 50.
8458
8459 @item selsched-max-sched-times
8460 The maximum number of times that an instruction will be scheduled during
8461 selective scheduling.  This is the limit on the number of iterations
8462 through which the instruction may be pipelined.  The default value is 2.
8463
8464 @item selsched-max-insns-to-rename
8465 The maximum number of best instructions in the ready list that are considered
8466 for renaming in the selective scheduler.  The default value is 2.
8467
8468 @item max-last-value-rtl
8469 The maximum size measured as number of RTLs that can be recorded in an expression
8470 in combiner for a pseudo register as last known value of that register.  The default
8471 is 10000.
8472
8473 @item integer-share-limit
8474 Small integer constants can use a shared data structure, reducing the
8475 compiler's memory usage and increasing its speed.  This sets the maximum
8476 value of a shared integer constant.  The default value is 256.
8477
8478 @item min-virtual-mappings
8479 Specifies the minimum number of virtual mappings in the incremental
8480 SSA updater that should be registered to trigger the virtual mappings
8481 heuristic defined by virtual-mappings-ratio.  The default value is
8482 100.
8483
8484 @item virtual-mappings-ratio
8485 If the number of virtual mappings is virtual-mappings-ratio bigger
8486 than the number of virtual symbols to be updated, then the incremental
8487 SSA updater switches to a full update for those symbols.  The default
8488 ratio is 3.
8489
8490 @item ssp-buffer-size
8491 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8492 protection when @option{-fstack-protection} is used.
8493
8494 @item max-jump-thread-duplication-stmts
8495 Maximum number of statements allowed in a block that needs to be
8496 duplicated when threading jumps.
8497
8498 @item max-fields-for-field-sensitive
8499 Maximum number of fields in a structure we will treat in
8500 a field sensitive manner during pointer analysis.  The default is zero
8501 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8502
8503 @item prefetch-latency
8504 Estimate on average number of instructions that are executed before
8505 prefetch finishes.  The distance we prefetch ahead is proportional
8506 to this constant.  Increasing this number may also lead to less
8507 streams being prefetched (see @option{simultaneous-prefetches}).
8508
8509 @item simultaneous-prefetches
8510 Maximum number of prefetches that can run at the same time.
8511
8512 @item l1-cache-line-size
8513 The size of cache line in L1 cache, in bytes.
8514
8515 @item l1-cache-size
8516 The size of L1 cache, in kilobytes.
8517
8518 @item l2-cache-size
8519 The size of L2 cache, in kilobytes.
8520
8521 @item min-insn-to-prefetch-ratio
8522 The minimum ratio between the number of instructions and the
8523 number of prefetches to enable prefetching in a loop.
8524
8525 @item prefetch-min-insn-to-mem-ratio
8526 The minimum ratio between the number of instructions and the
8527 number of memory references to enable prefetching in a loop.
8528
8529 @item use-canonical-types
8530 Whether the compiler should use the ``canonical'' type system.  By
8531 default, this should always be 1, which uses a more efficient internal
8532 mechanism for comparing types in C++ and Objective-C++.  However, if
8533 bugs in the canonical type system are causing compilation failures,
8534 set this value to 0 to disable canonical types.
8535
8536 @item switch-conversion-max-branch-ratio
8537 Switch initialization conversion will refuse to create arrays that are
8538 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8539 branches in the switch.
8540
8541 @item max-partial-antic-length
8542 Maximum length of the partial antic set computed during the tree
8543 partial redundancy elimination optimization (@option{-ftree-pre}) when
8544 optimizing at @option{-O3} and above.  For some sorts of source code
8545 the enhanced partial redundancy elimination optimization can run away,
8546 consuming all of the memory available on the host machine.  This
8547 parameter sets a limit on the length of the sets that are computed,
8548 which prevents the runaway behavior.  Setting a value of 0 for
8549 this parameter will allow an unlimited set length.
8550
8551 @item sccvn-max-scc-size
8552 Maximum size of a strongly connected component (SCC) during SCCVN
8553 processing.  If this limit is hit, SCCVN processing for the whole
8554 function will not be done and optimizations depending on it will
8555 be disabled.  The default maximum SCC size is 10000.
8556
8557 @item ira-max-loops-num
8558 IRA uses a regional register allocation by default.  If a function
8559 contains loops more than number given by the parameter, only at most
8560 given number of the most frequently executed loops will form regions
8561 for the regional register allocation.  The default value of the
8562 parameter is 100.
8563
8564 @item ira-max-conflict-table-size
8565 Although IRA uses a sophisticated algorithm of compression conflict
8566 table, the table can be still big for huge functions.  If the conflict
8567 table for a function could be more than size in MB given by the
8568 parameter, the conflict table is not built and faster, simpler, and
8569 lower quality register allocation algorithm will be used.  The
8570 algorithm do not use pseudo-register conflicts.  The default value of
8571 the parameter is 2000.
8572
8573 @item ira-loop-reserved-regs
8574 IRA can be used to evaluate more accurate register pressure in loops
8575 for decision to move loop invariants (see @option{-O3}).  The number
8576 of available registers reserved for some other purposes is described
8577 by this parameter.  The default value of the parameter is 2 which is
8578 minimal number of registers needed for execution of typical
8579 instruction.  This value is the best found from numerous experiments.
8580
8581 @item loop-invariant-max-bbs-in-loop
8582 Loop invariant motion can be very expensive, both in compile time and
8583 in amount of needed compile time memory, with very large loops.  Loops
8584 with more basic blocks than this parameter won't have loop invariant
8585 motion optimization performed on them.  The default value of the
8586 parameter is 1000 for -O1 and 10000 for -O2 and above.
8587
8588 @item max-vartrack-size
8589 Sets a maximum number of hash table slots to use during variable
8590 tracking dataflow analysis of any function.  If this limit is exceeded
8591 with variable tracking at assignments enabled, analysis for that
8592 function is retried without it, after removing all debug insns from
8593 the function.  If the limit is exceeded even without debug insns, var
8594 tracking analysis is completely disabled for the function.  Setting
8595 the parameter to zero makes it unlimited.
8596
8597 @item min-nondebug-insn-uid
8598 Use uids starting at this parameter for nondebug insns.  The range below
8599 the parameter is reserved exclusively for debug insns created by
8600 @option{-fvar-tracking-assignments}, but debug insns may get
8601 (non-overlapping) uids above it if the reserved range is exhausted.
8602
8603 @item ipa-sra-ptr-growth-factor
8604 IPA-SRA will replace a pointer to an aggregate with one or more new
8605 parameters only when their cumulative size is less or equal to
8606 @option{ipa-sra-ptr-growth-factor} times the size of the original
8607 pointer parameter.
8608
8609 @item graphite-max-nb-scop-params
8610 To avoid exponential effects in the Graphite loop transforms, the
8611 number of parameters in a Static Control Part (SCoP) is bounded.  The
8612 default value is 10 parameters.  A variable whose value is unknown at
8613 compile time and defined outside a SCoP is a parameter of the SCoP.
8614
8615 @item graphite-max-bbs-per-function
8616 To avoid exponential effects in the detection of SCoPs, the size of
8617 the functions analyzed by Graphite is bounded.  The default value is
8618 100 basic blocks.
8619
8620 @item loop-block-tile-size
8621 Loop blocking or strip mining transforms, enabled with
8622 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
8623 loop in the loop nest by a given number of iterations.  The strip
8624 length can be changed using the @option{loop-block-tile-size}
8625 parameter.  The default value is 51 iterations.
8626
8627 @end table
8628 @end table
8629
8630 @node Preprocessor Options
8631 @section Options Controlling the Preprocessor
8632 @cindex preprocessor options
8633 @cindex options, preprocessor
8634
8635 These options control the C preprocessor, which is run on each C source
8636 file before actual compilation.
8637
8638 If you use the @option{-E} option, nothing is done except preprocessing.
8639 Some of these options make sense only together with @option{-E} because
8640 they cause the preprocessor output to be unsuitable for actual
8641 compilation.
8642
8643 @table @gcctabopt
8644 @item -Wp,@var{option}
8645 @opindex Wp
8646 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8647 and pass @var{option} directly through to the preprocessor.  If
8648 @var{option} contains commas, it is split into multiple options at the
8649 commas.  However, many options are modified, translated or interpreted
8650 by the compiler driver before being passed to the preprocessor, and
8651 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8652 interface is undocumented and subject to change, so whenever possible
8653 you should avoid using @option{-Wp} and let the driver handle the
8654 options instead.
8655
8656 @item -Xpreprocessor @var{option}
8657 @opindex Xpreprocessor
8658 Pass @var{option} as an option to the preprocessor.  You can use this to
8659 supply system-specific preprocessor options which GCC does not know how to
8660 recognize.
8661
8662 If you want to pass an option that takes an argument, you must use
8663 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8664 @end table
8665
8666 @include cppopts.texi
8667
8668 @node Assembler Options
8669 @section Passing Options to the Assembler
8670
8671 @c prevent bad page break with this line
8672 You can pass options to the assembler.
8673
8674 @table @gcctabopt
8675 @item -Wa,@var{option}
8676 @opindex Wa
8677 Pass @var{option} as an option to the assembler.  If @var{option}
8678 contains commas, it is split into multiple options at the commas.
8679
8680 @item -Xassembler @var{option}
8681 @opindex Xassembler
8682 Pass @var{option} as an option to the assembler.  You can use this to
8683 supply system-specific assembler options which GCC does not know how to
8684 recognize.
8685
8686 If you want to pass an option that takes an argument, you must use
8687 @option{-Xassembler} twice, once for the option and once for the argument.
8688
8689 @end table
8690
8691 @node Link Options
8692 @section Options for Linking
8693 @cindex link options
8694 @cindex options, linking
8695
8696 These options come into play when the compiler links object files into
8697 an executable output file.  They are meaningless if the compiler is
8698 not doing a link step.
8699
8700 @table @gcctabopt
8701 @cindex file names
8702 @item @var{object-file-name}
8703 A file name that does not end in a special recognized suffix is
8704 considered to name an object file or library.  (Object files are
8705 distinguished from libraries by the linker according to the file
8706 contents.)  If linking is done, these object files are used as input
8707 to the linker.
8708
8709 @item -c
8710 @itemx -S
8711 @itemx -E
8712 @opindex c
8713 @opindex S
8714 @opindex E
8715 If any of these options is used, then the linker is not run, and
8716 object file names should not be used as arguments.  @xref{Overall
8717 Options}.
8718
8719 @cindex Libraries
8720 @item -l@var{library}
8721 @itemx -l @var{library}
8722 @opindex l
8723 Search the library named @var{library} when linking.  (The second
8724 alternative with the library as a separate argument is only for
8725 POSIX compliance and is not recommended.)
8726
8727 It makes a difference where in the command you write this option; the
8728 linker searches and processes libraries and object files in the order they
8729 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8730 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8731 to functions in @samp{z}, those functions may not be loaded.
8732
8733 The linker searches a standard list of directories for the library,
8734 which is actually a file named @file{lib@var{library}.a}.  The linker
8735 then uses this file as if it had been specified precisely by name.
8736
8737 The directories searched include several standard system directories
8738 plus any that you specify with @option{-L}.
8739
8740 Normally the files found this way are library files---archive files
8741 whose members are object files.  The linker handles an archive file by
8742 scanning through it for members which define symbols that have so far
8743 been referenced but not defined.  But if the file that is found is an
8744 ordinary object file, it is linked in the usual fashion.  The only
8745 difference between using an @option{-l} option and specifying a file name
8746 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8747 and searches several directories.
8748
8749 @item -lobjc
8750 @opindex lobjc
8751 You need this special case of the @option{-l} option in order to
8752 link an Objective-C or Objective-C++ program.
8753
8754 @item -nostartfiles
8755 @opindex nostartfiles
8756 Do not use the standard system startup files when linking.
8757 The standard system libraries are used normally, unless @option{-nostdlib}
8758 or @option{-nodefaultlibs} is used.
8759
8760 @item -nodefaultlibs
8761 @opindex nodefaultlibs
8762 Do not use the standard system libraries when linking.
8763 Only the libraries you specify will be passed to the linker, options
8764 specifying linkage of the system libraries, such as @code{-static-libgcc}
8765 or @code{-shared-libgcc}, will be ignored.
8766 The standard startup files are used normally, unless @option{-nostartfiles}
8767 is used.  The compiler may generate calls to @code{memcmp},
8768 @code{memset}, @code{memcpy} and @code{memmove}.
8769 These entries are usually resolved by entries in
8770 libc.  These entry points should be supplied through some other
8771 mechanism when this option is specified.
8772
8773 @item -nostdlib
8774 @opindex nostdlib
8775 Do not use the standard system startup files or libraries when linking.
8776 No startup files and only the libraries you specify will be passed to
8777 the linker, options specifying linkage of the system libraries, such as
8778 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8779 The compiler may generate calls to @code{memcmp}, @code{memset},
8780 @code{memcpy} and @code{memmove}.
8781 These entries are usually resolved by entries in
8782 libc.  These entry points should be supplied through some other
8783 mechanism when this option is specified.
8784
8785 @cindex @option{-lgcc}, use with @option{-nostdlib}
8786 @cindex @option{-nostdlib} and unresolved references
8787 @cindex unresolved references and @option{-nostdlib}
8788 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8789 @cindex @option{-nodefaultlibs} and unresolved references
8790 @cindex unresolved references and @option{-nodefaultlibs}
8791 One of the standard libraries bypassed by @option{-nostdlib} and
8792 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8793 that GCC uses to overcome shortcomings of particular machines, or special
8794 needs for some languages.
8795 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8796 Collection (GCC) Internals},
8797 for more discussion of @file{libgcc.a}.)
8798 In most cases, you need @file{libgcc.a} even when you want to avoid
8799 other standard libraries.  In other words, when you specify @option{-nostdlib}
8800 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8801 This ensures that you have no unresolved references to internal GCC
8802 library subroutines.  (For example, @samp{__main}, used to ensure C++
8803 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8804 GNU Compiler Collection (GCC) Internals}.)
8805
8806 @item -pie
8807 @opindex pie
8808 Produce a position independent executable on targets which support it.
8809 For predictable results, you must also specify the same set of options
8810 that were used to generate code (@option{-fpie}, @option{-fPIE},
8811 or model suboptions) when you specify this option.
8812
8813 @item -rdynamic
8814 @opindex rdynamic
8815 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8816 that support it. This instructs the linker to add all symbols, not
8817 only used ones, to the dynamic symbol table. This option is needed
8818 for some uses of @code{dlopen} or to allow obtaining backtraces
8819 from within a program.
8820
8821 @item -s
8822 @opindex s
8823 Remove all symbol table and relocation information from the executable.
8824
8825 @item -static
8826 @opindex static
8827 On systems that support dynamic linking, this prevents linking with the shared
8828 libraries.  On other systems, this option has no effect.
8829
8830 @item -shared
8831 @opindex shared
8832 Produce a shared object which can then be linked with other objects to
8833 form an executable.  Not all systems support this option.  For predictable
8834 results, you must also specify the same set of options that were used to
8835 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8836 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8837 needs to build supplementary stub code for constructors to work.  On
8838 multi-libbed systems, @samp{gcc -shared} must select the correct support
8839 libraries to link against.  Failing to supply the correct flags may lead
8840 to subtle defects.  Supplying them in cases where they are not necessary
8841 is innocuous.}
8842
8843 @item -shared-libgcc
8844 @itemx -static-libgcc
8845 @opindex shared-libgcc
8846 @opindex static-libgcc
8847 On systems that provide @file{libgcc} as a shared library, these options
8848 force the use of either the shared or static version respectively.
8849 If no shared version of @file{libgcc} was built when the compiler was
8850 configured, these options have no effect.
8851
8852 There are several situations in which an application should use the
8853 shared @file{libgcc} instead of the static version.  The most common
8854 of these is when the application wishes to throw and catch exceptions
8855 across different shared libraries.  In that case, each of the libraries
8856 as well as the application itself should use the shared @file{libgcc}.
8857
8858 Therefore, the G++ and GCJ drivers automatically add
8859 @option{-shared-libgcc} whenever you build a shared library or a main
8860 executable, because C++ and Java programs typically use exceptions, so
8861 this is the right thing to do.
8862
8863 If, instead, you use the GCC driver to create shared libraries, you may
8864 find that they will not always be linked with the shared @file{libgcc}.
8865 If GCC finds, at its configuration time, that you have a non-GNU linker
8866 or a GNU linker that does not support option @option{--eh-frame-hdr},
8867 it will link the shared version of @file{libgcc} into shared libraries
8868 by default.  Otherwise, it will take advantage of the linker and optimize
8869 away the linking with the shared version of @file{libgcc}, linking with
8870 the static version of libgcc by default.  This allows exceptions to
8871 propagate through such shared libraries, without incurring relocation
8872 costs at library load time.
8873
8874 However, if a library or main executable is supposed to throw or catch
8875 exceptions, you must link it using the G++ or GCJ driver, as appropriate
8876 for the languages used in the program, or using the option
8877 @option{-shared-libgcc}, such that it is linked with the shared
8878 @file{libgcc}.
8879
8880 @item -static-libstdc++
8881 When the @command{g++} program is used to link a C++ program, it will
8882 normally automatically link against @option{libstdc++}.  If
8883 @file{libstdc++} is available as a shared library, and the
8884 @option{-static} option is not used, then this will link against the
8885 shared version of @file{libstdc++}.  That is normally fine.  However, it
8886 is sometimes useful to freeze the version of @file{libstdc++} used by
8887 the program without going all the way to a fully static link.  The
8888 @option{-static-libstdc++} option directs the @command{g++} driver to
8889 link @file{libstdc++} statically, without necessarily linking other
8890 libraries statically.
8891
8892 @item -symbolic
8893 @opindex symbolic
8894 Bind references to global symbols when building a shared object.  Warn
8895 about any unresolved references (unless overridden by the link editor
8896 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8897 this option.
8898
8899 @item -T @var{script}
8900 @opindex T
8901 @cindex linker script
8902 Use @var{script} as the linker script.  This option is supported by most
8903 systems using the GNU linker.  On some targets, such as bare-board
8904 targets without an operating system, the @option{-T} option may be required
8905 when linking to avoid references to undefined symbols.
8906
8907 @item -Xlinker @var{option}
8908 @opindex Xlinker
8909 Pass @var{option} as an option to the linker.  You can use this to
8910 supply system-specific linker options which GCC does not know how to
8911 recognize.
8912
8913 If you want to pass an option that takes a separate argument, you must use
8914 @option{-Xlinker} twice, once for the option and once for the argument.
8915 For example, to pass @option{-assert definitions}, you must write
8916 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8917 @option{-Xlinker "-assert definitions"}, because this passes the entire
8918 string as a single argument, which is not what the linker expects.
8919
8920 When using the GNU linker, it is usually more convenient to pass
8921 arguments to linker options using the @option{@var{option}=@var{value}}
8922 syntax than as separate arguments.  For example, you can specify
8923 @samp{-Xlinker -Map=output.map} rather than
8924 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
8925 this syntax for command-line options.
8926
8927 @item -Wl,@var{option}
8928 @opindex Wl
8929 Pass @var{option} as an option to the linker.  If @var{option} contains
8930 commas, it is split into multiple options at the commas.  You can use this
8931 syntax to pass an argument to the option.
8932 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
8933 linker.  When using the GNU linker, you can also get the same effect with
8934 @samp{-Wl,-Map=output.map}.
8935
8936 @item -u @var{symbol}
8937 @opindex u
8938 Pretend the symbol @var{symbol} is undefined, to force linking of
8939 library modules to define it.  You can use @option{-u} multiple times with
8940 different symbols to force loading of additional library modules.
8941 @end table
8942
8943 @node Directory Options
8944 @section Options for Directory Search
8945 @cindex directory options
8946 @cindex options, directory search
8947 @cindex search path
8948
8949 These options specify directories to search for header files, for
8950 libraries and for parts of the compiler:
8951
8952 @table @gcctabopt
8953 @item -I@var{dir}
8954 @opindex I
8955 Add the directory @var{dir} to the head of the list of directories to be
8956 searched for header files.  This can be used to override a system header
8957 file, substituting your own version, since these directories are
8958 searched before the system header file directories.  However, you should
8959 not use this option to add directories that contain vendor-supplied
8960 system header files (use @option{-isystem} for that).  If you use more than
8961 one @option{-I} option, the directories are scanned in left-to-right
8962 order; the standard system directories come after.
8963
8964 If a standard system include directory, or a directory specified with
8965 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8966 option will be ignored.  The directory will still be searched but as a
8967 system directory at its normal position in the system include chain.
8968 This is to ensure that GCC's procedure to fix buggy system headers and
8969 the ordering for the include_next directive are not inadvertently changed.
8970 If you really need to change the search order for system directories,
8971 use the @option{-nostdinc} and/or @option{-isystem} options.
8972
8973 @item -iplugindir=@var{dir}
8974 Set the directory to search for plugins which are passed
8975 by @option{-fplugin=@var{name}} instead of
8976 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
8977 to be used by the user, but only passed by the driver.
8978
8979 @item -iquote@var{dir}
8980 @opindex iquote
8981 Add the directory @var{dir} to the head of the list of directories to
8982 be searched for header files only for the case of @samp{#include
8983 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8984 otherwise just like @option{-I}.
8985
8986 @item -L@var{dir}
8987 @opindex L
8988 Add directory @var{dir} to the list of directories to be searched
8989 for @option{-l}.
8990
8991 @item -B@var{prefix}
8992 @opindex B
8993 This option specifies where to find the executables, libraries,
8994 include files, and data files of the compiler itself.
8995
8996 The compiler driver program runs one or more of the subprograms
8997 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8998 @var{prefix} as a prefix for each program it tries to run, both with and
8999 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
9000
9001 For each subprogram to be run, the compiler driver first tries the
9002 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
9003 was not specified, the driver tries two standard prefixes, which are
9004 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
9005 those results in a file name that is found, the unmodified program
9006 name is searched for using the directories specified in your
9007 @env{PATH} environment variable.
9008
9009 The compiler will check to see if the path provided by the @option{-B}
9010 refers to a directory, and if necessary it will add a directory
9011 separator character at the end of the path.
9012
9013 @option{-B} prefixes that effectively specify directory names also apply
9014 to libraries in the linker, because the compiler translates these
9015 options into @option{-L} options for the linker.  They also apply to
9016 includes files in the preprocessor, because the compiler translates these
9017 options into @option{-isystem} options for the preprocessor.  In this case,
9018 the compiler appends @samp{include} to the prefix.
9019
9020 The run-time support file @file{libgcc.a} can also be searched for using
9021 the @option{-B} prefix, if needed.  If it is not found there, the two
9022 standard prefixes above are tried, and that is all.  The file is left
9023 out of the link if it is not found by those means.
9024
9025 Another way to specify a prefix much like the @option{-B} prefix is to use
9026 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
9027 Variables}.
9028
9029 As a special kludge, if the path provided by @option{-B} is
9030 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
9031 9, then it will be replaced by @file{[dir/]include}.  This is to help
9032 with boot-strapping the compiler.
9033
9034 @item -specs=@var{file}
9035 @opindex specs
9036 Process @var{file} after the compiler reads in the standard @file{specs}
9037 file, in order to override the defaults that the @file{gcc} driver
9038 program uses when determining what switches to pass to @file{cc1},
9039 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
9040 @option{-specs=@var{file}} can be specified on the command line, and they
9041 are processed in order, from left to right.
9042
9043 @item --sysroot=@var{dir}
9044 @opindex sysroot
9045 Use @var{dir} as the logical root directory for headers and libraries.
9046 For example, if the compiler would normally search for headers in
9047 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
9048 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
9049
9050 If you use both this option and the @option{-isysroot} option, then
9051 the @option{--sysroot} option will apply to libraries, but the
9052 @option{-isysroot} option will apply to header files.
9053
9054 The GNU linker (beginning with version 2.16) has the necessary support
9055 for this option.  If your linker does not support this option, the
9056 header file aspect of @option{--sysroot} will still work, but the
9057 library aspect will not.
9058
9059 @item -I-
9060 @opindex I-
9061 This option has been deprecated.  Please use @option{-iquote} instead for
9062 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
9063 Any directories you specify with @option{-I} options before the @option{-I-}
9064 option are searched only for the case of @samp{#include "@var{file}"};
9065 they are not searched for @samp{#include <@var{file}>}.
9066
9067 If additional directories are specified with @option{-I} options after
9068 the @option{-I-}, these directories are searched for all @samp{#include}
9069 directives.  (Ordinarily @emph{all} @option{-I} directories are used
9070 this way.)
9071
9072 In addition, the @option{-I-} option inhibits the use of the current
9073 directory (where the current input file came from) as the first search
9074 directory for @samp{#include "@var{file}"}.  There is no way to
9075 override this effect of @option{-I-}.  With @option{-I.} you can specify
9076 searching the directory which was current when the compiler was
9077 invoked.  That is not exactly the same as what the preprocessor does
9078 by default, but it is often satisfactory.
9079
9080 @option{-I-} does not inhibit the use of the standard system directories
9081 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
9082 independent.
9083 @end table
9084
9085 @c man end
9086
9087 @node Spec Files
9088 @section Specifying subprocesses and the switches to pass to them
9089 @cindex Spec Files
9090
9091 @command{gcc} is a driver program.  It performs its job by invoking a
9092 sequence of other programs to do the work of compiling, assembling and
9093 linking.  GCC interprets its command-line parameters and uses these to
9094 deduce which programs it should invoke, and which command-line options
9095 it ought to place on their command lines.  This behavior is controlled
9096 by @dfn{spec strings}.  In most cases there is one spec string for each
9097 program that GCC can invoke, but a few programs have multiple spec
9098 strings to control their behavior.  The spec strings built into GCC can
9099 be overridden by using the @option{-specs=} command-line switch to specify
9100 a spec file.
9101
9102 @dfn{Spec files} are plaintext files that are used to construct spec
9103 strings.  They consist of a sequence of directives separated by blank
9104 lines.  The type of directive is determined by the first non-whitespace
9105 character on the line and it can be one of the following:
9106
9107 @table @code
9108 @item %@var{command}
9109 Issues a @var{command} to the spec file processor.  The commands that can
9110 appear here are:
9111
9112 @table @code
9113 @item %include <@var{file}>
9114 @cindex %include
9115 Search for @var{file} and insert its text at the current point in the
9116 specs file.
9117
9118 @item %include_noerr <@var{file}>
9119 @cindex %include_noerr
9120 Just like @samp{%include}, but do not generate an error message if the include
9121 file cannot be found.
9122
9123 @item %rename @var{old_name} @var{new_name}
9124 @cindex %rename
9125 Rename the spec string @var{old_name} to @var{new_name}.
9126
9127 @end table
9128
9129 @item *[@var{spec_name}]:
9130 This tells the compiler to create, override or delete the named spec
9131 string.  All lines after this directive up to the next directive or
9132 blank line are considered to be the text for the spec string.  If this
9133 results in an empty string then the spec will be deleted.  (Or, if the
9134 spec did not exist, then nothing will happened.)  Otherwise, if the spec
9135 does not currently exist a new spec will be created.  If the spec does
9136 exist then its contents will be overridden by the text of this
9137 directive, unless the first character of that text is the @samp{+}
9138 character, in which case the text will be appended to the spec.
9139
9140 @item [@var{suffix}]:
9141 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
9142 and up to the next directive or blank line are considered to make up the
9143 spec string for the indicated suffix.  When the compiler encounters an
9144 input file with the named suffix, it will processes the spec string in
9145 order to work out how to compile that file.  For example:
9146
9147 @smallexample
9148 .ZZ:
9149 z-compile -input %i
9150 @end smallexample
9151
9152 This says that any input file whose name ends in @samp{.ZZ} should be
9153 passed to the program @samp{z-compile}, which should be invoked with the
9154 command-line switch @option{-input} and with the result of performing the
9155 @samp{%i} substitution.  (See below.)
9156
9157 As an alternative to providing a spec string, the text that follows a
9158 suffix directive can be one of the following:
9159
9160 @table @code
9161 @item @@@var{language}
9162 This says that the suffix is an alias for a known @var{language}.  This is
9163 similar to using the @option{-x} command-line switch to GCC to specify a
9164 language explicitly.  For example:
9165
9166 @smallexample
9167 .ZZ:
9168 @@c++
9169 @end smallexample
9170
9171 Says that .ZZ files are, in fact, C++ source files.
9172
9173 @item #@var{name}
9174 This causes an error messages saying:
9175
9176 @smallexample
9177 @var{name} compiler not installed on this system.
9178 @end smallexample
9179 @end table
9180
9181 GCC already has an extensive list of suffixes built into it.
9182 This directive will add an entry to the end of the list of suffixes, but
9183 since the list is searched from the end backwards, it is effectively
9184 possible to override earlier entries using this technique.
9185
9186 @end table
9187
9188 GCC has the following spec strings built into it.  Spec files can
9189 override these strings or create their own.  Note that individual
9190 targets can also add their own spec strings to this list.
9191
9192 @smallexample
9193 asm          Options to pass to the assembler
9194 asm_final    Options to pass to the assembler post-processor
9195 cpp          Options to pass to the C preprocessor
9196 cc1          Options to pass to the C compiler
9197 cc1plus      Options to pass to the C++ compiler
9198 endfile      Object files to include at the end of the link
9199 link         Options to pass to the linker
9200 lib          Libraries to include on the command line to the linker
9201 libgcc       Decides which GCC support library to pass to the linker
9202 linker       Sets the name of the linker
9203 predefines   Defines to be passed to the C preprocessor
9204 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9205              by default
9206 startfile    Object files to include at the start of the link
9207 @end smallexample
9208
9209 Here is a small example of a spec file:
9210
9211 @smallexample
9212 %rename lib                 old_lib
9213
9214 *lib:
9215 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9216 @end smallexample
9217
9218 This example renames the spec called @samp{lib} to @samp{old_lib} and
9219 then overrides the previous definition of @samp{lib} with a new one.
9220 The new definition adds in some extra command-line options before
9221 including the text of the old definition.
9222
9223 @dfn{Spec strings} are a list of command-line options to be passed to their
9224 corresponding program.  In addition, the spec strings can contain
9225 @samp{%}-prefixed sequences to substitute variable text or to
9226 conditionally insert text into the command line.  Using these constructs
9227 it is possible to generate quite complex command lines.
9228
9229 Here is a table of all defined @samp{%}-sequences for spec
9230 strings.  Note that spaces are not generated automatically around the
9231 results of expanding these sequences.  Therefore you can concatenate them
9232 together or combine them with constant text in a single argument.
9233
9234 @table @code
9235 @item %%
9236 Substitute one @samp{%} into the program name or argument.
9237
9238 @item %i
9239 Substitute the name of the input file being processed.
9240
9241 @item %b
9242 Substitute the basename of the input file being processed.
9243 This is the substring up to (and not including) the last period
9244 and not including the directory.
9245
9246 @item %B
9247 This is the same as @samp{%b}, but include the file suffix (text after
9248 the last period).
9249
9250 @item %d
9251 Marks the argument containing or following the @samp{%d} as a
9252 temporary file name, so that that file will be deleted if GCC exits
9253 successfully.  Unlike @samp{%g}, this contributes no text to the
9254 argument.
9255
9256 @item %g@var{suffix}
9257 Substitute a file name that has suffix @var{suffix} and is chosen
9258 once per compilation, and mark the argument in the same way as
9259 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9260 name is now chosen in a way that is hard to predict even when previously
9261 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9262 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9263 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9264 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9265 was simply substituted with a file name chosen once per compilation,
9266 without regard to any appended suffix (which was therefore treated
9267 just like ordinary text), making such attacks more likely to succeed.
9268
9269 @item %u@var{suffix}
9270 Like @samp{%g}, but generates a new temporary file name even if
9271 @samp{%u@var{suffix}} was already seen.
9272
9273 @item %U@var{suffix}
9274 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9275 new one if there is no such last file name.  In the absence of any
9276 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9277 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9278 would involve the generation of two distinct file names, one
9279 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9280 simply substituted with a file name chosen for the previous @samp{%u},
9281 without regard to any appended suffix.
9282
9283 @item %j@var{suffix}
9284 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9285 writable, and if save-temps is off; otherwise, substitute the name
9286 of a temporary file, just like @samp{%u}.  This temporary file is not
9287 meant for communication between processes, but rather as a junk
9288 disposal mechanism.
9289
9290 @item %|@var{suffix}
9291 @itemx %m@var{suffix}
9292 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9293 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9294 all.  These are the two most common ways to instruct a program that it
9295 should read from standard input or write to standard output.  If you
9296 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9297 construct: see for example @file{f/lang-specs.h}.
9298
9299 @item %.@var{SUFFIX}
9300 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9301 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9302 terminated by the next space or %.
9303
9304 @item %w
9305 Marks the argument containing or following the @samp{%w} as the
9306 designated output file of this compilation.  This puts the argument
9307 into the sequence of arguments that @samp{%o} will substitute later.
9308
9309 @item %o
9310 Substitutes the names of all the output files, with spaces
9311 automatically placed around them.  You should write spaces
9312 around the @samp{%o} as well or the results are undefined.
9313 @samp{%o} is for use in the specs for running the linker.
9314 Input files whose names have no recognized suffix are not compiled
9315 at all, but they are included among the output files, so they will
9316 be linked.
9317
9318 @item %O
9319 Substitutes the suffix for object files.  Note that this is
9320 handled specially when it immediately follows @samp{%g, %u, or %U},
9321 because of the need for those to form complete file names.  The
9322 handling is such that @samp{%O} is treated exactly as if it had already
9323 been substituted, except that @samp{%g, %u, and %U} do not currently
9324 support additional @var{suffix} characters following @samp{%O} as they would
9325 following, for example, @samp{.o}.
9326
9327 @item %p
9328 Substitutes the standard macro predefinitions for the
9329 current target machine.  Use this when running @code{cpp}.
9330
9331 @item %P
9332 Like @samp{%p}, but puts @samp{__} before and after the name of each
9333 predefined macro, except for macros that start with @samp{__} or with
9334 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9335 C@.
9336
9337 @item %I
9338 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9339 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9340 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9341 and @option{-imultilib} as necessary.
9342
9343 @item %s
9344 Current argument is the name of a library or startup file of some sort.
9345 Search for that file in a standard list of directories and substitute
9346 the full name found.  The current working directory is included in the
9347 list of directories scanned.
9348
9349 @item %T
9350 Current argument is the name of a linker script.  Search for that file
9351 in the current list of directories to scan for libraries. If the file
9352 is located insert a @option{--script} option into the command line
9353 followed by the full path name found.  If the file is not found then
9354 generate an error message.  Note: the current working directory is not
9355 searched.
9356
9357 @item %e@var{str}
9358 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9359 Use this when inconsistent options are detected.
9360
9361 @item %(@var{name})
9362 Substitute the contents of spec string @var{name} at this point.
9363
9364 @item %[@var{name}]
9365 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9366
9367 @item %x@{@var{option}@}
9368 Accumulate an option for @samp{%X}.
9369
9370 @item %X
9371 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9372 spec string.
9373
9374 @item %Y
9375 Output the accumulated assembler options specified by @option{-Wa}.
9376
9377 @item %Z
9378 Output the accumulated preprocessor options specified by @option{-Wp}.
9379
9380 @item %a
9381 Process the @code{asm} spec.  This is used to compute the
9382 switches to be passed to the assembler.
9383
9384 @item %A
9385 Process the @code{asm_final} spec.  This is a spec string for
9386 passing switches to an assembler post-processor, if such a program is
9387 needed.
9388
9389 @item %l
9390 Process the @code{link} spec.  This is the spec for computing the
9391 command line passed to the linker.  Typically it will make use of the
9392 @samp{%L %G %S %D and %E} sequences.
9393
9394 @item %D
9395 Dump out a @option{-L} option for each directory that GCC believes might
9396 contain startup files.  If the target supports multilibs then the
9397 current multilib directory will be prepended to each of these paths.
9398
9399 @item %L
9400 Process the @code{lib} spec.  This is a spec string for deciding which
9401 libraries should be included on the command line to the linker.
9402
9403 @item %G
9404 Process the @code{libgcc} spec.  This is a spec string for deciding
9405 which GCC support library should be included on the command line to the linker.
9406
9407 @item %S
9408 Process the @code{startfile} spec.  This is a spec for deciding which
9409 object files should be the first ones passed to the linker.  Typically
9410 this might be a file named @file{crt0.o}.
9411
9412 @item %E
9413 Process the @code{endfile} spec.  This is a spec string that specifies
9414 the last object files that will be passed to the linker.
9415
9416 @item %C
9417 Process the @code{cpp} spec.  This is used to construct the arguments
9418 to be passed to the C preprocessor.
9419
9420 @item %1
9421 Process the @code{cc1} spec.  This is used to construct the options to be
9422 passed to the actual C compiler (@samp{cc1}).
9423
9424 @item %2
9425 Process the @code{cc1plus} spec.  This is used to construct the options to be
9426 passed to the actual C++ compiler (@samp{cc1plus}).
9427
9428 @item %*
9429 Substitute the variable part of a matched option.  See below.
9430 Note that each comma in the substituted string is replaced by
9431 a single space.
9432
9433 @item %<@code{S}
9434 Remove all occurrences of @code{-S} from the command line.  Note---this
9435 command is position dependent.  @samp{%} commands in the spec string
9436 before this one will see @code{-S}, @samp{%} commands in the spec string
9437 after this one will not.
9438
9439 @item %:@var{function}(@var{args})
9440 Call the named function @var{function}, passing it @var{args}.
9441 @var{args} is first processed as a nested spec string, then split
9442 into an argument vector in the usual fashion.  The function returns
9443 a string which is processed as if it had appeared literally as part
9444 of the current spec.
9445
9446 The following built-in spec functions are provided:
9447
9448 @table @code
9449 @item @code{getenv}
9450 The @code{getenv} spec function takes two arguments: an environment
9451 variable name and a string.  If the environment variable is not
9452 defined, a fatal error is issued.  Otherwise, the return value is the
9453 value of the environment variable concatenated with the string.  For
9454 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9455
9456 @smallexample
9457 %:getenv(TOPDIR /include)
9458 @end smallexample
9459
9460 expands to @file{/path/to/top/include}.
9461
9462 @item @code{if-exists}
9463 The @code{if-exists} spec function takes one argument, an absolute
9464 pathname to a file.  If the file exists, @code{if-exists} returns the
9465 pathname.  Here is a small example of its usage:
9466
9467 @smallexample
9468 *startfile:
9469 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9470 @end smallexample
9471
9472 @item @code{if-exists-else}
9473 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9474 spec function, except that it takes two arguments.  The first argument is
9475 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9476 returns the pathname.  If it does not exist, it returns the second argument.
9477 This way, @code{if-exists-else} can be used to select one file or another,
9478 based on the existence of the first.  Here is a small example of its usage:
9479
9480 @smallexample
9481 *startfile:
9482 crt0%O%s %:if-exists(crti%O%s) \
9483 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9484 @end smallexample
9485
9486 @item @code{replace-outfile}
9487 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9488 first argument in the outfiles array and replaces it with the second argument.  Here
9489 is a small example of its usage:
9490
9491 @smallexample
9492 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9493 @end smallexample
9494
9495 @item @code{print-asm-header}
9496 The @code{print-asm-header} function takes no arguments and simply
9497 prints a banner like:
9498
9499 @smallexample
9500 Assembler options
9501 =================
9502
9503 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9504 @end smallexample
9505
9506 It is used to separate compiler options from assembler options
9507 in the @option{--target-help} output.
9508 @end table
9509
9510 @item %@{@code{S}@}
9511 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9512 If that switch was not specified, this substitutes nothing.  Note that
9513 the leading dash is omitted when specifying this option, and it is
9514 automatically inserted if the substitution is performed.  Thus the spec
9515 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9516 and would output the command line option @option{-foo}.
9517
9518 @item %W@{@code{S}@}
9519 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9520 deleted on failure.
9521
9522 @item %@{@code{S}*@}
9523 Substitutes all the switches specified to GCC whose names start
9524 with @code{-S}, but which also take an argument.  This is used for
9525 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9526 GCC considers @option{-o foo} as being
9527 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9528 text, including the space.  Thus two arguments would be generated.
9529
9530 @item %@{@code{S}*&@code{T}*@}
9531 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9532 (the order of @code{S} and @code{T} in the spec is not significant).
9533 There can be any number of ampersand-separated variables; for each the
9534 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9535
9536 @item %@{@code{S}:@code{X}@}
9537 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9538
9539 @item %@{!@code{S}:@code{X}@}
9540 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9541
9542 @item %@{@code{S}*:@code{X}@}
9543 Substitutes @code{X} if one or more switches whose names start with
9544 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9545 once, no matter how many such switches appeared.  However, if @code{%*}
9546 appears somewhere in @code{X}, then @code{X} will be substituted once
9547 for each matching switch, with the @code{%*} replaced by the part of
9548 that switch that matched the @code{*}.
9549
9550 @item %@{.@code{S}:@code{X}@}
9551 Substitutes @code{X}, if processing a file with suffix @code{S}.
9552
9553 @item %@{!.@code{S}:@code{X}@}
9554 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9555
9556 @item %@{,@code{S}:@code{X}@}
9557 Substitutes @code{X}, if processing a file for language @code{S}.
9558
9559 @item %@{!,@code{S}:@code{X}@}
9560 Substitutes @code{X}, if not processing a file for language @code{S}.
9561
9562 @item %@{@code{S}|@code{P}:@code{X}@}
9563 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9564 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9565 @code{*} sequences as well, although they have a stronger binding than
9566 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9567 alternatives must be starred, and only the first matching alternative
9568 is substituted.
9569
9570 For example, a spec string like this:
9571
9572 @smallexample
9573 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9574 @end smallexample
9575
9576 will output the following command-line options from the following input
9577 command-line options:
9578
9579 @smallexample
9580 fred.c        -foo -baz
9581 jim.d         -bar -boggle
9582 -d fred.c     -foo -baz -boggle
9583 -d jim.d      -bar -baz -boggle
9584 @end smallexample
9585
9586 @item %@{S:X; T:Y; :D@}
9587
9588 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9589 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9590 be as many clauses as you need.  This may be combined with @code{.},
9591 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9592
9593
9594 @end table
9595
9596 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9597 construct may contain other nested @samp{%} constructs or spaces, or
9598 even newlines.  They are processed as usual, as described above.
9599 Trailing white space in @code{X} is ignored.  White space may also
9600 appear anywhere on the left side of the colon in these constructs,
9601 except between @code{.} or @code{*} and the corresponding word.
9602
9603 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9604 handled specifically in these constructs.  If another value of
9605 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9606 @option{-W} switch is found later in the command line, the earlier
9607 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9608 just one letter, which passes all matching options.
9609
9610 The character @samp{|} at the beginning of the predicate text is used to
9611 indicate that a command should be piped to the following command, but
9612 only if @option{-pipe} is specified.
9613
9614 It is built into GCC which switches take arguments and which do not.
9615 (You might think it would be useful to generalize this to allow each
9616 compiler's spec to say which switches take arguments.  But this cannot
9617 be done in a consistent fashion.  GCC cannot even decide which input
9618 files have been specified without knowing which switches take arguments,
9619 and it must know which input files to compile in order to tell which
9620 compilers to run).
9621
9622 GCC also knows implicitly that arguments starting in @option{-l} are to be
9623 treated as compiler output files, and passed to the linker in their
9624 proper position among the other output files.
9625
9626 @c man begin OPTIONS
9627
9628 @node Target Options
9629 @section Specifying Target Machine and Compiler Version
9630 @cindex target options
9631 @cindex cross compiling
9632 @cindex specifying machine version
9633 @cindex specifying compiler version and target machine
9634 @cindex compiler version, specifying
9635 @cindex target machine, specifying
9636
9637 The usual way to run GCC is to run the executable called @file{gcc}, or
9638 @file{<machine>-gcc} when cross-compiling, or
9639 @file{<machine>-gcc-<version>} to run a version other than the one that
9640 was installed last.
9641
9642 @node Submodel Options
9643 @section Hardware Models and Configurations
9644 @cindex submodel options
9645 @cindex specifying hardware config
9646 @cindex hardware models and configurations, specifying
9647 @cindex machine dependent options
9648
9649 Each target machine types can have its own
9650 special options, starting with @samp{-m}, to choose among various
9651 hardware models or configurations---for example, 68010 vs 68020,
9652 floating coprocessor or none.  A single installed version of the
9653 compiler can compile for any model or configuration, according to the
9654 options specified.
9655
9656 Some configurations of the compiler also support additional special
9657 options, usually for compatibility with other compilers on the same
9658 platform.
9659
9660 @c This list is ordered alphanumerically by subsection name.
9661 @c It should be the same order and spelling as these options are listed
9662 @c in Machine Dependent Options
9663
9664 @menu
9665 * ARC Options::
9666 * ARM Options::
9667 * AVR Options::
9668 * Blackfin Options::
9669 * CRIS Options::
9670 * CRX Options::
9671 * Darwin Options::
9672 * DEC Alpha Options::
9673 * DEC Alpha/VMS Options::
9674 * FR30 Options::
9675 * FRV Options::
9676 * GNU/Linux Options::
9677 * H8/300 Options::
9678 * HPPA Options::
9679 * i386 and x86-64 Options::
9680 * i386 and x86-64 Windows Options::
9681 * IA-64 Options::
9682 * IA-64/VMS Options::
9683 * LM32 Options::
9684 * M32C Options::
9685 * M32R/D Options::
9686 * M680x0 Options::
9687 * M68hc1x Options::
9688 * MCore Options::
9689 * MeP Options::
9690 * MIPS Options::
9691 * MMIX Options::
9692 * MN10300 Options::
9693 * PDP-11 Options::
9694 * picoChip Options::
9695 * PowerPC Options::
9696 * RS/6000 and PowerPC Options::
9697 * RX Options::
9698 * S/390 and zSeries Options::
9699 * Score Options::
9700 * SH Options::
9701 * SPARC Options::
9702 * SPU Options::
9703 * System V Options::
9704 * V850 Options::
9705 * VAX Options::
9706 * VxWorks Options::
9707 * x86-64 Options::
9708 * Xstormy16 Options::
9709 * Xtensa Options::
9710 * zSeries Options::
9711 @end menu
9712
9713 @node ARC Options
9714 @subsection ARC Options
9715 @cindex ARC Options
9716
9717 These options are defined for ARC implementations:
9718
9719 @table @gcctabopt
9720 @item -EL
9721 @opindex EL
9722 Compile code for little endian mode.  This is the default.
9723
9724 @item -EB
9725 @opindex EB
9726 Compile code for big endian mode.
9727
9728 @item -mmangle-cpu
9729 @opindex mmangle-cpu
9730 Prepend the name of the cpu to all public symbol names.
9731 In multiple-processor systems, there are many ARC variants with different
9732 instruction and register set characteristics.  This flag prevents code
9733 compiled for one cpu to be linked with code compiled for another.
9734 No facility exists for handling variants that are ``almost identical''.
9735 This is an all or nothing option.
9736
9737 @item -mcpu=@var{cpu}
9738 @opindex mcpu
9739 Compile code for ARC variant @var{cpu}.
9740 Which variants are supported depend on the configuration.
9741 All variants support @option{-mcpu=base}, this is the default.
9742
9743 @item -mtext=@var{text-section}
9744 @itemx -mdata=@var{data-section}
9745 @itemx -mrodata=@var{readonly-data-section}
9746 @opindex mtext
9747 @opindex mdata
9748 @opindex mrodata
9749 Put functions, data, and readonly data in @var{text-section},
9750 @var{data-section}, and @var{readonly-data-section} respectively
9751 by default.  This can be overridden with the @code{section} attribute.
9752 @xref{Variable Attributes}.
9753
9754 @end table
9755
9756 @node ARM Options
9757 @subsection ARM Options
9758 @cindex ARM options
9759
9760 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9761 architectures:
9762
9763 @table @gcctabopt
9764 @item -mabi=@var{name}
9765 @opindex mabi
9766 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9767 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9768
9769 @item -mapcs-frame
9770 @opindex mapcs-frame
9771 Generate a stack frame that is compliant with the ARM Procedure Call
9772 Standard for all functions, even if this is not strictly necessary for
9773 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9774 with this option will cause the stack frames not to be generated for
9775 leaf functions.  The default is @option{-mno-apcs-frame}.
9776
9777 @item -mapcs
9778 @opindex mapcs
9779 This is a synonym for @option{-mapcs-frame}.
9780
9781 @ignore
9782 @c not currently implemented
9783 @item -mapcs-stack-check
9784 @opindex mapcs-stack-check
9785 Generate code to check the amount of stack space available upon entry to
9786 every function (that actually uses some stack space).  If there is
9787 insufficient space available then either the function
9788 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9789 called, depending upon the amount of stack space required.  The run time
9790 system is required to provide these functions.  The default is
9791 @option{-mno-apcs-stack-check}, since this produces smaller code.
9792
9793 @c not currently implemented
9794 @item -mapcs-float
9795 @opindex mapcs-float
9796 Pass floating point arguments using the float point registers.  This is
9797 one of the variants of the APCS@.  This option is recommended if the
9798 target hardware has a floating point unit or if a lot of floating point
9799 arithmetic is going to be performed by the code.  The default is
9800 @option{-mno-apcs-float}, since integer only code is slightly increased in
9801 size if @option{-mapcs-float} is used.
9802
9803 @c not currently implemented
9804 @item -mapcs-reentrant
9805 @opindex mapcs-reentrant
9806 Generate reentrant, position independent code.  The default is
9807 @option{-mno-apcs-reentrant}.
9808 @end ignore
9809
9810 @item -mthumb-interwork
9811 @opindex mthumb-interwork
9812 Generate code which supports calling between the ARM and Thumb
9813 instruction sets.  Without this option the two instruction sets cannot
9814 be reliably used inside one program.  The default is
9815 @option{-mno-thumb-interwork}, since slightly larger code is generated
9816 when @option{-mthumb-interwork} is specified.
9817
9818 @item -mno-sched-prolog
9819 @opindex mno-sched-prolog
9820 Prevent the reordering of instructions in the function prolog, or the
9821 merging of those instruction with the instructions in the function's
9822 body.  This means that all functions will start with a recognizable set
9823 of instructions (or in fact one of a choice from a small set of
9824 different function prologues), and this information can be used to
9825 locate the start if functions inside an executable piece of code.  The
9826 default is @option{-msched-prolog}.
9827
9828 @item -mfloat-abi=@var{name}
9829 @opindex mfloat-abi
9830 Specifies which floating-point ABI to use.  Permissible values
9831 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9832
9833 Specifying @samp{soft} causes GCC to generate output containing
9834 library calls for floating-point operations.
9835 @samp{softfp} allows the generation of code using hardware floating-point
9836 instructions, but still uses the soft-float calling conventions.
9837 @samp{hard} allows generation of floating-point instructions
9838 and uses FPU-specific calling conventions.
9839
9840 The default depends on the specific target configuration.  Note that
9841 the hard-float and soft-float ABIs are not link-compatible; you must
9842 compile your entire program with the same ABI, and link with a
9843 compatible set of libraries.
9844
9845 @item -mhard-float
9846 @opindex mhard-float
9847 Equivalent to @option{-mfloat-abi=hard}.
9848
9849 @item -msoft-float
9850 @opindex msoft-float
9851 Equivalent to @option{-mfloat-abi=soft}.
9852
9853 @item -mlittle-endian
9854 @opindex mlittle-endian
9855 Generate code for a processor running in little-endian mode.  This is
9856 the default for all standard configurations.
9857
9858 @item -mbig-endian
9859 @opindex mbig-endian
9860 Generate code for a processor running in big-endian mode; the default is
9861 to compile code for a little-endian processor.
9862
9863 @item -mwords-little-endian
9864 @opindex mwords-little-endian
9865 This option only applies when generating code for big-endian processors.
9866 Generate code for a little-endian word order but a big-endian byte
9867 order.  That is, a byte order of the form @samp{32107654}.  Note: this
9868 option should only be used if you require compatibility with code for
9869 big-endian ARM processors generated by versions of the compiler prior to
9870 2.8.
9871
9872 @item -mcpu=@var{name}
9873 @opindex mcpu
9874 This specifies the name of the target ARM processor.  GCC uses this name
9875 to determine what kind of instructions it can emit when generating
9876 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
9877 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
9878 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
9879 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9880 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9881 @samp{arm720},
9882 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9883 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9884 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9885 @samp{strongarm1110},
9886 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9887 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9888 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9889 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9890 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9891 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9892 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9893 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9},
9894 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9895 @samp{cortex-m1},
9896 @samp{cortex-m0},
9897 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9898
9899 @item -mtune=@var{name}
9900 @opindex mtune
9901 This option is very similar to the @option{-mcpu=} option, except that
9902 instead of specifying the actual target processor type, and hence
9903 restricting which instructions can be used, it specifies that GCC should
9904 tune the performance of the code as if the target were of the type
9905 specified in this option, but still choosing the instructions that it
9906 will generate based on the cpu specified by a @option{-mcpu=} option.
9907 For some ARM implementations better performance can be obtained by using
9908 this option.
9909
9910 @item -march=@var{name}
9911 @opindex march
9912 This specifies the name of the target ARM architecture.  GCC uses this
9913 name to determine what kind of instructions it can emit when generating
9914 assembly code.  This option can be used in conjunction with or instead
9915 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9916 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9917 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9918 @samp{armv6}, @samp{armv6j},
9919 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9920 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9921 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9922
9923 @item -mfpu=@var{name}
9924 @itemx -mfpe=@var{number}
9925 @itemx -mfp=@var{number}
9926 @opindex mfpu
9927 @opindex mfpe
9928 @opindex mfp
9929 This specifies what floating point hardware (or hardware emulation) is
9930 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9931 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
9932 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
9933 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
9934 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
9935 @option{-mfp} and @option{-mfpe} are synonyms for
9936 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
9937 of GCC@.
9938
9939 If @option{-msoft-float} is specified this specifies the format of
9940 floating point values.
9941
9942 @item -mfp16-format=@var{name}
9943 @opindex mfp16-format
9944 Specify the format of the @code{__fp16} half-precision floating-point type.
9945 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
9946 the default is @samp{none}, in which case the @code{__fp16} type is not
9947 defined.  @xref{Half-Precision}, for more information.
9948
9949 @item -mstructure-size-boundary=@var{n}
9950 @opindex mstructure-size-boundary
9951 The size of all structures and unions will be rounded up to a multiple
9952 of the number of bits set by this option.  Permissible values are 8, 32
9953 and 64.  The default value varies for different toolchains.  For the COFF
9954 targeted toolchain the default value is 8.  A value of 64 is only allowed
9955 if the underlying ABI supports it.
9956
9957 Specifying the larger number can produce faster, more efficient code, but
9958 can also increase the size of the program.  Different values are potentially
9959 incompatible.  Code compiled with one value cannot necessarily expect to
9960 work with code or libraries compiled with another value, if they exchange
9961 information using structures or unions.
9962
9963 @item -mabort-on-noreturn
9964 @opindex mabort-on-noreturn
9965 Generate a call to the function @code{abort} at the end of a
9966 @code{noreturn} function.  It will be executed if the function tries to
9967 return.
9968
9969 @item -mlong-calls
9970 @itemx -mno-long-calls
9971 @opindex mlong-calls
9972 @opindex mno-long-calls
9973 Tells the compiler to perform function calls by first loading the
9974 address of the function into a register and then performing a subroutine
9975 call on this register.  This switch is needed if the target function
9976 will lie outside of the 64 megabyte addressing range of the offset based
9977 version of subroutine call instruction.
9978
9979 Even if this switch is enabled, not all function calls will be turned
9980 into long calls.  The heuristic is that static functions, functions
9981 which have the @samp{short-call} attribute, functions that are inside
9982 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9983 definitions have already been compiled within the current compilation
9984 unit, will not be turned into long calls.  The exception to this rule is
9985 that weak function definitions, functions with the @samp{long-call}
9986 attribute or the @samp{section} attribute, and functions that are within
9987 the scope of a @samp{#pragma long_calls} directive, will always be
9988 turned into long calls.
9989
9990 This feature is not enabled by default.  Specifying
9991 @option{-mno-long-calls} will restore the default behavior, as will
9992 placing the function calls within the scope of a @samp{#pragma
9993 long_calls_off} directive.  Note these switches have no effect on how
9994 the compiler generates code to handle function calls via function
9995 pointers.
9996
9997 @item -msingle-pic-base
9998 @opindex msingle-pic-base
9999 Treat the register used for PIC addressing as read-only, rather than
10000 loading it in the prologue for each function.  The run-time system is
10001 responsible for initializing this register with an appropriate value
10002 before execution begins.
10003
10004 @item -mpic-register=@var{reg}
10005 @opindex mpic-register
10006 Specify the register to be used for PIC addressing.  The default is R10
10007 unless stack-checking is enabled, when R9 is used.
10008
10009 @item -mcirrus-fix-invalid-insns
10010 @opindex mcirrus-fix-invalid-insns
10011 @opindex mno-cirrus-fix-invalid-insns
10012 Insert NOPs into the instruction stream to in order to work around
10013 problems with invalid Maverick instruction combinations.  This option
10014 is only valid if the @option{-mcpu=ep9312} option has been used to
10015 enable generation of instructions for the Cirrus Maverick floating
10016 point co-processor.  This option is not enabled by default, since the
10017 problem is only present in older Maverick implementations.  The default
10018 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
10019 switch.
10020
10021 @item -mpoke-function-name
10022 @opindex mpoke-function-name
10023 Write the name of each function into the text section, directly
10024 preceding the function prologue.  The generated code is similar to this:
10025
10026 @smallexample
10027      t0
10028          .ascii "arm_poke_function_name", 0
10029          .align
10030      t1
10031          .word 0xff000000 + (t1 - t0)
10032      arm_poke_function_name
10033          mov     ip, sp
10034          stmfd   sp!, @{fp, ip, lr, pc@}
10035          sub     fp, ip, #4
10036 @end smallexample
10037
10038 When performing a stack backtrace, code can inspect the value of
10039 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
10040 location @code{pc - 12} and the top 8 bits are set, then we know that
10041 there is a function name embedded immediately preceding this location
10042 and has length @code{((pc[-3]) & 0xff000000)}.
10043
10044 @item -mthumb
10045 @opindex mthumb
10046 Generate code for the Thumb instruction set.  The default is to
10047 use the 32-bit ARM instruction set.
10048 This option automatically enables either 16-bit Thumb-1 or
10049 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
10050 and @option{-march=@var{name}} options.  This option is not passed to the
10051 assembler. If you want to force assembler files to be interpreted as Thumb code,
10052 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
10053 option directly to the assembler by prefixing it with @option{-Wa}.
10054
10055 @item -mtpcs-frame
10056 @opindex mtpcs-frame
10057 Generate a stack frame that is compliant with the Thumb Procedure Call
10058 Standard for all non-leaf functions.  (A leaf function is one that does
10059 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
10060
10061 @item -mtpcs-leaf-frame
10062 @opindex mtpcs-leaf-frame
10063 Generate a stack frame that is compliant with the Thumb Procedure Call
10064 Standard for all leaf functions.  (A leaf function is one that does
10065 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
10066
10067 @item -mcallee-super-interworking
10068 @opindex mcallee-super-interworking
10069 Gives all externally visible functions in the file being compiled an ARM
10070 instruction set header which switches to Thumb mode before executing the
10071 rest of the function.  This allows these functions to be called from
10072 non-interworking code.  This option is not valid in AAPCS configurations
10073 because interworking is enabled by default.
10074
10075 @item -mcaller-super-interworking
10076 @opindex mcaller-super-interworking
10077 Allows calls via function pointers (including virtual functions) to
10078 execute correctly regardless of whether the target code has been
10079 compiled for interworking or not.  There is a small overhead in the cost
10080 of executing a function pointer if this option is enabled.  This option
10081 is not valid in AAPCS configurations because interworking is enabled
10082 by default.
10083
10084 @item -mtp=@var{name}
10085 @opindex mtp
10086 Specify the access model for the thread local storage pointer.  The valid
10087 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
10088 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
10089 (supported in the arm6k architecture), and @option{auto}, which uses the
10090 best available method for the selected processor.  The default setting is
10091 @option{auto}.
10092
10093 @item -mword-relocations
10094 @opindex mword-relocations
10095 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
10096 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
10097 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
10098 is specified.
10099
10100 @item -mfix-cortex-m3-ldrd
10101 @opindex mfix-cortex-m3-ldrd
10102 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
10103 with overlapping destination and base registers are used.  This option avoids
10104 generating these instructions.  This option is enabled by default when
10105 @option{-mcpu=cortex-m3} is specified.
10106
10107 @end table
10108
10109 @node AVR Options
10110 @subsection AVR Options
10111 @cindex AVR Options
10112
10113 These options are defined for AVR implementations:
10114
10115 @table @gcctabopt
10116 @item -mmcu=@var{mcu}
10117 @opindex mmcu
10118 Specify ATMEL AVR instruction set or MCU type.
10119
10120 Instruction set avr1 is for the minimal AVR core, not supported by the C
10121 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10122 attiny11, attiny12, attiny15, attiny28).
10123
10124 Instruction set avr2 (default) is for the classic AVR core with up to
10125 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10126 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10127 at90c8534, at90s8535).
10128
10129 Instruction set avr3 is for the classic AVR core with up to 128K program
10130 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10131
10132 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10133 memory space (MCU types: atmega8, atmega83, atmega85).
10134
10135 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10136 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10137 atmega64, atmega128, at43usb355, at94k).
10138
10139 @item -mno-interrupts
10140 @opindex mno-interrupts
10141 Generated code is not compatible with hardware interrupts.
10142 Code size will be smaller.
10143
10144 @item -mcall-prologues
10145 @opindex mcall-prologues
10146 Functions prologues/epilogues expanded as call to appropriate
10147 subroutines.  Code size will be smaller.
10148
10149 @item -mtiny-stack
10150 @opindex mtiny-stack
10151 Change only the low 8 bits of the stack pointer.
10152
10153 @item -mint8
10154 @opindex mint8
10155 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10156 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10157 and long long will be 4 bytes.  Please note that this option does not
10158 comply to the C standards, but it will provide you with smaller code
10159 size.
10160 @end table
10161
10162 @node Blackfin Options
10163 @subsection Blackfin Options
10164 @cindex Blackfin Options
10165
10166 @table @gcctabopt
10167 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10168 @opindex mcpu=
10169 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10170 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10171 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10172 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10173 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10174 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10175 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10176 @samp{bf561}.
10177 The optional @var{sirevision} specifies the silicon revision of the target
10178 Blackfin processor.  Any workarounds available for the targeted silicon revision
10179 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10180 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10181 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10182 hexadecimal digits representing the major and minor numbers in the silicon
10183 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10184 is not defined.  If @var{sirevision} is @samp{any}, the
10185 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10186 If this optional @var{sirevision} is not used, GCC assumes the latest known
10187 silicon revision of the targeted Blackfin processor.
10188
10189 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10190 Only the processor macro is defined.
10191 Without this option, @samp{bf532} is used as the processor by default.
10192 The corresponding predefined processor macros for @var{cpu} is to
10193 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10194 provided by libgloss to be linked in if @option{-msim} is not given.
10195
10196 @item -msim
10197 @opindex msim
10198 Specifies that the program will be run on the simulator.  This causes
10199 the simulator BSP provided by libgloss to be linked in.  This option
10200 has effect only for @samp{bfin-elf} toolchain.
10201 Certain other options, such as @option{-mid-shared-library} and
10202 @option{-mfdpic}, imply @option{-msim}.
10203
10204 @item -momit-leaf-frame-pointer
10205 @opindex momit-leaf-frame-pointer
10206 Don't keep the frame pointer in a register for leaf functions.  This
10207 avoids the instructions to save, set up and restore frame pointers and
10208 makes an extra register available in leaf functions.  The option
10209 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10210 which might make debugging harder.
10211
10212 @item -mspecld-anomaly
10213 @opindex mspecld-anomaly
10214 When enabled, the compiler will ensure that the generated code does not
10215 contain speculative loads after jump instructions. If this option is used,
10216 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10217
10218 @item -mno-specld-anomaly
10219 @opindex mno-specld-anomaly
10220 Don't generate extra code to prevent speculative loads from occurring.
10221
10222 @item -mcsync-anomaly
10223 @opindex mcsync-anomaly
10224 When enabled, the compiler will ensure that the generated code does not
10225 contain CSYNC or SSYNC instructions too soon after conditional branches.
10226 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10227
10228 @item -mno-csync-anomaly
10229 @opindex mno-csync-anomaly
10230 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10231 occurring too soon after a conditional branch.
10232
10233 @item -mlow-64k
10234 @opindex mlow-64k
10235 When enabled, the compiler is free to take advantage of the knowledge that
10236 the entire program fits into the low 64k of memory.
10237
10238 @item -mno-low-64k
10239 @opindex mno-low-64k
10240 Assume that the program is arbitrarily large.  This is the default.
10241
10242 @item -mstack-check-l1
10243 @opindex mstack-check-l1
10244 Do stack checking using information placed into L1 scratchpad memory by the
10245 uClinux kernel.
10246
10247 @item -mid-shared-library
10248 @opindex mid-shared-library
10249 Generate code that supports shared libraries via the library ID method.
10250 This allows for execute in place and shared libraries in an environment
10251 without virtual memory management.  This option implies @option{-fPIC}.
10252 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10253
10254 @item -mno-id-shared-library
10255 @opindex mno-id-shared-library
10256 Generate code that doesn't assume ID based shared libraries are being used.
10257 This is the default.
10258
10259 @item -mleaf-id-shared-library
10260 @opindex mleaf-id-shared-library
10261 Generate code that supports shared libraries via the library ID method,
10262 but assumes that this library or executable won't link against any other
10263 ID shared libraries.  That allows the compiler to use faster code for jumps
10264 and calls.
10265
10266 @item -mno-leaf-id-shared-library
10267 @opindex mno-leaf-id-shared-library
10268 Do not assume that the code being compiled won't link against any ID shared
10269 libraries.  Slower code will be generated for jump and call insns.
10270
10271 @item -mshared-library-id=n
10272 @opindex mshared-library-id
10273 Specified the identification number of the ID based shared library being
10274 compiled.  Specifying a value of 0 will generate more compact code, specifying
10275 other values will force the allocation of that number to the current
10276 library but is no more space or time efficient than omitting this option.
10277
10278 @item -msep-data
10279 @opindex msep-data
10280 Generate code that allows the data segment to be located in a different
10281 area of memory from the text segment.  This allows for execute in place in
10282 an environment without virtual memory management by eliminating relocations
10283 against the text section.
10284
10285 @item -mno-sep-data
10286 @opindex mno-sep-data
10287 Generate code that assumes that the data segment follows the text segment.
10288 This is the default.
10289
10290 @item -mlong-calls
10291 @itemx -mno-long-calls
10292 @opindex mlong-calls
10293 @opindex mno-long-calls
10294 Tells the compiler to perform function calls by first loading the
10295 address of the function into a register and then performing a subroutine
10296 call on this register.  This switch is needed if the target function
10297 will lie outside of the 24 bit addressing range of the offset based
10298 version of subroutine call instruction.
10299
10300 This feature is not enabled by default.  Specifying
10301 @option{-mno-long-calls} will restore the default behavior.  Note these
10302 switches have no effect on how the compiler generates code to handle
10303 function calls via function pointers.
10304
10305 @item -mfast-fp
10306 @opindex mfast-fp
10307 Link with the fast floating-point library. This library relaxes some of
10308 the IEEE floating-point standard's rules for checking inputs against
10309 Not-a-Number (NAN), in the interest of performance.
10310
10311 @item -minline-plt
10312 @opindex minline-plt
10313 Enable inlining of PLT entries in function calls to functions that are
10314 not known to bind locally.  It has no effect without @option{-mfdpic}.
10315
10316 @item -mmulticore
10317 @opindex mmulticore
10318 Build standalone application for multicore Blackfin processor. Proper
10319 start files and link scripts will be used to support multicore.
10320 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10321 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10322 @option{-mcorea} or @option{-mcoreb}. If it's used without
10323 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10324 programming model is used. In this model, the main function of Core B
10325 should be named as coreb_main. If it's used with @option{-mcorea} or
10326 @option{-mcoreb}, one application per core programming model is used.
10327 If this option is not used, single core application programming
10328 model is used.
10329
10330 @item -mcorea
10331 @opindex mcorea
10332 Build standalone application for Core A of BF561 when using
10333 one application per core programming model. Proper start files
10334 and link scripts will be used to support Core A. This option
10335 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10336
10337 @item -mcoreb
10338 @opindex mcoreb
10339 Build standalone application for Core B of BF561 when using
10340 one application per core programming model. Proper start files
10341 and link scripts will be used to support Core B. This option
10342 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10343 should be used instead of main. It must be used with
10344 @option{-mmulticore}.
10345
10346 @item -msdram
10347 @opindex msdram
10348 Build standalone application for SDRAM. Proper start files and
10349 link scripts will be used to put the application into SDRAM.
10350 Loader should initialize SDRAM before loading the application
10351 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10352
10353 @item -micplb
10354 @opindex micplb
10355 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10356 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10357 are enabled; for standalone applications the default is off.
10358 @end table
10359
10360 @node CRIS Options
10361 @subsection CRIS Options
10362 @cindex CRIS Options
10363
10364 These options are defined specifically for the CRIS ports.
10365
10366 @table @gcctabopt
10367 @item -march=@var{architecture-type}
10368 @itemx -mcpu=@var{architecture-type}
10369 @opindex march
10370 @opindex mcpu
10371 Generate code for the specified architecture.  The choices for
10372 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10373 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10374 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10375 @samp{v10}.
10376
10377 @item -mtune=@var{architecture-type}
10378 @opindex mtune
10379 Tune to @var{architecture-type} everything applicable about the generated
10380 code, except for the ABI and the set of available instructions.  The
10381 choices for @var{architecture-type} are the same as for
10382 @option{-march=@var{architecture-type}}.
10383
10384 @item -mmax-stack-frame=@var{n}
10385 @opindex mmax-stack-frame
10386 Warn when the stack frame of a function exceeds @var{n} bytes.
10387
10388 @item -metrax4
10389 @itemx -metrax100
10390 @opindex metrax4
10391 @opindex metrax100
10392 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10393 @option{-march=v3} and @option{-march=v8} respectively.
10394
10395 @item -mmul-bug-workaround
10396 @itemx -mno-mul-bug-workaround
10397 @opindex mmul-bug-workaround
10398 @opindex mno-mul-bug-workaround
10399 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10400 models where it applies.  This option is active by default.
10401
10402 @item -mpdebug
10403 @opindex mpdebug
10404 Enable CRIS-specific verbose debug-related information in the assembly
10405 code.  This option also has the effect to turn off the @samp{#NO_APP}
10406 formatted-code indicator to the assembler at the beginning of the
10407 assembly file.
10408
10409 @item -mcc-init
10410 @opindex mcc-init
10411 Do not use condition-code results from previous instruction; always emit
10412 compare and test instructions before use of condition codes.
10413
10414 @item -mno-side-effects
10415 @opindex mno-side-effects
10416 Do not emit instructions with side-effects in addressing modes other than
10417 post-increment.
10418
10419 @item -mstack-align
10420 @itemx -mno-stack-align
10421 @itemx -mdata-align
10422 @itemx -mno-data-align
10423 @itemx -mconst-align
10424 @itemx -mno-const-align
10425 @opindex mstack-align
10426 @opindex mno-stack-align
10427 @opindex mdata-align
10428 @opindex mno-data-align
10429 @opindex mconst-align
10430 @opindex mno-const-align
10431 These options (no-options) arranges (eliminate arrangements) for the
10432 stack-frame, individual data and constants to be aligned for the maximum
10433 single data access size for the chosen CPU model.  The default is to
10434 arrange for 32-bit alignment.  ABI details such as structure layout are
10435 not affected by these options.
10436
10437 @item -m32-bit
10438 @itemx -m16-bit
10439 @itemx -m8-bit
10440 @opindex m32-bit
10441 @opindex m16-bit
10442 @opindex m8-bit
10443 Similar to the stack- data- and const-align options above, these options
10444 arrange for stack-frame, writable data and constants to all be 32-bit,
10445 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10446
10447 @item -mno-prologue-epilogue
10448 @itemx -mprologue-epilogue
10449 @opindex mno-prologue-epilogue
10450 @opindex mprologue-epilogue
10451 With @option{-mno-prologue-epilogue}, the normal function prologue and
10452 epilogue that sets up the stack-frame are omitted and no return
10453 instructions or return sequences are generated in the code.  Use this
10454 option only together with visual inspection of the compiled code: no
10455 warnings or errors are generated when call-saved registers must be saved,
10456 or storage for local variable needs to be allocated.
10457
10458 @item -mno-gotplt
10459 @itemx -mgotplt
10460 @opindex mno-gotplt
10461 @opindex mgotplt
10462 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10463 instruction sequences that load addresses for functions from the PLT part
10464 of the GOT rather than (traditional on other architectures) calls to the
10465 PLT@.  The default is @option{-mgotplt}.
10466
10467 @item -melf
10468 @opindex melf
10469 Legacy no-op option only recognized with the cris-axis-elf and
10470 cris-axis-linux-gnu targets.
10471
10472 @item -mlinux
10473 @opindex mlinux
10474 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10475
10476 @item -sim
10477 @opindex sim
10478 This option, recognized for the cris-axis-elf arranges
10479 to link with input-output functions from a simulator library.  Code,
10480 initialized data and zero-initialized data are allocated consecutively.
10481
10482 @item -sim2
10483 @opindex sim2
10484 Like @option{-sim}, but pass linker options to locate initialized data at
10485 0x40000000 and zero-initialized data at 0x80000000.
10486 @end table
10487
10488 @node CRX Options
10489 @subsection CRX Options
10490 @cindex CRX Options
10491
10492 These options are defined specifically for the CRX ports.
10493
10494 @table @gcctabopt
10495
10496 @item -mmac
10497 @opindex mmac
10498 Enable the use of multiply-accumulate instructions. Disabled by default.
10499
10500 @item -mpush-args
10501 @opindex mpush-args
10502 Push instructions will be used to pass outgoing arguments when functions
10503 are called. Enabled by default.
10504 @end table
10505
10506 @node Darwin Options
10507 @subsection Darwin Options
10508 @cindex Darwin options
10509
10510 These options are defined for all architectures running the Darwin operating
10511 system.
10512
10513 FSF GCC on Darwin does not create ``fat'' object files; it will create
10514 an object file for the single architecture that it was built to
10515 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10516 @option{-arch} options are used; it does so by running the compiler or
10517 linker multiple times and joining the results together with
10518 @file{lipo}.
10519
10520 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10521 @samp{i686}) is determined by the flags that specify the ISA
10522 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10523 @option{-force_cpusubtype_ALL} option can be used to override this.
10524
10525 The Darwin tools vary in their behavior when presented with an ISA
10526 mismatch.  The assembler, @file{as}, will only permit instructions to
10527 be used that are valid for the subtype of the file it is generating,
10528 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10529 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10530 and print an error if asked to create a shared library with a less
10531 restrictive subtype than its input files (for instance, trying to put
10532 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10533 for executables, @file{ld}, will quietly give the executable the most
10534 restrictive subtype of any of its input files.
10535
10536 @table @gcctabopt
10537 @item -F@var{dir}
10538 @opindex F
10539 Add the framework directory @var{dir} to the head of the list of
10540 directories to be searched for header files.  These directories are
10541 interleaved with those specified by @option{-I} options and are
10542 scanned in a left-to-right order.
10543
10544 A framework directory is a directory with frameworks in it.  A
10545 framework is a directory with a @samp{"Headers"} and/or
10546 @samp{"PrivateHeaders"} directory contained directly in it that ends
10547 in @samp{".framework"}.  The name of a framework is the name of this
10548 directory excluding the @samp{".framework"}.  Headers associated with
10549 the framework are found in one of those two directories, with
10550 @samp{"Headers"} being searched first.  A subframework is a framework
10551 directory that is in a framework's @samp{"Frameworks"} directory.
10552 Includes of subframework headers can only appear in a header of a
10553 framework that contains the subframework, or in a sibling subframework
10554 header.  Two subframeworks are siblings if they occur in the same
10555 framework.  A subframework should not have the same name as a
10556 framework, a warning will be issued if this is violated.  Currently a
10557 subframework cannot have subframeworks, in the future, the mechanism
10558 may be extended to support this.  The standard frameworks can be found
10559 in @samp{"/System/Library/Frameworks"} and
10560 @samp{"/Library/Frameworks"}.  An example include looks like
10561 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10562 the name of the framework and header.h is found in the
10563 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10564
10565 @item -iframework@var{dir}
10566 @opindex iframework
10567 Like @option{-F} except the directory is a treated as a system
10568 directory.  The main difference between this @option{-iframework} and
10569 @option{-F} is that with @option{-iframework} the compiler does not
10570 warn about constructs contained within header files found via
10571 @var{dir}.  This option is valid only for the C family of languages.
10572
10573 @item -gused
10574 @opindex gused
10575 Emit debugging information for symbols that are used.  For STABS
10576 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10577 This is by default ON@.
10578
10579 @item -gfull
10580 @opindex gfull
10581 Emit debugging information for all symbols and types.
10582
10583 @item -mmacosx-version-min=@var{version}
10584 The earliest version of MacOS X that this executable will run on
10585 is @var{version}.  Typical values of @var{version} include @code{10.1},
10586 @code{10.2}, and @code{10.3.9}.
10587
10588 If the compiler was built to use the system's headers by default,
10589 then the default for this option is the system version on which the
10590 compiler is running, otherwise the default is to make choices which
10591 are compatible with as many systems and code bases as possible.
10592
10593 @item -mkernel
10594 @opindex mkernel
10595 Enable kernel development mode.  The @option{-mkernel} option sets
10596 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10597 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10598 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10599 applicable.  This mode also sets @option{-mno-altivec},
10600 @option{-msoft-float}, @option{-fno-builtin} and
10601 @option{-mlong-branch} for PowerPC targets.
10602
10603 @item -mone-byte-bool
10604 @opindex mone-byte-bool
10605 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10606 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10607 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10608 option has no effect on x86.
10609
10610 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10611 to generate code that is not binary compatible with code generated
10612 without that switch.  Using this switch may require recompiling all
10613 other modules in a program, including system libraries.  Use this
10614 switch to conform to a non-default data model.
10615
10616 @item -mfix-and-continue
10617 @itemx -ffix-and-continue
10618 @itemx -findirect-data
10619 @opindex mfix-and-continue
10620 @opindex ffix-and-continue
10621 @opindex findirect-data
10622 Generate code suitable for fast turn around development.  Needed to
10623 enable gdb to dynamically load @code{.o} files into already running
10624 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10625 are provided for backwards compatibility.
10626
10627 @item -all_load
10628 @opindex all_load
10629 Loads all members of static archive libraries.
10630 See man ld(1) for more information.
10631
10632 @item -arch_errors_fatal
10633 @opindex arch_errors_fatal
10634 Cause the errors having to do with files that have the wrong architecture
10635 to be fatal.
10636
10637 @item -bind_at_load
10638 @opindex bind_at_load
10639 Causes the output file to be marked such that the dynamic linker will
10640 bind all undefined references when the file is loaded or launched.
10641
10642 @item -bundle
10643 @opindex bundle
10644 Produce a Mach-o bundle format file.
10645 See man ld(1) for more information.
10646
10647 @item -bundle_loader @var{executable}
10648 @opindex bundle_loader
10649 This option specifies the @var{executable} that will be loading the build
10650 output file being linked.  See man ld(1) for more information.
10651
10652 @item -dynamiclib
10653 @opindex dynamiclib
10654 When passed this option, GCC will produce a dynamic library instead of
10655 an executable when linking, using the Darwin @file{libtool} command.
10656
10657 @item -force_cpusubtype_ALL
10658 @opindex force_cpusubtype_ALL
10659 This causes GCC's output file to have the @var{ALL} subtype, instead of
10660 one controlled by the @option{-mcpu} or @option{-march} option.
10661
10662 @item -allowable_client  @var{client_name}
10663 @itemx -client_name
10664 @itemx -compatibility_version
10665 @itemx -current_version
10666 @itemx -dead_strip
10667 @itemx -dependency-file
10668 @itemx -dylib_file
10669 @itemx -dylinker_install_name
10670 @itemx -dynamic
10671 @itemx -exported_symbols_list
10672 @itemx -filelist
10673 @itemx -flat_namespace
10674 @itemx -force_flat_namespace
10675 @itemx -headerpad_max_install_names
10676 @itemx -image_base
10677 @itemx -init
10678 @itemx -install_name
10679 @itemx -keep_private_externs
10680 @itemx -multi_module
10681 @itemx -multiply_defined
10682 @itemx -multiply_defined_unused
10683 @itemx -noall_load
10684 @itemx -no_dead_strip_inits_and_terms
10685 @itemx -nofixprebinding
10686 @itemx -nomultidefs
10687 @itemx -noprebind
10688 @itemx -noseglinkedit
10689 @itemx -pagezero_size
10690 @itemx -prebind
10691 @itemx -prebind_all_twolevel_modules
10692 @itemx -private_bundle
10693 @itemx -read_only_relocs
10694 @itemx -sectalign
10695 @itemx -sectobjectsymbols
10696 @itemx -whyload
10697 @itemx -seg1addr
10698 @itemx -sectcreate
10699 @itemx -sectobjectsymbols
10700 @itemx -sectorder
10701 @itemx -segaddr
10702 @itemx -segs_read_only_addr
10703 @itemx -segs_read_write_addr
10704 @itemx -seg_addr_table
10705 @itemx -seg_addr_table_filename
10706 @itemx -seglinkedit
10707 @itemx -segprot
10708 @itemx -segs_read_only_addr
10709 @itemx -segs_read_write_addr
10710 @itemx -single_module
10711 @itemx -static
10712 @itemx -sub_library
10713 @itemx -sub_umbrella
10714 @itemx -twolevel_namespace
10715 @itemx -umbrella
10716 @itemx -undefined
10717 @itemx -unexported_symbols_list
10718 @itemx -weak_reference_mismatches
10719 @itemx -whatsloaded
10720 @opindex allowable_client
10721 @opindex client_name
10722 @opindex compatibility_version
10723 @opindex current_version
10724 @opindex dead_strip
10725 @opindex dependency-file
10726 @opindex dylib_file
10727 @opindex dylinker_install_name
10728 @opindex dynamic
10729 @opindex exported_symbols_list
10730 @opindex filelist
10731 @opindex flat_namespace
10732 @opindex force_flat_namespace
10733 @opindex headerpad_max_install_names
10734 @opindex image_base
10735 @opindex init
10736 @opindex install_name
10737 @opindex keep_private_externs
10738 @opindex multi_module
10739 @opindex multiply_defined
10740 @opindex multiply_defined_unused
10741 @opindex noall_load
10742 @opindex no_dead_strip_inits_and_terms
10743 @opindex nofixprebinding
10744 @opindex nomultidefs
10745 @opindex noprebind
10746 @opindex noseglinkedit
10747 @opindex pagezero_size
10748 @opindex prebind
10749 @opindex prebind_all_twolevel_modules
10750 @opindex private_bundle
10751 @opindex read_only_relocs
10752 @opindex sectalign
10753 @opindex sectobjectsymbols
10754 @opindex whyload
10755 @opindex seg1addr
10756 @opindex sectcreate
10757 @opindex sectobjectsymbols
10758 @opindex sectorder
10759 @opindex segaddr
10760 @opindex segs_read_only_addr
10761 @opindex segs_read_write_addr
10762 @opindex seg_addr_table
10763 @opindex seg_addr_table_filename
10764 @opindex seglinkedit
10765 @opindex segprot
10766 @opindex segs_read_only_addr
10767 @opindex segs_read_write_addr
10768 @opindex single_module
10769 @opindex static
10770 @opindex sub_library
10771 @opindex sub_umbrella
10772 @opindex twolevel_namespace
10773 @opindex umbrella
10774 @opindex undefined
10775 @opindex unexported_symbols_list
10776 @opindex weak_reference_mismatches
10777 @opindex whatsloaded
10778 These options are passed to the Darwin linker.  The Darwin linker man page
10779 describes them in detail.
10780 @end table
10781
10782 @node DEC Alpha Options
10783 @subsection DEC Alpha Options
10784
10785 These @samp{-m} options are defined for the DEC Alpha implementations:
10786
10787 @table @gcctabopt
10788 @item -mno-soft-float
10789 @itemx -msoft-float
10790 @opindex mno-soft-float
10791 @opindex msoft-float
10792 Use (do not use) the hardware floating-point instructions for
10793 floating-point operations.  When @option{-msoft-float} is specified,
10794 functions in @file{libgcc.a} will be used to perform floating-point
10795 operations.  Unless they are replaced by routines that emulate the
10796 floating-point operations, or compiled in such a way as to call such
10797 emulations routines, these routines will issue floating-point
10798 operations.   If you are compiling for an Alpha without floating-point
10799 operations, you must ensure that the library is built so as not to call
10800 them.
10801
10802 Note that Alpha implementations without floating-point operations are
10803 required to have floating-point registers.
10804
10805 @item -mfp-reg
10806 @itemx -mno-fp-regs
10807 @opindex mfp-reg
10808 @opindex mno-fp-regs
10809 Generate code that uses (does not use) the floating-point register set.
10810 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10811 register set is not used, floating point operands are passed in integer
10812 registers as if they were integers and floating-point results are passed
10813 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10814 so any function with a floating-point argument or return value called by code
10815 compiled with @option{-mno-fp-regs} must also be compiled with that
10816 option.
10817
10818 A typical use of this option is building a kernel that does not use,
10819 and hence need not save and restore, any floating-point registers.
10820
10821 @item -mieee
10822 @opindex mieee
10823 The Alpha architecture implements floating-point hardware optimized for
10824 maximum performance.  It is mostly compliant with the IEEE floating
10825 point standard.  However, for full compliance, software assistance is
10826 required.  This option generates code fully IEEE compliant code
10827 @emph{except} that the @var{inexact-flag} is not maintained (see below).
10828 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
10829 defined during compilation.  The resulting code is less efficient but is
10830 able to correctly support denormalized numbers and exceptional IEEE
10831 values such as not-a-number and plus/minus infinity.  Other Alpha
10832 compilers call this option @option{-ieee_with_no_inexact}.
10833
10834 @item -mieee-with-inexact
10835 @opindex mieee-with-inexact
10836 This is like @option{-mieee} except the generated code also maintains
10837 the IEEE @var{inexact-flag}.  Turning on this option causes the
10838 generated code to implement fully-compliant IEEE math.  In addition to
10839 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
10840 macro.  On some Alpha implementations the resulting code may execute
10841 significantly slower than the code generated by default.  Since there is
10842 very little code that depends on the @var{inexact-flag}, you should
10843 normally not specify this option.  Other Alpha compilers call this
10844 option @option{-ieee_with_inexact}.
10845
10846 @item -mfp-trap-mode=@var{trap-mode}
10847 @opindex mfp-trap-mode
10848 This option controls what floating-point related traps are enabled.
10849 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
10850 The trap mode can be set to one of four values:
10851
10852 @table @samp
10853 @item n
10854 This is the default (normal) setting.  The only traps that are enabled
10855 are the ones that cannot be disabled in software (e.g., division by zero
10856 trap).
10857
10858 @item u
10859 In addition to the traps enabled by @samp{n}, underflow traps are enabled
10860 as well.
10861
10862 @item su
10863 Like @samp{u}, but the instructions are marked to be safe for software
10864 completion (see Alpha architecture manual for details).
10865
10866 @item sui
10867 Like @samp{su}, but inexact traps are enabled as well.
10868 @end table
10869
10870 @item -mfp-rounding-mode=@var{rounding-mode}
10871 @opindex mfp-rounding-mode
10872 Selects the IEEE rounding mode.  Other Alpha compilers call this option
10873 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
10874 of:
10875
10876 @table @samp
10877 @item n
10878 Normal IEEE rounding mode.  Floating point numbers are rounded towards
10879 the nearest machine number or towards the even machine number in case
10880 of a tie.
10881
10882 @item m
10883 Round towards minus infinity.
10884
10885 @item c
10886 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10887
10888 @item d
10889 Dynamic rounding mode.  A field in the floating point control register
10890 (@var{fpcr}, see Alpha architecture reference manual) controls the
10891 rounding mode in effect.  The C library initializes this register for
10892 rounding towards plus infinity.  Thus, unless your program modifies the
10893 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10894 @end table
10895
10896 @item -mtrap-precision=@var{trap-precision}
10897 @opindex mtrap-precision
10898 In the Alpha architecture, floating point traps are imprecise.  This
10899 means without software assistance it is impossible to recover from a
10900 floating trap and program execution normally needs to be terminated.
10901 GCC can generate code that can assist operating system trap handlers
10902 in determining the exact location that caused a floating point trap.
10903 Depending on the requirements of an application, different levels of
10904 precisions can be selected:
10905
10906 @table @samp
10907 @item p
10908 Program precision.  This option is the default and means a trap handler
10909 can only identify which program caused a floating point exception.
10910
10911 @item f
10912 Function precision.  The trap handler can determine the function that
10913 caused a floating point exception.
10914
10915 @item i
10916 Instruction precision.  The trap handler can determine the exact
10917 instruction that caused a floating point exception.
10918 @end table
10919
10920 Other Alpha compilers provide the equivalent options called
10921 @option{-scope_safe} and @option{-resumption_safe}.
10922
10923 @item -mieee-conformant
10924 @opindex mieee-conformant
10925 This option marks the generated code as IEEE conformant.  You must not
10926 use this option unless you also specify @option{-mtrap-precision=i} and either
10927 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10928 is to emit the line @samp{.eflag 48} in the function prologue of the
10929 generated assembly file.  Under DEC Unix, this has the effect that
10930 IEEE-conformant math library routines will be linked in.
10931
10932 @item -mbuild-constants
10933 @opindex mbuild-constants
10934 Normally GCC examines a 32- or 64-bit integer constant to
10935 see if it can construct it from smaller constants in two or three
10936 instructions.  If it cannot, it will output the constant as a literal and
10937 generate code to load it from the data segment at runtime.
10938
10939 Use this option to require GCC to construct @emph{all} integer constants
10940 using code, even if it takes more instructions (the maximum is six).
10941
10942 You would typically use this option to build a shared library dynamic
10943 loader.  Itself a shared library, it must relocate itself in memory
10944 before it can find the variables and constants in its own data segment.
10945
10946 @item -malpha-as
10947 @itemx -mgas
10948 @opindex malpha-as
10949 @opindex mgas
10950 Select whether to generate code to be assembled by the vendor-supplied
10951 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10952
10953 @item -mbwx
10954 @itemx -mno-bwx
10955 @itemx -mcix
10956 @itemx -mno-cix
10957 @itemx -mfix
10958 @itemx -mno-fix
10959 @itemx -mmax
10960 @itemx -mno-max
10961 @opindex mbwx
10962 @opindex mno-bwx
10963 @opindex mcix
10964 @opindex mno-cix
10965 @opindex mfix
10966 @opindex mno-fix
10967 @opindex mmax
10968 @opindex mno-max
10969 Indicate whether GCC should generate code to use the optional BWX,
10970 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10971 sets supported by the CPU type specified via @option{-mcpu=} option or that
10972 of the CPU on which GCC was built if none was specified.
10973
10974 @item -mfloat-vax
10975 @itemx -mfloat-ieee
10976 @opindex mfloat-vax
10977 @opindex mfloat-ieee
10978 Generate code that uses (does not use) VAX F and G floating point
10979 arithmetic instead of IEEE single and double precision.
10980
10981 @item -mexplicit-relocs
10982 @itemx -mno-explicit-relocs
10983 @opindex mexplicit-relocs
10984 @opindex mno-explicit-relocs
10985 Older Alpha assemblers provided no way to generate symbol relocations
10986 except via assembler macros.  Use of these macros does not allow
10987 optimal instruction scheduling.  GNU binutils as of version 2.12
10988 supports a new syntax that allows the compiler to explicitly mark
10989 which relocations should apply to which instructions.  This option
10990 is mostly useful for debugging, as GCC detects the capabilities of
10991 the assembler when it is built and sets the default accordingly.
10992
10993 @item -msmall-data
10994 @itemx -mlarge-data
10995 @opindex msmall-data
10996 @opindex mlarge-data
10997 When @option{-mexplicit-relocs} is in effect, static data is
10998 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10999 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
11000 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
11001 16-bit relocations off of the @code{$gp} register.  This limits the
11002 size of the small data area to 64KB, but allows the variables to be
11003 directly accessed via a single instruction.
11004
11005 The default is @option{-mlarge-data}.  With this option the data area
11006 is limited to just below 2GB@.  Programs that require more than 2GB of
11007 data must use @code{malloc} or @code{mmap} to allocate the data in the
11008 heap instead of in the program's data segment.
11009
11010 When generating code for shared libraries, @option{-fpic} implies
11011 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
11012
11013 @item -msmall-text
11014 @itemx -mlarge-text
11015 @opindex msmall-text
11016 @opindex mlarge-text
11017 When @option{-msmall-text} is used, the compiler assumes that the
11018 code of the entire program (or shared library) fits in 4MB, and is
11019 thus reachable with a branch instruction.  When @option{-msmall-data}
11020 is used, the compiler can assume that all local symbols share the
11021 same @code{$gp} value, and thus reduce the number of instructions
11022 required for a function call from 4 to 1.
11023
11024 The default is @option{-mlarge-text}.
11025
11026 @item -mcpu=@var{cpu_type}
11027 @opindex mcpu
11028 Set the instruction set and instruction scheduling parameters for
11029 machine type @var{cpu_type}.  You can specify either the @samp{EV}
11030 style name or the corresponding chip number.  GCC supports scheduling
11031 parameters for the EV4, EV5 and EV6 family of processors and will
11032 choose the default values for the instruction set from the processor
11033 you specify.  If you do not specify a processor type, GCC will default
11034 to the processor on which the compiler was built.
11035
11036 Supported values for @var{cpu_type} are
11037
11038 @table @samp
11039 @item ev4
11040 @itemx ev45
11041 @itemx 21064
11042 Schedules as an EV4 and has no instruction set extensions.
11043
11044 @item ev5
11045 @itemx 21164
11046 Schedules as an EV5 and has no instruction set extensions.
11047
11048 @item ev56
11049 @itemx 21164a
11050 Schedules as an EV5 and supports the BWX extension.
11051
11052 @item pca56
11053 @itemx 21164pc
11054 @itemx 21164PC
11055 Schedules as an EV5 and supports the BWX and MAX extensions.
11056
11057 @item ev6
11058 @itemx 21264
11059 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
11060
11061 @item ev67
11062 @itemx 21264a
11063 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
11064 @end table
11065
11066 Native Linux/GNU toolchains also support the value @samp{native},
11067 which selects the best architecture option for the host processor.
11068 @option{-mcpu=native} has no effect if GCC does not recognize
11069 the processor.
11070
11071 @item -mtune=@var{cpu_type}
11072 @opindex mtune
11073 Set only the instruction scheduling parameters for machine type
11074 @var{cpu_type}.  The instruction set is not changed.
11075
11076 Native Linux/GNU toolchains also support the value @samp{native},
11077 which selects the best architecture option for the host processor.
11078 @option{-mtune=native} has no effect if GCC does not recognize
11079 the processor.
11080
11081 @item -mmemory-latency=@var{time}
11082 @opindex mmemory-latency
11083 Sets the latency the scheduler should assume for typical memory
11084 references as seen by the application.  This number is highly
11085 dependent on the memory access patterns used by the application
11086 and the size of the external cache on the machine.
11087
11088 Valid options for @var{time} are
11089
11090 @table @samp
11091 @item @var{number}
11092 A decimal number representing clock cycles.
11093
11094 @item L1
11095 @itemx L2
11096 @itemx L3
11097 @itemx main
11098 The compiler contains estimates of the number of clock cycles for
11099 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
11100 (also called Dcache, Scache, and Bcache), as well as to main memory.
11101 Note that L3 is only valid for EV5.
11102
11103 @end table
11104 @end table
11105
11106 @node DEC Alpha/VMS Options
11107 @subsection DEC Alpha/VMS Options
11108
11109 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
11110
11111 @table @gcctabopt
11112 @item -mvms-return-codes
11113 @opindex mvms-return-codes
11114 Return VMS condition codes from main.  The default is to return POSIX
11115 style condition (e.g.@: error) codes.
11116
11117 @item -mdebug-main=@var{prefix}
11118 @opindex mdebug-main=@var{prefix}
11119 Flag the first routine whose name starts with @var{prefix} as the main
11120 routine for the debugger.
11121
11122 @item -mmalloc64
11123 @opindex mmalloc64
11124 Default to 64bit memory allocation routines.
11125 @end table
11126
11127 @node FR30 Options
11128 @subsection FR30 Options
11129 @cindex FR30 Options
11130
11131 These options are defined specifically for the FR30 port.
11132
11133 @table @gcctabopt
11134
11135 @item -msmall-model
11136 @opindex msmall-model
11137 Use the small address space model.  This can produce smaller code, but
11138 it does assume that all symbolic values and addresses will fit into a
11139 20-bit range.
11140
11141 @item -mno-lsim
11142 @opindex mno-lsim
11143 Assume that run-time support has been provided and so there is no need
11144 to include the simulator library (@file{libsim.a}) on the linker
11145 command line.
11146
11147 @end table
11148
11149 @node FRV Options
11150 @subsection FRV Options
11151 @cindex FRV Options
11152
11153 @table @gcctabopt
11154 @item -mgpr-32
11155 @opindex mgpr-32
11156
11157 Only use the first 32 general purpose registers.
11158
11159 @item -mgpr-64
11160 @opindex mgpr-64
11161
11162 Use all 64 general purpose registers.
11163
11164 @item -mfpr-32
11165 @opindex mfpr-32
11166
11167 Use only the first 32 floating point registers.
11168
11169 @item -mfpr-64
11170 @opindex mfpr-64
11171
11172 Use all 64 floating point registers
11173
11174 @item -mhard-float
11175 @opindex mhard-float
11176
11177 Use hardware instructions for floating point operations.
11178
11179 @item -msoft-float
11180 @opindex msoft-float
11181
11182 Use library routines for floating point operations.
11183
11184 @item -malloc-cc
11185 @opindex malloc-cc
11186
11187 Dynamically allocate condition code registers.
11188
11189 @item -mfixed-cc
11190 @opindex mfixed-cc
11191
11192 Do not try to dynamically allocate condition code registers, only
11193 use @code{icc0} and @code{fcc0}.
11194
11195 @item -mdword
11196 @opindex mdword
11197
11198 Change ABI to use double word insns.
11199
11200 @item -mno-dword
11201 @opindex mno-dword
11202
11203 Do not use double word instructions.
11204
11205 @item -mdouble
11206 @opindex mdouble
11207
11208 Use floating point double instructions.
11209
11210 @item -mno-double
11211 @opindex mno-double
11212
11213 Do not use floating point double instructions.
11214
11215 @item -mmedia
11216 @opindex mmedia
11217
11218 Use media instructions.
11219
11220 @item -mno-media
11221 @opindex mno-media
11222
11223 Do not use media instructions.
11224
11225 @item -mmuladd
11226 @opindex mmuladd
11227
11228 Use multiply and add/subtract instructions.
11229
11230 @item -mno-muladd
11231 @opindex mno-muladd
11232
11233 Do not use multiply and add/subtract instructions.
11234
11235 @item -mfdpic
11236 @opindex mfdpic
11237
11238 Select the FDPIC ABI, that uses function descriptors to represent
11239 pointers to functions.  Without any PIC/PIE-related options, it
11240 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11241 assumes GOT entries and small data are within a 12-bit range from the
11242 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11243 are computed with 32 bits.
11244 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11245
11246 @item -minline-plt
11247 @opindex minline-plt
11248
11249 Enable inlining of PLT entries in function calls to functions that are
11250 not known to bind locally.  It has no effect without @option{-mfdpic}.
11251 It's enabled by default if optimizing for speed and compiling for
11252 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11253 optimization option such as @option{-O3} or above is present in the
11254 command line.
11255
11256 @item -mTLS
11257 @opindex mTLS
11258
11259 Assume a large TLS segment when generating thread-local code.
11260
11261 @item -mtls
11262 @opindex mtls
11263
11264 Do not assume a large TLS segment when generating thread-local code.
11265
11266 @item -mgprel-ro
11267 @opindex mgprel-ro
11268
11269 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11270 that is known to be in read-only sections.  It's enabled by default,
11271 except for @option{-fpic} or @option{-fpie}: even though it may help
11272 make the global offset table smaller, it trades 1 instruction for 4.
11273 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11274 one of which may be shared by multiple symbols, and it avoids the need
11275 for a GOT entry for the referenced symbol, so it's more likely to be a
11276 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11277
11278 @item -multilib-library-pic
11279 @opindex multilib-library-pic
11280
11281 Link with the (library, not FD) pic libraries.  It's implied by
11282 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11283 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11284 it explicitly.
11285
11286 @item -mlinked-fp
11287 @opindex mlinked-fp
11288
11289 Follow the EABI requirement of always creating a frame pointer whenever
11290 a stack frame is allocated.  This option is enabled by default and can
11291 be disabled with @option{-mno-linked-fp}.
11292
11293 @item -mlong-calls
11294 @opindex mlong-calls
11295
11296 Use indirect addressing to call functions outside the current
11297 compilation unit.  This allows the functions to be placed anywhere
11298 within the 32-bit address space.
11299
11300 @item -malign-labels
11301 @opindex malign-labels
11302
11303 Try to align labels to an 8-byte boundary by inserting nops into the
11304 previous packet.  This option only has an effect when VLIW packing
11305 is enabled.  It doesn't create new packets; it merely adds nops to
11306 existing ones.
11307
11308 @item -mlibrary-pic
11309 @opindex mlibrary-pic
11310
11311 Generate position-independent EABI code.
11312
11313 @item -macc-4
11314 @opindex macc-4
11315
11316 Use only the first four media accumulator registers.
11317
11318 @item -macc-8
11319 @opindex macc-8
11320
11321 Use all eight media accumulator registers.
11322
11323 @item -mpack
11324 @opindex mpack
11325
11326 Pack VLIW instructions.
11327
11328 @item -mno-pack
11329 @opindex mno-pack
11330
11331 Do not pack VLIW instructions.
11332
11333 @item -mno-eflags
11334 @opindex mno-eflags
11335
11336 Do not mark ABI switches in e_flags.
11337
11338 @item -mcond-move
11339 @opindex mcond-move
11340
11341 Enable the use of conditional-move instructions (default).
11342
11343 This switch is mainly for debugging the compiler and will likely be removed
11344 in a future version.
11345
11346 @item -mno-cond-move
11347 @opindex mno-cond-move
11348
11349 Disable the use of conditional-move instructions.
11350
11351 This switch is mainly for debugging the compiler and will likely be removed
11352 in a future version.
11353
11354 @item -mscc
11355 @opindex mscc
11356
11357 Enable the use of conditional set instructions (default).
11358
11359 This switch is mainly for debugging the compiler and will likely be removed
11360 in a future version.
11361
11362 @item -mno-scc
11363 @opindex mno-scc
11364
11365 Disable the use of conditional set instructions.
11366
11367 This switch is mainly for debugging the compiler and will likely be removed
11368 in a future version.
11369
11370 @item -mcond-exec
11371 @opindex mcond-exec
11372
11373 Enable the use of conditional execution (default).
11374
11375 This switch is mainly for debugging the compiler and will likely be removed
11376 in a future version.
11377
11378 @item -mno-cond-exec
11379 @opindex mno-cond-exec
11380
11381 Disable the use of conditional execution.
11382
11383 This switch is mainly for debugging the compiler and will likely be removed
11384 in a future version.
11385
11386 @item -mvliw-branch
11387 @opindex mvliw-branch
11388
11389 Run a pass to pack branches into VLIW instructions (default).
11390
11391 This switch is mainly for debugging the compiler and will likely be removed
11392 in a future version.
11393
11394 @item -mno-vliw-branch
11395 @opindex mno-vliw-branch
11396
11397 Do not run a pass to pack branches into VLIW instructions.
11398
11399 This switch is mainly for debugging the compiler and will likely be removed
11400 in a future version.
11401
11402 @item -mmulti-cond-exec
11403 @opindex mmulti-cond-exec
11404
11405 Enable optimization of @code{&&} and @code{||} in conditional execution
11406 (default).
11407
11408 This switch is mainly for debugging the compiler and will likely be removed
11409 in a future version.
11410
11411 @item -mno-multi-cond-exec
11412 @opindex mno-multi-cond-exec
11413
11414 Disable optimization of @code{&&} and @code{||} in conditional execution.
11415
11416 This switch is mainly for debugging the compiler and will likely be removed
11417 in a future version.
11418
11419 @item -mnested-cond-exec
11420 @opindex mnested-cond-exec
11421
11422 Enable nested conditional execution optimizations (default).
11423
11424 This switch is mainly for debugging the compiler and will likely be removed
11425 in a future version.
11426
11427 @item -mno-nested-cond-exec
11428 @opindex mno-nested-cond-exec
11429
11430 Disable nested conditional execution optimizations.
11431
11432 This switch is mainly for debugging the compiler and will likely be removed
11433 in a future version.
11434
11435 @item -moptimize-membar
11436 @opindex moptimize-membar
11437
11438 This switch removes redundant @code{membar} instructions from the
11439 compiler generated code.  It is enabled by default.
11440
11441 @item -mno-optimize-membar
11442 @opindex mno-optimize-membar
11443
11444 This switch disables the automatic removal of redundant @code{membar}
11445 instructions from the generated code.
11446
11447 @item -mtomcat-stats
11448 @opindex mtomcat-stats
11449
11450 Cause gas to print out tomcat statistics.
11451
11452 @item -mcpu=@var{cpu}
11453 @opindex mcpu
11454
11455 Select the processor type for which to generate code.  Possible values are
11456 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11457 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11458
11459 @end table
11460
11461 @node GNU/Linux Options
11462 @subsection GNU/Linux Options
11463
11464 These @samp{-m} options are defined for GNU/Linux targets:
11465
11466 @table @gcctabopt
11467 @item -mglibc
11468 @opindex mglibc
11469 Use the GNU C library instead of uClibc.  This is the default except
11470 on @samp{*-*-linux-*uclibc*} targets.
11471
11472 @item -muclibc
11473 @opindex muclibc
11474 Use uClibc instead of the GNU C library.  This is the default on
11475 @samp{*-*-linux-*uclibc*} targets.
11476 @end table
11477
11478 @node H8/300 Options
11479 @subsection H8/300 Options
11480
11481 These @samp{-m} options are defined for the H8/300 implementations:
11482
11483 @table @gcctabopt
11484 @item -mrelax
11485 @opindex mrelax
11486 Shorten some address references at link time, when possible; uses the
11487 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11488 ld, Using ld}, for a fuller description.
11489
11490 @item -mh
11491 @opindex mh
11492 Generate code for the H8/300H@.
11493
11494 @item -ms
11495 @opindex ms
11496 Generate code for the H8S@.
11497
11498 @item -mn
11499 @opindex mn
11500 Generate code for the H8S and H8/300H in the normal mode.  This switch
11501 must be used either with @option{-mh} or @option{-ms}.
11502
11503 @item -ms2600
11504 @opindex ms2600
11505 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11506
11507 @item -mint32
11508 @opindex mint32
11509 Make @code{int} data 32 bits by default.
11510
11511 @item -malign-300
11512 @opindex malign-300
11513 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11514 The default for the H8/300H and H8S is to align longs and floats on 4
11515 byte boundaries.
11516 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11517 This option has no effect on the H8/300.
11518 @end table
11519
11520 @node HPPA Options
11521 @subsection HPPA Options
11522 @cindex HPPA Options
11523
11524 These @samp{-m} options are defined for the HPPA family of computers:
11525
11526 @table @gcctabopt
11527 @item -march=@var{architecture-type}
11528 @opindex march
11529 Generate code for the specified architecture.  The choices for
11530 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11531 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11532 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11533 architecture option for your machine.  Code compiled for lower numbered
11534 architectures will run on higher numbered architectures, but not the
11535 other way around.
11536
11537 @item -mpa-risc-1-0
11538 @itemx -mpa-risc-1-1
11539 @itemx -mpa-risc-2-0
11540 @opindex mpa-risc-1-0
11541 @opindex mpa-risc-1-1
11542 @opindex mpa-risc-2-0
11543 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11544
11545 @item -mbig-switch
11546 @opindex mbig-switch
11547 Generate code suitable for big switch tables.  Use this option only if
11548 the assembler/linker complain about out of range branches within a switch
11549 table.
11550
11551 @item -mjump-in-delay
11552 @opindex mjump-in-delay
11553 Fill delay slots of function calls with unconditional jump instructions
11554 by modifying the return pointer for the function call to be the target
11555 of the conditional jump.
11556
11557 @item -mdisable-fpregs
11558 @opindex mdisable-fpregs
11559 Prevent floating point registers from being used in any manner.  This is
11560 necessary for compiling kernels which perform lazy context switching of
11561 floating point registers.  If you use this option and attempt to perform
11562 floating point operations, the compiler will abort.
11563
11564 @item -mdisable-indexing
11565 @opindex mdisable-indexing
11566 Prevent the compiler from using indexing address modes.  This avoids some
11567 rather obscure problems when compiling MIG generated code under MACH@.
11568
11569 @item -mno-space-regs
11570 @opindex mno-space-regs
11571 Generate code that assumes the target has no space registers.  This allows
11572 GCC to generate faster indirect calls and use unscaled index address modes.
11573
11574 Such code is suitable for level 0 PA systems and kernels.
11575
11576 @item -mfast-indirect-calls
11577 @opindex mfast-indirect-calls
11578 Generate code that assumes calls never cross space boundaries.  This
11579 allows GCC to emit code which performs faster indirect calls.
11580
11581 This option will not work in the presence of shared libraries or nested
11582 functions.
11583
11584 @item -mfixed-range=@var{register-range}
11585 @opindex mfixed-range
11586 Generate code treating the given register range as fixed registers.
11587 A fixed register is one that the register allocator can not use.  This is
11588 useful when compiling kernel code.  A register range is specified as
11589 two registers separated by a dash.  Multiple register ranges can be
11590 specified separated by a comma.
11591
11592 @item -mlong-load-store
11593 @opindex mlong-load-store
11594 Generate 3-instruction load and store sequences as sometimes required by
11595 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11596 the HP compilers.
11597
11598 @item -mportable-runtime
11599 @opindex mportable-runtime
11600 Use the portable calling conventions proposed by HP for ELF systems.
11601
11602 @item -mgas
11603 @opindex mgas
11604 Enable the use of assembler directives only GAS understands.
11605
11606 @item -mschedule=@var{cpu-type}
11607 @opindex mschedule
11608 Schedule code according to the constraints for the machine type
11609 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11610 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11611 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11612 proper scheduling option for your machine.  The default scheduling is
11613 @samp{8000}.
11614
11615 @item -mlinker-opt
11616 @opindex mlinker-opt
11617 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11618 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11619 linkers in which they give bogus error messages when linking some programs.
11620
11621 @item -msoft-float
11622 @opindex msoft-float
11623 Generate output containing library calls for floating point.
11624 @strong{Warning:} the requisite libraries are not available for all HPPA
11625 targets.  Normally the facilities of the machine's usual C compiler are
11626 used, but this cannot be done directly in cross-compilation.  You must make
11627 your own arrangements to provide suitable library functions for
11628 cross-compilation.
11629
11630 @option{-msoft-float} changes the calling convention in the output file;
11631 therefore, it is only useful if you compile @emph{all} of a program with
11632 this option.  In particular, you need to compile @file{libgcc.a}, the
11633 library that comes with GCC, with @option{-msoft-float} in order for
11634 this to work.
11635
11636 @item -msio
11637 @opindex msio
11638 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11639 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11640 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11641 options are available under HP-UX and HI-UX@.
11642
11643 @item -mgnu-ld
11644 @opindex mgnu-ld
11645 Use GNU ld specific options.  This passes @option{-shared} to ld when
11646 building a shared library.  It is the default when GCC is configured,
11647 explicitly or implicitly, with the GNU linker.  This option does not
11648 have any affect on which ld is called, it only changes what parameters
11649 are passed to that ld.  The ld that is called is determined by the
11650 @option{--with-ld} configure option, GCC's program search path, and
11651 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11652 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11653 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11654
11655 @item -mhp-ld
11656 @opindex mhp-ld
11657 Use HP ld specific options.  This passes @option{-b} to ld when building
11658 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11659 links.  It is the default when GCC is configured, explicitly or
11660 implicitly, with the HP linker.  This option does not have any affect on
11661 which ld is called, it only changes what parameters are passed to that
11662 ld.  The ld that is called is determined by the @option{--with-ld}
11663 configure option, GCC's program search path, and finally by the user's
11664 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11665 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11666 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11667
11668 @item -mlong-calls
11669 @opindex mno-long-calls
11670 Generate code that uses long call sequences.  This ensures that a call
11671 is always able to reach linker generated stubs.  The default is to generate
11672 long calls only when the distance from the call site to the beginning
11673 of the function or translation unit, as the case may be, exceeds a
11674 predefined limit set by the branch type being used.  The limits for
11675 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11676 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11677 240,000 bytes.
11678
11679 Distances are measured from the beginning of functions when using the
11680 @option{-ffunction-sections} option, or when using the @option{-mgas}
11681 and @option{-mno-portable-runtime} options together under HP-UX with
11682 the SOM linker.
11683
11684 It is normally not desirable to use this option as it will degrade
11685 performance.  However, it may be useful in large applications,
11686 particularly when partial linking is used to build the application.
11687
11688 The types of long calls used depends on the capabilities of the
11689 assembler and linker, and the type of code being generated.  The
11690 impact on systems that support long absolute calls, and long pic
11691 symbol-difference or pc-relative calls should be relatively small.
11692 However, an indirect call is used on 32-bit ELF systems in pic code
11693 and it is quite long.
11694
11695 @item -munix=@var{unix-std}
11696 @opindex march
11697 Generate compiler predefines and select a startfile for the specified
11698 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11699 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11700 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11701 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11702 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11703 and later.
11704
11705 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11706 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11707 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11708 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11709 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11710 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11711
11712 It is @emph{important} to note that this option changes the interfaces
11713 for various library routines.  It also affects the operational behavior
11714 of the C library.  Thus, @emph{extreme} care is needed in using this
11715 option.
11716
11717 Library code that is intended to operate with more than one UNIX
11718 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11719 as appropriate.  Most GNU software doesn't provide this capability.
11720
11721 @item -nolibdld
11722 @opindex nolibdld
11723 Suppress the generation of link options to search libdld.sl when the
11724 @option{-static} option is specified on HP-UX 10 and later.
11725
11726 @item -static
11727 @opindex static
11728 The HP-UX implementation of setlocale in libc has a dependency on
11729 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11730 when the @option{-static} option is specified, special link options
11731 are needed to resolve this dependency.
11732
11733 On HP-UX 10 and later, the GCC driver adds the necessary options to
11734 link with libdld.sl when the @option{-static} option is specified.
11735 This causes the resulting binary to be dynamic.  On the 64-bit port,
11736 the linkers generate dynamic binaries by default in any case.  The
11737 @option{-nolibdld} option can be used to prevent the GCC driver from
11738 adding these link options.
11739
11740 @item -threads
11741 @opindex threads
11742 Add support for multithreading with the @dfn{dce thread} library
11743 under HP-UX@.  This option sets flags for both the preprocessor and
11744 linker.
11745 @end table
11746
11747 @node i386 and x86-64 Options
11748 @subsection Intel 386 and AMD x86-64 Options
11749 @cindex i386 Options
11750 @cindex x86-64 Options
11751 @cindex Intel 386 Options
11752 @cindex AMD x86-64 Options
11753
11754 These @samp{-m} options are defined for the i386 and x86-64 family of
11755 computers:
11756
11757 @table @gcctabopt
11758 @item -mtune=@var{cpu-type}
11759 @opindex mtune
11760 Tune to @var{cpu-type} everything applicable about the generated code, except
11761 for the ABI and the set of available instructions.  The choices for
11762 @var{cpu-type} are:
11763 @table @emph
11764 @item generic
11765 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11766 If you know the CPU on which your code will run, then you should use
11767 the corresponding @option{-mtune} option instead of
11768 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11769 of your application will have, then you should use this option.
11770
11771 As new processors are deployed in the marketplace, the behavior of this
11772 option will change.  Therefore, if you upgrade to a newer version of
11773 GCC, the code generated option will change to reflect the processors
11774 that were most common when that version of GCC was released.
11775
11776 There is no @option{-march=generic} option because @option{-march}
11777 indicates the instruction set the compiler can use, and there is no
11778 generic instruction set applicable to all processors.  In contrast,
11779 @option{-mtune} indicates the processor (or, in this case, collection of
11780 processors) for which the code is optimized.
11781 @item native
11782 This selects the CPU to tune for at compilation time by determining
11783 the processor type of the compiling machine.  Using @option{-mtune=native}
11784 will produce code optimized for the local machine under the constraints
11785 of the selected instruction set.  Using @option{-march=native} will
11786 enable all instruction subsets supported by the local machine (hence
11787 the result might not run on different machines).
11788 @item i386
11789 Original Intel's i386 CPU@.
11790 @item i486
11791 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11792 @item i586, pentium
11793 Intel Pentium CPU with no MMX support.
11794 @item pentium-mmx
11795 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11796 @item pentiumpro
11797 Intel PentiumPro CPU@.
11798 @item i686
11799 Same as @code{generic}, but when used as @code{march} option, PentiumPro
11800 instruction set will be used, so the code will run on all i686 family chips.
11801 @item pentium2
11802 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
11803 @item pentium3, pentium3m
11804 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
11805 support.
11806 @item pentium-m
11807 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
11808 support.  Used by Centrino notebooks.
11809 @item pentium4, pentium4m
11810 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
11811 @item prescott
11812 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
11813 set support.
11814 @item nocona
11815 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
11816 SSE2 and SSE3 instruction set support.
11817 @item core2
11818 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11819 instruction set support.
11820 @item atom
11821 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11822 instruction set support.
11823 @item k6
11824 AMD K6 CPU with MMX instruction set support.
11825 @item k6-2, k6-3
11826 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
11827 @item athlon, athlon-tbird
11828 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
11829 support.
11830 @item athlon-4, athlon-xp, athlon-mp
11831 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
11832 instruction set support.
11833 @item k8, opteron, athlon64, athlon-fx
11834 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
11835 MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit instruction set extensions.)
11836 @item k8-sse3, opteron-sse3, athlon64-sse3
11837 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
11838 @item amdfam10, barcelona
11839 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
11840 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
11841 instruction set extensions.)
11842 @item winchip-c6
11843 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
11844 set support.
11845 @item winchip2
11846 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
11847 instruction set support.
11848 @item c3
11849 Via C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
11850 implemented for this chip.)
11851 @item c3-2
11852 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
11853 implemented for this chip.)
11854 @item geode
11855 Embedded AMD CPU with MMX and 3DNow!@: instruction set support.
11856 @end table
11857
11858 While picking a specific @var{cpu-type} will schedule things appropriately
11859 for that particular chip, the compiler will not generate any code that
11860 does not run on the i386 without the @option{-march=@var{cpu-type}} option
11861 being used.
11862
11863 @item -march=@var{cpu-type}
11864 @opindex march
11865 Generate instructions for the machine type @var{cpu-type}.  The choices
11866 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
11867 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
11868
11869 @item -mcpu=@var{cpu-type}
11870 @opindex mcpu
11871 A deprecated synonym for @option{-mtune}.
11872
11873 @item -mfpmath=@var{unit}
11874 @opindex mfpmath
11875 Generate floating point arithmetics for selected unit @var{unit}.  The choices
11876 for @var{unit} are:
11877
11878 @table @samp
11879 @item 387
11880 Use the standard 387 floating point coprocessor present majority of chips and
11881 emulated otherwise.  Code compiled with this option will run almost everywhere.
11882 The temporary results are computed in 80bit precision instead of precision
11883 specified by the type resulting in slightly different results compared to most
11884 of other chips.  See @option{-ffloat-store} for more detailed description.
11885
11886 This is the default choice for i386 compiler.
11887
11888 @item sse
11889 Use scalar floating point instructions present in the SSE instruction set.
11890 This instruction set is supported by Pentium3 and newer chips, in the AMD line
11891 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
11892 instruction set supports only single precision arithmetics, thus the double and
11893 extended precision arithmetics is still done using 387.  Later version, present
11894 only in Pentium4 and the future AMD x86-64 chips supports double precision
11895 arithmetics too.
11896
11897 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
11898 or @option{-msse2} switches to enable SSE extensions and make this option
11899 effective.  For the x86-64 compiler, these extensions are enabled by default.
11900
11901 The resulting code should be considerably faster in the majority of cases and avoid
11902 the numerical instability problems of 387 code, but may break some existing
11903 code that expects temporaries to be 80bit.
11904
11905 This is the default choice for the x86-64 compiler.
11906
11907 @item sse,387
11908 @itemx sse+387
11909 @itemx both
11910 Attempt to utilize both instruction sets at once.  This effectively double the
11911 amount of available registers and on chips with separate execution units for
11912 387 and SSE the execution resources too.  Use this option with care, as it is
11913 still experimental, because the GCC register allocator does not model separate
11914 functional units well resulting in instable performance.
11915 @end table
11916
11917 @item -masm=@var{dialect}
11918 @opindex masm=@var{dialect}
11919 Output asm instructions using selected @var{dialect}.  Supported
11920 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
11921 not support @samp{intel}.
11922
11923 @item -mieee-fp
11924 @itemx -mno-ieee-fp
11925 @opindex mieee-fp
11926 @opindex mno-ieee-fp
11927 Control whether or not the compiler uses IEEE floating point
11928 comparisons.  These handle correctly the case where the result of a
11929 comparison is unordered.
11930
11931 @item -msoft-float
11932 @opindex msoft-float
11933 Generate output containing library calls for floating point.
11934 @strong{Warning:} the requisite libraries are not part of GCC@.
11935 Normally the facilities of the machine's usual C compiler are used, but
11936 this can't be done directly in cross-compilation.  You must make your
11937 own arrangements to provide suitable library functions for
11938 cross-compilation.
11939
11940 On machines where a function returns floating point results in the 80387
11941 register stack, some floating point opcodes may be emitted even if
11942 @option{-msoft-float} is used.
11943
11944 @item -mno-fp-ret-in-387
11945 @opindex mno-fp-ret-in-387
11946 Do not use the FPU registers for return values of functions.
11947
11948 The usual calling convention has functions return values of types
11949 @code{float} and @code{double} in an FPU register, even if there
11950 is no FPU@.  The idea is that the operating system should emulate
11951 an FPU@.
11952
11953 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11954 in ordinary CPU registers instead.
11955
11956 @item -mno-fancy-math-387
11957 @opindex mno-fancy-math-387
11958 Some 387 emulators do not support the @code{sin}, @code{cos} and
11959 @code{sqrt} instructions for the 387.  Specify this option to avoid
11960 generating those instructions.  This option is the default on FreeBSD,
11961 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11962 indicates that the target cpu will always have an FPU and so the
11963 instruction will not need emulation.  As of revision 2.6.1, these
11964 instructions are not generated unless you also use the
11965 @option{-funsafe-math-optimizations} switch.
11966
11967 @item -malign-double
11968 @itemx -mno-align-double
11969 @opindex malign-double
11970 @opindex mno-align-double
11971 Control whether GCC aligns @code{double}, @code{long double}, and
11972 @code{long long} variables on a two word boundary or a one word
11973 boundary.  Aligning @code{double} variables on a two word boundary will
11974 produce code that runs somewhat faster on a @samp{Pentium} at the
11975 expense of more memory.
11976
11977 On x86-64, @option{-malign-double} is enabled by default.
11978
11979 @strong{Warning:} if you use the @option{-malign-double} switch,
11980 structures containing the above types will be aligned differently than
11981 the published application binary interface specifications for the 386
11982 and will not be binary compatible with structures in code compiled
11983 without that switch.
11984
11985 @item -m96bit-long-double
11986 @itemx -m128bit-long-double
11987 @opindex m96bit-long-double
11988 @opindex m128bit-long-double
11989 These switches control the size of @code{long double} type.  The i386
11990 application binary interface specifies the size to be 96 bits,
11991 so @option{-m96bit-long-double} is the default in 32 bit mode.
11992
11993 Modern architectures (Pentium and newer) would prefer @code{long double}
11994 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11995 conforming to the ABI, this would not be possible.  So specifying a
11996 @option{-m128bit-long-double} will align @code{long double}
11997 to a 16 byte boundary by padding the @code{long double} with an additional
11998 32 bit zero.
11999
12000 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
12001 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
12002
12003 Notice that neither of these options enable any extra precision over the x87
12004 standard of 80 bits for a @code{long double}.
12005
12006 @strong{Warning:} if you override the default value for your target ABI, the
12007 structures and arrays containing @code{long double} variables will change
12008 their size as well as function calling convention for function taking
12009 @code{long double} will be modified.  Hence they will not be binary
12010 compatible with arrays or structures in code compiled without that switch.
12011
12012 @item -mlarge-data-threshold=@var{number}
12013 @opindex mlarge-data-threshold=@var{number}
12014 When @option{-mcmodel=medium} is specified, the data greater than
12015 @var{threshold} are placed in large data section.  This value must be the
12016 same across all object linked into the binary and defaults to 65535.
12017
12018 @item -mrtd
12019 @opindex mrtd
12020 Use a different function-calling convention, in which functions that
12021 take a fixed number of arguments return with the @code{ret} @var{num}
12022 instruction, which pops their arguments while returning.  This saves one
12023 instruction in the caller since there is no need to pop the arguments
12024 there.
12025
12026 You can specify that an individual function is called with this calling
12027 sequence with the function attribute @samp{stdcall}.  You can also
12028 override the @option{-mrtd} option by using the function attribute
12029 @samp{cdecl}.  @xref{Function Attributes}.
12030
12031 @strong{Warning:} this calling convention is incompatible with the one
12032 normally used on Unix, so you cannot use it if you need to call
12033 libraries compiled with the Unix compiler.
12034
12035 Also, you must provide function prototypes for all functions that
12036 take variable numbers of arguments (including @code{printf});
12037 otherwise incorrect code will be generated for calls to those
12038 functions.
12039
12040 In addition, seriously incorrect code will result if you call a
12041 function with too many arguments.  (Normally, extra arguments are
12042 harmlessly ignored.)
12043
12044 @item -mregparm=@var{num}
12045 @opindex mregparm
12046 Control how many registers are used to pass integer arguments.  By
12047 default, no registers are used to pass arguments, and at most 3
12048 registers can be used.  You can control this behavior for a specific
12049 function by using the function attribute @samp{regparm}.
12050 @xref{Function Attributes}.
12051
12052 @strong{Warning:} if you use this switch, and
12053 @var{num} is nonzero, then you must build all modules with the same
12054 value, including any libraries.  This includes the system libraries and
12055 startup modules.
12056
12057 @item -msseregparm
12058 @opindex msseregparm
12059 Use SSE register passing conventions for float and double arguments
12060 and return values.  You can control this behavior for a specific
12061 function by using the function attribute @samp{sseregparm}.
12062 @xref{Function Attributes}.
12063
12064 @strong{Warning:} if you use this switch then you must build all
12065 modules with the same value, including any libraries.  This includes
12066 the system libraries and startup modules.
12067
12068 @item -mpc32
12069 @itemx -mpc64
12070 @itemx -mpc80
12071 @opindex mpc32
12072 @opindex mpc64
12073 @opindex mpc80
12074
12075 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
12076 is specified, the significands of results of floating-point operations are
12077 rounded to 24 bits (single precision); @option{-mpc64} rounds the
12078 significands of results of floating-point operations to 53 bits (double
12079 precision) and @option{-mpc80} rounds the significands of results of
12080 floating-point operations to 64 bits (extended double precision), which is
12081 the default.  When this option is used, floating-point operations in higher
12082 precisions are not available to the programmer without setting the FPU
12083 control word explicitly.
12084
12085 Setting the rounding of floating-point operations to less than the default
12086 80 bits can speed some programs by 2% or more.  Note that some mathematical
12087 libraries assume that extended precision (80 bit) floating-point operations
12088 are enabled by default; routines in such libraries could suffer significant
12089 loss of accuracy, typically through so-called "catastrophic cancellation",
12090 when this option is used to set the precision to less than extended precision.
12091
12092 @item -mstackrealign
12093 @opindex mstackrealign
12094 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
12095 option will generate an alternate prologue and epilogue that realigns the
12096 runtime stack if necessary.  This supports mixing legacy codes that keep
12097 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
12098 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
12099 applicable to individual functions.
12100
12101 @item -mpreferred-stack-boundary=@var{num}
12102 @opindex mpreferred-stack-boundary
12103 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
12104 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
12105 the default is 4 (16 bytes or 128 bits).
12106
12107 @item -mincoming-stack-boundary=@var{num}
12108 @opindex mincoming-stack-boundary
12109 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
12110 boundary.  If @option{-mincoming-stack-boundary} is not specified,
12111 the one specified by @option{-mpreferred-stack-boundary} will be used.
12112
12113 On Pentium and PentiumPro, @code{double} and @code{long double} values
12114 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
12115 suffer significant run time performance penalties.  On Pentium III, the
12116 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
12117 properly if it is not 16 byte aligned.
12118
12119 To ensure proper alignment of this values on the stack, the stack boundary
12120 must be as aligned as that required by any value stored on the stack.
12121 Further, every function must be generated such that it keeps the stack
12122 aligned.  Thus calling a function compiled with a higher preferred
12123 stack boundary from a function compiled with a lower preferred stack
12124 boundary will most likely misalign the stack.  It is recommended that
12125 libraries that use callbacks always use the default setting.
12126
12127 This extra alignment does consume extra stack space, and generally
12128 increases code size.  Code that is sensitive to stack space usage, such
12129 as embedded systems and operating system kernels, may want to reduce the
12130 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12131
12132 @item -mmmx
12133 @itemx -mno-mmx
12134 @itemx -msse
12135 @itemx -mno-sse
12136 @itemx -msse2
12137 @itemx -mno-sse2
12138 @itemx -msse3
12139 @itemx -mno-sse3
12140 @itemx -mssse3
12141 @itemx -mno-ssse3
12142 @itemx -msse4.1
12143 @itemx -mno-sse4.1
12144 @itemx -msse4.2
12145 @itemx -mno-sse4.2
12146 @itemx -msse4
12147 @itemx -mno-sse4
12148 @itemx -mavx
12149 @itemx -mno-avx
12150 @itemx -maes
12151 @itemx -mno-aes
12152 @itemx -mpclmul
12153 @itemx -mno-pclmul
12154 @itemx -msse4a
12155 @itemx -mno-sse4a
12156 @itemx -mfma4
12157 @itemx -mno-fma4
12158 @itemx -mxop
12159 @itemx -mno-xop
12160 @itemx -mlwp
12161 @itemx -mno-lwp
12162 @itemx -m3dnow
12163 @itemx -mno-3dnow
12164 @itemx -mpopcnt
12165 @itemx -mno-popcnt
12166 @itemx -mabm
12167 @itemx -mno-abm
12168 @opindex mmmx
12169 @opindex mno-mmx
12170 @opindex msse
12171 @opindex mno-sse
12172 @opindex m3dnow
12173 @opindex mno-3dnow
12174 These switches enable or disable the use of instructions in the MMX,
12175 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, FMA4, XOP,
12176 LWP, ABM or 3DNow!@: extended instruction sets.
12177 These extensions are also available as built-in functions: see
12178 @ref{X86 Built-in Functions}, for details of the functions enabled and
12179 disabled by these switches.
12180
12181 To have SSE/SSE2 instructions generated automatically from floating-point
12182 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12183
12184 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12185 generates new AVX instructions or AVX equivalence for all SSEx instructions
12186 when needed.
12187
12188 These options will enable GCC to use these extended instructions in
12189 generated code, even without @option{-mfpmath=sse}.  Applications which
12190 perform runtime CPU detection must compile separate files for each
12191 supported architecture, using the appropriate flags.  In particular,
12192 the file containing the CPU detection code should be compiled without
12193 these options.
12194
12195 @item -mfused-madd
12196 @itemx -mno-fused-madd
12197 @opindex mfused-madd
12198 @opindex mno-fused-madd
12199 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12200 instructions.  The default is to use these instructions.
12201
12202 @item -mcld
12203 @opindex mcld
12204 This option instructs GCC to emit a @code{cld} instruction in the prologue
12205 of functions that use string instructions.  String instructions depend on
12206 the DF flag to select between autoincrement or autodecrement mode.  While the
12207 ABI specifies the DF flag to be cleared on function entry, some operating
12208 systems violate this specification by not clearing the DF flag in their
12209 exception dispatchers.  The exception handler can be invoked with the DF flag
12210 set which leads to wrong direction mode, when string instructions are used.
12211 This option can be enabled by default on 32-bit x86 targets by configuring
12212 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12213 instructions can be suppressed with the @option{-mno-cld} compiler option
12214 in this case.
12215
12216 @item -mcx16
12217 @opindex mcx16
12218 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12219 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12220 data types.  This is useful for high resolution counters that could be updated
12221 by multiple processors (or cores).  This instruction is generated as part of
12222 atomic built-in functions: see @ref{Atomic Builtins} for details.
12223
12224 @item -msahf
12225 @opindex msahf
12226 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12227 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12228 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12229 SAHF are load and store instructions, respectively, for certain status flags.
12230 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12231 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12232
12233 @item -mmovbe
12234 @opindex mmovbe
12235 This option will enable GCC to use movbe instruction to implement
12236 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12237
12238 @item -mcrc32
12239 @opindex mcrc32
12240 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12241 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12242 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12243
12244 @item -mrecip
12245 @opindex mrecip
12246 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12247 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12248 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12249 variants) for single precision floating point arguments.  These instructions
12250 are generated only when @option{-funsafe-math-optimizations} is enabled
12251 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12252 Note that while the throughput of the sequence is higher than the throughput
12253 of the non-reciprocal instruction, the precision of the sequence can be
12254 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12255
12256 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12257 already with @option{-ffast-math} (or the above option combination), and
12258 doesn't need @option{-mrecip}.
12259
12260 @item -mveclibabi=@var{type}
12261 @opindex mveclibabi
12262 Specifies the ABI type to use for vectorizing intrinsics using an
12263 external library.  Supported types are @code{svml} for the Intel short
12264 vector math library and @code{acml} for the AMD math core library style
12265 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12266 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12267 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12268 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12269 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12270 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12271 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12272 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12273 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12274 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12275 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12276 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12277 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12278 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12279 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12280 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12281 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12282 compatible library will have to be specified at link time.
12283
12284 @item -mabi=@var{name}
12285 @opindex mabi
12286 Generate code for the specified calling convention.  Permissible values
12287 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12288 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12289 ABI when targeting Windows.  On all other systems, the default is the
12290 SYSV ABI.  You can control this behavior for a specific function by
12291 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12292 @xref{Function Attributes}.
12293
12294 @item -mpush-args
12295 @itemx -mno-push-args
12296 @opindex mpush-args
12297 @opindex mno-push-args
12298 Use PUSH operations to store outgoing parameters.  This method is shorter
12299 and usually equally fast as method using SUB/MOV operations and is enabled
12300 by default.  In some cases disabling it may improve performance because of
12301 improved scheduling and reduced dependencies.
12302
12303 @item -maccumulate-outgoing-args
12304 @opindex maccumulate-outgoing-args
12305 If enabled, the maximum amount of space required for outgoing arguments will be
12306 computed in the function prologue.  This is faster on most modern CPUs
12307 because of reduced dependencies, improved scheduling and reduced stack usage
12308 when preferred stack boundary is not equal to 2.  The drawback is a notable
12309 increase in code size.  This switch implies @option{-mno-push-args}.
12310
12311 @item -mthreads
12312 @opindex mthreads
12313 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12314 on thread-safe exception handling must compile and link all code with the
12315 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12316 @option{-D_MT}; when linking, it links in a special thread helper library
12317 @option{-lmingwthrd} which cleans up per thread exception handling data.
12318
12319 @item -mno-align-stringops
12320 @opindex mno-align-stringops
12321 Do not align destination of inlined string operations.  This switch reduces
12322 code size and improves performance in case the destination is already aligned,
12323 but GCC doesn't know about it.
12324
12325 @item -minline-all-stringops
12326 @opindex minline-all-stringops
12327 By default GCC inlines string operations only when destination is known to be
12328 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12329 size, but may improve performance of code that depends on fast memcpy, strlen
12330 and memset for short lengths.
12331
12332 @item -minline-stringops-dynamically
12333 @opindex minline-stringops-dynamically
12334 For string operation of unknown size, inline runtime checks so for small
12335 blocks inline code is used, while for large blocks library call is used.
12336
12337 @item -mstringop-strategy=@var{alg}
12338 @opindex mstringop-strategy=@var{alg}
12339 Overwrite internal decision heuristic about particular algorithm to inline
12340 string operation with.  The allowed values are @code{rep_byte},
12341 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12342 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12343 expanding inline loop, @code{libcall} for always expanding library call.
12344
12345 @item -momit-leaf-frame-pointer
12346 @opindex momit-leaf-frame-pointer
12347 Don't keep the frame pointer in a register for leaf functions.  This
12348 avoids the instructions to save, set up and restore frame pointers and
12349 makes an extra register available in leaf functions.  The option
12350 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12351 which might make debugging harder.
12352
12353 @item -mtls-direct-seg-refs
12354 @itemx -mno-tls-direct-seg-refs
12355 @opindex mtls-direct-seg-refs
12356 Controls whether TLS variables may be accessed with offsets from the
12357 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12358 or whether the thread base pointer must be added.  Whether or not this
12359 is legal depends on the operating system, and whether it maps the
12360 segment to cover the entire TLS area.
12361
12362 For systems that use GNU libc, the default is on.
12363
12364 @item -msse2avx
12365 @itemx -mno-sse2avx
12366 @opindex msse2avx
12367 Specify that the assembler should encode SSE instructions with VEX
12368 prefix.  The option @option{-mavx} turns this on by default.
12369 @end table
12370
12371 These @samp{-m} switches are supported in addition to the above
12372 on AMD x86-64 processors in 64-bit environments.
12373
12374 @table @gcctabopt
12375 @item -m32
12376 @itemx -m64
12377 @opindex m32
12378 @opindex m64
12379 Generate code for a 32-bit or 64-bit environment.
12380 The 32-bit environment sets int, long and pointer to 32 bits and
12381 generates code that runs on any i386 system.
12382 The 64-bit environment sets int to 32 bits and long and pointer
12383 to 64 bits and generates code for AMD's x86-64 architecture. For
12384 darwin only the -m64 option turns off the @option{-fno-pic} and
12385 @option{-mdynamic-no-pic} options.
12386
12387 @item -mno-red-zone
12388 @opindex mno-red-zone
12389 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12390 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12391 stack pointer that will not be modified by signal or interrupt handlers
12392 and therefore can be used for temporary data without adjusting the stack
12393 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12394
12395 @item -mcmodel=small
12396 @opindex mcmodel=small
12397 Generate code for the small code model: the program and its symbols must
12398 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12399 Programs can be statically or dynamically linked.  This is the default
12400 code model.
12401
12402 @item -mcmodel=kernel
12403 @opindex mcmodel=kernel
12404 Generate code for the kernel code model.  The kernel runs in the
12405 negative 2 GB of the address space.
12406 This model has to be used for Linux kernel code.
12407
12408 @item -mcmodel=medium
12409 @opindex mcmodel=medium
12410 Generate code for the medium model: The program is linked in the lower 2
12411 GB of the address space.  Small symbols are also placed there.  Symbols
12412 with sizes larger than @option{-mlarge-data-threshold} are put into
12413 large data or bss sections and can be located above 2GB.  Programs can
12414 be statically or dynamically linked.
12415
12416 @item -mcmodel=large
12417 @opindex mcmodel=large
12418 Generate code for the large model: This model makes no assumptions
12419 about addresses and sizes of sections.
12420 @end table
12421
12422 @node IA-64 Options
12423 @subsection IA-64 Options
12424 @cindex IA-64 Options
12425
12426 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12427
12428 @table @gcctabopt
12429 @item -mbig-endian
12430 @opindex mbig-endian
12431 Generate code for a big endian target.  This is the default for HP-UX@.
12432
12433 @item -mlittle-endian
12434 @opindex mlittle-endian
12435 Generate code for a little endian target.  This is the default for AIX5
12436 and GNU/Linux.
12437
12438 @item -mgnu-as
12439 @itemx -mno-gnu-as
12440 @opindex mgnu-as
12441 @opindex mno-gnu-as
12442 Generate (or don't) code for the GNU assembler.  This is the default.
12443 @c Also, this is the default if the configure option @option{--with-gnu-as}
12444 @c is used.
12445
12446 @item -mgnu-ld
12447 @itemx -mno-gnu-ld
12448 @opindex mgnu-ld
12449 @opindex mno-gnu-ld
12450 Generate (or don't) code for the GNU linker.  This is the default.
12451 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12452 @c is used.
12453
12454 @item -mno-pic
12455 @opindex mno-pic
12456 Generate code that does not use a global pointer register.  The result
12457 is not position independent code, and violates the IA-64 ABI@.
12458
12459 @item -mvolatile-asm-stop
12460 @itemx -mno-volatile-asm-stop
12461 @opindex mvolatile-asm-stop
12462 @opindex mno-volatile-asm-stop
12463 Generate (or don't) a stop bit immediately before and after volatile asm
12464 statements.
12465
12466 @item -mregister-names
12467 @itemx -mno-register-names
12468 @opindex mregister-names
12469 @opindex mno-register-names
12470 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12471 the stacked registers.  This may make assembler output more readable.
12472
12473 @item -mno-sdata
12474 @itemx -msdata
12475 @opindex mno-sdata
12476 @opindex msdata
12477 Disable (or enable) optimizations that use the small data section.  This may
12478 be useful for working around optimizer bugs.
12479
12480 @item -mconstant-gp
12481 @opindex mconstant-gp
12482 Generate code that uses a single constant global pointer value.  This is
12483 useful when compiling kernel code.
12484
12485 @item -mauto-pic
12486 @opindex mauto-pic
12487 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12488 This is useful when compiling firmware code.
12489
12490 @item -minline-float-divide-min-latency
12491 @opindex minline-float-divide-min-latency
12492 Generate code for inline divides of floating point values
12493 using the minimum latency algorithm.
12494
12495 @item -minline-float-divide-max-throughput
12496 @opindex minline-float-divide-max-throughput
12497 Generate code for inline divides of floating point values
12498 using the maximum throughput algorithm.
12499
12500 @item -mno-inline-float-divide
12501 @opindex mno-inline-float-divide
12502 Do not generate inline code for divides of floating point values.
12503
12504 @item -minline-int-divide-min-latency
12505 @opindex minline-int-divide-min-latency
12506 Generate code for inline divides of integer values
12507 using the minimum latency algorithm.
12508
12509 @item -minline-int-divide-max-throughput
12510 @opindex minline-int-divide-max-throughput
12511 Generate code for inline divides of integer values
12512 using the maximum throughput algorithm.
12513
12514 @item -mno-inline-int-divide
12515 @opindex mno-inline-int-divide
12516 Do not generate inline code for divides of integer values.
12517
12518 @item -minline-sqrt-min-latency
12519 @opindex minline-sqrt-min-latency
12520 Generate code for inline square roots
12521 using the minimum latency algorithm.
12522
12523 @item -minline-sqrt-max-throughput
12524 @opindex minline-sqrt-max-throughput
12525 Generate code for inline square roots
12526 using the maximum throughput algorithm.
12527
12528 @item -mno-inline-sqrt
12529 @opindex mno-inline-sqrt
12530 Do not generate inline code for sqrt.
12531
12532 @item -mfused-madd
12533 @itemx -mno-fused-madd
12534 @opindex mfused-madd
12535 @opindex mno-fused-madd
12536 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12537 instructions.  The default is to use these instructions.
12538
12539 @item -mno-dwarf2-asm
12540 @itemx -mdwarf2-asm
12541 @opindex mno-dwarf2-asm
12542 @opindex mdwarf2-asm
12543 Don't (or do) generate assembler code for the DWARF2 line number debugging
12544 info.  This may be useful when not using the GNU assembler.
12545
12546 @item -mearly-stop-bits
12547 @itemx -mno-early-stop-bits
12548 @opindex mearly-stop-bits
12549 @opindex mno-early-stop-bits
12550 Allow stop bits to be placed earlier than immediately preceding the
12551 instruction that triggered the stop bit.  This can improve instruction
12552 scheduling, but does not always do so.
12553
12554 @item -mfixed-range=@var{register-range}
12555 @opindex mfixed-range
12556 Generate code treating the given register range as fixed registers.
12557 A fixed register is one that the register allocator can not use.  This is
12558 useful when compiling kernel code.  A register range is specified as
12559 two registers separated by a dash.  Multiple register ranges can be
12560 specified separated by a comma.
12561
12562 @item -mtls-size=@var{tls-size}
12563 @opindex mtls-size
12564 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12565 64.
12566
12567 @item -mtune=@var{cpu-type}
12568 @opindex mtune
12569 Tune the instruction scheduling for a particular CPU, Valid values are
12570 itanium, itanium1, merced, itanium2, and mckinley.
12571
12572 @item -milp32
12573 @itemx -mlp64
12574 @opindex milp32
12575 @opindex mlp64
12576 Generate code for a 32-bit or 64-bit environment.
12577 The 32-bit environment sets int, long and pointer to 32 bits.
12578 The 64-bit environment sets int to 32 bits and long and pointer
12579 to 64 bits.  These are HP-UX specific flags.
12580
12581 @item -mno-sched-br-data-spec
12582 @itemx -msched-br-data-spec
12583 @opindex mno-sched-br-data-spec
12584 @opindex msched-br-data-spec
12585 (Dis/En)able data speculative scheduling before reload.
12586 This will result in generation of the ld.a instructions and
12587 the corresponding check instructions (ld.c / chk.a).
12588 The default is 'disable'.
12589
12590 @item -msched-ar-data-spec
12591 @itemx -mno-sched-ar-data-spec
12592 @opindex msched-ar-data-spec
12593 @opindex mno-sched-ar-data-spec
12594 (En/Dis)able data speculative scheduling after reload.
12595 This will result in generation of the ld.a instructions and
12596 the corresponding check instructions (ld.c / chk.a).
12597 The default is 'enable'.
12598
12599 @item -mno-sched-control-spec
12600 @itemx -msched-control-spec
12601 @opindex mno-sched-control-spec
12602 @opindex msched-control-spec
12603 (Dis/En)able control speculative scheduling.  This feature is
12604 available only during region scheduling (i.e.@: before reload).
12605 This will result in generation of the ld.s instructions and
12606 the corresponding check instructions chk.s .
12607 The default is 'disable'.
12608
12609 @item -msched-br-in-data-spec
12610 @itemx -mno-sched-br-in-data-spec
12611 @opindex msched-br-in-data-spec
12612 @opindex mno-sched-br-in-data-spec
12613 (En/Dis)able speculative scheduling of the instructions that
12614 are dependent on the data speculative loads before reload.
12615 This is effective only with @option{-msched-br-data-spec} enabled.
12616 The default is 'enable'.
12617
12618 @item -msched-ar-in-data-spec
12619 @itemx -mno-sched-ar-in-data-spec
12620 @opindex msched-ar-in-data-spec
12621 @opindex mno-sched-ar-in-data-spec
12622 (En/Dis)able speculative scheduling of the instructions that
12623 are dependent on the data speculative loads after reload.
12624 This is effective only with @option{-msched-ar-data-spec} enabled.
12625 The default is 'enable'.
12626
12627 @item -msched-in-control-spec
12628 @itemx -mno-sched-in-control-spec
12629 @opindex msched-in-control-spec
12630 @opindex mno-sched-in-control-spec
12631 (En/Dis)able speculative scheduling of the instructions that
12632 are dependent on the control speculative loads.
12633 This is effective only with @option{-msched-control-spec} enabled.
12634 The default is 'enable'.
12635
12636 @item -mno-sched-prefer-non-data-spec-insns
12637 @itemx -msched-prefer-non-data-spec-insns
12638 @opindex mno-sched-prefer-non-data-spec-insns
12639 @opindex msched-prefer-non-data-spec-insns
12640 If enabled, data speculative instructions will be chosen for schedule
12641 only if there are no other choices at the moment.  This will make
12642 the use of the data speculation much more conservative.
12643 The default is 'disable'.
12644
12645 @item -mno-sched-prefer-non-control-spec-insns
12646 @itemx -msched-prefer-non-control-spec-insns
12647 @opindex mno-sched-prefer-non-control-spec-insns
12648 @opindex msched-prefer-non-control-spec-insns
12649 If enabled, control speculative instructions will be chosen for schedule
12650 only if there are no other choices at the moment.  This will make
12651 the use of the control speculation much more conservative.
12652 The default is 'disable'.
12653
12654 @item -mno-sched-count-spec-in-critical-path
12655 @itemx -msched-count-spec-in-critical-path
12656 @opindex mno-sched-count-spec-in-critical-path
12657 @opindex msched-count-spec-in-critical-path
12658 If enabled, speculative dependencies will be considered during
12659 computation of the instructions priorities.  This will make the use of the
12660 speculation a bit more conservative.
12661 The default is 'disable'.
12662
12663 @item -msched-spec-ldc
12664 @opindex msched-spec-ldc
12665 Use a simple data speculation check.  This option is on by default.
12666
12667 @item -msched-control-spec-ldc
12668 @opindex msched-spec-ldc
12669 Use a simple check for control speculation.  This option is on by default.
12670
12671 @item -msched-stop-bits-after-every-cycle
12672 @opindex msched-stop-bits-after-every-cycle
12673 Place a stop bit after every cycle when scheduling.  This option is on
12674 by default.
12675
12676 @item -msched-fp-mem-deps-zero-cost
12677 @opindex msched-fp-mem-deps-zero-cost
12678 Assume that floating-point stores and loads are not likely to cause a conflict
12679 when placed into the same instruction group.  This option is disabled by
12680 default.
12681
12682 @item -msel-sched-dont-check-control-spec
12683 @opindex msel-sched-dont-check-control-spec
12684 Generate checks for control speculation in selective scheduling.
12685 This flag is disabled by default.
12686
12687 @item -msched-max-memory-insns=@var{max-insns}
12688 @opindex msched-max-memory-insns
12689 Limit on the number of memory insns per instruction group, giving lower
12690 priority to subsequent memory insns attempting to schedule in the same
12691 instruction group. Frequently useful to prevent cache bank conflicts.
12692 The default value is 1.
12693
12694 @item -msched-max-memory-insns-hard-limit
12695 @opindex msched-max-memory-insns-hard-limit
12696 Disallow more than `msched-max-memory-insns' in instruction group.
12697 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12698 when limit is reached but may still schedule memory operations.
12699
12700 @end table
12701
12702 @node IA-64/VMS Options
12703 @subsection IA-64/VMS Options
12704
12705 These @samp{-m} options are defined for the IA-64/VMS implementations:
12706
12707 @table @gcctabopt
12708 @item -mvms-return-codes
12709 @opindex mvms-return-codes
12710 Return VMS condition codes from main. The default is to return POSIX
12711 style condition (e.g.@ error) codes.
12712
12713 @item -mdebug-main=@var{prefix}
12714 @opindex mdebug-main=@var{prefix}
12715 Flag the first routine whose name starts with @var{prefix} as the main
12716 routine for the debugger.
12717
12718 @item -mmalloc64
12719 @opindex mmalloc64
12720 Default to 64bit memory allocation routines.
12721 @end table
12722
12723 @node LM32 Options
12724 @subsection LM32 Options
12725 @cindex LM32 options
12726
12727 These @option{-m} options are defined for the Lattice Mico32 architecture:
12728
12729 @table @gcctabopt
12730 @item -mbarrel-shift-enabled
12731 @opindex mbarrel-shift-enabled
12732 Enable barrel-shift instructions.
12733
12734 @item -mdivide-enabled
12735 @opindex mdivide-enabled
12736 Enable divide and modulus instructions.
12737
12738 @item -mmultiply-enabled
12739 @opindex multiply-enabled
12740 Enable multiply instructions.
12741
12742 @item -msign-extend-enabled
12743 @opindex msign-extend-enabled
12744 Enable sign extend instructions.
12745
12746 @item -muser-enabled
12747 @opindex muser-enabled
12748 Enable user-defined instructions.
12749
12750 @end table
12751
12752 @node M32C Options
12753 @subsection M32C Options
12754 @cindex M32C options
12755
12756 @table @gcctabopt
12757 @item -mcpu=@var{name}
12758 @opindex mcpu=
12759 Select the CPU for which code is generated.  @var{name} may be one of
12760 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12761 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12762 the M32C/80 series.
12763
12764 @item -msim
12765 @opindex msim
12766 Specifies that the program will be run on the simulator.  This causes
12767 an alternate runtime library to be linked in which supports, for
12768 example, file I/O@.  You must not use this option when generating
12769 programs that will run on real hardware; you must provide your own
12770 runtime library for whatever I/O functions are needed.
12771
12772 @item -memregs=@var{number}
12773 @opindex memregs=
12774 Specifies the number of memory-based pseudo-registers GCC will use
12775 during code generation.  These pseudo-registers will be used like real
12776 registers, so there is a tradeoff between GCC's ability to fit the
12777 code into available registers, and the performance penalty of using
12778 memory instead of registers.  Note that all modules in a program must
12779 be compiled with the same value for this option.  Because of that, you
12780 must not use this option with the default runtime libraries gcc
12781 builds.
12782
12783 @end table
12784
12785 @node M32R/D Options
12786 @subsection M32R/D Options
12787 @cindex M32R/D options
12788
12789 These @option{-m} options are defined for Renesas M32R/D architectures:
12790
12791 @table @gcctabopt
12792 @item -m32r2
12793 @opindex m32r2
12794 Generate code for the M32R/2@.
12795
12796 @item -m32rx
12797 @opindex m32rx
12798 Generate code for the M32R/X@.
12799
12800 @item -m32r
12801 @opindex m32r
12802 Generate code for the M32R@.  This is the default.
12803
12804 @item -mmodel=small
12805 @opindex mmodel=small
12806 Assume all objects live in the lower 16MB of memory (so that their addresses
12807 can be loaded with the @code{ld24} instruction), and assume all subroutines
12808 are reachable with the @code{bl} instruction.
12809 This is the default.
12810
12811 The addressability of a particular object can be set with the
12812 @code{model} attribute.
12813
12814 @item -mmodel=medium
12815 @opindex mmodel=medium
12816 Assume objects may be anywhere in the 32-bit address space (the compiler
12817 will generate @code{seth/add3} instructions to load their addresses), and
12818 assume all subroutines are reachable with the @code{bl} instruction.
12819
12820 @item -mmodel=large
12821 @opindex mmodel=large
12822 Assume objects may be anywhere in the 32-bit address space (the compiler
12823 will generate @code{seth/add3} instructions to load their addresses), and
12824 assume subroutines may not be reachable with the @code{bl} instruction
12825 (the compiler will generate the much slower @code{seth/add3/jl}
12826 instruction sequence).
12827
12828 @item -msdata=none
12829 @opindex msdata=none
12830 Disable use of the small data area.  Variables will be put into
12831 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
12832 @code{section} attribute has been specified).
12833 This is the default.
12834
12835 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
12836 Objects may be explicitly put in the small data area with the
12837 @code{section} attribute using one of these sections.
12838
12839 @item -msdata=sdata
12840 @opindex msdata=sdata
12841 Put small global and static data in the small data area, but do not
12842 generate special code to reference them.
12843
12844 @item -msdata=use
12845 @opindex msdata=use
12846 Put small global and static data in the small data area, and generate
12847 special instructions to reference them.
12848
12849 @item -G @var{num}
12850 @opindex G
12851 @cindex smaller data references
12852 Put global and static objects less than or equal to @var{num} bytes
12853 into the small data or bss sections instead of the normal data or bss
12854 sections.  The default value of @var{num} is 8.
12855 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
12856 for this option to have any effect.
12857
12858 All modules should be compiled with the same @option{-G @var{num}} value.
12859 Compiling with different values of @var{num} may or may not work; if it
12860 doesn't the linker will give an error message---incorrect code will not be
12861 generated.
12862
12863 @item -mdebug
12864 @opindex mdebug
12865 Makes the M32R specific code in the compiler display some statistics
12866 that might help in debugging programs.
12867
12868 @item -malign-loops
12869 @opindex malign-loops
12870 Align all loops to a 32-byte boundary.
12871
12872 @item -mno-align-loops
12873 @opindex mno-align-loops
12874 Do not enforce a 32-byte alignment for loops.  This is the default.
12875
12876 @item -missue-rate=@var{number}
12877 @opindex missue-rate=@var{number}
12878 Issue @var{number} instructions per cycle.  @var{number} can only be 1
12879 or 2.
12880
12881 @item -mbranch-cost=@var{number}
12882 @opindex mbranch-cost=@var{number}
12883 @var{number} can only be 1 or 2.  If it is 1 then branches will be
12884 preferred over conditional code, if it is 2, then the opposite will
12885 apply.
12886
12887 @item -mflush-trap=@var{number}
12888 @opindex mflush-trap=@var{number}
12889 Specifies the trap number to use to flush the cache.  The default is
12890 12.  Valid numbers are between 0 and 15 inclusive.
12891
12892 @item -mno-flush-trap
12893 @opindex mno-flush-trap
12894 Specifies that the cache cannot be flushed by using a trap.
12895
12896 @item -mflush-func=@var{name}
12897 @opindex mflush-func=@var{name}
12898 Specifies the name of the operating system function to call to flush
12899 the cache.  The default is @emph{_flush_cache}, but a function call
12900 will only be used if a trap is not available.
12901
12902 @item -mno-flush-func
12903 @opindex mno-flush-func
12904 Indicates that there is no OS function for flushing the cache.
12905
12906 @end table
12907
12908 @node M680x0 Options
12909 @subsection M680x0 Options
12910 @cindex M680x0 options
12911
12912 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
12913 The default settings depend on which architecture was selected when
12914 the compiler was configured; the defaults for the most common choices
12915 are given below.
12916
12917 @table @gcctabopt
12918 @item -march=@var{arch}
12919 @opindex march
12920 Generate code for a specific M680x0 or ColdFire instruction set
12921 architecture.  Permissible values of @var{arch} for M680x0
12922 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
12923 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
12924 architectures are selected according to Freescale's ISA classification
12925 and the permissible values are: @samp{isaa}, @samp{isaaplus},
12926 @samp{isab} and @samp{isac}.
12927
12928 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
12929 code for a ColdFire target.  The @var{arch} in this macro is one of the
12930 @option{-march} arguments given above.
12931
12932 When used together, @option{-march} and @option{-mtune} select code
12933 that runs on a family of similar processors but that is optimized
12934 for a particular microarchitecture.
12935
12936 @item -mcpu=@var{cpu}
12937 @opindex mcpu
12938 Generate code for a specific M680x0 or ColdFire processor.
12939 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
12940 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
12941 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
12942 below, which also classifies the CPUs into families:
12943
12944 @multitable @columnfractions 0.20 0.80
12945 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
12946 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
12947 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
12948 @item @samp{5206e} @tab @samp{5206e}
12949 @item @samp{5208} @tab @samp{5207} @samp{5208}
12950 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
12951 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
12952 @item @samp{5216} @tab @samp{5214} @samp{5216}
12953 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
12954 @item @samp{5225} @tab @samp{5224} @samp{5225}
12955 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
12956 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
12957 @item @samp{5249} @tab @samp{5249}
12958 @item @samp{5250} @tab @samp{5250}
12959 @item @samp{5271} @tab @samp{5270} @samp{5271}
12960 @item @samp{5272} @tab @samp{5272}
12961 @item @samp{5275} @tab @samp{5274} @samp{5275}
12962 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
12963 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
12964 @item @samp{5307} @tab @samp{5307}
12965 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
12966 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
12967 @item @samp{5407} @tab @samp{5407}
12968 @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}
12969 @end multitable
12970
12971 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
12972 @var{arch} is compatible with @var{cpu}.  Other combinations of
12973 @option{-mcpu} and @option{-march} are rejected.
12974
12975 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
12976 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
12977 where the value of @var{family} is given by the table above.
12978
12979 @item -mtune=@var{tune}
12980 @opindex mtune
12981 Tune the code for a particular microarchitecture, within the
12982 constraints set by @option{-march} and @option{-mcpu}.
12983 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
12984 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
12985 and @samp{cpu32}.  The ColdFire microarchitectures
12986 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
12987
12988 You can also use @option{-mtune=68020-40} for code that needs
12989 to run relatively well on 68020, 68030 and 68040 targets.
12990 @option{-mtune=68020-60} is similar but includes 68060 targets
12991 as well.  These two options select the same tuning decisions as
12992 @option{-m68020-40} and @option{-m68020-60} respectively.
12993
12994 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
12995 when tuning for 680x0 architecture @var{arch}.  It also defines
12996 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
12997 option is used.  If gcc is tuning for a range of architectures,
12998 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
12999 it defines the macros for every architecture in the range.
13000
13001 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
13002 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
13003 of the arguments given above.
13004
13005 @item -m68000
13006 @itemx -mc68000
13007 @opindex m68000
13008 @opindex mc68000
13009 Generate output for a 68000.  This is the default
13010 when the compiler is configured for 68000-based systems.
13011 It is equivalent to @option{-march=68000}.
13012
13013 Use this option for microcontrollers with a 68000 or EC000 core,
13014 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
13015
13016 @item -m68010
13017 @opindex m68010
13018 Generate output for a 68010.  This is the default
13019 when the compiler is configured for 68010-based systems.
13020 It is equivalent to @option{-march=68010}.
13021
13022 @item -m68020
13023 @itemx -mc68020
13024 @opindex m68020
13025 @opindex mc68020
13026 Generate output for a 68020.  This is the default
13027 when the compiler is configured for 68020-based systems.
13028 It is equivalent to @option{-march=68020}.
13029
13030 @item -m68030
13031 @opindex m68030
13032 Generate output for a 68030.  This is the default when the compiler is
13033 configured for 68030-based systems.  It is equivalent to
13034 @option{-march=68030}.
13035
13036 @item -m68040
13037 @opindex m68040
13038 Generate output for a 68040.  This is the default when the compiler is
13039 configured for 68040-based systems.  It is equivalent to
13040 @option{-march=68040}.
13041
13042 This option inhibits the use of 68881/68882 instructions that have to be
13043 emulated by software on the 68040.  Use this option if your 68040 does not
13044 have code to emulate those instructions.
13045
13046 @item -m68060
13047 @opindex m68060
13048 Generate output for a 68060.  This is the default when the compiler is
13049 configured for 68060-based systems.  It is equivalent to
13050 @option{-march=68060}.
13051
13052 This option inhibits the use of 68020 and 68881/68882 instructions that
13053 have to be emulated by software on the 68060.  Use this option if your 68060
13054 does not have code to emulate those instructions.
13055
13056 @item -mcpu32
13057 @opindex mcpu32
13058 Generate output for a CPU32.  This is the default
13059 when the compiler is configured for CPU32-based systems.
13060 It is equivalent to @option{-march=cpu32}.
13061
13062 Use this option for microcontrollers with a
13063 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
13064 68336, 68340, 68341, 68349 and 68360.
13065
13066 @item -m5200
13067 @opindex m5200
13068 Generate output for a 520X ColdFire CPU@.  This is the default
13069 when the compiler is configured for 520X-based systems.
13070 It is equivalent to @option{-mcpu=5206}, and is now deprecated
13071 in favor of that option.
13072
13073 Use this option for microcontroller with a 5200 core, including
13074 the MCF5202, MCF5203, MCF5204 and MCF5206.
13075
13076 @item -m5206e
13077 @opindex m5206e
13078 Generate output for a 5206e ColdFire CPU@.  The option is now
13079 deprecated in favor of the equivalent @option{-mcpu=5206e}.
13080
13081 @item -m528x
13082 @opindex m528x
13083 Generate output for a member of the ColdFire 528X family.
13084 The option is now deprecated in favor of the equivalent
13085 @option{-mcpu=528x}.
13086
13087 @item -m5307
13088 @opindex m5307
13089 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
13090 in favor of the equivalent @option{-mcpu=5307}.
13091
13092 @item -m5407
13093 @opindex m5407
13094 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
13095 in favor of the equivalent @option{-mcpu=5407}.
13096
13097 @item -mcfv4e
13098 @opindex mcfv4e
13099 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
13100 This includes use of hardware floating point instructions.
13101 The option is equivalent to @option{-mcpu=547x}, and is now
13102 deprecated in favor of that option.
13103
13104 @item -m68020-40
13105 @opindex m68020-40
13106 Generate output for a 68040, without using any of the new instructions.
13107 This results in code which can run relatively efficiently on either a
13108 68020/68881 or a 68030 or a 68040.  The generated code does use the
13109 68881 instructions that are emulated on the 68040.
13110
13111 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
13112
13113 @item -m68020-60
13114 @opindex m68020-60
13115 Generate output for a 68060, without using any of the new instructions.
13116 This results in code which can run relatively efficiently on either a
13117 68020/68881 or a 68030 or a 68040.  The generated code does use the
13118 68881 instructions that are emulated on the 68060.
13119
13120 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
13121
13122 @item -mhard-float
13123 @itemx -m68881
13124 @opindex mhard-float
13125 @opindex m68881
13126 Generate floating-point instructions.  This is the default for 68020
13127 and above, and for ColdFire devices that have an FPU@.  It defines the
13128 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13129 on ColdFire targets.
13130
13131 @item -msoft-float
13132 @opindex msoft-float
13133 Do not generate floating-point instructions; use library calls instead.
13134 This is the default for 68000, 68010, and 68832 targets.  It is also
13135 the default for ColdFire devices that have no FPU.
13136
13137 @item -mdiv
13138 @itemx -mno-div
13139 @opindex mdiv
13140 @opindex mno-div
13141 Generate (do not generate) ColdFire hardware divide and remainder
13142 instructions.  If @option{-march} is used without @option{-mcpu},
13143 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13144 architectures.  Otherwise, the default is taken from the target CPU
13145 (either the default CPU, or the one specified by @option{-mcpu}).  For
13146 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13147 @option{-mcpu=5206e}.
13148
13149 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13150
13151 @item -mshort
13152 @opindex mshort
13153 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13154 Additionally, parameters passed on the stack are also aligned to a
13155 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13156
13157 @item -mno-short
13158 @opindex mno-short
13159 Do not consider type @code{int} to be 16 bits wide.  This is the default.
13160
13161 @item -mnobitfield
13162 @itemx -mno-bitfield
13163 @opindex mnobitfield
13164 @opindex mno-bitfield
13165 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
13166 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13167
13168 @item -mbitfield
13169 @opindex mbitfield
13170 Do use the bit-field instructions.  The @option{-m68020} option implies
13171 @option{-mbitfield}.  This is the default if you use a configuration
13172 designed for a 68020.
13173
13174 @item -mrtd
13175 @opindex mrtd
13176 Use a different function-calling convention, in which functions
13177 that take a fixed number of arguments return with the @code{rtd}
13178 instruction, which pops their arguments while returning.  This
13179 saves one instruction in the caller since there is no need to pop
13180 the arguments there.
13181
13182 This calling convention is incompatible with the one normally
13183 used on Unix, so you cannot use it if you need to call libraries
13184 compiled with the Unix compiler.
13185
13186 Also, you must provide function prototypes for all functions that
13187 take variable numbers of arguments (including @code{printf});
13188 otherwise incorrect code will be generated for calls to those
13189 functions.
13190
13191 In addition, seriously incorrect code will result if you call a
13192 function with too many arguments.  (Normally, extra arguments are
13193 harmlessly ignored.)
13194
13195 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13196 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13197
13198 @item -mno-rtd
13199 @opindex mno-rtd
13200 Do not use the calling conventions selected by @option{-mrtd}.
13201 This is the default.
13202
13203 @item -malign-int
13204 @itemx -mno-align-int
13205 @opindex malign-int
13206 @opindex mno-align-int
13207 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13208 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13209 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13210 Aligning variables on 32-bit boundaries produces code that runs somewhat
13211 faster on processors with 32-bit busses at the expense of more memory.
13212
13213 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13214 align structures containing the above types  differently than
13215 most published application binary interface specifications for the m68k.
13216
13217 @item -mpcrel
13218 @opindex mpcrel
13219 Use the pc-relative addressing mode of the 68000 directly, instead of
13220 using a global offset table.  At present, this option implies @option{-fpic},
13221 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13222 not presently supported with @option{-mpcrel}, though this could be supported for
13223 68020 and higher processors.
13224
13225 @item -mno-strict-align
13226 @itemx -mstrict-align
13227 @opindex mno-strict-align
13228 @opindex mstrict-align
13229 Do not (do) assume that unaligned memory references will be handled by
13230 the system.
13231
13232 @item -msep-data
13233 Generate code that allows the data segment to be located in a different
13234 area of memory from the text segment.  This allows for execute in place in
13235 an environment without virtual memory management.  This option implies
13236 @option{-fPIC}.
13237
13238 @item -mno-sep-data
13239 Generate code that assumes that the data segment follows the text segment.
13240 This is the default.
13241
13242 @item -mid-shared-library
13243 Generate code that supports shared libraries via the library ID method.
13244 This allows for execute in place and shared libraries in an environment
13245 without virtual memory management.  This option implies @option{-fPIC}.
13246
13247 @item -mno-id-shared-library
13248 Generate code that doesn't assume ID based shared libraries are being used.
13249 This is the default.
13250
13251 @item -mshared-library-id=n
13252 Specified the identification number of the ID based shared library being
13253 compiled.  Specifying a value of 0 will generate more compact code, specifying
13254 other values will force the allocation of that number to the current
13255 library but is no more space or time efficient than omitting this option.
13256
13257 @item -mxgot
13258 @itemx -mno-xgot
13259 @opindex mxgot
13260 @opindex mno-xgot
13261 When generating position-independent code for ColdFire, generate code
13262 that works if the GOT has more than 8192 entries.  This code is
13263 larger and slower than code generated without this option.  On M680x0
13264 processors, this option is not needed; @option{-fPIC} suffices.
13265
13266 GCC normally uses a single instruction to load values from the GOT@.
13267 While this is relatively efficient, it only works if the GOT
13268 is smaller than about 64k.  Anything larger causes the linker
13269 to report an error such as:
13270
13271 @cindex relocation truncated to fit (ColdFire)
13272 @smallexample
13273 relocation truncated to fit: R_68K_GOT16O foobar
13274 @end smallexample
13275
13276 If this happens, you should recompile your code with @option{-mxgot}.
13277 It should then work with very large GOTs.  However, code generated with
13278 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13279 the value of a global symbol.
13280
13281 Note that some linkers, including newer versions of the GNU linker,
13282 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13283 you should only need to use @option{-mxgot} when compiling a single
13284 object file that accesses more than 8192 GOT entries.  Very few do.
13285
13286 These options have no effect unless GCC is generating
13287 position-independent code.
13288
13289 @end table
13290
13291 @node M68hc1x Options
13292 @subsection M68hc1x Options
13293 @cindex M68hc1x options
13294
13295 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13296 microcontrollers.  The default values for these options depends on
13297 which style of microcontroller was selected when the compiler was configured;
13298 the defaults for the most common choices are given below.
13299
13300 @table @gcctabopt
13301 @item -m6811
13302 @itemx -m68hc11
13303 @opindex m6811
13304 @opindex m68hc11
13305 Generate output for a 68HC11.  This is the default
13306 when the compiler is configured for 68HC11-based systems.
13307
13308 @item -m6812
13309 @itemx -m68hc12
13310 @opindex m6812
13311 @opindex m68hc12
13312 Generate output for a 68HC12.  This is the default
13313 when the compiler is configured for 68HC12-based systems.
13314
13315 @item -m68S12
13316 @itemx -m68hcs12
13317 @opindex m68S12
13318 @opindex m68hcs12
13319 Generate output for a 68HCS12.
13320
13321 @item -mauto-incdec
13322 @opindex mauto-incdec
13323 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13324 addressing modes.
13325
13326 @item -minmax
13327 @itemx -mnominmax
13328 @opindex minmax
13329 @opindex mnominmax
13330 Enable the use of 68HC12 min and max instructions.
13331
13332 @item -mlong-calls
13333 @itemx -mno-long-calls
13334 @opindex mlong-calls
13335 @opindex mno-long-calls
13336 Treat all calls as being far away (near).  If calls are assumed to be
13337 far away, the compiler will use the @code{call} instruction to
13338 call a function and the @code{rtc} instruction for returning.
13339
13340 @item -mshort
13341 @opindex mshort
13342 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13343
13344 @item -msoft-reg-count=@var{count}
13345 @opindex msoft-reg-count
13346 Specify the number of pseudo-soft registers which are used for the
13347 code generation.  The maximum number is 32.  Using more pseudo-soft
13348 register may or may not result in better code depending on the program.
13349 The default is 4 for 68HC11 and 2 for 68HC12.
13350
13351 @end table
13352
13353 @node MCore Options
13354 @subsection MCore Options
13355 @cindex MCore options
13356
13357 These are the @samp{-m} options defined for the Motorola M*Core
13358 processors.
13359
13360 @table @gcctabopt
13361
13362 @item -mhardlit
13363 @itemx -mno-hardlit
13364 @opindex mhardlit
13365 @opindex mno-hardlit
13366 Inline constants into the code stream if it can be done in two
13367 instructions or less.
13368
13369 @item -mdiv
13370 @itemx -mno-div
13371 @opindex mdiv
13372 @opindex mno-div
13373 Use the divide instruction.  (Enabled by default).
13374
13375 @item -mrelax-immediate
13376 @itemx -mno-relax-immediate
13377 @opindex mrelax-immediate
13378 @opindex mno-relax-immediate
13379 Allow arbitrary sized immediates in bit operations.
13380
13381 @item -mwide-bitfields
13382 @itemx -mno-wide-bitfields
13383 @opindex mwide-bitfields
13384 @opindex mno-wide-bitfields
13385 Always treat bit-fields as int-sized.
13386
13387 @item -m4byte-functions
13388 @itemx -mno-4byte-functions
13389 @opindex m4byte-functions
13390 @opindex mno-4byte-functions
13391 Force all functions to be aligned to a four byte boundary.
13392
13393 @item -mcallgraph-data
13394 @itemx -mno-callgraph-data
13395 @opindex mcallgraph-data
13396 @opindex mno-callgraph-data
13397 Emit callgraph information.
13398
13399 @item -mslow-bytes
13400 @itemx -mno-slow-bytes
13401 @opindex mslow-bytes
13402 @opindex mno-slow-bytes
13403 Prefer word access when reading byte quantities.
13404
13405 @item -mlittle-endian
13406 @itemx -mbig-endian
13407 @opindex mlittle-endian
13408 @opindex mbig-endian
13409 Generate code for a little endian target.
13410
13411 @item -m210
13412 @itemx -m340
13413 @opindex m210
13414 @opindex m340
13415 Generate code for the 210 processor.
13416
13417 @item -mno-lsim
13418 @opindex mno-lsim
13419 Assume that run-time support has been provided and so omit the
13420 simulator library (@file{libsim.a)} from the linker command line.
13421
13422 @item -mstack-increment=@var{size}
13423 @opindex mstack-increment
13424 Set the maximum amount for a single stack increment operation.  Large
13425 values can increase the speed of programs which contain functions
13426 that need a large amount of stack space, but they can also trigger a
13427 segmentation fault if the stack is extended too much.  The default
13428 value is 0x1000.
13429
13430 @end table
13431
13432 @node MeP Options
13433 @subsection MeP Options
13434 @cindex MeP options
13435
13436 @table @gcctabopt
13437
13438 @item -mabsdiff
13439 @opindex mabsdiff
13440 Enables the @code{abs} instruction, which is the absolute difference
13441 between two registers.
13442
13443 @item -mall-opts
13444 @opindex mall-opts
13445 Enables all the optional instructions - average, multiply, divide, bit
13446 operations, leading zero, absolute difference, min/max, clip, and
13447 saturation.
13448
13449
13450 @item -maverage
13451 @opindex maverage
13452 Enables the @code{ave} instruction, which computes the average of two
13453 registers.
13454
13455 @item -mbased=@var{n}
13456 @opindex mbased=
13457 Variables of size @var{n} bytes or smaller will be placed in the
13458 @code{.based} section by default.  Based variables use the @code{$tp}
13459 register as a base register, and there is a 128 byte limit to the
13460 @code{.based} section.
13461
13462 @item -mbitops
13463 @opindex mbitops
13464 Enables the bit operation instructions - bit test (@code{btstm}), set
13465 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13466 test-and-set (@code{tas}).
13467
13468 @item -mc=@var{name}
13469 @opindex mc=
13470 Selects which section constant data will be placed in.  @var{name} may
13471 be @code{tiny}, @code{near}, or @code{far}.
13472
13473 @item -mclip
13474 @opindex mclip
13475 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13476 useful unless you also provide @code{-mminmax}.
13477
13478 @item -mconfig=@var{name}
13479 @opindex mconfig=
13480 Selects one of the build-in core configurations.  Each MeP chip has
13481 one or more modules in it; each module has a core CPU and a variety of
13482 coprocessors, optional instructions, and peripherals.  The
13483 @code{MeP-Integrator} tool, not part of GCC, provides these
13484 configurations through this option; using this option is the same as
13485 using all the corresponding command line options.  The default
13486 configuration is @code{default}.
13487
13488 @item -mcop
13489 @opindex mcop
13490 Enables the coprocessor instructions.  By default, this is a 32-bit
13491 coprocessor.  Note that the coprocessor is normally enabled via the
13492 @code{-mconfig=} option.
13493
13494 @item -mcop32
13495 @opindex mcop32
13496 Enables the 32-bit coprocessor's instructions.
13497
13498 @item -mcop64
13499 @opindex mcop64
13500 Enables the 64-bit coprocessor's instructions.
13501
13502 @item -mivc2
13503 @opindex mivc2
13504 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13505
13506 @item -mdc
13507 @opindex mdc
13508 Causes constant variables to be placed in the @code{.near} section.
13509
13510 @item -mdiv
13511 @opindex mdiv
13512 Enables the @code{div} and @code{divu} instructions.
13513
13514 @item -meb
13515 @opindex meb
13516 Generate big-endian code.
13517
13518 @item -mel
13519 @opindex mel
13520 Generate little-endian code.
13521
13522 @item -mio-volatile
13523 @opindex mio-volatile
13524 Tells the compiler that any variable marked with the @code{io}
13525 attribute is to be considered volatile.
13526
13527 @item -ml
13528 @opindex ml
13529 Causes variables to be assigned to the @code{.far} section by default.
13530
13531 @item -mleadz
13532 @opindex mleadz
13533 Enables the @code{leadz} (leading zero) instruction.
13534
13535 @item -mm
13536 @opindex mm
13537 Causes variables to be assigned to the @code{.near} section by default.
13538
13539 @item -mminmax
13540 @opindex mminmax
13541 Enables the @code{min} and @code{max} instructions.
13542
13543 @item -mmult
13544 @opindex mmult
13545 Enables the multiplication and multiply-accumulate instructions.
13546
13547 @item -mno-opts
13548 @opindex mno-opts
13549 Disables all the optional instructions enabled by @code{-mall-opts}.
13550
13551 @item -mrepeat
13552 @opindex mrepeat
13553 Enables the @code{repeat} and @code{erepeat} instructions, used for
13554 low-overhead looping.
13555
13556 @item -ms
13557 @opindex ms
13558 Causes all variables to default to the @code{.tiny} section.  Note
13559 that there is a 65536 byte limit to this section.  Accesses to these
13560 variables use the @code{%gp} base register.
13561
13562 @item -msatur
13563 @opindex msatur
13564 Enables the saturation instructions.  Note that the compiler does not
13565 currently generate these itself, but this option is included for
13566 compatibility with other tools, like @code{as}.
13567
13568 @item -msdram
13569 @opindex msdram
13570 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13571
13572 @item -msim
13573 @opindex msim
13574 Link the simulator runtime libraries.
13575
13576 @item -msimnovec
13577 @opindex msimnovec
13578 Link the simulator runtime libraries, excluding built-in support
13579 for reset and exception vectors and tables.
13580
13581 @item -mtf
13582 @opindex mtf
13583 Causes all functions to default to the @code{.far} section.  Without
13584 this option, functions default to the @code{.near} section.
13585
13586 @item -mtiny=@var{n}
13587 @opindex mtiny=
13588 Variables that are @var{n} bytes or smaller will be allocated to the
13589 @code{.tiny} section.  These variables use the @code{$gp} base
13590 register.  The default for this option is 4, but note that there's a
13591 65536 byte limit to the @code{.tiny} section.
13592
13593 @end table
13594
13595 @node MIPS Options
13596 @subsection MIPS Options
13597 @cindex MIPS options
13598
13599 @table @gcctabopt
13600
13601 @item -EB
13602 @opindex EB
13603 Generate big-endian code.
13604
13605 @item -EL
13606 @opindex EL
13607 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13608 configurations.
13609
13610 @item -march=@var{arch}
13611 @opindex march
13612 Generate code that will run on @var{arch}, which can be the name of a
13613 generic MIPS ISA, or the name of a particular processor.
13614 The ISA names are:
13615 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13616 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13617 The processor names are:
13618 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13619 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13620 @samp{5kc}, @samp{5kf},
13621 @samp{20kc},
13622 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13623 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13624 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13625 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13626 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13627 @samp{loongson2e}, @samp{loongson2f},
13628 @samp{m4k},
13629 @samp{octeon},
13630 @samp{orion},
13631 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13632 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13633 @samp{rm7000}, @samp{rm9000},
13634 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13635 @samp{sb1},
13636 @samp{sr71000},
13637 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13638 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13639 and @samp{xlr}.
13640 The special value @samp{from-abi} selects the
13641 most compatible architecture for the selected ABI (that is,
13642 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13643
13644 Native Linux/GNU toolchains also support the value @samp{native},
13645 which selects the best architecture option for the host processor.
13646 @option{-march=native} has no effect if GCC does not recognize
13647 the processor.
13648
13649 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13650 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13651 @samp{vr} may be written @samp{r}.
13652
13653 Names of the form @samp{@var{n}f2_1} refer to processors with
13654 FPUs clocked at half the rate of the core, names of the form
13655 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13656 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13657 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13658 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13659 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13660 accepted as synonyms for @samp{@var{n}f1_1}.
13661
13662 GCC defines two macros based on the value of this option.  The first
13663 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13664 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13665 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13666 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13667 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13668
13669 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13670 above.  In other words, it will have the full prefix and will not
13671 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13672 the macro names the resolved architecture (either @samp{"mips1"} or
13673 @samp{"mips3"}).  It names the default architecture when no
13674 @option{-march} option is given.
13675
13676 @item -mtune=@var{arch}
13677 @opindex mtune
13678 Optimize for @var{arch}.  Among other things, this option controls
13679 the way instructions are scheduled, and the perceived cost of arithmetic
13680 operations.  The list of @var{arch} values is the same as for
13681 @option{-march}.
13682
13683 When this option is not used, GCC will optimize for the processor
13684 specified by @option{-march}.  By using @option{-march} and
13685 @option{-mtune} together, it is possible to generate code that will
13686 run on a family of processors, but optimize the code for one
13687 particular member of that family.
13688
13689 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13690 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13691 @samp{-march} ones described above.
13692
13693 @item -mips1
13694 @opindex mips1
13695 Equivalent to @samp{-march=mips1}.
13696
13697 @item -mips2
13698 @opindex mips2
13699 Equivalent to @samp{-march=mips2}.
13700
13701 @item -mips3
13702 @opindex mips3
13703 Equivalent to @samp{-march=mips3}.
13704
13705 @item -mips4
13706 @opindex mips4
13707 Equivalent to @samp{-march=mips4}.
13708
13709 @item -mips32
13710 @opindex mips32
13711 Equivalent to @samp{-march=mips32}.
13712
13713 @item -mips32r2
13714 @opindex mips32r2
13715 Equivalent to @samp{-march=mips32r2}.
13716
13717 @item -mips64
13718 @opindex mips64
13719 Equivalent to @samp{-march=mips64}.
13720
13721 @item -mips64r2
13722 @opindex mips64r2
13723 Equivalent to @samp{-march=mips64r2}.
13724
13725 @item -mips16
13726 @itemx -mno-mips16
13727 @opindex mips16
13728 @opindex mno-mips16
13729 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13730 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13731
13732 MIPS16 code generation can also be controlled on a per-function basis
13733 by means of @code{mips16} and @code{nomips16} attributes.
13734 @xref{Function Attributes}, for more information.
13735
13736 @item -mflip-mips16
13737 @opindex mflip-mips16
13738 Generate MIPS16 code on alternating functions.  This option is provided
13739 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13740 not intended for ordinary use in compiling user code.
13741
13742 @item -minterlink-mips16
13743 @itemx -mno-interlink-mips16
13744 @opindex minterlink-mips16
13745 @opindex mno-interlink-mips16
13746 Require (do not require) that non-MIPS16 code be link-compatible with
13747 MIPS16 code.
13748
13749 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13750 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13751 therefore disables direct jumps unless GCC knows that the target of the
13752 jump is not MIPS16.
13753
13754 @item -mabi=32
13755 @itemx -mabi=o64
13756 @itemx -mabi=n32
13757 @itemx -mabi=64
13758 @itemx -mabi=eabi
13759 @opindex mabi=32
13760 @opindex mabi=o64
13761 @opindex mabi=n32
13762 @opindex mabi=64
13763 @opindex mabi=eabi
13764 Generate code for the given ABI@.
13765
13766 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13767 generates 64-bit code when you select a 64-bit architecture, but you
13768 can use @option{-mgp32} to get 32-bit code instead.
13769
13770 For information about the O64 ABI, see
13771 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13772
13773 GCC supports a variant of the o32 ABI in which floating-point registers
13774 are 64 rather than 32 bits wide.  You can select this combination with
13775 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13776 and @samp{mfhc1} instructions and is therefore only supported for
13777 MIPS32R2 processors.
13778
13779 The register assignments for arguments and return values remain the
13780 same, but each scalar value is passed in a single 64-bit register
13781 rather than a pair of 32-bit registers.  For example, scalar
13782 floating-point values are returned in @samp{$f0} only, not a
13783 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
13784 remains the same, but all 64 bits are saved.
13785
13786 @item -mabicalls
13787 @itemx -mno-abicalls
13788 @opindex mabicalls
13789 @opindex mno-abicalls
13790 Generate (do not generate) code that is suitable for SVR4-style
13791 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
13792 systems.
13793
13794 @item -mshared
13795 @itemx -mno-shared
13796 Generate (do not generate) code that is fully position-independent,
13797 and that can therefore be linked into shared libraries.  This option
13798 only affects @option{-mabicalls}.
13799
13800 All @option{-mabicalls} code has traditionally been position-independent,
13801 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
13802 as an extension, the GNU toolchain allows executables to use absolute
13803 accesses for locally-binding symbols.  It can also use shorter GP
13804 initialization sequences and generate direct calls to locally-defined
13805 functions.  This mode is selected by @option{-mno-shared}.
13806
13807 @option{-mno-shared} depends on binutils 2.16 or higher and generates
13808 objects that can only be linked by the GNU linker.  However, the option
13809 does not affect the ABI of the final executable; it only affects the ABI
13810 of relocatable objects.  Using @option{-mno-shared} will generally make
13811 executables both smaller and quicker.
13812
13813 @option{-mshared} is the default.
13814
13815 @item -mplt
13816 @itemx -mno-plt
13817 @opindex mplt
13818 @opindex mno-plt
13819 Assume (do not assume) that the static and dynamic linkers
13820 support PLTs and copy relocations.  This option only affects
13821 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
13822 has no effect without @samp{-msym32}.
13823
13824 You can make @option{-mplt} the default by configuring
13825 GCC with @option{--with-mips-plt}.  The default is
13826 @option{-mno-plt} otherwise.
13827
13828 @item -mxgot
13829 @itemx -mno-xgot
13830 @opindex mxgot
13831 @opindex mno-xgot
13832 Lift (do not lift) the usual restrictions on the size of the global
13833 offset table.
13834
13835 GCC normally uses a single instruction to load values from the GOT@.
13836 While this is relatively efficient, it will only work if the GOT
13837 is smaller than about 64k.  Anything larger will cause the linker
13838 to report an error such as:
13839
13840 @cindex relocation truncated to fit (MIPS)
13841 @smallexample
13842 relocation truncated to fit: R_MIPS_GOT16 foobar
13843 @end smallexample
13844
13845 If this happens, you should recompile your code with @option{-mxgot}.
13846 It should then work with very large GOTs, although it will also be
13847 less efficient, since it will take three instructions to fetch the
13848 value of a global symbol.
13849
13850 Note that some linkers can create multiple GOTs.  If you have such a
13851 linker, you should only need to use @option{-mxgot} when a single object
13852 file accesses more than 64k's worth of GOT entries.  Very few do.
13853
13854 These options have no effect unless GCC is generating position
13855 independent code.
13856
13857 @item -mgp32
13858 @opindex mgp32
13859 Assume that general-purpose registers are 32 bits wide.
13860
13861 @item -mgp64
13862 @opindex mgp64
13863 Assume that general-purpose registers are 64 bits wide.
13864
13865 @item -mfp32
13866 @opindex mfp32
13867 Assume that floating-point registers are 32 bits wide.
13868
13869 @item -mfp64
13870 @opindex mfp64
13871 Assume that floating-point registers are 64 bits wide.
13872
13873 @item -mhard-float
13874 @opindex mhard-float
13875 Use floating-point coprocessor instructions.
13876
13877 @item -msoft-float
13878 @opindex msoft-float
13879 Do not use floating-point coprocessor instructions.  Implement
13880 floating-point calculations using library calls instead.
13881
13882 @item -msingle-float
13883 @opindex msingle-float
13884 Assume that the floating-point coprocessor only supports single-precision
13885 operations.
13886
13887 @item -mdouble-float
13888 @opindex mdouble-float
13889 Assume that the floating-point coprocessor supports double-precision
13890 operations.  This is the default.
13891
13892 @item -mllsc
13893 @itemx -mno-llsc
13894 @opindex mllsc
13895 @opindex mno-llsc
13896 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
13897 implement atomic memory built-in functions.  When neither option is
13898 specified, GCC will use the instructions if the target architecture
13899 supports them.
13900
13901 @option{-mllsc} is useful if the runtime environment can emulate the
13902 instructions and @option{-mno-llsc} can be useful when compiling for
13903 nonstandard ISAs.  You can make either option the default by
13904 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
13905 respectively.  @option{--with-llsc} is the default for some
13906 configurations; see the installation documentation for details.
13907
13908 @item -mdsp
13909 @itemx -mno-dsp
13910 @opindex mdsp
13911 @opindex mno-dsp
13912 Use (do not use) revision 1 of the MIPS DSP ASE@.
13913 @xref{MIPS DSP Built-in Functions}.  This option defines the
13914 preprocessor macro @samp{__mips_dsp}.  It also defines
13915 @samp{__mips_dsp_rev} to 1.
13916
13917 @item -mdspr2
13918 @itemx -mno-dspr2
13919 @opindex mdspr2
13920 @opindex mno-dspr2
13921 Use (do not use) revision 2 of the MIPS DSP ASE@.
13922 @xref{MIPS DSP Built-in Functions}.  This option defines the
13923 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
13924 It also defines @samp{__mips_dsp_rev} to 2.
13925
13926 @item -msmartmips
13927 @itemx -mno-smartmips
13928 @opindex msmartmips
13929 @opindex mno-smartmips
13930 Use (do not use) the MIPS SmartMIPS ASE.
13931
13932 @item -mpaired-single
13933 @itemx -mno-paired-single
13934 @opindex mpaired-single
13935 @opindex mno-paired-single
13936 Use (do not use) paired-single floating-point instructions.
13937 @xref{MIPS Paired-Single Support}.  This option requires
13938 hardware floating-point support to be enabled.
13939
13940 @item -mdmx
13941 @itemx -mno-mdmx
13942 @opindex mdmx
13943 @opindex mno-mdmx
13944 Use (do not use) MIPS Digital Media Extension instructions.
13945 This option can only be used when generating 64-bit code and requires
13946 hardware floating-point support to be enabled.
13947
13948 @item -mips3d
13949 @itemx -mno-mips3d
13950 @opindex mips3d
13951 @opindex mno-mips3d
13952 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
13953 The option @option{-mips3d} implies @option{-mpaired-single}.
13954
13955 @item -mmt
13956 @itemx -mno-mt
13957 @opindex mmt
13958 @opindex mno-mt
13959 Use (do not use) MT Multithreading instructions.
13960
13961 @item -mlong64
13962 @opindex mlong64
13963 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
13964 an explanation of the default and the way that the pointer size is
13965 determined.
13966
13967 @item -mlong32
13968 @opindex mlong32
13969 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
13970
13971 The default size of @code{int}s, @code{long}s and pointers depends on
13972 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
13973 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
13974 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
13975 or the same size as integer registers, whichever is smaller.
13976
13977 @item -msym32
13978 @itemx -mno-sym32
13979 @opindex msym32
13980 @opindex mno-sym32
13981 Assume (do not assume) that all symbols have 32-bit values, regardless
13982 of the selected ABI@.  This option is useful in combination with
13983 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
13984 to generate shorter and faster references to symbolic addresses.
13985
13986 @item -G @var{num}
13987 @opindex G
13988 Put definitions of externally-visible data in a small data section
13989 if that data is no bigger than @var{num} bytes.  GCC can then access
13990 the data more efficiently; see @option{-mgpopt} for details.
13991
13992 The default @option{-G} option depends on the configuration.
13993
13994 @item -mlocal-sdata
13995 @itemx -mno-local-sdata
13996 @opindex mlocal-sdata
13997 @opindex mno-local-sdata
13998 Extend (do not extend) the @option{-G} behavior to local data too,
13999 such as to static variables in C@.  @option{-mlocal-sdata} is the
14000 default for all configurations.
14001
14002 If the linker complains that an application is using too much small data,
14003 you might want to try rebuilding the less performance-critical parts with
14004 @option{-mno-local-sdata}.  You might also want to build large
14005 libraries with @option{-mno-local-sdata}, so that the libraries leave
14006 more room for the main program.
14007
14008 @item -mextern-sdata
14009 @itemx -mno-extern-sdata
14010 @opindex mextern-sdata
14011 @opindex mno-extern-sdata
14012 Assume (do not assume) that externally-defined data will be in
14013 a small data section if that data is within the @option{-G} limit.
14014 @option{-mextern-sdata} is the default for all configurations.
14015
14016 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
14017 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
14018 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
14019 is placed in a small data section.  If @var{Var} is defined by another
14020 module, you must either compile that module with a high-enough
14021 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
14022 definition.  If @var{Var} is common, you must link the application
14023 with a high-enough @option{-G} setting.
14024
14025 The easiest way of satisfying these restrictions is to compile
14026 and link every module with the same @option{-G} option.  However,
14027 you may wish to build a library that supports several different
14028 small data limits.  You can do this by compiling the library with
14029 the highest supported @option{-G} setting and additionally using
14030 @option{-mno-extern-sdata} to stop the library from making assumptions
14031 about externally-defined data.
14032
14033 @item -mgpopt
14034 @itemx -mno-gpopt
14035 @opindex mgpopt
14036 @opindex mno-gpopt
14037 Use (do not use) GP-relative accesses for symbols that are known to be
14038 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
14039 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
14040 configurations.
14041
14042 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
14043 might not hold the value of @code{_gp}.  For example, if the code is
14044 part of a library that might be used in a boot monitor, programs that
14045 call boot monitor routines will pass an unknown value in @code{$gp}.
14046 (In such situations, the boot monitor itself would usually be compiled
14047 with @option{-G0}.)
14048
14049 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
14050 @option{-mno-extern-sdata}.
14051
14052 @item -membedded-data
14053 @itemx -mno-embedded-data
14054 @opindex membedded-data
14055 @opindex mno-embedded-data
14056 Allocate variables to the read-only data section first if possible, then
14057 next in the small data section if possible, otherwise in data.  This gives
14058 slightly slower code than the default, but reduces the amount of RAM required
14059 when executing, and thus may be preferred for some embedded systems.
14060
14061 @item -muninit-const-in-rodata
14062 @itemx -mno-uninit-const-in-rodata
14063 @opindex muninit-const-in-rodata
14064 @opindex mno-uninit-const-in-rodata
14065 Put uninitialized @code{const} variables in the read-only data section.
14066 This option is only meaningful in conjunction with @option{-membedded-data}.
14067
14068 @item -mcode-readable=@var{setting}
14069 @opindex mcode-readable
14070 Specify whether GCC may generate code that reads from executable sections.
14071 There are three possible settings:
14072
14073 @table @gcctabopt
14074 @item -mcode-readable=yes
14075 Instructions may freely access executable sections.  This is the
14076 default setting.
14077
14078 @item -mcode-readable=pcrel
14079 MIPS16 PC-relative load instructions can access executable sections,
14080 but other instructions must not do so.  This option is useful on 4KSc
14081 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
14082 It is also useful on processors that can be configured to have a dual
14083 instruction/data SRAM interface and that, like the M4K, automatically
14084 redirect PC-relative loads to the instruction RAM.
14085
14086 @item -mcode-readable=no
14087 Instructions must not access executable sections.  This option can be
14088 useful on targets that are configured to have a dual instruction/data
14089 SRAM interface but that (unlike the M4K) do not automatically redirect
14090 PC-relative loads to the instruction RAM.
14091 @end table
14092
14093 @item -msplit-addresses
14094 @itemx -mno-split-addresses
14095 @opindex msplit-addresses
14096 @opindex mno-split-addresses
14097 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
14098 relocation operators.  This option has been superseded by
14099 @option{-mexplicit-relocs} but is retained for backwards compatibility.
14100
14101 @item -mexplicit-relocs
14102 @itemx -mno-explicit-relocs
14103 @opindex mexplicit-relocs
14104 @opindex mno-explicit-relocs
14105 Use (do not use) assembler relocation operators when dealing with symbolic
14106 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
14107 is to use assembler macros instead.
14108
14109 @option{-mexplicit-relocs} is the default if GCC was configured
14110 to use an assembler that supports relocation operators.
14111
14112 @item -mcheck-zero-division
14113 @itemx -mno-check-zero-division
14114 @opindex mcheck-zero-division
14115 @opindex mno-check-zero-division
14116 Trap (do not trap) on integer division by zero.
14117
14118 The default is @option{-mcheck-zero-division}.
14119
14120 @item -mdivide-traps
14121 @itemx -mdivide-breaks
14122 @opindex mdivide-traps
14123 @opindex mdivide-breaks
14124 MIPS systems check for division by zero by generating either a
14125 conditional trap or a break instruction.  Using traps results in
14126 smaller code, but is only supported on MIPS II and later.  Also, some
14127 versions of the Linux kernel have a bug that prevents trap from
14128 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
14129 allow conditional traps on architectures that support them and
14130 @option{-mdivide-breaks} to force the use of breaks.
14131
14132 The default is usually @option{-mdivide-traps}, but this can be
14133 overridden at configure time using @option{--with-divide=breaks}.
14134 Divide-by-zero checks can be completely disabled using
14135 @option{-mno-check-zero-division}.
14136
14137 @item -mmemcpy
14138 @itemx -mno-memcpy
14139 @opindex mmemcpy
14140 @opindex mno-memcpy
14141 Force (do not force) the use of @code{memcpy()} for non-trivial block
14142 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
14143 most constant-sized copies.
14144
14145 @item -mlong-calls
14146 @itemx -mno-long-calls
14147 @opindex mlong-calls
14148 @opindex mno-long-calls
14149 Disable (do not disable) use of the @code{jal} instruction.  Calling
14150 functions using @code{jal} is more efficient but requires the caller
14151 and callee to be in the same 256 megabyte segment.
14152
14153 This option has no effect on abicalls code.  The default is
14154 @option{-mno-long-calls}.
14155
14156 @item -mmad
14157 @itemx -mno-mad
14158 @opindex mmad
14159 @opindex mno-mad
14160 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14161 instructions, as provided by the R4650 ISA@.
14162
14163 @item -mfused-madd
14164 @itemx -mno-fused-madd
14165 @opindex mfused-madd
14166 @opindex mno-fused-madd
14167 Enable (disable) use of the floating point multiply-accumulate
14168 instructions, when they are available.  The default is
14169 @option{-mfused-madd}.
14170
14171 When multiply-accumulate instructions are used, the intermediate
14172 product is calculated to infinite precision and is not subject to
14173 the FCSR Flush to Zero bit.  This may be undesirable in some
14174 circumstances.
14175
14176 @item -nocpp
14177 @opindex nocpp
14178 Tell the MIPS assembler to not run its preprocessor over user
14179 assembler files (with a @samp{.s} suffix) when assembling them.
14180
14181 @item -mfix-r4000
14182 @itemx -mno-fix-r4000
14183 @opindex mfix-r4000
14184 @opindex mno-fix-r4000
14185 Work around certain R4000 CPU errata:
14186 @itemize @minus
14187 @item
14188 A double-word or a variable shift may give an incorrect result if executed
14189 immediately after starting an integer division.
14190 @item
14191 A double-word or a variable shift may give an incorrect result if executed
14192 while an integer multiplication is in progress.
14193 @item
14194 An integer division may give an incorrect result if started in a delay slot
14195 of a taken branch or a jump.
14196 @end itemize
14197
14198 @item -mfix-r4400
14199 @itemx -mno-fix-r4400
14200 @opindex mfix-r4400
14201 @opindex mno-fix-r4400
14202 Work around certain R4400 CPU errata:
14203 @itemize @minus
14204 @item
14205 A double-word or a variable shift may give an incorrect result if executed
14206 immediately after starting an integer division.
14207 @end itemize
14208
14209 @item -mfix-r10000
14210 @itemx -mno-fix-r10000
14211 @opindex mfix-r10000
14212 @opindex mno-fix-r10000
14213 Work around certain R10000 errata:
14214 @itemize @minus
14215 @item
14216 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14217 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14218 @end itemize
14219
14220 This option can only be used if the target architecture supports
14221 branch-likely instructions.  @option{-mfix-r10000} is the default when
14222 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14223 otherwise.
14224
14225 @item -mfix-vr4120
14226 @itemx -mno-fix-vr4120
14227 @opindex mfix-vr4120
14228 Work around certain VR4120 errata:
14229 @itemize @minus
14230 @item
14231 @code{dmultu} does not always produce the correct result.
14232 @item
14233 @code{div} and @code{ddiv} do not always produce the correct result if one
14234 of the operands is negative.
14235 @end itemize
14236 The workarounds for the division errata rely on special functions in
14237 @file{libgcc.a}.  At present, these functions are only provided by
14238 the @code{mips64vr*-elf} configurations.
14239
14240 Other VR4120 errata require a nop to be inserted between certain pairs of
14241 instructions.  These errata are handled by the assembler, not by GCC itself.
14242
14243 @item -mfix-vr4130
14244 @opindex mfix-vr4130
14245 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14246 workarounds are implemented by the assembler rather than by GCC,
14247 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14248 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14249 instructions are available instead.
14250
14251 @item -mfix-sb1
14252 @itemx -mno-fix-sb1
14253 @opindex mfix-sb1
14254 Work around certain SB-1 CPU core errata.
14255 (This flag currently works around the SB-1 revision 2
14256 ``F1'' and ``F2'' floating point errata.)
14257
14258 @item -mr10k-cache-barrier=@var{setting}
14259 @opindex mr10k-cache-barrier
14260 Specify whether GCC should insert cache barriers to avoid the
14261 side-effects of speculation on R10K processors.
14262
14263 In common with many processors, the R10K tries to predict the outcome
14264 of a conditional branch and speculatively executes instructions from
14265 the ``taken'' branch.  It later aborts these instructions if the
14266 predicted outcome was wrong.  However, on the R10K, even aborted
14267 instructions can have side effects.
14268
14269 This problem only affects kernel stores and, depending on the system,
14270 kernel loads.  As an example, a speculatively-executed store may load
14271 the target memory into cache and mark the cache line as dirty, even if
14272 the store itself is later aborted.  If a DMA operation writes to the
14273 same area of memory before the ``dirty'' line is flushed, the cached
14274 data will overwrite the DMA-ed data.  See the R10K processor manual
14275 for a full description, including other potential problems.
14276
14277 One workaround is to insert cache barrier instructions before every memory
14278 access that might be speculatively executed and that might have side
14279 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14280 controls GCC's implementation of this workaround.  It assumes that
14281 aborted accesses to any byte in the following regions will not have
14282 side effects:
14283
14284 @enumerate
14285 @item
14286 the memory occupied by the current function's stack frame;
14287
14288 @item
14289 the memory occupied by an incoming stack argument;
14290
14291 @item
14292 the memory occupied by an object with a link-time-constant address.
14293 @end enumerate
14294
14295 It is the kernel's responsibility to ensure that speculative
14296 accesses to these regions are indeed safe.
14297
14298 If the input program contains a function declaration such as:
14299
14300 @smallexample
14301 void foo (void);
14302 @end smallexample
14303
14304 then the implementation of @code{foo} must allow @code{j foo} and
14305 @code{jal foo} to be executed speculatively.  GCC honors this
14306 restriction for functions it compiles itself.  It expects non-GCC
14307 functions (such as hand-written assembly code) to do the same.
14308
14309 The option has three forms:
14310
14311 @table @gcctabopt
14312 @item -mr10k-cache-barrier=load-store
14313 Insert a cache barrier before a load or store that might be
14314 speculatively executed and that might have side effects even
14315 if aborted.
14316
14317 @item -mr10k-cache-barrier=store
14318 Insert a cache barrier before a store that might be speculatively
14319 executed and that might have side effects even if aborted.
14320
14321 @item -mr10k-cache-barrier=none
14322 Disable the insertion of cache barriers.  This is the default setting.
14323 @end table
14324
14325 @item -mflush-func=@var{func}
14326 @itemx -mno-flush-func
14327 @opindex mflush-func
14328 Specifies the function to call to flush the I and D caches, or to not
14329 call any such function.  If called, the function must take the same
14330 arguments as the common @code{_flush_func()}, that is, the address of the
14331 memory range for which the cache is being flushed, the size of the
14332 memory range, and the number 3 (to flush both caches).  The default
14333 depends on the target GCC was configured for, but commonly is either
14334 @samp{_flush_func} or @samp{__cpu_flush}.
14335
14336 @item mbranch-cost=@var{num}
14337 @opindex mbranch-cost
14338 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14339 This cost is only a heuristic and is not guaranteed to produce
14340 consistent results across releases.  A zero cost redundantly selects
14341 the default, which is based on the @option{-mtune} setting.
14342
14343 @item -mbranch-likely
14344 @itemx -mno-branch-likely
14345 @opindex mbranch-likely
14346 @opindex mno-branch-likely
14347 Enable or disable use of Branch Likely instructions, regardless of the
14348 default for the selected architecture.  By default, Branch Likely
14349 instructions may be generated if they are supported by the selected
14350 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14351 and processors which implement those architectures; for those, Branch
14352 Likely instructions will not be generated by default because the MIPS32
14353 and MIPS64 architectures specifically deprecate their use.
14354
14355 @item -mfp-exceptions
14356 @itemx -mno-fp-exceptions
14357 @opindex mfp-exceptions
14358 Specifies whether FP exceptions are enabled.  This affects how we schedule
14359 FP instructions for some processors.  The default is that FP exceptions are
14360 enabled.
14361
14362 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14363 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14364 FP pipe.
14365
14366 @item -mvr4130-align
14367 @itemx -mno-vr4130-align
14368 @opindex mvr4130-align
14369 The VR4130 pipeline is two-way superscalar, but can only issue two
14370 instructions together if the first one is 8-byte aligned.  When this
14371 option is enabled, GCC will align pairs of instructions that it
14372 thinks should execute in parallel.
14373
14374 This option only has an effect when optimizing for the VR4130.
14375 It normally makes code faster, but at the expense of making it bigger.
14376 It is enabled by default at optimization level @option{-O3}.
14377
14378 @item -msynci
14379 @itemx -mno-synci
14380 @opindex msynci
14381 Enable (disable) generation of @code{synci} instructions on
14382 architectures that support it.  The @code{synci} instructions (if
14383 enabled) will be generated when @code{__builtin___clear_cache()} is
14384 compiled.
14385
14386 This option defaults to @code{-mno-synci}, but the default can be
14387 overridden by configuring with @code{--with-synci}.
14388
14389 When compiling code for single processor systems, it is generally safe
14390 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14391 will not invalidate the instruction caches on all cores and may lead
14392 to undefined behavior.
14393
14394 @item -mrelax-pic-calls
14395 @itemx -mno-relax-pic-calls
14396 @opindex mrelax-pic-calls
14397 Try to turn PIC calls that are normally dispatched via register
14398 @code{$25} into direct calls.  This is only possible if the linker can
14399 resolve the destination at link-time and if the destination is within
14400 range for a direct call.
14401
14402 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14403 an assembler and a linker that supports the @code{.reloc} assembly
14404 directive and @code{-mexplicit-relocs} is in effect.  With
14405 @code{-mno-explicit-relocs}, this optimization can be performed by the
14406 assembler and the linker alone without help from the compiler.
14407
14408 @item -mmcount-ra-address
14409 @itemx -mno-mcount-ra-address
14410 @opindex mmcount-ra-address
14411 @opindex mno-mcount-ra-address
14412 Emit (do not emit) code that allows @code{_mcount} to modify the
14413 calling function's return address.  When enabled, this option extends
14414 the usual @code{_mcount} interface with a new @var{ra-address}
14415 parameter, which has type @code{intptr_t *} and is passed in register
14416 @code{$12}.  @code{_mcount} can then modify the return address by
14417 doing both of the following:
14418 @itemize
14419 @item
14420 Returning the new address in register @code{$31}.
14421 @item
14422 Storing the new address in @code{*@var{ra-address}},
14423 if @var{ra-address} is nonnull.
14424 @end itemize
14425
14426 The default is @option{-mno-mcount-ra-address}.
14427
14428 @end table
14429
14430 @node MMIX Options
14431 @subsection MMIX Options
14432 @cindex MMIX Options
14433
14434 These options are defined for the MMIX:
14435
14436 @table @gcctabopt
14437 @item -mlibfuncs
14438 @itemx -mno-libfuncs
14439 @opindex mlibfuncs
14440 @opindex mno-libfuncs
14441 Specify that intrinsic library functions are being compiled, passing all
14442 values in registers, no matter the size.
14443
14444 @item -mepsilon
14445 @itemx -mno-epsilon
14446 @opindex mepsilon
14447 @opindex mno-epsilon
14448 Generate floating-point comparison instructions that compare with respect
14449 to the @code{rE} epsilon register.
14450
14451 @item -mabi=mmixware
14452 @itemx -mabi=gnu
14453 @opindex mabi=mmixware
14454 @opindex mabi=gnu
14455 Generate code that passes function parameters and return values that (in
14456 the called function) are seen as registers @code{$0} and up, as opposed to
14457 the GNU ABI which uses global registers @code{$231} and up.
14458
14459 @item -mzero-extend
14460 @itemx -mno-zero-extend
14461 @opindex mzero-extend
14462 @opindex mno-zero-extend
14463 When reading data from memory in sizes shorter than 64 bits, use (do not
14464 use) zero-extending load instructions by default, rather than
14465 sign-extending ones.
14466
14467 @item -mknuthdiv
14468 @itemx -mno-knuthdiv
14469 @opindex mknuthdiv
14470 @opindex mno-knuthdiv
14471 Make the result of a division yielding a remainder have the same sign as
14472 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
14473 remainder follows the sign of the dividend.  Both methods are
14474 arithmetically valid, the latter being almost exclusively used.
14475
14476 @item -mtoplevel-symbols
14477 @itemx -mno-toplevel-symbols
14478 @opindex mtoplevel-symbols
14479 @opindex mno-toplevel-symbols
14480 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14481 code can be used with the @code{PREFIX} assembly directive.
14482
14483 @item -melf
14484 @opindex melf
14485 Generate an executable in the ELF format, rather than the default
14486 @samp{mmo} format used by the @command{mmix} simulator.
14487
14488 @item -mbranch-predict
14489 @itemx -mno-branch-predict
14490 @opindex mbranch-predict
14491 @opindex mno-branch-predict
14492 Use (do not use) the probable-branch instructions, when static branch
14493 prediction indicates a probable branch.
14494
14495 @item -mbase-addresses
14496 @itemx -mno-base-addresses
14497 @opindex mbase-addresses
14498 @opindex mno-base-addresses
14499 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14500 base address automatically generates a request (handled by the assembler
14501 and the linker) for a constant to be set up in a global register.  The
14502 register is used for one or more base address requests within the range 0
14503 to 255 from the value held in the register.  The generally leads to short
14504 and fast code, but the number of different data items that can be
14505 addressed is limited.  This means that a program that uses lots of static
14506 data may require @option{-mno-base-addresses}.
14507
14508 @item -msingle-exit
14509 @itemx -mno-single-exit
14510 @opindex msingle-exit
14511 @opindex mno-single-exit
14512 Force (do not force) generated code to have a single exit point in each
14513 function.
14514 @end table
14515
14516 @node MN10300 Options
14517 @subsection MN10300 Options
14518 @cindex MN10300 options
14519
14520 These @option{-m} options are defined for Matsushita MN10300 architectures:
14521
14522 @table @gcctabopt
14523 @item -mmult-bug
14524 @opindex mmult-bug
14525 Generate code to avoid bugs in the multiply instructions for the MN10300
14526 processors.  This is the default.
14527
14528 @item -mno-mult-bug
14529 @opindex mno-mult-bug
14530 Do not generate code to avoid bugs in the multiply instructions for the
14531 MN10300 processors.
14532
14533 @item -mam33
14534 @opindex mam33
14535 Generate code which uses features specific to the AM33 processor.
14536
14537 @item -mno-am33
14538 @opindex mno-am33
14539 Do not generate code which uses features specific to the AM33 processor.  This
14540 is the default.
14541
14542 @item -mreturn-pointer-on-d0
14543 @opindex mreturn-pointer-on-d0
14544 When generating a function which returns a pointer, return the pointer
14545 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14546 only in a0, and attempts to call such functions without a prototype
14547 would result in errors.  Note that this option is on by default; use
14548 @option{-mno-return-pointer-on-d0} to disable it.
14549
14550 @item -mno-crt0
14551 @opindex mno-crt0
14552 Do not link in the C run-time initialization object file.
14553
14554 @item -mrelax
14555 @opindex mrelax
14556 Indicate to the linker that it should perform a relaxation optimization pass
14557 to shorten branches, calls and absolute memory addresses.  This option only
14558 has an effect when used on the command line for the final link step.
14559
14560 This option makes symbolic debugging impossible.
14561 @end table
14562
14563 @node PDP-11 Options
14564 @subsection PDP-11 Options
14565 @cindex PDP-11 Options
14566
14567 These options are defined for the PDP-11:
14568
14569 @table @gcctabopt
14570 @item -mfpu
14571 @opindex mfpu
14572 Use hardware FPP floating point.  This is the default.  (FIS floating
14573 point on the PDP-11/40 is not supported.)
14574
14575 @item -msoft-float
14576 @opindex msoft-float
14577 Do not use hardware floating point.
14578
14579 @item -mac0
14580 @opindex mac0
14581 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14582
14583 @item -mno-ac0
14584 @opindex mno-ac0
14585 Return floating-point results in memory.  This is the default.
14586
14587 @item -m40
14588 @opindex m40
14589 Generate code for a PDP-11/40.
14590
14591 @item -m45
14592 @opindex m45
14593 Generate code for a PDP-11/45.  This is the default.
14594
14595 @item -m10
14596 @opindex m10
14597 Generate code for a PDP-11/10.
14598
14599 @item -mbcopy-builtin
14600 @opindex mbcopy-builtin
14601 Use inline @code{movmemhi} patterns for copying memory.  This is the
14602 default.
14603
14604 @item -mbcopy
14605 @opindex mbcopy
14606 Do not use inline @code{movmemhi} patterns for copying memory.
14607
14608 @item -mint16
14609 @itemx -mno-int32
14610 @opindex mint16
14611 @opindex mno-int32
14612 Use 16-bit @code{int}.  This is the default.
14613
14614 @item -mint32
14615 @itemx -mno-int16
14616 @opindex mint32
14617 @opindex mno-int16
14618 Use 32-bit @code{int}.
14619
14620 @item -mfloat64
14621 @itemx -mno-float32
14622 @opindex mfloat64
14623 @opindex mno-float32
14624 Use 64-bit @code{float}.  This is the default.
14625
14626 @item -mfloat32
14627 @itemx -mno-float64
14628 @opindex mfloat32
14629 @opindex mno-float64
14630 Use 32-bit @code{float}.
14631
14632 @item -mabshi
14633 @opindex mabshi
14634 Use @code{abshi2} pattern.  This is the default.
14635
14636 @item -mno-abshi
14637 @opindex mno-abshi
14638 Do not use @code{abshi2} pattern.
14639
14640 @item -mbranch-expensive
14641 @opindex mbranch-expensive
14642 Pretend that branches are expensive.  This is for experimenting with
14643 code generation only.
14644
14645 @item -mbranch-cheap
14646 @opindex mbranch-cheap
14647 Do not pretend that branches are expensive.  This is the default.
14648
14649 @item -msplit
14650 @opindex msplit
14651 Generate code for a system with split I&D@.
14652
14653 @item -mno-split
14654 @opindex mno-split
14655 Generate code for a system without split I&D@.  This is the default.
14656
14657 @item -munix-asm
14658 @opindex munix-asm
14659 Use Unix assembler syntax.  This is the default when configured for
14660 @samp{pdp11-*-bsd}.
14661
14662 @item -mdec-asm
14663 @opindex mdec-asm
14664 Use DEC assembler syntax.  This is the default when configured for any
14665 PDP-11 target other than @samp{pdp11-*-bsd}.
14666 @end table
14667
14668 @node picoChip Options
14669 @subsection picoChip Options
14670 @cindex picoChip options
14671
14672 These @samp{-m} options are defined for picoChip implementations:
14673
14674 @table @gcctabopt
14675
14676 @item -mae=@var{ae_type}
14677 @opindex mcpu
14678 Set the instruction set, register set, and instruction scheduling
14679 parameters for array element type @var{ae_type}.  Supported values
14680 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14681
14682 @option{-mae=ANY} selects a completely generic AE type.  Code
14683 generated with this option will run on any of the other AE types.  The
14684 code will not be as efficient as it would be if compiled for a specific
14685 AE type, and some types of operation (e.g., multiplication) will not
14686 work properly on all types of AE.
14687
14688 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14689 for compiled code, and is the default.
14690
14691 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14692 option may suffer from poor performance of byte (char) manipulation,
14693 since the DSP AE does not provide hardware support for byte load/stores.
14694
14695 @item -msymbol-as-address
14696 Enable the compiler to directly use a symbol name as an address in a
14697 load/store instruction, without first loading it into a
14698 register.  Typically, the use of this option will generate larger
14699 programs, which run faster than when the option isn't used.  However, the
14700 results vary from program to program, so it is left as a user option,
14701 rather than being permanently enabled.
14702
14703 @item -mno-inefficient-warnings
14704 Disables warnings about the generation of inefficient code.  These
14705 warnings can be generated, for example, when compiling code which
14706 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14707 no hardware support for byte-level memory operations, so all byte
14708 load/stores must be synthesized from word load/store operations.  This is
14709 inefficient and a warning will be generated indicating to the programmer
14710 that they should rewrite the code to avoid byte operations, or to target
14711 an AE type which has the necessary hardware support.  This option enables
14712 the warning to be turned off.
14713
14714 @end table
14715
14716 @node PowerPC Options
14717 @subsection PowerPC Options
14718 @cindex PowerPC options
14719
14720 These are listed under @xref{RS/6000 and PowerPC Options}.
14721
14722 @node RS/6000 and PowerPC Options
14723 @subsection IBM RS/6000 and PowerPC Options
14724 @cindex RS/6000 and PowerPC Options
14725 @cindex IBM RS/6000 and PowerPC Options
14726
14727 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14728 @table @gcctabopt
14729 @item -mpower
14730 @itemx -mno-power
14731 @itemx -mpower2
14732 @itemx -mno-power2
14733 @itemx -mpowerpc
14734 @itemx -mno-powerpc
14735 @itemx -mpowerpc-gpopt
14736 @itemx -mno-powerpc-gpopt
14737 @itemx -mpowerpc-gfxopt
14738 @itemx -mno-powerpc-gfxopt
14739 @itemx -mpowerpc64
14740 @itemx -mno-powerpc64
14741 @itemx -mmfcrf
14742 @itemx -mno-mfcrf
14743 @itemx -mpopcntb
14744 @itemx -mno-popcntb
14745 @itemx -mpopcntd
14746 @itemx -mno-popcntd
14747 @itemx -mfprnd
14748 @itemx -mno-fprnd
14749 @itemx -mcmpb
14750 @itemx -mno-cmpb
14751 @itemx -mmfpgpr
14752 @itemx -mno-mfpgpr
14753 @itemx -mhard-dfp
14754 @itemx -mno-hard-dfp
14755 @opindex mpower
14756 @opindex mno-power
14757 @opindex mpower2
14758 @opindex mno-power2
14759 @opindex mpowerpc
14760 @opindex mno-powerpc
14761 @opindex mpowerpc-gpopt
14762 @opindex mno-powerpc-gpopt
14763 @opindex mpowerpc-gfxopt
14764 @opindex mno-powerpc-gfxopt
14765 @opindex mpowerpc64
14766 @opindex mno-powerpc64
14767 @opindex mmfcrf
14768 @opindex mno-mfcrf
14769 @opindex mpopcntb
14770 @opindex mno-popcntb
14771 @opindex mpopcntd
14772 @opindex mno-popcntd
14773 @opindex mfprnd
14774 @opindex mno-fprnd
14775 @opindex mcmpb
14776 @opindex mno-cmpb
14777 @opindex mmfpgpr
14778 @opindex mno-mfpgpr
14779 @opindex mhard-dfp
14780 @opindex mno-hard-dfp
14781 GCC supports two related instruction set architectures for the
14782 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14783 instructions supported by the @samp{rios} chip set used in the original
14784 RS/6000 systems and the @dfn{PowerPC} instruction set is the
14785 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
14786 the IBM 4xx, 6xx, and follow-on microprocessors.
14787
14788 Neither architecture is a subset of the other.  However there is a
14789 large common subset of instructions supported by both.  An MQ
14790 register is included in processors supporting the POWER architecture.
14791
14792 You use these options to specify which instructions are available on the
14793 processor you are using.  The default value of these options is
14794 determined when configuring GCC@.  Specifying the
14795 @option{-mcpu=@var{cpu_type}} overrides the specification of these
14796 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
14797 rather than the options listed above.
14798
14799 The @option{-mpower} option allows GCC to generate instructions that
14800 are found only in the POWER architecture and to use the MQ register.
14801 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
14802 to generate instructions that are present in the POWER2 architecture but
14803 not the original POWER architecture.
14804
14805 The @option{-mpowerpc} option allows GCC to generate instructions that
14806 are found only in the 32-bit subset of the PowerPC architecture.
14807 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
14808 GCC to use the optional PowerPC architecture instructions in the
14809 General Purpose group, including floating-point square root.  Specifying
14810 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
14811 use the optional PowerPC architecture instructions in the Graphics
14812 group, including floating-point select.
14813
14814 The @option{-mmfcrf} option allows GCC to generate the move from
14815 condition register field instruction implemented on the POWER4
14816 processor and other processors that support the PowerPC V2.01
14817 architecture.
14818 The @option{-mpopcntb} option allows GCC to generate the popcount and
14819 double precision FP reciprocal estimate instruction implemented on the
14820 POWER5 processor and other processors that support the PowerPC V2.02
14821 architecture.
14822 The @option{-mpopcntd} option allows GCC to generate the popcount
14823 instruction implemented on the POWER7 processor and other processors
14824 that support the PowerPC V2.06 architecture.
14825 The @option{-mfprnd} option allows GCC to generate the FP round to
14826 integer instructions implemented on the POWER5+ processor and other
14827 processors that support the PowerPC V2.03 architecture.
14828 The @option{-mcmpb} option allows GCC to generate the compare bytes
14829 instruction implemented on the POWER6 processor and other processors
14830 that support the PowerPC V2.05 architecture.
14831 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
14832 general purpose register instructions implemented on the POWER6X
14833 processor and other processors that support the extended PowerPC V2.05
14834 architecture.
14835 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
14836 point instructions implemented on some POWER processors.
14837
14838 The @option{-mpowerpc64} option allows GCC to generate the additional
14839 64-bit instructions that are found in the full PowerPC64 architecture
14840 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
14841 @option{-mno-powerpc64}.
14842
14843 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
14844 will use only the instructions in the common subset of both
14845 architectures plus some special AIX common-mode calls, and will not use
14846 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
14847 permits GCC to use any instruction from either architecture and to
14848 allow use of the MQ register; specify this for the Motorola MPC601.
14849
14850 @item -mnew-mnemonics
14851 @itemx -mold-mnemonics
14852 @opindex mnew-mnemonics
14853 @opindex mold-mnemonics
14854 Select which mnemonics to use in the generated assembler code.  With
14855 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
14856 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
14857 assembler mnemonics defined for the POWER architecture.  Instructions
14858 defined in only one architecture have only one mnemonic; GCC uses that
14859 mnemonic irrespective of which of these options is specified.
14860
14861 GCC defaults to the mnemonics appropriate for the architecture in
14862 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
14863 value of these option.  Unless you are building a cross-compiler, you
14864 should normally not specify either @option{-mnew-mnemonics} or
14865 @option{-mold-mnemonics}, but should instead accept the default.
14866
14867 @item -mcpu=@var{cpu_type}
14868 @opindex mcpu
14869 Set architecture type, register usage, choice of mnemonics, and
14870 instruction scheduling parameters for machine type @var{cpu_type}.
14871 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
14872 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
14873 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
14874 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
14875 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
14876 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
14877 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
14878 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
14879 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
14880 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
14881 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
14882
14883 @option{-mcpu=common} selects a completely generic processor.  Code
14884 generated under this option will run on any POWER or PowerPC processor.
14885 GCC will use only the instructions in the common subset of both
14886 architectures, and will not use the MQ register.  GCC assumes a generic
14887 processor model for scheduling purposes.
14888
14889 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
14890 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
14891 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
14892 types, with an appropriate, generic processor model assumed for
14893 scheduling purposes.
14894
14895 The other options specify a specific processor.  Code generated under
14896 those options will run best on that processor, and may not run at all on
14897 others.
14898
14899 The @option{-mcpu} options automatically enable or disable the
14900 following options:
14901
14902 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
14903 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
14904 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
14905 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
14906
14907 The particular options set for any particular CPU will vary between
14908 compiler versions, depending on what setting seems to produce optimal
14909 code for that CPU; it doesn't necessarily reflect the actual hardware's
14910 capabilities.  If you wish to set an individual option to a particular
14911 value, you may specify it after the @option{-mcpu} option, like
14912 @samp{-mcpu=970 -mno-altivec}.
14913
14914 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
14915 not enabled or disabled by the @option{-mcpu} option at present because
14916 AIX does not have full support for these options.  You may still
14917 enable or disable them individually if you're sure it'll work in your
14918 environment.
14919
14920 @item -mtune=@var{cpu_type}
14921 @opindex mtune
14922 Set the instruction scheduling parameters for machine type
14923 @var{cpu_type}, but do not set the architecture type, register usage, or
14924 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
14925 values for @var{cpu_type} are used for @option{-mtune} as for
14926 @option{-mcpu}.  If both are specified, the code generated will use the
14927 architecture, registers, and mnemonics set by @option{-mcpu}, but the
14928 scheduling parameters set by @option{-mtune}.
14929
14930 @item -mswdiv
14931 @itemx -mno-swdiv
14932 @opindex mswdiv
14933 @opindex mno-swdiv
14934 Generate code to compute division as reciprocal estimate and iterative
14935 refinement, creating opportunities for increased throughput.  This
14936 feature requires: optional PowerPC Graphics instruction set for single
14937 precision and FRE instruction for double precision, assuming divides
14938 cannot generate user-visible traps, and the domain values not include
14939 Infinities, denormals or zero denominator.
14940
14941 @item -maltivec
14942 @itemx -mno-altivec
14943 @opindex maltivec
14944 @opindex mno-altivec
14945 Generate code that uses (does not use) AltiVec instructions, and also
14946 enable the use of built-in functions that allow more direct access to
14947 the AltiVec instruction set.  You may also need to set
14948 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
14949 enhancements.
14950
14951 @item -mvrsave
14952 @itemx -mno-vrsave
14953 @opindex mvrsave
14954 @opindex mno-vrsave
14955 Generate VRSAVE instructions when generating AltiVec code.
14956
14957 @item -mgen-cell-microcode
14958 @opindex mgen-cell-microcode
14959 Generate Cell microcode instructions
14960
14961 @item -mwarn-cell-microcode
14962 @opindex mwarn-cell-microcode
14963 Warning when a Cell microcode instruction is going to emitted.  An example
14964 of a Cell microcode instruction is a variable shift.
14965
14966 @item -msecure-plt
14967 @opindex msecure-plt
14968 Generate code that allows ld and ld.so to build executables and shared
14969 libraries with non-exec .plt and .got sections.  This is a PowerPC
14970 32-bit SYSV ABI option.
14971
14972 @item -mbss-plt
14973 @opindex mbss-plt
14974 Generate code that uses a BSS .plt section that ld.so fills in, and
14975 requires .plt and .got sections that are both writable and executable.
14976 This is a PowerPC 32-bit SYSV ABI option.
14977
14978 @item -misel
14979 @itemx -mno-isel
14980 @opindex misel
14981 @opindex mno-isel
14982 This switch enables or disables the generation of ISEL instructions.
14983
14984 @item -misel=@var{yes/no}
14985 This switch has been deprecated.  Use @option{-misel} and
14986 @option{-mno-isel} instead.
14987
14988 @item -mspe
14989 @itemx -mno-spe
14990 @opindex mspe
14991 @opindex mno-spe
14992 This switch enables or disables the generation of SPE simd
14993 instructions.
14994
14995 @item -mpaired
14996 @itemx -mno-paired
14997 @opindex mpaired
14998 @opindex mno-paired
14999 This switch enables or disables the generation of PAIRED simd
15000 instructions.
15001
15002 @item -mspe=@var{yes/no}
15003 This option has been deprecated.  Use @option{-mspe} and
15004 @option{-mno-spe} instead.
15005
15006 @item -mvsx
15007 @itemx -mno-vsx
15008 @opindex mvsx
15009 @opindex mno-vsx
15010 Generate code that uses (does not use) vector/scalar (VSX)
15011 instructions, and also enable the use of built-in functions that allow
15012 more direct access to the VSX instruction set.
15013
15014 @item -mfloat-gprs=@var{yes/single/double/no}
15015 @itemx -mfloat-gprs
15016 @opindex mfloat-gprs
15017 This switch enables or disables the generation of floating point
15018 operations on the general purpose registers for architectures that
15019 support it.
15020
15021 The argument @var{yes} or @var{single} enables the use of
15022 single-precision floating point operations.
15023
15024 The argument @var{double} enables the use of single and
15025 double-precision floating point operations.
15026
15027 The argument @var{no} disables floating point operations on the
15028 general purpose registers.
15029
15030 This option is currently only available on the MPC854x.
15031
15032 @item -m32
15033 @itemx -m64
15034 @opindex m32
15035 @opindex m64
15036 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
15037 targets (including GNU/Linux).  The 32-bit environment sets int, long
15038 and pointer to 32 bits and generates code that runs on any PowerPC
15039 variant.  The 64-bit environment sets int to 32 bits and long and
15040 pointer to 64 bits, and generates code for PowerPC64, as for
15041 @option{-mpowerpc64}.
15042
15043 @item -mfull-toc
15044 @itemx -mno-fp-in-toc
15045 @itemx -mno-sum-in-toc
15046 @itemx -mminimal-toc
15047 @opindex mfull-toc
15048 @opindex mno-fp-in-toc
15049 @opindex mno-sum-in-toc
15050 @opindex mminimal-toc
15051 Modify generation of the TOC (Table Of Contents), which is created for
15052 every executable file.  The @option{-mfull-toc} option is selected by
15053 default.  In that case, GCC will allocate at least one TOC entry for
15054 each unique non-automatic variable reference in your program.  GCC
15055 will also place floating-point constants in the TOC@.  However, only
15056 16,384 entries are available in the TOC@.
15057
15058 If you receive a linker error message that saying you have overflowed
15059 the available TOC space, you can reduce the amount of TOC space used
15060 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
15061 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
15062 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
15063 generate code to calculate the sum of an address and a constant at
15064 run-time instead of putting that sum into the TOC@.  You may specify one
15065 or both of these options.  Each causes GCC to produce very slightly
15066 slower and larger code at the expense of conserving TOC space.
15067
15068 If you still run out of space in the TOC even when you specify both of
15069 these options, specify @option{-mminimal-toc} instead.  This option causes
15070 GCC to make only one TOC entry for every file.  When you specify this
15071 option, GCC will produce code that is slower and larger but which
15072 uses extremely little TOC space.  You may wish to use this option
15073 only on files that contain less frequently executed code.
15074
15075 @item -maix64
15076 @itemx -maix32
15077 @opindex maix64
15078 @opindex maix32
15079 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
15080 @code{long} type, and the infrastructure needed to support them.
15081 Specifying @option{-maix64} implies @option{-mpowerpc64} and
15082 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
15083 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
15084
15085 @item -mxl-compat
15086 @itemx -mno-xl-compat
15087 @opindex mxl-compat
15088 @opindex mno-xl-compat
15089 Produce code that conforms more closely to IBM XL compiler semantics
15090 when using AIX-compatible ABI@.  Pass floating-point arguments to
15091 prototyped functions beyond the register save area (RSA) on the stack
15092 in addition to argument FPRs.  Do not assume that most significant
15093 double in 128-bit long double value is properly rounded when comparing
15094 values and converting to double.  Use XL symbol names for long double
15095 support routines.
15096
15097 The AIX calling convention was extended but not initially documented to
15098 handle an obscure K&R C case of calling a function that takes the
15099 address of its arguments with fewer arguments than declared.  IBM XL
15100 compilers access floating point arguments which do not fit in the
15101 RSA from the stack when a subroutine is compiled without
15102 optimization.  Because always storing floating-point arguments on the
15103 stack is inefficient and rarely needed, this option is not enabled by
15104 default and only is necessary when calling subroutines compiled by IBM
15105 XL compilers without optimization.
15106
15107 @item -mpe
15108 @opindex mpe
15109 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
15110 application written to use message passing with special startup code to
15111 enable the application to run.  The system must have PE installed in the
15112 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
15113 must be overridden with the @option{-specs=} option to specify the
15114 appropriate directory location.  The Parallel Environment does not
15115 support threads, so the @option{-mpe} option and the @option{-pthread}
15116 option are incompatible.
15117
15118 @item -malign-natural
15119 @itemx -malign-power
15120 @opindex malign-natural
15121 @opindex malign-power
15122 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15123 @option{-malign-natural} overrides the ABI-defined alignment of larger
15124 types, such as floating-point doubles, on their natural size-based boundary.
15125 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15126 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
15127
15128 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15129 is not supported.
15130
15131 @item -msoft-float
15132 @itemx -mhard-float
15133 @opindex msoft-float
15134 @opindex mhard-float
15135 Generate code that does not use (uses) the floating-point register set.
15136 Software floating point emulation is provided if you use the
15137 @option{-msoft-float} option, and pass the option to GCC when linking.
15138
15139 @item -msingle-float
15140 @itemx -mdouble-float
15141 @opindex msingle-float
15142 @opindex mdouble-float
15143 Generate code for single or double-precision floating point operations.
15144 @option{-mdouble-float} implies @option{-msingle-float}.
15145
15146 @item -msimple-fpu
15147 @opindex msimple-fpu
15148 Do not generate sqrt and div instructions for hardware floating point unit.
15149
15150 @item -mfpu
15151 @opindex mfpu
15152 Specify type of floating point unit.  Valid values are @var{sp_lite}
15153 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15154 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15155 and @var{dp_full} (equivalent to -mdouble-float).
15156
15157 @item -mxilinx-fpu
15158 @opindex mxilinx-fpu
15159 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15160
15161 @item -mmultiple
15162 @itemx -mno-multiple
15163 @opindex mmultiple
15164 @opindex mno-multiple
15165 Generate code that uses (does not use) the load multiple word
15166 instructions and the store multiple word instructions.  These
15167 instructions are generated by default on POWER systems, and not
15168 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
15169 endian PowerPC systems, since those instructions do not work when the
15170 processor is in little endian mode.  The exceptions are PPC740 and
15171 PPC750 which permit the instructions usage in little endian mode.
15172
15173 @item -mstring
15174 @itemx -mno-string
15175 @opindex mstring
15176 @opindex mno-string
15177 Generate code that uses (does not use) the load string instructions
15178 and the store string word instructions to save multiple registers and
15179 do small block moves.  These instructions are generated by default on
15180 POWER systems, and not generated on PowerPC systems.  Do not use
15181 @option{-mstring} on little endian PowerPC systems, since those
15182 instructions do not work when the processor is in little endian mode.
15183 The exceptions are PPC740 and PPC750 which permit the instructions
15184 usage in little endian mode.
15185
15186 @item -mupdate
15187 @itemx -mno-update
15188 @opindex mupdate
15189 @opindex mno-update
15190 Generate code that uses (does not use) the load or store instructions
15191 that update the base register to the address of the calculated memory
15192 location.  These instructions are generated by default.  If you use
15193 @option{-mno-update}, there is a small window between the time that the
15194 stack pointer is updated and the address of the previous frame is
15195 stored, which means code that walks the stack frame across interrupts or
15196 signals may get corrupted data.
15197
15198 @item -mavoid-indexed-addresses
15199 @itemx -mno-avoid-indexed-addresses
15200 @opindex mavoid-indexed-addresses
15201 @opindex mno-avoid-indexed-addresses
15202 Generate code that tries to avoid (not avoid) the use of indexed load
15203 or store instructions. These instructions can incur a performance
15204 penalty on Power6 processors in certain situations, such as when
15205 stepping through large arrays that cross a 16M boundary.  This option
15206 is enabled by default when targetting Power6 and disabled otherwise.
15207
15208 @item -mfused-madd
15209 @itemx -mno-fused-madd
15210 @opindex mfused-madd
15211 @opindex mno-fused-madd
15212 Generate code that uses (does not use) the floating point multiply and
15213 accumulate instructions.  These instructions are generated by default if
15214 hardware floating is used.
15215
15216 @item -mmulhw
15217 @itemx -mno-mulhw
15218 @opindex mmulhw
15219 @opindex mno-mulhw
15220 Generate code that uses (does not use) the half-word multiply and
15221 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15222 These instructions are generated by default when targetting those
15223 processors.
15224
15225 @item -mdlmzb
15226 @itemx -mno-dlmzb
15227 @opindex mdlmzb
15228 @opindex mno-dlmzb
15229 Generate code that uses (does not use) the string-search @samp{dlmzb}
15230 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15231 generated by default when targetting those processors.
15232
15233 @item -mno-bit-align
15234 @itemx -mbit-align
15235 @opindex mno-bit-align
15236 @opindex mbit-align
15237 On System V.4 and embedded PowerPC systems do not (do) force structures
15238 and unions that contain bit-fields to be aligned to the base type of the
15239 bit-field.
15240
15241 For example, by default a structure containing nothing but 8
15242 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15243 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15244 the structure would be aligned to a 1 byte boundary and be one byte in
15245 size.
15246
15247 @item -mno-strict-align
15248 @itemx -mstrict-align
15249 @opindex mno-strict-align
15250 @opindex mstrict-align
15251 On System V.4 and embedded PowerPC systems do not (do) assume that
15252 unaligned memory references will be handled by the system.
15253
15254 @item -mrelocatable
15255 @itemx -mno-relocatable
15256 @opindex mrelocatable
15257 @opindex mno-relocatable
15258 On embedded PowerPC systems generate code that allows (does not allow)
15259 the program to be relocated to a different address at runtime.  If you
15260 use @option{-mrelocatable} on any module, all objects linked together must
15261 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
15262
15263 @item -mrelocatable-lib
15264 @itemx -mno-relocatable-lib
15265 @opindex mrelocatable-lib
15266 @opindex mno-relocatable-lib
15267 On embedded PowerPC systems generate code that allows (does not allow)
15268 the program to be relocated to a different address at runtime.  Modules
15269 compiled with @option{-mrelocatable-lib} can be linked with either modules
15270 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
15271 with modules compiled with the @option{-mrelocatable} options.
15272
15273 @item -mno-toc
15274 @itemx -mtoc
15275 @opindex mno-toc
15276 @opindex mtoc
15277 On System V.4 and embedded PowerPC systems do not (do) assume that
15278 register 2 contains a pointer to a global area pointing to the addresses
15279 used in the program.
15280
15281 @item -mlittle
15282 @itemx -mlittle-endian
15283 @opindex mlittle
15284 @opindex mlittle-endian
15285 On System V.4 and embedded PowerPC systems compile code for the
15286 processor in little endian mode.  The @option{-mlittle-endian} option is
15287 the same as @option{-mlittle}.
15288
15289 @item -mbig
15290 @itemx -mbig-endian
15291 @opindex mbig
15292 @opindex mbig-endian
15293 On System V.4 and embedded PowerPC systems compile code for the
15294 processor in big endian mode.  The @option{-mbig-endian} option is
15295 the same as @option{-mbig}.
15296
15297 @item -mdynamic-no-pic
15298 @opindex mdynamic-no-pic
15299 On Darwin and Mac OS X systems, compile code so that it is not
15300 relocatable, but that its external references are relocatable.  The
15301 resulting code is suitable for applications, but not shared
15302 libraries.
15303
15304 @item -mprioritize-restricted-insns=@var{priority}
15305 @opindex mprioritize-restricted-insns
15306 This option controls the priority that is assigned to
15307 dispatch-slot restricted instructions during the second scheduling
15308 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15309 @var{no/highest/second-highest} priority to dispatch slot restricted
15310 instructions.
15311
15312 @item -msched-costly-dep=@var{dependence_type}
15313 @opindex msched-costly-dep
15314 This option controls which dependences are considered costly
15315 by the target during instruction scheduling.  The argument
15316 @var{dependence_type} takes one of the following values:
15317 @var{no}: no dependence is costly,
15318 @var{all}: all dependences are costly,
15319 @var{true_store_to_load}: a true dependence from store to load is costly,
15320 @var{store_to_load}: any dependence from store to load is costly,
15321 @var{number}: any dependence which latency >= @var{number} is costly.
15322
15323 @item -minsert-sched-nops=@var{scheme}
15324 @opindex minsert-sched-nops
15325 This option controls which nop insertion scheme will be used during
15326 the second scheduling pass.  The argument @var{scheme} takes one of the
15327 following values:
15328 @var{no}: Don't insert nops.
15329 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15330 according to the scheduler's grouping.
15331 @var{regroup_exact}: Insert nops to force costly dependent insns into
15332 separate groups.  Insert exactly as many nops as needed to force an insn
15333 to a new group, according to the estimated processor grouping.
15334 @var{number}: Insert nops to force costly dependent insns into
15335 separate groups.  Insert @var{number} nops to force an insn to a new group.
15336
15337 @item -mcall-sysv
15338 @opindex mcall-sysv
15339 On System V.4 and embedded PowerPC systems compile code using calling
15340 conventions that adheres to the March 1995 draft of the System V
15341 Application Binary Interface, PowerPC processor supplement.  This is the
15342 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15343
15344 @item -mcall-sysv-eabi
15345 @itemx -mcall-eabi
15346 @opindex mcall-sysv-eabi
15347 @opindex mcall-eabi
15348 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15349
15350 @item -mcall-sysv-noeabi
15351 @opindex mcall-sysv-noeabi
15352 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15353
15354 @item -mcall-aixdesc
15355 @opindex m
15356 On System V.4 and embedded PowerPC systems compile code for the AIX
15357 operating system.
15358
15359 @item -mcall-linux
15360 @opindex mcall-linux
15361 On System V.4 and embedded PowerPC systems compile code for the
15362 Linux-based GNU system.
15363
15364 @item -mcall-gnu
15365 @opindex mcall-gnu
15366 On System V.4 and embedded PowerPC systems compile code for the
15367 Hurd-based GNU system.
15368
15369 @item -mcall-freebsd
15370 @opindex mcall-freebsd
15371 On System V.4 and embedded PowerPC systems compile code for the
15372 FreeBSD operating system.
15373
15374 @item -mcall-netbsd
15375 @opindex mcall-netbsd
15376 On System V.4 and embedded PowerPC systems compile code for the
15377 NetBSD operating system.
15378
15379 @item -mcall-openbsd
15380 @opindex mcall-netbsd
15381 On System V.4 and embedded PowerPC systems compile code for the
15382 OpenBSD operating system.
15383
15384 @item -maix-struct-return
15385 @opindex maix-struct-return
15386 Return all structures in memory (as specified by the AIX ABI)@.
15387
15388 @item -msvr4-struct-return
15389 @opindex msvr4-struct-return
15390 Return structures smaller than 8 bytes in registers (as specified by the
15391 SVR4 ABI)@.
15392
15393 @item -mabi=@var{abi-type}
15394 @opindex mabi
15395 Extend the current ABI with a particular extension, or remove such extension.
15396 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15397 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15398
15399 @item -mabi=spe
15400 @opindex mabi=spe
15401 Extend the current ABI with SPE ABI extensions.  This does not change
15402 the default ABI, instead it adds the SPE ABI extensions to the current
15403 ABI@.
15404
15405 @item -mabi=no-spe
15406 @opindex mabi=no-spe
15407 Disable Booke SPE ABI extensions for the current ABI@.
15408
15409 @item -mabi=ibmlongdouble
15410 @opindex mabi=ibmlongdouble
15411 Change the current ABI to use IBM extended precision long double.
15412 This is a PowerPC 32-bit SYSV ABI option.
15413
15414 @item -mabi=ieeelongdouble
15415 @opindex mabi=ieeelongdouble
15416 Change the current ABI to use IEEE extended precision long double.
15417 This is a PowerPC 32-bit Linux ABI option.
15418
15419 @item -mprototype
15420 @itemx -mno-prototype
15421 @opindex mprototype
15422 @opindex mno-prototype
15423 On System V.4 and embedded PowerPC systems assume that all calls to
15424 variable argument functions are properly prototyped.  Otherwise, the
15425 compiler must insert an instruction before every non prototyped call to
15426 set or clear bit 6 of the condition code register (@var{CR}) to
15427 indicate whether floating point values were passed in the floating point
15428 registers in case the function takes a variable arguments.  With
15429 @option{-mprototype}, only calls to prototyped variable argument functions
15430 will set or clear the bit.
15431
15432 @item -msim
15433 @opindex msim
15434 On embedded PowerPC systems, assume that the startup module is called
15435 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15436 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
15437 configurations.
15438
15439 @item -mmvme
15440 @opindex mmvme
15441 On embedded PowerPC systems, assume that the startup module is called
15442 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15443 @file{libc.a}.
15444
15445 @item -mads
15446 @opindex mads
15447 On embedded PowerPC systems, assume that the startup module is called
15448 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15449 @file{libc.a}.
15450
15451 @item -myellowknife
15452 @opindex myellowknife
15453 On embedded PowerPC systems, assume that the startup module is called
15454 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15455 @file{libc.a}.
15456
15457 @item -mvxworks
15458 @opindex mvxworks
15459 On System V.4 and embedded PowerPC systems, specify that you are
15460 compiling for a VxWorks system.
15461
15462 @item -memb
15463 @opindex memb
15464 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15465 header to indicate that @samp{eabi} extended relocations are used.
15466
15467 @item -meabi
15468 @itemx -mno-eabi
15469 @opindex meabi
15470 @opindex mno-eabi
15471 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15472 Embedded Applications Binary Interface (eabi) which is a set of
15473 modifications to the System V.4 specifications.  Selecting @option{-meabi}
15474 means that the stack is aligned to an 8 byte boundary, a function
15475 @code{__eabi} is called to from @code{main} to set up the eabi
15476 environment, and the @option{-msdata} option can use both @code{r2} and
15477 @code{r13} to point to two separate small data areas.  Selecting
15478 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15479 do not call an initialization function from @code{main}, and the
15480 @option{-msdata} option will only use @code{r13} to point to a single
15481 small data area.  The @option{-meabi} option is on by default if you
15482 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15483
15484 @item -msdata=eabi
15485 @opindex msdata=eabi
15486 On System V.4 and embedded PowerPC systems, put small initialized
15487 @code{const} global and static data in the @samp{.sdata2} section, which
15488 is pointed to by register @code{r2}.  Put small initialized
15489 non-@code{const} global and static data in the @samp{.sdata} section,
15490 which is pointed to by register @code{r13}.  Put small uninitialized
15491 global and static data in the @samp{.sbss} section, which is adjacent to
15492 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15493 incompatible with the @option{-mrelocatable} option.  The
15494 @option{-msdata=eabi} option also sets the @option{-memb} option.
15495
15496 @item -msdata=sysv
15497 @opindex msdata=sysv
15498 On System V.4 and embedded PowerPC systems, put small global and static
15499 data in the @samp{.sdata} section, which is pointed to by register
15500 @code{r13}.  Put small uninitialized global and static data in the
15501 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15502 The @option{-msdata=sysv} option is incompatible with the
15503 @option{-mrelocatable} option.
15504
15505 @item -msdata=default
15506 @itemx -msdata
15507 @opindex msdata=default
15508 @opindex msdata
15509 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15510 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15511 same as @option{-msdata=sysv}.
15512
15513 @item -msdata=data
15514 @opindex msdata=data
15515 On System V.4 and embedded PowerPC systems, put small global
15516 data in the @samp{.sdata} section.  Put small uninitialized global
15517 data in the @samp{.sbss} section.  Do not use register @code{r13}
15518 to address small data however.  This is the default behavior unless
15519 other @option{-msdata} options are used.
15520
15521 @item -msdata=none
15522 @itemx -mno-sdata
15523 @opindex msdata=none
15524 @opindex mno-sdata
15525 On embedded PowerPC systems, put all initialized global and static data
15526 in the @samp{.data} section, and all uninitialized data in the
15527 @samp{.bss} section.
15528
15529 @item -G @var{num}
15530 @opindex G
15531 @cindex smaller data references (PowerPC)
15532 @cindex .sdata/.sdata2 references (PowerPC)
15533 On embedded PowerPC systems, put global and static items less than or
15534 equal to @var{num} bytes into the small data or bss sections instead of
15535 the normal data or bss section.  By default, @var{num} is 8.  The
15536 @option{-G @var{num}} switch is also passed to the linker.
15537 All modules should be compiled with the same @option{-G @var{num}} value.
15538
15539 @item -mregnames
15540 @itemx -mno-regnames
15541 @opindex mregnames
15542 @opindex mno-regnames
15543 On System V.4 and embedded PowerPC systems do (do not) emit register
15544 names in the assembly language output using symbolic forms.
15545
15546 @item -mlongcall
15547 @itemx -mno-longcall
15548 @opindex mlongcall
15549 @opindex mno-longcall
15550 By default assume that all calls are far away so that a longer more
15551 expensive calling sequence is required.  This is required for calls
15552 further than 32 megabytes (33,554,432 bytes) from the current location.
15553 A short call will be generated if the compiler knows
15554 the call cannot be that far away.  This setting can be overridden by
15555 the @code{shortcall} function attribute, or by @code{#pragma
15556 longcall(0)}.
15557
15558 Some linkers are capable of detecting out-of-range calls and generating
15559 glue code on the fly.  On these systems, long calls are unnecessary and
15560 generate slower code.  As of this writing, the AIX linker can do this,
15561 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15562 to the GNU linker for 32-bit PowerPC systems as well.
15563
15564 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15565 callee, L42'', plus a ``branch island'' (glue code).  The two target
15566 addresses represent the callee and the ``branch island''.  The
15567 Darwin/PPC linker will prefer the first address and generate a ``bl
15568 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15569 otherwise, the linker will generate ``bl L42'' to call the ``branch
15570 island''.  The ``branch island'' is appended to the body of the
15571 calling function; it computes the full 32-bit address of the callee
15572 and jumps to it.
15573
15574 On Mach-O (Darwin) systems, this option directs the compiler emit to
15575 the glue for every direct call, and the Darwin linker decides whether
15576 to use or discard it.
15577
15578 In the future, we may cause GCC to ignore all longcall specifications
15579 when the linker is known to generate glue.
15580
15581 @item -mtls-markers
15582 @itemx -mno-tls-markers
15583 @opindex mtls-markers
15584 @opindex mno-tls-markers
15585 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15586 specifying the function argument.  The relocation allows ld to
15587 reliably associate function call with argument setup instructions for
15588 TLS optimization, which in turn allows gcc to better schedule the
15589 sequence.
15590
15591 @item -pthread
15592 @opindex pthread
15593 Adds support for multithreading with the @dfn{pthreads} library.
15594 This option sets flags for both the preprocessor and linker.
15595
15596 @end table
15597
15598 @node RX Options
15599 @subsection RX Options
15600 @cindex RX Options
15601
15602 These command line options are defined for RX targets:
15603
15604 @table @gcctabopt
15605 @item -m64bit-doubles
15606 @itemx -m32bit-doubles
15607 @opindex m64bit-doubles
15608 @opindex m32bit-doubles
15609 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
15610 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
15611 @option{-m32bit-doubles}.  @emph{Note} RX floating point hardware only
15612 works on 32-bit values, which is why the default is
15613 @option{-m32bit-doubles}.
15614
15615 @item -fpu
15616 @itemx -nofpu
15617 @opindex fpu
15618 @opindex nofpu
15619 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
15620 floating point hardware.  The default is enabled for the @var{RX600}
15621 series and disabled for the @var{RX200} series.
15622
15623 Floating point instructions will only be generated for 32-bit floating
15624 point values however, so if the @option{-m64bit-doubles} option is in
15625 use then the FPU hardware will not be used for doubles.
15626
15627 @emph{Note} If the @option{-fpu} option is enabled then
15628 @option{-funsafe-math-optimizations} is also enabled automatically.
15629 This is because the RX FPU instructions are themselves unsafe.
15630
15631 @item -mcpu=@var{name}
15632 @itemx -patch=@var{name}
15633 @opindex -mcpu
15634 @opindex -patch
15635 Selects the type of RX CPU to be targeted.  Currently three types are
15636 supported, the generic @var{RX600} and @var{RX200} series hardware and
15637 the specific @var{RX610} cpu.  The default is @var{RX600}.
15638
15639 The only difference between @var{RX600} and @var{RX610} is that the
15640 @var{RX610} does not support the @code{MVTIPL} instruction.
15641
15642 The @var{RX200} series does not have a hardware floating point unit
15643 and so @option{-nofpu} is enabled by default when this type is
15644 selected.
15645
15646 @item -mbig-endian-data
15647 @itemx -mlittle-endian-data
15648 @opindex mbig-endian-data
15649 @opindex mlittle-endian-data
15650 Store data (but not code) in the big-endian format.  The default is
15651 @option{-mlittle-endian-data}, ie to store data in the little endian
15652 format.
15653
15654 @item -msmall-data-limit=@var{N}
15655 @opindex msmall-data-limit
15656 Specifies the maximum size in bytes of global and static variables
15657 which can be placed into the small data area.  Using the small data
15658 area can lead to smaller and faster code, but the size of area is
15659 limited and it is up to the programmer to ensure that the area does
15660 not overflow.  Also when the small data area is used one of the RX's
15661 registers (@code{r13}) is reserved for use pointing to this area, so
15662 it is no longer available for use by the compiler.  This could result
15663 in slower and/or larger code if variables which once could have been
15664 held in @code{r13} are now pushed onto the stack.
15665
15666 Note, common variables (variables which have not been initialised) and
15667 constants are not placed into the small data area as they are assigned
15668 to other sections in the output executable.
15669
15670 The default value is zero, which disables this feature.  Note, this
15671 feature is not enabled by default with higher optimization levels
15672 (@option{-O2} etc) because of the potentially detrimental effects of
15673 reserving register @code{r13}.  It is up to the programmer to
15674 experiment and discover whether this feature is of benefit to their
15675 program.
15676
15677 @item -msim
15678 @itemx -mno-sim
15679 @opindex msim
15680 @opindex mno-sim
15681 Use the simulator runtime.  The default is to use the libgloss board
15682 specific runtime.
15683
15684 @item -mas100-syntax
15685 @itemx -mno-as100-syntax
15686 @opindex mas100-syntax
15687 @opindex mno-as100-syntax
15688 When generating assembler output use a syntax that is compatible with
15689 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
15690 assembler but it has some restrictions so generating it is not the
15691 default option.
15692
15693 @item -mmax-constant-size=@var{N}
15694 @opindex mmax-constant-size
15695 Specifies the maximum size, in bytes, of a constant that can be used as
15696 an operand in a RX instruction.  Although the RX instruction set does
15697 allow constants of up to 4 bytes in length to be used in instructions,
15698 a longer value equates to a longer instruction.  Thus in some
15699 circumstances it can be beneficial to restrict the size of constants
15700 that are used in instructions.  Constants that are too big are instead
15701 placed into a constant pool and referenced via register indirection.
15702
15703 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
15704 or 4 means that constants of any size are allowed.
15705
15706 @item -mrelax
15707 @opindex mrelax
15708 Enable linker relaxation.  Linker relaxation is a process whereby the
15709 linker will attempt to reduce the size of a program by finding shorter
15710 versions of various instructions.  Disabled by default.
15711
15712 @item -mint-register=@var{N}
15713 @opindex mint-register
15714 Specify the number of registers to reserve for fast interrupt handler
15715 functions.  The value @var{N} can be between 0 and 4.  A value of 1
15716 means that register @code{r13} will be reserved for the exclusive use
15717 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
15718 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
15719 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
15720 A value of 0, the default, does not reserve any registers.
15721
15722 @item -msave-acc-in-interrupts
15723 @opindex msave-acc-in-interrupts
15724 Specifies that interrupt handler functions should preserve the
15725 accumulator register.  This is only necessary if normal code might use
15726 the accumulator register, for example because it performs 64-bit
15727 multiplications.  The default is to ignore the accumulator as this
15728 makes the interrupt handlers faster.
15729
15730 @end table
15731
15732 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
15733 has special significance to the RX port when used with the
15734 @code{interrupt} function attribute.  This attribute indicates a
15735 function intended to process fast interrupts.  GCC will will ensure
15736 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
15737 and/or @code{r13} and only provided that the normal use of the
15738 corresponding registers have been restricted via the
15739 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
15740 options.
15741
15742 @node S/390 and zSeries Options
15743 @subsection S/390 and zSeries Options
15744 @cindex S/390 and zSeries Options
15745
15746 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
15747
15748 @table @gcctabopt
15749 @item -mhard-float
15750 @itemx -msoft-float
15751 @opindex mhard-float
15752 @opindex msoft-float
15753 Use (do not use) the hardware floating-point instructions and registers
15754 for floating-point operations.  When @option{-msoft-float} is specified,
15755 functions in @file{libgcc.a} will be used to perform floating-point
15756 operations.  When @option{-mhard-float} is specified, the compiler
15757 generates IEEE floating-point instructions.  This is the default.
15758
15759 @item -mhard-dfp
15760 @itemx -mno-hard-dfp
15761 @opindex mhard-dfp
15762 @opindex mno-hard-dfp
15763 Use (do not use) the hardware decimal-floating-point instructions for
15764 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
15765 specified, functions in @file{libgcc.a} will be used to perform
15766 decimal-floating-point operations.  When @option{-mhard-dfp} is
15767 specified, the compiler generates decimal-floating-point hardware
15768 instructions.  This is the default for @option{-march=z9-ec} or higher.
15769
15770 @item -mlong-double-64
15771 @itemx -mlong-double-128
15772 @opindex mlong-double-64
15773 @opindex mlong-double-128
15774 These switches control the size of @code{long double} type. A size
15775 of 64bit makes the @code{long double} type equivalent to the @code{double}
15776 type. This is the default.
15777
15778 @item -mbackchain
15779 @itemx -mno-backchain
15780 @opindex mbackchain
15781 @opindex mno-backchain
15782 Store (do not store) the address of the caller's frame as backchain pointer
15783 into the callee's stack frame.
15784 A backchain may be needed to allow debugging using tools that do not understand
15785 DWARF-2 call frame information.
15786 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
15787 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
15788 the backchain is placed into the topmost word of the 96/160 byte register
15789 save area.
15790
15791 In general, code compiled with @option{-mbackchain} is call-compatible with
15792 code compiled with @option{-mmo-backchain}; however, use of the backchain
15793 for debugging purposes usually requires that the whole binary is built with
15794 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
15795 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15796 to build a linux kernel use @option{-msoft-float}.
15797
15798 The default is to not maintain the backchain.
15799
15800 @item -mpacked-stack
15801 @itemx -mno-packed-stack
15802 @opindex mpacked-stack
15803 @opindex mno-packed-stack
15804 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
15805 specified, the compiler uses the all fields of the 96/160 byte register save
15806 area only for their default purpose; unused fields still take up stack space.
15807 When @option{-mpacked-stack} is specified, register save slots are densely
15808 packed at the top of the register save area; unused space is reused for other
15809 purposes, allowing for more efficient use of the available stack space.
15810 However, when @option{-mbackchain} is also in effect, the topmost word of
15811 the save area is always used to store the backchain, and the return address
15812 register is always saved two words below the backchain.
15813
15814 As long as the stack frame backchain is not used, code generated with
15815 @option{-mpacked-stack} is call-compatible with code generated with
15816 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
15817 S/390 or zSeries generated code that uses the stack frame backchain at run
15818 time, not just for debugging purposes.  Such code is not call-compatible
15819 with code compiled with @option{-mpacked-stack}.  Also, note that the
15820 combination of @option{-mbackchain},
15821 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15822 to build a linux kernel use @option{-msoft-float}.
15823
15824 The default is to not use the packed stack layout.
15825
15826 @item -msmall-exec
15827 @itemx -mno-small-exec
15828 @opindex msmall-exec
15829 @opindex mno-small-exec
15830 Generate (or do not generate) code using the @code{bras} instruction
15831 to do subroutine calls.
15832 This only works reliably if the total executable size does not
15833 exceed 64k.  The default is to use the @code{basr} instruction instead,
15834 which does not have this limitation.
15835
15836 @item -m64
15837 @itemx -m31
15838 @opindex m64
15839 @opindex m31
15840 When @option{-m31} is specified, generate code compliant to the
15841 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
15842 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
15843 particular to generate 64-bit instructions.  For the @samp{s390}
15844 targets, the default is @option{-m31}, while the @samp{s390x}
15845 targets default to @option{-m64}.
15846
15847 @item -mzarch
15848 @itemx -mesa
15849 @opindex mzarch
15850 @opindex mesa
15851 When @option{-mzarch} is specified, generate code using the
15852 instructions available on z/Architecture.
15853 When @option{-mesa} is specified, generate code using the
15854 instructions available on ESA/390.  Note that @option{-mesa} is
15855 not possible with @option{-m64}.
15856 When generating code compliant to the GNU/Linux for S/390 ABI,
15857 the default is @option{-mesa}.  When generating code compliant
15858 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
15859
15860 @item -mmvcle
15861 @itemx -mno-mvcle
15862 @opindex mmvcle
15863 @opindex mno-mvcle
15864 Generate (or do not generate) code using the @code{mvcle} instruction
15865 to perform block moves.  When @option{-mno-mvcle} is specified,
15866 use a @code{mvc} loop instead.  This is the default unless optimizing for
15867 size.
15868
15869 @item -mdebug
15870 @itemx -mno-debug
15871 @opindex mdebug
15872 @opindex mno-debug
15873 Print (or do not print) additional debug information when compiling.
15874 The default is to not print debug information.
15875
15876 @item -march=@var{cpu-type}
15877 @opindex march
15878 Generate code that will run on @var{cpu-type}, which is the name of a system
15879 representing a certain processor type.  Possible values for
15880 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
15881 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
15882 When generating code using the instructions available on z/Architecture,
15883 the default is @option{-march=z900}.  Otherwise, the default is
15884 @option{-march=g5}.
15885
15886 @item -mtune=@var{cpu-type}
15887 @opindex mtune
15888 Tune to @var{cpu-type} everything applicable about the generated code,
15889 except for the ABI and the set of available instructions.
15890 The list of @var{cpu-type} values is the same as for @option{-march}.
15891 The default is the value used for @option{-march}.
15892
15893 @item -mtpf-trace
15894 @itemx -mno-tpf-trace
15895 @opindex mtpf-trace
15896 @opindex mno-tpf-trace
15897 Generate code that adds (does not add) in TPF OS specific branches to trace
15898 routines in the operating system.  This option is off by default, even
15899 when compiling for the TPF OS@.
15900
15901 @item -mfused-madd
15902 @itemx -mno-fused-madd
15903 @opindex mfused-madd
15904 @opindex mno-fused-madd
15905 Generate code that uses (does not use) the floating point multiply and
15906 accumulate instructions.  These instructions are generated by default if
15907 hardware floating point is used.
15908
15909 @item -mwarn-framesize=@var{framesize}
15910 @opindex mwarn-framesize
15911 Emit a warning if the current function exceeds the given frame size.  Because
15912 this is a compile time check it doesn't need to be a real problem when the program
15913 runs.  It is intended to identify functions which most probably cause
15914 a stack overflow.  It is useful to be used in an environment with limited stack
15915 size e.g.@: the linux kernel.
15916
15917 @item -mwarn-dynamicstack
15918 @opindex mwarn-dynamicstack
15919 Emit a warning if the function calls alloca or uses dynamically
15920 sized arrays.  This is generally a bad idea with a limited stack size.
15921
15922 @item -mstack-guard=@var{stack-guard}
15923 @itemx -mstack-size=@var{stack-size}
15924 @opindex mstack-guard
15925 @opindex mstack-size
15926 If these options are provided the s390 back end emits additional instructions in
15927 the function prologue which trigger a trap if the stack size is @var{stack-guard}
15928 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
15929 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
15930 the frame size of the compiled function is chosen.
15931 These options are intended to be used to help debugging stack overflow problems.
15932 The additionally emitted code causes only little overhead and hence can also be
15933 used in production like systems without greater performance degradation.  The given
15934 values have to be exact powers of 2 and @var{stack-size} has to be greater than
15935 @var{stack-guard} without exceeding 64k.
15936 In order to be efficient the extra code makes the assumption that the stack starts
15937 at an address aligned to the value given by @var{stack-size}.
15938 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
15939 @end table
15940
15941 @node Score Options
15942 @subsection Score Options
15943 @cindex Score Options
15944
15945 These options are defined for Score implementations:
15946
15947 @table @gcctabopt
15948 @item -meb
15949 @opindex meb
15950 Compile code for big endian mode.  This is the default.
15951
15952 @item -mel
15953 @opindex mel
15954 Compile code for little endian mode.
15955
15956 @item -mnhwloop
15957 @opindex mnhwloop
15958 Disable generate bcnz instruction.
15959
15960 @item -muls
15961 @opindex muls
15962 Enable generate unaligned load and store instruction.
15963
15964 @item -mmac
15965 @opindex mmac
15966 Enable the use of multiply-accumulate instructions. Disabled by default.
15967
15968 @item -mscore5
15969 @opindex mscore5
15970 Specify the SCORE5 as the target architecture.
15971
15972 @item -mscore5u
15973 @opindex mscore5u
15974 Specify the SCORE5U of the target architecture.
15975
15976 @item -mscore7
15977 @opindex mscore7
15978 Specify the SCORE7 as the target architecture. This is the default.
15979
15980 @item -mscore7d
15981 @opindex mscore7d
15982 Specify the SCORE7D as the target architecture.
15983 @end table
15984
15985 @node SH Options
15986 @subsection SH Options
15987
15988 These @samp{-m} options are defined for the SH implementations:
15989
15990 @table @gcctabopt
15991 @item -m1
15992 @opindex m1
15993 Generate code for the SH1.
15994
15995 @item -m2
15996 @opindex m2
15997 Generate code for the SH2.
15998
15999 @item -m2e
16000 Generate code for the SH2e.
16001
16002 @item -m2a-nofpu
16003 @opindex m2a-nofpu
16004 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
16005 that the floating-point unit is not used.
16006
16007 @item -m2a-single-only
16008 @opindex m2a-single-only
16009 Generate code for the SH2a-FPU, in such a way that no double-precision
16010 floating point operations are used.
16011
16012 @item -m2a-single
16013 @opindex m2a-single
16014 Generate code for the SH2a-FPU assuming the floating-point unit is in
16015 single-precision mode by default.
16016
16017 @item -m2a
16018 @opindex m2a
16019 Generate code for the SH2a-FPU assuming the floating-point unit is in
16020 double-precision mode by default.
16021
16022 @item -m3
16023 @opindex m3
16024 Generate code for the SH3.
16025
16026 @item -m3e
16027 @opindex m3e
16028 Generate code for the SH3e.
16029
16030 @item -m4-nofpu
16031 @opindex m4-nofpu
16032 Generate code for the SH4 without a floating-point unit.
16033
16034 @item -m4-single-only
16035 @opindex m4-single-only
16036 Generate code for the SH4 with a floating-point unit that only
16037 supports single-precision arithmetic.
16038
16039 @item -m4-single
16040 @opindex m4-single
16041 Generate code for the SH4 assuming the floating-point unit is in
16042 single-precision mode by default.
16043
16044 @item -m4
16045 @opindex m4
16046 Generate code for the SH4.
16047
16048 @item -m4a-nofpu
16049 @opindex m4a-nofpu
16050 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
16051 floating-point unit is not used.
16052
16053 @item -m4a-single-only
16054 @opindex m4a-single-only
16055 Generate code for the SH4a, in such a way that no double-precision
16056 floating point operations are used.
16057
16058 @item -m4a-single
16059 @opindex m4a-single
16060 Generate code for the SH4a assuming the floating-point unit is in
16061 single-precision mode by default.
16062
16063 @item -m4a
16064 @opindex m4a
16065 Generate code for the SH4a.
16066
16067 @item -m4al
16068 @opindex m4al
16069 Same as @option{-m4a-nofpu}, except that it implicitly passes
16070 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
16071 instructions at the moment.
16072
16073 @item -mb
16074 @opindex mb
16075 Compile code for the processor in big endian mode.
16076
16077 @item -ml
16078 @opindex ml
16079 Compile code for the processor in little endian mode.
16080
16081 @item -mdalign
16082 @opindex mdalign
16083 Align doubles at 64-bit boundaries.  Note that this changes the calling
16084 conventions, and thus some functions from the standard C library will
16085 not work unless you recompile it first with @option{-mdalign}.
16086
16087 @item -mrelax
16088 @opindex mrelax
16089 Shorten some address references at link time, when possible; uses the
16090 linker option @option{-relax}.
16091
16092 @item -mbigtable
16093 @opindex mbigtable
16094 Use 32-bit offsets in @code{switch} tables.  The default is to use
16095 16-bit offsets.
16096
16097 @item -mbitops
16098 @opindex mbitops
16099 Enable the use of bit manipulation instructions on SH2A.
16100
16101 @item -mfmovd
16102 @opindex mfmovd
16103 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
16104 alignment constraints.
16105
16106 @item -mhitachi
16107 @opindex mhitachi
16108 Comply with the calling conventions defined by Renesas.
16109
16110 @item -mrenesas
16111 @opindex mhitachi
16112 Comply with the calling conventions defined by Renesas.
16113
16114 @item -mno-renesas
16115 @opindex mhitachi
16116 Comply with the calling conventions defined for GCC before the Renesas
16117 conventions were available.  This option is the default for all
16118 targets of the SH toolchain except for @samp{sh-symbianelf}.
16119
16120 @item -mnomacsave
16121 @opindex mnomacsave
16122 Mark the @code{MAC} register as call-clobbered, even if
16123 @option{-mhitachi} is given.
16124
16125 @item -mieee
16126 @opindex mieee
16127 Increase IEEE-compliance of floating-point code.
16128 At the moment, this is equivalent to @option{-fno-finite-math-only}.
16129 When generating 16 bit SH opcodes, getting IEEE-conforming results for
16130 comparisons of NANs / infinities incurs extra overhead in every
16131 floating point comparison, therefore the default is set to
16132 @option{-ffinite-math-only}.
16133
16134 @item -minline-ic_invalidate
16135 @opindex minline-ic_invalidate
16136 Inline code to invalidate instruction cache entries after setting up
16137 nested function trampolines.
16138 This option has no effect if -musermode is in effect and the selected
16139 code generation option (e.g. -m4) does not allow the use of the icbi
16140 instruction.
16141 If the selected code generation option does not allow the use of the icbi
16142 instruction, and -musermode is not in effect, the inlined code will
16143 manipulate the instruction cache address array directly with an associative
16144 write.  This not only requires privileged mode, but it will also
16145 fail if the cache line had been mapped via the TLB and has become unmapped.
16146
16147 @item -misize
16148 @opindex misize
16149 Dump instruction size and location in the assembly code.
16150
16151 @item -mpadstruct
16152 @opindex mpadstruct
16153 This option is deprecated.  It pads structures to multiple of 4 bytes,
16154 which is incompatible with the SH ABI@.
16155
16156 @item -mspace
16157 @opindex mspace
16158 Optimize for space instead of speed.  Implied by @option{-Os}.
16159
16160 @item -mprefergot
16161 @opindex mprefergot
16162 When generating position-independent code, emit function calls using
16163 the Global Offset Table instead of the Procedure Linkage Table.
16164
16165 @item -musermode
16166 @opindex musermode
16167 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16168 if the inlined code would not work in user mode.
16169 This is the default when the target is @code{sh-*-linux*}.
16170
16171 @item -multcost=@var{number}
16172 @opindex multcost=@var{number}
16173 Set the cost to assume for a multiply insn.
16174
16175 @item -mdiv=@var{strategy}
16176 @opindex mdiv=@var{strategy}
16177 Set the division strategy to use for SHmedia code.  @var{strategy} must be
16178 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16179 inv:call2, inv:fp .
16180 "fp" performs the operation in floating point.  This has a very high latency,
16181 but needs only a few instructions, so it might be a good choice if
16182 your code has enough easily exploitable ILP to allow the compiler to
16183 schedule the floating point instructions together with other instructions.
16184 Division by zero causes a floating point exception.
16185 "inv" uses integer operations to calculate the inverse of the divisor,
16186 and then multiplies the dividend with the inverse.  This strategy allows
16187 cse and hoisting of the inverse calculation.  Division by zero calculates
16188 an unspecified result, but does not trap.
16189 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16190 have been found, or if the entire operation has been hoisted to the same
16191 place, the last stages of the inverse calculation are intertwined with the
16192 final multiply to reduce the overall latency, at the expense of using a few
16193 more instructions, and thus offering fewer scheduling opportunities with
16194 other code.
16195 "call" calls a library function that usually implements the inv:minlat
16196 strategy.
16197 This gives high code density for m5-*media-nofpu compilations.
16198 "call2" uses a different entry point of the same library function, where it
16199 assumes that a pointer to a lookup table has already been set up, which
16200 exposes the pointer load to cse / code hoisting optimizations.
16201 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16202 code generation, but if the code stays unoptimized, revert to the "call",
16203 "call2", or "fp" strategies, respectively.  Note that the
16204 potentially-trapping side effect of division by zero is carried by a
16205 separate instruction, so it is possible that all the integer instructions
16206 are hoisted out, but the marker for the side effect stays where it is.
16207 A recombination to fp operations or a call is not possible in that case.
16208 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16209 that the inverse calculation was nor separated from the multiply, they speed
16210 up division where the dividend fits into 20 bits (plus sign where applicable),
16211 by inserting a test to skip a number of operations in this case; this test
16212 slows down the case of larger dividends.  inv20u assumes the case of a such
16213 a small dividend to be unlikely, and inv20l assumes it to be likely.
16214
16215 @item -maccumulate-outgoing-args
16216 @opindex maccumulate-outgoing-args
16217 Reserve space once for outgoing arguments in the function prologue rather 
16218 than around each call.  Generally beneficial for performance and size.  Also
16219 needed for unwinding to avoid changing the stack frame around conditional code.
16220
16221 @item -mdivsi3_libfunc=@var{name}
16222 @opindex mdivsi3_libfunc=@var{name}
16223 Set the name of the library function used for 32 bit signed division to
16224 @var{name}.  This only affect the name used in the call and inv:call
16225 division strategies, and the compiler will still expect the same
16226 sets of input/output/clobbered registers as if this option was not present.
16227
16228 @item -mfixed-range=@var{register-range}
16229 @opindex mfixed-range
16230 Generate code treating the given register range as fixed registers.
16231 A fixed register is one that the register allocator can not use.  This is
16232 useful when compiling kernel code.  A register range is specified as
16233 two registers separated by a dash.  Multiple register ranges can be
16234 specified separated by a comma.
16235
16236 @item -madjust-unroll
16237 @opindex madjust-unroll
16238 Throttle unrolling to avoid thrashing target registers.
16239 This option only has an effect if the gcc code base supports the
16240 TARGET_ADJUST_UNROLL_MAX target hook.
16241
16242 @item -mindexed-addressing
16243 @opindex mindexed-addressing
16244 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16245 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16246 semantics for the indexed addressing mode.  The architecture allows the
16247 implementation of processors with 64 bit MMU, which the OS could use to
16248 get 32 bit addressing, but since no current hardware implementation supports
16249 this or any other way to make the indexed addressing mode safe to use in
16250 the 32 bit ABI, the default is -mno-indexed-addressing.
16251
16252 @item -mgettrcost=@var{number}
16253 @opindex mgettrcost=@var{number}
16254 Set the cost assumed for the gettr instruction to @var{number}.
16255 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16256
16257 @item -mpt-fixed
16258 @opindex mpt-fixed
16259 Assume pt* instructions won't trap.  This will generally generate better
16260 scheduled code, but is unsafe on current hardware.  The current architecture
16261 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16262 This has the unintentional effect of making it unsafe to schedule ptabs /
16263 ptrel before a branch, or hoist it out of a loop.  For example,
16264 __do_global_ctors, a part of libgcc that runs constructors at program
16265 startup, calls functions in a list which is delimited by @minus{}1.  With the
16266 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16267 That means that all the constructors will be run a bit quicker, but when
16268 the loop comes to the end of the list, the program crashes because ptabs
16269 loads @minus{}1 into a target register.  Since this option is unsafe for any
16270 hardware implementing the current architecture specification, the default
16271 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16272 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16273 this deters register allocation using target registers for storing
16274 ordinary integers.
16275
16276 @item -minvalid-symbols
16277 @opindex minvalid-symbols
16278 Assume symbols might be invalid.  Ordinary function symbols generated by
16279 the compiler will always be valid to load with movi/shori/ptabs or
16280 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16281 to generate symbols that will cause ptabs / ptrel to trap.
16282 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16283 It will then prevent cross-basic-block cse, hoisting and most scheduling
16284 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16285 @end table
16286
16287 @node SPARC Options
16288 @subsection SPARC Options
16289 @cindex SPARC options
16290
16291 These @samp{-m} options are supported on the SPARC:
16292
16293 @table @gcctabopt
16294 @item -mno-app-regs
16295 @itemx -mapp-regs
16296 @opindex mno-app-regs
16297 @opindex mapp-regs
16298 Specify @option{-mapp-regs} to generate output using the global registers
16299 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
16300 is the default.
16301
16302 To be fully SVR4 ABI compliant at the cost of some performance loss,
16303 specify @option{-mno-app-regs}.  You should compile libraries and system
16304 software with this option.
16305
16306 @item -mfpu
16307 @itemx -mhard-float
16308 @opindex mfpu
16309 @opindex mhard-float
16310 Generate output containing floating point instructions.  This is the
16311 default.
16312
16313 @item -mno-fpu
16314 @itemx -msoft-float
16315 @opindex mno-fpu
16316 @opindex msoft-float
16317 Generate output containing library calls for floating point.
16318 @strong{Warning:} the requisite libraries are not available for all SPARC
16319 targets.  Normally the facilities of the machine's usual C compiler are
16320 used, but this cannot be done directly in cross-compilation.  You must make
16321 your own arrangements to provide suitable library functions for
16322 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
16323 @samp{sparclite-*-*} do provide software floating point support.
16324
16325 @option{-msoft-float} changes the calling convention in the output file;
16326 therefore, it is only useful if you compile @emph{all} of a program with
16327 this option.  In particular, you need to compile @file{libgcc.a}, the
16328 library that comes with GCC, with @option{-msoft-float} in order for
16329 this to work.
16330
16331 @item -mhard-quad-float
16332 @opindex mhard-quad-float
16333 Generate output containing quad-word (long double) floating point
16334 instructions.
16335
16336 @item -msoft-quad-float
16337 @opindex msoft-quad-float
16338 Generate output containing library calls for quad-word (long double)
16339 floating point instructions.  The functions called are those specified
16340 in the SPARC ABI@.  This is the default.
16341
16342 As of this writing, there are no SPARC implementations that have hardware
16343 support for the quad-word floating point instructions.  They all invoke
16344 a trap handler for one of these instructions, and then the trap handler
16345 emulates the effect of the instruction.  Because of the trap handler overhead,
16346 this is much slower than calling the ABI library routines.  Thus the
16347 @option{-msoft-quad-float} option is the default.
16348
16349 @item -mno-unaligned-doubles
16350 @itemx -munaligned-doubles
16351 @opindex mno-unaligned-doubles
16352 @opindex munaligned-doubles
16353 Assume that doubles have 8 byte alignment.  This is the default.
16354
16355 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16356 alignment only if they are contained in another type, or if they have an
16357 absolute address.  Otherwise, it assumes they have 4 byte alignment.
16358 Specifying this option avoids some rare compatibility problems with code
16359 generated by other compilers.  It is not the default because it results
16360 in a performance loss, especially for floating point code.
16361
16362 @item -mno-faster-structs
16363 @itemx -mfaster-structs
16364 @opindex mno-faster-structs
16365 @opindex mfaster-structs
16366 With @option{-mfaster-structs}, the compiler assumes that structures
16367 should have 8 byte alignment.  This enables the use of pairs of
16368 @code{ldd} and @code{std} instructions for copies in structure
16369 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16370 However, the use of this changed alignment directly violates the SPARC
16371 ABI@.  Thus, it's intended only for use on targets where the developer
16372 acknowledges that their resulting code will not be directly in line with
16373 the rules of the ABI@.
16374
16375 @item -mimpure-text
16376 @opindex mimpure-text
16377 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16378 the compiler to not pass @option{-z text} to the linker when linking a
16379 shared object.  Using this option, you can link position-dependent
16380 code into a shared object.
16381
16382 @option{-mimpure-text} suppresses the ``relocations remain against
16383 allocatable but non-writable sections'' linker error message.
16384 However, the necessary relocations will trigger copy-on-write, and the
16385 shared object is not actually shared across processes.  Instead of
16386 using @option{-mimpure-text}, you should compile all source code with
16387 @option{-fpic} or @option{-fPIC}.
16388
16389 This option is only available on SunOS and Solaris.
16390
16391 @item -mcpu=@var{cpu_type}
16392 @opindex mcpu
16393 Set the instruction set, register set, and instruction scheduling parameters
16394 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
16395 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
16396 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
16397 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16398 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16399
16400 Default instruction scheduling parameters are used for values that select
16401 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
16402 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16403
16404 Here is a list of each supported architecture and their supported
16405 implementations.
16406
16407 @smallexample
16408     v7:             cypress
16409     v8:             supersparc, hypersparc
16410     sparclite:      f930, f934, sparclite86x
16411     sparclet:       tsc701
16412     v9:             ultrasparc, ultrasparc3, niagara, niagara2
16413 @end smallexample
16414
16415 By default (unless configured otherwise), GCC generates code for the V7
16416 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
16417 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16418 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
16419 SPARCStation 1, 2, IPX etc.
16420
16421 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
16422 architecture.  The only difference from V7 code is that the compiler emits
16423 the integer multiply and integer divide instructions which exist in SPARC-V8
16424 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
16425 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
16426 2000 series.
16427
16428 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
16429 the SPARC architecture.  This adds the integer multiply, integer divide step
16430 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
16431 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
16432 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
16433 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
16434 MB86934 chip, which is the more recent SPARClite with FPU@.
16435
16436 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
16437 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
16438 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
16439 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
16440 optimizes it for the TEMIC SPARClet chip.
16441
16442 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
16443 architecture.  This adds 64-bit integer and floating-point move instructions,
16444 3 additional floating-point condition code registers and conditional move
16445 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
16446 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
16447 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
16448 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
16449 @option{-mcpu=niagara}, the compiler additionally optimizes it for
16450 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
16451 additionally optimizes it for Sun UltraSPARC T2 chips.
16452
16453 @item -mtune=@var{cpu_type}
16454 @opindex mtune
16455 Set the instruction scheduling parameters for machine type
16456 @var{cpu_type}, but do not set the instruction set or register set that the
16457 option @option{-mcpu=@var{cpu_type}} would.
16458
16459 The same values for @option{-mcpu=@var{cpu_type}} can be used for
16460 @option{-mtune=@var{cpu_type}}, but the only useful values are those
16461 that select a particular cpu implementation.  Those are @samp{cypress},
16462 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
16463 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
16464 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
16465
16466 @item -mv8plus
16467 @itemx -mno-v8plus
16468 @opindex mv8plus
16469 @opindex mno-v8plus
16470 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
16471 difference from the V8 ABI is that the global and out registers are
16472 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
16473 mode for all SPARC-V9 processors.
16474
16475 @item -mvis
16476 @itemx -mno-vis
16477 @opindex mvis
16478 @opindex mno-vis
16479 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
16480 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
16481 @end table
16482
16483 These @samp{-m} options are supported in addition to the above
16484 on SPARC-V9 processors in 64-bit environments:
16485
16486 @table @gcctabopt
16487 @item -mlittle-endian
16488 @opindex mlittle-endian
16489 Generate code for a processor running in little-endian mode.  It is only
16490 available for a few configurations and most notably not on Solaris and Linux.
16491
16492 @item -m32
16493 @itemx -m64
16494 @opindex m32
16495 @opindex m64
16496 Generate code for a 32-bit or 64-bit environment.
16497 The 32-bit environment sets int, long and pointer to 32 bits.
16498 The 64-bit environment sets int to 32 bits and long and pointer
16499 to 64 bits.
16500
16501 @item -mcmodel=medlow
16502 @opindex mcmodel=medlow
16503 Generate code for the Medium/Low code model: 64-bit addresses, programs
16504 must be linked in the low 32 bits of memory.  Programs can be statically
16505 or dynamically linked.
16506
16507 @item -mcmodel=medmid
16508 @opindex mcmodel=medmid
16509 Generate code for the Medium/Middle code model: 64-bit addresses, programs
16510 must be linked in the low 44 bits of memory, the text and data segments must
16511 be less than 2GB in size and the data segment must be located within 2GB of
16512 the text segment.
16513
16514 @item -mcmodel=medany
16515 @opindex mcmodel=medany
16516 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
16517 may be linked anywhere in memory, the text and data segments must be less
16518 than 2GB in size and the data segment must be located within 2GB of the
16519 text segment.
16520
16521 @item -mcmodel=embmedany
16522 @opindex mcmodel=embmedany
16523 Generate code for the Medium/Anywhere code model for embedded systems:
16524 64-bit addresses, the text and data segments must be less than 2GB in
16525 size, both starting anywhere in memory (determined at link time).  The
16526 global register %g4 points to the base of the data segment.  Programs
16527 are statically linked and PIC is not supported.
16528
16529 @item -mstack-bias
16530 @itemx -mno-stack-bias
16531 @opindex mstack-bias
16532 @opindex mno-stack-bias
16533 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
16534 frame pointer if present, are offset by @minus{}2047 which must be added back
16535 when making stack frame references.  This is the default in 64-bit mode.
16536 Otherwise, assume no such offset is present.
16537 @end table
16538
16539 These switches are supported in addition to the above on Solaris:
16540
16541 @table @gcctabopt
16542 @item -threads
16543 @opindex threads
16544 Add support for multithreading using the Solaris threads library.  This
16545 option sets flags for both the preprocessor and linker.  This option does
16546 not affect the thread safety of object code produced by the compiler or
16547 that of libraries supplied with it.
16548
16549 @item -pthreads
16550 @opindex pthreads
16551 Add support for multithreading using the POSIX threads library.  This
16552 option sets flags for both the preprocessor and linker.  This option does
16553 not affect the thread safety of object code produced  by the compiler or
16554 that of libraries supplied with it.
16555
16556 @item -pthread
16557 @opindex pthread
16558 This is a synonym for @option{-pthreads}.
16559 @end table
16560
16561 @node SPU Options
16562 @subsection SPU Options
16563 @cindex SPU options
16564
16565 These @samp{-m} options are supported on the SPU:
16566
16567 @table @gcctabopt
16568 @item -mwarn-reloc
16569 @itemx -merror-reloc
16570 @opindex mwarn-reloc
16571 @opindex merror-reloc
16572
16573 The loader for SPU does not handle dynamic relocations.  By default, GCC
16574 will give an error when it generates code that requires a dynamic
16575 relocation.  @option{-mno-error-reloc} disables the error,
16576 @option{-mwarn-reloc} will generate a warning instead.
16577
16578 @item -msafe-dma
16579 @itemx -munsafe-dma
16580 @opindex msafe-dma
16581 @opindex munsafe-dma
16582
16583 Instructions which initiate or test completion of DMA must not be
16584 reordered with respect to loads and stores of the memory which is being
16585 accessed.  Users typically address this problem using the volatile
16586 keyword, but that can lead to inefficient code in places where the
16587 memory is known to not change.  Rather than mark the memory as volatile
16588 we treat the DMA instructions as potentially effecting all memory.  With
16589 @option{-munsafe-dma} users must use the volatile keyword to protect
16590 memory accesses.
16591
16592 @item -mbranch-hints
16593 @opindex mbranch-hints
16594
16595 By default, GCC will generate a branch hint instruction to avoid
16596 pipeline stalls for always taken or probably taken branches.  A hint
16597 will not be generated closer than 8 instructions away from its branch.
16598 There is little reason to disable them, except for debugging purposes,
16599 or to make an object a little bit smaller.
16600
16601 @item -msmall-mem
16602 @itemx -mlarge-mem
16603 @opindex msmall-mem
16604 @opindex mlarge-mem
16605
16606 By default, GCC generates code assuming that addresses are never larger
16607 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
16608 a full 32 bit address.
16609
16610 @item -mstdmain
16611 @opindex mstdmain
16612
16613 By default, GCC links against startup code that assumes the SPU-style
16614 main function interface (which has an unconventional parameter list).
16615 With @option{-mstdmain}, GCC will link your program against startup
16616 code that assumes a C99-style interface to @code{main}, including a
16617 local copy of @code{argv} strings.
16618
16619 @item -mfixed-range=@var{register-range}
16620 @opindex mfixed-range
16621 Generate code treating the given register range as fixed registers.
16622 A fixed register is one that the register allocator can not use.  This is
16623 useful when compiling kernel code.  A register range is specified as
16624 two registers separated by a dash.  Multiple register ranges can be
16625 specified separated by a comma.
16626
16627 @item -mea32
16628 @itemx -mea64
16629 @opindex mea32
16630 @opindex mea64
16631 Compile code assuming that pointers to the PPU address space accessed
16632 via the @code{__ea} named address space qualifier are either 32 or 64
16633 bits wide.  The default is 32 bits.  As this is an ABI changing option,
16634 all object code in an executable must be compiled with the same setting.
16635
16636 @item -maddress-space-conversion
16637 @itemx -mno-address-space-conversion
16638 @opindex maddress-space-conversion
16639 @opindex mno-address-space-conversion
16640 Allow/disallow treating the @code{__ea} address space as superset
16641 of the generic address space.  This enables explicit type casts
16642 between @code{__ea} and generic pointer as well as implicit
16643 conversions of generic pointers to @code{__ea} pointers.  The
16644 default is to allow address space pointer conversions.
16645
16646 @item -mcache-size=@var{cache-size}
16647 @opindex mcache-size
16648 This option controls the version of libgcc that the compiler links to an
16649 executable and selects a software-managed cache for accessing variables
16650 in the @code{__ea} address space with a particular cache size.  Possible
16651 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
16652 and @samp{128}.  The default cache size is 64KB.
16653
16654 @item -matomic-updates
16655 @itemx -mno-atomic-updates
16656 @opindex matomic-updates
16657 @opindex mno-atomic-updates
16658 This option controls the version of libgcc that the compiler links to an
16659 executable and selects whether atomic updates to the software-managed
16660 cache of PPU-side variables are used.  If you use atomic updates, changes
16661 to a PPU variable from SPU code using the @code{__ea} named address space
16662 qualifier will not interfere with changes to other PPU variables residing
16663 in the same cache line from PPU code.  If you do not use atomic updates,
16664 such interference may occur; however, writing back cache lines will be
16665 more efficient.  The default behavior is to use atomic updates.
16666
16667 @item -mdual-nops
16668 @itemx -mdual-nops=@var{n}
16669 @opindex mdual-nops
16670 By default, GCC will insert nops to increase dual issue when it expects
16671 it to increase performance.  @var{n} can be a value from 0 to 10.  A
16672 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
16673 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
16674
16675 @item -mhint-max-nops=@var{n}
16676 @opindex mhint-max-nops
16677 Maximum number of nops to insert for a branch hint.  A branch hint must
16678 be at least 8 instructions away from the branch it is effecting.  GCC
16679 will insert up to @var{n} nops to enforce this, otherwise it will not
16680 generate the branch hint.
16681
16682 @item -mhint-max-distance=@var{n}
16683 @opindex mhint-max-distance
16684 The encoding of the branch hint instruction limits the hint to be within
16685 256 instructions of the branch it is effecting.  By default, GCC makes
16686 sure it is within 125.
16687
16688 @item -msafe-hints
16689 @opindex msafe-hints
16690 Work around a hardware bug which causes the SPU to stall indefinitely.
16691 By default, GCC will insert the @code{hbrp} instruction to make sure
16692 this stall won't happen.
16693
16694 @end table
16695
16696 @node System V Options
16697 @subsection Options for System V
16698
16699 These additional options are available on System V Release 4 for
16700 compatibility with other compilers on those systems:
16701
16702 @table @gcctabopt
16703 @item -G
16704 @opindex G
16705 Create a shared object.
16706 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
16707
16708 @item -Qy
16709 @opindex Qy
16710 Identify the versions of each tool used by the compiler, in a
16711 @code{.ident} assembler directive in the output.
16712
16713 @item -Qn
16714 @opindex Qn
16715 Refrain from adding @code{.ident} directives to the output file (this is
16716 the default).
16717
16718 @item -YP,@var{dirs}
16719 @opindex YP
16720 Search the directories @var{dirs}, and no others, for libraries
16721 specified with @option{-l}.
16722
16723 @item -Ym,@var{dir}
16724 @opindex Ym
16725 Look in the directory @var{dir} to find the M4 preprocessor.
16726 The assembler uses this option.
16727 @c This is supposed to go with a -Yd for predefined M4 macro files, but
16728 @c the generic assembler that comes with Solaris takes just -Ym.
16729 @end table
16730
16731 @node V850 Options
16732 @subsection V850 Options
16733 @cindex V850 Options
16734
16735 These @samp{-m} options are defined for V850 implementations:
16736
16737 @table @gcctabopt
16738 @item -mlong-calls
16739 @itemx -mno-long-calls
16740 @opindex mlong-calls
16741 @opindex mno-long-calls
16742 Treat all calls as being far away (near).  If calls are assumed to be
16743 far away, the compiler will always load the functions address up into a
16744 register, and call indirect through the pointer.
16745
16746 @item -mno-ep
16747 @itemx -mep
16748 @opindex mno-ep
16749 @opindex mep
16750 Do not optimize (do optimize) basic blocks that use the same index
16751 pointer 4 or more times to copy pointer into the @code{ep} register, and
16752 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
16753 option is on by default if you optimize.
16754
16755 @item -mno-prolog-function
16756 @itemx -mprolog-function
16757 @opindex mno-prolog-function
16758 @opindex mprolog-function
16759 Do not use (do use) external functions to save and restore registers
16760 at the prologue and epilogue of a function.  The external functions
16761 are slower, but use less code space if more than one function saves
16762 the same number of registers.  The @option{-mprolog-function} option
16763 is on by default if you optimize.
16764
16765 @item -mspace
16766 @opindex mspace
16767 Try to make the code as small as possible.  At present, this just turns
16768 on the @option{-mep} and @option{-mprolog-function} options.
16769
16770 @item -mtda=@var{n}
16771 @opindex mtda
16772 Put static or global variables whose size is @var{n} bytes or less into
16773 the tiny data area that register @code{ep} points to.  The tiny data
16774 area can hold up to 256 bytes in total (128 bytes for byte references).
16775
16776 @item -msda=@var{n}
16777 @opindex msda
16778 Put static or global variables whose size is @var{n} bytes or less into
16779 the small data area that register @code{gp} points to.  The small data
16780 area can hold up to 64 kilobytes.
16781
16782 @item -mzda=@var{n}
16783 @opindex mzda
16784 Put static or global variables whose size is @var{n} bytes or less into
16785 the first 32 kilobytes of memory.
16786
16787 @item -mv850
16788 @opindex mv850
16789 Specify that the target processor is the V850.
16790
16791 @item -mbig-switch
16792 @opindex mbig-switch
16793 Generate code suitable for big switch tables.  Use this option only if
16794 the assembler/linker complain about out of range branches within a switch
16795 table.
16796
16797 @item -mapp-regs
16798 @opindex mapp-regs
16799 This option will cause r2 and r5 to be used in the code generated by
16800 the compiler.  This setting is the default.
16801
16802 @item -mno-app-regs
16803 @opindex mno-app-regs
16804 This option will cause r2 and r5 to be treated as fixed registers.
16805
16806 @item -mv850e1
16807 @opindex mv850e1
16808 Specify that the target processor is the V850E1.  The preprocessor
16809 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
16810 this option is used.
16811
16812 @item -mv850e
16813 @opindex mv850e
16814 Specify that the target processor is the V850E@.  The preprocessor
16815 constant @samp{__v850e__} will be defined if this option is used.
16816
16817 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
16818 are defined then a default target processor will be chosen and the
16819 relevant @samp{__v850*__} preprocessor constant will be defined.
16820
16821 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
16822 defined, regardless of which processor variant is the target.
16823
16824 @item -mdisable-callt
16825 @opindex mdisable-callt
16826 This option will suppress generation of the CALLT instruction for the
16827 v850e and v850e1 flavors of the v850 architecture.  The default is
16828 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
16829
16830 @end table
16831
16832 @node VAX Options
16833 @subsection VAX Options
16834 @cindex VAX options
16835
16836 These @samp{-m} options are defined for the VAX:
16837
16838 @table @gcctabopt
16839 @item -munix
16840 @opindex munix
16841 Do not output certain jump instructions (@code{aobleq} and so on)
16842 that the Unix assembler for the VAX cannot handle across long
16843 ranges.
16844
16845 @item -mgnu
16846 @opindex mgnu
16847 Do output those jump instructions, on the assumption that you
16848 will assemble with the GNU assembler.
16849
16850 @item -mg
16851 @opindex mg
16852 Output code for g-format floating point numbers instead of d-format.
16853 @end table
16854
16855 @node VxWorks Options
16856 @subsection VxWorks Options
16857 @cindex VxWorks Options
16858
16859 The options in this section are defined for all VxWorks targets.
16860 Options specific to the target hardware are listed with the other
16861 options for that target.
16862
16863 @table @gcctabopt
16864 @item -mrtp
16865 @opindex mrtp
16866 GCC can generate code for both VxWorks kernels and real time processes
16867 (RTPs).  This option switches from the former to the latter.  It also
16868 defines the preprocessor macro @code{__RTP__}.
16869
16870 @item -non-static
16871 @opindex non-static
16872 Link an RTP executable against shared libraries rather than static
16873 libraries.  The options @option{-static} and @option{-shared} can
16874 also be used for RTPs (@pxref{Link Options}); @option{-static}
16875 is the default.
16876
16877 @item -Bstatic
16878 @itemx -Bdynamic
16879 @opindex Bstatic
16880 @opindex Bdynamic
16881 These options are passed down to the linker.  They are defined for
16882 compatibility with Diab.
16883
16884 @item -Xbind-lazy
16885 @opindex Xbind-lazy
16886 Enable lazy binding of function calls.  This option is equivalent to
16887 @option{-Wl,-z,now} and is defined for compatibility with Diab.
16888
16889 @item -Xbind-now
16890 @opindex Xbind-now
16891 Disable lazy binding of function calls.  This option is the default and
16892 is defined for compatibility with Diab.
16893 @end table
16894
16895 @node x86-64 Options
16896 @subsection x86-64 Options
16897 @cindex x86-64 options
16898
16899 These are listed under @xref{i386 and x86-64 Options}.
16900
16901 @node i386 and x86-64 Windows Options
16902 @subsection i386 and x86-64 Windows Options
16903 @cindex i386 and x86-64 Windows Options
16904
16905 These additional options are available for Windows targets:
16906
16907 @table @gcctabopt
16908 @item -mconsole
16909 @opindex mconsole
16910 This option is available for Cygwin and MinGW targets.  It
16911 specifies that a console application is to be generated, by
16912 instructing the linker to set the PE header subsystem type
16913 required for console applications.
16914 This is the default behavior for Cygwin and MinGW targets.
16915
16916 @item -mcygwin
16917 @opindex mcygwin
16918 This option is available for Cygwin targets.  It specifies that
16919 the Cygwin internal interface is to be used for predefined
16920 preprocessor macros, C runtime libraries and related linker
16921 paths and options.  For Cygwin targets this is the default behavior.
16922 This option is deprecated and will be removed in a future release.
16923
16924 @item -mno-cygwin
16925 @opindex mno-cygwin
16926 This option is available for Cygwin targets.  It specifies that
16927 the MinGW internal interface is to be used instead of Cygwin's, by
16928 setting MinGW-related predefined macros and linker paths and default
16929 library options.
16930 This option is deprecated and will be removed in a future release.
16931
16932 @item -mdll
16933 @opindex mdll
16934 This option is available for Cygwin and MinGW targets.  It
16935 specifies that a DLL - a dynamic link library - is to be
16936 generated, enabling the selection of the required runtime
16937 startup object and entry point.
16938
16939 @item -mnop-fun-dllimport
16940 @opindex mnop-fun-dllimport
16941 This option is available for Cygwin and MinGW targets.  It
16942 specifies that the dllimport attribute should be ignored.
16943
16944 @item -mthread
16945 @opindex mthread
16946 This option is available for MinGW targets. It specifies
16947 that MinGW-specific thread support is to be used.
16948
16949 @item -municode
16950 @opindex municode
16951 This option is available for mingw-w64 targets.  It specifies
16952 that the UNICODE macro is getting pre-defined and that the
16953 unicode capable runtime startup code is chosen.
16954
16955 @item -mwin32
16956 @opindex mwin32
16957 This option is available for Cygwin and MinGW targets.  It
16958 specifies that the typical Windows pre-defined macros are to
16959 be set in the pre-processor, but does not influence the choice
16960 of runtime library/startup code.
16961
16962 @item -mwindows
16963 @opindex mwindows
16964 This option is available for Cygwin and MinGW targets.  It
16965 specifies that a GUI application is to be generated by
16966 instructing the linker to set the PE header subsystem type
16967 appropriately.
16968
16969 @item -fno-set-stack-executable
16970 @opindex fno-set-stack-executable
16971 This option is available for MinGW targets. It specifies that
16972 the executable flag for stack used by nested functions isn't
16973 set. This is necessary for binaries running in kernel mode of
16974 Windows, as there the user32 API, which is used to set executable
16975 privileges, isn't available.
16976
16977 @item -mpe-aligned-commons
16978 @opindex mpe-aligned-commons
16979 This option is available for Cygwin and MinGW targets.  It
16980 specifies that the GNU extension to the PE file format that
16981 permits the correct alignment of COMMON variables should be
16982 used when generating code.  It will be enabled by default if
16983 GCC detects that the target assembler found during configuration
16984 supports the feature.
16985 @end table
16986
16987 See also under @ref{i386 and x86-64 Options} for standard options.
16988
16989 @node Xstormy16 Options
16990 @subsection Xstormy16 Options
16991 @cindex Xstormy16 Options
16992
16993 These options are defined for Xstormy16:
16994
16995 @table @gcctabopt
16996 @item -msim
16997 @opindex msim
16998 Choose startup files and linker script suitable for the simulator.
16999 @end table
17000
17001 @node Xtensa Options
17002 @subsection Xtensa Options
17003 @cindex Xtensa Options
17004
17005 These options are supported for Xtensa targets:
17006
17007 @table @gcctabopt
17008 @item -mconst16
17009 @itemx -mno-const16
17010 @opindex mconst16
17011 @opindex mno-const16
17012 Enable or disable use of @code{CONST16} instructions for loading
17013 constant values.  The @code{CONST16} instruction is currently not a
17014 standard option from Tensilica.  When enabled, @code{CONST16}
17015 instructions are always used in place of the standard @code{L32R}
17016 instructions.  The use of @code{CONST16} is enabled by default only if
17017 the @code{L32R} instruction is not available.
17018
17019 @item -mfused-madd
17020 @itemx -mno-fused-madd
17021 @opindex mfused-madd
17022 @opindex mno-fused-madd
17023 Enable or disable use of fused multiply/add and multiply/subtract
17024 instructions in the floating-point option.  This has no effect if the
17025 floating-point option is not also enabled.  Disabling fused multiply/add
17026 and multiply/subtract instructions forces the compiler to use separate
17027 instructions for the multiply and add/subtract operations.  This may be
17028 desirable in some cases where strict IEEE 754-compliant results are
17029 required: the fused multiply add/subtract instructions do not round the
17030 intermediate result, thereby producing results with @emph{more} bits of
17031 precision than specified by the IEEE standard.  Disabling fused multiply
17032 add/subtract instructions also ensures that the program output is not
17033 sensitive to the compiler's ability to combine multiply and add/subtract
17034 operations.
17035
17036 @item -mserialize-volatile
17037 @itemx -mno-serialize-volatile
17038 @opindex mserialize-volatile
17039 @opindex mno-serialize-volatile
17040 When this option is enabled, GCC inserts @code{MEMW} instructions before
17041 @code{volatile} memory references to guarantee sequential consistency.
17042 The default is @option{-mserialize-volatile}.  Use
17043 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
17044
17045 @item -mtext-section-literals
17046 @itemx -mno-text-section-literals
17047 @opindex mtext-section-literals
17048 @opindex mno-text-section-literals
17049 Control the treatment of literal pools.  The default is
17050 @option{-mno-text-section-literals}, which places literals in a separate
17051 section in the output file.  This allows the literal pool to be placed
17052 in a data RAM/ROM, and it also allows the linker to combine literal
17053 pools from separate object files to remove redundant literals and
17054 improve code size.  With @option{-mtext-section-literals}, the literals
17055 are interspersed in the text section in order to keep them as close as
17056 possible to their references.  This may be necessary for large assembly
17057 files.
17058
17059 @item -mtarget-align
17060 @itemx -mno-target-align
17061 @opindex mtarget-align
17062 @opindex mno-target-align
17063 When this option is enabled, GCC instructs the assembler to
17064 automatically align instructions to reduce branch penalties at the
17065 expense of some code density.  The assembler attempts to widen density
17066 instructions to align branch targets and the instructions following call
17067 instructions.  If there are not enough preceding safe density
17068 instructions to align a target, no widening will be performed.  The
17069 default is @option{-mtarget-align}.  These options do not affect the
17070 treatment of auto-aligned instructions like @code{LOOP}, which the
17071 assembler will always align, either by widening density instructions or
17072 by inserting no-op instructions.
17073
17074 @item -mlongcalls
17075 @itemx -mno-longcalls
17076 @opindex mlongcalls
17077 @opindex mno-longcalls
17078 When this option is enabled, GCC instructs the assembler to translate
17079 direct calls to indirect calls unless it can determine that the target
17080 of a direct call is in the range allowed by the call instruction.  This
17081 translation typically occurs for calls to functions in other source
17082 files.  Specifically, the assembler translates a direct @code{CALL}
17083 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
17084 The default is @option{-mno-longcalls}.  This option should be used in
17085 programs where the call target can potentially be out of range.  This
17086 option is implemented in the assembler, not the compiler, so the
17087 assembly code generated by GCC will still show direct call
17088 instructions---look at the disassembled object code to see the actual
17089 instructions.  Note that the assembler will use an indirect call for
17090 every cross-file call, not just those that really will be out of range.
17091 @end table
17092
17093 @node zSeries Options
17094 @subsection zSeries Options
17095 @cindex zSeries options
17096
17097 These are listed under @xref{S/390 and zSeries Options}.
17098
17099 @node Code Gen Options
17100 @section Options for Code Generation Conventions
17101 @cindex code generation conventions
17102 @cindex options, code generation
17103 @cindex run-time options
17104
17105 These machine-independent options control the interface conventions
17106 used in code generation.
17107
17108 Most of them have both positive and negative forms; the negative form
17109 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
17110 one of the forms is listed---the one which is not the default.  You
17111 can figure out the other form by either removing @samp{no-} or adding
17112 it.
17113
17114 @table @gcctabopt
17115 @item -fbounds-check
17116 @opindex fbounds-check
17117 For front-ends that support it, generate additional code to check that
17118 indices used to access arrays are within the declared range.  This is
17119 currently only supported by the Java and Fortran front-ends, where
17120 this option defaults to true and false respectively.
17121
17122 @item -ftrapv
17123 @opindex ftrapv
17124 This option generates traps for signed overflow on addition, subtraction,
17125 multiplication operations.
17126
17127 @item -fwrapv
17128 @opindex fwrapv
17129 This option instructs the compiler to assume that signed arithmetic
17130 overflow of addition, subtraction and multiplication wraps around
17131 using twos-complement representation.  This flag enables some optimizations
17132 and disables others.  This option is enabled by default for the Java
17133 front-end, as required by the Java language specification.
17134
17135 @item -fexceptions
17136 @opindex fexceptions
17137 Enable exception handling.  Generates extra code needed to propagate
17138 exceptions.  For some targets, this implies GCC will generate frame
17139 unwind information for all functions, which can produce significant data
17140 size overhead, although it does not affect execution.  If you do not
17141 specify this option, GCC will enable it by default for languages like
17142 C++ which normally require exception handling, and disable it for
17143 languages like C that do not normally require it.  However, you may need
17144 to enable this option when compiling C code that needs to interoperate
17145 properly with exception handlers written in C++.  You may also wish to
17146 disable this option if you are compiling older C++ programs that don't
17147 use exception handling.
17148
17149 @item -fnon-call-exceptions
17150 @opindex fnon-call-exceptions
17151 Generate code that allows trapping instructions to throw exceptions.
17152 Note that this requires platform-specific runtime support that does
17153 not exist everywhere.  Moreover, it only allows @emph{trapping}
17154 instructions to throw exceptions, i.e.@: memory references or floating
17155 point instructions.  It does not allow exceptions to be thrown from
17156 arbitrary signal handlers such as @code{SIGALRM}.
17157
17158 @item -funwind-tables
17159 @opindex funwind-tables
17160 Similar to @option{-fexceptions}, except that it will just generate any needed
17161 static data, but will not affect the generated code in any other way.
17162 You will normally not enable this option; instead, a language processor
17163 that needs this handling would enable it on your behalf.
17164
17165 @item -fasynchronous-unwind-tables
17166 @opindex fasynchronous-unwind-tables
17167 Generate unwind table in dwarf2 format, if supported by target machine.  The
17168 table is exact at each instruction boundary, so it can be used for stack
17169 unwinding from asynchronous events (such as debugger or garbage collector).
17170
17171 @item -fpcc-struct-return
17172 @opindex fpcc-struct-return
17173 Return ``short'' @code{struct} and @code{union} values in memory like
17174 longer ones, rather than in registers.  This convention is less
17175 efficient, but it has the advantage of allowing intercallability between
17176 GCC-compiled files and files compiled with other compilers, particularly
17177 the Portable C Compiler (pcc).
17178
17179 The precise convention for returning structures in memory depends
17180 on the target configuration macros.
17181
17182 Short structures and unions are those whose size and alignment match
17183 that of some integer type.
17184
17185 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17186 switch is not binary compatible with code compiled with the
17187 @option{-freg-struct-return} switch.
17188 Use it to conform to a non-default application binary interface.
17189
17190 @item -freg-struct-return
17191 @opindex freg-struct-return
17192 Return @code{struct} and @code{union} values in registers when possible.
17193 This is more efficient for small structures than
17194 @option{-fpcc-struct-return}.
17195
17196 If you specify neither @option{-fpcc-struct-return} nor
17197 @option{-freg-struct-return}, GCC defaults to whichever convention is
17198 standard for the target.  If there is no standard convention, GCC
17199 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17200 the principal compiler.  In those cases, we can choose the standard, and
17201 we chose the more efficient register return alternative.
17202
17203 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17204 switch is not binary compatible with code compiled with the
17205 @option{-fpcc-struct-return} switch.
17206 Use it to conform to a non-default application binary interface.
17207
17208 @item -fshort-enums
17209 @opindex fshort-enums
17210 Allocate to an @code{enum} type only as many bytes as it needs for the
17211 declared range of possible values.  Specifically, the @code{enum} type
17212 will be equivalent to the smallest integer type which has enough room.
17213
17214 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17215 code that is not binary compatible with code generated without that switch.
17216 Use it to conform to a non-default application binary interface.
17217
17218 @item -fshort-double
17219 @opindex fshort-double
17220 Use the same size for @code{double} as for @code{float}.
17221
17222 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17223 code that is not binary compatible with code generated without that switch.
17224 Use it to conform to a non-default application binary interface.
17225
17226 @item -fshort-wchar
17227 @opindex fshort-wchar
17228 Override the underlying type for @samp{wchar_t} to be @samp{short
17229 unsigned int} instead of the default for the target.  This option is
17230 useful for building programs to run under WINE@.
17231
17232 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17233 code that is not binary compatible with code generated without that switch.
17234 Use it to conform to a non-default application binary interface.
17235
17236 @item -fno-common
17237 @opindex fno-common
17238 In C code, controls the placement of uninitialized global variables.
17239 Unix C compilers have traditionally permitted multiple definitions of
17240 such variables in different compilation units by placing the variables
17241 in a common block.
17242 This is the behavior specified by @option{-fcommon}, and is the default
17243 for GCC on most targets.
17244 On the other hand, this behavior is not required by ISO C, and on some
17245 targets may carry a speed or code size penalty on variable references.
17246 The @option{-fno-common} option specifies that the compiler should place
17247 uninitialized global variables in the data section of the object file,
17248 rather than generating them as common blocks.
17249 This has the effect that if the same variable is declared
17250 (without @code{extern}) in two different compilations,
17251 you will get a multiple-definition error when you link them.
17252 In this case, you must compile with @option{-fcommon} instead.
17253 Compiling with @option{-fno-common} is useful on targets for which
17254 it provides better performance, or if you wish to verify that the
17255 program will work on other systems which always treat uninitialized
17256 variable declarations this way.
17257
17258 @item -fno-ident
17259 @opindex fno-ident
17260 Ignore the @samp{#ident} directive.
17261
17262 @item -finhibit-size-directive
17263 @opindex finhibit-size-directive
17264 Don't output a @code{.size} assembler directive, or anything else that
17265 would cause trouble if the function is split in the middle, and the
17266 two halves are placed at locations far apart in memory.  This option is
17267 used when compiling @file{crtstuff.c}; you should not need to use it
17268 for anything else.
17269
17270 @item -fverbose-asm
17271 @opindex fverbose-asm
17272 Put extra commentary information in the generated assembly code to
17273 make it more readable.  This option is generally only of use to those
17274 who actually need to read the generated assembly code (perhaps while
17275 debugging the compiler itself).
17276
17277 @option{-fno-verbose-asm}, the default, causes the
17278 extra information to be omitted and is useful when comparing two assembler
17279 files.
17280
17281 @item -frecord-gcc-switches
17282 @opindex frecord-gcc-switches
17283 This switch causes the command line that was used to invoke the
17284 compiler to be recorded into the object file that is being created.
17285 This switch is only implemented on some targets and the exact format
17286 of the recording is target and binary file format dependent, but it
17287 usually takes the form of a section containing ASCII text.  This
17288 switch is related to the @option{-fverbose-asm} switch, but that
17289 switch only records information in the assembler output file as
17290 comments, so it never reaches the object file.
17291
17292 @item -fpic
17293 @opindex fpic
17294 @cindex global offset table
17295 @cindex PIC
17296 Generate position-independent code (PIC) suitable for use in a shared
17297 library, if supported for the target machine.  Such code accesses all
17298 constant addresses through a global offset table (GOT)@.  The dynamic
17299 loader resolves the GOT entries when the program starts (the dynamic
17300 loader is not part of GCC; it is part of the operating system).  If
17301 the GOT size for the linked executable exceeds a machine-specific
17302 maximum size, you get an error message from the linker indicating that
17303 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17304 instead.  (These maximums are 8k on the SPARC and 32k
17305 on the m68k and RS/6000.  The 386 has no such limit.)
17306
17307 Position-independent code requires special support, and therefore works
17308 only on certain machines.  For the 386, GCC supports PIC for System V
17309 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17310 position-independent.
17311
17312 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17313 are defined to 1.
17314
17315 @item -fPIC
17316 @opindex fPIC
17317 If supported for the target machine, emit position-independent code,
17318 suitable for dynamic linking and avoiding any limit on the size of the
17319 global offset table.  This option makes a difference on the m68k,
17320 PowerPC and SPARC@.
17321
17322 Position-independent code requires special support, and therefore works
17323 only on certain machines.
17324
17325 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17326 are defined to 2.
17327
17328 @item -fpie
17329 @itemx -fPIE
17330 @opindex fpie
17331 @opindex fPIE
17332 These options are similar to @option{-fpic} and @option{-fPIC}, but
17333 generated position independent code can be only linked into executables.
17334 Usually these options are used when @option{-pie} GCC option will be
17335 used during linking.
17336
17337 @option{-fpie} and @option{-fPIE} both define the macros
17338 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17339 for @option{-fpie} and 2 for @option{-fPIE}.
17340
17341 @item -fno-jump-tables
17342 @opindex fno-jump-tables
17343 Do not use jump tables for switch statements even where it would be
17344 more efficient than other code generation strategies.  This option is
17345 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17346 building code which forms part of a dynamic linker and cannot
17347 reference the address of a jump table.  On some targets, jump tables
17348 do not require a GOT and this option is not needed.
17349
17350 @item -ffixed-@var{reg}
17351 @opindex ffixed
17352 Treat the register named @var{reg} as a fixed register; generated code
17353 should never refer to it (except perhaps as a stack pointer, frame
17354 pointer or in some other fixed role).
17355
17356 @var{reg} must be the name of a register.  The register names accepted
17357 are machine-specific and are defined in the @code{REGISTER_NAMES}
17358 macro in the machine description macro file.
17359
17360 This flag does not have a negative form, because it specifies a
17361 three-way choice.
17362
17363 @item -fcall-used-@var{reg}
17364 @opindex fcall-used
17365 Treat the register named @var{reg} as an allocable register that is
17366 clobbered by function calls.  It may be allocated for temporaries or
17367 variables that do not live across a call.  Functions compiled this way
17368 will not save and restore the register @var{reg}.
17369
17370 It is an error to used this flag with the frame pointer or stack pointer.
17371 Use of this flag for other registers that have fixed pervasive roles in
17372 the machine's execution model will produce disastrous results.
17373
17374 This flag does not have a negative form, because it specifies a
17375 three-way choice.
17376
17377 @item -fcall-saved-@var{reg}
17378 @opindex fcall-saved
17379 Treat the register named @var{reg} as an allocable register saved by
17380 functions.  It may be allocated even for temporaries or variables that
17381 live across a call.  Functions compiled this way will save and restore
17382 the register @var{reg} if they use it.
17383
17384 It is an error to used this flag with the frame pointer or stack pointer.
17385 Use of this flag for other registers that have fixed pervasive roles in
17386 the machine's execution model will produce disastrous results.
17387
17388 A different sort of disaster will result from the use of this flag for
17389 a register in which function values may be returned.
17390
17391 This flag does not have a negative form, because it specifies a
17392 three-way choice.
17393
17394 @item -fpack-struct[=@var{n}]
17395 @opindex fpack-struct
17396 Without a value specified, pack all structure members together without
17397 holes.  When a value is specified (which must be a small power of two), pack
17398 structure members according to this value, representing the maximum
17399 alignment (that is, objects with default alignment requirements larger than
17400 this will be output potentially unaligned at the next fitting location.
17401
17402 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17403 code that is not binary compatible with code generated without that switch.
17404 Additionally, it makes the code suboptimal.
17405 Use it to conform to a non-default application binary interface.
17406
17407 @item -finstrument-functions
17408 @opindex finstrument-functions
17409 Generate instrumentation calls for entry and exit to functions.  Just
17410 after function entry and just before function exit, the following
17411 profiling functions will be called with the address of the current
17412 function and its call site.  (On some platforms,
17413 @code{__builtin_return_address} does not work beyond the current
17414 function, so the call site information may not be available to the
17415 profiling functions otherwise.)
17416
17417 @smallexample
17418 void __cyg_profile_func_enter (void *this_fn,
17419                                void *call_site);
17420 void __cyg_profile_func_exit  (void *this_fn,
17421                                void *call_site);
17422 @end smallexample
17423
17424 The first argument is the address of the start of the current function,
17425 which may be looked up exactly in the symbol table.
17426
17427 This instrumentation is also done for functions expanded inline in other
17428 functions.  The profiling calls will indicate where, conceptually, the
17429 inline function is entered and exited.  This means that addressable
17430 versions of such functions must be available.  If all your uses of a
17431 function are expanded inline, this may mean an additional expansion of
17432 code size.  If you use @samp{extern inline} in your C code, an
17433 addressable version of such functions must be provided.  (This is
17434 normally the case anyways, but if you get lucky and the optimizer always
17435 expands the functions inline, you might have gotten away without
17436 providing static copies.)
17437
17438 A function may be given the attribute @code{no_instrument_function}, in
17439 which case this instrumentation will not be done.  This can be used, for
17440 example, for the profiling functions listed above, high-priority
17441 interrupt routines, and any functions from which the profiling functions
17442 cannot safely be called (perhaps signal handlers, if the profiling
17443 routines generate output or allocate memory).
17444
17445 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
17446 @opindex finstrument-functions-exclude-file-list
17447
17448 Set the list of functions that are excluded from instrumentation (see
17449 the description of @code{-finstrument-functions}).  If the file that
17450 contains a function definition matches with one of @var{file}, then
17451 that function is not instrumented.  The match is done on substrings:
17452 if the @var{file} parameter is a substring of the file name, it is
17453 considered to be a match.
17454
17455 For example,
17456 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
17457 will exclude any inline function defined in files whose pathnames
17458 contain @code{/bits/stl} or @code{include/sys}.
17459
17460 If, for some reason, you want to include letter @code{','} in one of
17461 @var{sym}, write @code{'\,'}. For example,
17462 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
17463 (note the single quote surrounding the option).
17464
17465 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
17466 @opindex finstrument-functions-exclude-function-list
17467
17468 This is similar to @code{-finstrument-functions-exclude-file-list},
17469 but this option sets the list of function names to be excluded from
17470 instrumentation.  The function name to be matched is its user-visible
17471 name, such as @code{vector<int> blah(const vector<int> &)}, not the
17472 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
17473 match is done on substrings: if the @var{sym} parameter is a substring
17474 of the function name, it is considered to be a match.  For C99 and C++
17475 extended identifiers, the function name must be given in UTF-8, not
17476 using universal character names.
17477
17478 @item -fstack-check
17479 @opindex fstack-check
17480 Generate code to verify that you do not go beyond the boundary of the
17481 stack.  You should specify this flag if you are running in an
17482 environment with multiple threads, but only rarely need to specify it in
17483 a single-threaded environment since stack overflow is automatically
17484 detected on nearly all systems if there is only one stack.
17485
17486 Note that this switch does not actually cause checking to be done; the
17487 operating system or the language runtime must do that.  The switch causes
17488 generation of code to ensure that they see the stack being extended.
17489
17490 You can additionally specify a string parameter: @code{no} means no
17491 checking, @code{generic} means force the use of old-style checking,
17492 @code{specific} means use the best checking method and is equivalent
17493 to bare @option{-fstack-check}.
17494
17495 Old-style checking is a generic mechanism that requires no specific
17496 target support in the compiler but comes with the following drawbacks:
17497
17498 @enumerate
17499 @item
17500 Modified allocation strategy for large objects: they will always be
17501 allocated dynamically if their size exceeds a fixed threshold.
17502
17503 @item
17504 Fixed limit on the size of the static frame of functions: when it is
17505 topped by a particular function, stack checking is not reliable and
17506 a warning is issued by the compiler.
17507
17508 @item
17509 Inefficiency: because of both the modified allocation strategy and the
17510 generic implementation, the performances of the code are hampered.
17511 @end enumerate
17512
17513 Note that old-style stack checking is also the fallback method for
17514 @code{specific} if no target support has been added in the compiler.
17515
17516 @item -fstack-limit-register=@var{reg}
17517 @itemx -fstack-limit-symbol=@var{sym}
17518 @itemx -fno-stack-limit
17519 @opindex fstack-limit-register
17520 @opindex fstack-limit-symbol
17521 @opindex fno-stack-limit
17522 Generate code to ensure that the stack does not grow beyond a certain value,
17523 either the value of a register or the address of a symbol.  If the stack
17524 would grow beyond the value, a signal is raised.  For most targets,
17525 the signal is raised before the stack overruns the boundary, so
17526 it is possible to catch the signal without taking special precautions.
17527
17528 For instance, if the stack starts at absolute address @samp{0x80000000}
17529 and grows downwards, you can use the flags
17530 @option{-fstack-limit-symbol=__stack_limit} and
17531 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
17532 of 128KB@.  Note that this may only work with the GNU linker.
17533
17534 @item -fleading-underscore
17535 @opindex fleading-underscore
17536 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
17537 change the way C symbols are represented in the object file.  One use
17538 is to help link with legacy assembly code.
17539
17540 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
17541 generate code that is not binary compatible with code generated without that
17542 switch.  Use it to conform to a non-default application binary interface.
17543 Not all targets provide complete support for this switch.
17544
17545 @item -ftls-model=@var{model}
17546 @opindex ftls-model
17547 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
17548 The @var{model} argument should be one of @code{global-dynamic},
17549 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
17550
17551 The default without @option{-fpic} is @code{initial-exec}; with
17552 @option{-fpic} the default is @code{global-dynamic}.
17553
17554 @item -fvisibility=@var{default|internal|hidden|protected}
17555 @opindex fvisibility
17556 Set the default ELF image symbol visibility to the specified option---all
17557 symbols will be marked with this unless overridden within the code.
17558 Using this feature can very substantially improve linking and
17559 load times of shared object libraries, produce more optimized
17560 code, provide near-perfect API export and prevent symbol clashes.
17561 It is @strong{strongly} recommended that you use this in any shared objects
17562 you distribute.
17563
17564 Despite the nomenclature, @code{default} always means public ie;
17565 available to be linked against from outside the shared object.
17566 @code{protected} and @code{internal} are pretty useless in real-world
17567 usage so the only other commonly used option will be @code{hidden}.
17568 The default if @option{-fvisibility} isn't specified is
17569 @code{default}, i.e., make every
17570 symbol public---this causes the same behavior as previous versions of
17571 GCC@.
17572
17573 A good explanation of the benefits offered by ensuring ELF
17574 symbols have the correct visibility is given by ``How To Write
17575 Shared Libraries'' by Ulrich Drepper (which can be found at
17576 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
17577 solution made possible by this option to marking things hidden when
17578 the default is public is to make the default hidden and mark things
17579 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
17580 and @code{__attribute__ ((visibility("default")))} instead of
17581 @code{__declspec(dllexport)} you get almost identical semantics with
17582 identical syntax.  This is a great boon to those working with
17583 cross-platform projects.
17584
17585 For those adding visibility support to existing code, you may find
17586 @samp{#pragma GCC visibility} of use.  This works by you enclosing
17587 the declarations you wish to set visibility for with (for example)
17588 @samp{#pragma GCC visibility push(hidden)} and
17589 @samp{#pragma GCC visibility pop}.
17590 Bear in mind that symbol visibility should be viewed @strong{as
17591 part of the API interface contract} and thus all new code should
17592 always specify visibility when it is not the default ie; declarations
17593 only for use within the local DSO should @strong{always} be marked explicitly
17594 as hidden as so to avoid PLT indirection overheads---making this
17595 abundantly clear also aids readability and self-documentation of the code.
17596 Note that due to ISO C++ specification requirements, operator new and
17597 operator delete must always be of default visibility.
17598
17599 Be aware that headers from outside your project, in particular system
17600 headers and headers from any other library you use, may not be
17601 expecting to be compiled with visibility other than the default.  You
17602 may need to explicitly say @samp{#pragma GCC visibility push(default)}
17603 before including any such headers.
17604
17605 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
17606 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
17607 no modifications.  However, this means that calls to @samp{extern}
17608 functions with no explicit visibility will use the PLT, so it is more
17609 effective to use @samp{__attribute ((visibility))} and/or
17610 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
17611 declarations should be treated as hidden.
17612
17613 Note that @samp{-fvisibility} does affect C++ vague linkage
17614 entities. This means that, for instance, an exception class that will
17615 be thrown between DSOs must be explicitly marked with default
17616 visibility so that the @samp{type_info} nodes will be unified between
17617 the DSOs.
17618
17619 An overview of these techniques, their benefits and how to use them
17620 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
17621
17622 @end table
17623
17624 @c man end
17625
17626 @node Environment Variables
17627 @section Environment Variables Affecting GCC
17628 @cindex environment variables
17629
17630 @c man begin ENVIRONMENT
17631 This section describes several environment variables that affect how GCC
17632 operates.  Some of them work by specifying directories or prefixes to use
17633 when searching for various kinds of files.  Some are used to specify other
17634 aspects of the compilation environment.
17635
17636 Note that you can also specify places to search using options such as
17637 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
17638 take precedence over places specified using environment variables, which
17639 in turn take precedence over those specified by the configuration of GCC@.
17640 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
17641 GNU Compiler Collection (GCC) Internals}.
17642
17643 @table @env
17644 @item LANG
17645 @itemx LC_CTYPE
17646 @c @itemx LC_COLLATE
17647 @itemx LC_MESSAGES
17648 @c @itemx LC_MONETARY
17649 @c @itemx LC_NUMERIC
17650 @c @itemx LC_TIME
17651 @itemx LC_ALL
17652 @findex LANG
17653 @findex LC_CTYPE
17654 @c @findex LC_COLLATE
17655 @findex LC_MESSAGES
17656 @c @findex LC_MONETARY
17657 @c @findex LC_NUMERIC
17658 @c @findex LC_TIME
17659 @findex LC_ALL
17660 @cindex locale
17661 These environment variables control the way that GCC uses
17662 localization information that allow GCC to work with different
17663 national conventions.  GCC inspects the locale categories
17664 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
17665 so.  These locale categories can be set to any value supported by your
17666 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
17667 Kingdom encoded in UTF-8.
17668
17669 The @env{LC_CTYPE} environment variable specifies character
17670 classification.  GCC uses it to determine the character boundaries in
17671 a string; this is needed for some multibyte encodings that contain quote
17672 and escape characters that would otherwise be interpreted as a string
17673 end or escape.
17674
17675 The @env{LC_MESSAGES} environment variable specifies the language to
17676 use in diagnostic messages.
17677
17678 If the @env{LC_ALL} environment variable is set, it overrides the value
17679 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
17680 and @env{LC_MESSAGES} default to the value of the @env{LANG}
17681 environment variable.  If none of these variables are set, GCC
17682 defaults to traditional C English behavior.
17683
17684 @item TMPDIR
17685 @findex TMPDIR
17686 If @env{TMPDIR} is set, it specifies the directory to use for temporary
17687 files.  GCC uses temporary files to hold the output of one stage of
17688 compilation which is to be used as input to the next stage: for example,
17689 the output of the preprocessor, which is the input to the compiler
17690 proper.
17691
17692 @item GCC_EXEC_PREFIX
17693 @findex GCC_EXEC_PREFIX
17694 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
17695 names of the subprograms executed by the compiler.  No slash is added
17696 when this prefix is combined with the name of a subprogram, but you can
17697 specify a prefix that ends with a slash if you wish.
17698
17699 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
17700 an appropriate prefix to use based on the pathname it was invoked with.
17701
17702 If GCC cannot find the subprogram using the specified prefix, it
17703 tries looking in the usual places for the subprogram.
17704
17705 The default value of @env{GCC_EXEC_PREFIX} is
17706 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
17707 the installed compiler. In many cases @var{prefix} is the value
17708 of @code{prefix} when you ran the @file{configure} script.
17709
17710 Other prefixes specified with @option{-B} take precedence over this prefix.
17711
17712 This prefix is also used for finding files such as @file{crt0.o} that are
17713 used for linking.
17714
17715 In addition, the prefix is used in an unusual way in finding the
17716 directories to search for header files.  For each of the standard
17717 directories whose name normally begins with @samp{/usr/local/lib/gcc}
17718 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
17719 replacing that beginning with the specified prefix to produce an
17720 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
17721 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
17722 These alternate directories are searched first; the standard directories
17723 come next. If a standard directory begins with the configured
17724 @var{prefix} then the value of @var{prefix} is replaced by
17725 @env{GCC_EXEC_PREFIX} when looking for header files.
17726
17727 @item COMPILER_PATH
17728 @findex COMPILER_PATH
17729 The value of @env{COMPILER_PATH} is a colon-separated list of
17730 directories, much like @env{PATH}.  GCC tries the directories thus
17731 specified when searching for subprograms, if it can't find the
17732 subprograms using @env{GCC_EXEC_PREFIX}.
17733
17734 @item LIBRARY_PATH
17735 @findex LIBRARY_PATH
17736 The value of @env{LIBRARY_PATH} is a colon-separated list of
17737 directories, much like @env{PATH}.  When configured as a native compiler,
17738 GCC tries the directories thus specified when searching for special
17739 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
17740 using GCC also uses these directories when searching for ordinary
17741 libraries for the @option{-l} option (but directories specified with
17742 @option{-L} come first).
17743
17744 @item LANG
17745 @findex LANG
17746 @cindex locale definition
17747 This variable is used to pass locale information to the compiler.  One way in
17748 which this information is used is to determine the character set to be used
17749 when character literals, string literals and comments are parsed in C and C++.
17750 When the compiler is configured to allow multibyte characters,
17751 the following values for @env{LANG} are recognized:
17752
17753 @table @samp
17754 @item C-JIS
17755 Recognize JIS characters.
17756 @item C-SJIS
17757 Recognize SJIS characters.
17758 @item C-EUCJP
17759 Recognize EUCJP characters.
17760 @end table
17761
17762 If @env{LANG} is not defined, or if it has some other value, then the
17763 compiler will use mblen and mbtowc as defined by the default locale to
17764 recognize and translate multibyte characters.
17765 @end table
17766
17767 @noindent
17768 Some additional environments variables affect the behavior of the
17769 preprocessor.
17770
17771 @include cppenv.texi
17772
17773 @c man end
17774
17775 @node Precompiled Headers
17776 @section Using Precompiled Headers
17777 @cindex precompiled headers
17778 @cindex speed of compilation
17779
17780 Often large projects have many header files that are included in every
17781 source file.  The time the compiler takes to process these header files
17782 over and over again can account for nearly all of the time required to
17783 build the project.  To make builds faster, GCC allows users to
17784 `precompile' a header file; then, if builds can use the precompiled
17785 header file they will be much faster.
17786
17787 To create a precompiled header file, simply compile it as you would any
17788 other file, if necessary using the @option{-x} option to make the driver
17789 treat it as a C or C++ header file.  You will probably want to use a
17790 tool like @command{make} to keep the precompiled header up-to-date when
17791 the headers it contains change.
17792
17793 A precompiled header file will be searched for when @code{#include} is
17794 seen in the compilation.  As it searches for the included file
17795 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17796 compiler looks for a precompiled header in each directory just before it
17797 looks for the include file in that directory.  The name searched for is
17798 the name specified in the @code{#include} with @samp{.gch} appended.  If
17799 the precompiled header file can't be used, it is ignored.
17800
17801 For instance, if you have @code{#include "all.h"}, and you have
17802 @file{all.h.gch} in the same directory as @file{all.h}, then the
17803 precompiled header file will be used if possible, and the original
17804 header will be used otherwise.
17805
17806 Alternatively, you might decide to put the precompiled header file in a
17807 directory and use @option{-I} to ensure that directory is searched
17808 before (or instead of) the directory containing the original header.
17809 Then, if you want to check that the precompiled header file is always
17810 used, you can put a file of the same name as the original header in this
17811 directory containing an @code{#error} command.
17812
17813 This also works with @option{-include}.  So yet another way to use
17814 precompiled headers, good for projects not designed with precompiled
17815 header files in mind, is to simply take most of the header files used by
17816 a project, include them from another header file, precompile that header
17817 file, and @option{-include} the precompiled header.  If the header files
17818 have guards against multiple inclusion, they will be skipped because
17819 they've already been included (in the precompiled header).
17820
17821 If you need to precompile the same header file for different
17822 languages, targets, or compiler options, you can instead make a
17823 @emph{directory} named like @file{all.h.gch}, and put each precompiled
17824 header in the directory, perhaps using @option{-o}.  It doesn't matter
17825 what you call the files in the directory, every precompiled header in
17826 the directory will be considered.  The first precompiled header
17827 encountered in the directory that is valid for this compilation will
17828 be used; they're searched in no particular order.
17829
17830 There are many other possibilities, limited only by your imagination,
17831 good sense, and the constraints of your build system.
17832
17833 A precompiled header file can be used only when these conditions apply:
17834
17835 @itemize
17836 @item
17837 Only one precompiled header can be used in a particular compilation.
17838
17839 @item
17840 A precompiled header can't be used once the first C token is seen.  You
17841 can have preprocessor directives before a precompiled header; you can
17842 even include a precompiled header from inside another header, so long as
17843 there are no C tokens before the @code{#include}.
17844
17845 @item
17846 The precompiled header file must be produced for the same language as
17847 the current compilation.  You can't use a C precompiled header for a C++
17848 compilation.
17849
17850 @item
17851 The precompiled header file must have been produced by the same compiler
17852 binary as the current compilation is using.
17853
17854 @item
17855 Any macros defined before the precompiled header is included must
17856 either be defined in the same way as when the precompiled header was
17857 generated, or must not affect the precompiled header, which usually
17858 means that they don't appear in the precompiled header at all.
17859
17860 The @option{-D} option is one way to define a macro before a
17861 precompiled header is included; using a @code{#define} can also do it.
17862 There are also some options that define macros implicitly, like
17863 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
17864 defined this way.
17865
17866 @item If debugging information is output when using the precompiled
17867 header, using @option{-g} or similar, the same kind of debugging information
17868 must have been output when building the precompiled header.  However,
17869 a precompiled header built using @option{-g} can be used in a compilation
17870 when no debugging information is being output.
17871
17872 @item The same @option{-m} options must generally be used when building
17873 and using the precompiled header.  @xref{Submodel Options},
17874 for any cases where this rule is relaxed.
17875
17876 @item Each of the following options must be the same when building and using
17877 the precompiled header:
17878
17879 @gccoptlist{-fexceptions}
17880
17881 @item
17882 Some other command-line options starting with @option{-f},
17883 @option{-p}, or @option{-O} must be defined in the same way as when
17884 the precompiled header was generated.  At present, it's not clear
17885 which options are safe to change and which are not; the safest choice
17886 is to use exactly the same options when generating and using the
17887 precompiled header.  The following are known to be safe:
17888
17889 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
17890 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
17891 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
17892 -pedantic-errors}
17893
17894 @end itemize
17895
17896 For all of these except the last, the compiler will automatically
17897 ignore the precompiled header if the conditions aren't met.  If you
17898 find an option combination that doesn't work and doesn't cause the
17899 precompiled header to be ignored, please consider filing a bug report,
17900 see @ref{Bugs}.
17901
17902 If you do use differing options when generating and using the
17903 precompiled header, the actual behavior will be a mixture of the
17904 behavior for the options.  For instance, if you use @option{-g} to
17905 generate the precompiled header but not when using it, you may or may
17906 not get debugging information for routines in the precompiled header.